Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: transfer hook interface #6176

Merged
merged 3 commits into from
Jan 26, 2024
Merged

Conversation

buffalojoec
Copy link
Contributor

The documentation for Token-2022's TransferHook extension touches on the interface a bit, but it doesn't explain the whole interface and the account resolution capabilities that go along with it.

This PR introduces a dedicated section in the SPL docs covering the Transfer Hook interface, covering:

  • What the interface specification is
  • How to implement it in an on-chain program
  • How to configure additional required accounts for Execute
  • How dynamic account resolution is performed
  • Examples & loads of links

@buffalojoec buffalojoec requested a review from joncinque January 24, 2024 23:35
Copy link
Contributor

@joncinque joncinque left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks really good! Mainly small comments

docs/src/transfer-hook-interface/introduction.md Outdated Show resolved Hide resolved
docs/src/transfer-hook-interface/introduction.md Outdated Show resolved Hide resolved
docs/src/transfer-hook-interface/introduction.md Outdated Show resolved Hide resolved
docs/src/transfer-hook-interface/introduction.md Outdated Show resolved Hide resolved
docs/src/transfer-hook-interface/introduction.md Outdated Show resolved Hide resolved
docs/src/transfer-hook-interface/examples.md Outdated Show resolved Hide resolved
docs/src/transfer-hook-interface/examples.md Outdated Show resolved Hide resolved
@buffalojoec buffalojoec force-pushed the transfer-hook-interface-docs branch from 5a831ca to 4a65df0 Compare January 25, 2024 19:27
@buffalojoec buffalojoec force-pushed the transfer-hook-interface-docs branch from 4a65df0 to 24842cc Compare January 25, 2024 19:33
Copy link
Contributor

@joncinque joncinque left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, thanks for addressing all the comments!

@buffalojoec buffalojoec merged commit 2e2bf8f into master Jan 26, 2024
4 checks passed
@buffalojoec buffalojoec deleted the transfer-hook-interface-docs branch January 26, 2024 02:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants