feat(solana)!: enable calling SetConfig without sending the transaction #310
Conversation
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
🦋 Changeset detectedLatest commit: 183448a The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
This PR enables clients to call SetConfig() without sending the
instructions to the blockchain. Its purpose is to retrieve the instructions
that _would_ be sent -- to, for instance, use this instructions to
build an mcms proposal. The instructions are returned in the `TransactionResult` object, in the
`RawTransaction` attribute.
In order to "activate" this mode, clients must set leave the authority
private key as `nil` *and* specify the signer account in the
`instructionAuth` parameter. Existing clients (who still want to send
the instructions onchain) are also affected as we had to introduce a new
parameter to the Configurer constructor (`instructionAuth`).
Examples:
```go
// send instructions on-chain
result, err := NewConfigurer(client, auth, solana.PublicKey{}, chainSelector).SetConfig()
assert.True(t, solana.IsSignature(result.Hash))
assert.GreaterOrEqual(t, len(result.RawTransaction.([]solana.Instruction)), 4)
```
```go
// do NOT send instructions on-chain
result, err := NewConfigurer(client, auth, solana.PublicKey{}, chainSelector).SetConfig()
assert.Equal(t, result.Hash, "")
assert.GreaterOrEqual(t, len(result.RawTransaction.([]solana.Instruction)), 4)
```
!BREAKING CHANGE!
…breaking the contract
gustavogama-cll
force-pushed
the
enable-set-config-do-not-send-transaction
branch
from
419ea25 to
3bbdf4e
Compare
gustavogama-cll
force-pushed
the
enable-set-config-do-not-send-transaction
branch
from
d96b908 to
9551439
Compare
gustavogama-cll
changed the title
gustavogama-cll
changed the title
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR enables clients to call SetConfig() without sending the instructions to the blockchain. Its purpose is to retrieve the instructions that would be sent -- to, for instance, use this instructions to build an mcms proposal. The instructions are returned in the
TransactionResultobject, in theRawDataattribute (which used to be calledRawTransactionand was renamed to reflect the fact it can hold other arbitrary types).In order to "activate" this mode, clients must set the optional argument
SkipTransaction. For instance:BREAKING_CHANGE:
RawTransactionrenamed toRawData