feat(sdk-coin-starknet): scaffold @bitgo/sdk-coin-starknet package

Dockerfile

@@ -140,6 +140,7 @@ COPY --from=builder /tmp/bitgo/modules/sdk-coin-ethw /var/modules/sdk-coin-ethw/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-iota /var/modules/sdk-coin-iota/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-lnbtc /var/modules/sdk-coin-lnbtc/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-ltc /var/modules/sdk-coin-ltc/
+COPY --from=builder /tmp/bitgo/modules/sdk-coin-starknet /var/modules/sdk-coin-starknet/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-xlm /var/modules/sdk-coin-xlm/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-zec /var/modules/sdk-coin-zec/
 
@@ -242,6 +243,7 @@ cd /var/modules/sdk-coin-ethw && yarn link && \
 cd /var/modules/sdk-coin-iota && yarn link && \
 cd /var/modules/sdk-coin-lnbtc && yarn link && \
 cd /var/modules/sdk-coin-ltc && yarn link && \
+cd /var/modules/sdk-coin-starknet && yarn link && \
 cd /var/modules/sdk-coin-xlm && yarn link && \
 cd /var/modules/sdk-coin-zec && yarn link
 #COPY_END
@@ -347,6 +349,7 @@ RUN cd /var/bitgo-express && \
     yarn link @bitgo/sdk-coin-iota && \
     yarn link @bitgo/sdk-coin-lnbtc && \
     yarn link @bitgo/sdk-coin-ltc && \
+    yarn link @bitgo/sdk-coin-starknet && \
     yarn link @bitgo/sdk-coin-xlm && \
     yarn link @bitgo/sdk-coin-zec
 #LINK_END

modules/bitgo/package.json

@@ -107,6 +107,7 @@
     "@bitgo/sdk-coin-sgb": "^1.8.7",
     "@bitgo/sdk-coin-sol": "^7.19.2",
     "@bitgo/sdk-coin-soneium": "^1.10.7",
+    "@bitgo/sdk-coin-starknet": "^1.0.0",
     "@bitgo/sdk-coin-stt": "^1.6.7",
     "@bitgo/sdk-coin-stx": "^3.12.7",
     "@bitgo/sdk-coin-sui": "^5.23.6",

modules/bitgo/src/v2/coinFactory.ts

@@ -127,6 +127,7 @@ import {
   Sol,
   Soneium,
   SoneiumToken,
+  Starknet,
   StellarToken,
   Stx,
   Sui,
@@ -298,6 +299,7 @@ export function registerCoinConstructors(coinFactory: CoinFactory, coinMap: Coin
   coinFactory.register('sgb', Sgb.createInstance);
   coinFactory.register('sol', Sol.createInstance);
   coinFactory.register('soneium', Soneium.createInstance);
+  coinFactory.register('starknet', Starknet.createInstance);
   coinFactory.register('stx', Stx.createInstance);
   coinFactory.register('sui', Sui.createInstance);
   coinFactory.register('susd', Susd.createInstance);
@@ -363,6 +365,7 @@ export function registerCoinConstructors(coinFactory: CoinFactory, coinMap: Coin
   coinFactory.register('tsei', Tsei.createInstance);
   coinFactory.register('tsol', Tsol.createInstance);
   coinFactory.register('tsoneium', Tsoneium.createInstance);
+  coinFactory.register('tstarknet', Starknet.createInstance);
   coinFactory.register('tstx', Tstx.createInstance);
   coinFactory.register('tstt', Tstt.createInstance);
   coinFactory.register('tsui', Tsui.createInstance);
@@ -735,6 +738,8 @@ export function getCoinConstructor(coinName: string): CoinConstructor | undefine
       return Sol.createInstance;
     case 'soneium':
       return Soneium.createInstance;
+    case 'starknet':
+      return Starknet.createInstance;
     case 'stx':
       return Stx.createInstance;
     case 'sui':
@@ -865,6 +870,8 @@ export function getCoinConstructor(coinName: string): CoinConstructor | undefine
       return Tsol.createInstance;
     case 'tsoneium':
       return Tsoneium.createInstance;
+    case 'tstarknet':
+      return Starknet.createInstance;
     case 'tstx':
       return Tstx.createInstance;
     case 'tstt':

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

@@ -56,6 +56,7 @@ import { Rbtc, Trbtc } from '@bitgo/sdk-coin-rbtc';
 import { Rune, Trune } from '@bitgo/sdk-coin-rune';
 import { Sei, Tsei } from '@bitgo/sdk-coin-sei';
 import { Soneium, Tsoneium, SoneiumToken } from '@bitgo/sdk-coin-soneium';
+import { Starknet } from '@bitgo/sdk-coin-starknet';
 import { Tstt } from '@bitgo/sdk-coin-stt';
 import { Sgb, Tsgb } from '@bitgo/sdk-coin-sgb';
 import { Sol, Tsol } from '@bitgo/sdk-coin-sol';
@@ -133,6 +134,7 @@ export { Rune, Trune };
 export { Sgb, Tsgb };
 export { Sol, Tsol };
 export { Soneium, Tsoneium, SoneiumToken };
+export { Starknet };
 export { Tstt };
 export { Stx, Tstx, Sip10Token };
 export { Sui, Tsui, SuiToken };

modules/bitgo/test/browser/browser.spec.ts

@@ -61,6 +61,7 @@ describe('Coins', () => {
       MonToken: 1,
       XdcToken: 1,
       JettonToken: 1,
+      Starknet: 1,
       Tip20Token: 1,
       Fiat: 1,
       allFiatCoins: 1,

modules/bitgo/tsconfig.json

@@ -230,6 +230,9 @@
     {
       "path": "../sdk-coin-sol"
     },
+    {
+      "path": "../sdk-coin-starknet"
+    },
     {
       "path": "../sdk-coin-stx"
     },

modules/sdk-coin-starknet/.eslintignore

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

modules/sdk-coin-starknet/.gitignore

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

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

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

modules/sdk-coin-starknet/.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-starknet/.prettierignore

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

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

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

modules/sdk-coin-starknet/README.md

@@ -0,0 +1,32 @@
+# BitGo sdk-coin-starknet
+
+BitGo SDK coin library for [Starknet](https://www.starknet.io/) — a ZK-rollup L2 secured by Ethereum.
+
+Native Starknet accounts at BitGo use OpenZeppelin's `EthAccountUpgradeable` contract, which validates secp256k1 ECDSA signatures on-chain via Cairo's `secp256k1_get_point_from_x_syscall`. This lets BitGo reuse its existing 2-of-3 ECDSA TSS (the same protocol used for Bitcoin, Ethereum, ICP) with no new cryptographic work.
+
+## 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-starknet`.
+
+```shell
+npm i @bitgo/sdk-api @bitgo/sdk-coin-starknet
+```
+
+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 { Starknet } from '@bitgo/sdk-coin-starknet';
+
+const sdk = new BitGoAPI();
+
+sdk.register('starknet', Starknet.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.
+
+This package currently provides only the coin-class scaffold. Address derivation, transaction building, signing, and RPC client are tracked in follow-up tickets.

modules/sdk-coin-starknet/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@bitgo/sdk-coin-starknet",
+  "version": "1.0.0",
+  "description": "BitGo SDK coin library for Starknet",
+  "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": "BitGo SDK Team <sdkteam@bitgo.com>",
+  "license": "MIT",
+  "engines": {
+    "node": ">=20"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/BitGo/BitGoJS.git",
+    "directory": "modules/sdk-coin-starknet"
+  },
+  "lint-staged": {
+    "*.{js,ts}": [
+      "yarn prettier --write",
+      "yarn eslint --fix"
+    ]
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "nyc": {
+    "extension": [
+      ".ts"
+    ]
+  },
+  "dependencies": {
+    "@bitgo/sdk-core": "^36.44.0",
+    "@bitgo/sdk-lib-mpc": "^10.12.0",
+    "@bitgo/statics": "^58.39.0"
+  },
+  "devDependencies": {
+    "@bitgo/sdk-api": "^1.79.2",
+    "@bitgo/sdk-test": "^9.1.42"
+  }
+}

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

@@ -0,0 +1,2 @@
+export * from './register';
+export * from './starknet';

modules/sdk-coin-starknet/src/register.ts

@@ -0,0 +1,7 @@
+import { BitGoBase } from '@bitgo/sdk-core';
+import { Starknet } from './starknet';
+
+export const register = (sdk: BitGoBase): void => {
+  sdk.register('starknet', Starknet.createInstance);
+  sdk.register('tstarknet', Starknet.createInstance);
+};

modules/sdk-coin-starknet/src/starknet.ts

@@ -0,0 +1,113 @@
+import {
+  AuditDecryptedKeyParams,
+  BaseCoin,
+  BitGoBase,
+  KeyPair,
+  MPCAlgorithm,
+  MultisigType,
+  multisigTypes,
+  ParsedTransaction,
+  ParseTransactionOptions,
+  SignedTransaction,
+  SignTransactionOptions,
+  VerifyAddressOptions,
+  VerifyTransactionOptions,
+} from '@bitgo/sdk-core';
+import { auditEcdsaPrivateKey } from '@bitgo/sdk-lib-mpc';
+import { BaseCoin as StaticsBaseCoin } from '@bitgo/statics';
+
+export class Starknet extends BaseCoin {
+  protected readonly _staticsCoin: Readonly<StaticsBaseCoin>;
+
+  protected constructor(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>) {
+    super(bitgo);
+
+    if (!staticsCoin) {
+      throw new Error('missing required constructor parameter staticsCoin');
+    }
+
+    this._staticsCoin = staticsCoin;
+  }
+
+  static createInstance(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>): BaseCoin {
+    return new Starknet(bitgo, staticsCoin);
+  }
+
+  /** @inheritDoc */
+  public getBaseFactor(): number {
+    return Math.pow(10, this._staticsCoin.decimalPlaces);
+  }
+
+  /** @inheritDoc */
+  public getChain(): string {
+    return this._staticsCoin.name;
+  }
+
+  /** @inheritDoc */
+  public getFamily(): string {
+    return this._staticsCoin.family;
+  }
+
+  /** @inheritDoc */
+  public getFullName(): string {
+    return this._staticsCoin.fullName;
+  }
+
+  /** @inheritDoc */
+  supportsTss(): boolean {
+    return true;
+  }
+
+  /** @inheritDoc */
+  getDefaultMultisigType(): MultisigType {
+    return multisigTypes.tss;
+  }
+
+  /** @inheritDoc */
+  getMPCAlgorithm(): MPCAlgorithm {
+    return 'ecdsa';
+  }
+
+  /** @inheritDoc */
+  verifyTransaction(params: VerifyTransactionOptions): Promise<boolean> {
+    throw new Error('Method not implemented.');
+  }
+
+  /** @inheritDoc */
+  isWalletAddress(params: VerifyAddressOptions): Promise<boolean> {
+    throw new Error('Method not implemented.');
+  }
+
+  /** @inheritDoc */
+  parseTransaction(params: ParseTransactionOptions): Promise<ParsedTransaction> {
+    throw new Error('Method not implemented.');
+  }
+
+  /** @inheritDoc */
+  generateKeyPair(seed?: Buffer): KeyPair {
+    throw new Error('Method not implemented.');
+  }
+
+  /** @inheritDoc */
+  isValidPub(pub: string): boolean {
+    throw new Error('Method not implemented.');
+  }
+
+  /** @inheritDoc */
+  isValidAddress(address: string): boolean {
+    throw new Error('Method not implemented.');
+  }
+
+  /** @inheritDoc */
+  signTransaction(params: SignTransactionOptions): Promise<SignedTransaction> {
+    throw new Error('Method not implemented.');
+  }
+
+  /** @inheritDoc */
+  auditDecryptedKey({ multiSigType, prv, publicKey }: AuditDecryptedKeyParams): void {
+    if (multiSigType !== 'tss') {
+      throw new Error('Unsupported multiSigType');
+    }
+    auditEcdsaPrivateKey(prv, publicKey ?? '');
+  }
+}

modules/sdk-coin-starknet/test/unit/index.ts

@@ -0,0 +1,35 @@
+import 'should';
+import { BitGoAPI } from '@bitgo/sdk-api';
+import { TestBitGo, TestBitGoAPI } from '@bitgo/sdk-test';
+import { Starknet } from '../../src';
+
+describe('Starknet:', function () {
+  let bitgo: TestBitGoAPI;
+
+  before(function () {
+    bitgo = TestBitGo.decorate(BitGoAPI, { env: 'mock' });
+    bitgo.safeRegister('starknet', Starknet.createInstance);
+    bitgo.safeRegister('tstarknet', Starknet.createInstance);
+    bitgo.initializeTestVars();
+  });
+
+  it('should retrieve the mainnet coin', function () {
+    const coin = bitgo.coin('starknet');
+    coin.getChain().should.equal('starknet');
+    coin.getFamily().should.equal('starknet');
+    coin.getFullName().should.equal('Starknet');
+    coin.getBaseFactor().should.equal(1e18);
+    coin.supportsTss().should.equal(true);
+    coin.getMPCAlgorithm().should.equal('ecdsa');
+  });
+
+  it('should retrieve the testnet coin', function () {
+    const coin = bitgo.coin('tstarknet');
+    coin.getChain().should.equal('tstarknet');
+    coin.getFamily().should.equal('starknet');
+    coin.getFullName().should.equal('Testnet Starknet');
+    coin.getBaseFactor().should.equal(1e18);
+    coin.supportsTss().should.equal(true);
+    coin.getMPCAlgorithm().should.equal('ecdsa');
+  });
+});