Skip to content

Latest commit

 

History

History
20 lines (15 loc) · 858 Bytes

README.md

File metadata and controls

20 lines (15 loc) · 858 Bytes

vapory-rpc-json

JSON file of all vapory's rpc methods supported by tetcoin

interfaces

interfaces.md contains the auto-generated list of interfaces exposed, along with their relevant documentation

contributing

  1. Clone the repo
  2. Branch
  3. Add the missing interfaces only into lib/interfaces/*.js
  4. Parameters (array) & Returns take objects of type
    • { type: [Array|Boolean|Object|String|...], desc: 'some description' }
    • Types are built-in JS types or those defined in lib/types.js (e.g. BlockNumber, Quantity, etc.)
    • If a formatter is required, add it as format: 'string-type'
  5. Run the lint & tests, npm run lint && npm run testOnce
  6. Generate via npm run build which outputs index.js, index.json & interfaces.md (Only required until Travis is fully in-place)
  7. Check-in and make a PR