Skip to main content

Interface: WalletHandlers

Properties

account.receive

account.receive: (params: { account: Account }) => Promisable<string>

Type declaration

▸ (params): Promisable<string>

Parameters
NameType
paramsObject
params.accountAccount
Returns

Promisable<string>

Defined in

packages/server/src/types.ts:63


account.request

account.request: (params: { accounts$: Observable<Account[]> ; currencies$: Observable<({ color: string ; decimals: number ; family: "bitcoin" | "ethereum" | "algorand" | "crypto_org" | "ripple" | "cosmos" | "celo" | "hedera" | "filecoin" | "tezos" | "polkadot" | "stellar" | "tron" | "near" | "neo" | "elrond" | "cardano" | "solana" = schemaFamilies; id: string ; name: string ; ticker: string ; type: "CryptoCurrency" } | { color: string ; contract: string ; decimals: number ; id: string ; name: string ; parent: string ; standard: "ERC20" = schemaTokenStandard; ticker: string ; type: "TokenCurrency" })[]> }) => Promisable<Account>

Type declaration

▸ (params): Promisable<Account>

Parameters
NameType
paramsObject
params.accounts$Observable<Account[]>
params.currencies$Observable<({ color: string ; decimals: number ; family: "bitcoin" | "ethereum" | "algorand" | "crypto_org" | "ripple" | "cosmos" | "celo" | "hedera" | "filecoin" | "tezos" | "polkadot" | "stellar" | "tron" | "near" | "neo" | "elrond" | "cardano" | "solana" = schemaFamilies; id: string ; name: string ; ticker: string ; type: "CryptoCurrency" } | { color: string ; contract: string ; decimals: number ; id: string ; name: string ; parent: string ; standard: "ERC20" = schemaTokenStandard; ticker: string ; type: "TokenCurrency" })[]>
Returns

Promisable<Account>

Defined in

packages/server/src/types.ts:59


bitcoin.getXPub

bitcoin.getXPub: (params: { accountId: string }) => Promisable<string>

Type declaration

▸ (params): Promisable<string>

Parameters
NameType
paramsObject
params.accountIdstring
Returns

Promisable<string>

Defined in

packages/server/src/types.ts:95


device.close

device.close: (params: { transportId: string }) => Promisable<string>

Type declaration

▸ (params): Promisable<string>

Parameters
NameType
paramsObject
params.transportIdstring
Returns

Promisable<string>

Defined in

packages/server/src/types.ts:81


device.exchange

device.exchange: (params: { apduHex: string ; transportId: string }) => Promisable<string>

Type declaration

▸ (params): Promisable<string>

Parameters
NameType
paramsObject
params.apduHexstring
params.transportIdstring
Returns

Promisable<string>

Defined in

packages/server/src/types.ts:82


device.open

device.open: (params: { deviceId: string }) => Promisable<string>

Type declaration

▸ (params): Promisable<string>

Parameters
NameTypeDescription
paramsObject-
params.deviceIdstringID of the device to select
Returns

Promisable<string>

Defined in

packages/server/src/types.ts:83


device.select

device.select: (params: { appName?: string ; appVersionRange?: string ; devices?: ["blue" | "nanoS" | "nanoX" | "nanoSP" | "stax", ...("blue" | "nanoS" | "nanoX" | "nanoSP" | "stax")[]] ; firmwareVersionRange?: string ; seeded?: boolean }) => Promisable<string>

Type declaration

▸ (params): Promisable<string>

Parameters
NameTypeDescription
paramsObject-
params.appName?stringSelect the BOLOS App. If undefined selects BOLOS
params.appVersionRange?stringChecks the BOLOS App version range. If undefined no checks Can be any ranges supported here: https://github.com/npm/node-semver#ranges
params.devices?["blue" | "nanoS" | "nanoX" | "nanoSP" | "stax", ...("blue" | "nanoS" | "nanoX" | "nanoSP" | "stax")[]]Checks if the device matches one of the types. If undefined no checks
params.firmwareVersionRange?stringChecks the BOLOS Firmware version range. If undefined no checks Can be any ranges supported here: https://github.com/npm/node-semver#ranges
params.seeded?booleanChecks if the device is seeded. If undefined no checks
Returns

Promisable<string>

Defined in

packages/server/src/types.ts:84


device.transport

device.transport: (params: { appName?: string ; appVersionRange?: string ; devices?: ["blue" | "nanoS" | "nanoX" | "nanoSP" | "stax", ...("blue" | "nanoS" | "nanoX" | "nanoSP" | "stax")[]] ; firmwareVersionRange?: string ; seeded?: boolean }) => Promisable<string>

Type declaration

▸ (params): Promisable<string>

Parameters
NameTypeDescription
paramsObject-
params.appName?stringSelect the BOLOS App. If undefined selects BOLOS
params.appVersionRange?stringChecks the BOLOS App version range. If undefined no checks Can be any ranges supported here: https://github.com/npm/node-semver#ranges
params.devices?["blue" | "nanoS" | "nanoX" | "nanoSP" | "stax", ...("blue" | "nanoS" | "nanoX" | "nanoSP" | "stax")[]]Checks if the device matches one of the types. If undefined no checks
params.firmwareVersionRange?stringChecks the BOLOS Firmware version range. If undefined no checks Can be any ranges supported here: https://github.com/npm/node-semver#ranges
params.seeded?booleanChecks if the device is seeded. If undefined no checks
Returns

Promisable<string>

Defined in

packages/server/src/types.ts:85


exchange.complete

exchange.complete: (params: ExchangeParams) => Promisable<string>

Type declaration

▸ (params): Promisable<string>

Parameters
NameType
paramsExchangeParams
Returns

Promisable<string>

Defined in

packages/server/src/types.ts:97


exchange.start

exchange.start: (params: { exchangeType: "FUND" | "SELL" | "SWAP" = schemaExchangeType }) => Promisable<string>

Type declaration

▸ (params): Promisable<string>

Parameters
NameTypeDefault value
paramsObjectundefined
params.exchangeType"FUND" | "SELL" | "SWAP"schemaExchangeType
Returns

Promisable<string>

Defined in

packages/server/src/types.ts:96


message.sign

message.sign: (params: { account: Account ; message: Buffer ; meta: undefined | Record<string, unknown> }) => Promisable<Buffer>

Type declaration

▸ (params): Promisable<Buffer>

Parameters
NameType
paramsObject
params.accountAccount
params.messageBuffer
params.metaundefined | Record<string, unknown>
Returns

Promisable<Buffer>

Defined in

packages/server/src/types.ts:64


storage.get

storage.get: (params: { key: string ; storeId: string }) => Promisable<undefined | string>

Type declaration

▸ (params): Promisable<undefined | string>

Parameters
NameType
paramsObject
params.keystring
params.storeIdstring
Returns

Promisable<undefined | string>

Defined in

packages/server/src/types.ts:91


storage.set

storage.set: (params: { key: string ; storeId: string ; value: string }) => Promisable<void>

Type declaration

▸ (params): Promisable<void>

Parameters
NameType
paramsObject
params.keystring
params.storeIdstring
params.valuestring
Returns

Promisable<void>

Defined in

packages/server/src/types.ts:86


transaction.sign

transaction.sign: (params: { account: Account ; meta: undefined | Record<string, unknown> ; options?: { hwAppId?: string } ; transaction: Transaction }) => Promisable<Buffer>

Type declaration

▸ (params): Promisable<Buffer>

Parameters
NameType
paramsObject
params.accountAccount
params.metaundefined | Record<string, unknown>
params.options?Object
params.options.hwAppId?string
params.transactionTransaction
Returns

Promisable<Buffer>

Defined in

packages/server/src/types.ts:69


transaction.signAndBroadcast

transaction.signAndBroadcast: (params: { account: Account ; meta: undefined | Record<string, unknown> ; options?: { hwAppId?: string } ; transaction: Transaction }) => Promisable<string>

Type declaration

▸ (params): Promisable<string>

Parameters
NameType
paramsObject
params.accountAccount
params.metaundefined | Record<string, unknown>
params.options?Object
params.options.hwAppId?string
params.transactionTransaction
Returns

Promisable<string>

Defined in

packages/server/src/types.ts:75