@venly/venly-core-sdk
Version:
Javascrip/Typescript SDK for Venly's Web3 Services
405 lines • 25.4 kB
TypeScript
import { VyPromise } from '../core';
import { Any } from '../helpers/json';
import * as token from '../models/token/index';
import * as shared from '../models/shared/index';
import * as enums from '../models/enums/index';
import { VyApiBase } from './VyApiBase';
export declare abstract class VyTokenAPI_Gen {
protected _apiBase: VyApiBase;
protected _apiEndpoint: enums.VyApiEndpoint;
constructor(_apiBase: VyApiBase);
/**
* This endpoint is used to retrieve the supported chains for the NFT API.
* @returns {VyChain[]}
*/
getSupportedErc1155Chains(): VyPromise<enums.VyChain[]>;
/**
* This endpoint retrieves all company minter wallets.
* @param {VyQuery_GetCompanyWallets} query - Query to filter the operation results
* @returns {VyCompanyWalletBalanceDto[]}
*/
getCompanyWallets(query?: token.VyQuery_GetCompanyWallets): VyPromise<token.VyCompanyWalletBalanceDto[]>;
/**
* This endpoint retrieves company minter wallets by blockchain.
* @param {VyChain} chain - The blockchain to filter the result by
* @param {VyQuery_GetCompanyWalletsByChain} query - Query to filter the operation results
* @returns {VyCompanyWalletBalanceDto[]}
*/
getCompanyWalletsByChain(chain: enums.VyChain, query?: token.VyQuery_GetCompanyWalletsByChain): VyPromise<token.VyCompanyWalletBalanceDto[]>;
/**
* This endpoint deletes a company wallet by blockchain and wallet address.
* @param {VyChain} chain - The blockchain of the company wallet.
* @param {string} address - This is the wallet `address` of the company wallet.
*/
deleteCompanyWallet(chain: enums.VyChain, address: string): VyPromise<Any>;
/**
* This endpoint fetches all of your contracts.
* @param {VyQuery_GetErc1155Contracts} query - Query to filter the operation results
* @returns {VyErc1155ContractDto[]}
*/
getErc1155Contracts(query?: token.VyQuery_GetErc1155Contracts): VyPromise<token.VyErc1155ContractDto[]>;
/**
* This endpoint is used to fetch the metadata of as contract.
* @param {VyChain} chain - The blockchain of the contract.
* @param {string} contractAddress - The contract address whose metadata you want to fetch.
* @returns {VyErc1155TokenContractMetadataDto}
*/
getErc1155ContractMetadata(chain: enums.VyChain, contractAddress: string): VyPromise<token.VyErc1155TokenContractMetadataDto>;
/**
* This endpoint is used to update the metadata of a contract.
* @param {VyChain} chain - The blockchain of the contract.
* @param {string} contractAddress - The contract address whose metadata you want to update.
* @param {VyUpdateErc1155ContractMetadataRequest} reqParams - Request data for the operation
* @returns {VyErc1155TokenContractMetadataDto}
*/
updateErc1155ContractMetadata(chain: enums.VyChain, contractAddress: string, reqParams: token.VyUpdateErc1155ContractMetadataRequest): VyPromise<token.VyErc1155TokenContractMetadataDto>;
/**
*
* @param {VyChain} chain - The blockchain of the contract.
* @param {string} contractAddress - The contract address.
* @returns {VyErc1155TokenTypeSummaryDto[]}
*/
getErc1155TokenTypes(chain: enums.VyChain, contractAddress: string): VyPromise<token.VyErc1155TokenTypeSummaryDto[]>;
/**
*
* @param {string} chain - The blockchain of the contract.
* @param {string} contractAddress - The contract address.
* @returns {VyErc1155TokenTypeSummaryDto[]}
*/
getSuiTokenTypes(chain: string, contractAddress: string): VyPromise<token.VyErc1155TokenTypeSummaryDto[]>;
/**
* This endpoint is used to fetch the metadata of a token-type
* @param {VyChain} chain - The blockchain of the contract.
* @param {string} contractAddress - The contract address.
* @param {number} tokenTypeId - The `id` of the token-type whose metadata you want to fetch.
* @returns {VyMetadataDto}
*/
getErc1155TokenTypeMetadata(chain: enums.VyChain, contractAddress: string, tokenTypeId: number): VyPromise<token.VyMetadataDto>;
/**
* This endpoint is used to update the metadata of a token-type.
* @param {VyChain} chain - The blockchain of the contract.
* @param {string} contractAddress - The contract address.
* @param {number} tokenTypeId - The `id` of the token-type whose metadata you want to update.
* @param {VyUpdateErc1155TokenTypeMetadataRequest} reqParams - Request data for the operation
* @returns {VyMetadataDto}
*/
updateErc1155TokenTypeMetadata(chain: enums.VyChain, contractAddress: string, tokenTypeId: number, reqParams: token.VyUpdateErc1155TokenTypeMetadataRequest): VyPromise<token.VyMetadataDto>;
/**
* This endpoint is used to get all tokens in a contract.
* @param {VyChain} chain - The blockchain of the contract.
* @param {string} contractAddress - The contract address whose tokens you want to fetch.
* @param {VyQuery_GetErc1155Tokens} query - Query to filter the operation results
* @returns {VyErc1155TokenDto[]}
*/
getErc1155Tokens(chain: enums.VyChain, contractAddress: string, query?: token.VyQuery_GetErc1155Tokens): VyPromise<token.VyErc1155TokenDto[]>;
/**
* This endpoint fetches the metadata of a token by `tokenId`.
* @param {VyChain} chain - The blockchain of the contract.
* @param {string} contractAddress - The contract address.
* @param {number} tokenId - The `id` of the token whose metadata you want to fetch.
* @returns {VyMetadataDto}
*/
getErc1155TokenMetadata(chain: enums.VyChain, contractAddress: string, tokenId: number): VyPromise<token.VyMetadataDto>;
/**
* This endpoint is used to update a property for a specific NFT. You can also add a property using this endpoint.
* @param {VyChain} chain - The blockchain of the NFT collection
* @param {string} contractAddress - The NFT contract address
* @param {number} tokenId - The `ID` of the token you want to update
* @param {VyTokenPropertyType} propertyName - The name of the property you want to update (**NOTE**: This param is case sensitive.)
* @param {VyUpdateErc1155TokenPropertyRequest} reqParams - Request data for the operation
* @returns {VyMetadataDto}
*/
updateErc1155TokenProperty(chain: enums.VyChain, contractAddress: string, tokenId: number, propertyName: enums.VyTokenPropertyType, reqParams: token.VyUpdateErc1155TokenPropertyRequest): VyPromise<token.VyMetadataDto>;
/**
* This endpoint is used to delete a property for a specific NFT.
* @param {VyChain} chain - The blockchain of the NFT collection
* @param {string} contractAddress - The NFT contract address
* @param {number} tokenId - The `ID` of the token you want to update
* @param {VyTokenPropertyType} propertyName - The name of the property you want to update (**NOTE**: This param is case sensitive.)
* @returns {VyMetadataDto} Token property deleted successfully.
*/
deleteErc1155TokenProperty(chain: enums.VyChain, contractAddress: string, tokenId: number, propertyName: enums.VyTokenPropertyType): VyPromise<token.VyMetadataDto>;
/**
* This endpoint is used to add attributes to a specific NFT.
* @param {VyChain} chain - The blockchain of the NFT collection
* @param {string} contractAddress - The NFT contract address
* @param {number} tokenId - The `ID` of the token
* @param {VyErc1155TokenAttributeDto} reqParams - Request data for the operation
* @returns {VyMetadataDto}
*/
addErc1155TokenAttribute(chain: enums.VyChain, contractAddress: string, tokenId: number, reqParams: token.VyErc1155TokenAttributeDto): VyPromise<token.VyMetadataDto>;
/**
* This endpoint is used to update an attribute's data for a specific NFT.
* @param {VyChain} chain - The blockchain of the NFT collection
* @param {string} contractAddress - The NFT contract address
* @param {number} tokenId - The `ID` of the token you want to update
* @param {string} attributeName - The name of the attribute you want to update (**NOTE**: This param is case sensitive.)
* @param {VyUpdateErc1155TokenAttributeRequest} reqParams - Request data for the operation
* @returns {VyMetadataDto}
*/
updateErc1155TokenAttribute(chain: enums.VyChain, contractAddress: string, tokenId: number, attributeName: string, reqParams: token.VyUpdateErc1155TokenAttributeRequest): VyPromise<token.VyMetadataDto>;
/**
* This endpoint is used to delete an attribute for a specific NFT.
* @param {VyChain} chain - The blockchain of the NFT collection
* @param {string} contractAddress - The NFT contract address
* @param {number} tokenId - The `ID` of the token for which you want to delete the attribute
* @param {string} attributeName - The name of the attribute you want to delete. (**NOTE**: This param is case sensitive.)
* @returns {VyMetadataDto} Token attribute deleted successfully.
*/
deleteErc1155TokenAttribute(chain: enums.VyChain, contractAddress: string, tokenId: number, attributeName: string): VyPromise<token.VyMetadataDto>;
/**
* This endpoint is used to update the `animationUrls` for a specific NFT.
* @param {VyChain} chain - The blockchain of the NFT collection
* @param {string} contractAddress - The NFT contract address
* @param {number} tokenId - The `ID` of the token you want to update
* @param {VyAnimationUrlDto[]} reqParams - Request data for the operation
* @returns {VyMetadataDto}
*/
updateErc1155TokenAnimationUrls(chain: enums.VyChain, contractAddress: string, tokenId: number, reqParams: token.VyAnimationUrlDto[]): VyPromise<token.VyMetadataDto>;
/**
* This endpoint is used to delete `animationUrls` for a specific NFT.
* @param {VyChain} chain - The blockchain of the NFT collection
* @param {string} contractAddress - The NFT contract address
* @param {number} tokenId - The `ID` of the token
* @returns {VyMetadataDto} Token `animationUrls` array deleted successfully.
*/
deleteErc1155TokenAnimationUrls(chain: enums.VyChain, contractAddress: string, tokenId: number): VyPromise<token.VyMetadataDto>;
/**
* This endpoint is used to retrieve all of your SUI token mint requests.
* @param {VyQuery_GetSuiTokenMints} query - Query to filter the operation results
* @returns {VyErc1155TokenMintInfoDto[]}
*/
getSuiTokenMints(query?: token.VyQuery_GetSuiTokenMints): VyPromise<token.VyErc1155TokenMintInfoDto[]>;
/**
* This endpoint is used to mint SUI NFTs.
* @param {VyMintSuiTokensRequest} reqParams - Request data for the operation
* @returns {VyMintErc1155TokensResultDto}
*/
mintSuiTokens(reqParams: token.VyMintSuiTokensRequest): VyPromise<token.VyMintErc1155TokensResultDto>;
/**
* This endpoint is used to retrieve all of your token mint requests.
* @param {VyQuery_GetErc1155TokenMints} query - Query to filter the operation results
* @returns {VyErc1155TokenMintInfoDto[]}
*/
getErc1155TokenMints(query?: token.VyQuery_GetErc1155TokenMints): VyPromise<token.VyErc1155TokenMintInfoDto[]>;
/**
* This endpoint is used to mint fungible or non-fungible tokens.
* @param {VyMintErc1155TokensRequest} reqParams - Request data for the operation
* @returns {VyMintErc1155TokensResultDto}
*/
mintErc1155Tokens(reqParams: token.VyMintErc1155TokensRequest): VyPromise<token.VyMintErc1155TokensResultDto>;
/**
* This endpoint is used to create a token-type.
* @param {VyCreateErc1155TokenTypeRequest} reqParams - Request data for the operation
* @returns {VyCreateErc1155TokenTypeResultDto}
*/
createErc1155TokenType(reqParams: token.VyCreateErc1155TokenTypeRequest): VyPromise<token.VyCreateErc1155TokenTypeResultDto>;
/**
* This endpoint is used to create a SUI token-type.
* @param {VyCreateSuiTokenTypeRequest} reqParams - Request data for the operation
* @returns {VyCreateErc1155TokenTypeResultDto}
*/
createSuiTokenType(reqParams: token.VyCreateSuiTokenTypeRequest): VyPromise<token.VyCreateErc1155TokenTypeResultDto>;
/**
* This endpoint is used to upload a media file to our servers.
* @param {VyUploadMediaRequest} reqParams - Request data for the operation
* @returns {VyErc1155TokenMediaDto}
*/
uploadMedia(reqParams: token.VyUploadMediaRequest): VyPromise<token.VyErc1155TokenMediaDto>;
/**
* This endpoint is used to upload an NFT image to our servers. Make sure to only upload images to with this endpoint.
* @param {VyUploadImageRequest} reqParams - Request data for the operation
* @returns {VyErc1155TokenImageDto}
*/
uploadImage(reqParams: token.VyUploadImageRequest): VyPromise<token.VyErc1155TokenImageDto>;
/**
* This endpoint is used to create a contract.
* @param {VyCreateErc1155ContractRequest} reqParams - Request data for the operation
* @returns {VyDeployedErc1155ContractDto}
*/
createErc1155Contract(reqParams: token.VyCreateErc1155ContractRequest): VyPromise<token.VyDeployedErc1155ContractDto>;
/**
* This endpoint is used to create a SUI contract.
* @param {VyCreateSuiContractRequest} reqParams - Request data for the operation
* @returns {VyDeployedErc1155ContractDto}
*/
createSuiContract(reqParams: token.VyCreateSuiContractRequest): VyPromise<token.VyDeployedErc1155ContractDto>;
/**
* This endpoint is used to check the status of the contract creation request.
* @param {string} deploymentId - To track the status of contract creation. It is in the response body of the create contract endpoint as `result.id`.
* @returns {VyDeployedErc1155ContractDto}
*/
getDeployedErc1155Contract(deploymentId: string): VyPromise<token.VyDeployedErc1155ContractDto>;
/**
* This endpoint is used to check the status of a SUI contract creation request.
* @param {string} deploymentId - To track the status of contract creation. It is in the response body of the create contract endpoint as `result.id`.
* @returns {VyDeployedErc1155ContractDto}
*/
getDeployedSuiContract(deploymentId: string): VyPromise<token.VyDeployedErc1155ContractDto>;
/**
* This endpoint is used to update the `owner` of an NFT contract. The updated owner will have admin rights on the contract.
* @param {VyChain} chain - The blockchain of the contract.
* @param {string} contractAddress - The contract address.
* @param {VyUpdateErc1155ContractOwnerRequest} reqParams - Request data for the operation
* @returns {VyTransactionHashResultDto}
*/
updateErc1155ContractOwner(chain: enums.VyChain, contractAddress: string, reqParams: token.VyUpdateErc1155ContractOwnerRequest): VyPromise<shared.VyTransactionHashResultDto>;
/**
* This endpoint is used to add/update the royalties for an NFT contract. You can add a royalty recipient wallet address and specifiy the royalty percentage. (_only for contracts created with the NFT v3_)
* @param {VyChain} chain - The blockchain of the contract.
* @param {string} contractAddress - The contract address whose royalty information you want to update.
* @param {VyUpdateErc1155ContractRoyaltiesRequest} reqParams - Request data for the operation
* @returns {VyTransactionHashResultDto}
*/
updateErc1155ContractRoyalties(chain: enums.VyChain, contractAddress: string, reqParams: token.VyUpdateErc1155ContractRoyaltiesRequest): VyPromise<shared.VyTransactionHashResultDto>;
/**
* This endpoint is used to check the status of a token mint request.
* @param {string} mintId - To track the status of token mint. It is in the response body of the mint tokens endpoint as `creations.mints.id`.
* @returns {VyErc1155TokenMintDto}
*/
getErc1155TokenMint(mintId: string): VyPromise<token.VyErc1155TokenMintDto>;
/**
* This endpoint is used to check the status of a SUI token mint request.
* @param {string} mintId - To track the status of token mint. It is in the response body of the mint tokens endpoint as `creations.mints.id`.
* @returns {VyErc1155TokenMintDto}
*/
getSuiTokenMint(mintId: string): VyPromise<token.VyErc1155TokenMintDto>;
/**
* This endpoint is used to check the status of token-type creation request.
* @param {string} creationId - To track the status of token-type creation. It is in the response body of the create token-type endpoint as `result.id`.
* @returns {VyCheckErc1155TokenTypeResultDto}
*/
checkErc1155TokenType(creationId: string): VyPromise<token.VyCheckErc1155TokenTypeResultDto>;
/**
* This endpoint is used to check the status of a SUI token-type creation request.
* @param {string} creationId - To track the status of token-type creation. It is in the response body of the create token-type endpoint as `result.id`.
* @returns {VyCheckErc1155TokenTypeResultDto}
*/
checkSuiTokenType(creationId: string): VyPromise<token.VyCheckErc1155TokenTypeResultDto>;
/**
* This endpoint is used to get a specific contract by blockchain and contract address.
* @param {VyChain} chain - The blockchain of the contract
* @param {string} contractAddress - The contract address whose details you want to fetch.
* @returns {VyErc1155ContractDto}
*/
getErc1155Contract(chain: enums.VyChain, contractAddress: string): VyPromise<token.VyErc1155ContractDto>;
/**
* This endpoint allows you to archive a contract. When you archive an NFT contract, it will be removed from all API responses, rendering it inaccessible via any API calls. Furthermore, you will lose the ability to create new token-types under the deleted contract. All token-types and minted NFTs associated with the archived contract will also be archived and cannot be accessed via API calls. However, the NFT contract will remain on the blockchain.
* @param {VyChain} chain - The blockchain of the contract.
* @param {string} contractAddress - The contract address that you want to delete.
*/
archiveErc1155Contract(chain: enums.VyChain, contractAddress: string): VyPromise<Any>;
/**
* This endpoint fetches the details of a specific token by tokenId.
* @param {string} contractAddress - The contract address.
* @param {number} tokenId - The `id` of the token whose details you want to fetch.
* @param {VyChain} chain - The blockchain of the contract.
* @returns {VyErc1155TokenDto}
*/
getErc1155Token(contractAddress: string, tokenId: number, chain: enums.VyChain): VyPromise<token.VyErc1155TokenDto>;
/**
* This endpoint is used to archive a token by `tokenId`. The archived token will continue to exist on-chain but it will not be returned in API calls anymore.
* @param {VyChain} chain - The blockchain of the contract/token.
* @param {string} contractAddress - The token's contract address.
* @param {number} tokenId - The `Id` of the token you want to archive.
*/
archiveErc1155Token(chain: enums.VyChain, contractAddress: string, tokenId: number): VyPromise<Any>;
/**
* This endpoint fetches the details of a specific token-type by `tokenTypeId`.
* @param {VyChain} chain - The blockchain of the contract.
* @param {string} contractAddress - The contract address
* @param {number} tokenTypeId - This is the `id` of the token-type.
* @returns {VyErc1155TokenTypeDto}
*/
getErc1155TokenType(chain: enums.VyChain, contractAddress: string, tokenTypeId: number): VyPromise<token.VyErc1155TokenTypeDto>;
/**
* This endpoint archives a token type, removing it from all API responses and making it inaccessible through API calls. Once archived, you will no longer be able to mint new NFTs under this token type. Additionally, all NFTs associated with the archived token type will also be archived and cannot be accessed via API calls.
* @param {VyChain} chain -
* @param {string} contractAddress - The contract address.
* @param {number} tokenTypeId - The `id` of the token-type that you want to archive.
*/
deleteErc1155TokenType(chain: enums.VyChain, contractAddress: string, tokenTypeId: number): VyPromise<Any>;
/**
* This endpoint fetches the details of a specific SUI token-type by `tokenTypeId`.
* @param {string} chain - The blockchain of the contract.
* @param {string} contractAddress - The contract address
* @param {number} tokenTypeId - This is the `id` of the token-type.
* @returns {VyErc1155TokenTypeDto}
*/
getSuiTokenType(chain: string, contractAddress: string, tokenTypeId: number): VyPromise<token.VyErc1155TokenTypeDto>;
/**
* This endpoint archives a SUI token type, removing it from all API responses and making it inaccessible through API calls. Once archived, you will no longer be able to mint new NFTs under this token type. Additionally, all NFTs associated with the archived token type will also be archived and cannot be accessed via API calls.
* @param {string} chain -
* @param {string} contractAddress - The contract address.
* @param {number} tokenTypeId - The `id` of the token-type that you want to archive.
*/
archiveSuiTokenType(chain: string, contractAddress: string, tokenTypeId: number): VyPromise<Any>;
/**
* This endpoint is used to check the current health of the **NFT-API**. It returns the API health status as either **UP** or **DOWN**.
* @returns {VyTokenApiHealthDto}
*/
checkHealthTokenAPI(): VyPromise<token.VyTokenApiHealthDto>;
/**
* This endpoint is used to retreive the supported chains for the Token API.
* @returns {VyChain[]}
*/
getSupportedErc20Chains(): VyPromise<enums.VyChain[]>;
/**
* This endpoint is used to create an ERC20 contract.
* @param {VyCreateErc20ContractRequest} reqParams - Request data for the operation
* @returns {VyDeployedErc20ContractDto}
*/
createErc20Contract(reqParams: token.VyCreateErc20ContractRequest): VyPromise<token.VyDeployedErc20ContractDto>;
/**
* This endpoint is used to check the status of the token contract creation request.
* @param {string} deploymentId - To track the status of a token contract creation. It is in the response body of the create contract endpoint as `result.id`.
* @returns {VyDeployedErc20ContractDto}
*/
getDeployedErc20Contract(deploymentId: string): VyPromise<token.VyDeployedErc20ContractDto>;
/**
* This endpoint is used to mint and send ERC20 tokens.
* @param {VyMintErc20TokensRequest} reqParams - Request data for the operation
* @returns {VyMintErc20TokensResultDto}
*/
mintErc20Tokens(reqParams: token.VyMintErc20TokensRequest): VyPromise<token.VyMintErc20TokensResultDto>;
/**
* This endpoint is used to retrieve all of your ERC20 token mint requests.
* @param {VyQuery_GetErc20TokenMints} query - Query to filter the operation results
* @returns {VyErc20TokenMintSummaryDto[]}
*/
getErc20TokenMints(query?: token.VyQuery_GetErc20TokenMints): VyPromise<token.VyErc20TokenMintSummaryDto[]>;
/**
* This endpoint is used to check the status of a token mint request.
* @param {string} mintId - To track the status of token mint. It is in the response body of the mint tokens endpoint as `result.mints.id`.
* @returns {VyErc20TokenMintDto}
*/
getErc20TokenMint(mintId: string): VyPromise<token.VyErc20TokenMintDto>;
/**
* This endpoint fetches all of your token contracts.
* @param {VyQuery_GetErc20Contracts} query - Query to filter the operation results
* @returns {VyErc20TokenContractDto[]}
*/
getErc20Contracts(query?: token.VyQuery_GetErc20Contracts): VyPromise<token.VyErc20TokenContractDto[]>;
/**
* This endpoint is used to get a specific token contract by blockchain and contract address.
* @param {VyChain} chain - The blockchain of the token contract.
* @param {string} contractAddress - The token contract address whose details you want to fetch.
* @returns {VyErc20TokenContractDto}
*/
getErc20Contract(chain: enums.VyChain, contractAddress: string): VyPromise<token.VyErc20TokenContractDto>;
/**
* This endpoint allows you to archive an ERC20 contract. When you archive an ERC20 contract, it will be removed from all API responses, rendering it inaccessible via any API calls. Furthermore, you cannot mint new tokens under the archived contract. All minted ERC20 tokens associated with the archived contract will also be archived and cannot be accessed via API calls. However, the ERC20 contract will remain on the blockchain.
* @param {VyChain} chain - The blockchain of the token contract.
* @param {string} contractAddress - The token contract address that you want to delete.
*/
archiveErc20Contract(chain: enums.VyChain, contractAddress: string): VyPromise<Any>;
/**
* This endpoint is used to update the owner of a token contract.
* @param {VyChain} chain -
* @param {string} contractAddress -
* @param {VyUpdateErc20ContractOwnerRequest} reqParams - Request data for the operation
* @returns {VyTransactionHashResultDto}
*/
updateErc20ContractOwner(chain: enums.VyChain, contractAddress: string, reqParams: token.VyUpdateErc20ContractOwnerRequest): VyPromise<shared.VyTransactionHashResultDto>;
}
//# sourceMappingURL=VyTokenAPI.generated.d.ts.map