ya-ts-client

Yagna TS Client

The ya-ts-client package provides low level API bindings in form of collection TypeScript clients generated from the Yagna public API OpenApi specifications.

The primary and only purpose of this package is to provide that basic implementation. As a "core" library, it shouldn't need to be added as a dependency to any user code, only to other Golem Network related SDKs or libraries.

If you want to start building solutions using Golem Network, here are more suitable options:

• Official JS SDK - @golem-sdk/golem-js - which models the Decentralized Computation Marketplace logic
• TaskExecutor - @golem-sdk/task-executor - built on top of @golem-sdk/golem-js and provides a "task oriented" API for simple distributed computation scenarios

Installation

npm install --save ya-ts-client

Usage

The library exposes multiple API clients which are auto-generated from the official OpenApi specifications. The documentation of the generated API is hosted on GitHub pages.

Working with API Clients

Here's just one example of how to use the Payment module's ApiClient to obtain the list of allocations.

import { Payment } from "ya-ts-client";

/**
 * Example of usage of the Payment API
 */
const payment = new Payment.ApiClient({
  BASE: "http://localhost:7465/payment-api/v1",
  HEADERS: {
    Authorization: "Bearer your-app-key",
  },
});

const allocations = await payment.requestor.getAllocations();

Working with enum types generated for the library

In cases where you would like to make use of the enums available in the generated modules, this snippet explains how to do it:

// Reach for the module you need
import { Activity } from "ya-ts-client";

// You can import the enum from the **namespace** like that
import ResultEnum = Activity.ExeScriptCommandResult.result;
// Simple alias lie this one won't work
// type ResultEnum = Activity.ExeScriptCommandResult.result; // INVALID!!!

export interface YaTsTest {
  // Then refer to it via the alias
  result: ResultEnum;
}

// Check it yourself :)
const x: YaTsTest = {
  result: ResultEnum.OK,
};

// Outputs: { result: 'Ok' }
console.log(x);

See also

• Official Golem JS SDK repo
• Documentation for JS Creators