@garfdev/sdk v1.0.4

THX Network JavaScript SDK

This SDK contains a client class that simplifies interactions with THX Network API's. Configure your digital assets in your dashboard and use the SDK to integrate distribution of those assets into your application.

Prerequisites

1. Sign up for an account
2. Create a digital asset
3. Deploy a pool
4. Create API credentials

Grant Types

The OAuth2 server exposes two authorization variants:

Grant: Authorization Code

Meant for user authentication in a browser application. Upon signin a popup will be shown where the user will be able to authenticate before being redirected to your application and obtain a valid session.

Grant: Client Credentials

Meant for machine to machine authentication in a server-side application.

Usage (browser)

Sign in and list the tokens owned by this account.

const thx = new THXClient({
    clientId: 'CLIENT_ID',
    clientSecret: 'CLIENT_SECRET',
    grantType: 'authorization_code',
    redirectUrl: 'https://localhost:8080',
    scopes: 'openid account:read erc20:read erc721:read',
});

await thx.signin();

const tokens = await client.erc20.list();

Usage (server)

Transfer tokens from your pool to another account.

const thx = new THXClient({
    clientId: 'CLIENT_ID',
    clientSecret: 'CLIENT_SECRET',
    grantType: 'client_credentials',
    scopes: 'openid withdrawals:read withdrawals:write',
});

const withdrawal = await client.withdrawals.post({
    amount: '100000000',
    account: '0xf4b70b3931166B422bBC772a2EafcE8BD5A017F9',
});