@wharfkit/apiclient-telos
v4.0.6
Published
Wharf API plugin for calls to the Telos blockchain
Downloads
3
Readme
@wharfkit/apiclient-telos
Wharf API plugin for Telos specific calls to @antelopeio/leap (version 4.0.4).
Available on npm: https://www.npmjs.com/package/@wharfkit/apiclient-telos
Install
npm install @wharfkit/apiclient-telos
Reporting Issues
If you think you've found an issue with this codebase, please submit a pull request with a failing unit test to better help us reproduce and understand the issue you are experiencing.
To do this, fork this repository and create your own branch. In this new branch, use the test scaffolding at the path below to write code that either fails to execute, throws an error, or doesn't return the anticipated response.
./test/bug-report.ts
This specific test can be run within the root project folder either using make
:
grep="bug-report" make test
Or running mocha
directly from the installed ./node_modules
folder:
TS_NODE_PROJECT='./test/tsconfig.json' ./node_modules/.bin/mocha -u tdd -r ts-node/register -r tsconfig-paths/register --extension ts test/*.ts --grep="bug-report"
Once your test is failing and successfully shows the issue occurring, please submit a pull request to this repository. Feel free to include any additional details in the body of the pull request that might help us understand the situation.
NOTE: If you are performing API requests from within unit tests, you will need to prepend
MOCK=true
to the above commands in order instruct the test running to execute and cache the API request. Any subsequent API requests will utilize this cache to prevent the test from continously accessing API endpoints. Prefixing your command withMOCK=overwrite
is also possible which forces the test to ignore the cache and fetch new data.
Running Tests
Run the unit test suite:
make test
Run the unit test suite with coverage:
make coverage
Run the test suite in a browser:
make browser-test
The browser test suite for the current version of the library is available at: https://wharfkit.github.io/antelope/tests.html
Made with ☕️ & ❤️ by Greymass, if you find this useful please consider supporting us.