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,94 @@ | ||
| 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" | ||
| ) | ||
|
|
||
| // 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 | ||
| prefix string | ||
| } | ||
|
|
||
| func newPdaReadBinding(namespace, genericName string, prefix string) *pdaReadBinding { | ||
| return &pdaReadBinding{ | ||
| namespace: namespace, | ||
| genericName: genericName, | ||
| prefix: prefix, | ||
| } | ||
| } | ||
|
|
||
| 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(ctx context.Context, params any) (solana.PublicKey, error) { | ||
| seedBytes, err := b.buildSeedsSlice(ctx, params) | ||
| if err != nil { | ||
| return solana.PublicKey{}, fmt.Errorf("failed build seeds list for PDA calculation: %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(ctx context.Context, params any) ([][]byte, error) { | ||
| flattenedSeeds := make([]byte, 0, solana.MaxSeeds*solana.MaxSeedLength) | ||
| // Append the static prefix string first | ||
| flattenedSeeds = append(flattenedSeeds, []byte(b.prefix)...) | ||
| // Encode the seeds provided in the params | ||
| encodedParamSeeds, err := b.codec.Encode(ctx, params, codec.WrapItemType(true, b.namespace, b.genericName, "")) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to encode params into bytes for PDA seeds: %w", err) | ||
| } | ||
| // Append the encoded seeds | ||
| flattenedSeeds = append(flattenedSeeds, encodedParamSeeds...) | ||
|
|
||
| if len(flattenedSeeds) > solana.MaxSeeds*solana.MaxSeedLength { | ||
| return nil, fmt.Errorf("seeds exceed the maximum allowed length") | ||
| } | ||
|
|
||
| // Splitting the seeds since they are expected to be provided separately to FindProgramAddress | ||
| // Arbitrarily separating the seeds at max seed length would still yield the same PDA since | ||
| // FindProgramAddress appends the seed bytes together under the hood | ||
| numSeeds := len(flattenedSeeds) / solana.MaxSeedLength | ||
| if len(flattenedSeeds)%solana.MaxSeedLength != 0 { | ||
| numSeeds++ | ||
| } | ||
| seedByteArray := make([][]byte, 0, numSeeds) | ||
| for i := 0; i < numSeeds; i++ { | ||
| startIdx := i * solana.MaxSeedLength | ||
| endIdx := startIdx + solana.MaxSeedLength | ||
| if endIdx > len(flattenedSeeds) { | ||
| endIdx = len(flattenedSeeds) | ||
| } | ||
| seedByteArray = append(seedByteArray, flattenedSeeds[startIdx:endIdx]) | ||
| } | ||
| return seedByteArray, nil | ||
| } | ||
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
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.
I think this can go away in favour of just using
addCodecDef(). You just need to define seeds as a new IDL type and handle it like events, args and accounts are handled hereCreateCodecEntry()which is a func used byaddCodecDef().