Merge branch 'master' into COIN-7315-kava-sdk-support

TICKET: COIN-7315

Author: abhijeet8986

.iyarc

@@ -6,8 +6,8 @@
 GHSA-8qq5-rm4j-mr97
 
 # Excluded because:
-# - Same tar v6 dependency issue as above
-# - Affects only dev dependencies (lerna, yeoman-generator)
-# - Not exploitable in our build context
+# - Transitive dependency through lerna and yeoman-generator, which currently pin tar to a
+#   < 7.5.4 range; We only use their tar integration for
+#   archive PACKING, not extraction,
 GHSA-r6q2-hw4h-h46w
 

Dockerfile

@@ -2,7 +2,7 @@
 # An elaborated scheme to build all the dependencies of all packages first in a cached layer
 # https://stackoverflow.com/a/63142468/134409
 # https://medium.com/@emilefugulin/building-a-sane-docker-image-for-typescript-lerna-and-prisma-2-76d8ff9926e4
-FROM node:22.16.0-bookworm-slim@sha256:2f3571619daafc6b53232ebf2fcc0817c1e64795e92de317c1684a915d13f1a5 AS filter-packages-json
+FROM node:22.22.0-bookworm-slim@sha256:f86be15afa9a8277608e141ce2a8aa55d3d9c40845921b8511f4fb7897be2554 AS filter-packages-json
 LABEL maintainer="Developer Relations <developer-relations-team@bitgo.com>"
 
 COPY package.json yarn.lock lerna.json ./
@@ -12,7 +12,7 @@ COPY modules ./modules
 # delete all the non package.json files under `./modules/`
 RUN find modules \! -name "package.json" -mindepth 2 -maxdepth 2 -print | xargs rm -rf
 
-FROM node:22.16.0-bookworm-slim@sha256:2f3571619daafc6b53232ebf2fcc0817c1e64795e92de317c1684a915d13f1a5 AS builder
+FROM node:22.22.0-bookworm-slim@sha256:f86be15afa9a8277608e141ce2a8aa55d3d9c40845921b8511f4fb7897be2554 AS builder
 RUN apt-get update && apt-get install -y git python3 make g++ libtool autoconf automake
 WORKDIR /tmp/bitgo
 COPY --from=filter-packages-json /tmp/bitgo .
@@ -31,7 +31,7 @@ RUN \
     rm -r modules/*/src
 
 
-FROM node:22.16.0-bookworm-slim@sha256:2f3571619daafc6b53232ebf2fcc0817c1e64795e92de317c1684a915d13f1a5
+FROM node:22.22.0-bookworm-slim@sha256:f86be15afa9a8277608e141ce2a8aa55d3d9c40845921b8511f4fb7897be2554
 RUN apt-get update && apt-get install -y tini
 # copy the root node_modules to the bitgo-express parent node_modules
 COPY --from=builder /tmp/bitgo/node_modules  /var/node_modules/

modules/sdk-coin-ada/src/lib/transaction.ts

@@ -446,3 +446,8 @@ export class Transaction extends BaseTransaction {
     this._fee = fee;
   }
 }
+
+export interface SponsorshipInfo {
+  feeAddress: string;
+  feeAddressInputBalance: string;
+}

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

@@ -10,7 +10,7 @@ import {
   TransactionType,
   UtilsError,
 } from '@bitgo/sdk-core';
-import { Asset, Transaction, TransactionInput, TransactionOutput, Withdrawal } from './transaction';
+import { Asset, Transaction, TransactionInput, TransactionOutput, Withdrawal, SponsorshipInfo } from './transaction';
 import { KeyPair } from './keyPair';
 import util, { MIN_ADA_FOR_ONE_ASSET } from './utils';
 import * as CardanoWasm from '@emurgo/cardano-serialization-lib-nodejs';
@@ -46,6 +46,7 @@ export abstract class TransactionBuilder extends BaseTransactionBuilder {
   protected _recipientAddress: string;
   /** Map of sender's assets by asset name */
   protected _senderAssetList: Record<string, any> = {};
+  protected _sponsorshipInfo: SponsorshipInfo | undefined; // Enriched for sponsored transactions
   private _fee: BigNum;
   /** Flag indicating if this is a token transaction */
   private _isTokenTransaction = false;
@@ -113,6 +114,11 @@ export abstract class TransactionBuilder extends BaseTransactionBuilder {
     return this;
   }
 
+  sponsorshipInfo(info: SponsorshipInfo): this {
+    this._sponsorshipInfo = info;
+    return this;
+  }
+
   /**
    * Initialize the transaction builder fields using the decoded transaction data
    *
@@ -219,10 +225,26 @@ export abstract class TransactionBuilder extends BaseTransactionBuilder {
    * @param outputs - The outputs collection to add to
    */
   private addOutputs(outputs) {
-    const utxoBalance = CardanoWasm.BigNum.from_str(this._senderBalance); // Total UTXO balance
-    const change = utxoBalance.checked_sub(this._fee);
-    const changeAfterReceiverDeductions = this.addReceiverOutputs(outputs, change);
-    this.addChangeOutput(changeAfterReceiverDeductions, outputs);
+    if (this._sponsorshipInfo) {
+      const feeAddressUtxoBalance = CardanoWasm.BigNum.from_str(this._sponsorshipInfo.feeAddressInputBalance);
+      let feeAddressChange = feeAddressUtxoBalance.checked_sub(this._fee);
+      const senderAddressUtxoBalance = CardanoWasm.BigNum.from_str(this._senderBalance);
+      if (this._isTokenTransaction) {
+        // Fee address sponsors min ada
+        feeAddressChange = this.addReceiverOutputs(outputs, feeAddressChange);
+        this.addChangeOutput(senderAddressUtxoBalance, outputs, this._changeAddress);
+        this.addChangeOutput(feeAddressChange, outputs, this._sponsorshipInfo.feeAddress);
+      } else {
+        const senderChangeAfterReceiverDeductions = this.addReceiverOutputs(outputs, senderAddressUtxoBalance);
+        this.addChangeOutput(senderChangeAfterReceiverDeductions, outputs, this._changeAddress);
+        this.addChangeOutput(feeAddressChange, outputs, this._sponsorshipInfo.feeAddress);
+      }
+    } else {
+      const utxoBalance = CardanoWasm.BigNum.from_str(this._senderBalance); // Total UTXO balance
+      const change = utxoBalance.checked_sub(this._fee);
+      const changeAfterReceiverDeductions = this.addReceiverOutputs(outputs, change);
+      this.addChangeOutput(changeAfterReceiverDeductions, outputs, this._changeAddress);
+    }
   }
 
   /**
@@ -250,6 +272,7 @@ export abstract class TransactionBuilder extends BaseTransactionBuilder {
           );
         }
 
+        // output.multiAssets is set when there are token assets to send
         const multiAssets = output.multiAssets as Asset;
         if (multiAssets) {
           const policyId = multiAssets.policy_id;
@@ -273,6 +296,12 @@ export abstract class TransactionBuilder extends BaseTransactionBuilder {
           });
 
           change = change.checked_sub(minAmountNeededForAssetOutput);
+        } else {
+          // Native coin send
+          const amount = CardanoWasm.BigNum.from_str(receiverAmount);
+          outputs.add(
+            CardanoWasm.TransactionOutput.new(util.getWalletAddress(receiverAddress), CardanoWasm.Value.new(amount))
+          );
         }
       } catch (e) {
         if (e instanceof BuildTransactionError) {
@@ -337,26 +366,32 @@ export abstract class TransactionBuilder extends BaseTransactionBuilder {
    * @param change - The change amount in Lovelace
    * @param outputs - The outputs collection to add to
    */
-  private addChangeOutput(change, outputs) {
-    const changeAddress = util.getWalletAddress(this._changeAddress);
-    Object.keys(this._mutableSenderAssetList).forEach((fingerprint) => {
-      const asset = this._mutableSenderAssetList[fingerprint];
-      const changeQty = asset.quantity;
-      const policyId = asset.policy_id;
-      const assetName = asset.asset_name;
-
-      if (CardanoWasm.BigNum.from_str(changeQty).is_zero()) {
-        return;
-      }
+  private addChangeOutput(change, outputs, outputAddress) {
+    const changeAddress = util.getWalletAddress(outputAddress);
+    /**
+     * this.mutableSenderAssetList is the list of assets from the sender address
+     * As ada only utxos are picked for fee address, the assets by default are sent to the sender address
+     */
+    if (!this._sponsorshipInfo || this._sponsorshipInfo.feeAddress !== outputAddress) {
+      Object.keys(this._mutableSenderAssetList).forEach((fingerprint) => {
+        const asset = this._mutableSenderAssetList[fingerprint];
+        const changeQty = asset.quantity;
+        const policyId = asset.policy_id;
+        const assetName = asset.asset_name;
+
+        if (CardanoWasm.BigNum.from_str(changeQty).is_zero()) {
+          return;
+        }
 
-      const minAmountNeededForAssetOutput = this.addTokensToOutput(change, outputs, this._changeAddress, {
-        policy_id: policyId,
-        asset_name: assetName,
-        quantity: changeQty,
-        fingerprint,
+        const minAmountNeededForAssetOutput = this.addTokensToOutput(change, outputs, outputAddress, {
+          policy_id: policyId,
+          asset_name: assetName,
+          quantity: changeQty,
+          fingerprint,
+        });
+        change = change.checked_sub(minAmountNeededForAssetOutput);
       });
-      change = change.checked_sub(minAmountNeededForAssetOutput);
-    });
+    }
     if (!change.is_zero()) {
       const changeOutput = CardanoWasm.TransactionOutput.new(changeAddress, CardanoWasm.Value.new(change));
       outputs.add(changeOutput);
@@ -436,7 +471,7 @@ export abstract class TransactionBuilder extends BaseTransactionBuilder {
 
   /** @inheritdoc */
   protected async buildImplementation(): Promise<Transaction> {
-    if (this._isTokenTransaction) {
+    if (this._isTokenTransaction || (this._sponsorshipInfo && this._type === TransactionType.Send)) {
       return this.processTokenBuild();
     }
     const inputs = CardanoWasm.TransactionInputs.new();

modules/sdk-coin-ada/test/unit/tokenWithdrawal.ts

@@ -326,4 +326,76 @@ describe('ADA Token Operations', async () => {
 
     await txBuilder.build().should.not.be.rejected();
   });
+
+  it(`should build a sponsored token transaction where fee address sponsors min ADA for receiver`, async () => {
+    const feeAddress =
+      'addr_test1qz2fxv2umyhttkxyxp8x0dlpdt3k6cwng5pxj3jhsydzer3jcu5d8ps7zex2k2xt3uqxgjqnnj83ws8lhrn648jjxtwq2ytjqp';
+    const quantity = '20';
+    const senderInputBalance = 5000000;
+    const feeAddressInputBalance = 20000000; // Fee address has enough ADA to sponsor
+    const totalAssetList = {
+      [fingerprint]: {
+        quantity: '100',
+        policy_id: policyId,
+        asset_name: asciiEncodedName,
+      },
+    };
+
+    const txBuilder = factory.getTransferBuilder();
+    // Sender input (has tokens)
+    txBuilder.input({
+      transaction_id: '3677e75c7ba699bfdc6cd57d42f246f86f63aefd76025006ac78313fad2bba21',
+      transaction_index: 1,
+    });
+    // Fee address input (sponsors fees and min ADA)
+    txBuilder.input({
+      transaction_id: '3677e75c7ba699bfdc6cd57d42f246f86f63aefd76025006ac78313fad2bba22',
+      transaction_index: 0,
+    });
+
+    txBuilder.output({
+      address: receiverAddress,
+      amount: '0', // Set ADA amount to 0 for token transfer (min ADA is handled by fee address)
+      multiAssets: {
+        asset_name: asciiEncodedName,
+        policy_id: policyId,
+        quantity,
+        fingerprint,
+      },
+    });
+
+    txBuilder.changeAddress(senderAddress, senderInputBalance.toString(), totalAssetList);
+    txBuilder.sponsorshipInfo({
+      feeAddress: feeAddress,
+      feeAddressInputBalance: feeAddressInputBalance.toString(),
+    });
+    txBuilder.ttl(800000000);
+    txBuilder.isTokenTransaction();
+    const tx = (await txBuilder.build()) as Transaction;
+
+    should.equal(tx.type, TransactionType.Send);
+    const txData = tx.toJson();
+
+    txData.inputs.length.should.equal(2);
+    txData.outputs.length.should.equal(4);
+
+    // Validate receiver output - min ADA should be sponsored by fee address
+    const receiverOutput = txData.outputs.filter((output) => output.address === receiverAddress);
+    receiverOutput.length.should.equal(1);
+    receiverOutput[0].amount.should.equal('1500000'); // Minimum ADA for asset output (sponsored by fee address)
+    (receiverOutput[0].multiAssets! as CardanoWasm.MultiAsset)
+      .get_asset(policyScriptHash, CardanoWasm.AssetName.new(Buffer.from(asciiEncodedName, 'hex')))
+      .to_str()
+      .should.equal(quantity);
+
+    // Validate sender change output - should have full sender balance (tokens only, no ADA deduction for receiver)
+    const senderChangeOutput = txData.outputs.filter((output) => output.address === senderAddress);
+    senderChangeOutput.length.should.be.equal(2);
+
+    // Validate fee address change output - should have remaining ADA after fees and min ADA for receiver
+    const feeAddressChangeOutput = txData.outputs.filter((output) => output.address === feeAddress);
+    feeAddressChangeOutput.length.should.equal(1);
+    // Fee address change should not have any tokens
+    should.not.exist(feeAddressChangeOutput[0].multiAssets);
+  });
 });

modules/sdk-coin-cosmos/test/resources/kava.ts

@@ -0,0 +1,91 @@
+/**
+ * Kava test data for the sdk-coin-cosmos module
+ * This file extends the base configuration with kava-specific data
+ */
+
+import { generateCoinData } from '../testUtils';
+
+export const chainConfig = {
+  mainnetName: 'Kava',
+  mainnetCoin: 'kava',
+  testnetName: 'Testnet Kava',
+  testnetCoin: 'tkava',
+  family: 'kava',
+  decimalPlaces: 6,
+  baseDenom: 'ukava',
+  chainId: 'kava_2221-16000',
+  addressPrefix: 'kava',
+  validatorPrefix: 'kavavaloper',
+};
+
+export const DEFAULTS = {
+  senderAddress: 'kava1cyyzpxplxdzkeea7kwsydadg87357qnarn3sk9',
+  pubKey: 'AuwYyCUBxQiBGSUWebU46c+OrlApVsyGLHd4qhSDZeiG',
+  privateKey: 'SNI8xBejBnTpB6JAPxCfCC2S4ZeCPQLmpCPGrrjkEgQ=',
+  recipientAddress1: 'kava18s5lynnmx37hq4wlrw9gdn68sg2uxp5rucdhve',
+  recipientAddress2: 'kava1c6mj5v5wpjl6zs7lz0l6dlv3r4ccqaa4grcurq',
+  sendMessageTypeUrl: '/cosmos.bank.v1beta1.MsgSend',
+  sendAmount: '1000',
+  feeAmount: '5000',
+  gasLimit: 200000,
+  validatorAddress1: 'kavavaloper1q8mgs55hfgkm7d5rret439997x87s2ek00qcs9',
+  validatorAddress2: 'kavavaloper1ea4hlqfskjvn0ldenw8gv7jjdzrljcchxcmnqq',
+};
+
+export const TEST_SEND_TX = {
+  hash: 'A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4E5F6A1B2',
+  signature: 'OnBWLyOUqNqX7h65Dtfna4W1vU4+OEVZPZLOffO+amNnHHwoFQZMnVK1+s4Y5/arizHXdbFTtrIG1ANWJz94zw==',
+  signedTxBase64:
+    'CowBCokBChwvY29zbW9zLmJhbmsudjFiZXRhMS5Nc2dTZW5kEmkKK2thdmExY3l5enB4cGx4ZHprZWVhN2t3c3lkYWRnODczNTdxbmFybjNzazkSK2thdmExOHM1bHlubm14MzdocTR3bHJ3OWdkbjY4c2cydXhwNXJ1Y2RodmUaDQoFdWthdmESBDEwMDASZwpQCkYKHy9jb3Ntb3MuY3J5cHRvLnNlY3AyNTZrMS5QdWJLZXkSIwohAuwYyCUBxQiBGSUWebU46c+OrlApVsyGLHd4qhSDZeiGEgQKAggBGBQSEwoNCgV1a2F2YRIENTAwMBDAmgwaQDpwVi8jlKjal+4euQ7X52uFtb1OPjhFWT2Szn3zvmpjZxx8KBUGTJ1StfrOGOf2q4sx13WxU7ayBtQDVic/eM8=',
+  accountNumber: 182114,
+  sequence: 20,
+  sendAmount: '1000',
+};
+
+export const TEST_SEND_TX2 = {
+  hash: 'B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3',
+  signature: 'nCRo4QhtTTldC+bQadH6Dqplm8s9UuRtXVmQqvVriKkWFGlO/n70VvbB+YuQ8sYc1q06AapkWpt/mD4HQbgG3w==',
+  signedTxBase64:
+    'CokBCoYBChwvY29zbW9zLmJhbmsudjFiZXRhMS5Nc2dTZW5kEmYKK2thdmExY3l5enB4cGx4ZHprZWVhN2t3c3lkYWRnODczNTdxbmFybjNzazkSK2thdmExOHM1bHlubm14MzdocTR3bHJ3OWdkbjY4c2cydXhwNXJ1Y2RodmUaCgoFdWthdmESATESZwpQCkYKHy9jb3Ntb3MuY3J5cHRvLnNlY3AyNTZrMS5QdWJLZXkSIwohAuwYyCUBxQiBGSUWebU46c+OrlApVsyGLHd4qhSDZeiGEgQKAggBGBQSEwoNCgV1a2F2YRIENTAwMBDAmgwaQJwkaOEIbU05XQvm0GnR+g6qZZvLPVLkbV1ZkKr1a4ipFhRpTv5+9Fb2wfmLkPLGHNatOgGqZFqbf5g+B0G4Bt8=',
+  accountNumber: 182114,
+  sequence: 20,
+  sendAmount: '1',
+};
+
+export const TEST_SEND_MANY_TX = {
+  hash: 'C3D4E5F6A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4',
+  signature: 'Opz+KYGr/pjC+iaYytf4PqRcgvFxQ3Lf0+1o3pGub0xlA6QbkySn7WS+c06rx4f27DTjHrhNflvCdhXmTCHulQ==',
+  signedTxBase64:
+    'CpICCoYBChwvY29zbW9zLmJhbmsudjFiZXRhMS5Nc2dTZW5kEmYKK2thdmExY3l5enB4cGx4ZHprZWVhN2t3c3lkYWRnODczNTdxbmFybjNzazkSK2thdmExOHM1bHlubm14MzdocTR3bHJ3OWdkbjY4c2cydXhwNXJ1Y2RodmUaCgoFdWthdmESATEKhgEKHC9jb3Ntb3MuYmFuay52MWJldGExLk1zZ1NlbmQSZgora2F2YTFjeXl6cHhwbHhkemtlZWE3a3dzeWRhZGc4NzM1N3FuYXJuM3NrORIra2F2YTFjNm1qNXY1d3BqbDZ6czdsejBsNmRsdjNyNGNjcWFhNGdyY3VycRoKCgV1a2F2YRIBMhJnClAKRgofL2Nvc21vcy5jcnlwdG8uc2VjcDI1NmsxLlB1YktleRIjCiEC7BjIJQHFCIEZJRZ5tTjpz46uUClWzIYsd3iqFINl6IYSBAoCCAEYFBITCg0KBXVrYXZhEgQ1MDAwEMCaDBpAOpz+KYGr/pjC+iaYytf4PqRcgvFxQ3Lf0+1o3pGub0xlA6QbkySn7WS+c06rx4f27DTjHrhNflvCdhXmTCHulQ==',
+  accountNumber: 182114,
+  sequence: 20,
+  sendAmount: '1',
+  sendAmount2: '2',
+  recipient2: 'kava1c6mj5v5wpjl6zs7lz0l6dlv3r4ccqaa4grcurq',
+};
+
+export const TEST_TX_WITH_MEMO = {
+  hash: 'D4E5F6A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4E5',
+  signature: '5g4qRY2kii/w1vXRXbuGGOTbDZ9Ne+MeWyPNAXyNOvUM1hbhYGIVz0xI+J10B+Ugw/GqSSB6W1lxbzvAy/mQBg==',
+  signedTxBase64:
+    'CqcBCogBChwvY29zbW9zLmJhbmsudjFiZXRhMS5Nc2dTZW5kEmgKK2thdmExY3l5enB4cGx4ZHprZWVhN2t3c3lkYWRnODczNTdxbmFybjNzazkSK2thdmExOHM1bHlubm14MzdocTR3bHJ3OWdkbjY4c2cydXhwNXJ1Y2RodmUaDAoFdWthdmESAzUwMBIaVGVzdDEyM0FscGhhbnVtZXJpY01lbW80NTYSZwpQCkYKHy9jb3Ntb3MuY3J5cHRvLnNlY3AyNTZrMS5QdWJLZXkSIwohAuwYyCUBxQiBGSUWebU46c+OrlApVsyGLHd4qhSDZeiGEgQKAggBGBQSEwoNCgV1a2F2YRIENTAwMBDAmgwaQOYOKkWNpIov8Nb10V27hhjk2w2fTXvjHlsjzQF8jTr1DNYW4WBiFc9MSPiddAflIMPxqkkgeltZcW87wMv5kAY=',
+  accountNumber: 182114,
+  sequence: 20,
+  sendAmount: '500',
+  memo: 'Test123AlphanumericMemo456',
+};
+
+export const blockHashes = {
+  hash1: 'E5F6A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4E5F6',
+  hash2: 'F6A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4E5F6A1',
+};
+
+// Generate the complete kava test data
+export const kava = generateCoinData(chainConfig, DEFAULTS, blockHashes, {
+  TEST_SEND_TX,
+  TEST_SEND_TX2,
+  TEST_SEND_MANY_TX,
+  TEST_TX_WITH_MEMO,
+});
+
+export default kava;

modules/sdk-coin-polyx/src/lib/constants.ts

@@ -11,3 +11,9 @@ export const POLYX_ADDRESS_FORMAT = 12;
  * Tpolyx testnet address format
  */
 export const TPOLYX_ADDRESS_FORMAT = 42;
+
+/**
+ * Regex pattern for validating Polymesh DID (Decentralized Identifier)
+ * DIDs are 32-byte hex strings (0x prefix + 64 hex characters)
+ */
+export const POLYX_DID_REGEX = /^0x[a-fA-F0-9]{64}$/;

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

@@ -21,7 +21,17 @@ export { BatchStakingBuilder as BatchBuilder } from './batchStakingBuilder';
 export { BatchUnstakingBuilder } from './batchUnstakingBuilder';
 export { UnbondBuilder } from './unbondBuilder';
 export { WithdrawUnbondedBuilder } from './withdrawUnbondedBuilder';
+import polyxUtils from './utils';
 export { Utils, default as utils } from './utils';
 export * from './iface';
 
 export { BondArgs, NominateArgs, BatchCallObject, BatchArgs } from './iface';
+
+/**
+ * Checks if a string is a valid Polymesh DID (Decentralized Identifier)
+ * DIDs are 32-byte hex strings (0x prefix + 64 hex characters)
+ *
+ * @param {string} did - The string to validate
+ * @returns {boolean} true if valid DID format, false otherwise
+ */
+export const isValidDid = (did: string): boolean => polyxUtils.isValidDid(did);