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.
<!-- sha512-n3CgU6w9TJVf/pVIMHYhk3Gxv8lEQYjVrSSTLXvEBENLF+CQd1Kp0jxXj09yGUOkWerdv2mJlh1Mnz3aRfYqWw== lib/eos-api.js sha512-Cj2FQb94MMtDPgHb1R1577pEMjYhc+P5pNgv1/QwoJD9ntuR9rnWlqJACS/xNniNK5cFS6Y6CpQlHWpzWUeEbw== lib/eos-api.min.js sha512-4C6oDKarS8DaXO99o342USbeQwqW98qik+QSzVGfof939gUpIyRDCnbGIGQAIkLNpYZIV4XanmRy3wcis6UW8w== lib/eos-api.min.js.map --> See console object: EosApi
EosApi
Run nodeos
Usage
EosApi = // Or EosApi = require('./src') eos = // // 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 // A Promise is returned if a callback is not provided.eoseos // For callbacks instead of Promises provide a callback {err ? console : console} // The server does not expect any parameters only the callback is neededeos // Parameters are added before the callbackeos // Parameters can be an objecteoseos
Configuration
EosApi = // Or EosApi = require('./src') // everything is optionaloptions = httpEndpoint: 'http://127.0.0.1:8888' // default, null for cold-storage verbose: false // API logging logger: // Default logging functions log: configverbose ? consolelog : null error: configverbose ? consoleerror : null fetchConfiguration: {} eos =
options.logger example
During testing, an error may be expected and checked as follows:
optionslogger = { assert }
options.fetchConfiguration example
optionsfetchConfiguration = credentials: 'same-origin'
Every eosjs-api request will run fetch with this configuration:
Environment
Node and browser (es2015)