Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up randhound, timestamper. Also ByzCoin doc fixes #1480

Merged
merged 3 commits into from Sep 19, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion byzcoin/README.md
Expand Up @@ -6,7 +6,7 @@ ByzCoin
# ByzCoin

This implementation of ByzCoin has its goal to implement the protocol
described in the [ByzCoin Paper](https://eprint.iacr.org/2017/406.pdf).
described in the [OmniLedger Paper](https://eprint.iacr.org/2017/406.pdf).
As the paper is only describing the network interaction and very few of the
details of how the transactions themselves are handled, we will include
them as seem fit.
Expand Down
2 changes: 1 addition & 1 deletion eventlog/README.md
Expand Up @@ -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);
Expand Down
10 changes: 5 additions & 5 deletions eventlog/el/README.md
Expand Up @@ -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.
Expand Down
Expand Up @@ -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
Expand All @@ -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.
Expand Down Expand Up @@ -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
*/
Expand Down
Expand Up @@ -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;
Expand Down
Expand Up @@ -35,7 +35,7 @@ public class DarcInstance {
* 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
*/
Expand Down
Expand Up @@ -31,7 +31,7 @@ public class ValueInstance {
* 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
*/
Expand Down
4 changes: 2 additions & 2 deletions external/js/cothority/lib/byzcoin/ByzCoinRPC.js
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions external/js/cothority/lib/byzcoin/Config.js
Expand Up @@ -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 {
/**
Expand Down
42 changes: 0 additions & 42 deletions randhound/README.md

This file was deleted.