Merge pull request #6026 from BitGo/WIN-5030-soneium-txn-builder

feat(sdk-coin-soneium): add transaction builder

Author: yogeshwar-bitgo

CODEOWNERS

@@ -76,6 +76,7 @@
 /modules/sdk-coin-sol/ @BitGo/ethalt-team
 /modules/sdk-coin-stx/ @BitGo/ethalt-team
 /modules/sdk-coin-stt/ @BitGo/ethalt-team
+/modules/sdk-coin-soneium/ @BitGo/ethalt-team
 /modules/sdk-coin-sui/ @BitGo/ethalt-team
 /modules/sdk-coin-tao/ @BitGo/ethalt-team
 /modules/sdk-coin-ton/ @BitGo/ethalt-team

Dockerfile

@@ -93,6 +93,7 @@ COPY --from=builder /tmp/bitgo/modules/sdk-coin-rune /var/modules/sdk-coin-rune/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-sei /var/modules/sdk-coin-sei/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-sgb /var/modules/sdk-coin-sgb/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-sol /var/modules/sdk-coin-sol/
+COPY --from=builder /tmp/bitgo/modules/sdk-coin-soneium /var/modules/sdk-coin-soneium/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-stt /var/modules/sdk-coin-stt/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-stx /var/modules/sdk-coin-stx/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-sui /var/modules/sdk-coin-sui/
@@ -181,6 +182,7 @@ cd /var/modules/sdk-coin-rune && yarn link && \
 cd /var/modules/sdk-coin-sei && yarn link && \
 cd /var/modules/sdk-coin-sgb && yarn link && \
 cd /var/modules/sdk-coin-sol && yarn link && \
+cd /var/modules/sdk-coin-soneium && yarn link && \
 cd /var/modules/sdk-coin-stt && yarn link && \
 cd /var/modules/sdk-coin-stx && yarn link && \
 cd /var/modules/sdk-coin-sui && yarn link && \
@@ -272,6 +274,7 @@ RUN cd /var/bitgo-express && \
     yarn link @bitgo/sdk-coin-sei && \
     yarn link @bitgo/sdk-coin-sgb && \
     yarn link @bitgo/sdk-coin-sol && \
+    yarn link @bitgo/sdk-coin-soneium && \
     yarn link @bitgo/sdk-coin-stt && \
     yarn link @bitgo/sdk-coin-stx && \
     yarn link @bitgo/sdk-coin-sui && \

modules/account-lib/package.json

@@ -61,6 +61,7 @@
     "@bitgo/sdk-coin-rune": "^1.1.34",
     "@bitgo/sdk-coin-sei": "^3.0.46",
     "@bitgo/sdk-coin-sgb": "^1.2.1",
+    "@bitgo/sdk-coin-soneium": "^1.0.0",
     "@bitgo/sdk-coin-sol": "^4.10.0",
     "@bitgo/sdk-coin-stt": "^1.1.0",
     "@bitgo/sdk-coin-stx": "^3.5.6",

modules/account-lib/src/index.ts

@@ -173,6 +173,9 @@ export { World };
 import * as Stt from '@bitgo/sdk-coin-stt';
 export { Stt };
 
+import * as Soneium from '@bitgo/sdk-coin-soneium';
+export { Soneium };
+
 const coinBuilderMap = {
   trx: Trx.WrappedBuilder,
   ttrx: Trx.WrappedBuilder,
@@ -271,6 +274,8 @@ const coinBuilderMap = {
   tworld: World.TransactionBuilder,
   stt: Stt.TransactionBuilder,
   tstt: Stt.TransactionBuilder,
+  soneium: Soneium.TransactionBuilder,
+  tsoneium: Soneium.TransactionBuilder,
 };
 
 /**

modules/account-lib/tsconfig.json

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

modules/bitgo/package.json

@@ -98,6 +98,7 @@
     "@bitgo/sdk-coin-sei": "^3.0.46",
     "@bitgo/sdk-coin-sgb": "^1.2.1",
     "@bitgo/sdk-coin-sol": "^4.10.0",
+    "@bitgo/sdk-coin-soneium": "^1.0.0",
     "@bitgo/sdk-coin-stt": "^1.1.0",
     "@bitgo/sdk-coin-stx": "^3.5.6",
     "@bitgo/sdk-coin-sui": "^5.13.6",

modules/bitgo/src/v2/coinFactory.ts

@@ -79,6 +79,7 @@ import {
   Sgb,
   Sip10Token,
   Sol,
+  Soneium,
   StellarToken,
   Stx,
   Stt,
@@ -141,6 +142,7 @@ import {
   Tsgb,
   Tsei,
   Tsol,
+  Tsoneium,
   Tstx,
   Tstt,
   Tsui,
@@ -230,6 +232,7 @@ function registerCoinConstructors(globalCoinFactory: CoinFactory): void {
   globalCoinFactory.register('sei', Sei.createInstance);
   globalCoinFactory.register('sgb', Sgb.createInstance);
   globalCoinFactory.register('sol', Sol.createInstance);
+  globalCoinFactory.register('soneium', Soneium.createInstance);
   globalCoinFactory.register('stx', Stx.createInstance);
   globalCoinFactory.register('stt', Stt.createInstance);
   globalCoinFactory.register('sui', Sui.createInstance);
@@ -292,6 +295,7 @@ function registerCoinConstructors(globalCoinFactory: CoinFactory): void {
   globalCoinFactory.register('trx', Trx.createInstance);
   globalCoinFactory.register('tsei', Tsei.createInstance);
   globalCoinFactory.register('tsol', Tsol.createInstance);
+  globalCoinFactory.register('tsoneium', Tsoneium.createInstance);
   globalCoinFactory.register('tstx', Tstx.createInstance);
   globalCoinFactory.register('tstt', Tstt.createInstance);
   globalCoinFactory.register('tsui', Tsui.createInstance);

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

@@ -46,6 +46,7 @@ import { Polyx, Tpolyx } from '@bitgo/sdk-coin-polyx';
 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 } from '@bitgo/sdk-coin-soneium';
 import { Stt, Tstt } from '@bitgo/sdk-coin-stt';
 import { Sgb, Tsgb } from '@bitgo/sdk-coin-sgb';
 import { Sol, Tsol } from '@bitgo/sdk-coin-sol';
@@ -111,6 +112,7 @@ export { Rbtc, Trbtc };
 export { Rune, Trune };
 export { Sgb, Tsgb };
 export { Sol, Tsol };
+export { Soneium, Tsoneium };
 export { Stt, Tstt };
 export { Stx, Tstx, Sip10Token };
 export { Sui, Tsui, SuiToken };

modules/sdk-coin-soneium/.eslintignore

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

modules/sdk-coin-soneium/.gitignore

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

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

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

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

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

modules/sdk-coin-soneium/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-soneium
+
+### Features

modules/sdk-coin-soneium/README.md

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

@@ -0,0 +1,52 @@
+{
+  "name": "@bitgo/sdk-coin-soneium",
+  "version": "1.0.0",
+  "description": "BitGo SDK coin library for Soneium",
+  "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": ">=18 <21"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/BitGo/BitGoJS.git",
+    "directory": "modules/sdk-coin-soneium"
+  },
+  "lint-staged": {
+    "*.{js,ts}": [
+      "yarn prettier --write",
+      "yarn eslint --fix"
+    ]
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "nyc": {
+    "extension": [
+      ".ts"
+    ]
+  },
+  "dependencies": {
+    "@bitgo/abstract-eth": "^24.3.0",
+    "@bitgo/sdk-core": "^33.0.0",
+    "@bitgo/statics": "^52.0.0",
+    "@ethereumjs/common": "^2.6.5"
+  },
+  "devDependencies": {
+    "@bitgo/sdk-api": "^1.62.1",
+    "@bitgo/sdk-test": "^8.0.82"
+  }
+}

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

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

modules/sdk-coin-soneium/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 };

modules/sdk-coin-soneium/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: 'soneium testnet',
+    networkId: (coins.get('tsoneium').network as EthereumNetwork).chainId,
+    chainId: (coins.get('tsoneium').network as EthereumNetwork).chainId,
+  },
+  {
+    baseChain: 'sepolia',
+    hardfork: 'london',
+    eips: [1559],
+  }
+);
+export const mainnetCommon = EthereumCommon.custom(
+  {
+    name: 'Soneium mainnet',
+    networkId: (coins.get('soneium').network as EthereumNetwork).chainId,
+    chainId: (coins.get('soneium').network as EthereumNetwork).chainId,
+  },
+  {
+    baseChain: 'mainnet',
+    hardfork: 'london',
+    eips: [1559],
+  }
+);

modules/sdk-coin-soneium/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 });
+  }
+}

modules/sdk-coin-soneium/src/lib/transferBuilder.ts

@@ -0,0 +1 @@
+export { TransferBuilder } from '@bitgo/abstract-eth';

modules/sdk-coin-soneium/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;
+}

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

@@ -0,0 +1,8 @@
+import { BitGoBase } from '@bitgo/sdk-core';
+import { Soneium } from './soneium';
+import { Tsoneium } from './tsoneium';
+
+export const register = (sdk: BitGoBase): void => {
+  sdk.register('soneium', Soneium.createInstance);
+  sdk.register('tsoneium', Tsoneium.createInstance);
+};