@silvana-one/api/dist/node/client/sdk.gen.d.ts

Silvana API

import type { Options as ClientOptions, TDataShape, Client } from './client/index.js';
import type { LaunchNftCollectionData, LaunchNftCollectionResponses, LaunchNftCollectionErrors, LaunchTokenData, LaunchTokenResponses, LaunchTokenErrors, GetContractInfoData, GetContractInfoResponses, GetContractInfoErrors, GetNftInfoData, GetNftInfoResponses, GetNftInfoErrors, GetNftV2InfoData, GetNftV2InfoResponses, GetNftV2InfoErrors, FaucetData, FaucetResponses, FaucetErrors, GetTokenInfoData, GetTokenInfoResponses, GetTokenInfoErrors, GetTokenBalanceData, GetTokenBalanceResponses, GetTokenBalanceErrors, GetNonceData, GetNonceResponses, GetNonceErrors, GetTokenHoldersData, GetTokenHoldersResponses, GetTokenHoldersErrors, GetTransactionsData, GetTransactionsResponses, GetTransactionsErrors, ProveData, ProveResponses, ProveErrors, GetProofData, GetProofResponses, GetProofErrors, SendTransactionData, SendTransactionResponses, SendTransactionErrors, TxStatusData, TxStatusResponses, TxStatusErrors, MintTokensData, MintTokensResponses, MintTokensErrors, MintNftData, MintNftResponses, MintNftErrors, TransferNftData, TransferNftResponses, TransferNftErrors, CmsStoreNftData, CmsStoreNftResponses, CmsStoreNftErrors, CmsReadNftData, CmsReadNftResponses, CmsReadNftErrors, CmsReserveNftData, CmsReserveNftResponses, CmsReserveNftErrors, ApproveNftData, ApproveNftResponses, ApproveNftErrors, SellNftData, SellNftResponses, SellNftErrors, BuyNftData, BuyNftResponses, BuyNftErrors, TransferTokensData, TransferTokensResponses, TransferTokensErrors, AirdropTokensData, AirdropTokensResponses, AirdropTokensErrors, RedeemTokensData, RedeemTokensResponses, RedeemTokensErrors, BurnTokensData, BurnTokensResponses, BurnTokensErrors, TokenBidData, TokenBidResponses, TokenBidErrors, TokenOfferData, TokenOfferResponses, TokenOfferErrors, BuyTokensData, BuyTokensResponses, BuyTokensErrors, SellTokensData, SellTokensResponses, SellTokensErrors, WithdrawTokenBidData, WithdrawTokenBidResponses, WithdrawTokenBidErrors, WithdrawTokenOfferData, WithdrawTokenOfferResponses, WithdrawTokenOfferErrors, UpdateTokenBidWhitelistData, UpdateTokenBidWhitelistResponses, UpdateTokenBidWhitelistErrors, UpdateTokenOfferWhitelistData, UpdateTokenOfferWhitelistResponses, UpdateTokenOfferWhitelistErrors, UpdateTokenAdminWhitelistData, UpdateTokenAdminWhitelistResponses, UpdateTokenAdminWhitelistErrors } from './types.gen.js';
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
    /**
     * You can provide a client instance returned by `createClient()` instead of
     * individual options. This might be also useful if you want to implement a
     * custom client.
     */
    client?: Client;
    /**
     * You can pass arbitrary values through the `meta` object. This can be
     * used to access values that aren't defined as part of the SDK function.
     */
    meta?: Record<string, unknown>;
};
/**
 * Deploy a new NFT Collection contract.
 * The `launch` endpoint is used to deploy a new NFT Collection on the Mina blockchain.
 * It allows users to create a new NFT Collection with customizable parameters.
 *
 */
export declare const launchNftCollection: <ThrowOnError extends boolean = false>(options: Options<LaunchNftCollectionData, ThrowOnError>) => import("./client/types.js").RequestResult<LaunchNftCollectionResponses, LaunchNftCollectionErrors, ThrowOnError, "fields">;
/**
 * Deploy a new fungible token contract.
 * The `launch` endpoint is used to deploy a new fungible token on the Mina blockchain.
 * It allows users to create a new token with customizable parameters such as symbol,
 * decimals, URI, and admin contract type (standard or advanced).
 *
 */
export declare const launchToken: <ThrowOnError extends boolean = false>(options: Options<LaunchTokenData, ThrowOnError>) => import("./client/types.js").RequestResult<LaunchTokenResponses, LaunchTokenErrors, ThrowOnError, "fields">;
/**
 * Retrieve contract info
 * Retrieves detailed information about a contract.
 */
export declare const getContractInfo: <ThrowOnError extends boolean = false>(options: Options<GetContractInfoData, ThrowOnError>) => import("./client/types.js").RequestResult<GetContractInfoResponses, GetContractInfoErrors, ThrowOnError, "fields">;
/**
 * Retrieve NFT Info for Mina NFT V3
 * Retrieves detailed information about a Mina NFT V3 (NFT standard).
 */
export declare const getNftInfo: <ThrowOnError extends boolean = false>(options: Options<GetNftInfoData, ThrowOnError>) => import("./client/types.js").RequestResult<GetNftInfoResponses, GetNftInfoErrors, ThrowOnError, "fields">;
/**
 * Retrieve NFT Info for Mina NFT V2
 * Retrieves detailed information about a Mina NFT V2.
 */
export declare const getNftV2Info: <ThrowOnError extends boolean = false>(options: Options<GetNftV2InfoData, ThrowOnError>) => import("./client/types.js").RequestResult<GetNftV2InfoResponses, GetNftV2InfoErrors, ThrowOnError, "fields">;
/**
 * Request Funds from Faucet
 * Requests funds from the faucet for testing purposes.
 */
export declare const faucet: <ThrowOnError extends boolean = false>(options: Options<FaucetData, ThrowOnError>) => import("./client/types.js").RequestResult<FaucetResponses, FaucetErrors, ThrowOnError, "fields">;
/**
 * Retrieve information about a fungible token.
 * The `info` endpoint retrieves detailed information about a specific fungible token deployed on the Mina blockchain.
 *
 */
export declare const getTokenInfo: <ThrowOnError extends boolean = false>(options: Options<GetTokenInfoData, ThrowOnError>) => import("./client/types.js").RequestResult<GetTokenInfoResponses, GetTokenInfoErrors, ThrowOnError, "fields">;
/**
 * Retrieve the balance of a specific token for an address.
 * The `balance` endpoint retrieves the balance of a specific fungible token for a given Mina address.
 *
 */
export declare const getTokenBalance: <ThrowOnError extends boolean = false>(options: Options<GetTokenBalanceData, ThrowOnError>) => import("./client/types.js").RequestResult<GetTokenBalanceResponses, GetTokenBalanceErrors, ThrowOnError, "fields">;
/**
 * Retrieve the nonce for an address
 * The `nonce` endpoint retrieves the nonce for a given Mina address, taking into account the pending transactions.
 *
 */
export declare const getNonce: <ThrowOnError extends boolean = false>(options: Options<GetNonceData, ThrowOnError>) => import("./client/types.js").RequestResult<GetNonceResponses, GetNonceErrors, ThrowOnError, "fields">;
/**
 * Retrieve the holders of a token
 * The `holders` endpoint retrieves the holders of a token.
 *
 */
export declare const getTokenHolders: <ThrowOnError extends boolean = false>(options: Options<GetTokenHoldersData, ThrowOnError>) => import("./client/types.js").RequestResult<GetTokenHoldersResponses, GetTokenHoldersErrors, ThrowOnError, "fields">;
/**
 * Retrieve the transactions of a address
 * The `transactions` endpoint retrieves the transactions of a address.
 *
 */
export declare const getTransactions: <ThrowOnError extends boolean = false>(options: Options<GetTransactionsData, ThrowOnError>) => import("./client/types.js").RequestResult<GetTransactionsResponses, GetTransactionsErrors, ThrowOnError, "fields">;
/**
 * Generate proofs for signed token transactions.
 * The `prove` endpoint initiates the proof generation process for a set of signed token transactions.
 * It returns a job ID which can be used to check the status and retrieve the proofs or tx hashes using the `/proof` endpoint.
 *
 */
export declare const prove: <ThrowOnError extends boolean = false>(options: Options<ProveData, ThrowOnError>) => import("./client/types.js").RequestResult<ProveResponses, ProveErrors, ThrowOnError, "fields">;
/**
 * Check the status of a proof generation job and retrieve proofs.
 * The `proof` endpoint allows you to check the status of a proof generation job initiated via the `/prove` endpoint.
 * It returns the status of the job and the proofs or tx hashes if they are ready.
 *
 */
export declare const getProof: <ThrowOnError extends boolean = false>(options: Options<GetProofData, ThrowOnError>) => import("./client/types.js").RequestResult<GetProofResponses, GetProofErrors, ThrowOnError, "fields">;
/**
 * Send a transaction to the Mina blockchain.
 * The `send` endpoint allows you to send a transaction to the Mina blockchain.
 *
 */
export declare const sendTransaction: <ThrowOnError extends boolean = false>(options: Options<SendTransactionData, ThrowOnError>) => import("./client/types.js").RequestResult<SendTransactionResponses, SendTransactionErrors, ThrowOnError, "fields">;
/**
 * Retrieve the status of a transaction by its hash.
 * The `tx-status` endpoint allows you to check the current status of a transaction on the Mina blockchain by providing the transaction hash. It returns whether the transaction has been applied, failed, or is still pending.
 *
 */
export declare const txStatus: <ThrowOnError extends boolean = false>(options: Options<TxStatusData, ThrowOnError>) => import("./client/types.js").RequestResult<TxStatusResponses, TxStatusErrors, ThrowOnError, "fields">;
/**
 * Mint new tokens to a specified address.
 * The `mint` endpoint allows authorized users to mint new tokens of a fungible token on the Mina blockchain.
 * This transaction increases the total supply of the token by creating new tokens and assigning them to a specified address.
 * The sender must have the authority to mint tokens, typically the admin of the token contract.
 *
 */
export declare const mintTokens: <ThrowOnError extends boolean = false>(options: Options<MintTokensData, ThrowOnError>) => import("./client/types.js").RequestResult<MintTokensResponses, MintTokensErrors, ThrowOnError, "fields">;
/**
 * Mint new NFT to a specified address.
 * The `mint` endpoint allows authorized users to mint new NFT on the Mina blockchain.
 * This transaction creates new NFT.
 * The sender must have the authority to mint NFTs, typically the admin of the NFT contract.
 *
 */
export declare const mintNft: <ThrowOnError extends boolean = false>(options: Options<MintNftData, ThrowOnError>) => import("./client/types.js").RequestResult<MintNftResponses, MintNftErrors, ThrowOnError, "fields">;
/**
 * Transfer NFT to a specified address.
 * The `transfer` endpoint allows authorized users to transfer NFT on the Mina blockchain.
 * The sender must have the authority to transfer NFTs, being the owner or approved address of the NFT.
 *
 */
export declare const transferNft: <ThrowOnError extends boolean = false>(options: Options<TransferNftData, ThrowOnError>) => import("./client/types.js").RequestResult<TransferNftResponses, TransferNftErrors, ThrowOnError, "fields">;
/**
 * Store on-demand NFT in CMS
 * The `store` endpoint allows collection creators to store on-demand NFT in CMS.
 *
 */
export declare const cmsStoreNft: <ThrowOnError extends boolean = false>(options: Options<CmsStoreNftData, ThrowOnError>) => import("./client/types.js").RequestResult<CmsStoreNftResponses, CmsStoreNftErrors, ThrowOnError, "fields">;
/**
 * Read on-demand NFT from CMS
 * The `read` endpoint allows collection creators to read on-demand NFT from CMS.
 *
 */
export declare const cmsReadNft: <ThrowOnError extends boolean = false>(options: Options<CmsReadNftData, ThrowOnError>) => import("./client/types.js").RequestResult<CmsReadNftResponses, CmsReadNftErrors, ThrowOnError, "fields">;
/**
 * Reserve or remove reserve of on-demand NFT in CMS
 * The `reserve` endpoint allows collection admins to reserve or remove reserve of on-demand NFT in CMS.
 *
 */
export declare const cmsReserveNft: <ThrowOnError extends boolean = false>(options: Options<CmsReserveNftData, ThrowOnError>) => import("./client/types.js").RequestResult<CmsReserveNftResponses, CmsReserveNftErrors, ThrowOnError, "fields">;
/**
 * Approve a specified address to transfer NFT.
 * The `approve` endpoint allows authorized users to approve a specified address to transfer NFT.
 * The sender must have the authority to approve NFTs, being the owner of the NFT.
 *
 */
export declare const approveNft: <ThrowOnError extends boolean = false>(options: Options<ApproveNftData, ThrowOnError>) => import("./client/types.js").RequestResult<ApproveNftResponses, ApproveNftErrors, ThrowOnError, "fields">;
/**
 * Sell NFT at a specified price by creating a Offer contract.
 * The `sell` endpoint allows authorized users to sell NFT on the Mina blockchain.
 * The sender must have the authority to sell NFTs, being the owner of the NFT or approved address.
 *
 */
export declare const sellNft: <ThrowOnError extends boolean = false>(options: Options<SellNftData, ThrowOnError>) => import("./client/types.js").RequestResult<SellNftResponses, SellNftErrors, ThrowOnError, "fields">;
/**
 * Buy NFT.
 * The `buy` endpoint allows authorized users to buy NFT on the Mina blockchain.
 *
 */
export declare const buyNft: <ThrowOnError extends boolean = false>(options: Options<BuyNftData, ThrowOnError>) => import("./client/types.js").RequestResult<BuyNftResponses, BuyNftErrors, ThrowOnError, "fields">;
/**
 * Transfer tokens from one address to another.
 * The `transfer` endpoint allows users to transfer tokens of a fungible token on the Mina blockchain from one address to another.
 * The sender must have sufficient balance and appropriate permissions to perform the transfer.
 *
 */
export declare const transferTokens: <ThrowOnError extends boolean = false>(options: Options<TransferTokensData, ThrowOnError>) => import("./client/types.js").RequestResult<TransferTokensResponses, TransferTokensErrors, ThrowOnError, "fields">;
/**
 * Distribute tokens to multiple addresses via airdrop.
 * Allows users to distribute tokens to multiple addresses in a single transaction.
 * This is efficient for distributing tokens during events like token launches or community rewards.
 *
 */
export declare const airdropTokens: <ThrowOnError extends boolean = false>(options: Options<AirdropTokensData, ThrowOnError>) => import("./client/types.js").RequestResult<AirdropTokensResponses, AirdropTokensErrors, ThrowOnError, "fields">;
/**
 * Redeem tokens for a MINA (applicable for Fungible Tokens with Bonding Curve Admin)
 * The `redeem` endpoint allows users to redeem tokens of a fungible token on the Mina blockchain for a MINA.
 * The sender must have sufficient balance and appropriate permissions to perform the transfer.
 *
 */
export declare const redeemTokens: <ThrowOnError extends boolean = false>(options: Options<RedeemTokensData, ThrowOnError>) => import("./client/types.js").RequestResult<RedeemTokensResponses, RedeemTokensErrors, ThrowOnError, "fields">;
/**
 * Burn tokens from one address.
 * The `burn` endpoint allows users to burn tokens of a fungible token on the Mina blockchain from one address.
 * The sender must have sufficient balance and appropriate permissions to perform the burn.
 *
 */
export declare const burnTokens: <ThrowOnError extends boolean = false>(options: Options<BurnTokensData, ThrowOnError>) => import("./client/types.js").RequestResult<BurnTokensResponses, BurnTokensErrors, ThrowOnError, "fields">;
/**
 * Place a bid on a token
 * Allows users to place a bid on an token.
 *
 */
export declare const tokenBid: <ThrowOnError extends boolean = false>(options: Options<TokenBidData, ThrowOnError>) => import("./client/types.js").RequestResult<TokenBidResponses, TokenBidErrors, ThrowOnError, "fields">;
/**
 * Create an offer to sell tokens at a specified price.
 * Allows users to create an offer to sell a specified amount of tokens at a given price.
 *
 */
export declare const tokenOffer: <ThrowOnError extends boolean = false>(options: Options<TokenOfferData, ThrowOnError>) => import("./client/types.js").RequestResult<TokenOfferResponses, TokenOfferErrors, ThrowOnError, "fields">;
/**
 * Purchase tokens from an existing offer.
 * Allows users to purchase tokens from an existing offer on the Mina blockchain.
 * This endpoint facilitates the transaction where tokens are transferred from the offer address to the buyer's address in exchange for the specified price.
 *
 */
export declare const buyTokens: <ThrowOnError extends boolean = false>(options: Options<BuyTokensData, ThrowOnError>) => import("./client/types.js").RequestResult<BuyTokensResponses, BuyTokensErrors, ThrowOnError, "fields">;
/**
 * Sell a token to the Bid contract.
 * Allows token owners to sell their tokens to the Bid contract.
 *
 */
export declare const sellTokens: <ThrowOnError extends boolean = false>(options: Options<SellTokensData, ThrowOnError>) => import("./client/types.js").RequestResult<SellTokensResponses, SellTokensErrors, ThrowOnError, "fields">;
/**
 * Withdraw a previously placed bid on an token.
 * Allows users to withdraw a bid they have previously placed using the `/bid` endpoint.
 * This transaction cancels the active bid, releasing any locked funds.
 *
 */
export declare const withdrawTokenBid: <ThrowOnError extends boolean = false>(options: Options<WithdrawTokenBidData, ThrowOnError>) => import("./client/types.js").RequestResult<WithdrawTokenBidResponses, WithdrawTokenBidErrors, ThrowOnError, "fields">;
/**
 * Withdraw a previously made offer to sell a token.
 * Allows users to withdraw an offer they have previously made using the `/offer` endpoint.
 * This transaction cancels the active offer, releasing any locked tokens.
 *
 */
export declare const withdrawTokenOffer: <ThrowOnError extends boolean = false>(options: Options<WithdrawTokenOfferData, ThrowOnError>) => import("./client/types.js").RequestResult<WithdrawTokenOfferResponses, WithdrawTokenOfferErrors, ThrowOnError, "fields">;
/**
 * Update the bid whitelist
 * Allows administrators to update the whitelist of addresses permitted to interact with the Bid contract.
 * This is essential for managing participation in bidding processes, especially for controlled or private auctions.
 *
 */
export declare const updateTokenBidWhitelist: <ThrowOnError extends boolean = false>(options: Options<UpdateTokenBidWhitelistData, ThrowOnError>) => import("./client/types.js").RequestResult<UpdateTokenBidWhitelistResponses, UpdateTokenBidWhitelistErrors, ThrowOnError, "fields">;
/**
 * Update the offer whitelist
 * Allows administrators to update the whitelist of addresses permitted to interact with the Offer contract.
 * This is essential for managing participation in offer processes, especially for controlled or private sales.
 *
 */
export declare const updateTokenOfferWhitelist: <ThrowOnError extends boolean = false>(options: Options<UpdateTokenOfferWhitelistData, ThrowOnError>) => import("./client/types.js").RequestResult<UpdateTokenOfferWhitelistResponses, UpdateTokenOfferWhitelistErrors, ThrowOnError, "fields">;
/**
 * Update the advanced admin whitelist
 * Allows administrators to update the whitelist of admin contracts.
 *
 */
export declare const updateTokenAdminWhitelist: <ThrowOnError extends boolean = false>(options: Options<UpdateTokenAdminWhitelistData, ThrowOnError>) => import("./client/types.js").RequestResult<UpdateTokenAdminWhitelistResponses, UpdateTokenAdminWhitelistErrors, ThrowOnError, "fields">;