changesets

package
v0.0.0-...-769ca71 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 13, 2026 License: MIT Imports: 20 Imported by: 0

Documentation

Overview

Package changesets exports one CLDF ChangeSetV2 per Stellar CCIP component (deploy + initialize together), wrapping the per-component sequences in deployment/sequences. Each changeset resolves its dependency strkeys from the environment datastore, so a chain is built by applying them in dependency order:

tier 0: RMN Remote, TokenAdminRegistry, RampRegistry,
        VersionedVerifierResolver, Executor
tier 1: RMN Proxy (needs RMN Remote);
        FeeQuoter (needs the fee-token strkey in its config)
tier 2: OnRamp (TokenAdminRegistry + RMN Proxy + FeeQuoter);
        OffRamp (RMN Proxy + TokenAdminRegistry);
        Router (RMN Proxy);
        CommitteeVerifier (RMN Proxy + StorageLocations in its config)
tier 3: ccip_receiver_example (Router)

Peripheral components (one instance per token, identified by the config Qualifier where several can share a chain):

        bnm_token, link_token (no datastore dependencies; the pool
        changesets take the token strkey from config);
        advanced_pool_hooks (issuer-owned hooks contract);
        advanced_pool_hooks_extractor (stateless singleton, deploy-only);
        token_lock_box (needs the token strkey in its config)
Peripheral pools (need Router + RampRegistry + RMN Proxy from the
        datastore, plus the token strkey — and, for the canonical
        lock-release pool, the lock box strkey — in their config):
        burn_mint_pool, lock_release_pool, siloed_lock_release_pool

VerifyPreconditions returns "deploy <X> first" when a dependency ref is missing from the datastore.

Apply builds the deployer from the chain's signer, so no raw keypair is required and KMS-backed signers work; the address used to predict contract IDs is the signer's own address, so a predicted ID can never diverge from the key that signs the deploy. Owner defaults to that signer address (the configs accept another owner for custom workflows). These changesets never transfer ownership or emit MCMS proposals; ownership moves later through the transfer-ownership changesets. The exception is ActivateRMN, which hands an already-deployed RMN Remote to the RMNMCMS timelock and emits the accept_ownership proposal.

Rerun safety comes from the component sequences' three-layer skip (datastore ref, predicted contract ID + WASM hash, owner()): re-applying an already-deployed component sends no transactions and records no new refs.

Report size: each component changeset appends one sequence report plus at most one deploy and one initialize op report (two op reports on a fresh deploy, zero on a rerun). Op reports embed the absolute WASM path and are deleted from durable pipeline storage after 30 days, so they are a crash-resume aid, not the idempotency mechanism — the skip layers are.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ActivateRMN

ActivateRMN hands an existing, deployer-owned RMN Remote to MCMS governance. Unlike the component changesets it emits an MCMS proposal: it grants curse admin to the fast-curse timelock, transfers ownership directly, and returns one timelock proposal on the governance stack that runs accept_ownership.

func SetCommitteeVerifierFinality

SetCommitteeVerifierFinality sets the allowed finality of one Committee Verifier. A deployer-owned verifier is updated directly; a timelock-owned one gets a proposal on the MCMS stack named by the MCMS qualifier (default CLLCCIP), with the requested timelock action (default schedule).

func UpgradeAdvancedPoolHooks

UpgradeAdvancedPoolHooks upgrades one deployed Stellar advanced pool hooks contract in place; the qualifier identifies the hooks instance, typically the token symbol.

func UpgradeBurnMintPool

UpgradeBurnMintPool upgrades one deployed Stellar burn-mint token pool in place; the qualifier identifies the pool instance, typically the token symbol.

func UpgradeCCIPReceiver

UpgradeCCIPReceiver upgrades one deployed Stellar CCIP Receiver in place; the qualifier selects the receiver instance (empty keeps the unqualified ref).

func UpgradeCommitteeVerifier

UpgradeCommitteeVerifier upgrades one deployed Stellar Committee Verifier in place; the qualifier selects the instance (empty keeps the default).

func UpgradeExecutor

UpgradeExecutor upgrades one deployed Stellar Executor in place; the qualifier selects the instance (empty keeps the default).

func UpgradeFeeQuoter

UpgradeFeeQuoter upgrades the deployed Stellar FeeQuoter in place.

func UpgradeLockReleasePool

UpgradeLockReleasePool upgrades one deployed Stellar lock-release token pool in place; the qualifier identifies the pool instance, typically the token symbol.

func UpgradeOffRamp

UpgradeOffRamp upgrades the deployed Stellar OffRamp in place.

func UpgradeOnRamp

UpgradeOnRamp upgrades the deployed Stellar OnRamp in place (wasm swap at the same contract ID, address and storage preserved).

func UpgradeRampRegistry

UpgradeRampRegistry upgrades the deployed Stellar Ramp Registry in place.

func UpgradeRmnProxy

UpgradeRmnProxy upgrades the deployed Stellar RMN Proxy in place.

func UpgradeRmnRemote

UpgradeRmnRemote upgrades the deployed Stellar RMN Remote in place.

func UpgradeRouter

UpgradeRouter upgrades the deployed Stellar Router in place.

func UpgradeSiloedLockReleasePool

func UpgradeSiloedLockReleasePool(mcmsRegistry *changesets.MCMSReaderRegistry) cldf.ChangeSetV2[changesets.WithMCMS[UpgradeComponentConfig]]

UpgradeSiloedLockReleasePool upgrades one deployed Stellar siloed lock-release token pool in place; the qualifier identifies the pool instance, typically the token symbol.

func UpgradeTokenAdminRegistry

func UpgradeTokenAdminRegistry(mcmsRegistry *changesets.MCMSReaderRegistry) cldf.ChangeSetV2[changesets.WithMCMS[UpgradeComponentConfig]]

UpgradeTokenAdminRegistry upgrades the deployed Stellar TokenAdminRegistry in place.

func UpgradeTokenLockBox

UpgradeTokenLockBox upgrades one deployed Stellar token lock box in place; the qualifier identifies the lock-box instance, typically the token symbol.

func UpgradeVersionedVerifierResolver

func UpgradeVersionedVerifierResolver(mcmsRegistry *changesets.MCMSReaderRegistry) cldf.ChangeSetV2[changesets.WithMCMS[UpgradeComponentConfig]]

UpgradeVersionedVerifierResolver upgrades one deployed Stellar VersionedVerifierResolver in place; the qualifier selects the committee instance (empty keeps the default).

Types

type ActivateRMNConfig

type ActivateRMNConfig struct {
	ChainSelector       uint64   `json:"chainSelector" yaml:"chainSelector"`
	GovernanceQualifier string   `json:"governanceQualifier,omitempty" yaml:"governanceQualifier,omitempty"`
	FastCurseQualifier  string   `json:"fastCurseQualifier,omitempty" yaml:"fastCurseQualifier,omitempty"`
	ExtraCurseAdmins    []string `json:"extraCurseAdmins,omitempty" yaml:"extraCurseAdmins,omitempty"`
}

ActivateRMNConfig is the input of the ActivateRMN changeset. Empty qualifiers default to RMNMCMS (governance) and UltraFastCurse (curse admin).

type DeployAdvancedPoolHooks

type DeployAdvancedPoolHooks struct{}

DeployAdvancedPoolHooks deploys and initializes an Advanced Pool Hooks contract on one Stellar chain. Requires a non-empty Qualifier: more than one hooks contract can live on a chain (one per token), and the qualifier keeps their datastore refs, salts and op reports distinct.

func (DeployAdvancedPoolHooks) VerifyPreconditions

type DeployAdvancedPoolHooksConfig

type DeployAdvancedPoolHooksConfig struct {
	ChainSelector     uint64   `json:"chainSelector" yaml:"chainSelector"`
	Qualifier         string   `json:"qualifier" yaml:"qualifier"`
	Owner             string   `json:"owner,omitempty" yaml:"owner,omitempty"`
	WasmPath          string   `json:"wasmPath,omitempty" yaml:"wasmPath,omitempty"`
	Allowlist         []string `json:"allowlist,omitempty" yaml:"allowlist,omitempty"`
	ThresholdAmount   *big.Int `json:"thresholdAmount,omitempty" yaml:"thresholdAmount,omitempty"`
	AuthorizedCallers []string `json:"authorizedCallers,omitempty" yaml:"authorizedCallers,omitempty"`
	PolicyEngine      *string  `json:"policyEngine,omitempty" yaml:"policyEngine,omitempty"`
}

DeployAdvancedPoolHooksConfig is the input of the Advanced Pool Hooks deploy changeset. The hooks contract is per-token and issuer-owned: the Qualifier identifies the instance (typically the token symbol) and Owner defaults to the deployer — for the issuer-driven CCV flow pass the token issuer (who is typically also the pool owner). ThresholdAmount defaults to 0 (the hook applies to every amount), PolicyEngine to nil (policy checks dormant), and AuthorizedCallers to empty — the pools wired to these hooks via token_pool.SetAdvancedPoolHooks should be added before they invoke the hooks. No datastore dependencies; wiring the hooks to a pool and applying CCV configs are owner-gated config ops, not deploy steps.

type DeployAdvancedPoolHooksExtractor

type DeployAdvancedPoolHooksExtractor struct{}

DeployAdvancedPoolHooksExtractor deploys the stateless Advanced Pool Hooks Extractor contract on one Stellar chain. No dependencies.

func (DeployAdvancedPoolHooksExtractor) VerifyPreconditions

type DeployAdvancedPoolHooksExtractorConfig

type DeployAdvancedPoolHooksExtractorConfig struct {
	ChainSelector uint64 `json:"chainSelector" yaml:"chainSelector"`
	WasmPath      string `json:"wasmPath,omitempty" yaml:"wasmPath,omitempty"`
}

DeployAdvancedPoolHooksExtractorConfig is the input of the Advanced Pool Hooks Extractor deploy changeset. The extractor is stateless (only the pure extract / type_and_version views), so the changeset deploys and records the ref and nothing else. Wiring the extractor to a policy engine (set_extractor) is an operator action on the engine, not deploy tooling (EVM parity).

type DeployBnmToken

type DeployBnmToken struct{}

DeployBnmToken deploys and initializes the BnM test token on one Stellar chain. No dependencies.

func (DeployBnmToken) Apply

func (DeployBnmToken) VerifyPreconditions

func (DeployBnmToken) VerifyPreconditions(e cldf.Environment, cfg DeployBnmTokenConfig) error

type DeployBnmTokenConfig

type DeployBnmTokenConfig struct {
	ChainSelector uint64 `json:"chainSelector" yaml:"chainSelector"`
	Owner         string `json:"owner,omitempty" yaml:"owner,omitempty"`
	WasmPath      string `json:"wasmPath,omitempty" yaml:"wasmPath,omitempty"`
	Name          string `json:"name,omitempty" yaml:"name,omitempty"`
	Symbol        string `json:"symbol,omitempty" yaml:"symbol,omitempty"`
	Decimals      uint32 `json:"decimals,omitempty" yaml:"decimals,omitempty"`
}

DeployBnmTokenConfig is the input of the BnM token deploy changeset. Name/Symbol/Decimals default to "CCIP BnM" / "BnM" / 7 and the Owner (the initial token admin) to the deployer. The deploy covers the token only: the set_admin mint-authority handoff to the pool and the TokenAdminRegistry registration are separate steps (RunDeployBnmToken bundles the full onboarding).

type DeployBurnMintPool

type DeployBurnMintPool struct{}

DeployBurnMintPool deploys and initializes a burn-mint token pool on one Stellar chain. Requires Router, RampRegistry and RMN Proxy, a non-empty Token strkey with its decimals, and a non-empty Qualifier (more than one pool can live on a chain; the qualifier keeps their datastore refs, salts and op reports distinct — typically the token symbol).

func (DeployBurnMintPool) Apply

func (DeployBurnMintPool) VerifyPreconditions

type DeployBurnMintPoolConfig

type DeployBurnMintPoolConfig struct {
	ChainSelector uint64 `json:"chainSelector" yaml:"chainSelector"`
	Qualifier     string `json:"qualifier" yaml:"qualifier"`
	Owner         string `json:"owner,omitempty" yaml:"owner,omitempty"`
	WasmPath      string `json:"wasmPath,omitempty" yaml:"wasmPath,omitempty"`
	Token         string `json:"token" yaml:"token"`
	TokenDecimals uint32 `json:"tokenDecimals" yaml:"tokenDecimals"`
}

DeployBurnMintPoolConfig is the input of the burn-mint pool deploy changeset. The pool takes any custom token from config (BnM, LINK, or an issuer token); the Router/RampRegistry/RMN Proxy strkeys are resolved from the environment datastore, not configured here. The set_admin mint-authority handoff (custom token → pool) and the TokenAdminRegistry registration are separate operator steps (RunDeployBnmToken bundles the full onboarding), and per-remote-chain pool config is applied at lane-configuration time.

type DeployCCIPReceiver

type DeployCCIPReceiver struct{}

DeployCCIPReceiver deploys and initializes the ccip_receiver_example contract on one Stellar chain. Requires Router.

func (DeployCCIPReceiver) Apply

func (DeployCCIPReceiver) VerifyPreconditions

type DeployCCIPReceiverConfig

type DeployCCIPReceiverConfig struct {
	ChainSelector uint64 `json:"chainSelector" yaml:"chainSelector"`
	Owner         string `json:"owner,omitempty" yaml:"owner,omitempty"`
	WasmPath      string `json:"wasmPath,omitempty" yaml:"wasmPath,omitempty"`
}

DeployCCIPReceiverConfig is the input of the ccip_receiver_example deploy changeset. The Router strkey is resolved from the environment datastore, not configured here. Enabling remote chains is a config op and stays with the orchestrator.

type DeployCommitteeVerifier

type DeployCommitteeVerifier struct{}

DeployCommitteeVerifier deploys and initializes the CommitteeVerifier contract on one Stellar chain. Requires RMN Proxy.

func (DeployCommitteeVerifier) VerifyPreconditions

type DeployCommitteeVerifierConfig

type DeployCommitteeVerifierConfig struct {
	ChainSelector    uint64   `json:"chainSelector" yaml:"chainSelector"`
	Qualifier        string   `json:"qualifier,omitempty" yaml:"qualifier,omitempty"`
	Owner            string   `json:"owner,omitempty" yaml:"owner,omitempty"`
	WasmPath         string   `json:"wasmPath,omitempty" yaml:"wasmPath,omitempty"`
	StorageLocations [][]byte `json:"storageLocations" yaml:"storageLocations"`
	AllowlistAdmin   string   `json:"allowlistAdmin,omitempty" yaml:"allowlistAdmin,omitempty"`
	FeeAggregator    string   `json:"feeAggregator,omitempty" yaml:"feeAggregator,omitempty"`
	VersionTag       [4]byte  `json:"versionTag" yaml:"versionTag"`
}

DeployCommitteeVerifierConfig is the input of the CommitteeVerifier deploy changeset. StorageLocations is a required input: the deploy never invents one. AllowlistAdmin and FeeAggregator default to the owner and VersionTag to the default committee-verifier tag. The RmnProxy strkey is resolved from the environment datastore, not configured here. An empty Qualifier deploys the default instance; a non-empty one deploys a distinct, extra verifier (its own datastore ref and salt).

type DeployExecutor

type DeployExecutor struct{}

DeployExecutor deploys and initializes the source-side Executor contract on one Stellar chain. No dependencies.

func (DeployExecutor) Apply

func (DeployExecutor) VerifyPreconditions

func (DeployExecutor) VerifyPreconditions(e cldf.Environment, cfg DeployExecutorConfig) error

type DeployExecutorConfig

type DeployExecutorConfig struct {
	ChainSelector         uint64 `json:"chainSelector" yaml:"chainSelector"`
	Owner                 string `json:"owner,omitempty" yaml:"owner,omitempty"`
	WasmPath              string `json:"wasmPath,omitempty" yaml:"wasmPath,omitempty"`
	MaxCCVsPerMsg         uint32 `json:"maxCCVsPerMsg,omitempty" yaml:"maxCCVsPerMsg,omitempty"`
	AllowedFinalityConfig uint32 `json:"allowedFinalityConfig,omitempty" yaml:"allowedFinalityConfig,omitempty"`
	CcvAllowlistEnabled   bool   `json:"ccvAllowlistEnabled,omitempty" yaml:"ccvAllowlistEnabled,omitempty"`
	FeeAggregator         string `json:"feeAggregator,omitempty" yaml:"feeAggregator,omitempty"`
}

DeployExecutorConfig is the input of the Executor deploy changeset. MaxCCVsPerMsg defaults to 10 (EVM parity: the ccv devenv deploys its executor with MaxCCVsPerMsg 10), AllowedFinalityConfig to 0, CcvAllowlistEnabled to false and FeeAggregator to the owner. The changeset records both the executor and executor-proxy rows: Soroban has no delegate proxy, so both point at the same contract.

type DeployFeeQuoter

type DeployFeeQuoter struct{}

DeployFeeQuoter deploys and initializes the FeeQuoter contract on one Stellar chain.

func (DeployFeeQuoter) Apply

func (DeployFeeQuoter) VerifyPreconditions

func (DeployFeeQuoter) VerifyPreconditions(e cldf.Environment, cfg DeployFeeQuoterConfig) error

type DeployFeeQuoterConfig

type DeployFeeQuoterConfig struct {
	ChainSelector     uint64   `json:"chainSelector" yaml:"chainSelector"`
	Owner             string   `json:"owner,omitempty" yaml:"owner,omitempty"`
	WasmPath          string   `json:"wasmPath,omitempty" yaml:"wasmPath,omitempty"`
	FeeToken          string   `json:"feeToken" yaml:"feeToken"`
	MaxFeeJuelsPerMsg *big.Int `json:"maxFeeJuelsPerMsg,omitempty" yaml:"maxFeeJuelsPerMsg,omitempty"`
	AuthorizedCallers []string `json:"authorizedCallers,omitempty" yaml:"authorizedCallers,omitempty"`
}

DeployFeeQuoterConfig is the input of the FeeQuoter deploy changeset. FeeToken is the strkey of the SAC used for fee payments, a required input: the deploy never derives it. MaxFeeJuelsPerMsg defaults to 1e18 and AuthorizedCallers to [owner]. No datastore dependencies.

type DeployLinkToken

type DeployLinkToken struct{}

DeployLinkToken deploys and initializes the LINK token on one Stellar chain. No dependencies.

func (DeployLinkToken) Apply

func (DeployLinkToken) VerifyPreconditions

func (DeployLinkToken) VerifyPreconditions(e cldf.Environment, cfg DeployLinkTokenConfig) error

type DeployLinkTokenConfig

type DeployLinkTokenConfig struct {
	ChainSelector uint64 `json:"chainSelector" yaml:"chainSelector"`
	Owner         string `json:"owner,omitempty" yaml:"owner,omitempty"`
	WasmPath      string `json:"wasmPath,omitempty" yaml:"wasmPath,omitempty"`
	Name          string `json:"name,omitempty" yaml:"name,omitempty"`
	Symbol        string `json:"symbol,omitempty" yaml:"symbol,omitempty"`
	Decimals      uint32 `json:"decimals,omitempty" yaml:"decimals,omitempty"`
}

DeployLinkTokenConfig is the input of the LINK token deploy changeset. Name/Symbol/Decimals default to "ChainLink Token" / "LINK" / 7 and the Owner (the initial token admin) to the deployer. The deploy covers the token only: the set_admin mint-authority handoff to the pool and the TokenAdminRegistry registration are separate operator steps (see RunDeployBnmToken for the onboarding order).

type DeployLockReleasePool

type DeployLockReleasePool struct{}

DeployLockReleasePool deploys and initializes the canonical (non-siloed) lock-release token pool on one Stellar chain. Requires Router, RampRegistry and RMN Proxy, a non-empty Token strkey with its decimals and its LockBox, and a non-empty Qualifier (more than one pool can live on a chain; the qualifier keeps their datastore refs, salts and op reports distinct — typically the token symbol).

func (DeployLockReleasePool) Apply

func (DeployLockReleasePool) VerifyPreconditions

type DeployLockReleasePoolConfig

type DeployLockReleasePoolConfig struct {
	ChainSelector uint64 `json:"chainSelector" yaml:"chainSelector"`
	Qualifier     string `json:"qualifier" yaml:"qualifier"`
	Owner         string `json:"owner,omitempty" yaml:"owner,omitempty"`
	WasmPath      string `json:"wasmPath,omitempty" yaml:"wasmPath,omitempty"`
	Token         string `json:"token" yaml:"token"`
	TokenDecimals uint32 `json:"tokenDecimals" yaml:"tokenDecimals"`
	LockBox       string `json:"lockBox" yaml:"lockBox"`
}

DeployLockReleasePoolConfig is the input of the canonical lock-release pool deploy changeset. The pool takes the token and its lock box from config; the Router/RampRegistry/RMN Proxy strkeys are resolved from the environment datastore, not configured here. The LockBox must be an initialized TokenLockBox for the same token (the pool validates token support on-chain); deploy it first (DeployTokenLockBox). Per-remote-chain pool config is applied at lane-configuration time.

type DeployOffRamp

type DeployOffRamp struct{}

DeployOffRamp deploys and initializes the OffRamp contract on one Stellar chain. Requires RMN Proxy and TokenAdminRegistry.

func (DeployOffRamp) Apply

func (DeployOffRamp) VerifyPreconditions

func (DeployOffRamp) VerifyPreconditions(e cldf.Environment, cfg DeployOffRampConfig) error

type DeployOffRampConfig

type DeployOffRampConfig struct {
	ChainSelector uint64 `json:"chainSelector" yaml:"chainSelector"`
	Owner         string `json:"owner,omitempty" yaml:"owner,omitempty"`
	WasmPath      string `json:"wasmPath,omitempty" yaml:"wasmPath,omitempty"`
}

DeployOffRampConfig is the input of the OffRamp deploy changeset. The RmnProxy and TokenAdminRegistry strkeys are resolved from the environment datastore, not configured here.

type DeployOnRamp

type DeployOnRamp struct{}

DeployOnRamp deploys and initializes the OnRamp contract on one Stellar chain. Requires TokenAdminRegistry, RMN Proxy and FeeQuoter.

func (DeployOnRamp) Apply

func (DeployOnRamp) VerifyPreconditions

func (DeployOnRamp) VerifyPreconditions(e cldf.Environment, cfg DeployOnRampConfig) error

type DeployOnRampConfig

type DeployOnRampConfig struct {
	ChainSelector         uint64 `json:"chainSelector" yaml:"chainSelector"`
	Owner                 string `json:"owner,omitempty" yaml:"owner,omitempty"`
	WasmPath              string `json:"wasmPath,omitempty" yaml:"wasmPath,omitempty"`
	MaxUsdCentsPerMessage uint32 `json:"maxUsdCentsPerMessage,omitempty" yaml:"maxUsdCentsPerMessage,omitempty"`
	FeeAggregator         string `json:"feeAggregator,omitempty" yaml:"feeAggregator,omitempty"`
}

DeployOnRampConfig is the input of the OnRamp deploy changeset. The TokenAdminRegistry, RmnProxy and FeeQuoter strkeys are resolved from the environment datastore, not configured here. MaxUsdCentsPerMessage defaults to 500000 ($5000) and FeeAggregator to the owner.

type DeployRMNProxy

type DeployRMNProxy struct{}

DeployRMNProxy deploys and initializes the RMN Proxy contract on one Stellar chain. Requires RMN Remote.

func (DeployRMNProxy) Apply

func (DeployRMNProxy) VerifyPreconditions

func (DeployRMNProxy) VerifyPreconditions(e cldf.Environment, cfg DeployRMNProxyConfig) error

type DeployRMNProxyConfig

type DeployRMNProxyConfig struct {
	ChainSelector uint64 `json:"chainSelector" yaml:"chainSelector"`
	Owner         string `json:"owner,omitempty" yaml:"owner,omitempty"`
	WasmPath      string `json:"wasmPath,omitempty" yaml:"wasmPath,omitempty"`
}

DeployRMNProxyConfig is the input of the RMN Proxy deploy changeset. The RmnRemote strkey is resolved from the environment datastore, not configured here.

type DeployRMNRemote

type DeployRMNRemote struct{}

DeployRMNRemote deploys and initializes the RMN Remote contract on one Stellar chain. No dependencies.

func (DeployRMNRemote) Apply

func (DeployRMNRemote) VerifyPreconditions

func (DeployRMNRemote) VerifyPreconditions(e cldf.Environment, cfg DeployRMNRemoteConfig) error

type DeployRMNRemoteConfig

type DeployRMNRemoteConfig struct {
	ChainSelector      uint64   `json:"chainSelector" yaml:"chainSelector"`
	Owner              string   `json:"owner,omitempty" yaml:"owner,omitempty"`
	WasmPath           string   `json:"wasmPath,omitempty" yaml:"wasmPath,omitempty"`
	CurseAdmins        []string `json:"curseAdmins,omitempty" yaml:"curseAdmins,omitempty"`
	EnableFastCurse    bool     `json:"enableFastCurse,omitempty" yaml:"enableFastCurse,omitempty"`
	FastCurseQualifier string   `json:"fastCurseQualifier,omitempty" yaml:"fastCurseQualifier,omitempty"`
}

DeployRMNRemoteConfig is the input of the RMN Remote deploy changeset. CurseAdmins default to none; EnableFastCurse prepends the fast-curse timelock resolved from the datastore (qualifier FastCurseQualifier, default the Ultra Fast Curse qualifier).

type DeployRampRegistry

type DeployRampRegistry struct{}

DeployRampRegistry deploys and initializes the RampRegistry contract on one Stellar chain.

func (DeployRampRegistry) Apply

func (DeployRampRegistry) VerifyPreconditions

type DeployRampRegistryConfig

type DeployRampRegistryConfig struct {
	ChainSelector uint64 `json:"chainSelector" yaml:"chainSelector"`
	Owner         string `json:"owner,omitempty" yaml:"owner,omitempty"`
	WasmPath      string `json:"wasmPath,omitempty" yaml:"wasmPath,omitempty"`
}

DeployRampRegistryConfig is the input of the RampRegistry deploy changeset. The ramp map updates are config ops and stay with the orchestrator. No dependencies.

type DeployRouter

type DeployRouter struct{}

DeployRouter deploys and initializes the Router contract on one Stellar chain. Requires RMN Proxy.

func (DeployRouter) Apply

func (DeployRouter) VerifyPreconditions

func (DeployRouter) VerifyPreconditions(e cldf.Environment, cfg DeployRouterConfig) error

type DeployRouterConfig

type DeployRouterConfig struct {
	ChainSelector uint64 `json:"chainSelector" yaml:"chainSelector"`
	Owner         string `json:"owner,omitempty" yaml:"owner,omitempty"`
	WasmPath      string `json:"wasmPath,omitempty" yaml:"wasmPath,omitempty"`
}

DeployRouterConfig is the input of the Router deploy changeset. The RmnProxy strkey is resolved from the environment datastore, not configured here.

type DeploySiloedLockReleasePool

type DeploySiloedLockReleasePool struct{}

DeploySiloedLockReleasePool deploys and initializes the siloed lock-release token pool on one Stellar chain. Requires Router, RampRegistry and RMN Proxy, a non-empty Token strkey with its decimals, and a non-empty Qualifier (more than one pool can live on a chain; the qualifier keeps their datastore refs, salts and op reports distinct — typically the token symbol).

func (DeploySiloedLockReleasePool) VerifyPreconditions

type DeploySiloedLockReleasePoolConfig

type DeploySiloedLockReleasePoolConfig struct {
	ChainSelector uint64 `json:"chainSelector" yaml:"chainSelector"`
	Qualifier     string `json:"qualifier" yaml:"qualifier"`
	Owner         string `json:"owner,omitempty" yaml:"owner,omitempty"`
	WasmPath      string `json:"wasmPath,omitempty" yaml:"wasmPath,omitempty"`
	Token         string `json:"token" yaml:"token"`
	TokenDecimals uint32 `json:"tokenDecimals" yaml:"tokenDecimals"`
}

DeploySiloedLockReleasePoolConfig is the input of the siloed lock-release pool deploy changeset. The pool takes the token from config; the Router/RampRegistry/RMN Proxy strkeys are resolved from the environment datastore, not configured here. There is no immutable lock box at initialize — the per-remote-chain lock boxes are wired post-deploy (configure_lock_boxes), an owner-gated config op, and per-remote-chain pool config is applied at lane-configuration time.

type DeployTokenAdminRegistry

type DeployTokenAdminRegistry struct{}

DeployTokenAdminRegistry deploys and initializes the TokenAdminRegistry contract on one Stellar chain.

func (DeployTokenAdminRegistry) VerifyPreconditions

type DeployTokenAdminRegistryConfig

type DeployTokenAdminRegistryConfig struct {
	ChainSelector uint64 `json:"chainSelector" yaml:"chainSelector"`
	Owner         string `json:"owner,omitempty" yaml:"owner,omitempty"`
	WasmPath      string `json:"wasmPath,omitempty" yaml:"wasmPath,omitempty"`
}

DeployTokenAdminRegistryConfig is the input of the TokenAdminRegistry deploy changeset. No params beyond owner, and no dependencies.

type DeployTokenLockBox

type DeployTokenLockBox struct{}

DeployTokenLockBox deploys and initializes a TokenLockBox on one Stellar chain. Requires a non-empty Token strkey and a non-empty Qualifier (more than one box can live on a chain — one per pool/token; the qualifier keeps their datastore refs, salts and op reports distinct, typically the token symbol matching the pool it serves).

func (DeployTokenLockBox) Apply

func (DeployTokenLockBox) VerifyPreconditions

type DeployTokenLockBoxConfig

type DeployTokenLockBoxConfig struct {
	ChainSelector uint64 `json:"chainSelector" yaml:"chainSelector"`
	Qualifier     string `json:"qualifier" yaml:"qualifier"`
	Owner         string `json:"owner,omitempty" yaml:"owner,omitempty"`
	WasmPath      string `json:"wasmPath,omitempty" yaml:"wasmPath,omitempty"`
	Token         string `json:"token" yaml:"token"`
}

DeployTokenLockBoxConfig is the input of the TokenLockBox deploy changeset. The box takes the token it holds from config; a canonical lock-release pool takes the box strkey in its own config (DeployLockReleasePool).

type DeployVVR

type DeployVVR struct{}

DeployVVR deploys and initializes the VersionedVerifierResolver contract on one Stellar chain.

func (DeployVVR) Apply

func (DeployVVR) VerifyPreconditions

func (DeployVVR) VerifyPreconditions(e cldf.Environment, cfg DeployVVRConfig) error

type DeployVVRConfig

type DeployVVRConfig struct {
	ChainSelector uint64 `json:"chainSelector" yaml:"chainSelector"`
	Owner         string `json:"owner,omitempty" yaml:"owner,omitempty"`
	WasmPath      string `json:"wasmPath,omitempty" yaml:"wasmPath,omitempty"`
	FeeAggregator string `json:"feeAggregator,omitempty" yaml:"feeAggregator,omitempty"`
}

DeployVVRConfig is the input of the VersionedVerifierResolver deploy changeset. FeeAggregator defaults to the owner. No dependencies.

type SetCommitteeVerifierFinalityConfig

type SetCommitteeVerifierFinalityConfig struct {
	ChainSelector uint64 `json:"chainSelector" yaml:"chainSelector"`
	// Qualifier selects the verifier; empty keeps the default instance.
	Qualifier       string          `json:"qualifier,omitempty" yaml:"qualifier,omitempty"`
	AllowedFinality finality.Config `json:"allowedFinality" yaml:"allowedFinality"`
}

SetCommitteeVerifierFinalityConfig is the input of the SetCommitteeVerifierFinality changeset.

type UpgradeComponentConfig

type UpgradeComponentConfig struct {
	ChainSelector uint64 `json:"chainSelector" yaml:"chainSelector"`
	Qualifier     string `json:"qualifier,omitempty" yaml:"qualifier,omitempty"`
}

UpgradeComponentConfig is the input of every per-component in-place upgrade changeset. Qualifier selects the contract instance for multi-instance components (Committee Verifier, VVR, CCIP Receiver, Executor map empty to their default instance; pools require one, e.g. the token symbol); it is independent of the MCMS input's qualifier, which selects the MCMS/timelock stack.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL