Merge branch 'master' into WP-5447-express-migrate-api-v2-coin-wallet-id-state-to-typed-routes

Author: danielzhao122

examples/ts/sol/stake-jito.ts

@@ -3,106 +3,110 @@
  *
  * Copyright 2025, BitGo, Inc.  All Rights Reserved.
  */
-import { BitGoAPI } from '@bitgo/sdk-api'
-import { TransactionBuilderFactory, Tsol } from '@bitgo/sdk-coin-sol'
-import { coins } from '@bitgo/statics'
-import { Connection, PublicKey, clusterApiUrl, Transaction, Keypair, LAMPORTS_PER_SOL } from "@solana/web3.js"
-import { getStakePoolAccount, updateStakePool } from '@solana/spl-stake-pool'
+import { SolStakingTypeEnum } from '@bitgo/public-types';
+import { BitGoAPI } from '@bitgo/sdk-api';
+import { TransactionBuilderFactory, Tsol } from '@bitgo/sdk-coin-sol';
+import { coins } from '@bitgo/statics';
+import { Connection, PublicKey, clusterApiUrl, Transaction, Keypair, LAMPORTS_PER_SOL } from '@solana/web3.js';
+import { getStakePoolAccount, updateStakePool } from '@solana/spl-stake-pool';
+import { getAssociatedTokenAddressSync } from '@solana/spl-token';
 import * as bs58 from 'bs58';
 
-require('dotenv').config({ path: '../../.env' })
+require('dotenv').config({ path: '../../.env' });
 
-const AMOUNT_LAMPORTS = 1000
-const JITO_STAKE_POOL_ADDRESS = 'Jito4APyf642JPZPx3hGc6WWJ8zPKtRbRs4P815Awbb'
-const NETWORK = 'devnet'
+const AMOUNT_LAMPORTS = 1000;
+const JITO_STAKE_POOL_ADDRESS = 'Jito4APyf642JPZPx3hGc6WWJ8zPKtRbRs4P815Awbb';
+const NETWORK = 'devnet';
 
 const bitgo = new BitGoAPI({
   accessToken: process.env.TESTNET_ACCESS_TOKEN,
   env: 'test',
-})
-const coin = coins.get("tsol")
-bitgo.register(coin.name, Tsol.createInstance)
+});
+const coin = coins.get('tsol');
+bitgo.register(coin.name, Tsol.createInstance);
 
 async function main() {
-  const account = getAccount()
-  const connection = new Connection(clusterApiUrl(NETWORK), 'confirmed')
-  const recentBlockhash = await connection.getLatestBlockhash()
-  const stakePoolAccount = await getStakePoolAccount(connection, new PublicKey(JITO_STAKE_POOL_ADDRESS))
-
+  const account = getAccount();
+  const connection = new Connection(clusterApiUrl(NETWORK), 'confirmed');
+  const recentBlockhash = await connection.getLatestBlockhash();
+  const stakePoolAccount = await getStakePoolAccount(connection, new PublicKey(JITO_STAKE_POOL_ADDRESS));
+  const associatedTokenAddress = getAssociatedTokenAddressSync(
+    stakePoolAccount.account.data.poolMint,
+    account.publicKey
+  );
+  const associatedTokenAccountExists = !!(await connection.getAccountInfo(associatedTokenAddress));
 
   // Account should have sufficient balance
-  const accountBalance = await connection.getBalance(account.publicKey)
+  const accountBalance = await connection.getBalance(account.publicKey);
   if (accountBalance < 0.1 * LAMPORTS_PER_SOL) {
-    console.info(`Your account balance is ${accountBalance / LAMPORTS_PER_SOL} SOL, requesting airdrop`)
-    const sig = await connection.requestAirdrop(account.publicKey, 2 * LAMPORTS_PER_SOL)
-    await connection.confirmTransaction(sig)
-    console.info(`Airdrop successful: ${sig}`)
+    console.info(`Your account balance is ${accountBalance / LAMPORTS_PER_SOL} SOL, requesting airdrop`);
+    const sig = await connection.requestAirdrop(account.publicKey, 2 * LAMPORTS_PER_SOL);
+    await connection.confirmTransaction(sig);
+    console.info(`Airdrop successful: ${sig}`);
   }
 
   // Stake pool should be up to date
-  const epochInfo = await connection.getEpochInfo()
+  const epochInfo = await connection.getEpochInfo();
   if (stakePoolAccount.account.data.lastUpdateEpoch.ltn(epochInfo.epoch)) {
-    console.info('Stake pool is out of date.')
-    const usp = await updateStakePool(connection, stakePoolAccount)
-    const tx = new Transaction()
-    tx.add(...usp.updateListInstructions, ...usp.finalInstructions)
-    const signer = Keypair.fromSecretKey(account.secretKeyArray)
-    const sig = await connection.sendTransaction(tx, [signer])
-    await connection.confirmTransaction(sig)
-    console.info(`Stake pool updated: ${sig}`)
+    console.info('Stake pool is out of date.');
+    const usp = await updateStakePool(connection, stakePoolAccount);
+    const tx = new Transaction();
+    tx.add(...usp.updateListInstructions, ...usp.finalInstructions);
+    const signer = Keypair.fromSecretKey(account.secretKeyArray);
+    const sig = await connection.sendTransaction(tx, [signer]);
+    await connection.confirmTransaction(sig);
+    console.info(`Stake pool updated: ${sig}`);
   }
 
   // Use BitGoAPI to build depositSol instruction
-  const txBuilder = new TransactionBuilderFactory(coin).getStakingActivateBuilder()
+  const txBuilder = new TransactionBuilderFactory(coin).getStakingActivateBuilder();
   txBuilder
     .amount(`${AMOUNT_LAMPORTS}`)
     .sender(account.publicKey.toBase58())
     .stakingAddress(JITO_STAKE_POOL_ADDRESS)
     .validator(JITO_STAKE_POOL_ADDRESS)
-    .stakingTypeParams({
-      type: 'JITO',
+    .stakingType(SolStakingTypeEnum.JITO)
+    .extraParams({
       stakePoolData: {
-        managerFeeAccount: stakePoolAccount.account.data.managerFeeAccount.toString(),
-        poolMint: stakePoolAccount.account.data.poolMint.toString(),
-        reserveStake: stakePoolAccount.account.data.toString(),
-      }
+        managerFeeAccount: stakePoolAccount.account.data.managerFeeAccount.toBase58(),
+        poolMint: stakePoolAccount.account.data.poolMint.toBase58(),
+        reserveStake: stakePoolAccount.account.data.reserveStake.toBase58(),
+      },
+      createAssociatedTokenAccount: !associatedTokenAccountExists,
     })
-    .nonce(recentBlockhash.blockhash)
-  txBuilder.sign({ key: account.secretKey })
-  const tx = await txBuilder.build()
-  const serializedTx = tx.toBroadcastFormat()
-  console.info(`Transaction JSON:\n${JSON.stringify(tx.toJson(), undefined, 2)}`)
+    .nonce(recentBlockhash.blockhash);
+  txBuilder.sign({ key: account.secretKey });
+  const tx = await txBuilder.build();
+  const serializedTx = tx.toBroadcastFormat();
+  console.info(`Transaction JSON:\n${JSON.stringify(tx.toJson(), undefined, 2)}`);
 
   // Send transaction
   try {
-    const sig = await connection.sendRawTransaction(Buffer.from(serializedTx, 'base64'))
-    await connection.confirmTransaction(sig)
-    console.log(`${AMOUNT_LAMPORTS / LAMPORTS_PER_SOL} SOL deposited`, sig)
+    const sig = await connection.sendRawTransaction(Buffer.from(serializedTx, 'base64'));
+    await connection.confirmTransaction(sig);
+    console.log(`${AMOUNT_LAMPORTS / LAMPORTS_PER_SOL} SOL deposited`, sig);
   } catch (e) {
-    console.log('Error sending transaction')
-    console.error(e)
-    if (e.transactionMessage === 'Transaction simulation failed: Error processing Instruction 0: Provided owner is not allowed') {
-      console.error('If you successfully staked JitoSOL once, you cannot stake again.')
-    }
+    console.log('Error sending transaction');
+    console.error(e);
   }
 }
 
 const getAccount = () => {
-  const publicKey = process.env.ACCOUNT_PUBLIC_KEY
-  const secretKey = process.env.ACCOUNT_SECRET_KEY
+  const publicKey = process.env.ACCOUNT_PUBLIC_KEY;
+  const secretKey = process.env.ACCOUNT_SECRET_KEY;
   if (publicKey === undefined || secretKey === undefined) {
-    const { publicKey, secretKey } = Keypair.generate()
-    console.log('# Here is a new account to save into your .env file.')
-    console.log(`ACCOUNT_PUBLIC_KEY=${publicKey.toBase58()}`)
-    console.log(`ACCOUNT_SECRET_KEY=${bs58.encode(secretKey)}`)
-    throw new Error("Missing account information")
+    const { publicKey, secretKey } = Keypair.generate();
+    console.log('# Here is a new account to save into your .env file.');
+    console.log(`ACCOUNT_PUBLIC_KEY=${publicKey.toBase58()}`);
+    console.log(`ACCOUNT_SECRET_KEY=${bs58.encode(secretKey)}`);
+    throw new Error('Missing account information');
   }
 
   return {
     publicKey: new PublicKey(publicKey),
     secretKey,
     secretKeyArray: new Uint8Array(bs58.decode(secretKey)),
-  }
-}
+  };
+};
 
-main().catch((e) => console.error(e))
+main().catch((e) => console.error(e));

modules/abstract-lightning/src/codecs/api/wallet.ts

@@ -52,11 +52,15 @@ export const WatchOnlyAccount = t.type({
 
 export type WatchOnlyAccount = t.TypeOf<typeof WatchOnlyAccount>;
 
-export const WatchOnly = t.type({
-  master_key_birthday_timestamp: t.string,
-  master_key_fingerprint: t.string,
-  accounts: t.array(WatchOnlyAccount),
-});
+export const WatchOnly = t.intersection([
+  t.type({
+    accounts: t.array(WatchOnlyAccount),
+  }),
+  t.partial({
+    master_key_birthday_timestamp: t.string,
+    master_key_fingerprint: t.string,
+  }),
+]);
 
 export type WatchOnly = t.TypeOf<typeof WatchOnly>;
 

modules/abstract-lightning/src/lightning/lightningUtils.ts

@@ -154,14 +154,18 @@ function convertXpubPrefix(xpub: string, purpose: ExtendedKeyPurpose, isMainnet:
 /**
  * Derives watch-only accounts from the master HD node for the given purposes and network.
  */
-function deriveWatchOnlyAccounts(masterHDNode: utxolib.BIP32Interface, isMainnet: boolean): WatchOnlyAccount[] {
+export function deriveWatchOnlyAccounts(
+  masterHDNode: utxolib.BIP32Interface,
+  isMainnet: boolean,
+  params: { onlyAddressCreationAccounts?: boolean } = { onlyAddressCreationAccounts: false }
+): WatchOnlyAccount[] {
   // https://github.com/lightningnetwork/lnd/blob/master/docs/remote-signing.md#required-accounts
   if (masterHDNode.isNeutered()) {
     throw new Error('masterHDNode must not be neutered');
   }
-
-  const purposes = [PURPOSE_WRAPPED_P2WKH, PURPOSE_P2WKH, PURPOSE_P2TR, PURPOSE_ALL_OTHERS] as const;
-
+  const purposes = params.onlyAddressCreationAccounts
+    ? ([PURPOSE_WRAPPED_P2WKH, PURPOSE_P2WKH, PURPOSE_P2TR] as const)
+    : ([PURPOSE_WRAPPED_P2WKH, PURPOSE_P2WKH, PURPOSE_P2TR, PURPOSE_ALL_OTHERS] as const);
   return purposes.flatMap((purpose) => {
     const maxAccount = purpose === PURPOSE_ALL_OTHERS ? 255 : 0;
     const coinType = purpose !== PURPOSE_ALL_OTHERS || isMainnet ? 0 : 1;

modules/abstract-substrate/src/lib/utils.ts

@@ -8,7 +8,7 @@ import { hexToU8a, isHex, u8aToHex, u8aToU8a } from '@polkadot/util';
 import { base64Decode, signatureVerify } from '@polkadot/util-crypto';
 import { UnsignedTransaction } from '@substrate/txwrapper-core';
 import { DecodedSignedTx, DecodedSigningPayload, TypeRegistry } from '@substrate/txwrapper-core/lib/types';
-import { construct } from '@substrate/txwrapper-polkadot';
+import { construct, decode } from '@substrate/txwrapper-polkadot';
 import bs58 from 'bs58';
 import base32 from 'hi-base32';
 import nacl from 'tweetnacl';
@@ -30,6 +30,7 @@ import {
   BatchArgs,
   MoveStakeArgs,
 } from './iface';
+import { SingletonRegistry } from './singletonRegistry';
 
 export class Utils implements BaseUtils {
   /** @inheritdoc */
@@ -317,6 +318,31 @@ export class Utils implements BaseUtils {
   getMaterial(networkType: NetworkType): Material {
     throw new Error('Method not implemented.');
   }
+
+  /**
+   * Decodes a substrate transaction from raw transaction hex
+   *
+   * @param {string} txHex - The raw transaction hex string to decode (signed or unsigned)
+   * @param {Material} material - Network material containing metadata and chain information
+   * @param {boolean} [isImmortalEra] - Whether the transaction uses immortal era (optional)
+   * @returns {DecodedSignedTx | DecodedSigningPayload} The decoded transaction object
+   */
+  decodeTransaction(txHex: string, material: Material, isImmortalEra = false): DecodedSignedTx | DecodedSigningPayload {
+    try {
+      const registry = SingletonRegistry.getInstance(material);
+
+      // Attempt to decode as a signed transaction or unsigned transaction
+      const decoded = decode(txHex, {
+        metadataRpc: material.metadata,
+        registry,
+        isImmortalEra,
+      });
+
+      return decoded;
+    } catch (error) {
+      throw new Error(`Failed to decode transaction: ${error}`);
+    }
+  }
 }
 
 const utils = new Utils();

modules/bitgo/package.json

@@ -147,10 +147,10 @@
     "@types/lodash": "^4.14.121",
     "aws-sdk": "^2.1155.0",
     "io-ts-types": "^0.5.16",
-    "karma": "^6.4.2",
-    "karma-chrome-launcher": "^3.1.0",
-    "karma-jasmine": "^4.0.0",
-    "karma-typescript": "^5.0.3",
+    "karma": "6.4.4",
+    "karma-chrome-launcher": "3.2.0",
+    "karma-jasmine": "5.1.0",
+    "karma-typescript": "5.5.4",
     "keccak": "3.0.3",
     "libsodium-wrappers-sumo": "^0.7.9",
     "puppeteer": "2.1.1",

modules/bitgo/src/v2/coinFactory.ts

@@ -37,6 +37,7 @@ import {
   VetTokenConfig,
   TaoTokenConfig,
   PolyxTokenConfig,
+  JettonTokenConfig,
 } from '@bitgo/statics';
 import {
   Ada,
@@ -99,6 +100,7 @@ import {
   Injective,
   Iota,
   Islm,
+  JettonToken,
   Lnbtc,
   Ltc,
   Mon,
@@ -528,6 +530,10 @@ export function registerCoinConstructors(coinFactory: CoinFactory, coinMap: Coin
     ({ name, coinConstructor }) => coinFactory.register(name, coinConstructor)
   );
 
+  JettonToken.createTokenConstructors([...tokens.bitcoin.ton.tokens, ...tokens.testnet.ton.tokens]).forEach(
+    ({ name, coinConstructor }) => coinFactory.register(name, coinConstructor)
+  );
+
   VetToken.createTokenConstructors().forEach(({ name, coinConstructor }) =>
     coinFactory.register(name, coinConstructor)
   );
@@ -971,6 +977,9 @@ export function getTokenConstructor(tokenConfig: TokenConfig): CoinConstructor |
     case 'flr':
     case 'tflr':
       return FlrToken.createTokenConstructor(tokenConfig as EthLikeTokenConfig);
+    case 'ton':
+    case 'tton':
+      return JettonToken.createTokenConstructor(tokenConfig as JettonTokenConfig);
     default:
       return undefined;
   }

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

@@ -60,7 +60,7 @@ import { Stx, Tstx, 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 { Tia, Ttia } from '@bitgo/sdk-coin-tia';
-import { Ton, Tton } from '@bitgo/sdk-coin-ton';
+import { Ton, Tton, JettonToken } from '@bitgo/sdk-coin-ton';
 import { Trx, Ttrx } from '@bitgo/sdk-coin-trx';
 import { StellarToken, Txlm, Xlm } from '@bitgo/sdk-coin-xlm';
 import { Vet, Tvet, VetToken } from '@bitgo/sdk-coin-vet';
@@ -131,7 +131,7 @@ export { Stx, Tstx, Sip10Token };
 export { Sui, Tsui, SuiToken };
 export { Tao, Ttao, TaoToken };
 export { Tia, Ttia };
-export { Ton, Tton };
+export { Ton, Tton, JettonToken };
 export { Bld, Tbld };
 export { Sei, Tsei };
 export { Injective, Tinjective };

modules/bitgo/test/browser/browser.spec.ts

@@ -57,6 +57,7 @@ describe('Coins', () => {
       EthLikeErc20Token: 1,
       HashToken: 1,
       FlrToken: 1,
+      JettonToken: 1,
     };
     Object.keys(BitGoJS.Coin)
       .filter((coinName) => !excludedKeys[coinName])

modules/bitgo/test/v2/unit/staking/stakingWalletNonTSS.ts

@@ -400,7 +400,7 @@ describe('non-TSS Staking Wallet', function () {
       await topethWctStakingWallet.buildAndSign({ walletPassphrase: 'passphrase' }, stakingTransaction);
     });
 
-    it('should log an error if a transaction is failed to be validated transaction if unsigned transaction does not match the staking transaction', async function () {
+    it('should throw an error if unsigned transaction does not match the staking transaction', async function () {
       const unsignedTransaction: PrebuildTransactionResult = {
         walletId: topethWctStakingWallet.walletId,
         ...opethFixtures.unsignedStakingTransaction,
@@ -409,8 +409,6 @@ describe('non-TSS Staking Wallet', function () {
       } as PrebuildTransactionResult;
       const stakingTransaction: StakingTransaction = opethFixtures.updatedStakingRequest;
 
-      const consoleStub = sinon.stub(console, 'error');
-
       nock(microservicesUri)
         .get(
           `/api/staking/v1/${topethWctStakingWallet.coin}/wallets/${topethWctStakingWallet.walletId}/requests/${stakingTransaction.stakingRequestId}/transactions/${stakingTransaction.id}`
@@ -426,11 +424,14 @@ describe('non-TSS Staking Wallet', function () {
         .post(`/api/v2/topeth/wallet/${topethWctStakingWallet.walletId}/tx/build`)
         .reply(200, unsignedTransaction);
 
-      await topethWctStakingWallet.buildAndSign({ walletPassphrase: 'passphrase' }, stakingTransaction);
+      const expectedErrorMessage =
+        'Staking transaction validation failed before signing: ' +
+        'Unexpected recipient address found in built transaction: 0x86bb6dca2cd6f9a0189c478bbb8f7ee2fef07c89; ' +
+        'Expected recipient address not found in built transaction: 0x75bb6dca2cd6f9a0189c478bbb8f7ee2fef07c78';
 
-      consoleStub.calledWith(
-        'Invalid recipient address: 0x86bb6dca2cd6f9a0189c478bbb8f7ee2fef07c89, Missing recipient address(es): 0x75bb6dca2cd6f9a0189c478bbb8f7ee2fef07c78'
-      );
+      await topethWctStakingWallet
+        .buildAndSign({ walletPassphrase: 'passphrase' }, stakingTransaction)
+        .should.be.rejectedWith(expectedErrorMessage);
     });
   });
 });