feat: add guarded sol transfer helper#82
Draft
amilz wants to merge 4 commits into
Draft
Conversation
This file contains hidden or 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
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.
Adds a guarded SOL-transfer helper that validates a destination before building the
transferSolinstruction, preventing common footguns where SOL is sent to an unrecoverable address.Adds:
assertValidTransferSolDestination(rpc, destination, config?)— throwsInvalidTransferSolDestinationErrorif the destination is unsafe.getTransferSolGuardedInstruction(rpc, input, config?)— runs the assertion, then returns a standardtransferSolinstruction (async, since the owner check needs an RPC).Updates:
systemProgram()plugin — extends the generated System plugin with atransferSolGuardedinstruction method onclient.system.instructions.Validation rules
A destination is rejected unless it's an existing account owned by the expected program (default: System Program). Overridable via config:
programOwnerallowUnfundedRecipientfalseallowOffCurvefalseEach rejection carries a
reason(unexpected-owner|unfunded-recipient|off-curve) and, where relevant, the actualowner.Changes
clients/js/src/transferSolGuarded.ts— helper + error typeclients/js/src/plugin.ts—systemProgram()plugin wrapperclients/js/src/index.ts— exportsclients/js/test/transferSolGuarded.test.ts— coverageclients/js/README.md— usage docs