Package Exports

atomicmarket

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (atomicmarket) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

AtomicMarket JavaScript

JS Library to read data from the atomicmarket contract which is based on the atomicassets NFT standard.

Contract / General Documentation can be found on https://github.com/pinknetworkx/atomicmarket-contract/wiki

Usage

This is a Node.js module available through the npm registry. Installation is done using the npm install command:

$ npm install atomicmarket

Initialize

Web library can be found in the dist folder

// standard import
const {AtomicMarketApi} = require("atomicmarket");
// ES6 import
import {AtomicMarketApi} from "atomicmarket"

Documentation

There are two methods available to fetch data from the blockchain.

ExplorerAPI: uses an hosted API which proves simple and fast REST API endpoints
RpcAPI: uses only native nodeos calls

Explorer API

The explorer API uses eosio-contract-api to query data about the NFTs. A documentation of each endpoint and its responses can be found here. It is recommended to self-host the API for the best performance.

Example

// init Explorer Api
// endpoint: server where atomicmarket api is deployed
// namespace: used namespace for the API
// options:
// - fetch: either node-fetch module or the browser equivalent
const api = new AtomicMarketApi("https://test.wax.api.atomicassets.io", "atomicmarket", {fetch});

const sale = await api.getSale("100");