feat(sdk-coin-irys): Irys commitment transaction support

Dockerfile

@@ -136,6 +136,7 @@ COPY --from=builder /tmp/bitgo/modules/sdk-coin-eos /var/modules/sdk-coin-eos/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-ethlike /var/modules/sdk-coin-ethlike/
 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-irys /var/modules/sdk-coin-irys/
 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-xlm /var/modules/sdk-coin-xlm/
@@ -236,6 +237,7 @@ cd /var/modules/sdk-coin-eos && yarn link && \
 cd /var/modules/sdk-coin-ethlike && yarn link && \
 cd /var/modules/sdk-coin-ethw && yarn link && \
 cd /var/modules/sdk-coin-iota && yarn link && \
+cd /var/modules/sdk-coin-irys && yarn link && \
 cd /var/modules/sdk-coin-lnbtc && yarn link && \
 cd /var/modules/sdk-coin-ltc && yarn link && \
 cd /var/modules/sdk-coin-xlm && yarn link && \
@@ -339,6 +341,7 @@ RUN cd /var/bitgo-express && \
     yarn link @bitgo/sdk-coin-ethlike && \
     yarn link @bitgo/sdk-coin-ethw && \
     yarn link @bitgo/sdk-coin-iota && \
+    yarn link @bitgo/sdk-coin-irys && \
     yarn link @bitgo/sdk-coin-lnbtc && \
     yarn link @bitgo/sdk-coin-ltc && \
     yarn link @bitgo/sdk-coin-xlm && \

modules/bitgo/package.json

@@ -90,6 +90,7 @@
     "@bitgo/sdk-coin-initia": "^2.5.2",
     "@bitgo/sdk-coin-injective": "^3.6.2",
     "@bitgo/sdk-coin-iota": "^1.8.2",
+    "@bitgo/sdk-coin-irys": "^1.0.0",
     "@bitgo/sdk-coin-islm": "^2.5.2",
     "@bitgo/sdk-coin-lnbtc": "^1.6.2",
     "@bitgo/sdk-coin-ltc": "^3.7.2",

modules/bitgo/src/v2/coinFactory.ts

@@ -105,6 +105,7 @@ import {
   Initia,
   Injective,
   Iota,
+  Irys,
   Islm,
   JettonToken,
   Lnbtc,
@@ -183,6 +184,7 @@ import {
   Ticp,
   Tinitia,
   Tinjective,
+  TIrys,
   Tislm,
   Tlnbtc,
   Tltc,
@@ -293,6 +295,7 @@ export function registerCoinConstructors(coinFactory: CoinFactory, coinMap: Coin
   coinFactory.register('initia', Initia.createInstance);
   coinFactory.register('injective', Injective.createInstance);
   coinFactory.register('iota', Iota.createInstance);
+  coinFactory.register('irys', Irys.createInstance);
   coinFactory.register('islm', Islm.createInstance);
   coinFactory.register('near', Near.createInstance);
   coinFactory.register('oas', Oas.createInstance);
@@ -361,6 +364,7 @@ export function registerCoinConstructors(coinFactory: CoinFactory, coinMap: Coin
   coinFactory.register('tinitia', Tinitia.createInstance);
   coinFactory.register('tinjective', Tinjective.createInstance);
   coinFactory.register('tiota', Iota.createInstance);
+  coinFactory.register('tirys', TIrys.createInstance);
   coinFactory.register('tislm', Tislm.createInstance);
   coinFactory.register('tlnbtc', Tlnbtc.createInstance);
   coinFactory.register('tltc', Tltc.createInstance);

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

@@ -42,6 +42,7 @@ import { Icp, Ticp } from '@bitgo/sdk-coin-icp';
 import { Initia, Tinitia } from '@bitgo/sdk-coin-initia';
 import { Injective, Tinjective } from '@bitgo/sdk-coin-injective';
 import { Iota } from '@bitgo/sdk-coin-iota';
+import { Irys, TIrys } from '@bitgo/sdk-coin-irys';
 import { Islm, Tislm } from '@bitgo/sdk-coin-islm';
 import { Lnbtc, Tlnbtc } from '@bitgo/sdk-coin-lnbtc';
 import { Ltc, Tltc } from '@bitgo/sdk-coin-ltc';
@@ -118,6 +119,7 @@ export { Hbar, Thbar };
 export { Icp, Ticp };
 export { Initia, Tinitia };
 export { Iota };
+export { Irys, TIrys };
 export { Lnbtc, Tlnbtc };
 export { Ltc, Tltc };
 export { Mon, Tmon, MonToken };

modules/bitgo/tsconfig.json

@@ -182,6 +182,9 @@
     {
       "path": "../sdk-coin-iota"
     },
+    {
+      "path": "../sdk-coin-irys"
+    },
     {
       "path": "../sdk-coin-islm"
     },

modules/sdk-coin-irys/.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-irys/.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-irys/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@bitgo/sdk-coin-irys",
+  "version": "1.0.0",
+  "description": "BitGo SDK coin library for Irys",
+  "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 '**/*.{ts,js,json}'",
+    "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 <25"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/BitGo/BitGoJS.git",
+    "directory": "modules/sdk-coin-irys"
+  },
+  "lint-staged": {
+    "*.{js,ts}": [
+      "yarn prettier --write",
+      "yarn eslint --fix"
+    ]
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "nyc": {
+    "extension": [
+      ".ts"
+    ]
+  },
+  "dependencies": {
+    "@bitgo/abstract-eth": "^24.20.2",
+    "@bitgo/sdk-core": "^36.31.1",
+    "@bitgo/statics": "^58.25.0",
+    "@ethereumjs/common": "^2.6.5",
+    "@ethereumjs/rlp": "^4.0.0",
+    "bs58": "^4.0.1",
+    "ethers": "^5.1.3",
+    "superagent": "^9.0.1"
+  },
+  "devDependencies": {
+    "@bitgo/sdk-api": "^1.74.1",
+    "@bitgo/sdk-test": "^9.1.27",
+    "@types/sinon": "^10.0.11",
+    "@types/superagent": "^8.1.0",
+    "nock": "^13.3.1",
+    "should": "^13.2.3",
+    "sinon": "^13.0.1"
+  },
+  "files": [
+    "dist"
+  ]
+}

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

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

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

@@ -0,0 +1,64 @@
+import { BaseCoin, BitGoBase, MPCAlgorithm } from '@bitgo/sdk-core';
+import { AbstractEthLikeNewCoins } from '@bitgo/abstract-eth';
+import { CoinFeature, BaseCoin as StaticsBaseCoin, coins, EthereumNetwork } from '@bitgo/statics';
+import { IrysCommitmentTransactionBuilder, TransactionBuilder } from './lib';
+
+/**
+ * Irys coin implementation.
+ *
+ * Irys is EVM-compatible for standard transfers (inherits from AbstractEthLikeNewCoins)
+ * but uses custom commitment transactions for staking (STAKE, PLEDGE, etc.).
+ *
+ * Standard EVM operations (transfers, balance queries) use the inherited EVM logic.
+ * Commitment transactions use the IrysCommitmentTransactionBuilder.
+ */
+export class Irys extends AbstractEthLikeNewCoins {
+  protected constructor(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>) {
+    super(bitgo, staticsCoin);
+  }
+
+  static createInstance(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>): BaseCoin {
+    return new Irys(bitgo, staticsCoin);
+  }
+
+  /**
+   * Irys supports TSS (from EVM_FEATURES in statics).
+   */
+  supportsTss(): boolean {
+    return this.staticsCoin?.features.includes(CoinFeature.TSS) ?? false;
+  }
+
+  /** @inheritdoc */
+  getMPCAlgorithm(): MPCAlgorithm {
+    return 'ecdsa';
+  }
+
+  /**
+   * Get the Irys native API URL from the network config.
+   * This is the non-EVM API used for commitment transactions.
+   */
+  getIrysApiUrl(): string | undefined {
+    const network = this.getNetwork() as EthereumNetwork;
+    return network.irysApiUrl;
+  }
+
+  /**
+   * Create a commitment transaction builder for staking operations.
+   * This is separate from getTransactionBuilder() which handles standard EVM transfers.
+   */
+  getCommitmentTransactionBuilder(): IrysCommitmentTransactionBuilder {
+    const apiUrl = this.getIrysApiUrl();
+    if (!apiUrl) {
+      throw new Error('Irys API URL is not configured for this network');
+    }
+    return new IrysCommitmentTransactionBuilder(apiUrl, BigInt(this.getChainId()));
+  }
+
+  /**
+   * Create a new transaction builder for standard EVM transactions.
+   * @return a new transaction builder
+   */
+  protected getTransactionBuilder(): TransactionBuilder {
+    return new TransactionBuilder(coins.get(this.getBaseChain()));
+  }
+}