Documentation
¶
Index ¶
- type AcceptTokenAdminInput
- type AcceptTokenOwnershipInput
- type AcceptTokenPoolOwnershipInput
- type AddTokenPoolConfig
- type AptosChainDefinition
- func (c AptosChainDefinition) GetChainFamily() string
- func (c AptosChainDefinition) GetConvertedEVMFeeQuoterConfig() evm_fee_quoter.FeeQuoterDestChainConfig
- func (c AptosChainDefinition) GetSelector() uint64
- func (c AptosChainDefinition) Validate(client aptos.AptosRpcClient, state aptosstate.CCIPChainState) error
- type ChainContractParams
- type ChainDefinition
- type DeployAptosChainConfig
- type DeployCurseMCMSConfig
- type DeployRegulatedTokenConfig
- type DeployTokenFaucetInput
- type DynamicConfig
- type EVMChainDefinition
- type EVMRemoteConfig
- type ExecuteTokenOwnershipTransferInput
- type ExecuteTokenPoolOwnershipTransferInput
- type FeeQuoterParams
- type MigrateOnRampDestChainConfigsToV2Config
- type MintTokenInput
- type OffRampParams
- type OnRampParams
- type RateLimiterConfig
- type TokenAcceptInput
- type TokenMint
- type TokenParams
- type TokenPoolAccept
- type TokenPoolTransfer
- type TokenTransferInput
- type TransferTokenAdminInput
- type TransferTokenOwnershipInput
- type TransferTokenPoolOwnershipInput
- type UpgradeAptosChainConfig
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AcceptTokenAdminInput ¶
type AcceptTokenAdminInput struct {
ChainSelector uint64
Accepts []TokenAcceptInput
MCMSConfig *cldfproposalutils.TimelockConfig
}
type AcceptTokenOwnershipInput ¶
type AcceptTokenOwnershipInput struct {
ChainSelector uint64
Accepts []TokenAcceptInput
MCMSConfig *cldfproposalutils.TimelockConfig
}
type AcceptTokenPoolOwnershipInput ¶
type AcceptTokenPoolOwnershipInput struct {
ChainSelector uint64
Accepts []TokenPoolAccept
MCMSConfig *cldfproposalutils.TimelockConfig
}
type AddTokenPoolConfig ¶
type AddTokenPoolConfig struct {
// DeployAptosTokenConfig
ChainSelector uint64
TokenAddress aptos.AccountAddress // if empty, token will be deployed
TokenCodeObjAddress aptos.AccountAddress // if empty, token will be deployed
TokenPoolAddress aptos.AccountAddress // if empty, token pool will be deployed
PoolType cldf.ContractType
TokenTransferFeeByRemoteChainConfig map[uint64]fee_quoter.TokenTransferFeeConfig
EVMRemoteConfigs map[uint64]EVMRemoteConfig
TokenParams TokenParams
MCMSConfig *cldfproposalutils.TimelockConfig
TokenMint *TokenMint
// ReplaceExisting allows this changeset to take datastore keys that are already
// recorded, as an intentional redeploy of this token or pool does. Without it, an
// occupied key is an error raised before anything is deployed.
ReplaceExisting bool
}
func (AddTokenPoolConfig) Qualifier ¶
func (c AddTokenPoolConfig) Qualifier() shared.TokenSymbol
Qualifier returns the datastore qualifier applied to every address this changeset records. Token-scoped types are qualified by token symbol, so the symbol is required even when the token already exists: pool refs are keyed by (chain, PoolType, version, qualifier) with the address excluded, and an empty qualifier would collide between two pools of the same type on one chain. The symbol is normalised to the convention's canonical form so Aptos rows key identically to other families'.
type AptosChainDefinition ¶
type AptosChainDefinition struct {
// ConnectionConfig holds configuration for connection.
v1_6.ConnectionConfig `json:"connectionConfig"`
// Selector is the chain selector of this chain.
Selector uint64 `json:"selector"`
// GasPrice defines the USD price (18 decimals) per unit gas for this chain as a destination.
GasPrice *big.Int `json:"gasPrice"`
// TokenPrices defines USD price for a token address (28 decimals)
TokenPrices map[aptos.AccountAddress]*big.Int
// FeeQuoterDestChainConfig is the configuration on a fee quoter for this chain as a destination.
FeeQuoterDestChainConfig aptos_fee_quoter.DestChainConfig `json:"feeQuoterDestChainConfig"`
// AddTokenTransferFeeConfigs is the configuration for token transfer fees to be added to fee quoter
AddTokenTransferFeeConfigs []aptos_fee_quoter.TokenTransferFeeConfigAdded
// RemoveTokenTransferFeeConfigs holds token transfer fees to be removed from fee quoter
RemoveTokenTransferFeeConfigs []aptos_fee_quoter.TokenTransferFeeConfigRemoved
}
func (AptosChainDefinition) GetChainFamily ¶
func (c AptosChainDefinition) GetChainFamily() string
func (AptosChainDefinition) GetConvertedEVMFeeQuoterConfig ¶
func (c AptosChainDefinition) GetConvertedEVMFeeQuoterConfig() evm_fee_quoter.FeeQuoterDestChainConfig
func (AptosChainDefinition) GetSelector ¶
func (c AptosChainDefinition) GetSelector() uint64
func (AptosChainDefinition) Validate ¶
func (c AptosChainDefinition) Validate(client aptos.AptosRpcClient, state aptosstate.CCIPChainState) error
type ChainContractParams ¶
type ChainContractParams struct {
FeeQuoterParams FeeQuoterParams
OffRampParams OffRampParams
OnRampParams OnRampParams
}
ChainContractParams stores configuration to call initialize in CCIP contracts
func (ChainContractParams) Validate ¶
func (c ChainContractParams) Validate() error
type ChainDefinition ¶
ChainDefinition is an interface that defines a chain config for lane deployment It is used to convert between Aptos and EVM fee quoter configs.
type DeployAptosChainConfig ¶
type DeployAptosChainConfig struct {
MCMSDeployConfigPerChain map[uint64]types.MCMSWithTimelockConfigV2
MCMSTimelockConfigPerChain map[uint64]cldfproposalutils.TimelockConfig
ContractParamsPerChain map[uint64]ChainContractParams
// ReplaceExisting allows this changeset to take datastore keys that are already
// recorded, as an intentional redeploy of a chain does. Without it, an occupied key is
// an error raised before anything is deployed.
ReplaceExisting bool
}
DeployAptosChainConfig is a configuration for deploying CCIP Package for Aptos chains
func (DeployAptosChainConfig) Validate ¶
func (c DeployAptosChainConfig) Validate() error
type DeployCurseMCMSConfig ¶
type DeployCurseMCMSConfig struct {
CurseMCMSConfigPerChain map[uint64]cldfproposalutils.MCMSWithTimelockConfig
MCMSTimelockConfigPerChain map[uint64]cldfproposalutils.TimelockConfig
// ReplaceExisting allows this changeset to take datastore keys that are already
// recorded, as an intentional redeploy of CurseMCMS does. Without it, an occupied key
// is an error raised before anything is deployed.
ReplaceExisting bool
}
DeployCurseMCMSConfig holds per-chain configuration for deploying and configuring a CurseMCMS contract on Aptos chains.
func (DeployCurseMCMSConfig) Validate ¶
func (c DeployCurseMCMSConfig) Validate() error
type DeployRegulatedTokenConfig ¶
type DeployRegulatedTokenConfig struct {
ChainSelector uint64
TokenParams TokenParams
TokenMint *TokenMint
// RegistrarPreregister is passed to DeployMCMSRegistrarToExistingObject (default true).
RegistrarPreregister *bool
MCMSConfig *cldfproposalutils.TimelockConfig
// ReplaceExisting allows this changeset to take datastore keys that are already
// recorded, as an intentional redeploy of this token does. Without it, an occupied key
// is an error raised before anything is deployed.
ReplaceExisting bool
}
DeployRegulatedTokenConfig drives the regulated token publish + initialize + transfer_ownership + transfer_admin to the MCMS registry owner, and emits an MCMS proposal with accept_ownership and accept_admin. Note: regulated_token cannot be deployed via MCMS due to DFA re-entrancy; those steps are signed directly by the deployer.
func (DeployRegulatedTokenConfig) RegistrarPreregisterOrDefault ¶
func (c DeployRegulatedTokenConfig) RegistrarPreregisterOrDefault() bool
RegistrarPreregisterOrDefault returns true when unset (matches test helper default).
func (DeployRegulatedTokenConfig) Validate ¶
func (c DeployRegulatedTokenConfig) Validate() error
type DeployTokenFaucetInput ¶
type DeployTokenFaucetInput struct {
ChainSelector uint64
TokenCodeObjectAddress aptos.AccountAddress
MCMSConfig *cldfproposalutils.TimelockConfig
}
type DynamicConfig ¶
type DynamicConfig struct {
Defs []operations.Definition
Inputs []any // Each element should be the corresponding input type for its operation
ChainSelector uint64
Description string
MCMSConfig *cldfproposalutils.TimelockConfig
}
type EVMChainDefinition ¶
type EVMChainDefinition struct {
v1_6.ChainDefinition
OnRampVersion []byte
}
func (EVMChainDefinition) GetChainFamily ¶
func (c EVMChainDefinition) GetChainFamily() string
func (EVMChainDefinition) GetConvertedAptosFeeQuoterConfig ¶
func (c EVMChainDefinition) GetConvertedAptosFeeQuoterConfig() aptos_fee_quoter.DestChainConfig
func (EVMChainDefinition) GetSelector ¶
func (c EVMChainDefinition) GetSelector() uint64
type EVMRemoteConfig ¶
type EVMRemoteConfig struct {
TokenAddress common.Address
// TODO: EVM has a way of picking up Pool by token address and type, use this instead of passing PoolAddress
TokenPoolAddress common.Address
RateLimiterConfig
}
func (EVMRemoteConfig) Validate ¶
func (erc EVMRemoteConfig) Validate() error
type ExecuteTokenOwnershipTransferInput ¶
type ExecuteTokenOwnershipTransferInput struct {
ChainSelector uint64
Transfers []TokenTransferInput
MCMSConfig *cldfproposalutils.TimelockConfig
}
type ExecuteTokenPoolOwnershipTransferInput ¶
type ExecuteTokenPoolOwnershipTransferInput struct {
ChainSelector uint64
Transfers []TokenPoolTransfer
MCMSConfig *cldfproposalutils.TimelockConfig
}
type FeeQuoterParams ¶
type FeeQuoterParams struct {
MaxFeeJuelsPerMsg *big.Int
TokenPriceStalenessThreshold uint64
FeeTokens []aptos.AccountAddress
PremiumMultiplierWeiPerEthByFeeToken map[shared.TokenSymbol]uint64
}
func (FeeQuoterParams) Validate ¶
func (f FeeQuoterParams) Validate() error
type MigrateOnRampDestChainConfigsToV2Config ¶
type MigrateOnRampDestChainConfigsToV2Config struct {
ChainSelector uint64
DestChainSelectors []uint64
RouterModuleAddresses []aptos.AccountAddress
MCMS *cldfproposalutils.TimelockConfig
}
type MintTokenInput ¶
type MintTokenInput struct {
ChainSelector uint64
TokenCodeObjectAddress aptos.AccountAddress
MCMSConfig *cldfproposalutils.TimelockConfig
TokenMint
}
type OffRampParams ¶
type OffRampParams struct {
ChainSelector uint64
PermissionlessExecutionThreshold uint32
IsRMNVerificationDisabled []bool
SourceChainSelectors []uint64
SourceChainIsEnabled []bool
SourceChainsOnRamp [][]byte
}
func (OffRampParams) Validate ¶
func (o OffRampParams) Validate() error
type OnRampParams ¶
type OnRampParams struct {
ChainSelector uint64
AllowlistAdmin aptos.AccountAddress
FeeAggregator aptos.AccountAddress
}
func (OnRampParams) Validate ¶
func (o OnRampParams) Validate() error
type RateLimiterConfig ¶
type TokenAcceptInput ¶
type TokenAcceptInput struct {
TokenCodeObjectAddress aptos.AccountAddress
TokenType deployment.ContractType
}
type TokenMint ¶
type TokenMint struct {
Amount uint64
To aptos.AccountAddress
}
type TokenParams ¶
type TokenParams struct {
MaxSupply *big.Int
Name string
Symbol shared.TokenSymbol
Decimals byte
Icon string
Project string
}
func (TokenParams) Validate ¶
func (tp TokenParams) Validate() error
type TokenPoolAccept ¶
type TokenPoolAccept struct {
TokenPoolAddress aptos.AccountAddress
TokenPoolType cldf.ContractType
}
type TokenPoolTransfer ¶
type TokenPoolTransfer struct {
TokenPoolAddress aptos.AccountAddress
To aptos.AccountAddress
TokenPoolType cldf.ContractType
}
type TokenTransferInput ¶
type TokenTransferInput struct {
TokenCodeObjectAddress aptos.AccountAddress
TokenType deployment.ContractType
To aptos.AccountAddress
}
type TransferTokenAdminInput ¶
type TransferTokenAdminInput struct {
ChainSelector uint64
Transfers []TokenTransferInput
MCMSConfig *cldfproposalutils.TimelockConfig
}
type TransferTokenOwnershipInput ¶
type TransferTokenOwnershipInput struct {
ChainSelector uint64
Transfers []TokenTransferInput
MCMSConfig *cldfproposalutils.TimelockConfig
}
type TransferTokenPoolOwnershipInput ¶
type TransferTokenPoolOwnershipInput struct {
ChainSelector uint64
Transfers []TokenPoolTransfer
MCMSConfig *cldfproposalutils.TimelockConfig
}
type UpgradeAptosChainConfig ¶
type UpgradeAptosChainConfig struct {
ChainSelector uint64
UpgradeCCIP bool
UpgradeOffRamp bool
UpgradeOnRamp bool
UpgradeRouter bool
MCMS *cldfproposalutils.TimelockConfig
}