Merge pull request #9 from getamis/release-v1.0.1

Release v1.0.1

client/client.go

@@ -27,11 +27,13 @@ import (
 	ethrpc "github.com/ethereum/go-ethereum/rpc"
 )
 
+// client defines typed wrappers for the Ethereum RPC API.
 type client struct {
 	*ethclient.Client
 	rpc *ethrpc.Client
 }
 
+// Dial connects a client to the given URL.
 func Dial(rawurl string) (Client, error) {
 	c, err := ethrpc.Dial(rawurl)
 	if err != nil {
@@ -40,13 +42,15 @@ func Dial(rawurl string) (Client, error) {
 	return NewClient(c), nil
 }
 
+// NewClient creates a client that uses the given RPC client.
 func NewClient(rpc *ethrpc.Client) Client {
 	return &client{
 		Client: ethclient.NewClient(rpc),
 		rpc:    rpc,
 	}
 }
 
+// Close closes an existing RPC connection.
 func (c *client) Close() {
 	c.rpc.Close()
 }
@@ -62,6 +66,7 @@ func (c *client) SendRawTransaction(ctx context.Context, tx *types.Transaction)
 	return c.SendTransaction(ctx, tx)
 }
 
+// BlockNumber returns the current block number.
 func (c *client) BlockNumber(ctx context.Context) (*big.Int, error) {
 	var r string
 	err := c.rpc.CallContext(ctx, &r, "eth_blockNumber")
@@ -75,6 +80,7 @@ func (c *client) BlockNumber(ctx context.Context) (*big.Int, error) {
 // ----------------------------------------------------------------------------
 // admin
 
+// AddPeer connects to the given nodeURL.
 func (c *client) AddPeer(ctx context.Context, nodeURL string) error {
 	var r bool
 	// TODO: Result needs to be verified
@@ -86,6 +92,7 @@ func (c *client) AddPeer(ctx context.Context, nodeURL string) error {
 	return err
 }
 
+// AdminPeers returns the number of connected peers.
 func (c *client) AdminPeers(ctx context.Context) ([]*p2p.PeerInfo, error) {
 	var r []*p2p.PeerInfo
 	// The response data type are bytes, but we cannot parse...
@@ -96,6 +103,7 @@ func (c *client) AdminPeers(ctx context.Context) ([]*p2p.PeerInfo, error) {
 	return r, err
 }
 
+// NodeInfo gathers and returns a collection of metadata known about the host.
 func (c *client) NodeInfo(ctx context.Context) (*p2p.PeerInfo, error) {
 	var r *p2p.PeerInfo
 	err := c.rpc.CallContext(ctx, &r, "admin_nodeInfo")
@@ -108,6 +116,7 @@ func (c *client) NodeInfo(ctx context.Context) (*p2p.PeerInfo, error) {
 // ----------------------------------------------------------------------------
 // miner
 
+// StartMining starts mining operation.
 func (c *client) StartMining(ctx context.Context) error {
 	var r []byte
 	// TODO: Result needs to be verified
@@ -119,6 +128,7 @@ func (c *client) StartMining(ctx context.Context) error {
 	return err
 }
 
+// StopMining stops mining.
 func (c *client) StopMining(ctx context.Context) error {
 	err := c.rpc.CallContext(ctx, nil, "miner_stop", nil)
 	if err != nil {

glide.yaml

@@ -1,8 +1,8 @@
 package: github.com/getamis/eth-client
 import:
 - package: github.com/ethereum/go-ethereum
-  version: istanbul/develop
-  repo: [email protected]:getamis/go-ethereum
+  version: v1.7.2
+  repo: [email protected]:ethereum/go-ethereum
   subpackages:
   - common
   - common/hexutil

istanbul/client.go

@@ -29,11 +29,13 @@ import (
 	ethClient "github.com/getamis/eth-client/client"
 )
 
+// client defines typed wrappers for the eth-client.
 type client struct {
 	ethClient.Client
 	rpc *rpc.Client
 }
 
+// Dial connects a client to the given URL.
 func Dial(rawurl string) (Client, error) {
 	rc, err := rpc.Dial(rawurl)
 	if err != nil {
@@ -48,6 +50,7 @@ func Dial(rawurl string) (Client, error) {
 	return c, nil
 }
 
+// Propose injects a new authorization candidate that the validator will attempt to push through.
 func (c *client) ProposeValidator(ctx context.Context, address common.Address, auth bool) error {
 	var r []byte
 	err := c.rpc.CallContext(ctx, &r, "istanbul_propose", address, auth)
@@ -71,6 +74,7 @@ func (addrs addresses) Swap(i, j int) {
 	addrs[i], addrs[j] = addrs[j], addrs[i]
 }
 
+// GetValidators retrieves the list of authorized validators at the specified block.
 func (c *client) GetValidators(ctx context.Context, blockNumbers *big.Int) ([]common.Address, error) {
 	var r []common.Address
 	err := c.rpc.CallContext(ctx, &r, "istanbul_getValidators", toNumArg(blockNumbers))

log/log.go

@@ -34,6 +34,7 @@ func init() {
 	)
 }
 
+// New returns a new logger with the given context.
 func New(ctx ...interface{}) log15.Logger {
 	return defaultLogger.New(ctx...)
 }

quorum/client.go

@@ -26,11 +26,13 @@ import (
 	ethClient "github.com/getamis/eth-client/client"
 )
 
+// client defines typed wrappers for the eth-client.
 type client struct {
 	ethClient.Client
 	rpc *rpc.Client
 }
 
+// Dial connects a client to the given URL.
 func Dial(rawurl string) (Client, error) {
 	rc, err := rpc.Dial(rawurl)
 	if err != nil {
@@ -45,6 +47,7 @@ func Dial(rawurl string) (Client, error) {
 	return c, nil
 }
 
+// CreateContract creates a contract with the given parameters.
 func (c *client) CreateContract(ctx context.Context, from common.Address, bytecode string, gas *big.Int) (txHash string, err error) {
 	var hex hexutil.Bytes
 	arg := map[string]interface{}{
@@ -58,6 +61,8 @@ func (c *client) CreateContract(ctx context.Context, from common.Address, byteco
 	return
 }
 
+// CreatePrivateContract creates a private contract with the given parameters. The related information can refer
+// to https://github.com/jpmorganchase/quorum/wiki/Using-Quorum#creating-private-transactionscontracts.
 func (c *client) CreatePrivateContract(ctx context.Context, from common.Address, bytecode string, gas *big.Int, privateFor []string) (txHash string, err error) {
 	var hex hexutil.Bytes
 	arg := map[string]interface{}{