eosjs-api
Version:
Application programming interface to EOS blockchain nodes.
119 lines (90 loc) • 3.25 kB
Markdown
[](https://www.npmjs.org/package/eosjs-api)
# Eos API
Application programming interface to EOS blockchain nodes. This is for
read-only API calls. If you need to sign transactions use
[eosjs](https://github.com/eosio/eosjs) instead.
# Include
* Install with: `npm install eosjs-api`
* Html script tag, see [releases](https://github.com/EOSIO/eosjs-api/releases) for the correct **version** and its matching script **integrity** hash.
```html
<html>
<head>
<meta charset="utf-8">
<!--
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
-->
<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](https://github.com/eosio/eos)
* [API](./docs/api.md)
* [Helper Functions](./docs/index.md)
## Usage
```javascript
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
```js
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:
```js
options.logger = {
error: err => {
assert.equal(err, 'expected error')
done()
}
}
```
### options.fetchConfiguration example
```js
options.fetchConfiguration = {
credentials: 'same-origin'
}
```
Every eosjs-api request will run [fetch](https://github.com/github/fetch#sending-cookies) with this configuration:
```js
fetch('https://example.com', {
credentials: 'same-origin'
})
```
## Environment
Node and browser (es2015)