Class: GrantBurnRole
Defined in: cct/evm/token/operations/grant-burn-role.ts:36
Grants the burn role on a supported CCT token.
Extends
EVMOperation<GrantBurnRoleParams>
Constructors
Constructor
new GrantBurnRole():
GrantBurnRole
Returns
GrantBurnRole
Inherited from
EVMOperation<GrantBurnRoleParams>.constructor
Properties
name
readonlyname:"grantBurnRole"='grantBurnRole'
Defined in: cct/evm/token/operations/grant-burn-role.ts:37
camelCase id; matches the token-manager facade method and error context.
Overrides
EVMOperation.name
Methods
buildUnsigned()
protectedbuildUnsigned(chain:EVMChain,params:GrantBurnRoleParams):Promise<UnsignedEVMTx>
Defined in: cct/evm/token/operations/grant-burn-role.ts:66
Reads the current role state, then — when sender is known — confirms it owns the token.
The role read runs first because it is also the family check (resolveTokenRoleHandler), which
owner() cannot make: a token pool and a v2.0.0 CrossChainToken declare owner() too. Both
checks run here rather than in execute, so the offline / multisig path gets them, and
a redundant grant is rejected even though the chain would mine it as a silent no-op.
Parameters
| Parameter | Type |
|---|---|
chain | EVMChain |
params | GrantBurnRoleParams |
Returns
Promise<UnsignedEVMTx>
Throws
CCTContractTypeInvalidError if tokenAddress is neither a BurnMintERC677 token
nor a supported CrossChainToken
Throws
CCTContractVersionUnsupportedError if CrossChainToken reports an unsupported version
Throws
CCTParamsInvalidError if burner already holds the burn role, or sender
lacks the version's role-admin permission
Overrides
EVMOperation.buildUnsigned
execute()
execute(
chain:EVMChain,params:EVMExecuteParams<GrantBurnRoleParams>):Promise<TransactionResult>
Defined in: cct/evm/operation.ts:150
generate, then sign and submit; returns the confirmed tx hash.
Parameters
| Parameter | Type |
|---|---|
chain | EVMChain |
params | EVMExecuteParams<GrantBurnRoleParams> |
Returns
Promise<TransactionResult>
Inherited from
EVMOperation.execute
generate()
generate(
chain:EVMChain,params:GrantBurnRoleParams):Promise<UnsignedEVMTx>
Defined in: cct/evm/operation.ts:110
Run prepare and buildUnsigned, applying optional sender; no signing.
Parameters
| Parameter | Type |
|---|---|
chain | EVMChain |
params | GrantBurnRoleParams |
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()
protectedparse(params:GrantBurnRoleParams):GrantBurnRoleParams
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
| Parameter | Type |
|---|---|
params | GrantBurnRoleParams |
Returns
Inherited from
EVMOperation.parse
prepare()
protectedprepare(params:GrantBurnRoleParams):GrantBurnRoleParams
Defined in: cct/operation.ts:48
validate then parse — the single pre-RPC step, before any chain access.
Parameters
| Parameter | Type |
|---|---|
params | GrantBurnRoleParams |
Returns
Inherited from
EVMOperation.prepare
resolveWalletSender()
protectedresolveWalletSender(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
| Parameter | Type |
|---|---|
wallet | unknown |
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()
protectedvalidate(__namedParameters:GrantBurnRoleParams):void
Defined in: cct/evm/token/operations/grant-burn-role.ts:47
Validates both addresses before any RPC. Neither may be zero: a tx to 0x0 hits no code, and
granting a role to 0x0 mines as a no-op nobody can use.
Parameters
| Parameter | Type |
|---|---|
__namedParameters | GrantBurnRoleParams |
Returns
void
Overrides
EVMOperation.validate