@stardust-collective/dag4 v2.4.0

DAG4 - DAG JavaScript API

This is the DAG JavaScript API for Constellation Network.

Please read the documentation for more detailed instructions. The following includes basic install and configuration.

Installation

Node

npm install @stardust-collective/dag4

Yarn

yarn add @stardust-collective/dag4

Usage

// In Node.js
const fetch = require('node-fetch');
const { dag4 } = require("@stardust-collective/dag4");

dag4.di.useFetchHttpClient(fetch);
dag4.network.config({
    beUrl: 'https://block-explorer.constellationnetwork.io',
    lbUrl: 'http://lb.constellationnetwork.io:9000'
})

Now you can use it to:

// Get latest snapshot from the block explorer
dag4.network.blockExplorerApi.getLatestSnapshot();

// Get the total supply from a validator node
dag4.network.loadBalancerApi.getTotalSupply();

Usage with TypeScript

We support types within the repo itself. Please open an issue here if you find any wrong types.

You can use dag4.js as follows:

import dag4

import { dag4 } from '@stardust-collective/dag4';

Configure Network

import fetch from 'node-fetch';

dag4.di.useFetchHttpClient(fetch);
dag4.network.config({
   beUrl: 'https://block-explorer.constellationnetwork.io',
   lbUrl: 'http://lb.constellationnetwork.io:9000'
})

If you are using the types in a commonjs module, like in a Node app, you have to enable esModuleInterop and allowSyntheticDefaultImports in your tsconfig for typesystem compatibility:

"compilerOptions": {
    "allowSyntheticDefaultImports": true,
    "esModuleInterop": true,
    ....

Documentation

Documentation can be found at Wiki.

Building

Requirements

• Node.js
• npm

sudo apt-get update
sudo apt-get install nodejs
sudo apt-get install npm

Building (DAG4)

Build the dag4.js package:

npm run build

Testing (mocha)

npm test

Community

• Discord
• Telegram

License

This project is licensed under the terms of the MIT license.