hub / github.com/EOSIO/eosjs-api

github.com/EOSIO/eosjs-api @v7.0.4

repository ↗ · DeepWiki ↗ · release v7.0.4 ↗ · + Follow

17 symbols 37 edges 10 files 2 documented · 12% ● updated 2y agov7.0.4 · 2018-09-11★ 1775 open issues

What it actually does AI analysis from the code graph — generated when you open this

loading…

README

Eos API

Application programming interface to EOS blockchain nodes. This is for read-only API calls. If you need to sign transactions use eosjs instead.

Include

Install with: npm install eosjs-api
Html script tag, see releases for the correct version and its matching script integrity hash.

<html>
<head>
  <meta charset="utf-8">

  <script src="https://cdn.jsdelivr.net/npm/eosjs-api@7.0.4/lib/eos-api.min.js"
    integrity="sha512-LLDsX/GdVZYA82k9TVz3zUxSjvaX8s5b1FJm64W51JGxLFKI2z+ljqYQtsUZIOxh9pSUqvLA5HCoxXqdRxusKw=="
    crossorigin="anonymous"></script>

</head>
<body>
  See console object: EosApi
</body>
</html>

EosApi

Run nodeos

Usage

EosApi = require('eosjs-api') // Or EosApi = require('./src')

eos = EosApi() // // 127.0.0.1:8888

// Any API call without a callback parameter will print documentation: description,
// parameters, return value, and possible errors.  All methods and documentation
// are created from JSON files in eosjs/json/api/v1..
eos.getInfo()

// A Promise is returned if a callback is not provided.
eos.getInfo({}).then(result => console.log(result))
eos.getBlock(1).then(result => console.log(result))

// For callbacks instead of Promises provide a callback
callback = (err, res) => {err ? console.error(err) : console.log(res)}

// The server does not expect any parameters only the callback is needed
eos.getInfo(callback)

// Parameters are added before the callback
eos.getBlock(1, callback)

// Parameters can be an object
eos.getBlock({block_num_or_id: 1}, callback)
eos.getBlock({block_num_or_id: 1}).then(result => console.log(result))

Configuration

EosApi = require('eosjs-api') // Or EosApi = require('./src')

// everything is optional
options = {
  httpEndpoint: 'http://127.0.0.1:8888', // default, null for cold-storage
  verbose: false, // API logging
  logger: { // Default logging functions
    log: config.verbose ? console.log : null,
    error: config.verbose ? console.error : null
  },
  fetchConfiguration: {}
}

eos = EosApi(options)

options.logger example

During testing, an error may be expected and checked as follows:

options.logger = {
  error: err => {
    assert.equal(err, 'expected error')
    done()
  }
}

options.fetchConfiguration example

options.fetchConfiguration = {
  credentials: 'same-origin'
}

Every eosjs-api request will run fetch with this configuration:

fetch('https://example.com', {
  credentials: 'same-origin'
})

Environment

Node and browser (es2015)

Core symbols most depended-on inside this repo

src/exported-helpers.js

applyDefaults

called by 2

src/apigen.js

Shape

Function 17

Languages

TypeScript100%

Modules by API surface

src/apigen.js6 symbols

bin/api-docs.js4 symbols

src/process-args.test.js3 symbols

src/exported-helpers.js2 symbols

src/process-args.js1 symbols

src/index.js1 symbols

For agents

$ claude mcp add eosjs-api \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact