Skip to main content

network/model/Nodes

Api Code Documentation / Exports / network/model/Nodes

Table of contents#

Interfaces#

Type aliases#

Functions#

Type aliases#

NetworkPermission#

Ƭ NetworkPermission: "connect" | "send" | "receive" | "issue" | "create" | "mine" | "activate" | "admin"

Defined in#

src/network/model/Nodes.ts:14


Organization#

Ƭ Organization: string

Defined in#

src/network/model/Nodes.ts:13


WalletAddress#

Ƭ WalletAddress: string

Defined in#

src/network/model/Nodes.ts:12

Functions#

active#

active(multichain): Promise<number>

Parameters#

NameType
multichainMultichainClient

Returns#

Promise<number>

Defined in#

src/network/model/Nodes.ts:234


get#

get(multichain): Promise<NodeInfo[]>

Gets a list with all registered nodes

Parameters#

NameTypeDescription
multichainMultichainClientthe multichain on which the nodes were registered

Returns#

Promise<NodeInfo[]>

Defined in#

src/network/model/Nodes.ts:140


getNetworkPermissions#

getNetworkPermissions(multichain, address, organizationsByAddress?): Promise<PermissionInfo[]>

Parameters#

NameType
multichainMultichainClient
addressstring
organizationsByAddress?Map<string, string>

Returns#

Promise<PermissionInfo[]>

Defined in#

src/network/model/Nodes.ts:305


getNode#

getNode(multichain, address, organization?): Promise<NodeInfo | undefined>

Gets a node registered on the multichain

Parameters#

NameTypeDescription
multichainMultichainClientthe multichain on which the node is registered
addressstringthe address of the node
organization?stringif given, also checks that the organization of the node matches the address

Returns#

Promise<NodeInfo | undefined>

Defined in#

src/network/model/Nodes.ts:218


grant#

grant(multichain, issuer, target, permissions): Promise<void>

Parameters#

NameType
multichainMultichainClient
issuerstring
targetstring
permissionsNetworkPermission[]

Returns#

Promise<void>

Defined in#

src/network/model/Nodes.ts:44


publish#

publish(multichain, address, args): Promise<Event>

Parameters#

NameType
multichainMultichainClient
addressstring
argsObject
args.createdBystring
args.creationTimestampDate
args.dataany
args.dataVersionnumber
args.intentdefault

Returns#

Promise<Event>

Defined in#

src/network/model/Nodes.ts:62


revoke#

revoke(multichain, issuer, target, permissions): Promise<void>

Parameters#

NameType
multichainMultichainClient
issuerstring
targetstring
permissionsNetworkPermission[]

Returns#

Promise<void>

Defined in#

src/network/model/Nodes.ts:53