Pendulum SDK

Pendulum is a distributed globally available messaging protocol that enables tamper proof timestamps. The pendulum SDK provides the necessary tools to create applications running on the distributed pendulum network. The SDK is built on iota.js.

Contributing

Thanks for everyone involved in the process of developing the Pendulum SDK. Hat tip to all of the IOTA developers! Please see the AUTHORS.md

Clone and bootstrap

Fork the repo with Fork button at top right corner.
Clone your fork locally and cd pendulum-sdk.
Bootstrap your environment with:

npm run init

This will install all dependencies, build and link the packages together. The pendulum-sdk uses Lerna to manage multiple packages. You can re-bootstrap your setup at any point with lerna bootstrap command.

Run the tests

Make your changes on a single or across multiple packages and test the system in integration. Run from the root directory:

npm run test

To run tests of specific package just cd to the package directory and run npm test from there.

You may also want to configure your editor to build the source upon save and watch the tests running. Once building on save is setup, you can start watching tests with npm test --watch from each package directory.

Generate docs

Please update the documentation when needed by editing JSDoc annotations and running npm run docs from the root directory.

Using the API

Installation

Install using npm:

npm i @helixnetwork/core

Example

import { composeAPI } from '@helixnetwork/core'

const helix = composeAPI({
    provider: 'http://localhost:14700'
})

helix.getNodeInfo()
    .then(info => console.log(info))
    .catch(err => {})

Composing custom client methods with network provider:

Install an Helix.Protocol http client:

npm install @helixnetwork/http-client

Create an api method with custom provider:

import { createHttpClient } from '@helixnetwork/http-client'
import { createGetNodeInfo } from '@helixnetwork/core'

const client = createHttpClient({
    provider: 'http://localhost:14265'
})

const getNodeInfo = createGetNodeInfo(client)

Creating & broadcasting transactions

Publish transfers by calling prepareTransfers and piping the prepared txs to sendTxHex command.

// must be truly random
const seed = ' your seed here '

// Array of transfers which defines transfer recipients and value transferred in HLX.
const transfers = [{
    address: ' recipient address here ',
    value: 1000, // 1Kh
    tag: '', // optional tag in hexString
    message: '' // optional message in hexString
}]

// Depth or how far to go for tip selection entry point
const depth = 3

// Difficulty of Proof-of-Work required to attach transaction to tangle.
// Minimum value on testnet is currently 2.
const minWeightMagnitude = 2

helix.prepareTransfers(seed, transfers)
    .then(txs => helix.sendTxHex(txs, depth, minWeightMagnitude))
    .then(bundle => {
        console.log(`Published transaction with tail hash: ${bundle[0].hash}`)
        console.log(`Bundle: ${bundle}`)
    })
    .catch(err => {
        // catch any errors
    })

Documentation

For details on all available API methods please see the reference page.

Documentation of Pendulum core and the HTTP API can be found in the Pendulum Documentation in the near future.

fsbbn / pendulum-sdk