address comments, rename buildMessageForDest

Author: andrevmatos

ccip-cli/src/commands/send.ts

@@ -233,7 +233,7 @@ async function sendMessage(
   }
 
   // builds a catch-all extraArgs object, which can be massaged by
-  // [[Chain.populateDefaultMessageForDest]] to create suitable extraArgs with defaults if needed
+  // [[Chain.buildMessageForDest]] to create suitable extraArgs with defaults if needed
   const extraArgs = {
     ...(argv.allowOutOfOrderExec != null && {
       allowOutOfOrderExecution: !!argv.allowOutOfOrderExec,

ccip-sdk/src/aptos/index.ts

@@ -90,11 +90,11 @@ import { getUserTxByVersion, getVersionTimestamp, streamAptosLogs } from './logs
 import { getTokenInfo } from './token.ts'
 import type { CCIPMessage_V1_6_EVM } from '../evm/messages.ts'
 import {
+  buildMessageForDest,
   decodeMessage,
   getMessageById,
   getMessagesInBatch,
   getMessagesInTx,
-  populateDefaultMessageForDest,
 } from '../requests.ts'
 export type { UnsignedAptosTx }
 
@@ -537,26 +537,29 @@ export class AptosChain extends Chain<typeof ChainFamily.Aptos> {
     destChainSelector,
     message,
   }: Parameters<Chain['getFee']>[0]): Promise<bigint> {
-    const message_ = populateDefaultMessageForDest(message, networkInfo(destChainSelector).family)
-    return getFee(this.provider, router, destChainSelector, message_)
+    const populatedMessage = buildMessageForDest(message, networkInfo(destChainSelector).family)
+    return getFee(this.provider, router, destChainSelector, populatedMessage)
   }
 
   /** {@inheritDoc Chain.generateUnsignedSendMessage} */
   async generateUnsignedSendMessage(
     opts: Parameters<Chain['generateUnsignedSendMessage']>[0],
   ): Promise<UnsignedAptosTx> {
-    opts.message = populateDefaultMessageForDest(
+    const { sender, router, destChainSelector } = opts
+    const populatedMessage = buildMessageForDest(
       opts.message,
-      networkInfo(opts.destChainSelector).family,
+      networkInfo(destChainSelector).family,
     )
-    const { sender, router, destChainSelector, message } = opts
-    if (!message.fee) message.fee = await this.getFee(opts)
+    const message = {
+      ...populatedMessage,
+      fee: opts.message.fee ?? (await this.getFee({ ...opts, message: populatedMessage })),
+    }
     const tx = await generateUnsignedCcipSend(
       this.provider,
       sender,
       router,
       destChainSelector,
-      message as AnyMessage & { fee: bigint },
+      message,
       opts,
     )
     return {

ccip-sdk/src/chain.ts

@@ -693,9 +693,9 @@ export abstract class Chain<F extends ChainFamily = ChainFamily> {
    */
   abstract getFeeTokens(router: string): Promise<Record<string, TokenInfo>>
 
-  /** {@inheritDoc ChainStatic.populateDefaultMessageForDest} */
-  static populateDefaultMessageForDest(
-    message: Parameters<ChainStatic['populateDefaultMessageForDest']>[0],
+  /** {@inheritDoc ChainStatic.buildMessageForDest} */
+  static buildMessageForDest(
+    message: Parameters<ChainStatic['buildMessageForDest']>[0],
   ): AnyMessage {
     // default to GenericExtraArgsV2, aka EVMExtraArgsV2
     return {
@@ -798,7 +798,7 @@ export type ChainStatic<F extends ChainFamily = ChainFamily> = Function & {
    * @param message - AnyMessage (from source), containing at least `receiver`
    * @returns A message suitable for `sendMessage` to this destination chain family
    */
-  populateDefaultMessageForDest(message: RequestMessage): AnyMessage
+  buildMessageForDest(message: RequestMessage): AnyMessage
 }
 
 /** Function type for getting a Chain instance by ID, selector, or name. */

ccip-sdk/src/evm/index.ts

@@ -64,6 +64,7 @@ import {
 import type { LeafHasher } from '../hasher/common.ts'
 import { supportedChains } from '../supported-chains.ts'
 import {
+  type AnyMessage,
   type CCIPExecution,
   type CCIPMessage,
   type CCIPRequest,
@@ -117,10 +118,10 @@ import {
 } from './messages.ts'
 import { encodeEVMOffchainTokenData, fetchEVMOffchainTokenData } from './offchain.ts'
 import {
+  buildMessageForDest,
   getMessageById,
   getMessagesInBatch,
   getMessagesInTx,
-  populateDefaultMessageForDest,
 } from '../requests.ts'
 import type { UnsignedEVMTx } from './types.ts'
 export type { UnsignedEVMTx }
@@ -965,18 +966,20 @@ export class EVMChain extends Chain<typeof ChainFamily.EVM> {
     destChainSelector,
     message,
   }: Parameters<Chain['getFee']>[0]): Promise<bigint> {
-    const message_ = populateDefaultMessageForDest(message, networkInfo(destChainSelector).family)
+    const populatedMessage = buildMessageForDest(message, networkInfo(destChainSelector).family)
     const contract = new Contract(
       router,
       interfaces.Router,
       this.provider,
     ) as unknown as TypedContract<typeof Router_ABI>
     return contract.getFee(destChainSelector, {
-      receiver: zeroPadValue(getAddressBytes(message.receiver), 32),
-      data: hexlify(message_.data ?? '0x'),
-      tokenAmounts: message.tokenAmounts ?? [],
-      feeToken: message.feeToken ?? ZeroAddress,
-      extraArgs: hexlify((this.constructor as typeof EVMChain).encodeExtraArgs(message.extraArgs)),
+      receiver: zeroPadValue(getAddressBytes(populatedMessage.receiver), 32),
+      data: hexlify(populatedMessage.data ?? '0x'),
+      tokenAmounts: populatedMessage.tokenAmounts ?? [],
+      feeToken: populatedMessage.feeToken ?? ZeroAddress,
+      extraArgs: hexlify(
+        (this.constructor as typeof EVMChain).encodeExtraArgs(populatedMessage.extraArgs),
+      ),
     })
   }
 
@@ -988,15 +991,21 @@ export class EVMChain extends Chain<typeof ChainFamily.EVM> {
   async generateUnsignedSendMessage(
     opts: Parameters<Chain['generateUnsignedSendMessage']>[0],
   ): Promise<UnsignedEVMTx> {
-    const { sender, router, destChainSelector, message } = opts
-    if (!message.fee) message.fee = await this.getFee(opts)
+    const { sender, router, destChainSelector } = opts
+    const populatedMessage = buildMessageForDest(
+      opts.message,
+      networkInfo(destChainSelector).family,
+    )
+    const message = {
+      ...populatedMessage,
+      fee: opts.message.fee ?? (await this.getFee({ ...opts, message: populatedMessage })),
+    }
+
     const feeToken = message.feeToken ?? ZeroAddress
     const receiver = zeroPadValue(getAddressBytes(message.receiver), 32)
-
-    const message_ = populateDefaultMessageForDest(message, networkInfo(destChainSelector).family)
-    const data = hexlify(message_.data ?? '0x')
+    const data = hexlify(message.data ?? '0x')
     const extraArgs = hexlify(
-      (this.constructor as typeof EVMChain).encodeExtraArgs(message_.extraArgs),
+      (this.constructor as typeof EVMChain).encodeExtraArgs(message.extraArgs),
     )
 
     // make sure to approve once per token, for the total amount (including fee, if needed)