feat(sdk-coin-zketh): add zketh sdk skeleton

Ticket: WIN-1417

Dockerfile

@@ -102,71 +102,73 @@ COPY --from=builder /tmp/bitgo/modules/sdk-coin-ltc /var/modules/sdk-coin-ltc/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-xlm /var/modules/sdk-coin-xlm/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-xrp /var/modules/sdk-coin-xrp/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-zec /var/modules/sdk-coin-zec/
+COPY --from=builder /tmp/bitgo/modules/sdk-coin-zketh /var/modules/sdk-coin-zketh/
 
 RUN cd /var/modules/sdk-core && yarn link && \
-cd /var/modules/bls-dkg && yarn link && \
-cd /var/modules/sdk-lib-mpc && yarn link && \
-cd /var/modules/statics && yarn link && \
-cd /var/modules/utxo-lib && yarn link && \
-cd /var/modules/blake2b && yarn link && \
-cd /var/modules/blake2b-wasm && yarn link && \
-cd /var/modules/bitgo && yarn link && \
-cd /var/modules/abstract-utxo && yarn link && \
-cd /var/modules/blockapis && yarn link && \
-cd /var/modules/sdk-api && yarn link && \
-cd /var/modules/sjcl && yarn link && \
-cd /var/modules/unspents && yarn link && \
-cd /var/modules/account-lib && yarn link && \
-cd /var/modules/sdk-coin-algo && yarn link && \
-cd /var/modules/sdk-coin-arbeth && yarn link && \
-cd /var/modules/abstract-eth && yarn link && \
-cd /var/modules/sdk-coin-atom && yarn link && \
-cd /var/modules/sdk-coin-avaxc && yarn link && \
-cd /var/modules/sdk-coin-avaxp && yarn link && \
-cd /var/modules/sdk-coin-eth && yarn link && \
-cd /var/modules/sdk-coin-bera && yarn link && \
-cd /var/modules/abstract-cosmos && yarn link && \
-cd /var/modules/sdk-coin-bld && yarn link && \
-cd /var/modules/sdk-coin-bsc && yarn link && \
-cd /var/modules/sdk-coin-celo && yarn link && \
-cd /var/modules/sdk-coin-coreum && yarn link && \
-cd /var/modules/sdk-coin-cspr && yarn link && \
-cd /var/modules/sdk-coin-dot && yarn link && \
-cd /var/modules/sdk-coin-etc && yarn link && \
-cd /var/modules/sdk-coin-eth2 && yarn link && \
-cd /var/modules/sdk-coin-hash && yarn link && \
-cd /var/modules/sdk-coin-hbar && yarn link && \
-cd /var/modules/sdk-coin-injective && yarn link && \
-cd /var/modules/sdk-coin-islm && yarn link && \
-cd /var/modules/sdk-coin-near && yarn link && \
-cd /var/modules/sdk-coin-opeth && yarn link && \
-cd /var/modules/sdk-coin-osmo && yarn link && \
-cd /var/modules/sdk-coin-polygon && yarn link && \
-cd /var/modules/sdk-coin-rbtc && yarn link && \
-cd /var/modules/sdk-coin-sei && yarn link && \
-cd /var/modules/sdk-coin-sol && yarn link && \
-cd /var/modules/sdk-coin-stx && yarn link && \
-cd /var/modules/sdk-coin-sui && yarn link && \
-cd /var/modules/sdk-coin-tia && yarn link && \
-cd /var/modules/sdk-coin-ton && yarn link && \
-cd /var/modules/sdk-coin-trx && yarn link && \
-cd /var/modules/sdk-coin-xtz && yarn link && \
-cd /var/modules/sdk-coin-zeta && yarn link && \
-cd /var/modules/sdk-coin-ada && yarn link && \
-cd /var/modules/sdk-coin-bch && yarn link && \
-cd /var/modules/sdk-coin-bcha && yarn link && \
-cd /var/modules/sdk-coin-bsv && yarn link && \
-cd /var/modules/sdk-coin-btc && yarn link && \
-cd /var/modules/utxo-ord && yarn link && \
-cd /var/modules/sdk-coin-btg && yarn link && \
-cd /var/modules/sdk-coin-dash && yarn link && \
-cd /var/modules/sdk-coin-doge && yarn link && \
-cd /var/modules/sdk-coin-eos && yarn link && \
-cd /var/modules/sdk-coin-ethw && yarn link && \
-cd /var/modules/sdk-coin-ltc && yarn link && \
-cd /var/modules/sdk-coin-xlm && yarn link && \
-cd /var/modules/sdk-coin-xrp && yarn link && \
-cd /var/modules/sdk-coin-zec && yarn link
+    cd /var/modules/bls-dkg && yarn link && \
+    cd /var/modules/sdk-lib-mpc && yarn link && \
+    cd /var/modules/statics && yarn link && \
+    cd /var/modules/utxo-lib && yarn link && \
+    cd /var/modules/blake2b && yarn link && \
+    cd /var/modules/blake2b-wasm && yarn link && \
+    cd /var/modules/bitgo && yarn link && \
+    cd /var/modules/abstract-utxo && yarn link && \
+    cd /var/modules/blockapis && yarn link && \
+    cd /var/modules/sdk-api && yarn link && \
+    cd /var/modules/sjcl && yarn link && \
+    cd /var/modules/unspents && yarn link && \
+    cd /var/modules/account-lib && yarn link && \
+    cd /var/modules/sdk-coin-algo && yarn link && \
+    cd /var/modules/sdk-coin-arbeth && yarn link && \
+    cd /var/modules/abstract-eth && yarn link && \
+    cd /var/modules/sdk-coin-atom && yarn link && \
+    cd /var/modules/sdk-coin-avaxc && yarn link && \
+    cd /var/modules/sdk-coin-avaxp && yarn link && \
+    cd /var/modules/sdk-coin-eth && yarn link && \
+    cd /var/modules/sdk-coin-bera && yarn link && \
+    cd /var/modules/abstract-cosmos && yarn link && \
+    cd /var/modules/sdk-coin-bld && yarn link && \
+    cd /var/modules/sdk-coin-bsc && yarn link && \
+    cd /var/modules/sdk-coin-celo && yarn link && \
+    cd /var/modules/sdk-coin-coreum && yarn link && \
+    cd /var/modules/sdk-coin-cspr && yarn link && \
+    cd /var/modules/sdk-coin-dot && yarn link && \
+    cd /var/modules/sdk-coin-etc && yarn link && \
+    cd /var/modules/sdk-coin-eth2 && yarn link && \
+    cd /var/modules/sdk-coin-hash && yarn link && \
+    cd /var/modules/sdk-coin-hbar && yarn link && \
+    cd /var/modules/sdk-coin-injective && yarn link && \
+    cd /var/modules/sdk-coin-islm && yarn link && \
+    cd /var/modules/sdk-coin-near && yarn link && \
+    cd /var/modules/sdk-coin-opeth && yarn link && \
+    cd /var/modules/sdk-coin-osmo && yarn link && \
+    cd /var/modules/sdk-coin-polygon && yarn link && \
+    cd /var/modules/sdk-coin-rbtc && yarn link && \
+    cd /var/modules/sdk-coin-sei && yarn link && \
+    cd /var/modules/sdk-coin-sol && yarn link && \
+    cd /var/modules/sdk-coin-stx && yarn link && \
+    cd /var/modules/sdk-coin-sui && yarn link && \
+    cd /var/modules/sdk-coin-tia && yarn link && \
+    cd /var/modules/sdk-coin-ton && yarn link && \
+    cd /var/modules/sdk-coin-trx && yarn link && \
+    cd /var/modules/sdk-coin-xtz && yarn link && \
+    cd /var/modules/sdk-coin-zeta && yarn link && \
+    cd /var/modules/sdk-coin-ada && yarn link && \
+    cd /var/modules/sdk-coin-bch && yarn link && \
+    cd /var/modules/sdk-coin-bcha && yarn link && \
+    cd /var/modules/sdk-coin-bsv && yarn link && \
+    cd /var/modules/sdk-coin-btc && yarn link && \
+    cd /var/modules/utxo-ord && yarn link && \
+    cd /var/modules/sdk-coin-btg && yarn link && \
+    cd /var/modules/sdk-coin-dash && yarn link && \
+    cd /var/modules/sdk-coin-doge && yarn link && \
+    cd /var/modules/sdk-coin-eos && yarn link && \
+    cd /var/modules/sdk-coin-ethw && yarn link && \
+    cd /var/modules/sdk-coin-ltc && yarn link && \
+    cd /var/modules/sdk-coin-xlm && yarn link && \
+    cd /var/modules/sdk-coin-xrp && yarn link && \
+    cd /var/modules/sdk-coin-zec && yarn link && \
+    cd /var/modules/sdk-coin-zketh && yarn link
 #COPY_END
 
 #LINK_START
@@ -234,7 +236,8 @@ RUN cd /var/bitgo-express && \
     yarn link @bitgo/sdk-coin-ltc && \
     yarn link @bitgo/sdk-coin-xlm && \
     yarn link @bitgo/sdk-coin-xrp && \
-    yarn link @bitgo/sdk-coin-zec
+    yarn link @bitgo/sdk-coin-zec && \
+    yarn link @bitgo/sdk-coin-zketh
 #LINK_END
 
 #LABEL_START

modules/account-lib/package.json

@@ -60,6 +60,7 @@
     "@bitgo/sdk-coin-trx": "^1.27.0",
     "@bitgo/sdk-coin-xtz": "^1.6.22",
     "@bitgo/sdk-coin-zeta": "^1.20.0",
+    "@bitgo/sdk-coin-zketh": "^1.0.0",
     "@bitgo/sdk-core": "^17.0.0",
     "@bitgo/sdk-lib-mpc": "^8.24.0",
     "@bitgo/statics": "^38.0.0",

modules/account-lib/src/index.ts

@@ -125,6 +125,9 @@ export { Sui };
 import * as Ton from '@bitgo/sdk-coin-ton';
 export { Ton };
 
+import * as zkEth from '@bitgo/sdk-coin-zketh';
+export { zkEth };
+
 const coinBuilderMap = {
   trx: Trx.WrappedBuilder,
   ttrx: Trx.WrappedBuilder,
@@ -191,6 +194,8 @@ const coinBuilderMap = {
   topeth: Opeth.TransactionBuilder,
   ton: Ton.TransactionBuilder,
   tton: Ton.TransactionBuilder,
+  zketh: zkEth.TransactionBuilder,
+  tzketh: zkEth.TransactionBuilder,
 };
 
 /**

modules/account-lib/tsconfig.json

@@ -100,6 +100,9 @@
     {
       "path": "../sdk-coin-zeta"
     },
+    {
+      "path": "../sdk-coin-zketh"
+    },
     {
       "path": "../sdk-core"
     },

modules/bitgo/package.json

@@ -95,6 +95,7 @@
     "@bitgo/sdk-coin-xtz": "^1.6.22",
     "@bitgo/sdk-coin-zec": "^1.5.22",
     "@bitgo/sdk-coin-zeta": "^1.20.0",
+    "@bitgo/sdk-coin-zketh": "^1.0.0",
     "@bitgo/sdk-core": "^17.0.0",
     "@bitgo/sdk-lib-mpc": "^8.24.0",
     "@bitgo/sjcl": "^1.0.1",

modules/bitgo/src/v2/coinFactory.ts

@@ -115,11 +115,14 @@ import {
   Txtz,
   Tzec,
   Tzeta,
+  Tzketh,
   Xlm,
   Xrp,
   Xtz,
   Zec,
   Zeta,
+  Zketh,
+  ZkethToken,
 } from './coins';
 
 function registerCoinConstructors(globalCoinFactory: CoinFactory): void {
@@ -221,11 +224,13 @@ function registerCoinConstructors(globalCoinFactory: CoinFactory): void {
   globalCoinFactory.register('txtz', Txtz.createInstance);
   globalCoinFactory.register('tzec', Tzec.createInstance);
   globalCoinFactory.register('tzeta', Tzeta.createInstance);
+  globalCoinFactory.register('tzketh', Tzketh.createInstance);
   globalCoinFactory.register('xlm', Xlm.createInstance);
   globalCoinFactory.register('xrp', Xrp.createInstance);
   globalCoinFactory.register('xtz', Xtz.createInstance);
   globalCoinFactory.register('zec', Zec.createInstance);
   globalCoinFactory.register('zeta', Zeta.createInstance);
+  globalCoinFactory.register('zketh', Zketh.createInstance);
 
   Erc20Token.createTokenConstructors().forEach(({ name, coinConstructor }) => {
     globalCoinFactory.register(name, coinConstructor);
@@ -287,6 +292,10 @@ function registerCoinConstructors(globalCoinFactory: CoinFactory): void {
   AdaToken.createTokenConstructors().forEach(({ name, coinConstructor }) =>
     globalCoinFactory.register(name, coinConstructor)
   );
+
+  ZkethToken.createTokenConstructors().forEach(({ name, coinConstructor }) =>
+    globalCoinFactory.register(name, coinConstructor)
+  );
 }
 
 const GlobalCoinFactory: CoinFactory = new CoinFactory();

modules/bitgo/src/v2/coins/index.ts

@@ -45,6 +45,8 @@ import { Txrp, Xrp } from '@bitgo/sdk-coin-xrp';
 import { Txtz, Xtz } from '@bitgo/sdk-coin-xtz';
 import { Tzec, Zec } from '@bitgo/sdk-coin-zec';
 import { Tzeta, Zeta } from '@bitgo/sdk-coin-zeta';
+import { Zketh, Tzketh, ZkethToken } from '@bitgo/sdk-coin-zketh';
+
 export { AbstractUtxoCoin };
 export { Algo, AlgoToken, Talgo };
 export { Arbeth, Tarbeth, ArbethToken };
@@ -92,6 +94,7 @@ export { Txrp, Xrp };
 export { Txtz, Xtz };
 export { Tzec, Zec };
 export { Tzeta, Zeta };
+export { Zketh, Tzketh, ZkethToken };
 
 import { coins } from '@bitgo/sdk-core';
 const { Ofc, OfcToken, Susd, FiatUsd, FiatEur, FiatGBP, Tsusd, TfiatUsd, TfiatEur, TfiatGBP } = coins;

modules/bitgo/tsconfig.json

@@ -176,6 +176,9 @@
     {
       "path": "../sdk-coin-zeta"
     },
+    {
+      "path": "../sdk-coin-zketh"
+    },
     {
       "path": "../sdk-core"
     },

modules/sdk-coin-zketh/.eslintignore

@@ -0,0 +1,4 @@
+node_modules
+.idea
+public
+dist

modules/sdk-coin-zketh/.gitignore

@@ -0,0 +1,3 @@
+node_modules/
+.idea/
+dist/

modules/sdk-coin-zketh/.mocharc.yml

@@ -0,0 +1,8 @@
+require: 'ts-node/register'
+timeout: 120000
+reporter: 'min'
+reporter-option:
+  - 'cdn=true'
+  - 'json=false'
+exit: true
+spec: ['test/unit/**/*.ts']

modules/sdk-coin-zketh/.npmignore

@@ -0,0 +1,14 @@
+!dist/
+dist/test/
+dist/tsconfig.tsbuildinfo
+.idea/
+.prettierrc.yml
+tsconfig.json
+src/
+test/
+scripts/
+.nyc_output
+CODEOWNERS
+node_modules/
+.prettierignore
+.mocharc.js

modules/sdk-coin-zketh/.prettierignore

@@ -0,0 +1,2 @@
+.nyc_output/
+dist/

modules/sdk-coin-zketh/.prettierrc.yml

@@ -0,0 +1,3 @@
+printWidth: 120
+singleQuote: true
+trailingComma: 'es5'

modules/sdk-coin-zketh/README.md

@@ -0,0 +1,32 @@
+# BitGo sdk-coin-zketh
+
+Integration of this coin is still a Work In Progress.
+
+SDK coins provide a modular approach to a monolithic architecture. This and all BitGoJS SDK coins allow developers to use only the coins needed for a given project.
+
+## Installation
+
+All coins are loaded traditionally through the `bitgo` package. If you are using coins individually, you will be accessing the coin via the `@bitgo/sdk-api` package.
+
+In your project install both `@bitgo/sdk-api` and `@bitgo/sdk-coin-zketh`.
+
+```shell
+npm i @bitgo/sdk-api @bitgo/sdk-coin-zketh
+```
+
+Next, you will be able to initialize an instance of "bitgo" through `@bitgo/sdk-api` instead of `bitgo`.
+
+```javascript
+import { BitGoAPI } from '@bitgo/sdk-api';
+import { Zketh } from '@bitgo/sdk-coin-zketh';
+
+const sdk = new BitGoAPI();
+
+sdk.register('zketh', Zketh.createInstance);
+```
+
+## Development
+
+Most of the coin implementations are derived from `@bitgo/sdk-core`, `@bitgo/statics`, and coin specific packages. These implementations are used to interact with the BitGo API and BitGo platform services.
+
+You will notice that the basic version of common class extensions have been provided to you and must be resolved before the package build will succeed. Upon initiation of a given SDK coin, you will need to verify that your coin has been included in the root `tsconfig.packages.json` and that the linting, formatting, and testing succeeds when run both within the coin and from the root of BitGoJS.

modules/sdk-coin-zketh/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@bitgo/sdk-coin-zketh",
+  "version": "1.0.0",
+  "description": "BitGo SDK coin library for zkSync",
+  "main": "./dist/src/index.js",
+  "types": "./dist/src/index.d.ts",
+  "scripts": {
+    "build": "yarn tsc --build --incremental --verbose .",
+    "fmt": "prettier --write .",
+    "check-fmt": "prettier --check .",
+    "clean": "rm -r ./dist",
+    "lint": "eslint --quiet .",
+    "prepare": "npm run build",
+    "test": "npm run coverage",
+    "coverage": "nyc -- npm run unit-test",
+    "unit-test": "mocha"
+  },
+  "author": "Ajay Srinivas <[email protected]>",
+  "license": "MIT",
+  "engines": {
+    "node": ">=16 <21"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/BitGo/BitGoJS.git",
+    "directory": "modules/sdk-coin-zketh"
+  },
+  "lint-staged": {
+    "*.{js,ts}": [
+      "yarn prettier --write",
+      "yarn eslint --fix"
+    ]
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "nyc": {
+    "extension": [
+      ".ts"
+    ]
+  },
+  "dependencies": {
+    "@bitgo/abstract-eth": "^10.0.0",
+    "@bitgo/sdk-core": "^17.0.0",
+    "@bitgo/statics": "^38.0.0",
+    "@ethereumjs/common": "^2.6.5",
+    "superagent": "^3.8.3"
+  },
+  "devDependencies": {
+    "@bitgo/sdk-api": "^1.33.0",
+    "@bitgo/sdk-test": "^1.2.52",
+    "secp256k1": "5.0.0"
+  }
+}

modules/sdk-coin-zketh/src/index.ts

@@ -0,0 +1,5 @@
+export * from './lib';
+export * from './zketh';
+export * from './tzketh';
+export * from './zkethToken';
+export * from './register';