### Metaplex Hydra API Documentation Source: https://mpl-hydra.typedoc.metaplex.com/functions/fetchFanoutMint This section consolidates API documentation for various Metaplex Hydra instructions and data structures. It covers types related to wallet distribution, fanout management, membership vouchers, mints, and specific instructions for operations like initialization, member management, token staking, metadata signing, share transfers, and unstaking. ```APIDOC WalletInstructionData: Represents data for wallet distribution instructions. WalletInstructionDataArgs: Arguments for WalletInstructionData. Fanout: Represents fanout-related types. FanoutAccountData: Data structure for fanout accounts. FanoutAccountDataArgs: Arguments for FanoutAccountData. FanoutMembershipMintVoucher: Represents a membership voucher using a mint. FanoutMembershipMintVoucherAccountData: Account data for a membership mint voucher. FanoutMembershipMintVoucherAccountDataArgs: Arguments for FanoutMembershipMintVoucherAccountData. FanoutMembershipVoucher: Represents a membership voucher. FanoutMembershipVoucherAccountData: Account data for a membership voucher. FanoutMembershipVoucherAccountDataArgs: Arguments for FanoutMembershipVoucherAccountData. FanoutMint: Represents mint-related types. FanoutMintAccountData: Account data for a fanout mint. FanoutMintAccountDataArgs: Arguments for FanoutMintAccountData. InitForMintInstructionAccounts: Accounts required for initializing for a mint. InitForMintInstructionArgs: Arguments for initializing for a mint. InitForMintInstructionData: Data for initializing for a mint. InitForMintInstructionDataArgs: Arguments for InitForMintInstructionData. InitInstructionAccounts: Accounts required for initialization. InitInstructionArgs: Arguments for initialization. InitInstructionData: Data for initialization. InitInstructionDataArgs: Arguments for InitInstructionData. MembershipModelArgs: Arguments for MembershipModel. PickPartial: Utility type for creating partial types. RemoveMemberInstructionAccounts: Accounts required for removing a member. RemoveMemberInstructionData: Data for removing a member. RemoveMemberInstructionDataArgs: Arguments for RemoveMemberInstructionData. SetForTokenMemberStakeInstructionAccounts: Accounts required for setting token member stake. SetForTokenMemberStakeInstructionArgs: Arguments for setting token member stake. SetForTokenMemberStakeInstructionData: Data for setting token member stake. SetForTokenMemberStakeInstructionDataArgs: Arguments for SetForTokenMemberStakeInstructionData. SetTokenMemberStakeInstructionAccounts: Accounts required for setting token member stake. SetTokenMemberStakeInstructionArgs: Arguments for setting token member stake. SetTokenMemberStakeInstructionData: Data for setting token member stake. SetTokenMemberStakeInstructionDataArgs: Arguments for SetTokenMemberStakeInstructionData. SignMetadataInstructionAccounts: Accounts required for signing metadata. SignMetadataInstructionData: Data for signing metadata. SignMetadataInstructionDataArgs: Arguments for SignMetadataInstructionData. TransferSharesInstructionAccounts: Accounts required for transferring shares. TransferSharesInstructionArgs: Arguments for transferring shares. TransferSharesInstructionData: Data for transferring shares. TransferSharesInstructionDataArgs: Arguments for TransferSharesInstructionData. UnstakeInstructionAccounts: Accounts required for unstaking. UnstakeInstructionData: Data for unstaking. UnstakeInstructionDataArgs: Arguments for UnstakeInstructionData. ``` -------------------------------- ### findFanoutMembershipVoucherPda TypeScript Example Source: https://mpl-hydra.typedoc.metaplex.com/functions/findFanoutMembershipVoucherPda Example usage of the findFanoutMembershipVoucherPda function in TypeScript. This snippet demonstrates how to call the function with the required context and seeds to obtain the PDA. ```typescript import { findFanoutMembershipVoucherPda } from '@metaplex-foundation/mpl-hydra'; import { Context, PublicKey } from '@metaplex-foundation/mpl-core'; // Assuming these types are available async function getVoucherPda(context: Pick, fanoutAddress: PublicKey, memberAddress: PublicKey) { const seeds = { fanout: fanoutAddress, member: memberAddress }; const pda = findFanoutMembershipVoucherPda(context, seeds); return pda; } ``` -------------------------------- ### Metaplex Hydra API Documentation Source: https://mpl-hydra.typedoc.metaplex.com/functions/init This section consolidates API documentation for various Metaplex Hydra instructions and data structures. It covers types related to wallet distribution, fanout management, membership vouchers, mints, and specific instructions for operations like initialization, member management, token staking, metadata signing, share transfers, and unstaking. ```APIDOC WalletInstructionData: Represents data for wallet distribution instructions. WalletInstructionDataArgs: Arguments for WalletInstructionData. Fanout: Represents fanout-related types. FanoutAccountData: Data structure for fanout accounts. FanoutAccountDataArgs: Arguments for FanoutAccountData. FanoutMembershipMintVoucher: Represents a membership voucher using a mint. FanoutMembershipMintVoucherAccountData: Account data for a membership mint voucher. FanoutMembershipMintVoucherAccountDataArgs: Arguments for FanoutMembershipMintVoucherAccountData. FanoutMembershipVoucher: Represents a membership voucher. FanoutMembershipVoucherAccountData: Account data for a membership voucher. FanoutMembershipVoucherAccountDataArgs: Arguments for FanoutMembershipVoucherAccountData. FanoutMint: Represents mint-related types. FanoutMintAccountData: Account data for a fanout mint. FanoutMintAccountDataArgs: Arguments for FanoutMintAccountData. InitForMintInstructionAccounts: Accounts required for initializing for a mint. InitForMintInstructionArgs: Arguments for initializing for a mint. InitForMintInstructionData: Data for initializing for a mint. InitForMintInstructionDataArgs: Arguments for InitForMintInstructionData. InitInstructionAccounts: Accounts required for initialization. InitInstructionArgs: Arguments for initialization. InitInstructionData: Data for initialization. InitInstructionDataArgs: Arguments for InitInstructionData. MembershipModelArgs: Arguments for MembershipModel. PickPartial: Utility type for creating partial types. RemoveMemberInstructionAccounts: Accounts required for removing a member. RemoveMemberInstructionData: Data for removing a member. RemoveMemberInstructionDataArgs: Arguments for RemoveMemberInstructionData. SetForTokenMemberStakeInstructionAccounts: Accounts required for setting token member stake. SetForTokenMemberStakeInstructionArgs: Arguments for setting token member stake. SetForTokenMemberStakeInstructionData: Data for setting token member stake. SetForTokenMemberStakeInstructionDataArgs: Arguments for SetForTokenMemberStakeInstructionData. SetTokenMemberStakeInstructionAccounts: Accounts required for setting token member stake. SetTokenMemberStakeInstructionArgs: Arguments for setting token member stake. SetTokenMemberStakeInstructionData: Data for setting token member stake. SetTokenMemberStakeInstructionDataArgs: Arguments for SetTokenMemberStakeInstructionData. SignMetadataInstructionAccounts: Accounts required for signing metadata. SignMetadataInstructionData: Data for signing metadata. SignMetadataInstructionDataArgs: Arguments for SignMetadataInstructionData. TransferSharesInstructionAccounts: Accounts required for transferring shares. TransferSharesInstructionArgs: Arguments for transferring shares. TransferSharesInstructionData: Data for transferring shares. TransferSharesInstructionDataArgs: Arguments for TransferSharesInstructionData. UnstakeInstructionAccounts: Accounts required for unstaking. UnstakeInstructionData: Data for unstaking. UnstakeInstructionDataArgs: Arguments for UnstakeInstructionData. ``` -------------------------------- ### Metaplex UMI Plugin Installation Source: https://mpl-hydra.typedoc.metaplex.com/interfaces/_internal_.Umi Documentation for the `use` method in the Metaplex UMI SDK, which allows for the installation of UMI plugins. This method is essential for extending the functionality of the UMI instance. ```APIDOC use(plugin: UmiPlugin): Umi Installs a UMI plugin. Parameters: plugin: UmiPlugin Returns: Umi: The UMI instance after the plugin has been installed. Visibility: Protected, Private, Inherited, External ``` -------------------------------- ### Utility and Miscellaneous Types Source: https://mpl-hydra.typedoc.metaplex.com/variables/_internal_.Locale-1 Includes various utility types such as Amount, Some, UmiPlugin, and LocaleIdentifier, along with options for uploading and getting upload prices. ```APIDOC Amount: // Represents an amount, likely with a unit and value Some: // Represents an optional value of type T UmiErrorSource: // Defines sources for UMI errors UmiPlugin: // Represents a UMI plugin UnderlyingProgramError: // Represents an error from an underlying program UnicodeBCP47LocaleIdentifier: // Represents a BCP-47 locale identifier UploaderGetUploadPriceOptions: // Options for getting upload price UploaderUploadOptions: // Options for uploading data WrappedInstruction: // Represents an instruction that has been wrapped ``` -------------------------------- ### initForMint Function Source: https://mpl-hydra.typedoc.metaplex.com/functions/initForMint Initializes a mint account. This function is part of the mpl-hydra library and is used to set up a new mint. It requires a context object containing identity and programs, and an input object that combines account and data arguments. The function returns a TransactionBuilder. ```APIDOC Function initForMint * initForMint(context: Pick, input: InitForMintInstructionAccounts & InitForMintInstructionDataArgs): TransactionBuilder * #### Parameters * ##### context: Pick * ##### input: InitForMintInstructionAccounts & InitForMintInstructionDataArgs #### Returns TransactionBuilder * Defined in src/generated/instructions/initForMint.ts:81 #### Member Visibility * Protected * Private * Inherited * External ``` ```typescript initForMint(context: Pick, input: InitForMintInstructionAccounts & InitForMintInstructionDataArgs): TransactionBuilder ``` -------------------------------- ### Hydra Instruction Initialization Source: https://mpl-hydra.typedoc.metaplex.com/functions/fetchAllFanoutMint Functions for initializing various Hydra program instructions. ```APIDOC init: Description: Initializes a generic Hydra instruction. Usage: init() initForMint: Description: Initializes an instruction for a mint. Usage: initForMint() ``` -------------------------------- ### Utility and Miscellaneous Types Source: https://mpl-hydra.typedoc.metaplex.com/types/_internal_.WrapInSerializer Includes various utility types such as Amount, Some, UmiPlugin, and LocaleIdentifier, along with options for uploading and getting upload prices. ```APIDOC Amount: // Represents an amount, likely with a unit and value Some: // Represents an optional value of type T UmiErrorSource: // Defines sources for UMI errors UmiPlugin: // Represents a UMI plugin UnderlyingProgramError: // Represents an error from an underlying program UnicodeBCP47LocaleIdentifier: // Represents a BCP-47 locale identifier UploaderGetUploadPriceOptions: // Options for getting upload price UploaderUploadOptions: // Options for uploading data WrappedInstruction: // Represents an instruction that has been wrapped ``` -------------------------------- ### Hydra Instruction Initialization Source: https://mpl-hydra.typedoc.metaplex.com/functions/getFanoutAccountDataSerializer Functions for initializing various Hydra program instructions. ```APIDOC init: Description: Initializes a generic Hydra instruction. Usage: init() initForMint: Description: Initializes an instruction for a mint. Usage: initForMint() ``` -------------------------------- ### Utility and Miscellaneous Types Source: https://mpl-hydra.typedoc.metaplex.com/types/_internal_.UnderlyingProgramError Includes various utility types such as Amount, Some, UmiPlugin, and LocaleIdentifier, along with options for uploading and getting upload prices. ```APIDOC Amount: // Represents an amount, likely with a unit and value Some: // Represents an optional value of type T UmiErrorSource: // Defines sources for UMI errors UmiPlugin: // Represents a UMI plugin UnderlyingProgramError: // Represents an error from an underlying program UnicodeBCP47LocaleIdentifier: // Represents a BCP-47 locale identifier UploaderGetUploadPriceOptions: // Options for getting upload price UploaderUploadOptions: // Options for uploading data WrappedInstruction: // Represents an instruction that has been wrapped ``` -------------------------------- ### InitForMintInstructionAccounts Type Source: https://mpl-hydra.typedoc.metaplex.com/types/InitForMintInstructionAccounts Defines the accounts required for the InitForMint instruction. This includes various public keys for fanout, mint, and holding accounts, with optional authority and rent/system program references. ```APIDOC Type alias InitForMintInstructionAccounts InitForMintInstructionAccounts: { authority?: Signer; fanout: PublicKey | Pda; fanoutForMint: PublicKey | Pda; mint: PublicKey | Pda; mintHoldingAccount: PublicKey | Pda; rent?: PublicKey | Pda; systemProgram?: PublicKey | Pda; } Type declaration: Optional authority?: Signer fanout: PublicKey | Pda fanoutForMint: PublicKey | Pda mint: PublicKey | Pda mintHoldingAccount: PublicKey | Pda Optional rent?: PublicKey | Pda Optional systemProgram?: PublicKey | Pda; Defined in src/generated/instructions/initForMint.ts:29 ``` -------------------------------- ### Utility and Miscellaneous Types Source: https://mpl-hydra.typedoc.metaplex.com/types/_internal_.UnicodeBCP47LocaleIdentifier Includes various utility types such as Amount, Some, UmiPlugin, and LocaleIdentifier, along with options for uploading and getting upload prices. ```APIDOC Amount: // Represents an amount, likely with a unit and value Some: // Represents an optional value of type T UmiErrorSource: // Defines sources for UMI errors UmiPlugin: // Represents a UMI plugin UnderlyingProgramError: // Represents an error from an underlying program UnicodeBCP47LocaleIdentifier: // Represents a BCP-47 locale identifier UploaderGetUploadPriceOptions: // Options for getting upload price UploaderUploadOptions: // Options for uploading data WrappedInstruction: // Represents an instruction that has been wrapped ``` -------------------------------- ### Utility and Miscellaneous Types Source: https://mpl-hydra.typedoc.metaplex.com/types/_internal_.TransactionInputLegacy Includes various utility types such as Amount, Some, UmiPlugin, and LocaleIdentifier, along with options for uploading and getting upload prices. ```APIDOC Amount: // Represents an amount, likely with a unit and value Some: // Represents an optional value of type T UmiErrorSource: // Defines sources for UMI errors UmiPlugin: // Represents a UMI plugin UnderlyingProgramError: // Represents an error from an underlying program UnicodeBCP47LocaleIdentifier: // Represents a BCP-47 locale identifier UploaderGetUploadPriceOptions: // Options for getting upload price UploaderUploadOptions: // Options for uploading data WrappedInstruction: // Represents an instruction that has been wrapped ``` -------------------------------- ### Metaplex Hydra API Documentation Source: https://mpl-hydra.typedoc.metaplex.com/functions/fetchAllFanout This section consolidates API documentation for various Metaplex Hydra instructions and data structures. It covers types related to wallet distribution, fanout management, membership vouchers, mints, and specific instructions for operations like initialization, member management, token staking, metadata signing, share transfers, and unstaking. ```APIDOC WalletInstructionData: Represents data for wallet distribution instructions. WalletInstructionDataArgs: Arguments for WalletInstructionData. Fanout: Represents fanout-related types. FanoutAccountData: Data structure for fanout accounts. FanoutAccountDataArgs: Arguments for FanoutAccountData. FanoutMembershipMintVoucher: Represents a membership voucher using a mint. FanoutMembershipMintVoucherAccountData: Account data for a membership mint voucher. FanoutMembershipMintVoucherAccountDataArgs: Arguments for FanoutMembershipMintVoucherAccountData. FanoutMembershipVoucher: Represents a membership voucher. FanoutMembershipVoucherAccountData: Account data for a membership voucher. FanoutMembershipVoucherAccountDataArgs: Arguments for FanoutMembershipVoucherAccountData. FanoutMint: Represents mint-related types. FanoutMintAccountData: Account data for a fanout mint. FanoutMintAccountDataArgs: Arguments for FanoutMintAccountData. InitForMintInstructionAccounts: Accounts required for initializing for a mint. InitForMintInstructionArgs: Arguments for initializing for a mint. InitForMintInstructionData: Data for initializing for a mint. InitForMintInstructionDataArgs: Arguments for InitForMintInstructionData. InitInstructionAccounts: Accounts required for initialization. InitInstructionArgs: Arguments for initialization. InitInstructionData: Data for initialization. InitInstructionDataArgs: Arguments for InitInstructionData. MembershipModelArgs: Arguments for MembershipModel. PickPartial: Utility type for creating partial types. RemoveMemberInstructionAccounts: Accounts required for removing a member. RemoveMemberInstructionData: Data for removing a member. RemoveMemberInstructionDataArgs: Arguments for RemoveMemberInstructionData. SetForTokenMemberStakeInstructionAccounts: Accounts required for setting token member stake. SetForTokenMemberStakeInstructionArgs: Arguments for setting token member stake. SetForTokenMemberStakeInstructionData: Data for setting token member stake. SetForTokenMemberStakeInstructionDataArgs: Arguments for SetForTokenMemberStakeInstructionData. SetTokenMemberStakeInstructionAccounts: Accounts required for setting token member stake. SetTokenMemberStakeInstructionArgs: Arguments for setting token member stake. SetTokenMemberStakeInstructionData: Data for setting token member stake. SetTokenMemberStakeInstructionDataArgs: Arguments for SetTokenMemberStakeInstructionData. SignMetadataInstructionAccounts: Accounts required for signing metadata. SignMetadataInstructionData: Data for signing metadata. SignMetadataInstructionDataArgs: Arguments for SignMetadataInstructionData. TransferSharesInstructionAccounts: Accounts required for transferring shares. TransferSharesInstructionArgs: Arguments for transferring shares. TransferSharesInstructionData: Data for transferring shares. TransferSharesInstructionDataArgs: Arguments for TransferSharesInstructionData. UnstakeInstructionAccounts: Accounts required for unstaking. UnstakeInstructionData: Data for unstaking. UnstakeInstructionDataArgs: Arguments for UnstakeInstructionData. ``` -------------------------------- ### Utility and Miscellaneous Types Source: https://mpl-hydra.typedoc.metaplex.com/types/_internal_.TransactionBuilderOptions Includes various utility types such as Amount, Some, UmiPlugin, and LocaleIdentifier, along with options for uploading and getting upload prices. ```APIDOC Amount: // Represents an amount, likely with a unit and value Some: // Represents an optional value of type T UmiErrorSource: // Defines sources for UMI errors UmiPlugin: // Represents a UMI plugin UnderlyingProgramError: // Represents an error from an underlying program UnicodeBCP47LocaleIdentifier: // Represents a BCP-47 locale identifier UploaderGetUploadPriceOptions: // Options for getting upload price UploaderUploadOptions: // Options for uploading data WrappedInstruction: // Represents an instruction that has been wrapped ``` -------------------------------- ### Hydra Instruction Initialization Source: https://mpl-hydra.typedoc.metaplex.com/functions/getFanoutMembershipVoucherAccountDataSerializer Functions for initializing various Hydra program instructions. ```APIDOC init: Description: Initializes a generic Hydra instruction. Usage: init() initForMint: Description: Initializes an instruction for a mint. Usage: initForMint() ``` -------------------------------- ### Utility and Miscellaneous Types Source: https://mpl-hydra.typedoc.metaplex.com/types/_internal_.StringSerializerOptions Includes various utility types such as Amount, Some, UmiPlugin, and LocaleIdentifier, along with options for uploading and getting upload prices. ```APIDOC Amount: // Represents an amount, likely with a unit and value Some: // Represents an optional value of type T UmiErrorSource: // Defines sources for UMI errors UmiPlugin: // Represents a UMI plugin UnderlyingProgramError: // Represents an error from an underlying program UnicodeBCP47LocaleIdentifier: // Represents a BCP-47 locale identifier UploaderGetUploadPriceOptions: // Options for getting upload price UploaderUploadOptions: // Options for uploading data WrappedInstruction: // Represents an instruction that has been wrapped ``` -------------------------------- ### Hydra Instruction Initialization Source: https://mpl-hydra.typedoc.metaplex.com/functions/fetchFanoutMintFromSeeds Functions for initializing various Hydra program instructions. ```APIDOC init: Description: Initializes a generic Hydra instruction. Usage: init() initForMint: Description: Initializes an instruction for a mint. Usage: initForMint() ``` -------------------------------- ### Utility and Miscellaneous Types Source: https://mpl-hydra.typedoc.metaplex.com/types/_internal_.SolAmount Includes various utility types such as Amount, Some, UmiPlugin, and LocaleIdentifier, along with options for uploading and getting upload prices. ```APIDOC Amount: // Represents an amount, likely with a unit and value Some: // Represents an optional value of type T UmiErrorSource: // Defines sources for UMI errors UmiPlugin: // Represents a UMI plugin UnderlyingProgramError: // Represents an error from an underlying program UnicodeBCP47LocaleIdentifier: // Represents a BCP-47 locale identifier UploaderGetUploadPriceOptions: // Options for getting upload price UploaderUploadOptions: // Options for uploading data WrappedInstruction: // Represents an instruction that has been wrapped ``` -------------------------------- ### Metaplex Hydra Account Creation and Management Source: https://mpl-hydra.typedoc.metaplex.com/functions/fetchFanoutMint Functions for creating and managing accounts and instructions related to the Metaplex Hydra program, including adding members and distributing assets. ```APIDOC addAccountMeta(account: PublicKey, isSigner: boolean, isWritable: boolean): description: Creates an AccountMeta object. parameters: - name: account type: PublicKey description: The public key of the account. - name: isSigner type: boolean description: Whether the account is a signer. - name: isWritable type: boolean description: Whether the account is writable. returns: AccountMeta addMemberNft(fanout: PublicKey, member: PublicKey, mint: PublicKey): description: Creates instruction data for adding an NFT member to a fanout. parameters: - name: fanout type: PublicKey description: The fanout account. - name: member type: PublicKey description: The member's public key. - name: mint type: PublicKey description: The mint address of the NFT. returns: InstructionData addMemberWallet(fanout: PublicKey, member: PublicKey): description: Creates instruction data for adding a wallet member to a fanout. parameters: - name: fanout type: PublicKey description: The fanout account. - name: member type: PublicKey description: The member's public key. returns: InstructionData addObjectProperty(key: string, value: any): description: Creates an object property. parameters: - name: key type: string description: The property key. - name: value type: any description: The property value. returns: ObjectProperty createMplHydraProgram(programId: PublicKey): description: Creates a Metaplex Hydra program instance. parameters: - name: programId type: PublicKey description: The program ID of the Hydra program. returns: MplHydraProgram distributeNft(fanout: PublicKey, mint: PublicKey): description: Creates instruction data for distributing an NFT from a fanout. parameters: - name: fanout type: PublicKey description: The fanout account. - name: mint type: PublicKey description: The mint address of the NFT. returns: InstructionData distributeToken(fanout: PublicKey, mint: PublicKey): description: Creates instruction data for distributing a token from a fanout. parameters: - name: fanout type: PublicKey description: The fanout account. - name: mint type: PublicKey description: The mint address of the token. returns: InstructionData distributeWallet(fanout: PublicKey, wallet: PublicKey): description: Creates instruction data for distributing a wallet from a fanout. parameters: - name: fanout type: PublicKey description: The fanout account. - name: wallet type: PublicKey description: The wallet address. returns: InstructionData ``` -------------------------------- ### Utility and Miscellaneous Types Source: https://mpl-hydra.typedoc.metaplex.com/types/_internal_.RpcConfirmTransactionResult Includes various utility types such as Amount, Some, UmiPlugin, and LocaleIdentifier, along with options for uploading and getting upload prices. ```APIDOC Amount: // Represents an amount, likely with a unit and value Some: // Represents an optional value of type T UmiErrorSource: // Defines sources for UMI errors UmiPlugin: // Represents a UMI plugin UnderlyingProgramError: // Represents an error from an underlying program UnicodeBCP47LocaleIdentifier: // Represents a BCP-47 locale identifier UploaderGetUploadPriceOptions: // Options for getting upload price UploaderUploadOptions: // Options for uploading data WrappedInstruction: // Represents an instruction that has been wrapped ``` -------------------------------- ### Metaplex Hydra API Documentation Source: https://mpl-hydra.typedoc.metaplex.com/functions/fetchAllFanoutMint This section consolidates API documentation for various Metaplex Hydra instructions and data structures. It covers types related to wallet distribution, fanout management, membership vouchers, mints, and specific instructions for operations like initialization, member management, token staking, metadata signing, share transfers, and unstaking. ```APIDOC WalletInstructionData: Represents data for wallet distribution instructions. WalletInstructionDataArgs: Arguments for WalletInstructionData. Fanout: Represents fanout-related types. FanoutAccountData: Data structure for fanout accounts. FanoutAccountDataArgs: Arguments for FanoutAccountData. FanoutMembershipMintVoucher: Represents a membership voucher using a mint. FanoutMembershipMintVoucherAccountData: Account data for a membership mint voucher. FanoutMembershipMintVoucherAccountDataArgs: Arguments for FanoutMembershipMintVoucherAccountData. FanoutMembershipVoucher: Represents a membership voucher. FanoutMembershipVoucherAccountData: Account data for a membership voucher. FanoutMembershipVoucherAccountDataArgs: Arguments for FanoutMembershipVoucherAccountData. FanoutMint: Represents mint-related types. FanoutMintAccountData: Account data for a fanout mint. FanoutMintAccountDataArgs: Arguments for FanoutMintAccountData. InitForMintInstructionAccounts: Accounts required for initializing for a mint. InitForMintInstructionArgs: Arguments for initializing for a mint. InitForMintInstructionData: Data for initializing for a mint. InitForMintInstructionDataArgs: Arguments for InitForMintInstructionData. InitInstructionAccounts: Accounts required for initialization. InitInstructionArgs: Arguments for initialization. InitInstructionData: Data for initialization. InitInstructionDataArgs: Arguments for InitInstructionData. MembershipModelArgs: Arguments for MembershipModel. PickPartial: Utility type for creating partial types. RemoveMemberInstructionAccounts: Accounts required for removing a member. RemoveMemberInstructionData: Data for removing a member. RemoveMemberInstructionDataArgs: Arguments for RemoveMemberInstructionData. SetForTokenMemberStakeInstructionAccounts: Accounts required for setting token member stake. SetForTokenMemberStakeInstructionArgs: Arguments for setting token member stake. SetForTokenMemberStakeInstructionData: Data for setting token member stake. SetForTokenMemberStakeInstructionDataArgs: Arguments for SetForTokenMemberStakeInstructionData. SetTokenMemberStakeInstructionAccounts: Accounts required for setting token member stake. SetTokenMemberStakeInstructionArgs: Arguments for setting token member stake. SetTokenMemberStakeInstructionData: Data for setting token member stake. SetTokenMemberStakeInstructionDataArgs: Arguments for SetTokenMemberStakeInstructionData. SignMetadataInstructionAccounts: Accounts required for signing metadata. SignMetadataInstructionData: Data for signing metadata. SignMetadataInstructionDataArgs: Arguments for SignMetadataInstructionData. TransferSharesInstructionAccounts: Accounts required for transferring shares. TransferSharesInstructionArgs: Arguments for transferring shares. TransferSharesInstructionData: Data for transferring shares. TransferSharesInstructionDataArgs: Arguments for TransferSharesInstructionData. UnstakeInstructionAccounts: Accounts required for unstaking. UnstakeInstructionData: Data for unstaking. UnstakeInstructionDataArgs: Arguments for UnstakeInstructionData. ``` -------------------------------- ### Metaplex Hydra API Documentation Source: https://mpl-hydra.typedoc.metaplex.com/functions/fetchFanoutFromSeeds This section consolidates API documentation for various Metaplex Hydra instructions and data structures. It covers types related to wallet distribution, fanout management, membership vouchers, mints, and specific instructions for operations like initialization, member management, token staking, metadata signing, share transfers, and unstaking. ```APIDOC WalletInstructionData: Represents data for wallet distribution instructions. WalletInstructionDataArgs: Arguments for WalletInstructionData. Fanout: Represents fanout-related types. FanoutAccountData: Data structure for fanout accounts. FanoutAccountDataArgs: Arguments for FanoutAccountData. FanoutMembershipMintVoucher: Represents a membership voucher using a mint. FanoutMembershipMintVoucherAccountData: Account data for a membership mint voucher. FanoutMembershipMintVoucherAccountDataArgs: Arguments for FanoutMembershipMintVoucherAccountData. FanoutMembershipVoucher: Represents a membership voucher. FanoutMembershipVoucherAccountData: Account data for a membership voucher. FanoutMembershipVoucherAccountDataArgs: Arguments for FanoutMembershipVoucherAccountData. FanoutMint: Represents mint-related types. FanoutMintAccountData: Account data for a fanout mint. FanoutMintAccountDataArgs: Arguments for FanoutMintAccountData. InitForMintInstructionAccounts: Accounts required for initializing for a mint. InitForMintInstructionArgs: Arguments for initializing for a mint. InitForMintInstructionData: Data for initializing for a mint. InitForMintInstructionDataArgs: Arguments for InitForMintInstructionData. InitInstructionAccounts: Accounts required for initialization. InitInstructionArgs: Arguments for initialization. InitInstructionData: Data for initialization. InitInstructionDataArgs: Arguments for InitInstructionData. MembershipModelArgs: Arguments for MembershipModel. PickPartial: Utility type for creating partial types. RemoveMemberInstructionAccounts: Accounts required for removing a member. RemoveMemberInstructionData: Data for removing a member. RemoveMemberInstructionDataArgs: Arguments for RemoveMemberInstructionData. SetForTokenMemberStakeInstructionAccounts: Accounts required for setting token member stake. SetForTokenMemberStakeInstructionArgs: Arguments for setting token member stake. SetForTokenMemberStakeInstructionData: Data for setting token member stake. SetForTokenMemberStakeInstructionDataArgs: Arguments for SetForTokenMemberStakeInstructionData. SetTokenMemberStakeInstructionAccounts: Accounts required for setting token member stake. SetTokenMemberStakeInstructionArgs: Arguments for setting token member stake. SetTokenMemberStakeInstructionData: Data for setting token member stake. SetTokenMemberStakeInstructionDataArgs: Arguments for SetTokenMemberStakeInstructionData. SignMetadataInstructionAccounts: Accounts required for signing metadata. SignMetadataInstructionData: Data for signing metadata. SignMetadataInstructionDataArgs: Arguments for SignMetadataInstructionData. TransferSharesInstructionAccounts: Accounts required for transferring shares. TransferSharesInstructionArgs: Arguments for transferring shares. TransferSharesInstructionData: Data for transferring shares. TransferSharesInstructionDataArgs: Arguments for TransferSharesInstructionData. UnstakeInstructionAccounts: Accounts required for unstaking. UnstakeInstructionData: Data for unstaking. UnstakeInstructionDataArgs: Arguments for UnstakeInstructionData. ``` -------------------------------- ### Utility and Miscellaneous Types Source: https://mpl-hydra.typedoc.metaplex.com/types/_internal_.RpcConfirmTransactionOptions Includes various utility types such as Amount, Some, UmiPlugin, and LocaleIdentifier, along with options for uploading and getting upload prices. ```APIDOC Amount: // Represents an amount, likely with a unit and value Some: // Represents an optional value of type T UmiErrorSource: // Defines sources for UMI errors UmiPlugin: // Represents a UMI plugin UnderlyingProgramError: // Represents an error from an underlying program UnicodeBCP47LocaleIdentifier: // Represents a BCP-47 locale identifier UploaderGetUploadPriceOptions: // Options for getting upload price UploaderUploadOptions: // Options for uploading data WrappedInstruction: // Represents an instruction that has been wrapped ``` -------------------------------- ### Utility and Miscellaneous Types Source: https://mpl-hydra.typedoc.metaplex.com/types/_internal_.NumberSerializer Includes various utility types such as Amount, Some, UmiPlugin, and LocaleIdentifier, along with options for uploading and getting upload prices. ```APIDOC Amount: // Represents an amount, likely with a unit and value Some: // Represents an optional value of type T UmiErrorSource: // Defines sources for UMI errors UmiPlugin: // Represents a UMI plugin UnderlyingProgramError: // Represents an error from an underlying program UnicodeBCP47LocaleIdentifier: // Represents a BCP-47 locale identifier UploaderGetUploadPriceOptions: // Options for getting upload price UploaderUploadOptions: // Options for uploading data WrappedInstruction: // Represents an instruction that has been wrapped ``` -------------------------------- ### Metaplex Hydra API Documentation Source: https://mpl-hydra.typedoc.metaplex.com/types/InitForMintInstructionAccounts This section consolidates API documentation for various Metaplex Hydra instructions and data structures. It covers types related to wallet distribution, fanout management, membership vouchers, mints, and specific instructions for operations like initialization, member management, token staking, metadata signing, share transfers, and unstaking. ```APIDOC WalletInstructionData: Represents data for wallet distribution instructions. WalletInstructionDataArgs: Arguments for WalletInstructionData. Fanout: Represents fanout-related types. FanoutAccountData: Data structure for fanout accounts. FanoutAccountDataArgs: Arguments for FanoutAccountData. FanoutMembershipMintVoucher: Represents a membership voucher using a mint. FanoutMembershipMintVoucherAccountData: Account data for a membership mint voucher. FanoutMembershipMintVoucherAccountDataArgs: Arguments for FanoutMembershipMintVoucherAccountData. FanoutMembershipVoucher: Represents a membership voucher. FanoutMembershipVoucherAccountData: Account data for a membership voucher. FanoutMembershipVoucherAccountDataArgs: Arguments for FanoutMembershipVoucherAccountData. FanoutMint: Represents mint-related types. FanoutMintAccountData: Account data for a fanout mint. FanoutMintAccountDataArgs: Arguments for FanoutMintAccountData. InitForMintInstructionAccounts: Accounts required for initializing for a mint. InitForMintInstructionArgs: Arguments for initializing for a mint. InitForMintInstructionData: Data for initializing for a mint. InitForMintInstructionDataArgs: Arguments for InitForMintInstructionData. InitInstructionAccounts: Accounts required for initialization. InitInstructionArgs: Arguments for initialization. InitInstructionData: Data for initialization. InitInstructionDataArgs: Arguments for InitInstructionData. MembershipModelArgs: Arguments for MembershipModel. PickPartial: Utility type for creating partial types. RemoveMemberInstructionAccounts: Accounts required for removing a member. RemoveMemberInstructionData: Data for removing a member. RemoveMemberInstructionDataArgs: Arguments for RemoveMemberInstructionData. SetForTokenMemberStakeInstructionAccounts: Accounts required for setting token member stake. SetForTokenMemberStakeInstructionArgs: Arguments for setting token member stake. SetForTokenMemberStakeInstructionData: Data for setting token member stake. SetForTokenMemberStakeInstructionDataArgs: Arguments for SetForTokenMemberStakeInstructionData. SetTokenMemberStakeInstructionAccounts: Accounts required for setting token member stake. SetTokenMemberStakeInstructionArgs: Arguments for setting token member stake. SetTokenMemberStakeInstructionData: Data for setting token member stake. SetTokenMemberStakeInstructionDataArgs: Arguments for SetTokenMemberStakeInstructionData. SignMetadataInstructionAccounts: Accounts required for signing metadata. SignMetadataInstructionData: Data for signing metadata. SignMetadataInstructionDataArgs: Arguments for SignMetadataInstructionData. TransferSharesInstructionAccounts: Accounts required for transferring shares. TransferSharesInstructionArgs: Arguments for transferring shares. TransferSharesInstructionData: Data for transferring shares. TransferSharesInstructionDataArgs: Arguments for TransferSharesInstructionData. UnstakeInstructionAccounts: Accounts required for unstaking. UnstakeInstructionData: Data for unstaking. UnstakeInstructionDataArgs: Arguments for UnstakeInstructionData. ``` -------------------------------- ### Hydra Instruction Initialization Source: https://mpl-hydra.typedoc.metaplex.com/functions/getSetForTokenMemberStakeInstructionDataSerializer Functions for initializing various Hydra program instructions. ```APIDOC init: Description: Initializes a generic Hydra instruction. Usage: init() initForMint: Description: Initializes an instruction for a mint. Usage: initForMint() ``` -------------------------------- ### Utility and Miscellaneous Types Source: https://mpl-hydra.typedoc.metaplex.com/types/_internal_.ErrorWithLogs Includes various utility types such as Amount, Some, UmiPlugin, and LocaleIdentifier, along with options for uploading and getting upload prices. ```APIDOC Amount: // Represents an amount, likely with a unit and value Some: // Represents an optional value of type T UmiErrorSource: // Defines sources for UMI errors UmiPlugin: // Represents a UMI plugin UnderlyingProgramError: // Represents an error from an underlying program UnicodeBCP47LocaleIdentifier: // Represents a BCP-47 locale identifier UploaderGetUploadPriceOptions: // Options for getting upload price UploaderUploadOptions: // Options for uploading data WrappedInstruction: // Represents an instruction that has been wrapped ``` -------------------------------- ### Hydra Instruction Initialization Source: https://mpl-hydra.typedoc.metaplex.com/functions/getFanoutMintGpaBuilder Functions for initializing various Hydra program instructions. ```APIDOC init: Description: Initializes a generic Hydra instruction. Usage: init() initForMint: Description: Initializes an instruction for a mint. Usage: initForMint() ``` -------------------------------- ### Utility and Miscellaneous Types Source: https://mpl-hydra.typedoc.metaplex.com/types/_internal_.DownloaderOptions Includes various utility types such as Amount, Some, UmiPlugin, and LocaleIdentifier, along with options for uploading and getting upload prices. ```APIDOC Amount: // Represents an amount, likely with a unit and value Some: // Represents an optional value of type T UmiErrorSource: // Defines sources for UMI errors UmiPlugin: // Represents a UMI plugin UnderlyingProgramError: // Represents an error from an underlying program UnicodeBCP47LocaleIdentifier: // Represents a BCP-47 locale identifier UploaderGetUploadPriceOptions: // Options for getting upload price UploaderUploadOptions: // Options for uploading data WrappedInstruction: // Represents an instruction that has been wrapped ``` -------------------------------- ### Utility and Miscellaneous Types Source: https://mpl-hydra.typedoc.metaplex.com/types/_internal_.DataEnum Includes various utility types such as Amount, Some, UmiPlugin, and LocaleIdentifier, along with options for uploading and getting upload prices. ```APIDOC Amount: // Represents an amount, likely with a unit and value Some: // Represents an optional value of type T UmiErrorSource: // Defines sources for UMI errors UmiPlugin: // Represents a UMI plugin UnderlyingProgramError: // Represents an error from an underlying program UnicodeBCP47LocaleIdentifier: // Represents a BCP-47 locale identifier UploaderGetUploadPriceOptions: // Options for getting upload price UploaderUploadOptions: // Options for uploading data WrappedInstruction: // Represents an instruction that has been wrapped ``` -------------------------------- ### Hydra Instruction Initialization Source: https://mpl-hydra.typedoc.metaplex.com/functions/safeFetchFanoutMembershipMintVoucherFromSeeds Functions for initializing various Hydra program instructions. ```APIDOC init: Description: Initializes a generic Hydra instruction. Usage: init() initForMint: Description: Initializes an instruction for a mint. Usage: initForMint() ``` -------------------------------- ### Utility and Miscellaneous Types Source: https://mpl-hydra.typedoc.metaplex.com/types/_internal_.DataEnumSerializerOptions Includes various utility types such as Amount, Some, UmiPlugin, and LocaleIdentifier, along with options for uploading and getting upload prices. ```APIDOC Amount: // Represents an amount, likely with a unit and value Some: // Represents an optional value of type T UmiErrorSource: // Defines sources for UMI errors UmiPlugin: // Represents a UMI plugin UnderlyingProgramError: // Represents an error from an underlying program UnicodeBCP47LocaleIdentifier: // Represents a BCP-47 locale identifier UploaderGetUploadPriceOptions: // Options for getting upload price UploaderUploadOptions: // Options for uploading data WrappedInstruction: // Represents an instruction that has been wrapped ``` -------------------------------- ### Metaplex Hydra API Documentation Source: https://mpl-hydra.typedoc.metaplex.com/functions/fetchAllFanoutMembershipVoucher This section consolidates API documentation for various Metaplex Hydra instructions and data structures. It covers types related to wallet distribution, fanout management, membership vouchers, mints, and specific instructions for operations like initialization, member management, token staking, metadata signing, share transfers, and unstaking. ```APIDOC WalletInstructionData: Represents data for wallet distribution instructions. WalletInstructionDataArgs: Arguments for WalletInstructionData. Fanout: Represents fanout-related types. FanoutAccountData: Data structure for fanout accounts. FanoutAccountDataArgs: Arguments for FanoutAccountData. FanoutMembershipMintVoucher: Represents a membership voucher using a mint. FanoutMembershipMintVoucherAccountData: Account data for a membership mint voucher. FanoutMembershipMintVoucherAccountDataArgs: Arguments for FanoutMembershipMintVoucherAccountData. FanoutMembershipVoucher: Represents a membership voucher. FanoutMembershipVoucherAccountData: Account data for a membership voucher. FanoutMembershipVoucherAccountDataArgs: Arguments for FanoutMembershipVoucherAccountData. FanoutMint: Represents mint-related types. FanoutMintAccountData: Account data for a fanout mint. FanoutMintAccountDataArgs: Arguments for FanoutMintAccountData. InitForMintInstructionAccounts: Accounts required for initializing for a mint. InitForMintInstructionArgs: Arguments for initializing for a mint. InitForMintInstructionData: Data for initializing for a mint. InitForMintInstructionDataArgs: Arguments for InitForMintInstructionData. InitInstructionAccounts: Accounts required for initialization. InitInstructionArgs: Arguments for initialization. InitInstructionData: Data for initialization. InitInstructionDataArgs: Arguments for InitInstructionData. MembershipModelArgs: Arguments for MembershipModel. PickPartial: Utility type for creating partial types. RemoveMemberInstructionAccounts: Accounts required for removing a member. RemoveMemberInstructionData: Data for removing a member. RemoveMemberInstructionDataArgs: Arguments for RemoveMemberInstructionData. SetForTokenMemberStakeInstructionAccounts: Accounts required for setting token member stake. SetForTokenMemberStakeInstructionArgs: Arguments for setting token member stake. SetForTokenMemberStakeInstructionData: Data for setting token member stake. SetForTokenMemberStakeInstructionDataArgs: Arguments for SetForTokenMemberStakeInstructionData. SetTokenMemberStakeInstructionAccounts: Accounts required for setting token member stake. SetTokenMemberStakeInstructionArgs: Arguments for setting token member stake. SetTokenMemberStakeInstructionData: Data for setting token member stake. SetTokenMemberStakeInstructionDataArgs: Arguments for SetTokenMemberStakeInstructionData. SignMetadataInstructionAccounts: Accounts required for signing metadata. SignMetadataInstructionData: Data for signing metadata. SignMetadataInstructionDataArgs: Arguments for SignMetadataInstructionData. TransferSharesInstructionAccounts: Accounts required for transferring shares. TransferSharesInstructionArgs: Arguments for transferring shares. TransferSharesInstructionData: Data for transferring shares. TransferSharesInstructionDataArgs: Arguments for TransferSharesInstructionData. UnstakeInstructionAccounts: Accounts required for unstaking. UnstakeInstructionData: Data for unstaking. UnstakeInstructionDataArgs: Arguments for UnstakeInstructionData. ```