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

Class Space

Constructors

constructor +

Class Space

Constructors

constructor

Properties

spaceOwner -

Constructors

constructor

Properties

spaceOwner

spaceOwner: Pubkey

Settings

Member Visibility

Theme

On This Page

constructorspaceOwner

Generated using TypeDoc

Enumeration BundlrUrl

Enumeration Members

dev +

Enumeration BundlrUrl

Enumeration Members

dev prd -

Enumeration Members

dev

dev: "https://devnet.irys.xyz"

prd

prd: "https://node1.irys.xyz,https://node2.irys.xyz"

Settings

Member Visibility

Theme

On This Page

devprd

Generated using TypeDoc

Enumeration Cluster

Enumeration Members

dev +

Enumeration Cluster

Enumeration Members

dev localhost prd prdMetaplex -

Enumeration Members

dev

dev: "devnet"

localhost

localhost: "localhost-devnet"

prd

prd: "mainnet-beta"

prdMetaplex

prdMetaplex: "mainnet-beta-metaplex"

Settings

Member Visibility

Theme

On This Page

devlocalhostprdprdMetaplex

Generated using TypeDoc

Enumeration DasApiUrl

Enumeration Members

dev +

Enumeration DasApiUrl

Enumeration Members

dev prd -

Enumeration Members

dev

dev: "https://devnet.helius-rpc.com/?api-key=15319bf4-5b40-4958-ac8d-6313aa55eb92"

prd

prd: "https://mainnet.helius-rpc.com/?api-key=15319bf4-5b40-4958-ac8d-6313aa55eb92"

Settings

Member Visibility

Theme

On This Page

devprd

Generated using TypeDoc

Enumeration EndPointUrl

Enumeration Members

dev +

Enumeration EndPointUrl

Enumeration Members

dev localhost prd prdMetaplex -

Enumeration Members

dev

dev: "https://api.devnet.solana.com"

localhost

localhost: "http://api.devnet.solana.com"

prd

prd: "https://api.mainnet-beta.solana.com"

prdMetaplex

prdMetaplex: "https://api.metaplex.solana.com"

Settings

Member Visibility

Theme

On This Page

devlocalhostprdprdMetaplex

Generated using TypeDoc

Enumeration NftstorageApiKey

Enumeration Members

dev +

Enumeration NftstorageApiKey

Enumeration Members

dev prd -

Enumeration Members

dev

dev: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJkaWQ6ZXRocjoweERGMjcyN2VkODZhRGU1RTMyZDZDZEJlODc0YzRFNDlEODY1OWZmOEMiLCJpc3MiOiJuZnQtc3RvcmFnZSIsImlhdCI6MTYyMDI2NDk0MzcwNiwibmFtZSI6ImRlbW8ifQ.d4J70mikxRB8a5vwNu6SO5HDA8JaueuseAj7Q_ytMCE"

prd

prd: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJkaWQ6ZXRocjoweERGMjcyN2VkODZhRGU1RTMyZDZDZEJlODc0YzRFNDlEODY1OWZmOEMiLCJpc3MiOiJuZnQtc3RvcmFnZSIsImlhdCI6MTYyMDI2NDk0MzcwNiwibmFtZSI6ImRlbW8ifQ.d4J70mikxRB8a5vwNu6SO5HDA8JaueuseAj7Q_ytMCE"

Settings

Member Visibility

Theme

On This Page

devprd

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 findMintIdBySignature

  • findMintIdBySignature(signature): Promise<Result<Pubkey, Error>>

  • Find cNFT mint id by transaction signature

    Parameters

    • signature: string

    Returns Promise<Result<Pubkey, Error>>

    Promise<Result<Pubkey, Error>>

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

Function gasLessDelegate

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

  • Create delegate with gas-less

    -

    Parameters

    • mint: Pubkey
    • owner: Secret
    • newDelegate: Pubkey
    • options: Partial<GasLessDelegateOptions> = {}

    Returns Promise<Result<PartialSignStructure, Error>>

Settings

Member Visibility

Theme

Generated using TypeDoc

Function gasLessTransfer

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

  • Transfer with gas-less

    -

    Parameters

    • mint: Pubkey
    • owner: Secret
    • dest: Pubkey
    • feePayer: Pubkey
    • options: Partial<GasLessTransferOptions> = {}

    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, options?): Promise<Result<PartialSignStructure, Error>>

  • Transfer without solana sol, delegate feepayer for commission

    Parameters

    • mint: Pubkey
    • owner: Secret
    • dest: Pubkey
    • feePayer: Pubkey
    • options: Partial<GasLessTransferOptions> = {}

    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, options?): Promise<Result<PartialSignStructure, Error>>

  • Transfer without solana sol, delegate feepayer for commission

    Parameters

    • owner: Secret
    • dest: Pubkey
    • amount: number
    • feePayer: Pubkey
    • options: Partial<GasLessTransferOptions> = {}

    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, options?): 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
    • options: Partial<GasLessTransferOptions> = {}

    Returns Promise<Result<PartialSignStructure, Error>>

    Promise<Result<PartialSignStructure, Error>>

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

Function toConvertOffchaindata

  • toConvertOffchaindata(input, sellerFeeBasisPoints): Offchain

  • Parameters

    • input: InputNftMetadata
    • sellerFeeBasisPoints: number

    Returns Offchain

Settings

Member Visibility

Theme

Generated using TypeDoc

Function toConvertOffchaindata

  • toConvertOffchaindata(input, sellerFeeBasisPoints): Offchain

  • Parameters

    • input: InputNftMetadata
    • sellerFeeBasisPoints: number

    Returns Offchain

Settings

Member Visibility

Theme

Generated using TypeDoc

Function upload

  • upload(input, filePath, storageType, options?): Promise<Result<string, Error>>

  • Parameters

    • input: Offchain
    • filePath: FileType
    • storageType: string
    • options: Partial<StorageOptions> = {}

    Returns Promise<Result<string, Error>>

Settings

Member Visibility

Theme

Generated using TypeDoc

Function upload

  • upload(input, filePath, storageType, options?): Promise<Result<string, Error>>

  • Parameters

    • input: Offchain
    • filePath: FileType
    • storageType: string
    • options: Partial<StorageOptions> = {}

    Returns Promise<Result<string, Error>>

Settings

Member Visibility

Theme

Generated using TypeDoc

Function uploadData

  • uploadData(input, storageType, options?): Promise<Result<string, Error>>

  • Parameters

    • input: Offchain
    • storageType: string
    • options: Partial<StorageOptions> = {}

    Returns Promise<Result<string, Error>>

Settings

Member Visibility

Theme

Generated using TypeDoc

Function uploadData

  • uploadData(input, storageType, options?): Promise<Result<string, Error>>

  • Parameters

    • input: Offchain
    • storageType: string
    • options: Partial<StorageOptions> = {}

    Returns Promise<Result<string, Error>>

Settings

Member Visibility

Theme

Generated using TypeDoc

Function uploadFile

  • uploadFile(filePath, storageType, options?): Promise<Result<string, Error>>

  • Parameters

    • filePath: FileType
    • storageType: string
    • options: Partial<StorageOptions> = {}

    Returns Promise<Result<string, Error>>

Settings

Member Visibility

Theme

Generated using TypeDoc

Function uploadFile

  • uploadFile(filePath, storageType, options?): Promise<Result<string, Error>>

  • Parameters

    • filePath: FileType
    • storageType: string
    • options: Partial<StorageOptions> = {}

    Returns Promise<Result<string, Error>>

Settings

Member Visibility

Theme

Generated using TypeDoc

Function loadConfig

Settings

Member Visibility

Theme

Generated using TypeDoc

Function loadConfig

Settings

Member Visibility

Theme

Generated using TypeDoc

Function switchBundlr

Settings

Member Visibility

Theme

Generated using TypeDoc

Function switchBundlr

Settings

Member Visibility

Theme

Generated using TypeDoc

Function switchCluster

  • switchCluster(param): string

  • Parameters

    • param: {
          cluster?: string;
          customClusterUrl?: string[];
      }
      • Optional cluster?: string
      • Optional customClusterUrl?: string[]

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc

Function switchCluster

  • switchCluster(param): string

  • Parameters

    • param: {
          cluster?: string;
          customClusterUrl?: string[];
      }
      • Optional cluster?: string
      • Optional customClusterUrl?: string[]

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc

Function switchDasApi

Settings

Member Visibility

Theme

Generated using TypeDoc

Function switchDasApi

Settings

Member Visibility

Theme

Generated using TypeDoc

Function switchNftStorage

Settings

Member Visibility

Theme

Generated using TypeDoc

Function switchNftStorage

Settings

Member Visibility

Theme

Generated using TypeDoc

Function all

Settings

Member Visibility

Theme

Generated using TypeDoc

Function all

Settings

Member Visibility

Theme

Generated using TypeDoc

Function err

Settings

Member Visibility

Theme

Generated using TypeDoc

Function err

Settings

Member Visibility

Theme

Generated using TypeDoc

Function ok

Settings

Member Visibility

Theme

Generated using TypeDoc

Function ok

Settings

Member Visibility

Theme

Generated using TypeDoc

Function Try

Settings

Member Visibility

Theme

Generated using TypeDoc

Function bufferToArray

  • bufferToArray(buffer): number[]

  • convert buffer to Array

    Parameters

    • buffer: Buffer

    Returns number[]

    number[]

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

Function convertTimestampToDateTime

  • convertTimestampToDateTime(created_at): undefined | Date

  • argument is promise or other

    Parameters

    • created_at: undefined | number

    Returns undefined | Date

    Date | undefined

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

Function debugLog

  • debugLog(data1, data2?, data3?, data4?): void

  • Display log for solana-suite-config.js

    Parameters

    • data1: unknown
    • data2: unknown = ''
    • data3: unknown = ''
    • data4: unknown = ''

    Returns void

    void

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

Function isBrowser

Settings

Member Visibility

Theme

Generated using TypeDoc

Function isNode

Settings

Member Visibility

Theme

Generated using TypeDoc

Function isPromise

  • isPromise(obj): obj is Promise<unknown>

  • argument is promise or other

    Parameters

    • obj: unknown

    Returns obj is Promise<unknown>

    boolean

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

Function overwriteObject

  • overwriteObject(object, targets): unknown

  • Overwrite JS Object

    Parameters

    • object: unknown
    • targets: {
          existsKey: string;
          will: {
              key: string;
              value: unknown;
          };
      }[]

    Returns unknown

    Object

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

Function sleep

Settings

Member Visibility

Theme

Generated using TypeDoc

Function unixTimestamp

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 2fcba76f1..f0bcd603d 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 175bef563..46876a32b 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 36bd7f63d..0aa2d7073 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 7dab61115..1ca4e6821 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 diff --git a/docs/modules/_solana_suite_storage.Storage.html b/docs/modules/_solana_suite_storage.Storage.html index 207d02eba..db6f7c573 100644 --- a/docs/modules/_solana_suite_storage.Storage.html +++ b/docs/modules/_solana_suite_storage.Storage.html @@ -156,7 +156,7 @@ --md-sys-color-surface-container-high: #e9e7ec; --md-sys-color-surface-container-highest: #e4e2e6 } -

Namespace Storage

Index

Functions

toConvertOffchaindata +

Namespace Storage

Index

Functions

toConvertOffchaindata upload uploadData uploadFile diff --git a/docs/modules/_solana_suite_utils.Constants.WarnningMessage.html b/docs/modules/_solana_suite_utils.Constants.WarnningMessage.html index 9258143d2..a50bb46f4 100644 --- a/docs/modules/_solana_suite_utils.Constants.WarnningMessage.html +++ b/docs/modules/_solana_suite_utils.Constants.WarnningMessage.html @@ -156,7 +156,7 @@ --md-sys-color-surface-container-high: #e9e7ec; --md-sys-color-surface-container-highest: #e4e2e6 } -

Namespace WarnningMessage

Index

Variables

DAS_API_URL +

Namespace WarnningMessage

Index

Variables

DAS_API_URL NFT_STORAGE_API_KEY

Settings

Member Visibility

Theme

Generated using TypeDoc

Namespace Constants

Index

Namespaces

WarnningMessage +

Namespace Constants

Index

Namespaces

WarnningMessage

Enumerations

BundlrUrl Cluster DasApiUrl diff --git a/docs/modules/_solana_suite_utils.Result.html b/docs/modules/_solana_suite_utils.Result.html index a60003bfd..ec441c6df 100644 --- a/docs/modules/_solana_suite_utils.Result.html +++ b/docs/modules/_solana_suite_utils.Result.html @@ -156,7 +156,7 @@ --md-sys-color-surface-container-high: #e9e7ec; --md-sys-color-surface-container-highest: #e4e2e6 } -

Namespace Result

Index

Type Aliases

Err +

Namespace Result

Index

Type Aliases

Err Ok

Functions

all err diff --git a/docs/types/_solana_suite_utils.Result-1.html b/docs/types/_solana_suite_utils.Result-1.html index 8d7a14a30..a56be61cf 100644 --- a/docs/types/_solana_suite_utils.Result-1.html +++ b/docs/types/_solana_suite_utils.Result-1.html @@ -156,7 +156,7 @@ --md-sys-color-surface-container-high: #e9e7ec; --md-sys-color-surface-container-highest: #e4e2e6 } -

Type alias Result<T, E>

Result<T, E>: Ok<T, E> | Err<T, E>

Type Parameters

  • T
  • E extends Error = Error

Settings

Member Visibility

Theme

Generated using TypeDoc

Type alias Result<T, E>

Result<T, E>: Ok<T, E> | Err<T, E>

Type Parameters

  • T
  • E extends Error = Error

Settings

Member Visibility

Theme

Generated using TypeDoc

Type alias Err<T, E>

Err<T, E>: InternalErr<T, E>

Type Parameters

  • T
  • E extends Error

Settings

Member Visibility

Theme

Generated using TypeDoc

Type alias Err<T, E>

Err<T, E>: InternalErr<T, E>

Type Parameters

  • T
  • E extends Error

Settings

Member Visibility

Theme

Generated using TypeDoc

Type alias Ok<T, E>

Ok<T, E>: InternalOk<T, E>

Type Parameters

  • T
  • E extends Error

Settings

Member Visibility

Theme

Generated using TypeDoc

Type alias Ok<T, E>

Ok<T, E>: InternalOk<T, E>

Type Parameters

  • T
  • E extends Error

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable Config

Config: {
    cluster: {
        customClusterUrl: never[];
        type: string;
    };
    dasApiUrl: never[];
    debugging: string;
    nftStorageApiKey: string;
} = SolanaJsonConfig

Type declaration

  • cluster: {
        customClusterUrl: never[];
        type: string;
    }
    • customClusterUrl: never[]
    • type: string
  • dasApiUrl: never[]
  • debugging: string
  • nftStorageApiKey: string

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable Config

Config: {
    cluster: {
        customClusterUrl: never[];
        type: string;
    };
    dasApiUrl: never[];
    debugging: string;
    nftStorageApiKey: string;
} = SolanaJsonConfig

Type declaration

  • cluster: {
        customClusterUrl: never[];
        type: string;
    }
    • customClusterUrl: never[]
    • type: string
  • dasApiUrl: never[]
  • debugging: string
  • nftStorageApiKey: string

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable BUNDLR_NETWORK_URLConst

BUNDLR_NETWORK_URL: string = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable BUNDLR_NETWORK_URLConst

BUNDLR_NETWORK_URL: string = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable COMMITMENTConst

COMMITMENT: Finality = 'confirmed'

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable COMMITMENTConst

COMMITMENT: Finality = 'confirmed'

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable DAS_API_URLConst

DAS_API_URL: string = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable DAS_API_URLConst

DAS_API_URL: string = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable EXPLORER_SOLANAFM_URLConst

EXPLORER_SOLANAFM_URL: "https://solana.fm" = 'https://solana.fm'

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable EXPLORER_SOLANAFM_URLConst

EXPLORER_SOLANAFM_URL: "https://solana.fm" = 'https://solana.fm'

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable EXPLORER_SOLSCAN_URLConst

EXPLORER_SOLSCAN_URL: "https://solscan.io" = 'https://solscan.io'

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable EXPLORER_SOLSCAN_URLConst

EXPLORER_SOLSCAN_URL: "https://solscan.io" = 'https://solscan.io'

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable EXPLORER_XRAY_URLConst

EXPLORER_XRAY_URL: "https://xray.helius.xyz" = 'https://xray.helius.xyz'

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable EXPLORER_XRAY_URLConst

EXPLORER_XRAY_URL: "https://xray.helius.xyz" = 'https://xray.helius.xyz'

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable IRYS_GATEWAY_URLConst

IRYS_GATEWAY_URL: "https://gateway.irys.xyz" = 'https://gateway.irys.xyz'

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable IRYS_GATEWAY_URLConst

IRYS_GATEWAY_URL: "https://gateway.irys.xyz" = 'https://gateway.irys.xyz'

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable MAX_TRANSACTION_RETRIESConst

MAX_TRANSACTION_RETRIES: 1 = 1

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable MAX_TRANSACTION_RETRIESConst

MAX_TRANSACTION_RETRIES: 1 = 1

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable MAX_TRANSACTION_VERSIONConst

MAX_TRANSACTION_VERSION: number = 0

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable MAX_TRANSACTION_VERSIONConst

MAX_TRANSACTION_VERSION: number = 0

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable MEMO_PROGRAM_IDConst

MEMO_PROGRAM_ID: PublicKey = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable MEMO_PROGRAM_IDConst

MEMO_PROGRAM_ID: PublicKey = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable METAPLEX_PROGRAM_IDConst

METAPLEX_PROGRAM_ID: PublicKey = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable METAPLEX_PROGRAM_IDConst

METAPLEX_PROGRAM_ID: PublicKey = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable NFT_STORAGE_API_KEYConst

NFT_STORAGE_API_KEY: string = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable NFT_STORAGE_API_KEYConst

NFT_STORAGE_API_KEY: string = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable NFT_STORAGE_GATEWAY_URLConst

NFT_STORAGE_GATEWAY_URL: "https://ipfs.io/ipfs" = 'https://ipfs.io/ipfs'

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable NFT_STORAGE_GATEWAY_URLConst

NFT_STORAGE_GATEWAY_URL: "https://ipfs.io/ipfs" = 'https://ipfs.io/ipfs'

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable WRAPPED_TOKEN_PROGRAM_IDConst

WRAPPED_TOKEN_PROGRAM_ID: PublicKey = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable WRAPPED_TOKEN_PROGRAM_IDConst

WRAPPED_TOKEN_PROGRAM_ID: PublicKey = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable DAS_API_URLConst

DAS_API_URL: "\n [YOU HAVE TO DO]\n --------------------------------------\n You need to update dasApiUrl define parameter in solana-suite.json.\n can get api url from https://www.helius.dev/\n -------------------------------------- \n " = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable DAS_API_URLConst

DAS_API_URL: "\n [YOU HAVE TO DO]\n --------------------------------------\n You need to update dasApiUrl define parameter in solana-suite.json.\n can get api url from https://www.helius.dev/\n -------------------------------------- \n " = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable NFT_STORAGE_API_KEYConst

NFT_STORAGE_API_KEY: "\n [YOU HAVE TO DO]\n --------------------------------------\n You need to update nftStorageApiKey define parameter in solana-suite.json.\n Can get api key from https://nft.storage/\n --------------------------------------\n " = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable NFT_STORAGE_API_KEYConst

NFT_STORAGE_API_KEY: "\n [YOU HAVE TO DO]\n --------------------------------------\n You need to update nftStorageApiKey define parameter in solana-suite.json.\n Can get api key from https://nft.storage/\n --------------------------------------\n " = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable currentClusterConst

currentCluster: string = Config.cluster.type

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable currentClusterConst

currentCluster: string = Config.cluster.type

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable customClusterUrlConst

customClusterUrl: never[] = Config.cluster.customClusterUrl

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable customClusterUrlConst

customClusterUrl: never[] = Config.cluster.customClusterUrl

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable customDasApiUrlConst

customDasApiUrl: never[] = Config.dasApiUrl

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable customDasApiUrlConst

customDasApiUrl: never[] = Config.dasApiUrl

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable customNftStorageApiKeyConst

customNftStorageApiKey: string = Config.nftStorageApiKey

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable customNftStorageApiKeyConst

customNftStorageApiKey: string = Config.nftStorageApiKey

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable isDebuggingConst

isDebugging: string = Config.debugging

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable isDebuggingConst

isDebugging: string = Config.debugging

Settings

Member Visibility

Theme

Generated using TypeDoc