-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add token group extension in token (#6295)
* feat: add token group extension in token * wip: add e2e tests * fix: token group member * feat: init group and groupMember with rent transfer * fix: token group e2e tests * fix: remove single pool changes * fix: pnpm install * fix instructions * rework tests * rename directory to `tokenGroup` --------- Co-authored-by: Joe C <[email protected]>
- Loading branch information
1 parent
ce0389b
commit 56b083d
Showing
12 changed files
with
3,251 additions
and
1,548 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
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,281 @@ | ||
| import type { ConfirmOptions, Connection, PublicKey, Signer, TransactionSignature } from '@solana/web3.js'; | ||
| import { sendAndConfirmTransaction, SystemProgram, Transaction } from '@solana/web3.js'; | ||
| import { | ||
| createInitializeGroupInstruction, | ||
| createUpdateGroupMaxSizeInstruction, | ||
| createUpdateGroupAuthorityInstruction, | ||
| createInitializeMemberInstruction, | ||
| TOKEN_GROUP_SIZE, | ||
| TOKEN_GROUP_MEMBER_SIZE, | ||
| } from '@solana/spl-token-group'; | ||
|
|
||
| import { TOKEN_2022_PROGRAM_ID } from '../../constants.js'; | ||
| import { getSigners } from '../../actions/internal.js'; | ||
|
|
||
| /** | ||
| * Initialize a new `Group` | ||
| * | ||
| * Assumes one has already initialized a mint for the group. | ||
| * | ||
| * @param connection Connection to use | ||
| * @param payer Payer of the transaction fee | ||
| * @param mint Group mint | ||
| * @param mintAuthority Group mint authority | ||
| * @param updateAuthority Group update authority | ||
| * @param maxSize Maximum number of members in the group | ||
| * @param multiSigners Signing accounts if `authority` is a multisig | ||
| * @param confirmOptions Options for confirming the transaction | ||
| * @param programId SPL Token program account | ||
| * | ||
| * @return Signature of the confirmed transaction | ||
| */ | ||
| export async function tokenGroupInitializeGroup( | ||
| connection: Connection, | ||
| payer: Signer, | ||
| mint: PublicKey, | ||
| mintAuthority: PublicKey | Signer, | ||
| updateAuthority: PublicKey | null, | ||
| maxSize: number, | ||
| multiSigners: Signer[] = [], | ||
| confirmOptions?: ConfirmOptions, | ||
| programId = TOKEN_2022_PROGRAM_ID | ||
| ): Promise<TransactionSignature> { | ||
| const [mintAuthorityPublicKey, signers] = getSigners(mintAuthority, multiSigners); | ||
|
|
||
| const transaction = new Transaction().add( | ||
| createInitializeGroupInstruction({ | ||
| programId, | ||
| group: mint, | ||
| mint, | ||
| mintAuthority: mintAuthorityPublicKey, | ||
| updateAuthority, | ||
| maxSize, | ||
| }) | ||
| ); | ||
|
|
||
| return await sendAndConfirmTransaction(connection, transaction, [payer, ...signers], confirmOptions); | ||
| } | ||
|
|
||
| /** | ||
| * Initialize a new `Group` with rent transfer. | ||
| * | ||
| * Assumes one has already initialized a mint for the group. | ||
| * | ||
| * @param connection Connection to use | ||
| * @param payer Payer of the transaction fee | ||
| * @param mint Group mint | ||
| * @param mintAuthority Group mint authority | ||
| * @param updateAuthority Group update authority | ||
| * @param maxSize Maximum number of members in the group | ||
| * @param multiSigners Signing accounts if `authority` is a multisig | ||
| * @param confirmOptions Options for confirming the transaction | ||
| * @param programId SPL Token program account | ||
| * | ||
| * @return Signature of the confirmed transaction | ||
| */ | ||
| export async function tokenGroupInitializeGroupWithRentTransfer( | ||
| connection: Connection, | ||
| payer: Signer, | ||
| mint: PublicKey, | ||
| mintAuthority: PublicKey | Signer, | ||
| updateAuthority: PublicKey | null, | ||
| maxSize: number, | ||
| multiSigners: Signer[] = [], | ||
| confirmOptions?: ConfirmOptions, | ||
| programId = TOKEN_2022_PROGRAM_ID | ||
| ): Promise<TransactionSignature> { | ||
| const [mintAuthorityPublicKey, signers] = getSigners(mintAuthority, multiSigners); | ||
|
|
||
| const lamports = await connection.getMinimumBalanceForRentExemption(TOKEN_GROUP_SIZE); | ||
|
|
||
| const transaction = new Transaction().add( | ||
| SystemProgram.transfer({ | ||
| fromPubkey: payer.publicKey, | ||
| toPubkey: mint, | ||
| lamports, | ||
| }), | ||
| createInitializeGroupInstruction({ | ||
| programId, | ||
| group: mint, | ||
| mint, | ||
| mintAuthority: mintAuthorityPublicKey, | ||
| updateAuthority, | ||
| maxSize, | ||
| }) | ||
| ); | ||
|
|
||
| return await sendAndConfirmTransaction(connection, transaction, [payer, ...signers], confirmOptions); | ||
| } | ||
|
|
||
| /** | ||
| * Update the max size of a `Group` | ||
| * | ||
| * @param connection Connection to use | ||
| * @param payer Payer of the transaction fee | ||
| * @param mint Group mint | ||
| * @param updateAuthority Group update authority | ||
| * @param maxSize Maximum number of members in the group | ||
| * @param multiSigners Signing accounts if `authority` is a multisig | ||
| * @param confirmOptions Options for confirming the transaction | ||
| * @param programId SPL Token program account | ||
| * | ||
| * @return Signature of the confirmed transaction | ||
| */ | ||
| export async function tokenGroupUpdateGroupMaxSize( | ||
| connection: Connection, | ||
| payer: Signer, | ||
| mint: PublicKey, | ||
| updateAuthority: PublicKey | Signer, | ||
| maxSize: number, | ||
| multiSigners: Signer[] = [], | ||
| confirmOptions?: ConfirmOptions, | ||
| programId = TOKEN_2022_PROGRAM_ID | ||
| ): Promise<TransactionSignature> { | ||
| const [updateAuthorityPublicKey, signers] = getSigners(updateAuthority, multiSigners); | ||
|
|
||
| const transaction = new Transaction().add( | ||
| createUpdateGroupMaxSizeInstruction({ | ||
| programId, | ||
| group: mint, | ||
| updateAuthority: updateAuthorityPublicKey, | ||
| maxSize, | ||
| }) | ||
| ); | ||
|
|
||
| return await sendAndConfirmTransaction(connection, transaction, [payer, ...signers], confirmOptions); | ||
| } | ||
|
|
||
| /** | ||
| * Update the authority of a `Group` | ||
| * | ||
| * @param connection Connection to use | ||
| * @param payer Payer of the transaction fee | ||
| * @param mint Group mint | ||
| * @param updateAuthority Group update authority | ||
| * @param newAuthority New authority for the token group, or unset | ||
| * @param multiSigners Signing accounts if `authority` is a multisig | ||
| * @param confirmOptions Options for confirming the transaction | ||
| * @param programId SPL Token program account | ||
| * | ||
| * @return Signature of the confirmed transaction | ||
| */ | ||
| export async function tokenGroupUpdateGroupAuthority( | ||
| connection: Connection, | ||
| payer: Signer, | ||
| mint: PublicKey, | ||
| updateAuthority: PublicKey | Signer, | ||
| newAuthority: PublicKey | null, | ||
| multiSigners: Signer[] = [], | ||
| confirmOptions?: ConfirmOptions, | ||
| programId = TOKEN_2022_PROGRAM_ID | ||
| ): Promise<TransactionSignature> { | ||
| const [updateAuthorityPublicKey, signers] = getSigners(updateAuthority, multiSigners); | ||
|
|
||
| const transaction = new Transaction().add( | ||
| createUpdateGroupAuthorityInstruction({ | ||
| programId, | ||
| group: mint, | ||
| currentAuthority: updateAuthorityPublicKey, | ||
| newAuthority, | ||
| }) | ||
| ); | ||
|
|
||
| return await sendAndConfirmTransaction(connection, transaction, [payer, ...signers], confirmOptions); | ||
| } | ||
|
|
||
| /** | ||
| * Initialize a new `Member` of a `Group` | ||
| * | ||
| * Assumes the `Group` has already been initialized, | ||
| * as well as the mint for the member. | ||
| * | ||
| * @param connection Connection to use | ||
| * @param payer Payer of the transaction fee | ||
| * @param mint Member mint | ||
| * @param mintAuthority Member mint authority | ||
| * @param group Group mint | ||
| * @param groupUpdateAuthority Group update authority | ||
| * @param multiSigners Signing accounts if `authority` is a multisig | ||
| * @param confirmOptions Options for confirming the transaction | ||
| * @param programId SPL Token program account | ||
| * | ||
| * @return Signature of the confirmed transaction | ||
| */ | ||
| export async function tokenGroupMemberInitialize( | ||
| connection: Connection, | ||
| payer: Signer, | ||
| mint: PublicKey, | ||
| mintAuthority: PublicKey | Signer, | ||
| group: PublicKey, | ||
| groupUpdateAuthority: PublicKey, | ||
| multiSigners: Signer[] = [], | ||
| confirmOptions?: ConfirmOptions, | ||
| programId = TOKEN_2022_PROGRAM_ID | ||
| ): Promise<TransactionSignature> { | ||
| const [mintAuthorityPublicKey, signers] = getSigners(mintAuthority, multiSigners); | ||
|
|
||
| const transaction = new Transaction().add( | ||
| createInitializeMemberInstruction({ | ||
| programId, | ||
| member: mint, | ||
| memberMint: mint, | ||
| memberMintAuthority: mintAuthorityPublicKey, | ||
| group, | ||
| groupUpdateAuthority, | ||
| }) | ||
| ); | ||
|
|
||
| return await sendAndConfirmTransaction(connection, transaction, [payer, ...signers], confirmOptions); | ||
| } | ||
|
|
||
| /** | ||
| * Initialize a new `Member` of a `Group` with rent transfer. | ||
| * | ||
| * Assumes the `Group` has already been initialized, | ||
| * as well as the mint for the member. | ||
| * | ||
| * @param connection Connection to use | ||
| * @param payer Payer of the transaction fee | ||
| * @param mint Member mint | ||
| * @param mintAuthority Member mint authority | ||
| * @param group Group mint | ||
| * @param groupUpdateAuthority Group update authority | ||
| * @param multiSigners Signing accounts if `authority` is a multisig | ||
| * @param confirmOptions Options for confirming the transaction | ||
| * @param programId SPL Token program account | ||
| * | ||
| * @return Signature of the confirmed transaction | ||
| */ | ||
| export async function tokenGroupMemberInitializeWithRentTransfer( | ||
| connection: Connection, | ||
| payer: Signer, | ||
| mint: PublicKey, | ||
| mintAuthority: PublicKey | Signer, | ||
| group: PublicKey, | ||
| groupUpdateAuthority: PublicKey, | ||
| multiSigners: Signer[] = [], | ||
| confirmOptions?: ConfirmOptions, | ||
| programId = TOKEN_2022_PROGRAM_ID | ||
| ): Promise<TransactionSignature> { | ||
| const [mintAuthorityPublicKey, signers] = getSigners(mintAuthority, multiSigners); | ||
|
|
||
| const lamports = await connection.getMinimumBalanceForRentExemption(TOKEN_GROUP_MEMBER_SIZE); | ||
|
|
||
| const transaction = new Transaction().add( | ||
| SystemProgram.transfer({ | ||
| fromPubkey: payer.publicKey, | ||
| toPubkey: mint, | ||
| lamports, | ||
| }), | ||
| createInitializeMemberInstruction({ | ||
| programId, | ||
| member: mint, | ||
| memberMint: mint, | ||
| memberMintAuthority: mintAuthorityPublicKey, | ||
| group, | ||
| groupUpdateAuthority, | ||
| }) | ||
| ); | ||
|
|
||
| return await sendAndConfirmTransaction(connection, transaction, [payer, ...signers], confirmOptions); | ||
| } |
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,2 @@ | ||
| export * from './actions.js'; | ||
| export * from './state.js'; |
Oops, something went wrong.