Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/owenvoke/arionum-js
An API wrapper for the Arionum cryptocurrency node.
https://github.com/owenvoke/arionum-js
api api-client arionum js npm
Last synced: about 1 month ago
JSON representation
An API wrapper for the Arionum cryptocurrency node.
- Host: GitHub
- URL: https://github.com/owenvoke/arionum-js
- Owner: owenvoke
- License: mit
- Created: 2018-09-27T08:43:46.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-05-31T07:12:27.000Z (7 months ago)
- Last Synced: 2024-11-03T17:08:52.537Z (2 months ago)
- Topics: api, api-client, arionum, js, npm
- Language: TypeScript
- Homepage: https://npmjs.com/package/arionum-js
- Size: 178 KB
- Stars: 0
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Arionum JS
[![Latest Version on npm][ico-version]][link-npm]
[![Software License][ico-license]](LICENSE.md)
[![Build Status][ico-github-actions]][link-github-actions]
[![Total Downloads][ico-downloads]][link-downloads]
[![Buy us a tree][ico-treeware-gifting]][link-treeware-gifting]
An API wrapper for the Arionum cryptocurrency node.
## Install
Via npm
```shell
npm install arionum-js
```
## Usage
Initialise the Arionum node configuration object:
```typescript
import { buildNodeConfiguration } from "arionum-js";
const url = 'http://peer1.arionum.com'
const nodeConfiguration = buildNodeConfiguration({ url })
```
Then pass this to any of the SDK functions:
```typescript
import { getBlock } from "arionum-js";
// This returns basic metadata about the specified block.
const block = getBlock(nodeConfiguration, { height: 12345 });
```
## Change log
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
## Credits
- [Owen Voke][link-author]
- [All Contributors][link-contributors]
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
## Treeware
You're free to use this package, but if it makes it to your production environment you are required to buy the world a tree.
It’s now common knowledge that one of the best tools to tackle the climate crisis and keep our temperatures from rising above 1.5C is to plant trees. If you support this package and contribute to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.
You can buy trees [here][link-treeware-gifting].
Read more about Treeware at [treeware.earth][link-treeware].
[ico-version]: https://img.shields.io/npm/v/arionum-js.svg?style=flat-square
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
[ico-github-actions]: https://img.shields.io/github/actions/workflow/status/owenvoke/arionum-js/tests.yml?branch=main&style=flat-square
[ico-downloads]: https://img.shields.io/npm/dt/arionum-js.svg?style=flat-square
[ico-treeware-gifting]: https://img.shields.io/badge/Treeware-%F0%9F%8C%B3-lightgreen?style=flat-square
[link-npm]: https://www.npmjs.com/package/arionum-js
[link-github-actions]: https://github.com/owenvoke/arionum-js/actions
[link-downloads]: https://www.npmjs.com/package/arionum-js
[link-treeware]: https://treeware.earth
[link-treeware-gifting]: https://ecologi.com/owenvoke?gift-trees
[link-author]: https://github.com/owenvoke
[link-contributors]: ../../contributors