Comment on page
Type Definitions
interface Account {
pubKey: Uint8Array
bech32Address: string
isNanoLedger: boolean
}
enum Tabs {
SWAP = 'swap',
CROSS_CHAIN_SWAPS = 'cross-chain-swaps',
FIAT_ON_RAMP = 'fiat-on-ramp',
TRANSFER = 'transfer',
BRIDGE_USDC = 'bridge-usdc'
}
interface ChainBaseData {
chainName: string;
icon: string;
rpcUrl: string;
chainId: string | number;
chainType: 'cosmos' | 'evm';
}
interface CosmosChainData extends ChainBaseData {
chainId: string;
restUrl: string;
addressPrefix: string;
baseDenom: string;
chainType: 'cosmos';
coinType: string;
chainRegistryPath: string;
txExplorer: {
mainnet: {
name: string;
txUrl: string;
};
testnet?: {
name: string;
txUrl: string;
};
};
}
interface EVMChainData extends ChainBaseData {
chainId: number;
chainType: 'evm';
}
type ChainData = CosmosChainData | EVMChainData;
type Asset = {
denom: string;
symbol: string;
logoUri: string;
originDenom: string;
decimals: number;
denomTracePath?: string;
};
type Currency = {
name: string;
symbol: string;
countryCode: string;
priority: number;
};
enum TXN_STATUS {
INIT = "INIT",
PENDING = "PENDING",
SUCCESS = "SUCCESS",
FAILED = "FAILED",
SIGNED = "SIGNED"
}
type TxnStatus = {
status: TXN_STATUS
responses: ActionResponse[]
isComplete: boolean
}[]
type ActionResponse = {
status: TRANSFER_STATE
data: any
}
enum TRANSFER_STATE {
TRANSFER_UNKNOWN = "TRANSFER_UNKNOWN",
TRANSFER_PENDING = "TRANSFER_PENDING",
TRANSFER_RECEIVED = "TRANSFER_RECEIVED",
TRANSFER_SUCCESS = "TRANSFER_SUCCESS",
TRANSFER_FAILURE = "TRANSFER_FAILURE"
}
type OrderStatusResponse = {
transferStatus: TRANSFER_STATUS;
humanStatusField: string;
paymentStatus: string;
allPossibleTxHashes: {
originalTxHashFromProvider: {
txHash: string;
txLink: string;
};
};
txHash: string;
};
enum TRANSFER_STATUS {
UNINITIATED = "uninitiated",
PENDING = "pending",
FAILED = "failed",
SETTLED = "settled",
UNKNOWN = "unknown"
}
type IBCSwapTxnInfo = {
type: 'ibc-swap-data'
fromChain: CosmosChainData
toChain: CosmosChainData
fromToken: Asset | string
toToken: Asset | string
hops: number
}
interface SignDirectResponse {
signature: Uint8Array;
signed: SignDoc;
}
interface SignAminoResponse {
readonly signed: StdSignDoc;
readonly signature: Uint8Array;
}
interface Signer {
signDirect: (address: string, signDoc: SignDoc) => Promise<SignDirectResponse | TxRaw>
signAmino: (address: string, signDoc: StdSignDoc) => Promise<SignAminoResponse>
}
type TxnSignBaseArgs =
| {
chainType: 'cosmos'
chainId: string
chainName: string
signMode: 'amino' | 'direct'
transactionTypes: MsgTypeUrl[]
messages: MessageWithInfo[]
}
| {
chainType: 'evm'
chainId: number
chainName: string
}
type TxnSignInitArgs = TxnSignBaseArgs
type OnTxnSignInit = (txn: TxnSignInitArgs) => void
type BroadcastedTxInfo =
| {
chainType: 'evm'
txHash: `0x${string}`
}
| {
chainType: 'cosmos'
txHash: string
fees: readonly Coin[]
data?: IBCSwapTxnInfo
}
type TxnSignApprovedArgs = Prettify<TxnSignBaseArgs & BroadcastedTxInfo>
type TxnSignInitArgs = TxnSignBaseArgs
type OnTxnSignFailed = (txn: TxnSignFailedArgs, err: Error) => void
// the return value of this callback is a function which is
// called when the said transaction is completed
type OnTxnInProgress = (tab: Tabs) => () => void