@tatumio/tatum-v1
Version:
Tatum API client allows browsers and Node.js clients to interact with Tatum API.
64 lines (63 loc) • 3.89 kB
TypeScript
import { Account, Address, BroadcastWithdrawal, CreateErc20Offchain, TxHash, Withdrawal, WithdrawalResponse } from '../model';
import { AddressBatch } from '../model/request/CreateOffchainAddressesBatch';
import { CreateTrcOffchain } from '../model/request/CreateTrcOffchain';
/**
* For more details, see <a href="https://apidoc.tatum.io/#operation/generateDepositAddress" target="_blank">Tatum API documentation</a>
*/
export declare const generateDepositAddress: (id: string, index?: number | undefined) => Promise<Address>;
/**
* For more details, see <a href="https://apidoc.tatum.io/#operation/generateDepositAddressesBatch" target="_blank">Tatum API documentation</a>
*/
export declare const generateDepositAddresses: (batch: AddressBatch) => Promise<Address[]>;
/**
* For more details, see <a href="https://apidoc.tatum.io/#operation/addressExists" target="_blank">Tatum API documentation</a>
*/
export declare const checkAddressExists: (address: string, currency: string, index?: number | undefined) => Promise<Account>;
/**
* For more details, see <a href="https://apidoc.tatum.io/#operation/GetWithdrawals" target="_blank">Tatum API documentation</a>
*/
export declare const getWithdrawals: (status?: string | undefined, currency?: string | undefined, pageSize?: number, offset?: number) => Promise<Withdrawal[]>;
/**
* For more details, see <a href="https://apidoc.tatum.io/#operation/assignAddress" target="_blank">Tatum API documentation</a>
*/
export declare const assignDepositAddress: (id: string, address: string) => Promise<Address>;
/**
* For more details, see <a href="https://apidoc.tatum.io/#operation/createErc20" target="_blank">Tatum API documentation</a>
*/
export declare const registerEthereumErc20: (data: CreateErc20Offchain) => Promise<Account>;
/**
* For more details, see <a href="https://apidoc.tatum.io/#operation/storeErc20Address" target="_blank">Tatum API documentation</a>
*/
export declare const storeErc20ContractAddress: (name: string, address: string) => Promise<Address>;
/**
* For more details, see <a href="https://apidoc.tatum.io/#operation/storeTrcAddress" target="_blank">Tatum API documentation</a>
*/
export declare const storeTrcContractAddress: (name: string, address: string) => Promise<Address>;
/**
* For more details, see <a href="https://apidoc.tatum.io/#operation/createTrc" target="_blank">Tatum API documentation</a>
*/
export declare const registerTronTrc: (data: CreateTrcOffchain) => Promise<Account>;
/**
* For more details, see <a href="https://apidoc.tatum.io/#operation/removeAddress" target="_blank">Tatum API documentation</a>
*/
export declare const removeDepositAddress: (id: string, address: string) => Promise<void>;
/**
* For more details, see <a href="https://apidoc.tatum.io/#operation/getAllDepositAddresses" target="_blank">Tatum API documentation</a>
*/
export declare const getDepositAddressesForAccount: (id: string) => Promise<Address[]>;
/**
* For more details, see <a href="https://apidoc.tatum.io/#operation/broadcastBlockchainTransaction" target="_blank">Tatum API documentation</a>
*/
export declare const offchainBroadcast: (data: BroadcastWithdrawal) => Promise<TxHash>;
/**
* For more details, see <a href="https://apidoc.tatum.io/#operation/storeWithdrawal" target="_blank">Tatum API documentation</a>
*/
export declare const offchainStoreWithdrawal: (data: any) => Promise<WithdrawalResponse>;
/**
* For more details, see <a href="https://apidoc.tatum.io/#operation/cancelInProgressWithdrawal" target="_blank">Tatum API documentation</a>
*/
export declare const offchainCancelWithdrawal: (id: string, revert?: boolean) => Promise<void>;
/**
* For more details, see <a href="https://apidoc.tatum.io/#operation/completeWithdrawal" target="_blank">Tatum API documentation</a>
*/
export declare const offchainCompleteWithdrawal: (id: string, txId: string) => Promise<void>;