@stacks/blockchain-api-client

@stacks/blockchain-api-client

A JS Client for the Stacks Blockchain API

Features

This package provides the ability to:

• Execute REST API requests against the Stacks Blockchain API
• Subscribe to WebSockets for real-time Stacks updates (for addresses or transactions)
• Full type safety for WebSocket and API requests and responses

Installation

You can install this package using NPM:

npm install --save-dev @stacks/blockchain-api-client

Usage

Here is an example code that connects with the WebSocket server and subscribes to updates for a specific Stacks address:

import { connectWebSocketClient } from '@stacks/blockchain-api-client';

// for mainnet, replace with ws://stacks-node-api.testnet.stacks.co/
const client = await connectWebSocketClient('wss://stacks-node-api.mainnet.stacks.co/');

const sub = await client.subscribeAddressTransactions('ST3GQB6WGCWKDNFNPSQRV8DY93JN06XPZ2ZE9EVMA', event =>
  console.log(event);
  /*
    {
      address: 'ST3GQB6WGCWKDNFNPSQRV8DY93JN06XPZ2ZE9EVMA',
      tx_id: '0x8912000000000000000000000000000000000000000000000000000000000000',
      tx_status: 'success',
      tx_type: 'token_transfer',
    }
  */
);

await sub.unsubscribe();

Documentation

You can find full references here.

Known Issues

• The TypeScript definitions for several objects involving type unions, including transactions, are incorrectly specified as only object.

Changelog

0.56.0 (2021-04-29)

Bug Fixes

• added canonical and latest flags in query (ff01c6f)
• [Rosetta] Error 500 & fee operation (523c0af)
• add devenv:stop in bns test (3d8374b)
• add support for mainnet contract address (a9a8573)
• add tx_id and status to names and namespaces table (493c9d8)
• added latest in getName (fa0efc3)
• assign subdomain name field to name part in v1-import (#555) (f8fe7b6)
• bns v1-import test (6a91ad9)
• bug with EADDRINUSE server init errors not being handled correctly (da51f7b)
• chainprocessor logging messages are shorter (c993436)
• chainprocessor was not ending properly -- forgot to call the empty callback (fc6b75c)
• change tx_id from string to bytea in all bns tables (a05da3a)
• clean up console logs, do not hide subdomain insert query error (740f0cf)
• comma added in imports (e6198ee)
• datastore tests update (3ed9868)
• distinction between total locked and total unlocked token offering schedule amounts (44f7a06)
• do not re-import Stacks 1.0 BNS data (66a0371)
• empty status from imported bns names (44076b2)
• emtpy subdomains issue in event-server (b4f3c15)
• ensure that importV1 is called with a PgDataStore object (0f2952b)
• event count added in transaction (141c85c)
• fix package-lock.json error (fbf4a6d)
• fix tx_id conversion issue (db02047)
• fixed a chunk size comparison (== instead of >), trying 4000 subdomains at a time (4deb007)
• fixed a lint issue (974a608)
• fixed datastore error (ce3f071)
• fixed lint issue (12183db)
• fixed name not being updated issue, update names for name update (a0d7828)
• fixed name-register missing issue (ba38df2)
• fixed schema paths (open-api) (6d7d669)
• fixed subdomains zonefile (fca5c25)
• fixed type (8a4cf53)
• fixed zonefile type in name info response schema (7092ed6)
• handle invalid BTC addresses in import (0a92015)
• handle re-org for subdomains (054ff56)
• import path format safety (001301a)
• linting errors after an eslint dependency disregarded semver and implemented breaking changes (63bfca2)
• liquid STX discrepancy between sql db and /v2/pox #468 (106c595)
• namespaces, name insertions in db - updated tests (502c1ec)
• namespaces, names used from tx (DataStoreUpdateData) (977a9fb)
• parsing updated chainstate.txt format (200455a)
• redirect url in bns names api (#560) (d36dc62)
• remove /v2/pox override, no longer needed #474 (72fc7ef)
• remove empty line for lint (7b92455)
• remove extra space (75fd47d)
• removed logs added TODO for tests (88bc889)
• rename src/importV1 to src/import-v1 (bf3d4c1)
• rename the @blockstack/stacks-blockchain-api-types package to @stacks/stacks-blockchain-api-types (0393c12)
• revert package.json changes (5914abc)
• tests updated (a06b015)
• update zone-file lib to latest with typescript support (966d14b)
• updated schema file ref in open api (de796d1)
• use a single db client connection for the import (9ee4d16)
• use index_block_hash for unresolved subdomain attachment handling (7f88860)

Features

• [rosetta] stacking operation (1cb8e9c)
• add pricing names and namespaces (98989a5)
• address transactions with stx transfers endpoint (#547) (01bcbf7)
• API endpoint to get reward slot holder entries for a given address (5be97a2)
• bns: namespaces endpoints implementation (5d87dd3)
• db handling and API endpoint for burnchain reward slot holder event data (382036c)
• expose token sale locking/unlocking data (#553) (78d475f)
• get names by address and historical zonefile (bdde26c)
• implement graceful shutdown handler for the event http server (07048bd)
• implement offline mode (#545) (be2358b)
• include chainstate.txt and import token offering locked data by default (#556) (d0f966c)
• make the v2 proxy cache control file configurable via env var #519 (#559) (8929191)
• streams and async iterators for subdomain import reading (8b00a5e)
• test for fetch burnchain rewards for testnet STX address (0f7d02e)