diff --git a/docs/classes/_solana_suite_compressed_nft.CompressedNft.Space.html b/docs/classes/_solana_suite_compressed_nft.CompressedNft.Space.html index dc8fea572..a832ad0c4 100644 --- a/docs/classes/_solana_suite_compressed_nft.CompressedNft.Space.html +++ b/docs/classes/_solana_suite_compressed_nft.CompressedNft.Space.html @@ -156,10 +156,10 @@ --md-sys-color-surface-container-high: #e9e7ec; --md-sys-color-surface-container-highest: #e4e2e6 } -

Class Space

Constructors

constructor +

Class Space

Constructors

constructor

Properties

spaceOwner

Methods

getAssetId -

Constructors

constructor

Properties

spaceOwner

spaceOwner: Pubkey

Methods

getAssetId

  • getAssetId(): Promise<Pubkey>

  • Returns Promise<Pubkey>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

Function request

  • request(pubkey, options?): Promise<Result<string, Error>>

  • Reuqest airdrop SOL only devnet, testnet

    Parameters

    • pubkey: Pubkey
    • options: Partial<AirdropOptions> = {}

    Returns Promise<Result<string, Error>>

    Promise<Result<string, Error>>

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

Function calculateSpaceCost

  • calculateSpaceCost(spaceSize): Promise<{
        sol: number;
    }>

  • Calculate space cost

    Parameters

    • spaceSize: number

    Returns Promise<{
        sol: number;
    }>

    Promise<{sol: number}>

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

Function createSpace

  • createSpace(owner, spaceSize, options?): Promise<Result<MintStructure, Error>>

  • create a new nft space This function needs only 1 call

    Parameters

    • owner: Secret
    • spaceSize: SpaceNumber
    • options: Partial<SpaceOptions> = {}

    Returns Promise<Result<MintStructure, Error>>

    Promise<Result<MintTransaction, Error>>

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

Function findByCollection

  • findByCollection(collectionMint, options?): Promise<Result<NftMetadata, Error>>

  • Find nft by collection mint

    Parameters

    • collectionMint: Pubkey
    • options: Partial<FindOptions> = {}

    Returns Promise<Result<NftMetadata, Error>>

    Promise<Result<CompressedNftMetadata, Error>>

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

Function findByMint

  • findByMint(mint): Promise<Result<Partial<Metadata>, Error>>

  • Find nft by mint address

    Parameters

    • mint: Pubkey

    Returns Promise<Result<Partial<Metadata>, Error>>

    Promise<Result<NftMetadata, Error>>

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

Function findByOwner

  • findByOwner(owner, options?): Promise<Result<NftMetadata, Error>>

  • Find nft by owner address

    Parameters

    • owner: Pubkey
    • options: Partial<FindOptions> = {}

    Returns Promise<Result<NftMetadata, Error>>

    Promise<Result<CompressedNftMetadata, Error>>

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

Function gasLessDelegate

  • gasLessDelegate(mint, owner, newDelegate): Promise<Result<PartialSignStructure, Error>>

  • Create delegate with gas-less

    -

    Parameters

    • mint: Pubkey
    • owner: Secret
    • newDelegate: Pubkey

    Returns Promise<Result<PartialSignStructure, Error>>

Settings

Member Visibility

Theme

Generated using TypeDoc

Function gasLessTransfer

  • gasLessTransfer(mint, owner, dest, feePayer): Promise<Result<PartialSignStructure, Error>[]>

  • Transfer with gas-less

    -

    Parameters

    • mint: Pubkey
    • owner: Secret
    • dest: Pubkey
    • feePayer: Pubkey

    Returns Promise<Result<PartialSignStructure, Error>[]>

Settings

Member Visibility

Theme

Generated using TypeDoc

Function mintCollection

  • mintCollection(owner, input, options?): Promise<Result<MintStructure, Error>>

  • Parameters

    • owner: Secret
    • input: InputNftMetadata
    • options: Partial<MintCollectionOptions> = {}

    Returns Promise<Result<MintStructure, Error>>

Settings

Member Visibility

Theme

Generated using TypeDoc

Function mintCollection

  • mintCollection(owner, input, options?): Promise<Result<MintStructure, Error>>

  • Parameters

    • owner: Secret
    • input: InputNftMetadata
    • options: Partial<MintCollectionOptions> = {}

    Returns Promise<Result<MintStructure, Error>>

Settings

Member Visibility

Theme

Generated using TypeDoc

Function transfer

  • transfer(mint, owner, dest, ownerOrMultisig): Promise<Result<CommonStructure, Error>>

  • transfer nft

    Parameters

    • mint: Pubkey
    • owner: Pubkey
    • dest: Pubkey
    • ownerOrMultisig: Secret[]

    Returns Promise<Result<CommonStructure, Error>>

    Promise<Result<Transaction, Error>>

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

Function create

  • create(data, owner, options?): Result<CommonStructure, Error>

  • Parameters

    • data: string
    • owner: Secret
    • options: Partial<MemoOptions> = {}

    Returns Result<CommonStructure, Error>

Settings

Member Visibility

Theme

Generated using TypeDoc

Function create

  • create(data, owner, options?): Result<CommonStructure, Error>

  • Parameters

    • data: string
    • owner: Secret
    • options: Partial<MemoOptions> = {}

    Returns Result<CommonStructure, Error>

Settings

Member Visibility

Theme

Generated using TypeDoc

Function decode

  • decode(encoded): string

  • Parameters

    • encoded: string

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc

Function decode

  • decode(encoded): string

  • Parameters

    • encoded: string

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc

Function encode

  • encode(data): Buffer

  • Parameters

    • data: string

    Returns Buffer

Settings

Member Visibility

Theme

Generated using TypeDoc

Function encode

  • encode(data): Buffer

  • Parameters

    • data: string

    Returns Buffer

Settings

Member Visibility

Theme

Generated using TypeDoc

Function findByOwner

  • findByOwner(owner, onOk, onErr, options?): Promise<void>

  • Parameters

    • owner: Pubkey
    • onOk: OnOk<History>
    • onErr: OnErr
    • options: Partial<FindOptions> = {}

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

Function findByOwner

  • findByOwner(owner, onOk, onErr, options?): Promise<void>

  • Parameters

    • owner: Pubkey
    • onOk: OnOk<History>
    • onErr: OnErr
    • options: Partial<FindOptions> = {}

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

Function getInfo

  • getInfo(multisig): Promise<Result<LayoutObject, Error>>

  • Parameters

    • multisig: Pubkey

    Returns Promise<Result<LayoutObject, Error>>

Settings

Member Visibility

Theme

Generated using TypeDoc

Function getInfo

  • getInfo(multisig): Promise<Result<LayoutObject, Error>>

  • Parameters

    • multisig: Pubkey

    Returns Promise<Result<LayoutObject, Error>>

Settings

Member Visibility

Theme

Generated using TypeDoc

Function isAddress

  • isAddress(multisig): Promise<Result<boolean, Error>>

  • Check if it is a multisig address

    Parameters

    • multisig: Pubkey

      // multisig account

    Returns Promise<Result<boolean, Error>>

    Promise<Result<boolean, Error>>

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

Function add

  • add(token, owner, cluster, totalAmount, mintDecimal, phantom): Promise<Result<string, Error>>

  • Adding new token to existing token

    Parameters

    • token: Pubkey
    • owner: Pubkey
    • cluster: string
    • totalAmount: number
    • mintDecimal: number
    • phantom: PhantomProvider

      //phantom wallet object

    Returns Promise<Result<string, Error>>

    Promise<Result<string, Error>>

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

Function mint

  • mint(input, owner, cluster, totalAmount, mintDecimal, phantom): Promise<Result<string, Error>>

  • Mint new spl-token

    Parameters

    • input: InputTokenMetadata
    • owner: Pubkey
    • cluster: string
    • totalAmount: number
    • mintDecimal: number
    • phantom: PhantomProvider

      //phantom wallet object

    Returns Promise<Result<string, Error>>

    Promise<Result<string, Error>>

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

Function mint

  • mint(input, cluster, phantom): Promise<Result<string, Error | ValidatorError>>

  • Upload content and NFT mint

    Parameters

    • input: InputNftMetadata
    • cluster: string
    • phantom: PhantomProvider

      //phantom wallet object

    Returns Promise<Result<string, Error | ValidatorError>>

    Promise<Result<string, Error | ValidatorError>>

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

Function burn

  • burn(mint, owner, ownerOrMultisig, options?): Result<CommonStructure, Error>

  • Burn existing token

    Parameters

    • mint: Pubkey
    • owner: Pubkey
    • ownerOrMultisig: Secret[]
    • options: Partial<BurnOptions> = {}

    Returns Result<CommonStructure, Error>

    Result<CommonStructure, Error>>

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

Function createDeleagate

  • createDeleagate(mint, owner, delegateAuthority): TransactionInstruction

  • Parameters

    • mint: PublicKey
    • owner: PublicKey
    • delegateAuthority: PublicKey

    Returns TransactionInstruction

Settings

Member Visibility

Theme

Generated using TypeDoc

Function createDeleagate

  • createDeleagate(mint, owner, delegateAuthority): TransactionInstruction

  • Parameters

    • mint: PublicKey
    • owner: PublicKey
    • delegateAuthority: PublicKey

    Returns TransactionInstruction

Settings

Member Visibility

Theme

Generated using TypeDoc

Function createMint

  • createMint(mint, owner, nftMetadata, feePayer, isMutable): Promise<TransactionInstruction[]>

  • Parameters

    • mint: PublicKey
    • owner: PublicKey
    • nftMetadata: DataV2
    • feePayer: PublicKey
    • isMutable: boolean

    Returns Promise<TransactionInstruction[]>

Settings

Member Visibility

Theme

Generated using TypeDoc

Function createMint

  • createMint(mint, owner, nftMetadata, feePayer, isMutable): Promise<TransactionInstruction[]>

  • Parameters

    • mint: PublicKey
    • owner: PublicKey
    • nftMetadata: DataV2
    • feePayer: PublicKey
    • isMutable: boolean

    Returns Promise<TransactionInstruction[]>

Settings

Member Visibility

Theme

Generated using TypeDoc

Function createVerifyCreator

  • createVerifyCreator(mint, creator): TransactionInstruction

  • Parameters

    • mint: PublicKey
    • creator: PublicKey

    Returns TransactionInstruction

Settings

Member Visibility

Theme

Generated using TypeDoc

Function createVerifyCreator

  • createVerifyCreator(mint, creator): TransactionInstruction

  • Parameters

    • mint: PublicKey
    • creator: PublicKey

    Returns TransactionInstruction

Settings

Member Visibility

Theme

Generated using TypeDoc

Function createVerifySizedCollection

  • createVerifySizedCollection(collectionChild, collectionParent, feePayer): TransactionInstruction

  • Parameters

    • collectionChild: PublicKey
    • collectionParent: PublicKey
    • feePayer: PublicKey

    Returns TransactionInstruction

Settings

Member Visibility

Theme

Generated using TypeDoc

Function createVerifySizedCollection

  • createVerifySizedCollection(collectionChild, collectionParent, feePayer): TransactionInstruction

  • Parameters

    • collectionChild: PublicKey
    • collectionParent: PublicKey
    • feePayer: PublicKey

    Returns TransactionInstruction

Settings

Member Visibility

Theme

Generated using TypeDoc

Function findByCollection

  • findByCollection(collectionMint, options?): Promise<Result<NftMetadata, Error>>

  • Find nft by collection mint

    Parameters

    • collectionMint: Pubkey
    • options: Partial<FindOptions> = {}

    Returns Promise<Result<NftMetadata, Error>>

    Promise<Result<CompressedNftMetadata, Error>>

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

Function findByMint

  • findByMint(mint): Promise<Result<Partial<Metadata>, Error>>

  • Find nft by mint address

    Parameters

    • mint: Pubkey

    Returns Promise<Result<Partial<Metadata>, Error>>

    Promise<Result<NftMetadata, Error>>

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

Function findByOwner

  • findByOwner(owner, options?): Promise<Result<NftMetadata, Error>>

  • Find nft by owner address

    Parameters

    • owner: Pubkey
    • options: Partial<FindOptions> = {}

    Returns Promise<Result<NftMetadata, Error>>

    Promise<Result<CompressedNftMetadata, Error>>

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

Function gasLessTransfer

  • gasLessTransfer(mint, owner, dest, feePayer): Promise<Result<PartialSignStructure, Error>>

  • Transfer without solana sol, delegate feepayer for commission

    Parameters

    • mint: Pubkey
    • owner: Secret
    • dest: Pubkey
    • feePayer: Pubkey

    Returns Promise<Result<PartialSignStructure, Error>>

    Promise<Result<PartialSignStructure, Error>>

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

Function mintCollection

  • mintCollection(owner, input, options?): Promise<Result<MintStructure, Error>>

  • Parameters

    • owner: Secret
    • input: InputNftMetadata
    • options: Partial<MintCollectionOptions> = {}

    Returns Promise<Result<MintStructure, Error>>

Settings

Member Visibility

Theme

Generated using TypeDoc

Function mintCollection

  • mintCollection(owner, input, options?): Promise<Result<MintStructure, Error>>

  • Parameters

    • owner: Secret
    • input: InputNftMetadata
    • options: Partial<MintCollectionOptions> = {}

    Returns Promise<Result<MintStructure, Error>>

Settings

Member Visibility

Theme

Generated using TypeDoc

Function findByOwner

  • findByOwner(owner): Promise<Result<OwnerInfo, Error>>

  • Find nft by owner address

    Parameters

    • owner: Pubkey

    Returns Promise<Result<OwnerInfo, Error>>

    Promise<Result<OwnerInfo, Error>>

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

Function gasLessTransfer

  • gasLessTransfer(owner, dest, amount, feePayer): Promise<Result<PartialSignStructure, Error>>

  • Transfer without solana sol, delegate feepayer for commission

    Parameters

    • owner: Secret
    • dest: Pubkey
    • amount: number
    • feePayer: Pubkey

    Returns Promise<Result<PartialSignStructure, Error>>

    Promise<Result<PartialSignStructure, Error>>

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

Function add

  • add(token, owner, ownerOrMultisig, totalAmount, mintDecimal, options?): Promise<Result<CommonStructure<Pubkey>, Error>>

  • Adding new token to existing token

    Parameters

    • token: Pubkey
    • owner: Pubkey
    • ownerOrMultisig: Secret[]
    • totalAmount: number
    • mintDecimal: number
    • options: Partial<MintOptions> = {}

    Returns Promise<Result<CommonStructure<Pubkey>, Error>>

    Promise<Result<string, Error>>

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

Function burn

  • burn(mint, owner, ownerOrMultisig, burnAmount, tokenDecimals, options?): Result<CommonStructure, Error>

  • Burn existing token

    Parameters

    • mint: Pubkey
    • owner: Pubkey
    • ownerOrMultisig: Secret[]
    • burnAmount: number
    • tokenDecimals: number
    • options: Partial<BurnOptions> = {}

    Returns Result<CommonStructure, Error>

    Result<CommonStructure, Error>>

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

Function createFreezeAuthority

  • createFreezeAuthority(mint, owner, freezeAuthority): TransactionInstruction

  • Parameters

    • mint: PublicKey
    • owner: PublicKey
    • freezeAuthority: PublicKey

    Returns TransactionInstruction

Settings

Member Visibility

Theme

Generated using TypeDoc

Function createFreezeAuthority

  • createFreezeAuthority(mint, owner, freezeAuthority): TransactionInstruction

  • Parameters

    • mint: PublicKey
    • owner: PublicKey
    • freezeAuthority: PublicKey

    Returns TransactionInstruction

Settings

Member Visibility

Theme

Generated using TypeDoc

Function createMint

  • createMint(mint, owner, totalAmount, mintDecimal, tokenMetadata, feePayer, isMutable): Promise<TransactionInstruction[]>

  • Parameters

    • mint: PublicKey
    • owner: PublicKey
    • totalAmount: number
    • mintDecimal: number
    • tokenMetadata: DataV2
    • feePayer: PublicKey
    • isMutable: boolean

    Returns Promise<TransactionInstruction[]>

Settings

Member Visibility

Theme

Generated using TypeDoc

Function createMint

  • createMint(mint, owner, totalAmount, mintDecimal, tokenMetadata, feePayer, isMutable): Promise<TransactionInstruction[]>

  • Parameters

    • mint: PublicKey
    • owner: PublicKey
    • totalAmount: number
    • mintDecimal: number
    • tokenMetadata: DataV2
    • feePayer: PublicKey
    • isMutable: boolean

    Returns Promise<TransactionInstruction[]>

Settings

Member Visibility

Theme

Generated using TypeDoc

Function findByMint

  • findByMint(mint): Promise<Result<TokenMetadata, Error>>

  • Fetch minted metadata by mint address

    Parameters

    • mint: Pubkey

    Returns Promise<Result<TokenMetadata, Error>>

    Promise<Result<UserSideOutput.TokenMetadata, Error>>

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

Function findByOwner

  • findByOwner(owner): Promise<Result<TokenMetadata[], Error>>

  • Fetch minted metadata by owner Pubkey

    -

    Parameters

    • owner: Pubkey

    Returns Promise<Result<TokenMetadata[], Error>>

Settings

Member Visibility

Theme

Generated using TypeDoc

Function gasLessTransfer

  • gasLessTransfer(mint, owner, dest, amount, mintDecimal, feePayer): Promise<Result<PartialSignStructure, Error>>

  • Transfer without solana sol, delegate feepayer for commission

    Parameters

    • mint: Pubkey
    • owner: Secret
    • dest: Pubkey
    • amount: number
    • mintDecimal: number
    • feePayer: Pubkey

    Returns Promise<Result<PartialSignStructure, Error>>

    Promise<Result<PartialSignStructure, Error>>

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

Namespace Airdrop

Index

Functions

request +

Namespace Airdrop

Index

Functions

request

Settings

Member Visibility

Theme

Generated using TypeDoc

Namespace CompressedNft

Index

Classes

Space +

Namespace CompressedNft

Index

Classes

Space

Functions

calculateSpaceCost createSpace findByCollection diff --git a/docs/modules/_solana_suite_memo.Memo.html b/docs/modules/_solana_suite_memo.Memo.html index 939eb9da7..c4ba6ebd0 100644 --- a/docs/modules/_solana_suite_memo.Memo.html +++ b/docs/modules/_solana_suite_memo.Memo.html @@ -156,7 +156,7 @@ --md-sys-color-surface-container-high: #e9e7ec; --md-sys-color-surface-container-highest: #e4e2e6 } -

Namespace Memo

Index

Functions

create +

Namespace Memo

Index

Functions

create decode encode findByOwner diff --git a/docs/modules/_solana_suite_multisig.Multisig.html b/docs/modules/_solana_suite_multisig.Multisig.html index 0901fbe8f..bf2b1dbde 100644 --- a/docs/modules/_solana_suite_multisig.Multisig.html +++ b/docs/modules/_solana_suite_multisig.Multisig.html @@ -156,7 +156,7 @@ --md-sys-color-surface-container-high: #e9e7ec; --md-sys-color-surface-container-highest: #e4e2e6 } -

Namespace Multisig

Index

Functions

create +

Namespace Multisig

Index

Functions

create getInfo isAddress

Settings

Member Visibility

Theme

Generated using TypeDoc

Namespace PhantomSplToken

Index

Functions

add +

Namespace PhantomSplToken

Index

Functions

add mint

Settings

Member Visibility

Theme

Generated using TypeDoc

Namespace RegularNft

Index

Functions

mint +

Namespace RegularNft

Index

Functions

mint

Settings

Member Visibility

Theme

Generated using TypeDoc

Namespace RegularNft

Index

Functions

burn +

Namespace RegularNft

Index

Functions

burn createDeleagate createMint createVerifyCreator diff --git a/docs/modules/_solana_suite_sol_native.SolNative.html b/docs/modules/_solana_suite_sol_native.SolNative.html index a62185396..fb786371a 100644 --- a/docs/modules/_solana_suite_sol_native.SolNative.html +++ b/docs/modules/_solana_suite_sol_native.SolNative.html @@ -156,7 +156,7 @@ --md-sys-color-surface-container-high: #e9e7ec; --md-sys-color-surface-container-highest: #e4e2e6 } -

Namespace SolNative

Index

Functions

findByOwner +

Namespace SolNative

Index

Functions

findByOwner gasLessTransfer transfer transferWithMultisig diff --git a/docs/modules/_solana_suite_spl_token.SplToken.html b/docs/modules/_solana_suite_spl_token.SplToken.html index 3941a30c7..813133875 100644 --- a/docs/modules/_solana_suite_spl_token.SplToken.html +++ b/docs/modules/_solana_suite_spl_token.SplToken.html @@ -156,7 +156,7 @@ --md-sys-color-surface-container-high: #e9e7ec; --md-sys-color-surface-container-highest: #e4e2e6 } -

Namespace SplToken

Index

Functions

add +

Namespace SplToken

Index

Functions

add burn createFreezeAuthority createMint