Git Product home page Git Product logo

vapjs-query's Introduction

vapjs-query


A simple module for querying the Vapory RPC layer.

Install

npm install --save vapjs-query

Usage

const BN = require('bn.js');
const HttpProvider = require('vapjs-provider-http');
const Vap = require('vapjs-query');
const vap = new Vap(new HttpProvider('http://localhost:8545'));

vap.getBalance('0x407d73d8a49eeb85d32cf465507dd71d507100c1', cb);

// result null <BN ...>

vap.sendTransaction({
  from: '0x407d73d8a49eeb85d32cf465507dd71d507100c1',
  to: '0x987d73d8a49eeb85d32cf462207dd71d50710033',
  value: new BN('6500000'),
  gas: 3000000,
  data: '0x',
}).then(cb).catch(cb);

// result null 0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470

About

A simple Vapory RPC module for querying data from an Vapory node such as a gvap (go-vapory), parity (rust-vapory) or TestRPC (local js-vapory).

This module supports all Vapory RPC methods and is designed completely to specification.

Amorphic Data Formatting

vapjs-query uses the vapjs-format module to format incoming and outgoing RPC data payloads. The primary formatting task is numbers. Number values can be inputed as: BigNumber, BN, string, hex or actual numbers. Because the blockchain does not support decimal or negative numbers, any kind of decimal or negative number will cause an error return. All received number values are returned as BN.js object instances.

Read more about the formatting layer here: vapjs-format

Async Only

All methods are async only, requiring either a callback or promise.

Error handling

Error handling is done through function callbacks or promised catches.

Debugging Options

vapjs-query comes equip with a full debug options for all data inputs and outputs.

const HttpProvider = require('vapjs-provider-http');
const Vap = require('vapjs-query');
const vap = new Vap(new HttpProvider('http://localhost:8545'), { 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

vapjs-query supports all Vapory specified RPC methods.

const HttpProvider = require('vapjs-provider-http');
const Vap = require('vapjs-query');
const vap = new Vap(new HttpProvider('http://localhost:8545'));

vap.protocolVersion(cb);

// ....

Contributing

Please help better the ecosystem by submitting issues and pull requests to vapjs-query. 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.

Guides

You'll find more detailed information on using vapjs-query and tailoring it to your needs in our guides:

  • User guide - Usage, configuration, FAQ and complementary tools.
  • Developer guide - Contributing to vapjs-query and writing your own code and coverage.

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.

vapjs-query's People

Contributors

kumavis avatar marlonhanks avatar silentcicero avatar

Watchers

 avatar  avatar

vapjs-query's Issues

0.0.5 tests

vapjs-query

Before opening a new issue, please take a moment to review our community guidelines to make the contribution process easy and effective for everyone involved.

Before opening a new issue, you may find an answer in already closed issues:
https://github.com/vapjs/vapjs-query/issues?q=is%3Aissue+is%3Aclosed

Issue Type

Description

Some tests on 0.0.5 are failing are disabled to allow builds. Revisiting recommended:

  1. 'should function while vap_compileSolidity' yields:
AssertionError: expected [Error: [vapjs-query] while formatting outputs from RPC '{"code":"6060604052600c8060106000396000f360606040523615600a575b00","info":{"source":"pragma solidity ^0.4.0;\n\n      /// @title Voting with delegation.\n      contract Ballot {\n        function () payable {\n        }\n\n        uint cool;\n      }\n      ","language":"Solidity","languageVersion":"0","compilerVersion":"0.4.2+commit.af6afb04.mod.Emscripten.clang","abiDefinition":[{"payable":true,"type":"fallback"}],"userDoc":{"methods":{}},"developerDoc":{"methods":{}}}}' for method 'compileSolidity' TypeError [ERR_INVALID_ARG_TYPE]: The "string" argument must be one of type string, Buffer, or ArrayBuffer. Received type object] to equal null
  1. 'should function while vap_getTransactionByBlockHashAndIndex' yields:
AssertionError: expected [Error: [vapjs-query] while formatting outputs from RPC '{"transactionHash":"0x68f1a32a268410d29ce44db27f98b5a5766ad55cc579a974fcd393184ab7b273","transactionIndex":"0x00","blockHash":"0xdc184b7c33365c8dbadb8a42aa988502e58c8d0c3469a01cb0691285eb49410c","blockNumber":"0x01","gasUsed":"0x5208","cumulativeGasUsed":"0x5208","contractAddress":null,"logs":[]}' for method 'getTransactionReceipt' TypeError [ERR_INVALID_ARG_TYPE]: The "string" argument must be one of type string, Buffer, or ArrayBuffer. Received type object] to equal null
  1. 'should function while vap_getTransactionByBlockNumberAndIndex' yields:
AssertionError: expected [Error: [vapjs-query] while formatting outputs from RPC '{"transactionHash":"0x247c32ad1822c28f076b1ecb89114844ed69e077134fa532470f5353ee96bce7","transactionIndex":"0x00","blockHash":"0xb644e0747bc394a6a66d97170618c0cf697527eb2c33be1125dbab891272ced6","blockNumber":"0x01","gasUsed":"0x5208","cumulativeGasUsed":"0x5208","contractAddress":null,"logs":[]}' for method 'getTransactionReceipt' TypeError [ERR_INVALID_ARG_TYPE]: The "string" argument must be one of type string, Buffer, or ArrayBuffer. Received type object] to equal null
  1. 'should function while vap_getTransactionReceipt' yields:
AssertionError: expected [Error: [vapjs-query] while formatting outputs from RPC '{"transactionHash":"0x27979a27644008a25025c66ba56983fbc7ba0e2a3428a0f2b1c5ab6c81459ef8","transactionIndex":"0x00","blockHash":"0x2657d78aa41440135c7a8e05fa14a5b81e1053218b37d0b76255ff5c301e427a","blockNumber":"0x03","gasUsed":"0x5208","cumulativeGasUsed":"0x5208","contractAddress":null,"logs":[]}' for method 'getTransactionReceipt' TypeError [ERR_INVALID_ARG_TYPE]: The "string" argument must be one of type string, Buffer, or ArrayBuffer. Received type object] to equal null

Steps to reproduce

(Add link to a demo on https://jsfiddle.net or similar if possible)

Versions

  • Node/NPM:
  • Browser:

Many tests on 0.1.3 are failing

vapjs-query

Before opening a new issue, please take a moment to review our community guidelines to make the contribution process easy and effective for everyone involved.

Before opening a new issue, you may find an answer in already closed issues:
https://github.com/vapjs/vapjs-query/issues?q=is%3Aissue+is%3Aclosed

Issue Type

Description

(Add images if possible)

Steps to reproduce

(Add link to a demo on https://jsfiddle.net or similar if possible)

Versions

  • Node/NPM: LTS/Dubnium
  • Browser:

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.