From a3c13eddf87cdf2a81bf3f250f454d051a2ddcb2 Mon Sep 17 00:00:00 2001 From: fukaoi Date: Mon, 8 Jul 2024 15:03:24 +0900 Subject: [PATCH] Did documents --- .../_solana_suite_compressed_nft.CompressedNft.Space.html | 4 ++-- docs/enums/_solana_suite_phantom.UseMethod.html | 4 ++-- docs/enums/_solana_suite_utils.Constants.BundlrUrl.html | 4 ++-- docs/enums/_solana_suite_utils.Constants.Cluster.html | 4 ++-- docs/enums/_solana_suite_utils.Constants.DasApiUrl.html | 4 ++-- docs/enums/_solana_suite_utils.Constants.EndPointUrl.html | 4 ++-- docs/functions/_solana_suite_airdrop.Airdrop.request.html | 2 +- ...suite_compressed_nft.CompressedNft.calculateSpaceCost.html | 2 +- ...solana_suite_compressed_nft.CompressedNft.createSpace.html | 2 +- ...a_suite_compressed_nft.CompressedNft.findByCollection.html | 2 +- ..._solana_suite_compressed_nft.CompressedNft.findByMint.html | 2 +- ...solana_suite_compressed_nft.CompressedNft.findByOwner.html | 2 +- ...te_compressed_nft.CompressedNft.findMintIdBySignature.html | 2 +- ...na_suite_compressed_nft.CompressedNft.gasLessDelegate.html | 2 +- ...na_suite_compressed_nft.CompressedNft.gasLessTransfer.html | 2 +- .../_solana_suite_compressed_nft.CompressedNft.mint.html | 2 +- ...ana_suite_compressed_nft.CompressedNft.mintCollection.html | 2 +- ...solana_suite_compressed_nft.CompressedNft.setDelegate.html | 2 +- .../_solana_suite_compressed_nft.CompressedNft.transfer.html | 2 +- docs/functions/_solana_suite_multisig.Multisig.create.html | 2 +- docs/functions/_solana_suite_multisig.Multisig.getInfo.html | 2 +- docs/functions/_solana_suite_multisig.Multisig.isAddress.html | 2 +- .../_solana_suite_phantom.PhantomRegularNft.mint.html | 2 +- docs/functions/_solana_suite_phantom.PhantomSplToken.add.html | 2 +- .../functions/_solana_suite_phantom.PhantomSplToken.mint.html | 2 +- docs/functions/_solana_suite_regular_nft.RegularNft.burn.html | 2 +- .../_solana_suite_regular_nft.RegularNft.createDeleagate.html | 2 +- .../_solana_suite_regular_nft.RegularNft.createMint.html | 2 +- ...lana_suite_regular_nft.RegularNft.createVerifyCreator.html | 2 +- ...te_regular_nft.RegularNft.createVerifySizedCollection.html | 2 +- ..._solana_suite_regular_nft.RegularNft.findByCollection.html | 2 +- .../_solana_suite_regular_nft.RegularNft.findByMint.html | 2 +- .../_solana_suite_regular_nft.RegularNft.findByOwner.html | 2 +- .../_solana_suite_regular_nft.RegularNft.freeze.html | 2 +- .../_solana_suite_regular_nft.RegularNft.gasLessMint.html | 2 +- .../_solana_suite_regular_nft.RegularNft.gasLessTransfer.html | 2 +- docs/functions/_solana_suite_regular_nft.RegularNft.mint.html | 2 +- .../_solana_suite_regular_nft.RegularNft.mintCollection.html | 2 +- docs/functions/_solana_suite_regular_nft.RegularNft.thaw.html | 2 +- .../_solana_suite_regular_nft.RegularNft.transfer.html | 2 +- .../_solana_suite_sol_native.SolNative.findByOwner.html | 2 +- .../_solana_suite_sol_native.SolNative.gasLessTransfer.html | 2 +- .../_solana_suite_sol_native.SolNative.transfer.html | 2 +- ...olana_suite_sol_native.SolNative.transferWithMultisig.html | 2 +- docs/functions/_solana_suite_spl_token.SplToken.add.html | 2 +- docs/functions/_solana_suite_spl_token.SplToken.burn.html | 2 +- ...solana_suite_spl_token.SplToken.createFreezeAuthority.html | 2 +- .../_solana_suite_spl_token.SplToken.createMint.html | 2 +- .../_solana_suite_spl_token.SplToken.findByMint.html | 2 +- .../_solana_suite_spl_token.SplToken.findByOwner.html | 2 +- docs/functions/_solana_suite_spl_token.SplToken.freeze.html | 2 +- .../_solana_suite_spl_token.SplToken.gasLessTransfer.html | 2 +- docs/functions/_solana_suite_spl_token.SplToken.mint.html | 2 +- docs/functions/_solana_suite_spl_token.SplToken.thaw.html | 2 +- docs/functions/_solana_suite_spl_token.SplToken.transfer.html | 2 +- .../_solana_suite_storage.Storage.toConvertOffchaindata.html | 2 +- docs/functions/_solana_suite_storage.Storage.upload.html | 2 +- docs/functions/_solana_suite_storage.Storage.uploadData.html | 2 +- docs/functions/_solana_suite_storage.Storage.uploadFile.html | 2 +- docs/functions/_solana_suite_utils.Constants.loadConfig.html | 2 +- .../functions/_solana_suite_utils.Constants.switchBundlr.html | 2 +- .../_solana_suite_utils.Constants.switchCluster.html | 2 +- .../functions/_solana_suite_utils.Constants.switchDasApi.html | 2 +- ...solana_suite_utils.Constants.switchFilebaseCredential.html | 2 +- docs/functions/_solana_suite_utils.Result.all.html | 2 +- docs/functions/_solana_suite_utils.Result.err-1.html | 2 +- docs/functions/_solana_suite_utils.Result.ok-1.html | 2 +- docs/functions/_solana_suite_utils.Try.html | 2 +- docs/functions/_solana_suite_utils.bufferToArray.html | 2 +- .../_solana_suite_utils.convertTimestampToDateTime.html | 2 +- docs/functions/_solana_suite_utils.debugLog.html | 2 +- docs/functions/_solana_suite_utils.isBrowser.html | 2 +- docs/functions/_solana_suite_utils.isNode.html | 2 +- docs/functions/_solana_suite_utils.isPromise.html | 2 +- docs/functions/_solana_suite_utils.overwriteObject.html | 2 +- docs/functions/_solana_suite_utils.sleep.html | 2 +- docs/functions/_solana_suite_utils.unixTimestamp.html | 2 +- docs/modules/_solana_suite_airdrop.Airdrop.html | 2 +- docs/modules/_solana_suite_compressed_nft.CompressedNft.html | 2 +- docs/modules/_solana_suite_multisig.Multisig.html | 2 +- docs/modules/_solana_suite_phantom.PhantomRegularNft.html | 2 +- docs/modules/_solana_suite_phantom.PhantomSplToken.html | 2 +- docs/modules/_solana_suite_regular_nft.RegularNft.html | 2 +- docs/modules/_solana_suite_sol_native.SolNative.html | 2 +- docs/modules/_solana_suite_spl_token.SplToken.html | 2 +- docs/modules/_solana_suite_storage.Storage.html | 2 +- .../_solana_suite_utils.Constants.WarnningMessage.html | 2 +- docs/modules/_solana_suite_utils.Constants.html | 2 +- docs/modules/_solana_suite_utils.Result.html | 2 +- docs/types/_solana_suite_phantom.BurnOptions.html | 2 +- docs/types/_solana_suite_phantom.Collection.html | 2 +- docs/types/_solana_suite_phantom.Creators.html | 2 +- docs/types/_solana_suite_phantom.FreezeOptions.html | 2 +- docs/types/_solana_suite_phantom.InitializeMint.html | 2 +- docs/types/_solana_suite_phantom.InputCollection.html | 2 +- docs/types/_solana_suite_phantom.InputCreators.html | 2 +- docs/types/_solana_suite_phantom.InputNftMetadata.html | 2 +- docs/types/_solana_suite_phantom.MintCollectionOptions.html | 2 +- docs/types/_solana_suite_phantom.MintOptions.html | 2 +- docs/types/_solana_suite_phantom.Option.html | 2 +- docs/types/_solana_suite_phantom.Options.html | 2 +- docs/types/_solana_suite_phantom.PhantomProvider.html | 2 +- docs/types/_solana_suite_phantom.ThawOptions.html | 2 +- docs/types/_solana_suite_phantom.TransferOptions.html | 2 +- docs/types/_solana_suite_phantom.Uses.html | 2 +- docs/types/_solana_suite_phantom.bignum.html | 2 +- docs/types/_solana_suite_phantom.connectOption.html | 2 +- docs/types/_solana_suite_utils.Result-1.html | 2 +- docs/types/_solana_suite_utils.Result.Err.html | 2 +- docs/types/_solana_suite_utils.Result.Ok.html | 2 +- docs/variables/_solana_suite_utils.Config.html | 2 +- .../_solana_suite_utils.Constants.BUNDLR_NETWORK_URL.html | 2 +- docs/variables/_solana_suite_utils.Constants.COMMITMENT.html | 2 +- docs/variables/_solana_suite_utils.Constants.DAS_API_URL.html | 2 +- .../_solana_suite_utils.Constants.EXPLORER_SOLANAFM_URL.html | 2 +- .../_solana_suite_utils.Constants.EXPLORER_SOLSCAN_URL.html | 2 +- .../_solana_suite_utils.Constants.EXPLORER_XRAY_URL.html | 2 +- .../_solana_suite_utils.Constants.FILEBADE_GATEWAY_URL.html | 2 +- .../_solana_suite_utils.Constants.FILEBASE_ACCESS_KEYS.html | 2 +- .../_solana_suite_utils.Constants.FilebaseCredential.html | 2 +- .../_solana_suite_utils.Constants.IRYS_GATEWAY_URL.html | 2 +- ..._solana_suite_utils.Constants.MAX_TRANSACTION_RETRIES.html | 2 +- ..._solana_suite_utils.Constants.MAX_TRANSACTION_VERSION.html | 2 +- .../_solana_suite_utils.Constants.MEMO_PROGRAM_ID.html | 2 +- .../_solana_suite_utils.Constants.METAPLEX_PROGRAM_ID.html | 2 +- ...solana_suite_utils.Constants.WRAPPED_TOKEN_PROGRAM_ID.html | 2 +- ...ana_suite_utils.Constants.WarnningMessage.DAS_API_URL.html | 2 +- ...e_utils.Constants.WarnningMessage.FILEBASE_CREDENTIAL.html | 2 +- .../_solana_suite_utils.Constants.currentCluster.html | 2 +- .../_solana_suite_utils.Constants.customClusterUrl.html | 2 +- .../_solana_suite_utils.Constants.customDasApiUrl.html | 2 +- docs/variables/_solana_suite_utils.Constants.isDebugging.html | 2 +- 132 files changed, 138 insertions(+), 138 deletions(-) diff --git a/docs/classes/_solana_suite_compressed_nft.CompressedNft.Space.html b/docs/classes/_solana_suite_compressed_nft.CompressedNft.Space.html index 43e68b01..135c8fbe 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 } -

Constructors

constructor +

Constructors

Properties

Constructors

Properties

spaceOwner: Pubkey

Enumeration Members

Burn +

Enumeration Members

Enumeration Members

Burn: 0
Multiple: 1
Single: 2

Enumeration Members

dev +

Enumeration Members

Enumeration Members

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

Enumeration Members

dev +

Enumeration Members

Enumeration Members

dev: "devnet"
localhost: "localhost-devnet"
prd: "mainnet-beta"
prdMetaplex: "mainnet-beta-metaplex"

Enumeration Members

dev +

Enumeration Members

Enumeration Members

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

Enumeration Members

dev +

Enumeration Members

Enumeration Members

dev: "https://api.devnet.solana.com"
localhost: "http://api.devnet.solana.com"
prd: "https://api.mainnet-beta.solana.com"
prdMetaplex: "https://api.metaplex.solana.com"
  • Reuqest airdrop SOL only devnet, testnet

    Parameters

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

    Returns Promise<Result<string, Error>>

    Promise<Result<string, Error>>

    -
  • Calculate space cost

    Parameters

    • spaceSize: number

    Returns Promise<{
        sol: number;
    }>

    Promise<{sol: number}>

    -
  • 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>>

    -
  • Find nft by collection mint

    Parameters

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

    Returns Promise<Result<NftMetadata, Error>>

    Promise<Result<CompressedNftMetadata, Error>>

    -
  • Find nft by mint address

    Parameters

    • mint: Pubkey

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

    Promise<Result<NftMetadata, Error>>

    -
  • Find nft by owner address

    Parameters

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

    Returns Promise<Result<NftMetadata, Error>>

    Promise<Result<CompressedNftMetadata, Error>>

    -
  • Find cNFT mint id by transaction signature

    Parameters

    • signature: string

    Returns Promise<Result<Pubkey, Error>>

    Promise<Result<Pubkey, Error>>

    -
  • Create delegate with gas-less

    -

    Parameters

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

    Returns 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>>

  • transfer nft

    Parameters

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

    Returns Promise<Result<CommonStructure, Error>>

    Promise<Result<Transaction, Error>>

    -
  • Parameters

    • multisig: Pubkey

    Returns Promise<Result<LayoutObject, Error>>

  • Parameters

    • multisig: Pubkey

    Returns Promise<Result<LayoutObject, Error>>

  • Check if it is a multisig address

    Parameters

    • multisig: Pubkey

      // multisig account

    Returns Promise<Result<boolean, Error>>

    Promise<Result<boolean, 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>>

    -
  • 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>>

    -
  • Burn existing token

    Parameters

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

    Returns Result<CommonStructure, Error>

    Result<CommonStructure, Error>>

    -
  • Parameters

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

    Returns TransactionInstruction

  • Parameters

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

    Returns TransactionInstruction

  • Parameters

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

    Returns Promise<TransactionInstruction[]>

  • Parameters

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

    Returns Promise<TransactionInstruction[]>

  • Parameters

    • mint: PublicKey
    • creator: PublicKey

    Returns TransactionInstruction

  • Parameters

    • mint: PublicKey
    • creator: PublicKey

    Returns TransactionInstruction

  • Parameters

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

    Returns TransactionInstruction

  • Parameters

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

    Returns TransactionInstruction

  • Find nft by collection mint

    Parameters

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

    Returns Promise<Result<NftMetadata, Error>>

    Promise<Result<CompressedNftMetadata, Error>>

    -
  • Find nft by mint address

    Parameters

    • mint: Pubkey

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

    Promise<Result<NftMetadata, Error>>

    -
  • Find nft by owner address

    Parameters

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

    Returns Promise<Result<NftMetadata, Error>>

    Promise<Result<CompressedNftMetadata, 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>>

    -
  • Find nft by owner address

    Parameters

    • owner: Pubkey

    Returns Promise<Result<OwnerInfo, Error>>

    Promise<Result<OwnerInfo, 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>>

    -
  • 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>>

    -
  • Burn existing token

    Parameters

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

    Returns Result<CommonStructure, Error>

    Result<CommonStructure, Error>>

    -
  • Parameters

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

    Returns TransactionInstruction

  • Parameters

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

    Returns TransactionInstruction

  • Parameters

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

    Returns Promise<TransactionInstruction[]>

  • Parameters

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

    Returns Promise<TransactionInstruction[]>

  • Fetch minted metadata by mint address

    Parameters

    • mint: Pubkey

    Returns Promise<Result<TokenMetadata, Error>>

    Promise<Result<UserSideOutput.TokenMetadata, Error>>

    -
  • Fetch minted metadata by owner Pubkey

    -

    Parameters

    • owner: Pubkey

    Returns Promise<Result<TokenMetadata[], 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>>

    -
  • Parameters

    Returns Offchain

  • Parameters

    Returns Offchain

  • Parameters

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

    Returns Promise<Result<string, Error>>

  • Parameters

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

    Returns Promise<Result<string, Error>>

  • Parameters

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

    Returns Promise<Result<string, Error>>

  • Parameters

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

    Returns Promise<Result<string, Error>>

  • Parameters

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

    Returns Promise<Result<string, Error>>

  • Parameters

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

    Returns Promise<Result<string, Error>>

  • Parameters

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

    Returns string

  • Parameters

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

    Returns string

  • Parameters

    • env: string

    Returns {
        key: string;
        secret: string;
    }

    • key: string
    • secret: string
  • Parameters

    • env: string

    Returns {
        key: string;
        secret: string;
    }

    • key: string
    • secret: string
  • convert buffer to Array

    Parameters

    • buffer: Buffer

    Returns number[]

    number[]

    -
  • argument is promise or other

    Parameters

    • created_at: undefined | number

    Returns undefined | Date

    Date | undefined

    -
  • Display log for solana-suite-config.js

    Parameters

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

    Returns void

    void

    -
  • argument is promise or other

    Parameters

    • obj: unknown

    Returns obj is Promise<unknown>

    boolean

    -
  • Overwrite JS Object

    Parameters

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

    Returns unknown

    Object

    -

Index

Functions

request +

Index

Classes

Space +

Index

Classes

Functions

calculateSpaceCost createSpace findByCollection diff --git a/docs/modules/_solana_suite_multisig.Multisig.html b/docs/modules/_solana_suite_multisig.Multisig.html index 61b0782f..3870cf99 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 } -

Index

Functions

create +

Index

Functions

mint +

Index

Functions

add +

Index

Functions

burn +

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 920fc943..8217776a 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 } -

Index

Functions

findByOwner +

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 554d05b8..f83f2296 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 } -

Index

Functions

add +

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 47854a2b..75fd5eae 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 } -

Index

Functions

toConvertOffchaindata +

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 71490b79..07d21702 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 } -

Index

Variables

DAS_API_URL +

Index

Namespaces

WarnningMessage +

Index

Namespaces

Enumerations

BundlrUrl Cluster DasApiUrl diff --git a/docs/modules/_solana_suite_utils.Result.html b/docs/modules/_solana_suite_utils.Result.html index 70bebfa5..b699c6f2 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 } -

Index

Type Aliases

Err +

Index

Type Aliases

Functions

all err diff --git a/docs/types/_solana_suite_phantom.BurnOptions.html b/docs/types/_solana_suite_phantom.BurnOptions.html index 62728667..bb84e06c 100644 --- a/docs/types/_solana_suite_phantom.BurnOptions.html +++ b/docs/types/_solana_suite_phantom.BurnOptions.html @@ -156,7 +156,7 @@ --md-sys-color-surface-container-high: #e9e7ec; --md-sys-color-surface-container-highest: #e4e2e6 } -
BurnOptions: {
    feePayer: Secret;
}

Type declaration

  • feePayer: Secret
BurnOptions: {
    feePayer: Secret;
}

Type declaration

  • feePayer: Secret
Collection: {
    address: Pubkey;
    verified: boolean;
}

Type declaration

  • address: Pubkey
  • verified: boolean
Collection: {
    address: Pubkey;
    verified: boolean;
}

Type declaration

  • address: Pubkey
  • verified: boolean
Creators: {
    address: Pubkey;
    share: number;
    verified: boolean;
}

Type declaration

  • address: Pubkey
  • share: number
  • verified: boolean
Creators: {
    address: Pubkey;
    share: number;
    verified: boolean;
}

Type declaration

  • address: Pubkey
  • share: number
  • verified: boolean
FreezeOptions: {
    feePayer: Secret;
}

Type declaration

  • feePayer: Secret
FreezeOptions: {
    feePayer: Secret;
}

Type declaration

  • feePayer: Secret
InitializeMint: {
    mint: Keypair;
    tx: Transaction;
}

Type declaration

  • mint: Keypair
  • tx: Transaction
InitializeMint: {
    mint: Keypair;
    tx: Transaction;
}

Type declaration

  • mint: Keypair
  • tx: Transaction
InputCreators: {
    address: Pubkey;
    secret: Secret;
    share: number;
}

Type declaration

  • address: Pubkey
  • secret: Secret
  • share: number
InputCreators: {
    address: Pubkey;
    secret: Secret;
    share: number;
}

Type declaration

  • address: Pubkey
  • secret: Secret
  • share: number
InputNftMetadata: {
    animation_url?: string;
    attributes?: Attribute[];
    collection?: InputCollection;
    creators?: InputCreators[];
    description?: string;
    external_url?: string;
    filePath?: FileType;
    isMutable?: boolean;
    maxSupply?: bignum;
    name: string;
    options?: Options;
    properties?: Properties;
    royalty?: number;
    storageType?: StorageType;
    symbol: string;
    uri?: string;
    uses?: Uses;
}

Type declaration

  • Optional animation_url?: string
  • Optional attributes?: Attribute[]
  • Optional collection?: InputCollection
  • Optional creators?: InputCreators[]
  • Optional description?: string
  • Optional external_url?: string
  • Optional filePath?: FileType
  • Optional isMutable?: boolean
  • Optional maxSupply?: bignum
  • name: string
  • Optional options?: Options
  • Optional properties?: Properties
  • Optional royalty?: number
  • Optional storageType?: StorageType
  • symbol: string
  • Optional uri?: string
  • Optional uses?: Uses
InputNftMetadata: {
    animation_url?: string;
    attributes?: Attribute[];
    collection?: InputCollection;
    creators?: InputCreators[];
    description?: string;
    external_url?: string;
    filePath?: FileType;
    isMutable?: boolean;
    maxSupply?: bignum;
    name: string;
    options?: Options;
    properties?: Properties;
    royalty?: number;
    storageType?: StorageType;
    symbol: string;
    uri?: string;
    uses?: Uses;
}

Type declaration

  • Optional animation_url?: string
  • Optional attributes?: Attribute[]
  • Optional collection?: InputCollection
  • Optional creators?: InputCreators[]
  • Optional description?: string
  • Optional external_url?: string
  • Optional filePath?: FileType
  • Optional isMutable?: boolean
  • Optional maxSupply?: bignum
  • name: string
  • Optional options?: Options
  • Optional properties?: Properties
  • Optional royalty?: number
  • Optional storageType?: StorageType
  • symbol: string
  • Optional uri?: string
  • Optional uses?: Uses
MintCollectionOptions: {
    collectionSize: number;
    feePayer: Secret;
    freezeAuthority: Pubkey;
}

Type declaration

  • collectionSize: number
  • feePayer: Secret
  • freezeAuthority: Pubkey
MintCollectionOptions: {
    collectionSize: number;
    feePayer: Secret;
    freezeAuthority: Pubkey;
}

Type declaration

  • collectionSize: number
  • feePayer: Secret
  • freezeAuthority: Pubkey
MintOptions: {
    feePayer: Secret;
    freezeAuthority: Pubkey;
}

Type declaration

  • feePayer: Secret
  • freezeAuthority: Pubkey
MintOptions: {
    feePayer: Secret;
    freezeAuthority: Pubkey;
}

Type declaration

  • feePayer: Secret
  • freezeAuthority: Pubkey
Option<T>: T | null

Type Parameters

  • T
Option<T>: T | null

Type Parameters

  • T
Options: {
    [key: string]: unknown;
}

Type declaration

  • [key: string]: unknown
Options: {
    [key: string]: unknown;
}

Type declaration

  • [key: string]: unknown
PhantomProvider: {
    isPhantom?: boolean;
    publicKey: PublicKey | null;
    connect(): Promise<void>;
    disconnect(): Promise<void>;
    signAllTransactions(transactions): Promise<Transaction[]>;
    signMessage(message): Promise<Uint8Array>;
    signTransaction(transaction): Promise<Transaction>;
}

Type declaration

  • Optional isPhantom?: boolean
  • publicKey: PublicKey | null
  • connect:function
  • disconnect:function
  • signAllTransactions:function
    • Parameters

      • transactions: Transaction[]

      Returns Promise<Transaction[]>

  • signMessage:function
  • signTransaction:function
PhantomProvider: {
    isPhantom?: boolean;
    publicKey: PublicKey | null;
    connect(): Promise<void>;
    disconnect(): Promise<void>;
    signAllTransactions(transactions): Promise<Transaction[]>;
    signMessage(message): Promise<Uint8Array>;
    signTransaction(transaction): Promise<Transaction>;
}

Type declaration

  • Optional isPhantom?: boolean
  • publicKey: PublicKey | null
  • connect:function
  • disconnect:function
  • signAllTransactions:function
    • Parameters

      • transactions: Transaction[]

      Returns Promise<Transaction[]>

  • signMessage:function
  • signTransaction:function
ThawOptions: {
    feePayer: Secret;
}

Type declaration

  • feePayer: Secret
ThawOptions: {
    feePayer: Secret;
}

Type declaration

  • feePayer: Secret
TransferOptions: {
    feePayer: Secret;
}

Type declaration

  • feePayer: Secret
TransferOptions: {
    feePayer: Secret;
}

Type declaration

  • feePayer: Secret
Uses: {
    remaining: bignum;
    total: bignum;
    useMethod: UseMethod;
}

Type declaration

Uses: {
    remaining: bignum;
    total: bignum;
    useMethod: UseMethod;
}

Type declaration

connectOption: {
    onlyIfTrusted: false;
}

Type declaration

  • onlyIfTrusted: false
connectOption: {
    onlyIfTrusted: false;
}

Type declaration

  • onlyIfTrusted: false
Result<T, E>: Ok<T, E> | Err<T, E>

Type Parameters

  • T
  • E extends Error = Error
Result<T, E>: Ok<T, E> | Err<T, E>

Type Parameters

  • T
  • E extends Error = Error
Err<T, E>: InternalErr<T, E>

Type Parameters

  • T
  • E extends Error
Err<T, E>: InternalErr<T, E>

Type Parameters

  • T
  • E extends Error
Ok<T, E>: InternalOk<T, E>

Type Parameters

  • T
  • E extends Error
Ok<T, E>: InternalOk<T, E>

Type Parameters

  • T
  • E extends Error
Config: {
    cluster: {
        customClusterUrl: never[];
        type: string;
    };
    dasApiUrl: never[];
    debugging: string;
    filebase: {
        key: string;
        secret: string;
    };
} = SolanaJsonConfig

Type declaration

  • cluster: {
        customClusterUrl: never[];
        type: string;
    }
    • customClusterUrl: never[]
    • type: string
  • dasApiUrl: never[]
  • debugging: string
  • filebase: {
        key: string;
        secret: string;
    }
    • key: string
    • secret: string
Config: {
    cluster: {
        customClusterUrl: never[];
        type: string;
    };
    dasApiUrl: never[];
    debugging: string;
    filebase: {
        key: string;
        secret: string;
    };
} = SolanaJsonConfig

Type declaration

  • cluster: {
        customClusterUrl: never[];
        type: string;
    }
    • customClusterUrl: never[]
    • type: string
  • dasApiUrl: never[]
  • debugging: string
  • filebase: {
        key: string;
        secret: string;
    }
    • key: string
    • secret: string
BUNDLR_NETWORK_URL: string = ...
BUNDLR_NETWORK_URL: string = ...
COMMITMENT: Finality = 'confirmed'
COMMITMENT: Finality = 'confirmed'
EXPLORER_SOLANAFM_URL: "https://solana.fm" = 'https://solana.fm'
EXPLORER_SOLANAFM_URL: "https://solana.fm" = 'https://solana.fm'
EXPLORER_SOLSCAN_URL: "https://solscan.io" = 'https://solscan.io'
EXPLORER_SOLSCAN_URL: "https://solscan.io" = 'https://solscan.io'
EXPLORER_XRAY_URL: "https://xray.helius.xyz" = 'https://xray.helius.xyz'
EXPLORER_XRAY_URL: "https://xray.helius.xyz" = 'https://xray.helius.xyz'
FILEBADE_GATEWAY_URL: "https://ipfs.filebase.io/ipfs" = 'https://ipfs.filebase.io/ipfs'
FILEBADE_GATEWAY_URL: "https://ipfs.filebase.io/ipfs" = 'https://ipfs.filebase.io/ipfs'
FILEBASE_ACCESS_KEYS: {
    key: string;
    secret: string;
} = ...

Type declaration

  • key: string
  • secret: string
FILEBASE_ACCESS_KEYS: {
    key: string;
    secret: string;
} = ...

Type declaration

  • key: string
  • secret: string
FilebaseCredential: {
    dev: {
        key: string;
        secret: string;
    };
} = ...

Type declaration

  • dev: {
        key: string;
        secret: string;
    }
    • key: string
    • secret: string
FilebaseCredential: {
    dev: {
        key: string;
        secret: string;
    };
} = ...

Type declaration

  • dev: {
        key: string;
        secret: string;
    }
    • key: string
    • secret: string
IRYS_GATEWAY_URL: "https://gateway.irys.xyz" = 'https://gateway.irys.xyz'
IRYS_GATEWAY_URL: "https://gateway.irys.xyz" = 'https://gateway.irys.xyz'
MAX_TRANSACTION_RETRIES: 1 = 1
MAX_TRANSACTION_RETRIES: 1 = 1
MAX_TRANSACTION_VERSION: number = 0
MAX_TRANSACTION_VERSION: number = 0
MEMO_PROGRAM_ID: PublicKey = ...
MEMO_PROGRAM_ID: PublicKey = ...
METAPLEX_PROGRAM_ID: PublicKey = ...
METAPLEX_PROGRAM_ID: PublicKey = ...
WRAPPED_TOKEN_PROGRAM_ID: PublicKey = ...
WRAPPED_TOKEN_PROGRAM_ID: PublicKey = ...
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 " = ...
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 " = ...
FILEBASE_CREDENTIAL: "\n [YOU HAVE TO DO]\n --------------------------------------\n You need to update Filebase credential(accessKey and secret) define parameter in solana-suite.json.\n Can get credential from https://filebase.com/\n --------------------------------------\n " = ...
FILEBASE_CREDENTIAL: "\n [YOU HAVE TO DO]\n --------------------------------------\n You need to update Filebase credential(accessKey and secret) define parameter in solana-suite.json.\n Can get credential from https://filebase.com/\n --------------------------------------\n " = ...
currentCluster: string = Config.cluster.type
currentCluster: string = Config.cluster.type
customClusterUrl: never[] = Config.cluster.customClusterUrl
customClusterUrl: never[] = Config.cluster.customClusterUrl
customDasApiUrl: never[] = Config.dasApiUrl
customDasApiUrl: never[] = Config.dasApiUrl
isDebugging: string = Config.debugging
isDebugging: string = Config.debugging