Skip to content

feat(canton): integrate Canton support #613

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stackman27 merged 1 commit into from
Jun 5, 2026
Merged

feat(canton): integrate Canton support #613

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions chainwrappers/chainaccessor.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@ import (
"github.com/xssnick/tonutils-go/ton"
tonwallet "github.com/xssnick/tonutils-go/ton/wallet"

cantonsdk "github.com/smartcontractkit/mcms/sdk/canton"
evmsdk "github.com/smartcontractkit/mcms/sdk/evm"
suisuisdk "github.com/smartcontractkit/mcms/sdk/sui"
suisdk "github.com/smartcontractkit/mcms/sdk/sui"
)

type ChainAccessor interface {
Expand All @@ -21,7 +22,8 @@ type ChainAccessor interface {
AptosClient(selector uint64) (aptoslib.AptosRpcClient, bool)
AptosSigner(selector uint64) (aptoslib.TransactionSigner, bool)
SuiClient(selector uint64) (sui.ISuiAPI, bool)
SuiSigner(selector uint64) (suisuisdk.SuiSigner, bool)
SuiSigner(selector uint64) (suisdk.SuiSigner, bool)
TonClient(selector uint64) (ton.APIClientWrapped, bool)
TonSigner(selector uint64) (*tonwallet.Wallet, bool)
CantonChain(selector uint64) (cantonsdk.Chain, bool)
}
Comment thread
gustavogama-cll marked this conversation as resolved.
3 changes: 3 additions & 0 deletions chainwrappers/converters.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import (

"github.com/smartcontractkit/mcms/sdk"
"github.com/smartcontractkit/mcms/sdk/aptos"
"github.com/smartcontractkit/mcms/sdk/canton"
"github.com/smartcontractkit/mcms/sdk/evm"
"github.com/smartcontractkit/mcms/sdk/solana"
"github.com/smartcontractkit/mcms/sdk/sui"
Expand Down Expand Up @@ -51,6 +52,8 @@ func BuildConverter(selector types.ChainSelector, metadata types.ChainMetadata)
converter, _ = sui.NewTimelockConverter()
case chainsel.FamilyTon:
converter = ton.NewTimelockConverter(ton.DefaultSendAmount)
case chainsel.FamilyCanton:
converter = canton.NewTimelockConverter()
default:
return nil, fmt.Errorf("unsupported chain family %s", fam)
}
Expand Down
30 changes: 28 additions & 2 deletions chainwrappers/executors.go
View file
Open in desktop
Comment thread
gustavogama-cll marked this conversation as resolved.
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,12 @@ import (
"encoding/json"
"fmt"

"github.com/samber/lo"
chainsel "github.com/smartcontractkit/chain-selectors"

"github.com/smartcontractkit/mcms/sdk"
"github.com/smartcontractkit/mcms/sdk/aptos"
cantonsdk "github.com/smartcontractkit/mcms/sdk/canton"
"github.com/smartcontractkit/mcms/sdk/evm"
"github.com/smartcontractkit/mcms/sdk/solana"
"github.com/smartcontractkit/mcms/sdk/sui"
Expand All @@ -23,13 +25,11 @@ func BuildExecutors(
action types.TimelockAction,
) (map[types.ChainSelector]sdk.Executor, error) {
executors := map[types.ChainSelector]sdk.Executor{}

for chainSelector, metadata := range chainMetadata {
encoder, ok := encoders[chainSelector]
if !ok {
return nil, fmt.Errorf("missing encoder for chain selector %d", chainSelector)
}

executor, err := BuildExecutor(chains, chainSelector, encoder, action, metadata)
if err != nil {
return nil, err
Expand Down Expand Up @@ -167,6 +167,32 @@ func BuildExecutor(
Amount: ton.DefaultSendAmount,
})

case chainsel.FamilyCanton:
ch, ok := chains.CantonChain(rawSelector)
if !ok || len(ch.Participants) == 0 {
return nil, fmt.Errorf("missing Canton chain participant for selector %d", rawSelector)
}
participant := ch.Participants[0]
mcmsParties := lo.Map(ch.Participants, func(p cantonsdk.Participant, _ int) string { return p.PartyID })
cantonEncoder, ok := encoder.(*cantonsdk.Encoder)
if !ok {
return nil, fmt.Errorf("invalid encoder type for selector %d: %T", chainSelector, encoder)
}
role, err := cantonsdk.CantonRoleFromAction(action)
if err != nil {
return nil, fmt.Errorf("error getting canton role from proposal: %w", err)
}
inspector := cantonsdk.NewInspector(participant.LedgerServices.State, mcmsParties, role)

return cantonsdk.NewExecutor(
cantonEncoder,
inspector,
participant.LedgerServices.Command,
participant.PartyID,
mcmsParties,
role,
)

default:
return nil, fmt.Errorf("unsupported chain family %s", family)
}
Expand Down
49 changes: 33 additions & 16 deletions chainwrappers/executors_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import (
sol "github.com/gagliardetto/solana-go"
solrpc "github.com/gagliardetto/solana-go/rpc"
"github.com/google/go-cmp/cmp"
"github.com/google/go-cmp/cmp/cmpopts"
chainsel "github.com/smartcontractkit/chain-selectors"
"github.com/stretchr/testify/mock"
"github.com/stretchr/testify/require"
Expand All @@ -16,6 +17,7 @@ import (
mcmssdk "github.com/smartcontractkit/mcms/sdk"
"github.com/smartcontractkit/mcms/sdk/aptos"
aptosmocks "github.com/smartcontractkit/mcms/sdk/aptos/mocks/aptos"
cantonsdk "github.com/smartcontractkit/mcms/sdk/canton"
"github.com/smartcontractkit/mcms/sdk/evm"
"github.com/smartcontractkit/mcms/sdk/solana"
"github.com/smartcontractkit/mcms/sdk/sui"
Expand All @@ -27,11 +29,12 @@ import (
)

var (
evmSelector = mcmstypes.ChainSelector(chainsel.ETHEREUM_TESTNET_SEPOLIA.Selector)
solSelector = mcmstypes.ChainSelector(chainsel.SOLANA_DEVNET.Selector)
aptosSelector = mcmstypes.ChainSelector(chainsel.APTOS_TESTNET.Selector)
suiSelector = mcmstypes.ChainSelector(chainsel.SUI_TESTNET.Selector)
tonSelector = mcmstypes.ChainSelector(chainsel.TON_TESTNET.Selector)
evmSelector = mcmstypes.ChainSelector(chainsel.ETHEREUM_TESTNET_SEPOLIA.Selector)
solSelector = mcmstypes.ChainSelector(chainsel.SOLANA_DEVNET.Selector)
aptosSelector = mcmstypes.ChainSelector(chainsel.APTOS_TESTNET.Selector)
suiSelector = mcmstypes.ChainSelector(chainsel.SUI_TESTNET.Selector)
tonSelector = mcmstypes.ChainSelector(chainsel.TON_TESTNET.Selector)
cantonSelector = mcmstypes.ChainSelector(chainsel.CANTON_TESTNET.Selector)
)

func TestBuildExecutors(t *testing.T) {
Expand Down Expand Up @@ -65,6 +68,12 @@ func TestBuildExecutors(t *testing.T) {
tonExecOpts := ton.ExecutorOpts{Encoder: tonEncoder, Client: tonClient, Wallet: tonSigner, Amount: ton.DefaultSendAmount}
tonExecutor, err := ton.NewExecutor(tonExecOpts)
require.NoError(t, err)
cantonEncoder := cantonsdk.NewEncoder(cantonSelector, 0, false)
cantonChain := cantonsdk.Chain{Participants: []cantonsdk.Participant{{PartyID: "party::test"}}}
cantonInspector := cantonsdk.NewInspector(cantonChain.Participants[0].LedgerServices.State, []string{"party::test"}, cantonsdk.TimelockRoleProposer)
cantonExecutor, err := cantonsdk.NewExecutor(cantonEncoder, cantonInspector,
cantonChain.Participants[0].LedgerServices.Command, "party::test", []string{"party::test"}, cantonsdk.TimelockRoleProposer)
require.NoError(t, err)

tests := []struct {
name string
Expand All @@ -77,11 +86,12 @@ func TestBuildExecutors(t *testing.T) {
{
name: "success",
encoders: map[mcmstypes.ChainSelector]mcmssdk.Encoder{
evmSelector: evmEncoder,
solSelector: solEncoder,
aptosSelector: aptosEncoder,
suiSelector: suiEncoder,
tonSelector: tonEncoder,
evmSelector: evmEncoder,
solSelector: solEncoder,
aptosSelector: aptosEncoder,
suiSelector: suiEncoder,
tonSelector: tonEncoder,
cantonSelector: cantonEncoder,
},
chainMetadata: map[mcmstypes.ChainSelector]mcmstypes.ChainMetadata{
mcmstypes.ChainSelector(chainsel.ETHEREUM_TESTNET_SEPOLIA.Selector): {
Expand Down Expand Up @@ -113,6 +123,10 @@ func TestBuildExecutors(t *testing.T) {
MCMAddress: "0xton",
StartingOpCount: 0,
},
mcmstypes.ChainSelector(chainsel.CANTON_TESTNET.Selector): {
MCMAddress: "0xcanton",
StartingOpCount: 0,
},
},
setup: func(accessor *mocks.ChainAccessor) {
accessor.EXPECT().EVMClient(mock.Anything).Return(nil, true)
Expand All @@ -125,13 +139,15 @@ func TestBuildExecutors(t *testing.T) {
accessor.EXPECT().SuiSigner(mock.Anything).Return(nil, true)
accessor.EXPECT().TonClient(mock.Anything).Return(tonClient, true)
accessor.EXPECT().TonSigner(mock.Anything).Return(tonSigner, true)
accessor.EXPECT().CantonChain(mock.Anything).Return(cantonChain, true)
},
want: map[mcmstypes.ChainSelector]mcmssdk.Executor{
evmSelector: evmExecutor,
solSelector: solExecutor,
aptosSelector: aptosExecutor,
suiSelector: suiExecutor,
tonSelector: tonExecutor,
evmSelector: evmExecutor,
solSelector: solExecutor,
aptosSelector: aptosExecutor,
suiSelector: suiExecutor,
tonSelector: tonExecutor,
cantonSelector: cantonExecutor,
},
},
{
Expand Down Expand Up @@ -166,7 +182,8 @@ func TestBuildExecutors(t *testing.T) {
got, err := BuildExecutors(chainAccessor, tt.chainMetadata, tt.encoders, mcmstypes.TimelockActionSchedule)
if tt.wantErr == "" {
require.NoError(t, err)
require.Empty(t, cmp.Diff(tt.want, got))
require.Empty(t, cmp.Diff(tt.want, got,
cmpopts.IgnoreUnexported(cantonsdk.Inspector{}, cantonsdk.Executor{})))
} else {
require.ErrorContains(t, err, tt.wantErr)
}
Expand Down
15 changes: 15 additions & 0 deletions chainwrappers/inspectors.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,12 @@ import (
"encoding/json"
"fmt"

"github.com/samber/lo"
chainsel "github.com/smartcontractkit/chain-selectors"

"github.com/smartcontractkit/mcms/sdk"
"github.com/smartcontractkit/mcms/sdk/aptos"
cantonsdk "github.com/smartcontractkit/mcms/sdk/canton"
"github.com/smartcontractkit/mcms/sdk/evm"
"github.com/smartcontractkit/mcms/sdk/solana"
"github.com/smartcontractkit/mcms/sdk/sui"
Expand Down Expand Up @@ -50,6 +52,19 @@ func BuildInspector(

rawSelector := uint64(selector)
switch family {
case chainsel.FamilyCanton:
ch, ok := chains.CantonChain(rawSelector)
if !ok || len(ch.Participants) == 0 {
return nil, fmt.Errorf("missing Canton chain participant for selector %d", rawSelector)
}
participant := ch.Participants[0]
mcmsParties := lo.Map(ch.Participants, func(p cantonsdk.Participant, _ int) string { return p.PartyID })
role, err := cantonsdk.CantonRoleFromAction(action)
if err != nil {
return nil, fmt.Errorf("error getting canton role from proposal: %w", err)
}

return cantonsdk.NewInspector(participant.LedgerServices.State, mcmsParties, role), nil
case chainsel.FamilyEVM:
client, ok := chains.EVMClient(rawSelector)
if !ok {
Expand Down
57 changes: 57 additions & 0 deletions chainwrappers/mocks/chain_accessor.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 17 additions & 1 deletion chainwrappers/timelock_executors.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,12 @@ import (
"encoding/json"
"fmt"

"github.com/samber/lo"
chainsel "github.com/smartcontractkit/chain-selectors"

"github.com/smartcontractkit/mcms/sdk"
"github.com/smartcontractkit/mcms/sdk/aptos"
cantonsdk "github.com/smartcontractkit/mcms/sdk/canton"
"github.com/smartcontractkit/mcms/sdk/evm"
"github.com/smartcontractkit/mcms/sdk/solana"
"github.com/smartcontractkit/mcms/sdk/sui"
Expand All @@ -22,7 +24,6 @@ func BuildTimelockExecutors(
action types.TimelockAction,
) (map[types.ChainSelector]sdk.TimelockExecutor, error) {
executors := map[types.ChainSelector]sdk.TimelockExecutor{}

for chainSelector, metadata := range chainMetadata {
executor, err := BuildTimelockExecutor(chains, chainSelector, action, metadata)
if err != nil {
Expand Down Expand Up @@ -135,6 +136,21 @@ func BuildTimelockExecutor(
Amount: ton.DefaultSendAmount,
})

case chainsel.FamilyCanton:
ch, ok := chains.CantonChain(rawSelector)
if !ok || len(ch.Participants) == 0 {
return nil, fmt.Errorf("missing Canton chain participant for selector %d", rawSelector)
}
participant := ch.Participants[0]
mcmsParties := lo.Map(ch.Participants, func(p cantonsdk.Participant, _ int) string { return p.PartyID })

return cantonsdk.NewTimelockExecutor(
participant.LedgerServices.Command,
participant.LedgerServices.State,
participant.PartyID,
mcmsParties,
), nil
Comment thread
gustavogama-cll marked this conversation as resolved.

default:
return nil, fmt.Errorf("unsupported chain family %s", family)
}
Expand Down
10 changes: 10 additions & 0 deletions e2e/config.canton.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
[settings]
private_keys = [
"0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80",
"0x59c6995e998f97a5a0044966f0945389dc9e86dae88c7a8412f4603b6b78690d",
"0x5de4111afa1a4b94908f83103eb1f1706367c2e68ca870fc3fb9a804cdab365a"
]

[canton_config]
type = "canton"
number_of_canton_validators = 1
Loading
Loading