Enable ChainReader to read PDA account state #1003
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| package chainreader | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
|
|
||
| "github.com/gagliardetto/solana-go" | ||
|
|
||
| "github.com/smartcontractkit/chainlink-common/pkg/types" | ||
|
|
||
| "github.com/smartcontractkit/chainlink-solana/pkg/solana/codec" | ||
| "github.com/smartcontractkit/chainlink-solana/pkg/solana/config" | ||
| "github.com/smartcontractkit/chainlink-solana/pkg/solana/utils" | ||
| ) | ||
|
|
||
| // pdaReadBinding provides calculating PDA addresses with the provided seeds and reading decoded PDA Account data using a defined codec | ||
| type pdaReadBinding struct { | ||
|
There was a problem hiding this comment. Do you think we could merge this into account_read_binding.go? They essentially do the same thing, since we’re reading an account in both cases. The only difference is that we need to calculate the PDA address if parameters are provided. There was a problem hiding this comment. Hmm good point. I think I could. I'll give this a shot There was a problem hiding this comment. I merged the two in the latest commit |
||
| namespace string | ||
| genericName string | ||
| codec types.RemoteCodec | ||
| programID solana.PublicKey | ||
| seeds []config.Seed | ||
| } | ||
|
|
||
| func newPdaReadBinding(namespace, genericName string, seeds []config.Seed) *pdaReadBinding { | ||
| return &pdaReadBinding{ | ||
| namespace: namespace, | ||
| genericName: genericName, | ||
| seeds: seeds, | ||
| } | ||
| } | ||
|
|
||
| var _ readBinding = &pdaReadBinding{} | ||
|
|
||
| func (b *pdaReadBinding) SetCodec(codec types.RemoteCodec) { | ||
| b.codec = codec | ||
| } | ||
|
|
||
| func (b *pdaReadBinding) SetAddress(programID solana.PublicKey) { | ||
| b.programID = programID | ||
| } | ||
|
|
||
| func (b *pdaReadBinding) GetAddress(params any) (solana.PublicKey, error) { | ||
| seedBytes, err := b.buildSeedsSlice(params) | ||
| if err != nil { | ||
| return solana.PublicKey{}, fmt.Errorf("failed build seeds list for PDA generation: %w", err) | ||
| } | ||
| key, _, err := solana.FindProgramAddress(seedBytes, b.programID) | ||
| if err != nil { | ||
| return solana.PublicKey{}, fmt.Errorf("failed find program address for PDA: %w", err) | ||
| } | ||
| return key, nil | ||
| } | ||
|
|
||
| func (b *pdaReadBinding) CreateType(forEncoding bool) (any, error) { | ||
| return b.codec.CreateType(codec.WrapItemType(forEncoding, b.namespace, b.genericName, codec.ChainConfigTypeAccountDef), forEncoding) | ||
| } | ||
|
|
||
| func (b *pdaReadBinding) Decode(ctx context.Context, bts []byte, outVal any) error { | ||
| return b.codec.Decode(ctx, bts, outVal, codec.WrapItemType(false, b.namespace, b.genericName, codec.ChainConfigTypeAccountDef)) | ||
| } | ||
|
|
||
| func (b *pdaReadBinding) buildSeedsSlice(params any) ([][]byte, error) { | ||
| if b.seeds == nil { | ||
| return [][]byte{}, nil | ||
| } | ||
|
|
||
| seedByteArray := make([][]byte, 0, len(b.seeds)) | ||
| for _, seed := range b.seeds { | ||
silaslenihan marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| if seed.Value != nil && len(seed.Location) > 0 { | ||
| return nil, fmt.Errorf("seed cannot have both Value (%v) and Location (%s) defined", seed.Value, seed.Location) | ||
| } | ||
| if seed.Value != nil { | ||
| byteArray := utils.ConvertAnyToPDASeed(seed.Value) | ||
| if byteArray == nil { | ||
| return nil, fmt.Errorf("failed to convert seed %v to byte array", seed.Value) | ||
| } | ||
| if len(byteArray) > solana.MaxSeedLength { | ||
| return nil, fmt.Errorf("seed length %d exceeds the max allowed length %d", len(byteArray), solana.MaxSeedLength) | ||
| } | ||
| seedByteArray = append(seedByteArray, utils.ConvertAnyToPDASeed(seed.Value)) | ||
| continue | ||
| } | ||
| if len(seed.Location) > 0 { | ||
| byteArrays, err := utils.GetValuesAtLocation(params, seed.Location) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to find seed at location %s in params: %w", seed.Location, err) | ||
| } | ||
| if len(byteArrays) != 1 { | ||
| return nil, fmt.Errorf("expected 1 seed. found %d seeds at location %s", len(byteArrays), seed.Location) | ||
| } | ||
| seedByteArray = append(seedByteArray, byteArrays[0]) | ||
| continue | ||
| } | ||
| } | ||
| return seedByteArray, nil | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would an empty seeds list just be a normal account read?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think
FindProgramAddressstill outputs a different programID even with empty seeds since it's still applying the bump seed. I think every PDA in the on-chain code uses some sort of seed though. So guess it wouldn't hurt to also validate empty seeds for our current use case but I wanted to keep this open in case something changes in the future.