Merge pull request #9843 from BitGo/cshld-1849-tstxsignet

feat(sdk-coin-stx): register tstxsignet staking-testnet coin

Author: akarath

modules/account-lib/src/index.ts

@@ -249,6 +249,7 @@ const coinBuilderMap = {
   tcspr: Cspr.TransactionBuilderFactory,
   stx: Stx.TransactionBuilderFactory,
   tstx: Stx.TransactionBuilderFactory,
+  tstxsignet: Stx.TransactionBuilderFactory,
   algo: Algo.TransactionBuilderFactory,
   talgo: Algo.TransactionBuilderFactory,
   sol: Sol.TransactionBuilderFactory,

modules/bitgo/src/v2/coinFactory.ts

@@ -207,6 +207,7 @@ import {
   Tsol,
   Tsoneium,
   Tstx,
+  Tstxsignet,
   Tstt,
   Tsui,
   Tsusd,
@@ -390,6 +391,7 @@ export function registerCoinConstructors(coinFactory: CoinFactory, coinMap: Coin
   coinFactory.register('tsoneium', Tsoneium.createInstance);
   coinFactory.register('tstarknet', Starknet.createInstance);
   coinFactory.register('tstx', Tstx.createInstance);
+  coinFactory.register('tstxsignet', Tstxsignet.createInstance);
   coinFactory.register('tstt', Tstt.createInstance);
   coinFactory.register('tsui', Tsui.createInstance);
   coinFactory.register('tsusd', Tsusd.createInstance);
@@ -972,6 +974,8 @@ export function getCoinConstructor(coinName: string): CoinConstructor | undefine
       return Starknet.createInstance;
     case 'tstx':
       return Tstx.createInstance;
+    case 'tstxsignet':
+      return Tstxsignet.createInstance;
     case 'tstt':
       return Tstt.createInstance;
     case 'tsui':
@@ -1184,6 +1188,7 @@ export function getTokenConstructor(
     }
     case 'stx':
     case 'tstx':
+    case 'tstxsignet':
       return Sip10Token.createTokenConstructor(tokenConfig as Sip10TokenConfig);
     case 'near':
     case 'tnear':

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

@@ -61,7 +61,7 @@ import { Tstt } from '@bitgo/sdk-coin-stt';
 import { Sgb, Tsgb } from '@bitgo/sdk-coin-sgb';
 import { Sol, Tsol } from '@bitgo/sdk-coin-sol';
 import { Starknet } from '@bitgo/sdk-coin-starknet';
-import { Stx, Tstx, Sip10Token } from '@bitgo/sdk-coin-stx';
+import { Stx, Tstx, Tstxsignet, Sip10Token } from '@bitgo/sdk-coin-stx';
 import { Sui, Tsui, SuiToken } from '@bitgo/sdk-coin-sui';
 import { Tao, Ttao, TaoToken } from '@bitgo/sdk-coin-tao';
 import { Tempo, Ttempo, Tip20Token } from '@bitgo/sdk-coin-tempo';
@@ -138,7 +138,7 @@ export { Sol, Tsol };
 export { Soneium, Tsoneium, SoneiumToken };
 export { Starknet };
 export { Tstt };
-export { Stx, Tstx, Sip10Token };
+export { Stx, Tstx, Tstxsignet, Sip10Token };
 export { Sui, Tsui, SuiToken };
 export { Tao, Ttao, TaoToken };
 export { Tempo, Ttempo, Tip20Token };

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

@@ -1,6 +1,7 @@
 export * as StxLib from './lib';
 export * from './stx';
 export * from './tstx';
+export * from './tstxsignet';
 export * from './types';
 export * from './register';
 export * from './sip10Token';

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

@@ -1,5 +1,6 @@
 export { AddressVersion, AddressHashMode } from '@stacks/transactions';
 export * from './keyPair';
+export * from './network';
 export * from './transaction';
 export * from './transactionBuilderFactory';
 export * from './sbtcWithdrawBuilder';

modules/sdk-coin-stx/src/lib/network.ts

@@ -0,0 +1,28 @@
+import { BaseCoin as CoinConfig, NetworkType, StacksNetwork as StaticsStacksNetwork } from '@bitgo/statics';
+import { StacksMainnet, StacksNetwork, StacksTestnet } from '@stacks/network';
+
+/**
+ * Build the `@stacks/network` object a transaction is serialized against.
+ *
+ * The stock Stacks mainnet/testnet networks hardcode their chain ID and transaction version. A
+ * statics network that describes a different Stacks deployment (for example the Stacks
+ * Foundation `staking-testnet`, chain ID 1280, on a private Bitcoin signet) declares
+ * `chainId` / `transactionVersion`; those are applied on top of the stock network so the
+ * serialized transaction carries the chain ID the node expects.
+ *
+ * When statics omits both fields the returned network is exactly the stock one, so existing
+ * `stx` / `tstx` transactions stay byte-identical.
+ */
+export function toStacksNetwork(coinConfig: Readonly<CoinConfig>): StacksNetwork {
+  const staticsNetwork = coinConfig.network as StaticsStacksNetwork;
+  const network = staticsNetwork.type === NetworkType.MAINNET ? new StacksMainnet() : new StacksTestnet();
+
+  if (staticsNetwork.chainId !== undefined) {
+    network.chainId = staticsNetwork.chainId;
+  }
+  if (staticsNetwork.transactionVersion !== undefined) {
+    network.version = staticsNetwork.transactionVersion;
+  }
+
+  return network;
+}

modules/sdk-coin-stx/src/lib/transactionBuilder.ts

@@ -1,6 +1,6 @@
 import BigNumber from 'bignumber.js';
 import BigNum from 'bn.js';
-import { BaseCoin as CoinConfig, NetworkType } from '@bitgo/statics';
+import { BaseCoin as CoinConfig } from '@bitgo/statics';
 import {
   AuthType,
   BufferReader,
@@ -13,7 +13,7 @@ import {
   StacksMessageType,
   PubKeyEncoding,
 } from '@stacks/transactions';
-import { StacksNetwork, StacksTestnet, StacksMainnet } from '@stacks/network';
+import { StacksNetwork } from '@stacks/network';
 import {
   BaseAddress,
   BaseFee,
@@ -31,6 +31,7 @@ import { KeyPair } from './keyPair';
 import { SignatureData } from './iface';
 import { isValidAddress, removeHexPrefix, isValidMemo, isValidPublicKey } from './utils';
 import { ANCHOR_MODE, DEFAULT_MULTISIG_SIG_NUMBER } from './constants';
+import { toStacksNetwork } from './network';
 
 export abstract class TransactionBuilder extends BaseTransactionBuilder {
   private _transaction: Transaction;
@@ -51,7 +52,7 @@ export abstract class TransactionBuilder extends BaseTransactionBuilder {
     this._fromPubKeys = [];
     this._signatures = [];
     this._numberSignatures = DEFAULT_MULTISIG_SIG_NUMBER;
-    this._network = _coinConfig.network.type === NetworkType.MAINNET ? new StacksMainnet() : new StacksTestnet();
+    this._network = toStacksNetwork(_coinConfig);
     this._transaction = new Transaction(_coinConfig);
   }
 

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

@@ -1,11 +1,13 @@
 import { BitGoBase } from '@bitgo/sdk-core';
 import { Stx } from './stx';
 import { Tstx } from './tstx';
+import { Tstxsignet } from './tstxsignet';
 import { Sip10Token } from './sip10Token';
 
 export const register = (sdk: BitGoBase): void => {
   sdk.register('stx', Stx.createInstance);
   sdk.register('tstx', Tstx.createInstance);
+  sdk.register('tstxsignet', Tstxsignet.createInstance);
   Sip10Token.createTokenConstructors().forEach(({ name, coinConstructor }) => {
     sdk.register(name, coinConstructor);
   });

modules/sdk-coin-stx/src/sip10Token.ts

@@ -2,7 +2,7 @@ import _ from 'lodash';
 import BigNumber from 'bignumber.js';
 
 import { BitGoBase, CoinConstructor, NamedCoinConstructor, VerifyTransactionOptions } from '@bitgo/sdk-core';
-import { BaseCoin as StaticsBaseCoin, coins, NetworkType, Sip10TokenConfig, tokens } from '@bitgo/statics';
+import { BaseCoin as StaticsBaseCoin, coins, Sip10TokenConfig, tokens } from '@bitgo/statics';
 
 import { Stx } from './stx';
 import { TransactionBuilderFactory } from './lib';
@@ -13,7 +13,9 @@ export class Sip10Token extends Stx {
   public readonly tokenConfig: Sip10TokenConfig;
 
   constructor(bitgo: BitGoBase, tokenConfig: Sip10TokenConfig) {
-    const staticsCoin = tokenConfig.network === NetworkType.MAINNET ? coins.get('stx') : coins.get('tstx');
+    // tokenConfig.coin is derived by statics from the token's network, so it stays correct for
+    // deployments beyond the stock mainnet/testnet pair (e.g. tstxsignet, chain ID 1280).
+    const staticsCoin = coins.get(tokenConfig.coin);
     super(bitgo, staticsCoin);
     this.tokenConfig = tokenConfig;
   }

modules/sdk-coin-stx/src/tstxsignet.ts

@@ -0,0 +1,40 @@
+/**
+ * Testnet Stacks Signet
+ *
+ * @format
+ */
+import { BaseCoin, BitGoBase, Environments } from '@bitgo/sdk-core';
+import { BaseCoin as StaticsBaseCoin } from '@bitgo/statics';
+
+import { Stx } from './stx';
+
+export class Tstxsignet extends Stx {
+  protected readonly _staticsCoin: Readonly<StaticsBaseCoin>;
+
+  constructor(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>) {
+    super(bitgo, staticsCoin);
+
+    if (!staticsCoin) {
+      throw new Error('missing required constructor parameter staticsCoin');
+    }
+
+    this._staticsCoin = staticsCoin;
+  }
+
+  static createInstance(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>): BaseCoin {
+    return new Tstxsignet(bitgo, staticsCoin);
+  }
+
+  /**
+   * The Stacks staking-testnet RPC. It is a distinct chain (chain ID 1280) that only exists on
+   * testnet-derived environments; environments without it configured (e.g. prod) cannot talk to
+   * this network.
+   */
+  override getPublicNodeUrl(): string {
+    const nodeUrl = Environments[this.bitgo.getEnv()].stxSignetNodeUrl;
+    if (!nodeUrl) {
+      throw new Error(`no stx signet node url configured for env ${this.bitgo.getEnv()}`);
+    }
+    return nodeUrl;
+  }
+}