Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rchain-community/rchain-api
An API for rchain dapps to communicate with the blockchain
https://github.com/rchain-community/rchain-api
blockchain capabilities dapp decentralization javascript
Last synced: 24 days ago
JSON representation
An API for rchain dapps to communicate with the blockchain
- Host: GitHub
- URL: https://github.com/rchain-community/rchain-api
- Owner: rchain-community
- License: other
- Created: 2018-07-25T18:15:10.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-03-07T18:09:53.000Z (11 months ago)
- Last Synced: 2024-04-13T15:56:47.156Z (9 months ago)
- Topics: blockchain, capabilities, dapp, decentralization, javascript
- Language: JavaScript
- Homepage:
- Size: 3.1 MB
- Stars: 22
- Watchers: 13
- Forks: 12
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# RChain-API
An API for dApp frontends to communicate with the RChain blockchain.
The [RChain Cooperative][1] is developing a decentralized, economically sustainable public compute infrastructure. Decentralized applications or "dApps" will run their business logic as smart contracts on the blockchain. Their user interfaces will be more traditional programs that interact with the blockchain as a backend. This separation allows dApp developers to create nice abstract interfaces, and allows end users to create their own sovereign interfaces should they choose to do so.
[1]: https://www.rchain.coop/
## Quickstart
Install with `npm install rchain-community/rchain-api`. Then,
to get current block info from testnet:
```js
import { RNode } = from 'rchain-api';
const obs = RNode(fetch)
.observer('https://observer.testnet.rchain.coop');
(async () => {
const blocks = await rnode.getBlocks(1);
assert.ok(blocks[0].blockHash);
})();
```
If your node is a validator and you have a key to authorize payment, you can deploy code:
```js
const { RNode, signDeploy } = require('rchain-api');
const val = RNode(fetch)
.validator('https://node1.testnet.rchain-dev.tk');
const term = '@"world"!("Hello!")';
const myKey = '11'.repeat(32);
const timestamp = new Date('2019-04-12T17:59:29.274Z').valueOf();
const [recent] = await observer.getBlocks(1);
const info = signDeploy(myKey, { timestamp, term, phloLimit: 10000, phloPrice: 1, validAfterBlockNumber: recent.blockNumber });
rnode.deploy(info).then((message) => { assert(message.startsWith('Success')); });
```
## API (OUT OF DATE)
[./docs/](./docs/index.md)
## Getting access to an RChain node
Choices include:
- [RChain testnet][testnet] nodes such as `node4.testnet.rchain-dev.tk`
- a community node at `rnode-test.rhobot.net`
- [running your own RNode][2]
[testnet]: https://rchain.atlassian.net/wiki/spaces/CORE/pages/678756429/RChain+public+testnet+information
[2]: https://rchain.atlassian.net/wiki/spaces/CORE/pages/428376065/User+guide+for+running+RNode
## Examples and Related Projects
* [Nth Caller](https://github.com/JoshOrndorff/nth-caller-game) a minimal RChain-based dApp game that uses RChain-API
* [Status](https://github.com/JoshOrndorff/RChain-Status) a moderately complex dapp that uses more RChain-API features as well as [RSign](https://github.com/dckc/RSign)
* [Coin Faucet](https://github.com/BlockSpaces/coin-faucet/) An advanced robust dApp that use raspberry PI to airdrop tokens to devices in physical proximity
* [RChain-dbr](https://github.com/dckc/rchain-dbr) A web-of-trust based distributed budgeting and rewards dApp
* [RSign](https://github.com/dckc/RSign) A chrome extension for generating client-side signatures akin to metamask
* [node-client](https://github.com/rchain/rchain/tree/dev/node-client) A similar but less mature RChain API written in python
## License
Copyright 2018-2019 RChain Cooperative
Apache 2.0 License (See LICENSE.txt)
Contributions welcome (See CONTRIBUTING.md)