Skip to content
This repository has been archived by the owner on Sep 6, 2024. It is now read-only.

Latest commit

 

History

History
87 lines (62 loc) · 3.91 KB

README.md

File metadata and controls

87 lines (62 loc) · 3.91 KB
Raw

@iota/iota.js

This library is functionally complete, but it is recommended to use iota.rs. The rust library will be more heavily maintained and is much more performant.

Client library for IOTA chrysalis network, implemeted in TypeScript to strongly type the objects sent and received from the API.

Runs in both NodeJS and Browser environments.

Prerequisites

npm install @iota/iota.js

Example

const { SingleNodeClient } = require("@iota/iota.js");

async function run() {
    const client = new SingleNodeClient("https://chrysalis-nodes.iota.org");

    const info = await client.info();
    console.log("Node Info");
    console.log("\tName:", info.name);
    console.log("\tVersion:", info.version);
    console.log("\tIs Healthy:", info.isHealthy);
    console.log("\tNetwork Id:", info.networkId);
    console.log("\tLatest Milestone Index:", info.latestMilestoneIndex);
    console.log("\tConfirmed Milestone Index:", info.confirmedMilestoneIndex);
    console.log("\tPruning Index:", info.pruningIndex);
    console.log("\tFeatures:", info.features);
    console.log("\tMin PoW Score:", info.minPoWScore);
}

run()
    .then(() => console.log("Done"))
    .catch((err) => console.error(err));

API

The class and method documentation can be found in ./docs/api.md

High level operations

There are also high level operations which make use of the API level methods:

  • getBalance - Given a seed and account index calculate the total balance available on it's addresses.
  • getUnspentAddress - Given a seed, account index, and start index find the next unspent address.
  • getUnspentAddresses - Given a seed, account index, and start index find all the unspent addresses.
  • promote - Promote a message by attaching an empty message to it.
  • reattach - Reattach a message using the message id.
  • retry - Looks at the metadata for a message and promotes or retries depending on it's state.
  • retrieveData - Given a message id return the index and data from it.
  • send - Given a seed, path, destination address in bech32 format and amount, make a single transfer.
  • sendEd25519 - Given a seed, path, destination address in ed25519 format and amount, make a single transfer.
  • sendMultiple - Given a seed, path, destination addresses in bech32 format and amounts, make multiple transfers.
  • sendMultipleEd25519 - Given a seed, path, destination addresses in ed25519 format and amounts, make multiple transfers.
  • sendAdvanced - Given a set of inputs with keypairs seed, path, list of destinations make multiple transfers, can also include index data.
  • sendData - Given index and data create a new data message.

Models

You can see the model definitions for all the objects in the typings folder.

Examples

Please find other examples in the ./examples folder.

  • Simple - Performs basic API operations.
  • Address - Demonstrates address generation from a Bip39 mnemonic seed using raw and Bip32 path methods.
  • Transaction - Demonstrates how to send a transaction and call some of the other higher level functions.
  • Data - Storing and retrieving data on the tangle.
  • Browser - Demonstrates direct inclusion and use of the library in an html page.
  • Peers - Demonstrates peer management.
  • Pow - Demonstrates using one of the other PoW packages.

Supporting the project

If the iota.js has been useful to you and you feel like contributing, consider submitting a bug report, feature request or a pull request.

See our contributing guidelines for more information.

Joining the discussion

If you want to get involved in the community, need help with getting set up, have any issues or just want to discuss IOTA, feel free to join our Discord.