Skip to main content

LookupClient

@totemsdk/lookup-client

@totemsdk/lookup-client / LookupClient

Class: LookupClient

Constructors​

Constructor​

new LookupClient(_config): LookupClient

Parameters​

_config​

LookupClientConfig

Returns​

LookupClient

Methods​

_connect()​

_connect(transport): Promise<void>

Parameters​

transport​

ITransport

Returns​

Promise<void>

announceAgent()​

announceAgent(params): Promise<void>

Parameters​

params​
capabilityId​

string

expiresAt​

number

latencyMs?​

number

manifest​

Uint8Array

Encoded SignedManifest bytes — call encodeManifest(signedManifest) first.

pricePerCall?​

number

tags?​

string[]

Returns​

Promise<void>

announceApp()​

announceApp(params): Promise<void>

Parameters​

params​
appId​

string

authorAddress?​

string

expiresAt​

number

isFree?​

boolean

manifest​

Uint8Array

Encoded SignedManifest bytes — call encodeManifest(signedManifest) first.

Returns​

Promise<void>

broadcastTxPoW()​

broadcastTxPoW(txpowHex): Promise<BroadcastResult>

Parameters​

txpowHex​

string

Returns​

Promise<BroadcastResult>

disconnect()​

disconnect(): void

Returns​

void

getCoin()​

getCoin(coinId): Promise<Coin | null>

Parameters​

coinId​

string

Returns​

Promise<Coin | null>

getCoins()​

getCoins(query): Promise<Coin[]>

Parameters​

query​

CoinsQuery

Returns​

Promise<Coin[]>

getProof()​

getProof(coinId): Promise<MMRProof>

Parameters​

coinId​

string

Returns​

Promise<MMRProof>

getTip()​

getTip(): Promise<ChainTip>

Returns​

Promise<ChainTip>

getToken()​

getToken(tokenId): Promise<TokenInfo>

Parameters​

tokenId​

string

Returns​

Promise<TokenInfo>

getTokensByCreator()​

getTokensByCreator(_address): Promise<TokenInfo[]>

Parameters​

_address​

string

Returns​

Promise<TokenInfo[]>

leaseBurn()​

leaseBurn(reservationId, reason, indices): Promise<void>

Parameters​

reservationId​

string

reason​

string

indices​
addressIndex​

number

l1​

number

l2​

number

Returns​

Promise<void>

leaseCommit()​

leaseCommit(reservationId, txId, indices): Promise<void>

Parameters​

reservationId​

string

txId​

string

indices​
addressIndex​

number

l1​

number

l2​

number

Returns​

Promise<void>

leaseReserve()​

leaseReserve(params): Promise<{ certificate?: unknown; reservation: unknown; }>

Parameters​

params​
branchId?​

string

deviceId?​

string

payloadHash?​

string

purpose?​

string

treeId​

string

ttlMs?​

number

Returns​

Promise<{ certificate?: unknown; reservation: unknown; }>

on()​

on(event, handler): Unsubscribe

Parameters​

event​

"reconnecting" | "reconnected"

handler​

EventHandler

Returns​

Unsubscribe

queryAgents()​

queryAgents(params?): Promise<object[]>

Parameters​

params?​
capabilityName?​

string

limit?​

number

maxLatencyMs?​

number

maxPricePerCall?​

number

tags?​

string[]

Returns​

Promise<object[]>

queryApps()​

queryApps(params?): Promise<object[]>

Parameters​

params?​
authorAddress?​

string

category?​

string[]

freeOnly?​

boolean

limit?​

number

minVersion?​

number

Returns​

Promise<object[]>

searchTokens()​

searchTokens(_query): Promise<TokenInfo[]>

Parameters​

_query​

TokenSearchQuery

Returns​

Promise<TokenInfo[]>

subscribeCoinUpdates()​

subscribeCoinUpdates(cb): Unsubscribe

Parameters​

cb​

CoinUpdateCallback

Returns​

Unsubscribe

watchAddress()​

watchAddress(address): Promise<void>

Parameters​

address​

string

Returns​

Promise<void>

watchCoin()​

watchCoin(coinId): Promise<void>

Parameters​

coinId​

string

Returns​

Promise<void>

watchScript()​

watchScript(script): Promise<void>

Parameters​

script​

string

Returns​

Promise<void>