Class: GetBurnAddress
Defined in: cct/evm/token-pool/operations/get-burn-address.ts:28
Reads a BurnToAddress pool's burn address, for audit and UX: it is immutable, so this is the way to confirm a deployed pool sends to the address intended.
Extends
EVMQuery<GetBurnAddressParams,GetBurnAddressResult>
Constructors
Constructor
new GetBurnAddress():
GetBurnAddress
Returns
GetBurnAddress
Inherited from
EVMQuery<GetBurnAddressParams, GetBurnAddressResult>.constructor
Properties
name
readonlyname:"getBurnAddress"='getBurnAddress'
Defined in: cct/evm/token-pool/operations/get-burn-address.ts:29
camelCase id; matches the token-manager facade method and error context.
Overrides
EVMQuery.name
Methods
prepare()
protectedprepare(params:GetBurnAddressParams):GetBurnAddressParams
Defined in: cct/evm/token-pool/operations/get-burn-address.ts:35
Validates the pool address; nothing to convert for read.
Parameters
| Parameter | Type |
|---|---|
params | GetBurnAddressParams |
Returns
Throws
CCTParamsInvalidError if poolAddress is not a valid address
Overrides
EVMQuery.prepare
query()
query(
chain:EVMChain,params:GetBurnAddressParams):Promise<string>
Defined in: cct/query.ts:25
Run prepare and read; no wallet.
Parameters
| Parameter | Type |
|---|---|
chain | EVMChain |
params | GetBurnAddressParams |
Returns
Promise<string>
Inherited from
EVMQuery.query
read()
protectedread(chain:EVMChain,__namedParameters:GetBurnAddressParams):Promise<string>
Defined in: cct/evm/token-pool/operations/get-burn-address.ts:47
Resolves the pool's type/version before the read, so any other pool reports why instead of a bare call failure on a getter it does not declare.
Parameters
| Parameter | Type |
|---|---|
chain | EVMChain |
__namedParameters | GetBurnAddressParams |
Returns
Promise<string>
Throws
CCTContractTypeInvalidError if the pool is not a BurnToAddressTokenPool
Throws
CCTContractVersionUnsupportedError if the pool reports a version BurnToAddress never shipped at (1.5.0, or an unknown one)
Overrides
EVMQuery.read