Merge pull request #6001 from BitGo/WIN-5031-worldchain-txn-builder

yogeshwar-bitgo · web-flow · commit 9a99cdeb8a16 · 2025-04-23T14:43:12.000+05:30
feat(sdk-coin-world): add transaction builder
diff --git a/CODEOWNERS b/CODEOWNERS
@@ -80,6 +80,7 @@
 /modules/sdk-coin-ton/ @BitGo/ethalt-team
 /modules/sdk-coin-trx/ @BitGo/ethalt-team
 /modules/sdk-coin-wemix/ @BitGo/ethalt-team
+/modules/sdk-coin-world/ @BitGo/ethalt-team
 /modules/sdk-coin-xdc/ @BitGo/ethalt-team
 /modules/sdk-coin-xlm/ @BitGo/ethalt-team
 /modules/sdk-coin-xrp/ @BitGo/ethalt-team
diff --git a/Dockerfile b/Dockerfile
@@ -101,6 +101,7 @@ COPY --from=builder /tmp/bitgo/modules/sdk-coin-tia /var/modules/sdk-coin-tia/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-ton /var/modules/sdk-coin-ton/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-trx /var/modules/sdk-coin-trx/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-wemix /var/modules/sdk-coin-wemix/
+COPY --from=builder /tmp/bitgo/modules/sdk-coin-world /var/modules/sdk-coin-world/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-xdc /var/modules/sdk-coin-xdc/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-xrp /var/modules/sdk-coin-xrp/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-xtz /var/modules/sdk-coin-xtz/
@@ -187,6 +188,7 @@ 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-wemix && yarn link && \
+cd /var/modules/sdk-coin-world && yarn link && \
 cd /var/modules/sdk-coin-xdc && yarn link && \
 cd /var/modules/sdk-coin-xrp && yarn link && \
 cd /var/modules/sdk-coin-xtz && yarn link && \
@@ -276,6 +278,7 @@ RUN cd /var/bitgo-express && \
     yarn link @bitgo/sdk-coin-ton && \
     yarn link @bitgo/sdk-coin-trx && \
     yarn link @bitgo/sdk-coin-wemix && \
+    yarn link @bitgo/sdk-coin-world && \
     yarn link @bitgo/sdk-coin-xdc && \
     yarn link @bitgo/sdk-coin-xrp && \
     yarn link @bitgo/sdk-coin-xtz && \
diff --git a/modules/account-lib/package.json b/modules/account-lib/package.json
@@ -68,6 +68,7 @@
     "@bitgo/sdk-coin-ton": "^3.4.33",
     "@bitgo/sdk-coin-trx": "^2.0.76",
     "@bitgo/sdk-coin-wemix": "^1.2.0",
+    "@bitgo/sdk-coin-world": "^1.0.0",
     "@bitgo/sdk-coin-xdc": "^1.2.0",
     "@bitgo/sdk-coin-xrp": "^3.7.18",
     "@bitgo/sdk-coin-xtz": "^2.2.7",
diff --git a/modules/account-lib/src/index.ts b/modules/account-lib/src/index.ts
@@ -167,6 +167,9 @@ export { Xdc };
 import * as Wemix from '@bitgo/sdk-coin-wemix';
 export { Wemix };
 
+import * as World from '@bitgo/sdk-coin-world';
+export { World };
+
 const coinBuilderMap = {
   trx: Trx.WrappedBuilder,
   ttrx: Trx.WrappedBuilder,
@@ -261,6 +264,8 @@ const coinBuilderMap = {
   tmantra: Mantra.TransactionBuilder,
   mon: Mon.TransactionBuilder,
   tmon: Mon.TransactionBuilder,
+  world: World.TransactionBuilder,
+  tworld: World.TransactionBuilder,
 };
 
 /**
diff --git a/modules/account-lib/tsconfig.json b/modules/account-lib/tsconfig.json
@@ -112,6 +112,9 @@
     {
       "path": "../sdk-coin-wemix"
     },
+    {
+      "path": "../sdk-coin-world"
+    },
     {
       "path": "../sdk-coin-xdc"
     },
diff --git a/modules/bitgo/package.json b/modules/bitgo/package.json
@@ -105,6 +105,7 @@
     "@bitgo/sdk-coin-ton": "^3.4.33",
     "@bitgo/sdk-coin-trx": "^2.0.76",
     "@bitgo/sdk-coin-wemix": "^1.2.0",
+    "@bitgo/sdk-coin-world": "^1.0.0",
     "@bitgo/sdk-coin-xdc": "^1.2.0",
     "@bitgo/sdk-coin-xlm": "^3.2.50",
     "@bitgo/sdk-coin-xrp": "^3.7.18",
diff --git a/modules/bitgo/src/v2/coinFactory.ts b/modules/bitgo/src/v2/coinFactory.ts
@@ -144,6 +144,7 @@ import {
   Tsui,
   Tsusd,
   Twemix,
+  Tworld,
   Ttao,
   Ttia,
   Tton,
@@ -156,6 +157,7 @@ import {
   Tzeta,
   Tzketh,
   Wemix,
+  World,
   Xdc,
   Xlm,
   Xrp,
@@ -302,11 +304,13 @@ function registerCoinConstructors(globalCoinFactory: CoinFactory): void {
   globalCoinFactory.register('tzeta', Tzeta.createInstance);
   globalCoinFactory.register('tzketh', Tzketh.createInstance);
   globalCoinFactory.register('twemix', Twemix.createInstance);
+  globalCoinFactory.register('tworld', Tworld.createInstance);
   globalCoinFactory.register('xdc', Xdc.createInstance);
   globalCoinFactory.register('xlm', Xlm.createInstance);
   globalCoinFactory.register('xrp', Xrp.createInstance);
   globalCoinFactory.register('xtz', Xtz.createInstance);
   globalCoinFactory.register('wemix', Wemix.createInstance);
+  globalCoinFactory.register('world', World.createInstance);
   globalCoinFactory.register('zec', Zec.createInstance);
   globalCoinFactory.register('zeta', Zeta.createInstance);
   globalCoinFactory.register('zketh', Zketh.createInstance);
diff --git a/modules/bitgo/src/v2/coins/index.ts b/modules/bitgo/src/v2/coins/index.ts
@@ -56,6 +56,7 @@ import { Ton, Tton } from '@bitgo/sdk-coin-ton';
 import { Trx, Ttrx } from '@bitgo/sdk-coin-trx';
 import { StellarToken, Txlm, Xlm } from '@bitgo/sdk-coin-xlm';
 import { Wemix, Twemix } from '@bitgo/sdk-coin-wemix';
+import { World, Tworld } from '@bitgo/sdk-coin-world';
 import { Xdc, Txdc } from '@bitgo/sdk-coin-xdc';
 import { Txrp, Xrp, XrpToken } from '@bitgo/sdk-coin-xrp';
 import { Txtz, Xtz } from '@bitgo/sdk-coin-xtz';
@@ -126,6 +127,7 @@ export { Txtz, Xtz };
 export { Tzec, Zec };
 export { Tzeta, Zeta };
 export { Wemix, Twemix };
+export { World, Tworld };
 export { Zketh, Tzketh, ZkethToken };
 
 import { coins } from '@bitgo/sdk-core';
diff --git a/modules/sdk-coin-world/.eslintignore b/modules/sdk-coin-world/.eslintignore
@@ -0,0 +1,5 @@
+node_modules
+.idea
+public
+dist
+
diff --git a/modules/sdk-coin-world/.gitignore b/modules/sdk-coin-world/.gitignore
@@ -0,0 +1,3 @@
+node_modules/
+.idea/
+dist/
diff --git a/modules/sdk-coin-world/.mocharc.yml b/modules/sdk-coin-world/.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-world/.npmignore b/modules/sdk-coin-world/.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-world/.prettierignore b/modules/sdk-coin-world/.prettierignore
@@ -0,0 +1,2 @@
+.nyc_output/
+dist/
diff --git a/modules/sdk-coin-world/.prettierrc.yml b/modules/sdk-coin-world/.prettierrc.yml
@@ -0,0 +1,3 @@
+printWidth: 120
+singleQuote: true
+trailingComma: 'es5'
diff --git a/modules/sdk-coin-world/CHANGELOG.md b/modules/sdk-coin-world/CHANGELOG.md
@@ -0,0 +1,10 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+### Bug Fixes
+
+**Note:** Version bump only for package @bitgo/sdk-coin-world
+
+### Features
diff --git a/modules/sdk-coin-world/README.md b/modules/sdk-coin-world/README.md
@@ -0,0 +1,29 @@
+# BitGo sdk-coin-world
+
+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-world`.
+
+````shell
+npm i @bitgo/sdk-api @bitgo/sdk-coin-world```
+
+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 { world } from '@bitgo/sdk-coin-world';
+
+const sdk = new BitGoAPI();
+
+sdk.register('world', World.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-world/package.json b/modules/sdk-coin-world/package.json
@@ -0,0 +1,52 @@
+{
+  "name": "@bitgo/sdk-coin-world",
+  "version": "1.0.0",
+  "description": "BitGo SDK coin library for World",
+  "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-world"
+  },
+  "lint-staged": {
+    "*.{js,ts}": [
+      "yarn prettier --write",
+      "yarn eslint --fix"
+    ]
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "nyc": {
+    "extension": [
+      ".ts"
+    ]
+  },
+  "dependencies": {
+    "@bitgo/abstract-eth": "^24.2.0",
+    "@bitgo/sdk-core": "^32.2.0",
+    "@bitgo/statics": "^51.8.0",
+    "@ethereumjs/common": "^2.6.5"
+  },
+  "devDependencies": {
+    "@bitgo/sdk-api": "^1.62.0",
+    "@bitgo/sdk-test": "^8.0.81"
+  }
+}
diff --git a/modules/sdk-coin-world/src/index.ts b/modules/sdk-coin-world/src/index.ts
@@ -0,0 +1,4 @@
+export * from './lib';
+export * from './world';
+export * from './tworld';
+export * from './register';
diff --git a/modules/sdk-coin-world/src/lib/index.ts b/modules/sdk-coin-world/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-world/src/lib/resources.ts b/modules/sdk-coin-world/src/lib/resources.ts
@@ -0,0 +1,27 @@
+import EthereumCommon from '@ethereumjs/common';
+import { coins, EthereumNetwork } from '@bitgo/statics';
+
+export const testnetCommon = EthereumCommon.custom(
+  {
+    name: 'world testnet',
+    networkId: (coins.get('tworld').network as EthereumNetwork).chainId,
+    chainId: (coins.get('tworld').network as EthereumNetwork).chainId,
+  },
+  {
+    baseChain: 'sepolia',
+    hardfork: 'london',
+    eips: [1559],
+  }
+);
+export const mainnetCommon = EthereumCommon.custom(
+  {
+    name: 'World mainnet',
+    networkId: (coins.get('world').network as EthereumNetwork).chainId,
+    chainId: (coins.get('world').network as EthereumNetwork).chainId,
+  },
+  {
+    baseChain: 'mainnet',
+    hardfork: 'london',
+    eips: [1559],
+  }
+);
diff --git a/modules/sdk-coin-world/src/lib/transactionBuilder.ts b/modules/sdk-coin-world/src/lib/transactionBuilder.ts
@@ -0,0 +1,31 @@
+import { BaseCoin as CoinConfig } from '@bitgo/statics';
+import { BuildTransactionError, PublicKey, Signature, 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;
+  private _signatures: Signature[] = [];
+
+  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;
+  }
+
+  addSignature(publicKey: PublicKey, signature: Buffer): void {
+    this._signatures.push({ publicKey, signature });
+  }
+}
diff --git a/modules/sdk-coin-world/src/lib/transferBuilder.ts b/modules/sdk-coin-world/src/lib/transferBuilder.ts
@@ -0,0 +1 @@
+export { TransferBuilder } from '@bitgo/abstract-eth';
diff --git a/modules/sdk-coin-world/src/lib/utils.ts b/modules/sdk-coin-world/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 { mainnetCommon, testnetCommon } 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-world/src/register.ts b/modules/sdk-coin-world/src/register.ts
@@ -0,0 +1,8 @@
+import { BitGoBase } from '@bitgo/sdk-core';
+import { World } from './world';
+import { Tworld } from './tworld';
+
+export const register = (sdk: BitGoBase): void => {
+  sdk.register('world', World.createInstance);
+  sdk.register('tworld', Tworld.createInstance);
+};
diff --git a/modules/sdk-coin-world/src/tworld.ts b/modules/sdk-coin-world/src/tworld.ts
@@ -0,0 +1,18 @@
+/**
+ * Testnet World
+ *
+ * @format
+ */
+import { BaseCoin, BitGoBase } from '@bitgo/sdk-core';
+import { BaseCoin as StaticsBaseCoin } from '@bitgo/statics';
+import { World } from './world';
+
+export class Tworld extends World {
+  protected constructor(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>) {
+    super(bitgo, staticsCoin);
+  }
+
+  static createInstance(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>): BaseCoin {
+    return new Tworld(bitgo, staticsCoin);
+  }
+}
diff --git a/modules/sdk-coin-world/src/world.ts b/modules/sdk-coin-world/src/world.ts
diff --git a/modules/sdk-coin-world/test/unit/getBuilder.ts b/modules/sdk-coin-world/test/unit/getBuilder.ts
diff --git a/modules/sdk-coin-world/test/unit/resources.ts b/modules/sdk-coin-world/test/unit/resources.ts
diff --git a/modules/sdk-coin-world/test/unit/transactionBuilder/send.ts b/modules/sdk-coin-world/test/unit/transactionBuilder/send.ts
diff --git a/modules/sdk-coin-world/test/unit/utils.ts b/modules/sdk-coin-world/test/unit/utils.ts
diff --git a/modules/sdk-coin-world/test/unit/world.ts b/modules/sdk-coin-world/test/unit/world.ts
diff --git a/modules/sdk-coin-world/tsconfig.json b/modules/sdk-coin-world/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/map.ts b/modules/statics/src/map.ts
diff --git a/tsconfig.packages.json b/tsconfig.packages.json

Original file line number	Diff line number	Diff line change
`@@ -112,6 +112,9 @@`
`112`	`112`	`{`
`113`	`113`	`"path": "../sdk-coin-wemix"`
`114`	`114`	`},`
	`115`	`+ {`
	`116`	`+ "path": "../sdk-coin-world"`
	`117`	`+ },`
`115`	`118`	`{`
`116`	`119`	`"path": "../sdk-coin-xdc"`
`117`	`120`	`},`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +node_modules
 +.idea
 +public
 +dist
++