Permalink
Browse files

Minor ByzCoin documentation fixes.

  • Loading branch information...
jeffallen committed Sep 14, 2018
1 parent b82a462 commit b2430e3cba3d8406cef4bd947b36f49ad931829c
View
@@ -53,7 +53,7 @@ to initialise it, the first for when you do not have an existing eventlog
instance on ByzCoin to connect to, the other when you do.
```java
// Create the eventlog instance. It expects an ByzCoin RPC, a list of
// Create the eventlog instance. It expects a ByzCoin RPC, a list of
// signers that have the "spawn:eventlog" permission and the darcID for where
// the permission is stored.
EventLogInstance el = new EventLogInstance(bcRPC, admins, darcID);
View
@@ -16,11 +16,11 @@ private key the right to make new event logs.
$ PRIVATE_KEY=$priv el create -ol $file
```
The ByzCoin admin will give you an ByzCoin config file, which you will
use with the -bc argument, or you can set the BC environment
variable to the name of the ByzCoin config file. A new event log will be spawned,
and the event log ID will be printed. Set the EL environment variable to
communicate it to future calls to the `el` program.
The ByzCoin admin will give you a ByzCoin config file, which you will
use with the -bc argument, or you can set the BC environment variable to the
name of the ByzCoin config file. A new event log will be spawned, and the
event log ID will be printed. Set the EL environment variable to communicate
it to future calls to the `el` program.
You need to give the private key from above, using the PRIVATE_KEY environment
variable or the `-priv` argument.
@@ -74,7 +74,7 @@ public ByzCoinRPC(Roster r, Darc d, Duration blockInterval) throws CothorityExce
}
/**
* Constructs an ByzCoinRPC from a known configuration. The constructor will communicate with the service to
* Constructs a ByzCoinRPC from a known configuration. The constructor will communicate with the service to
* populate other fields and perform verification.
*
* @param roster the roster to talk to
@@ -101,16 +101,6 @@ public ByzCoinRPC(Roster roster, SkipblockId skipchainId) throws CothorityExcept
latest = skipchain.getLatestSkipblock();
}
/**
* Instantiates an byzcoin object given the byte representation. The byzcoin must already have been
* initialized on the cothority.
*
* @param buf is the representation of the basic byzcoin parameters, it should have a Roster and a skipchain ID.
*/
public ByzCoinRPC(byte[] buf) {
throw new RuntimeException("Not implemented yet");
}
/**
* Sends a transaction to byzcoin, but doesn't wait for the inclusion of this transaction in a block.
* Once the transaction has been sent, you need to poll to verify if it has been included or not.
@@ -258,7 +248,7 @@ public Block getBlock(SkipblockId id) throws CothorityCommunicationException, Co
/**
* Fetches the latest block from the Skipchain and returns the corresponding Block.
*
* @return an Block representation of the skipblock
* @return a Block representation of the skipblock
* @throws CothorityCommunicationException if it couldn't contact the nodes
* @throws CothorityCryptoException if the omniblock is invalid
*/
@@ -10,8 +10,8 @@
import static java.time.temporal.ChronoUnit.NANOS;
/**
* Config is the genesis configuration of an byzcoin instance. It can be stored only once in byzcoin
* and defines the basic running parameters of byzcoin.
* Config is the genesis configuration of a ByzCoin instance. It can be stored only once in ByzCoin
* and defines the basic running parameters of the ledger and its underlying skipchain.
*/
public class Config {
private Duration blockInterval;
@@ -35,7 +35,7 @@
* the current darcInstance. If the instance is not found, or is not of
* contractId "darc", an exception will be thrown.
*
* @param bc is a link to an byzcoin instance that is running
* @param bc is a ByzCoin instance that is running
* @param id of the darc-instance to connect to
* @throws CothorityException
*/
@@ -31,7 +31,7 @@
* the current valueInstance. If the instance is not found, or is not of
* contractId "Value", an exception will be thrown.
*
* @param bc is a link to an byzcoin instance that is running
* @param bc is a ByzCoin instance that is running
* @param id of the value-instance to connect to
* @throws CothorityException
*/
@@ -12,7 +12,7 @@ const protobuf = require("protobufjs");
*/
class ByzCoinRPC {
/**
* Constructs an ByzCoinRPC when the complete configuration is known
* Constructs a ByzCoinRPC when the complete configuration is known
*
* @param {Config} config - the configuration of the ByzCoin
* @param {Socket|LeaderSocket|RosterSocket} socket - the socket to communicate with the ByzCoin ledger
@@ -167,7 +167,7 @@ class ByzCoinRPC {
}
/**
* Constructs an ByzGenRPC from a known configuration. The constructor will communicate with the service to
* Constructs a ByzGenRPC from a known configuration. The constructor will communicate with the service to
* populate other fields and perform verification.
*
* @param {Socket|LeaderSocket|RosterSocket} socket - the socket to communicate with the conode
@@ -2,8 +2,8 @@ const root = require("../protobuf/index.js").root;
const identity = require("../identity");
/**
* Config is the genesis configuration of an byzcoin instance. It can be stored only once in byzcoin
* and defines the basic running parameters of byzcoin.
* Config is the genesis configuration of a ByzCoin instance. It can be stored only once in ByzCoin
* and defines the basic running parameters of ByzCoin.
*/
class Config {
/**

0 comments on commit b2430e3

Please sign in to comment.