Documentation | United Network

united-noncustodial-front

united-noncustodial-front / api/common

api/common ​

Enumerations ​

CardErrorCode ​

Defined in: src/api/common.ts:19

Enumeration Members ​

BadPin ​

BadPin: 1

Defined in: src/api/common.ts:21

CardLocked ​

CardLocked: 2

Defined in: src/api/common.ts:22

Success ​

Success: 0

Defined in: src/api/common.ts:20

Interfaces ​

BlockchainManager ​

Defined in: src/api/common.ts:134

Properties ​

nativeCoin ​

readonly nativeCoin: Token

Defined in: src/api/common.ts:136

type ​

readonly type: "bitcoin" | "evm" | "solana" | "ton" | "tron" | "venom" | "xrpl"

Defined in: src/api/common.ts:135

Methods ​

addToken() ​

addToken(token): void

Defined in: src/api/common.ts:138

Parameters ​
token ​

Token

Returns ​

void

addTokenByMetadata() ​

addTokenByMetadata(metadata): void

Defined in: src/api/common.ts:139

Parameters ​
metadata ​

TokenMetadataInput

Returns ​

void

findTokens() ​

findTokens(text): Promise<Token[]>

Defined in: src/api/common.ts:143

Parameters ​
text ​

string

Returns ​

Promise<Token[]>

getToken() ​

getToken(id): undefined | Token

Defined in: src/api/common.ts:141

Parameters ​
id ​

string

Returns ​

undefined | Token

getTokens() ​

getTokens(): Token[]

Defined in: src/api/common.ts:142

Returns ​

Token[]

getWalletAddress() ​

getWalletAddress(keys): Promise<string>

Defined in: src/api/common.ts:145

Parameters ​
keys ​

CardKeys

Returns ​

Promise<string>

isValidAddress() ​

isValidAddress(address): boolean

Defined in: src/api/common.ts:146

Parameters ​
address ​

string

Returns ​

boolean

CardKeys ​

Defined in: src/api/common.ts:11

Properties ​

ed25519? ​

optional ed25519: string

Defined in: src/api/common.ts:14

ioPublicKey? ​

optional ioPublicKey: string

Defined in: src/api/common.ts:12

secp256k1? ​

optional secp256k1: string

Defined in: src/api/common.ts:13

HistoryProvider ​

Defined in: src/api/common.ts:40

Methods ​

getNativeTransactions() ​

getNativeTransactions(owner): Promise<TransactionInfo[]>

Defined in: src/api/common.ts:41

Parameters ​
owner ​

string

Returns ​

Promise<TransactionInfo[]>

getTokenTransactions() ​

getTokenTransactions(args): Promise<TransactionInfo[]>

Defined in: src/api/common.ts:43

Parameters ​
args ​
owner ​

string

token ​

string

Returns ​

Promise<TransactionInfo[]>

Logger ​

Defined in: src/api/common.ts:2

Methods ​

debug() ​

debug(message): any

Defined in: src/api/common.ts:3

Parameters ​
message ​

string

Returns ​

any

error() ​

error(message): any

Defined in: src/api/common.ts:6

Parameters ​
message ​

string

Returns ​

any

info() ​

info(message): any

Defined in: src/api/common.ts:4

Parameters ​
message ​

string

Returns ​

any

warn() ​

warn(message): any

Defined in: src/api/common.ts:5

Parameters ​
message ​

string

Returns ​

any

Request ​

Defined in: src/api/common.ts:66

Properties ​

chunks ​

readonly chunks: RequestChunk[]

Defined in: src/api/common.ts:67

Methods ​

estimateFee() ​

estimateFee(): Promise<string>

Defined in: src/api/common.ts:68

Returns ​

Promise<string>

send() ​

send(): Promise<string>

Defined in: src/api/common.ts:69

Returns ​

Promise<string>

RequestChunk ​

Defined in: src/api/common.ts:50

Methods ​

buildCardRequest() ​

buildCardRequest(args): Promise<Uint8Array<ArrayBufferLike>>

Defined in: src/api/common.ts:53

Parameters ​
args ​
pin ​

string

Returns ​

Promise<Uint8Array<ArrayBufferLike>>

getExpectedResponseSize() ​

getExpectedResponseSize(): number

Defined in: src/api/common.ts:57

Returns ​

number

isSigned() ​

isSigned(): boolean

Defined in: src/api/common.ts:51

Returns ​

boolean

processCardResponse() ​

processCardResponse(rawData): object

Defined in: src/api/common.ts:59

Parameters ​
rawData ​

ArrayBuffer | Uint8Array<ArrayBufferLike>

Returns ​

object

errorCode ​

errorCode: CardErrorCode

keys ​

keys: CardKeys

pinRemaining ​

pinRemaining: number

Token ​

Defined in: src/api/common.ts:81

Properties ​

id ​

readonly id: string

Defined in: src/api/common.ts:83

isMandatory ​

readonly isMandatory: boolean

Defined in: src/api/common.ts:85

isNative ​

readonly isNative: boolean

Defined in: src/api/common.ts:84

Methods ​

getAddress() ​

getAddress(): string

Defined in: src/api/common.ts:94

Returns ​

string

getApprovedAmount()? ​

optional getApprovedAmount(args): Promise<string>

Defined in: src/api/common.ts:95

Parameters ​
args ​
owner ​

string

spender ​

string

Returns ​

Promise<string>

getAvailableBalance() ​

getAvailableBalance(owner): Promise<string>

Defined in: src/api/common.ts:90

Parameters ​
owner ​

string

Returns ​

Promise<string>

getBalance() ​

getBalance(owner): Promise<string>

Defined in: src/api/common.ts:89

Parameters ​
owner ​

string

Returns ​

Promise<string>

getDecimals() ​

getDecimals(): Promise<number>

Defined in: src/api/common.ts:92

Returns ​

Promise<number>

getIconUrl() ​

getIconUrl(): Promise<undefined | string>

Defined in: src/api/common.ts:93

Returns ​

Promise<undefined | string>

getName() ​

getName(): Promise<string>

Defined in: src/api/common.ts:87

Returns ​

Promise<string>

getPrice() ​

getPrice(): Promise<undefined | TokenPriceInfo>

Defined in: src/api/common.ts:91

Returns ​

Promise<undefined | TokenPriceInfo>

getSymbol() ​

getSymbol(): Promise<string>

Defined in: src/api/common.ts:88

Returns ​

Promise<string>

getTransactions() ​

getTransactions(args): Promise<{ items: TransactionInfo[]; total: number; }>

Defined in: src/api/common.ts:108

Parameters ​
args ​
limit ​

number

offset? ​

number

owner ​

string

Returns ​

Promise<{ items: TransactionInfo[]; total: number; }>

getWalletAddress()? ​

optional getWalletAddress(owner): Promise<string>

Defined in: src/api/common.ts:100

Parameters ​
owner ​

string

Returns ​

Promise<string>

swap()? ​

optional swap(args): Promise<Request>

Defined in: src/api/common.ts:117

Parameters ​
args ​

any

Returns ​

Promise<Request>

transfer() ​

transfer(args): Promise<Request>

Defined in: src/api/common.ts:102

Parameters ​
args ​
amount ​

string | number

keys? ​

CardKeys

recipient ​

string

Returns ​

Promise<Request>

TokenMetadataInput ​

Defined in: src/api/common.ts:122

Properties ​

address ​

address: string

Defined in: src/api/common.ts:123

decimals? ​

optional decimals: number

Defined in: src/api/common.ts:126

icon? ​

optional icon: string

Defined in: src/api/common.ts:129

isMandatory? ​

optional isMandatory: boolean

Defined in: src/api/common.ts:128

name? ​

optional name: string

Defined in: src/api/common.ts:124

symbol? ​

optional symbol: string

Defined in: src/api/common.ts:125

ticker? ​

optional ticker: string

Defined in: src/api/common.ts:127

TokenPriceInfo ​

Defined in: src/api/common.ts:74

Properties ​

usd24hChange ​

usd24hChange: string

Defined in: src/api/common.ts:76

usdPrice ​

usdPrice: string

Defined in: src/api/common.ts:75

TransactionInfo ​

Defined in: src/api/common.ts:29

Properties ​

amount ​

amount: string

Defined in: src/api/common.ts:35

confirmed ​

confirmed: boolean

Defined in: src/api/common.ts:32

direction ​

direction: TransactionDirection

Defined in: src/api/common.ts:33

id ​

id: string

Defined in: src/api/common.ts:30

scannerUrl ​

scannerUrl: string

Defined in: src/api/common.ts:36

success ​

success: boolean

Defined in: src/api/common.ts:31

timestamp ​

timestamp: number

Defined in: src/api/common.ts:34

Type Aliases ​

TransactionDirection ​

TransactionDirection = "in" | "out"

Defined in: src/api/common.ts:27