Skip to main content
Version: 1.15.0

Type Alias: TransferAdminParams

TransferAdminParams = { address: string; newAdmin: string; sender?: string; tokenAddress: string; }

Defined in: cct/evm/token-admin-registry/operations/transfer-admin.ts:36

Parameters for TransferAdmin.

Remarks​

sender is typed optional to satisfy EVMOperation's shared shape, but is required for TransferAdmin.generate: the pre-tx check below has nothing to compare administrator against without it, so an omitted sender is rejected in TransferAdmin.parse. TransferAdmin.execute relaxes this — it defaults sender to the signing wallet's own address, the only address that can satisfy the current-administrator check for a signed submission (see TransferAdmin.execute).

Properties​

address​

address: string

Defined in: cct/evm/token-admin-registry/operations/transfer-admin.ts:48

Contract to resolve the TokenAdminRegistry from. Pass the registry itself for a direct lookup; a Router, OnRamp, OffRamp, or TokenPool also work but add hops and need a configured lane.


newAdmin​

newAdmin: string

Defined in: cct/evm/token-admin-registry/operations/transfer-admin.ts:42

The administrator proposed to accept the token's registry admin role. Pass ZeroAddress to cancel any pending transfer — the pending proposal is discarded without accepting the role.


sender?​

optional sender?: string

Defined in: cct/evm/token-admin-registry/operations/transfer-admin.ts:56

Current registry administrator. Required for TransferAdmin.generate (unsigned/offline flows) — buildUnsigned must read the registry and confirm the caller is the current administrator before encoding a tx, so it needs to know who that caller is up front. Optional for TransferAdmin.execute, which defaults it to the wallet's address — see the remarks above.


tokenAddress​

tokenAddress: string

Defined in: cct/evm/token-admin-registry/operations/transfer-admin.ts:38

Token whose registry admin role is being handed over.