Class: NetworkApiAdapter
shared/yagna/adapters/network-api-adapter.NetworkApiAdapter
Implements
Table of contents
Constructors
Methods
Constructors
constructor
• new NetworkApiAdapter(yagnaApi): NetworkApiAdapter
Parameters
| Name | Type |
|---|---|
yagnaApi | YagnaApi |
Returns
Defined in
src/shared/yagna/adapters/network-api-adapter.ts:6
Methods
createNetwork
▸ createNetwork(options): Promise<Network>
Creates a new network with the specified options.
Parameters
| Name | Type | Description |
|---|---|---|
options | Object | NetworkOptions |
options.ip | string | - |
options.mask? | string | - |
options.gateway? | string | - |
Returns
Promise<Network>
Implementation of
Defined in
src/shared/yagna/adapters/network-api-adapter.ts:8
removeNetwork
▸ removeNetwork(network): Promise<void>
Removes an existing network.
Parameters
| Name | Type | Description |
|---|---|---|
network | Network | The network to be removed. |
Returns
Promise<void>
Implementation of
Defined in
src/shared/yagna/adapters/network-api-adapter.ts:22
createNetworkNode
▸ createNetworkNode(network, nodeId, nodeIp): Promise<NetworkNode>
Creates a new node within a specified network.
Parameters
| Name | Type | Description |
|---|---|---|
network | Network | The network to which the node will be added. |
nodeId | string | The ID of the node to be created. |
nodeIp | string | Optional IP address for the node. If not provided, the first available IP address will be assigned. |
Returns
Promise<NetworkNode>
Implementation of
Defined in
src/shared/yagna/adapters/network-api-adapter.ts:35
removeNetworkNode
▸ removeNetworkNode(network, node): Promise<void>
Removes an existing node from a specified network.
Parameters
| Name | Type | Description |
|---|---|---|
network | Network | The network from which the node will be removed. |
node | NetworkNode | The node to be removed. |
Returns
Promise<void>
Implementation of
Defined in
src/shared/yagna/adapters/network-api-adapter.ts:56
getIdentity
▸ getIdentity(): Promise<string>
Returns the identifier of the requesor
Returns
Promise<string>