Dapp-client NPM

DAPP JavaScript/TypeScript Client Library

General purpose library for the DAPP network

Installation

Using Yarn:

yarn add dapp-client

or using NPM:

npm install --save dapp-client

Quick Start

CommonJS

const { DappClient } = require("dapp-client")
const fetch = require("isomorphic-fetch")

const endpoint = "https://dsp.eosn.io"
const client = new DappClient(endpoint, { fetch })

TypeScript

import { DappClient } from "dapp-client"
import fetch from "isomorphic-fetch"

const endpoint = "https://dsp.eosn.io"
const client = new DappClient(endpoint, { fetch })

Supported Endpoints

# Chain
/v1/chain/get_currency_stats
/v1/chain/get_info
/v1/chain/get_table_by_scope
/v1/chain/get_table_rows

# DSP
/v1/dsp/ipfsservice1/get_table_row

API

DappClient

DAPP Client

General purpose library for the DAPP network.

Parameters

endpoint string dsp endpoint
options object optional params (optional, default {})
- options.dappservices string DAPP Services contract (optional, default "dappservices")
- options.ipfsservice1 string IPFS Services contract (optional, default "ipfsservice1")
- options.oracleservic string Oracle Services contract (optional, default "oracleservic")
- options.cronservices string Cron Services contract (optional, default "cronservices")
- options.fetch Fetch fetch (optional, default global.fetch)

Examples

const endpoint = "https://dsp.eosn.io"
const client = new DappClient(endpoint, { fetch })

get_table_package

Get TABLE package

Parameters

options object optional params (optional, default {})
- options.lower_bound string? Filters results to return the first element that is not less than provided value in set
- options.upper_bound string? Filters results to return the first element that is greater than provided value in set
- options.limit number Limit the result amount (optional, default 10)
- options.show_payer boolean Show Payer (optional, default false)

Examples

const response = await client.get_table_package({limit: 500});

for (const row of response.rows) {
    console.log(row);
    // {
    //     id: 9,
    //     api_endpoint: 'https://dsp.eosn.io',
    //     package_json_uri: 'https://eosnation.io/package1.dsp-package.json',
    //     package_id: 'package1',
    //     service: 'ipfsservice1',
    //     provider: 'eosnationdsp',
    //     quota: '500.0000 QUOTA',
    //     package_period: 86400,
    //     min_stake_quantity: '10000.0000 DAPP',
    //     min_unstake_period: 3600,
    //     enabled: 1
    // }
}

get_table_staking

Get TABLE staking

Parameters

scope string dsp account
options object optional params (optional, default {})
- options.lower_bound string? Filters results to return the first element that is not less than provided value in set
- options.upper_bound string? Filters results to return the first element that is greater than provided value in set
- options.limit number Limit the result amount (optional, default 10)
- options.show_payer boolean Show Payer (optional, default false)

Examples

const response = await client.get_table_staking('eosnationdsp', {limit: 500});

for (const row of response.rows) {
    console.log(row);
    // {
    //     id: 0,
    //     account: 'eosnationdsp',
    //     balance: '0.0000 DAPP',
    //     provider: 'eosnationdsp',
    //     service: 'ipfsservice1'
    // }
}

get_table_refunds

Get TABLE refunds

Parameters

scope string dsp account
options object optional params (optional, default {})
- options.lower_bound string? Filters results to return the first element that is not less than provided value in set
- options.upper_bound string? Filters results to return the first element that is greater than provided value in set
- options.limit number Limit the result amount (optional, default 10)
- options.show_payer boolean Show Payer (optional, default false)

Examples

const response = await client.get_table_refunds('eosnationdsp', {limit: 500});

for (const row of response.rows) {
    console.log(row);
    // {
    //     id: 0,
    //     account: 'eosnationdsp',
    //     amount: '10.0000 DAPP',
    //     unstake_time: 12345678
    //     provider: 'eosnationdsp',
    //     service: 'ipfsservice1'
    // }
}

get_table_accountext

Get TABLE accountext

Parameters

options object optional params (optional, default {})
- options.lower_bound string? Filters results to return the first element that is not less than provided value in set
- options.upper_bound string? Filters results to return the first element that is greater than provided value in set
- options.limit number Limit the result amount (optional, default 10)
- options.show_payer boolean Show Payer (optional, default false)

Examples

const response = await client.get_table_accountext({limit: 500});

for (const row of response.rows) {
    console.log(row);
    // {
    //     id: 29,
    //     account: 'eosnationdsp',
    //     service: 'ipfsservice1',
    //     provider: 'eosnationdsp',
    //     quota: '0.0001 QUOTA',
    //     balance: '255101.1461 DAPP',
    //     last_usage: '1555466031000',
    //     last_reward: '1555466031000',
    //     package: 'package2',
    //     pending_package: 'package2',
    //     package_started: '1555466031000',
    //     package_end: '1555469631000'
    // }
}

get_dapphdl_accounts

Get TABLE accounts from dappairhodl1 contract

Parameters

scope string user account
options object optional params (optional, default {})
- options.lower_bound string? Filters results to return the first element that is not less than provided value in set
- options.upper_bound string? Filters results to return the first element that is greater than provided value in set
- options.limit number Limit the result amount (optional, default 10)
- options.show_payer boolean Show Payer (optional, default false)

Examples

const response = await client.get_dapphdl_accounts('eosnationdsp', {limit: 500});

for (const row of response.rows) {
    console.log(row);
    // {
    //     balance: '0.0000 DAPPHDL',
    //     allocation: '0.0000 DAPPHDL',
    //     staked: '0.0000 DAPPHDL',
    //     claimed: false
    // }
}

dsp_ipfs_get_table_row

GET /v1/dsp/ipfsservice1/get_table_row

Returns an object containing row from the specified table.

Parameters

contract string The name of the smart contract that controls the provided table
scope string The account to which this data belongs
table string The name of the table to query
key string The key value to query
options object optional params (optional, default {})
- options.lower_bound string? Filters results to return the first element that is not less than provided value in set
- options.upper_bound string? Filters results to return the first element that is greater than provided value in set
- options.limit number Limit the result amount (optional, default 10)
- options.show_payer boolean Show Payer (optional, default false)
- options.json boolean JSON response (optional, default true)
- options.index_position number Position of the index used (optional, default 1)
- options.key_type string? Type of key specified by index_position (for example - uint64_t or name)
- options.table_key string? Table Key
- options.encode_type string? Encode type

Examples

const response = await rpc.dsp_ipfs_get_table_row("<contract>", "<scope>", "<table>", "<key>");
console.log(response);

Returns Promise<GetTableRows> table rows

DAPP

Examples

import { names } from "dapp-client"

names.DAPP // => "......2ke1.o4"

DAPPHDL

Examples

import { names } from "dapp-client"

names.DAPPHDL // => ".1a4cm2ke1.o4"

EosioClient

EOSIO Client

Parameters

endpoint string dsp endpoint
options object optional params (optional, default {})
- options.fetch Fetch fetch (optional, default global.fetch)

Examples

const endpoint = "https://api.eosn.io"
const client = new EosioClient(endpoint, { fetch })

get_table_rows

GET /v1/chain/get_table_rows

Returns an object containing rows from the specified table.

Parameters

code string The name of the smart contract that controls the provided table
scope string The account to which this data belongs
table string The name of the table to query
options object optional params (optional, default {})
- options.lower_bound string? Filters results to return the first element that is not less than provided value in set
- options.upper_bound string? Filters results to return the first element that is greater than provided value in set
- options.limit number Limit the result amount (optional, default 10)
- options.show_payer boolean Show Payer (optional, default false)
- options.json boolean JSON response (optional, default true)
- options.index_position number Position of the index used (optional, default 1)
- options.key_type string? Type of key specified by index_position (for example - uint64_t or name)
- options.table_key string? Table Key
- options.encode_type string? Encode type

Examples

const response = await rpc.get_table_rows("<code>", "<scope>", "<table>");
console.log(response);

Returns Promise<GetTableRows> table rows

get_all_table_rows

GET /v1/chain/get_table_rows

Returns all objects containing rows from the specified table.

Parameters

code string The name of the smart contract that controls the provided table
scope string The account to which this data belongs
table string The name of the table to query
lower_bound_key string Key value to identify lower_bound object
options object optional params (optional, default {})
- options.lower_bound string? Filters results to return the first element that is not less than provided value in set
- options.upper_bound string? Filters results to return the first element that is greater than provided value in set
- options.limit number Limit the result amount per get_table_rows API request (optional, default 1500)
- options.show_payer boolean Show Payer (optional, default false)
- options.json boolean JSON response (optional, default true)
- options.index_position number Position of the index used (optional, default 1)
- options.key_type string? Type of key specified by index_position (for example - uint64_t or name)
- options.table_key string? Table Key
- options.encode_type string? Encode type
- options.delay_ms number? Delay in ms between API calls (helps prevents rate limited APIs)

Examples

const response = await rpc.get_all_table_rows("<code>", "<scope>", "<table>", "<lower_bound_key>");
console.log(response);

Returns Promise<GetTableRows> table rows

get_table_by_scope

GET /v1/chain/get_table_by_scope

Returns an object containing rows from the specified table.

Parameters

code string name of the contract to return table data for
options object optional params (optional, default {})
- options.table string? Filter results by table
- options.lower_bound string? Filters results to return the first element that is not less than provided value in set
- options.upper_bound string? Filters results to return the first element that is greater than provided value in set
- options.limit number? Limit number of results returned.
- options.reverse boolean Reverse the order of returned results (optional, default false)

Examples

const response = await rpc.get_table_by_scope();
console.log(response);

Returns Promise<GetTableByScope> table rows

get_currency_balance

GET /v1/chain/get_currency_balance

Retrieve the stats of for a given currency

Parameters

code string The contract that operates the currency
account string The account to query balances for
symbol string The symbol for the currency if the contract operates multiple currencies

Examples

const response = await rpc.get_currency_balance("eosio.token", "eosio.null", "EOS");
console.log(response);

Returns Promise<GetCurrencyBalance> table rows

get_currency_stats

GET /v1/chain/get_currency_stats

Retrieve the stats of for a given currency

Parameters

code string The contract that operates the currency
symbol string The symbol for the currency if the contract operates multiple currencies

Examples

const response = await rpc.get_currency_stats("eosio.token", "EOS");
console.log(response);

Returns Promise<GetCurrencyStats> table rows

get_info

GET /v1/chain/get_info

Returns an object containing various details about the blockchain.

Examples

const response = await rpc.get_info();
console.log(response);

Returns Promise<GetInfo> table rows

delay

Promise based timeout delay

Parameters

ms number Milisecond delay

Examples

await delay(100);

Returns Promise<void>

@infinitebrahmanuniverse/nolb-dap @everything-registry/sub-chunk-1441 dappaccount dappaccount_demo dappaccount_demo_rn

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

7 years ago

7 years ago

7 years ago

DAPP JavaScript/TypeScript Client Library

Installation

Quick Start

Supported Endpoints

API

Table of Contents

DappClient

Parameters

Examples

get_table_package

Parameters

Examples

get_table_staking

Parameters

Examples

get_table_refunds

Parameters

Examples

get_table_accountext

Parameters

Examples

get_dapphdl_accounts

Parameters

Examples

dsp_ipfs_get_table_row

Parameters

Examples

DAPP

Examples

DAPPHDL

Examples

EosioClient

Parameters

Examples

get_table_rows

Parameters

Examples

get_all_table_rows

Parameters

Examples

get_table_by_scope

Parameters

Examples

get_currency_balance

Parameters

Examples

get_currency_stats

Parameters

Examples

get_info

Examples

delay

Parameters

Examples