feat(sdk-coin-apt): new coin generation, apt skeleton

CODEOWNERS

@@ -47,6 +47,7 @@
 /modules/abstract-cosmos/ @BitGo/ethalt-team
 /modules/sdk-coin-ada/ @BitGo/ethalt-team
 /modules/sdk-coin-algo/ @BitGo/ethalt-team
+/modules/sdk-coin-apt/ @Bitgo/ethalt-team
 /modules/sdk-coin-arbeth/ @BitGo/ethalt-team
 /modules/sdk-coin-atom/ @BitGo/ethalt-team
 /modules/sdk-coin-avaxc/ @BitGo/ethalt-team

Dockerfile

@@ -55,6 +55,7 @@ COPY --from=builder /tmp/bitgo/modules/sdk-api /var/modules/sdk-api/
 COPY --from=builder /tmp/bitgo/modules/unspents /var/modules/unspents/
 COPY --from=builder /tmp/bitgo/modules/account-lib /var/modules/account-lib/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-algo /var/modules/sdk-coin-algo/
+COPY --from=builder /tmp/bitgo/modules/sdk-coin-apt /var/modules/sdk-coin-apt/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-arbeth /var/modules/sdk-coin-arbeth/
 COPY --from=builder /tmp/bitgo/modules/abstract-eth /var/modules/abstract-eth/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-atom /var/modules/sdk-coin-atom/
@@ -126,6 +127,7 @@ cd /var/modules/sdk-api && 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-apt && 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 && \
@@ -200,6 +202,7 @@ RUN cd /var/bitgo-express && \
     yarn link @bitgo/unspents && \
     yarn link @bitgo/account-lib && \
     yarn link @bitgo/sdk-coin-algo && \
+    yarn link @bitgo/sdk-coin-apt && \
     yarn link @bitgo/sdk-coin-arbeth && \
     yarn link @bitgo/abstract-eth && \
     yarn link @bitgo/sdk-coin-atom && \

modules/bitgo/package.json

@@ -51,6 +51,7 @@
     "@bitgo/sdk-api": "^1.56.3",
     "@bitgo/sdk-coin-ada": "^4.3.4",
     "@bitgo/sdk-coin-algo": "^2.1.43",
+    "@bitgo/sdk-coin-apt": "^1.0.0",
     "@bitgo/sdk-coin-arbeth": "^21.0.37",
     "@bitgo/sdk-coin-atom": "^13.1.1",
     "@bitgo/sdk-coin-avaxc": "^5.1.6",

modules/bitgo/src/v2/coinFactory.ts

@@ -13,6 +13,7 @@ import { tokens } from '../config';
 import {
   Ada,
   Algo,
+  Apt,
   Arbeth,
   ArbethToken,
   Atom,
@@ -74,6 +75,7 @@ import {
   Ton,
   Tada,
   Talgo,
+  Tapt,
   Tarbeth,
   Tatom,
   TavaxC,
@@ -140,6 +142,7 @@ import {
 function registerCoinConstructors(globalCoinFactory: CoinFactory): void {
   globalCoinFactory.register('ada', Ada.createInstance);
   globalCoinFactory.register('algo', Algo.createInstance);
+  globalCoinFactory.register('apt', Apt.createInstance);
   globalCoinFactory.register('arbeth', Arbeth.createInstance);
   globalCoinFactory.register('atom', Atom.createInstance);
   globalCoinFactory.register('avaxc', AvaxC.createInstance);
@@ -191,6 +194,7 @@ function registerCoinConstructors(globalCoinFactory: CoinFactory): void {
   globalCoinFactory.register('tia', Tia.createInstance);
   globalCoinFactory.register('ton', Ton.createInstance);
   globalCoinFactory.register('talgo', Talgo.createInstance);
+  globalCoinFactory.register('tapt', Tapt.createInstance);
   globalCoinFactory.register('tarbeth', Tarbeth.createInstance);
   globalCoinFactory.register('tada', Tada.createInstance);
   globalCoinFactory.register('tatom', Tatom.createInstance);

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

@@ -2,6 +2,7 @@ import { AbstractUtxoCoin } from '@bitgo/abstract-utxo';
 import { AbstractLightningCoin } from '@bitgo/abstract-lightning';
 import { Ada, Tada } from '@bitgo/sdk-coin-ada';
 import { Algo, AlgoToken, Talgo } from '@bitgo/sdk-coin-algo';
+import { Apt, Tapt } from '@bitgo/sdk-coin-apt';
 import { Arbeth, Tarbeth, ArbethToken } from '@bitgo/sdk-coin-arbeth';
 import { Atom, Tatom } from '@bitgo/sdk-coin-atom';
 import { AvaxC, AvaxCToken, TavaxC } from '@bitgo/sdk-coin-avaxc';
@@ -54,6 +55,7 @@ import { Zketh, Tzketh, ZkethToken } from '@bitgo/sdk-coin-zketh';
 export { AbstractUtxoCoin };
 export { AbstractLightningCoin };
 export { Algo, AlgoToken, Talgo };
+export { Apt, Tapt };
 export { Arbeth, Tarbeth, ArbethToken };
 export { Ada, Tada };
 export { Atom, Tatom };

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

@@ -33,6 +33,8 @@ describe('Coins', () => {
       XrpToken: 1,
       Rune: 1,
       Trune: 1,
+      Apt: 1,
+      Tapt: 1,
     };
     Object.keys(BitGoJS.Coin)
       .filter((coinName) => !excludedKeys[coinName])

modules/bitgo/tsconfig.json

@@ -44,6 +44,9 @@
     {
       "path": "../sdk-coin-algo"
     },
+    {
+      "path": "../sdk-coin-apt"
+    },
     {
       "path": "../sdk-coin-arbeth"
     },

modules/sdk-coin-apt/.eslintignore

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

modules/sdk-coin-apt/.gitignore

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

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

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

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

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

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

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

modules/sdk-coin-apt/README.md

@@ -0,0 +1,30 @@
+# BitGo sdk-coin-apt
+
+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-apt`.
+
+```shell
+npm i @bitgo/sdk-api @bitgo/sdk-coin-apt
+```
+
+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 { Apt } from '@bitgo/sdk-coin-apt';
+
+const sdk = new BitGoAPI();
+
+sdk.register('apt', Apt.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-apt/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@bitgo/sdk-coin-apt",
+  "version": "1.0.0",
+  "description": "BitGo SDK coin library for APT (Aptos) coin",
+  "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 <[email protected]>",
+  "license": "MIT",
+  "engines": {
+    "node": ">=16 <21"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/BitGo/BitGoJS.git",
+    "directory": "modules/sdk-coin-apt"
+  },
+  "lint-staged": {
+    "*.{js,ts}": [
+      "yarn prettier --write",
+      "yarn eslint --fix"
+    ]
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "nyc": {
+    "extension": [
+      ".ts"
+    ]
+  },
+  "dependencies": {
+    "@bitgo/sdk-core": "^28.13.1",
+    "@bitgo/statics": "^50.6.0",
+    "bignumber.js": "^9.1.2"
+  },
+  "devDependencies": {
+    "@bitgo/sdk-api": "^1.56.3",
+    "@bitgo/sdk-test": "^8.0.50"
+  }
+}

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

@@ -0,0 +1,76 @@
+import {
+  BaseCoin,
+  BitGoBase,
+  KeyPair,
+  ParsedTransaction,
+  ParseTransactionOptions,
+  SignedTransaction,
+  SignTransactionOptions,
+  VerifyAddressOptions,
+  VerifyTransactionOptions,
+} from '@bitgo/sdk-core';
+import { BaseCoin as StaticsBaseCoin } from '@bitgo/statics';
+
+export class Apt 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 Apt(bitgo, staticsCoin);
+  }
+
+  /**
+   * Factor between the coin's base unit and its smallest subdivison
+   */
+  public getBaseFactor(): number {
+    return 1e8;
+  }
+
+  public getChain(): string {
+    return 'apt';
+  }
+
+  public getFamily(): string {
+    return 'apt';
+  }
+
+  public getFullName(): string {
+    return 'Aptos';
+  }
+
+  verifyTransaction(params: VerifyTransactionOptions): Promise<boolean> {
+    throw new Error('Method not implemented.');
+  }
+
+  isWalletAddress(params: VerifyAddressOptions): Promise<boolean> {
+    throw new Error('Method not implemented.');
+  }
+
+  parseTransaction(params: ParseTransactionOptions): Promise<ParsedTransaction> {
+    throw new Error('Method not implemented.');
+  }
+
+  generateKeyPair(seed?: Buffer): KeyPair {
+    throw new Error('Method not implemented.');
+  }
+
+  isValidPub(pub: string): boolean {
+    throw new Error('Method not implemented.');
+  }
+
+  isValidAddress(address: string): boolean {
+    throw new Error('Method not implemented.');
+  }
+
+  signTransaction(params: SignTransactionOptions): Promise<SignedTransaction> {
+    throw new Error('Method not implemented.');
+  }
+}

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

@@ -0,0 +1,4 @@
+export * from './lib';
+export * from './register';
+export * from './apt';
+export * from './tapt';

modules/sdk-coin-apt/src/lib/iface.ts

@@ -0,0 +1,6 @@
+/**
+ * The transaction data returned from the toJson() function of a transaction
+ */
+export interface TxData {
+  id: string;
+}

modules/sdk-coin-apt/src/lib/index.ts

@@ -0,0 +1,9 @@
+import * as Utils from './utils';
+import * as Interface from './iface';
+
+export { KeyPair } from './keyPair';
+export { Transaction } from './transaction';
+export { TransactionBuilder } from './transactionBuilder';
+export { TransferBuilder } from './transferBuilder';
+export { TransactionBuilderFactory } from './transactionBuilderFactory';
+export { Interface, Utils };

modules/sdk-coin-apt/src/lib/keyPair.ts

@@ -0,0 +1,23 @@
+import { DefaultKeys, Ed25519KeyPair } from '@bitgo/sdk-core';
+
+export class KeyPair extends Ed25519KeyPair {
+  /** @inheritdoc */
+  getKeys(): DefaultKeys {
+    throw new Error('Method not implemented.');
+  }
+
+  /** @inheritdoc */
+  recordKeysFromPrivateKeyInProtocolFormat(prv: string): DefaultKeys {
+    throw new Error('Method not implemented.');
+  }
+
+  /** @inheritdoc */
+  recordKeysFromPublicKeyInProtocolFormat(pub: string): DefaultKeys {
+    throw new Error('Method not implemented.');
+  }
+
+  /** @inheritdoc */
+  getAddress(): string {
+    throw new Error('Method not implemented.');
+  }
+}

modules/sdk-coin-apt/src/lib/transaction.ts

@@ -0,0 +1,16 @@
+import { BaseKey, BaseTransaction } from '@bitgo/sdk-core';
+import { TxData } from './iface';
+
+export class Transaction extends BaseTransaction {
+  canSign(key: BaseKey): boolean {
+    return false;
+  }
+
+  toBroadcastFormat(): string {
+    throw new Error('Method not implemented.');
+  }
+
+  toJson(): TxData {
+    throw new Error('Method not implemented.');
+  }
+}