Options
All
  • Public
  • Public/Protected
  • All
Menu

@tatumio/tatum - v1.37.56

Index

Enumerations

Classes

Interfaces

Variables

Functions

Variables

Const ADA_DERIVATION_PATH

ADA_DERIVATION_PATH: "m/1852'/1815'/0'" = 'm/1852\'/1815\'/0\''

Const ADA_DERIVATION_SCHEME

ADA_DERIVATION_SCHEME: 2 = 2

Const ARB_BASED_CURRENCIES

ARB_BASED_CURRENCIES: string[] = ...

Const ARB_CURRENCIES

ARB_CURRENCIES: string[] = ...

Const BASE_BASED_CURRENCIES

BASE_BASED_CURRENCIES: string[] = ...

Const BASE_CURRENCIES

BASE_CURRENCIES: string[] = ...

Const BCH_DERIVATION_PATH

BCH_DERIVATION_PATH: "m/44'/145'/0'/0" = 'm/44\'/145\'/0\'/0'

Const BEP20_CURRENCIES

BEP20_CURRENCIES: string[] = ...

Const BSC_BASED_CURRENCIES

BSC_BASED_CURRENCIES: string[] = ...

Const BTC_DERIVATION_PATH

BTC_DERIVATION_PATH: "m/44'/0'/0'/0" = 'm/44\'/0\'/0\'/0'

Const CELO_BASED_CURRENCIES

CELO_BASED_CURRENCIES: string[] = ...

Const CELO_DERIVATION_PATH

CELO_DERIVATION_PATH: "m/44'/52752'/0'/0" = 'm/44\'/52752\'/0\'/0'

Const CEUR_ADDRESS_MAINNET

CEUR_ADDRESS_MAINNET: "0xd8763cba276a3738e6de85b4b3bf5fded6d6ca73" = '0xd8763cba276a3738e6de85b4b3bf5fded6d6ca73'

Const CEUR_ADDRESS_TESTNET

CEUR_ADDRESS_TESTNET: "0x10c892a6ec43a53e45d0b916b4b7d383b1b78c0f" = '0x10c892a6ec43a53e45d0b916b4b7d383b1b78c0f'

Const CONTRACT_ADDRESSES

CONTRACT_ADDRESSES: { EURTENT: string; GOLDAX: string; INTENT: string } = ...

Type declaration

  • EURTENT: string
  • GOLDAX: string
  • INTENT: string

Const CONTRACT_DECIMALS

CONTRACT_DECIMALS: { EURTENT: number; GOLDAX: number; INTENT: number } = ...

Type declaration

  • EURTENT: number
  • GOLDAX: number
  • INTENT: number

Const CUSD_ADDRESS_MAINNET

CUSD_ADDRESS_MAINNET: "0x765de816845861e75a25fca122bb6898b8b1282a" = '0x765de816845861e75a25fca122bb6898b8b1282a'

Const CUSD_ADDRESS_TESTNET

CUSD_ADDRESS_TESTNET: "0x874069fa1eb16d44d622f2e0ca25eea172369bc1" = '0x874069fa1eb16d44d622f2e0ca25eea172369bc1'

Const CUSTODIAL_PROXY_ABI

CUSTODIAL_PROXY_ABI: { inputs: { internalType: string; name: string; type: string }[]; name: string; outputs: never[]; stateMutability: string; type: string } = ...

Type declaration

  • inputs: { internalType: string; name: string; type: string }[]
  • name: string
  • outputs: never[]
  • stateMutability: string
  • type: string

Const DOGE_DERIVATION_PATH

DOGE_DERIVATION_PATH: "m/44'/3'/0'/0" = 'm/44\'/3\'/0\'/0'

Const DOGE_NETWORK

DOGE_NETWORK: { bech32: string; bip32: { private: number; public: number }; messagePrefix: string; pubKeyHash: number; scriptHash: number; wif: number } = ...

Type declaration

  • bech32: string
  • bip32: { private: number; public: number }
    • private: number
    • public: number
  • messagePrefix: string
  • pubKeyHash: number
  • scriptHash: number
  • wif: number

Const DOGE_TEST_NETWORK

DOGE_TEST_NETWORK: { bech32: string; bip32: { private: number; public: number }; messagePrefix: string; pubKeyHash: number; scriptHash: number; wif: number } = ...

Type declaration

  • bech32: string
  • bip32: { private: number; public: number }
    • private: number
    • public: number
  • messagePrefix: string
  • pubKeyHash: number
  • scriptHash: number
  • wif: number

Const EGLD_DERIVATION_PATH

EGLD_DERIVATION_PATH: "m/44'/508'/0'/0'" = 'm/44\'/508\'/0\'/0\''

Const ERC20_CURRENCIES

ERC20_CURRENCIES: string[] = ...

Const ESDT_SYSTEM_SMART_CONTRACT_ADDRESS

ESDT_SYSTEM_SMART_CONTRACT_ADDRESS: "erd1qqqqqqqqqqqqqqqpqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqzllls8a5w6u" = 'erd1qqqqqqqqqqqqqqqpqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqzllls8a5w6u'

Const ETH_BASED_CURRENCIES

ETH_BASED_CURRENCIES: string[] = ...

Const ETH_DERIVATION_PATH

ETH_DERIVATION_PATH: "m/44'/60'/0'/0" = 'm/44\'/60\'/0\'/0'

Const FLOW_DERIVATION_PATH

FLOW_DERIVATION_PATH: "m/44'/539'/0'/0" = 'm/44\'/539\'/0\'/0'

Const FLOW_MAINNET_ADDRESSES

FLOW_MAINNET_ADDRESSES: { FUSD: string; FlowToken: string; FungibleToken: string; TatumMultiNFT: string } = ...

Type declaration

  • FUSD: string
  • FlowToken: string
  • FungibleToken: string
  • TatumMultiNFT: string

Const FLOW_TESTNET_ADDRESSES

FLOW_TESTNET_ADDRESSES: { FUSD: string; FlowToken: string; FungibleToken: string; TatumMultiNFT: string } = ...

Type declaration

  • FUSD: string
  • FlowToken: string
  • FungibleToken: string
  • TatumMultiNFT: string

Const HARDENED_THRESHOLD

HARDENED_THRESHOLD: 2147483648 = 0x80000000

Const KLAYTN_DERIVATION_PATH

KLAYTN_DERIVATION_PATH: "m/44'/8217'/0'/0" = 'm/44\'/8217\'/0\'/0'

Const LTC_DERIVATION_PATH

LTC_DERIVATION_PATH: "m/44'/2'/0'/0" = 'm/44\'/2\'/0\'/0'

Const LTC_NETWORK

LTC_NETWORK: { bech32: string; bip32: { private: number; public: number }; messagePrefix: string; pubKeyHash: number; scriptHash: number; wif: number } = ...

Type declaration

  • bech32: string
  • bip32: { private: number; public: number }
    • private: number
    • public: number
  • messagePrefix: string
  • pubKeyHash: number
  • scriptHash: number
  • wif: number

Const LTC_TEST_NETWORK

LTC_TEST_NETWORK: { bech32: string; bip32: { private: number; public: number }; messagePrefix: string; pubKeyHash: number; scriptHash: number; wif: number } = ...

Type declaration

  • bech32: string
  • bip32: { private: number; public: number }
    • private: number
    • public: number
  • messagePrefix: string
  • pubKeyHash: number
  • scriptHash: number
  • wif: number

Const LYRA_NETWORK

LYRA_NETWORK: { bech32: string; bip32: { private: number; public: number }; messagePrefix: string; pubKeyHash: number; scriptHash: number; wif: number } = ...

Type declaration

  • bech32: string
  • bip32: { private: number; public: number }
    • private: number
    • public: number
  • messagePrefix: string
  • pubKeyHash: number
  • scriptHash: number
  • wif: number

Const LYRA_TEST_NETWORK

LYRA_TEST_NETWORK: { bech32: string; bip32: { private: number; public: number }; messagePrefix: string; pubKeyHash: number; scriptHash: number; wif: number } = ...

Type declaration

  • bech32: string
  • bip32: { private: number; public: number }
    • private: number
    • public: number
  • messagePrefix: string
  • pubKeyHash: number
  • scriptHash: number
  • wif: number

Const MATIC20_CURRENCIES

MATIC20_CURRENCIES: string[] = ...

Const MATIC_BASED_CURRENCIES

MATIC_BASED_CURRENCIES: string[] = ...

Const MATIC_DERIVATION_PATH

MATIC_DERIVATION_PATH: "m/44'/966'/0'/0" = 'm/44\'/966\'/0\'/0'

Const ONE_DERIVATION_PATH

ONE_DERIVATION_PATH: "m/44'/1023'/0'/0" = 'm/44\'/1023\'/0\'/0'

Const OPTIMISM_BASED_CURRENCIES

OPTIMISM_BASED_CURRENCIES: string[] = ...

Const OPTIMISM_CURRENCIES

OPTIMISM_CURRENCIES: string[] = ...

Const RIPPLE_EPOCH

RIPPLE_EPOCH: 946684800 = 946684800

Const TATUM_API_URL

TATUM_API_URL: "https://api.tatum.io" = 'https://api.tatum.io'

Const TATUM_RETRIES

TATUM_RETRIES: 5 = 5

Const TATUM_RETRY_DELAY

TATUM_RETRY_DELAY: 1000 = 1000

Const TESTNET_DERIVATION_PATH

TESTNET_DERIVATION_PATH: "m/44'/1'/0'/0" = 'm/44\'/1\'/0\'/0'

Const TEST_VET_URL

TEST_VET_URL: "https://sync-testnet.vechain.org/" = 'https://sync-testnet.vechain.org/'

Const TRANSFER_METHOD_ABI

TRANSFER_METHOD_ABI: { constant: boolean; inputs: { name: string; type: string }[]; name: string; outputs: { name: string; type: string }[]; payable: boolean; stateMutability: string; type: string } = ...

Type declaration

  • constant: boolean
  • inputs: { name: string; type: string }[]
  • name: string
  • outputs: { name: string; type: string }[]
  • payable: boolean
  • stateMutability: string
  • type: string

Const TRON_DERIVATION_PATH

TRON_DERIVATION_PATH: "m/44'/195'/0'/0" = 'm/44\'/195\'/0\'/0'

Const VET_DERIVATION_PATH

VET_DERIVATION_PATH: "m/44'/818'/0'/0" = 'm/44\'/818\'/0\'/0'

Const VET_URL

VET_URL: "https://sync-mainnet.vechain.org/" = 'https://sync-mainnet.vechain.org/'

Const XDC_DERIVATION_PATH

XDC_DERIVATION_PATH: "m/44'/550'/0'/0" = 'm/44\'/550\'/0\'/0'

Const ZERO_ADDRESS

ZERO_ADDRESS: { ZERO_ADDRESS_26_CHARS: string; ZERO_ADDRESS_42_CHARS: string; ZERO_ADDRESS_58_CHARS: string } = ...

Type declaration

  • ZERO_ADDRESS_26_CHARS: string
  • ZERO_ADDRESS_42_CHARS: string
  • ZERO_ADDRESS_58_CHARS: string

Const ethGetGasPriceInWeiWrapper

ethGetGasPriceInWeiWrapper: { ethGetGasPriceInWei: () => Promise<string> } = ...

(!) Internal function Used to be able to override it later

Type declaration

  • ethGetGasPriceInWei: () => Promise<string>
      • (): Promise<string>

      • Estimate Gas price for the transaction.

        Returns Promise<string>

Functions

Const activateAccount

  • activateAccount(id: string): Promise<void>

Const activateCustomer

  • activateCustomer(id: string): Promise<void>

Const adaBroadcast

  • adaBroadcast(txData: string, signatureId?: string): Promise<TransactionHash>

Const adaGetAccountsByAddress

  • adaGetAccountsByAddress(address: string): Promise<AdaAccount[]>

Const adaGetBlock

  • adaGetBlock(hash: string): Promise<AdaBlock>

Const adaGetBlockChainInfo

Const adaGetTransaction

Const adaGetTransactionsByAccount

  • adaGetTransactionsByAccount(address: string, pageSize?: number, offset?: number): Promise<AdaTransaction[]>

  • Returns transactions by address from Ada blockchain.

    Parameters

    • address: string

      For which address will be transactions returned.

    • pageSize: number = 50
    • offset: number = 0

      Offset to obtain the next page of data.

      For more details, see Tatum API documentation

    Returns Promise<AdaTransaction[]>

Const adaGetUtxos

  • adaGetUtxos(address: string): Promise<AdaUtxo[]>

Const adaToLovelace

  • adaToLovelace(ada: string | number): string

Const addAddressInputs

  • addAddressInputs(transactionBuilder: TransactionBuilder, fromAddresses: FromAddress[]): Promise<{ amount: BigNumber; privateKeysToSign: (undefined | string)[] }>

  • Parameters

    • transactionBuilder: TransactionBuilder
    • fromAddresses: FromAddress[]

    Returns Promise<{ amount: BigNumber; privateKeysToSign: (undefined | string)[] }>

Const addAddressInputsWithoutPrivateKey

  • addAddressInputsWithoutPrivateKey(transactionBuilder: TransactionBuilder, fromAddresses: { address: string }[]): Promise<BigNumber>

  • Parameters

    • transactionBuilder: TransactionBuilder
    • fromAddresses: { address: string }[]

    Returns Promise<BigNumber>

Const addChangeIfNeeded

  • addChangeIfNeeded(txBuilder: TransactionBuilder, changeAddress: string): void

  • Parameters

    • txBuilder: TransactionBuilder
    • changeAddress: string

    Returns void

Const addFee

  • addFee(txBuilder: TransactionBuilder, feeInLovelace: BigNumber): void

  • Parameters

    • txBuilder: TransactionBuilder
    • feeInLovelace: BigNumber

    Returns void

Const addInput

  • addInput(transactionBuilder: TransactionBuilder, utxo: AdaUtxo, address: string): void

Const addInputs

  • addInputs(transactionBuilder: TransactionBuilder, transferAdaBlockchain: TransferAdaBlockchain): Promise<{ amount: BigNumber; privateKeysToSign: (undefined | string)[] }>

  • Parameters

    Returns Promise<{ amount: BigNumber; privateKeysToSign: (undefined | string)[] }>

Const addInputsPrivateKeys

Const addOutputAda

  • addOutputAda(transactionBuilder: TransactionBuilder, address: string, amount: string | number): string

  • Parameters

    • transactionBuilder: TransactionBuilder
    • address: string
    • amount: string | number

    Returns string

Const addOutputLovelace

  • addOutputLovelace(transactionBuilder: TransactionBuilder, address: string, amount: string): void

  • Parameters

    • transactionBuilder: TransactionBuilder
    • address: string
    • amount: string

    Returns void

Const addOutputs

  • addOutputs(transactionBuilder: TransactionBuilder, tos: To[]): BigNumber

Const addUtxoInputs

  • addUtxoInputs(transactionBuilder: TransactionBuilder, fromUTXOs: FromUTXO[]): Promise<{ amount: BigNumber; privateKeysToSign: (undefined | string)[] }>

  • Parameters

    • transactionBuilder: TransactionBuilder
    • fromUTXOs: FromUTXO[]

    Returns Promise<{ amount: BigNumber; privateKeysToSign: (undefined | string)[] }>

Const algorandBroadcast

  • algorandBroadcast(txData: string, signatureId?: string): Promise<TransactionHash>

Const algorandGetAccountBalance

  • algorandGetAccountBalance(address: string): Promise<BigNumber>

Const algorandGetBlock

  • algorandGetBlock(roundNumber: string): Promise<AlgoBlock>

Const algorandGetCurrentBlock

  • algorandGetCurrentBlock(): Promise<number>

Const algorandGetTransaction

  • algorandGetTransaction(txid: string): Promise<AlgoTx>

Const algorandGetTransactionsCount

  • algorandGetTransactionsCount(address: string): Promise<number>

Const assignDepositAddress

  • assignDepositAddress(id: string, address: string): Promise<Address>

Const bcashBroadcast

  • bcashBroadcast(txData: string, signatureId?: string): Promise<TransactionHash>

Const bcashGetBlock

  • bcashGetBlock(hash: string): Promise<BchBlock>

Const bcashGetBlockHash

  • bcashGetBlockHash(i: number): Promise<BlockHash>

Const bcashGetCurrentBlock

  • bcashGetCurrentBlock(): Promise<BchInfo>

Const bcashGetTransaction

  • bcashGetTransaction(hash: string): Promise<BchTx>

Const bcashGetTxForAccount

  • bcashGetTxForAccount(address: string, skip?: number): Promise<BchTx[]>

  • Returns transactions for address from Bch blockchain.

    Parameters

    • address: string

      For which address will be transactions returned.

    • skip: number = 0

      Offset how many transactions will be skipped.

      For more details, see Tatum API documentation

    Returns Promise<BchTx[]>

Const blockAmount

  • blockAmount(id: string, block: BlockAmount): Promise<{ id: string }>

Const bnbBroadcast

  • bnbBroadcast(txData: string, signatureId?: string): Promise<TransactionHash>

Const bnbGetAccount

  • bnbGetAccount(address: string): Promise<{ account_number: number; address: string; sequence: number }>

  • Returns account by address from Bnb blockchain.
    For more details, see Tatum API documentation

    Parameters

    • address: string

    Returns Promise<{ account_number: number; address: string; sequence: number }>

Const bscBroadcast

  • bscBroadcast(txData: string, signatureId?: string): Promise<TransactionHash>

Const bscEstimateGas

Const bscGetAccountBalance

  • bscGetAccountBalance(address: string): Promise<BigNumber>

Const bscGetAccountBep20Address

  • bscGetAccountBep20Address(address: string, contractAddress: string): Promise<number>

Const bscGetBlock

  • bscGetBlock(hash: string): Promise<EthBlock>

Const bscGetCurrentBlock

  • bscGetCurrentBlock(): Promise<number>

Const bscGetGasPriceInWei

  • bscGetGasPriceInWei(): Promise<string>

Const bscGetTransaction

  • bscGetTransaction(hash: string): Promise<EthTx>

Const bscGetTransactionsCount

  • bscGetTransactionsCount(address: string): Promise<number>

  • Returns a number of outgoing BSC transactions for the address from Bsc blockchain.
    When a transaction is sent, there can be multiple outgoing transactions, which are not yet processed by the blockchain. To distinguish between them, there is a counter called a nonce, which represents the order of the transaction in the list of outgoing transactions.
    For more details, see Tatum API documentation

    Parameters

    • address: string

    Returns Promise<number>

Const btcBroadcast

  • btcBroadcast(txData: string, signatureId?: string): Promise<TransactionHash>

Const btcGetBalance

  • btcGetBalance(address: string): Promise<{ incoming: string; outgoing: string }>

Const btcGetBlock

  • btcGetBlock(hash: string): Promise<BtcBlock>

Const btcGetBlockHash

  • btcGetBlockHash(i: number): Promise<BlockHash>

Const btcGetCurrentBlock

  • btcGetCurrentBlock(): Promise<BtcInfo>

Const btcGetTransaction

  • btcGetTransaction(hash: string): Promise<BtcTx>

Const btcGetTxForAccount

  • btcGetTxForAccount(address: string, pageSize?: number, offset?: number): Promise<BtcTx[]>

  • Returns transactions by address from Btc blockchain.

    Parameters

    • address: string

      For which address will be transactions returned.

    • pageSize: number = 50

      How many transactions will be returned. Max number of transactions per page is 50.

    • offset: number = 0

      Offset to obtain the next page of data.

      For more details, see Tatum API documentation

    Returns Promise<BtcTx[]>

Const btcGetUTXO

  • btcGetUTXO(hash: string, i: number): Promise<BtcUTXO>

  • Returns the UTXO of given transaction and output index from Btc blockchain.

    UTXO means Unspent Transaction Output, which in blockchain terminology means assets that a user has received at a specific address and has not yet spent. In bitcoin-like blockchains (BTC, LTC, DOGE, BCH), every transaction is built from a list of previously unspent transactions connected to the address. If a user owns address A, and receives 10 BTC in transaction T1, they can spend a UTXO T1 with a total value of 10 BTC in the next transaction. The user can spend multiple UTXOs from different addresses in one transaction.

    Parameters

    • hash: string

      Transaction hash.

    • i: number

      Index of tx output to check if it has been spent or not. For more details, see Tatum API documentation

    Returns Promise<BtcUTXO>

Const burnMultiToken

Const burnMultiTokenBatch

Const burnNFT

Const cancelExistingSubscription

  • cancelExistingSubscription(id: string): Promise<void>

Const celoBroadcast

  • celoBroadcast(txData: string, signatureId?: string): Promise<TransactionHash>

Const celoGetAccountBalance

  • celoGetAccountBalance(address: string): Promise<{ cUsd: BigNumber; celo: BigNumber }>

Const celoGetBlock

  • celoGetBlock(hash: string): Promise<Block>

Const celoGetCurrentBlock

  • celoGetCurrentBlock(): Promise<number>

Const celoGetTransaction

  • celoGetTransaction(hash: string): Promise<Transaction>

Const celoGetTransactionsCount

  • celoGetTransactionsCount(address: string): Promise<number>

  • Returns a number of outgoing transactions for the address from Celo blockchain.
    When a transaction is sent, there can be multiple outgoing transactions, which are not yet processed by the blockchain. To distinguish between them, there is a counter called a nonce, which represents the order of the transaction in the list of outgoing transactions. For more details, see Tatum API documentation

    Parameters

    • address: string

    Returns Promise<number>

Const checkAddressExists

  • checkAddressExists(address: string, currency: string, index?: number): Promise<Account>

Const checkMaliciousAddress

  • checkMaliciousAddress(address: string): Promise<{ status: string }>

Const completePendingTransactionKMS

  • completePendingTransactionKMS(id: string, txId: string): Promise<void>

Const convertAddressFromHex

  • convertAddressFromHex(address: string): any

Const convertAddressToHex

  • convertAddressToHex(address: string): any

Const countTransactionsByAccount

Const countTransactionsByCustomer

Const countTransactionsByLedger

Const createAccount

Const createAccounts

  • createAccounts(accounts: CreateAccountsBatch): Promise<Account[]>

Const createNFT

  • createNFT(testnet: boolean, body: EthMintErc721 | FlowMintNft | TronMintTrc721 | CeloMintErc721, file: Buffer, name: string, description?: string, scheme?: any, provider?: string): Promise<{ imagePublicUrl: string; imageUrl: string; metadataPublicUrl: string; metadataUrl: string; tokenId: any; txId: string }>

  • Mint new NFT token with metadata stored on the IPFS.

    Parameters

    • testnet: boolean

      if we use testnet or not

    • body: EthMintErc721 | FlowMintNft | TronMintTrc721 | CeloMintErc721

      body of the mint request

    • file: Buffer

      file to be stored on the IPFS

    • name: string

      name of the file

    • Optional description: string

      description of the file

    • Optional scheme: any

      optional JSON Metadata scheme

    • Optional provider: string

      optional provider do broadcast tx

    Returns Promise<{ imagePublicUrl: string; imageUrl: string; metadataPublicUrl: string; metadataUrl: string; tokenId: any; txId: string }>

Const createNewSubscription

Const createTronTrc10Transaction

  • Create Tron TRC10 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: CreateTronTrc10

      content of the transaction to broadcast

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const createTronTrc20Transaction

  • Create Tron TRC20 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: CreateTronTrc20

      content of the transaction to broadcast

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const createVirtualCurrency

  • createVirtualCurrency(data: CreateCurrency): Promise<Account>

Const createWitnesses

  • createWitnesses(transactionBody: TransactionBody, transferAdaBlockchain: TransferAdaBlockchain): TransactionWitnessSet

Const deactivateAccount

  • deactivateAccount(id: string): Promise<void>

Const deactivateCustomer

  • deactivateCustomer(id: string): Promise<void>

Const deleteBlockedAmount

  • deleteBlockedAmount(id: string): Promise<void>

Const deleteBlockedAmountForAccount

  • deleteBlockedAmountForAccount(id: string): Promise<void>

Const deleteBlockedAmountWithTransaction

  • deleteBlockedAmountWithTransaction(id: string, txData: BlockageTransaction): Promise<{ reference: string }>

Const deleteTransactionKMS

  • deleteTransactionKMS(id: string, revert?: boolean): Promise<void>

Const deployAuction

  • deployAuction(testnet: boolean, body: DeployNftAuction, provider?: string): Promise<unknown>

  • Deploy new smart contract for NFT auction logic. Smart contract enables auction operator to create new auction for NFT (ERC-721/1155). Operator can set a fee in percentage, which will be paid on top of the price of the asset. can be offered for native asset - ETH, BSC, etc. - or any ERC20 token - this is configurable during auction creation. Before auction is created, seller must approve transfer of the NFT to the auction contract. Buyer will bid for the asset from the auction using native asset - send assets along the gid() smart contract call, or via ERC20 token. Buyer of the auction must perform approval for the smart contract to access ERC20 token, before the actual bid() method is called. Once there is higher bid than the actual one, the previous bidder's funds will be returned to him and new bidder will be the current winning one. When auction ends, anyone can settle the auction - NFT will be sent to the bidder, assets to the seller and fee to the operator.

    Parameters

    • testnet: boolean

      chain to work with

    • body: DeployNftAuction

      request data

    • Optional provider: string

      optional provider to enter. if not present, Tatum Web3 will be used.

    Returns Promise<unknown>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const deployMarketplaceListing

  • Deploy new smart contract for NFT marketplace logic. Smart contract enables marketplace operator to create new listing for NFT (ERC-721/1155). Operator can set a fee in percentage, which will be paid on top of the price of the asset. Listing can be offered for native asset - ETH, BSC, etc. - or any ERC20 token - this is configurable during listing creation. Once the listing is created, seller must send the NFT asset to the smart contract. Buyer will buy the asset from the listing using native asset - send assets along the buyAssetFromListing() smart contract call, or via ERC20 token. Buyer of the listing must perform approval for the smart contract to access ERC20 token, before the actual buyAssetFromListing() method is called. Once both assets - from buyer and seller - are in the smart contract, NFT is sent to the buyer, price is sent to the seller and marketplace fee is set to the operator.

    Parameters

    Returns Promise<TransactionHash>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const deployMultiToken

Const deployNFT

Const disableCustomer

  • disableCustomer(id: string): Promise<void>

Const dogeBroadcast

  • dogeBroadcast(txData: string, signatureId?: string): Promise<TransactionHash>

Const dogeGetBlock

  • dogeGetBlock(hash: string): Promise<DogeBlock>

Const dogeGetBlockHash

  • dogeGetBlockHash(i: number): Promise<BlockHash>

Const dogeGetCurrentBlock

  • dogeGetCurrentBlock(): Promise<DogeInfo>

Const dogeGetTransaction

  • dogeGetTransaction(hash: string): Promise<DogeTx>

Const dogeGetUTXO

  • dogeGetUTXO(hash: string, i: number): Promise<DogeUTXO>

Const egldBroadcast

  • egldBroadcast(txData: string, signatureId?: string): Promise<TransactionHash>

Const egldEstimateGas

Const egldGetAccountBalance

  • egldGetAccountBalance(address: string): Promise<BigNumber>

Const egldGetAccountErc20Balance

  • egldGetAccountErc20Balance(address: string, tokenId: string): Promise<number>

Const egldGetBlock

  • egldGetBlock(hash: string): Promise<EgldBlock>

Const egldGetConfig

  • egldGetConfig(provider?: string): Promise<any>

  • Get Elrond network config

    Parameters

    • Optional provider: string

    Returns Promise<any>

Const egldGetCurrentBlock

  • egldGetCurrentBlock(): Promise<number>

Const egldGetGasLimit

Const egldGetGasPrice

  • egldGetGasPrice(provider?: string): Promise<number>

  • Estimate Gas price for the transaction.

    Parameters

    • Optional provider: string

    Returns Promise<number>

Const egldGetTransaction

Const egldGetTransactionsCount

  • egldGetTransactionsCount(address: string): Promise<number>

Const egldGetTxsCount

  • egldGetTxsCount(address: string, client: string): Promise<any>

Const enableCustomer

  • enableCustomer(id: string): Promise<void>

Const ethBroadcast

  • ethBroadcast(txData: string, signatureId?: string): Promise<TransactionHash>

Const ethEstimateGas

Const ethGetAccountBalance

  • ethGetAccountBalance(address: string): Promise<BigNumber>

Const ethGetAccountErc20Address

  • ethGetAccountErc20Address(address: string, contractAddress: string): Promise<{ balance: number }>

Const ethGetAccountTransactions

  • ethGetAccountTransactions(address: string, pageSize?: number, offset?: number): Promise<EthTx[]>

Const ethGetBlock

  • ethGetBlock(hash: string): Promise<EthBlock>

Const ethGetCurrentBlock

  • ethGetCurrentBlock(): Promise<number>

Const ethGetGasPriceInWei

  • ethGetGasPriceInWei(): Promise<string>

Const ethGetTransaction

  • ethGetTransaction(hash: string): Promise<EthTx>

Const ethGetTransactionsCount

  • ethGetTransactionsCount(address: string): Promise<number>

Const existsAuction

  • existsAuction(testnet: boolean, chain: Currency, id: string, contractAddress: string, provider?: string): Promise<boolean>

Const flowAddPublicKeyToAccount

  • flowAddPublicKeyToAccount(testnet: boolean, publicKey: string, signerAddress: string, signerPrivateKey: string, weight?: number, proposer?: (...args: any[]) => any, payer?: (...args: any[]) => any): Promise<{ address: string; txId: string }>

  • Add public key to existing blockchain address with defined weight

    Parameters

    • testnet: boolean
    • publicKey: string

      key to add

    • signerAddress: string

      address of the authorizer key

    • signerPrivateKey: string

      key of the authorize key

    • weight: number = 0

      defaults to 1000 - weight of the key

    • Optional proposer: (...args: any[]) => any

      function to obtain proposer key from

        • (...args: any[]): any

        • Parameters

          • Rest ...args: any[]

          Returns any

    • Optional payer: (...args: any[]) => any

      function to obtain payer key from

        • (...args: any[]): any

        • Parameters

          • Rest ...args: any[]

          Returns any

    Returns Promise<{ address: string; txId: string }>

Const flowBroadcastTx

  • flowBroadcastTx(txData: string, signatureId?: string, proposalKey?: number): Promise<unknown>

  • Parameters

    • txData: string
    • Optional signatureId: string
    • Optional proposalKey: number

    Returns Promise<unknown>

Const flowCreateAccountFromPublicKey

  • flowCreateAccountFromPublicKey(testnet: boolean, publicKey: string, signerAddress: string, signerPrivateKey: string, proposer?: (isPayer: boolean) => any, payer?: (isPayer: boolean) => any): Promise<{ address: string; txId: string }>

  • Create account on the FLOW network. It automatically creates 100 0-weight proposal keys, which are managed by Tatum API - index 1-100. Main 1000 weight authorizer key is stored as a first one on index 0.

    Parameters

    • testnet: boolean

      if we use testnet or not

    • publicKey: string

      public key to assign to address as authorizer (1000 weight) key

    • signerAddress: string

      address of the authorizer creator of the address on the chain

    • signerPrivateKey: string

      private key of the authorizer creator of the address on the chain

    • Optional proposer: (isPayer: boolean) => any

      function to obtain proposer key from

        • (isPayer: boolean): any

        • Parameters

          • isPayer: boolean

          Returns any

    • Optional payer: (isPayer: boolean) => any

      function to obtain payer key from

        • (isPayer: boolean): any

        • Parameters

          • isPayer: boolean

          Returns any

    Returns Promise<{ address: string; txId: string }>

Const flowGetAccount

  • flowGetAccount(address: string): Promise<any>

Const flowGetBlock

  • flowGetBlock(hash: string): Promise<any>

Const flowGetCurrentBlock

  • flowGetCurrentBlock(): Promise<number>

Const flowGetSignKey

  • flowGetSignKey(isPayer: boolean): Promise<{ address: string; keyId: number }>

Const flowGetTransaction

  • flowGetTransaction(hash: string): Promise<any>

Const flowSendCustomTransaction

  • flowSendCustomTransaction(testnet: boolean, body: TransferFlowCustomTx, proposer?: (isPayer: boolean) => any, payer?: (isPayer: boolean) => any): Promise<{ events: any[]; txId: string }>

  • Send custom transaction to the FLOW network

    Parameters

    • testnet: boolean
    • body: TransferFlowCustomTx

      content of the transaction to broadcast

    • Optional proposer: (isPayer: boolean) => any

      function to obtain proposer key from

        • (isPayer: boolean): any

        • Parameters

          • isPayer: boolean

          Returns any

    • Optional payer: (isPayer: boolean) => any

      function to obtain payer key from

        • (isPayer: boolean): any

        • Parameters

          • isPayer: boolean

          Returns any

    Returns Promise<{ events: any[]; txId: string }>

    txId id of the transaction in the blockchain

Const flowSendTransaction

  • flowSendTransaction(testnet: boolean, body: TransferFlow, proposer?: (isPayer: boolean) => any, payer?: (isPayer: boolean) => any): Promise<{ txId: string }>

  • Send FLOW or FUSD from account to account.

    Parameters

    • testnet: boolean
    • body: TransferFlow

      content of the transaction to broadcast

    • Optional proposer: (isPayer: boolean) => any

      function to obtain proposer key from

        • (isPayer: boolean): any

        • Parameters

          • isPayer: boolean

          Returns any

    • Optional payer: (isPayer: boolean) => any

      function to obtain payer key from

        • (isPayer: boolean): any

        • Parameters

          • isPayer: boolean

          Returns any

    Returns Promise<{ txId: string }>

    txId id of the transaction in the blockchain

Const flowSign

  • flowSign(pk: string, msg: Buffer): string

Const flowSignKMSTransaction

  • flowSignKMSTransaction(tx: TransactionKMS, privateKeys: string[], testnet: boolean): Promise<{ txId: string }>

Const flowSignWithKey

  • flowSignWithKey(data: string, isPayer: boolean): Promise<{ signature: string }>

Const freezeAccount

  • freezeAccount(id: string): Promise<void>

Const freezeTronTransaction

  • Send Tron Freeze balance transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: FreezeTron

      content of the transaction to broadcast

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const fromXdcAddress

  • fromXdcAddress(xdcAddress: string): string

  • Convert XDC address format.

    Parameters

    • xdcAddress: string

    Returns string

Const generateAccount

  • generateAccount(account: CreateAccount, generateNewWallet?: boolean, testnet?: boolean, webhookUrl?: string): Promise<{ account: Account; address: Address; wallet: undefined | { address: string; privateKey: string } | { mnemonic: string } | { address: any; secret: any } }>

  • Abstraction unification endpoint for creating new ledger account, optionally added wallet generation, generating deposit blockchain address and register incoming TX webhook notification.

    Parameters

    • account: CreateAccount

      Account to be created.

    • generateNewWallet: boolean = true

      If new wallet should be created as well

    • testnet: boolean = true

      if we are using testnet or not

    • Optional webhookUrl: string

      optional URL, where webhook will be post for every incoming blockchain transaction to the address

    Returns Promise<{ account: Account; address: Address; wallet: undefined | { address: string; privateKey: string } | { mnemonic: string } | { address: any; secret: any } }>

Const generateAdaWallet

  • generateAdaWallet(mnemonic: string): Promise<Wallet>

  • Generate ADA wallet

    Parameters

    • mnemonic: string

      mnemonic seed to use

    Returns Promise<Wallet>

    wallet

Const generateAddressFromPrivatekey

  • generateAddressFromPrivatekey(currency: Currency, testnet: boolean, privateKey: string): any

  • Generate address from private key

    Parameters

    • currency: Currency

      type of blockchain

    • testnet: boolean

      testnet or mainnet version of address

    • privateKey: string

      private key to use

    Returns any

    blockchain private key to the address

Const generateAddressFromXPub

  • generateAddressFromXPub(currency: Currency, testnet: boolean, xpub: string, i: number): any

  • Generate address

    Parameters

    • currency: Currency

      type of blockchain

    • testnet: boolean

      testnet or mainnet version of address

    • xpub: string

      extended public key to generate address from

    • i: number

      derivation index of address to generate. Up to 2^31 addresses can be generated.

    Returns any

    blockchain address

Const generateAlgoWallet

  • generateAlgoWallet(mnem?: string): Promise<{ address: any; secret: any }>

  • Generate Algo wallet

    Parameters

    • Optional mnem: string

      mnemonic seed to use

    Returns Promise<{ address: any; secret: any }>

    address and secret

Const generateAlgodAddressFromPrivatetKey

  • generateAlgodAddressFromPrivatetKey(privKey: string): any

  • Generate Algo Address From Private Key

    Parameters

    • privKey: string

      Private key to use

    Returns any

    blockchain address

Const generateBchWallet

  • generateBchWallet(testnet: boolean, mnem: string): Promise<Wallet>

  • Generate Bitcoin Cash wallet

    Parameters

    • testnet: boolean

      testnet or mainnet version of address

    • mnem: string

      mnemonic seed to use

    Returns Promise<Wallet>

    wallet

Const generateBnbWallet

  • generateBnbWallet(testnet: boolean): Promise<{ address: string; privateKey: string }>

  • Generate BnB wallet

    Parameters

    • testnet: boolean

      testnet or mainnet version of address

    Returns Promise<{ address: string; privateKey: string }>

    wallet

Const generateBscWallet

  • generateBscWallet(testnet: boolean, mnem: string): Promise<Wallet>

  • Generate BSC or any other BEP-20 or BEP-721 wallet

    Parameters

    • testnet: boolean

      testnet or mainnet version of address

    • mnem: string

      mnemonic seed to use

    Returns Promise<Wallet>

    wallet

Const generateBtcWallet

  • generateBtcWallet(testnet: boolean, mnem: string): Promise<Wallet>

  • Generate Bitcoin wallet

    Parameters

    • testnet: boolean

      testnet or mainnet version of address

    • mnem: string

      mnemonic seed to use

    Returns Promise<Wallet>

    wallet

Const generateCeloWallet

  • generateCeloWallet(testnet: boolean, mnem: string): Promise<Wallet>

  • Generate Celo or any other ERC20 wallet

    Parameters

    • testnet: boolean

      testnet or mainnet version of address

    • mnem: string

      mnemonic seed to use

    Returns Promise<Wallet>

    wallet

Const generateCustodialWallet

  • This method is @Deprecated. Use @link{generateCustodialWalletBatch} instead Generate new smart contract based custodial wallet. This wallet is able to receive any type of assets, but transaction costs connected to the withdrawal of assets is covered by the deployer.

    Parameters

    Returns Promise<TransactionHash>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const generateCustodialWalletBatch

  • Generate new smart contract based custodial wallet. This wallet is able to receive any type of assets, but transaction costs connected to the withdrawal of assets is covered by the deployer.

    Parameters

    • testnet: boolean

      chain to work with

    • body: GenerateCustodialAddressBatch

      request data

    • Optional provider: string

      optional provider to enter. if not present, Tatum Web3 will be used.

    Returns Promise<TransactionHash>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const generateDepositAddress

  • generateDepositAddress(id: string, index?: number): Promise<Address>

Const generateDepositAddresses

  • generateDepositAddresses(batch: AddressBatch): Promise<Address[]>

Const generateDogeWallet

  • generateDogeWallet(testnet: boolean, mnem: string): Promise<Wallet>

  • Generate Doge wallet

    Parameters

    • testnet: boolean

      testnet or mainnet version of address

    • mnem: string

      mnemonic seed to use

    Returns Promise<Wallet>

    wallet

Const generateEgldAddress

  • generateEgldAddress(testnet: boolean, mnem: string, i: number): Promise<string>

  • Generate EGLD address

    Parameters

    • testnet: boolean

      testnet or mainnet version of address

    • mnem: string
    • i: number

      derivation index of address to generate. Up to 2^31 addresses can be generated.

    Returns Promise<string>

    blockchain address

Const generateEgldWallet

  • generateEgldWallet(mnem: string): Promise<{ mnemonic: string }>

  • Generate EGLD wallet

    Parameters

    • mnem: string

      mnemonic seed to use

    Returns Promise<{ mnemonic: string }>

    wallet

Const generateEthWallet

  • generateEthWallet(testnet: boolean, mnem: string): Promise<Wallet>

  • Generate Ethereum or any other ERC20 wallet

    Parameters

    • testnet: boolean

      testnet or mainnet version of address

    • mnem: string

      mnemonic seed to use

    Returns Promise<Wallet>

    wallet

Const generateFlowPublicKeyFromPrivateKey

  • generateFlowPublicKeyFromPrivateKey(pk: string): string

  • Generate FLOW or FUSD public key from private key

    Parameters

    • pk: string

    Returns string

    blockchain address

Const generateFlowWallet

  • generateFlowWallet(mnem: string): Promise<Wallet>

  • Generate Flow or FUSD wallet

    Parameters

    • mnem: string

      mnemonic seed to use

    Returns Promise<Wallet>

    wallet

Const generateKlaytnWallet

  • generateKlaytnWallet(testnet: boolean, mnem: string): Promise<Wallet>

  • Generate Polygon or any other ERC20 wallet

    Parameters

    • testnet: boolean

      testnet or mainnet version of address

    • mnem: string

      mnemonic seed to use

    Returns Promise<Wallet>

    wallet

Const generateLtcWallet

  • generateLtcWallet(testnet: boolean, mnem: string): Promise<Wallet>

  • Generate Litecoin wallet

    Parameters

    • testnet: boolean

      testnet or mainnet version of address

    • mnem: string

      mnemonic seed to use

    Returns Promise<Wallet>

    wallet

Const generateOneWallet

  • generateOneWallet(testnet: boolean, mnem: string): Promise<Wallet>

  • Generate Harmony or any other ERC20 wallet

    Parameters

    • testnet: boolean

      testnet or mainnet version of address

    • mnem: string

      mnemonic seed to use

    Returns Promise<Wallet>

    wallet

Const generatePolygonWallet

  • generatePolygonWallet(testnet: boolean, mnem: string): Promise<Wallet>

  • Generate Polygon or any other ERC20 wallet

    Parameters

    • testnet: boolean

      testnet or mainnet version of address

    • mnem: string

      mnemonic seed to use

    Returns Promise<Wallet>

    wallet

Const generatePrivateKeyFromMnemonic

  • generatePrivateKeyFromMnemonic(currency: Currency, testnet: boolean, mnemonic: string, i: number): Promise<string>

  • Generate private key from mnemonic seed

    Parameters

    • currency: Currency

      type of blockchain

    • testnet: boolean

      testnet or mainnet version of address

    • mnemonic: string

      mnemonic to generate private key from

    • i: number

      derivation index of private key to generate.

    Returns Promise<string>

    blockchain private key to the address

Const generateTronWallet

  • generateTronWallet(mnem: string): Promise<{ mnemonic: string; xpub: string }>

  • Generate Tron wallet

    Parameters

    • mnem: string

    Returns Promise<{ mnemonic: string; xpub: string }>

    mnemonic for the wallet

Const generateVetWallet

  • generateVetWallet(testnet: boolean, mnem: string): Promise<Wallet>

  • Generate VeChain wallet

    Parameters

    • testnet: boolean

      testnet or mainnet version of address

    • mnem: string

      mnemonic seed to use

    Returns Promise<Wallet>

    wallet

Const generateWallet

  • generateWallet(currency: Currency, testnet: boolean, mnemonic?: string): Promise<{ address: string; privateKey: string }> | Promise<{ mnemonic: string }> | { address: undefined | string; secret: string } | Promise<{ address: any; secret: any }>

  • Generate wallet

    Parameters

    • currency: Currency

      blockchain to generate wallet for

    • testnet: boolean

      testnet or mainnet version of address

    • Optional mnemonic: string

      mnemonic seed to use. If not present, new one will be generated

    Returns Promise<{ address: string; privateKey: string }> | Promise<{ mnemonic: string }> | { address: undefined | string; secret: string } | Promise<{ address: any; secret: any }>

    wallet or a combination of address and private key

Const generateXdcWallet

  • generateXdcWallet(testnet: boolean, mnem: string): Promise<Wallet>

Const generateXlmWallet

  • generateXlmWallet(secret?: string): { address: string; secret: string }

  • Generate Stellar address and secret.

    Parameters

    • Optional secret: string

      secret of the account to generate address

    Returns { address: string; secret: string }

    • address: string
    • secret: string

Const generateXrpWallet

  • generateXrpWallet(): { address: undefined | string; secret: string }

  • Generate Xrp address and secret.

    Returns { address: undefined | string; secret: string }

    • address: undefined | string
    • secret: string

Const getAccountBalance

Const getAccountById

  • getAccountById(id: string): Promise<Account>

Const getAccountsByCustomerId

  • getAccountsByCustomerId(id: string, pageSize?: number, offset?: number): Promise<Account[]>

Const getAlgoClient

  • getAlgoClient(testnet: boolean, provider?: string): default

  • Algod V2 Client

    Parameters

    • testnet: boolean

      if the algorand node is testnet or not

    • Optional provider: string

      url of the algorand server endpoint

    Returns default

    algorand Client

Const getAlgoIndexerClient

  • getAlgoIndexerClient(testnet: boolean, provider?: string): any

  • Algo Indexer Client

    Parameters

    • testnet: boolean

      if the algorand node is testnet or not

    • Optional provider: string

      url of the algorand server endpoint

    Returns any

    algorand Indexer Client

Const getAllAccounts

  • getAllAccounts(pageSize?: number, offset?: number): Promise<Account[]>

Const getAllCustomers

  • getAllCustomers(pageSize?: number, offset?: number): Promise<Customer[]>

Const getAuction

  • getAuction(chain: Currency, contractAddress: string, auctionId: string): Promise<Auction>

Const getAuctionFee

  • getAuctionFee(chain: Currency, contractAddress: string): Promise<number>

Const getAuctionFeeRecipient

  • getAuctionFeeRecipient(chain: Currency, contractAddress: string): Promise<{ address: string }>

Const getBlockedAmountsByAccountId

  • getBlockedAmountsByAccountId(id: string, pageSize?: number, offset?: number): Promise<Blockage[]>

Const getBscBep20ContractDecimals

  • getBscBep20ContractDecimals(testnet: boolean, contractAddress: string, provider?: string): Promise<any>

  • Parameters

    • testnet: boolean
    • contractAddress: string
    • Optional provider: string

    Returns Promise<any>

Const getBscClient

  • getBscClient(provider?: string, fromPrivateKey?: string): default

  • Returns BSC server to connect to.

    Parameters

    • Optional provider: string

      url of the BSC Server to connect to. If not set, default public server will be used.

    • Optional fromPrivateKey: string

      optional private key of sender account

    Returns default

Const getCeloClient

  • getCeloClient(provider?: string): default

Const getCeloErc20ContractDecimals

  • getCeloErc20ContractDecimals(testnet: boolean, contractAddress: string, provider?: string): Promise<any>

  • Parameters

    • testnet: boolean
    • contractAddress: string
    • Optional provider: string

    Returns Promise<any>

Const getClient

  • getClient(provider?: string, privateKey?: string): default

  • Returns Ethereum server to connect to.

    Parameters

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    • Optional privateKey: string

    Returns default

Const getCustodialAddresses

  • getCustodialAddresses(chain: Currency, txId: string): Promise<string[]>

Const getCustomer

  • getCustomer(id: string): Promise<Customer>

Const getDepositAddressesForAccount

  • getDepositAddressesForAccount(id: string): Promise<Address[]>

Const getEgldClient

  • getEgldClient(provider?: string): string

  • Returns EGLD server to connect to.

    Parameters

    • Optional provider: string

      url of the EGLD Server to connect to. If not set, default public server will be used.

    Returns string

Const getErc20Decimals

  • getErc20Decimals(testnet: boolean, chain: Currency, contractAddress: string, provider?: string): Promise<any>

  • Get Decimals for the ERC20 token

    Parameters

    • testnet: boolean

      if we are using testnet or mainnet

    • chain: Currency

      chain to query for the token

    • contractAddress: string

      address of the token

    • Optional provider: string

      optional provider

    Returns Promise<any>

Const getEthErc20ContractDecimals

  • getEthErc20ContractDecimals(testnet: boolean, contractAddress: string, provider?: string): Promise<any>

  • Parameters

    • testnet: boolean
    • contractAddress: string
    • Optional provider: string

    Returns Promise<any>

Const getExchangeRate

Const getFlowApiSigner

  • getFlowApiSigner(isPayer: boolean): { keyHash: string; signer: (account: any) => Promise<any> }

  • Parameters

    • isPayer: boolean

    Returns { keyHash: string; signer: (account: any) => Promise<any> }

    • keyHash: string
    • signer: (account: any) => Promise<any>
        • (account: any): Promise<any>

        • Parameters

          • account: any

          Returns Promise<any>

Const getFlowNftMetadata

  • getFlowNftMetadata(testnet: boolean, account: string, id: string, tokenType: string): Promise<any>

  • Parameters

    • testnet: boolean
    • account: string
    • id: string
    • tokenType: string

    Returns Promise<any>

Const getFlowNftTokenByAddress

  • getFlowNftTokenByAddress(testnet: boolean, account: string, tokenType: string): Promise<any>

  • Parameters

    • testnet: boolean
    • account: string
    • tokenType: string

    Returns Promise<any>

Const getFlowSigner

  • getFlowSigner(pk: string, address: string, keyId?: number): { signer: (account: any) => any }

  • Parameters

    • pk: string
    • address: string
    • keyId: number = 0

    Returns { signer: (account: any) => any }

    • signer: (account: any) => any
        • (account: any): any

        • Parameters

          • account: any

          Returns any

Const getKlayErc20ContractDecimals

  • getKlayErc20ContractDecimals(testnet: boolean, contractAddress: string, provider?: string): Promise<any>

  • Parameters

    • testnet: boolean
    • contractAddress: string
    • Optional provider: string

    Returns Promise<any>

Const getLogRecord

  • getLogRecord(chain: Currency, id: string): Promise<{ data: string }>

Const getMarketplaceFee

  • getMarketplaceFee(chain: Currency, contractAddress: string): Promise<number>

Const getMarketplaceFeeRecipient

  • getMarketplaceFeeRecipient(chain: Currency, contractAddress: string): Promise<{ address: string }>

Const getMarketplaceListing

Const getMultiTokenContractAddress

  • getMultiTokenContractAddress(chain: Currency, txId: string): Promise<{ contractAddress: string }>

Const getMultiTokenMetadata

  • getMultiTokenMetadata(chain: Currency, contractAddress: string, tokenId: string): Promise<{ data: string }>

Const getMultiTokenTransaction

  • getMultiTokenTransaction(chain: Currency, txId: string): Promise<any>

Const getMultiTokensBalance

  • getMultiTokensBalance(chain: Currency, contractAddress: string, address: string, tokenId: string): Promise<string[]>

Const getMultiTokensBatchBalance

  • getMultiTokensBatchBalance(chain: Currency, contractAddress: string, address: string, tokenIds: string): Promise<string[]>

Const getNFTContractAddress

  • getNFTContractAddress(chain: Currency, txId: string): Promise<{ contractAddress: string }>

Const getNFTImage

  • getNFTImage(chain: Currency, contractAddress: string, tokenId: string, account?: string): Promise<{ originalUrl: string; publicUrl: string }>

  • Get IPFS image URL from the NFT with the IPFS Metadata scheme. URL

    Parameters

    • chain: Currency

      chain where NFT token is

    • contractAddress: string

      contract address of the NFT token

    • tokenId: string

      ID of the token

    • Optional account: string

      FLOW only - account where the token is minted

    Returns Promise<{ originalUrl: string; publicUrl: string }>

Const getNFTMetadataURI

  • getNFTMetadataURI(chain: Currency, contractAddress: string, tokenId: string, account?: string): Promise<{ data: string }>

Const getNFTProvenanceData

  • getNFTProvenanceData(chain: Currency, contractAddress: string, tokenId: string): Promise<any>

Const getNFTRoyalty

  • getNFTRoyalty(chain: Currency, contractAddress: string, tokenId: string): Promise<{ data: string }>

Const getNFTsByAddress

  • getNFTsByAddress(chain: Currency, contractAddress: string, address: string): Promise<string[]>

Const getOne20ContractDecimals

  • getOne20ContractDecimals(testnet: boolean, contractAddress: string, provider?: string): Promise<any>

  • Parameters

    • testnet: boolean
    • contractAddress: string
    • Optional provider: string

    Returns Promise<any>

Const getPendingTransactionsKMSByChain

Const getPolygonErc20ContractDecimals

  • getPolygonErc20ContractDecimals(testnet: boolean, contractAddress: string, provider?: string): Promise<any>

  • Parameters

    • testnet: boolean
    • contractAddress: string
    • Optional provider: string

    Returns Promise<any>

Const getTransactionKMS

Const getTransactionsByAccount

Const getTransactionsByCustomer

Const getTransactionsByLedger

Const getTransactionsByReference

  • getTransactionsByReference(reference: string): Promise<Transaction[]>

Const getTronTrc20ContractDecimals

  • getTronTrc20ContractDecimals(testnet: boolean, contractAddress: string, provider?: string): Promise<number>

  • Parameters

    • testnet: boolean
    • contractAddress: string
    • Optional provider: string

    Returns Promise<number>

Const getUsage

Const getVirtualCurrencyByName

  • getVirtualCurrencyByName(name: string): Promise<VC>

Const getWithdrawals

  • getWithdrawals(status?: string, currency?: string, pageSize?: number, offset?: number): Promise<Withdrawal[]>

Const getXdcClient

  • getXdcClient(provider?: string, fromPrivateKey?: string): default

  • Returns XDC server to connect to.

    Parameters

    • Optional provider: string

      url of the XDC Server to connect to. If not set, default public server will be used.

    • Optional fromPrivateKey: string

      optional private key of sender account

    Returns default

Const initTransactionBuilder

  • initTransactionBuilder(): Promise<TransactionBuilder>

Const ipfsDelete

  • ipfsDelete(id: string): Promise<void>

  • Unpin the data from the IPFS. After this operation, credits won't be charged for a storage, but file will keep exists on the IPFS. For more details, see Tatum API documentation

    Parameters

    • id: string

    Returns Promise<void>

Const ipfsGet

  • ipfsGet(id: string): Promise<any>

Const ipfsUpload

  • ipfsUpload(file: Buffer, fileName: string): Promise<{ ipfsHash: string }>

  • Upload file to the IPFS storage.

    Parameters

    • file: Buffer

      Data buffer of the file

    • fileName: string

      Name of the file to upload.

    Returns Promise<{ ipfsHash: string }>

Const klayGetGasPriceInWei

  • klayGetGasPriceInWei(client: default): Promise<string>

  • Estimate Gas price for the transaction.

    Parameters

    • client: default

    Returns Promise<string>

Const klaytnBroadcast

  • klaytnBroadcast(txData: string, signatureId?: string): Promise<TransactionHash>

Const klaytnEstimateGas

Const klaytnGetAccountBalance

  • klaytnGetAccountBalance(address: string): Promise<BigNumber>

Const klaytnGetBlock

  • klaytnGetBlock(hash: string): Promise<EthBlock>

Const klaytnGetCurrentBlock

  • klaytnGetCurrentBlock(): Promise<number>

Const klaytnGetTransaction

  • klaytnGetTransaction(hash: string): Promise<EthTx>

Const klaytnGetTransactionsCount

  • klaytnGetTransactionsCount(address: string): Promise<number>

Const listActiveSubscriptions

  • listActiveSubscriptions(pageSize?: number, offset?: number): Promise<Subscription[]>

Const lovelaceToAda

  • lovelaceToAda(lovelace: string | number): string

Const ltcBroadcast

  • ltcBroadcast(txData: string, signatureId?: string): Promise<TransactionHash>

Const ltcGetBalance

  • ltcGetBalance(address: string): Promise<{ incoming: string; outgoing: string }>

Const ltcGetBlock

  • ltcGetBlock(hash: string): Promise<LtcBlock>

Const ltcGetBlockHash

  • ltcGetBlockHash(i: number): Promise<BlockHash>

Const ltcGetCurrentBlock

  • ltcGetCurrentBlock(): Promise<LtcInfo>

Const ltcGetTransaction

  • ltcGetTransaction(hash: string): Promise<LtcTx>

Const ltcGetTxForAccount

  • ltcGetTxForAccount(address: string, pageSize?: number, offset?: number): Promise<LtcTx[]>

Const ltcGetUTXO

  • ltcGetUTXO(hash: string, i: number): Promise<LtcUTXO>

Const makeWitness

  • makeWitness(privateKey: string, txHash: TransactionHash, vKeyWitnesses: Vkeywitnesses): void

  • Parameters

    • privateKey: string
    • txHash: TransactionHash
    • vKeyWitnesses: Vkeywitnesses

    Returns void

Const mintMultiToken

Const mintMultiTokenBatch

Const mintMultipleNFTWithUri

Const mintNFT

Const mintNFTWithUri

Const mintVirtualCurrency

  • mintVirtualCurrency(data: CurrencyOperation): Promise<{ reference: string }>

Const obtainCustodialAddressType

  • obtainCustodialAddressType(body: GenerateCustodialAddress): { abi: ({ anonymous: boolean; inputs: { indexed: boolean; internalType: string; name: string; type: string }[]; name: string; outputs: undefined; stateMutability: undefined; type: string } | { anonymous: undefined; inputs: { internalType: string; name: string; type: string }[]; name: string; outputs: { internalType: string; name: string; type: string }[]; stateMutability: string; type: string } | { anonymous: undefined; inputs: undefined; name: undefined; outputs: undefined; stateMutability: string; type: string })[]; code: string }

  • Parameters

    Returns { abi: ({ anonymous: boolean; inputs: { indexed: boolean; internalType: string; name: string; type: string }[]; name: string; outputs: undefined; stateMutability: undefined; type: string } | { anonymous: undefined; inputs: { internalType: string; name: string; type: string }[]; name: string; outputs: { internalType: string; name: string; type: string }[]; stateMutability: string; type: string } | { anonymous: undefined; inputs: undefined; name: undefined; outputs: undefined; stateMutability: string; type: string })[]; code: string }

    • abi: ({ anonymous: boolean; inputs: { indexed: boolean; internalType: string; name: string; type: string }[]; name: string; outputs: undefined; stateMutability: undefined; type: string } | { anonymous: undefined; inputs: { internalType: string; name: string; type: string }[]; name: string; outputs: { internalType: string; name: string; type: string }[]; stateMutability: string; type: string } | { anonymous: undefined; inputs: undefined; name: undefined; outputs: undefined; stateMutability: string; type: string })[]
    • code: string

Const obtainReportForSubscription

Const offchainBroadcast

Const offchainCancelWithdrawal

  • offchainCancelWithdrawal(id: string, revert?: boolean): Promise<void>

Const offchainCompleteWithdrawal

  • offchainCompleteWithdrawal(id: string, txId: string): Promise<void>

Const offchainStoreWithdrawal

Const offchainTransferAdaKMS

Const offchainTransferBcashKMS

Const offchainTransferBscKMS

Const offchainTransferBtcKMS

Const offchainTransferCeloKMS

Const offchainTransferDogeKMS

Const offchainTransferEgldKMS

Const offchainTransferEthErc20KMS

Const offchainTransferEthKMS

Const offchainTransferKlaytnKMS

Const offchainTransferLtcKMS

Const offchainTransferPolygonKMS

Const offchainTransferTronKMS

Const offchainTransferXdcKMS

Const offchainTransferXlmKMS

Const offchainTransferXrpKMS

Const oneBroadcast

  • oneBroadcast(txData: string, signatureId?: string): Promise<TransactionHash>

Const oneGetBalance

  • oneGetBalance(address: string): Promise<string>

Const oneGetBlock

  • oneGetBlock(hash: string): Promise<any>

Const oneGetCurrentBlock

  • oneGetCurrentBlock(): Promise<number>

Const oneGetTransaction

  • oneGetTransaction(hash: string): Promise<OneTx>

Const oneGetTransactionCount

  • oneGetTransactionCount(address: string): Promise<number>

Const polygonBroadcast

  • polygonBroadcast(txData: string, signatureId?: string): Promise<TransactionHash>

Const polygonEstimateGas

Const polygonGetAccountBalance

  • polygonGetAccountBalance(address: string): Promise<BigNumber>

Const polygonGetBlock

  • polygonGetBlock(hash: string): Promise<EthBlock>

Const polygonGetCurrentBlock

  • polygonGetCurrentBlock(): Promise<number>

Const polygonGetGasPriceInWei

  • polygonGetGasPriceInWei(): Promise<string>

Const polygonGetTransaction

  • polygonGetTransaction(hash: string): Promise<EthTx>

Const polygonGetTransactionsCount

  • polygonGetTransactionsCount(address: string): Promise<number>

Const prepareAdaTransaction

  • Prepare a signed Ada transaction with the private key locally. Nothing is broadcasted to the blockchain.

    Parameters

    Returns Promise<string>

    raw transaction data in hex, to be broadcasted to blockchain.

Const prepareAddMultiTokenMinter

  • prepareAddMultiTokenMinter(testnet: boolean, body: AddMinter, provider?: string): Promise<string>

  • Prepare add new minter to the MultiToken (1155) contract transaction.

    Parameters

    • testnet: boolean

      if we use testnet or not

    • body: AddMinter

      body of the add minter request

    • Optional provider: string

      optional provider do broadcast tx

    Returns Promise<string>

Const prepareAddNFTMinter

  • prepareAddNFTMinter(testnet: boolean, body: AddMinter, provider?: string): Promise<string>

  • Prepare add new minter to the NFT contract transaction.

    Parameters

    • testnet: boolean

      if we use testnet or not

    • body: AddMinter

      body of the add minter request

    • Optional provider: string

      optional provider do broadcast tx

    Returns Promise<string>

Const prepareAlgoBurnFTSignedTransaction

  • prepareAlgoBurnFTSignedTransaction(testnet: boolean, tx: BurnErc20, provider?: string): Promise<string>

  • Sign ALgorand burn FT transaction with private key locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • tx: BurnErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Algorand Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareAlgoBurnFractionalNFTSignedTransaction

  • prepareAlgoBurnFractionalNFTSignedTransaction(testnet: boolean, tx: BurnMultiToken, provider?: string): Promise<string>

  • Sign Algorand burn Fracational NFT transaction with private key locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • tx: BurnMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Algorand Server to connecto to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareAlgoBurnNFTSignedTransaction

  • prepareAlgoBurnNFTSignedTransaction(testnet: boolean, tx: BurnErc721, provider?: string): Promise<string>

  • Sign Algorand burn NFT transaction with private key locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • tx: BurnErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Algorand Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareAlgoCreateFTSignedTransaction

  • prepareAlgoCreateFTSignedTransaction(testnet: boolean, tx: DeployErc20, provider?: string): Promise<string>

  • Sign Algorand create FT transaction with private key locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • tx: DeployErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Algorand Server to connnect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareAlgoCreateFractionalNFTSignedTransaction

  • prepareAlgoCreateFractionalNFTSignedTransaction(testnet: boolean, tx: MintMultiToken, provider?: string): Promise<string>

  • Sign Algorand create Fractional NFT transaction with private key locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • tx: MintMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Algorand Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareAlgoCreateNFTSignedTransaction

  • prepareAlgoCreateNFTSignedTransaction(testnet: boolean, tx: MintAlgoNft, provider?: string, decimals?: number, total?: number): Promise<string>

  • Sign Algorand create NFT transaction with private key locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • tx: MintAlgoNft

      content of the transaction to broadcast

    • Optional provider: string

      url of the Algorand Server to connect to. If not set, default public server will be used.

    • decimals: number = 0
    • total: number = 1

    Returns Promise<string>

    transaction data to be broadcast to blockchain

Const prepareAlgoReceiveNFTSignedTransaction

  • prepareAlgoReceiveNFTSignedTransaction(testnet: boolean, tx: ReceiveAlgoNft, provider?: string): Promise<string>

  • Sign Algorand receive NFT transaction with private key locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • tx: ReceiveAlgoNft

      content of the transaction to broadcast

    • Optional provider: string

      url of the Algorand Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareAlgoSignedTransaction

  • prepareAlgoSignedTransaction(testnet: boolean, tx: AlgoTransaction, provider?: string): Promise<string>

  • Algorand transaction signing

    Parameters

    • testnet: boolean

      if the algorand node is testnet or not

    • tx: AlgoTransaction

      content of the transaction to broadcast

    • Optional provider: string

      url of the algorand server endpoint for purestake.io restapi

    Returns Promise<string>

    transaction data to be broadcast to blockchain

Const prepareAlgoTransferFTSignedTransaction

  • prepareAlgoTransferFTSignedTransaction(testnet: boolean, tx: TransferErc20, provider?: string): Promise<string>

  • Sign Algorand transfer FT transaction with private kwy locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • tx: TransferErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Algorand Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareAlgoTransferFractionalNFTSignedTransaction

  • prepareAlgoTransferFractionalNFTSignedTransaction(testnet: boolean, tx: TransferMultiToken, provider?: string): Promise<string>

  • Sign Algorand transfer Fractional NFT transaction with private key locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • tx: TransferMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Algorand Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareAlgoTransferNFTSignedTransaction

  • prepareAlgoTransferNFTSignedTransaction(testnet: boolean, tx: TransferAlgoNft, provider?: string, amount?: number): Promise<string>

  • Sign Algorand transfer NFT transaction with private key locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • tx: TransferAlgoNft

      content of the transaction to broadcast

    • Optional provider: string

      url of the Algorand Server to connect to. If not set, default public server will be used.

    • amount: number = 1

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareApproveErc20

  • prepareApproveErc20(testnet: boolean, body: ApproveErc20, provider?: string): Promise<string>

  • Prepare approve ERC20 signed transaction.

    Parameters

    • testnet: boolean

      if we are on testnet or not

    • body: ApproveErc20

      body of the approve operation

    • Optional provider: string

      optional Web3 provider

    Returns Promise<string>

Const prepareApproveFromCustodialWallet

  • prepareApproveFromCustodialWallet(testnet: boolean, body: ApproveCustodialTransfer, provider?: string): Promise<string>

  • Prepare signed approve transaction from the custodial SC wallet.

    Parameters

    • testnet: boolean

      chain to work with

    • body: ApproveCustodialTransfer

      request data

    • Optional provider: string

      optional provider to enter. if not present, Tatum Web3 will be used.

    Returns Promise<string>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const prepareAuctionApproveErc20Transfer

  • prepareAuctionApproveErc20Transfer(testnet: boolean, body: ApproveErc20, provider?: string): Promise<string>

  • Approve ERC20 transfer for auction to perform bidding on the asset in the auction.

    Parameters

    • testnet: boolean

      chain to work with

    • body: ApproveErc20

      request data

    • Optional provider: string

      optional provider to enter. if not present, Tatum Web3 will be used.

    Returns Promise<string>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const prepareAuctionApproveNftTransfer

  • prepareAuctionApproveNftTransfer(testnet: boolean, body: ApproveNftTransfer, provider?: string): Promise<string>

  • Approve NFT transfer for auction to perform listing of the asset.

    Parameters

    • testnet: boolean

      chain to work with

    • body: ApproveNftTransfer

      request data

    • Optional provider: string

      optional provider to enter. if not present, Tatum Web3 will be used.

    Returns Promise<string>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const prepareAuctionBid

  • Bid on the auction. Buyer must either send native assets with this operation, or approve ERC20 token spending before. After auction is sold, it's in a pending state to be processed by the auction. Noone receives the assets unless the auction operator processes that.

    Parameters

    • testnet: boolean

      chain to work with

    • body: InvokeAuctionOperation

      request data

    • Optional provider: string

      optional provider to enter. if not present, Tatum Web3 will be used.

    Returns Promise<string>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const prepareAuctionCancel

  • Cancel auction on the auction. Only possible for the seller or the operator. There must be no buyer present for that auction. NFT asset is sent back to the seller.

    Parameters

    • testnet: boolean

      chain to work with

    • body: InvokeAuctionOperation

      request data

    • Optional provider: string

      optional provider to enter. if not present, Tatum Web3 will be used.

    Returns Promise<string>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const prepareAuctionCreate

  • prepareAuctionCreate(testnet: boolean, body: CreateAuction, provider?: string): Promise<string>

  • Create new auction on the auction contract. Before auction, seller must approve spending of the NFT token for the Auction contract. After auction is created, auction contract transfers the asset to the auction smart contract. Only auction for existing NFTs can be created - seller must be owner of the NFT asset.

    Parameters

    • testnet: boolean

      chain to work with

    • body: CreateAuction

      request data

    • Optional provider: string

      optional provider to enter. if not present, Tatum Web3 will be used.

    Returns Promise<string>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const prepareAuctionSettle

  • Settle auction. There must be buyer present for that auction. NFT will be sent to the bidder, assets to the seller and fee to the operator.

    Parameters

    • testnet: boolean

      chain to work with

    • body: InvokeAuctionOperation

      request data

    • Optional provider: string

      optional provider to enter. if not present, Tatum Web3 will be used.

    Returns Promise<string>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const prepareAuctionUpdateFee

  • prepareAuctionUpdateFee(testnet: boolean, body: UpdateAuctionFee, provider?: string): Promise<string>

  • Update auction fee.

    Parameters

    • testnet: boolean

      chain to work with

    • body: UpdateAuctionFee

      request data

    • Optional provider: string

      optional provider to enter. if not present, Tatum Web3 will be used.

    Returns Promise<string>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const prepareAuctionUpdateFeeRecipient

  • Update auction fee recipient.

    Parameters

    • testnet: boolean

      chain to work with

    • body: UpdateMarketplaceFeeRecipient

      request data

    • Optional provider: string

      optional provider to enter. if not present, Tatum Web3 will be used.

    Returns Promise<string>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const prepareBatchTransferFromCustodialWallet

Const prepareBitcoinCashSignedOffchainTransaction

  • prepareBitcoinCashSignedOffchainTransaction(testnet: boolean, data: WithdrawalResponseData[], amount: string, address: string, mnemonic?: string, keyPair?: KeyPair[], changeAddress?: string, multipleAmounts?: string[]): Promise<any>

  • Sign Bitcoin Cash transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • data: WithdrawalResponseData[]

      data from Tatum system to prepare transaction from

    • amount: string

      amount to send

    • address: string

      recipient address, if multiple recipients are present, it should be string separated by ','

    • Optional mnemonic: string

      mnemonic to sign transaction from. mnemonic or keyPair must be present

    • Optional keyPair: KeyPair[]

      keyPair to sign transaction from. keyPair or mnemonic must be present

    • Optional changeAddress: string

      address to send the rest of the unused coins

    • Optional multipleAmounts: string[]

      if multiple recipients are present in the address separated by ',', this should be list of amounts to send

    Returns Promise<any>

    transaction data to be broadcast to blockchain.

Const prepareBitcoinCashSignedTransaction

  • Sign Bitcoin Cash transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TransferBchBlockchain

      content of the transaction to broadcast

    Returns Promise<any>

    transaction data to be broadcast to blockchain.

Const prepareBitcoinSignedOffchainTransaction

  • prepareBitcoinSignedOffchainTransaction(testnet: boolean, data: WithdrawalResponseData[], amount: string, address: string, mnemonic?: string, keyPair?: KeyPair[], changeAddress?: string, xpub?: string, multipleAmounts?: string[], signatureId?: string): Promise<any>

  • Sign Bitcoin transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • data: WithdrawalResponseData[]

      data from Tatum system to prepare transaction from

    • amount: string

      amount to send

    • address: string

      recipient address, if multiple recipients are present, it should be string separated by ','

    • Optional mnemonic: string

      mnemonic to sign transaction from. mnemonic or keyPair must be present

    • Optional keyPair: KeyPair[]

      keyPair to sign transaction from. keyPair or mnemonic must be present

    • Optional changeAddress: string

      address to send the rest of the unused coins

    • Optional xpub: string

      xpub of the wallet

    • Optional multipleAmounts: string[]

      if multiple recipients are present in the address separated by ',', this should be list of amounts to send

    • Optional signatureId: string

      if using KMS, this is signatureId of the wallet representing mnemonic

    Returns Promise<any>

    transaction data to be broadcast to blockchain.

Const prepareBitcoinSignedTransaction

  • prepareBitcoinSignedTransaction(testnet: boolean, body: TransferBtcLtcBlockchain): Promise<any>

  • Sign Bitcoin transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TransferBtcLtcBlockchain

      content of the transaction to broadcast

    Returns Promise<any>

    transaction data to be broadcast to blockchain.

Const prepareBscBatchTransferMultiTokenSignedTransaction

  • prepareBscBatchTransferMultiTokenSignedTransaction(body: TransferMultiTokenBatch, provider?: string): Promise<string>

Const prepareBscBurnBep721SignedTransaction

  • prepareBscBurnBep721SignedTransaction(body: EthBurnErc721, provider?: string): Promise<string>

  • Sign Bsc burn ERC 721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EthBurnErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Bsc Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareBscBurnMultiTokenBatchSignedTransaction

  • prepareBscBurnMultiTokenBatchSignedTransaction(body: EthBurnMultiTokenBatch, provider?: string): Promise<string>

Const prepareBscBurnMultiTokenSignedTransaction

  • prepareBscBurnMultiTokenSignedTransaction(body: EthBurnMultiToken, provider?: string): Promise<string>

  • Sign Bsc burn ERC 1155 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EthBurnMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Bsc Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareBscDeployAuctionSignedTransaction

  • prepareBscDeployAuctionSignedTransaction(body: DeployNftAuction, provider?: string): Promise<string>

  • Sign BSC deploy NFT Auction contract transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: DeployNftAuction

      content of the transaction to broadcast

    • Optional provider: string

      url of the Bsc Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain, or signatureId in case of Tatum KMS

Const prepareBscDeployBep721SignedTransaction

  • prepareBscDeployBep721SignedTransaction(body: EthDeployErc721, provider?: string): Promise<string>

  • Sign Bsc deploy ERC 721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EthDeployErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Bsc Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareBscDeployMarketplaceListingSignedTransaction

  • prepareBscDeployMarketplaceListingSignedTransaction(body: DeployMarketplaceListing, provider?: string): Promise<string>

  • Sign BSC generate custodial wallet address transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: DeployMarketplaceListing

      content of the transaction to broadcast

    • Optional provider: string

      url of the Bsc Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain, or signatureId in case of Tatum KMS

Const prepareBscDeployMultiTokenSignedTransaction

  • prepareBscDeployMultiTokenSignedTransaction(body: EthDeployMultiToken, provider?: string): Promise<string>

  • Sign Bsc deploy ERC 1155 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EthDeployMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Bsc Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareBscGenerateCustodialWalletSignedTransaction

  • prepareBscGenerateCustodialWalletSignedTransaction(body: GenerateCustodialAddress, provider?: string): Promise<string>

  • Sign Bsc generate custodial wallet address transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: GenerateCustodialAddress

      content of the transaction to broadcast

    • Optional provider: string

      url of the Bsc Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareBscMintBep721ProvenanceSignedTransaction

  • prepareBscMintBep721ProvenanceSignedTransaction(body: EthMintErc721, provider?: string): Promise<string>

  • Sign Bsc mint ERC 721 provenance transaction with cashback via private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EthMintErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Bsc Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareBscMintBep721SignedTransaction

  • prepareBscMintBep721SignedTransaction(body: EthMintErc721, provider?: string): Promise<string>

  • Sign Bsc mint ERC 721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EthMintErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Bsc Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareBscMintBepCashback721SignedTransaction

  • prepareBscMintBepCashback721SignedTransaction(body: EthMintErc721, provider?: string): Promise<string>

  • Sign Bsc mint ERC 721 transaction with cashback via private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EthMintErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Bsc Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareBscMintMultiTokenBatchSignedTransaction

  • prepareBscMintMultiTokenBatchSignedTransaction(body: MintMultiTokenBatch, provider?: string): Promise<string>

  • Sign BSC mint ERC 1155 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: MintMultiTokenBatch

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareBscMintMultiTokenSignedTransaction

  • prepareBscMintMultiTokenSignedTransaction(body: MintMultiToken, provider?: string): Promise<string>

  • Sign Bsc mint ERC 1155 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: MintMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareBscMintMultipleBep721ProvenanceSignedTransaction

  • prepareBscMintMultipleBep721ProvenanceSignedTransaction(body: EthMintMultipleErc721, provider?: string): Promise<string>

  • Sign Bsc mint multiple ERC 721 Cashback transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EthMintMultipleErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Bsc Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareBscMintMultipleBep721SignedTransaction

  • prepareBscMintMultipleBep721SignedTransaction(body: EthMintMultipleErc721, provider?: string): Promise<string>

  • Sign Bsc mint multiple ERC 721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EthMintMultipleErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Bsc Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareBscMintMultipleCashbackBep721SignedTransaction

  • prepareBscMintMultipleCashbackBep721SignedTransaction(body: EthMintMultipleErc721, provider?: string): Promise<string>

  • Sign Bsc mint multiple ERC 721 Cashback transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EthMintMultipleErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Bsc Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareBscOrBep20SignedTransaction

  • prepareBscOrBep20SignedTransaction(body: TransferBscBep20, provider?: string): Promise<string>

  • Sign Bsc or supported BEP20 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: TransferBscBep20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Bsc Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareBscSmartContractWriteMethodInvocation

  • Sign Bsc invoke smart contract transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: SmartContractMethodInvocation

      content of the transaction to broadcast

    • Optional provider: string

      url of the Bsc Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareBscStoreDataTransaction

  • prepareBscStoreDataTransaction(body: CreateRecord, provider?: string): Promise<string>

  • Sign Bsc Store data transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: CreateRecord

      content of the transaction to broadcast

    • Optional provider: string

      url of the Bsc Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareBscTransferBep721SignedTransaction

  • prepareBscTransferBep721SignedTransaction(body: EthTransferErc721, provider?: string): Promise<string>

  • Sign Bsc transfer ERC 721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EthTransferErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Bsc Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareBscTransferMultiTokenSignedTransaction

  • prepareBscTransferMultiTokenSignedTransaction(body: TransferMultiToken, provider?: string): Promise<string>

Const prepareBscUpdateCashbackForAuthorErc721SignedTransaction

  • prepareBscUpdateCashbackForAuthorErc721SignedTransaction(body: UpdateCashbackErc721, provider?: string): Promise<string>

  • Sign Bsc update cashback ERC 721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: UpdateCashbackErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Bsc Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareBurnBep20SignedTransaction

  • prepareBurnBep20SignedTransaction(body: BurnErc20, provider?: string): Promise<string>

  • Sign BEP20 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: BurnErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Bsc Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareCeloBatchTransferMultiTokenSignedTransaction

  • prepareCeloBatchTransferMultiTokenSignedTransaction(testnet: boolean, body: CeloTransferMultiTokenBatch, provider?: string): Promise<string>

  • Prepare a signed Celo batch transfer multiple tokens transaction with the private key locally. Nothing is broadcasted to the blockchain.

    Parameters

    Returns Promise<string>

    raw transaction data in hex, to be broadcasted to blockchain.

Const prepareCeloBurnErc20SignedTransaction

  • prepareCeloBurnErc20SignedTransaction(testnet: boolean, body: BurnCeloErc20, provider?: string): Promise<string>

  • Prepare a signed Celo burn erc20 transaction with the private key locally. Nothing is broadcasted to the blockchain.

    Parameters

    Returns Promise<string>

    raw transaction data in hex, to be broadcasted to blockchain.

Const prepareCeloBurnErc721SignedTransaction

  • prepareCeloBurnErc721SignedTransaction(testnet: boolean, body: CeloBurnErc721, provider?: string): Promise<string>

  • Prepare a signed Celo burn erc721 transaction with the private key locally. Nothing is broadcasted to the blockchain.

    Parameters

    Returns Promise<string>

    raw transaction data in hex, to be broadcasted to blockchain.

Const prepareCeloBurnMultiTokenBatchSignedTransaction

  • prepareCeloBurnMultiTokenBatchSignedTransaction(testnet: boolean, body: CeloBurnMultiTokenBatch, provider?: string): Promise<string>

  • Prepare a signed Celo burn multiple tokens batch transaction with the private key locally. Nothing is broadcasted to the blockchain.

    Parameters

    Returns Promise<string>

    raw transaction data in hex, to be broadcasted to blockchain.

Const prepareCeloBurnMultiTokenSignedTransaction

  • prepareCeloBurnMultiTokenSignedTransaction(testnet: boolean, body: CeloBurnMultiToken, provider?: string): Promise<string>

  • Prepare a signed Celo burn multiple tokens transaction with the private key locally. Nothing is broadcasted to the blockchain.

    Parameters

    Returns Promise<string>

    raw transaction data in hex, to be broadcasted to blockchain.

Const prepareCeloDeployAuctionSignedTransaction

  • prepareCeloDeployAuctionSignedTransaction(testnet: boolean, body: DeployNftAuction, provider?: string): Promise<string>

  • Sign CELO deploy NFT Auction contract transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean
    • body: DeployNftAuction

      content of the transaction to broadcast

    • Optional provider: string

      url of the Bsc Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain, or signatureId in case of Tatum KMS

Const prepareCeloDeployErc20SignedTransaction

  • prepareCeloDeployErc20SignedTransaction(testnet: boolean, body: DeployCeloErc20, provider?: string): Promise<string>

  • Prepare a signed Celo deploy erc20 transaction with the private key locally. Nothing is broadcasted to the blockchain.

    Parameters

    Returns Promise<string>

    raw transaction data in hex, to be broadcasted to blockchain.

Const prepareCeloDeployErc721SignedTransaction

  • prepareCeloDeployErc721SignedTransaction(testnet: boolean, body: CeloDeployErc721, provider?: string): Promise<string>

  • Prepare a signed Celo deploy erc721 transaction with the private key locally. Nothing is broadcasted to the blockchain.

    Parameters

    Returns Promise<string>

    raw transaction data in hex, to be broadcasted to blockchain.

Const prepareCeloDeployMarketplaceListingSignedTransaction

  • prepareCeloDeployMarketplaceListingSignedTransaction(testnet: boolean, body: DeployMarketplaceListing, provider?: string): Promise<string>

  • Sign CELO generate custodial wallet address transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean
    • body: DeployMarketplaceListing

      content of the transaction to broadcast

    • Optional provider: string

      url of the Bsc Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain, or signatureId in case of Tatum KMS

Const prepareCeloDeployMultiTokenSignedTransaction

  • prepareCeloDeployMultiTokenSignedTransaction(testnet: boolean, body: CeloDeployMultiToken, provider?: string): Promise<string>

  • Prepare a signed Celo deploy multi token transaction with the private key locally. Nothing is broadcasted to the blockchain.

    Parameters

    Returns Promise<string>

    raw transaction data in hex, to be broadcasted to blockchain.

Const prepareCeloGenerateCustodialWalletSignedTransaction

  • prepareCeloGenerateCustodialWalletSignedTransaction(testnet: boolean, body: GenerateCustodialAddress, provider?: string): Promise<string>

  • Sign CELO generate custodial wallet address transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean
    • body: GenerateCustodialAddress

      content of the transaction to broadcast

    • Optional provider: string

      url of the Bsc Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain, or signatureId in case of Tatum KMS

Const prepareCeloMintCashbackErc721SignedTransaction

  • prepareCeloMintCashbackErc721SignedTransaction(testnet: boolean, body: CeloMintErc721, provider?: string): Promise<string>

  • Prepare a signed Celo mint cashback erc721 transaction with the private key locally. Nothing is broadcasted to the blockchain.

    Parameters

    Returns Promise<string>

    raw transaction data in hex, to be broadcasted to blockchain.

Const prepareCeloMintErc20SignedTransaction

  • prepareCeloMintErc20SignedTransaction(testnet: boolean, body: MintCeloErc20, provider?: string): Promise<string>

  • Prepare a signed Celo mint erc20 transaction with the private key locally. Nothing is broadcasted to the blockchain.

    Parameters

    Returns Promise<string>

    raw transaction data in hex, to be broadcasted to blockchain.

Const prepareCeloMintErc721ProvenanceSignedTransaction

  • prepareCeloMintErc721ProvenanceSignedTransaction(testnet: boolean, body: CeloMintErc721, provider?: string): Promise<string>

  • Prepare a signed Celo mint provenance erc732 transaction with the private key locally. Nothing is broadcasted to the blockchain.

    Parameters

    Returns Promise<string>

    raw transaction data in hex, to be broadcasted to blockchain.

Const prepareCeloMintErc721SignedTransaction

  • prepareCeloMintErc721SignedTransaction(testnet: boolean, body: CeloMintErc721, provider?: string): Promise<string>

  • Prepare a signed Celo mint erc732 transaction with the private key locally. Nothing is broadcasted to the blockchain.

    Parameters

    Returns Promise<string>

    raw transaction data in hex, to be broadcasted to blockchain.

Const prepareCeloMintMultiTokenBatchSignedTransaction

  • prepareCeloMintMultiTokenBatchSignedTransaction(testnet: boolean, body: CeloMintMultiTokenBatch, provider?: string): Promise<string>

  • Prepare a signed Celo mint multiple tokens batch transaction with the private key locally. Nothing is broadcasted to the blockchain.

    Parameters

    Returns Promise<string>

    raw transaction data in hex, to be broadcasted to blockchain.

Const prepareCeloMintMultiTokenSignedTransaction

  • prepareCeloMintMultiTokenSignedTransaction(testnet: boolean, body: CeloMintMultiToken, provider?: string): Promise<string>

  • Prepare a signed Celo mint multiple tokens transaction with the private key locally. Nothing is broadcasted to the blockchain.

    Parameters

    Returns Promise<string>

    raw transaction data in hex, to be broadcasted to blockchain.

Const prepareCeloMintMultipleCashbackErc721SignedTransaction

  • prepareCeloMintMultipleCashbackErc721SignedTransaction(testnet: boolean, body: CeloMintMultipleErc721, provider?: string): Promise<string>

  • Prepare a signed Celo mint multiple cashback erc721 transaction with the private key locally. Nothing is broadcasted to the blockchain.

    Parameters

    Returns Promise<string>

    raw transaction data in hex, to be broadcasted to blockchain.

Const prepareCeloMintMultipleErc721ProvenanceSignedTransaction

  • prepareCeloMintMultipleErc721ProvenanceSignedTransaction(testnet: boolean, body: CeloMintMultipleErc721, provider?: string): Promise<string>

  • Prepare a signed Celo mint multiple provenance cashback erc721 transaction with the private key locally. Nothing is broadcasted to the blockchain.

    Parameters

    Returns Promise<string>

    raw transaction data in hex, to be broadcasted to blockchain.

Const prepareCeloMintMultipleErc721SignedTransaction

  • prepareCeloMintMultipleErc721SignedTransaction(testnet: boolean, body: CeloMintMultipleErc721, provider?: string): Promise<string>

  • Prepare a signed Celo mint multiple erc721 transaction with the private key locally. Nothing is broadcasted to the blockchain.

    Parameters

    Returns Promise<string>

    raw transaction data in hex, to be broadcasted to blockchain.

Const prepareCeloOrCUsdSignedTransaction

  • Sign Celo, cUsd or cEur transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TransferCeloOrCeloErc20Token

      content of the transaction to broadcast

    • Optional provider: string

      url of the Celo Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain, or signatureId in case of Tatum KMS

Const prepareCeloSmartContractWriteMethodInvocation

  • Prepare a smart contract write method invocation transaction with the private key locally. Nothing is broadcasted to the blockchain.

    Parameters

    Returns Promise<string>

    raw transaction data in hex, to be broadcasted to blockchain.

Const prepareCeloStoreDataSignedTransaction

  • prepareCeloStoreDataSignedTransaction(testnet: boolean, body: CreateRecord, provider?: string): Promise<string>

  • Sign store data transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: CreateRecord

      content of the transaction to broadcast

    • Optional provider: string

      url of the Celo Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain, or signatureId in case of Tatum KMS

Const prepareCeloTransferErc20SignedTransaction

  • Prepare a signed Celo transfer erc20 transaction with the private key locally. Nothing is broadcasted to the blockchain.

    Parameters

    Returns Promise<string>

    raw transaction data in hex, to be broadcasted to blockchain.

Const prepareCeloTransferErc721SignedTransaction

  • prepareCeloTransferErc721SignedTransaction(testnet: boolean, body: CeloTransferErc721, provider?: string): Promise<string>

  • Prepare a signed Celo transfer erc721 transaction with the private key locally. Nothing is broadcasted to the blockchain.

    Parameters

    Returns Promise<string>

    raw transaction data in hex, to be broadcasted to blockchain.

Const prepareCeloTransferMultiTokenSignedTransaction

  • prepareCeloTransferMultiTokenSignedTransaction(testnet: boolean, body: CeloTransferMultiToken, provider?: string): Promise<string>

  • Prepare a signed Celo transfer multiple tokens transaction with the private key locally. Nothing is broadcasted to the blockchain.

    Parameters

    Returns Promise<string>

    raw transaction data in hex, to be broadcasted to blockchain.

Const prepareCeloUpdateCashbackForAuthorErc721SignedTransaction

  • prepareCeloUpdateCashbackForAuthorErc721SignedTransaction(testnet: boolean, body: CeloUpdateCashbackErc721, provider?: string): Promise<string>

  • Prepare a signed Celo update cashback for author erc721 transaction with the private key locally. Nothing is broadcasted to the blockchain.

    Parameters

    Returns Promise<string>

    raw transaction data in hex, to be broadcasted to blockchain.

Const prepareCustodialWallet

  • This method is @Deprecated. Use @link{prepareCustodialWalletBatch} instead Generate new smart contract based custodial wallet. This wallet is able to receive any type of assets, but transaction costs connected to the withdrawal of assets is covered by the deployer.

    Parameters

    Returns Promise<string>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const prepareCustodialWalletBatch

  • Generate new smart contract based custodial wallet. This wallet is able to receive any type of assets, but transaction costs connected to the withdrawal of assets is covered by the deployer.

    Parameters

    • testnet: boolean

      chain to work with

    • body: GenerateCustodialAddressBatch

      request data

    • Optional provider: string

      optional provider to enter. if not present, Tatum Web3 will be used.

    Returns Promise<string>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const prepareCustomBep20SignedTransaction

  • prepareCustomBep20SignedTransaction(body: TransferErc20, provider?: string): Promise<string>

  • Sign Bsc custom BEP20 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: TransferErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Bsc Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareCustomErc20SignedTransaction

  • prepareCustomErc20SignedTransaction(body: TransferErc20, provider?: string): Promise<string>

  • Sign Ethereum custom ERC20 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: TransferErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareDeployAuction

  • prepareDeployAuction(testnet: boolean, body: DeployNftAuction, provider?: string): Promise<string>

  • Prepare signed transaction for NFT auction logic. Smart contract enables auction operator to create new auction for NFT (ERC-721/1155). Operator can set a fee in percentage, which will be paid on top of the price of the asset. can be offered for native asset - ETH, BSC, etc. - or any ERC20 token - this is configurable during auction creation. Before auction is created, seller must approve transfer of the NFT to the auction contract. Buyer will bid for the asset from the auction using native asset - send assets along the gid() smart contract call, or via ERC20 token. Buyer of the auction must perform approval for the smart contract to access ERC20 token, before the actual bid() method is called. Once there is higher bid than the actual one, the previous bidder's funds will be returned to him and new bidder will be the current winning one. When auction ends, anyone can settle the auction - NFT will be sent to the bidder, assets to the seller and fee to the operator.

    Parameters

    • testnet: boolean

      chain to work with

    • body: DeployNftAuction

      request data

    • Optional provider: string

      optional provider to enter. if not present, Tatum Web3 will be used.

    Returns Promise<string>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const prepareDeployBep20SignedTransaction

  • prepareDeployBep20SignedTransaction(body: DeployErc20, provider?: string): Promise<string>

  • Sign Bsc deploy BEP20 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: DeployErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Bsc Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareDeployErc20SignedTransaction

  • prepareDeployErc20SignedTransaction(body: DeployErc20, provider?: string): Promise<string>

  • Sign Ethereum deploy ERC20 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: DeployErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareDeployMarketplaceListing

  • Prepare signed transaction for deploy new smart contract for NFT marketplace logic. Smart contract enables marketplace operator to create new listing for NFT (ERC-721/1155). Operator can set a fee in percentage, which will be paid on top of the price of the asset. Listing can be offered for native asset - ETH, BSC, etc. - or any ERC20 token - this is configurable during listing creation. Once the listing is created, seller must send the NFT asset to the smart contract. Buyer will buy the asset from the listing using native asset - send assets along the buyAssetFromListing() smart contract call, or via ERC20 token. Buyer of the listing must perform approval for the smart contract to access ERC20 token, before the actual buyAssetFromListing() method is called. Once both assets - from buyer and seller - are in the smart contract, NFT is sent to the buyer, price is sent to the seller and marketplace fee is set to the operator.

    Parameters

    Returns Promise<string>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const prepareDogecoinSignedOffchainTransaction

  • prepareDogecoinSignedOffchainTransaction(testnet: boolean, data: WithdrawalResponseData[], amount: string, address: string, mnemonic?: string, keyPair?: KeyPair[], changeAddress?: string, xpub?: string, multipleAmounts?: string[], signatureId?: string): Promise<any>

  • Sign Dogecoin transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • data: WithdrawalResponseData[]

      data from Tatum system to prepare transaction from

    • amount: string

      amount to send

    • address: string

      recipient address, if multiple recipients are present, it should be string separated by ','

    • Optional mnemonic: string

      mnemonic to sign transaction from. mnemonic or keyPair must be present

    • Optional keyPair: KeyPair[]

      keyPair to sign transaction from. keyPair or mnemonic must be present

    • Optional changeAddress: string

      address to send the rest of the unused coins

    • Optional xpub: string

      xpub of the wallet

    • Optional multipleAmounts: string[]

      if multiple recipients are present in the address separated by ',', this should be list of amounts to send

    • Optional signatureId: string

      if using KMS, this is signatureId of the wallet representing mnemonic

    Returns Promise<any>

    transaction data to be broadcast to blockchain.

Const prepareDogecoinSignedTransaction

  • Sign Dogecoin transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    Returns Promise<any>

    transaction data to be broadcast to blockchain.

Const prepareEgldAddOrBurnNftQuantitySignedTransaction

  • prepareEgldAddOrBurnNftQuantitySignedTransaction(body: EgldEsdtTransaction, provider?: string): Promise<string>

  • Sign ESDT Burn or Add quantity (SFT only) transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EgldEsdtTransaction

      content of the transaction to broadcast

    • Optional provider: string

      url of the EGLD Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareEgldBurnEsdtSignedTransaction

  • prepareEgldBurnEsdtSignedTransaction(body: EgldEsdtTransaction, provider?: string): Promise<string>

  • Sign ESDT burn transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EgldEsdtTransaction

      content of the transaction to broadcast

    • Optional provider: string

      url of the EGLD Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareEgldControlChangesEsdtSignedTransaction

  • prepareEgldControlChangesEsdtSignedTransaction(body: EgldEsdtTransaction, provider?: string): Promise<string>

  • Sign ESDT control changes (upgrading props) transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EgldEsdtTransaction

      content of the transaction to broadcast

    • Optional provider: string

      url of the EGLD Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareEgldCreateNftOrSftSignedTransaction

  • prepareEgldCreateNftOrSftSignedTransaction(body: EgldEsdtTransaction, provider?: string): Promise<string>

  • Sign ESDT create NFT/SFT transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EgldEsdtTransaction

      content of the transaction to broadcast

    • Optional provider: string

      url of the EGLD Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareEgldDeployEsdtSignedTransaction

  • prepareEgldDeployEsdtSignedTransaction(body: EgldEsdtTransaction, provider?: string): Promise<string>

  • Sign ESDT transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EgldEsdtTransaction

      content of the transaction to broadcast

    • Optional provider: string

      url of the EGLD Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareEgldDeployNftOrSftSignedTransaction

  • prepareEgldDeployNftOrSftSignedTransaction(body: EgldEsdtTransaction, provider?: string): Promise<string>

  • Sign ESDT issue transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EgldEsdtTransaction

      content of the transaction to broadcast

    • Optional provider: string

      url of the EGLD Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareEgldFreezeNftSignedTransaction

  • prepareEgldFreezeNftSignedTransaction(body: EgldEsdtTransaction, provider?: string): Promise<string>

  • Sign ESDT freeze NFT transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EgldEsdtTransaction

      content of the transaction to broadcast

    • Optional provider: string

      url of the EGLD Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareEgldFreezeOrWipeOrOwvershipEsdtSignedTransaction

  • prepareEgldFreezeOrWipeOrOwvershipEsdtSignedTransaction(body: EgldEsdtTransaction, provider?: string): Promise<string>

  • Sign ESDT freze | wipe | transfer ownership transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EgldEsdtTransaction

      content of the transaction to broadcast

    • Optional provider: string

      url of the EGLD Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareEgldMintEsdtSignedTransaction

  • prepareEgldMintEsdtSignedTransaction(body: EgldEsdtTransaction, provider?: string): Promise<string>

  • Sign ESDT mint transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EgldEsdtTransaction

      content of the transaction to broadcast

    • Optional provider: string

      url of the EGLD Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareEgldPauseEsdtSignedTransaction

  • prepareEgldPauseEsdtSignedTransaction(body: EgldEsdtTransaction, provider?: string): Promise<string>

  • Sign ESDT pause transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EgldEsdtTransaction

      content of the transaction to broadcast

    • Optional provider: string

      url of the EGLD Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareEgldSignedTransaction

  • Sign EGLD transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EgldEsdtTransaction

      content of the transaction to broadcast

    • Optional provider: string

      url of the EGLD Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareEgldSpecialRoleEsdtOrNftSignedTransaction

  • prepareEgldSpecialRoleEsdtOrNftSignedTransaction(body: EgldEsdtTransaction, provider?: string): Promise<string>

  • Sign ESDT special role transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EgldEsdtTransaction

      content of the transaction to broadcast

    • Optional provider: string

      url of the EGLD Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareEgldStopNftCreateSignedTransaction

  • prepareEgldStopNftCreateSignedTransaction(body: EgldEsdtTransaction, provider?: string): Promise<string>

  • Sign ESDT stop NFT create transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EgldEsdtTransaction

      content of the transaction to broadcast

    • Optional provider: string

      url of the EGLD Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareEgldStoreDataTransaction

  • prepareEgldStoreDataTransaction(body: CreateRecord, provider?: string): Promise<string>

  • Sign EGLD Store data transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: CreateRecord

      content of the transaction to broadcast

    • Optional provider: string

      url of the EGLD Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareEgldTransferEsdtSignedTransaction

  • prepareEgldTransferEsdtSignedTransaction(body: EgldEsdtTransaction, provider?: string): Promise<string>

  • Sign ESDT transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EgldEsdtTransaction

      content of the transaction to broadcast

    • Optional provider: string

      url of the EGLD Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareEgldTransferNftCreateRoleSignedTransaction

  • prepareEgldTransferNftCreateRoleSignedTransaction(body: EgldEsdtTransaction, provider?: string): Promise<string>

  • Sign ESDT transfer NFT create role transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EgldEsdtTransaction

      content of the transaction to broadcast

    • Optional provider: string

      url of the EGLD Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareEgldTransferNftSignedTransaction

  • prepareEgldTransferNftSignedTransaction(body: EgldEsdtTransaction, provider?: string): Promise<string>

  • Sign ESDT transfer NFT transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EgldEsdtTransaction

      content of the transaction to broadcast

    • Optional provider: string

      url of the EGLD Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareEgldWipeNftSignedTransaction

  • prepareEgldWipeNftSignedTransaction(body: EgldEsdtTransaction, provider?: string): Promise<string>

  • Sign ESDT freeze NFT transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EgldEsdtTransaction

      content of the transaction to broadcast

    • Optional provider: string

      url of the EGLD Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareEthBatchTransferMultiTokenSignedTransaction

  • prepareEthBatchTransferMultiTokenSignedTransaction(body: TransferMultiTokenBatch, provider?: string): Promise<string>

  • Sign Ethereum transfer ERC 1155 Batch transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: TransferMultiTokenBatch

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareEthBurnBatchMultiTokenSignedTransaction

  • prepareEthBurnBatchMultiTokenSignedTransaction(body: EthBurnMultiTokenBatch, provider?: string): Promise<string>

  • Sign Ethereum burn ERC 1155 batch transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EthBurnMultiTokenBatch

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareEthBurnErc20SignedTransaction

  • prepareEthBurnErc20SignedTransaction(body: BurnErc20, provider?: string): Promise<string>

  • Sign Ethereum burn ERC 721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: BurnErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareEthBurnErc721SignedTransaction

  • prepareEthBurnErc721SignedTransaction(body: EthBurnErc721, provider?: string): Promise<string>

  • Sign Ethereum burn ERC 721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EthBurnErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareEthBurnMultiTokenSignedTransaction

  • prepareEthBurnMultiTokenSignedTransaction(body: EthBurnMultiToken, provider?: string): Promise<string>

  • Sign Ethereum burn ERC 1155 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EthBurnMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareEthDeployAuctionSignedTransaction

  • prepareEthDeployAuctionSignedTransaction(body: DeployNftAuction, provider?: string): Promise<string>

  • Sign ETH deploy NFT Auction contract transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: DeployNftAuction

      content of the transaction to broadcast

    • Optional provider: string

      url of the ETH Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain, or signatureId in case of Tatum KMS

Const prepareEthDeployErc721SignedTransaction

  • prepareEthDeployErc721SignedTransaction(body: EthDeployErc721, provider?: string): Promise<string>

  • Sign Ethereum deploy ERC 721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EthDeployErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareEthDeployMarketplaceListingSignedTransaction

  • prepareEthDeployMarketplaceListingSignedTransaction(body: DeployMarketplaceListing, provider?: string): Promise<string>

  • Sign ETH generate custodial wallet address transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: DeployMarketplaceListing

      content of the transaction to broadcast

    • Optional provider: string

      url of the ETH Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain, or signatureId in case of Tatum KMS

Const prepareEthDeployMultiTokenSignedTransaction

  • prepareEthDeployMultiTokenSignedTransaction(body: EthDeployMultiToken, provider?: string): Promise<string>

  • Sign Ethereum deploy ERC 1155 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EthDeployMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareEthErc20SignedOffchainTransaction

  • Sign Ethereum custom ERC20 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    Returns Promise<{ gasLimit: string | number; txData: string }>

    transaction data to be broadcast to blockchain.

Const prepareEthGenerateCustodialWalletSignedTransaction

  • prepareEthGenerateCustodialWalletSignedTransaction(body: GenerateCustodialAddress, provider?: string): Promise<string>

  • Sign Eth generate custodial wallet address transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: GenerateCustodialAddress

      content of the transaction to broadcast

    • Optional provider: string

      url of the ETH Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareEthMintCashbackErc721SignedTransaction

  • prepareEthMintCashbackErc721SignedTransaction(body: EthMintErc721, provider?: string): Promise<string>

  • Sign Ethereum mint multiple ERC 721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EthMintErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareEthMintErc20SignedTransaction

  • prepareEthMintErc20SignedTransaction(body: MintErc20, provider?: string): Promise<string>

  • Sign Ethereum mint ERC 20 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: MintErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareEthMintErc721ProvenanceSignedTransaction

  • prepareEthMintErc721ProvenanceSignedTransaction(body: EthMintErc721, provider?: string): Promise<string>

  • Sign Ethereum mint ERC 721 provenance transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EthMintErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareEthMintErc721SignedTransaction

  • prepareEthMintErc721SignedTransaction(body: EthMintErc721, provider?: string): Promise<string>

  • Sign Ethereum mint ERC 721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EthMintErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareEthMintMultiTokenBatchSignedTransaction

  • prepareEthMintMultiTokenBatchSignedTransaction(body: MintMultiTokenBatch, provider?: string): Promise<string>

  • Sign Ethereum mint ERC 1155 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: MintMultiTokenBatch

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareEthMintMultiTokenSignedTransaction

  • prepareEthMintMultiTokenSignedTransaction(body: MintMultiToken, provider?: string): Promise<string>

  • Sign Ethereum mint ERC 1155 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: MintMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareEthMintMultipleCashbackErc721SignedTransaction

  • prepareEthMintMultipleCashbackErc721SignedTransaction(body: EthMintMultipleErc721, provider?: string): Promise<string>

  • Sign Ethereum mint multiple ERC 721 Cashback transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EthMintMultipleErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareEthMintMultipleErc721ProvenanceSignedTransaction

  • prepareEthMintMultipleErc721ProvenanceSignedTransaction(body: EthMintMultipleErc721, provider?: string): Promise<string>

  • Sign Ethereum mint multiple ERC 721 Provenance transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EthMintMultipleErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareEthMintMultipleErc721SignedTransaction

  • prepareEthMintMultipleErc721SignedTransaction(body: EthMintMultipleErc721, provider?: string): Promise<string>

  • Sign Ethereum mint multiple ERC 721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EthMintMultipleErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareEthOrErc20SignedTransaction

  • prepareEthOrErc20SignedTransaction(body: TransferErc20, provider?: string): Promise<string>

  • Sign Ethereum or supported ERC20 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: TransferErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareEthSignedOffchainTransaction

  • Sign Ethereum transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    Returns Promise<{ gasLimit: string | number; txData: string }>

    transaction data to be broadcast to blockchain.

Const prepareEthTransferErc721SignedTransaction

  • prepareEthTransferErc721SignedTransaction(body: EthTransferErc721, provider?: string): Promise<string>

  • Sign Ethereum transfer ERC 721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EthTransferErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareEthTransferMultiTokenSignedTransaction

  • prepareEthTransferMultiTokenSignedTransaction(body: TransferMultiToken, provider?: string): Promise<string>

  • Sign Ethereum transfer ERC 1155 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: TransferMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareEthUpdateCashbackForAuthorErc721SignedTransaction

  • prepareEthUpdateCashbackForAuthorErc721SignedTransaction(body: UpdateCashbackErc721, provider?: string): Promise<string>

  • Sign Ethereum update cashback ERC 721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: UpdateCashbackErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareKlaytnBatchTransferMultiTokenSignedTransaction

  • prepareKlaytnBatchTransferMultiTokenSignedTransaction(testnet: boolean, body: TransferMultiTokenBatch, provider?: string): Promise<string>

  • Sign Klay batch transfer multiple tokens transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TransferMultiTokenBatch

      content of the transaction to broadcast

    • Optional provider: string

      url of the Klay Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareKlaytnBurnErc20SignedTransaction

  • prepareKlaytnBurnErc20SignedTransaction(testnet: boolean, body: BurnErc20, provider?: string): Promise<string>

  • Sign Klay burn erc20 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: BurnErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Klay Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareKlaytnBurnErc721SignedTransaction

  • prepareKlaytnBurnErc721SignedTransaction(testnet: boolean, body: EthBurnErc721, provider?: string): Promise<string>

  • Sign Klay burn erc721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: EthBurnErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Klay Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareKlaytnBurnMultiTokenBatchSignedTransaction

  • prepareKlaytnBurnMultiTokenBatchSignedTransaction(testnet: boolean, body: EthBurnMultiTokenBatch, provider?: string): Promise<string>

  • Sign Klay burn multiple tokens batch transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: EthBurnMultiTokenBatch

      content of the transaction to broadcast

    • Optional provider: string

      url of the Klay Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareKlaytnBurnMultiTokenSignedTransaction

  • prepareKlaytnBurnMultiTokenSignedTransaction(testnet: boolean, body: EthBurnMultiToken, provider?: string): Promise<string>

  • Sign Klay burn multiple tokens transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: EthBurnMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Klay Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareKlaytnClient

  • prepareKlaytnClient(testnet: boolean, provider?: string, fromPrivateKey?: string): default

  • Parameters

    • testnet: boolean
    • Optional provider: string
    • Optional fromPrivateKey: string

    Returns default

Const prepareKlaytnDeployAuctionSignedTransaction

  • prepareKlaytnDeployAuctionSignedTransaction(testnet: boolean, body: DeployNftAuction, provider?: string): Promise<string>

  • Sign Klay deploy NFT Auction contract transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean
    • body: DeployNftAuction

      content of the transaction to broadcast

    • Optional provider: string

      url of the Klay Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain, or signatureId in case of Tatum KMS

Const prepareKlaytnDeployErc20SignedTransaction

  • prepareKlaytnDeployErc20SignedTransaction(testnet: boolean, body: DeployErc20, provider?: string): Promise<string>

  • Sign Klay deploy erc20 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: DeployErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Klay Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareKlaytnDeployErc721SignedTransaction

  • prepareKlaytnDeployErc721SignedTransaction(testnet: boolean, body: EthDeployErc721, provider?: string): Promise<string>

  • Sign Klay deploy erc721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: EthDeployErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Klay Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareKlaytnDeployMarketplaceListingSignedTransaction

  • prepareKlaytnDeployMarketplaceListingSignedTransaction(testnet: boolean, body: DeployMarketplaceListing, provider?: string): Promise<string>

  • Sign Klay generate custodial wallet address transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean
    • body: DeployMarketplaceListing

      content of the transaction to broadcast

    • Optional provider: string

      url of the Klay Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain, or signatureId in case of Tatum KMS

Const prepareKlaytnDeployMultiTokenSignedTransaction

  • prepareKlaytnDeployMultiTokenSignedTransaction(testnet: boolean, body: EthDeployMultiToken, provider?: string): Promise<string>

  • Sign Klay deploy multiple tokens transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: EthDeployMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Klay Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareKlaytnGenerateCustodialWalletSignedTransaction

  • prepareKlaytnGenerateCustodialWalletSignedTransaction(testnet: boolean, body: GenerateCustodialAddress, provider?: string): Promise<string>

  • Sign Klay generate custodial wallet transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: GenerateCustodialAddress

      content of the transaction to broadcast

    • Optional provider: string

      url of the Klay Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareKlaytnMintCashbackErc721SignedTransaction

  • prepareKlaytnMintCashbackErc721SignedTransaction(testnet: boolean, body: EthMintErc721, provider?: string): Promise<string>

  • Sign Klay mint cashback erc721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: EthMintErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Klay Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareKlaytnMintErc20SignedTransaction

  • prepareKlaytnMintErc20SignedTransaction(testnet: boolean, body: MintErc20, provider?: string): Promise<string>

  • Sign Klay mint erc20 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: MintErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Klay Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareKlaytnMintErc721ProvenanceSignedTransaction

  • prepareKlaytnMintErc721ProvenanceSignedTransaction(testnet: boolean, body: EthMintErc721, provider?: string): Promise<string>

  • Sign Klay mint cashback erc721 provenance transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: EthMintErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Klay Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareKlaytnMintErc721SignedTransaction

  • prepareKlaytnMintErc721SignedTransaction(testnet: boolean, body: EthMintErc721, provider?: string): Promise<string>

  • Sign Klay mint erc721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: EthMintErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Klay Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareKlaytnMintMultiTokenBatchSignedTransaction

  • prepareKlaytnMintMultiTokenBatchSignedTransaction(testnet: boolean, body: MintMultiTokenBatch, provider?: string): Promise<string>

  • Sign Klay mint multiple tokens batch transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: MintMultiTokenBatch

      content of the transaction to broadcast

    • Optional provider: string

      url of the Klay Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareKlaytnMintMultiTokenSignedTransaction

  • prepareKlaytnMintMultiTokenSignedTransaction(testnet: boolean, body: MintMultiToken, provider?: string): Promise<string>

  • Sign Klay mint multiple tokens transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: MintMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Klay Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareKlaytnMintMultipleCashbackErc721SignedTransaction

  • prepareKlaytnMintMultipleCashbackErc721SignedTransaction(testnet: boolean, body: EthMintMultipleErc721, provider?: string): Promise<string>

  • Sign Klay mint multiple cashback erc721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: EthMintMultipleErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Klay Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareKlaytnMintMultipleErc721ProvenanceSignedTransaction

  • prepareKlaytnMintMultipleErc721ProvenanceSignedTransaction(testnet: boolean, body: EthMintMultipleErc721, provider?: string): Promise<string>

  • Sign Klay mint multiple cashback erc721 provenance transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: EthMintMultipleErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Klay Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareKlaytnMintMultipleErc721SignedTransaction

  • prepareKlaytnMintMultipleErc721SignedTransaction(testnet: boolean, body: EthMintMultipleErc721, provider?: string): Promise<string>

  • Sign Klay mint multiple erc721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: EthMintMultipleErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Klay Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareKlaytnSignedTransaction

  • prepareKlaytnSignedTransaction(testnet: boolean, body: TransferErc20, provider?: string): Promise<string>

  • Sign Klay transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TransferErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Klay Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareKlaytnSmartContractWriteMethodInvocation

  • Sign Klay smart contract write method invocation transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: SmartContractMethodInvocation

      content of the transaction to broadcast

    • Optional provider: string

      url of the Klay Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareKlaytnStoreDataTransaction

  • prepareKlaytnStoreDataTransaction(testnet: boolean, body: CreateRecord, provider?: string): Promise<string>

  • Sign Klay store data transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: CreateRecord

      content of the transaction to broadcast

    • Optional provider: string

      url of the Klay Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareKlaytnTransferErc20SignedTransaction

  • prepareKlaytnTransferErc20SignedTransaction(testnet: boolean, body: TransferErc20, provider?: string): Promise<string>

  • Sign Klay transfer erc20 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TransferErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Klay Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareKlaytnTransferErc721SignedTransaction

  • prepareKlaytnTransferErc721SignedTransaction(testnet: boolean, body: EthTransferErc721, provider?: string): Promise<string>

  • Sign Klay transfer erc721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: EthTransferErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Klay Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareKlaytnTransferMultiTokenSignedTransaction

  • prepareKlaytnTransferMultiTokenSignedTransaction(testnet: boolean, body: TransferMultiToken, provider?: string): Promise<string>

  • Sign Klay transfer multiple tokens transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TransferMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Klay Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareKlaytnUpdateCashbackForAuthorErc721SignedTransaction

  • prepareKlaytnUpdateCashbackForAuthorErc721SignedTransaction(testnet: boolean, body: UpdateCashbackErc721, provider?: string): Promise<string>

  • Sign Klay update cashback for author erc721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: UpdateCashbackErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Klay Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareLitecoinSignedOffchainTransaction

  • prepareLitecoinSignedOffchainTransaction(testnet: boolean, data: WithdrawalResponseData[], amount: string, address: string, mnemonic?: string, keyPair?: KeyPair[], changeAddress?: string, xpub?: string, multipleAmounts?: string[], signatureId?: string): Promise<any>

  • Sign Litecoin transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • data: WithdrawalResponseData[]

      data from Tatum system to prepare transaction from

    • amount: string

      amount to send

    • address: string

      recipient address, if multiple recipients are present, it should be string separated by ','

    • Optional mnemonic: string

      mnemonic to sign transaction from. mnemonic or keyPair must be present

    • Optional keyPair: KeyPair[]

      keyPair to sign transaction from. keyPair or mnemonic must be present

    • Optional changeAddress: string

      address to send the rest of the unused coins

    • Optional xpub: string

      xpub of the wallet

    • Optional multipleAmounts: string[]

      if multiple recipients are present in the address separated by ',', this should be list of amounts to send

    • Optional signatureId: string

      if using KMS, this is signatureId of the wallet representing mnemonic

    Returns Promise<any>

    transaction data to be broadcast to blockchain.

Const prepareLitecoinSignedTransaction

  • prepareLitecoinSignedTransaction(testnet: boolean, body: TransferBtcLtcBlockchain): Promise<any>

  • Sign Litcoin transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TransferBtcLtcBlockchain

      content of the transaction to broadcast

    Returns Promise<any>

    transaction data to be broadcast to blockchain.

Const prepareMarketplaceApproveErc20Spending

  • prepareMarketplaceApproveErc20Spending(testnet: boolean, body: ApproveErc20, provider?: string): Promise<string>

  • Approve ERC20 spending for marketplace to perform buy with ERC20 token.

    Parameters

    • testnet: boolean

      chain to work with

    • body: ApproveErc20

      request data

    • Optional provider: string

      optional provider to enter. if not present, Tatum Web3 will be used.

    Returns Promise<string>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const prepareMarketplaceBuyListing

  • Buy listing on the marketplace. Buyer must either send native assets with this operation, or approve ERC20 token spending before. After listing is sold, it's in a pending state to be processed by the marketplace. Noone receives the assets unless the marketplace operator processes that.

    Parameters

    Returns Promise<string>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const prepareMarketplaceCancelListing

  • Cancel listing on the marketplace. Only possible for the seller or the operator. There must be no buyer present for that listing. NFT asset is sent back to the seller.

    Parameters

    Returns Promise<string>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const prepareMarketplaceCreateListing

  • Create new listing on the marketplace. After listing is created, seller must send the asset to the marketplace smart contract. Only listing for existing NFTs can be created - seller must be owner of the NFT asset.

    Parameters

    Returns Promise<string>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const prepareMarketplaceUpdateFee

Const prepareMarketplaceUpdateFeeRecipient

Const prepareMintBep20SignedTransaction

  • prepareMintBep20SignedTransaction(body: MintErc20, provider?: string): Promise<string>

  • Sign BEP20 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: MintErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Bsc Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareOneBatchTransferMultiTokenSignedTransaction

  • prepareOneBatchTransferMultiTokenSignedTransaction(testnet: boolean, body: OneTransferMultiTokenBatch, provider?: string): Promise<string>

  • Sign Harmony batch transfer multiple tokens transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: OneTransferMultiTokenBatch

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareOneBurn20SignedTransaction

  • prepareOneBurn20SignedTransaction(testnet: boolean, body: OneBurn20, provider?: string): Promise<string>

  • Sign Harmony burn erc20 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: OneBurn20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareOneBurn721SignedTransaction

  • prepareOneBurn721SignedTransaction(testnet: boolean, body: OneBurn721, provider?: string): Promise<string>

  • Sign Harmony burn erc721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: OneBurn721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareOneBurnMultiTokenBatchSignedTransaction

  • prepareOneBurnMultiTokenBatchSignedTransaction(testnet: boolean, body: OneBurnMultiTokenBatch, provider?: string): Promise<string>

  • Sign Harmony burn multiple tokens batch transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: OneBurnMultiTokenBatch

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareOneBurnMultiTokenSignedTransaction

  • prepareOneBurnMultiTokenSignedTransaction(testnet: boolean, body: OneBurnMultiToken, provider?: string): Promise<string>

  • Sign Harmony burn multiple tokens transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: OneBurnMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareOneClient

  • prepareOneClient(testnet: boolean, provider?: string, fromPrivateKey?: string): default

  • Parameters

    • testnet: boolean
    • Optional provider: string
    • Optional fromPrivateKey: string

    Returns default

Const prepareOneDeploy20SignedTransaction

  • prepareOneDeploy20SignedTransaction(testnet: boolean, body: OneDeploy20, provider?: string): Promise<string>

  • Sign Harmony deploy erc20 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: OneDeploy20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareOneDeploy721SignedTransaction

  • prepareOneDeploy721SignedTransaction(testnet: boolean, body: OneDeploy721, provider?: string): Promise<string>

  • Sign Harmony deploy erc721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: OneDeploy721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareOneDeployAuctionSignedTransaction

  • prepareOneDeployAuctionSignedTransaction(testnet: boolean, body: DeployNftAuction, provider?: string): Promise<string>

  • Sign ONE deploy NFT Auction contract transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean
    • body: DeployNftAuction

      content of the transaction to broadcast

    • Optional provider: string

      url of the One Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain, or signatureId in case of Tatum KMS

Const prepareOneDeployMarketplaceListingSignedTransaction

  • prepareOneDeployMarketplaceListingSignedTransaction(testnet: boolean, body: DeployMarketplaceListing, provider?: string): Promise<string>

  • Sign ONE generate custodial wallet address transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean
    • body: DeployMarketplaceListing

      content of the transaction to broadcast

    • Optional provider: string

      url of the One Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain, or signatureId in case of Tatum KMS

Const prepareOneDeployMultiTokenSignedTransaction

  • prepareOneDeployMultiTokenSignedTransaction(testnet: boolean, body: OneDeployMultiToken, provider?: string): Promise<string>

  • Sign Harmony deploy multiple tokens transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: OneDeployMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareOneGenerateCustodialWalletSignedTransaction

  • prepareOneGenerateCustodialWalletSignedTransaction(testnet: boolean, body: GenerateCustodialAddress, provider?: string): Promise<string>

  • Sign Harmony generate custodial wallet transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: GenerateCustodialAddress

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareOneMint20SignedTransaction

  • prepareOneMint20SignedTransaction(testnet: boolean, body: OneMint20, provider?: string): Promise<string>

  • Sign Harmony mint erc20 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: OneMint20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareOneMint721ProvenanceSignedTransaction

  • prepareOneMint721ProvenanceSignedTransaction(testnet: boolean, body: OneMint721, provider?: string): Promise<string>

  • Sign Harmony mint cashback erc721 provenance transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: OneMint721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareOneMint721SignedTransaction

  • prepareOneMint721SignedTransaction(testnet: boolean, body: OneMint721, provider?: string): Promise<string>

  • Sign Harmony mint erc721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: OneMint721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareOneMintCashback721SignedTransaction

  • prepareOneMintCashback721SignedTransaction(testnet: boolean, body: OneMint721, provider?: string): Promise<string>

  • Sign Harmony mint cashback erc721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: OneMint721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareOneMintMultiTokenBatchSignedTransaction

  • prepareOneMintMultiTokenBatchSignedTransaction(testnet: boolean, body: OneMintMultiTokenBatch, provider?: string): Promise<string>

  • Sign Harmony mint multiple tokens transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: OneMintMultiTokenBatch

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareOneMintMultiTokenSignedTransaction

  • prepareOneMintMultiTokenSignedTransaction(testnet: boolean, body: OneMintMultiToken, provider?: string): Promise<string>

  • Sign Harmony mint multiple tokens transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: OneMintMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareOneMintMultiple721ProvenanceSignedTransaction

  • prepareOneMintMultiple721ProvenanceSignedTransaction(testnet: boolean, body: OneMintMultiple721, provider?: string): Promise<string>

  • Sign Harmony mint multiple cashback erc721 provenance transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: OneMintMultiple721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareOneMintMultiple721SignedTransaction

  • prepareOneMintMultiple721SignedTransaction(testnet: boolean, body: OneMintMultiple721, provider?: string): Promise<string>

  • Sign Harmony mint multiple erc721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: OneMintMultiple721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareOneMintMultipleCashback721SignedTransaction

  • prepareOneMintMultipleCashback721SignedTransaction(testnet: boolean, body: OneMintMultiple721, provider?: string): Promise<string>

  • Sign Harmony mint multiple cashback erc721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: OneMintMultiple721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareOneSignedTransaction

  • prepareOneSignedTransaction(testnet: boolean, body: OneTransfer, provider?: string): Promise<string>

  • Sign Harmony transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: OneTransfer

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareOneSmartContractWriteMethodInvocation

  • Sign Harmony smart contract write method invocation transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: SmartContractMethodInvocation

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareOneStoreDataTransaction

  • prepareOneStoreDataTransaction(testnet: boolean, body: CreateRecord, provider?: string): Promise<string>

  • Sign Harmony store data transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: CreateRecord

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareOneTransfer20SignedTransaction

  • prepareOneTransfer20SignedTransaction(testnet: boolean, body: OneTransfer20, provider?: string): Promise<string>

  • Sign Harmony transfer erc20 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: OneTransfer20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareOneTransfer721SignedTransaction

  • prepareOneTransfer721SignedTransaction(testnet: boolean, body: OneTransfer721, provider?: string): Promise<string>

  • Sign Harmony transfer erc721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: OneTransfer721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareOneTransferMultiTokenSignedTransaction

  • prepareOneTransferMultiTokenSignedTransaction(testnet: boolean, body: OneTransferMultiToken, provider?: string): Promise<string>

  • Sign Harmony transfer multiple tokens transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: OneTransferMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareOneUpdateCashbackForAuthor721SignedTransaction

  • prepareOneUpdateCashbackForAuthor721SignedTransaction(testnet: boolean, body: OneUpdateCashback721, provider?: string): Promise<string>

  • Sign Harmony update cashback for author 721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: OneUpdateCashback721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const preparePolygonBatchTransferMultiTokenSignedTransaction

  • preparePolygonBatchTransferMultiTokenSignedTransaction(testnet: boolean, body: TransferMultiTokenBatch, provider?: string): Promise<string>

  • Sign Polygon batch transfer multiple tokens transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TransferMultiTokenBatch

      content of the transaction to broadcast

    • Optional provider: string

      url of the Polygon Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const preparePolygonBurnErc20SignedTransaction

  • preparePolygonBurnErc20SignedTransaction(testnet: boolean, body: BurnErc20, provider?: string): Promise<string>

  • Sign Polygon burn erc20 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: BurnErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Polygon Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const preparePolygonBurnErc721SignedTransaction

  • preparePolygonBurnErc721SignedTransaction(testnet: boolean, body: EthBurnErc721, provider?: string): Promise<string>

  • Sign Polygon burn erc721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: EthBurnErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Polygon Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const preparePolygonBurnMultiTokenBatchSignedTransaction

  • preparePolygonBurnMultiTokenBatchSignedTransaction(testnet: boolean, body: EthBurnMultiTokenBatch, provider?: string): Promise<string>

  • Sign Polygon burn multiple tokens batch transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: EthBurnMultiTokenBatch

      content of the transaction to broadcast

    • Optional provider: string

      url of the Polygon Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const preparePolygonBurnMultiTokenSignedTransaction

  • preparePolygonBurnMultiTokenSignedTransaction(testnet: boolean, body: EthBurnMultiToken, provider?: string): Promise<string>

  • Sign Polygon burn multiple tokens transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: EthBurnMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Polygon Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const preparePolygonClient

  • preparePolygonClient(testnet: boolean, provider?: string, fromPrivateKey?: string): default

  • Parameters

    • testnet: boolean
    • Optional provider: string
    • Optional fromPrivateKey: string

    Returns default

Const preparePolygonDeployAuctionSignedTransaction

  • preparePolygonDeployAuctionSignedTransaction(testnet: boolean, body: DeployNftAuction, provider?: string): Promise<string>

  • Sign Polygon deploy NFT Auction contract transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean
    • body: DeployNftAuction

      content of the transaction to broadcast

    • Optional provider: string

      url of the Polygon Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain, or signatureId in case of Tatum KMS

Const preparePolygonDeployErc20SignedTransaction

  • preparePolygonDeployErc20SignedTransaction(testnet: boolean, body: DeployErc20, provider?: string): Promise<string>

  • Sign Polygon deploy erc20 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: DeployErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Polygon Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const preparePolygonDeployErc721SignedTransaction

  • preparePolygonDeployErc721SignedTransaction(testnet: boolean, body: EthDeployErc721, provider?: string): Promise<string>

  • Sign Polygon deploy erc721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: EthDeployErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Polygon Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const preparePolygonDeployMarketplaceListingSignedTransaction

  • preparePolygonDeployMarketplaceListingSignedTransaction(testnet: boolean, body: DeployMarketplaceListing, provider?: string): Promise<string>

  • Sign Polygon generate custodial wallet address transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean
    • body: DeployMarketplaceListing

      content of the transaction to broadcast

    • Optional provider: string

      url of the Polygon Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain, or signatureId in case of Tatum KMS

Const preparePolygonDeployMultiTokenSignedTransaction

  • preparePolygonDeployMultiTokenSignedTransaction(testnet: boolean, body: EthDeployMultiToken, provider?: string): Promise<string>

  • Sign Polygon deploy multiple tokens transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: EthDeployMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Polygon Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const preparePolygonGenerateCustodialWalletSignedTransaction

  • preparePolygonGenerateCustodialWalletSignedTransaction(testnet: boolean, body: GenerateCustodialAddress, provider?: string): Promise<string>

  • Sign Polygon generate custodial wallet transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: GenerateCustodialAddress

      content of the transaction to broadcast

    • Optional provider: string

      url of the Polygon Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const preparePolygonMintCashbackErc721SignedTransaction

  • preparePolygonMintCashbackErc721SignedTransaction(testnet: boolean, body: EthMintErc721, provider?: string): Promise<string>

  • Sign Polygon mint cashback erc721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: EthMintErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Polygon Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const preparePolygonMintErc20SignedTransaction

  • preparePolygonMintErc20SignedTransaction(testnet: boolean, body: MintErc20, provider?: string): Promise<string>

  • Sign Polygon mint erc20 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: MintErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Polygon Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const preparePolygonMintErc721ProvenanceSignedTransaction

  • preparePolygonMintErc721ProvenanceSignedTransaction(testnet: boolean, body: EthMintErc721, provider?: string): Promise<string>

  • Sign Polygon mint cashback erc721 provenance transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: EthMintErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Polygon Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const preparePolygonMintErc721SignedTransaction

  • preparePolygonMintErc721SignedTransaction(testnet: boolean, body: EthMintErc721, provider?: string): Promise<string>

  • Sign Polygon mint erc721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: EthMintErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Polygon Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const preparePolygonMintMultiTokenBatchSignedTransaction

  • preparePolygonMintMultiTokenBatchSignedTransaction(testnet: boolean, body: MintMultiTokenBatch, provider?: string): Promise<string>

  • Sign Polygon mint multiple tokens batch transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: MintMultiTokenBatch

      content of the transaction to broadcast

    • Optional provider: string

      url of the Polygon Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const preparePolygonMintMultiTokenSignedTransaction

  • preparePolygonMintMultiTokenSignedTransaction(testnet: boolean, body: MintMultiToken, provider?: string): Promise<string>

  • Sign Polygon mint multiple tokens transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: MintMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Polygon Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const preparePolygonMintMultipleCashbackErc721SignedTransaction

  • preparePolygonMintMultipleCashbackErc721SignedTransaction(testnet: boolean, body: EthMintMultipleErc721, provider?: string): Promise<string>

  • Sign Polygon mint multiple cashback erc721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: EthMintMultipleErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Polygon Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const preparePolygonMintMultipleErc721ProvenanceSignedTransaction

  • preparePolygonMintMultipleErc721ProvenanceSignedTransaction(testnet: boolean, body: EthMintMultipleErc721, provider?: string): Promise<string>

  • Sign Polygon mint multiple cashback erc721 provenance transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: EthMintMultipleErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Polygon Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const preparePolygonMintMultipleErc721SignedTransaction

  • preparePolygonMintMultipleErc721SignedTransaction(testnet: boolean, body: EthMintMultipleErc721, provider?: string): Promise<string>

  • Sign Polygon mint multiple erc721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: EthMintMultipleErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Polygon Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const preparePolygonSignedTransaction

  • preparePolygonSignedTransaction(testnet: boolean, body: TransferErc20, provider?: string): Promise<string>

  • Sign Polygon transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TransferErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Polygon Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const preparePolygonSmartContractWriteMethodInvocation

  • Sign Polygon smart contract write method invocation transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: SmartContractMethodInvocation

      content of the transaction to broadcast

    • Optional provider: string

      url of the Polygon Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const preparePolygonStoreDataTransaction

  • preparePolygonStoreDataTransaction(testnet: boolean, body: CreateRecord, provider?: string): Promise<string>

  • Sign Polygon store data transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: CreateRecord

      content of the transaction to broadcast

    • Optional provider: string

      url of the Polygon Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const preparePolygonTransferErc20SignedTransaction

  • preparePolygonTransferErc20SignedTransaction(testnet: boolean, body: TransferErc20, provider?: string): Promise<string>

  • Sign Polygon transfer erc20 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TransferErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Polygon Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const preparePolygonTransferErc721SignedTransaction

  • preparePolygonTransferErc721SignedTransaction(testnet: boolean, body: EthTransferErc721, provider?: string): Promise<string>

  • Sign Polygon transfer erc721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: EthTransferErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Polygon Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const preparePolygonTransferMultiTokenSignedTransaction

  • preparePolygonTransferMultiTokenSignedTransaction(testnet: boolean, body: TransferMultiToken, provider?: string): Promise<string>

  • Sign Polygon transfer multiple tokens transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TransferMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Polygon Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const preparePolygonUpdateCashbackForAuthorErc721SignedTransaction

  • preparePolygonUpdateCashbackForAuthorErc721SignedTransaction(testnet: boolean, body: UpdateCashbackErc721, provider?: string): Promise<string>

  • Sign Polygon update cashback for author erc721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: UpdateCashbackErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Polygon Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareSmartContractWriteMethodInvocation

  • Sign Ethereum invoke smart contract transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: SmartContractMethodInvocation

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareStoreDataTransaction

  • prepareStoreDataTransaction(body: CreateRecord, provider?: string): Promise<string>

  • Sign Ethereum Store data transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: CreateRecord

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareTransferFromCustodialWallet

Const prepareTronBurnTrc721SignedTransaction

  • prepareTronBurnTrc721SignedTransaction(testnet: boolean, body: TronBurnTrc721, provider?: string): Promise<string>

  • Sign Tron burn trc721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TronBurnTrc721

      content of the transaction to broadcast

    • Optional provider: string

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareTronCreateTrc10SignedKMSTransaction

  • prepareTronCreateTrc10SignedKMSTransaction(testnet: boolean, body: CreateTronTrc10, provider?: string): Promise<string>

  • Prepare create Tron TRC10 transaction for KMS. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: CreateTronTrc10

      content of the transaction to broadcast

    • Optional provider: string

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareTronCreateTrc10SignedTransaction

  • prepareTronCreateTrc10SignedTransaction(testnet: boolean, body: CreateTronTrc10, provider?: string): Promise<string>

  • Sign create Tron TRC10 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: CreateTronTrc10

      content of the transaction to broadcast

    • Optional provider: string

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareTronCreateTrc20SignedKMSTransaction

  • prepareTronCreateTrc20SignedKMSTransaction(testnet: boolean, body: CreateTronTrc20, provider?: string): Promise<string>

  • Prepare create Tron TRC20 transaction for KMS. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: CreateTronTrc20

      content of the transaction to broadcast

    • Optional provider: string

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareTronCreateTrc20SignedTransaction

  • prepareTronCreateTrc20SignedTransaction(testnet: boolean, body: CreateTronTrc20, provider?: string): Promise<string>

  • Sign create Tron TRC20 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: CreateTronTrc20

      content of the transaction to broadcast

    • Optional provider: string

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareTronCustodialTransferBatch

  • prepareTronCustodialTransferBatch(testnet: boolean, body: SmartContractMethodInvocation, feeLimit: number, from?: string, provider?: string): Promise<string>

  • Sign Tron custodial transfer batch transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: SmartContractMethodInvocation

      content of the transaction to broadcast

    • feeLimit: number
    • Optional from: string
    • Optional provider: string

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareTronDeployMarketplaceListingSignedTransaction

  • prepareTronDeployMarketplaceListingSignedTransaction(testnet: boolean, body: DeployTronMarketplaceListing, provider?: string): Promise<string>

  • Sign TRON deploy new smart contract for NFT marketplace transaction. Smart contract enables marketplace operator to create new listing for NFT (ERC-721/1155).

    Parameters

    • testnet: boolean

      chain to work with

    • body: DeployTronMarketplaceListing

      request data

    • Optional provider: string

      optional provider to enter. if not present, Tatum provider will be used.

    Returns Promise<string>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const prepareTronDeployTrc721SignedTransaction

  • prepareTronDeployTrc721SignedTransaction(testnet: boolean, body: TronDeployTrc721, provider?: string): Promise<string>

  • Sign Tron deploy trc721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TronDeployTrc721

      content of the transaction to broadcast

    • Optional provider: string

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareTronFreezeKMSTransaction

  • prepareTronFreezeKMSTransaction(testnet: boolean, body: FreezeTron, provider?: string): Promise<string>

  • Prepare Tron Freeze balance transaction for KMS. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: FreezeTron

      content of the transaction to broadcast

    • Optional provider: string

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareTronFreezeTransaction

  • prepareTronFreezeTransaction(testnet: boolean, body: FreezeTron, provider?: string): Promise<string>

  • Sign Tron Freeze balance transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: FreezeTron

      content of the transaction to broadcast

    • Optional provider: string

      optional provider to enter. if not present, Tatum provider will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareTronGenerateCustodialWalletSignedTransaction

  • prepareTronGenerateCustodialWalletSignedTransaction(testnet: boolean, body: GenerateTronCustodialAddress, provider?: string): Promise<string>

  • Sign Tron generate custodial wallet transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: GenerateTronCustodialAddress

      content of the transaction to broadcast

    • Optional provider: string

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareTronMintCashbackTrc721SignedTransaction

  • prepareTronMintCashbackTrc721SignedTransaction(testnet: boolean, body: TronMintTrc721, provider?: string): Promise<string>

  • Sign Tron deploy trc721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TronMintTrc721

      content of the transaction to broadcast

    • Optional provider: string

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareTronMintMultipleTrc721SignedTransaction

  • prepareTronMintMultipleTrc721SignedTransaction(testnet: boolean, body: TronMintMultipleTrc721, provider?: string): Promise<string>

  • Sign Tron mint multiple trc721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TronMintMultipleTrc721

      content of the transaction to broadcast

    • Optional provider: string

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareTronMintTrc721SignedTransaction

  • prepareTronMintTrc721SignedTransaction(testnet: boolean, body: TronMintTrc721, provider?: string): Promise<string>

  • Sign Tron mint trc721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TronMintTrc721

      content of the transaction to broadcast

    • Optional provider: string

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareTronSignedKMSTransaction

  • prepareTronSignedKMSTransaction(testnet: boolean, body: TransferTron, provider?: string): Promise<string>

  • Prepare Tron transaction for KMS. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TransferTron

      content of the transaction to broadcast

    • Optional provider: string

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareTronSignedTransaction

  • prepareTronSignedTransaction(testnet: boolean, body: TransferTron, provider?: string): Promise<string>

  • Sign Tron transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TransferTron

      content of the transaction to broadcast

    • Optional provider: string

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareTronSmartContractInvocation

  • prepareTronSmartContractInvocation(testnet: boolean, body: SmartContractMethodInvocation, feeLimit: number, from?: string, provider?: string): Promise<string>

  • Sign Tron custodial transfer transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: SmartContractMethodInvocation

      content of the transaction to broadcast

    • feeLimit: number
    • Optional from: string
    • Optional provider: string

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareTronTransferTrc721SignedTransaction

  • prepareTronTransferTrc721SignedTransaction(testnet: boolean, body: TronTransferTrc721, provider?: string): Promise<string>

  • Sign Tron transfer trc721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TronTransferTrc721

      content of the transaction to broadcast

    • Optional provider: string

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareTronTrc10SignedKMSTransaction

  • prepareTronTrc10SignedKMSTransaction(testnet: boolean, body: TransferTronTrc10, precision?: number, provider?: string): Promise<string>

  • Prepare Tron TRC10 transaction for KMS. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TransferTronTrc10

      content of the transaction to broadcast

    • Optional precision: number
    • Optional provider: string

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareTronTrc10SignedTransaction

  • prepareTronTrc10SignedTransaction(testnet: boolean, body: TransferTronTrc10, precision?: number, provider?: string): Promise<string>

  • Sign Tron TRC10 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TransferTronTrc10

      content of the transaction to broadcast

    • Optional precision: number
    • Optional provider: string

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareTronTrc20SignedKMSTransaction

  • prepareTronTrc20SignedKMSTransaction(testnet: boolean, body: TransferTronTrc20, provider?: string): Promise<string>

  • Prepare Tron TRC20 transaction for KMS. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TransferTronTrc20

      content of the transaction to broadcast

    • Optional provider: string

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareTronTrc20SignedTransaction

  • prepareTronTrc20SignedTransaction(testnet: boolean, body: TransferTronTrc20, provider?: string): Promise<string>

  • Sign Tron TRC20 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TransferTronTrc20

      content of the transaction to broadcast

    • Optional provider: string

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareTronUpdateCashbackForAuthorTrc721SignedTransaction

  • prepareTronUpdateCashbackForAuthorTrc721SignedTransaction(testnet: boolean, body: TronUpdateCashbackTrc721, provider?: string): Promise<string>

  • Sign Tron update cashback for author trc721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TronUpdateCashbackTrc721

      content of the transaction to broadcast

    • Optional provider: string

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareVetSignedTransaction

  • prepareVetSignedTransaction(testnet: boolean, body: TransferVet, provider?: string): Promise<any>

  • Sign VeChain transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TransferVet

      content of the transaction to broadcast

    • Optional provider: string

      url of the VeChain Server to connect to. If not set, default public server will be used.

    Returns Promise<any>

    transaction data to be broadcast to blockchain.

Const prepareXdcBurnErc20SignedTransaction

  • prepareXdcBurnErc20SignedTransaction(body: BurnErc20, provider?: string): Promise<string>

  • Sign ERC20 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: BurnErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the XDC Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareXdcBurnErc721SignedTransaction

  • prepareXdcBurnErc721SignedTransaction(body: EthBurnErc721, provider?: string): Promise<string>

  • Sign XDC burn ERC 721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EthBurnErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the XDC Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareXdcCustomErc20SignedTransaction

  • prepareXdcCustomErc20SignedTransaction(body: TransferErc20, provider?: string): Promise<string>

  • Sign XDC custom ERC20 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: TransferErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the XDC Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareXdcDeployErc20SignedTransaction

  • prepareXdcDeployErc20SignedTransaction(body: DeployErc20, provider?: string): Promise<string>

  • Sign XDC deploy ERC20 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: DeployErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the XDC Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareXdcDeployErc721SignedTransaction

  • prepareXdcDeployErc721SignedTransaction(body: EthDeployErc721, provider?: string): Promise<string>

  • Sign XDC deploy ERC 721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EthDeployErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the XDC Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareXdcMintErc20SignedTransaction

  • prepareXdcMintErc20SignedTransaction(body: MintErc20, provider?: string): Promise<string>

  • Sign ERC20 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: MintErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the XDC Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareXdcMintErc721SignedTransaction

  • prepareXdcMintErc721SignedTransaction(body: EthMintErc721, provider?: string): Promise<string>

  • Sign XDC mint ERC 721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EthMintErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the XDC Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareXdcMintErcCashback721SignedTransaction

  • prepareXdcMintErcCashback721SignedTransaction(body: EthMintErc721, provider?: string): Promise<string>

  • Sign XDC mint ERC 721 transaction with cashback via private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EthMintErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the XDC Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareXdcMintMultipleCashbackErc721SignedTransaction

  • prepareXdcMintMultipleCashbackErc721SignedTransaction(body: EthMintMultipleErc721, provider?: string): Promise<string>

  • Sign XDC mint multiple ERC 721 Cashback transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EthMintMultipleErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the XDC Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareXdcMintMultipleErc721SignedTransaction

  • prepareXdcMintMultipleErc721SignedTransaction(body: EthMintMultipleErc721, provider?: string): Promise<string>

  • Sign XDC mint multiple ERC 721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EthMintMultipleErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the XDC Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareXdcOrErc20SignedTransaction

  • prepareXdcOrErc20SignedTransaction(body: TransferErc20, provider?: string): Promise<string>

  • Sign XDC or supported ERC20 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: TransferErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the XDC Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareXdcSmartContractWriteMethodInvocation

  • Sign XDC invoke smart contract transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: SmartContractMethodInvocation

      content of the transaction to broadcast

    • Optional provider: string

      url of the XDC Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareXdcStoreDataTransaction

  • prepareXdcStoreDataTransaction(body: CreateRecord, provider?: string): Promise<string>

  • Sign XDC Store data transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: CreateRecord

      content of the transaction to broadcast

    • Optional provider: string

      url of the XDC Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareXdcTransferErc721SignedTransaction

  • prepareXdcTransferErc721SignedTransaction(body: EthTransferErc721, provider?: string): Promise<string>

  • Sign XDC transfer ERC 721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: EthTransferErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the XDC Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareXdcUpdateCashbackForAuthorErc721SignedTransaction

  • prepareXdcUpdateCashbackForAuthorErc721SignedTransaction(body: UpdateCashbackErc721, provider?: string): Promise<string>

  • Sign XDC update cashback ERC 721 transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: UpdateCashbackErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the XDC Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareXlmSignedOffchainTransaction

  • prepareXlmSignedOffchainTransaction(testnet: boolean, account: any, amount: string, address: string, secret: string, memo?: Memo<MemoType>): Promise<string>

  • Sign Stellar transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • account: any

      Stellar account with information

    • amount: string

      amount to send

    • address: string

      recipient address

    • secret: string

      secret to sign transaction with

    • Optional memo: Memo<MemoType>

      short memo to include in transaction

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareXlmSignedTransaction

  • prepareXlmSignedTransaction(testnet: boolean, body: TransferXlm): Promise<string>

  • Sign Stellar transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TransferXlm

      content of the transaction to broadcast

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareXrpSignedOffchainTransaction

  • prepareXrpSignedOffchainTransaction(testnet: boolean, amount: string, address: string, secret: string, account: any, fee: string, sourceTag?: number, destinationTag?: string): Promise<string>

  • Sign Xrp transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • amount: string

      amount to send

    • address: string

      recipient address

    • secret: string

      secret to sign transaction with

    • account: any

      Xrp source account

    • fee: string

      fee to pay

    • Optional sourceTag: number

      source tag to include in transaction

    • Optional destinationTag: string

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const prepareXrpSignedTransaction

  • prepareXrpSignedTransaction(body: TransferXrp): Promise<string>

  • Sign Xrp transaction with private keys locally. Nothing is broadcast to the blockchain.

    Parameters

    • body: TransferXrp

      content of the transaction to broadcast

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const processFeeAndRest

  • processFeeAndRest(transactionBuilder: TransactionBuilder, fromAmountInLovelace: BigNumber, toAmountInLovelace: BigNumber, transferAdaBlockchain: TransferAdaBlockchain): Promise<void>

Const quorumCreateAccount

  • quorumCreateAccount(body: AccountPassword): Promise<{ success: boolean }>

Const quorumGetBlock

Const quorumGetCurrentBlock

  • quorumGetCurrentBlock(): Promise<number>

Const quorumGetTransaction

  • quorumGetTransaction(hash: string): Promise<QuorumTx>

Const quorumGetTransactionReceipt

Const quorumUnlockAccount

  • quorumUnlockAccount(address: string, body: AccountPassword): Promise<{ success: boolean }>

Const registerEthereumErc20

Const registerTronTrc

  • registerTronTrc(data: CreateTrcOffchain): Promise<Account>

Const removeDepositAddress

  • removeDepositAddress(id: string, address: string): Promise<void>

Const revokeVirtualCurrency

  • revokeVirtualCurrency(data: CurrencyOperation): Promise<{ reference: string }>

Const scryptaBroadcast

  • scryptaBroadcast(txData: string, signatureId?: string): Promise<TransactionHash>

Const scryptaGetBlock

Const scryptaGetBlockHash

  • scryptaGetBlockHash(i: number): Promise<BlockHash>

Const scryptaGetCurrentBlock

Const scryptaGetTransaction

  • scryptaGetTransaction(hash: string): Promise<ScryptaTx>

Const scryptaGetTxForAccount

  • scryptaGetTxForAccount(address: string, pageSize?: number, offset?: number): Promise<ScryptaTx[]>

Const scryptaGetUTXO

  • scryptaGetUTXO(hash: string, i: number): Promise<ScryptaUTXO>

Const scryptaGetUnspentForAccount

  • scryptaGetUnspentForAccount(address: string, pageSize?: number, offset?: number): Promise<ScryptaUTXO[]>

Const sendAdaOffchainTransaction

  • Send Ada transaction from Tatum Ledger account to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    Returns Promise<SignatureId | { completed: boolean; id: string; txId: string } | { id: string }>

    transaction id of the transaction in the blockchain or id of the withdrawal, if it was not cancelled automatically

Const sendAdaTransaction

  • Send Ada transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendAddMultiTokenMinter

  • sendAddMultiTokenMinter(testnet: boolean, body: AddMinter, provider?: string): Promise<unknown>

  • Add new minter to the MultiToken (1155) contract.

    Parameters

    • testnet: boolean

      if we use testnet or not

    • body: AddMinter

      body of the add minter request

    • Optional provider: string

      optional provider do broadcast tx

    Returns Promise<unknown>

Const sendAddNFTMinter

  • sendAddNFTMinter(testnet: boolean, body: AddMinter, provider?: string): Promise<unknown>

  • Add new minter to the NFT contract.

    Parameters

    • testnet: boolean

      if we use testnet or not

    • body: AddMinter

      body of the add minter request

    • Optional provider: string

      optional provider do broadcast tx

    Returns Promise<unknown>

Const sendAlgoBurnFTSignedTransaction

  • Sned Algorand burn FT transaction to the blockchain. This method broadcasts signed transaction to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • tx: BurnErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Algorand Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain.

Const sendAlgoBurnFractionalNFTSignedTransaction

  • Send Algorand burn Fractional NFT transaction to the blockchain. This method broadcasts signed transaction to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • tx: BurnMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Algorand Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain.

Const sendAlgoBurnNFTSignedTransaction

  • Send Algorand burn NFT transaction to the blockchain. This method broadcasts signed transaction to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • tx: BurnErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Algorand Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain.

Const sendAlgoCreateFTSignedTransaction

  • Send Algorand create FT transaction to the blockchain. This method broadcasts signed transaction to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • tx: DeployErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Algorand Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain.

Const sendAlgoCreateFractionalNFTSignedTransaction

  • Send Algorand create Fractinoal NFT transaction to the blockchain. This method broadcasts signed transaction to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • tx: MintMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Algorand Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain.

Const sendAlgoCreateNFTSignedTransaction

  • Send Algorand create NFT transaction to the blockchain. This method broadcasts signed transaction to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • tx: MintAlgoNft

      content of the transaction to broadcast

    • Optional provider: string

      url of the Algorand Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendAlgoReceiveNFTSignedTransaction

  • Send Algorand Receive NFT transaction to the blockchain. This method broadcasts signed transaction to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • tx: ReceiveAlgoNft

      content of the transaction to broadcast

    • Optional provider: string

      url of the Algorand Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain.

Const sendAlgoSignedTransaction

  • Send Algorand transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • tx: AlgoTransaction

      content of the transaction to broadcast

    • Optional provider: string

      url of the Algorand Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendAlgoTransferFTSignedTransaction

  • Send Algorand transfer FT transaction to the blockchain. This method broadcasts signed transaction to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • tx: TransferErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Algorand Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain.

Const sendAlgoTransferFractionalNFTSignedTransaction

  • Send Algorand transfer Fractinoal NFT transaction to the blockchain. This method broadcasts signed transaction to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • tx: TransferMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Algorand Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain.

Const sendAlgoTransferNFTSignedTransaction

  • Send Algorand Transfer NFT transaction to the blockchain. This method broadcasts signed transaction to the blockchain.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • tx: TransferAlgoNft

      content of the transaction to broadcast

    • Optional provider: string

      url of the Algorand Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain.

Const sendApproveErc20

  • sendApproveErc20(testnet: boolean, body: ApproveErc20, provider?: string): Promise<unknown>

  • Approve ERC20 transfer for spender.

    Parameters

    • testnet: boolean

      chain to work with

    • body: ApproveErc20

      request data

    • Optional provider: string

      optional provider to enter. if not present, Tatum Web3 will be used.

    Returns Promise<unknown>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const sendApproveFromCustodialWallet

  • Send signed approve transaction from the custodial SC wallet.

    Parameters

    • testnet: boolean

      chain to work with

    • body: ApproveCustodialTransfer

      request data

    • Optional provider: string

      optional provider to enter. if not present, Tatum Web3 will be used.

    Returns Promise<unknown>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const sendAuctionApproveErc20Transfer

  • sendAuctionApproveErc20Transfer(testnet: boolean, body: ApproveErc20, provider?: string): Promise<unknown>

  • Approve ERC20 transfer for auction to perform bidding on the asset in the auction.

    Parameters

    • testnet: boolean

      chain to work with

    • body: ApproveErc20

      request data

    • Optional provider: string

      optional provider to enter. if not present, Tatum Web3 will be used.

    Returns Promise<unknown>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const sendAuctionApproveNftTransfer

  • sendAuctionApproveNftTransfer(testnet: boolean, body: ApproveNftTransfer, provider?: string): Promise<unknown>

  • Approve NFT transfer for auction to perform listing of the asset.

    Parameters

    • testnet: boolean

      chain to work with

    • body: ApproveNftTransfer

      request data

    • Optional provider: string

      optional provider to enter. if not present, Tatum Web3 will be used.

    Returns Promise<unknown>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const sendAuctionBid

  • Bid auction on the auction. Buyer must either send native assets with this operation, or approve ERC20 token spending before. After auction is sold, it's in a pending state to be processed by the auction. Noone receives the assets unless the auction operator processes that.

    Parameters

    • testnet: boolean

      chain to work with

    • body: InvokeAuctionOperation

      request data

    • Optional provider: string

      optional provider to enter. if not present, Tatum Web3 will be used.

    Returns Promise<unknown>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const sendAuctionCancel

  • Cancel auction on the auction. Only possible for the seller or the operator. There must be no buyer present for that auction. NFT asset is sent back to the seller.

    Parameters

    • testnet: boolean

      chain to work with

    • body: InvokeAuctionOperation

      request data

    • Optional provider: string

      optional provider to enter. if not present, Tatum Web3 will be used.

    Returns Promise<unknown>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const sendAuctionCreate

  • sendAuctionCreate(testnet: boolean, body: CreateAuction, provider?: string): Promise<unknown>

  • Create new auction on the auction contract. Before auction, seller must approve spending of the NFT token for the Auction contract. After auction is created, auction contract transfers the asset to the auction smart contract. Only auction for existing NFTs can be created - seller must be owner of the NFT asset.

    Parameters

    • testnet: boolean

      chain to work with

    • body: CreateAuction

      request data

    • Optional provider: string

      optional provider to enter. if not present, Tatum Web3 will be used.

    Returns Promise<unknown>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const sendAuctionSettle

  • Settle auction. There must be buyer present for that auction. NFT will be sent to the bidder, assets to the seller and fee to the operator.

    Parameters

    • testnet: boolean

      chain to work with

    • body: InvokeAuctionOperation

      request data

    • Optional provider: string

      optional provider to enter. if not present, Tatum Web3 will be used.

    Returns Promise<unknown>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const sendAuctionUpdateFee

  • sendAuctionUpdateFee(testnet: boolean, body: UpdateAuctionFee, provider?: string): Promise<unknown>

  • Update auction fee.

    Parameters

    • testnet: boolean

      chain to work with

    • body: UpdateAuctionFee

      request data

    • Optional provider: string

      optional provider to enter. if not present, Tatum Web3 will be used.

    Returns Promise<unknown>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const sendAuctionUpdateFeeRecipient

  • Update auction fee recipient.

    Parameters

    • testnet: boolean

      chain to work with

    • body: UpdateMarketplaceFeeRecipient

      request data

    • Optional provider: string

      optional provider to enter. if not present, Tatum Web3 will be used.

    Returns Promise<unknown>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const sendBatchTransferFromCustodialWallet

Const sendBep721Transaction

  • Send Bsc BEP721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: EthTransferErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Bsc Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendBitcoinCashOffchainTransaction

  • sendBitcoinCashOffchainTransaction(testnet: boolean, body: TransferBtcBasedOffchain): Promise<SignatureId | { completed: boolean; id: string; txId: string } | { id: string }>

  • Send Bitcoin Cash transaction from Tatum Ledger account to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    Returns Promise<SignatureId | { completed: boolean; id: string; txId: string } | { id: string }>

    transaction id of the transaction in the blockchain or id of the withdrawal, if it was not cancelled automatically

Const sendBitcoinCashTransaction

  • Send Bitcoin Cash transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TransferBchBlockchain

      content of the transaction to broadcast

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendBitcoinOffchainTransaction

  • Send Bitcoin transaction from Tatum Ledger account to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    Returns Promise<SignatureId | { completed: boolean; id: string; txId: string } | { id: string }>

    transaction id of the transaction in the blockchain or id of the withdrawal, if it was not cancelled automatically

Const sendBitcoinTransaction

  • sendBitcoinTransaction(testnet: boolean, body: TransferBtcLtcBlockchain): Promise<TransactionHash>

  • Send Bitcoin transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TransferBtcLtcBlockchain

      content of the transaction to broadcast

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendBscBurnBatchMultiTokenTransaction

Const sendBscBurnMultiTokenTransaction

Const sendBscDeployMarketplaceListingSignedTransaction

  • Deploy new smart contract for NFT marketplace logic. Smart contract enables marketplace operator to create new listing for NFT (ERC-721/1155).

    Parameters

    • body: DeployMarketplaceListing

      request data

    • Optional provider: string

      optional provider to enter. if not present, Tatum Web3 will be used.

    Returns Promise<TransactionHash>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const sendBscDeployMultiTokenTransaction

Const sendBscGenerateCustodialWalletSignedTransaction

Const sendBscMintMultiTokenBatchTransaction

Const sendBscMintMultiTokenTransaction

Const sendBscMultiTokenBatchTransaction

Const sendBscMultiTokenTransaction

  • Send Bsc MultiToken transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: TransferMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Bsc Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendBscOffchainTransaction

  • sendBscOffchainTransaction(testnet: boolean, body: TransferEthOffchain, provider?: string): Promise<SignatureId | { completed: boolean; id: string; txId: string } | { id: string }>

  • Send Bsc transaction from Tatum Ledger account to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TransferEthOffchain

      content of the transaction to broadcast

    • Optional provider: string

      url of the Bsc Server to connect to. If not set, default public server will be used.

    Returns Promise<SignatureId | { completed: boolean; id: string; txId: string } | { id: string }>

    transaction id of the transaction in the blockchain or id of the withdrawal, if it was not cancelled automatically

Const sendBscOrBep20Transaction

  • Send Bsc or supported BEP20 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: TransferBscBep20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Bsc Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendBscSmartContractMethodInvocationTransaction

  • Send Bsc invoke smart contract transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    Returns Promise<TransactionHash | { data: any }>

    transaction id of the transaction in the blockchain

Const sendBscSmartContractReadMethodInvocationTransaction

  • Send Bsc invoke smart contract transaction to the blockchain. Invoked method only reads from blockchain the data and returns them back.

    Parameters

    • body: SmartContractReadMethodInvocation

      content of the transaction to broadcast

    • Optional provider: string

      url of the Bsc Server to connect to. If not set, default public server will be used.

    Returns Promise<{ data: any }>

Const sendBscStoreDataTransaction

  • Send Bsc store data transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: CreateRecord

      content of the transaction to broadcast

    • Optional provider: string

      url of the Bsc Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendBurnBep721Transaction

  • Send Bsc BEP721 burn transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: EthBurnErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Bsc Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendBurnErc721Transaction

  • Send Ethereum ERC721 burn transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: EthBurnErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendCeloBurnErc721Transaction

  • Send Celo burn erc721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: CeloBurnErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Celo Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendCeloBurnMultiTokenBatchTransaction

  • Send Celo burn multiple tokens batch transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: CeloBurnMultiTokenBatch

      content of the transaction to broadcast

    • Optional provider: string

      url of the Celo Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendCeloBurnMultiTokenTransaction

  • Send Celo burn multiple tokens transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: CeloBurnMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Celo Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendCeloDeployErc20Transaction

Const sendCeloDeployErc721Transaction

  • Send Celo deploy erc721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: CeloDeployErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Celo Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendCeloDeployMarketplaceListingSignedTransaction

  • Deploy new smart contract for NFT marketplace logic. Smart contract enables marketplace operator to create new listing for NFT (ERC-721/1155).

    Parameters

    • testnet: boolean

      chain to work with

    • body: DeployMarketplaceListing

      request data

    • Optional provider: string

      optional provider to enter. if not present, Tatum Web3 will be used.

    Returns Promise<TransactionHash>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const sendCeloDeployMultiTokenTransaction

  • Send Celo deploy multiple tokens transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: CeloDeployMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Celo Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendCeloErc20Transaction

  • Send Celo or cUsd transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TransferCeloOrCeloErc20Token

      content of the transaction to broadcast

    • Optional provider: string

      url of the Celo Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendCeloGenerateCustodialWalletSignedTransaction

  • Send generate custodial wallet transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: GenerateCustodialAddress

      content of the transaction to broadcast

    • Optional provider: string

      url of the Celo Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendCeloMintCashbackErc721Transaction

  • Send Celo mint cashback erc721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: CeloMintErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Celo Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendCeloMintErc721ProvenanceTransaction

  • Send Celo mint provenance cashback erc721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: CeloMintErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Celo Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendCeloMintErc721Transaction

  • Send Celo mint erc721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: CeloMintErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Celo Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendCeloMintMultiTokenBatchTransaction

  • Send Celo mint multiple tokens batch transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: CeloMintMultiTokenBatch

      content of the transaction to broadcast

    • Optional provider: string

      url of the Celo Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendCeloMintMultiTokenTransaction

  • Send Celo mint multiple tokens transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: CeloMintMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Celo Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendCeloMintMultipleCashbackErc721Transaction

  • Send Celo mint multiple cashback erc721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: CeloMintMultipleErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Celo Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendCeloMintMultipleErc721ProvenanceTransaction

  • Send Celo mint multiple provenance erc721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: CeloMintMultipleErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Celo Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendCeloMintMultipleErc721Transaction

  • Send Celo mint multiple erc721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: CeloMintMultipleErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Celo Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendCeloOffchainTransaction

  • sendCeloOffchainTransaction(testnet: boolean, body: TransferCeloOffchain, provider?: string): Promise<SignatureId | { completed: boolean; id: string; txId: string } | { id: string }>

  • Send Celo transaction from Tatum Ledger account to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TransferCeloOffchain

      content of the transaction to broadcast

    • Optional provider: string

      url of the Celo Server to connect to. If not set, default public server will be used.

    Returns Promise<SignatureId | { completed: boolean; id: string; txId: string } | { id: string }>

    transaction id of the transaction in the blockchain or id of the withdrawal, if it was not cancelled automatically

Const sendCeloOrcUsdTransaction

  • Send Celo or cUsd transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TransferCeloOrCeloErc20Token

      content of the transaction to broadcast

    • Optional provider: string

      url of the Celo Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendCeloSmartContractMethodInvocationTransaction

Const sendCeloSmartContractReadMethodInvocationTransaction

  • Prepare a signed Celo smart contract read method invocation transaction with the private key locally. Nothing is broadcasted to the blockchain.

    Parameters

    Returns Promise<{ data: any }>

    raw transaction data in hex, to be broadcasted to blockchain.

Const sendCeloStoreDataSignedTransaction

Const sendCeloTransferErc721Transaction

  • Send Celo transfer nft transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: CeloTransferErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Celo Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendCeloTransferMultiTokenBatchTransaction

  • Send Celo transfer multiple tokens batch transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: CeloTransferMultiTokenBatch

      content of the transaction to broadcast

    • Optional provider: string

      url of the Celo Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendCeloTransferMultiTokenTransaction

  • Send Celo transfer multiple tokens transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: CeloTransferMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Celo Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendCeloUpdateCashbackForAuthorErc721Transaction

  • Send Celo update cashback for author erc721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: CeloUpdateCashbackErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Celo Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendCustodialWallet

  • deprecated,

    use generateCustodialWalletBatch Generate new smart contract based custodial wallet. This wallet is able to receive any type of assets, but transaction costs connected to the withdrawal of assets is covered by the deployer.

    Parameters

    Returns Promise<unknown>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const sendCustomBep20Transaction

  • Send Bsc custom BEP20 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: TransferErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Bsc Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendCustomErc20Transaction

  • Send Ethereum custom ERC20 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: TransferErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendDeployBep20Transaction

  • Send Bsc deploy BEP20 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: DeployErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Bsc Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendDeployBep721Transaction

  • Send Bsc BEP721 deploy to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: EthDeployErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Bsc Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendDeployErc20Transaction

  • Send Ethereum deploy ERC20 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: DeployErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendDeployErc721Transaction

  • Send Ethereum ERC721 deploy to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: EthDeployErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendDogecoinOffchainTransaction

  • Send Dogecoin transaction from Tatum Ledger account to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    Returns Promise<SignatureId | { completed: boolean; id: string; txId: string } | { id: string }>

    transaction id of the transaction in the blockchain or id of the withdrawal, if it was not cancelled automatically

Const sendDogecoinTransaction

  • Send Dogecoin transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendEgldDeployEsdtTransaction

  • Send EGLD deploy ESDT transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: EgldEsdtTransaction

      content of the transaction to broadcast

    • Optional provider: string

      url of the EGLD Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendEgldDeployNftTransaction

  • Send EGLD NFT deploy to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: EgldEsdtTransaction

      content of the transaction to broadcast

    • Optional provider: string

      url of the EGLD Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendEgldOffchainTransaction

  • sendEgldOffchainTransaction(testnet: boolean, body: EgldTransferOffchain, provider?: string): Promise<SignatureId | { completed: boolean; id: string; txId: string } | { id: string }>

  • Send EGLD transaction from Tatum Ledger account to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: EgldTransferOffchain

      content of the transaction to broadcast

    • Optional provider: string

      url of the EGLD Server to connect to. If not set, default public server will be used.

    Returns Promise<SignatureId | { completed: boolean; id: string; txId: string } | { id: string }>

    transaction id of the transaction in the blockchain or id of the withdrawal, if it was not cancelled automatically

Const sendEgldSmartContractMethodInvocationTransaction

  • Send EGLD invoke smart contract transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: EgldEsdtTransaction

      content of the transaction to broadcast

    • Optional provider: string

      url of the EGLD Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendEgldStoreDataTransaction

  • Send EGLD store data transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: CreateRecord

      content of the transaction to broadcast

    • Optional provider: string

      url of the EGLD Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendEgldTransaction

  • Send EGLD or supported ERC20 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: EgldEsdtTransaction

      content of the transaction to broadcast

    • Optional provider: string

      url of the EGLD Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendEgldTransferNftTransaction

  • Send EGLD ERC721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: EgldEsdtTransaction

      content of the transaction to broadcast

    • Optional provider: string

      url of the EGLD Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendErc721Transaction

  • Send Ethereum ERC721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: EthTransferErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendEthBurnBatchMultiTokenTransaction

  • Send Ethereum MultiToken burn batch transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: EthBurnMultiTokenBatch

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendEthBurnMultiTokenTransaction

  • Send Ethereum MultiToken burn transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: EthBurnMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendEthDeployMarketplaceListingSignedTransaction

  • Deploy new smart contract for NFT marketplace logic. Smart contract enables marketplace operator to create new listing for NFT (ERC-721/1155).

    Parameters

    • body: DeployMarketplaceListing

      request data

    • Optional provider: string

      optional provider to enter. if not present, Tatum Web3 will be used.

    Returns Promise<TransactionHash>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const sendEthDeployMultiTokenTransaction

  • Send Ethereum MultiToken deploy to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: EthDeployMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendEthErc20OffchainTransaction

  • Send Ethereum ERC20 transaction from Tatum Ledger account to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TransferEthOffchain

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<SignatureId | { id: string }>

    transaction id of the transaction in the blockchain or id of the withdrawal, if it was not cancelled automatically

Const sendEthGenerateCustodialWalletSignedTransaction

  • Send Ethereum generate custodial wallet transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: GenerateCustodialAddress

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendEthMintMultiTokenBatchTransaction

  • Send Ethereum MultiToken mint batch transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: MintMultiTokenBatch

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendEthMintMultiTokenTransaction

  • Send Ethereum MultiToken mint transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: MintMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendEthMintMultipleCashbackErc721SignedTransaction

  • Send Ethereum ERC721 mint multiple cashback transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: EthMintMultipleErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendEthMultiTokenBatchTransaction

  • Send Ethereum MultiToken batch transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: TransferMultiTokenBatch

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendEthMultiTokenTransaction

  • Send Ethereum MultiToken transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: TransferMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendEthOffchainTransaction

  • sendEthOffchainTransaction(testnet: boolean, body: TransferEthOffchain, provider?: string): Promise<SignatureId | { completed: boolean; id: string; txId: string } | { id: string }>

  • Send Ethereum transaction from Tatum Ledger account to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TransferEthOffchain

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<SignatureId | { completed: boolean; id: string; txId: string } | { id: string }>

    transaction id of the transaction in the blockchain or id of the withdrawal, if it was not cancelled automatically

Const sendEthOrErc20Transaction

  • Send Ethereum or supported ERC20 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: TransferErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendFlowNftBurnToken

  • sendFlowNftBurnToken(testnet: boolean, body: FlowBurnNft, proposer?: (isPayer: boolean) => any, payer?: (isPayer: boolean) => any): Promise<{ txId: string }>

  • Send Flow NFT burn token transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: FlowBurnNft

      content of the transaction to broadcast

    • Optional proposer: (isPayer: boolean) => any

      function to obtain proposer key from

        • (isPayer: boolean): any

        • Parameters

          • isPayer: boolean

          Returns any

    • Optional payer: (isPayer: boolean) => any

      function to obtain payer key from

        • (isPayer: boolean): any

        • Parameters

          • isPayer: boolean

          Returns any

    Returns Promise<{ txId: string }>

    txId id of the transaction in the blockchain

Const sendFlowNftMintMultipleToken

  • sendFlowNftMintMultipleToken(testnet: boolean, body: FlowMintMultipleNft, proposer?: (isPayer: boolean) => any, payer?: (isPayer: boolean) => any): Promise<{ tokenId: number[]; txId: string }>

  • Send Flow NFT mint multiple tokens transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: FlowMintMultipleNft

      content of the transaction to broadcast

    • Optional proposer: (isPayer: boolean) => any

      function to obtain proposer key from

        • (isPayer: boolean): any

        • Parameters

          • isPayer: boolean

          Returns any

    • Optional payer: (isPayer: boolean) => any

      function to obtain payer key from

        • (isPayer: boolean): any

        • Parameters

          • isPayer: boolean

          Returns any

    Returns Promise<{ tokenId: number[]; txId: string }>

    txId id of the transaction in the blockchain

Const sendFlowNftMintToken

  • sendFlowNftMintToken(testnet: boolean, body: FlowMintNft, proposer?: (isPayer: boolean) => any, payer?: (isPayer: boolean) => any): Promise<{ tokenId: string; txId: string }>

  • Send Flow NFT mint token transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: FlowMintNft

      content of the transaction to broadcast

    • Optional proposer: (isPayer: boolean) => any

      function to obtain proposer key from

        • (isPayer: boolean): any

        • Parameters

          • isPayer: boolean

          Returns any

    • Optional payer: (isPayer: boolean) => any

      function to obtain payer key from

        • (isPayer: boolean): any

        • Parameters

          • isPayer: boolean

          Returns any

    Returns Promise<{ tokenId: string; txId: string }>

    txId id of the transaction in the blockchain

Const sendFlowNftTransferToken

  • sendFlowNftTransferToken(testnet: boolean, body: FlowTransferNft, proposer?: (isPayer: boolean) => any, payer?: (isPayer: boolean) => any): Promise<{ txId: string }>

  • Send Flow NFT transfer token transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: FlowTransferNft

      content of the transaction to broadcast

    • Optional proposer: (isPayer: boolean) => any

      function to obtain proposer key from

        • (isPayer: boolean): any

        • Parameters

          • isPayer: boolean

          Returns any

    • Optional payer: (isPayer: boolean) => any

      function to obtain payer key from

        • (isPayer: boolean): any

        • Parameters

          • isPayer: boolean

          Returns any

    Returns Promise<{ txId: string }>

    id of the transaction in the blockchain and events this tx produced

Const sendKlaytnBatchTransferMultiTokenSignedTransaction

  • Send Klay batch transfer multiple tokens transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: TransferMultiTokenBatch

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendKlaytnBurnErc20SignedTransaction

  • Send Klay burn erc20 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: BurnErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendKlaytnBurnErc721SignedTransaction

  • Send Klay burn erc721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: EthBurnErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendKlaytnBurnMultiTokenBatchSignedTransaction

  • Send Klay burn multiple tokens batch transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: BurnMultiTokenBatch

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendKlaytnBurnMultiTokenSignedTransaction

  • Send Klay burn multiple tokens erc721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: BurnMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendKlaytnDeployErc20SignedTransaction

  • Send Klay deploy erc20 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: DeployErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendKlaytnDeployErc721SignedTransaction

  • Send Klay deploy erc721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: EthDeployErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendKlaytnDeployMarketplaceListingSignedTransaction

  • Deploy new smart contract for NFT marketplace logic. Smart contract enables marketplace operator to create new listing for NFT (ERC-721/1155).

    Parameters

    • testnet: boolean

      chain to work with

    • body: DeployMarketplaceListing

      request data

    • Optional provider: string

      optional provider to enter. if not present, Tatum Web3 will be used.

    Returns Promise<TransactionHash>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const sendKlaytnDeployMultiTokenSignedTransaction

  • Send Klay deploy multiple tokens transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: EthDeployMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendKlaytnGenerateCustodialWalletSignedTransaction

  • Send Klay generate custodial wallet transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: GenerateCustodialAddress

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendKlaytnMintCashbackErc721SignedTransaction

  • Send Klay mint cashback erc721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: EthMintErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendKlaytnMintErc20SignedTransaction

  • Send Klay mint erc20 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: MintErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendKlaytnMintErc721ProvenanceSignedTransaction

  • Send Klay mint cashback erc721 provenance transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: EthMintErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendKlaytnMintErc721SignedTransaction

  • Send Klay mint erc721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: EthMintErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendKlaytnMintMultiTokenBatchSignedTransaction

  • Send Klay mint multiple tokens batch transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: MintMultiTokenBatch

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendKlaytnMintMultiTokenSignedTransaction

  • Send Klay mint multiple tokens transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: MintMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendKlaytnMintMultipleCashbackErc721SignedTransaction

  • Send Klay mint multiple erc721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: EthMintMultipleErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendKlaytnMintMultipleErc721ProvenanceSignedTransaction

  • Send Klay mint multiple erc721 Provenance transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: EthMintMultipleErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendKlaytnMintMultipleErc721SignedTransaction

  • Send Klay mint multiple erc721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: EthMintMultipleErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendKlaytnSmartContractMethodInvocationTransaction

  • Send Klay smart contract method invocation transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    Returns Promise<TransactionHash | { data: any }>

    transaction id of the transaction in the blockchain

Const sendKlaytnSmartContractReadMethodInvocationTransaction

Const sendKlaytnStoreDataTransaction

  • Send Klay smart store data transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: CreateRecord

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendKlaytnTransaction

  • Send Klay transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TransferErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Klay Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendKlaytnTransferErc20SignedTransaction

  • Send Klay transfer erc20 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: TransferErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendKlaytnTransferErc721SignedTransaction

  • Send Klay transfer erc721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: EthTransferErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendKlaytnTransferMultiTokenSignedTransaction

  • Send Klay transfer multiple tokens transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: TransferMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendKlaytnUpdateCashbackForAuthorErc721SignedTransaction

  • Send Klay update cashback for author erc721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: UpdateCashbackErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendKlaytntnOffchainTransaction

  • sendKlaytntnOffchainTransaction(testnet: boolean, body: TransferEthOffchain, provider?: string): Promise<SignatureId | { completed: boolean; id: string; txId: string } | { id: string }>

  • Send Klaytn transaction from Tatum Ledger account to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TransferEthOffchain

      content of the transaction to broadcast

    • Optional provider: string

      url of the Klaytn Server to connect to. If not set, default public server will be used.

    Returns Promise<SignatureId | { completed: boolean; id: string; txId: string } | { id: string }>

    transaction id of the transaction in the blockchain or id of the withdrawal, if it was not cancelled automatically

Const sendLitecoinOffchainTransaction

  • Send Litecoin transaction from Tatum Ledger account to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    Returns Promise<SignatureId | { completed: boolean; id: string; txId: string } | { id: string }>

    transaction id of the transaction in the blockchain or id of the withdrawal, if it was not cancelled automatically

Const sendLitecoinTransaction

  • sendLitecoinTransaction(testnet: boolean, body: TransferBtcLtcBlockchain): Promise<TransactionHash>

  • Send Litecoin transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TransferBtcLtcBlockchain

      content of the transaction to broadcast

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendMarketplaceApproveErc20Spending

  • sendMarketplaceApproveErc20Spending(testnet: boolean, body: ApproveErc20, provider?: string): Promise<unknown>

  • Approve ERC20 spending for marketplace to perform buy with ERC20 token.

    Parameters

    • testnet: boolean

      chain to work with

    • body: ApproveErc20

      request data

    • Optional provider: string

      optional provider to enter. if not present, Tatum Web3 will be used.

    Returns Promise<unknown>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const sendMarketplaceBuyListing

  • Buy listing on the marketplace. Buyer must either send native assets with this operation, or approve ERC20 token spending before. After listing is sold, it's in a pending state to be processed by the marketplace. Noone receives the assets unless the marketplace operator processes that.

    Parameters

    Returns Promise<unknown>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const sendMarketplaceCancelListing

  • Cancel listing on the marketplace. Only possible for the seller or the operator. There must be no buyer present for that listing. NFT asset is sent back to the seller.

    Parameters

    Returns Promise<unknown>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const sendMarketplaceCreateListing

  • Create new listing on the marketplace. After listing is created, seller must send the asset to the marketplace smart contract. Only listing for existing NFTs can be created - seller must be owner of the NFT asset.

    Parameters

    Returns Promise<unknown>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const sendMarketplaceUpdateFee

  • Update marketplace fee.

    Parameters

    Returns Promise<unknown>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const sendMarketplaceUpdateFeeRecipient

Const sendMintBep721ProvenanceTransaction

  • Send Bsc BEP721 mint provenance transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: EthMintErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Bsc Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendMintBep721Transaction

  • Send Bsc BEP721 mint transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: EthMintErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Bsc Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendMintBepCashback721Transaction

  • Send Bsc BEP721 mint transaction to the blockchain with cashback details. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: EthMintErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Bsc Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendMintCashbackErc721Transaction

  • Send Ethereum ERC721 mint with cashback transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: EthMintErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendMintErc721ProvenanceTransaction

  • Send Ethereum ERC721 provenance mint with cashback transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: EthMintErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendMintErc721Transaction

  • Send Ethereum ERC721 mint transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: EthMintErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendMintMultipleBep721ProvenanceTransaction

  • Send Bsc BEP721 mint multiple provenance transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: EthMintMultipleErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Bsc Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendMintMultipleBep721Transaction

  • Send Bsc BEP721 mint multiple transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: EthMintMultipleErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Bsc Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendMintMultipleCashbackBep721Transaction

  • Send Bsc BEP721 mint multiple transaction with cashback to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: EthMintMultipleErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Bsc Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendMintMultipleErc721ProvenanceTransaction

  • Send Ethereum ERC721 mint multiple provenance transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: EthMintMultipleErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendMintMultipleErc721Transaction

  • Send Ethereum ERC721 mint multiple transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: EthMintMultipleErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendOneBatchTransferMultiTokenSignedTransaction

  • Send Harmony batch transfer multiple tokens transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: OneTransferMultiTokenBatch

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendOneBurn20SignedTransaction

  • Send Harmony burn erc20 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: OneBurn20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendOneBurn721SignedTransaction

  • Send Harmony burn erc721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: OneBurn721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendOneBurnMultiTokenBatchSignedTransaction

  • Send Harmony burn multiple tokens batch transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: OneBurnMultiTokenBatch

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendOneBurnMultiTokenSignedTransaction

  • Send Harmony burn multiple tokens transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: OneBurnMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendOneDeploy20SignedTransaction

  • Send Harmony deploy erc20 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: OneDeploy20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendOneDeploy721SignedTransaction

  • Send Harmony deploy erc721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: OneDeploy721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendOneDeployMarketplaceListingSignedTransaction

  • Deploy new smart contract for NFT marketplace logic. Smart contract enables marketplace operator to create new listing for NFT (ERC-721/1155).

    Parameters

    • testnet: boolean

      chain to work with

    • body: DeployMarketplaceListing

      request data

    • Optional provider: string

      optional provider to enter. if not present, Tatum Web3 will be used.

    Returns Promise<TransactionHash>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const sendOneDeployMultiTokenSignedTransaction

  • Send Harmony deploy multiple tokens transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: OneDeployMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendOneGenerateCustodialWalletSignedTransaction

  • Send Harmony mint generate custodial wallet signed transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: GenerateCustodialAddress

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendOneMint20SignedTransaction

  • Send Harmony mint erc20 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: OneMint20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendOneMint721ProvenanceSignedTransaction

  • Send Harmony mint erc721 Provenance transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: OneMint721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendOneMint721SignedTransaction

  • Send Harmony mint erc721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: OneMint721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendOneMintCashback721SignedTransaction

  • Send Harmony mint cashback erc721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: OneMint721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendOneMintMultiTokenBatchSignedTransaction

  • Send Harmony mint multiple tokens batch transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: OneMintMultiTokenBatch

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendOneMintMultiTokenSignedTransaction

  • Send Harmony mint multiple tokens transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: OneMintMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendOneMintMultiple721ProvenanceSignedTransaction

  • Send Harmony mint multiple cashback erc721 provenance transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: OneMintMultiple721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendOneMintMultiple721SignedTransaction

  • Send Harmony mint multiple erc721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: OneMintMultiple721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendOneMintMultipleCashback721SignedTransaction

  • Send Harmony mint multiple cashback erc721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: OneMintMultiple721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendOneSmartContractMethodInvocationTransaction

  • Send Harmony smart contract method invocation transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    Returns Promise<TransactionHash | { data: any }>

    transaction id of the transaction in the blockchain

Const sendOneSmartContractReadMethodInvocationTransaction

  • Send Harmony smart contract read method invocation transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: SmartContractReadMethodInvocation

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<{ data: any }>

    transaction id of the transaction in the blockchain

Const sendOneStoreDataTransaction

  • Send Harmony store data transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: CreateRecord

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendOneTransaction

  • Send Harmony transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: OneTransfer

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendOneTransfer20SignedTransaction

  • Send Harmony transfer erc20 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: OneTransfer20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendOneTransfer721SignedTransaction

  • Send Harmony transfer erc721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: OneTransfer721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendOneTransferMultiTokenSignedTransaction

  • Send Harmony transfer multiple tokens transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: OneTransferMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendOneUpdateCashbackForAuthor721SignedTransaction

  • Send Harmony update cashback for author erc721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: OneUpdateCashback721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendPolygonBatchTransferMultiTokenSignedTransaction

  • Send Polygon batch transfer multiple tokens transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: TransferMultiTokenBatch

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendPolygonBurnErc20SignedTransaction

  • Send Polygon burn erc20 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: BurnErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendPolygonBurnErc721SignedTransaction

  • Send Polygon burn erc721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: EthBurnErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendPolygonBurnMultiTokenBatchSignedTransaction

  • Send Polygon burn multiple tokens batch transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: BurnMultiTokenBatch

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendPolygonBurnMultiTokenSignedTransaction

  • Send Polygon burn multiple tokens erc721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: BurnMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendPolygonDeployErc20SignedTransaction

  • Send Polygon deploy erc20 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: DeployErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendPolygonDeployErc721SignedTransaction

  • Send Polygon deploy erc721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: EthDeployErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendPolygonDeployMarketplaceListingSignedTransaction

  • Deploy new smart contract for NFT marketplace logic. Smart contract enables marketplace operator to create new listing for NFT (ERC-721/1155).

    Parameters

    • testnet: boolean

      chain to work with

    • body: DeployMarketplaceListing

      request data

    • Optional provider: string

      optional provider to enter. if not present, Tatum Web3 will be used.

    Returns Promise<TransactionHash>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const sendPolygonDeployMultiTokenSignedTransaction

  • Send Polygon deploy multiple tokens transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: EthDeployMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendPolygonGenerateCustodialWalletSignedTransaction

  • Send Polygon generate custodial wallet transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: GenerateCustodialAddress

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendPolygonMintCashbackErc721SignedTransaction

  • Send Polygon mint cashback erc721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: EthMintErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendPolygonMintErc20SignedTransaction

  • Send Polygon mint erc20 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: MintErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendPolygonMintErc721ProvenanceSignedTransaction

  • Send Polygon mint cashback erc721 provenance transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: EthMintErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendPolygonMintErc721SignedTransaction

  • Send Polygon mint erc721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: EthMintErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendPolygonMintMultiTokenBatchSignedTransaction

  • Send Polygon mint multiple tokens batch transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: MintMultiTokenBatch

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendPolygonMintMultiTokenSignedTransaction

  • Send Polygon mint multiple tokens transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: MintMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendPolygonMintMultipleCashbackErc721SignedTransaction

  • Send Polygon mint multiple erc721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: EthMintMultipleErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendPolygonMintMultipleErc721ProvenanceSignedTransaction

  • Send Polygon mint multiple erc721 Provenance transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: EthMintMultipleErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendPolygonMintMultipleErc721SignedTransaction

  • Send Polygon mint multiple erc721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: EthMintMultipleErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendPolygonOffchainTransaction

  • sendPolygonOffchainTransaction(testnet: boolean, body: TransferEthOffchain, provider?: string): Promise<SignatureId | { completed: boolean; id: string; txId: string } | { id: string }>

  • Send Polygon transaction from Tatum Ledger account to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TransferEthOffchain

      content of the transaction to broadcast

    • Optional provider: string

      url of the Polygon Server to connect to. If not set, default public server will be used.

    Returns Promise<SignatureId | { completed: boolean; id: string; txId: string } | { id: string }>

    transaction id of the transaction in the blockchain or id of the withdrawal, if it was not cancelled automatically

Const sendPolygonSmartContractMethodInvocationTransaction

  • Send Polygon smart contract method invocation transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    Returns Promise<TransactionHash | { data: any }>

    transaction id of the transaction in the blockchain

Const sendPolygonSmartContractReadMethodInvocationTransaction

Const sendPolygonStoreDataTransaction

  • Send Polygon smart store data transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: CreateRecord

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendPolygonTransaction

  • Send Polygon transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TransferErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Polygon Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendPolygonTransferErc20SignedTransaction

  • Send Polygon transfer erc20 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: TransferErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendPolygonTransferErc721SignedTransaction

  • Send Polygon transfer erc721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: EthTransferErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendPolygonTransferMultiTokenSignedTransaction

  • Send Polygon transfer multiple tokens transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: TransferMultiToken

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendPolygonUpdateCashbackForAuthorErc721SignedTransaction

  • Send Polygon update cashback for author erc721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: UpdateCashbackErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendSmartContractMethodInvocationTransaction

  • Send Ethereum invoke smart contract transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    Returns Promise<TransactionHash | { data: any }>

    transaction id of the transaction in the blockchain

Const sendSmartContractReadMethodInvocationTransaction

  • Send Ethereum invoke smart contract transaction to the blockchain. Invoked method only reads from blockchain the data and returns them back.

    Parameters

    • body: SmartContractReadMethodInvocation

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<{ data: any }>

Const sendStoreDataTransaction

  • Send Ethereum store data transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: CreateRecord

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendTransaction

Const sendTransferFromCustodialWallet

Const sendTronBurnTrc721SignedTransaction

  • Send Tron burn trc721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: TronBurnTrc721

      content of the transaction to broadcast

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendTronDeployMarketplaceListingSignedTransaction

  • Deploy new smart contract for NFT marketplace logic. Smart contract enables marketplace operator to create new listing for NFT (ERC-721/1155).

    Parameters

    • testnet: boolean

      chain to work with

    • body: DeployTronMarketplaceListing

      request data

    • Optional provider: string

      optional provider to enter. if not present, Tatum provider will be used.

    Returns Promise<TransactionHash>

    Transaction ID of the operation, or signatureID in case of Tatum KMS

Const sendTronDeployTrc721SignedTransaction

  • Send Tron deploy trc721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: TronDeployTrc721

      content of the transaction to broadcast

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendTronGenerateCustodialWalletSignedTransaction

  • Send Tron generate custodial wallet transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendTronMintCashbackTrc721SignedTransaction

  • Send Tron mint cashback trc721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: TronMintTrc721

      content of the transaction to broadcast

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendTronMintMultipleTrc721SignedTransaction

  • Send Tron mint multiple trc721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendTronMintTrc721SignedTransaction

  • Send Tron mint trc721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean
    • body: TronMintTrc721

      content of the transaction to broadcast

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendTronOffchainTransaction

  • sendTronOffchainTransaction(testnet: boolean, body: TransferTrxOffchain): Promise<SignatureId | { completed: boolean; id: string; txId: string } | { id: string }>

  • Send Tron transaction from Tatum Ledger account to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TransferTrxOffchain

      content of the transaction to broadcast

    Returns Promise<SignatureId | { completed: boolean; id: string; txId: string } | { id: string }>

    transaction id of the transaction in the blockchain or id of the withdrawal, if it was not cancelled automatically

Const sendTronTransaction

  • Send Tron transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TransferTron

      content of the transaction to broadcast

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendTronTransferTrc721SignedTransaction

  • Send Tron transfer trc721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendTronTrc10Transaction

  • Send Tron TRC10 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TransferTronTrc10

      content of the transaction to broadcast

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendTronTrc20Transaction

  • Send Tron TRC20 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TransferTronTrc20

      content of the transaction to broadcast

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendTronUpdateCashbackForAuthorTrc721SignedTransaction

  • Send Tron update cashback for author trc721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendUpdateCashbackForAuthorBep721Transaction

Const sendUpdateCashbackForAuthorErc721Transaction

  • Send Ethereum ERC721 update cashback for author transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: UpdateCashbackErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendVetTransaction

  • Send VeChain transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TransferVet

      content of the transaction to broadcast

    • Optional provider: string

      url of the VeChain Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendXdcBurnErc721Transaction

  • Send XDC ERC721 burn transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: EthBurnErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the XDC Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendXdcCustomErc20Transaction

  • Send XDC custom ERC20 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: TransferErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the XDC Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendXdcDeployErc20Transaction

  • Send XDC deploy ERC20 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: DeployErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the XDC Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendXdcDeployErc721Transaction

  • Send XDC ERC721 deploy to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: EthDeployErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the XDC Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendXdcErc721Transaction

  • Send XDC ERC721 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: EthTransferErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the XDC Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendXdcMintErc721Transaction

  • Send XDC ERC721 mint transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: EthMintErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the XDC Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendXdcMintErcCashback721Transaction

  • Send XDC ERC721 mint transaction to the blockchain with cashback details. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: EthMintErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the XDC Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendXdcMintMultipleCashbackErc721Transaction

  • Send XDC ERC721 mint multiple transaction with cashback to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: EthMintMultipleErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the XDC Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendXdcMintMultipleErc721Transaction

  • Send XDC ERC721 mint multiple transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: EthMintMultipleErc721

      content of the transaction to broadcast

    • Optional provider: string

      url of the XDC Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendXdcOffchainTransaction

  • sendXdcOffchainTransaction(testnet: boolean, body: TransferEthOffchain, provider?: string): Promise<SignatureId | { completed: boolean; id: string; txId: string } | { id: string }>

  • Send XDC transaction from Tatum Ledger account to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TransferEthOffchain

      content of the transaction to broadcast

    • Optional provider: string

      url of the XDC Server to connect to. If not set, default public server will be used.

    Returns Promise<SignatureId | { completed: boolean; id: string; txId: string } | { id: string }>

    transaction id of the transaction in the blockchain or id of the withdrawal, if it was not cancelled automatically

Const sendXdcOrErc20Transaction

  • Send XDC or supported ERC20 transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: TransferErc20

      content of the transaction to broadcast

    • Optional provider: string

      url of the XDC Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendXdcSmartContractMethodInvocationTransaction

  • Send XDC invoke smart contract transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    Returns Promise<TransactionHash | { data: any }>

    transaction id of the transaction in the blockchain

Const sendXdcSmartContractReadMethodInvocationTransaction

  • Send XDC invoke smart contract transaction to the blockchain. Invoked method only reads from blockchain the data and returns them back.

    Parameters

    • body: SmartContractReadMethodInvocation

      content of the transaction to broadcast

    • Optional provider: string

      url of the XDC Server to connect to. If not set, default public server will be used.

    Returns Promise<{ data: any }>

Const sendXdcStoreDataTransaction

  • Send XDC store data transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: CreateRecord

      content of the transaction to broadcast

    • Optional provider: string

      url of the XDC Server to connect to. If not set, default public server will be used.

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendXdcUpdateCashbackForAuthorErc721Transaction

Const sendXlmOffchainTransaction

  • sendXlmOffchainTransaction(testnet: boolean, body: TransferXlmOffchain): Promise<{ completed: boolean; id: string; txId: string } | { id: string }>

  • Send Stellar transaction from Tatum Ledger account to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TransferXlmOffchain

      content of the transaction to broadcast

    Returns Promise<{ completed: boolean; id: string; txId: string } | { id: string }>

    transaction id of the transaction in the blockchain or id of the withdrawal, if it was not cancelled automatically

Const sendXlmTransaction

  • Send Stellar transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TransferXlm

      content of the transaction to broadcast

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const sendXrpOffchainTransaction

  • sendXrpOffchainTransaction(testnet: boolean, body: TransferXrpOffchain): Promise<{ completed: boolean; id: string; txId: string } | { id: string }>

  • Send Xrp transaction from Tatum Ledger account to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • body: TransferXrpOffchain

      content of the transaction to broadcast

    Returns Promise<{ completed: boolean; id: string; txId: string } | { id: string }>

    transaction id of the transaction in the blockchain or id of the withdrawal, if it was not cancelled automatically

Const sendXrpTransaction

  • Send Xrp transaction to the blockchain. This method broadcasts signed transaction to the blockchain. This operation is irreversible.

    Parameters

    • body: TransferXrp

      content of the transaction to broadcast

    Returns Promise<TransactionHash>

    transaction id of the transaction in the blockchain

Const signAdaKMSTransaction

  • signAdaKMSTransaction(tx: TransactionKMS, privateKeys: string[]): Promise<string>

  • Sign Ada pending transaction from Tatum KMS

    Parameters

    • tx: TransactionKMS

      pending transaction from KMS

    • privateKeys: string[]

      private keys to sign transaction with.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const signAdaOffchainKMSTransaction

  • signAdaOffchainKMSTransaction(tx: TransactionKMS, mnemonic: string, testnet: boolean): Promise<string>

  • Sign Ada pending transaction from Tatum KMS

    Parameters

    • tx: TransactionKMS

      pending transaction from KMS

    • mnemonic: string

      mnemonic to generate private keys to sign transaction with.

    • testnet: boolean

      mainnet or testnet version

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const signAlgoKMSTransaction

  • signAlgoKMSTransaction(tx: TransactionKMS, fromPrivateKey: string, testnet: boolean, provider?: string): Promise<string>

  • Sign Algorand pending transaction from Tatum KMS

    Parameters

    • tx: TransactionKMS

      pendding transaction from Tatum KMS

    • fromPrivateKey: string

      private key to sign transaction with

    • testnet: boolean

      mainnet or testnet version

    • Optional provider: string

      url of the Algorand Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const signBitcoinCashKMSTransaction

  • signBitcoinCashKMSTransaction(tx: TransactionKMS, privateKeys: string[], testnet: boolean): Promise<any>

  • Sign Bitcoin Cash pending transaction from Tatum KMS

    Parameters

    • tx: TransactionKMS

      pending transaction from KMS

    • privateKeys: string[]

      private keys to sign transaction with.

    • testnet: boolean

      mainnet or testnet version

    Returns Promise<any>

    transaction data to be broadcast to blockchain.

Const signBitcoinCashOffchainKMSTransaction

  • signBitcoinCashOffchainKMSTransaction(tx: TransactionKMS, mnemonic: string, testnet: boolean): Promise<any>

  • Sign Bitcoin Cash pending transaction from Tatum KMS

    Parameters

    • tx: TransactionKMS

      pending transaction from KMS

    • mnemonic: string

      mnemonic to generate private keys to sign transaction with.

    • testnet: boolean

      mainnet or testnet version

    Returns Promise<any>

    transaction data to be broadcast to blockchain.

Const signBitcoinKMSTransaction

  • signBitcoinKMSTransaction(tx: TransactionKMS, privateKeys: string[]): Promise<any>

  • Sign Bitcoin pending transaction from Tatum KMS

    Parameters

    • tx: TransactionKMS

      pending transaction from KMS

    • privateKeys: string[]

      private keys to sign transaction with.

    Returns Promise<any>

    transaction data to be broadcast to blockchain.

Const signBitcoinOffchainKMSTransaction

  • signBitcoinOffchainKMSTransaction(tx: TransactionKMS, mnemonic: string, testnet: boolean): Promise<any>

  • Sign Bitcoin pending transaction from Tatum KMS

    Parameters

    • tx: TransactionKMS

      pending transaction from KMS

    • mnemonic: string

      mnemonic to generate private keys to sign transaction with.

    • testnet: boolean

      mainnet or testnet version

    Returns Promise<any>

    transaction data to be broadcast to blockchain.

Const signBnbKMSTransaction

  • signBnbKMSTransaction(tx: TransactionKMS, fromPrivateKey: string, testnet: boolean, provider?: string): Promise<string>

  • Sign Bnb pending transaction from Tatum KMS

    Parameters

    • tx: TransactionKMS

      pending transaction from KMS

    • fromPrivateKey: string

      private key to sign transaction with.

    • testnet: boolean

      mainnet or testnet version

    • Optional provider: string

      url of the Bnb Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const signBscKMSTransaction

  • signBscKMSTransaction(tx: TransactionKMS, fromPrivateKey: string, provider?: string): Promise<string>

  • Sign BSC pending transaction from Tatum KMS

    Parameters

    • tx: TransactionKMS

      pending transaction from KMS

    • fromPrivateKey: string

      private key to sign transaction with.

    • Optional provider: string

      url of the BSC Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const signCeloKMSTransaction

  • signCeloKMSTransaction(tx: TransactionKMS, fromPrivateKey: string, testnet: boolean, provider?: string): Promise<string>

  • Sign Celo pending transaction from Tatum KMS

    Parameters

    • tx: TransactionKMS

      pending transaction from KMS

    • fromPrivateKey: string

      private key to sign transaction with.

    • testnet: boolean

      mainnet or testnet version

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain, or signatureId in case of Tatum KMS

Const signDogecoinKMSTransaction

  • signDogecoinKMSTransaction(tx: TransactionKMS, privateKeys: string[], testnet: boolean): Promise<any>

  • Sign Dogecoin pending transaction from Tatum KMS

    Parameters

    • tx: TransactionKMS

      pending transaction from KMS

    • privateKeys: string[]

      private keys to sign transaction with.

    • testnet: boolean

      mainnet or testnet version

    Returns Promise<any>

    transaction data to be broadcast to blockchain.

Const signDogecoinOffchainKMSTransaction

  • signDogecoinOffchainKMSTransaction(tx: TransactionKMS, mnemonic: string, testnet: boolean): Promise<any>

  • Sign Dogecoin pending transaction from Tatum KMS

    Parameters

    • tx: TransactionKMS

      pending transaction from KMS

    • mnemonic: string

      mnemonic to generate private keys to sign transaction with.

    • testnet: boolean

      mainnet or testnet version

    Returns Promise<any>

    transaction data to be broadcast to blockchain.

Const signEgldKMSTransaction

  • signEgldKMSTransaction(tx: TransactionKMS, fromPrivateKey: string, provider?: string): Promise<string>

  • Sign EGLD pending transaction from Tatum KMS

    Parameters

    • tx: TransactionKMS

      pending transaction from KMS

    • fromPrivateKey: string

      private key to sign transaction with.

    • Optional provider: string

      url of the EGLD Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const signEgldTransaction

  • signEgldTransaction(tx: Transaction, fromPrivateKey: string): Promise<string>

  • Sign transaction

    Parameters

    • tx: Transaction
    • fromPrivateKey: string

    Returns Promise<string>

Const signEthKMSTransaction

  • signEthKMSTransaction(tx: TransactionKMS, fromPrivateKey: string, provider?: string): Promise<string>

  • Sign Ethereum pending transaction from Tatum KMS

    Parameters

    • tx: TransactionKMS

      pending transaction from KMS

    • fromPrivateKey: string

      private key to sign transaction with.

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const signEthOffchainKMSTransaction

  • signEthOffchainKMSTransaction(tx: TransactionKMS, fromPrivateKey: string, testnet: boolean, provider?: string): Promise<string>

  • Sign Ethereum pending transaction from Tatum KMS

    Parameters

    • tx: TransactionKMS

      pending transaction from KMS

    • fromPrivateKey: string

      private key to sign transaction with.

    • testnet: boolean

      mainnet or testnet version

    • Optional provider: string

      url of the Ethereum Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const signKlayKMSTransaction

  • signKlayKMSTransaction(tx: TransactionKMS, fromPrivateKey: string, testnet: boolean, provider?: string): Promise<string>

  • Sign Klay pending transaction from Tatum KMS

    Parameters

    • tx: TransactionKMS

      pending transaction from KMS

    • fromPrivateKey: string

      private key to sign transaction with.

    • testnet: boolean

      mainnet or testnet version

    • Optional provider: string

      url of the Klay Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const signLitecoinKMSTransaction

  • signLitecoinKMSTransaction(tx: TransactionKMS, privateKeys: string[], testnet: boolean): Promise<any>

  • Sign Litecoin pending transaction from Tatum KMS

    Parameters

    • tx: TransactionKMS

      pending transaction from KMS

    • privateKeys: string[]

      private keys to sign transaction with.

    • testnet: boolean

      mainnet or testnet version

    Returns Promise<any>

    transaction data to be broadcast to blockchain.

Const signLitecoinOffchainKMSTransaction

  • signLitecoinOffchainKMSTransaction(tx: TransactionKMS, mnemonic: string, testnet: boolean): Promise<any>

  • Sign Litecoin pending transaction from Tatum KMS

    Parameters

    • tx: TransactionKMS

      pending transaction from KMS

    • mnemonic: string

      mnemonic to generate private keys to sign transaction with.

    • testnet: boolean

      mainnet or testnet version

    Returns Promise<any>

    transaction data to be broadcast to blockchain.

Const signOneKMSTransaction

  • signOneKMSTransaction(tx: TransactionKMS, fromPrivateKey: string, testnet: boolean, provider?: string): Promise<string>

  • Sign Harmony pending transaction from Tatum KMS

    Parameters

    • tx: TransactionKMS

      pending transaction from KMS

    • fromPrivateKey: string

      private key to sign transaction with.

    • testnet: boolean

      mainnet or testnet version

    • Optional provider: string

      url of the Harmony Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const signPolygonKMSTransaction

  • signPolygonKMSTransaction(tx: TransactionKMS, fromPrivateKey: string, testnet: boolean, provider?: string): Promise<string>

  • Sign Polygon pending transaction from Tatum KMS

    Parameters

    • tx: TransactionKMS

      pending transaction from KMS

    • fromPrivateKey: string

      private key to sign transaction with.

    • testnet: boolean

      mainnet or testnet version

    • Optional provider: string

      url of the Polygon Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const signTransaction

  • signTransaction(transactionBuilder: TransactionBuilder, transferAdaBlockchain: TransferAdaBlockchain, privateKeysToSign: (undefined | string)[]): string

Const signTronKMSTransaction

  • signTronKMSTransaction(tx: TransactionKMS, fromPrivateKey: string, testnet: boolean): Promise<string>

  • Sign Tron pending transaction from Tatum KMS

    Parameters

    • tx: TransactionKMS

      pending transaction from KMS

    • fromPrivateKey: string

      private key to sign transaction with.

    • testnet: boolean

      mainnet or testnet version

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const signTrxKMSTransaction

  • signTrxKMSTransaction(tx: TransactionKMS, fromPrivateKey: string, testnet: boolean): Promise<string>

  • Sign Tron pending transaction from Tatum KMS

    Parameters

    • tx: TransactionKMS

      pending transaction from KMS

    • fromPrivateKey: string

      private key to sign transaction with.

    • testnet: boolean

      mainnet or testnet version

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const signVetKMSTransaction

  • signVetKMSTransaction(tx: TransactionKMS, fromPrivateKey: string, testnet: boolean, provider?: string): Promise<any>

  • Sign VeChain pending transaction from Tatum KMS

    Parameters

    • tx: TransactionKMS

      pending transaction from KMS

    • fromPrivateKey: string

      private key to sign transaction with.

    • testnet: boolean

      mainnet or testnet version

    • Optional provider: string

      url of the VeChain Server to connect to. If not set, default public server will be used.

    Returns Promise<any>

    transaction data to be broadcast to blockchain.

Const signXdcKMSTransaction

  • signXdcKMSTransaction(tx: TransactionKMS, fromPrivateKey: string, provider?: string): Promise<string>

  • Sign XDC pending transaction from Tatum KMS

    Parameters

    • tx: TransactionKMS

      pending transaction from KMS

    • fromPrivateKey: string

      private key to sign transaction with.

    • Optional provider: string

      url of the XDC Server to connect to. If not set, default public server will be used.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const signXlmKMSTransaction

  • signXlmKMSTransaction(tx: TransactionKMS, secret: string, testnet: boolean): Promise<string>

  • Sign Stellar pending transaction from Tatum KMS

    Parameters

    • tx: TransactionKMS

      pending transaction from KMS

    • secret: string

      secret key to sign transaction with.

    • testnet: boolean

      mainnet or testnet version

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const signXlmOffchainKMSTransaction

  • signXlmOffchainKMSTransaction(tx: TransactionKMS, secret: string, testnet: boolean): Promise<string>

  • Sign Stellar pending transaction from Tatum KMS

    Parameters

    • tx: TransactionKMS

      pending transaction from KMS

    • secret: string

      secret key to sign transaction with.

    • testnet: boolean

      mainnet or testnet version

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const signXrpKMSTransaction

  • signXrpKMSTransaction(tx: TransactionKMS, secret: string): Promise<string>

  • Sign Xrp pending transaction from Tatum KMS

    Parameters

    • tx: TransactionKMS

      pending transaction from KMS

    • secret: string

      secret key to sign transaction with.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const signXrpOffchainKMSTransaction

  • signXrpOffchainKMSTransaction(tx: TransactionKMS, secret: string): Promise<string>

  • Sign Xrp pending transaction from Tatum KMS

    Parameters

    • tx: TransactionKMS

      pending transaction from KMS

    • secret: string

      secret key to sign transaction with.

    Returns Promise<string>

    transaction data to be broadcast to blockchain.

Const storeData

  • Store any arbitrary data on the blockchain.

    Parameters

    • testnet: boolean

      if we are on testnet or not

    • body: CreateRecord

      Body of the transaction.

    • Optional provider: string

      Optional provider to use for broadcasting signed tx to the blockchain.

    Returns Promise<TransactionHash>

Const storeErc20ContractAddress

  • storeErc20ContractAddress(name: string, address: string): Promise<Address>

Const storeTransaction

Const storeTrcContractAddress

  • storeTrcContractAddress(name: string, address: string): Promise<Address>

Const toLegacyAddress

  • toLegacyAddress(address: string): any

Const transferHexToBase58Address

  • transferHexToBase58Address(address: string): any

Const transferMultiToken

Const transferMultiTokenBatch

Const transferNFT

Const tronBroadcast

  • tronBroadcast(txData: string, signatureId?: string): Promise<TransactionHash>

Const tronGetAccount

  • tronGetAccount(address: string): Promise<TronAccount>

Const tronGetAccountTrc20Address

  • tronGetAccountTrc20Address(testnet: boolean, address: string, contractAddress: string, provider?: string): Promise<any>

  • Get TRC20 balance for the given tron address.

    Parameters

    • testnet: boolean

      mainnet or testnet version

    • address: string

      the address whose balance is returned

    • contractAddress: string

      the TRC20 contract address

    • Optional provider: string

    Returns Promise<any>

Const tronGetBlock

  • tronGetBlock(hash: string): Promise<TronBlock>

Const tronGetCurrentBlock

  • tronGetCurrentBlock(): Promise<{ blockNumber: number; hash: string; testnet: boolean }>

Const tronGetTransaction

Const tronGetTrc10Detail

  • tronGetTrc10Detail(id: string): Promise<TronTrc10>

Const unfreezeAccount

  • unfreezeAccount(id: string): Promise<void>

Const updateAccount

  • updateAccount(id: string, account: UpdateAccount): Promise<Account>

Const updateCashbackForAuthorNFT

Const updateCustomer

  • updateCustomer(id: string, data: CustomerUpdate): Promise<{ id: string }>

Const updateVirtualCurrency

  • updateVirtualCurrency(data: UpdateCurrency): Promise<void>

Const vetBroadcast

  • vetBroadcast(txData: string, signatureId?: string): Promise<TransactionHash>

Const vetEstimateGas

Const vetGetAccountBalance

  • vetGetAccountBalance(address: string): Promise<number>

Const vetGetAccountEnergy

  • vetGetAccountEnergy(address: string): Promise<number>

Const vetGetBlock

  • vetGetBlock(hash: string): Promise<VetBlock>

Const vetGetCurrentBlock

  • vetGetCurrentBlock(): Promise<number>

Const vetGetTransaction

  • vetGetTransaction(hash: string): Promise<VetTx>

Const vetGetTransactionReceipt

  • vetGetTransactionReceipt(hash: string): Promise<VetTxReceipt>

Const xdcBroadcast

  • xdcBroadcast(txData: string, signatureId?: string): Promise<TransactionHash>

Const xdcEstimateGas

Const xdcGetAccountBalance

  • xdcGetAccountBalance(address: string): Promise<BigNumber>

Const xdcGetAccountErc20Balance

  • xdcGetAccountErc20Balance(address: string, contractAddress: string): Promise<number>

Const xdcGetBlock

  • xdcGetBlock(hash: string): Promise<EthBlock>

Const xdcGetCurrentBlock

  • xdcGetCurrentBlock(): Promise<number>

Const xdcGetGasPriceInWei

  • xdcGetGasPriceInWei(): Promise<string | BN>

Const xdcGetTransaction

  • xdcGetTransaction(hash: string): Promise<EthTx>

Const xdcGetTransactionsCount

  • xdcGetTransactionsCount(address: string): Promise<number>

Const xlmBroadcast

  • xlmBroadcast(txData: string, signatureId?: string): Promise<TransactionHash>

Const xlmGetAccountInfo

  • xlmGetAccountInfo(account: string): Promise<{ sequence: string }>

Const xlmGetAccountTransactions

  • xlmGetAccountTransactions(address: string): Promise<unknown>

Const xlmGetCurrentLedger

  • xlmGetCurrentLedger(): Promise<unknown>

Const xlmGetFee

  • xlmGetFee(): Promise<unknown>

Const xlmGetLedger

  • xlmGetLedger(i: number): Promise<unknown>

Const xlmGetLedgerTx

  • xlmGetLedgerTx(i: number): Promise<unknown>

Const xlmGetTransaction

  • xlmGetTransaction(hash: string): Promise<unknown>

Const xrpBroadcast

  • xrpBroadcast(txData: string, signatureId?: string): Promise<TransactionHash>

Const xrpGetAccountBalance

  • xrpGetAccountBalance(address: string): Promise<unknown>

Const xrpGetAccountInfo

  • xrpGetAccountInfo(account: string): Promise<{ account_data: { Sequence: number }; ledger_current_index: number; ledger_index: number }>

Const xrpGetAccountTransactions

  • xrpGetAccountTransactions(address: string, min?: number, marker?: string): Promise<unknown>

Const xrpGetCurrentLedger

  • xrpGetCurrentLedger(): Promise<number>

Const xrpGetFee

  • xrpGetFee(): Promise<{ drops: { base_fee: number } }>

Const xrpGetLedger

  • xrpGetLedger(i: number): Promise<unknown>

Const xrpGetTransaction

  • xrpGetTransaction(hash: string): Promise<unknown>

Generated using TypeDoc