Data types

ENUMs

BladeEnv

export enum BladeEnv {
  Prod = 'Prod',
  CI = 'CI',
}

CryptoFlowServiceStrategy

export enum CryptoFlowServiceStrategy {
  BUY = 'Buy',
  SELL = 'Sell',
  SWAP = 'Swap',
}

MirrorNodeTransactionType

export enum MirrorNodeTransactionType {
  CONSENSUSCREATETOPIC = 'CONSENSUSCREATETOPIC',
  CONSENSUSDELETETOPIC = 'CONSENSUSDELETETOPIC',
  CONSENSUSSUBMITMESSAGE = 'CONSENSUSSUBMITMESSAGE',
  CONSENSUSUPDATETOPIC = 'CONSENSUSUPDATETOPIC',
  CONTRACTCALL = 'CONTRACTCALL',
  CONTRACTCREATEINSTANCE = 'CONTRACTCREATEINSTANCE',
  CONTRACTDELETEINSTANCE = 'CONTRACTDELETEINSTANCE',
  CONTRACTUPDATEINSTANCE = 'CONTRACTUPDATEINSTANCE',
  CRYPTOADDLIVEHASH = 'CRYPTOADDLIVEHASH',
  CRYPTOCREATEACCOUNT = 'CRYPTOCREATEACCOUNT',
  CRYPTODELETE = 'CRYPTODELETE',
  CRYPTODELETELIVEHASH = 'CRYPTODELETELIVEHASH',
  CRYPTOTRANSFER = 'CRYPTOTRANSFER',
  CRYPTOUPDATEACCOUNT = 'CRYPTOUPDATEACCOUNT',
  FILEAPPEND = 'FILEAPPEND',
  FILECREATE = 'FILECREATE',
  FILEDELETE = 'FILEDELETE',
  FILEUPDATE = 'FILEUPDATE',
  FREEZE = 'FREEZE',
  SCHEDULECREATE = 'SCHEDULECREATE',
  SCHEDULEDELETE = 'SCHEDULEDELETE',
  SCHEDULESIGN = 'SCHEDULESIGN',
  SYSTEMDELETE = 'SYSTEMDELETE',
  SYSTEMUNDELETE = 'SYSTEMUNDELETE',
  TOKENASSOCIATE = 'TOKENASSOCIATE',
  TOKENBURN = 'TOKENBURN',
  TOKENCREATION = 'TOKENCREATION',
  TOKENDELETION = 'TOKENDELETION',
  TOKENDISSOCIATE = 'TOKENDISSOCIATE',
  TOKENFEESCHEDULEUPDATE = 'TOKENFEESCHEDULEUPDATE',
  TOKENFREEZE = 'TOKENFREEZE',
  TOKENGRANTKYC = 'TOKENGRANTKYC',
  TOKENMINT = 'TOKENMINT',
  TOKENPAUSE = 'TOKENPAUSE',
  TOKENREVOKEKYC = 'TOKENREVOKEKYC',
  TOKENUNFREEZE = 'TOKENUNFREEZE',
  TOKENUNPAUSE = 'TOKENUNPAUSE',
  TOKENUPDATE = 'TOKENUPDATE',
  TOKENWIPE = 'TOKENWIPE',
  UNCHECKEDSUBMIT = 'UNCHECKEDSUBMIT',
}

Network

export enum Network {
  Mainnet = 'MAINNET',
  Testnet = 'TESTNET',
}

Data types

BalanceData

export interface BalanceData {
  hbars: number;
  tokens: {
    tokenId: string;
    balance: number;
  }[];
}

CoinData

export interface CoinData {
  id: string;
  symbol: string;
  name: string;
  web_slug: string;
  description: CoinDataDescription;
  image: CoinDataImage;
  market_data: CoinDataMarket;
  platforms: CoinGeckoPlatform[];
}

CoinDataDescription

export interface CoinDataDescription {
  en: string;
}

CoinDataImage

export interface CoinDataImage {
  thumb: string;
  small: string;
  large: string;
}

CoinDataMarket

export interface CoinDataMarket {
  current_price: { [key: string]: number };
}

CoinGeckoPlatform

export interface CoinGeckoPlatform {
  name: string;
  address: string;
}

CoinInfoData

export interface CoinInfoData {
  coin: CoinData;
  priceUsd: number;
  price?: number;
  currency: string;
}

CoinItem

export interface CoinItem {
  id: string;
  symbol: string;
  name: string;
  platforms: CoinGeckoPlatform[];
}

CoinListData

export interface CoinListData {
  coins: CoinItem[];
}

CreateAccountData

export interface CreateAccountData {
  seedPhrase: string;
  publicKey: string;
  privateKey: string;
  accountId?: string;
  evmAddress: string;
  transactionId?: string;
  status: string;
  queueNumber: number;
}

IAssetQuote

export interface IAssetQuote {
  asset: ICryptoFlowAsset;
  amountExpected: number;
  totalFee?: number;
}

ICryptoFlowAsset

export interface ICryptoFlowAsset {
  name: string;
  code: string;
  type: string;
  address?: string;
  chainId?: number;
  decimals?: number;
  minAmount?: number;
  maxAmount?: number;
  symbol?: string;
  imageUrl?: string;
}

ICryptoFlowQuote

export interface ICryptoFlowQuote {
  service: ICryptoFlowQuoteService;
  source: IAssetQuote;
  target: IAssetQuote;
  rate: number;
  widgetUrl?: string;
  paymentMethods?: string[];
}

ICryptoFlowQuoteService

export interface ICryptoFlowQuoteService {
  id: string;
  name: string;
  logo: string;
  description?: string;
}

InfoData

export interface InfoData {
  apiKey: string;
  dAppCode: string;
  network: string;
  visitorId: string;
  sdkEnvironment: string;
  sdkVersion: string;
  nonce: number;
}

IntegrationUrlData

export interface IntegrationUrlData {
  url?: string;
}

SignMessageData

export interface SignMessageData {
  signedMessage: string;
}

SwapQuotesData

export interface SwapQuotesData {
  quotes: ICryptoFlowQuote[];
}

SwapResultData

export interface SwapResultData {
  success: boolean;
  sourceAddress: string;
  targetAddress: string;
  balance: BalanceData;
}

TransactionData

export interface TransactionData {
  transactionId: string;
  type: MirrorNodeTransactionType;
  time: Date;
  transfers: TransferData[];
  nftTransfers?: [];
  memo?: string;
  fee?: number;
  showDetailed?: boolean;
  plainData?: any;
  consensusTimestamp: string;
}

TransactionReceiptData

export interface TransactionReceiptData {
  status: string;
  contractId?: string;
  topicSequenceNumber?: string;
  totalSupply?: string;
  serials: string[];
}

TransactionsHistoryData

export interface TransactionsHistoryData {
  transactions: TransactionData[];
  nextPage?: string;
}

TransakOrderInfo

export interface TransakOrderInfo {
  orderId: string;
  status: string;
  walletAddress?: string;
  createdAt: string;
  autoExpiresAt: string;
  isBuyOrSell: string;
  network: string;
  notes?: string[];
  fiatCurrency: string;
  fiatAmount: number;
  cryptoCurrency: string;
  cryptoAmount: number;
  conversionPrice?: number;
  slippage?: number;
  totalFeeInFiat: number;
  totalFee?: number;
}

TransferData

export interface TransferData {
  amount: number;
  account: string;
  token_id?: string;
}

Last updated