vapjs-query
v0.0.5
Published
A simple query layer for the Vapory RPC.
Downloads
11
Readme
vapjs-query
A simple wrapper around the vap-query
module with formatting for numbers, hex value and data structures.
Install
npm install --save vapjs-query
Usage
const Vap = require('vapjs-query');
const vap = new Vap(providerObject);
vap.getBalance('0x407d73d8a49eeb85d32cf465507dd71d507100c1', cb);
// result null <BigNumber ...>
vap.sendTransaction({
from: '0x407d73d8a49eeb85d32cf465507dd71d507100c1',
to: '0x987d73d8a49eeb85d32cf462207dd71d50710033',
gas: 300000,
data: '0x',
}).then(cb).catch(cb);
// result null 0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470
About
A simple wrapper around the vap-query
module using the vapjs-format
as a formatting layer.
Debugging Options
vapjs-query
comes equip with a full debug options for all data inputs and outputs.
const Vap = require('vapjs-query');
const vap = new Vap(providerObject, { debug: true, logger: console, jsonSpace: 0 });
vap.accounts(cb);
/* result
[vapjs-query 2016-11-27T19:37:54.917Z] attempting method accounts with params [null]
[vapjs-query 2016-11-27T19:37:54.917Z] [method 'accounts'] callback provided: true
[vapjs-query 2016-11-27T19:37:54.917Z] [method 'accounts'] attempting input formatting of 0 inputs
[vapjs-query 2016-11-27T19:37:54.917Z] [method 'accounts'] formatted inputs: []
[vapjs-query 2016-11-27T19:37:54.917Z] [method 'accounts'] attempting query with formatted inputs...
[vapjs-query 2016-11-27T19:37:54.919Z] [method 'accounts'] callback success, attempting formatting of raw outputs: ["0xb88643569c19d05dc67b960f91d9d696eebf808e","0xf...]
[vapjs-query 2016-11-27T19:37:54.919Z] [method 'accounts'] formatted outputs: ["0xb88643569c19d05dc67b960f91d9d696eebf808e","0xf...]
*/
Supported Methods
getBalance
getCode
getTransactionCount
getStorageAt
call
protocolVersion
syncing
coinbase
mining
hashrate
gasPrice
accounts
blockNumber
getBlockTransactionCountByHash
getBlockTransactionCountByNumber
getUncleCountByBlockHash
getUncleCountByBlockNumber
sign
sendTransaction
sendRawTransaction
estimateGas
getBlockByHash
getBlockByNumber
getTransactionByHash
getTransactionByBlockHashAndIndex
getTransactionByBlockNumberAndIndex
getTransactionReceipt
getUncleByBlockHashAndIndex
getUncleByBlockNumberAndIndex
getCompilers
compileLLL
compileSolidity
compileSerpent
newFilter
newBlockFilter
newPendingTransactionFilter
uninstallFilter
getFilterChanges
getFilterLogs
getLogs
getWork
submitWork
submitHashrate
Contributing
Please help better the ecosystem by submitting issues and pull requests to default. We need all the help we can get to build the absolute best linting standards and utilities. We follow the AirBNB linting standard and the unix philosophy.
Help out
There is always a lot of work to do, and will have many rules to maintain. So please help out in any way that you can:
- Create, enhance, and debug vapjs rules (see our guide to "Working on rules").
- Improve documentation.
- Chime in on any open issue or pull request.
- Open new issues about your ideas for making
vapjs-query
better, and pull requests to show us how your idea works. - Add new tests to absolutely anything.
- Create or contribute to ecosystem tools, like modules for encoding or contracts.
- Spread the word.
Please consult our Code of Conduct docs before helping out.
We communicate via issues and pull requests.
Important documents
Licence
This project is licensed under the MIT license, Copyright (c) 2016 Nick Dodson. For more information see LICENSE.md.
The MIT License
Copyright (c) 2016 Nick Dodson. nickdodson.com
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.