Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 3bbdf4e

Browse files
gustavogama-cllgustavogama-cll
committedFeb 20, 2025··
review: use functional options to pass the instructionAuth and avoid breaking the contract
1 parent caa7637 commit 3bbdf4e

File tree

8 files changed

+63
-50
lines changed

8 files changed

+63
-50
lines changed
 

‎e2e/ledger/ledger_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ func (s *ManualLedgerSigningTestSuite) setRootSolana(
127127
// set config
128128
mcmAddress := solanamcms.ContractAddress(mcmProgramID, mcmInstanceSeed)
129129
mcmConfig := types.Config{Quorum: 1, Signers: []common.Address{ledgerAccount}}
130-
configurer := solanamcms.NewConfigurer(s.SolanaClient, s.authSolana, solana.PublicKey{}, s.chainSelectorSolana)
130+
configurer := solanamcms.NewConfigurer(s.SolanaClient, s.authSolana, s.chainSelectorSolana)
131131
_, err := configurer.SetConfig(ctx, mcmAddress, &mcmConfig, true)
132132
s.Require().NoError(err)
133133

‎e2e/tests/solana/execute.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ func (s *SolanaTestSuite) Test_Solana_Execute() {
101101
s.Require().NoError(err)
102102

103103
// set config
104-
configurer := mcmsSolana.NewConfigurer(s.SolanaClient, auth, solana.PublicKey{}, s.ChainSelector)
104+
configurer := mcmsSolana.NewConfigurer(s.SolanaClient, auth, s.ChainSelector)
105105
_, err = configurer.SetConfig(ctx, mcmID, &mcmConfig, true)
106106
s.Require().NoError(err)
107107

‎e2e/tests/solana/set_config.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ func (s *SolanaTestSuite) Test_Solana_SetConfig() {
7070
}
7171

7272
// --- act ---
73-
configurer := mcmsSolana.NewConfigurer(s.SolanaClient, auth, solana.PublicKey{}, s.ChainSelector)
73+
configurer := mcmsSolana.NewConfigurer(s.SolanaClient, auth, s.ChainSelector)
7474
signature, err := configurer.SetConfig(ctx, mcmAddress, &config, true)
7575
s.Require().NoError(err)
7676
_, err = solana.SignatureFromBase58(signature.Hash)

‎e2e/tests/solana/set_root.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ func (s *SolanaTestSuite) Test_Solana_SetRoot() {
6767
s.Require().NoError(err)
6868

6969
// set config
70-
configurer := solanasdk.NewConfigurer(s.SolanaClient, auth, solana.PublicKey{}, s.ChainSelector)
70+
configurer := solanasdk.NewConfigurer(s.SolanaClient, auth, s.ChainSelector)
7171
_, err = configurer.SetConfig(ctx, mcmAddress, &mcmConfig, true)
7272
s.Require().NoError(err)
7373

‎e2e/tests/solana/simulator.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ func (s *SolanaTestSuite) TestSimulator_SimulateSetRoot() {
7171
s.Require().NoError(err)
7272

7373
// set config
74-
configurer := solanasdk.NewConfigurer(s.SolanaClient, auth, solana.PublicKey{}, s.ChainSelector)
74+
configurer := solanasdk.NewConfigurer(s.SolanaClient, auth, s.ChainSelector)
7575
_, err = configurer.SetConfig(ctx, mcmAddress, &mcmConfig, true)
7676
s.Require().NoError(err)
7777

‎e2e/tests/solana/timelock_converter.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -587,7 +587,7 @@ func (s *SolanaTestSuite) executeConvertedProposal(
587587
// set config
588588
signerEVMAccount := NewEVMTestAccount(s.T())
589589
mcmConfig := types.Config{Quorum: 1, Signers: []common.Address{signerEVMAccount.Address}}
590-
configurer := solanasdk.NewConfigurer(s.SolanaClient, wallet, solana.PublicKey{}, s.ChainSelector)
590+
configurer := solanasdk.NewConfigurer(s.SolanaClient, wallet, s.ChainSelector)
591591
_, err := configurer.SetConfig(ctx, mcmAddress, &mcmConfig, true)
592592
s.Require().NoError(err)
593593

‎sdk/solana/configurer.go

+16-3
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,10 @@ type Configurer struct {
2929

3030
// NewConfigurer creates a new Configurer for Solana chains.
3131
func NewConfigurer(
32-
client *rpc.Client, auth solana.PrivateKey, instructionsAuth solana.PublicKey, chainSelector types.ChainSelector,
32+
client *rpc.Client, auth solana.PrivateKey, chainSelector types.ChainSelector, options ...configurerOption,
3333
) *Configurer {
34-
if instructionsAuth.IsZero() {
34+
instructionsAuth := solana.PublicKey{}
35+
if len(auth) > 0 {
3536
instructionsAuth = auth.PublicKey()
3637
}
3738

@@ -41,10 +42,21 @@ func NewConfigurer(
4142
instructionsAuth: instructionsAuth,
4243
chainSelector: chainSelector,
4344
}
45+
for _, opt := range options {
46+
opt(configurer)
47+
}
4448

4549
return configurer
4650
}
4751

52+
type configurerOption func(*Configurer)
53+
54+
func WithInstructionAuth(authPublicKey solana.PublicKey) configurerOption {
55+
return func(c *Configurer) {
56+
c.instructionsAuth = authPublicKey
57+
}
58+
}
59+
4860
// SetConfig sets the configuration for the MCM contract on the Solana chain.
4961
func (c *Configurer) SetConfig(ctx context.Context, mcmAddress string, cfg *types.Config, clearRoot bool) (types.TransactionResult, error) {
5062
programID, pdaSeed, err := ParseContractAddress(mcmAddress)
@@ -123,7 +135,7 @@ func (c *Configurer) preloadSigners(
123135
configPDA solana.PublicKey,
124136
configSignersPDA solana.PublicKey,
125137
) error {
126-
err := c.addInstruction("initSigners", bindings.NewInitSignersInstruction(mcmName, uint8(len(signerAddresses)),
138+
err := c.addInstruction("initSigners", bindings.NewInitSignersInstruction(mcmName, uint8(len(signerAddresses)), //nolint:gosec
127139
configPDA, configSignersPDA, c.instructionsAuth, solana.SystemProgramID))
128140
if err != nil {
129141
return err
@@ -180,6 +192,7 @@ func (c *instructionCollection) addInstruction(label string, instructionBuilder
180192
}
181193

182194
c.instructions = append(c.instructions, labeledInstruction{instruction, label})
195+
183196
return nil
184197
}
185198

‎sdk/solana/configurer_test.go

+41-41
Original file line numberDiff line numberDiff line change
@@ -29,27 +29,32 @@ func Test_NewConfigurer(t *testing.T) {
2929

3030
tests := []struct {
3131
name string
32-
giveInstructionAuth solana.PublicKey
32+
constructorFn func() *Configurer
3333
wantInstructionAuth solana.PublicKey
3434
}{
3535
{
3636
name: "implicit instruction authority",
37-
giveInstructionAuth: solana.PublicKey{},
37+
constructorFn: func() *Configurer {
38+
return NewConfigurer(client, auth, chainSelector)
39+
},
3840
wantInstructionAuth: auth.PublicKey(),
3941
},
4042
{
4143
name: "explicit instruction authority",
42-
giveInstructionAuth: instructionAuth,
44+
constructorFn: func() *Configurer {
45+
return NewConfigurer(client, auth, chainSelector, WithInstructionAuth(instructionAuth))
46+
},
4347
wantInstructionAuth: instructionAuth,
4448
},
4549
}
4650

4751
for _, tt := range tests {
4852
t.Run(tt.name, func(t *testing.T) {
49-
configurer := NewConfigurer(client, auth, tt.giveInstructionAuth, chainSelector)
53+
t.Parallel()
54+
configurer := tt.constructorFn()
5055

5156
require.NotNil(t, configurer)
52-
require.Equal(t, configurer.instructionsAuth, tt.wantInstructionAuth)
57+
require.Equal(t, tt.wantInstructionAuth, configurer.instructionsAuth)
5358
})
5459
}
5560
}
@@ -67,18 +72,17 @@ func TestConfigurer_SetConfig(t *testing.T) {
6772
tests := []struct {
6873
name string
6974
auth solana.PrivateKey
70-
instructionAuth solana.PublicKey
75+
options []configurerOption
7176
mcmConfig *types.Config
7277
setup func(t *testing.T, configurer *Configurer, mockJSONRPCClient *mocks.JSONRPCClient)
7378
wantHash string
7479
wantInstructions []solana.Instruction
7580
wantErr string
7681
}{
7782
{
78-
name: "success - send instructions",
79-
auth: auth,
80-
instructionAuth: solana.PublicKey{},
81-
mcmConfig: defaultMcmConfig,
83+
name: "success - send instructions",
84+
auth: auth,
85+
mcmConfig: defaultMcmConfig,
8286
setup: func(t *testing.T, configurer *Configurer, mockJSONRPCClient *mocks.JSONRPCClient) {
8387
t.Helper()
8488

@@ -102,12 +106,12 @@ func TestConfigurer_SetConfig(t *testing.T) {
102106
},
103107
},
104108
{
105-
name: "success - do not send instructions",
106-
auth: nil,
107-
instructionAuth: auth.PublicKey(),
108-
mcmConfig: defaultMcmConfig,
109-
setup: func(t *testing.T, configurer *Configurer, mockJSONRPCClient *mocks.JSONRPCClient) { t.Helper() },
110-
wantHash: "",
109+
name: "success - do not send instructions",
110+
auth: nil,
111+
options: []configurerOption{WithInstructionAuth(auth.PublicKey())},
112+
mcmConfig: defaultMcmConfig,
113+
setup: func(t *testing.T, configurer *Configurer, mockJSONRPCClient *mocks.JSONRPCClient) { t.Helper() },
114+
wantHash: "",
111115
wantInstructions: []solana.Instruction{
112116
bindings.NewInitSignersInstructionBuilder().Build(),
113117
bindings.NewAppendSignersInstructionBuilder().Build(),
@@ -116,18 +120,16 @@ func TestConfigurer_SetConfig(t *testing.T) {
116120
},
117121
},
118122
{
119-
name: "failure: too many signers",
120-
auth: auth,
121-
instructionAuth: solana.PublicKey{},
122-
mcmConfig: &types.Config{Quorum: 1, Signers: generateSigners(t, 181)},
123-
setup: func(t *testing.T, configurer *Configurer, mockJSONRPCClient *mocks.JSONRPCClient) { t.Helper() },
124-
wantErr: "too many signers (max 180)",
123+
name: "failure: too many signers",
124+
auth: auth,
125+
mcmConfig: &types.Config{Quorum: 1, Signers: generateSigners(t, 181)},
126+
setup: func(t *testing.T, configurer *Configurer, mockJSONRPCClient *mocks.JSONRPCClient) { t.Helper() },
127+
wantErr: "too many signers (max 180)",
125128
},
126129
{
127-
name: "failure: initialize signers error",
128-
auth: auth,
129-
instructionAuth: solana.PublicKey{},
130-
mcmConfig: defaultMcmConfig,
130+
name: "failure: initialize signers error",
131+
auth: auth,
132+
mcmConfig: defaultMcmConfig,
131133
setup: func(t *testing.T, configurer *Configurer, mockJSONRPCClient *mocks.JSONRPCClient) {
132134
t.Helper()
133135

@@ -138,10 +140,9 @@ func TestConfigurer_SetConfig(t *testing.T) {
138140
wantErr: "unable to set config: unable to send instruction 0 - initSigners: unable to send instruction: initialize signers error",
139141
},
140142
{
141-
name: "failure: append signers error",
142-
auth: auth,
143-
instructionAuth: solana.PublicKey{},
144-
mcmConfig: defaultMcmConfig,
143+
name: "failure: append signers error",
144+
auth: auth,
145+
mcmConfig: defaultMcmConfig,
145146
setup: func(t *testing.T, configurer *Configurer, mockJSONRPCClient *mocks.JSONRPCClient) {
146147
t.Helper()
147148

@@ -157,10 +158,9 @@ func TestConfigurer_SetConfig(t *testing.T) {
157158
wantErr: "unable to set config: unable to send instruction 1 - appendSigners0: unable to send instruction: append signers error",
158159
},
159160
{
160-
name: "failure: finalize signers error",
161-
auth: auth,
162-
instructionAuth: solana.PublicKey{},
163-
mcmConfig: defaultMcmConfig,
161+
name: "failure: finalize signers error",
162+
auth: auth,
163+
mcmConfig: defaultMcmConfig,
164164
setup: func(t *testing.T, configurer *Configurer, mockJSONRPCClient *mocks.JSONRPCClient) {
165165
t.Helper()
166166

@@ -178,10 +178,9 @@ func TestConfigurer_SetConfig(t *testing.T) {
178178
wantErr: "unable to set config: unable to send instruction 2 - finalizeSigners: unable to send instruction: finalize signers error",
179179
},
180180
{
181-
name: "failure: set config error",
182-
auth: auth,
183-
instructionAuth: solana.PublicKey{},
184-
mcmConfig: &types.Config{Quorum: 1, Signers: []common.Address{common.HexToAddress("0x1")}},
181+
name: "failure: set config error",
182+
auth: auth,
183+
mcmConfig: &types.Config{Quorum: 1, Signers: []common.Address{common.HexToAddress("0x1")}},
185184
setup: func(t *testing.T, configurer *Configurer, mockJSONRPCClient *mocks.JSONRPCClient) {
186185
t.Helper()
187186

@@ -205,7 +204,7 @@ func TestConfigurer_SetConfig(t *testing.T) {
205204
t.Run(tt.name, func(t *testing.T) {
206205
t.Parallel()
207206

208-
configurer, mockJSONRPCClient := newTestConfigurer(t, tt.auth, tt.instructionAuth, chainSelector)
207+
configurer, mockJSONRPCClient := newTestConfigurer(t, tt.auth, chainSelector, tt.options...)
209208
tt.setup(t, configurer, mockJSONRPCClient)
210209

211210
got, err := configurer.SetConfig(ctx, ContractAddress(testMCMProgramID, testPDASeed), tt.mcmConfig, clearRoot)
@@ -225,12 +224,13 @@ func TestConfigurer_SetConfig(t *testing.T) {
225224
// ----- helpers -----
226225

227226
func newTestConfigurer(
228-
t *testing.T, auth solana.PrivateKey, instructionAuth solana.PublicKey, chainSelector types.ChainSelector,
227+
t *testing.T, auth solana.PrivateKey, chainSelector types.ChainSelector, options ...configurerOption,
229228
) (*Configurer, *mocks.JSONRPCClient) {
230229
t.Helper()
231230

232231
mockJSONRPCClient := mocks.NewJSONRPCClient(t)
233232
client := rpc.NewWithCustomRPCClient(mockJSONRPCClient)
234233

235-
return NewConfigurer(client, auth, instructionAuth, chainSelector), mockJSONRPCClient
234+
fmt.Printf("AAAAAAAAAAAAAA %v\n", len(options))
235+
return NewConfigurer(client, auth, chainSelector, options...), mockJSONRPCClient
236236
}

0 commit comments

Comments
 (0)
Please sign in to comment.