Class: GolemNetwork

golem-network/golem-network.GolemNetwork

General purpose and high-level API for the Golem Network

This class is the main entry-point for developers that would like to build on Golem Network using @golem-sdk/golem-js. It is supposed to provide an easy access API for use 80% of use cases.

• constructor

• events
• options
• market
• payment
• activity
• network
• rental
• services

• connect
• disconnect
• oneOf
• manyOf
• isConnected
• createNetwork
• destroyNetwork

• new GolemNetwork(options?): GolemNetwork

GolemNetwork

src/golem-network/golem-network.ts:229

• Readonly events: EventEmitter<GolemNetworkEvents, any>

src/golem-network/golem-network.ts:198

• Readonly options: GolemNetworkOptions

src/golem-network/golem-network.ts:200

• Readonly market: MarketModule

src/golem-network/golem-network.ts:206

• Readonly payment: PaymentModule

src/golem-network/golem-network.ts:207

• Readonly activity: ActivityModule

src/golem-network/golem-network.ts:208

• Readonly network: NetworkModule

src/golem-network/golem-network.ts:209

• Readonly rental: RentalModule

src/golem-network/golem-network.ts:210

• Readonly services: GolemServices

Dependency Container

src/golem-network/golem-network.ts:215

▸ connect(): Promise<void>

"Connects" to the network by initializing the underlying components required to perform operations on Golem Network

Promise<void>

Resolves when all initialization steps are completed

src/golem-network/golem-network.ts:322

▸ disconnect(): Promise<void>

"Disconnects" from the Golem Network

Promise<void>

Resolves when all shutdown steps are completed

src/golem-network/golem-network.ts:358

▸ oneOf(options): Promise<ResourceRental>

Define your computational resource demand and access a single instance

Use Case: Get a single instance of a resource from the market to execute operations on

Promise<ResourceRental>

Example

const rental = await glm.oneOf({ order });
await rental
 .getExeUnit()
 .then((exe) => exe.run("echo Hello, Golem! 👋"))
 .then((res) => console.log(res.stdout));
await rental.stopAndFinalize();

src/golem-network/golem-network.ts:425

▸ manyOf(options): Promise<ResourceRentalPool>

Define your computational resource demand and access a pool of instances. The pool will grow up to the specified poolSize.

Promise<ResourceRentalPool>

Example

// create a pool that can grow up to 3 rentals at the same time
const pool = await glm.manyOf({
  poolSize: 3,
  demand
});
await Promise.allSettled([
  pool.withRental(async (rental) =>
    rental
      .getExeUnit()
      .then((exe) => exe.run("echo Hello, Golem from the first machine! 👋"))
      .then((res) => console.log(res.stdout)),
  ),
  pool.withRental(async (rental) =>
    rental
      .getExeUnit()
      .then((exe) => exe.run("echo Hello, Golem from the second machine! 👋"))
      .then((res) => console.log(res.stdout)),
  ),
  pool.withRental(async (rental) =>
    rental
      .getExeUnit()
      .then((exe) => exe.run("echo Hello, Golem from the third machine! 👋"))
      .then((res) => console.log(res.stdout)),
  ),
]);

src/golem-network/golem-network.ts:548

▸ isConnected(): boolean

boolean

src/golem-network/golem-network.ts:621

▸ createNetwork(options?): Promise<Network>

Creates a new logical network within the Golem VPN infrastructure. Allows communication between network nodes using standard network mechanisms, but requires specific implementation in the ExeUnit/runtime, which must be capable of providing a standard Unix-socket interface to their payloads and marshaling the logical network traffic through the Golem Net transport layer

Promise<Network>

src/golem-network/golem-network.ts:633

▸ destroyNetwork(network): Promise<void>

Removes an existing network from the Golem VPN infrastructure.

Promise<void>

src/golem-network/golem-network.ts:641