From 4b3c4b86fb7296e820fe6d51dc214a6c8eb35712 Mon Sep 17 00:00:00 2001 From: Adam Schmideg Date: Wed, 18 Sep 2019 11:34:37 +0200 Subject: [PATCH] Fixed last broken links --- _config.yml | 2 +- docs/_doc/Ethereum-Specification.md | 2 +- .../Japanese-Contracts-and-Transactions.md | 2 +- docs/_install-and-build/Backup--restore.md | 2 +- docs/_interface/JavaScript-Console.md | 2 +- docs/_interface/Management-APIs.md | 20 ++++++++++++++----- ...ing-your-own-Ethereum-apps-using-Eth-go.md | 6 +++--- docs/_legacy/Mining.md | 15 +++++++------- docs/_legacy/geth.md | 6 +++--- 9 files changed, 33 insertions(+), 24 deletions(-) diff --git a/_config.yml b/_config.yml index 105371fea9..2d87f54698 100644 --- a/_config.yml +++ b/_config.yml @@ -15,7 +15,7 @@ defaults: - scope: path: "*" values: - root: ".." + root: "." - scope: path: "*/*" values: diff --git a/docs/_doc/Ethereum-Specification.md b/docs/_doc/Ethereum-Specification.md index 9bed53d2a1..4a55748e65 100644 --- a/docs/_doc/Ethereum-Specification.md +++ b/docs/_doc/Ethereum-Specification.md @@ -15,7 +15,7 @@ Specifications of all ethereum technologies, languages, protocols, etc. - [JavaScript API](https://github.com/ethereum/wiki/wiki/JavaScript-API#a) - [Generic JSON RPC](https://github.com/ethereum/wiki/wiki/JSON-RPC) -- [JSRE admin API](../interface/javascript-console#console-api) +- [JSRE admin API](../interface/javascript-console) - [RLP](https://github.com/ethereum/wiki/wiki/RLP) - [ÐΞVp2p Wire Protocol](https://github.com/ethereum/wiki/wiki/%C3%90%CE%9EVp2p-Wire-Protocol) - [Web3 Secret Storage](https://github.com/ethereum/wiki/wiki/Web3-Secret-Storage-Definition) diff --git a/docs/_doc/Japanese-Contracts-and-Transactions.md b/docs/_doc/Japanese-Contracts-and-Transactions.md index 53a3590e3f..478ae8eb3f 100644 --- a/docs/_doc/Japanese-Contracts-and-Transactions.md +++ b/docs/_doc/Japanese-Contracts-and-Transactions.md @@ -118,7 +118,7 @@ You are ready to compile solidity code in the `geth` JS console using [`eth.comp } ``` -The compiler is also available via [RPC](https://github.com/ethereum/wiki/JSON-RPC) and therefore via [web3.js](https://github.com/ethereum/wiki/wiki/JavaScript-API#web3ethcompilesolidity) to any in-browser Ðapp connecting to `geth` via RPC. +The compiler is also available via [RPC](https://github.com/ethereum/wiki/wiki/JSON-RPC) and therefore via [web3.js](https://github.com/ethereum/wiki/wiki/JavaScript-API#web3ethcompilesolidity) to any in-browser Ðapp connecting to `geth` via RPC. The following example shows how you interface `geth` via JSON-RPC to use the compiler. diff --git a/docs/_install-and-build/Backup--restore.md b/docs/_install-and-build/Backup--restore.md index ce896ccd1f..e2f1820c0a 100644 --- a/docs/_install-and-build/Backup--restore.md +++ b/docs/_install-and-build/Backup--restore.md @@ -25,7 +25,7 @@ Accounts are stored in the `keystore` subdirectory. The contents of this directo To configure the location of the data directory, the `--datadir` parameter can be specified. See [CLI Options](../interface/command-line-options) for more details. -_**note:** the [ethash dag](../legacy/mining#ethash-dag) is stored at `~/.ethash` (Mac/Linux) or `%APPDATA%\Ethash` (Windows) so that it can be reused by all clients. You can store this in a different location by using a symbolic link._ +_**note:** the [ethash dag](../legacy/mining) is stored at `~/.ethash` (Mac/Linux) or `%APPDATA%\Ethash` (Windows) so that it can be reused by all clients. You can store this in a different location by using a symbolic link._ ## Upgrades diff --git a/docs/_interface/JavaScript-Console.md b/docs/_interface/JavaScript-Console.md index f70e51d488..907bb01278 100644 --- a/docs/_interface/JavaScript-Console.md +++ b/docs/_interface/JavaScript-Console.md @@ -3,7 +3,7 @@ title: JavaScript console --- Ethereum implements a **javascript runtime environment** (JSRE) that can be used in either interactive (console) or non-interactive (script) mode. -Ethereum's Javascript console exposes the full [web3 JavaScript Dapp API](https://github.com/ethereum/wiki/wiki/JavaScript-API) and the [admin API](#javascript-console-api). +Ethereum's Javascript console exposes the full [web3 JavaScript Dapp API](https://github.com/ethereum/wiki/wiki/JavaScript-API) and the admin API. ## Interactive use: the JSRE REPL Console diff --git a/docs/_interface/Management-APIs.md b/docs/_interface/Management-APIs.md index 99b24c5579..e0596e7e21 100644 --- a/docs/_interface/Management-APIs.md +++ b/docs/_interface/Management-APIs.md @@ -1,7 +1,7 @@ --- title: Management APIs --- -Beside the official [DApp APIs](https://github.com/ethereum/wiki/JSON-RPC) interface go-ethereum +Beside the official [DApp APIs](https://github.com/ethereum/wiki/wiki/JSON-RPC) interface go-ethereum has support for additional management APIs. Similar to the DApp APIs, these are also provided using [JSON-RPC](http://www.jsonrpc.org/specification) and follow exactly the same conventions. Geth comes with a console client which has support for all additional APIs described here. @@ -96,8 +96,8 @@ extra management API namespaces: | [peers](#admin_peers) | [dumpBlock](#debug_dumpblock) | [stop](#miner_stop) | [lockAccount](#personal_lockaccount) | | | [setSolc](#admin_setsolc) | [gcStats](#debug_gcstats) | [getHashrate](#miner_gethashrate) | [newAccount](#personal_newaccount) | | | [startRPC](#admin_startrpc) | [getBlockRlp](#debug_getblockrlp) | [setEtherbase](#miner_setetherbase) | [unlockAccount](#personal_unlockaccount) | | -| [startWS](#admin_startws) | [goTrace](#debug_goTrace) | | [sendTransaction](#personal_sendtransaction) | | -| [stopRPC](#admin_stoprpc) | [memStats](#debug_memStats) | | [sign](#personal_sign) | | +| [startWS](#admin_startws) | [goTrace](#debug_gotrace) | | [sendTransaction](#personal_sendtransaction) | | +| [stopRPC](#admin_stoprpc) | [memStats](#debug_memstats) | | [sign](#personal_sign) | | | [stopWS](#admin_stopws) | [seedHash](#debug_seedhash)[sign](#personal_sign)| | | | | | [setBlockProfileRate](#debug_setblockprofilerate) | | | | | | [setHead](#debug_sethead) | | | | @@ -107,8 +107,8 @@ extra management API namespaces: | | [stopCPUProfile](#debug_stopcpuprofile) | | | | | | [stopGoTrace](#debug_stopgotrace) | | | | | | [traceBlock](#debug_traceblock) | | | | -| | [traceBlockByNumber](#debug_blockbynumber) | | | | -| | [traceBlockByHash](#debug_blockbyhash) | | | | +| | [traceBlockByNumber](#debug_traceblockbynumber) | | | | +| | [traceBlockByHash](#debug_traceblockbyhash) | | | | | | [traceBlockFromFile](#debug_traceblockfromfile) | | | | | | [traceTransaction](#debug_tracetransaction) | | | | | | [verbosity](#debug_verbosity) | | | | @@ -869,6 +869,16 @@ flag. The `miner` API allows you to remote control the node's mining operation and set various mining specific settings. +### miner_getHashrate + +TBD +The result is in H/s (Hash operations per second). + +| Client | Method invocation | +|:-------:|-------------------------------------------------------------| +| Console | `miner.getHashrate()` | +| RPC | `{"method": "miner_getHashrate", "params": []}` | + ### miner_setExtra Sets the extra data a miner can include when miner blocks. This is capped at diff --git a/docs/_legacy/Creating-your-own-Ethereum-apps-using-Eth-go.md b/docs/_legacy/Creating-your-own-Ethereum-apps-using-Eth-go.md index 83f295f650..ee6fca53bd 100644 --- a/docs/_legacy/Creating-your-own-Ethereum-apps-using-Eth-go.md +++ b/docs/_legacy/Creating-your-own-Ethereum-apps-using-Eth-go.md @@ -4,11 +4,11 @@ title: Creating your own Ethereum apps using Eth go **This page is heavily outdated** -The modular nature of Go and the Ethereum Go implementation, [eth-go](https://github.com/ethereum/eth-go), make it very easy to build your own Ethereum native applications. +The modular nature of Go and the Ethereum Go implementation make it very easy to build your own Ethereum native applications. This post will cover the minimal steps required to build an native Ethereum application. -Ethereum comes with a global config found in the [ethutil](https://github.com/ethereum/eth-go/tree/master/ethutil) package. The global config requires you to set a base path to store it's files (database, settings, etc). +Ethereum comes with a global config found in the ethutil package. The global config requires you to set a base path to store it's files (database, settings, etc). ```go func main() { @@ -19,7 +19,7 @@ func main() { ReadConfig takes four arguments. The data folder to use, a log flag, a globalConf instance and an id string to identify your app to other nodes in the network. -Once you've configured the global config you can set up and create your Ethereum node. The Ethereum Object, or Node, will handle all trafic from and to the Ethereum network as well as handle all incoming block and transactions. A new node can be created through the `new` method found in [eth-go](https://github.com/ethereum/eth-go). +Once you've configured the global config you can set up and create your Ethereum node. The Ethereum Object, or Node, will handle all trafic from and to the Ethereum network as well as handle all incoming block and transactions. A new node can be created through the `new` method found in eth-go. ```go func main() { diff --git a/docs/_legacy/Mining.md b/docs/_legacy/Mining.md index 5c711ed842..bdc7727c3a 100644 --- a/docs/_legacy/Mining.md +++ b/docs/_legacy/Mining.md @@ -9,7 +9,7 @@ title: Mining At Frontier, the first release of Ethereum, you'll just need a) a GPU and b) an Ethereum client, Geth. CPU mining will be possible but too inefficient to hold any value. -At the moment, Geth only includes a CPU miner, and the team is testing a [GPU miner branch](https://github.com/ethereum/go-ethereum/tree/gpu_miner), but this won't be part of Frontier. +At the moment, Geth only includes a CPU miner, and the team is testing a GPU miner branch, but this won't be part of Frontier. The C++ implementation of Ethereum also offers a GPU miner, both as part of Eth (its CLI), AlethZero (its GUI) and EthMiner (the standalone miner). @@ -19,7 +19,7 @@ When you start up your ethereum node with `geth` it is not mining by default. To `geth --mine --minerthreads=4` -You can also start and stop CPU mining at runtime using the [console](../interface/javascript-console#adminminerstart). `miner.start` takes an optional parameter for the number of miner threads. +You can also start and stop CPU mining at runtime using the [console](../interface/javascript-console). `miner.start` takes an optional parameter for the number of miner threads. ``` > miner.start(8) @@ -46,7 +46,7 @@ miner.setEtherbase(eth.accounts[2]) Note that your etherbase does not need to be an address of a local account, just an existing one. -There is an option [to add extra Data](../interface/javascript-console#adminminersetextra) (32 bytes only) to your mined blocks. By convention this is interpreted as a unicode string, so you can set your short vanity tag. +There is an option [to add extra Data](../interface/javascript-console) (32 bytes only) to your mined blocks. By convention this is interpreted as a unicode string, so you can set your short vanity tag. ``` miner.setExtra("ΞTHΞЯSPHΞЯΞ") @@ -66,7 +66,7 @@ Header: See also [this proposal](https://github.com/ethereum/wiki/wiki/Extra-Data) -You can check your hashrate with [miner.hashrate](../interface/javascript-console#adminminerhashrate), the result is in H/s (Hash operations per second). +You can check your hashrate with [miner.hashrate](../interface/javascript-console), the result is in H/s (Hash operations per second). ``` > miner.hashrate @@ -139,14 +139,13 @@ The GPU miner is implemented in OpenCL, so AMD GPUs will be 'faster' than same-c ASICs and FPGAs are relatively inefficient and therefore discouraged. To get openCL for your chipset and platform, try: -* [AMD SDK openCL](http://developer.amd.com/tools-and-sdks/opencl-zone/amd-accelerated-parallel-processing-app-sdk) +* [AMD SDK openCL](http://developer.amd.com/tools-and-sdks) * [NVIDIA CUDA openCL](https://developer.nvidia.com/cuda-downloads) ## On Ubuntu ### AMD -* http://developer.amd.com/tools-and-sdks/opencl-zone/amd-accelerated-parallel-processing -* http://developer.amd.com/tools-and-sdks/graphics-development/display-library-adl-sdk/ +* http://developer.amd.com/tools-and-sdks download: `ADL_SDK8.zip ` and `AMD-APP-SDK-v2.9-1.599.381-GA-linux64.sh` @@ -189,7 +188,7 @@ You check your cooling status: ## Mining Software -The official Frontier release of `geth` only supports a CPU miner natively. We are working on a [GPU miner](https://github.com/ethereum/go-ethereum/tree/gpuminer), but it may not be available for the Frontier release. Geth however can be used in conjunction with `ethminer`, using the standalone miner as workers and `geth` as scheduler communicating via [JSON-RPC](https://github.com/ethereum/wiki/JSON-RPC). +The official Frontier release of `geth` only supports a CPU miner natively. We are working on a GPU miner, but it may not be available for the Frontier release. Geth however can be used in conjunction with `ethminer`, using the standalone miner as workers and `geth` as scheduler communicating via [JSON-RPC](https://github.com/ethereum/wiki/wiki/JSON-RPC). The [C++ implementation of Ethereum](https://github.com/ethereum/cpp-ethereum/) (not officially released) however has a GPU miner. It can be used from `eth`, `AlethZero` (GUI) and `ethMiner` (the standalone miner). diff --git a/docs/_legacy/geth.md b/docs/_legacy/geth.md index a29961c795..607ab9cd85 100644 --- a/docs/_legacy/geth.md +++ b/docs/_legacy/geth.md @@ -25,7 +25,7 @@ Developers and community enthusiast are advised to read the [Developers' Guide]( ## Interfaces * Javascript Console: `geth` can be launched with an interactive console, that provides a javascript runtime environment exposing a javascript API to interact with your node. [Javascript Console API](../interface/javascript-console) includes the `web3` javascript Ðapp API as well as an additional admin API. -* JSON-RPC server: `geth` can be launched with a json-rpc server that exposes the [JSON-RPC API](https://github.com/ethereum/wiki/JSON-RPC) +* JSON-RPC server: `geth` can be launched with a $c server that exposes the [JSON-RPC API](https://github.com/ethereum/wiki/wiki/JSON-RPC) * [Command line options](../interface/command-line-options) documents command line parameters as well as subcommands. ## Basic Use Case Documentation @@ -37,7 +37,7 @@ Developers and community enthusiast are advised to read the [Developers' Guide]( ## License -The Ethereum Core Protocol licensed under the [GNU Lesser General Public License](https://www.gnu.org/licenses/lgpl.html). All frontend client software (under [cmd](https://github.com/ethereum/go-ethereum/tree/develop/cmd)) is licensed under the [GNU General Public License](https://www.gnu.org/copyleft/gpl.html). +The Ethereum Core Protocol licensed under the [GNU Lesser General Public License](https://www.gnu.org/licenses/lgpl.html). All frontend client software (under [cmd](https://github.com/ethereum/go-ethereum/tree/master/cmd)) is licensed under the [GNU General Public License](https://www.gnu.org/copyleft/gpl.html). ## Reporting @@ -96,7 +96,7 @@ IRC Freenode channels: ### Forum -- [Forum](https://forum.ethereum.org/categories/go-implementation) +- [Forum](https://forum.ethereum.org/categories/geth) ### The ZeroGox Bot