Skip to main content
Version: 1.15.0

Class: SetCCIPAdmin

Defined in: cct/evm/token/operations/set-ccip-admin.ts:33

Sets a CrossChainToken CCIP admin via setCCIPAdmin.

Extends​

Constructors​

Constructor​

new SetCCIPAdmin(): SetCCIPAdmin

Returns​

SetCCIPAdmin

Inherited from​

EVMOperation<SetCCIPAdminParams>.constructor

Properties​

name​

readonly name: "setCCIPAdmin" = 'setCCIPAdmin'

Defined in: cct/evm/token/operations/set-ccip-admin.ts:34

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

Overrides​

EVMOperation.name

Methods​

buildUnsigned()​

protected buildUnsigned(chain: EVMChain, __namedParameters: SetCCIPAdminParams): Promise<UnsignedEVMTx>

Defined in: cct/evm/token/operations/set-ccip-admin.ts:53

Resolves the v2 encoder and confirms sender (when known) is the current default admin.

Parameters​

ParameterType
chainEVMChain
__namedParametersSetCCIPAdminParams

Returns​

Promise<UnsignedEVMTx>

Throws​

CCTContractTypeInvalidError if tokenAddress is not a CrossChainToken

Throws​

CCTContractVersionUnsupportedError if it reports an unknown token version

Throws​

CCTOperationUnsupportedError if no encoder supports the resolved version

Throws​

CCTParamsInvalidError if the token has no default admin or sender is not it

Overrides​

EVMOperation.buildUnsigned


execute()​

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

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

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

Parameters​

ParameterType
chainEVMChain
paramsEVMExecuteParams<SetCCIPAdminParams>

Returns​

Promise<TransactionResult>

Inherited from​

EVMOperation.execute


generate()​

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

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

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

Parameters​

ParameterType
chainEVMChain
paramsSetCCIPAdminParams

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: SetCCIPAdminParams): SetCCIPAdminParams

Defined in: cct/operation.ts:42

Normalize validated params for the builder — defaults, conversions, derived values. Identity by default, so an op that needs no normalization declares nothing.

Parameters​

ParameterType
paramsSetCCIPAdminParams

Returns​

SetCCIPAdminParams

Inherited from​

EVMOperation.parse


prepare()​

protected prepare(params: SetCCIPAdminParams): SetCCIPAdminParams

Defined in: cct/operation.ts:48

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

Parameters​

ParameterType
paramsSetCCIPAdminParams

Returns​

SetCCIPAdminParams

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(__namedParameters: SetCCIPAdminParams): void

Defined in: cct/evm/token/operations/set-ccip-admin.ts:40

Validates addresses before any RPC; v2 CrossChainToken deliberately allows zero newAdmin.

Parameters​

ParameterType
__namedParametersSetCCIPAdminParams

Returns​

void

Overrides​

EVMOperation.validate