API reorg: RholangCrypto, REV, ...

.flowconfig

@@ -3,7 +3,6 @@
 [include]
 
 [libs]
-interfaces/
 protobuf/interfaces/
 
 [lints]

.markdown-doctest-setup.js

@@ -0,0 +1,28 @@
+/* global module, require, Buffer */
+
+const assert = require('assert');
+
+const rchain = require('.');
+const { grpcMock } = require('./test/testRNode');
+const { RHOCore, RhoTypes, RNode, RholangCrypto, REV, Hex, Ed25519keyPair } = rchain;
+
+
+function config(env, grpcAccess) {
+  const grpc = env.NODE_ENV === 'production' ? grpcAccess() : grpcMock();
+  console.log('doctest env:', env.NODE_ENV || 'dev');
+
+  return {
+    babel: false,
+    require: {
+      url: require('url'),
+      grpc: grpc,
+      'rchain-api': { RHOCore, RhoTypes, RNode, RholangCrypto, REV, Hex, Ed25519keyPair },
+    },
+    globals: {
+      assert, Buffer,
+    },
+  };
+}
+
+/* global process */
+module.exports = config(process.env, () => require('grpc'));

.travis.yml

@@ -6,6 +6,4 @@ cache:
     - "node_modules"
     - "rclient/node_modules"
 script:
-  - npm test
-  - npm run flow-check
-  - npm run lint
+  - npm run check

CONTRIBUTING.md

@@ -1,15 +1,12 @@
 # Code Conventions and Design Notes
 
-All contributions should pass these checks (as noted in
-`.travis.yml`):
+As noted in `.travis.yml`, all contributions must pass `npm run check`,
+which runs `test`, `lint`, etc. The `test` check is conventional unit tests.
 
-```yaml
-  - npm test
-  - npm run flow-check
-  - npm run lint
-```
+Contributions should also pass `npm run integrationTest`, which
+requires a running validator node (see below).
 
-The `test` check is conventional unit tests.
+To run both the offline and online tests, use `npm run testAll`.
 
 
 ## Static Typechecking: flow
@@ -19,18 +16,26 @@ flow-check` script does a complete check and `npm run flow-status`
 does an incremental check.
 
 
-## RChain Validator Node for Integration testing
+0## RChain Validator Node for Integration testing
 
 One way to provide a validator node for testing, provided you're OK
-with the security risks around `--net host`, is:
+with the security risks around `--net host`, is to first have
+the node start up and generate some random validator keys:
 
+```bash
+docker run --rm --net host -v$HOME/.rnode:/var/lib/rnode \
+    rchain/rnode run -s
+```
+
+Then grab one of the secret keys for use as a validator private key:
 
 ```bash
-$ docker run --rm -it --net host coop.rchain/rnode:0.7.1 run -s
+first_key=$(cat $(ls ~/.rnode/genesis/*.sk|head -1))
+
+docker run --rm --net host -v$HOME/.rnode:/var/lib/rnode \
+    rchain/rnode run -s --validator-private-key $first_key
 ```
 
-This presumes you've built `coop.rchain/rnode` per `DEVELOPER.md` in
-rchain/rchain.
 
 ## Code Style: airbnb
 
@@ -77,19 +82,9 @@ All of our protobuf encoding and decoding is done using [protobuf.js](https://gi
 
 ![protobuf.js diagram](https://camo.githubusercontent.com/f090df881cc6c82ecb7c5d09c9fad550fdfd153e/687474703a2f2f64636f64652e696f2f70726f746f6275662e6a732f746f6f6c7365742e737667)
 
-##  Struggles with extracting API doc
-
-We don't use classes (TODO: cite explanation as to why not)
-but neither of the relevant recipies seem to work:
-
-> Many libraries and frameworks have special 'class constructor
-> methods' that accept an object as an input and return a class with
-> that object's properties as prototype properties.
-
-https://github.com/documentationjs/documentation/blob/master/docs/RECIPES.md#class-factories-using-lends
-
 
-We'd like to use these scripts in our `package.json`:
+##  Extracting API doc
 
-    "doc": "node ./node_modules/.bin/documentation build --github rnodeAPI.js -f html -o docs",
-    "doc-watch": "node ./node_modules/.bin/documentation serve --watch --github rnodeAPI.js"
+We use [documentation.js](https://documentation.js.org/) to build API
+docs (docs/index.md) from sources. Use the `docs-watch`, `build:docs`,
+or `build:docs-html` npm scripts.

README.md

@@ -8,56 +8,59 @@ The [RChain Cooperative][1] is developing a decentralized, economically sustaina
 
 
 ## Quickstart
-### Find an RChain node whose grpc endpoint you can use.
-At the moment that likely means [running your own RNode](2). We're working on a community node at rnode-test.rhobot.net
 
-Make note of your RNode's hostname and gRPC port. If you're not sure, `localhost` and `40401` are good guesses.
+Install with `npm install rchain-community/rchain-api`. Then, with
+rnode on `localhost`, you can get current block info:
 
-[2]: https://rchain.atlassian.net/wiki/spaces/CORE/pages/428376065/User+guide+for+running+RNode
-
-### Grab RChain-API
-Clone this repository with eg `git clone https://github.com/JoshOrndorff/RChain-API`
 
-And install dependencies with `npm install`
+```js
+const grpc = require('grpc');
+const { RNode, Ed25519keyPair, Hex, REV } = require('rchain-api');
 
-### (Recommended) Run the integration test
+const rnode = RNode(grpc, { host: 'localhost', port: 40401 });
+rnode.showBlocks()
+  .then((blocks) => { assert.ok(blocks[0].blockHash); });
+```
 
-Run `rnodeAPI.js` with _host_ and _port_ arguments, as in: `node rnodeAPI.js rnode-test.rhobot.net 50000`.
+If your node is a validator and you have a key to authorize payment, you can deploy code:
 
-You should see something like:
+```js
+const grpc = require('grpc');
+const { RNode, Ed25519keyPair, Hex, REV } = require('rchain-api');
 
-```
-stuffToSign serialized {
-  "type": "Buffer",
-  "data": "0a300a110a0f2a031a01784a08000000000000000012112a051a036162634a0800000000000000002a0800000000000000004a080000000000000000"
-}
-...
-doDeploy result: { success: true, message: 'Success!' }
-@@createBlock():  {
-  "block": {
-    "blockHash": {
-      "type": "Buffer",
-      "data": "3c5d97e2627432026b6d4a17c8027afb95b72e8d08a936d785b58459eff5859e"
-```
+const rnode = RNode(grpc, { host: 'localhost', port: 40401 });
 
-### Deploy contract to RNode
-There are not yet nice truffle-style build tools, so you will probably deploy your code directly using the `rnode deploy` thin client or using RChain-API itself.
-
-```javascript
-const myNode = RNode('localhost', 40401);
-rchain.doDeploy({
-  term: '@"aliceUpdates"!("Having fun traveling!")',
-  timestamp: clock().valueOf(),
-  // from: '0x1',
-  // nonce: 0,
-})
+const term = '@"world"!("Hello!")';
+const myKey = Ed25519keyPair(Hex.decode('11'.repeat(32)));
+const timestamp = new Date('2019-04-12T17:59:29.274Z').valueOf();
+const info = REV.SignDeployment.sign(myKey, { timestamp, term, phloLimit: 10000, phloPrice: 1 });
+rnode.doDeploy(info, true).then((message) => { assert(message.startsWith('Success')); });
 ```
 
 ## API
 
 [./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
+
+
+### RChain gRPC protobuf compatibility
+
+[protobuf][proto]: v0.9.1 bf1b2c6 Mar 28, 2019
+
+[proto]: https://github.com/rchain/rchain/tree/bf1b2c6c6662515403c0a429e8c9fa25edd64638/models/src/main/protobuf
+
+
 ## 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)
@@ -66,12 +69,9 @@ rchain.doDeploy({
 * [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
 
-## RChain gRPC protobuf compatibility
-* Commit hash [51d9323](https://github.com/rchain/rchain/tree/dev/models/src/main/protobuf) Jan 3, 2019
-
 
 ## License
-Copyright 2018 RChain Cooperative
+Copyright 2018-2019 RChain Cooperative
 
 Apache 2.0 License (See LICENSE.txt)
 

docs/config.yml

@@ -0,0 +1,8 @@
+toc:
+  - RNode
+  - RHOCore
+  - REV
+  - RholangCrypto
+  - RegistryProxy
+  - Ed25519keyPair
+  - Hex