Type alias TransferNftInput

TransferNftInput: {
    nftOrSft: Pick<Sft, "address" | "tokenStandard">;
    toOwner: PublicKey;
    authority?: Signer | TokenMetadataAuthorityTokenDelegate | TokenMetadataAuthorityHolder;
    authorizationDetails?: TokenMetadataAuthorizationDetails;
    fromOwner?: PublicKey;
    fromToken?: PublicKey;
    toToken?: PublicKey;
    amount?: SplTokenAmount;
    compression?: TransferNftCompressionParam;
}

Type declaration

  • nftOrSft: Pick<Sft, "address" | "tokenStandard">

    The NFT or SFT to transfer. We only need its address and token standard.

  • toOwner: PublicKey

    The wallet to send the tokens to.

  • Optional authority?: Signer | TokenMetadataAuthorityTokenDelegate | TokenMetadataAuthorityHolder

    An authority allowed to transfer the asset.

    Note that Metadata authorities are not supported for this instruction.

    If a Signer is provided directly, it will be used as an Holder authority.

    See

    TokenMetadataAuthority

    Default Value

    metaplex.identity()

  • Optional authorizationDetails?: TokenMetadataAuthorizationDetails

    The authorization rules and data to use for the transfer.

    See

    TokenMetadataAuthorizationDetails

    Default Value

    Defaults to not using auth rules.

  • Optional fromOwner?: PublicKey

    The wallet to get the tokens from.

    Default Value

    The public key of the provided authority.

  • Optional fromToken?: PublicKey

    The token account to be debited.

    Default Value

    Defaults to the associated token account of fromOwner.

  • Optional toToken?: PublicKey

    The token account to be credited.

    Default Value

    Defaults to the associated token account of toOwner.

  • Optional amount?: SplTokenAmount

    The amount of tokens to transfer.

    Default Value

    token(1)

  • Optional compression?: TransferNftCompressionParam

    The compression data needed for transfer.

Settings

Member Visibility

Theme

Generated using TypeDoc