forked from cerc-io/plugeth
README, core, rpc: fix various typos
This commit is contained in:
parent
4f3f6e28d5
commit
a3efdb13f2
@ -46,7 +46,7 @@ The go-ethereum project comes with several wrappers/executables found in the `cm
|
|||||||
|
|
||||||
| Command | Description |
|
| Command | Description |
|
||||||
|:----------:|-------------|
|
|:----------:|-------------|
|
||||||
| **`geth`** | Our main Ethereum CLI client. It is the entry point into the Ethereum network (main-, test- or private net), capable of running as a full node (default) archive node (retaining all historical state) or a light node (retrieving data live). It can be used by other processes as an gateway into the Ethereum network via JSON RPC endpoints exposed on top of HTTP, WebSocket and/or IPC transports. Please see our [Command Line Options](https://github.com/ethereum/go-ethereum/wiki/Command-Line-Options) wiki page for details. |
|
| **`geth`** | Our main Ethereum CLI client. It is the entry point into the Ethereum network (main-, test- or private net), capable of running as a full node (default) archive node (retaining all historical state) or a light node (retrieving data live). It can be used by other processes as a gateway into the Ethereum network via JSON RPC endpoints exposed on top of HTTP, WebSocket and/or IPC transports. Please see our [Command Line Options](https://github.com/ethereum/go-ethereum/wiki/Command-Line-Options) wiki page for details. |
|
||||||
| `abigen` | Source code generator to convert Ethereum contract definitions into easy to use, compile-time type-safe Go packages. It operates on plain [Ethereum contract ABIs](https://github.com/ethereum/wiki/wiki/Ethereum-Contract-ABI) with expanded functionality if the contract bytecode is also available. However it also accepts Solidity source files, making development much more streamlined. Please see our [Native DApps](https://github.com/ethereum/go-ethereum/wiki/Native-DApps:-Go-bindings-to-Ethereum-contracts) wiki page for details. |
|
| `abigen` | Source code generator to convert Ethereum contract definitions into easy to use, compile-time type-safe Go packages. It operates on plain [Ethereum contract ABIs](https://github.com/ethereum/wiki/wiki/Ethereum-Contract-ABI) with expanded functionality if the contract bytecode is also available. However it also accepts Solidity source files, making development much more streamlined. Please see our [Native DApps](https://github.com/ethereum/go-ethereum/wiki/Native-DApps:-Go-bindings-to-Ethereum-contracts) wiki page for details. |
|
||||||
| `bootnode` | Stripped down version of our Ethereum client implementation that only takes part in the network node discovery protocol, but does not run any of the higher level application protocols. It can be used as a lightweight bootstrap node to aid in finding peers in private networks. |
|
| `bootnode` | Stripped down version of our Ethereum client implementation that only takes part in the network node discovery protocol, but does not run any of the higher level application protocols. It can be used as a lightweight bootstrap node to aid in finding peers in private networks. |
|
||||||
| `disasm` | Bytecode disassembler to convert EVM (Ethereum Virtual Machine) bytecode into more user friendly assembly-like opcodes (e.g. `echo "6001" | disasm`). For details on the individual opcodes, please see pages 22-30 of the [Ethereum Yellow Paper](http://gavwood.com/paper.pdf). |
|
| `disasm` | Bytecode disassembler to convert EVM (Ethereum Virtual Machine) bytecode into more user friendly assembly-like opcodes (e.g. `echo "6001" | disasm`). For details on the individual opcodes, please see pages 22-30 of the [Ethereum Yellow Paper](http://gavwood.com/paper.pdf). |
|
||||||
|
@ -64,7 +64,7 @@ func NewBlockValidator(config *ChainConfig, blockchain *BlockChain, pow pow.PoW)
|
|||||||
//
|
//
|
||||||
// ValidateBlock also validates and makes sure that any previous state (or present)
|
// ValidateBlock also validates and makes sure that any previous state (or present)
|
||||||
// state that might or might not be present is checked to make sure that fast
|
// state that might or might not be present is checked to make sure that fast
|
||||||
// sync has done it's job proper. This prevents the block validator form accepting
|
// sync has done it's job proper. This prevents the block validator from accepting
|
||||||
// false positives where a header is present but the state is not.
|
// false positives where a header is present but the state is not.
|
||||||
func (v *BlockValidator) ValidateBlock(block *types.Block) error {
|
func (v *BlockValidator) ValidateBlock(block *types.Block) error {
|
||||||
if v.bc.HasBlock(block.Hash()) {
|
if v.bc.HasBlock(block.Hash()) {
|
||||||
@ -139,7 +139,7 @@ func (v *BlockValidator) ValidateState(block, parent *types.Block, statedb *stat
|
|||||||
// error if any of the included uncle headers were invalid. It returns an error
|
// error if any of the included uncle headers were invalid. It returns an error
|
||||||
// if the validation failed.
|
// if the validation failed.
|
||||||
func (v *BlockValidator) VerifyUncles(block, parent *types.Block) error {
|
func (v *BlockValidator) VerifyUncles(block, parent *types.Block) error {
|
||||||
// validate that there at most 2 uncles included in this block
|
// validate that there are at most 2 uncles included in this block
|
||||||
if len(block.Uncles()) > 2 {
|
if len(block.Uncles()) > 2 {
|
||||||
return ValidationError("Block can only contain maximum 2 uncles (contained %v)", len(block.Uncles()))
|
return ValidationError("Block can only contain maximum 2 uncles (contained %v)", len(block.Uncles()))
|
||||||
}
|
}
|
||||||
@ -193,7 +193,7 @@ func (v *BlockValidator) ValidateHeader(header, parent *types.Header, checkPow b
|
|||||||
if parent == nil {
|
if parent == nil {
|
||||||
return ParentError(header.ParentHash)
|
return ParentError(header.ParentHash)
|
||||||
}
|
}
|
||||||
// Short circuit if the header's already known or its parent missing
|
// Short circuit if the header's already known or its parent is missing
|
||||||
if v.bc.HasHeader(header.Hash()) {
|
if v.bc.HasHeader(header.Hash()) {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
@ -49,7 +49,7 @@ arguments. It will pass the mod argument as nil to the RPC method.
|
|||||||
The server offers the ServeCodec method which accepts a ServerCodec instance. It will
|
The server offers the ServeCodec method which accepts a ServerCodec instance. It will
|
||||||
read requests from the codec, process the request and sends the response back to the
|
read requests from the codec, process the request and sends the response back to the
|
||||||
client using the codec. The server can execute requests concurrently. Responses
|
client using the codec. The server can execute requests concurrently. Responses
|
||||||
can be send back to the client out of order.
|
can be sent back to the client out of order.
|
||||||
|
|
||||||
An example server which uses the JSON codec:
|
An example server which uses the JSON codec:
|
||||||
type CalculatorService struct {}
|
type CalculatorService struct {}
|
||||||
|
@ -82,7 +82,7 @@ func (s *RPCService) Modules() map[string]string {
|
|||||||
return modules
|
return modules
|
||||||
}
|
}
|
||||||
|
|
||||||
// RegisterName will create an service for the given rcvr type under the given name. When no methods on the given rcvr
|
// RegisterName will create a service for the given rcvr type under the given name. When no methods on the given rcvr
|
||||||
// match the criteria to be either a RPC method or a subscription an error is returned. Otherwise a new service is
|
// match the criteria to be either a RPC method or a subscription an error is returned. Otherwise a new service is
|
||||||
// created and added to the service collection this server instance serves.
|
// created and added to the service collection this server instance serves.
|
||||||
func (s *Server) RegisterName(name string, rcvr interface{}) error {
|
func (s *Server) RegisterName(name string, rcvr interface{}) error {
|
||||||
@ -236,7 +236,7 @@ func (s *Server) ServeSingleRequest(codec ServerCodec, options CodecOption) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Stop will stop reading new requests, wait for stopPendingRequestTimeout to allow pending requests to finish,
|
// Stop will stop reading new requests, wait for stopPendingRequestTimeout to allow pending requests to finish,
|
||||||
// close all codecs which will cancels pending requests/subscriptions.
|
// close all codecs which will cancel pending requests/subscriptions.
|
||||||
func (s *Server) Stop() {
|
func (s *Server) Stop() {
|
||||||
if atomic.CompareAndSwapInt32(&s.run, 1, 0) {
|
if atomic.CompareAndSwapInt32(&s.run, 1, 0) {
|
||||||
glog.V(logger.Debug).Infoln("RPC Server shutdown initiatied")
|
glog.V(logger.Debug).Infoln("RPC Server shutdown initiatied")
|
||||||
@ -294,7 +294,7 @@ func (s *Server) handle(ctx context.Context, codec ServerCodec, req *serverReque
|
|||||||
return codec.CreateErrorResponse(&req.id, &callbackError{err.Error()}), nil
|
return codec.CreateErrorResponse(&req.id, &callbackError{err.Error()}), nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// active the subscription after the sub id was successful sent to the client
|
// active the subscription after the sub id was successfully sent to the client
|
||||||
activateSub := func() {
|
activateSub := func() {
|
||||||
notifier, _ := NotifierFromContext(ctx)
|
notifier, _ := NotifierFromContext(ctx)
|
||||||
notifier.(*bufferedNotifier).activate(subid)
|
notifier.(*bufferedNotifier).activate(subid)
|
||||||
|
Loading…
Reference in New Issue
Block a user