Class NiftoryClient

Hierarchy

BaseNiftoryClient
- NiftoryClient

Index

Properties

`Protected` params

params: NiftoryClientParams

Accessors

isReady

get isReady(): boolean
Checks if token or client secret has been initialized yet

Returns boolean
Inherited from BaseNiftoryClient.isReady
- Defined in src/core/api/baseNiftoryClient.ts:99

Methods - App

addCredential

addCredential(params): Promise<Keys>
Adds a credential to an app
Parameters
- params: Exact<{
      appId: string;
      data?: CredentialUpdateInput;
      type?: CredentialType;
  }>
Returns Promise<Keys>
The added credential
- Defined in src/core/api/niftoryClient.ts:902

createApp

createApp(params): Promise<App>
Creates App
Parameters
- params: Exact<{
  data: AppCreateInput;
  }>
Returns Promise<App>
The App created
- Defined in src/core/api/niftoryClient.ts:885

deleteCredential

deleteCredential(params): Promise<Keys>
Deletes a credential
Parameters
- params: Exact<{
  clientId: string;
  }>
Returns Promise<Keys>
The deleted credential, if any
- Defined in src/core/api/niftoryClient.ts:937

getAppById

getAppById(id): Promise<App>
Gets app by its ID
Parameters
- id: string
  
  Id of the app to fetch
Returns Promise<App>
The App
- Defined in src/core/api/niftoryClient.ts:967

getCurrentApp

getCurrentApp(): Promise<App>
Gets the current app

Returns Promise<App>
The App
- Defined in src/core/api/niftoryClient.ts:953

updateCredential

updateCredential(params): Promise<Keys>
Updates a credential
Parameters
- params: Exact<{
  clientId: string;
  data: CredentialUpdateInput;
  }>
Returns Promise<Keys>
The added credential
- Defined in src/core/api/niftoryClient.ts:920

Methods - Blockchain

approveCustomTransaction

approveCustomTransaction(id): Promise<CustomTransaction>
Approves a custom transaction to be executed on the blockchain. Can only be used by a niftory admin.
Parameters
- id: string
  
  ID of the custom transaction to approve
Returns Promise<CustomTransaction>
the CustomTransaction approved
- Defined in src/core/api/niftoryClient.ts:1201

createCustomTransaction

createCustomTransaction(params): Promise<CustomTransaction>
Creates a custom transaction to be executed on the blockchain. This needs to be approved by a Niftory admin before it can be executed.
Parameters
- params: Exact<{
  appId?: string;
  data: CustomTransactionCreateInput;
  }>
Returns Promise<CustomTransaction>
the CustomTransaction created
- Defined in src/core/api/niftoryClient.ts:1185

deleteTransaction

deleteTransaction(id): Promise<CustomTransaction>
deletes a custom Transaction from the database, This won't delete the transaction from the blockchain. Can only be used by an app admin
Parameters
- id: string
  
  ID of the custom transaction to delete
Returns Promise<CustomTransaction>
the CustomTransaction deleted
- Defined in src/core/api/niftoryClient.ts:1219

executeBlockchainTransaction

executeBlockchainTransaction(params): Promise<BlockchainTransaction>
executes a custom transaction on the blockchain
Parameters
- params: Exact<{
      address?: string;
      appId?: string;
      args?: any;
      name?: string;
      transaction: string;
      transactionId?: string;
      userId?: string;
      walletId?: string;
  }>
Returns Promise<BlockchainTransaction>
- Defined in src/core/api/niftoryClient.ts:1259

getBlockchainTransaction

getBlockchainTransaction(params): Promise<BlockchainTransaction>
Gets a Blockchain transaction
Parameters
- params: GetBlockchainTransactionParams
Returns Promise<BlockchainTransaction>
the MarketplaceListing
- Defined in src/core/api/niftoryClient.ts:1236

getCustomTransaction

getCustomTransaction(id): Promise<CustomTransaction>
fetches the custom transaction to be executed on the blockchain
Parameters
- id: string
  
  ID of the custom transaction
Returns Promise<CustomTransaction>
the CustomTransaction
- Defined in src/core/api/niftoryClient.ts:1149

getCustomTransactions

getCustomTransactions(params): Promise<CustomTransactionList>
fetches the custom transactions to be executed on the blockchain
Parameters
- params: Exact<{
      appId?: string;
      cursor?: string;
      maxResults?: any;
      search?: string;
  }>
Returns Promise<CustomTransactionList>
the CustomTransactionList
- Defined in src/core/api/niftoryClient.ts:1167

Methods - Contract

deployContract

deployContract(params): Promise<Contract>
Deploys the contract of current app
Parameters
- params: Exact<{
      appId: string;
      blockchain: Blockchain;
      name: string;
  }>
Returns Promise<Contract>
the Contract deployed
- Defined in src/core/api/niftoryClient.ts:1002

getContract

getContract(appId?): Promise<Contract>
Gets the contract belonging to current app
Parameters
- Optional appId: string
  
  the if of the app you want to get the contract for
Returns Promise<Contract>
the Contract
- Defined in src/core/api/niftoryClient.ts:984

Methods - DapperWallet

checkoutWithDapperWallet

checkoutWithDapperWallet(params): Promise<CheckoutWithDapperWalletResponse>
Initiates checkout with Dapper Wallet of specified NFTModels, and returns a signed transaction to complete checkout with. Flow blockchain only.
Parameters
- params: Exact<{
      address?: string;
      expiry?: any;
      nftModelId: string;
      price?: any;
      userId?: string;
      walletId?: string;
  }>
Returns Promise<CheckoutWithDapperWalletResponse>
CheckoutWithDapperWalletResponse
- Defined in src/core/api/niftoryClient.ts:1287

completeCheckoutWithDapperWallet

completeCheckoutWithDapperWallet(params): Promise<Nft>
Marks the checkout with Dapper Wallet as complete, and updates the NFT as belonging to specified wallet. Called after checkoutWithDapperWallet once purchase is completed.
Parameters
- params: Exact<{
  nftDatabaseId?: string;
  transactionId: string;
  }>
Returns Promise<Nft>
the CompleteCheckoutWithDapperWalletMutation
- Defined in src/core/api/niftoryClient.ts:1306

signTransactionForDapperWallet

signTransactionForDapperWallet(params): Promise<string>
Signs a transaction for Dapper Wallet.
Parameters
- params: Exact<{
  transaction?: string;
  }>
Returns Promise<string>
signed signature
- Defined in src/core/api/niftoryClient.ts:1323

Methods - File

createFileUploadUrl

createFileUploadUrl(params): Promise<File>
Gets the Niftory Wallet of the currently signed-in user
Parameters
- params: Exact<{
      appId?: string;
      description?: string;
      name: string;
      options?: CreateFileOptionsInput;
  }>
Returns Promise<File>
the created file
- Defined in src/core/api/niftoryClient.ts:716

getFile

getFile(id): Promise<File>
Gets a file by ID using the Niftory API.
Parameters
- id: string
  
  The ID of the file to retrieve
Returns Promise<File>
the file
- Defined in src/core/api/niftoryClient.ts:286

Methods - Invoice

getInvoices

getInvoices(params): Promise<InvoiceList>
Gets the list of invoices for your app.
Parameters
- params: Exact<{
      appId?: string;
      cursor?: string;
      filter?: InvoicesFilterInput;
      maxResults?: any;
  }>
Returns Promise<InvoiceList>
the {InvoiceList}
- Defined in src/core/api/niftoryClient.ts:1480

Methods - Marketplace

completeMarketplaceCancel

completeMarketplaceCancel(params): Promise<MarketplaceListing>
Marks the marketplace listing as cancelled
Parameters
- params: Exact<{
  id: string;
  transactionId: string;
  }>
Returns Promise<MarketplaceListing>
the MarketplaceListing
- Defined in src/core/api/niftoryClient.ts:1420

completeMarketplaceList

completeMarketplaceList(params): Promise<MarketplaceListing>
Marks the marketplace listing as completed. This should be caleld after listing transactions is sealed with its trasanctionhash and nftId
Parameters
- params: Exact<{
  nftId: string;
  transactionId: string;
  }>
Returns Promise<MarketplaceListing>
the MarketplaceListing
- Defined in src/core/api/niftoryClient.ts:1401

completeMarketplacePurchase

completeMarketplacePurchase(params): Promise<MarketplaceListing>
Transfers the NFT in the marketplace listing to a new owner
Parameters
- params: Exact<{
  id: string;
  transactionId: string;
  }>
Returns Promise<MarketplaceListing>
the MarketplaceListing
- Defined in src/core/api/niftoryClient.ts:1439

getMarketplaceListing

getMarketplaceListing(id): Promise<MarketplaceListing>
Fetches a Marketplace listing from its ID
Parameters
- id: string
  
  ID of the listing
Returns Promise<MarketplaceListing>
the MarketplaceListing
- Defined in src/core/api/niftoryClient.ts:1361

getMarketplaceListings

getMarketplaceListings(params): Promise<MarketplaceListingList>
Fetches a Marketplace listings filtered and paginated from given params
Parameters
- params: QueryMarketplaceListingsArgs
Returns Promise<MarketplaceListingList>
the MarketplaceListing
- Defined in src/core/api/niftoryClient.ts:1379

Methods - NFTListing

checkoutListing

checkoutListing(params): Promise<InitiateCheckoutResponse>
Starts the checkout process of an NFT Listing
Parameters
- params: CheckoutListingParams
Returns Promise<InitiateCheckoutResponse>
the Invoice of the reserve
- Defined in src/core/api/niftoryClient.ts:1043

createNFTListing

createNFTListing(params): Promise<NftListing>
Creates an NFT listing
Parameters
- params: CreateNftListingInput
Returns Promise<NftListing>
the NFTListing created
- Defined in src/core/api/niftoryClient.ts:1066

getNFTListing

getNFTListing(id): Promise<NftListing>
Fetches an NFT listing
Parameters
- id: string
  
  ID of the listing
Returns Promise<NftListing>
the NFTListing
- Defined in src/core/api/niftoryClient.ts:1101

getNFTListings

getNFTListings(params): Promise<NftListingList>
Fetches NFT listings from given params
Parameters
- params: GetNFTListingsParams
Returns Promise<NftListingList>
the NFTListingList
- Defined in src/core/api/niftoryClient.ts:1118

reserveListing

reserveListing(id): Promise<Invoice>
Reserves an NFT listing
Parameters
- id: string
  
  ID of the listing
Returns Promise<Invoice>
the Invoice of the reserve
- Defined in src/core/api/niftoryClient.ts:1026

updateNftListing

updateNftListing(params): Promise<NftListing>
Updates an existing NFTListing.
Parameters
- params: Exact<{
  data: UpdateNftListingInput;
  id: string;
  }>
Returns Promise<NftListing>
the updated NFTSet
- Defined in src/core/api/niftoryClient.ts:1084

Methods - Nft

getNft

getNft(id): Promise<Nft>
Gets an NFT by ID using the Niftory API.
Parameters
- id: string
  
  The ID of the NFT to retrieve
Returns Promise<Nft>
the NFT
- Defined in src/core/api/niftoryClient.ts:301

getNfts

getNfts(params): Promise<NftList>
Gets NFTs associated with the current AppUser context, including those that are transferring or failed to transfer. Read more here.
Parameters
- params: QueryNftsArgs
Returns Promise<NftList>
The list of NFTs
- Defined in src/core/api/niftoryClient.ts:320

getNftsByWallet

getNftsByWallet(params): Promise<NftList>
Gets NFTs associated with the current wallet, including those that are transferring or failed to transfer. Read more here.
Parameters
- params: GetNFTsByWalletParams
Returns Promise<NftList>
The list of NFTs
- Defined in src/core/api/niftoryClient.ts:338

transfer

transfer(params): Promise<Nft>
Initiates the transfer of an NFT to the currently-logged in AppUser. The NFT is reserved for the user in database, and you can use the NFT.status field to check on the transfer progress.
Parameters
- params: Exact<{
      address?: string;
      appId?: string;
      force?: boolean;
      nftId?: string;
      nftModelId?: string;
      userId?: string;
      walletId?: string;
  }>
Returns Promise<Nft>
the NFT which was transferred
- Defined in src/core/api/niftoryClient.ts:362

uploadNftContent

uploadNftContent(params): Promise<NftContent>
Creates an NFTContent object containing pre-signed URLs that can then be used to upload a file and poster. The primary file will automatically be uploaded to IPFS once it's been uploaded to the pre-signed URL. Each returned File has a 'state' property to track the upload.
Parameters
- params: Exact<{
      contentType?: string;
      description?: string;
      name?: string;
      posterContentType?: string;
  }>
Returns Promise<NftContent>
the {NftContent}
- Defined in src/core/api/niftoryClient.ts:1460

withdraw

withdraw(params): Promise<Nft>
Withdraws an NFT from a Niftory Custodial Wallet to an external wallet address.
Parameters
- params: Exact<{
      appId?: string;
      id: string;
      niftoryWalletAddress?: string;
      receiverAddress: string;
  }>
Returns Promise<Nft>
the NFT which was withdrawn
- Defined in src/core/api/niftoryClient.ts:387

Methods - NftListing

deleteNftListing

deleteNftListing(id): Promise<NftListing>
Deletes an existing NFTListing
Parameters
- id: string
  
  ID of the NFTListing to delete
Returns Promise<NftListing>
the deleted NFTListing
- Defined in src/core/api/niftoryClient.ts:653

deleteNftSet

deleteNftSet(id): Promise<NftSet>
Deletes an existing NFTSet. This operation will only be perfomed if no NFTs have been minted from this NFTSet
Parameters
- id: string
  
  ID of the NFTSet to delete
Returns Promise<NftSet>
the deleted NFTSet
- Defined in src/core/api/niftoryClient.ts:493

Methods - NftModel

createNftModel

createNftModel(params): Promise<NftModel>
Creates a new NFTModel using the Niftory API
Parameters
- params: Exact<{
      appId?: string;
      data: NftModelCreateInput;
      setId: string;
  }>
Returns Promise<NftModel>
the newly created NFTModel
- Defined in src/core/api/niftoryClient.ts:538

deleteNftModel

deleteNftModel(id): Promise<NftModel>
Deletes an existing NFTModel. This operation will only be perfomed if no NFTs have been minted from this NFTModel
Parameters
- id: string
  
  ID of the NFTModel to delete
Returns Promise<NftModel>
the deleted NFTModel
- Defined in src/core/api/niftoryClient.ts:555

getNftModel

getNftModel(id): Promise<NftModel>
Gets an NFT Model by ID using the Niftory API.
Parameters
- id: string
  
  The ID of the NFT Model to retrieve
Returns Promise<NftModel>
the NFT Model
- Defined in src/core/api/niftoryClient.ts:620

getNftModels

getNftModels(params): Promise<NftModelList>
Gets an NFT Model by ID using the Niftory API.
Parameters
- params: QueryNftModelsArgs
Returns Promise<NftModelList>
the NFT Model
- Defined in src/core/api/niftoryClient.ts:638

mintNftModel

mintNftModel(params): Promise<NftModel>
Mints an NFT model using the API
Parameters
- params: Exact<{
      appId?: string;
      nftModelId: string;
      quantity?: any;
  }>
Returns Promise<NftModel>
the NFTModel which was minted
- Defined in src/core/api/niftoryClient.ts:596

updateNftModel

updateNftModel(params): Promise<NftModel>
Updates an existing NFTModel. Note that if this NFTModel has already been used to mint an NFT, the update operation will fail for any properties that affect the blockchain (such as 'quantity', 'title', 'metadata', etc.), whereas updating 'attributes' will succeed.
Parameters
- params: Exact<{
  data: NftModelUpdateInput;
  id: string;
  }>
Returns Promise<NftModel>
the updated NFTModel
- Defined in src/core/api/niftoryClient.ts:577

Methods - NftSet

getNftSets

getNftSets(params): Promise<NftSetList>
Gets an NFT Model by ID using the Niftory API.
Parameters
- params: QueryNftSetsArgs
Returns Promise<NftSetList>
the NFT Set
- Defined in src/core/api/niftoryClient.ts:453

updateNftSet

updateNftSet(params): Promise<NftSet>
Updates an existing NftSet.
Parameters
- params: Exact<{
      appId?: string;
      data: NftSetUpdateInput;
      id: string;
  }>
Returns Promise<NftSet>
the updated NftSet
- Defined in src/core/api/niftoryClient.ts:515

Methods - Organization

createOrganization

createOrganization(params): Promise<Organization>
Creates an Organization
Parameters
- params: Exact<{
  data: OrganizationCreateInput;
  }>
Returns Promise<Organization>
The organization created
- Defined in src/core/api/niftoryClient.ts:866

Methods - Set

createSet

createSet(params): Promise<NftSet>
Creates a new set using the Niftory API
Parameters
- params: Exact<{
  appId?: string;
  data: NftSetCreateInput;
  }>
Returns Promise<NftSet>
the newly created set
- Defined in src/core/api/niftoryClient.ts:469

getSet

getSet(id): Promise<NftSet>
Gets a set by ID using the Niftory API
Parameters
- id: string
  
  the ID of the set to retrieve
Returns Promise<NftSet>
the set
- Defined in src/core/api/niftoryClient.ts:411

getSets

getSets(params): Promise<NftSet[]>
Gets a list of sets using the Niftory API
Parameters
- params: QuerySetsArgs
Returns Promise<NftSet[]>
the list of sets
- Defined in src/core/api/niftoryClient.ts:430

Methods - User

getAdminUser

getAdminUser(): Promise<AdminUser>
Gets the current admin user using the Niftory API

Returns Promise<AdminUser>
the current admin user
- Defined in src/core/api/niftoryClient.ts:271

getAppUser

getAppUser(): Promise<AppUser>
Fetches the current app user

Returns Promise<AppUser>
the AppUser
- Defined in src/core/api/niftoryClient.ts:1134

Methods - Wallet

createNiftoryWallet

createNiftoryWallet(args?): Promise<Wallet>
Creates a new Niftory Wallet using the Niftory API
Parameters
- Optional args: Exact<{
  appId?: string;
  userId?: string;
  }>
Returns Promise<Wallet>
the newly created Niftory Wallet
- Defined in src/core/api/niftoryClient.ts:674

getNiftoryWallet

getNiftoryWallet(id): Promise<Wallet>
Parameters
- id: string
  
  The ID of the Niftory Wallet to retrieve
Returns Promise<Wallet>
the Niftory Wallet
- Defined in src/core/api/niftoryClient.ts:698

getWallet

getWallet(): Promise<Wallet>
Gets the primary wallet of the current user

Returns Promise<Wallet>
the Wallet
- Defined in src/core/api/niftoryClient.ts:736

getWalletByAddress

getWalletByAddress(params): Promise<Wallet>
Parameters
- params: QueryWalletByAddressArgs
Returns Promise<Wallet>
the Wallet
- Defined in src/core/api/niftoryClient.ts:750

getWallets

getWallets(params): Promise<WalletList>
Parameters
- params: QueryWalletsArgs
Returns Promise<WalletList>
all Wallets for the current app
- Defined in src/core/api/niftoryClient.ts:769

readyWallet

readyWallet(address): Promise<Wallet>
Marks a Wallet as ready, indicating that the wallet is ready to receive NFTs from the app's Contract. The wallet must be verified before this succeeds. Read more here.
Parameters
- address: string
  
  The address of the wallet
Returns Promise<Wallet>
- Defined in src/core/api/niftoryClient.ts:826

registerWallet

registerWallet(address): Promise<Wallet>
Registers a Wallet, associating it with the currently signed-in AppUser if specified. Read more here.
Parameters
- address: string
  
  The address of the wallet
Returns Promise<Wallet>
- Defined in src/core/api/niftoryClient.ts:787

setPrimaryWallet

setPrimaryWallet(params): Promise<Wallet>
Sets the primary Wallet for the currently signed in user.
Parameters
- params: Exact<{
  address?: string;
  walletId?: string;
  }>
Returns Promise<Wallet>
- Defined in src/core/api/niftoryClient.ts:848

signTransaction

signTransaction(params): Promise<string>
Signs a transaction for Niftory Wallet.
Parameters
- params: Exact<{
      address?: string;
      appId?: string;
      transaction: string;
      userId?: string;
      walletId?: string;
  }>
Returns Promise<string>
signed signature
- Defined in src/core/api/niftoryClient.ts:1344

verifyWallet

verifyWallet(params): Promise<Wallet>
Verifies a Wallet to the currently signed-in user. If the signed verification code fails to decode with the wallet's public key or doesn't match the wallet's verification code, the request will fail. Read more here.
Parameters
- params: Exact<{
  address: string;
  signedVerificationCode: any;
  }>
Returns Promise<Wallet>
- Defined in src/core/api/niftoryClient.ts:805

Class NiftoryClient

Hierarchy

Index

Properties

Accessors

Methods - App

Methods - Blockchain

Methods - Contract

Methods - DapperWallet

Methods - File

Methods - Invoice

Methods - Marketplace

Methods - NFTListing

Methods - Nft

Methods - NftListing

Methods - NftModel

Methods - NftSet

Methods - Organization

Methods - Set

Methods - User

Methods - Wallet

Properties

Protected params

Accessors

isReady

Returns boolean

Methods - App

addCredential

Parameters

params: Exact<{ appId: string; data?: CredentialUpdateInput; type?: CredentialType; }>

Returns Promise<Keys>

createApp

Parameters

params: Exact<{ data: AppCreateInput; }>

Returns Promise<App>

deleteCredential

Parameters

params: Exact<{ clientId: string; }>

Returns Promise<Keys>

getAppById

Parameters

id: string

Returns Promise<App>

getCurrentApp

Returns Promise<App>

updateCredential

Parameters

params: Exact<{ clientId: string; data: CredentialUpdateInput; }>

Returns Promise<Keys>

Methods - Blockchain

approveCustomTransaction

Parameters

id: string

Returns Promise<CustomTransaction>

createCustomTransaction

Parameters

params: Exact<{ appId?: string; data: CustomTransactionCreateInput; }>

Returns Promise<CustomTransaction>

deleteTransaction

Parameters

id: string

Returns Promise<CustomTransaction>

executeBlockchainTransaction

Parameters

params: Exact<{ address?: string; appId?: string; args?: any; name?: string; transaction: string; transactionId?: string; userId?: string; walletId?: string; }>

Returns Promise<BlockchainTransaction>

getBlockchainTransaction

Parameters

params: GetBlockchainTransactionParams

Returns Promise<BlockchainTransaction>

getCustomTransaction

Parameters

id: string

Returns Promise<CustomTransaction>

getCustomTransactions

Parameters

params: Exact<{ appId?: string; cursor?: string; maxResults?: any; search?: string; }>

Returns Promise<CustomTransactionList>

Methods - Contract

deployContract

`Protected` params

params: Exact<{
appId: string;
data?: CredentialUpdateInput;
type?: CredentialType;
}>

params: Exact<{
data: AppCreateInput;
}>

params: Exact<{
clientId: string;
}>

params: Exact<{
clientId: string;
data: CredentialUpdateInput;
}>

params: Exact<{
appId?: string;
data: CustomTransactionCreateInput;
}>

params: Exact<{
address?: string;
appId?: string;
args?: any;
name?: string;
transaction: string;
transactionId?: string;
userId?: string;
walletId?: string;
}>

params: Exact<{
appId?: string;
cursor?: string;
maxResults?: any;
search?: string;
}>

params: Exact<{
appId: string;
blockchain: Blockchain;
name: string;
}>

`Optional` appId: string

params: Exact<{
address?: string;
expiry?: any;
nftModelId: string;
price?: any;
userId?: string;
walletId?: string;
}>

params: Exact<{
nftDatabaseId?: string;
transactionId: string;
}>

params: Exact<{
transaction?: string;
}>

params: Exact<{
appId?: string;
description?: string;
name: string;
options?: CreateFileOptionsInput;
}>

params: Exact<{
appId?: string;
cursor?: string;
filter?: InvoicesFilterInput;
maxResults?: any;
}>

params: Exact<{
id: string;
transactionId: string;
}>

params: Exact<{
nftId: string;
transactionId: string;
}>

params: Exact<{
id: string;
transactionId: string;
}>