adamant-api

ADAMANT JavaScript API library

ADAMANT JavaScript API is a library intended to interact with ADAMANT blockchain for JavaScript developers. Also ADAMANT Console and ADAMANT node Direct API are available.

Features:

• High reliability
• GET-requests to the blockchain
• Sending tokens
• Sending messages
• Creating a delegate
• Voting for delegates
• Caching public keys
• Encrypting and decrypting of messages
• Forming and signing transactions
• Working with ADM key pairs
• Generating crypto wallets (addresses and keys), bound to ADM account
• Working with ADAMANT epoch time
• Support for WebSocket connections
• Logging warnings, errors, info

Reliability

JS API shows decentralization in action—if a network node cannot fulfill your request, the library will redirect it to another node, and so on several times. You will get the result and you do not need to think about processing the request.

Health Check system pings all nodes in the list using /status endpoint, and connects to a node with actual height. When the library unable to process request with current node, it forces to re-initialize Health Check.

Usage

Install library from npm:

npm i adamant-api

Initialize the library:

const { AdamantApi } = require('adamant-api')

const nodes = [
  "http://localhost:36666",
  "https://endless.adamant.im",
  "https://clown.adamant.im",
  "http://23.226.231.225:36666",
  "http://88.198.156.44:36666",
  "https://lake.adamant.im"
];

const api = new AdamantApi({
  nodes,
});

Request example:

const response = await api.getBlocks()

console.log(response.data)

Documentation

See Wiki for documentation and usage.

Changelog

[2.1.0] - 2023-11-17

Added

• api.initSocket() now accepts an instance of WebSocketClient as an argument:

  const socket = new WebSocketClient({
    /* ... */
  });
  
  api.initSocket(socket);
  // instead of
  api.socket = socket;
  

• Improved the encodeMessage() and decodeMessage() functions to accept public keys as Uint8Array or Buffer

  import {encodeMessage, createKeypairFromPassphrase} from 'adamant-api'
  
  const {publicKey} = createKeypairFromPassphrase('...')
  const message = encodeMessage(,, publicKey) // No need to convert public key to string
  

• decodeMessage() allows passing a key pair instead of a passphrase:

  import {decodeMessage, createKeypairFromPassphrase} from 'adamant-api'
  
  const keyPair = createKeypairFromPassphrase('...')
  const message = decodeMessage(,, keyPair,) // <- It won't create a key pair from passphrase again
  

• TypeScript: Export transaction handlers TypeScript utils: SingleTransactionHandler, AnyTransactionHandler, TransactionHandler<T extends AnyTransaction>

Fixed

• TypeScript: Fixed typing for AdamantApiOptions by adding LogLevelName as possible value for logLevel property.

  For example, you can now use 'log' instead of LogLevel.Log in TypeScript:

  const api = new AdamantApi({/* ... */ logLevel: 'log'});
  

• TypeScript: Added missing declaration modules to npm that led to the error:

  Could not find a declaration file for module 'coininfo'.
  /// <reference path="../../types/coininfo.d.ts" />
  

• TypeScript: amount property in ChatTransactionData (createChatTransaction() argument) is now truly optional:

  -  amount: number | undefined;
  +  amount?: number;