feat(isdk-coin-ton): add ton whales deposit tx building

feng-bitgo · feng-bitgo · commit f88d569b5b5b · 2025-12-15T11:45:32.000-05:00
TICKET: SC-4503
diff --git a/modules/sdk-coin-ton/src/lib/constants.ts b/modules/sdk-coin-ton/src/lib/constants.ts
@@ -4,3 +4,4 @@ export const JETTON_TRANSFER_OPCODE = 0x0f8a7ea5;
 export const WITHDRAW_OPCODE = '00001000';
 export const VESTING_CONTRACT_CODE_B64 =
   'te6cckECHAEAA/sAART/APSkE/S88sgLAQIBIAISAgFIAwUDrNBsIiDXScFgkVvgAdDTAwFxsJFb4PpAMNs8AdMf0z/4S1JAxwUjghCnczrNurCOpGwS2zyCEPdzOs0BcIAYyMsFUATPFiP6AhPLassfyz/JgED7AOMOExQEAc74SlJAxwUDghByWKabuhOwjtGOLAH6QH/IygAC+kQByMoHy//J0PhEECOBAQj0QfhkINdKwgAglQHUMNAB3rMS5oIQ8limmzJwgBjIywVQBM8WI/oCE8tqyx/LP8mAQPsA2zySXwPiGwIBIAYPAgEgBwoCAW4ICQAZrc52omhAIGuQ64X/wAAZrx32omhAEGuQ64WPwAIBYgsMAUutNG2eNvwiRw1AgIR6STfSmRDOaQPp/5g3gSgBt4EBSJhxWfMYQBMCAWoNDgAPol+1E0NcLH4BL6LHbPPpEAcjKB8v/ydD4RIEBCPQKb6ExhMCASAQEQEpukYts8+EX4RvhH+Ej4SfhK+Ev4RIEwINuYRts82zyBMVA7jygwjXGCDTH9Mf0x8C+CO78mTtRNDTH9Mf0/8wWrryoVAzuvKiAvkBQDP5EPKj+ADbPCDXSsABjpntRO1F7UeRW+1n7WXtZI6C2zztQe3xAfL/kTDi+EGk+GHbPBMUGwB+7UTQ0x8B+GHTHwH4YtP/Afhj9AQB+GTUAdDTPwH4ZdMfAfhm0x8B+GfTHwH4aPoAAfhp+kAB+Gr6QAH4a9HRAlzTB9TR+CPbPCDCAI6bIsAD8uBkIdDTA/pAMfpA+EpSIMcFs5JfBOMNkTDiAfsAFRYAYPhF+EagUhC8kjBw4PhF+EigUhC5kzD4SeD4SfhJ+EUTofhHqQT4RvhHqQQQI6mEoQP6IfpEAcjKB8v/ydD4RIEBCPQKb6Exj18zAXKwwALy4GUB+gAxcdch+gAx+gAx0z8x0x8x0wABwADy4GbTAAGT1DDQ3iFx2zyOKjHTHzAgghBOc3RLuiGCEEdldCS6sSGCEFZ0Q3C6sQGCEFZvdGW6sfLgZ+MOcJJfA+IgwgAYFxoC6gFw2zyObSDXScIAjmPTHyHAACKDC7qxIoEQAbqxIoIQR9VDkbqxIoIQWV8HvLqxIoIQafswbLqxIoIQVm90ZbqxIoIQVnRDcLqx8uBnAcAAIddJwgCwjhXTBzAgwGQhwHexIcBEsQHAV7Hy4GiRMOKRMOLjDRgZAEQB+kQBw/+SW3DgAfgzIG6SW3Dg0CDXSYMHuZJbcODXC/+6ABrTHzCCEFZvdGW68uBnAA6TcvsCkTDiAGb4SPhH+Eb4RcjLP8sfyx/LH/hJ+gL4Ss8W+EvPFsn4RPhD+EL4QcjLH8sfy//0AMzJ7VSo1+S9';
+export const TON_WHALES_DEPOSIT_OPCODE = '2077040623';
diff --git a/modules/sdk-coin-ton/src/lib/tonWhalesDepositBuilder.ts b/modules/sdk-coin-ton/src/lib/tonWhalesDepositBuilder.ts
@@ -0,0 +1,34 @@
+import { BaseCoin as CoinConfig } from '@bitgo/statics';
+import { Recipient, TransactionType } from '@bitgo/sdk-core';
+import { TransactionBuilder } from './transactionBuilder';
+import { Transaction } from './transaction';
+import { TON_WHALES_DEPOSIT_OPCODE } from './constants';
+
+export class TonWhalesDepositBuilder extends TransactionBuilder {
+  constructor(_coinConfig: Readonly<CoinConfig>) {
+    super(_coinConfig);
+    this._transaction = new Transaction(_coinConfig);
+  }
+
+  protected get transactionType(): TransactionType {
+    return TransactionType.TonWhalesDeposit;
+  }
+
+  setDepositMessage(): TonWhalesDepositBuilder {
+    // Deposit payload is just OpCode + QueryId.
+    // The Amount is in the transaction value (recipient.amount)
+    // The Gas Limit is hardcoded in Transaction.ts build()
+    const queryId = '0000000000000000';
+    this.transaction.message = TON_WHALES_DEPOSIT_OPCODE + queryId;
+    return this;
+  }
+
+  send(recipient: Recipient): TonWhalesDepositBuilder {
+    this.transaction.recipient = recipient;
+    return this;
+  }
+
+  setMessage(msg: string): TonWhalesDepositBuilder {
+    throw new Error('Method not implemented.');
+  }
+}
diff --git a/modules/sdk-coin-ton/src/lib/transaction.ts b/modules/sdk-coin-ton/src/lib/transaction.ts
@@ -5,7 +5,13 @@ import { Cell } from 'tonweb/dist/types/boc/cell';
 import { BaseKey, BaseTransaction, Entry, Recipient, TransactionRecipient, TransactionType } from '@bitgo/sdk-core';
 import { BaseCoin as CoinConfig } from '@bitgo/statics';
 import { TransactionExplanation, TxData } from './iface';
-import { WITHDRAW_OPCODE, WALLET_ID, JETTON_TRANSFER_OPCODE, VESTING_CONTRACT_WALLET_ID } from './constants';
+import {
+  WITHDRAW_OPCODE,
+  WALLET_ID,
+  JETTON_TRANSFER_OPCODE,
+  VESTING_CONTRACT_WALLET_ID,
+  TON_WHALES_DEPOSIT_OPCODE,
+} from './constants';
 
 export class Transaction extends BaseTransaction {
   public recipient: Recipient;
@@ -127,6 +133,11 @@ export class Transaction extends BaseTransaction {
             payloadCell.bits.writeUint(parseInt(WITHDRAW_OPCODE, 16), 32);
             payloadCell.bits.writeUint(parseInt(queryId, 16), 64);
             payloadCell.bits.writeCoins(new BN(withdrawAmount));
+          } else if (payload.length >= 24 && payload.substring(0, 8) === TON_WHALES_DEPOSIT_OPCODE) {
+            const queryId = payload.substring(8, 24);
+            payloadCell.bits.writeUint(parseInt(TON_WHALES_DEPOSIT_OPCODE, 16), 32);
+            payloadCell.bits.writeUint(parseInt(queryId, 16), 64);
+            payloadCell.bits.writeCoins(TonWeb.utils.toNano('20'));
           } else {
             payloadCell.bits.writeUint(0, 32);
             payloadCell.bits.writeString(payload);
@@ -369,6 +380,10 @@ export class Transaction extends BaseTransaction {
             forwardTonAmount: forwardTonAmount.toString(),
             message: message,
           };
+        } else if (opcode === parseInt(TON_WHALES_DEPOSIT_OPCODE, 16)) {
+          this.transactionType = TransactionType.TonWhalesDeposit;
+          const queryId = order.loadUint(64).toNumber();
+          payload = TON_WHALES_DEPOSIT_OPCODE + queryId.toString(16).padStart(16, '0');
         } else {
           payload = '';
         }
diff --git a/modules/sdk-coin-ton/src/lib/transactionBuilderFactory.ts b/modules/sdk-coin-ton/src/lib/transactionBuilderFactory.ts
@@ -6,6 +6,7 @@ import { SingleNominatorWithdrawBuilder } from './singleNominatorWithdrawBuilder
 import { Transaction } from './transaction';
 import { TokenTransferBuilder } from './tokenTransferBuilder';
 import { TokenTransaction } from './tokenTransaction';
+import { TonWhalesDepositBuilder } from './tonWhalesDepositBuilder';
 
 export class TransactionBuilderFactory extends BaseTransactionBuilderFactory {
   constructor(_coinConfig: Readonly<CoinConfig>) {
@@ -37,6 +38,9 @@ export class TransactionBuilderFactory extends BaseTransactionBuilderFactory {
         case TransactionType.SendToken:
           builder = this.getTokenTransferBuilder();
           break;
+        case TransactionType.TonWhalesDeposit:
+          builder = this.getTonWhalesDepositBuilder();
+          break;
         default:
           throw new InvalidTransactionError('unsupported transaction');
       }
@@ -70,4 +74,8 @@ export class TransactionBuilderFactory extends BaseTransactionBuilderFactory {
   getWalletInitializationBuilder(): void {
     throw new Error('Method not implemented.');
   }
+
+  getTonWhalesDepositBuilder(): TonWhalesDepositBuilder {
+    return new TonWhalesDepositBuilder(this._coinConfig);
+  }
 }
diff --git a/modules/sdk-coin-ton/test/unit/tonWhalesDepositBuilder.ts b/modules/sdk-coin-ton/test/unit/tonWhalesDepositBuilder.ts
@@ -0,0 +1,141 @@
+import should from 'should';
+import { TransactionType } from '@bitgo/sdk-core';
+import { TransactionBuilderFactory } from '../../src/lib/transactionBuilderFactory';
+import { coins } from '@bitgo/statics';
+import * as testData from '../resources/ton';
+import { KeyPair } from '../../src/lib/keyPair';
+import * as utils from '../../src/lib/utils';
+import { TON_WHALES_DEPOSIT_OPCODE } from '../../src/lib/constants';
+
+describe('Ton Whales Deposit Builder', () => {
+  const factory = new TransactionBuilderFactory(coins.get('tton'));
+
+  // Use a valid pool address (TonWhales Testnet Pool)
+  const poolAddress = 'kQDr9Sq482A6ikIUh5mUUjJaBUUJBrye13CJiDB-R31_l7mg';
+  const depositAmount = '10000000000'; // 10 TON
+
+  it('should build a unsigned deposit tx', async function () {
+    const txBuilder = factory.getTonWhalesDepositBuilder();
+
+    // 1. Setup Sender using fixture data
+    txBuilder.sender(testData.sender.address);
+    txBuilder.sequenceNumber(0);
+    txBuilder.publicKey(testData.sender.publicKey);
+    txBuilder.expireTime(1234567890);
+
+    // 2. Setup Deposit
+    txBuilder.send({ address: poolAddress, amount: depositAmount });
+    txBuilder.setDepositMessage(); // Sets the OpCode
+
+    const tx = await txBuilder.build();
+    const json = tx.toJson();
+
+    // 3. Verify Type and Fields
+    should.equal(tx.type, TransactionType.TonWhalesDeposit);
+
+    // Check Outputs
+    tx.outputs.length.should.equal(1);
+    tx.outputs[0].should.deepEqual({
+      address: poolAddress,
+      value: depositAmount,
+      coin: 'tton',
+    });
+
+    // Check Payload contains OpCode + QueryID (0x7BCD136F + 0...0)
+    const expectedPayload = TON_WHALES_DEPOSIT_OPCODE + '0000000000000000';
+    should.equal(tx['message'], expectedPayload);
+
+    // Check JSON
+    should.equal(json.bounceable, false);
+    should.equal(json.amount, depositAmount);
+    should.equal(json.destination, poolAddress);
+  });
+
+  it('should parse a raw deposit transaction (Round Trip)', async function () {
+    // 1. Build the transaction
+    const buildStep = factory.getTonWhalesDepositBuilder();
+    buildStep.sender(testData.sender.address);
+    buildStep.sequenceNumber(123);
+    buildStep.publicKey(testData.sender.publicKey);
+    buildStep.expireTime(1700000000);
+    buildStep.send({ address: poolAddress, amount: depositAmount });
+    buildStep.setDepositMessage();
+
+    const builtTx = await buildStep.build();
+    const rawBoc = builtTx.toBroadcastFormat();
+
+    // 2. Parse it back (Simulate receiving from chain/API)
+    const parseStep = factory.from(rawBoc);
+    const parsedTx = await parseStep.build();
+    const parsedJson = parsedTx.toJson();
+
+    // 3. Verify Parsing Logic correctly identified it as TonWhalesDeposit
+    should.equal(parsedTx.type, TransactionType.TonWhalesDeposit);
+
+    // Verify fields persisted
+    parsedJson.seqno.should.equal(123);
+    parsedJson.expirationTime.should.equal(1700000000);
+    parsedJson.amount.should.equal(depositAmount);
+    parsedJson.destination.should.equal(poolAddress);
+    parsedJson.sender.should.equal(testData.sender.address);
+  });
+
+  it('should build a signed deposit tx using add signature', async function () {
+    // Use private key from fixtures
+    const keyPair = new KeyPair({ prv: testData.privateKeys.prvKey1 });
+    const publicKey = keyPair.getKeys().pub;
+    const address = await utils.default.getAddressFromPublicKey(publicKey);
+
+    const txBuilder = factory.getTonWhalesDepositBuilder();
+    txBuilder.sender(address);
+    txBuilder.sequenceNumber(0);
+    txBuilder.publicKey(publicKey);
+    const expireAt = Math.floor(Date.now() / 1e3) + 60 * 60 * 24 * 7;
+    txBuilder.expireTime(expireAt);
+
+    txBuilder.send({ address: poolAddress, amount: depositAmount });
+    txBuilder.setDepositMessage();
+
+    const tx = await txBuilder.build();
+
+    // Sign
+    const signable = tx.signablePayload;
+    const signature = keyPair.signMessageinUint8Array(signable);
+
+    // Add Signature
+    txBuilder.addSignature(keyPair.getKeys(), Buffer.from(signature));
+
+    const signedTx = await txBuilder.build();
+
+    // Re-parse to verify signature attachment
+    const builder2 = factory.from(signedTx.toBroadcastFormat());
+    const tx2 = await builder2.build();
+
+    should.equal(tx.toBroadcastFormat(), tx2.toBroadcastFormat());
+    should.equal(tx2.type, TransactionType.TonWhalesDeposit);
+    should.exist(tx2.toJson().signature);
+  });
+
+  it('should build deposit tx with bounceable flag', async function () {
+    const txBuilder = factory.getTonWhalesDepositBuilder();
+    txBuilder.sender(testData.sender.address);
+    txBuilder.sequenceNumber(0);
+    txBuilder.publicKey(testData.sender.publicKey);
+    txBuilder.expireTime(1234567890);
+
+    txBuilder.send({ address: poolAddress, amount: depositAmount });
+    txBuilder.setDepositMessage();
+
+    // Set Bounceable
+    txBuilder.bounceable(true);
+
+    const tx = await txBuilder.build();
+    should.equal(tx.type, TransactionType.TonWhalesDeposit);
+    should.equal(tx.toJson().bounceable, true);
+
+    // Round trip verification
+    const builder2 = factory.from(tx.toBroadcastFormat());
+    const tx2 = await builder2.build();
+    should.equal(tx2.toJson().bounceable, true);
+  });
+});
diff --git a/modules/sdk-core/src/account-lib/baseCoin/enum.ts b/modules/sdk-core/src/account-lib/baseCoin/enum.ts
@@ -119,6 +119,10 @@ export enum TransactionType {
 
   // flrp
   ImportToC,
+
+  // ton whales
+  TonWhalesDeposit,
+  TonWhalesWithdraw,
 }
 
 /**

Original file line number	Diff line number	Diff line change
`@@ -119,6 +119,10 @@ export enum TransactionType {`
`119`	`119`
`120`	`120`	`// flrp`
`121`	`121`	`ImportToC,`
	`122`	`+`
	`123`	`+ // ton whales`
	`124`	`+ TonWhalesDeposit,`
	`125`	`+ TonWhalesWithdraw,`
`122`	`126`	`}`
`123`	`127`
`124`	`128`	`/**`