https://github.com/golemfactory/ya-ts-client

https://github.com/golemfactory/ya-ts-client

golem

Last synced: 4 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/golemfactory/ya-ts-client
• Owner: golemfactory
• Created: 2020-08-10T16:31:01.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-04-08T21:45:58.000Z (10 months ago)
• Last Synced: 2024-04-14T04:19:28.858Z (10 months ago)
• Topics: golem
• Language: JavaScript
• Homepage:
• Size: 1.22 MB
• Stars: 2
• Watchers: 5
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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](https://github.com/golemfactory/ya-client) 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](https://www.npmjs.com/package/@golem-sdk/golem-js) - which models the Decentralized Computation Marketplace logic

- [TaskExecutor - @golem-sdk/task-executor](https://www.npmjs.com/package/@golem-sdk/task-executor) - built on top of `@golem-sdk/golem-js` and provides a "task oriented" API for simple distributed computation scenarios

## Installation

```bash

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](https://golemfactory.github.io/ya-ts-client/).

### Working with API Clients

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

```ts

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

// Or refer to the whole library:

//import * as YaTsClient from "ya-ts-client";

/**

 * Example of usage of the Payment API

 */

const payment = new PaymentApi.Client({

  BASE: "http://localhost:7465/payment-api/v1",

  HEADERS: {

    Authorization: "Bearer your-app-key",

  },

});

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

console.log("Allocated funds:", allocations);

```

## See also

- [Official Golem JS SDK repo](https://github.com/golemfactory/golem-js)

- [Documentation for JS Creators](https://docs.golem.network/docs/creators/javascript)