README
¶
CLD Changesets
This repository contains reusable common CLD Changesets such as MCMS, Datastore, JD and more which are used in CLD to perform deployments.
cre
Directory cre holds CRE-related changesets and operations.
cre_workflow_deploy: resolves pre-built workflow WASM, workflow config, and project.yaml (GitHub release, URL, or local), writes workflow.yaml and context.yaml, and runs cre workflow deploy via the framework operations API.
- Changeset:
cre/changesets.CREWorkflowDeployChangeset - Input:
cre/operations.CREWorkflowDeployInput— pipeline YAML suppliesproject(cre/artifacts.ConfigSource),deploymentRegistry, and the workflow bundle (binary, config, name). RPCs andcre-clisettings live in the user-providedproject.yaml. - Operation:
cre/operations.CREWorkflowDeployOp
Domain resolvers can be pass-through; pipeline YAML must include donFamily, project, and the workflow bundle fields.
Package layout
| Package | Purpose |
|---|---|
cre/changesets |
CLD changesets (e.g. CREWorkflowDeployChangeset) |
cre/operations |
Idempotent CLD operations invoked by changesets; also defines shared CRE deploy types (CREWorkflowDeployInput, CREDeployDeps) |
Usage
go get github.com/smartcontractkit/cld-changesets
Contributing
For instructions on how to contribute to cld-changesets and the release process,
see CONTRIBUTING.md
Releasing
For instructions on how to release cld-changesets,
see RELEASE.md
Directories
¶
| Path | Synopsis |
|---|---|
|
catalog
|
|
|
changesets
Deprecated: Use github.com/smartcontractkit/cld-changesets/datastore/changesets instead.
|
Deprecated: Use github.com/smartcontractkit/cld-changesets/datastore/changesets instead. |
|
operations
Deprecated: Use github.com/smartcontractkit/cld-changesets/datastore/operations instead.
|
Deprecated: Use github.com/smartcontractkit/cld-changesets/datastore/operations instead. |
|
cre
|
|
|
changesets
Package changesets provides CRE workflow changesets that can be applied to deployment environments.
|
Package changesets provides CRE workflow changesets that can be applied to deployment environments. |
|
operations
Package operations provides CRE workflow operations that execute side effects via the CRE CLI.
|
Package operations provides CRE workflow operations that execute side effects via the CRE CLI. |
|
datastore
|
|
|
internal/keys
Package keys provides JSON-friendly mirror types for the framework datastore key interfaces.
|
Package keys provides JSON-friendly mirror types for the framework datastore key interfaces. |
|
evm
|
|
|
changesets
Package changesets provides reusable EVM changesets.
|
Package changesets provides reusable EVM changesets. |
|
internal
|
|
|
familyregistry
Package familyregistry provides a generic, thread-safe registry mapping a string key (typically a chain-selectors family) to a per-family implementation.
|
Package familyregistry provides a generic, thread-safe registry mapping a string key (typically a chain-selectors family) to a per-family implementation. |
|
mcmsrole
Package mcmsrole provides RBACTimelock role names and IDs used by MCMS changesets.
|
Package mcmsrole provides RBACTimelock role names and IDs used by MCMS changesets. |
|
semvers
Package semvers defines the canonical semver constants used as version labels throughout this repository (e.g.
|
Package semvers defines the canonical semver constants used as version labels throughout this repository (e.g. |
|
testutil/datastoretest
Package datastoretest provides lightweight fakes for datastore interfaces in unit tests.
|
Package datastoretest provides lightweight fakes for datastore interfaces in unit tests. |
|
testutil/evmtest
Package evmtest provides test utilities for interacting with EVM chains.
|
Package evmtest provides test utilities for interacting with EVM chains. |
|
testutil/solanatest
Package solanatest provides test utilities for Solana MCMS integration tests.
|
Package solanatest provides test utilities for Solana MCMS integration tests. |
|
jd
|
|
|
changesets/jobs
Package jobs provides changesets for managing Job Distributor jobs.
|
Package jobs provides changesets for managing Job Distributor jobs. |
|
changesets/nodes
Package nodes provides changesets for managing Job Distributor nodes.
|
Package nodes provides changesets for managing Job Distributor nodes. |
|
legacy
|
|
|
mcms/changesets
Package changesets provides reusable MCMS changesets.
|
Package changesets provides reusable MCMS changesets. |
|
link
|
|
|
changesets
Package changesets provides reusable LINK token changesets.
|
Package changesets provides reusable LINK token changesets. |
|
mcms
|
|
|
changesets
Package changesets provides multi-family MCMS changesets.
|
Package changesets provides multi-family MCMS changesets. |
|
changesets/deploy
Package deploy provides the DeployMCMSWithTimelock changeset and a registry for per-chain-family deploy implementations.
|
Package deploy provides the DeployMCMSWithTimelock changeset and a registry for per-chain-family deploy implementations. |
|
changesets/deploy-custom-topology
Package deploycustomtopology provides the DeployCustomTopology changeset and a registry for per-chain-family deploy implementations.
|
Package deploycustomtopology provides the DeployCustomTopology changeset and a registry for per-chain-family deploy implementations. |
|
changesets/firedrill
Package firedrill provides the MCMS signing fire-drill changeset and a registry for per-chain-family fire-drill implementations.
|
Package firedrill provides the MCMS signing fire-drill changeset and a registry for per-chain-family fire-drill implementations. |
|
changesets/firedrill/all
Package all blank-imports built-in MCMS fire-drill families and MCMS readers.
|
Package all blank-imports built-in MCMS fire-drill families and MCMS readers. |
|
changesets/grant-role/all
Package all blank-imports built-in MCMS grant-role families and readers.
|
Package all blank-imports built-in MCMS grant-role families and readers. |
|
changesets/set-config
Package setconfig provides the SetConfigMCMS changeset and a registry for per-chain-family set-config sequences.
|
Package setconfig provides the SetConfigMCMS changeset and a registry for per-chain-family set-config sequences. |
|
changesets/set-config/all
Package all blank-imports built-in MCMS set-config families and MCMS readers.
|
Package all blank-imports built-in MCMS set-config families and MCMS readers. |
|
changesets/transfer-to-timelock
Package transfertotimelock provides the transfer-to-timelock changeset and a registry for per-chain-family implementations.
|
Package transfertotimelock provides the transfer-to-timelock changeset and a registry for per-chain-family implementations. |
|
changesets/transfer-to-timelock/all
Package all blank-imports built-in MCMS transfer-to-timelock families and readers.
|
Package all blank-imports built-in MCMS transfer-to-timelock families and readers. |
|
evm/deploy
Package evmdeploy provides the EVM chain-family implementation for the MCMS deploy changeset (mcms/changesets/deploy).
|
Package evmdeploy provides the EVM chain-family implementation for the MCMS deploy changeset (mcms/changesets/deploy). |
|
solana/changesets
Package changesets holds Solana-only MCMS changesets.
|
Package changesets holds Solana-only MCMS changesets. |
|
solana/changesets/fund-mcm-pdas
Package fundmcmpdas funds MCMS signer PDAs on Solana chains.
|
Package fundmcmpdas funds MCMS signer PDAs on Solana chains. |
|
solana/deploy
Package soldeploy provides the Solana chain-family implementation for the MCMS deploy changeset (mcms/changesets/deploy).
|
Package soldeploy provides the Solana chain-family implementation for the MCMS deploy changeset (mcms/changesets/deploy). |
|
pkg
|
|
|
tokens
|
|
|
link/changesets
Package changesets provides reusable LINK token changesets.
|
Package changesets provides reusable LINK token changesets. |
Click to show internal directories.
Click to hide internal directories.