Skip to main content
Version: 1.15.0

Class: AddRemotePool

Defined in: cct/evm/token-pool/operations/add-remote-pool.ts:59

Authorizes an additional remote pool on one lane of a v1.5.1+ pool via addRemotePool.

Extends​

Constructors​

Constructor​

new AddRemotePool(): AddRemotePool

Returns​

AddRemotePool

Inherited from​

EVMOperation<AddRemotePoolParams, ParsedAddRemotePoolParams>.constructor

Properties​

name​

readonly name: "addRemotePool" = 'addRemotePool'

Defined in: cct/evm/token-pool/operations/add-remote-pool.ts:60

camelCase id; matches the token-manager facade method and error context.

Overrides​

EVMOperation.name

Methods​

buildUnsigned()​

protected buildUnsigned(chain: EVMChain, params: ParsedRemotePoolParams): Promise<UnsignedEVMTx>

Defined in: cct/evm/token-pool/operations/add-remote-pool.ts:90

Resolves the pool's version (rejecting v1.5.0), confirms sender owns the pool, then rejects a duplicate: the lane's currently registered remote pools are read scoped to this one selector, and an address already among them would revert on-chain (PoolAlreadyAdded). A lane that is not configured yet reads as having none — see readRegisteredRemotePools.

Parameters​

ParameterType
chainEVMChain
paramsParsedRemotePoolParams

Returns​

Promise<UnsignedEVMTx>

Throws​

CCTOperationUnsupportedError if the pool is v1.5.0

Throws​

CCTParamsInvalidError if sender is given and is not the pool owner, or if remotePoolAddress is already registered on this lane

Overrides​

EVMOperation.buildUnsigned


execute()​

execute(chain: EVMChain, params: EVMExecuteParams<RemotePoolParams>): Promise<TransactionResult>

Defined in: cct/evm/operation.ts:150

generate, then sign and submit; returns the confirmed tx hash.

Parameters​

ParameterType
chainEVMChain
paramsEVMExecuteParams<RemotePoolParams>

Returns​

Promise<TransactionResult>

Inherited from​

EVMOperation.execute


generate()​

generate(chain: EVMChain, params: RemotePoolParams): Promise<UnsignedEVMTx>

Defined in: cct/evm/operation.ts:110

Run prepare and buildUnsigned, applying optional sender; no signing.

Parameters​

ParameterType
chainEVMChain
paramsRemotePoolParams

Returns​

Promise<UnsignedEVMTx>

Remarks​

Also pins every built transaction to chain.network.chainId (no RPC, known at construction). This is the one point every CCT builder and both execute paths pass through; unpinned, ethers would infer the chain from the eventual signer's provider.

Inherited from​

EVMOperation.generate


parse()​

protected parse(params: RemotePoolParams): ParsedRemotePoolParams

Defined in: cct/evm/token-pool/operations/add-remote-pool.ts:76

Validates the pool address, lane selector and remote pool address before any RPC, keeping the parsed remotePoolAddress so buildUnsigned checks and encodes it without re-parsing.

Parameters​

ParameterType
paramsRemotePoolParams

Returns​

ParsedRemotePoolParams

Overrides​

EVMOperation.parse


prepare()​

protected prepare(params: RemotePoolParams): ParsedRemotePoolParams

Defined in: cct/operation.ts:48

validate then parse — the single pre-RPC step, before any chain access.

Parameters​

ParameterType
paramsRemotePoolParams

Returns​

ParsedRemotePoolParams

Inherited from​

EVMOperation.prepare


resolveWalletSender()​

protected resolveWalletSender(wallet: unknown, sender?: string): Promise<string>

Defined in: cct/evm/operation.ts:130

Resolves the address a signed submission is authorized against: the signing wallet's own. The chain gates on msg.sender, and submit clears any builder-set tx.from before populating the tx (so ethers' own from/signer guard never fires) — an explicit sender that differs from the wallet would therefore let an op's pre-tx checks authorize one address while a different one actually signs, passing every local guard and reverting on-chain. Ops that gate on an on-chain role call this from execute; build with generateUnsigned* instead when the eventual signer isn't known yet, where sender is trusted as given.

Parameters​

ParameterType
walletunknown
sender?string

Returns​

Promise<string>

Throws​

CCIPWalletInvalidError if wallet is not a valid signer

Throws​

CCTParamsInvalidError if sender is given and is not the wallet's address

Inherited from​

EVMOperation.resolveWalletSender


validate()​

protected validate(_params: RemotePoolParams): void

Defined in: cct/operation.ts:36

Reject invalid params before any chain RPC. No-op by default: an op that normalizes as it checks does that work in parse instead, and needs no empty stub here.

Parameters​

ParameterType
_paramsRemotePoolParams

Returns​

void

Inherited from​

EVMOperation.validate