Skip to main content

EdgeLookupPort

@totemsdk/edge


@totemsdk/edge / EdgeLookupPort

Interface: EdgeLookupPort

Methods

announce()

announce(params): Promise<EdgeOperationResult<unknown>>

Parameters

params

{ appId: string; authorAddress?: string; expiresAt: number; isFree?: boolean; kind: "app"; signed: unknown; } | { capabilityId: string; expiresAt: number; kind: "agent"; latencyMs?: number; pricePerCall?: number; signed: unknown; tags?: string[]; }

Type Literal

{ appId: string; authorAddress?: string; expiresAt: number; isFree?: boolean; kind: "app"; signed: unknown; }

appId

string

authorAddress?

string

expiresAt

number

isFree?

boolean

kind

"app"

signed

unknown

WOTS-signed manifest (SignedManifest from @totemsdk/manifest).


Type Literal

{ capabilityId: string; expiresAt: number; kind: "agent"; latencyMs?: number; pricePerCall?: number; signed: unknown; tags?: string[]; }

capabilityId

string

expiresAt

number

kind

"agent"

latencyMs?

number

pricePerCall?

number

signed

unknown

WOTS-signed manifest (SignedManifest from @totemsdk/manifest).

tags?

string[]

Returns

Promise<EdgeOperationResult<unknown>>


lookup()

lookup(params): Promise<EdgeOperationResult<{ results: unknown[]; }>>

Parameters

params
kind?

string

query

string

Returns

Promise<EdgeOperationResult<{ results: unknown[]; }>>


query()

query(params): Promise<EdgeOperationResult<{ results: object[]; }>>

Query the lookup network for registered apps or agents. Returns an empty array if no lookup port is configured on the node.

Parameters

params

{ authorAddress?: string; category?: string[]; freeOnly?: boolean; kind: "app"; limit?: number; minVersion?: number; } | { capabilityName?: string; kind: "agent"; limit?: number; maxLatencyMs?: number; maxPricePerCall?: number; tags?: string[]; }

Returns

Promise<EdgeOperationResult<{ results: object[]; }>>


watch()

watch(params): Promise<EdgeOperationResult<{ unsubscribe: () => void; }>>

Parameters

params
address

string

onUpdate

(data) => void

Returns

Promise<EdgeOperationResult<{ unsubscribe: () => void; }>>