Merge pull request #5093 from BitGo/WIN-3696_oas_skeleton

adarsh312 · web-flow · commit c5262dd2fb6c · 2024-11-15T10:55:20.000+05:30
feat(sdk-coin-oas): add oas sdk skeleton
diff --git a/CODEOWNERS b/CODEOWNERS
@@ -59,6 +59,7 @@
 /modules/sdk-coin-ethlike/ @BitGo/ethalt-team
 /modules/sdk-coin-hbar/ @BitGo/ethalt-team
 /modules/sdk-coin-near/ @BitGo/ethalt-team
+/modules/sdk-coin-oas/ @BitGo/ethalt-team
 /modules/sdk-coin-opeth/ @BitGo/ethalt-team
 /modules/sdk-coin-polygon/ @BitGo/ethalt-team
 /modules/sdk-coin-rune/ @BitGo/ethalt-team
diff --git a/Dockerfile b/Dockerfile
@@ -78,6 +78,7 @@ COPY --from=builder /tmp/bitgo/modules/sdk-coin-hbar /var/modules/sdk-coin-hbar/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-injective /var/modules/sdk-coin-injective/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-islm /var/modules/sdk-coin-islm/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-near /var/modules/sdk-coin-near/
+COPY --from=builder /tmp/bitgo/modules/sdk-coin-oas /var/modules/sdk-coin-oas/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-opeth /var/modules/sdk-coin-opeth/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-osmo /var/modules/sdk-coin-osmo/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-polygon /var/modules/sdk-coin-polygon/
@@ -150,6 +151,7 @@ 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-oas && 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 && \
@@ -225,6 +227,7 @@ RUN cd /var/bitgo-express && \
     yarn link @bitgo/sdk-coin-injective && \
     yarn link @bitgo/sdk-coin-islm && \
     yarn link @bitgo/sdk-coin-near && \
+    yarn link @bitgo/sdk-coin-oas && \
     yarn link @bitgo/sdk-coin-opeth && \
     yarn link @bitgo/sdk-coin-osmo && \
     yarn link @bitgo/sdk-coin-polygon && \
diff --git a/modules/account-lib/package.json b/modules/account-lib/package.json
@@ -47,6 +47,7 @@
     "@bitgo/sdk-coin-injective": "^3.0.14",
     "@bitgo/sdk-coin-islm": "^2.0.45",
     "@bitgo/sdk-coin-near": "^2.0.45",
+    "@bitgo/sdk-coin-oas": "^1.0.0",
     "@bitgo/sdk-coin-opeth": "^18.1.30",
     "@bitgo/sdk-coin-osmo": "^3.0.14",
     "@bitgo/sdk-coin-polygon": "^21.0.14",
diff --git a/modules/account-lib/src/index.ts b/modules/account-lib/src/index.ts
@@ -134,6 +134,9 @@ export { XRP };
 import * as zkEth from '@bitgo/sdk-coin-zketh';
 export { zkEth };
 
+import * as Oas from '@bitgo/sdk-coin-oas';
+export { Oas };
+
 const coinBuilderMap = {
   trx: Trx.WrappedBuilder,
   ttrx: Trx.WrappedBuilder,
@@ -204,6 +207,8 @@ const coinBuilderMap = {
   tbera: Bera.TransactionBuilder,
   rune: Rune.TransactionBuilderFactory,
   trune: Rune.TransactionBuilderFactory,
+  oas: Oas.TransactionBuilder,
+  toas: Oas.TransactionBuilder,
 };
 
 /**
diff --git a/modules/account-lib/tsconfig.json b/modules/account-lib/tsconfig.json
@@ -67,6 +67,9 @@
     {
       "path": "../sdk-coin-near"
     },
+    {
+      "path": "../sdk-coin-oas"
+    },
     {
       "path": "../sdk-coin-opeth"
     },
diff --git a/modules/bitgo/package.json b/modules/bitgo/package.json
@@ -83,6 +83,7 @@
     "@bitgo/sdk-coin-lnbtc": "^1.1.23",
     "@bitgo/sdk-coin-ltc": "^3.0.45",
     "@bitgo/sdk-coin-near": "^2.0.45",
+    "@bitgo/sdk-coin-oas": "^1.0.0",
     "@bitgo/sdk-coin-opeth": "^18.1.30",
     "@bitgo/sdk-coin-osmo": "^3.0.14",
     "@bitgo/sdk-coin-polygon": "^21.0.14",
diff --git a/modules/bitgo/src/v2/coinFactory.ts b/modules/bitgo/src/v2/coinFactory.ts
@@ -57,6 +57,7 @@ import {
   Lnbtc,
   Ltc,
   Ofc,
+  Oas,
   OfcToken,
   Opeth,
   OpethToken,
@@ -109,6 +110,7 @@ import {
   Tislm,
   Tlnbtc,
   Tltc,
+  Toas,
   Tosmo,
   Topeth,
   Tpolygon,
@@ -180,6 +182,7 @@ function registerCoinConstructors(globalCoinFactory: CoinFactory): void {
   globalCoinFactory.register('injective', Injective.createInstance);
   globalCoinFactory.register('islm', Islm.createInstance);
   globalCoinFactory.register('near', Near.createInstance);
+  globalCoinFactory.register('oas', Oas.createInstance);
   globalCoinFactory.register('ofc', Ofc.createInstance);
   globalCoinFactory.register('opeth', Opeth.createInstance);
   globalCoinFactory.register('osmo', Osmo.createInstance);
@@ -230,6 +233,7 @@ function registerCoinConstructors(globalCoinFactory: CoinFactory): void {
   globalCoinFactory.register('tlnbtc', Tlnbtc.createInstance);
   globalCoinFactory.register('tltc', Tltc.createInstance);
   globalCoinFactory.register('tnear', TNear.createInstance);
+  globalCoinFactory.register('toas', Toas.createInstance);
   globalCoinFactory.register('topeth', Topeth.createInstance);
   globalCoinFactory.register('tosmo', Tosmo.createInstance);
   globalCoinFactory.register('tpolygon', Tpolygon.createInstance);
diff --git a/modules/bitgo/src/v2/coins/index.ts b/modules/bitgo/src/v2/coins/index.ts
@@ -33,6 +33,7 @@ import { Injective, Tinjective } from '@bitgo/sdk-coin-injective';
 import { Islm, Tislm } from '@bitgo/sdk-coin-islm';
 import { Lnbtc, Tlnbtc } from '@bitgo/sdk-coin-lnbtc';
 import { Ltc, Tltc } from '@bitgo/sdk-coin-ltc';
+import { Oas, Toas } from '@bitgo/sdk-coin-oas';
 import { Opeth, Topeth, OpethToken } from '@bitgo/sdk-coin-opeth';
 import { Osmo, Tosmo } from '@bitgo/sdk-coin-osmo';
 import { Polygon, PolygonToken, Tpolygon } from '@bitgo/sdk-coin-polygon';
@@ -84,6 +85,7 @@ export { Hash, Thash };
 export { Hbar, Thbar };
 export { Lnbtc, Tlnbtc };
 export { Ltc, Tltc };
+export { Oas, Toas };
 export { Opeth, Topeth, OpethToken };
 export { Osmo, Tosmo };
 export { Polygon, PolygonToken, Tpolygon };
diff --git a/modules/bitgo/tsconfig.json b/modules/bitgo/tsconfig.json
@@ -140,6 +140,9 @@
     {
       "path": "../sdk-coin-near"
     },
+    {
+      "path": "../sdk-coin-oas"
+    },
     {
       "path": "../sdk-coin-opeth"
     },
diff --git a/modules/sdk-coin-bsc/src/lib/transactionBuilder.ts b/modules/sdk-coin-bsc/src/lib/transactionBuilder.ts
@@ -23,8 +23,4 @@ export class TransactionBuilder extends AbstractTransactionBuilder {
     }
     return this._transfer;
   }
-
-  protected getContractData(addresses: string[]): string {
-    throw new Error('Method not implemented.');
-  }
 }
diff --git a/modules/sdk-coin-oas/.eslintignore b/modules/sdk-coin-oas/.eslintignore
@@ -0,0 +1,5 @@
+node_modules
+.idea
+public
+dist
+
diff --git a/modules/sdk-coin-oas/.gitignore b/modules/sdk-coin-oas/.gitignore
@@ -0,0 +1,3 @@
+node_modules/
+.idea/
+dist/
diff --git a/modules/sdk-coin-oas/.mocharc.yml b/modules/sdk-coin-oas/.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']
diff --git a/modules/sdk-coin-oas/.npmignore b/modules/sdk-coin-oas/.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
diff --git a/modules/sdk-coin-oas/.prettierignore b/modules/sdk-coin-oas/.prettierignore
@@ -0,0 +1,2 @@
+.nyc_output/
+dist/
diff --git a/modules/sdk-coin-oas/.prettierrc.yml b/modules/sdk-coin-oas/.prettierrc.yml
@@ -0,0 +1,3 @@
+printWidth: 120
+singleQuote: true
+trailingComma: 'es5'
diff --git a/modules/sdk-coin-oas/README.md b/modules/sdk-coin-oas/README.md
@@ -0,0 +1,30 @@
+# BitGo sdk-coin-oas
+
+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-oas`.
+
+```shell
+npm i @bitgo/sdk-api @bitgo/sdk-coin-oas
+```
+
+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 { Oas } from '@bitgo/sdk-coin-oas';
+
+const sdk = new BitGoAPI();
+
+sdk.register('oas', Oas.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.
diff --git a/modules/sdk-coin-oas/package.json b/modules/sdk-coin-oas/package.json
@@ -0,0 +1,52 @@
+{
+  "name": "@bitgo/sdk-coin-oas",
+  "version": "1.0.0",
+  "description": "BitGo SDK coin library for Oasys",
+  "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": ">=18 <21"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/BitGo/BitGoJS.git",
+    "directory": "modules/sdk-coin-oas"
+  },
+  "lint-staged": {
+    "*.{js,ts}": [
+      "yarn prettier --write",
+      "yarn eslint --fix"
+    ]
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "nyc": {
+    "extension": [
+      ".ts"
+    ]
+  },
+  "dependencies": {
+    "@bitgo/abstract-eth": "^22.3.1",
+    "@bitgo/sdk-core": "^28.13.1",
+    "@bitgo/statics": "^50.6.0",
+    "@ethereumjs/common": "^2.6.5"
+  },
+  "devDependencies": {
+    "@bitgo/sdk-api": "^1.56.3",
+    "@bitgo/sdk-test": "^8.0.50"
+  }
+}
diff --git a/modules/sdk-coin-oas/src/index.ts b/modules/sdk-coin-oas/src/index.ts
@@ -0,0 +1,4 @@
+export * from './lib';
+export * from './oas';
+export * from './toas';
+export * from './register';
diff --git a/modules/sdk-coin-oas/src/lib/index.ts b/modules/sdk-coin-oas/src/lib/index.ts
@@ -0,0 +1,6 @@
+import * as Utils from './utils';
+
+export { TransactionBuilder } from './transactionBuilder';
+export { TransferBuilder } from './transferBuilder';
+export { Transaction, KeyPair } from '@bitgo/abstract-eth';
+export { Utils };
diff --git a/modules/sdk-coin-oas/src/lib/resources.ts b/modules/sdk-coin-oas/src/lib/resources.ts
@@ -0,0 +1,28 @@
+import EthereumCommon from '@ethereumjs/common';
+import { coins, EthereumNetwork } from '@bitgo/statics';
+
+export const testnetCommon = EthereumCommon.custom(
+  {
+    name: 'oas testnet',
+    networkId: (coins.get('toas').network as EthereumNetwork).chainId,
+    chainId: (coins.get('toas').network as EthereumNetwork).chainId,
+  },
+  {
+    baseChain: 'sepolia',
+    hardfork: 'london',
+    eips: [1559],
+  }
+);
+
+export const mainnetCommon = EthereumCommon.custom(
+  {
+    name: 'oas mainnet',
+    networkId: (coins.get('oas').network as EthereumNetwork).chainId,
+    chainId: (coins.get('oas').network as EthereumNetwork).chainId,
+  },
+  {
+    baseChain: 'mainnet',
+    hardfork: 'london',
+    eips: [1559],
+  }
+);
diff --git a/modules/sdk-coin-oas/src/lib/transactionBuilder.ts b/modules/sdk-coin-oas/src/lib/transactionBuilder.ts
@@ -0,0 +1,30 @@
+import { BaseCoin as CoinConfig } from '@bitgo/statics';
+import { BuildTransactionError, TransactionType } from '@bitgo/sdk-core';
+import { TransactionBuilder as AbstractTransactionBuilder, Transaction } from '@bitgo/abstract-eth';
+import { getCommon } from './utils';
+import { TransferBuilder } from './transferBuilder';
+
+export class TransactionBuilder extends AbstractTransactionBuilder {
+  protected _transfer: TransferBuilder;
+
+  constructor(_coinConfig: Readonly<CoinConfig>) {
+    super(_coinConfig);
+    this._common = getCommon(this._coinConfig.network.type);
+    this.transaction = new Transaction(this._coinConfig, this._common);
+  }
+
+  /** @inheritdoc */
+  transfer(data?: string): TransferBuilder {
+    if (this._type !== TransactionType.Send) {
+      throw new BuildTransactionError('Transfers can only be set for send transactions');
+    }
+    if (!this._transfer) {
+      this._transfer = new TransferBuilder(data);
+    }
+    return this._transfer;
+  }
+
+  protected getContractData(addresses: string[]): string {
+    throw new Error('Method not implemented.');
+  }
+}
diff --git a/modules/sdk-coin-oas/src/lib/transferBuilder.ts b/modules/sdk-coin-oas/src/lib/transferBuilder.ts
@@ -0,0 +1 @@
+export { TransferBuilder } from '@bitgo/abstract-eth';
diff --git a/modules/sdk-coin-oas/src/lib/utils.ts b/modules/sdk-coin-oas/src/lib/utils.ts
@@ -0,0 +1,21 @@
+import { NetworkType } from '@bitgo/statics';
+import EthereumCommon from '@ethereumjs/common';
+import { InvalidTransactionError } from '@bitgo/sdk-core';
+import { testnetCommon, mainnetCommon } from './resources';
+
+const commons: Map<NetworkType, EthereumCommon> = new Map<NetworkType, EthereumCommon>([
+  [NetworkType.MAINNET, mainnetCommon],
+  [NetworkType.TESTNET, testnetCommon],
+]);
+
+/**
+ * @param {NetworkType} network either mainnet or testnet
+ * @returns {EthereumCommon} Ethereum common configuration object
+ */
+export function getCommon(network: NetworkType): EthereumCommon {
+  const common = commons.get(network);
+  if (!common) {
+    throw new InvalidTransactionError('Missing network common configuration');
+  }
+  return common;
+}
diff --git a/modules/sdk-coin-oas/src/oas.ts b/modules/sdk-coin-oas/src/oas.ts
diff --git a/modules/sdk-coin-oas/src/register.ts b/modules/sdk-coin-oas/src/register.ts
diff --git a/modules/sdk-coin-oas/src/toas.ts b/modules/sdk-coin-oas/src/toas.ts
diff --git a/modules/sdk-coin-oas/test/unit/getBuilder.ts b/modules/sdk-coin-oas/test/unit/getBuilder.ts
diff --git a/modules/sdk-coin-oas/test/unit/oas.ts b/modules/sdk-coin-oas/test/unit/oas.ts
diff --git a/modules/sdk-coin-oas/test/unit/transactionBuilder/send.ts b/modules/sdk-coin-oas/test/unit/transactionBuilder/send.ts
diff --git a/modules/sdk-coin-oas/test/unit/utils.ts b/modules/sdk-coin-oas/test/unit/utils.ts
diff --git a/modules/sdk-coin-oas/tsconfig.json b/modules/sdk-coin-oas/tsconfig.json
diff --git a/modules/sdk-core/src/bitgo/environments.ts b/modules/sdk-core/src/bitgo/environments.ts
diff --git a/modules/statics/src/networks.ts b/modules/statics/src/networks.ts
diff --git a/tsconfig.packages.json b/tsconfig.packages.json

Original file line number	Diff line number	Diff line change
`@@ -67,6 +67,9 @@`
`67`	`67`	`{`
`68`	`68`	`"path": "../sdk-coin-near"`
`69`	`69`	`},`
	`70`	`+ {`
	`71`	`+ "path": "../sdk-coin-oas"`
	`72`	`+ },`
`70`	`73`	`{`
`71`	`74`	`"path": "../sdk-coin-opeth"`
`72`	`75`	`},`
Original file line number	Diff line number	Diff line change
`@@ -140,6 +140,9 @@`
`140`	`140`	`{`
`141`	`141`	`"path": "../sdk-coin-near"`
`142`	`142`	`},`
	`143`	`+ {`
	`144`	`+ "path": "../sdk-coin-oas"`
	`145`	`+ },`
`143`	`146`	`{`
`144`	`147`	`"path": "../sdk-coin-opeth"`
`145`	`148`	`},`
Original file line number	Diff line number	Diff line change
`@@ -23,8 +23,4 @@ export class TransactionBuilder extends AbstractTransactionBuilder {`
`23`	`23`	`}`
`24`	`24`	`return this._transfer;`
`25`	`25`	`}`
`26`		`-`
`27`		`- protected getContractData(addresses: string[]): string {`
`28`		`- throw new Error('Method not implemented.');`
`29`		`- }`
`30`	`26`	`}`