Skip to main content
Version: 1.15.0

Type Alias: RegisterAdminParams

RegisterAdminParams = { address: string; registrationMethod?: RegisterAdminMethod; registryModule: string; sender?: string; tokenAddress: string; }

Defined in: cct/evm/token-admin-registry/operations/register-admin.ts:70

Parameters for RegisterAdmin. One shape for every RegistryModuleOwnerCustom version: RegisterAdmin.buildUnsigned resolves the module's own version, which only decides whether access-control-default-admin exists (added at v1.6.0). The administrator itself is never a parameter — see REGISTRATION.

Properties​

address​

address: string

Defined in: cct/evm/token-admin-registry/operations/register-admin.ts:83

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.


registrationMethod?​

optional registrationMethod?: RegisterAdminMethod

Defined in: cct/evm/token-admin-registry/operations/register-admin.ts:88

Selects how control is proved; defaults to owner. access-control-default-admin needs a v1.6.0+ module, and is rejected against a v1.5.0 one.


registryModule​

registryModule: string

Defined in: cct/evm/token-admin-registry/operations/register-admin.ts:77

RegistryModuleOwnerCustom to call. The TAR exposes isRegistryModule but no enumeration, so — unlike address below — this can't be discovered on-chain and must be supplied.


sender?​

optional sender?: string

Defined in: cct/evm/token-admin-registry/operations/register-admin.ts:95

Address the registration is authorized against. Optional here, unlike transferAdmin and acceptAdmin which reject an omitted sender: leaving it out SKIPS the token-authority probe in RegisterAdmin.buildUnsigned, so the tx builds without that check and can then only fail on-chain. RegisterAdmin.execute defaults it to the signing wallet.


tokenAddress​

tokenAddress: string

Defined in: cct/evm/token-admin-registry/operations/register-admin.ts:72

Token to register. Stays unregistered until acceptAdmin is called by the proposed admin.