@golem-sdk/golem-js/dist/network/api.d.ts

NodeJS and WebBrowser SDK for building apps running on Golem Network

import { Network } from "./network";
import { NetworkNode } from "./node";
import { NetworkOptions } from "./network.module";
export interface NetworkEvents {
    networkCreated: (event: {
        network: Network;
    }) => void;
    errorCreatingNetwork: (event: {
        error: Error;
    }) => void;
    networkRemoved: (event: {
        network: Network;
    }) => void;
    errorRemovingNetwork: (event: {
        network: Network;
        error: Error;
    }) => void;
    nodeCreated: (event: {
        network: Network;
        node: NetworkNode;
    }) => void;
    errorCreatingNode: (event: {
        network: Network;
        error: Error;
    }) => void;
    nodeRemoved: (event: {
        network: Network;
        node: NetworkNode;
    }) => void;
    errorRemovingNode: (event: {
        network: Network;
        node: NetworkNode;
        error: Error;
    }) => void;
}
export interface INetworkApi {
    /**
     * Creates a new network with the specified options.
     * @param options NetworkOptions
     * @param signalOrTimeout - The timeout in milliseconds or an AbortSignal that will be used to cancel the operation
     */
    createNetwork(options: NetworkOptions, signalOrTimeout?: AbortSignal | number): Promise<Network>;
    /**
     * Removes an existing network.
     * @param network - The network to be removed.
     * @param signalOrTimeout - The timeout in milliseconds or an AbortSignal that will be used to cancel the operation
     */
    removeNetwork(network: Network, signalOrTimeout?: AbortSignal | number): Promise<void>;
    /**
     * Creates a new node within a specified network.
     * @param network - The network to which the node will be added.
     * @param nodeId - The ID of the node to be created.
     * @param nodeIp - Optional IP address for the node. If not provided, the first available IP address will be assigned.
     * @param signalOrTimeout - The timeout in milliseconds or an AbortSignal that will be used to cancel the operation
     */
    createNetworkNode(network: Network, nodeId: string, nodeIp?: string, signalOrTimeout?: AbortSignal | number): Promise<NetworkNode>;
    /**
     * Removes an existing node from a specified network.
     * @param network - The network from which the node will be removed.
     * @param node - The node to be removed.
     * @param signalOrTimeout - The timeout in milliseconds or an AbortSignal that will be used to cancel the operation
     */
    removeNetworkNode(network: Network, node: NetworkNode, signalOrTimeout?: AbortSignal | number): Promise<void>;
    /**
     * Returns the identifier of the requesor
     * @param signalOrTimeout - The timeout in milliseconds or an AbortSignal that will be used to cancel the operation
     */
    getIdentity(signalOrTimeout?: AbortSignal | number): Promise<string>;
}