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
Organization
Ƭ Organization: string
Defined in
WalletAddress
Ƭ WalletAddress: string
Defined in
Functions
active
▸ active(multichain): Promise<number>
Parameters
| Name | Type |
|---|---|
multichain | MultichainClient |
Returns
Promise<number>
Defined in
src/network/model/Nodes.ts:235
get
▸ get(multichain): Promise<NodeInfo[]>
Gets a list with all registered nodes
Parameters
| Name | Type | Description |
|---|---|---|
multichain | MultichainClient | the multichain on which the nodes were registered |
Returns
Promise<NodeInfo[]>
Defined in
src/network/model/Nodes.ts:141
getNetworkPermissions
▸ getNetworkPermissions(multichain, address, organizationsByAddress?): Promise<PermissionInfo[]>
Parameters
| Name | Type |
|---|---|
multichain | MultichainClient |
address | string |
organizationsByAddress? | Map<string, string> |
Returns
Promise<PermissionInfo[]>
Defined in
src/network/model/Nodes.ts:306
getNode
▸ getNode(multichain, address, organization?): Promise<NodeInfo | undefined>
Gets a node registered on the multichain
Parameters
| Name | Type | Description |
|---|---|---|
multichain | MultichainClient | the multichain on which the node is registered |
address | string | the address of the node |
organization? | string | if given, also checks that the organization of the node matches the address |
Returns
Promise<NodeInfo | undefined>
Defined in
src/network/model/Nodes.ts:219
grant
▸ grant(multichain, issuer, target, permissions): Promise<void>
Parameters
| Name | Type |
|---|---|
multichain | MultichainClient |
issuer | string |
target | string |
permissions | NetworkPermission[] |
Returns
Promise<void>
Defined in
publish
▸ publish(multichain, address, args): Promise<Event>
Parameters
| Name | Type |
|---|---|
multichain | MultichainClient |
address | string |
args | Object |
args.createdBy | string |
args.creationTimestamp | Date |
args.data | any |
args.dataVersion | number |
args.intent | default |
Returns
Promise<Event>
Defined in
revoke
▸ revoke(multichain, issuer, target, permissions): Promise<void>
Parameters
| Name | Type |
|---|---|
multichain | MultichainClient |
issuer | string |
target | string |
permissions | NetworkPermission[] |
Returns
Promise<void>