From 31e631473baa563051e284bea1bd51bc4ae4385d Mon Sep 17 00:00:00 2001 From: Eric Passmore Date: Fri, 23 Sep 2022 13:09:00 -0700 Subject: [PATCH 01/18] updated trace_api openapi documentation - added trace_transcation method - added new component types - ERROR_DETAILS - TRACE - TRANSACTION_HEADER - TRANSACTION_TRACE - BLOCK_TRACE - updated return schema for both get_block and get_transaction --- .../trace_api_plugin/trace_api.swagger.yaml | 288 +++++++++++++++++- 1 file changed, 284 insertions(+), 4 deletions(-) diff --git a/plugins/trace_api_plugin/trace_api.swagger.yaml b/plugins/trace_api_plugin/trace_api.swagger.yaml index 2c5f5dc78e..1531dae149 100644 --- a/plugins/trace_api_plugin/trace_api.swagger.yaml +++ b/plugins/trace_api_plugin/trace_api.swagger.yaml @@ -1,12 +1,13 @@ openapi: 3.0.0 info: title: Trace API + description: This plubing must specifiy one option `trace-rpc-abi` or `no-trace-abis`. These options are provided at nodeos startup on the command line or in config.ini file. Configuration option `trace-rpc-abi` There must be at least one ABI specified OR the flag trace-no-abis must be used. ABIs are specified as "Key=Value" pairs in the form = Where can be an absolute path to a file containing a valid JSON-encoded ABI a relative path from `data-dir` to a file containing a valid JSON-encoded ABI. Configuration option `trace-no-abis` use to indicate that the RPC responses version: 1.0.0 license: name: MIT url: https://opensource.org/licenses/MIT contact: - url: https://eos.io + url: https://eosnetwork.com servers: - url: '{protocol}://{host}:{port}/v1/' variables: @@ -21,9 +22,12 @@ servers: default: "8080" components: schemas: {} +security: + - {} paths: /trace_api/get_block: post: + summary: get block description: Returns a block trace object containing retired actions and related metadata. operationId: get_block requestBody: @@ -43,12 +47,288 @@ paths: content: application/json: schema: - oneOf: - - $ref: "https://eosio.github.io/schemata/v2.0/oas/BlockTraceV0.yaml" - - $ref: "https://eosio.github.io/schemata/v2.0/oas/BlockTraceV1.yaml" + $ref: "#/component/schema/BLOCK_TRACE" "400": description: Error - requested block number is invalid (not a number, larger than max int) + content: + application/json: + schema: + type: object + properties: + code: + type: integer + example: 400 + message: + type: string + example: "bad or missing block_num" + error: + $ref: "#/component/schema/ERROR_DETAILS" + "404": + description: Error - requested data not present on node + content: + application/json: + schema: + type: object + properties: + code: + type: integer + example: 400 + message: + type: string + example: "bad or missing block_num" + error: + $ref: "#/component/schema/ERROR_DETAILS" + "500": + description: Error - exceptional condition while processing get_block; e.g. corrupt files + content: + application/json: + schema: + type: object + properties: + code: + type: integer + example: 500 + message: + type: string + example: "Trace API encountered an Error which it cannot recover from. Please resolve the error and relaunch the process" + error: + $ref: "#/component/schema/ERROR_DETAILS" + + /trace_api/get_transaction_trace: + post: + summary: transaction trace + description: Does a scan of the trace files looking for the transaction + optionationId: get_transaction_trace + requestBody: + content: + application/json: + schema: + type: object + required: + - id + properties: + id: + type: integer + description: Proviade a transaction id + responses: + "200": + content: + application/json: + schema: + $ref: "#/component/schema/TRANSACTION_TRACE" + "400": + description: Error - requested block number is invalid (not a number, larger than max int) + content: + application/json: + schema: + type: object + properties: + code: + type: integer + example: 400 + message: + type: string + example: "bad or missing block_num" + error: + $ref: "#/component/schema/ERROR_DETAILS" "404": description: Error - requested data not present on node + content: + application/json: + schema: + type: object + properties: + code: + type: integer + example: 400 + message: + type: string + example: "bad or missing block_num" + error: + $ref: "#/component/schema/ERROR_DETAILS" "500": description: Error - exceptional condition while processing get_block; e.g. corrupt files + content: + application/json: + schema: + type: object + properties: + code: + type: integer + example: 500 + message: + type: string + example: "Trace API encountered an Error which it cannot recover from. Please resolve the error and relaunch the process" + error: + $ref: "#/component/schema/ERROR_DETAILS" +component: + schema: + TRACE: + type: object + properties: + global_squence: + type: integer + example: 669 + receiver: + type: string + example: myproducer + account: + type: string + example: esio.token + action: + type: string + example: transfer + authorization: + type: array + items: + type: object + properties: + account: + type: string + example: myaccount + permission: + type: string + example: active + data: + type: string + $ref: "https://docs.eosnetwork.com/openapi/v2.0/Sha256.yaml" + return_value: + type: string + example: "" + params: + type: object + properties: + from: + type: string + example: eosio + to: + type: string + example: myproducer + quantity: + type: string + example: "10.000 SYS" + memo: + type: string + example: "first transfer" + TRANSACTION_HEADER: + type: object + properties: + expiration: + type: string + example: "2019-06-18T00:00:00" + ref_block_num: + type: integer + example: 25 + ref_block_prefix: + type: integer + example: 61809694 + max_net_usage_words: + type: integer + example: 0 + max_cpu_usage_ms: + type: integer + example: 0 + delay_sec: + type: integer + example: 0 + TRANSACTION_TRACE: + type: object + properties: + id: + type: string + $ref: "https://docs.eosnetwork.com/openapi/v2.0/Sha256.yaml" + block_num: + type: integer + example: 31 + block_time: + type: string + example: "2019-06-18T00:00:00" + producer_block_id: + type: string + $ref: "https://docs.eosnetwork.com/openapi/v2.0/Sha256.yaml" + actions: + type: array + items: + $ref: "#/component/schema/TRACE" + status: + type: string + example: executed + cpu_usage_us: + type: integer + example: 669 + net_usage_words: + type: integer + example: 6 + signatures: + type: array + items: + $ref: "https://docs.eosnetwork.com/openapi/v2.0/CppSignature.yaml" + transaction_header: + type: object + $ref: "#/component/schema/TRANSACTION_HEADER" + BLOCK_TRACE: + type: object + properties: + id: + $ref: "https://docs.eosnetwork.com/openapi/v2.0/Sha256.yaml" + number: + type: integer + example: 31 + previous_id: + $ref: "https://docs.eosnetwork.com/openapi/v2.0/Sha256.yaml" + status: + type: string + enum: + - "irreversible" + - "executed" + - "pending" + example: executed + timestamp: + type: string + example: "2019-06-18T00:00:00" + producer: + type: string + example: myproducer + transaction_mroot: + $ref: "https://docs.eosnetwork.com/openapi/v2.0/Sha256.yaml" + action_mroot: + $ref: "https://docs.eosnetwork.com/openapi/v2.0/Sha256.yaml" + schedule_version: + type: integer + example: 1 + transactions: + type: array + items: + type: object + properties: + id: + $ref: "https://docs.eosnetwork.com/openapi/v2.0/Sha256.yaml" + block_num: + type: integer + example: 31 + block_time: + type: string + example: "2019-06-18T00:00:00" + producer_block_id: + $ref: "https://docs.eosnetwork.com/openapi/v2.0/Sha256.yaml" + actions: + type: array + items: + $ref: "#/component/schema/TRACE" + transaction_header: + type: object + $ref: "#/component/schema/TRANSACTION_HEADER" + ERROR_DETAILS: + type: object + properties: + code: + type: integer + example: 0 + name: + type: string + what: + type: string + details: + type: array + items: + type: string From 05099f957ad32b572f2b255ac20ee5e7da8ea4b6 Mon Sep 17 00:00:00 2001 From: 766C6164 Date: Wed, 29 Jun 2022 22:29:11 -0400 Subject: [PATCH 02/18] docs cleanup --- .../00_install-prebuilt-binaries.md | 71 ---- .../01_download-eosio-source.md | 31 -- .../02_build-eosio-binaries.md | 18 - .../03_install-eosio-binaries.md | 24 -- .../04_test-eosio-binaries.md | 15 - .../01_shell-scripts/05_uninstall-eosio.md | 13 - .../01_shell-scripts/index.md | 17 - .../02_manual-build/00_eosio-dependencies.md | 45 --- .../03_platforms/amazon_linux-2.md | 92 ----- .../03_platforms/centos-7.7.md | 100 ----- .../02_manual-build/03_platforms/index.md | 8 - .../03_platforms/macos-10.14.md | 74 ---- .../03_platforms/ubuntu-18.04.md | 92 ----- .../02_manual-build/index.md | 28 -- docs/00_install/01_build-from-source/index.md | 58 ++- docs/00_install/index.md | 22 +- .../02_node-setups/00_producing-node.md | 8 +- .../02_node-setups/01_non-producing-node.md | 8 +- .../00_local-single-node-testnet.md | 4 +- .../01_local-multi-node-testnet.md | 23 +- .../03_development-environment/index.md | 6 +- .../03_plugins/chain_plugin/index.md | 2 +- .../03_plugins/login_plugin/index.md | 2 +- .../03_plugins/producer_plugin/index.md | 4 +- ...0_how-to-fast-start-without-old-history.md | 2 +- ...w-to-replay-or-resync-with-full-history.md | 2 +- ...ow-to-create-snapshot-with-full-history.md | 2 +- ...w-to-restore-snapshot-with-full-history.md | 2 +- .../03_plugins/state_history_plugin/index.md | 5 - .../03_plugins/trace_api_plugin/index.md | 8 +- .../03_plugins/txn_test_gen_plugin/index.md | 2 +- docs/01_nodeos/06_logging/index.md | 4 +- .../07_concepts/05_storage-and-read-modes.md | 6 +- .../07_concepts/10_context-free-data/index.md | 2 +- docs/01_nodeos/08_troubleshooting/index.md | 4 +- docs/01_nodeos/09_deprecation-notices.md | 3 - docs/01_nodeos/index.md | 7 +- .../how-to-create-a-wallet.md | 2 +- .../how-to-create-an-account.md | 10 +- .../how-to-create-key-pairs.md | 6 +- .../how-to-delegate-CPU-resource.md | 8 +- .../how-to-delegate-net-resource.md | 8 +- .../how-to-deploy-a-smart-contract.md | 2 +- .../how-to-get-account-information.md | 10 +- .../how-to-get-block-information.md | 4 +- .../how-to-get-transaction-information.md | 6 +- .../02_how-to-guides/how-to-import-a-key.md | 4 +- .../how-to-list-all-key-pairs.md | 4 +- .../03_command-reference/create/account.md | 2 +- .../03_command-reference/net/connect.md | 2 +- .../03_command-reference/net/disconnect.md | 2 +- .../03_command-reference/net/peers.md | 2 +- .../03_command-reference/net/status.md | 2 +- .../03_command-reference/set/set-account.md | 2 +- docs/02_cleos/04_troubleshooting.md | 2 +- docs/02_cleos/index.md | 6 +- docs/03_keosd/index.md | 4 +- docs/10_utilities/index.md | 6 +- docs/20_upgrade-guide/79_2.0-upgrade-guide.md | 3 - docs/20_upgrade-guide/81_1.8-upgrade-guide.md | 132 ------ docs/20_upgrade-guide/index.md | 52 --- docs/30_release-notes/87_v2.0.12.md | 4 - docs/30_release-notes/88_v2.0.11.md | 21 - docs/30_release-notes/89_v2.0.10.md | 41 -- docs/30_release-notes/90_v2.0.9.md | 17 - docs/30_release-notes/91_v2.0.8.md | 59 --- docs/30_release-notes/92_v2.0.7.md | 30 -- docs/30_release-notes/93_v2.0.6.md | 74 ---- docs/30_release-notes/94_v2.0.5.md | 65 --- docs/30_release-notes/95_v2.0.4.md | 88 ---- docs/30_release-notes/96_v2.0.3.md | 29 -- docs/30_release-notes/97_v2.0.2.md | 46 --- docs/30_release-notes/98_v2.0.1.md | 37 -- docs/30_release-notes/99_v2.0.0.md | 377 ------------------ docs/30_release-notes/index.md | 28 -- docs/index.md | 22 +- ...o_components.png => mandel_components.png} | Bin 77 files changed, 166 insertions(+), 1867 deletions(-) delete mode 100644 docs/00_install/00_install-prebuilt-binaries.md delete mode 100644 docs/00_install/01_build-from-source/01_shell-scripts/01_download-eosio-source.md delete mode 100644 docs/00_install/01_build-from-source/01_shell-scripts/02_build-eosio-binaries.md delete mode 100644 docs/00_install/01_build-from-source/01_shell-scripts/03_install-eosio-binaries.md delete mode 100644 docs/00_install/01_build-from-source/01_shell-scripts/04_test-eosio-binaries.md delete mode 100644 docs/00_install/01_build-from-source/01_shell-scripts/05_uninstall-eosio.md delete mode 100644 docs/00_install/01_build-from-source/01_shell-scripts/index.md delete mode 100644 docs/00_install/01_build-from-source/02_manual-build/00_eosio-dependencies.md delete mode 100644 docs/00_install/01_build-from-source/02_manual-build/03_platforms/amazon_linux-2.md delete mode 100644 docs/00_install/01_build-from-source/02_manual-build/03_platforms/centos-7.7.md delete mode 100644 docs/00_install/01_build-from-source/02_manual-build/03_platforms/index.md delete mode 100644 docs/00_install/01_build-from-source/02_manual-build/03_platforms/macos-10.14.md delete mode 100644 docs/00_install/01_build-from-source/02_manual-build/03_platforms/ubuntu-18.04.md delete mode 100644 docs/00_install/01_build-from-source/02_manual-build/index.md delete mode 100644 docs/01_nodeos/09_deprecation-notices.md delete mode 100644 docs/20_upgrade-guide/79_2.0-upgrade-guide.md delete mode 100644 docs/20_upgrade-guide/81_1.8-upgrade-guide.md delete mode 100644 docs/20_upgrade-guide/index.md delete mode 100644 docs/30_release-notes/87_v2.0.12.md delete mode 100644 docs/30_release-notes/88_v2.0.11.md delete mode 100644 docs/30_release-notes/89_v2.0.10.md delete mode 100644 docs/30_release-notes/90_v2.0.9.md delete mode 100644 docs/30_release-notes/91_v2.0.8.md delete mode 100644 docs/30_release-notes/92_v2.0.7.md delete mode 100644 docs/30_release-notes/93_v2.0.6.md delete mode 100644 docs/30_release-notes/94_v2.0.5.md delete mode 100644 docs/30_release-notes/95_v2.0.4.md delete mode 100644 docs/30_release-notes/96_v2.0.3.md delete mode 100644 docs/30_release-notes/97_v2.0.2.md delete mode 100644 docs/30_release-notes/98_v2.0.1.md delete mode 100644 docs/30_release-notes/99_v2.0.0.md delete mode 100644 docs/30_release-notes/index.md rename docs/{eosio_components.png => mandel_components.png} (100%) diff --git a/docs/00_install/00_install-prebuilt-binaries.md b/docs/00_install/00_install-prebuilt-binaries.md deleted file mode 100644 index 6888d6b6f2..0000000000 --- a/docs/00_install/00_install-prebuilt-binaries.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -content_title: Install Prebuilt Binaries ---- - -[[info | Previous Builds]] -| If you have previously installed EOSIO from source using shell scripts, you must first run the [Uninstall Script](01_build-from-source/01_shell-scripts/05_uninstall-eosio.md) before installing any prebuilt binaries on the same OS. - -## Prebuilt Binaries - -Prebuilt EOSIO software packages are available for the operating systems below. Find and follow the instructions for your OS: - -### Mac OS X: - -#### Mac OS X Brew Install -```sh -brew tap eosio/eosio -brew install eosio -``` -#### Mac OS X Brew Uninstall -```sh -brew remove eosio -``` - -### Ubuntu Linux: - -#### Ubuntu 18.04 Package Install -```sh -wget https://github.com/eosio/eos/releases/download/v2.0.13/eosio_2.0.13-1-ubuntu-18.04_amd64.deb -sudo apt install ./eosio_2.0.13-1-ubuntu-18.04_amd64.deb -``` -#### Ubuntu 16.04 Package Install -```sh -wget https://github.com/eosio/eos/releases/download/v2.0.13/eosio_2.0.13-1-ubuntu-16.04_amd64.deb -sudo apt install ./eosio_2.0.13-1-ubuntu-16.04_amd64.deb -``` -#### Ubuntu Package Uninstall -```sh -sudo apt remove eosio -``` - -### RPM-based (CentOS, Amazon Linux, etc.): - -#### RPM Package Install -```sh -wget https://github.com/eosio/eos/releases/download/v2.0.13/eosio-2.0.13-1.el7.x86_64.rpm -sudo yum install ./eosio-2.0.13-1.el7.x86_64.rpm -``` -#### RPM Package Uninstall -```sh -sudo yum remove eosio -``` - -## Location of EOSIO binaries - -After installing the prebuilt packages, the actual EOSIO binaries will be located under: -* `/usr/opt/eosio//bin` (Linux-based); or -* `/usr/local/Cellar/eosio//bin` (MacOS) - -where `version-string` is the EOSIO version that was installed. - -Also, soft links for each EOSIO program (`nodeos`, `cleos`, `keosd`, etc.) will be created under `usr/bin` or `usr/local/bin` to allow them to be executed from any directory. - -## Previous Versions - -To install previous versions of the EOSIO prebuilt binaries: - -1. Browse to https://github.com/EOSIO/eos/tags and select the actual version of the EOSIO software you need to install. - -2. Scroll down past the `Release Notes` and download the package or archive that you need for your OS. - -3. Follow the instructions on the first paragraph above to install the selected prebuilt binaries on the given OS. diff --git a/docs/00_install/01_build-from-source/01_shell-scripts/01_download-eosio-source.md b/docs/00_install/01_build-from-source/01_shell-scripts/01_download-eosio-source.md deleted file mode 100644 index 18f436899b..0000000000 --- a/docs/00_install/01_build-from-source/01_shell-scripts/01_download-eosio-source.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -content_title: Download EOSIO Source ---- - -To download the EOSIO source code, clone the `eos` repo and its submodules. It is adviced to create a home `eosio` folder first and download all the EOSIO related software there: - -```sh -mkdir -p ~/eosio && cd ~/eosio -git clone --recursive https://github.com/EOSIO/eos -``` - -## Update Submodules - -If a repository is cloned without the `--recursive` flag, the submodules *must* be updated before starting the build process: - -```sh -cd ~/eosio/eos -git submodule update --init --recursive -``` - -## Pull Changes - -When pulling changes, especially after switching branches, the submodules *must* also be updated. This can be achieved with the `git submodule` command as above, or using `git pull` directly: - -```sh -[git checkout ] (optional) -git pull --recurse-submodules -``` - -[[info | What's Next?]] -| [Build EOSIO binaries](02_build-eosio-binaries.md) diff --git a/docs/00_install/01_build-from-source/01_shell-scripts/02_build-eosio-binaries.md b/docs/00_install/01_build-from-source/01_shell-scripts/02_build-eosio-binaries.md deleted file mode 100644 index 9f550793ad..0000000000 --- a/docs/00_install/01_build-from-source/01_shell-scripts/02_build-eosio-binaries.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -content_title: Build EOSIO Binaries ---- - -[[info | Shell Scripts]] -| The build script is one of various automated shell scripts provided in the EOSIO repository for building, installing, and optionally uninstalling the EOSIO software and its dependencies. They are available in the `eos/scripts` folder. - -The build script first installs all dependencies and then builds EOSIO. The script supports these [Operating Systems](../../index.md#supported-operating-systems). To run it, first change to the `~/eosio/eos` folder, then launch the script: - -```sh -cd ~/eosio/eos -./scripts/eosio_build.sh -``` - -The build process writes temporary content to the `eos/build` folder. After building, the program binaries can be found at `eos/build/programs`. - -[[info | What's Next?]] -| [Installing EOSIO](03_install-eosio-binaries.md) is strongly recommended after building from source as it makes local development significantly more friendly. diff --git a/docs/00_install/01_build-from-source/01_shell-scripts/03_install-eosio-binaries.md b/docs/00_install/01_build-from-source/01_shell-scripts/03_install-eosio-binaries.md deleted file mode 100644 index dfc8e8d9d1..0000000000 --- a/docs/00_install/01_build-from-source/01_shell-scripts/03_install-eosio-binaries.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -content_title: Install EOSIO Binaries ---- - -## EOSIO install script - -For ease of contract development, content can be installed at the `/usr/local` folder using the `eosio_install.sh` script within the `eos/scripts` folder. Adequate permission is required to install on system folders: - -```sh -cd ~/eosio/eos -./scripts/eosio_install.sh -``` - -## EOSIO manual install - -In lieu of the `eosio_install.sh` script, you can install the EOSIO binaries directly by invoking `make install` within the `eos/build` folder. Again, adequate permission is required to install on system folders: - -```sh -cd ~/eosio/eos/build -make install -``` - -[[info | What's Next?]] -| Configure and use [Nodeos](../../../01_nodeos/index.md), or optionally [Test the EOSIO binaries](04_test-eosio-binaries.md). diff --git a/docs/00_install/01_build-from-source/01_shell-scripts/04_test-eosio-binaries.md b/docs/00_install/01_build-from-source/01_shell-scripts/04_test-eosio-binaries.md deleted file mode 100644 index 3a34bf8cee..0000000000 --- a/docs/00_install/01_build-from-source/01_shell-scripts/04_test-eosio-binaries.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -content_title: Test EOSIO Binaries ---- - -Optionally, a set of tests can be run against your build to perform some basic validation of the EOSIO software installation. - -To run the test suite after building, run: - -```sh -cd ~/eosio/eos/build -make test -``` - -[[info | What's Next?]] -| Configure and use [Nodeos](../../../01_nodeos/index.md). diff --git a/docs/00_install/01_build-from-source/01_shell-scripts/05_uninstall-eosio.md b/docs/00_install/01_build-from-source/01_shell-scripts/05_uninstall-eosio.md deleted file mode 100644 index 7b8ca8e831..0000000000 --- a/docs/00_install/01_build-from-source/01_shell-scripts/05_uninstall-eosio.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -content_title: Uninstall EOSIO ---- - -If you have previously built EOSIO from source and now wish to install the prebuilt binaries, or to build from source again, it is recommended to run the `eosio_uninstall.sh` script within the `eos/scripts` folder: - -```sh -cd ~/eosio/eos -./scripts/eosio_uninstall.sh -``` - -[[info | Uninstall Dependencies]] -| The uninstall script will also prompt the user to uninstall EOSIO dependencies. This is recommended if installing prebuilt EOSIO binaries or building EOSIO for the first time. diff --git a/docs/00_install/01_build-from-source/01_shell-scripts/index.md b/docs/00_install/01_build-from-source/01_shell-scripts/index.md deleted file mode 100644 index 6e1f1ffbbe..0000000000 --- a/docs/00_install/01_build-from-source/01_shell-scripts/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -content_title: Shell Scripts ---- - -[[info | Did you know?]] -| Shell scripts automate the process of building, installing, testing, and uninstalling the EOSIO software and dependencies. - -To build EOSIO from the source code using shell scripts, visit the sections below: - -1. [Download EOSIO Source](01_download-eosio-source.md) -2. [Build EOSIO Binaries](02_build-eosio-binaries.md) -3. [Install EOSIO Binaries](03_install-eosio-binaries.md) -4. [Test EOSIO Binaries](04_test-eosio-binaries.md) -5. [Uninstall EOSIO](05_uninstall-eosio.md) - -[[info | Building EOSIO is for Advanced Developers]] -| If you are new to EOSIO, it is recommended that you install the [EOSIO Prebuilt Binaries](../../00_install-prebuilt-binaries.md) instead of building from source. diff --git a/docs/00_install/01_build-from-source/02_manual-build/00_eosio-dependencies.md b/docs/00_install/01_build-from-source/02_manual-build/00_eosio-dependencies.md deleted file mode 100644 index fa119af890..0000000000 --- a/docs/00_install/01_build-from-source/02_manual-build/00_eosio-dependencies.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -content_title: EOSIO Software Dependencies ---- - -The EOSIO software requires specific software dependencies to build the EOSIO binaries. These dependencies can be built from source or installed from binaries directly. Dependencies can be pinned to a specific version release or unpinned to the current version, usually the latest one. The main EOSIO dependencies hosted outside the EOSIO repos are: - -* Clang - the C++17 compliant compiler used by EOSIO -* CMake - the build system used by EOSIO -* Boost - the C++ Boost library used by EOSIO -* OpenSSL - the secure communications (and crypto) library -* LLVM - the LLVM compiler/toolchain infrastructure - -Other dependencies are either inside the EOSIO repo, such as the `secp256k1` elliptic curve DSA library, or they are otherwise used for testing or housekeeping purposes, such as: - -* automake, autoconf, autotools -* doxygen, graphviz -* python2, python3 -* bzip2, zlib -* etc. - -## Pinned Dependencies - -To guarantee interoperability across different EOSIO software releases, developers may opt to reproduce the exact "pinned" dependency binaries used in-house. Block producers may want to install and run the EOSIO software built with these pinned dependencies for portability and stability reasons. Pinned dependencies are usually built from source. - -## Unpinned Dependencies - -Regular users or application developers may prefer installing unpinned versions of the EOSIO dependencies. These correspond to the latest or otherwise stable versions of the dependencies. The main advantage of unpinned dependencies is reduced installation times and perhaps better performance. Pinned dependencies are typically installed from binaries. - -## Automatic Installation of Dependencies - -EOSIO dependencies can be built or installed automatically from the [Build Script](../01_shell-scripts/02_build-eosio-binaries.md) when building EOSIO from source. To build the pinned dependencies, the optional `-P` parameter can be specified when invoking the script. Otherwise, the unpinned dependencies will be installed instead, with the exception of `boost` and `cmake` which are always pinned: - -```sh -cd ~/eosio/eos -./scripts/eosio_build.sh [-P] -``` - -### Unupported Platforms - -EOSIO dependencies can also be built and installed manually by reproducing the same commands invoked by the [Build Script](../01_shell-scripts/02_build-eosio-binaries.md). The actual commands can be generated from the script directly by exporting specific environment variables and CLI parameters to the script when invoked: - -```sh -cd ~/eosio/eos -export VERBOSE=true && export DRYRUN=true && ./scripts/eosio_build.sh -y [-P] -``` diff --git a/docs/00_install/01_build-from-source/02_manual-build/03_platforms/amazon_linux-2.md b/docs/00_install/01_build-from-source/02_manual-build/03_platforms/amazon_linux-2.md deleted file mode 100644 index 21d69ed950..0000000000 --- a/docs/00_install/01_build-from-source/02_manual-build/03_platforms/amazon_linux-2.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -content_title: Amazon Linux 2 ---- - -This section contains shell commands to manually download, build, install, test, and uninstall EOSIO and dependencies on Amazon Linux 2. - -[[info | Building EOSIO is for Advanced Developers]] -| If you are new to EOSIO, it is recommended that you install the [EOSIO Prebuilt Binaries](../../../00_install-prebuilt-binaries.md) instead of building from source. - -Select a task below, then copy/paste the shell commands to a Unix terminal to execute: - -* [Download EOSIO Repository](#download-eosio-repository) -* [Install EOSIO Dependencies](#install-eosio-dependencies) -* [Build EOSIO](#build-eosio) -* [Install EOSIO](#install-eosio) -* [Test EOSIO](#test-eosio) -* [Uninstall EOSIO](#uninstall-eosio) - -[[info | Building EOSIO on another OS?]] -| Visit the [Build EOSIO from Source](../../index.md) section. - -## Download EOSIO Repository -These commands set the EOSIO directories, install git, and clone the EOSIO repository. -```sh -# set EOSIO directories -export EOSIO_LOCATION=~/eosio/eos -export EOSIO_INSTALL_LOCATION=$EOSIO_LOCATION/../install -mkdir -p $EOSIO_INSTALL_LOCATION -# install git -yum update -y && yum install -y git -# clone EOSIO repository -git clone https://github.com/EOSIO/eos.git $EOSIO_LOCATION -cd $EOSIO_LOCATION && git submodule update --init --recursive -``` - -## Install EOSIO Dependencies -These commands install the EOSIO software dependencies. Make sure to [Download the EOSIO Repository](#download-eosio-repository) first and set the EOSIO directories. -```sh -# install dependencies -yum install -y which sudo procps-ng util-linux autoconf automake \ - libtool make bzip2 bzip2-devel openssl-devel gmp-devel libstdc++ libcurl-devel \ - libusbx-devel python3 python3-devel python-devel libedit-devel doxygen \ - graphviz clang patch llvm-devel llvm-static vim-common jq -# build cmake -export PATH=$EOSIO_INSTALL_LOCATION/bin:$PATH -cd $EOSIO_INSTALL_LOCATION && curl -LO https://cmake.org/files/v3.13/cmake-3.13.2.tar.gz && \ - tar -xzf cmake-3.13.2.tar.gz && \ - cd cmake-3.13.2 && \ - ./bootstrap --prefix=$EOSIO_INSTALL_LOCATION && \ - make -j$(nproc) && \ - make install && \ - rm -rf $EOSIO_INSTALL_LOCATION/cmake-3.13.2.tar.gz $EOSIO_INSTALL_LOCATION/cmake-3.13.2 -# build boost -cd $EOSIO_INSTALL_LOCATION && curl -LO https://boostorg.jfrog.io/artifactory/main/release/1.71.0/source/boost_1_71_0.tar.bz2 && \ - tar -xjf boost_1_71_0.tar.bz2 && \ - cd boost_1_71_0 && \ - ./bootstrap.sh --prefix=$EOSIO_INSTALL_LOCATION && \ - ./b2 --with-iostreams --with-date_time --with-filesystem --with-system --with-program_options --with-chrono --with-test -q -j$(nproc) install && \ - rm -rf $EOSIO_INSTALL_LOCATION/boost_1_71_0.tar.bz2 $EOSIO_INSTALL_LOCATION/boost_1_71_0 -``` - -## Build EOSIO -These commands build the EOSIO software on the specified OS. Make sure to [Install EOSIO Dependencies](#install-eosio-dependencies) first. - -[[caution | `EOSIO_BUILD_LOCATION` environment variable]] -| Do NOT change this variable. It is set for convenience only. It should always be set to the `build` folder within the cloned repository. - -```sh -export EOSIO_BUILD_LOCATION=$EOSIO_LOCATION/build -mkdir -p $EOSIO_BUILD_LOCATION -cd $EOSIO_BUILD_LOCATION && $EOSIO_INSTALL_LOCATION/bin/cmake -DCMAKE_BUILD_TYPE='Release' -DCMAKE_CXX_COMPILER='clang++' -DCMAKE_C_COMPILER='clang' -DCMAKE_INSTALL_PREFIX=$EOSIO_INSTALL_LOCATION $EOSIO_LOCATION -cd $EOSIO_BUILD_LOCATION && make -j$(nproc) -``` - -## Install EOSIO -This command installs the EOSIO software on the specified OS. Make sure to [Build EOSIO](#build-eosio) first. -```sh -cd $EOSIO_BUILD_LOCATION && make install -``` - -## Test EOSIO -These commands validate the EOSIO software installation on the specified OS. This task is optional but recommended. Make sure to [Install EOSIO](#install-eosio) first. -```sh -cd $EOSIO_BUILD_LOCATION && make test -``` - -## Uninstall EOSIO -These commands uninstall the EOSIO software from the specified OS. -```sh -xargs rm < $EOSIO_BUILD_LOCATION/install_manifest.txt -rm -rf $EOSIO_BUILD_LOCATION -``` diff --git a/docs/00_install/01_build-from-source/02_manual-build/03_platforms/centos-7.7.md b/docs/00_install/01_build-from-source/02_manual-build/03_platforms/centos-7.7.md deleted file mode 100644 index 8a7fdbd5ae..0000000000 --- a/docs/00_install/01_build-from-source/02_manual-build/03_platforms/centos-7.7.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -content_title: Centos 7.7 ---- - -This section contains shell commands to manually download, build, install, test, and uninstall EOSIO and dependencies on Centos 7.7. - -[[info | Building EOSIO is for Advanced Developers]] -| If you are new to EOSIO, it is recommended that you install the [EOSIO Prebuilt Binaries](../../../00_install-prebuilt-binaries.md) instead of building from source. - -Select a task below, then copy/paste the shell commands to a Unix terminal to execute: - -* [Download EOSIO Repository](#download-eosio-repository) -* [Install EOSIO Dependencies](#install-eosio-dependencies) -* [Build EOSIO](#build-eosio) -* [Install EOSIO](#install-eosio) -* [Test EOSIO](#test-eosio) -* [Uninstall EOSIO](#uninstall-eosio) - -[[info | Building EOSIO on another OS?]] -| Visit the [Build EOSIO from Source](../../index.md) section. - -## Download EOSIO Repository -These commands set the EOSIO directories, install git, and clone the EOSIO repository. -```sh -# set EOSIO directories -export EOSIO_LOCATION=~/eosio/eos -export EOSIO_INSTALL_LOCATION=$EOSIO_LOCATION/../install -mkdir -p $EOSIO_INSTALL_LOCATION -# install git -yum update -y && yum install -y git -# clone EOSIO repository -git clone https://github.com/EOSIO/eos.git $EOSIO_LOCATION -cd $EOSIO_LOCATION && git submodule update --init --recursive -``` - -## Install EOSIO Dependencies -These commands install the EOSIO software dependencies. Make sure to [Download the EOSIO Repository](#download-eosio-repository) first and set the EOSIO directories. -```sh -# install dependencies -yum update -y && \ - yum install -y epel-release && \ - yum --enablerepo=extras install -y centos-release-scl && \ - yum --enablerepo=extras install -y devtoolset-8 && \ - yum --enablerepo=extras install -y which git autoconf automake libtool make bzip2 doxygen \ - graphviz bzip2-devel openssl-devel gmp-devel ocaml \ - python python-devel rh-python36 file libusbx-devel \ - libcurl-devel patch vim-common jq llvm-toolset-7.0-llvm-devel llvm-toolset-7.0-llvm-static -# build cmake -export PATH=$EOSIO_INSTALL_LOCATION/bin:$PATH -cd $EOSIO_INSTALL_LOCATION && curl -LO https://cmake.org/files/v3.13/cmake-3.13.2.tar.gz && \ - source /opt/rh/devtoolset-8/enable && \ - tar -xzf cmake-3.13.2.tar.gz && \ - cd cmake-3.13.2 && \ - ./bootstrap --prefix=$EOSIO_INSTALL_LOCATION && \ - make -j$(nproc) && \ - make install && \ - rm -rf $EOSIO_INSTALL_LOCATION/cmake-3.13.2.tar.gz $EOSIO_INSTALL_LOCATION/cmake-3.13.2 -# apply clang patch -cp -f $EOSIO_LOCATION/scripts/clang-devtoolset8-support.patch /tmp/clang-devtoolset8-support.patch -# build boost -cd $EOSIO_INSTALL_LOCATION && curl -LO https://boostorg.jfrog.io/artifactory/main/release/1.71.0/source/boost_1_71_0.tar.bz2 && \ - source /opt/rh/devtoolset-8/enable && \ - tar -xjf boost_1_71_0.tar.bz2 && \ - cd boost_1_71_0 && \ - ./bootstrap.sh --prefix=$EOSIO_INSTALL_LOCATION && \ - ./b2 --with-iostreams --with-date_time --with-filesystem --with-system --with-program_options --with-chrono --with-test -q -j$(nproc) install && \ - rm -rf $EOSIO_INSTALL_LOCATION/boost_1_71_0.tar.bz2 $EOSIO_INSTALL_LOCATION/boost_1_71_0 -``` - -## Build EOSIO -These commands build the EOSIO software on the specified OS. Make sure to [Install EOSIO Dependencies](#install-eosio-dependencies) first. - -[[caution | `EOSIO_BUILD_LOCATION` environment variable]] -| Do NOT change this variable. It is set for convenience only. It should always be set to the `build` folder within the cloned repository. - -```sh -export EOSIO_BUILD_LOCATION=$EOSIO_LOCATION/build -mkdir -p $EOSIO_BUILD_LOCATION -cd $EOSIO_BUILD_LOCATION && source /opt/rh/devtoolset-8/enable && cmake -DCMAKE_BUILD_TYPE='Release' -DLLVM_DIR='/opt/rh/llvm-toolset-7.0/root/usr/lib64/cmake/llvm' -DCMAKE_INSTALL_PREFIX=$EOSIO_INSTALL_LOCATION $EOSIO_LOCATION -cd $EOSIO_BUILD_LOCATION && make -j$(nproc) -``` - -## Install EOSIO -This command installs the EOSIO software on the specified OS. Make sure to [Build EOSIO](#build-eosio) first. -```sh -cd $EOSIO_BUILD_LOCATION && make install -``` - -## Test EOSIO -These commands validate the EOSIO software installation on the specified OS. This task is optional but recommended. Make sure to [Install EOSIO](#install-eosio) first. -```sh -cd $EOSIO_BUILD_LOCATION && source /opt/rh/rh-python36/enable && make test -``` - -## Uninstall EOSIO -These commands uninstall the EOSIO software from the specified OS. -```sh -xargs rm < $EOSIO_BUILD_LOCATION/install_manifest.txt -rm -rf $EOSIO_BUILD_LOCATION -``` diff --git a/docs/00_install/01_build-from-source/02_manual-build/03_platforms/index.md b/docs/00_install/01_build-from-source/02_manual-build/03_platforms/index.md deleted file mode 100644 index 4058c091e5..0000000000 --- a/docs/00_install/01_build-from-source/02_manual-build/03_platforms/index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -content_title: Platforms ---- - -* [Amazon Linux 2](amazon_linux-2.md) -* [CentOS 7.7](centos-7.7.md) -* [MacOS 10.14](macos-10.14.md) -* [Ubuntu 18.04](ubuntu-18.04.md) diff --git a/docs/00_install/01_build-from-source/02_manual-build/03_platforms/macos-10.14.md b/docs/00_install/01_build-from-source/02_manual-build/03_platforms/macos-10.14.md deleted file mode 100644 index 15e58cc106..0000000000 --- a/docs/00_install/01_build-from-source/02_manual-build/03_platforms/macos-10.14.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -content_title: MacOS 10.14 ---- - -This section contains shell commands to manually download, build, install, test, and uninstall EOSIO and dependencies on MacOS 10.14. - -[[info | Building EOSIO is for Advanced Developers]] -| If you are new to EOSIO, it is recommended that you install the [EOSIO Prebuilt Binaries](../../../00_install-prebuilt-binaries.md) instead of building from source. - -Select a task below, then copy/paste the shell commands to a Unix terminal to execute: - -* [Download EOSIO Repository](#download-eosio-repository) -* [Install EOSIO Dependencies](#install-eosio-dependencies) -* [Build EOSIO](#build-eosio) -* [Install EOSIO](#install-eosio) -* [Test EOSIO](#test-eosio) -* [Uninstall EOSIO](#uninstall-eosio) - -[[info | Building EOSIO on another OS?]] -| Visit the [Build EOSIO from Source](../../index.md) section. - -## Download EOSIO Repository -These commands set the EOSIO directories, install git, and clone the EOSIO repository. -```sh -# set EOSIO directories -export EOSIO_LOCATION=~/eosio/eos -export EOSIO_INSTALL_LOCATION=$EOSIO_LOCATION/../install -mkdir -p $EOSIO_INSTALL_LOCATION -# install git -brew update && brew install git -# clone EOSIO repository -git clone https://github.com/EOSIO/eos.git $EOSIO_LOCATION -cd $EOSIO_LOCATION && git submodule update --init --recursive -``` - -## Install EOSIO Dependencies -These commands install the EOSIO software dependencies. Make sure to [Download the EOSIO Repository](#download-eosio-repository) first and set the EOSIO directories. -```sh -# install dependencies -brew install cmake python libtool libusb graphviz automake wget gmp pkgconfig doxygen openssl@1.1 jq boost || : -export PATH=$EOSIO_INSTALL_LOCATION/bin:$PATH -``` - -## Build EOSIO -These commands build the EOSIO software on the specified OS. Make sure to [Install EOSIO Dependencies](#install-eosio-dependencies) first. - -[[caution | `EOSIO_BUILD_LOCATION` environment variable]] -| Do NOT change this variable. It is set for convenience only. It should always be set to the `build` folder within the cloned repository. - -```sh -export EOSIO_BUILD_LOCATION=$EOSIO_LOCATION/build -mkdir -p $EOSIO_BUILD_LOCATION -cd $EOSIO_BUILD_LOCATION && cmake -DCMAKE_BUILD_TYPE='Release' -DCMAKE_INSTALL_PREFIX=$EOSIO_INSTALL_LOCATION $EOSIO_LOCATION -cd $EOSIO_BUILD_LOCATION && make -j$(getconf _NPROCESSORS_ONLN) -``` - -## Install EOSIO -This command installs the EOSIO software on the specified OS. Make sure to [Build EOSIO](#build-eosio) first. -```sh -cd $EOSIO_BUILD_LOCATION && make install -``` - -## Test EOSIO -These commands validate the EOSIO software installation on the specified OS. This task is optional but recommended. Make sure to [Install EOSIO](#install-eosio) first. -```sh -cd $EOSIO_BUILD_LOCATION && make test -``` - -## Uninstall EOSIO -These commands uninstall the EOSIO software from the specified OS. -```sh -xargs rm < $EOSIO_BUILD_LOCATION/install_manifest.txt -rm -rf $EOSIO_BUILD_LOCATION -``` diff --git a/docs/00_install/01_build-from-source/02_manual-build/03_platforms/ubuntu-18.04.md b/docs/00_install/01_build-from-source/02_manual-build/03_platforms/ubuntu-18.04.md deleted file mode 100644 index 49717b5f10..0000000000 --- a/docs/00_install/01_build-from-source/02_manual-build/03_platforms/ubuntu-18.04.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -content_title: Ubuntu 18.04 ---- - -This section contains shell commands to manually download, build, install, test, and uninstall EOSIO and dependencies on Ubuntu 18.04. - -[[info | Building EOSIO is for Advanced Developers]] -| If you are new to EOSIO, it is recommended that you install the [EOSIO Prebuilt Binaries](../../../00_install-prebuilt-binaries.md) instead of building from source. - -Select a task below, then copy/paste the shell commands to a Unix terminal to execute: - -* [Download EOSIO Repository](#download-eosio-repository) -* [Install EOSIO Dependencies](#install-eosio-dependencies) -* [Build EOSIO](#build-eosio) -* [Install EOSIO](#install-eosio) -* [Test EOSIO](#test-eosio) -* [Uninstall EOSIO](#uninstall-eosio) - -[[info | Building EOSIO on another OS?]] -| Visit the [Build EOSIO from Source](../../index.md) section. - -## Download EOSIO Repository -These commands set the EOSIO directories, install git, and clone the EOSIO repository. -```sh -# set EOSIO directories -export EOSIO_LOCATION=~/eosio/eos -export EOSIO_INSTALL_LOCATION=$EOSIO_LOCATION/../install -mkdir -p $EOSIO_INSTALL_LOCATION -# install git -apt-get update && apt-get upgrade -y && DEBIAN_FRONTEND=noninteractive apt-get install -y git -# clone EOSIO repository -git clone https://github.com/EOSIO/eos.git $EOSIO_LOCATION -cd $EOSIO_LOCATION && git submodule update --init --recursive -``` - -## Install EOSIO Dependencies -These commands install the EOSIO software dependencies. Make sure to [Download the EOSIO Repository](#download-eosio-repository) first and set the EOSIO directories. -```sh -# install dependencies -apt-get install -y make bzip2 automake libbz2-dev libssl-dev doxygen graphviz libgmp3-dev \ - autotools-dev python2.7 python2.7-dev python3 python3-dev \ - autoconf libtool curl zlib1g-dev sudo ruby libusb-1.0-0-dev \ - libcurl4-gnutls-dev pkg-config patch llvm-7-dev clang-7 vim-common jq -# build cmake -export PATH=$EOSIO_INSTALL_LOCATION/bin:$PATH -cd $EOSIO_INSTALL_LOCATION && curl -LO https://cmake.org/files/v3.13/cmake-3.13.2.tar.gz && \ - tar -xzf cmake-3.13.2.tar.gz && \ - cd cmake-3.13.2 && \ - ./bootstrap --prefix=$EOSIO_INSTALL_LOCATION && \ - make -j$(nproc) && \ - make install && \ - rm -rf $EOSIO_INSTALL_LOCATION/cmake-3.13.2.tar.gz $EOSIO_INSTALL_LOCATION/cmake-3.13.2 -# build boost -cd $EOSIO_INSTALL_LOCATION && curl -LO https://boostorg.jfrog.io/artifactory/main/release/1.71.0/source/boost_1_71_0.tar.bz2 && \ - tar -xjf boost_1_71_0.tar.bz2 && \ - cd boost_1_71_0 && \ - ./bootstrap.sh --prefix=$EOSIO_INSTALL_LOCATION && \ - ./b2 --with-iostreams --with-date_time --with-filesystem --with-system --with-program_options --with-chrono --with-test -q -j$(nproc) install && \ - rm -rf $EOSIO_INSTALL_LOCATION/boost_1_71_0.tar.bz2 $EOSIO_INSTALL_LOCATION/boost_1_71_0 -``` - -## Build EOSIO -These commands build the EOSIO software on the specified OS. Make sure to [Install EOSIO Dependencies](#install-eosio-dependencies) first. - -[[caution | `EOSIO_BUILD_LOCATION` environment variable]] -| Do NOT change this variable. It is set for convenience only. It should always be set to the `build` folder within the cloned repository. - -```sh -export EOSIO_BUILD_LOCATION=$EOSIO_LOCATION/build -mkdir -p $EOSIO_BUILD_LOCATION -cd $EOSIO_BUILD_LOCATION && cmake -DCMAKE_BUILD_TYPE='Release' -DCMAKE_CXX_COMPILER='clang++-7' -DCMAKE_C_COMPILER='clang-7' -DLLVM_DIR='/usr/lib/llvm-7/lib/cmake/llvm' -DCMAKE_INSTALL_PREFIX=$EOSIO_INSTALL_LOCATION $EOSIO_LOCATION -cd $EOSIO_BUILD_LOCATION && make -j$(nproc) -``` - -## Install EOSIO -This command installs the EOSIO software on the specified OS. Make sure to [Build EOSIO](#build-eosio) first. -```sh -cd $EOSIO_BUILD_LOCATION && make install -``` - -## Test EOSIO -These commands validate the EOSIO software installation on the specified OS. Make sure to [Install EOSIO](#install-eosio) first. (**Note**: This task is optional but recommended.) -```sh -cd $EOSIO_BUILD_LOCATION && make test -``` - -## Uninstall EOSIO -These commands uninstall the EOSIO software from the specified OS. -```sh -xargs rm < $EOSIO_BUILD_LOCATION/install_manifest.txt -rm -rf $EOSIO_BUILD_LOCATION -``` diff --git a/docs/00_install/01_build-from-source/02_manual-build/index.md b/docs/00_install/01_build-from-source/02_manual-build/index.md deleted file mode 100644 index 0852795c3f..0000000000 --- a/docs/00_install/01_build-from-source/02_manual-build/index.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -content_title: EOSIO Manual Build ---- - -[[info | Manual Builds are for Advanced Developers]] -| These manual instructions are intended for advanced developers. The [Shell Scripts](../01_shell-scripts/index.md) should be the preferred method to build EOSIO from source. If the script fails or your platform is not supported, continue with the instructions below. - -## EOSIO Dependencies - -When performing a manual build, it is necessary to install specific software packages that the EOSIO software depends on. To learn more about these dependencies, visit the [EOSIO Software Dependencies](00_eosio-dependencies.md) section. - -## Platforms - -Shell commands are available to manually download, build, install, test, and uninstall the EOSIO software and dependencies for these [platforms](03_platforms/index.md). - -## Out-of-source Builds - -While building dependencies and EOSIO binaries, out-of-source builds are also supported. Refer to the `cmake` help for more information. - -## Other Compilers - -To override `clang`'s default compiler toolchain, add these flags to the `cmake` command within the above instructions: - -`-DCMAKE_CXX_COMPILER=/path/to/c++ -DCMAKE_C_COMPILER=/path/to/cc` - -## Debug Builds - -For a debug build, add `-DCMAKE_BUILD_TYPE=Debug`. Other common build types include `Release` and `RelWithDebInfo`. diff --git a/docs/00_install/01_build-from-source/index.md b/docs/00_install/01_build-from-source/index.md index 03f3db858f..7e9bdfbc44 100644 --- a/docs/00_install/01_build-from-source/index.md +++ b/docs/00_install/01_build-from-source/index.md @@ -1,14 +1,56 @@ --- -content_title: Build EOSIO from Source +content_title: Build Mandel from Source --- -[[info | Building EOSIO is for Advanced Developers]] -| If you are new to EOSIO, it is recommended that you install the [EOSIO Prebuilt Binaries](../00_install-prebuilt-binaries.md) instead of building from source. +The shell scripts previously recommended for building the software have been removed in favor of a build process entirely driven by CMake. Those wishing to build from source are now responsible for installing the necessary dependencies. The list of dependencies and the recommended build procedure are in the README.md file. Instructions are also included for efficiently running the tests. -EOSIO can be built on several platforms using different build methods. Advanced users may opt to build EOSIO using our shell scripts. Node operators or block producers who wish to deploy a public node, may prefer our manual build instructions. +## Building Mandel -* [Shell Scripts](01_shell-scripts/index.md) - Suitable for the majority of developers, these scripts build on Mac OS and many flavors of Linux. -* [Manual Build](02_manual-build/index.md) - Suitable for those platforms that may be hostile to the shell scripts or for operators who need more control over their builds. +``` +git submodule update --init --recursive +mkdir build +cd build +cmake -DCMAKE_BUILD_TYPE=Release .. +make -j $(nproc) +``` -[[info | EOSIO Installation Recommended]] -| After building EOSIO successfully, it is highly recommended to install the EOSIO binaries from their default build directory. This copies the EOSIO binaries to a central location, such as `/usr/local/bin`, or `~/eosio/x.y/bin`, where `x.y` is the EOSIO release version. +We support the following CMake options: +``` +-DCMAKE_CXX_COMPILER_LAUNCHER=ccache Speed up builds +-DCMAKE_C_COMPILER_LAUNCHER=ccache Speed up builds +-DCMAKE_BUILD_TYPE=DEBUG Debug builds +-DDISABLE_WASM_SPEC_TESTS=yes Speed up builds and skip many tests +-DCMAKE_INSTALL_PREFIX=/foo/bar Where to install to +-DENABLE_OC=no Disable OC support; useful when this repo is used + as a library +-GNinja Use ninja instead of make + (faster on high-core-count machines) +``` + +I highly recommend the ccache options. They don't speed up the first clean build, but they speed up future clean builds after the first build. + +### Running tests + +``` +cd build + +# Runs parallelizable tests in parallel. This runs much faster when +# -DDISABLE_WASM_SPEC_TESTS=yes is used. +ctest -j $(nproc) -LE "nonparallelizable_tests|long_running_tests" -E "full-version-label-test|release-build-test|print-build-info-test" + +# These tests can't run in parallel. +ctest -L "nonparallelizable_tests" + +# These tests can't run in parallel. They also take a long time to run. +ctest -L "long_running_tests" +``` + +## Other Compilers + +To override `clang`'s default compiler toolchain, add these flags to the `cmake` command within the above instructions: + +`-DCMAKE_CXX_COMPILER=/path/to/c++ -DCMAKE_C_COMPILER=/path/to/cc` + +## Debug Builds + +For a debug build, add `-DCMAKE_BUILD_TYPE=Debug`. Other common build types include `Release` and `RelWithDebInfo`. diff --git a/docs/00_install/index.md b/docs/00_install/index.md index 3153b2547c..7ed71bdcdb 100644 --- a/docs/00_install/index.md +++ b/docs/00_install/index.md @@ -1,24 +1,18 @@ --- -content_title: EOSIO Software Installation +content_title: Mandel Software Installation --- -There are various ways to install and use the EOSIO software: +The best way to install and use the Mandel software is to build it from source: -* [Install EOSIO Prebuilt Binaries](00_install-prebuilt-binaries.md) -* [Build EOSIO from Source](01_build-from-source/index.md) - -[[info]] -| If you are new to EOSIO, it is recommended that you install the [EOSIO Prebuilt Binaries](00_install-prebuilt-binaries.md), then proceed to the [Getting Started](https://developers.eos.io/eosio-home/docs/) section of the [EOSIO Developer Portal](https://developers.eos.io/). If you are an advanced developer, a block producer, or no binaries are available for your platform, you may need to [Build EOSIO from source](01_build-from-source/index.md) instead. +* [Build Mandel from Source](01_build-from-source/index.md) ## Supported Operating Systems -EOSIO currently supports the following operating systems: +Mandel currently supports the following operating systems: -1. Amazon Linux 2 -2. CentOS 7 -3. Ubuntu 16.04 -4. Ubuntu 18.04 -5. MacOS 10.14 (Mojave) +1. Ubuntu 18.04 +2. Ubuntu 20.04 +3. Ubuntu 22.04 [[info | Note]] -| It may be possible to install EOSIO on other Unix-based operating systems. This is not officially supported, though. +| It may be possible to install Mandel on other Unix-based operating systems. This is not officially supported, though. diff --git a/docs/01_nodeos/02_usage/02_node-setups/00_producing-node.md b/docs/01_nodeos/02_usage/02_node-setups/00_producing-node.md index f9555ba262..d6950fc4c7 100644 --- a/docs/01_nodeos/02_usage/02_node-setups/00_producing-node.md +++ b/docs/01_nodeos/02_usage/02_node-setups/00_producing-node.md @@ -7,12 +7,12 @@ content_title: Producing Node Setup ## Goal -This section describes how to set up a producing node within the EOSIO network. A producing node, as its name implies, is a node that is configured to produce blocks in an `EOSIO` based blockchain. This functionality if provided through the `producer_plugin` as well as other [Nodeos Plugins](../../03_plugins/index.md). +This section describes how to set up a producing node within the Mandel network. A producing node, as its name implies, is a node that is configured to produce blocks in an `Mandel` based blockchain. This functionality if provided through the `producer_plugin` as well as other [Nodeos Plugins](../../03_plugins/index.md). ## Before you begin -* [Install the EOSIO software](../../../00_install/index.md) before starting this section. -* It is assumed that `nodeos`, `cleos`, and `keosd` are accessible through the path. If you built EOSIO using shell scripts, make sure to run the [Install Script](../../../00_install/01_build-from-source/01_shell-scripts/03_install-eosio-binaries.md). +* [Install the Mandel software](../../../00_install/index.md) before starting this section. +* It is assumed that `nodeos`, `cleos`, and `keosd` are accessible through the path. If you built Mandel using shell scripts, make sure to run the [Install Script](../../../00_install/01_build-from-source/01_shell-scripts/03_install-eosio-binaries.md). * Know how to pass [Nodeos options](../../02_usage/00_nodeos-options.md) to enable or disable functionality. ## Steps @@ -49,7 +49,7 @@ producer-name = youraccount You will need to set the private key for your producer. The public key should have an authority for the producer account defined above. `signature-provider` is defined with a 3-field tuple: -* `public-key` - A valid EOSIO public key in form of a string. +* `public-key` - A valid Mandel public key in form of a string. * `provider-spec` - It's a string formatted like : * `provider-type` - KEY or KEOSD diff --git a/docs/01_nodeos/02_usage/02_node-setups/01_non-producing-node.md b/docs/01_nodeos/02_usage/02_node-setups/01_non-producing-node.md index 77365ef18f..6ad52526e1 100644 --- a/docs/01_nodeos/02_usage/02_node-setups/01_non-producing-node.md +++ b/docs/01_nodeos/02_usage/02_node-setups/01_non-producing-node.md @@ -4,12 +4,12 @@ content_title: Non-producing Node Setup ## Goal -This section describes how to set up a non-producing node within the EOSIO network. A non-producing node is a node that is not configured to produce blocks, instead it is connected and synchronized with other peers from an `EOSIO` based blockchain, exposing one or more services publicly or privately by enabling one or more [Nodeos Plugins](../../03_plugins/index.md), except the `producer_plugin`. +This section describes how to set up a non-producing node within the Mandel network. A non-producing node is a node that is not configured to produce blocks, instead it is connected and synchronized with other peers from an `Mandel` based blockchain, exposing one or more services publicly or privately by enabling one or more [Nodeos Plugins](../../03_plugins/index.md), except the `producer_plugin`. ## Before you begin -* [Install the EOSIO software](../../../00_install/index.md) before starting this section. -* It is assumed that `nodeos`, `cleos`, and `keosd` are accessible through the path. If you built EOSIO using shell scripts, make sure to run the [Install Script](../../../00_install/01_build-from-source/01_shell-scripts/03_install-eosio-binaries.md). +* [Install the Mandel software](../../../00_install/index.md) before starting this section. +* It is assumed that `nodeos`, `cleos`, and `keosd` are accessible through the path. If you built Mandel using shell scripts, make sure to run the [Install Script](../../../00_install/01_build-from-source/01_shell-scripts/03_install-eosio-binaries.md). * Know how to pass [Nodeos options](../../02_usage/00_nodeos-options.md) to enable or disable functionality. ## Steps @@ -37,4 +37,4 @@ nodeos ... --p2p-peer-address=106.10.42.238:9876 ### 2. Enable one or more available plugins -Each available plugin is listed and detailed in the [Nodeos Plugins](../../03_plugins/index.md) section. When `nodeos` starts, it will expose the functionality provided by the enabled plugins it was started with. For example, if you start `nodeos` with [`state_history_plugin`](../../03_plugins/state_history_plugin/index.md) enabled, you will have a non-producing node that offers full blockchain history. If you start `nodeos` with [`http_plugin`](../../03_plugins/http_plugin/index.md) enabled, you will have a non-producing node which exposes the EOSIO RPC API. Therefore, you can extend the basic functionality provided by a non-producing node by enabling any number of existing plugins on top of it. Another aspect to consider is that some plugins have dependencies to other plugins. Therefore, you need to satisfy all dependencies for a plugin in order to enable it. +Each available plugin is listed and detailed in the [Nodeos Plugins](../../03_plugins/index.md) section. When `nodeos` starts, it will expose the functionality provided by the enabled plugins it was started with. For example, if you start `nodeos` with [`state_history_plugin`](../../03_plugins/state_history_plugin/index.md) enabled, you will have a non-producing node that offers full blockchain history. If you start `nodeos` with [`http_plugin`](../../03_plugins/http_plugin/index.md) enabled, you will have a non-producing node which exposes the Mandel RPC API. Therefore, you can extend the basic functionality provided by a non-producing node by enabling any number of existing plugins on top of it. Another aspect to consider is that some plugins have dependencies to other plugins. Therefore, you need to satisfy all dependencies for a plugin in order to enable it. diff --git a/docs/01_nodeos/02_usage/03_development-environment/00_local-single-node-testnet.md b/docs/01_nodeos/02_usage/03_development-environment/00_local-single-node-testnet.md index 53ca22048c..f1e7f8be2a 100644 --- a/docs/01_nodeos/02_usage/03_development-environment/00_local-single-node-testnet.md +++ b/docs/01_nodeos/02_usage/03_development-environment/00_local-single-node-testnet.md @@ -12,8 +12,8 @@ This section describes how to set up a single-node blockchain configuration runn ## Before you begin -* [Install the EOSIO software](../../../00_install/index.md) before starting this section. -* It is assumed that `nodeos`, `cleos`, and `keosd` are accessible through the path. If you built EOSIO using shell scripts, make sure to run the [Install Script](../../../00_install/01_build-from-source/01_shell-scripts/03_install-eosio-binaries.md). +* [Install the Mandel software](../../../00_install/index.md) before starting this section. +* It is assumed that `nodeos`, `cleos`, and `keosd` are accessible through the path. If you built Mandel using shell scripts, make sure to run the [Install Script](../../../00_install/01_build-from-source/01_shell-scripts/03_install-eosio-binaries.md). * Know how to pass [Nodeos options](../../02_usage/00_nodeos-options.md) to enable or disable functionality. ## Steps diff --git a/docs/01_nodeos/02_usage/03_development-environment/01_local-multi-node-testnet.md b/docs/01_nodeos/02_usage/03_development-environment/01_local-multi-node-testnet.md index 7f94e88b81..2794ad9c79 100644 --- a/docs/01_nodeos/02_usage/03_development-environment/01_local-multi-node-testnet.md +++ b/docs/01_nodeos/02_usage/03_development-environment/01_local-multi-node-testnet.md @@ -10,20 +10,23 @@ This section describes how to set up a multi-node blockchain configuration runni ## Before you begin -* [Install the EOSIO software](../../../00_install/index.md) before starting this section. -* It is assumed that `nodeos`, `cleos`, and `keosd` are accessible through the path. If you built EOSIO using shell scripts, make sure to run the [Install Script](../../../00_install/01_build-from-source/01_shell-scripts/03_install-eosio-binaries.md). +* [Install the Mandel software](../../../00_install/index.md) before starting this section. +* It is assumed that `nodeos`, `cleos`, and `keosd` are accessible through the path. * Know how to pass [Nodeos options](../../02_usage/00_nodeos-options.md) to enable or disable functionality. ## Steps Open four "terminal" windows and perform the following steps: -1. [Start the Wallet Manager](#1-start-the-wallet-manager) -2. [Create a Default Wallet](#2-create-a-default-wallet) -3. [Loading the EOSIO Key](#3-loading-the-eosio-key) -4. [Start the First Producer Node](#4-start-the-first-producer-node) -5. [Start the Second Producer Node](#5-start-the-second-producer-node) -6. [Get Nodes Info](#6-get-nodes-info) +- [Goal](#goal) +- [Before you begin](#before-you-begin) +- [Steps](#steps) + - [1. Start the Wallet Manager](#1-start-the-wallet-manager) + - [2. Create a Default Wallet](#2-create-a-default-wallet) + - [3. Loading the Mandel Key](#3-loading-the-mandel-key) + - [4. Start the First Producer Node](#4-start-the-first-producer-node) + - [5. Start the Second Producer Node](#5-start-the-second-producer-node) + - [6. Get Nodes Info](#6-get-nodes-info) ### 1. Start the Wallet Manager @@ -66,7 +69,7 @@ Without password imported keys will not be retrievable. `keosd` will generate some status output in its window. We will continue to use this second window for subsequent `cleos` commands. -### 3. Loading the EOSIO Key +### 3. Loading the Mandel Key The private blockchain launched in the steps above is created with a default initial key which must be loaded into the wallet. @@ -90,7 +93,7 @@ This creates a special producer, known as the "bios" producer. Assuming everythi ### 5. Start the Second Producer Node -The following commands assume that you are running this tutorial from the `eos\build` directory, from which you ran `./eosio_build.sh` to build the EOSIO binaries. +The following commands assume that you are running this tutorial from the `eos\build` directory, from which you ran `./eosio_build.sh` to build the Mandel binaries. To start additional nodes, you must first load the `eosio.bios` contract. This contract enables you to have direct control over the resource allocation of other accounts and to access other privileged API calls. Return to the second terminal window and run the following command to load the contract: diff --git a/docs/01_nodeos/02_usage/03_development-environment/index.md b/docs/01_nodeos/02_usage/03_development-environment/index.md index f7cfa8f882..c09829aba9 100644 --- a/docs/01_nodeos/02_usage/03_development-environment/index.md +++ b/docs/01_nodeos/02_usage/03_development-environment/index.md @@ -15,17 +15,17 @@ This is the go-to option for smart contract developers, aspiring Block Producers While this option can technically be used for smart contract development, it may be overkill. This is most beneficial for those who are working on aspects of core development, such as benchmarking, optimization and experimentation. It's also a good option for hands-on learning and concept proofing. * [Configure Nodeos as a Local Two-Node Testnet](01_local-multi-node-testnet.md) -* [Configure Nodeos as a Local 21-Node Testnet](https://github.com/EOSIO/eos/blob/master/tutorials/bios-boot-tutorial/README.md) +* [Configure Nodeos as a Local 21-Node Testnet](https://github.com/eosnetworkfoundation/mandel/tree/main/tutorials/bios-boot-tutorial) ## Official Testnet -The official testnet is available for testing EOSIO dApps and smart contracts: +The official testnet is available for testing Mandel dApps and smart contracts: * [testnet.eos.io](https://testnet.eos.io/) ## Third-Party Testnets -The following third-party testnets are available for testing EOSIO dApps and smart contracts: +The following third-party testnets are available for testing Mandel dApps and smart contracts: * Jungle Testnet [monitor](https://monitor.jungletestnet.io/), [website](https://jungletestnet.io/) * [CryptoKylin Testnet](https://www.cryptokylin.io/) diff --git a/docs/01_nodeos/03_plugins/chain_plugin/index.md b/docs/01_nodeos/03_plugins/chain_plugin/index.md index 9da5921080..3815ef6346 100644 --- a/docs/01_nodeos/03_plugins/chain_plugin/index.md +++ b/docs/01_nodeos/03_plugins/chain_plugin/index.md @@ -1,6 +1,6 @@ ## Description -The `chain_plugin` is a core plugin required to process and aggregate chain data on an EOSIO node. +The `chain_plugin` is a core plugin required to process and aggregate chain data on a Mandel node. ## Usage diff --git a/docs/01_nodeos/03_plugins/login_plugin/index.md b/docs/01_nodeos/03_plugins/login_plugin/index.md index 68df9d4c1e..74d0b2a205 100644 --- a/docs/01_nodeos/03_plugins/login_plugin/index.md +++ b/docs/01_nodeos/03_plugins/login_plugin/index.md @@ -1,6 +1,6 @@ ## Description -The `login_plugin` supports the concept of applications authenticating with the EOSIO blockchain. The `login_plugin` API allows an application to verify whether an account is allowed to sign in order to satisfy a specified authority. +The `login_plugin` supports the concept of applications authenticating with the Mandel blockchain. The `login_plugin` API allows an application to verify whether an account is allowed to sign in order to satisfy a specified authority. ## Usage diff --git a/docs/01_nodeos/03_plugins/producer_plugin/index.md b/docs/01_nodeos/03_plugins/producer_plugin/index.md index 14b5be24ba..ac6475e761 100644 --- a/docs/01_nodeos/03_plugins/producer_plugin/index.md +++ b/docs/01_nodeos/03_plugins/producer_plugin/index.md @@ -49,7 +49,7 @@ Config Options for eosio::producer_plugin: = Where: is a string form of - a vaild EOSIO public + a vaild Mandel public key is a string in the @@ -59,7 +59,7 @@ Config Options for eosio::producer_plugin: is KEY, or KEOSD KEY: is a string form of - a valid EOSIO + a valid Mandel private key which maps to the provided public key diff --git a/docs/01_nodeos/03_plugins/state_history_plugin/10_how-to-fast-start-without-old-history.md b/docs/01_nodeos/03_plugins/state_history_plugin/10_how-to-fast-start-without-old-history.md index 4e1f534483..facd99cbac 100644 --- a/docs/01_nodeos/03_plugins/state_history_plugin/10_how-to-fast-start-without-old-history.md +++ b/docs/01_nodeos/03_plugins/state_history_plugin/10_how-to-fast-start-without-old-history.md @@ -8,7 +8,7 @@ This procedure records the current chain state and future history, without previ ## Before you begin -* Make sure [EOSIO is installed](../../../00_install/index.md). +* Make sure [Mandel is installed](../../../00_install/index.md). * Learn about [Using Nodeos](../../02_usage/index.md). * Get familiar with [state_history_plugin](../../03_plugins/state_history_plugin/index.md). diff --git a/docs/01_nodeos/03_plugins/state_history_plugin/20_how-to-replay-or-resync-with-full-history.md b/docs/01_nodeos/03_plugins/state_history_plugin/20_how-to-replay-or-resync-with-full-history.md index 9f0a7308f0..b1ada13126 100644 --- a/docs/01_nodeos/03_plugins/state_history_plugin/20_how-to-replay-or-resync-with-full-history.md +++ b/docs/01_nodeos/03_plugins/state_history_plugin/20_how-to-replay-or-resync-with-full-history.md @@ -8,7 +8,7 @@ This procedure records the entire chain history. ## Before you begin -* Make sure [EOSIO is installed](../../../00_install/index.md). +* Make sure [Mandel is installed](../../../00_install/index.md). * Learn about [Using Nodeos](../../02_usage/index.md). * Get familiar with [state_history_plugin](../../03_plugins/state_history_plugin/index.md). diff --git a/docs/01_nodeos/03_plugins/state_history_plugin/30_how-to-create-snapshot-with-full-history.md b/docs/01_nodeos/03_plugins/state_history_plugin/30_how-to-create-snapshot-with-full-history.md index 19d69e9c28..712b48c7a5 100644 --- a/docs/01_nodeos/03_plugins/state_history_plugin/30_how-to-create-snapshot-with-full-history.md +++ b/docs/01_nodeos/03_plugins/state_history_plugin/30_how-to-create-snapshot-with-full-history.md @@ -8,7 +8,7 @@ This procedure creates a database containing the chain state, with full history ## Before you begin -* Make sure [EOSIO is installed](../../../00_install/index.md). +* Make sure [Mandel is installed](../../../00_install/index.md). * Learn about [Using Nodeos](../../02_usage/index.md). * Get familiar with [state_history_plugin](../../03_plugins/state_history_plugin/index.md). diff --git a/docs/01_nodeos/03_plugins/state_history_plugin/40_how-to-restore-snapshot-with-full-history.md b/docs/01_nodeos/03_plugins/state_history_plugin/40_how-to-restore-snapshot-with-full-history.md index 6eb2e76db4..582ea6b6c2 100644 --- a/docs/01_nodeos/03_plugins/state_history_plugin/40_how-to-restore-snapshot-with-full-history.md +++ b/docs/01_nodeos/03_plugins/state_history_plugin/40_how-to-restore-snapshot-with-full-history.md @@ -8,7 +8,7 @@ This procedure restores an existing snapshot with full history, so the node can ## Before you begin -* Make sure [EOSIO is installed](../../../00_install/index.md). +* Make sure [Mandel is installed](../../../00_install/index.md). * Learn about [Using Nodeos](../../02_usage/index.md). * Get familiar with [state_history_plugin](../../03_plugins/state_history_plugin/index.md). diff --git a/docs/01_nodeos/03_plugins/state_history_plugin/index.md b/docs/01_nodeos/03_plugins/state_history_plugin/index.md index 4ee27384f5..44d8c40c27 100644 --- a/docs/01_nodeos/03_plugins/state_history_plugin/index.md +++ b/docs/01_nodeos/03_plugins/state_history_plugin/index.md @@ -48,11 +48,6 @@ Config Options for eosio::state_history_plugin: ## Examples -### history-tools - - * [Source code](https://github.com/EOSIO/history-tools/) - * [Documentation](https://eosio.github.io/history-tools/) - ## Dependencies * [`chain_plugin`](../chain_plugin/index.md) diff --git a/docs/01_nodeos/03_plugins/trace_api_plugin/index.md b/docs/01_nodeos/03_plugins/trace_api_plugin/index.md index 74d1215ec0..696a397709 100644 --- a/docs/01_nodeos/03_plugins/trace_api_plugin/index.md +++ b/docs/01_nodeos/03_plugins/trace_api_plugin/index.md @@ -5,11 +5,11 @@ The `trace_api_plugin` provides a consumer-focused long-term API for retrieving ## Purpose -While integrating applications such as block explorers and exchanges with an EOSIO blockchain, the user might require a complete transcript of actions processed by the blockchain, including those spawned from the execution of smart contracts and scheduled transactions. The `trace_api_plugin` serves this need. The purpose of the plugin is to provide: +While integrating applications such as block explorers and exchanges with a Mandel blockchain, the user might require a complete transcript of actions processed by the blockchain, including those spawned from the execution of smart contracts and scheduled transactions. The `trace_api_plugin` serves this need. The purpose of the plugin is to provide: * A transcript of retired actions and related metadata * A consumer-focused long-term API to retrieve blocks -* Maintainable resource commitments at the EOSIO nodes +* Maintainable resource commitments at the Mandel nodes Therefore, one crucial goal of the `trace_api_plugin` is to improve the maintenance of node resources (file system, disk space, memory used, etc.). This goal is different from the existing `history_plugin` which provides far more configurable filtering and querying capabilities, or the existing `state_history_plugin` which provides a binary streaming interface to access structural chain data, action data, as well as state deltas. @@ -101,7 +101,7 @@ nodeos ... --plugin eosio::chain_plugin [options] \ ## Configuration Example -Here is a `nodeos` configuration example for the `trace_api_plugin` when tracing some EOSIO reference contracts: +Here is a `nodeos` configuration example for the `trace_api_plugin` when tracing some Mandel reference contracts: ```sh nodeos --data-dir data_dir --config-dir config_dir --trace-dir traces_dir @@ -191,7 +191,7 @@ If resource usage cannot be effectively managed via the `trace-minimum-irreversi ## Manual Maintenance -The `trace-dir` option defines the directory on the filesystem where the trace log files are stored by the `trace_api_plugin`. These files are stable once the LIB block has progressed past a given slice and then can be deleted at any time to reclaim filesystem space. The deployed EOSIO system will tolerate any out-of-process management system that removes some or all of these files in this directory regardless of what data they represent, or whether there is a running `nodeos` instance accessing them or not. Data which would nominally be available, but is no longer so due to manual maintenance, will result in a HTTP 404 response from the appropriate API endpoint(s). +The `trace-dir` option defines the directory on the filesystem where the trace log files are stored by the `trace_api_plugin`. These files are stable once the LIB block has progressed past a given slice and then can be deleted at any time to reclaim filesystem space. The deployed Mandel system will tolerate any out-of-process management system that removes some or all of these files in this directory regardless of what data they represent, or whether there is a running `nodeos` instance accessing them or not. Data which would nominally be available, but is no longer so due to manual maintenance, will result in a HTTP 404 response from the appropriate API endpoint(s). [[info | For node operators]] | Node operators can take full control over the lifetime of the historical data available in their nodes via the `trace-api-plugin` and the `trace-minimum-irreversible-history-blocks` and `trace-minimum-uncompressed-irreversible-history-blocks` options in conjunction with any external filesystem resource manager. diff --git a/docs/01_nodeos/03_plugins/txn_test_gen_plugin/index.md b/docs/01_nodeos/03_plugins/txn_test_gen_plugin/index.md index bca53fba1c..9150e4fd1b 100644 --- a/docs/01_nodeos/03_plugins/txn_test_gen_plugin/index.md +++ b/docs/01_nodeos/03_plugins/txn_test_gen_plugin/index.md @@ -4,7 +4,7 @@ The `txn_test_gen_plugin` is used for transaction test purposes. [[info | For More Information]] -For more information, check the [txn_test_gen_plugin/README.md](https://github.com/EOSIO/eos/blob/develop/plugins/txn_test_gen_plugin/README.md) on the EOSIO/eos repository. +For more information, check the [txn_test_gen_plugin/README.md](https://github.com/eosnetworkfoundation/mandel/tree/main/plugins/txn_test_gen_plugin) on the Mandel/eos repository. ## Usage diff --git a/docs/01_nodeos/06_logging/index.md b/docs/01_nodeos/06_logging/index.md index 8a7670e7fb..0b1fdb8c7d 100644 --- a/docs/01_nodeos/06_logging/index.md +++ b/docs/01_nodeos/06_logging/index.md @@ -6,7 +6,7 @@ Logging for `nodeos` is controlled by the `logging.json` file. CLI options can b ## Appenders -The logging library built into EOSIO supports two appender types: +The logging library built into Mandel supports two appender types: - [Console](#console) - [GELF](#gelf) (Graylog Extended Log Format) @@ -74,7 +74,7 @@ Example: ## Loggers -The logging library built into EOSIO currently supports the following loggers: +The logging library built into Mandel currently supports the following loggers: - `default` - the default logger, always enabled. - `net_plugin_impl` - detailed logging for the net plugin. diff --git a/docs/01_nodeos/07_concepts/05_storage-and-read-modes.md b/docs/01_nodeos/07_concepts/05_storage-and-read-modes.md index df2a872729..b682285906 100644 --- a/docs/01_nodeos/07_concepts/05_storage-and-read-modes.md +++ b/docs/01_nodeos/07_concepts/05_storage-and-read-modes.md @@ -2,7 +2,7 @@ content_title: Storage and Read Modes --- -The EOSIO platform stores blockchain information in various data structures at various stages of a transaction's lifecycle. Some of these are described below. The producing node is the `nodeos` instance run by the block producer who is currently creating blocks for the blockchain (which changes every 6 seconds, producing 12 blocks in sequence before switching to another producer.) +The Mandel platform stores blockchain information in various data structures at various stages of a transaction's lifecycle. Some of these are described below. The producing node is the `nodeos` instance run by the block producer who is currently creating blocks for the blockchain (which changes every 6 seconds, producing 12 blocks in sequence before switching to another producer.) ## Blockchain State and Storage @@ -15,9 +15,9 @@ Every `nodeos` instance creates some internal files to housekeep the blockchain * The `pending block` is an in memory block containing transactions as they are processed and pushed into the block; this will/may eventually become the head block. If the `nodeos` instance is the producing node, the pending block is distributed to other `nodeos` instances. * Outside the chain state, block data is cached in RAM until it becomes final/irreversible; especifically the signed block itself. After the last irreversible block (LIB) catches up to the block, that block is then retrieved from the irreversible blocks log. -## EOSIO Interfaces +## Mandel Interfaces -EOSIO provides a set of [services](../../) and [interfaces](https://developers.eos.io/manuals/eosio.cdt/latest/files) that enable contract developers to persist state across action, and consequently transaction, boundaries. Contracts may use these services and interfaces for various purposes. For example, `eosio.token` contract keeps balances for all users in the chain database. Each instance of `nodeos` keeps the database in memory, so contracts can read and write data with ease. +Mandel provides a set of [services](../../) and [interfaces](https://developers.eos.io/manuals/eosio.cdt/latest/files) that enable contract developers to persist state across action, and consequently transaction, boundaries. Contracts may use these services and interfaces for various purposes. For example, `eosio.token` contract keeps balances for all users in the chain database. Each instance of `nodeos` keeps the database in memory, so contracts can read and write data with ease. ### Nodeos RPC API diff --git a/docs/01_nodeos/07_concepts/10_context-free-data/index.md b/docs/01_nodeos/07_concepts/10_context-free-data/index.md index 0a31072bcb..cb894d55ee 100644 --- a/docs/01_nodeos/07_concepts/10_context-free-data/index.md +++ b/docs/01_nodeos/07_concepts/10_context-free-data/index.md @@ -4,7 +4,7 @@ link_text: Context-Free Data --- ## Overview -The immutable nature of the blockchain allows data to be stored securely while also enforcing the integrity of such data. However, this benefit also complicates the removal of non-essential data from the blockchain. Consequently, EOSIO blockchains contain a special section within the transaction, called the *context-free data*. As its name implies, data stored in the context-free data section is considered free of previous contexts or dependencies, which makes their potential removal possible. More importantly, such removal can be performed safely without compromising the integrity of the blockchain. +The immutable nature of the blockchain allows data to be stored securely while also enforcing the integrity of such data. However, this benefit also complicates the removal of non-essential data from the blockchain. Consequently, Mandel blockchains contain a special section within the transaction, called the *context-free data*. As its name implies, data stored in the context-free data section is considered free of previous contexts or dependencies, which makes their potential removal possible. More importantly, such removal can be performed safely without compromising the integrity of the blockchain. ## Concept The goal of context-free data is to allow blockchain applications the option to store non-essential information within a transaction. Some examples of context-free data include: diff --git a/docs/01_nodeos/08_troubleshooting/index.md b/docs/01_nodeos/08_troubleshooting/index.md index 409ca6c371..be225e3070 100644 --- a/docs/01_nodeos/08_troubleshooting/index.md +++ b/docs/01_nodeos/08_troubleshooting/index.md @@ -28,7 +28,7 @@ Command Line Options for eosio::chain_plugin: Start `nodeos` with `--shared-memory-size-mb 1024`. A 1 GB shared memory file allows approximately half a million transactions. -### What version of EOSIO am I running/connecting to? +### What version of Mandel am I running/connecting to? If defaults can be used, then `cleos get info` will output a block that contains a field called `server_version`. If your `nodeos` is not using the defaults, then you need to know the URL of the `nodeos`. In that case, use the following with your `nodeos` URL: @@ -44,4 +44,4 @@ cleos --url http://localhost:8888 get info | grep server_version ### Error 3070000: WASM Exception Error -If you try to deploy the `eosio.bios` contract or `eosio.system` contract in an attempt to boot an EOSIO-based blockchain and you get the following error or similar: `Publishing contract... Error 3070000: WASM Exception Error Details: env.set_proposed_producers_ex unresolveable`, it is because you have to activate the `PREACTIVATE_FEATURE` protocol first. More details about it and how to enable it can be found in the [Bios Boot Sequence Tutorial](https://developers.eos.io/welcome/latest/tutorials/bios-boot-sequence/#112-set-the-eosiosystem-contract). For more information, you may also visit the [Nodeos Upgrade Guides](https://developers.eos.io/manuals/eos/latest/nodeos/upgrade-guides/). +If you try to deploy the `eosio.bios` contract or `eosio.system` contract in an attempt to boot a Mandel-based blockchain and you get the following error or similar: `Publishing contract... Error 3070000: WASM Exception Error Details: env.set_proposed_producers_ex unresolveable`, it is because you have to activate the `PREACTIVATE_FEATURE` protocol first. More details about it and how to enable it can be found in the [Bios Boot Sequence Tutorial](https://developers.eos.io/welcome/latest/tutorials/bios-boot-sequence/#112-set-the-eosiosystem-contract). For more information, you may also visit the [Nodeos Upgrade Guides](https://developers.eos.io/manuals/eos/latest/nodeos/upgrade-guides/). diff --git a/docs/01_nodeos/09_deprecation-notices.md b/docs/01_nodeos/09_deprecation-notices.md deleted file mode 100644 index ab7f356582..0000000000 --- a/docs/01_nodeos/09_deprecation-notices.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -link: https://github.com/EOSIO/eos/issues/7597 ---- diff --git a/docs/01_nodeos/index.md b/docs/01_nodeos/index.md index 7fac253202..21b8e045a1 100644 --- a/docs/01_nodeos/index.md +++ b/docs/01_nodeos/index.md @@ -4,11 +4,11 @@ content_title: Nodeos ## Introduction -`nodeos` is the core service daemon that runs on every EOSIO node. It can be configured to process smart contracts, validate transactions, produce blocks containing valid transactions, and confirm blocks to record them on the blockchain. +`nodeos` is the core service daemon that runs on every Mandel node. It can be configured to process smart contracts, validate transactions, produce blocks containing valid transactions, and confirm blocks to record them on the blockchain. ## Installation -`nodeos` is distributed as part of the [EOSIO software suite](https://github.com/EOSIO/eos/blob/master/README.md). To install `nodeos`, visit the [EOSIO Software Installation](../00_install/index.md) section. +`nodeos` is distributed as part of the [Mandel software suite](https://github.com/eosnetworkfoundation/mandel). To install `nodeos`, visit the [Mandel Software Installation](../00_install/index.md) section. ## Explore @@ -21,7 +21,6 @@ Navigate the sections below to configure and use `nodeos`. * [Logging](06_logging/index.md) - Logging config/usage, loggers, appenders, logging levels. * [Concepts](07_concepts/index.md) - `nodeos` concepts, explainers, implementation aspects. * [Troubleshooting](08_troubleshooting/index.md) - Common `nodeos` troubleshooting questions. -* [Deprecation Notices](https://github.com/EOSIO/eos/issues/7597) - Lists `nodeos` deprecated functionality. [[info | Access Node]] -| A local or remote EOSIO access node running `nodeos` is required for a client application or smart contract to interact with the blockchain. +| A local or remote Mandel access node running `nodeos` is required for a client application or smart contract to interact with the blockchain. diff --git a/docs/02_cleos/02_how-to-guides/how-to-create-a-wallet.md b/docs/02_cleos/02_how-to-guides/how-to-create-a-wallet.md index 4973217f16..f5a6528f0b 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-create-a-wallet.md +++ b/docs/02_cleos/02_how-to-guides/how-to-create-a-wallet.md @@ -11,7 +11,7 @@ Make sure you meet the following requirements: * Install the currently supported version of `cleos`. [[info | Note]] -| `cleos` is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install `cleos`. +| `cleos` is bundled with the Mandel software. [Installing Mandel](../../00_install/index.md) will also install `cleos`. * Understand what an [account](https://developers.eos.io/welcome/latest/glossary/index/#account) is and its role in the blockchain. * Understand [Accounts and Permissions](https://developers.eos.io/welcome/latest/protocol-guides/accounts_and_permissions) in the protocol documents. diff --git a/docs/02_cleos/02_how-to-guides/how-to-create-an-account.md b/docs/02_cleos/02_how-to-guides/how-to-create-an-account.md index 20fc565847..528c500a37 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-create-an-account.md +++ b/docs/02_cleos/02_how-to-guides/how-to-create-an-account.md @@ -1,6 +1,6 @@ ## Overview -This how-to guide provides instructions on how to create a new EOSIO blockchain account using the `cleos` CLI tool. You can use accounts to deploy smart contracts and perform other related blockchain operations. Create one or multiple accounts as part of your development environment setup. +This how-to guide provides instructions on how to create a new Mandel blockchain account using the `cleos` CLI tool. You can use accounts to deploy smart contracts and perform other related blockchain operations. Create one or multiple accounts as part of your development environment setup. The example in this how-to guide creates a new account named **bob**, authorized by the default system account **eosio**, using the `cleos` CLI tool. @@ -10,8 +10,8 @@ Make sure you meet the following requirements: * Install the currently supported version of `cleos`. [[info | Note]] -| The cleos tool is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install the cleos tool. -* Learn about [EOSIO Accounts and Permissions](https://developers.eos.io/welcome/v2.1/protocol/accounts_and_permissions) +| The cleos tool is bundled with the Mandel software. [Installing Mandel](../../00_install/index.md) will also install the cleos tool. +* Learn about [Mandel Accounts and Permissions](https://developers.eos.io/welcome/v2.1/protocol/accounts_and_permissions) * Learn about Asymmetric Cryptography - [public key](https://developers.eos.io/welcome/v2.1/glossary/index#public-key) and [private key](https://developers.eos.io/welcome/v2.1/glossary/index#private-key) pairs. * Create public/private keypairs for the `owner` and `active` permissions of an account. @@ -34,7 +34,7 @@ cleos create account eosio bob EOS87TQktA5RVse2EguhztfQVEh6XXxBmgkU8b4Y5YnGvtYAo * `bob` = the name of the new account conforming to [account naming conventions](https://developers.eos.io/welcome/v2.1/protocol-guides/accounts_and_permissions#2-accounts) * `EOS87TQ...AoLGNN` = the owner public key or permission level for the new account (**required**) [[info | Note]] -| To create a new account in the EOSIO blockchain, an existing account, also referred to as a creator account, is required to authorize the creation of a new account. For a newly created EOSIO blockchain, the default system account used to create a new account is **eosio**. +| To create a new account in the Mandel blockchain, an existing account, also referred to as a creator account, is required to authorize the creation of a new account. For a newly created Mandel blockchain, the default system account used to create a new account is **eosio**. **Example Output** @@ -46,4 +46,4 @@ warning: transaction executed locally, but may not be confirmed by the network y ### Summary -By following these instructions, you are able to create a new EOSIO account in your blockchain environment. +By following these instructions, you are able to create a new Mandel account in your blockchain environment. diff --git a/docs/02_cleos/02_how-to-guides/how-to-create-key-pairs.md b/docs/02_cleos/02_how-to-guides/how-to-create-key-pairs.md index e3e298aefe..385fc6b017 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-create-key-pairs.md +++ b/docs/02_cleos/02_how-to-guides/how-to-create-key-pairs.md @@ -1,14 +1,14 @@ ## Overview -This how-to guide provides instructions on how to create a keypair consisting of a public key and a private key for signing transactions in an EOSIO blockchain. +This how-to guide provides instructions on how to create a keypair consisting of a public key and a private key for signing transactions in a Mandel blockchain. ## Before you begin Make sure you meet the following requirements: * Install the currently supported version of `cleos` [[info | Note]] -| The cleos tool is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install the cleos tool. -* Learn about asymmetric cryptography (public and private keypair) in the context of an EOSIO blockchain. +| The cleos tool is bundled with the Mandel software. [Installing Mandel](../../00_install/index.md) will also install the cleos tool. +* Learn about asymmetric cryptography (public and private keypair) in the context of a Mandel blockchain. ## Command Reference diff --git a/docs/02_cleos/02_how-to-guides/how-to-delegate-CPU-resource.md b/docs/02_cleos/02_how-to-guides/how-to-delegate-CPU-resource.md index 5345bd83f6..606209e3d6 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-delegate-CPU-resource.md +++ b/docs/02_cleos/02_how-to-guides/how-to-delegate-CPU-resource.md @@ -10,12 +10,12 @@ Make sure you meet the following requirements: * Install the currently supported version of `cleos`. [[info | Note]] -| `cleos` is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install `cleos`. +| `cleos` is bundled with the Mandel software. [Installing Mandel](../../00_install/index.md) will also install `cleos`. -* Ensure the reference system contracts from [`eosio.contracts`](https://github.com/EOSIO/eosio.contracts) repository is deployed and used to manage system resources. +* Ensure the reference system contracts from [`eosio.contracts`](https://github.com/eosnetworkfoundation/mandel-contracts) repository is deployed and used to manage system resources. * Understand what an [account](https://developers.eos.io/welcome/latest/glossary/index/#account) is and its role in the blockchain. -* Understand [CPU bandwidth](https://developers.eos.io/welcome/latest/glossary/index/#cpu) in an EOSIO blockchain. -* Understand [NET bandwidth](https://developers.eos.io/welcome/latest/glossary/index/#net) in an EOSIO blockchain. +* Understand [CPU bandwidth](https://developers.eos.io/welcome/latest/glossary/index/#cpu) in a Mandel blockchain. +* Understand [NET bandwidth](https://developers.eos.io/welcome/latest/glossary/index/#net) in a Mandel blockchain. ## Steps diff --git a/docs/02_cleos/02_how-to-guides/how-to-delegate-net-resource.md b/docs/02_cleos/02_how-to-guides/how-to-delegate-net-resource.md index 118c36ba13..51ec81b0b9 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-delegate-net-resource.md +++ b/docs/02_cleos/02_how-to-guides/how-to-delegate-net-resource.md @@ -10,12 +10,12 @@ Make sure you meet the following requirements: * Install the currently supported version of `cleos`. [[info | Note]] -| `cleos` is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install `cleos`. +| `cleos` is bundled with the Mandel software. [Installing Mandel](../../00_install/index.md) will also install `cleos`. -* Ensure the reference system contracts from [`eosio.contracts`](https://github.com/EOSIO/eosio.contracts) repository is deployed and used to manage system resources. +* Ensure the reference system contracts from [`eosio.contracts`](https://github.com/eosnetworkfoundation/mandel-contracts) repository is deployed and used to manage system resources. * Understand what an [account](https://developers.eos.io/welcome/latest/glossary/index/#account) is and its role in the blockchain. -* Understand [NET bandwidth](https://developers.eos.io/welcome/latest/glossary/index/#net) in an EOSIO blockchain. -* Understand [CPU bandwidth](https://developers.eos.io/welcome/latest/glossary/index/#cpu) in an EOSIO blockchain. +* Understand [NET bandwidth](https://developers.eos.io/welcome/latest/glossary/index/#net) in a Mandel blockchain. +* Understand [CPU bandwidth](https://developers.eos.io/welcome/latest/glossary/index/#cpu) in a Mandel blockchain. ## Steps diff --git a/docs/02_cleos/02_how-to-guides/how-to-deploy-a-smart-contract.md b/docs/02_cleos/02_how-to-guides/how-to-deploy-a-smart-contract.md index 32fcce2c00..ccb970fbf2 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-deploy-a-smart-contract.md +++ b/docs/02_cleos/02_how-to-guides/how-to-deploy-a-smart-contract.md @@ -1,6 +1,6 @@ ## Goal -Deploy an EOSIO contract +Deploy a Mandel contract ## Before you begin diff --git a/docs/02_cleos/02_how-to-guides/how-to-get-account-information.md b/docs/02_cleos/02_how-to-guides/how-to-get-account-information.md index 7dc5f686d0..fabf5045fe 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-get-account-information.md +++ b/docs/02_cleos/02_how-to-guides/how-to-get-account-information.md @@ -1,15 +1,15 @@ ## Overview -This how-to guide provides instructions on how to query infomation of an EOSIO account. The example in this how-to guide retrieves information of the `eosio` account. +This how-to guide provides instructions on how to query infomation of a Mandel account. The example in this how-to guide retrieves information of the `eosio` account. ## Before you begin * Install the currently supported version of `cleos` [[info | Note]] -| The cleos tool is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install the cleos tool. +| The cleos tool is bundled with the Mandel software. [Installing Mandel](../../00_install/index.md) will also install the cleos tool. -* Acquire functional understanding of [EOSIO Accounts and Permissions](https://developers.eos.io/welcome/v2.1/protocol/accounts_and_permissions) +* Acquire functional understanding of [Mandel Accounts and Permissions](https://developers.eos.io/welcome/v2.1/protocol/accounts_and_permissions) ## Command Reference @@ -28,7 +28,7 @@ cleos get account eosio ``` **Where**: -* `eosio` = The name of the default system account in the EOSIO blockchain. +* `eosio` = The name of the default system account in the Mandel blockchain. **Example Output** @@ -53,4 +53,4 @@ cpu bandwidth: ``` [[info | Account Fields]] -| Depending on the EOSIO network you are connected, you might see different fields associated with an account. That depends on which system contract has been deployed on the network. +| Depending on the Mandel network you are connected, you might see different fields associated with an account. That depends on which system contract has been deployed on the network. diff --git a/docs/02_cleos/02_how-to-guides/how-to-get-block-information.md b/docs/02_cleos/02_how-to-guides/how-to-get-block-information.md index 7efd62427f..ca23c507f0 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-get-block-information.md +++ b/docs/02_cleos/02_how-to-guides/how-to-get-block-information.md @@ -10,10 +10,10 @@ Make sure to meet the following requirements: * Install the currently supported version of `cleos`. [[info | Note]] -| `cleos` is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install `cleos`. +| `cleos` is bundled with the Mandel software. [Installing Mandel](../../00_install/index.md) will also install `cleos`. * Understand what a [block](https://developers.eos.io/welcome/latest/glossary/index/#block) is and its role in the blockchain. -* Understand the [block lifecycle](https://developers.eos.io/welcome/latest/protocol-guides/consensus_protocol/#5-block-lifecycle) in the EOSIO consensus protocol. +* Understand the [block lifecycle](https://developers.eos.io/welcome/latest/protocol-guides/consensus_protocol/#5-block-lifecycle) in the Mandel consensus protocol. ## Steps diff --git a/docs/02_cleos/02_how-to-guides/how-to-get-transaction-information.md b/docs/02_cleos/02_how-to-guides/how-to-get-transaction-information.md index aaf5fd7e74..f6e33fe0d8 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-get-transaction-information.md +++ b/docs/02_cleos/02_how-to-guides/how-to-get-transaction-information.md @@ -1,6 +1,6 @@ ## Overview -This how-to guide provides instructions on how to retrieve infomation of an EOSIO transaction using a transaction ID. +This how-to guide provides instructions on how to retrieve infomation of a Mandel transaction using a transaction ID. The example in this how-to retrieves transaction information associated with the creation of the account **bob**. @@ -9,8 +9,8 @@ The example in this how-to retrieves transaction information associated with the Make sure you meet the following requirements: * Install the currently supported version of `cleos`. [[info | Note]] -| `cleos` is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install `cleos`. -* Understand how transactions work in an EOSIO blockchain. For more information on transactions, see the [Transactions Protocol](https://developers.eos.io/welcome/latest/protocol-guides/transactions_protocol) section. +| `cleos` is bundled with the Mandel software. [Installing Mandel](../../00_install/index.md) will also install `cleos`. +* Understand how transactions work in a Mandel blockchain. For more information on transactions, see the [Transactions Protocol](https://developers.eos.io/welcome/latest/protocol-guides/transactions_protocol) section. ## Command Reference diff --git a/docs/02_cleos/02_how-to-guides/how-to-import-a-key.md b/docs/02_cleos/02_how-to-guides/how-to-import-a-key.md index 19a8ee0d7d..6e13925fc0 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-import-a-key.md +++ b/docs/02_cleos/02_how-to-guides/how-to-import-a-key.md @@ -1,6 +1,6 @@ ## Overview -This how-to guide provides instructions on how to import a private key into the `keosd` default wallet. You can use the private key to authorize transactions in an EOSIO blockchain. +This how-to guide provides instructions on how to import a private key into the `keosd` default wallet. You can use the private key to authorize transactions in a Mandel blockchain. ## Before you Begin @@ -11,7 +11,7 @@ Make sure you meet the following requirements: * Familiarize with the [`cleos wallet import`](../03_command-reference/wallet/import.md) command. * Install the currently supported version of `cleos`. [[info | Note]] -| `cleos` is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install `cleos`. +| `cleos` is bundled with the Mandel software. [Installing Mandel](../../00_install/index.md) will also install `cleos`. * Understand what a [public key](https://developers.eos.io/welcome/latest/glossary/index/#public-key) and [private key](https://developers.eos.io/welcome/latest/glossary/index/#private-key) is. ## Command Reference diff --git a/docs/02_cleos/02_how-to-guides/how-to-list-all-key-pairs.md b/docs/02_cleos/02_how-to-guides/how-to-list-all-key-pairs.md index 7a9bb7348f..7b5703b046 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-list-all-key-pairs.md +++ b/docs/02_cleos/02_how-to-guides/how-to-list-all-key-pairs.md @@ -1,6 +1,6 @@ ## Overview -This how-to guide provides instructions on how to list all public keys and public/private key pairs within the `keosd` default wallet. You can use the public and private keys to authorize transactions in an EOSIO blockchain. +This how-to guide provides instructions on how to list all public keys and public/private key pairs within the `keosd` default wallet. You can use the public and private keys to authorize transactions in a Mandel blockchain. The example in this how-to guide displays all public keys and public/private key pairs stored within the existing default wallet. @@ -13,7 +13,7 @@ Make sure you meet the following requirements: * Familiarize with the [`cleos wallet`](../03_command-reference/wallet/index.md) commands. * Install the currently supported version of `cleos`. [[info | Note]] -| `cleos` is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install `cleos`. +| `cleos` is bundled with the Mandel software. [Installing Mandel](../../00_install/index.md) will also install `cleos`. * Understand what a [public key](https://developers.eos.io/welcome/latest/glossary/index/#public-key) and [private key](https://developers.eos.io/welcome/latest/glossary/index/#private-key) is. ## Command Reference diff --git a/docs/02_cleos/03_command-reference/create/account.md b/docs/02_cleos/03_command-reference/create/account.md index 976c986f56..e35d2bf146 100755 --- a/docs/02_cleos/03_command-reference/create/account.md +++ b/docs/02_cleos/03_command-reference/create/account.md @@ -30,7 +30,7 @@ Options: ``` ## Command -A set of EOSIO keys is required to create an account. The EOSIO keys can be generated by using `cleos create key`. +A set of Mandel keys is required to create an account. The Mandel keys can be generated by using `cleos create key`. ```sh cleos create account inita tester EOS4toFS3YXEQCkuuw1aqDLrtHim86Gz9u3hBdcBw5KNPZcursVHq EOS7d9A3uLe6As66jzN8j44TXJUqJSK3bFjjEEqR4oTvNAB3iM9SA diff --git a/docs/02_cleos/03_command-reference/net/connect.md b/docs/02_cleos/03_command-reference/net/connect.md index be0b2af0b3..278f3f47c6 100755 --- a/docs/02_cleos/03_command-reference/net/connect.md +++ b/docs/02_cleos/03_command-reference/net/connect.md @@ -26,7 +26,7 @@ Make sure you meet the following requirements: * Install the currently supported version of `cleos`. [[info | Note]] -| `cleos` is bundled with the EOSIO software. [Installing EOSIO](../../../00_install/index.md) will also install the `cleos` and `keosd` command line tools. +| `cleos` is bundled with the Mandel software. [Installing Mandel](../../../00_install/index.md) will also install the `cleos` and `keosd` command line tools. * You have access to a producing node instance with the [`net_api_plugin`](../../../01_nodeos/03_plugins/net_api_plugin/index.md) loaded. ## Examples diff --git a/docs/02_cleos/03_command-reference/net/disconnect.md b/docs/02_cleos/03_command-reference/net/disconnect.md index 29c3039961..f2dfa12c82 100755 --- a/docs/02_cleos/03_command-reference/net/disconnect.md +++ b/docs/02_cleos/03_command-reference/net/disconnect.md @@ -26,7 +26,7 @@ Make sure you meet the following requirements: * Install the currently supported version of `cleos`. [[info | Note]] -| `cleos` is bundled with the EOSIO software. [Installing EOSIO](../../../00_install/index.md) will also install the `cleos` and `keosd` command line tools. +| `cleos` is bundled with the Mandel software. [Installing Mandel](../../../00_install/index.md) will also install the `cleos` and `keosd` command line tools. * You have access to a producing node instance with the [`net_api_plugin`](../../../01_nodeos/03_plugins/net_api_plugin/index.md) loaded. ## Examples diff --git a/docs/02_cleos/03_command-reference/net/peers.md b/docs/02_cleos/03_command-reference/net/peers.md index 2814731c75..c625506c53 100755 --- a/docs/02_cleos/03_command-reference/net/peers.md +++ b/docs/02_cleos/03_command-reference/net/peers.md @@ -25,7 +25,7 @@ Make sure you meet the following requirements: * Install the currently supported version of `cleos`. [[info | Note]] -| `cleos` is bundled with the EOSIO software. [Installing EOSIO](../../../00_install/index.md) will also install the `cleos` and `keosd` command line tools. +| `cleos` is bundled with the Mandel software. [Installing Mandel](../../../00_install/index.md) will also install the `cleos` and `keosd` command line tools. * You have access to a producing node instance with the [`net_api_plugin`](../../../01_nodeos/03_plugins/net_api_plugin/index.md) loaded. ## Examples diff --git a/docs/02_cleos/03_command-reference/net/status.md b/docs/02_cleos/03_command-reference/net/status.md index f8f45265ec..7a8fd4f535 100755 --- a/docs/02_cleos/03_command-reference/net/status.md +++ b/docs/02_cleos/03_command-reference/net/status.md @@ -26,7 +26,7 @@ Make sure you meet the following requirements: * Install the currently supported version of `cleos`. [[info | Note]] -| `cleos` is bundled with the EOSIO software. [Installing EOSIO](../../../00_install/index.md) will also install the `cleos` and `keosd` command line tools. +| `cleos` is bundled with the Mandel software. [Installing Mandel](../../../00_install/index.md) will also install the `cleos` and `keosd` command line tools. * You have access to a producing node instance with the [`net_api_plugin`](../../../01_nodeos/03_plugins/net_api_plugin/index.md) loaded. ## Examples diff --git a/docs/02_cleos/03_command-reference/set/set-account.md b/docs/02_cleos/03_command-reference/set/set-account.md index e4ed9f6e32..1e682aa485 100755 --- a/docs/02_cleos/03_command-reference/set/set-account.md +++ b/docs/02_cleos/03_command-reference/set/set-account.md @@ -2,7 +2,7 @@ set parameters dealing with account permissions [[info | JSON input]] -| This command involves specifying JSON input which depends on underlying class definitions. Therefore, such JSON input is subject to change in future versions of the EOSIO software. +| This command involves specifying JSON input which depends on underlying class definitions. Therefore, such JSON input is subject to change in future versions of the Mandel software. ## Positionals - `account` _TEXT_ - The account to set/delete a permission authority for diff --git a/docs/02_cleos/04_troubleshooting.md b/docs/02_cleos/04_troubleshooting.md index 63250119e9..748ac82df3 100644 --- a/docs/02_cleos/04_troubleshooting.md +++ b/docs/02_cleos/04_troubleshooting.md @@ -20,4 +20,4 @@ Replace API_ENDPOINT and PORT with your remote `nodeos` API endpoint detail ## "Missing Authorizations" -That means you are not using the required authorizations. Most likely you are not using correct EOSIO account or permission level to sign the transaction +That means you are not using the required authorizations. Most likely you are not using correct Mandel account or permission level to sign the transaction diff --git a/docs/02_cleos/index.md b/docs/02_cleos/index.md index 6e0ea9423b..e2303863af 100644 --- a/docs/02_cleos/index.md +++ b/docs/02_cleos/index.md @@ -4,11 +4,11 @@ content_title: Cleos ## Introduction -`cleos` is a command line tool that interfaces with the REST API exposed by `nodeos`. Developers can also use `cleos` to deploy and test EOSIO smart contracts. +`cleos` is a command line tool that interfaces with the REST API exposed by `nodeos`. Developers can also use `cleos` to deploy and test Mandel smart contracts. ## Installation -`cleos` is distributed as part of the [EOSIO software suite](https://github.com/EOSIO/eos/blob/master/README.md). To install `cleos` just visit the [EOSIO Software Installation](../00_install/index.md) section. +`cleos` is distributed as part of the [Mandel software suite](https://github.com/eosnetworkfoundation/mandel). To install `cleos` just visit the [Mandel Software Installation](../00_install/index.md) section. ## Using Cleos @@ -23,7 +23,7 @@ cleos --help ``` ```console -Command Line Interface to EOSIO Client +Command Line Interface to Mandel Client Usage: cleos [OPTIONS] SUBCOMMAND Options: diff --git a/docs/03_keosd/index.md b/docs/03_keosd/index.md index 43f2301dbb..99144dd25f 100644 --- a/docs/03_keosd/index.md +++ b/docs/03_keosd/index.md @@ -8,11 +8,11 @@ content_title: Keosd ## Installation -`keosd` is distributed as part of the [EOSIO software suite](https://github.com/EOSIO/eos/blob/master/README.md). To install `keosd` just visit the [EOSIO Software Installation](../00_install/index.md) section. +`keosd` is distributed as part of the [Mandel software suite](https://github.com/eosnetworkfoundation/mandel). To install `keosd` just visit the [Mandel Software Installation](../00_install/index.md) section. ## Operation When a wallet is unlocked with the corresponding password, `cleos` can request `keosd` to sign a transaction with the appropriate private keys. Also, `keosd` provides support for hardware-based wallets such as Secure Encalve and YubiHSM. [[info | Audience]] -| `keosd` is intended to be used by EOSIO developers only. +| `keosd` is intended to be used by Mandel developers only. diff --git a/docs/10_utilities/index.md b/docs/10_utilities/index.md index 747c95cb72..d0a078b58e 100644 --- a/docs/10_utilities/index.md +++ b/docs/10_utilities/index.md @@ -1,9 +1,9 @@ --- -content_title: EOSIO Utilities -link_text: EOSIO Utilities +content_title: Mandel Utilities +link_text: Mandel Utilities --- -This section contains documentation for additional utilities that complement or extend `nodeos` and potentially other EOSIO software: +This section contains documentation for additional utilities that complement or extend `nodeos` and potentially other Mandel software: * [eosio-blocklog](eosio-blocklog.md) - Low-level utility for node operators to interact with block log files. * [trace_api_util](trace_api_util.md) - Low-level utility for performing tasks associated with the [Trace API](../01_nodeos/03_plugins/trace_api_plugin/index.md). diff --git a/docs/20_upgrade-guide/79_2.0-upgrade-guide.md b/docs/20_upgrade-guide/79_2.0-upgrade-guide.md deleted file mode 100644 index 1a8d5b57ce..0000000000 --- a/docs/20_upgrade-guide/79_2.0-upgrade-guide.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -link: /20_upgrade-guide/index.md ---- diff --git a/docs/20_upgrade-guide/81_1.8-upgrade-guide.md b/docs/20_upgrade-guide/81_1.8-upgrade-guide.md deleted file mode 100644 index 9d0bdb7445..0000000000 --- a/docs/20_upgrade-guide/81_1.8-upgrade-guide.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -content_title: EOSIO 1.8 Consensus Protocol Upgrade Process ---- - -This guide is intended to instruct node operators on the steps needed to successfully transition an EOSIO network through a consensus protocol upgrade (also known as a "hard fork") with minimal disruption to users. - -## Test networks - -Before deploying the upgrade to any non-test networks, protocol upgrades should be deployed and verified on test networks. The version of nodeos supporting the initial set of protocol upgrades is [v1.8.1](https://github.com/EOSIO/eos/releases/tag/v1.8.1). Existing EOSIO-based test networks can use this version of nodeos to carry out and test the upgrade process. - -This test upgrade process can give block producers of their respective EOSIO blockchain networks practice with carrying out the steps necessary to successfully coordinate the activation of the first consensus protocol upgrade feature (or just protocol feature for short), which will fork out any nodes that have not yet updated to the new version of nodeos by the time of activation. The process will also inform block producers of the requirements for nodes to upgrade nodeos to v1.8 from v1.7 and earlier, and it can help them decide an appropriate deadline to be given as notice to the community for when the first protocol feature will be activated. - -Testing the upgrade process on test networks will also allow block explorers and other applications interacting with the blockchain to test the transition and the behavior of their applications under the new rules after activation of the individual protocol features. Some of the protocol features (`PREACTIVATE_FEATURE` and `NO_DUPLICATE_DEFERRED_ID` as examples) make slight changes to the block and transaction data structures, and therefore force applications that are reliant on the old structure to migrate. One of the protocol features (`RESTRICT_ACTION_TO_SELF`) restricts an existing authorization bypass (which has been deprecated since the v1.5.1 release of EOSIO) and could potentially break smart contracts that continue to rely on that authorization bypass. - -## Upgrade process for all EOSIO networks (including test networks) - -Because these steps require replay from genesis, after the release of [v1.8.1](https://github.com/EOSIO/eos/releases/tag/v1.8.1) of nodeos which supports the initial set of consensus protocol upgrades, all node operators should take the following steps as soon as possible. These steps should be followed on an additional node that they can afford to be taken offline for an extended period of time: - -1. Ensure that their existing node is running the most recent stable release (1.7) of nodeos and then shut down nodeos. -2. Make a backup and delete the `blocks/reversible` directory, `state-history` directory, and `state` directory within the data directory. -3. Replace their old version of nodeos with the new release. -4. Start the new 1.8 release of nodeos and let it complete replay from genesis and catch up with syncing with the network. The node should receive blocks and LIB should advance. Nodes running v1.8 and v1.7 will continue to coexist in the same network prior to the activation of the first protocol upgrade feature. - -A replay from genesis is required when upgrading nodeos from v1.7 to v1.8. Afterward, the v1.8 node can, as usual, start and stop quickly without requiring replays. The state directory generated by a v1.7 node will not be compatible with v1.8 of nodeos. Version 1 portable snapshots (generated by v1.7) will not be compatible with v1.8 which require the version 2 portable snapshots. - -Due to the long amount of time it will take to replay from genesis (even longer if running with plugins that track history), block producers of the network are suggested to provide sufficient time to the community to upgrade their nodes prior to activating the first protocol upgrade feature. - -Nodes that wish to make the transition but are not interested in tracking the history of the chain from genesis have an option to speed things up by using a version 2 portable snapshots that can be generated by synced v1.8 nodes. Since the portable snapshots are generated in a deterministic and portable manner, users can simply compare the hash of the snapshot files they downloaded from an arbitrary source to the hashes published by a variety of trusted sources, but only if they correspond to snapshots taken at the same block ID. - -### Special notes to block producers - -Block producers will obviously need to run the replay of nodeos on a separate machine that is not producing blocks. This machine will have to be production ready so that they can switch block production over to it when it has finished replaying and syncing. Alternatively, they can take a portable snapshot on the replay machine and move it to yet another machine which is production ready, then activate the switch over from their currently producing v1.7 BP node to the v1.8 node. - -Nearly all of the protocol upgrade features introduced in v1.8 first require a special protocol feature (codename `PREACTIVATE_FEATURE`) to be activated and for an updated version of the system contract that utilizes the functionality introduced by that feature to be deployed. Block producers should be aware that as soon as the `PREACTIVATE_FEATURE` protocol feature is activated by the BPs, all nodes still on v1.7 will be unable to continue syncing normally and their last irreversible block will stop advancing. For this reason, it is important to coordinate when the activation happens and announce the expected activation date with sufficient time provided to the community to upgrade their nodes in time. - -After activation of the `PREACTIVATE_FEATURE` and deployment of the updated system contract, block producers will be able to more easily coordinate activation of further protocol features. For the remaining protocol features in the v1.8 release, they can activate the features at any time and no preparation time needs to be given to the community since anyone synced up with the blockchain at that time will necessarily be on a version of nodeos that is at least v1.8 and therefore will support the entire initial set of protocol features. Furthermore, due to the `PREACTIVATE_FEATURE` protocol feature, they can activate the other remaining protocol features with an `eosio.msig` proposed transaction using the `activate` action in the new system contract and no replay is required. - -The activation of the first protocol feature, `PREACTIVATE_FEATURE`, however cannot be done with an `eosio.msig` proposed transaction. It will require more coordination and manual action by the block producers. First, block producers should come to an agreement on the earliest time that they are willing to activate the first protocol feature. - -The BPs should then set this chosen time in the configuration JSON file for the `PREACTIVATE_FEATURE` protocol upgrade of their v1.8 node. Specifically, they should modify the value for the `earliest_allowed_activation_time` field in the `protocol_features/BUILTIN-PREACTIVATE_FEATURE.json` file located in the config directory. - -It is important that this configuration change happens prior to allowing that node to produce blocks on the network. As long as more than two-thirds of the active block producers have set the same future time in the configuration file for the `PREACTIVATE_FEATURE` on their BP nodes, the network will be safe from any attempts at premature activation by some other active BP. - -After the agreed upon time has passed, any of the active block producers can activate the `PREACTIVATE_FEATURE` protocol feature with a simple request sent to the [`producer_api_plugin`](../01_nodeos/03_plugins/producer_api_plugin/index.md) of their BP node. - -To determine the specific format of the request, the digest of the `PREACTIVATE_FEATURE` protocol feature must first be determined. This can be found by looking at nodeos startup logs, or by sending a request to the `get_supported_protocol_features` endpoint provided by the [`producer_api_plugin`](../01_nodeos/03_plugins/producer_api_plugin/index.md). - -Send a request to the endpoint locally: - -``` -curl -X POST http://127.0.0.1:8888/v1/producer/get_supported_protocol_features -d '{}' | jq -``` - -In the returned array, find an object that references the `PREACTIVATE_FEATURE` codename, for example: - -``` -... -{ - "feature_digest": "0ec7e080177b2c02b278d5088611686b49d739925a92d9bfcacd7fc6b74053bd", - "subjective_restrictions": { - "enabled": true, - "preactivation_required": false, - "earliest_allowed_activation_time": "1970-01-01T00:00:00.000" - }, - "description_digest": "64fe7df32e9b86be2b296b3f81dfd527f84e82b98e363bc97e40bc7a83733310", - "dependencies": [], - "protocol_feature_type": "builtin", - "specification": [ - { - "name": "builtin_feature_codename", - "value": "PREACTIVATE_FEATURE" - } - ] -}, -... -``` - -In this case, the digest of the `PREACTIVATE_FEATURE` protocol feature is `0ec7e080177b2c02b278d5088611686b49d739925a92d9bfcacd7fc6b74053bd` (note that the values may be different depending on the local changes made to the configuration of the protocol features that are specific to the blockchain network). - -Then, the local block producing nodeos instance can be requested to activate the `PREACTIVATE_FEATURE` protocol at its earliest opportunity (i.e. the next time that node produces a block) using the following command: - -``` -curl -X POST http://127.0.0.1:8888/v1/producer/schedule_protocol_feature_activations -d '{"protocol_features_to_activate": ["0ec7e080177b2c02b278d5088611686b49d739925a92d9bfcacd7fc6b74053bd"]}' | jq -``` - -The above command should only be used after the time has passed the agreed upon `earliest_allowed_activation_time` for the `PREACTIVATE_FEATURE` protocol feature. - -Any synced v1.8.x nodes can be used to check which protocol features have been activated using the following command: - -``` -curl -X POST http://127.0.0.1:8888/v1/chain/get_activated_protocol_features -d '{}' | jq -``` - -For example, if the `PREACTIVATE_FEATURE` protocol feature is activated, that command may return a result such as (specific values, especially the `activation_block_num`, may vary): - -``` -{ - "activated_protocol_features": [ - { - "feature_digest": "0ec7e080177b2c02b278d5088611686b49d739925a92d9bfcacd7fc6b74053bd", - "activation_ordinal": 0, - "activation_block_num": 348, - "description_digest": "64fe7df32e9b86be2b296b3f81dfd527f84e82b98e363bc97e40bc7a83733310", - "dependencies": [], - "protocol_feature_type": "builtin", - "specification": [ - { - "name": "builtin_feature_codename", - "value": "PREACTIVATE_FEATURE" - } - ] - } - ] -} -``` - -Once the `PREACTIVATE_FEATURE` protocol feature has been activated, the [new system contract](https://github.com/EOSIO/eosio.contracts/releases/tag/v1.7.0) with the `activate` action can be deployed. - -## Notes for block explorers, exchanges, and applications - -Block explorers, exchanges, and applications building on the blockchain can all follow the four-step processes described above to upgrade their nodes in time and ensure their services continue when the first protocol upgrade is activated. However, they should also be aware that certain protocol features change the behavior of existing operations on the blockchain, and in some cases also slightly change the structure of blocks and transactions. - - -**First**, v1.8 changes the structure of transaction traces, even prior to the activation of any protocol features. Clients consuming transaction and action traces made available through [`history_plugin`](../01_nodeos/03_plugins/history_plugin/index.md), `mongo_db_plugin`, or [`state_history_plugin`](../01_nodeos/03_plugins/state_history_plugin/index.md) should be aware of the changes made to the trace structure (see details at [#7044](https://github.com/EOSIO/eos/pull/7044) and [#7108](https://github.com/EOSIO/eos/pull/7108)). Clients consuming the trace output of the `push_transaction` RPC from the chain API should not need to do anything since the output of that RPC should be backwards compatible. However, they are encouraged to replace usage of `push_transaction` with the new RPC [`send_transaction`](https://developers.eos.io/eosio-nodeos/reference#send_transaction) which uses the new flat structure to store the action traces. - -The [`state_history_plugin`](../01_nodeos/03_plugins/state_history_plugin/index.md) has also changed its API and the structure of the files it stores on disk in a backwards incompatible way in v1.8. These changes reflect, among other things, the transaction trace structural changes and the data structure changes made within the chain state database to support the new protocol features. Consumers of the [`state_history_plugin`](../01_nodeos/03_plugins/state_history_plugin/index.md) will need to be updated to work with the new changes in v1.8. - -**Second**, all protocol features are activated by signaling their 256-bit digest through a block. The block producer is able to place the digest of a protocol feature in a special section of the block header (called the block header extensions) that, under the original rules of v1.7, is expected to be empty. This change may especially be relevant to block explorers which need to ensure that their tools will not break because of the extra data included in the block header and ideally will update their block explorers to reflect the new information. The first time block explorers or other consumers of the blockchain data will encounter a non-empty block header extension is during the activation of the `PREACTIVATE_FEATURE` protocol feature. - -**Third**, upon activation of the `NO_DUPLICATE_DEFERRED_ID` protocol feature, contract-generated deferred transactions will include a non-empty `transaction_extensions` field. While block explorers may be interested in exposing the contents of this field in a user-friendly way, clients are free to ignore it. However, for code dealing with the binary serialized form of these transactions directly, they must be capable of successfully deserializing the transaction with the extension data present. Note that this also applies to smart contract code that may be reading the deferred transaction that caused it to execute, whether it is because it is executing an action within the deferred transaction or executing the `eosio::onerror` notification handler of the contract that sent the (failed) deferred transaction. - -**Fourth**, activation of the `RESTRICT_ACTION_TO_SELF` protocol feature will remove the authorization bypass that is available when a contract sends an inline action to itself (this authorization bypass was deprecated in the v1.5.1 release of EOSIO). Smart contract developers should ensure their contracts do not rely on this authorization bypass prior to the time the block producers activate the `RESTRICT_ACTION_TO_SELF` protocol feature, otherwise, their contracts may stop functioning correctly. diff --git a/docs/20_upgrade-guide/index.md b/docs/20_upgrade-guide/index.md deleted file mode 100644 index f627e445c3..0000000000 --- a/docs/20_upgrade-guide/index.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -content_title: EOSIO 2.0 Upgrade Guide ---- - -This section contains important instructions for node operators and other EOSIO stakeholders to transition an EOSIO network successfully through an EOSIO version or protocol upgrade. - -## Consensus Protocol Upgrades -EOSIO v2.0.x introduces two new consensus protocol upgrade features (or just protocol features for short): - -1. `WEBAUTHN_KEY`: Adds support for WebAuthn keys and signatures ([#7421](https://github.com/EOSIO/eos/pull/7421)) -2. `WTMSIG_BLOCK_SIGNATURES`: Adds support for weighted threshold multi-signature (WTMsig) authorities for block production ([#7404](https://github.com/EOSIO/eos/pull/7404), [#8002](https://github.com/EOSIO/eos/pull/8002), [#8021](https://github.com/EOSIO/eos/pull/8021)) - -Both of these features require activation through the privileged `preactivate_feature` intrinsic. This is typically facilitated by executing the `eosio::activate` system contract action (requires system contract [v1.7.0](https://github.com/EOSIO/eosio.contracts/releases/tag/v1.7.0) or later) via the `eosio.msig` contract after getting supermajority block producer approval. However, while these protocol features can be activated through coordination of the block producers alone, **it is still critical to give sufficient time for all nodes to upgrade to v2.0.x before activating any of the above two protocol features**. Activation of any of these two protocol features will immediately fork out any nodes that do not support the protocol features (e.g. any nodes running a version of nodeos earlier than v2.0.x). - -Both of the above protocol features only add new behavior to the EOSIO blockchain. They are not expected to change existing behavior in a significant way that would cause existing contracts to break. Existing applications and block explorers are also unlikely to break upon activation of these protocol features. However, these new features enable new data structures to be utilized on-chain which applications and especially block explorers need to be prepared to handle. For example, activation of the `WEBAUTHN_KEY` protocol feature means that an `eosio::newaccount` or `eosio::updateauth` action could now include WebAuthn public keys as part of the provided `authority`. So, an application dealing with these actions (e.g. a general authenticator for EOSIO transactions) will need to be prepared to support the serialization of WebAuthn public keys appearing in a place where a `public_key` ABI type is expected. Another example is how the activation of the `WTMSIG_BLOCK_SIGNATURES` protocol feature causes the `new_producers` field of a block header to always remain empty, even when a proposed producer schedule gets promoted to pending; upon activation of the `WTMSIG_BLOCK_SIGNATURES` protocol feature, the pending schedule data is instead stored (when present) within the `header_extensions` of the block header. So, block explorers expecting to show these pending producer schedules to users will need to update their code accordingly. As usual, test networks provide a great environment to try existing contracts, applications, services, etc. with the changes of the above protocol features to determine what breaks and what needs to be updated. - -For more details on the `WEBAUTH_KEY` protocol feature, see the section titled [WebAuthn Support](#webauthn-support-7421). For more details on the `WTMSIG_BLOCK_SIGNATURES` protocol feature, see the section titled [Weighted Threshold Multi-signature (WTMsig) Block Signing Authorities](#weighted-threshold-multi-signature-block-signing-authorities-7403). - -### WebAuthn Support ([#7421](https://github.com/EOSIO/eos/pull/7421)) -WebAuthn support within EOSIO is now available for developers to begin testing WebAuthn based transaction signing in their EOSIO applications. Private EOSIO chains can [start](https://github.com/EOSIO/eosio-webauthn-example-app) using WebAuthn based signatures with this release. We also anticipate releasing additional demos which will attempt to outline how Dapp authors can leverage WebAuthn for contract actions meriting higher levels of security as a second factor authorization mechanism. - -### Weighted Threshold Multi-Signature Block Signing Authorities ([#7403](https://github.com/EOSIO/eos/issues/7403)) -Block producers must be able to provide high availability for their core service of running the blockchain (aka producing blocks). A common approach to achieve this is redundant infrastructure that efficiently maintains block production, in the event of a hardware malfunction or networking issues. Weighted Threshold Multi-Signature Block Production is the first of many features that seek to provide block producers with a complete high availability solution. - -Current consensus rules require exactly one cryptographic block signing key per block producer. This key, whether stored on disk and loaded via software or protected with a hardware wallet, represents a single-point-of-failure for the operations of a block producer. If that key is lost or access to the hardware module that contains it is temporarily unavailable, the block producer has no choice but to drop blocks, impacting the whole network’s throughput. - -To improve the security and scalability of block production, weighted threshold multi-signature (WTMsig) block signing authorities provides a permission layer that allows for multiple block signing keys in a flexible scheme that will enable redundant block signing infrastructure to exist without sharing any sensitive data. - -An updated version of the system contract is required to enable block producers to use WTMsig block signing authorities. Version [v1.9.0-rc1](https://github.com/EOSIO/eosio.contracts/releases/tag/v1.9.0-rc1) of eosio.contracts adds a new `regproducer2` action to the eosio.system contract which enables a block producer candidate to register a WTMsig block signing authority. (That version of the system contract can only be deployed on an EOSIO chain that has activated the `WTMSIG_BLOCK_SIGNATURES` protocol feature.) More details are available at: [#7404](https://github.com/EOSIO/eos/pull/7404), [#8002](https://github.com/EOSIO/eos/pull/8002), [#8021](https://github.com/EOSIO/eos/pull/8021). - -## Upgrading from previous versions of EOSIO - -EOSIO v2.0.x has made changes to the state database that prevent it from working with existing state databases in v1.8.x and earlier. So upgrading from earlier versions of EOSIO requires importing the state from a portable snapshot. - -Furthermore, the changes to the state database necessitate a version bump in the portable snapshots generated by EOSIO v2.0.x from v2 to v3. However, unlike the upgrade of portable snapshot versions in EOSIO v1.8.x from v1 to v2, EOSIO v2.0.x is able to import v2 portable snapshots. This means that it is not necessary to replay the blockchain from genesis to upgrade from EOSIO v1.8.x to v2.0.x. (One exception is if the operator of the node is using the deprecated history_plugin and wishes to preserve that history.) - -Finally, EOSIO v2.0.x has also upgraded the version of the irreversible blocks log to v3. However, older versions of the blocks log are still supported, so there is no need to do anything special to handle existing blocks log files. - -### Upgrading from v1.8.x - -If the node uses the deprecated history_plugin (and the operator of the node wishes to preserve this history), the only option to upgrade is to replay the blockchain from genesis. - -Users of the state_history_plugin (SHiP) do not need to replay from genesis because the state history logs are portable and contain versioned data structures within. However, upgrading a node that uses state history without a full replay means that the state history log will contain a mix of versions for any upgrade types. For example, the changes in v2.0.x modify the `global_property_object` in the database state and so the state history log could contain a `global_property_object_v0` type (for the part of the history before the local node upgrade) and a `global_property_object_v1` type (for the part of the history after the local node upgrade). This should not cause problems for any history fillers that have been updated to support both versions of the type. However, operators should be aware that this can lead to the log file contents being slightly different across different nodes even if they all start and stop at the same blocks and have not enabled `trace-history-debug-mode`. (Replaying a v2.0.x node with state_history_plugin enabled from genesis would guarantee that the state history logs do not contain the `global_property_object_v0` type.) - -The following instructions should be followed to upgrade nodeos from v1.8.x to v2.0.x without a full replay (after making appropriate backup copies): -1. Obtain a compatible portable snapshot of the state. A v2 or v3 portable snapshot can be downloaded from a trusted source. Alternatively, one can use an existing v1.8.x node to generate a v2 portable snapshot by launching nodeos with `--read-mode=irreversible --plugin=eosio::producer_api_plugin` command-line options and then using the `/v1/producer/create_snapshot` RPC endpoint to generate a portable snapshot (e.g. run the command `curl -X POST http:/127.0.0.1:8888/v1/producer/create_snapshot -d '{}' | jq`). -2. Shut down nodeos and delete the `blocks/reversible` and `state` sub-directories within the data directory. -3. Launch nodeos v2.0.x from the generated snapshot using the `--snapshot` command line option and give it time to import the snapshot while starting up (this could take several minutes). (Subsequent launches of nodeos should not use the `--snapshot` option.) - -### Upgrading from v2.0.0-rc1, v2.0.0-rc2, or v2.0.0-rc3 - -Node operators should consider upgrading v2.0.0-rc1, v2.0.0-rc2, and v2.0.0-rc3 nodes to v2.0.0 as soon as possible. They can follow normal upgrade procedures for the upgrade. There should be no need to do a replay or import from a snapshot. diff --git a/docs/30_release-notes/87_v2.0.12.md b/docs/30_release-notes/87_v2.0.12.md deleted file mode 100644 index a7e664163a..0000000000 --- a/docs/30_release-notes/87_v2.0.12.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -link: /30_release-notes/index.md -link_text: v2.0.12 ---- diff --git a/docs/30_release-notes/88_v2.0.11.md b/docs/30_release-notes/88_v2.0.11.md deleted file mode 100644 index 46f053cca8..0000000000 --- a/docs/30_release-notes/88_v2.0.11.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -content_title: EOSIO v2.0.11 Release Notes -link_text: v2.0.11 ---- - -This release contains security and miscellaneous fixes. - -## Security bug fixes - -### Consolidated Security Fixes for v2.0.11 ([#10147](https://github.com/EOSIO/eos/pull/10147)) -- Fix issue with account query db that could result in incorrect data or hung processes - -Note: These security fixes are relevant to all nodes on EOSIO blockchain networks. - -## Other changes -- ([#10063](https://github.com/EOSIO/eos/pull/10063)) [release 2.0.x] Fix docker steps on tagged builds. -- ([#10135](https://github.com/EOSIO/eos/pull/10135)) Wlb/adding nodeos param tests 2.0.x -- ([#10133](https://github.com/EOSIO/eos/pull/10133)) fix compiling with boost 1.76; add include in chainbase - 2.0 - -## Documentation -- ([#10094](https://github.com/EOSIO/eos/pull/10094)) [docs] Add EOSIO 2.0.10 release notes to dev portal - 2.0 diff --git a/docs/30_release-notes/89_v2.0.10.md b/docs/30_release-notes/89_v2.0.10.md deleted file mode 100644 index 5ddad16cc7..0000000000 --- a/docs/30_release-notes/89_v2.0.10.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -content_title: EOSIO v2.0.10 Release Notes -link_text: v2.0.10 ---- - -This release contains security, stability, and miscellaneous fixes. - -## Security bug fixes - -### Consolidated Security Fixes for v2.0.10 ([#10091](https://github.com/EOSIO/eos/pull/10091)) -- Fix issue with account query db that could result in incorrect data or hung processes -- Implement a Subjective CPU billing system that helps P2P and API nodes better respond to extreme network congestion - -Note: These security fixes are relevant to all nodes on EOSIO blockchain networks. - -### Notes on Subjective CPU Billing - -This system consists of two primary features: a subjective (node local) view of spent CPU resources that are not yet accounted for by the blockchain that allows individual nodes to predict what resource consumption will be and, a subjective penalty system to offset work done in service of erroneous or malicious transactions. - -The subjective view of CPU resources will synchronize with the resources present in the blockchain as it discovers the true CPU billing for transactions it has already accounted for. - -The system will also accumulate CPU resources spent on failing transactions that will not be relayed in a decaying "subjective penalty" which can protect the individual nodes from abusive actors while remaining tolerant to occasional mistakes. - -Subjective billing defaults to active and can be disabled with the `disable-subjective-billing` configuration in `config.ini` or on the command line. - -## Stability bug fixes -- ([#9985](https://github.com/EOSIO/eos/pull/9985)) EPE-389 net_plugin stall during head catchup - merge release/2.0.x - -## Other changes -- ([#9894](https://github.com/EOSIO/eos/pull/9894)) EOS VM OC: Support LLVM 11 - 2.0 -- ([#9911](https://github.com/EOSIO/eos/pull/9911)) add step to the pipeline to build and push to dockerhub on release br… -- ([#9944](https://github.com/EOSIO/eos/pull/9944)) Create eosio-debug-build Pipeline -- ([#9969](https://github.com/EOSIO/eos/pull/9969)) Updating name for the new Docker hub repo EOSIO instead EOS -- ([#9971](https://github.com/EOSIO/eos/pull/9971)) Fix pinned builds error due to obsolete LLVM repo -- ([#10015](https://github.com/EOSIO/eos/pull/10015)) [release 2.0.x] Fix LRT triggers -- ([#10026](https://github.com/EOSIO/eos/pull/10026)) EPE-165: Improve logic for unlinkable blocks while sync'ing -- ([#10047](https://github.com/EOSIO/eos/pull/10047)) Reduce Docker Hub Manifest Queries -- ([#10088](https://github.com/EOSIO/eos/pull/10088)) [release 2.0.x] Specify boost version for unpinned MacOS 10.14 builds - -## Documentation -- ([#10011](https://github.com/EOSIO/eos/pull/10011)) [docs] Update various cleos how-tos and fix index - 2.0 diff --git a/docs/30_release-notes/90_v2.0.9.md b/docs/30_release-notes/90_v2.0.9.md deleted file mode 100644 index f3c2740039..0000000000 --- a/docs/30_release-notes/90_v2.0.9.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -content_title: EOSIO v2.0.9 Release Notes -link_text: v2.0.9 ---- - -This release contains security and miscellaneous fixes. - -## Security bug fixes - -### Consolidated Security Fixes for 2.0.9 ([#9841](https://github.com/EOSIO/eos/pull/9841)) -- Fixes to packed_transaction cache -- Transaction account fail limit refactor - -Note: These security fixes are relevant to all nodes on EOSIO blockchain networks. - -## Other Changes -- ([#9803](https://github.com/EOSIO/eos/pull/9803)) Fix stdout console logging: Merge back #9582 to 2.0.x diff --git a/docs/30_release-notes/91_v2.0.8.md b/docs/30_release-notes/91_v2.0.8.md deleted file mode 100644 index ecf5bad0b0..0000000000 --- a/docs/30_release-notes/91_v2.0.8.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -content_title: EOSIO v2.0.8 Release Notes -link_text: v2.0.8 ---- - -This release contains security, stability, and miscellaneous fixes. - -## Security bug fixes - -### Consolidated Security Fixes for 2.0.8 ([#9745](https://github.com/EOSIO/eos/pull/9745)) - -- Adjust eos-vm-oc string intrinsic to perform as intended. -- Adjust CPU validation logic for unapplied transactions. - -Note: These security fixes are relevant to all nodes on EOSIO blockchain networks. - -## Stability bug fixes -- ([#9370](https://github.com/EOSIO/eos/pull/9370)) set medium priority for process signed block - 2.0.x -- ([#9382](https://github.com/EOSIO/eos/pull/9382)) Handle case newaccount in Account Query DB -- ([#9412](https://github.com/EOSIO/eos/pull/9412)) port the fix of flight bytes bug into release/2.0.x -- ([#9423](https://github.com/EOSIO/eos/pull/9423)) Update to fc with variant blob fix - 2.0 -- ([#9441](https://github.com/EOSIO/eos/pull/9441)) Fix app() shutdown - 2.0 -- ([#9516](https://github.com/EOSIO/eos/pull/9516)) Keep http_plugin_impl alive while connection objects are alive - 2.0 -- ([#9624](https://github.com/EOSIO/eos/pull/9624)) Fixing typos on injected params for `producer_plugin::log_failed_tran… - -## Other Changes -- ([#9304](https://github.com/EOSIO/eos/pull/9304)) relaxing the on_notify constraint to * -- ([#9311](https://github.com/EOSIO/eos/pull/9311)) Track Source Files Excluded from Code Coverage Reports -- ([#9314](https://github.com/EOSIO/eos/pull/9314)) Prevent an older version of g++ to build eosio -- ([#9334](https://github.com/EOSIO/eos/pull/9334)) Add missing comma in loggers array -- ([#9399](https://github.com/EOSIO/eos/pull/9399)) [2.0.x] Fix docker tags when building forked PRs -- ([#9638](https://github.com/EOSIO/eos/pull/9638)) Migrate CI from Docker Hub to Amazon ECR -- ([#9657](https://github.com/EOSIO/eos/pull/9657)) CI: Fix Serial Test Bug + Simplification + UX -- ([#9665](https://github.com/EOSIO/eos/pull/9665)) Add "Testing Changes" Section to Pull Request Template - -## Documentation -- ([#9323](https://github.com/EOSIO/eos/pull/9323)) [docs] Remove unneeded options for nodeos replays - 2.0 -- ([#9322](https://github.com/EOSIO/eos/pull/9322)) [docs] Remove redundant nodeos replay example - 2.0 -- ([#9373](https://github.com/EOSIO/eos/pull/9373)) [docs] Fix broken link in Wallet API plugin - 2.0 -- ([#9464](https://github.com/EOSIO/eos/pull/9464)) [docs] Create nodeos concepts folder and rearrange folders - 2.0 -- ([#9479](https://github.com/EOSIO/eos/pull/9479)) [docs] Add explainers on CFD, eosio utilities, eosio-blocklog - 2.0 -- ([#9487](https://github.com/EOSIO/eos/pull/9487)) [docs] Minor edits on CFD explainer and eosio-blocklog reference - 2.0 -- ([#9488](https://github.com/EOSIO/eos/pull/9488)) [docs] Fix how-tos for delegating cpu/net with cleos - 2.0 -- ([#9491](https://github.com/EOSIO/eos/pull/9491)) [docs] Add EOSIO upgrade guide 2.0 to dev portal -- ([#9492](https://github.com/EOSIO/eos/pull/9492)) Add explicit left nav link for eosio 2.0 upgrade guide - 2.0 -- ([#9496](https://github.com/EOSIO/eos/pull/9496)) [docs] Add eosio 2.0 release notes to dev portal - 2.0 -- ([#9498](https://github.com/EOSIO/eos/pull/9498)) [docs] Add trace_api_util reference to eosio utilities docs - 2.0 -- ([#9503](https://github.com/EOSIO/eos/pull/9503)) [docs] Add slices, trace log, clog format explainers to Trace API plugin - 2.0 -- ([#9584](https://github.com/EOSIO/eos/pull/9584)) [docs] Update cleos get table reference - 2.0 -- ([#9592](https://github.com/EOSIO/eos/pull/9592)) [docs] Various additions/fixes to cleos reference - 2.0 -- ([#9602](https://github.com/EOSIO/eos/pull/9602)) [docs] Fix broken anchor link on MacOS build from source - 2.0 -- ([#9627](https://github.com/EOSIO/eos/pull/9627)) [docs] Update get_table_* reference in Chain API - 2.0 -- ([#9753](https://github.com/EOSIO/eos/pull/9753)) [docs] Update URL in net_api_plugin description - 2.0 -- ([#9754](https://github.com/EOSIO/eos/pull/9754)) [docs] Update some chain_api_plugin descriptions - 2.0 -- ([#9756](https://github.com/EOSIO/eos/pull/9756)) [docs] Remove sudo command from install/uninstall script instructions - 2.0 - -## Thanks! -Special thanks to the community contributors that submitted patches for this release: -- @nsjames diff --git a/docs/30_release-notes/92_v2.0.7.md b/docs/30_release-notes/92_v2.0.7.md deleted file mode 100644 index b92acb66f1..0000000000 --- a/docs/30_release-notes/92_v2.0.7.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -content_title: EOSIO v2.0.7 Release Notes -link_text: v2.0.7 ---- - -This release contains stability and miscellaneous fixes. - -## Stability bug fixes -- ([#9223](https://github.com/EOSIO/eos/pull/9223)) Fix log of pending block producer - 2.0 - -## Changes - -### The following logger has been added: `transaction_failure_tracing`. ([#9252](https://github.com/EOSIO/eos/pull/9252)) - -A detailed log that emits failed verdicts from relay nodes on the P2P network. In addition, it adds a logging statement for a failed signature condition. - -### New config file option: `max-nonprivileged-inline-action-size`. ([#9262](https://github.com/EOSIO/eos/pull/9262)) - -This option is the cap for the size of an inline action above which a transaction will subjectively fail; the default value is 4KB. - -## Other Changes -- ([#9170](https://github.com/EOSIO/eos/pull/9170)) Fix onblock trace tracking - 2.0 -- ([#9201](https://github.com/EOSIO/eos/pull/9201)) [2.0.x] Anka version bump -- ([#9265](https://github.com/EOSIO/eos/pull/9265)) Remove Concurrency Groups for Scheduled Builds - -## Documentation -- ([#9124](https://github.com/EOSIO/eos/pull/9124)) Update the authority example -- ([#9275](https://github.com/EOSIO/eos/pull/9275)) [docs] New threshold for non privileged inline actions - 2.0 -- ([#9288](https://github.com/EOSIO/eos/pull/9288)) [docs] Fix character formatting in nodeos CLI option - 2.0 -- ([#9290](https://github.com/EOSIO/eos/pull/9290)) [docs] Correct Producer API title in RPC reference - 2.0 diff --git a/docs/30_release-notes/93_v2.0.6.md b/docs/30_release-notes/93_v2.0.6.md deleted file mode 100644 index 97815d56bf..0000000000 --- a/docs/30_release-notes/93_v2.0.6.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -content_title: EOSIO v2.0.6 Release Notes -link_text: v2.0.6 ---- - -This release contains security, stability, and miscellaneous fixes. - -## Security bug fixes - -- ([#9172](https://github.com/EOSIO/eos/pull/9172)) Escape Unicode C1 control code points. - -Note: These security fixes are relevant to API nodes on EOSIO blockchain networks. - -## Stability bug fixes - -- ([#9065](https://github.com/EOSIO/eos/pull/9065)) Fix for cleos and keosd race condition - 2.0 -- ([#9089](https://github.com/EOSIO/eos/pull/9089)) make ship WA key serialization match expected serialization - 2.0 -- ([#9095](https://github.com/EOSIO/eos/pull/9095)) fix gcc10 build due to libyubihsm problem - 2.0 -- ([#9127](https://github.com/EOSIO/eos/pull/9127)) Fix onblock handling in trace_api_plugin - 2.0 -- ([#9129](https://github.com/EOSIO/eos/pull/9129)) GCC 8.3 on CentOS 7 compiler workaround - 2.0 -- ([#9128](https://github.com/EOSIO/eos/pull/9128)) Restore abi_serializer backward compatibility - 2.0 - -## Changes - -### Add more information in trace-api-plugin responses for better usage. ([#9005](https://github.com/EOSIO/eos/pull/9005)) - -Adds `transaction_mroot`, `action_mroot` and `schedule_version` in block trace. Also adds `status`, `cpu_usage_us`, `net_usage_words`, `signatures`, and `transaction_header` in transaction trace. - -### New RPC endpoint **`get_accounts_by_authorizers`** ([#8899](https://github.com/EOSIO/eos/pull/8899)) - -New optional RPC endpoint **`POST /v1/chain/get_accounts_by_authorizers`** added to `chain_api_plugin` that provides a super-set of the deprecated `history_api_plugin`'s `get_key_accounts` and `get_controlled_accounts` RPC methods. - -Flag to enable endpoint (default false): **`--enable-account-queries`** - -## Other Changes - -- ([#8975](https://github.com/EOSIO/eos/pull/8975)) failing nodeos_run_test when core symbol is not SYS - 2.0 -- ([#9002](https://github.com/EOSIO/eos/pull/9002)) Support Triggering a Build that Runs ALL Tests in One Build -- ([#9007](https://github.com/EOSIO/eos/pull/9007)) Improved reporting in nodeos_forked_chain_lr_test - 2.0.x -- ([#9013](https://github.com/EOSIO/eos/pull/9013)) Bugfix for uninitialized variable in cleos - 2.0 -- ([#9009](https://github.com/EOSIO/eos/pull/9009)) Upgrade CLI11 to 1.9.0 - 2.0 -- ([#9028](https://github.com/EOSIO/eos/pull/9028)) Fix keosd auto-launching after CLI11 upgrade - 2.0 -- ([#9035](https://github.com/EOSIO/eos/pull/9035)) For Release 2.0 - Updated the priority of the APIs in producer_api_plugin and net_api_plugin to MEDIUM_HIGH -- ([#9049](https://github.com/EOSIO/eos/pull/9049)) add rapidjson license to install - 2.0 -- ([#9052](https://github.com/EOSIO/eos/pull/9052)) Print stderr if keosd_auto_launch_test.py fails - 2.0 -- ([#9060](https://github.com/EOSIO/eos/pull/9060)) Fix uninitialized struct members used as CLI flags - 2.0 -- ([#9062](https://github.com/EOSIO/eos/pull/9062)) Fix timedelta and strftime usage - 2.0 -- ([#9078](https://github.com/EOSIO/eos/pull/9078)) Update date in LICENSE - 2.0 -- ([#9063](https://github.com/EOSIO/eos/pull/9063)) add help text to wasm-runtime - 2.0.x -- ([#9084](https://github.com/EOSIO/eos/pull/9084)) Add support for specifing a logging.json to keosd - 2.0 -- ([#9082](https://github.com/EOSIO/eos/pull/9082)) Add change type to pull request template - 2.0 -- ([#8899](https://github.com/EOSIO/eos/pull/8899)) Account Query DB : Proposal to maintain get_(key|controlled)_accounts [2.0] -- ([#9103](https://github.com/EOSIO/eos/pull/9103)) Add default contract name clarifier in how to deploy smart contract - 2.0 -- ([#9109](https://github.com/EOSIO/eos/pull/9109)) [2.0.x] Bump Anka plugin version and timeouts. -- ([#9115](https://github.com/EOSIO/eos/pull/9115)) Simplify create_snapshot POST request - 2.0 -- ([#9110](https://github.com/EOSIO/eos/pull/9110)) Update algorithm for determining number of parallel jobs - 2.0 - -## Documentation - -- ([#8980](https://github.com/EOSIO/eos/pull/8980)) Add nodeos RPC API index, improve nodeos implementation doc, fix link - 2.0 -- ([#8995](https://github.com/EOSIO/eos/pull/8995)) Update example logging.json - 2.0 -- ([#9102](https://github.com/EOSIO/eos/pull/9102)) Fix inaccurate nodeos reference in wallet_api_plugin - 2.0 -- ([#9116](https://github.com/EOSIO/eos/pull/9116)) Replace inaccurate wording in how to replay from snapshot - 2.0 -- ([#9113](https://github.com/EOSIO/eos/pull/9113)) Add trace_api logger to docs - 2.0 -- ([#9142](https://github.com/EOSIO/eos/pull/9142)) Add missing reference to RPC API index [docs] - 2.0 -- ([#9141](https://github.com/EOSIO/eos/pull/9141)) Fix Trace API reference request/response inaccuracies [docs] - 2.0 -- ([#9144](https://github.com/EOSIO/eos/pull/9144)) Fix title case issue in keosd how-to [docs] - 2.0 -- ([#9145](https://github.com/EOSIO/eos/pull/9145)) Add conditional step in state history plugin how-to [docs] - 2.0 - -## Thanks! - -Special thanks to the community contributors that submitted patches for this release: -- @cc32d9 -- @oldcold diff --git a/docs/30_release-notes/94_v2.0.5.md b/docs/30_release-notes/94_v2.0.5.md deleted file mode 100644 index 2a912715ad..0000000000 --- a/docs/30_release-notes/94_v2.0.5.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -content_title: EOSIO v2.0.5 Release Notes -link_text: v2.0.5 ---- - -This release contains security, stability, and miscellaneous fixes. - -## Security bug fixes - -### Consolidated Security Fixes for 2.0.5 ([#8983](https://github.com/EOSIO/eos/pull/8983)) - -- EOS-VM security fixes - -Note: These security fixes are relevant to all nodes on EOSIO blockchain networks. - -## Stability bug fixes - -- ([#8826](https://github.com/EOSIO/eos/pull/8826)) trace_api_plugin yield timeout - 2.0 -- ([#8836](https://github.com/EOSIO/eos/pull/8836)) fix potential leak in OC's wrapped_fd move assignment op - 2.0 - -## Changes - -### Trace API Compressed Data Log Support ([#8826](https://github.com/EOSIO/eos/pull/8826), [#8837](https://github.com/EOSIO/eos/pull/8837), [#8881](https://github.com/EOSIO/eos/pull/8881)) - -Compressed file support was added to `trace_api_plugin`. See ([#8837](https://github.com/EOSIO/eos/pull/8837)) for more details. - -The RPC call `v1/trace_api/get_block` now has "async" http support. Therefore, executing `get_block` no longer runs on the main application thread but on the configurable `http-threads` thread pool. - -Additionally, `trace_api_plugin` now respects `http-max-response-time-ms` for limiting response time of RPC call `v1/trace_api/get_block`. It is very likely that the default value of `http-max-response-time-ms` will not be appropriate for large blocks and will need to be increased. - -## Other Changes - -- ([#8822](https://github.com/EOSIO/eos/pull/8822)) Merge minimize logging changes to 2.0.x -- ([#8823](https://github.com/EOSIO/eos/pull/8823)) yield_function for abi_serializer - 2.0 -- ([#8855](https://github.com/EOSIO/eos/pull/8855)) Improve too many bytes in flight error info - 2.0 -- ([#8861](https://github.com/EOSIO/eos/pull/8861)) HTTP Plugin async APIs [2.0] -- ([#8873](https://github.com/EOSIO/eos/pull/8873)) Fix spurious HTTP related test failure [2.0] (round 3) -- ([#8883](https://github.com/EOSIO/eos/pull/8883)) wabt: don't search for python because we don't run tests - 2.0 -- ([#8884](https://github.com/EOSIO/eos/pull/8884)) Correctly Sanitize git Branch and Tag Names -- ([#8894](https://github.com/EOSIO/eos/pull/8894)) Increase get info priority to medium high -- ([#8889](https://github.com/EOSIO/eos/pull/8889)) Sync from snapshot - 2.0 -- ([#8906](https://github.com/EOSIO/eos/pull/8906)) Remove assert check for error code 400 - release 2.0.x -- ([#8944](https://github.com/EOSIO/eos/pull/8944)) noop change to macos-10.14-unpinned.sh to regen CI image, 2.0 -- ([#8941](https://github.com/EOSIO/eos/pull/8941)) replace boost::bind with std::bind, fixing boost 1.73beta builds - 2.0 -- ([#8954](https://github.com/EOSIO/eos/pull/8954)) llvm 10 support for EOS VM OC - 2.0 -- ([#8949](https://github.com/EOSIO/eos/pull/8949)) Replace bc with shell arithmetic - 2.0 -- ([#8962](https://github.com/EOSIO/eos/pull/8962)) tests/get_table_tests.cpp: incorrect use of CORE_SYM_STR - 2.0 -- ([#8963](https://github.com/EOSIO/eos/pull/8963)) Make /bin/df ignore $BLOCKSIZE - 2.0 -- ([#8952](https://github.com/EOSIO/eos/pull/8952)) Fix SHIP block delay - 2.0 -- ([#8972](https://github.com/EOSIO/eos/pull/8972)) Add possibility to run .cicd scripts from different environments (2.0.x Backport) -- ([#8968](https://github.com/EOSIO/eos/pull/8968)) Support Running ALL Tests in One Build - -## Documentation changes - -- ([#8825](https://github.com/EOSIO/eos/pull/8825)) remove leading $ chars from shell codeblocks in README.md - 2.0 -- ([#8835](https://github.com/EOSIO/eos/pull/8835)) Trace API documentation update - 2.0 -- ([#8843](https://github.com/EOSIO/eos/pull/8843)) Fix double titles for release 2.0.x -- ([#8845](https://github.com/EOSIO/eos/pull/8845)) [docs] trace api reference api correction - 2.0 -- ([#8918](https://github.com/EOSIO/eos/pull/8918)) Updates to manual build instructions - 2.0 - -## Thanks! - -Special thanks to the community contributors that submitted patches for this release: -- @cc32d9 -- @maoueh diff --git a/docs/30_release-notes/95_v2.0.4.md b/docs/30_release-notes/95_v2.0.4.md deleted file mode 100644 index 6906b87069..0000000000 --- a/docs/30_release-notes/95_v2.0.4.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -content_title: EOSIO v2.0.4 Release Notes -link_text: v2.0.4 ---- - -This release contains stability and miscellaneous fixes. - -## Deprecation Notices - -The `read-only` option for the `read-mode` parameter in `nodeos` has been deprecated. It is possible to achieve the same behavior with `read-mode = head`, `p2p-accept-transactions = false`, and `api-accept-transactions = false`. See the sub-section "Accept transactions options" below for more details. - -Please refer to the [Consolidated EOSIO Deprecations List](https://github.com/EOSIO/eos/issues/7597) for the currently active set of deprecation notices. - -## Stability bug fixes - -- ([#8684](https://github.com/EOSIO/eos/pull/8684)) Net plugin sync priority - 2.0 -- ([#8729](https://github.com/EOSIO/eos/pull/8729)) Get info priority - 2.0 - -## Changes - -### Trace API Plugin ([#8800](https://github.com/EOSIO/eos/pull/8800)) - -This release contains the first official release of the Trace API Plugin. This plugin is an optional addition to `nodeos` that stores a tailored view of the transactions and actions that execute on the chain retrievable at a block level. The Trace API focuses on operational maintainability storing data on the filesystem instead of in RAM like the deprecated `history-plugin` and organizing that data such that operators can easily prune old data without disrupting operations. - -For more information, see the PR notes and the official documentation. - -### Exit transaction early when there is insufficient account CPU ([#8638](https://github.com/EOSIO/eos/pull/8638)) - -`nodeos` no longer considers a transaction for inclusion in a block in the process of being produced if the billed account(s) do not have sufficient CPU available to cover the previously estimated CPU usage of the transaction (only if a previous estimate for CPU usage is available). - -### Produce block immediately if resource limits are exhausted ([#8651](https://github.com/EOSIO/eos/pull/8651), [#8673](https://github.com/EOSIO/eos/pull/8673)) - -`nodeos` now immediately produces a block if either the CPU or NET usage thresholds are exceeded. This change includes a fix for dropping late blocks starting 50ms earlier than the block production window. - -New options: -* `max-block-cpu-usage-threshold-us`: -Threshold (in microseconds) of CPU block production to consider block full; when accumulated CPU usage within a block is less than `max-block-cpu-usage-threshold-us` away from `max-block-cpu-usage`, the block can be produced immediately. Default value is 5000. -* `max-block-net-usage-threshold-bytes`: -Threshold (in bytes) of NET block production to consider block full; when accumulated NET usage within a block is less than `max-block-net-usage-threshold-us` away from `max-block-net-usage`, the block can be produced immediately. Default value is 1024. - -### Accept transactions options ([#8702](https://github.com/EOSIO/eos/pull/8702)) - -New options: -* `p2p-accept-transactions`: Allow transactions received over p2p -network to be evaluated and relayed if valid. Default is true. -* `api-accept-transactions`: Allow API transactions to be evaluated -and relayed if valid. Default is true. - -Provides ability to have a `read-mode = head` with `p2p-accept-transactions = false` and `api-accept-transactions = true`. This combination creates an efficient API node that is not burdened with processing P2P transactions. - -The same behavior of the now deprecated `read-mode = read-only` can be achieved with `read-mode = head` by setting `p2p-accept-transactions = false` and `api-accept-transactions = false`. - -**WARNING:** Use of `read-mode = irreversible` now requires setting `p2p-accept-transactions = false` and `api-accept-transactions = false` to avoid assertion at startup. - -### Relay block early ([#8701](https://github.com/EOSIO/eos/pull/8701)) - -Improve block relaying performance when a block is from a trusted producer or if `nodeos` is running in light validation mode. This is achieved by relaying the block as soon as block header validation is complete (but before full block application/validation). - -## Other Changes - -- ([#8654](https://github.com/EOSIO/eos/pull/8654)) Fix format message. - 2.0 -- ([#8668](https://github.com/EOSIO/eos/pull/8668)) Add troubleshooting item for PREACTIVATE_FEATURE protocol -- ([#8689](https://github.com/EOSIO/eos/pull/8689)) incoming-defer-ratio description - 2.0 -- ([#8695](https://github.com/EOSIO/eos/pull/8695)) [2.0.x] Community PR tweaks. -- ([#8700](https://github.com/EOSIO/eos/pull/8700)) [2.0.x] Base images pipeline. -- ([#8714](https://github.com/EOSIO/eos/pull/8714)) [2.0.x] Actions rerun fixes. -- ([#8710](https://github.com/EOSIO/eos/pull/8710)) Add block producing explainer doc - 2.0 -- ([#8721](https://github.com/EOSIO/eos/pull/8721)) Fix multiple version protocol test intermittent failure - 2.0 -- ([#8727](https://github.com/EOSIO/eos/pull/8727)) Update the getting started link [merge 2] -- ([#8752](https://github.com/EOSIO/eos/pull/8752)) chain_api_plugin swagger file - 2.0 -- ([#8756](https://github.com/EOSIO/eos/pull/8756)) Fixes #8600 clean up nodeos options section -- ([#8757](https://github.com/EOSIO/eos/pull/8757)) link cleos net status reference doc with the peer network protocol doc -- ([#8590](https://github.com/EOSIO/eos/pull/8590)) db_size_api_plugin swagger file - 2.0 -- ([#8591](https://github.com/EOSIO/eos/pull/8591)) net_api_plugin swagger file - 2.0 -- ([#8592](https://github.com/EOSIO/eos/pull/8592)) producer_api_plugin swagger file - 2.0 -- ([#8593](https://github.com/EOSIO/eos/pull/8593)) test_control_api_plugin swagger file - 2.0 -- ([#8754](https://github.com/EOSIO/eos/pull/8754)) swagger configuration for docs - 2.0 -- ([#8762](https://github.com/EOSIO/eos/pull/8762)) Fix broken link in producer plugin docs - 2.0 -- ([#8763](https://github.com/EOSIO/eos/pull/8763)) Fix wasm-runtime option parameters - 2.0 -- ([#8765](https://github.com/EOSIO/eos/pull/8765)) Add Incoming-defer-ratio description - 2.0 -- ([#8767](https://github.com/EOSIO/eos/pull/8767)) Fix other blocks.log callout - 2.0 -- ([#8768](https://github.com/EOSIO/eos/pull/8768)) Improve create account description - 2.0 -- ([#8782](https://github.com/EOSIO/eos/pull/8782)) link to librt when using posix timers - 2.0 -- ([#8781](https://github.com/EOSIO/eos/pull/8781)) free unknown EOS VM OC codegen versions from the code cache - 2.0 -- ([#8794](https://github.com/EOSIO/eos/pull/8794)) disable EOS VM on non-x86 platforms - 2.0 -- ([#8803](https://github.com/EOSIO/eos/pull/8803)) Expire blacklisted scheduled transactions by LIB time - 2.0 -- ([#8811](https://github.com/EOSIO/eos/pull/8811)) Add initial Trace API plugin docs to nodeos - 2.0 -- ([#8814](https://github.com/EOSIO/eos/pull/8814)) Add RPC Trace API plugin reference to nodeos - 2.0 diff --git a/docs/30_release-notes/96_v2.0.3.md b/docs/30_release-notes/96_v2.0.3.md deleted file mode 100644 index 1ba0a6ffb2..0000000000 --- a/docs/30_release-notes/96_v2.0.3.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -content_title: EOSIO v2.0.3 Release Notes -link_text: v2.0.3 ---- - -This release contains security, stability, and miscellaneous fixes. - -## Security bug fixes - -### Consolidated Security Fixes for 2.0.3 ([#8643](https://github.com/EOSIO/eos/pull/8643)) - -- Add deadline to base58 encoding. - -Note: These security fixes are relevant to all nodes on EOSIO blockchain networks. - -## Stability bug fixes - -- ([#8617](https://github.com/EOSIO/eos/pull/8617)) Init net_plugin member variables - 2.0 - -## Other Changes - -- ([#8606](https://github.com/EOSIO/eos/pull/8606)) Skip sync from genesis and resume from state test on tagged builds -- ([#8612](https://github.com/EOSIO/eos/pull/8612)) [2.0.x] Actions for community PRs. -- ([#8633](https://github.com/EOSIO/eos/pull/8633)) remove brew's python@2 install - 2.0 -- ([#8636](https://github.com/EOSIO/eos/pull/8636)) bump script's macos version check to 10.14 - 2.0 - -## Deprecation notice reminder - -Please refer to the [Consolidated EOSIO Deprecations List](https://github.com/EOSIO/eos/issues/7597) for the currently active set of deprecation notices. diff --git a/docs/30_release-notes/97_v2.0.2.md b/docs/30_release-notes/97_v2.0.2.md deleted file mode 100644 index c9707f171c..0000000000 --- a/docs/30_release-notes/97_v2.0.2.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -content_title: EOSIO v2.0.2 Release Notes -link_text: v2.0.2 ---- - -This release contains security, stability, and miscellaneous fixes. - -## Security bug fixes - -### Consolidated Security Fixes for 2.0.2 ([#8595](https://github.com/EOSIO/eos/pull/8595)) - -- Restrict allowed block signature types. - -Note: These security fixes are relevant to all nodes on EOSIO blockchain networks. - -## Stability bug fixes - -- ([#8526](https://github.com/EOSIO/eos/pull/8526)) Handle socket close before async callback - 2.0 -- ([#8546](https://github.com/EOSIO/eos/pull/8546)) Net plugin dispatch - 2.0 -- ([#8552](https://github.com/EOSIO/eos/pull/8552)) Net plugin unlinkable blocks - 2.0 -- ([#8560](https://github.com/EOSIO/eos/pull/8560)) Backport of 8056 to 2.0 -- ([#8561](https://github.com/EOSIO/eos/pull/8561)) Net plugin post - 2.0 -- ([#8564](https://github.com/EOSIO/eos/pull/8564)) Delayed production time - 2.0 - -## Changes - -### Limit block production window ([#8571](https://github.com/EOSIO/eos/pull/8571), [#8578](https://github.com/EOSIO/eos/pull/8578)) - -The new options `cpu-effort-percent` and `last-block-cpu-effort-percent` now provide a mechanism to restrict the amount of time a producer is processing transactions for inclusion into a block. It also controls the time a producer will finalize/produce and transmit a block. Block construction now always begins at whole or half seconds for the next block. - -### Stricter signature parsing - -Versions of EOSIO prior to v2.0.x accept keys and signatures containing extra data at the end. In EOSIO v2.0.x, the Base58 string parser performs additional sanity checks on keys and signatures to make sure they do not contain more data than necessary. These stricter checks cause nodes to reject signatures generated by some transaction signing libraries; eosjs v20 is known to generate proper signatures. For more information see issue [#8534](https://github.com/EOSIO/eos/issues/8534). - -## Other Changes - -- ([#8555](https://github.com/EOSIO/eos/pull/8555)) Drop late check - 2.0 -- ([#8557](https://github.com/EOSIO/eos/pull/8557)) Read-only with drop-late-block - 2.0 -- ([#8568](https://github.com/EOSIO/eos/pull/8568)) Timestamp watermark slot - 2.0.x -- ([#8577](https://github.com/EOSIO/eos/pull/8577)) [release 2.0.x] Documentation patch 1 update -- ([#8583](https://github.com/EOSIO/eos/pull/8583)) P2p read only - 2.0 -- ([#8589](https://github.com/EOSIO/eos/pull/8589)) Producer plugin log - 2.0 - -## Deprecation notice reminder - -Please refer to the [Consolidated EOSIO Deprecations List](https://github.com/EOSIO/eos/issues/7597) for the currently active set of deprecation notices. diff --git a/docs/30_release-notes/98_v2.0.1.md b/docs/30_release-notes/98_v2.0.1.md deleted file mode 100644 index 755ef919c3..0000000000 --- a/docs/30_release-notes/98_v2.0.1.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -content_title: EOSIO v2.0.1 Release Notes -link_text: v2.0.1 ---- - -This release contains security, stability, and miscellaneous fixes. - -## Security bug fixes - -### Consolidated Security Fixes for 2.0.1 ([#8514](https://github.com/EOSIO/eos/pull/8514)) - -- Earlier block validation for greater security. -- Improved handling of deferred transactions during block production. -- Reduce net plugin logging and handshake size limits. - -Note: These security fixes are relevant to all nodes on EOSIO blockchain networks. - -## Stability bug fixes - -- ([#8471](https://github.com/EOSIO/eos/pull/8471)) Remove new block id notify feature - 2.0 -- ([#8472](https://github.com/EOSIO/eos/pull/8472)) Report block header diff when digests do not match - 2.0 -- ([#8496](https://github.com/EOSIO/eos/pull/8496)) Drop late blocks - 2.0 -- ([#8510](https://github.com/EOSIO/eos/pull/8510)) http_plugin shutdown - 2.0 - -## Other Changes - -- ([#8430](https://github.com/EOSIO/eos/pull/8430)) Update fc to fix crash in logging -- ([#8435](https://github.com/EOSIO/eos/pull/8435)) [release/2.0.x] Update README.md and hotfix documentation links -- ([#8452](https://github.com/EOSIO/eos/pull/8452)) [2.0.x] [CI/CD] Boost will not install without SDKROOT -- ([#8457](https://github.com/EOSIO/eos/pull/8457)) [2.0.x] reverting fc -- ([#8458](https://github.com/EOSIO/eos/pull/8458)) [2.0.x] Pipeline file for testing the build script -- ([#8467](https://github.com/EOSIO/eos/pull/8467)) [2.0.x] Switching to using the EOSIO fork of anka-buildkite-plugin for security reasons -- ([#8515](https://github.com/EOSIO/eos/pull/8515)) [2.0.x] Don't trigger LRT a second time - -## Deprecation notice reminder - -Please refer to the [Consolidated EOSIO Deprecations List](https://github.com/EOSIO/eos/issues/7597) for the currently active set of deprecation notices. diff --git a/docs/30_release-notes/99_v2.0.0.md b/docs/30_release-notes/99_v2.0.0.md deleted file mode 100644 index 6462f86fad..0000000000 --- a/docs/30_release-notes/99_v2.0.0.md +++ /dev/null @@ -1,377 +0,0 @@ ---- -content_title: EOSIO v2.0.0 Release Notes -link_text: v2.0.0 ---- - -This release contains security, stability, and miscellaneous fixes. - -This release also includes an EOSIO consensus upgrade. Please see the "Consensus Protocol Upgrades" section below for details. These protocol upgrades necessitate a change to the state database structure which requires a nodeos upgrade process that involves more steps than in the case of most minor release upgrades. For details on the upgrade process, see the "Upgrading from previous versions of EOSIO" section below. - -## Security bug fixes - -### Consolidated Security Fixes for 2.0.0 ([#8420](https://github.com/EOSIO/eos/pull/8420)) - -- Limit size of response to API requests -- EOS VM fixes - -Note: These security fixes are relevant to all nodes on EOSIO blockchain networks. - -The above is in addition to the other security fixes that were introduced in prior release candidates for 2.0.0: - -- ([#8195](https://github.com/EOSIO/eos/pull/8195)) Consolidated Security Fixes for 2.0.0-rc2 -- ([#8344](https://github.com/EOSIO/eos/pull/8344)) Consolidated Security Fixes for 2.0.0-rc3 - -## Stability bug fixes - -- ([#8399](https://github.com/EOSIO/eos/pull/8399)) Net plugin sync check - 2.0 - -This above is in addition to the other stability fixes that were introduced in prior release candidates for 2.0.0: - -- ([#8084](https://github.com/EOSIO/eos/pull/8084)) Net plugin remove read delays - 2.0 -- ([#8099](https://github.com/EOSIO/eos/pull/8099)) net_plugin remove sync w/peer check - 2.0 -- ([#8120](https://github.com/EOSIO/eos/pull/8120)) Net plugin sync fix - 2.0 -- ([#8229](https://github.com/EOSIO/eos/pull/8229)) Net plugin sync -- ([#8285](https://github.com/EOSIO/eos/pull/8285)) Net plugin handshake -- ([#8298](https://github.com/EOSIO/eos/pull/8298)) net_plugin lib sync -- ([#8303](https://github.com/EOSIO/eos/pull/8303)) net_plugin boost asio error handling -- ([#8305](https://github.com/EOSIO/eos/pull/8305)) net_plugin thread protection peer logging variables -- ([#8311](https://github.com/EOSIO/eos/pull/8311)) Fix race in fc::message_buffer and move message_buffer_tests to fc. -- ([#8307](https://github.com/EOSIO/eos/pull/8307)) reset the new handler - -## Changes - -### EOS VM: New High Performance WASM Runtimes ([#7974](https://github.com/EOSIO/eos/pull/7974), [#7975](https://github.com/EOSIO/eos/pull/7975)) -Three new WASM runtimes are available in this release: EOS VM Interpreter, EOS VM Just In Time Compiler (JIT), and EOS VM Optimized Compiler. - -EOS VM Interpreter is a low latency interpreter and is included to enable future support for smart contract debuggers. EOS VM JIT is a low latency single pass compiler for x86_64 platforms. To use EOS VM Interpreter or EOS VM JIT, set the `wasm-runtime` to either `eos-vm` or `eos-vm-jit` respectively - -EOS VM Optimized Compiler is a high performance WASM _tier-up_ runtime available on the x86_64 Linux platform that works in conjunction with the configured baseline runtime (such as EOS VM JIT). When enabled via `eos-vm-oc-enable`, actions on a contract are initially dispatched to the baseline runtime while EOS VM Optimized Compiler does an optimized compilation in the background. Up to the configured `eos-vm-oc-compile-threads` compilations can be ongoing simultaneously. Once the background compilation is complete, actions on that contract will then be run with the optimized compiled code from then on. This optimized compile can take a handful of seconds but since it is performed in the background it does not cause delays. Optimized compilations are also saved to a new data file (`code_cache.bin` in the data directory) so when restarting nodeos there is no need to recompile previously compiled contracts. - -None of the EOS VM runtimes require a replay nor activation of any consensus protocol upgrades. They can be switched between (including enabling and disabling EOS VM Optimized Compiler) at will. - -At this time, **block producers should consider all running EOS VM JIT as the WASM runtime on their block producing nodes**. Other non-producing nodes should feel free to use the faster EOS VM Optimized Compiler runtime instead. - -### Consensus Protocol Upgrades - -Refer to this section on the [Upgrade Guide: Consensus Protocol Upgrades](../20_upgrade-guide/index.md#consensus-protocol-upgrades). - -### Multi-threaded net_plugin -We have added multi-threading support to net_plugin. Almost all processing in the net_plugin (block propagation, transaction processing, block/transaction packing/unpacking etc.) are now handled by separate threads distinct from the main application thread. This significantly improves transaction processing and block processing performance on multi-producer EOSIO networks. The `net-threads` arg (defaults to 2) controls the number of worker threads in net_plugin thread pool.([#6845](https://github.com/EOSIO/eos/pull/6845), [#7598](https://github.com/EOSIO/eos/pull/7598), [#7392](https://github.com/EOSIO/eos/pull/7392), [#7786](https://github.com/EOSIO/eos/pull/7786) and related optimizations are available in: [#7686](https://github.com/EOSIO/eos/pull/7686), [#7785](https://github.com/EOSIO/eos/pull/7785), [#7721](https://github.com/EOSIO/eos/pull/7721), [#7825](https://github.com/EOSIO/eos/pull/7825), and [#7756](https://github.com/EOSIO/eos/pull/7756)). - -### Chain API Enhancements ([#7530](https://github.com/EOSIO/eos/pull/7530)) -The `uint128` and `int128` ABI types are now represented as decimal numbers rather than the old little-endian hexadecimal representation. This means that the JSON representation of table rows returned by the `get_table_rows` RPC will represent fields using this type differently than in prior versions. It also means that the `lower_bound` and `upper_bound` fields for `get_table_rows` RPC requests that search using a `uint128` secondary index will need to use the new decimal representation. This change makes the ABI serialization for `uint128` and `int128` ABI types consistent with [eosjs](https://github.com/EOSIO/eosjs) and [abieos](http://github.com/EOSIO/abieos). - -The `get_table_rows` RPC when used with secondary index types like `sha256`, `i256`, and `ripemd160` had bugs that scrambled the bytes in the `lower_bound` and `upper_bound` input field. This release now fixes these issues allowing clients to properly search for tables rows using these index types. - -A new field `next_key` has been added to the response of the `get_table_rows` RPC which represents the key of the next row (in the same format as `lower_bound` and `upper_bound`) that was not able to be returned in the response due to timeout limitations or the user-specified limit. The value of the `next_key` can be used as the `lower_bound` input for subsequent requests in order to retrieve a range of a large number of rows that could not be retrieved within just a single request. - -## Upgrading from previous versions of EOSIO - -Refer to this section on the [Upgrade Guide: Upgrading from previous versions of EOSIO](../20_upgrade-guide/index.md#upgrading-from-previous-versions-of-eosio). - -## Deprecation and Removal Notices - -### WAVM removed ([#8407](https://github.com/EOSIO/eos/pull/8407)) - -The WAVM WebAssembly runtime was deprecated several months ago with the release of [EOSIO v2.0.0-rc1](https://github.com/EOSIO/eos/releases/tag/v2.0.0-rc1) which introduced EOS VM. Now with the release of a stable version 2.0.0, EOS VM (JIT or Optimized Compiler variants) can be used instead of WAVM. So WAVM has now been removed as a WASM runtime option from nodeos. - -### Deprecation notice reminder - -Please refer to the [Consolidated EOSIO Deprecations List](https://github.com/EOSIO/eos/issues/7597) for the currently active set of deprecation notices. - -## Other Changes - -- ([#7247](https://github.com/EOSIO/eos/pull/7247)) Change default log level from debug to info. - develop -- ([#7238](https://github.com/EOSIO/eos/pull/7238)) Remove unused cpack bits; these are not being used -- ([#7248](https://github.com/EOSIO/eos/pull/7248)) Pass env to build script installs -- ([#6913](https://github.com/EOSIO/eos/pull/6913)) Block log util#6884 -- ([#7249](https://github.com/EOSIO/eos/pull/7249)) Http configurable logging -- ([#7255](https://github.com/EOSIO/eos/pull/7255)) Move Test Metrics Code to Agent -- ([#7217](https://github.com/EOSIO/eos/pull/7217)) Created Universal Pipeline Configuration File -- ([#7264](https://github.com/EOSIO/eos/pull/7264)) use protocol-features-sync-nodes branch for LRT pipeline - develop -- ([#7207](https://github.com/EOSIO/eos/pull/7207)) Optimize mongodb plugin -- ([#7276](https://github.com/EOSIO/eos/pull/7276)) correct net_plugin's win32 check -- ([#7279](https://github.com/EOSIO/eos/pull/7279)) build unittests in c++17, not c++14 -- ([#7282](https://github.com/EOSIO/eos/pull/7282)) Fix cleos REX help - develop -- ([#7284](https://github.com/EOSIO/eos/pull/7284)) remove boost asio string_view workaround -- ([#7286](https://github.com/EOSIO/eos/pull/7286)) chainbase uniqueness violation fixes -- ([#7287](https://github.com/EOSIO/eos/pull/7287)) restrict range of error codes that contracts are allowed to emit -- ([#7278](https://github.com/EOSIO/eos/pull/7278)) simplify openssl setup in cmakelists -- ([#7288](https://github.com/EOSIO/eos/pull/7288)) Changes for Boost 1_70_0 -- ([#7285](https://github.com/EOSIO/eos/pull/7285)) Use of Mac Anka Fleet instead of iMac fleet -- ([#7293](https://github.com/EOSIO/eos/pull/7293)) Update EosioTester.cmake.in (develop) -- ([#7290](https://github.com/EOSIO/eos/pull/7290)) Block log util test -- ([#6845](https://github.com/EOSIO/eos/pull/6845)) Net plugin multithread -- ([#7295](https://github.com/EOSIO/eos/pull/7295)) Modify the pipeline control file for triggered builds -- ([#7305](https://github.com/EOSIO/eos/pull/7305)) Eliminating trigger to allow for community PR jobs to run again -- ([#7306](https://github.com/EOSIO/eos/pull/7306)) when unable to find mongo driver stop cmake -- ([#7309](https://github.com/EOSIO/eos/pull/7309)) add debug_mode to state history plugin - develop -- ([#7310](https://github.com/EOSIO/eos/pull/7310)) Switched to git checkout of commit + supporting forked repo -- ([#7291](https://github.com/EOSIO/eos/pull/7291)) add DB guard check for nodeos_under_min_avail_ram.py -- ([#7240](https://github.com/EOSIO/eos/pull/7240)) add signal tests -- ([#7315](https://github.com/EOSIO/eos/pull/7315)) Add REX balance info to cleos get account command -- ([#7304](https://github.com/EOSIO/eos/pull/7304)) transaction_metadata thread safety -- ([#7321](https://github.com/EOSIO/eos/pull/7321)) Only call init if system contract is loaded -- ([#7275](https://github.com/EOSIO/eos/pull/7275)) remove win32 from CMakeLists.txt -- ([#7322](https://github.com/EOSIO/eos/pull/7322)) Fix under min avail ram test -- ([#7327](https://github.com/EOSIO/eos/pull/7327)) fix block serialization order in fork_database::close - develop -- ([#7331](https://github.com/EOSIO/eos/pull/7331)) Use debug level logging for --verbose -- ([#7325](https://github.com/EOSIO/eos/pull/7325)) Look in both lib and lib64 for CMake modules when building EOSIO Tester -- ([#7337](https://github.com/EOSIO/eos/pull/7337)) correct signed mismatch warning in http_plugin -- ([#7348](https://github.com/EOSIO/eos/pull/7348)) Anka develop fix -- ([#7320](https://github.com/EOSIO/eos/pull/7320)) Add test for various chainbase objects which contain fields that require dynamic allocation -- ([#7350](https://github.com/EOSIO/eos/pull/7350)) correct signed mismatch warning in chain controller -- ([#7356](https://github.com/EOSIO/eos/pull/7356)) Fixes for Boost 1.70 to compile with our current CMake -- ([#7359](https://github.com/EOSIO/eos/pull/7359)) update to use boost 1.70 -- ([#7341](https://github.com/EOSIO/eos/pull/7341)) Add Version Check for Package Builder -- ([#7367](https://github.com/EOSIO/eos/pull/7367)) Fix exception # -- ([#7342](https://github.com/EOSIO/eos/pull/7342)) Update to appbase max priority on main thread -- ([#7336](https://github.com/EOSIO/eos/pull/7336)) (softfloat sync) clean up strict-aliasing rules warnings -- ([#7371](https://github.com/EOSIO/eos/pull/7371)) Adds configuration for replay test pipeline -- ([#7370](https://github.com/EOSIO/eos/pull/7370)) Fix `-b` flag for `cleos get table` subcommand -- ([#7369](https://github.com/EOSIO/eos/pull/7369)) Add `boost/asio/io_context.hpp` header to `transaction_metadata.hpp` for branch `develop` -- ([#7385](https://github.com/EOSIO/eos/pull/7385)) Ship: port #7383 and #7384 to develop -- ([#7377](https://github.com/EOSIO/eos/pull/7377)) Allow aliases of variants in ABI -- ([#7316](https://github.com/EOSIO/eos/pull/7316)) Explicit name -- ([#7389](https://github.com/EOSIO/eos/pull/7389)) Fix develop merge -- ([#7379](https://github.com/EOSIO/eos/pull/7379)) transaction deadline cleanup -- ([#7380](https://github.com/EOSIO/eos/pull/7380)) Producer incoming-transaction-queue-size-mb -- ([#7391](https://github.com/EOSIO/eos/pull/7391)) Allow for EOS clone to be a submodule -- ([#7390](https://github.com/EOSIO/eos/pull/7390)) port db_modes_test to python -- ([#7399](https://github.com/EOSIO/eos/pull/7399)) throw error if trying to create non R1 key on SE or YubiHSM wallet -- ([#7394](https://github.com/EOSIO/eos/pull/7394)) (fc sync) static_variant improvements & fix certificate trust when trust settings is empty -- ([#7405](https://github.com/EOSIO/eos/pull/7405)) Centralize EOSIO Pipeline -- ([#7401](https://github.com/EOSIO/eos/pull/7401)) state database versioning -- ([#7392](https://github.com/EOSIO/eos/pull/7392)) Trx blk connections -- ([#7433](https://github.com/EOSIO/eos/pull/7433)) use imported targets for boost & cleanup fc/appbase/chainbase standalone usage -- ([#7434](https://github.com/EOSIO/eos/pull/7434)) (chainbase) don’t keep file mapping active when in heap/locked mode -- ([#7432](https://github.com/EOSIO/eos/pull/7432)) No need to start keosd for cleos command which doesn't need keosd -- ([#7430](https://github.com/EOSIO/eos/pull/7430)) Add option for cleos sign subcommand to ask keosd for signing -- ([#7425](https://github.com/EOSIO/eos/pull/7425)) txn json to file -- ([#7440](https://github.com/EOSIO/eos/pull/7440)) Fix #7436 SIGSEGV - develop -- ([#7461](https://github.com/EOSIO/eos/pull/7461)) Name txn_test_gen threads -- ([#7442](https://github.com/EOSIO/eos/pull/7442)) Enhance cleos error message when parsing JSON argument -- ([#7451](https://github.com/EOSIO/eos/pull/7451)) set initial costs for expensive parallel unit tests -- ([#7366](https://github.com/EOSIO/eos/pull/7366)) BATS bash tests for build scripts + various other improvements and fixes -- ([#7467](https://github.com/EOSIO/eos/pull/7467)) Pipeline Configuration File Update -- ([#7476](https://github.com/EOSIO/eos/pull/7476)) Various improvements from pull/7458 -- ([#7488](https://github.com/EOSIO/eos/pull/7488)) Various BATS fixes to fix CI/CD -- ([#7489](https://github.com/EOSIO/eos/pull/7489)) Fix Incorrectly Resolved and Untested Merge Conflicts in Pipeline Configuration File -- ([#7474](https://github.com/EOSIO/eos/pull/7474)) fix copy_bin() for win32 builds -- ([#7478](https://github.com/EOSIO/eos/pull/7478)) remove stray SIGUSR1 -- ([#7475](https://github.com/EOSIO/eos/pull/7475)) guard unix socket support in http_plugin depending on platform support -- ([#7492](https://github.com/EOSIO/eos/pull/7492)) Enabled helpers for unpinned builds. -- ([#7482](https://github.com/EOSIO/eos/pull/7482)) Let delete-all-blocks option to only remove the contents instead of the directory itself -- ([#7502](https://github.com/EOSIO/eos/pull/7502)) [develop] Versioned images (prep for hashing) -- ([#7507](https://github.com/EOSIO/eos/pull/7507)) use create_directories in initialize_protocol_features - develop -- ([#7484](https://github.com/EOSIO/eos/pull/7484)) return zero exit status for nodeos version, help, fixed reversible, and extracted genesis -- ([#7468](https://github.com/EOSIO/eos/pull/7468)) Versioning library -- ([#7486](https://github.com/EOSIO/eos/pull/7486)) [develop] Ensure we're in repo root -- ([#7515](https://github.com/EOSIO/eos/pull/7515)) Custom path support for eosio installation. -- ([#7516](https://github.com/EOSIO/eos/pull/7516)) on supported platforms build with system clang by default -- ([#7519](https://github.com/EOSIO/eos/pull/7519)) [develop] Removed lrt from pipeline.jsonc -- ([#7525](https://github.com/EOSIO/eos/pull/7525)) [develop] Readlink quick fix and BATS test fixes -- ([#7532](https://github.com/EOSIO/eos/pull/7532)) [develop] BASE IMAGE Fixes -- ([#7535](https://github.com/EOSIO/eos/pull/7535)) Add -j option to print JSON format for cleos get currency balance. -- ([#7537](https://github.com/EOSIO/eos/pull/7537)) connection via listen needs to start in connecting mode -- ([#7497](https://github.com/EOSIO/eos/pull/7497)) properly add single quotes for parameter with spaces in logs output -- ([#7544](https://github.com/EOSIO/eos/pull/7544)) restore usage of devtoolset-8 on centos7 -- ([#7547](https://github.com/EOSIO/eos/pull/7547)) Sighup logging -- ([#7421](https://github.com/EOSIO/eos/pull/7421)) WebAuthn key and signature support -- ([#7572](https://github.com/EOSIO/eos/pull/7572)) [develop] Don't create mongo folders unless ENABLE_MONGO is true -- ([#7576](https://github.com/EOSIO/eos/pull/7576)) [develop] Better found/not found messages for clarity -- ([#7545](https://github.com/EOSIO/eos/pull/7545)) add nodiscard attribute to tester's push_action -- ([#7581](https://github.com/EOSIO/eos/pull/7581)) Update to fc with logger fix -- ([#7558](https://github.com/EOSIO/eos/pull/7558)) [develop] Ability to set *_DIR on CLI -- ([#7553](https://github.com/EOSIO/eos/pull/7553)) [develop] CMAKE version check before dependencies are installed -- ([#7584](https://github.com/EOSIO/eos/pull/7584)) fix hash<>::result_type deprecation spam -- ([#7588](https://github.com/EOSIO/eos/pull/7588)) [develop] Various BATS test fixes -- ([#7578](https://github.com/EOSIO/eos/pull/7578)) [develop] -i support for relative paths -- ([#7449](https://github.com/EOSIO/eos/pull/7449)) add accurate checktime timer for macOS -- ([#7591](https://github.com/EOSIO/eos/pull/7591)) [develop] SUDO_COMMAND -> NEW_SUDO_COMMAND (base fixed) -- ([#7594](https://github.com/EOSIO/eos/pull/7594)) [develop] Install location fix -- ([#7586](https://github.com/EOSIO/eos/pull/7586)) Modify transaction_ack to process bcast_transaction and rejected_transaction correctly -- ([#7585](https://github.com/EOSIO/eos/pull/7585)) Enhance cleos to enable new RPC send_transaction -- ([#7599](https://github.com/EOSIO/eos/pull/7599)) Use updated sync nodes for sync tests -- ([#7608](https://github.com/EOSIO/eos/pull/7608)) indicate in brew bottle mojave is required -- ([#7615](https://github.com/EOSIO/eos/pull/7615)) Change hardcoded currency symbol in testnet.template into a variable -- ([#7610](https://github.com/EOSIO/eos/pull/7610)) use explicit billing for unapplied and deferred transactions in tester - develop -- ([#7621](https://github.com/EOSIO/eos/pull/7621)) Call resolve on connection strand -- ([#7623](https://github.com/EOSIO/eos/pull/7623)) additional wasm unittests around max depth -- ([#7607](https://github.com/EOSIO/eos/pull/7607)) Improve nodeos make-index speeds -- ([#7598](https://github.com/EOSIO/eos/pull/7598)) Net plugin block id notification -- ([#7624](https://github.com/EOSIO/eos/pull/7624)) bios-boot-tutorial.py: bugfix, SYS hardcoded instead of using command… -- ([#7632](https://github.com/EOSIO/eos/pull/7632)) [develop] issues/7627: Install script missing ! -- ([#7634](https://github.com/EOSIO/eos/pull/7634)) fix fc::temp_directory usage in tester -- ([#7642](https://github.com/EOSIO/eos/pull/7642)) remove stale warning about dirty metadata -- ([#7640](https://github.com/EOSIO/eos/pull/7640)) fix win32 build of eosio-blocklog -- ([#7643](https://github.com/EOSIO/eos/pull/7643)) remove unused dlfcn.h include; troublesome for win32 -- ([#7645](https://github.com/EOSIO/eos/pull/7645)) add eosio-blocklog to base install component -- ([#7651](https://github.com/EOSIO/eos/pull/7651)) Port #7619 to develop -- ([#7652](https://github.com/EOSIO/eos/pull/7652)) remove raise() in keosd in favor of simple appbase quit (de-posix it) -- ([#7453](https://github.com/EOSIO/eos/pull/7453)) Refactor unapplied transaction queue -- ([#7657](https://github.com/EOSIO/eos/pull/7657)) (chainbase sync) print name of DB causing failure condition & win32 fixes -- ([#7663](https://github.com/EOSIO/eos/pull/7663)) Fix path error in cleos set code/abi -- ([#7633](https://github.com/EOSIO/eos/pull/7633)) Small optimization to move more trx processing off application thread -- ([#7662](https://github.com/EOSIO/eos/pull/7662)) fix fork resolve in special case -- ([#7667](https://github.com/EOSIO/eos/pull/7667)) fix 7600 double confirm after changing sign key -- ([#7625](https://github.com/EOSIO/eos/pull/7625)) Fix flaky tests - mainly net_plugin fixes -- ([#7672](https://github.com/EOSIO/eos/pull/7672)) Fix memory leak -- ([#7676](https://github.com/EOSIO/eos/pull/7676)) Remove unused code -- ([#7677](https://github.com/EOSIO/eos/pull/7677)) Commas go outside the quotes... -- ([#7675](https://github.com/EOSIO/eos/pull/7675)) wasm unit test with an imported function as start function -- ([#7678](https://github.com/EOSIO/eos/pull/7678)) Issue 3516 fix -- ([#7404](https://github.com/EOSIO/eos/pull/7404)) wtmsig block production -- ([#7686](https://github.com/EOSIO/eos/pull/7686)) Unapplied transaction queue performance -- ([#7685](https://github.com/EOSIO/eos/pull/7685)) Integration Test descriptions and timeout fix -- ([#7691](https://github.com/EOSIO/eos/pull/7691)) Fix nodeos 1.8.x to > 1.7.x peering issue (allowed-connection not equal to "any") -- ([#7250](https://github.com/EOSIO/eos/pull/7250)) wabt: reduce redundant memset -- ([#7702](https://github.com/EOSIO/eos/pull/7702)) fix producer_plugin watermark tracking - develop -- ([#7477](https://github.com/EOSIO/eos/pull/7477)) Fix abi_serializer to encode optional non-built_in types -- ([#7703](https://github.com/EOSIO/eos/pull/7703)) return flat_multimap from transaction::validate_and_extract_extensions -- ([#7720](https://github.com/EOSIO/eos/pull/7720)) Fix bug to make sed -i work properly on Mac -- ([#7716](https://github.com/EOSIO/eos/pull/7716)) [TRAVIS POC] develop Support passing in JOBS for docker/kube multi-tenancy -- ([#7707](https://github.com/EOSIO/eos/pull/7707)) add softfloat only injection mode -- ([#7725](https://github.com/EOSIO/eos/pull/7725)) Fix increment in test -- ([#7729](https://github.com/EOSIO/eos/pull/7729)) Fix db_modes_test -- ([#7734](https://github.com/EOSIO/eos/pull/7734)) Fix db exhaustion -- ([#7487](https://github.com/EOSIO/eos/pull/7487)) Enable extended_asset to be encoded from array -- ([#7736](https://github.com/EOSIO/eos/pull/7736)) unit test ensuring that OOB table init allowed on set code; fails on action -- ([#7744](https://github.com/EOSIO/eos/pull/7744)) (appbase) update to get non-option fix & unique_ptr tweak -- ([#7746](https://github.com/EOSIO/eos/pull/7746)) (chainbase sync) fix build with boost 1.71 -- ([#7721](https://github.com/EOSIO/eos/pull/7721)) Improve signature recovery -- ([#7757](https://github.com/EOSIO/eos/pull/7757)) remove stale license headers -- ([#7756](https://github.com/EOSIO/eos/pull/7756)) block_log performance improvement, and misc. -- ([#7654](https://github.com/EOSIO/eos/pull/7654)) exclusively use timer for checktime -- ([#7763](https://github.com/EOSIO/eos/pull/7763)) Use fc::cfile instead of std::fstream for state_history -- ([#7770](https://github.com/EOSIO/eos/pull/7770)) Net plugin sync fix -- ([#7717](https://github.com/EOSIO/eos/pull/7717)) Support for v2 snapshots with pending producer schedules -- ([#7795](https://github.com/EOSIO/eos/pull/7795)) Hardcode initial eosio ABI: #7794 -- ([#7792](https://github.com/EOSIO/eos/pull/7792)) Restore default logging if logging.json is removed when SIGHUP. -- ([#7791](https://github.com/EOSIO/eos/pull/7791)) Producer plugin -- ([#7786](https://github.com/EOSIO/eos/pull/7786)) Remove redundant work from net plugin -- ([#7785](https://github.com/EOSIO/eos/pull/7785)) Optimize block log usage -- ([#7812](https://github.com/EOSIO/eos/pull/7812)) Add IMPORTANT file and update README - develop -- ([#7820](https://github.com/EOSIO/eos/pull/7820)) rename IMPORTANT to IMPORTANT.md - develop -- ([#7809](https://github.com/EOSIO/eos/pull/7809)) Correct cpu_usage calculation when more than one signature -- ([#7803](https://github.com/EOSIO/eos/pull/7803)) callback support for checktime timer expiry -- ([#7838](https://github.com/EOSIO/eos/pull/7838)) Bandwidth - develop -- ([#7845](https://github.com/EOSIO/eos/pull/7845)) Deprecate network version match - develop -- ([#7700](https://github.com/EOSIO/eos/pull/7700)) [develop] Travis CI + Buildkite 3.0 -- ([#7825](https://github.com/EOSIO/eos/pull/7825)) apply_block optimization -- ([#7849](https://github.com/EOSIO/eos/pull/7849)) Increase Contracts Builder Timeout + Fix $SKIP_MAC -- ([#7854](https://github.com/EOSIO/eos/pull/7854)) Net plugin sync -- ([#7860](https://github.com/EOSIO/eos/pull/7860)) [develop] Ensure release flag is added to all builds. -- ([#7873](https://github.com/EOSIO/eos/pull/7873)) [develop] Mac Builder Boost Fix -- ([#7868](https://github.com/EOSIO/eos/pull/7868)) cleos get actions -- ([#7774](https://github.com/EOSIO/eos/pull/7774)) update WAVM to be compatible with LLVM 7 through 9 -- ([#7864](https://github.com/EOSIO/eos/pull/7864)) Add output of build info on nodeos startup -- ([#7881](https://github.com/EOSIO/eos/pull/7881)) [develop] Ensure Artfacts Upload on Failed Tests -- ([#7886](https://github.com/EOSIO/eos/pull/7886)) promote read-only disablement log from net_plugin to warn level -- ([#7887](https://github.com/EOSIO/eos/pull/7887)) print unix socket path when there is an error starting unix socket server -- ([#7889](https://github.com/EOSIO/eos/pull/7889)) Update docker builder tag -- ([#7891](https://github.com/EOSIO/eos/pull/7891)) Fix exit crash - develop -- ([#7877](https://github.com/EOSIO/eos/pull/7877)) Create Release Build Test -- ([#7883](https://github.com/EOSIO/eos/pull/7883)) Add Support for eosio-test-stability Pipeline -- ([#7903](https://github.com/EOSIO/eos/pull/7903)) adds support for builder priority queues -- ([#7853](https://github.com/EOSIO/eos/pull/7853)) change behavior of recover_key to better support variable length keys -- ([#7901](https://github.com/EOSIO/eos/pull/7901)) [develop] Add Trigger for LRTs and Multiversion Tests Post PR -- ([#7914](https://github.com/EOSIO/eos/pull/7914)) [Develop] Forked PR fix -- ([#7923](https://github.com/EOSIO/eos/pull/7923)) return error when attempting to remove key from YubiHSM wallet -- ([#7910](https://github.com/EOSIO/eos/pull/7910)) [Develop] Updated anka plugin, added failover for registries, and added sleep fix for git clone/networking bug -- ([#7926](https://github.com/EOSIO/eos/pull/7926)) Better error check in test -- ([#7919](https://github.com/EOSIO/eos/pull/7919)) decouple wavm runtime from being required & initial support for platform specific wasm runtimes -- ([#7927](https://github.com/EOSIO/eos/pull/7927)) Fix Release Build Type for macOS on Travis CI -- ([#7931](https://github.com/EOSIO/eos/pull/7931)) Fix intermittent crash on exit when port already in use - develop -- ([#7930](https://github.com/EOSIO/eos/pull/7930)) use -fdiagnostics-color=always even for clang -- ([#7933](https://github.com/EOSIO/eos/pull/7933)) [Develop] Support all BK/Travis cases in Submodule Regression Script -- ([#7943](https://github.com/EOSIO/eos/pull/7943)) Change eosio-launcher enable-gelf-logging argument default to false. -- ([#7946](https://github.com/EOSIO/eos/pull/7946)) Forked chain test error statement - develop -- ([#7948](https://github.com/EOSIO/eos/pull/7948)) net_plugin correctly handle unknown_block_exception - develop -- ([#7954](https://github.com/EOSIO/eos/pull/7954)) remove bad semicolon (in unused but compiled code) -- ([#7952](https://github.com/EOSIO/eos/pull/7952)) Unable to Create Block Log Index #7865 -- ([#7953](https://github.com/EOSIO/eos/pull/7953)) Refactor producer plugin start_block - develop -- ([#7841](https://github.com/EOSIO/eos/pull/7841)) 7646 chain id in blog -- ([#7958](https://github.com/EOSIO/eos/pull/7958)) [develop] Fix Mac builds on Travis -- ([#7962](https://github.com/EOSIO/eos/pull/7962)) set immutable chain_id during construction of controller -- ([#7957](https://github.com/EOSIO/eos/pull/7957)) Upgrade to Boost 1.71.0 -- ([#7971](https://github.com/EOSIO/eos/pull/7971)) Net plugin unexpected block - develop -- ([#7967](https://github.com/EOSIO/eos/pull/7967)) support unix socket HTTP server for nodeos -- ([#7947](https://github.com/EOSIO/eos/pull/7947)) Function body code size test -- ([#7955](https://github.com/EOSIO/eos/pull/7955)) EOSIO WASM Spec tests -- ([#7978](https://github.com/EOSIO/eos/pull/7978)) use the LLVM 7 library provided by SCL on CentOS7 -- ([#7983](https://github.com/EOSIO/eos/pull/7983)) port consolidated security fixes for 1.8.4 to develop; add unit tests associated with consolidated security fixes for 1.8.1 -- ([#7986](https://github.com/EOSIO/eos/pull/7986)) Remove unnecessary comment -- ([#7985](https://github.com/EOSIO/eos/pull/7985)) more bug fixes with chain_id in state changes -- ([#7974](https://github.com/EOSIO/eos/pull/7974)) Experimental/wb2 jit -- ([#7989](https://github.com/EOSIO/eos/pull/7989)) Correct designator order for field of get_table_rows_params -- ([#7992](https://github.com/EOSIO/eos/pull/7992)) move wasm_allocator from wasm_interface to controller -- ([#7995](https://github.com/EOSIO/eos/pull/7995)) new timeout to handle when two jobs on the same host are maxing their… -- ([#7993](https://github.com/EOSIO/eos/pull/7993)) update eos-vm to latest develop, fix issues with instantiation limit … -- ([#7991](https://github.com/EOSIO/eos/pull/7991)) missing block log chain id unit tests -- ([#8001](https://github.com/EOSIO/eos/pull/8001)) Net plugin trx progress - develop -- ([#8003](https://github.com/EOSIO/eos/pull/8003)) update eos-vm ref -- ([#7988](https://github.com/EOSIO/eos/pull/7988)) Net plugin version match -- ([#8004](https://github.com/EOSIO/eos/pull/8004)) bump version -- ([#7975](https://github.com/EOSIO/eos/pull/7975)) EOS-VM Optimized Compiler -- ([#8007](https://github.com/EOSIO/eos/pull/8007)) disallow WAVM with EOS-VM OC -- ([#8010](https://github.com/EOSIO/eos/pull/8010)) Change log level of index write -- ([#8009](https://github.com/EOSIO/eos/pull/8009)) pending incoming order on subjective failure -- ([#8013](https://github.com/EOSIO/eos/pull/8013)) ensure eos-vm-oc headers get installed -- ([#8008](https://github.com/EOSIO/eos/pull/8008)) Increase stability of nodeos_under_min_avail_ram.py - develop -- ([#8015](https://github.com/EOSIO/eos/pull/8015)) two fixes for eosio tester cmake modules -- ([#8019](https://github.com/EOSIO/eos/pull/8019)) [Develop] Change submodule script to see stderr for git commands -- ([#8014](https://github.com/EOSIO/eos/pull/8014)) Retain persisted trx until expired on speculative nodes -- ([#8024](https://github.com/EOSIO/eos/pull/8024)) Add optional ability to disable WASM Spec Tests -- ([#8023](https://github.com/EOSIO/eos/pull/8023)) Make subjective_cpu_leeway a config option -- ([#8025](https://github.com/EOSIO/eos/pull/8025)) Fix build script LLVM symlinking -- ([#8026](https://github.com/EOSIO/eos/pull/8026)) update EOS VM Optimized Compiler naming convention -- ([#8012](https://github.com/EOSIO/eos/pull/8012)) 7939 trim block log v3 support -- ([#8029](https://github.com/EOSIO/eos/pull/8029)) update eos-vm ref and install eos-vm license -- ([#8033](https://github.com/EOSIO/eos/pull/8033)) net_plugin better error for unknown block -- ([#8034](https://github.com/EOSIO/eos/pull/8034)) EOS VM OC license updates -- ([#8042](https://github.com/EOSIO/eos/pull/8042)) [2.0.x] dockerhub | eosio/producer -> eosio/ci -- ([#8050](https://github.com/EOSIO/eos/pull/8050)) Add greylist limit - v2.0.x -- ([#8060](https://github.com/EOSIO/eos/pull/8060)) #8054: fix commas in ship abi -- ([#8072](https://github.com/EOSIO/eos/pull/8072)) nodeos & keosd version reporting - 2.0 -- ([#8071](https://github.com/EOSIO/eos/pull/8071)) Update cleos to support new producer schedule - 2.0 -- ([#8070](https://github.com/EOSIO/eos/pull/8070)) don't rebuild llvm unnecessarily during pinned builds - 2.0 -- ([#8074](https://github.com/EOSIO/eos/pull/8074)) [2.0.x] Upgrade mac anka template to 10.14.6 -- ([#8076](https://github.com/EOSIO/eos/pull/8076)) Handle cases where version_* not specified in CMakeLists.txt - 2.0 -- ([#8088](https://github.com/EOSIO/eos/pull/8088)) [2.0.x] Linux build fleet update -- ([#8091](https://github.com/EOSIO/eos/pull/8091)) report block extensions_type contents in RPC and eosio-blocklog tool - 2.0 -- ([#8105](https://github.com/EOSIO/eos/pull/8105)) Modify --print-default-config to exit with success - 2.0 -- ([#8113](https://github.com/EOSIO/eos/pull/8113)) [2.0.x] WASM Spec Test Step in CI -- ([#8114](https://github.com/EOSIO/eos/pull/8114)) [2.0.x] Mac OSX steps need a min of 1 hour -- ([#8127](https://github.com/EOSIO/eos/pull/8127)) [2.0.x] Move the ensure step into the build step, eliminating the need for templaters -- ([#8144](https://github.com/EOSIO/eos/pull/8144)) fix pinned builds on fresh macOS install - 2.0 -- ([#8149](https://github.com/EOSIO/eos/pull/8149)) [2.0.x] CI platform directories -- ([#8155](https://github.com/EOSIO/eos/pull/8155)) Post State history callback as medium priority - 2.0 -- ([#8173](https://github.com/EOSIO/eos/pull/8173)) ensure GMP is always dynamically linked - 2.0 -- ([#8175](https://github.com/EOSIO/eos/pull/8175)) [2.0.x] Unpinned and WASM test fixes -- ([#8168](https://github.com/EOSIO/eos/pull/8168)) add harden flags to cicd & pinned builds - 2.0 -- ([#8180](https://github.com/EOSIO/eos/pull/8180)) [2.0.x] 10 second sleep to address heavy usage wait-network bug in Anka -- ([#8192](https://github.com/EOSIO/eos/pull/8192)) Reduce logging - 2.0 -- ([#8367](https://github.com/EOSIO/eos/pull/8367)) Add Sync from Genesis Test -- ([#8363](https://github.com/EOSIO/eos/pull/8363)) Fix linking OpenSSL (branch `release/2.0.x`) -- ([#8383](https://github.com/EOSIO/eos/pull/8383)) Escape BUILDKITE_COMMIT to generate tag properly -- ([#8385](https://github.com/EOSIO/eos/pull/8385)) Propagate exceptions out push_block - 2.0 -- ([#8391](https://github.com/EOSIO/eos/pull/8391)) Add eosio-resume-from-state Test -- ([#8393](https://github.com/EOSIO/eos/pull/8393)) Make multiversion protocol test conditional. -- ([#8402](https://github.com/EOSIO/eos/pull/8402)) fix EOS VM OC monitor thread name - 2.0 -- ([#8406](https://github.com/EOSIO/eos/pull/8406)) [2.0.x] Modified Amazon and Centos to use yum install ccache -- ([#8414](https://github.com/EOSIO/eos/pull/8414)) Add better logging of exceptions in emit - 2.0 -- ([#8328](https://github.com/EOSIO/eos/pull/8328)) Fix bios boot python script due to 2.0.x changes -- ([#8293](https://github.com/EOSIO/eos/pull/8293)) Add nodeos/cleos/keosd docs from develop, update README -- ([#8425](https://github.com/EOSIO/eos/pull/8425)) fix discovery of openssl in tester cmake when OPENSSL_ROOT_DIR not set - 2.0 - -## Thanks! - -Special thanks to the community contributors that submitted patches for this release: -- @UMU618 -- @conr2d -- @YordanPavlov -- @baegjae -- @olexiybuyanskyy -- @spartucus -- @rdewilder diff --git a/docs/30_release-notes/index.md b/docs/30_release-notes/index.md deleted file mode 100644 index 94b9a53f52..0000000000 --- a/docs/30_release-notes/index.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -content_title: EOSIO v2.0.12 Release Notes ---- - -This release contains security updates and miscellaneous fixes. - -## Security updates - -### Consolidated Security Updates for v2.0.12 ([#10264](https://github.com/EOSIO/eos/pull/10264)) -- Apply three-strikes rule to all transaction failures -- Apply unconditional subjective CPU check along with some additional logging -- Provide options to enable subjective CPU billing for P2P and API transactions ,and provide an option to disable it for individual accounts - -This release expands upon the subjective CPU billing introduced in ([v2.0.10](https://github.com/EOSIO/eos/tree/v2.0.10)). Subjective billing (disabled by default) can now be applied to transactions that come in from either P2P connections, API requests, or both. By setting `disable-subjective-billing` to `false` both P2P and API transactions will have subjective CPU billing applied. Using `disable-subjective-p2p-billing` and/or `disable-subjective-api-billing` will allow subjective CPU billing to be enabled/disabled for P2P transactions or API transactions respectively. Another option , `disable-subjective-account-billing = `, is used to selectively disable subjective CPU billing for certain accounts while applying subjective CPU billing to all other accounts. - -`cleos get account` is enhanced to report `subjective cpu bandwidth`, which contains used subjective CPU billing in microseconds for a particular account on a given node. - -Note: These security updates are relevant to all nodes on EOSIO blockchain networks. - - -## Other changes -- ([#10155](https://github.com/EOSIO/eos/pull/10155)) [2.0.x] Improve timeouts occurring on Anka builds. -- ([#10171](https://github.com/EOSIO/eos/pull/10171)) Wlb/ctest generalization for parameter tests 2.0.x -- ([#10233](https://github.com/EOSIO/eos/pull/10233)) Support Running Version Tests on Fresh OS Installs -- ([#10244](https://github.com/EOSIO/eos/pull/10244)) migrate boost downloads from BinTray to JFrog Artifactory - 2.0 -- ([#10250](https://github.com/EOSIO/eos/pull/10250)) Rel 2.0.x: Subjective CPU billing cleos enhancement and adding subjective_cpu_bill to /v1/chain/get_account result -## Documentation -- ([#10186](https://github.com/EOSIO/eos/pull/10186)) Add EOSIO 2.0.11 release notes to dev portal - 2.0 diff --git a/docs/index.md b/docs/index.md index 9cfcdb8292..8acf1ecb74 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,21 +1,21 @@ --- -content_title: EOSIO Overview +content_title: Mandel Overview --- -EOSIO is the next-generation blockchain platform for creating and deploying smart contracts and distributed applications. EOSIO comes with a number of programs. The primary ones included in EOSIO are the following: +Mandel is the next-generation blockchain platform for creating and deploying smart contracts and distributed applications. Mandel comes with a number of programs. The primary ones included in Mandel are the following: -* [Nodeos](01_nodeos/index.md) (node + eos = nodeos) - Core service daemon that runs a node for block production, API endpoints, or local development. -* [Cleos](02_cleos/index.md) (cli + eos = cleos) - Command line interface to interact with the blockchain (via `nodeos`) and manage wallets (via `keosd`). -* [Keosd](03_keosd/index.md) (key + eos = keosd) - Component that manages EOSIO keys in wallets and provides a secure enclave for digital signing. +* [Nodeos](01_nodeos/index.md) - Core service daemon that runs a node for block production, API endpoints, or local development. +* [Cleos](02_cleos/index.md) - Command line interface to interact with the blockchain (via `nodeos`) and manage wallets (via `keosd`). +* [Keosd](03_keosd/index.md) - Component that manages Mandel keys in wallets and provides a secure enclave for digital signing. The basic relationship between these components is illustrated in the diagram below. -![EOSIO components](eosio_components.png) +![Mandel components](mandel_components.png) -Additional EOSIO Resources: -* [EOSIO Utilities](10_utilities/index.md) - Utilities that complement the EOSIO software. -* [Upgrade Guide](20_upgrade-guide/index.md) - EOSIO version/protocol upgrade guide. -* [Release Notes](30_release-notes/index.md) - All release notes for this EOSIO version. +Additional Mandel Resources: +* [Mandel Utilities](10_utilities/index.md) - Utilities that complement the Mandel software. +* [Upgrade Guide](20_upgrade-guide/index.md) - Mandel version/protocol upgrade guide. +* [Release Notes](30_release-notes/index.md) - All release notes for this Mandel version. [[info | What's Next?]] -| [Install the EOSIO Software](00_install/index.md) before exploring the sections above. +| [Install the Mandel Software](00_install/index.md) before exploring the sections above. diff --git a/docs/eosio_components.png b/docs/mandel_components.png similarity index 100% rename from docs/eosio_components.png rename to docs/mandel_components.png From 4c8f1fd39f213791d67a498923339bdccd617169 Mon Sep 17 00:00:00 2001 From: 766C6164 Date: Thu, 7 Jul 2022 08:16:58 -0400 Subject: [PATCH 03/18] Fixes added link to DUNE --- docs/00_install/01_build-from-source/index.md | 122 +++++++++++++----- docs/00_install/index.md | 8 +- .../02_usage/01_nodeos-configuration.md | 5 +- .../03_development-environment/index.md | 4 +- 4 files changed, 103 insertions(+), 36 deletions(-) diff --git a/docs/00_install/01_build-from-source/index.md b/docs/00_install/01_build-from-source/index.md index 7e9bdfbc44..31a3888b4b 100644 --- a/docs/00_install/01_build-from-source/index.md +++ b/docs/00_install/01_build-from-source/index.md @@ -4,53 +4,117 @@ content_title: Build Mandel from Source The shell scripts previously recommended for building the software have been removed in favor of a build process entirely driven by CMake. Those wishing to build from source are now responsible for installing the necessary dependencies. The list of dependencies and the recommended build procedure are in the README.md file. Instructions are also included for efficiently running the tests. -## Building Mandel +### Building From Source +Recent Ubuntu LTS releases are the only Linux distributions that we fully support. Other Linux distros and other POSIX operating systems (such as macOS) are tended to on a best-effort basis and may not be full featured. Notable requirements to build are: +* C++17 compiler and standard library +* boost 1.67+ +* CMake 3.8+ +* (for Linux only) LLVM 7 - 11 (newer versions do not work) + +A few other common libraries are tools also required such as openssl 1.1+, libcurl, curl, libusb, GMP, Python 3, and zlib. + +**A Warning On Parallel Compilation Jobs (`-j` flag)**: When building C/C++ software often the build is performed in parallel via a command such as `make -j $(nproc)` which uses the number of CPU cores as the number of compilation jobs to perform simultaneously. However, be aware that some compilation units (.cpp files) in mandel are extremely complex and will consume nearly 4GB of memory to compile. You may need to reduce the level of parallelization depending on the amount of memory on your build host. e.g. instead of `make -j $(nproc)` run `make -j2`. Failures due to memory exhaustion will typically but not always manifest as compiler crashes. + +Generally we recommend performing what we refer to as a "pinned build" which ensures the compiler and boost version remain the same between builds of different mandel versions (mandel requires these versions remain the same otherwise its state needs to be repopulated from a portable snapshot). + +#### Building Pinned Build Binary Packages +In the directory `/scripts` you will find the two scripts `install_deps.sh` and `pinned_build.sh`. If you haven't installed build dependencies then run `install_deps.sh`. Then run `pinned_build.sh `. + +The dependencies directory is where the script will pull the C++ dependencies that need to be built with the pinned compiler for building the pinned binaries for binary packaging. + +The binary package will be produced in the mandel build directory that was supplied. + +#### Manual (non "pinned") Build Instructions + +
+ Ubuntu 20.04 & 22.04 Build Instructions + +Install required dependencies: +``` +apt-get update && apt-get install \ + build-essential \ + cmake \ + curl \ + git \ + libboost-all-dev \ + libcurl4-openssl-dev \ + libgmp-dev \ + libssl-dev \ + libusb-1.0-0-dev \ + llvm-11-dev \ + pkg-config +``` +and perform the build: ``` git submodule update --init --recursive mkdir build cd build cmake -DCMAKE_BUILD_TYPE=Release .. -make -j $(nproc) +make -j $(nproc) package ``` +
-We support the following CMake options: +
+ Ubuntu 18.04 Build Instructions + +Install required dependencies. You will need to build Boost from source on this distribution. ``` --DCMAKE_CXX_COMPILER_LAUNCHER=ccache Speed up builds --DCMAKE_C_COMPILER_LAUNCHER=ccache Speed up builds --DCMAKE_BUILD_TYPE=DEBUG Debug builds --DDISABLE_WASM_SPEC_TESTS=yes Speed up builds and skip many tests --DCMAKE_INSTALL_PREFIX=/foo/bar Where to install to --DENABLE_OC=no Disable OC support; useful when this repo is used - as a library --GNinja Use ninja instead of make - (faster on high-core-count machines) +apt-get update && apt-get install \ + build-essential \ + cmake \ + curl \ + g++-8 \ + git \ + libcurl4-openssl-dev \ + libgmp-dev \ + libssl-dev \ + libusb-1.0-0-dev \ + llvm-7-dev \ + pkg-config \ + python3 \ + zlib1g-dev + +curl -L https://boostorg.jfrog.io/artifactory/main/release/1.79.0/source/boost_1_79_0.tar.bz2 | tar jx && \ + cd boost_1_79_0 && \ + ./bootstrap.sh --prefix=$HOME/boost1.79 && \ + ./b2 --with-iostreams --with-date_time --with-filesystem --with-system \ + --with-program_options --with-chrono --with-test -j$(nproc) install && \ + cd .. ``` - -I highly recommend the ccache options. They don't speed up the first clean build, but they speed up future clean builds after the first build. - -### Running tests - +and perform the build: ``` +git submodule update --init --recursive +mkdir build cd build +cmake -DCMAKE_C_COMPILER=gcc-8 -DCMAKE_CXX_COMPILER=g++-8 \ + -DCMAKE_PREFIX_PATH="$HOME/boost1.79;/usr/lib/llvm-7/" -DCMAKE_BUILD_TYPE=Release .. \ +make -j $(nproc) package +``` +After building you may remove the `$HOME/boost1.79` directory, or you may keep it around until next time building the software. +
-# Runs parallelizable tests in parallel. This runs much faster when -# -DDISABLE_WASM_SPEC_TESTS=yes is used. -ctest -j $(nproc) -LE "nonparallelizable_tests|long_running_tests" -E "full-version-label-test|release-build-test|print-build-info-test" +### Running Tests -# These tests can't run in parallel. -ctest -L "nonparallelizable_tests" +When building from source it's recommended to run at least what we refer to as the "parallelizable tests". Not included by default in the "parallelizable tests" are the WASM spec tests which can add additional coverage and can also be run in parallel. -# These tests can't run in parallel. They also take a long time to run. -ctest -L "long_running_tests" ``` +cd build -## Other Compilers +# "parallelizable tests": the minimum test set that should be run +ctest -j $(nproc) -LE _tests -To override `clang`'s default compiler toolchain, add these flags to the `cmake` command within the above instructions: +# Also consider running the WASM spec tests for more coverage +ctest -j $(nproc) -L wasm_spec_tests +``` -`-DCMAKE_CXX_COMPILER=/path/to/c++ -DCMAKE_C_COMPILER=/path/to/cc` +Some other tests are available and recommended but be aware they can be sensitive to other software running on the same host and they may **SIGKILL** other nodeos instances running on the host. +``` +cd build -## Debug Builds +# These tests can't run in parallel but are recommended. +ctest -L "nonparallelizable_tests" -For a debug build, add `-DCMAKE_BUILD_TYPE=Debug`. Other common build types include `Release` and `RelWithDebInfo`. +# These tests can't run in parallel. They also take a long time to run. +ctest -L "long_running_tests" +``` \ No newline at end of file diff --git a/docs/00_install/index.md b/docs/00_install/index.md index 7ed71bdcdb..4d39062839 100644 --- a/docs/00_install/index.md +++ b/docs/00_install/index.md @@ -15,4 +15,10 @@ Mandel currently supports the following operating systems: 3. Ubuntu 22.04 [[info | Note]] -| It may be possible to install Mandel on other Unix-based operating systems. This is not officially supported, though. +| It may be possible to build and install Mandel on other Unix-based operating systems. This is not officially supported, though. + +## Docker Utilities for Node Execution (D.U.N.E.) + +If you are using different operating system or prefer not to build Mandel from source you can try our Docker - based set of utilities called DUNE that can get you started with exploring Mandel and doing contract development pretty much instantly + +* [Docker Utilities for Node Execution (D.U.N.E.)](https://github.com/eosnetworkfoundation/DUNE) diff --git a/docs/01_nodeos/02_usage/01_nodeos-configuration.md b/docs/01_nodeos/02_usage/01_nodeos-configuration.md index 7ed18bc8f6..1ab5db8933 100644 --- a/docs/01_nodeos/02_usage/01_nodeos-configuration.md +++ b/docs/01_nodeos/02_usage/01_nodeos-configuration.md @@ -10,9 +10,8 @@ For example, the CLI option `--plugin eosio::chain_api_plugin` can also be set b ## `config.ini` location -The default `config.ini` can be found in the following folders: -- Mac OS: `~/Library/Application Support/eosio/nodeos/config` -- Linux: `~/.local/share/eosio/nodeos/config` +The default `config.ini` can be found in the following folder on Linux: +`~/.local/share/eosio/nodeos/config` A custom `config.ini` file can be set by passing the `nodeos` option `--config path/to/config.ini`. diff --git a/docs/01_nodeos/02_usage/03_development-environment/index.md b/docs/01_nodeos/02_usage/03_development-environment/index.md index c09829aba9..6ced9ef847 100644 --- a/docs/01_nodeos/02_usage/03_development-environment/index.md +++ b/docs/01_nodeos/02_usage/03_development-environment/index.md @@ -19,9 +19,7 @@ While this option can technically be used for smart contract development, it may ## Official Testnet -The official testnet is available for testing Mandel dApps and smart contracts: - -* [testnet.eos.io](https://testnet.eos.io/) +The official testnet for testing Mandel dApps and smart contracts will be available soon ## Third-Party Testnets From 0da59704a62c9969779112aa29f0de46c1b57264 Mon Sep 17 00:00:00 2001 From: 766C6164 Date: Thu, 7 Jul 2022 12:57:03 -0400 Subject: [PATCH 04/18] Mandel -> EOSIO --- docs/00_install/01_build-from-source/index.md | 2 +- docs/00_install/index.md | 12 ++++++------ .../02_node-setups/00_producing-node.md | 8 ++++---- .../02_node-setups/01_non-producing-node.md | 8 ++++---- .../00_local-single-node-testnet.md | 4 ++-- .../01_local-multi-node-testnet.md | 8 ++++---- .../03_development-environment/index.md | 4 ++-- .../01_nodeos/03_plugins/chain_plugin/index.md | 2 +- .../01_nodeos/03_plugins/login_plugin/index.md | 2 +- .../03_plugins/producer_plugin/index.md | 4 ++-- ...10_how-to-fast-start-without-old-history.md | 2 +- ...ow-to-replay-or-resync-with-full-history.md | 2 +- ...how-to-create-snapshot-with-full-history.md | 2 +- ...ow-to-restore-snapshot-with-full-history.md | 2 +- .../03_plugins/trace_api_plugin/index.md | 8 ++++---- .../03_plugins/txn_test_gen_plugin/index.md | 2 +- docs/01_nodeos/06_logging/index.md | 4 ++-- .../07_concepts/05_storage-and-read-modes.md | 6 +++--- .../07_concepts/10_context-free-data/index.md | 2 +- docs/01_nodeos/08_troubleshooting/index.md | 4 ++-- docs/01_nodeos/index.md | 6 +++--- .../02_how-to-guides/how-to-create-a-wallet.md | 2 +- .../how-to-create-an-account.md | 10 +++++----- .../how-to-create-key-pairs.md | 6 +++--- .../how-to-delegate-CPU-resource.md | 6 +++--- .../how-to-delegate-net-resource.md | 6 +++--- .../how-to-deploy-a-smart-contract.md | 2 +- .../how-to-get-account-information.md | 10 +++++----- .../how-to-get-block-information.md | 4 ++-- .../how-to-get-transaction-information.md | 6 +++--- .../02_how-to-guides/how-to-import-a-key.md | 4 ++-- .../how-to-list-all-key-pairs.md | 4 ++-- .../03_command-reference/create/account.md | 2 +- .../03_command-reference/net/connect.md | 2 +- .../03_command-reference/net/disconnect.md | 2 +- .../02_cleos/03_command-reference/net/peers.md | 2 +- .../03_command-reference/net/status.md | 2 +- .../03_command-reference/set/set-account.md | 2 +- docs/02_cleos/04_troubleshooting.md | 2 +- docs/02_cleos/index.md | 6 +++--- docs/03_keosd/index.md | 4 ++-- docs/10_utilities/index.md | 6 +++--- docs/index.md | 18 +++++++++--------- 43 files changed, 101 insertions(+), 101 deletions(-) diff --git a/docs/00_install/01_build-from-source/index.md b/docs/00_install/01_build-from-source/index.md index 31a3888b4b..343ad80ccc 100644 --- a/docs/00_install/01_build-from-source/index.md +++ b/docs/00_install/01_build-from-source/index.md @@ -1,5 +1,5 @@ --- -content_title: Build Mandel from Source +content_title: Build EOSIO from Source --- The shell scripts previously recommended for building the software have been removed in favor of a build process entirely driven by CMake. Those wishing to build from source are now responsible for installing the necessary dependencies. The list of dependencies and the recommended build procedure are in the README.md file. Instructions are also included for efficiently running the tests. diff --git a/docs/00_install/index.md b/docs/00_install/index.md index 4d39062839..0bfa20716f 100644 --- a/docs/00_install/index.md +++ b/docs/00_install/index.md @@ -1,24 +1,24 @@ --- -content_title: Mandel Software Installation +content_title: EOSIO Software Installation --- -The best way to install and use the Mandel software is to build it from source: +The best way to install and use the EOSIO software is to build it from source: -* [Build Mandel from Source](01_build-from-source/index.md) +* [Build EOSIO from Source](01_build-from-source/index.md) ## Supported Operating Systems -Mandel currently supports the following operating systems: +EOSIO currently supports the following operating systems: 1. Ubuntu 18.04 2. Ubuntu 20.04 3. Ubuntu 22.04 [[info | Note]] -| It may be possible to build and install Mandel on other Unix-based operating systems. This is not officially supported, though. +| It may be possible to build and install EOSIO on other Unix-based operating systems. This is not officially supported, though. ## Docker Utilities for Node Execution (D.U.N.E.) -If you are using different operating system or prefer not to build Mandel from source you can try our Docker - based set of utilities called DUNE that can get you started with exploring Mandel and doing contract development pretty much instantly +If you are using different operating system or prefer not to build EOSIO from source you can try our Docker - based set of utilities called DUNE that can get you started with exploring EOSIO and doing contract development pretty much instantly * [Docker Utilities for Node Execution (D.U.N.E.)](https://github.com/eosnetworkfoundation/DUNE) diff --git a/docs/01_nodeos/02_usage/02_node-setups/00_producing-node.md b/docs/01_nodeos/02_usage/02_node-setups/00_producing-node.md index d6950fc4c7..f9555ba262 100644 --- a/docs/01_nodeos/02_usage/02_node-setups/00_producing-node.md +++ b/docs/01_nodeos/02_usage/02_node-setups/00_producing-node.md @@ -7,12 +7,12 @@ content_title: Producing Node Setup ## Goal -This section describes how to set up a producing node within the Mandel network. A producing node, as its name implies, is a node that is configured to produce blocks in an `Mandel` based blockchain. This functionality if provided through the `producer_plugin` as well as other [Nodeos Plugins](../../03_plugins/index.md). +This section describes how to set up a producing node within the EOSIO network. A producing node, as its name implies, is a node that is configured to produce blocks in an `EOSIO` based blockchain. This functionality if provided through the `producer_plugin` as well as other [Nodeos Plugins](../../03_plugins/index.md). ## Before you begin -* [Install the Mandel software](../../../00_install/index.md) before starting this section. -* It is assumed that `nodeos`, `cleos`, and `keosd` are accessible through the path. If you built Mandel using shell scripts, make sure to run the [Install Script](../../../00_install/01_build-from-source/01_shell-scripts/03_install-eosio-binaries.md). +* [Install the EOSIO software](../../../00_install/index.md) before starting this section. +* It is assumed that `nodeos`, `cleos`, and `keosd` are accessible through the path. If you built EOSIO using shell scripts, make sure to run the [Install Script](../../../00_install/01_build-from-source/01_shell-scripts/03_install-eosio-binaries.md). * Know how to pass [Nodeos options](../../02_usage/00_nodeos-options.md) to enable or disable functionality. ## Steps @@ -49,7 +49,7 @@ producer-name = youraccount You will need to set the private key for your producer. The public key should have an authority for the producer account defined above. `signature-provider` is defined with a 3-field tuple: -* `public-key` - A valid Mandel public key in form of a string. +* `public-key` - A valid EOSIO public key in form of a string. * `provider-spec` - It's a string formatted like : * `provider-type` - KEY or KEOSD diff --git a/docs/01_nodeos/02_usage/02_node-setups/01_non-producing-node.md b/docs/01_nodeos/02_usage/02_node-setups/01_non-producing-node.md index 6ad52526e1..77365ef18f 100644 --- a/docs/01_nodeos/02_usage/02_node-setups/01_non-producing-node.md +++ b/docs/01_nodeos/02_usage/02_node-setups/01_non-producing-node.md @@ -4,12 +4,12 @@ content_title: Non-producing Node Setup ## Goal -This section describes how to set up a non-producing node within the Mandel network. A non-producing node is a node that is not configured to produce blocks, instead it is connected and synchronized with other peers from an `Mandel` based blockchain, exposing one or more services publicly or privately by enabling one or more [Nodeos Plugins](../../03_plugins/index.md), except the `producer_plugin`. +This section describes how to set up a non-producing node within the EOSIO network. A non-producing node is a node that is not configured to produce blocks, instead it is connected and synchronized with other peers from an `EOSIO` based blockchain, exposing one or more services publicly or privately by enabling one or more [Nodeos Plugins](../../03_plugins/index.md), except the `producer_plugin`. ## Before you begin -* [Install the Mandel software](../../../00_install/index.md) before starting this section. -* It is assumed that `nodeos`, `cleos`, and `keosd` are accessible through the path. If you built Mandel using shell scripts, make sure to run the [Install Script](../../../00_install/01_build-from-source/01_shell-scripts/03_install-eosio-binaries.md). +* [Install the EOSIO software](../../../00_install/index.md) before starting this section. +* It is assumed that `nodeos`, `cleos`, and `keosd` are accessible through the path. If you built EOSIO using shell scripts, make sure to run the [Install Script](../../../00_install/01_build-from-source/01_shell-scripts/03_install-eosio-binaries.md). * Know how to pass [Nodeos options](../../02_usage/00_nodeos-options.md) to enable or disable functionality. ## Steps @@ -37,4 +37,4 @@ nodeos ... --p2p-peer-address=106.10.42.238:9876 ### 2. Enable one or more available plugins -Each available plugin is listed and detailed in the [Nodeos Plugins](../../03_plugins/index.md) section. When `nodeos` starts, it will expose the functionality provided by the enabled plugins it was started with. For example, if you start `nodeos` with [`state_history_plugin`](../../03_plugins/state_history_plugin/index.md) enabled, you will have a non-producing node that offers full blockchain history. If you start `nodeos` with [`http_plugin`](../../03_plugins/http_plugin/index.md) enabled, you will have a non-producing node which exposes the Mandel RPC API. Therefore, you can extend the basic functionality provided by a non-producing node by enabling any number of existing plugins on top of it. Another aspect to consider is that some plugins have dependencies to other plugins. Therefore, you need to satisfy all dependencies for a plugin in order to enable it. +Each available plugin is listed and detailed in the [Nodeos Plugins](../../03_plugins/index.md) section. When `nodeos` starts, it will expose the functionality provided by the enabled plugins it was started with. For example, if you start `nodeos` with [`state_history_plugin`](../../03_plugins/state_history_plugin/index.md) enabled, you will have a non-producing node that offers full blockchain history. If you start `nodeos` with [`http_plugin`](../../03_plugins/http_plugin/index.md) enabled, you will have a non-producing node which exposes the EOSIO RPC API. Therefore, you can extend the basic functionality provided by a non-producing node by enabling any number of existing plugins on top of it. Another aspect to consider is that some plugins have dependencies to other plugins. Therefore, you need to satisfy all dependencies for a plugin in order to enable it. diff --git a/docs/01_nodeos/02_usage/03_development-environment/00_local-single-node-testnet.md b/docs/01_nodeos/02_usage/03_development-environment/00_local-single-node-testnet.md index f1e7f8be2a..53ca22048c 100644 --- a/docs/01_nodeos/02_usage/03_development-environment/00_local-single-node-testnet.md +++ b/docs/01_nodeos/02_usage/03_development-environment/00_local-single-node-testnet.md @@ -12,8 +12,8 @@ This section describes how to set up a single-node blockchain configuration runn ## Before you begin -* [Install the Mandel software](../../../00_install/index.md) before starting this section. -* It is assumed that `nodeos`, `cleos`, and `keosd` are accessible through the path. If you built Mandel using shell scripts, make sure to run the [Install Script](../../../00_install/01_build-from-source/01_shell-scripts/03_install-eosio-binaries.md). +* [Install the EOSIO software](../../../00_install/index.md) before starting this section. +* It is assumed that `nodeos`, `cleos`, and `keosd` are accessible through the path. If you built EOSIO using shell scripts, make sure to run the [Install Script](../../../00_install/01_build-from-source/01_shell-scripts/03_install-eosio-binaries.md). * Know how to pass [Nodeos options](../../02_usage/00_nodeos-options.md) to enable or disable functionality. ## Steps diff --git a/docs/01_nodeos/02_usage/03_development-environment/01_local-multi-node-testnet.md b/docs/01_nodeos/02_usage/03_development-environment/01_local-multi-node-testnet.md index 2794ad9c79..9bccdf0fed 100644 --- a/docs/01_nodeos/02_usage/03_development-environment/01_local-multi-node-testnet.md +++ b/docs/01_nodeos/02_usage/03_development-environment/01_local-multi-node-testnet.md @@ -10,7 +10,7 @@ This section describes how to set up a multi-node blockchain configuration runni ## Before you begin -* [Install the Mandel software](../../../00_install/index.md) before starting this section. +* [Install the EOSIO software](../../../00_install/index.md) before starting this section. * It is assumed that `nodeos`, `cleos`, and `keosd` are accessible through the path. * Know how to pass [Nodeos options](../../02_usage/00_nodeos-options.md) to enable or disable functionality. @@ -23,7 +23,7 @@ Open four "terminal" windows and perform the following steps: - [Steps](#steps) - [1. Start the Wallet Manager](#1-start-the-wallet-manager) - [2. Create a Default Wallet](#2-create-a-default-wallet) - - [3. Loading the Mandel Key](#3-loading-the-mandel-key) + - [3. Loading the EOSIO Key](#3-loading-the-mandel-key) - [4. Start the First Producer Node](#4-start-the-first-producer-node) - [5. Start the Second Producer Node](#5-start-the-second-producer-node) - [6. Get Nodes Info](#6-get-nodes-info) @@ -69,7 +69,7 @@ Without password imported keys will not be retrievable. `keosd` will generate some status output in its window. We will continue to use this second window for subsequent `cleos` commands. -### 3. Loading the Mandel Key +### 3. Loading the EOSIO Key The private blockchain launched in the steps above is created with a default initial key which must be loaded into the wallet. @@ -93,7 +93,7 @@ This creates a special producer, known as the "bios" producer. Assuming everythi ### 5. Start the Second Producer Node -The following commands assume that you are running this tutorial from the `eos\build` directory, from which you ran `./eosio_build.sh` to build the Mandel binaries. +The following commands assume that you are running this tutorial from the `eos\build` directory, from which you ran `./eosio_build.sh` to build the EOSIO binaries. To start additional nodes, you must first load the `eosio.bios` contract. This contract enables you to have direct control over the resource allocation of other accounts and to access other privileged API calls. Return to the second terminal window and run the following command to load the contract: diff --git a/docs/01_nodeos/02_usage/03_development-environment/index.md b/docs/01_nodeos/02_usage/03_development-environment/index.md index 6ced9ef847..fcb7f7b463 100644 --- a/docs/01_nodeos/02_usage/03_development-environment/index.md +++ b/docs/01_nodeos/02_usage/03_development-environment/index.md @@ -19,11 +19,11 @@ While this option can technically be used for smart contract development, it may ## Official Testnet -The official testnet for testing Mandel dApps and smart contracts will be available soon +The official testnet for testing EOSIO dApps and smart contracts will be available soon ## Third-Party Testnets -The following third-party testnets are available for testing Mandel dApps and smart contracts: +The following third-party testnets are available for testing EOSIO dApps and smart contracts: * Jungle Testnet [monitor](https://monitor.jungletestnet.io/), [website](https://jungletestnet.io/) * [CryptoKylin Testnet](https://www.cryptokylin.io/) diff --git a/docs/01_nodeos/03_plugins/chain_plugin/index.md b/docs/01_nodeos/03_plugins/chain_plugin/index.md index 3815ef6346..b60b394dd3 100644 --- a/docs/01_nodeos/03_plugins/chain_plugin/index.md +++ b/docs/01_nodeos/03_plugins/chain_plugin/index.md @@ -1,6 +1,6 @@ ## Description -The `chain_plugin` is a core plugin required to process and aggregate chain data on a Mandel node. +The `chain_plugin` is a core plugin required to process and aggregate chain data on a EOSIO node. ## Usage diff --git a/docs/01_nodeos/03_plugins/login_plugin/index.md b/docs/01_nodeos/03_plugins/login_plugin/index.md index 74d0b2a205..68df9d4c1e 100644 --- a/docs/01_nodeos/03_plugins/login_plugin/index.md +++ b/docs/01_nodeos/03_plugins/login_plugin/index.md @@ -1,6 +1,6 @@ ## Description -The `login_plugin` supports the concept of applications authenticating with the Mandel blockchain. The `login_plugin` API allows an application to verify whether an account is allowed to sign in order to satisfy a specified authority. +The `login_plugin` supports the concept of applications authenticating with the EOSIO blockchain. The `login_plugin` API allows an application to verify whether an account is allowed to sign in order to satisfy a specified authority. ## Usage diff --git a/docs/01_nodeos/03_plugins/producer_plugin/index.md b/docs/01_nodeos/03_plugins/producer_plugin/index.md index ac6475e761..14b5be24ba 100644 --- a/docs/01_nodeos/03_plugins/producer_plugin/index.md +++ b/docs/01_nodeos/03_plugins/producer_plugin/index.md @@ -49,7 +49,7 @@ Config Options for eosio::producer_plugin: = Where: is a string form of - a vaild Mandel public + a vaild EOSIO public key is a string in the @@ -59,7 +59,7 @@ Config Options for eosio::producer_plugin: is KEY, or KEOSD KEY: is a string form of - a valid Mandel + a valid EOSIO private key which maps to the provided public key diff --git a/docs/01_nodeos/03_plugins/state_history_plugin/10_how-to-fast-start-without-old-history.md b/docs/01_nodeos/03_plugins/state_history_plugin/10_how-to-fast-start-without-old-history.md index facd99cbac..4e1f534483 100644 --- a/docs/01_nodeos/03_plugins/state_history_plugin/10_how-to-fast-start-without-old-history.md +++ b/docs/01_nodeos/03_plugins/state_history_plugin/10_how-to-fast-start-without-old-history.md @@ -8,7 +8,7 @@ This procedure records the current chain state and future history, without previ ## Before you begin -* Make sure [Mandel is installed](../../../00_install/index.md). +* Make sure [EOSIO is installed](../../../00_install/index.md). * Learn about [Using Nodeos](../../02_usage/index.md). * Get familiar with [state_history_plugin](../../03_plugins/state_history_plugin/index.md). diff --git a/docs/01_nodeos/03_plugins/state_history_plugin/20_how-to-replay-or-resync-with-full-history.md b/docs/01_nodeos/03_plugins/state_history_plugin/20_how-to-replay-or-resync-with-full-history.md index b1ada13126..9f0a7308f0 100644 --- a/docs/01_nodeos/03_plugins/state_history_plugin/20_how-to-replay-or-resync-with-full-history.md +++ b/docs/01_nodeos/03_plugins/state_history_plugin/20_how-to-replay-or-resync-with-full-history.md @@ -8,7 +8,7 @@ This procedure records the entire chain history. ## Before you begin -* Make sure [Mandel is installed](../../../00_install/index.md). +* Make sure [EOSIO is installed](../../../00_install/index.md). * Learn about [Using Nodeos](../../02_usage/index.md). * Get familiar with [state_history_plugin](../../03_plugins/state_history_plugin/index.md). diff --git a/docs/01_nodeos/03_plugins/state_history_plugin/30_how-to-create-snapshot-with-full-history.md b/docs/01_nodeos/03_plugins/state_history_plugin/30_how-to-create-snapshot-with-full-history.md index 712b48c7a5..19d69e9c28 100644 --- a/docs/01_nodeos/03_plugins/state_history_plugin/30_how-to-create-snapshot-with-full-history.md +++ b/docs/01_nodeos/03_plugins/state_history_plugin/30_how-to-create-snapshot-with-full-history.md @@ -8,7 +8,7 @@ This procedure creates a database containing the chain state, with full history ## Before you begin -* Make sure [Mandel is installed](../../../00_install/index.md). +* Make sure [EOSIO is installed](../../../00_install/index.md). * Learn about [Using Nodeos](../../02_usage/index.md). * Get familiar with [state_history_plugin](../../03_plugins/state_history_plugin/index.md). diff --git a/docs/01_nodeos/03_plugins/state_history_plugin/40_how-to-restore-snapshot-with-full-history.md b/docs/01_nodeos/03_plugins/state_history_plugin/40_how-to-restore-snapshot-with-full-history.md index 582ea6b6c2..6eb2e76db4 100644 --- a/docs/01_nodeos/03_plugins/state_history_plugin/40_how-to-restore-snapshot-with-full-history.md +++ b/docs/01_nodeos/03_plugins/state_history_plugin/40_how-to-restore-snapshot-with-full-history.md @@ -8,7 +8,7 @@ This procedure restores an existing snapshot with full history, so the node can ## Before you begin -* Make sure [Mandel is installed](../../../00_install/index.md). +* Make sure [EOSIO is installed](../../../00_install/index.md). * Learn about [Using Nodeos](../../02_usage/index.md). * Get familiar with [state_history_plugin](../../03_plugins/state_history_plugin/index.md). diff --git a/docs/01_nodeos/03_plugins/trace_api_plugin/index.md b/docs/01_nodeos/03_plugins/trace_api_plugin/index.md index 696a397709..160e2aa2e5 100644 --- a/docs/01_nodeos/03_plugins/trace_api_plugin/index.md +++ b/docs/01_nodeos/03_plugins/trace_api_plugin/index.md @@ -5,11 +5,11 @@ The `trace_api_plugin` provides a consumer-focused long-term API for retrieving ## Purpose -While integrating applications such as block explorers and exchanges with a Mandel blockchain, the user might require a complete transcript of actions processed by the blockchain, including those spawned from the execution of smart contracts and scheduled transactions. The `trace_api_plugin` serves this need. The purpose of the plugin is to provide: +While integrating applications such as block explorers and exchanges with a EOSIO blockchain, the user might require a complete transcript of actions processed by the blockchain, including those spawned from the execution of smart contracts and scheduled transactions. The `trace_api_plugin` serves this need. The purpose of the plugin is to provide: * A transcript of retired actions and related metadata * A consumer-focused long-term API to retrieve blocks -* Maintainable resource commitments at the Mandel nodes +* Maintainable resource commitments at the EOSIO nodes Therefore, one crucial goal of the `trace_api_plugin` is to improve the maintenance of node resources (file system, disk space, memory used, etc.). This goal is different from the existing `history_plugin` which provides far more configurable filtering and querying capabilities, or the existing `state_history_plugin` which provides a binary streaming interface to access structural chain data, action data, as well as state deltas. @@ -101,7 +101,7 @@ nodeos ... --plugin eosio::chain_plugin [options] \ ## Configuration Example -Here is a `nodeos` configuration example for the `trace_api_plugin` when tracing some Mandel reference contracts: +Here is a `nodeos` configuration example for the `trace_api_plugin` when tracing some EOSIO reference contracts: ```sh nodeos --data-dir data_dir --config-dir config_dir --trace-dir traces_dir @@ -191,7 +191,7 @@ If resource usage cannot be effectively managed via the `trace-minimum-irreversi ## Manual Maintenance -The `trace-dir` option defines the directory on the filesystem where the trace log files are stored by the `trace_api_plugin`. These files are stable once the LIB block has progressed past a given slice and then can be deleted at any time to reclaim filesystem space. The deployed Mandel system will tolerate any out-of-process management system that removes some or all of these files in this directory regardless of what data they represent, or whether there is a running `nodeos` instance accessing them or not. Data which would nominally be available, but is no longer so due to manual maintenance, will result in a HTTP 404 response from the appropriate API endpoint(s). +The `trace-dir` option defines the directory on the filesystem where the trace log files are stored by the `trace_api_plugin`. These files are stable once the LIB block has progressed past a given slice and then can be deleted at any time to reclaim filesystem space. The deployed EOSIO system will tolerate any out-of-process management system that removes some or all of these files in this directory regardless of what data they represent, or whether there is a running `nodeos` instance accessing them or not. Data which would nominally be available, but is no longer so due to manual maintenance, will result in a HTTP 404 response from the appropriate API endpoint(s). [[info | For node operators]] | Node operators can take full control over the lifetime of the historical data available in their nodes via the `trace-api-plugin` and the `trace-minimum-irreversible-history-blocks` and `trace-minimum-uncompressed-irreversible-history-blocks` options in conjunction with any external filesystem resource manager. diff --git a/docs/01_nodeos/03_plugins/txn_test_gen_plugin/index.md b/docs/01_nodeos/03_plugins/txn_test_gen_plugin/index.md index 9150e4fd1b..efbb5a0204 100644 --- a/docs/01_nodeos/03_plugins/txn_test_gen_plugin/index.md +++ b/docs/01_nodeos/03_plugins/txn_test_gen_plugin/index.md @@ -4,7 +4,7 @@ The `txn_test_gen_plugin` is used for transaction test purposes. [[info | For More Information]] -For more information, check the [txn_test_gen_plugin/README.md](https://github.com/eosnetworkfoundation/mandel/tree/main/plugins/txn_test_gen_plugin) on the Mandel/eos repository. +For more information, check the [txn_test_gen_plugin/README.md](https://github.com/eosnetworkfoundation/mandel/tree/main/plugins/txn_test_gen_plugin) on the EOSIO/eos repository. ## Usage diff --git a/docs/01_nodeos/06_logging/index.md b/docs/01_nodeos/06_logging/index.md index 0b1fdb8c7d..8a7670e7fb 100644 --- a/docs/01_nodeos/06_logging/index.md +++ b/docs/01_nodeos/06_logging/index.md @@ -6,7 +6,7 @@ Logging for `nodeos` is controlled by the `logging.json` file. CLI options can b ## Appenders -The logging library built into Mandel supports two appender types: +The logging library built into EOSIO supports two appender types: - [Console](#console) - [GELF](#gelf) (Graylog Extended Log Format) @@ -74,7 +74,7 @@ Example: ## Loggers -The logging library built into Mandel currently supports the following loggers: +The logging library built into EOSIO currently supports the following loggers: - `default` - the default logger, always enabled. - `net_plugin_impl` - detailed logging for the net plugin. diff --git a/docs/01_nodeos/07_concepts/05_storage-and-read-modes.md b/docs/01_nodeos/07_concepts/05_storage-and-read-modes.md index b682285906..df2a872729 100644 --- a/docs/01_nodeos/07_concepts/05_storage-and-read-modes.md +++ b/docs/01_nodeos/07_concepts/05_storage-and-read-modes.md @@ -2,7 +2,7 @@ content_title: Storage and Read Modes --- -The Mandel platform stores blockchain information in various data structures at various stages of a transaction's lifecycle. Some of these are described below. The producing node is the `nodeos` instance run by the block producer who is currently creating blocks for the blockchain (which changes every 6 seconds, producing 12 blocks in sequence before switching to another producer.) +The EOSIO platform stores blockchain information in various data structures at various stages of a transaction's lifecycle. Some of these are described below. The producing node is the `nodeos` instance run by the block producer who is currently creating blocks for the blockchain (which changes every 6 seconds, producing 12 blocks in sequence before switching to another producer.) ## Blockchain State and Storage @@ -15,9 +15,9 @@ Every `nodeos` instance creates some internal files to housekeep the blockchain * The `pending block` is an in memory block containing transactions as they are processed and pushed into the block; this will/may eventually become the head block. If the `nodeos` instance is the producing node, the pending block is distributed to other `nodeos` instances. * Outside the chain state, block data is cached in RAM until it becomes final/irreversible; especifically the signed block itself. After the last irreversible block (LIB) catches up to the block, that block is then retrieved from the irreversible blocks log. -## Mandel Interfaces +## EOSIO Interfaces -Mandel provides a set of [services](../../) and [interfaces](https://developers.eos.io/manuals/eosio.cdt/latest/files) that enable contract developers to persist state across action, and consequently transaction, boundaries. Contracts may use these services and interfaces for various purposes. For example, `eosio.token` contract keeps balances for all users in the chain database. Each instance of `nodeos` keeps the database in memory, so contracts can read and write data with ease. +EOSIO provides a set of [services](../../) and [interfaces](https://developers.eos.io/manuals/eosio.cdt/latest/files) that enable contract developers to persist state across action, and consequently transaction, boundaries. Contracts may use these services and interfaces for various purposes. For example, `eosio.token` contract keeps balances for all users in the chain database. Each instance of `nodeos` keeps the database in memory, so contracts can read and write data with ease. ### Nodeos RPC API diff --git a/docs/01_nodeos/07_concepts/10_context-free-data/index.md b/docs/01_nodeos/07_concepts/10_context-free-data/index.md index cb894d55ee..0a31072bcb 100644 --- a/docs/01_nodeos/07_concepts/10_context-free-data/index.md +++ b/docs/01_nodeos/07_concepts/10_context-free-data/index.md @@ -4,7 +4,7 @@ link_text: Context-Free Data --- ## Overview -The immutable nature of the blockchain allows data to be stored securely while also enforcing the integrity of such data. However, this benefit also complicates the removal of non-essential data from the blockchain. Consequently, Mandel blockchains contain a special section within the transaction, called the *context-free data*. As its name implies, data stored in the context-free data section is considered free of previous contexts or dependencies, which makes their potential removal possible. More importantly, such removal can be performed safely without compromising the integrity of the blockchain. +The immutable nature of the blockchain allows data to be stored securely while also enforcing the integrity of such data. However, this benefit also complicates the removal of non-essential data from the blockchain. Consequently, EOSIO blockchains contain a special section within the transaction, called the *context-free data*. As its name implies, data stored in the context-free data section is considered free of previous contexts or dependencies, which makes their potential removal possible. More importantly, such removal can be performed safely without compromising the integrity of the blockchain. ## Concept The goal of context-free data is to allow blockchain applications the option to store non-essential information within a transaction. Some examples of context-free data include: diff --git a/docs/01_nodeos/08_troubleshooting/index.md b/docs/01_nodeos/08_troubleshooting/index.md index be225e3070..92db833328 100644 --- a/docs/01_nodeos/08_troubleshooting/index.md +++ b/docs/01_nodeos/08_troubleshooting/index.md @@ -28,7 +28,7 @@ Command Line Options for eosio::chain_plugin: Start `nodeos` with `--shared-memory-size-mb 1024`. A 1 GB shared memory file allows approximately half a million transactions. -### What version of Mandel am I running/connecting to? +### What version of EOSIO am I running/connecting to? If defaults can be used, then `cleos get info` will output a block that contains a field called `server_version`. If your `nodeos` is not using the defaults, then you need to know the URL of the `nodeos`. In that case, use the following with your `nodeos` URL: @@ -44,4 +44,4 @@ cleos --url http://localhost:8888 get info | grep server_version ### Error 3070000: WASM Exception Error -If you try to deploy the `eosio.bios` contract or `eosio.system` contract in an attempt to boot a Mandel-based blockchain and you get the following error or similar: `Publishing contract... Error 3070000: WASM Exception Error Details: env.set_proposed_producers_ex unresolveable`, it is because you have to activate the `PREACTIVATE_FEATURE` protocol first. More details about it and how to enable it can be found in the [Bios Boot Sequence Tutorial](https://developers.eos.io/welcome/latest/tutorials/bios-boot-sequence/#112-set-the-eosiosystem-contract). For more information, you may also visit the [Nodeos Upgrade Guides](https://developers.eos.io/manuals/eos/latest/nodeos/upgrade-guides/). +If you try to deploy the `eosio.bios` contract or `eosio.system` contract in an attempt to boot a EOSIO-based blockchain and you get the following error or similar: `Publishing contract... Error 3070000: WASM Exception Error Details: env.set_proposed_producers_ex unresolveable`, it is because you have to activate the `PREACTIVATE_FEATURE` protocol first. More details about it and how to enable it can be found in the [Bios Boot Sequence Tutorial](https://developers.eos.io/welcome/latest/tutorials/bios-boot-sequence/#112-set-the-eosiosystem-contract). For more information, you may also visit the [Nodeos Upgrade Guides](https://developers.eos.io/manuals/eos/latest/nodeos/upgrade-guides/). diff --git a/docs/01_nodeos/index.md b/docs/01_nodeos/index.md index 21b8e045a1..9877dc16a9 100644 --- a/docs/01_nodeos/index.md +++ b/docs/01_nodeos/index.md @@ -4,11 +4,11 @@ content_title: Nodeos ## Introduction -`nodeos` is the core service daemon that runs on every Mandel node. It can be configured to process smart contracts, validate transactions, produce blocks containing valid transactions, and confirm blocks to record them on the blockchain. +`nodeos` is the core service daemon that runs on every EOSIO node. It can be configured to process smart contracts, validate transactions, produce blocks containing valid transactions, and confirm blocks to record them on the blockchain. ## Installation -`nodeos` is distributed as part of the [Mandel software suite](https://github.com/eosnetworkfoundation/mandel). To install `nodeos`, visit the [Mandel Software Installation](../00_install/index.md) section. +`nodeos` is distributed as part of the [EOSIO software suite](https://github.com/eosnetworkfoundation/mandel). To install `nodeos`, visit the [EOSIO Software Installation](../00_install/index.md) section. ## Explore @@ -23,4 +23,4 @@ Navigate the sections below to configure and use `nodeos`. * [Troubleshooting](08_troubleshooting/index.md) - Common `nodeos` troubleshooting questions. [[info | Access Node]] -| A local or remote Mandel access node running `nodeos` is required for a client application or smart contract to interact with the blockchain. +| A local or remote EOSIO access node running `nodeos` is required for a client application or smart contract to interact with the blockchain. diff --git a/docs/02_cleos/02_how-to-guides/how-to-create-a-wallet.md b/docs/02_cleos/02_how-to-guides/how-to-create-a-wallet.md index f5a6528f0b..4973217f16 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-create-a-wallet.md +++ b/docs/02_cleos/02_how-to-guides/how-to-create-a-wallet.md @@ -11,7 +11,7 @@ Make sure you meet the following requirements: * Install the currently supported version of `cleos`. [[info | Note]] -| `cleos` is bundled with the Mandel software. [Installing Mandel](../../00_install/index.md) will also install `cleos`. +| `cleos` is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install `cleos`. * Understand what an [account](https://developers.eos.io/welcome/latest/glossary/index/#account) is and its role in the blockchain. * Understand [Accounts and Permissions](https://developers.eos.io/welcome/latest/protocol-guides/accounts_and_permissions) in the protocol documents. diff --git a/docs/02_cleos/02_how-to-guides/how-to-create-an-account.md b/docs/02_cleos/02_how-to-guides/how-to-create-an-account.md index 528c500a37..20fc565847 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-create-an-account.md +++ b/docs/02_cleos/02_how-to-guides/how-to-create-an-account.md @@ -1,6 +1,6 @@ ## Overview -This how-to guide provides instructions on how to create a new Mandel blockchain account using the `cleos` CLI tool. You can use accounts to deploy smart contracts and perform other related blockchain operations. Create one or multiple accounts as part of your development environment setup. +This how-to guide provides instructions on how to create a new EOSIO blockchain account using the `cleos` CLI tool. You can use accounts to deploy smart contracts and perform other related blockchain operations. Create one or multiple accounts as part of your development environment setup. The example in this how-to guide creates a new account named **bob**, authorized by the default system account **eosio**, using the `cleos` CLI tool. @@ -10,8 +10,8 @@ Make sure you meet the following requirements: * Install the currently supported version of `cleos`. [[info | Note]] -| The cleos tool is bundled with the Mandel software. [Installing Mandel](../../00_install/index.md) will also install the cleos tool. -* Learn about [Mandel Accounts and Permissions](https://developers.eos.io/welcome/v2.1/protocol/accounts_and_permissions) +| The cleos tool is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install the cleos tool. +* Learn about [EOSIO Accounts and Permissions](https://developers.eos.io/welcome/v2.1/protocol/accounts_and_permissions) * Learn about Asymmetric Cryptography - [public key](https://developers.eos.io/welcome/v2.1/glossary/index#public-key) and [private key](https://developers.eos.io/welcome/v2.1/glossary/index#private-key) pairs. * Create public/private keypairs for the `owner` and `active` permissions of an account. @@ -34,7 +34,7 @@ cleos create account eosio bob EOS87TQktA5RVse2EguhztfQVEh6XXxBmgkU8b4Y5YnGvtYAo * `bob` = the name of the new account conforming to [account naming conventions](https://developers.eos.io/welcome/v2.1/protocol-guides/accounts_and_permissions#2-accounts) * `EOS87TQ...AoLGNN` = the owner public key or permission level for the new account (**required**) [[info | Note]] -| To create a new account in the Mandel blockchain, an existing account, also referred to as a creator account, is required to authorize the creation of a new account. For a newly created Mandel blockchain, the default system account used to create a new account is **eosio**. +| To create a new account in the EOSIO blockchain, an existing account, also referred to as a creator account, is required to authorize the creation of a new account. For a newly created EOSIO blockchain, the default system account used to create a new account is **eosio**. **Example Output** @@ -46,4 +46,4 @@ warning: transaction executed locally, but may not be confirmed by the network y ### Summary -By following these instructions, you are able to create a new Mandel account in your blockchain environment. +By following these instructions, you are able to create a new EOSIO account in your blockchain environment. diff --git a/docs/02_cleos/02_how-to-guides/how-to-create-key-pairs.md b/docs/02_cleos/02_how-to-guides/how-to-create-key-pairs.md index 385fc6b017..069d14e0d1 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-create-key-pairs.md +++ b/docs/02_cleos/02_how-to-guides/how-to-create-key-pairs.md @@ -1,14 +1,14 @@ ## Overview -This how-to guide provides instructions on how to create a keypair consisting of a public key and a private key for signing transactions in a Mandel blockchain. +This how-to guide provides instructions on how to create a keypair consisting of a public key and a private key for signing transactions in a EOSIO blockchain. ## Before you begin Make sure you meet the following requirements: * Install the currently supported version of `cleos` [[info | Note]] -| The cleos tool is bundled with the Mandel software. [Installing Mandel](../../00_install/index.md) will also install the cleos tool. -* Learn about asymmetric cryptography (public and private keypair) in the context of a Mandel blockchain. +| The cleos tool is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install the cleos tool. +* Learn about asymmetric cryptography (public and private keypair) in the context of a EOSIO blockchain. ## Command Reference diff --git a/docs/02_cleos/02_how-to-guides/how-to-delegate-CPU-resource.md b/docs/02_cleos/02_how-to-guides/how-to-delegate-CPU-resource.md index 606209e3d6..6291e9b284 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-delegate-CPU-resource.md +++ b/docs/02_cleos/02_how-to-guides/how-to-delegate-CPU-resource.md @@ -10,12 +10,12 @@ Make sure you meet the following requirements: * Install the currently supported version of `cleos`. [[info | Note]] -| `cleos` is bundled with the Mandel software. [Installing Mandel](../../00_install/index.md) will also install `cleos`. +| `cleos` is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install `cleos`. * Ensure the reference system contracts from [`eosio.contracts`](https://github.com/eosnetworkfoundation/mandel-contracts) repository is deployed and used to manage system resources. * Understand what an [account](https://developers.eos.io/welcome/latest/glossary/index/#account) is and its role in the blockchain. -* Understand [CPU bandwidth](https://developers.eos.io/welcome/latest/glossary/index/#cpu) in a Mandel blockchain. -* Understand [NET bandwidth](https://developers.eos.io/welcome/latest/glossary/index/#net) in a Mandel blockchain. +* Understand [CPU bandwidth](https://developers.eos.io/welcome/latest/glossary/index/#cpu) in a EOSIO blockchain. +* Understand [NET bandwidth](https://developers.eos.io/welcome/latest/glossary/index/#net) in a EOSIO blockchain. ## Steps diff --git a/docs/02_cleos/02_how-to-guides/how-to-delegate-net-resource.md b/docs/02_cleos/02_how-to-guides/how-to-delegate-net-resource.md index 51ec81b0b9..5c74b7a9a7 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-delegate-net-resource.md +++ b/docs/02_cleos/02_how-to-guides/how-to-delegate-net-resource.md @@ -10,12 +10,12 @@ Make sure you meet the following requirements: * Install the currently supported version of `cleos`. [[info | Note]] -| `cleos` is bundled with the Mandel software. [Installing Mandel](../../00_install/index.md) will also install `cleos`. +| `cleos` is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install `cleos`. * Ensure the reference system contracts from [`eosio.contracts`](https://github.com/eosnetworkfoundation/mandel-contracts) repository is deployed and used to manage system resources. * Understand what an [account](https://developers.eos.io/welcome/latest/glossary/index/#account) is and its role in the blockchain. -* Understand [NET bandwidth](https://developers.eos.io/welcome/latest/glossary/index/#net) in a Mandel blockchain. -* Understand [CPU bandwidth](https://developers.eos.io/welcome/latest/glossary/index/#cpu) in a Mandel blockchain. +* Understand [NET bandwidth](https://developers.eos.io/welcome/latest/glossary/index/#net) in a EOSIO blockchain. +* Understand [CPU bandwidth](https://developers.eos.io/welcome/latest/glossary/index/#cpu) in a EOSIO blockchain. ## Steps diff --git a/docs/02_cleos/02_how-to-guides/how-to-deploy-a-smart-contract.md b/docs/02_cleos/02_how-to-guides/how-to-deploy-a-smart-contract.md index ccb970fbf2..b38656bbd7 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-deploy-a-smart-contract.md +++ b/docs/02_cleos/02_how-to-guides/how-to-deploy-a-smart-contract.md @@ -1,6 +1,6 @@ ## Goal -Deploy a Mandel contract +Deploy a EOSIO contract ## Before you begin diff --git a/docs/02_cleos/02_how-to-guides/how-to-get-account-information.md b/docs/02_cleos/02_how-to-guides/how-to-get-account-information.md index fabf5045fe..91c399a951 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-get-account-information.md +++ b/docs/02_cleos/02_how-to-guides/how-to-get-account-information.md @@ -1,15 +1,15 @@ ## Overview -This how-to guide provides instructions on how to query infomation of a Mandel account. The example in this how-to guide retrieves information of the `eosio` account. +This how-to guide provides instructions on how to query infomation of a EOSIO account. The example in this how-to guide retrieves information of the `eosio` account. ## Before you begin * Install the currently supported version of `cleos` [[info | Note]] -| The cleos tool is bundled with the Mandel software. [Installing Mandel](../../00_install/index.md) will also install the cleos tool. +| The cleos tool is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install the cleos tool. -* Acquire functional understanding of [Mandel Accounts and Permissions](https://developers.eos.io/welcome/v2.1/protocol/accounts_and_permissions) +* Acquire functional understanding of [EOSIO Accounts and Permissions](https://developers.eos.io/welcome/v2.1/protocol/accounts_and_permissions) ## Command Reference @@ -28,7 +28,7 @@ cleos get account eosio ``` **Where**: -* `eosio` = The name of the default system account in the Mandel blockchain. +* `eosio` = The name of the default system account in the EOSIO blockchain. **Example Output** @@ -53,4 +53,4 @@ cpu bandwidth: ``` [[info | Account Fields]] -| Depending on the Mandel network you are connected, you might see different fields associated with an account. That depends on which system contract has been deployed on the network. +| Depending on the EOSIO network you are connected, you might see different fields associated with an account. That depends on which system contract has been deployed on the network. diff --git a/docs/02_cleos/02_how-to-guides/how-to-get-block-information.md b/docs/02_cleos/02_how-to-guides/how-to-get-block-information.md index ca23c507f0..7efd62427f 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-get-block-information.md +++ b/docs/02_cleos/02_how-to-guides/how-to-get-block-information.md @@ -10,10 +10,10 @@ Make sure to meet the following requirements: * Install the currently supported version of `cleos`. [[info | Note]] -| `cleos` is bundled with the Mandel software. [Installing Mandel](../../00_install/index.md) will also install `cleos`. +| `cleos` is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install `cleos`. * Understand what a [block](https://developers.eos.io/welcome/latest/glossary/index/#block) is and its role in the blockchain. -* Understand the [block lifecycle](https://developers.eos.io/welcome/latest/protocol-guides/consensus_protocol/#5-block-lifecycle) in the Mandel consensus protocol. +* Understand the [block lifecycle](https://developers.eos.io/welcome/latest/protocol-guides/consensus_protocol/#5-block-lifecycle) in the EOSIO consensus protocol. ## Steps diff --git a/docs/02_cleos/02_how-to-guides/how-to-get-transaction-information.md b/docs/02_cleos/02_how-to-guides/how-to-get-transaction-information.md index f6e33fe0d8..27b9422701 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-get-transaction-information.md +++ b/docs/02_cleos/02_how-to-guides/how-to-get-transaction-information.md @@ -1,6 +1,6 @@ ## Overview -This how-to guide provides instructions on how to retrieve infomation of a Mandel transaction using a transaction ID. +This how-to guide provides instructions on how to retrieve infomation of a EOSIO transaction using a transaction ID. The example in this how-to retrieves transaction information associated with the creation of the account **bob**. @@ -9,8 +9,8 @@ The example in this how-to retrieves transaction information associated with the Make sure you meet the following requirements: * Install the currently supported version of `cleos`. [[info | Note]] -| `cleos` is bundled with the Mandel software. [Installing Mandel](../../00_install/index.md) will also install `cleos`. -* Understand how transactions work in a Mandel blockchain. For more information on transactions, see the [Transactions Protocol](https://developers.eos.io/welcome/latest/protocol-guides/transactions_protocol) section. +| `cleos` is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install `cleos`. +* Understand how transactions work in a EOSIO blockchain. For more information on transactions, see the [Transactions Protocol](https://developers.eos.io/welcome/latest/protocol-guides/transactions_protocol) section. ## Command Reference diff --git a/docs/02_cleos/02_how-to-guides/how-to-import-a-key.md b/docs/02_cleos/02_how-to-guides/how-to-import-a-key.md index 6e13925fc0..614be5cb59 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-import-a-key.md +++ b/docs/02_cleos/02_how-to-guides/how-to-import-a-key.md @@ -1,6 +1,6 @@ ## Overview -This how-to guide provides instructions on how to import a private key into the `keosd` default wallet. You can use the private key to authorize transactions in a Mandel blockchain. +This how-to guide provides instructions on how to import a private key into the `keosd` default wallet. You can use the private key to authorize transactions in a EOSIO blockchain. ## Before you Begin @@ -11,7 +11,7 @@ Make sure you meet the following requirements: * Familiarize with the [`cleos wallet import`](../03_command-reference/wallet/import.md) command. * Install the currently supported version of `cleos`. [[info | Note]] -| `cleos` is bundled with the Mandel software. [Installing Mandel](../../00_install/index.md) will also install `cleos`. +| `cleos` is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install `cleos`. * Understand what a [public key](https://developers.eos.io/welcome/latest/glossary/index/#public-key) and [private key](https://developers.eos.io/welcome/latest/glossary/index/#private-key) is. ## Command Reference diff --git a/docs/02_cleos/02_how-to-guides/how-to-list-all-key-pairs.md b/docs/02_cleos/02_how-to-guides/how-to-list-all-key-pairs.md index 7b5703b046..d76430fd5c 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-list-all-key-pairs.md +++ b/docs/02_cleos/02_how-to-guides/how-to-list-all-key-pairs.md @@ -1,6 +1,6 @@ ## Overview -This how-to guide provides instructions on how to list all public keys and public/private key pairs within the `keosd` default wallet. You can use the public and private keys to authorize transactions in a Mandel blockchain. +This how-to guide provides instructions on how to list all public keys and public/private key pairs within the `keosd` default wallet. You can use the public and private keys to authorize transactions in a EOSIO blockchain. The example in this how-to guide displays all public keys and public/private key pairs stored within the existing default wallet. @@ -13,7 +13,7 @@ Make sure you meet the following requirements: * Familiarize with the [`cleos wallet`](../03_command-reference/wallet/index.md) commands. * Install the currently supported version of `cleos`. [[info | Note]] -| `cleos` is bundled with the Mandel software. [Installing Mandel](../../00_install/index.md) will also install `cleos`. +| `cleos` is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install `cleos`. * Understand what a [public key](https://developers.eos.io/welcome/latest/glossary/index/#public-key) and [private key](https://developers.eos.io/welcome/latest/glossary/index/#private-key) is. ## Command Reference diff --git a/docs/02_cleos/03_command-reference/create/account.md b/docs/02_cleos/03_command-reference/create/account.md index e35d2bf146..976c986f56 100755 --- a/docs/02_cleos/03_command-reference/create/account.md +++ b/docs/02_cleos/03_command-reference/create/account.md @@ -30,7 +30,7 @@ Options: ``` ## Command -A set of Mandel keys is required to create an account. The Mandel keys can be generated by using `cleos create key`. +A set of EOSIO keys is required to create an account. The EOSIO keys can be generated by using `cleos create key`. ```sh cleos create account inita tester EOS4toFS3YXEQCkuuw1aqDLrtHim86Gz9u3hBdcBw5KNPZcursVHq EOS7d9A3uLe6As66jzN8j44TXJUqJSK3bFjjEEqR4oTvNAB3iM9SA diff --git a/docs/02_cleos/03_command-reference/net/connect.md b/docs/02_cleos/03_command-reference/net/connect.md index 278f3f47c6..be0b2af0b3 100755 --- a/docs/02_cleos/03_command-reference/net/connect.md +++ b/docs/02_cleos/03_command-reference/net/connect.md @@ -26,7 +26,7 @@ Make sure you meet the following requirements: * Install the currently supported version of `cleos`. [[info | Note]] -| `cleos` is bundled with the Mandel software. [Installing Mandel](../../../00_install/index.md) will also install the `cleos` and `keosd` command line tools. +| `cleos` is bundled with the EOSIO software. [Installing EOSIO](../../../00_install/index.md) will also install the `cleos` and `keosd` command line tools. * You have access to a producing node instance with the [`net_api_plugin`](../../../01_nodeos/03_plugins/net_api_plugin/index.md) loaded. ## Examples diff --git a/docs/02_cleos/03_command-reference/net/disconnect.md b/docs/02_cleos/03_command-reference/net/disconnect.md index f2dfa12c82..29c3039961 100755 --- a/docs/02_cleos/03_command-reference/net/disconnect.md +++ b/docs/02_cleos/03_command-reference/net/disconnect.md @@ -26,7 +26,7 @@ Make sure you meet the following requirements: * Install the currently supported version of `cleos`. [[info | Note]] -| `cleos` is bundled with the Mandel software. [Installing Mandel](../../../00_install/index.md) will also install the `cleos` and `keosd` command line tools. +| `cleos` is bundled with the EOSIO software. [Installing EOSIO](../../../00_install/index.md) will also install the `cleos` and `keosd` command line tools. * You have access to a producing node instance with the [`net_api_plugin`](../../../01_nodeos/03_plugins/net_api_plugin/index.md) loaded. ## Examples diff --git a/docs/02_cleos/03_command-reference/net/peers.md b/docs/02_cleos/03_command-reference/net/peers.md index c625506c53..2814731c75 100755 --- a/docs/02_cleos/03_command-reference/net/peers.md +++ b/docs/02_cleos/03_command-reference/net/peers.md @@ -25,7 +25,7 @@ Make sure you meet the following requirements: * Install the currently supported version of `cleos`. [[info | Note]] -| `cleos` is bundled with the Mandel software. [Installing Mandel](../../../00_install/index.md) will also install the `cleos` and `keosd` command line tools. +| `cleos` is bundled with the EOSIO software. [Installing EOSIO](../../../00_install/index.md) will also install the `cleos` and `keosd` command line tools. * You have access to a producing node instance with the [`net_api_plugin`](../../../01_nodeos/03_plugins/net_api_plugin/index.md) loaded. ## Examples diff --git a/docs/02_cleos/03_command-reference/net/status.md b/docs/02_cleos/03_command-reference/net/status.md index 7a8fd4f535..f8f45265ec 100755 --- a/docs/02_cleos/03_command-reference/net/status.md +++ b/docs/02_cleos/03_command-reference/net/status.md @@ -26,7 +26,7 @@ Make sure you meet the following requirements: * Install the currently supported version of `cleos`. [[info | Note]] -| `cleos` is bundled with the Mandel software. [Installing Mandel](../../../00_install/index.md) will also install the `cleos` and `keosd` command line tools. +| `cleos` is bundled with the EOSIO software. [Installing EOSIO](../../../00_install/index.md) will also install the `cleos` and `keosd` command line tools. * You have access to a producing node instance with the [`net_api_plugin`](../../../01_nodeos/03_plugins/net_api_plugin/index.md) loaded. ## Examples diff --git a/docs/02_cleos/03_command-reference/set/set-account.md b/docs/02_cleos/03_command-reference/set/set-account.md index 1e682aa485..e4ed9f6e32 100755 --- a/docs/02_cleos/03_command-reference/set/set-account.md +++ b/docs/02_cleos/03_command-reference/set/set-account.md @@ -2,7 +2,7 @@ set parameters dealing with account permissions [[info | JSON input]] -| This command involves specifying JSON input which depends on underlying class definitions. Therefore, such JSON input is subject to change in future versions of the Mandel software. +| This command involves specifying JSON input which depends on underlying class definitions. Therefore, such JSON input is subject to change in future versions of the EOSIO software. ## Positionals - `account` _TEXT_ - The account to set/delete a permission authority for diff --git a/docs/02_cleos/04_troubleshooting.md b/docs/02_cleos/04_troubleshooting.md index 748ac82df3..63250119e9 100644 --- a/docs/02_cleos/04_troubleshooting.md +++ b/docs/02_cleos/04_troubleshooting.md @@ -20,4 +20,4 @@ Replace API_ENDPOINT and PORT with your remote `nodeos` API endpoint detail ## "Missing Authorizations" -That means you are not using the required authorizations. Most likely you are not using correct Mandel account or permission level to sign the transaction +That means you are not using the required authorizations. Most likely you are not using correct EOSIO account or permission level to sign the transaction diff --git a/docs/02_cleos/index.md b/docs/02_cleos/index.md index e2303863af..fbe3ca8d30 100644 --- a/docs/02_cleos/index.md +++ b/docs/02_cleos/index.md @@ -4,11 +4,11 @@ content_title: Cleos ## Introduction -`cleos` is a command line tool that interfaces with the REST API exposed by `nodeos`. Developers can also use `cleos` to deploy and test Mandel smart contracts. +`cleos` is a command line tool that interfaces with the REST API exposed by `nodeos`. Developers can also use `cleos` to deploy and test EOSIO smart contracts. ## Installation -`cleos` is distributed as part of the [Mandel software suite](https://github.com/eosnetworkfoundation/mandel). To install `cleos` just visit the [Mandel Software Installation](../00_install/index.md) section. +`cleos` is distributed as part of the [EOSIO software suite](https://github.com/eosnetworkfoundation/mandel). To install `cleos` just visit the [EOSIO Software Installation](../00_install/index.md) section. ## Using Cleos @@ -23,7 +23,7 @@ cleos --help ``` ```console -Command Line Interface to Mandel Client +Command Line Interface to EOSIO Client Usage: cleos [OPTIONS] SUBCOMMAND Options: diff --git a/docs/03_keosd/index.md b/docs/03_keosd/index.md index 99144dd25f..cfd45cb9de 100644 --- a/docs/03_keosd/index.md +++ b/docs/03_keosd/index.md @@ -8,11 +8,11 @@ content_title: Keosd ## Installation -`keosd` is distributed as part of the [Mandel software suite](https://github.com/eosnetworkfoundation/mandel). To install `keosd` just visit the [Mandel Software Installation](../00_install/index.md) section. +`keosd` is distributed as part of the [EOSIO software suite](https://github.com/eosnetworkfoundation/mandel). To install `keosd` just visit the [EOSIO Software Installation](../00_install/index.md) section. ## Operation When a wallet is unlocked with the corresponding password, `cleos` can request `keosd` to sign a transaction with the appropriate private keys. Also, `keosd` provides support for hardware-based wallets such as Secure Encalve and YubiHSM. [[info | Audience]] -| `keosd` is intended to be used by Mandel developers only. +| `keosd` is intended to be used by EOSIO developers only. diff --git a/docs/10_utilities/index.md b/docs/10_utilities/index.md index d0a078b58e..747c95cb72 100644 --- a/docs/10_utilities/index.md +++ b/docs/10_utilities/index.md @@ -1,9 +1,9 @@ --- -content_title: Mandel Utilities -link_text: Mandel Utilities +content_title: EOSIO Utilities +link_text: EOSIO Utilities --- -This section contains documentation for additional utilities that complement or extend `nodeos` and potentially other Mandel software: +This section contains documentation for additional utilities that complement or extend `nodeos` and potentially other EOSIO software: * [eosio-blocklog](eosio-blocklog.md) - Low-level utility for node operators to interact with block log files. * [trace_api_util](trace_api_util.md) - Low-level utility for performing tasks associated with the [Trace API](../01_nodeos/03_plugins/trace_api_plugin/index.md). diff --git a/docs/index.md b/docs/index.md index 8acf1ecb74..5ccf7dd462 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,21 +1,21 @@ --- -content_title: Mandel Overview +content_title: EOSIO Overview --- -Mandel is the next-generation blockchain platform for creating and deploying smart contracts and distributed applications. Mandel comes with a number of programs. The primary ones included in Mandel are the following: +EOSIO is the next-generation blockchain platform for creating and deploying smart contracts and distributed applications. EOSIO comes with a number of programs. The primary ones included in EOSIO are the following: * [Nodeos](01_nodeos/index.md) - Core service daemon that runs a node for block production, API endpoints, or local development. * [Cleos](02_cleos/index.md) - Command line interface to interact with the blockchain (via `nodeos`) and manage wallets (via `keosd`). -* [Keosd](03_keosd/index.md) - Component that manages Mandel keys in wallets and provides a secure enclave for digital signing. +* [Keosd](03_keosd/index.md) - Component that manages EOSIO keys in wallets and provides a secure enclave for digital signing. The basic relationship between these components is illustrated in the diagram below. -![Mandel components](mandel_components.png) +![EOSIO components](mandel_components.png) -Additional Mandel Resources: -* [Mandel Utilities](10_utilities/index.md) - Utilities that complement the Mandel software. -* [Upgrade Guide](20_upgrade-guide/index.md) - Mandel version/protocol upgrade guide. -* [Release Notes](30_release-notes/index.md) - All release notes for this Mandel version. +Additional EOSIO Resources: +* [EOSIO Utilities](10_utilities/index.md) - Utilities that complement the EOSIO software. +* [Upgrade Guide](20_upgrade-guide/index.md) - EOSIO version/protocol upgrade guide. +* [Release Notes](30_release-notes/index.md) - All release notes for this EOSIO version. [[info | What's Next?]] -| [Install the Mandel Software](00_install/index.md) before exploring the sections above. +| [Install the EOSIO Software](00_install/index.md) before exploring the sections above. From 27cb589ad90e88059ccbea6dadc4e9b55ea5980e Mon Sep 17 00:00:00 2001 From: 766C6164 Date: Thu, 7 Jul 2022 12:59:53 -0400 Subject: [PATCH 05/18] Update "an EOSIO" --- docs/01_nodeos/03_plugins/chain_plugin/index.md | 2 +- docs/01_nodeos/03_plugins/trace_api_plugin/index.md | 2 +- docs/01_nodeos/08_troubleshooting/index.md | 2 +- docs/02_cleos/02_how-to-guides/how-to-create-key-pairs.md | 4 ++-- .../02_cleos/02_how-to-guides/how-to-delegate-CPU-resource.md | 4 ++-- .../02_cleos/02_how-to-guides/how-to-delegate-net-resource.md | 4 ++-- .../02_how-to-guides/how-to-deploy-a-smart-contract.md | 2 +- .../02_how-to-guides/how-to-get-account-information.md | 2 +- .../02_how-to-guides/how-to-get-transaction-information.md | 4 ++-- docs/02_cleos/02_how-to-guides/how-to-import-a-key.md | 2 +- docs/02_cleos/02_how-to-guides/how-to-list-all-key-pairs.md | 2 +- 11 files changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/01_nodeos/03_plugins/chain_plugin/index.md b/docs/01_nodeos/03_plugins/chain_plugin/index.md index b60b394dd3..9da5921080 100644 --- a/docs/01_nodeos/03_plugins/chain_plugin/index.md +++ b/docs/01_nodeos/03_plugins/chain_plugin/index.md @@ -1,6 +1,6 @@ ## Description -The `chain_plugin` is a core plugin required to process and aggregate chain data on a EOSIO node. +The `chain_plugin` is a core plugin required to process and aggregate chain data on an EOSIO node. ## Usage diff --git a/docs/01_nodeos/03_plugins/trace_api_plugin/index.md b/docs/01_nodeos/03_plugins/trace_api_plugin/index.md index 160e2aa2e5..74d1215ec0 100644 --- a/docs/01_nodeos/03_plugins/trace_api_plugin/index.md +++ b/docs/01_nodeos/03_plugins/trace_api_plugin/index.md @@ -5,7 +5,7 @@ The `trace_api_plugin` provides a consumer-focused long-term API for retrieving ## Purpose -While integrating applications such as block explorers and exchanges with a EOSIO blockchain, the user might require a complete transcript of actions processed by the blockchain, including those spawned from the execution of smart contracts and scheduled transactions. The `trace_api_plugin` serves this need. The purpose of the plugin is to provide: +While integrating applications such as block explorers and exchanges with an EOSIO blockchain, the user might require a complete transcript of actions processed by the blockchain, including those spawned from the execution of smart contracts and scheduled transactions. The `trace_api_plugin` serves this need. The purpose of the plugin is to provide: * A transcript of retired actions and related metadata * A consumer-focused long-term API to retrieve blocks diff --git a/docs/01_nodeos/08_troubleshooting/index.md b/docs/01_nodeos/08_troubleshooting/index.md index 92db833328..409ca6c371 100644 --- a/docs/01_nodeos/08_troubleshooting/index.md +++ b/docs/01_nodeos/08_troubleshooting/index.md @@ -44,4 +44,4 @@ cleos --url http://localhost:8888 get info | grep server_version ### Error 3070000: WASM Exception Error -If you try to deploy the `eosio.bios` contract or `eosio.system` contract in an attempt to boot a EOSIO-based blockchain and you get the following error or similar: `Publishing contract... Error 3070000: WASM Exception Error Details: env.set_proposed_producers_ex unresolveable`, it is because you have to activate the `PREACTIVATE_FEATURE` protocol first. More details about it and how to enable it can be found in the [Bios Boot Sequence Tutorial](https://developers.eos.io/welcome/latest/tutorials/bios-boot-sequence/#112-set-the-eosiosystem-contract). For more information, you may also visit the [Nodeos Upgrade Guides](https://developers.eos.io/manuals/eos/latest/nodeos/upgrade-guides/). +If you try to deploy the `eosio.bios` contract or `eosio.system` contract in an attempt to boot an EOSIO-based blockchain and you get the following error or similar: `Publishing contract... Error 3070000: WASM Exception Error Details: env.set_proposed_producers_ex unresolveable`, it is because you have to activate the `PREACTIVATE_FEATURE` protocol first. More details about it and how to enable it can be found in the [Bios Boot Sequence Tutorial](https://developers.eos.io/welcome/latest/tutorials/bios-boot-sequence/#112-set-the-eosiosystem-contract). For more information, you may also visit the [Nodeos Upgrade Guides](https://developers.eos.io/manuals/eos/latest/nodeos/upgrade-guides/). diff --git a/docs/02_cleos/02_how-to-guides/how-to-create-key-pairs.md b/docs/02_cleos/02_how-to-guides/how-to-create-key-pairs.md index 069d14e0d1..e3e298aefe 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-create-key-pairs.md +++ b/docs/02_cleos/02_how-to-guides/how-to-create-key-pairs.md @@ -1,6 +1,6 @@ ## Overview -This how-to guide provides instructions on how to create a keypair consisting of a public key and a private key for signing transactions in a EOSIO blockchain. +This how-to guide provides instructions on how to create a keypair consisting of a public key and a private key for signing transactions in an EOSIO blockchain. ## Before you begin @@ -8,7 +8,7 @@ Make sure you meet the following requirements: * Install the currently supported version of `cleos` [[info | Note]] | The cleos tool is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install the cleos tool. -* Learn about asymmetric cryptography (public and private keypair) in the context of a EOSIO blockchain. +* Learn about asymmetric cryptography (public and private keypair) in the context of an EOSIO blockchain. ## Command Reference diff --git a/docs/02_cleos/02_how-to-guides/how-to-delegate-CPU-resource.md b/docs/02_cleos/02_how-to-guides/how-to-delegate-CPU-resource.md index 6291e9b284..155c738bf6 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-delegate-CPU-resource.md +++ b/docs/02_cleos/02_how-to-guides/how-to-delegate-CPU-resource.md @@ -14,8 +14,8 @@ Make sure you meet the following requirements: * Ensure the reference system contracts from [`eosio.contracts`](https://github.com/eosnetworkfoundation/mandel-contracts) repository is deployed and used to manage system resources. * Understand what an [account](https://developers.eos.io/welcome/latest/glossary/index/#account) is and its role in the blockchain. -* Understand [CPU bandwidth](https://developers.eos.io/welcome/latest/glossary/index/#cpu) in a EOSIO blockchain. -* Understand [NET bandwidth](https://developers.eos.io/welcome/latest/glossary/index/#net) in a EOSIO blockchain. +* Understand [CPU bandwidth](https://developers.eos.io/welcome/latest/glossary/index/#cpu) in an EOSIO blockchain. +* Understand [NET bandwidth](https://developers.eos.io/welcome/latest/glossary/index/#net) in an EOSIO blockchain. ## Steps diff --git a/docs/02_cleos/02_how-to-guides/how-to-delegate-net-resource.md b/docs/02_cleos/02_how-to-guides/how-to-delegate-net-resource.md index 5c74b7a9a7..ac26f6e52a 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-delegate-net-resource.md +++ b/docs/02_cleos/02_how-to-guides/how-to-delegate-net-resource.md @@ -14,8 +14,8 @@ Make sure you meet the following requirements: * Ensure the reference system contracts from [`eosio.contracts`](https://github.com/eosnetworkfoundation/mandel-contracts) repository is deployed and used to manage system resources. * Understand what an [account](https://developers.eos.io/welcome/latest/glossary/index/#account) is and its role in the blockchain. -* Understand [NET bandwidth](https://developers.eos.io/welcome/latest/glossary/index/#net) in a EOSIO blockchain. -* Understand [CPU bandwidth](https://developers.eos.io/welcome/latest/glossary/index/#cpu) in a EOSIO blockchain. +* Understand [NET bandwidth](https://developers.eos.io/welcome/latest/glossary/index/#net) in an EOSIO blockchain. +* Understand [CPU bandwidth](https://developers.eos.io/welcome/latest/glossary/index/#cpu) in an EOSIO blockchain. ## Steps diff --git a/docs/02_cleos/02_how-to-guides/how-to-deploy-a-smart-contract.md b/docs/02_cleos/02_how-to-guides/how-to-deploy-a-smart-contract.md index b38656bbd7..32fcce2c00 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-deploy-a-smart-contract.md +++ b/docs/02_cleos/02_how-to-guides/how-to-deploy-a-smart-contract.md @@ -1,6 +1,6 @@ ## Goal -Deploy a EOSIO contract +Deploy an EOSIO contract ## Before you begin diff --git a/docs/02_cleos/02_how-to-guides/how-to-get-account-information.md b/docs/02_cleos/02_how-to-guides/how-to-get-account-information.md index 91c399a951..7dc5f686d0 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-get-account-information.md +++ b/docs/02_cleos/02_how-to-guides/how-to-get-account-information.md @@ -1,6 +1,6 @@ ## Overview -This how-to guide provides instructions on how to query infomation of a EOSIO account. The example in this how-to guide retrieves information of the `eosio` account. +This how-to guide provides instructions on how to query infomation of an EOSIO account. The example in this how-to guide retrieves information of the `eosio` account. ## Before you begin diff --git a/docs/02_cleos/02_how-to-guides/how-to-get-transaction-information.md b/docs/02_cleos/02_how-to-guides/how-to-get-transaction-information.md index 27b9422701..aaf5fd7e74 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-get-transaction-information.md +++ b/docs/02_cleos/02_how-to-guides/how-to-get-transaction-information.md @@ -1,6 +1,6 @@ ## Overview -This how-to guide provides instructions on how to retrieve infomation of a EOSIO transaction using a transaction ID. +This how-to guide provides instructions on how to retrieve infomation of an EOSIO transaction using a transaction ID. The example in this how-to retrieves transaction information associated with the creation of the account **bob**. @@ -10,7 +10,7 @@ Make sure you meet the following requirements: * Install the currently supported version of `cleos`. [[info | Note]] | `cleos` is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install `cleos`. -* Understand how transactions work in a EOSIO blockchain. For more information on transactions, see the [Transactions Protocol](https://developers.eos.io/welcome/latest/protocol-guides/transactions_protocol) section. +* Understand how transactions work in an EOSIO blockchain. For more information on transactions, see the [Transactions Protocol](https://developers.eos.io/welcome/latest/protocol-guides/transactions_protocol) section. ## Command Reference diff --git a/docs/02_cleos/02_how-to-guides/how-to-import-a-key.md b/docs/02_cleos/02_how-to-guides/how-to-import-a-key.md index 614be5cb59..19a8ee0d7d 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-import-a-key.md +++ b/docs/02_cleos/02_how-to-guides/how-to-import-a-key.md @@ -1,6 +1,6 @@ ## Overview -This how-to guide provides instructions on how to import a private key into the `keosd` default wallet. You can use the private key to authorize transactions in a EOSIO blockchain. +This how-to guide provides instructions on how to import a private key into the `keosd` default wallet. You can use the private key to authorize transactions in an EOSIO blockchain. ## Before you Begin diff --git a/docs/02_cleos/02_how-to-guides/how-to-list-all-key-pairs.md b/docs/02_cleos/02_how-to-guides/how-to-list-all-key-pairs.md index d76430fd5c..7a9bb7348f 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-list-all-key-pairs.md +++ b/docs/02_cleos/02_how-to-guides/how-to-list-all-key-pairs.md @@ -1,6 +1,6 @@ ## Overview -This how-to guide provides instructions on how to list all public keys and public/private key pairs within the `keosd` default wallet. You can use the public and private keys to authorize transactions in a EOSIO blockchain. +This how-to guide provides instructions on how to list all public keys and public/private key pairs within the `keosd` default wallet. You can use the public and private keys to authorize transactions in an EOSIO blockchain. The example in this how-to guide displays all public keys and public/private key pairs stored within the existing default wallet. From 287a6e799a0d5a1bdbb58edc6de2791e3901a0a3 Mon Sep 17 00:00:00 2001 From: 766C6164 Date: Thu, 7 Jul 2022 13:08:58 -0400 Subject: [PATCH 06/18] Fixed butchered by md plugin index --- .../01_local-multi-node-testnet.md | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/docs/01_nodeos/02_usage/03_development-environment/01_local-multi-node-testnet.md b/docs/01_nodeos/02_usage/03_development-environment/01_local-multi-node-testnet.md index 9bccdf0fed..698f0414de 100644 --- a/docs/01_nodeos/02_usage/03_development-environment/01_local-multi-node-testnet.md +++ b/docs/01_nodeos/02_usage/03_development-environment/01_local-multi-node-testnet.md @@ -18,15 +18,12 @@ This section describes how to set up a multi-node blockchain configuration runni Open four "terminal" windows and perform the following steps: -- [Goal](#goal) -- [Before you begin](#before-you-begin) -- [Steps](#steps) - - [1. Start the Wallet Manager](#1-start-the-wallet-manager) - - [2. Create a Default Wallet](#2-create-a-default-wallet) - - [3. Loading the EOSIO Key](#3-loading-the-mandel-key) - - [4. Start the First Producer Node](#4-start-the-first-producer-node) - - [5. Start the Second Producer Node](#5-start-the-second-producer-node) - - [6. Get Nodes Info](#6-get-nodes-info) +1. [Start the Wallet Manager](#1-start-the-wallet-manager) +2. [Create a Default Wallet](#2-create-a-default-wallet) +3. [Loading the EOSIO Key](#3-loading-the-eosio-key) +4. [Start the First Producer Node](#4-start-the-first-producer-node) +5. [Start the Second Producer Node](#5-start-the-second-producer-node) +6. [Get Nodes Info](#6-get-nodes-info) ### 1. Start the Wallet Manager From 847d114e62a54196efb63c2c55eb1973fdb2dcf3 Mon Sep 17 00:00:00 2001 From: Eric Passmore Date: Mon, 18 Jul 2022 14:56:18 -0700 Subject: [PATCH 07/18] general doc cleanup fixed broken links and unclosed '<' --- .../02_node-setups/00_producing-node.md | 14 +- .../02_node-setups/01_non-producing-node.md | 8 +- .../00_local-single-node-testnet.md | 10 +- .../03_plugins/producer_plugin/index.md | 124 +++++++++--------- .../how-to-replay-from-a-snapshot.md | 2 +- docs/01_nodeos/04_replays/index.md | 6 +- .../03_command-reference/convert/index.md | 8 +- .../03_command-reference/create/index.md | 4 +- .../get/transaction-status.md | 4 +- docs/02_cleos/03_command-reference/index.md | 7 +- .../03_command-reference/net/connect.md | 6 +- .../03_command-reference/net/disconnect.md | 6 +- .../03_command-reference/net/index.md | 14 +- .../03_command-reference/net/peers.md | 4 +- .../03_command-reference/net/status.md | 6 +- .../03_command-reference/set/index.md | 12 +- .../03_command-reference/system/system-rex.md | 38 +++--- .../system/system-voteproducer.md | 8 +- .../03_command-reference/version/index.md | 2 +- .../15_plugins/wallet_plugin/index.md | 5 +- docs/index.md | 8 +- 21 files changed, 163 insertions(+), 133 deletions(-) diff --git a/docs/01_nodeos/02_usage/02_node-setups/00_producing-node.md b/docs/01_nodeos/02_usage/02_node-setups/00_producing-node.md index f9555ba262..7bb7d2a2ba 100644 --- a/docs/01_nodeos/02_usage/02_node-setups/00_producing-node.md +++ b/docs/01_nodeos/02_usage/02_node-setups/00_producing-node.md @@ -12,7 +12,11 @@ This section describes how to set up a producing node within the EOSIO network. ## Before you begin * [Install the EOSIO software](../../../00_install/index.md) before starting this section. -* It is assumed that `nodeos`, `cleos`, and `keosd` are accessible through the path. If you built EOSIO using shell scripts, make sure to run the [Install Script](../../../00_install/01_build-from-source/01_shell-scripts/03_install-eosio-binaries.md). +* It is assumed that `nodeos`, `cleos`, and `keosd` are accessible through the path. + +[//]: # ( THIS IS A COMMENT LINK BELOW IS BROKEN ) +[//]: # ( If you built EOSIO using shell scripts, make sure to run the Install Script ../../../00_install/01_build-from-source/01_shell-scripts/03_install-eosio-binaries.md ) + * Know how to pass [Nodeos options](../../02_usage/00_nodeos-options.md) to enable or disable functionality. ## Steps @@ -46,11 +50,11 @@ producer-name = youraccount ### 3. Set the Producer's signature-provider -You will need to set the private key for your producer. The public key should have an authority for the producer account defined above. +You will need to set the private key for your producer. The public key should have an authority for the producer account defined above. `signature-provider` is defined with a 3-field tuple: * `public-key` - A valid EOSIO public key in form of a string. -* `provider-spec` - It's a string formatted like : +* `provider-spec` - It's a string formatted like `:` * `provider-type` - KEY or KEOSD #### Using a Key: @@ -65,7 +69,7 @@ signature-provider = PUBLIC_SIGNING_KEY=KEY:PRIVATE_SIGNING_KEY ``` #### Using Keosd: -You can also use `keosd` instead of hard-defining keys. +You can also use `keosd` instead of hard-defining keys. ```console # config.ini: @@ -87,7 +91,7 @@ p2p-peer-address = 123.255.78.9:9876 ### 5. Load the Required Plugins -In your [config.ini](../index.md), confirm the following plugins are loading or append them if necessary. +In your [config.ini](../index.md), confirm the following plugins are loading or append them if necessary. ```console # config.ini: diff --git a/docs/01_nodeos/02_usage/02_node-setups/01_non-producing-node.md b/docs/01_nodeos/02_usage/02_node-setups/01_non-producing-node.md index 77365ef18f..b85a014c34 100644 --- a/docs/01_nodeos/02_usage/02_node-setups/01_non-producing-node.md +++ b/docs/01_nodeos/02_usage/02_node-setups/01_non-producing-node.md @@ -9,12 +9,16 @@ This section describes how to set up a non-producing node within the EOSIO netwo ## Before you begin * [Install the EOSIO software](../../../00_install/index.md) before starting this section. -* It is assumed that `nodeos`, `cleos`, and `keosd` are accessible through the path. If you built EOSIO using shell scripts, make sure to run the [Install Script](../../../00_install/01_build-from-source/01_shell-scripts/03_install-eosio-binaries.md). +* It is assumed that `nodeos`, `cleos`, and `keosd` are accessible through the path. + +[//]: # ( THIS IS A COMMENT NEXT LINK CONTAINS A BROKEN LINK ) +[//]: # ( If you built EOSIO using shell scripts, make sure to run the Install Script ../../../00_install/01_build-from-source/01_shell-scripts/03_install-eosio-binaries.md ) + * Know how to pass [Nodeos options](../../02_usage/00_nodeos-options.md) to enable or disable functionality. ## Steps -To setup a non-producing node is simple. +To setup a non-producing node is simple. 1. [Set Peers](#1-set-peers) 2. [Enable one or more available plugins](#2-enable-one-or-more-available-plugins) diff --git a/docs/01_nodeos/02_usage/03_development-environment/00_local-single-node-testnet.md b/docs/01_nodeos/02_usage/03_development-environment/00_local-single-node-testnet.md index 53ca22048c..4b0f8d1b56 100644 --- a/docs/01_nodeos/02_usage/03_development-environment/00_local-single-node-testnet.md +++ b/docs/01_nodeos/02_usage/03_development-environment/00_local-single-node-testnet.md @@ -13,7 +13,11 @@ This section describes how to set up a single-node blockchain configuration runn ## Before you begin * [Install the EOSIO software](../../../00_install/index.md) before starting this section. -* It is assumed that `nodeos`, `cleos`, and `keosd` are accessible through the path. If you built EOSIO using shell scripts, make sure to run the [Install Script](../../../00_install/01_build-from-source/01_shell-scripts/03_install-eosio-binaries.md). +* It is assumed that `nodeos`, `cleos`, and `keosd` are accessible through the path. + +[//]: # (THIS IS A COMMENT, NEXT LINK HAS BROKEN LINK) +[//]: # (If you built EOSIO using shell scripts, make sure to run the Install Script ../../../00_install/01_build-from-source/01_shell-scripts/03_install-eosio-binaries.md .) + * Know how to pass [Nodeos options](../../02_usage/00_nodeos-options.md) to enable or disable functionality. ## Steps @@ -87,7 +91,7 @@ The more advanced user will likely have need to modify the configuration. `node * Linux: `~/.local/share/eosio/nodeos/config` The build seeds this folder with a default `genesis.json` file. A configuration folder can be specified using the `--config-dir` command line argument to `nodeos`. If you use this option, you will need to manually copy a `genesis.json` file to your config folder. - + `nodeos` will need a properly configured `config.ini` file in order to do meaningful work. On startup, `nodeos` looks in the config folder for `config.ini`. If one is not found, a default `config.ini` file is created. If you do not already have a `config.ini` file ready to use, run `nodeos` and then close it immediately with Ctrl-C. A default configuration (`config.ini`) will have been created in the config folder. Edit the `config.ini` file, adding/updating the following settings to the defaults already in place: ```console @@ -115,7 +119,7 @@ nodeos * Mac OS: `~/Library/Application\ Support/eosio/nodeos/data` * Linux: `~/.local/share/eosio/nodeos/data` - + A data folder can be specified using the `--data-dir` command line argument to `nodeos`. [[info | What's next?]] diff --git a/docs/01_nodeos/03_plugins/producer_plugin/index.md b/docs/01_nodeos/03_plugins/producer_plugin/index.md index 14b5be24ba..66e1b0077f 100644 --- a/docs/01_nodeos/03_plugins/producer_plugin/index.md +++ b/docs/01_nodeos/03_plugins/producer_plugin/index.md @@ -24,100 +24,100 @@ These can be specified from both the `nodeos` command-line or the `config.ini` f ```console Config Options for eosio::producer_plugin: - -e [ --enable-stale-production ] Enable block production, even if the + -e [ --enable-stale-production ] Enable block production, even if the chain is stale. - -x [ --pause-on-startup ] Start this node in a state where + -x [ --pause-on-startup ] Start this node in a state where production is paused - --max-transaction-time arg (=30) Limits the maximum time (in - milliseconds) that is allowed a pushed - transaction's code to execute before + --max-transaction-time arg (=30) Limits the maximum time (in + milliseconds) that is allowed a pushed + transaction's code to execute before being considered invalid --max-irreversible-block-age arg (=-1) - Limits the maximum age (in seconds) of + Limits the maximum age (in seconds) of the DPOS Irreversible Block for a chain - this node will produce blocks on (use + this node will produce blocks on (use negative value to indicate unlimited) - -p [ --producer-name ] arg ID of producer controlled by this node - (e.g. inita; may specify multiple + -p [ --producer-name ] arg ID of producer controlled by this node + (e.g. inita; may specify multiple times) - --private-key arg (DEPRECATED - Use signature-provider - instead) Tuple of [public key, WIF - private key] (may specify multiple + --private-key arg (DEPRECATED - Use signature-provider + instead) Tuple of [public key, WIF + private key] (may specify multiple times) --signature-provider arg (=EOS6MRyAjQq8ud7hVNYcfnVPJqcVpscN5So8BhtHuGYqET5GDW5CV=KEY:5KQwrPbwdL6PhXujxW37FSSQZ1JiwsST4cqQzDeyXtP79zkvFD3) - Key=Value pairs in the form + Key=Value pairs in the form = Where: - is a string form of + is a string form of a vaild EOSIO public key - - is a string in the + + is a string in the form : - + is KEY, or KEOSD - - KEY: is a string form of - a valid EOSIO - private key which + + KEY: is a string form of + a valid EOSIO + private key which maps to the provided public key - - KEOSD: is the URL where - keosd is available - and the approptiate - wallet(s) are + + KEOSD: is the URL where + keosd is available + and the approptiate + wallet(s) are unlocked - --keosd-provider-timeout arg (=5) Limits the maximum time (in - milliseconds) that is allowed for - sending blocks to a keosd provider for + --keosd-provider-timeout arg (=5) Limits the maximum time (in + milliseconds) that is allowed for + sending blocks to a keosd provider for signing --greylist-account arg account that can not access to extended CPU/NET virtual resources - --greylist-limit arg (=1000) Limit (between 1 and 1000) on the + --greylist-limit arg (=1000) Limit (between 1 and 1000) on the multiple that CPU/NET virtual resources - can extend during low usage (only - enforced subjectively; use 1000 to not + can extend during low usage (only + enforced subjectively; use 1000 to not enforce any limit) --produce-time-offset-us arg (=0) Offset of non last block producing time - in microseconds. Valid range 0 .. + in microseconds. Valid range 0 .. -block_time_interval. --last-block-time-offset-us arg (=-200000) - Offset of last block producing time in - microseconds. Valid range 0 .. + Offset of last block producing time in + microseconds. Valid range 0 .. -block_time_interval. --cpu-effort-percent arg (=80) Percentage of cpu block production time - used to produce block. Whole number + used to produce block. Whole number percentages, e.g. 80 for 80% --last-block-cpu-effort-percent arg (=80) Percentage of cpu block production time - used to produce last block. Whole + used to produce last block. Whole number percentages, e.g. 80 for 80% --max-block-cpu-usage-threshold-us arg (=5000) - Threshold of CPU block production to - consider block full; when within - threshold of max-block-cpu-usage block + Threshold of CPU block production to + consider block full; when within + threshold of max-block-cpu-usage block can be produced immediately --max-block-net-usage-threshold-bytes arg (=1024) - Threshold of NET block production to - consider block full; when within - threshold of max-block-net-usage block + Threshold of NET block production to + consider block full; when within + threshold of max-block-net-usage block can be produced immediately --max-scheduled-transaction-time-per-block-ms arg (=100) - Maximum wall-clock time, in - milliseconds, spent retiring scheduled - transactions in any block before - returning to normal transaction + Maximum wall-clock time, in + milliseconds, spent retiring scheduled + transactions in any block before + returning to normal transaction processing. --subjective-cpu-leeway-us arg (=31000) - Time in microseconds allowed for a - transaction that starts with - insufficient CPU quota to complete and + Time in microseconds allowed for a + transaction that starts with + insufficient CPU quota to complete and cover its CPU usage. --subjective-account-max-failures arg (=3) - Sets the maximum amount of failures - that are allowed for a given account + Sets the maximum amount of failures + that are allowed for a given account per block. Disregarded for accounts that have been whitelisted by disabling subjective @@ -128,33 +128,33 @@ Config Options for eosio::producer_plugin: Sets the time to return full subjective cpu for accounts --incoming-defer-ratio arg (=1) ratio between incoming transactions and - deferred transactions when both are + deferred transactions when both are queued for execution --incoming-transaction-queue-size-mb arg (=1024) - Maximum size (in MiB) of the incoming + Maximum size (in MiB) of the incoming transaction queue. Exceeding this value will subjectively drop transaction with resource exhaustion. - --disable-api-persisted-trx Disable the re-apply of API + --disable-api-persisted-trx Disable the re-apply of API transactions. - --disable-subjective-billing arg (=1) Disable subjective CPU billing for + --disable-subjective-billing arg (=1) Disable subjective CPU billing for API/P2P transactions --disable-subjective-account-billing arg - Account which is excluded from + Account which is excluded from subjective CPU billing Account is considered whitelisted and will not be subject to enforcement of subjective-account-max-failures. --disable-subjective-p2p-billing arg (=1) - Disable subjective CPU billing for P2P + Disable subjective CPU billing for P2P transactions --disable-subjective-api-billing arg (=1) - Disable subjective CPU billing for API + Disable subjective CPU billing for API transactions - --producer-threads arg (=2) Number of worker threads in producer + --producer-threads arg (=2) Number of worker threads in producer thread pool --snapshots-dir arg (="snapshots") the location of the snapshots directory - (absolute path or relative to + (absolute path or relative to application data dir) ``` @@ -172,7 +172,7 @@ The option below sets the ratio between the incoming transaction and the deferre --incoming-defer-ratio arg (=1) ``` -By default value of `1`, the `producer` plugin processes one incoming transaction per deferred transaction. When `arg` sets to `10`, the `producer` plugin processes 10 incoming transactions per deferred transaction. +By default value of `1`, the `producer` plugin processes one incoming transaction per deferred transaction. When `arg` sets to `10`, the `producer` plugin processes 10 incoming transactions per deferred transaction. If the `arg` is set to a sufficiently large number, the plugin always processes the incoming transaction first until the queue of the incoming transactions is empty. Respectively, if the `arg` is 0, the `producer` plugin processes the deferred transactions queue first. diff --git a/docs/01_nodeos/04_replays/how-to-replay-from-a-snapshot.md b/docs/01_nodeos/04_replays/how-to-replay-from-a-snapshot.md index cb7bd5028d..3c79cc72a5 100644 --- a/docs/01_nodeos/04_replays/how-to-replay-from-a-snapshot.md +++ b/docs/01_nodeos/04_replays/how-to-replay-from-a-snapshot.md @@ -6,7 +6,7 @@ Once you have obtained a copy of a valid snapshot file from which you wish to cr location | name | action ----------------- | -------------------------- | ------------ -data/snapshots | .bin | place the snapshot file you want to replay here +data/snapshots | `.bin` | place the snapshot file you want to replay here data/ | * | remove You can use `snapshots-dir = "snapshots" ` in the configuration file or using the `--snapshots-dir` command line option, to specify the where to find the the snapshot to replay, use `--snapshot` to specify the name of the snapshot to replay. diff --git a/docs/01_nodeos/04_replays/index.md b/docs/01_nodeos/04_replays/index.md index 0ec937f15a..e618fef78a 100644 --- a/docs/01_nodeos/04_replays/index.md +++ b/docs/01_nodeos/04_replays/index.md @@ -17,7 +17,7 @@ Snapshot files can be created from a running `nodeos` instance. The snapshot con * [How To Generate a Blocks Log](how-to-generate-a-blocks.log.md) * [How To Generate a Snapshot](how-to-generate-a-snapshot.md) * [How To Replay from a Blocks Log](how-to-replay-from-a-blocks.log.md) -* [How to Replay from a Snapshot](how-to-replay-from-a-snapshot.md) +* [How to Replay from a Snapshot](../04_replays/how-to-replay-from-a-snapshot.md) ## Replay Snapshot-specific Options @@ -41,9 +41,9 @@ This tells `nodeos` to clear the local chain state and local the `blocks.log` fi - **--truncate-at-block** Default argument (=0), only used if the given value is non-zero. Using this option when replaying the blockchain will force the replay to stop at the specified block number. This option will only work if replaying with the `--hard-replay-blockchain` option. The local `nodeos` process will contain the chain state for that block. This option may be useful for checking blockchain state at specific points in time. It is intended for testing/validation and is not intended to be used when creating a local `nodeos` instance which is synchronized with the network. - + - **--snapshot** -Use this option to specify which snapshot file to use to recreate the chain state from a snapshot file. This option will not replay the `blocks.log` file. The `nodeos` instance will not know the full transaction history of the blockchain. +Use this option to specify which snapshot file to use to recreate the chain state from a snapshot file. This option will not replay the `blocks.log` file. The `nodeos` instance will not know the full transaction history of the blockchain. - **--snapshots-dir** You can use this to specify the location of the snapshot file directory (absolute path or relative to application data dir.) diff --git a/docs/02_cleos/03_command-reference/convert/index.md b/docs/02_cleos/03_command-reference/convert/index.md index d4ae096130..404478ffed 100755 --- a/docs/02_cleos/03_command-reference/convert/index.md +++ b/docs/02_cleos/03_command-reference/convert/index.md @@ -2,7 +2,7 @@ Pack and unpack transactions ## subcommands -- [pack_transaction](pack_transaction) - From plain signed json to packed form -- [unpack_transaction](unpack_transaction) - From packed to plain signed json form -- [pack_action_data](pack_action_data) - From json action data to packed form -- [unpack_action_data](unpack_action_data) - From packed to json action data form \ No newline at end of file +- [pack_transaction](pack_transaction.md) - From plain signed json to packed form +- [unpack_transaction](unpack_transaction.md) - From packed to plain signed json form +- [pack_action_data](pack_action_data.md) - From json action data to packed form +- [unpack_action_data](unpack_action_data.md) - From packed to json action data form diff --git a/docs/02_cleos/03_command-reference/create/index.md b/docs/02_cleos/03_command-reference/create/index.md index 6e559a6b6e..a4783da2de 100755 --- a/docs/02_cleos/03_command-reference/create/index.md +++ b/docs/02_cleos/03_command-reference/create/index.md @@ -2,8 +2,8 @@ Create various items, on and off the blockchain ## Subcommands -- [key](key) - Create a new keypair and print the public and private keys -- [account](account) - Create a new account on the blockchain +- [key](key.md) - Create a new keypair and print the public and private keys +- [account](account.md) - Create a new account on the blockchain ```console Create various items, on and off the blockchain diff --git a/docs/02_cleos/03_command-reference/get/transaction-status.md b/docs/02_cleos/03_command-reference/get/transaction-status.md index 4873a8fea9..852d8a0d8a 100644 --- a/docs/02_cleos/03_command-reference/get/transaction-status.md +++ b/docs/02_cleos/03_command-reference/get/transaction-status.md @@ -3,7 +3,7 @@ Gets current blockchain state and, if available, transaction information given the transaction id. For query to work, the transaction finality status feature must be enabled by configuring -the chain plugin with the config option "--transaction-finality-status-max-storage-size-gb " +the chain plugin with the config option "--transaction-finality-status-max-storage-size-gb \" in nodeos. ## Position Parameters @@ -19,7 +19,7 @@ in nodeos. cleos get transaction-status 6438df82216dfaf46978f703fb818b49110dbfc5d9b521b5d08c342277438b29 ``` -This command simply returns the current chain status and transaction status information (if available). +This command simply returns the current chain status and transaction status information (if available). ```json { diff --git a/docs/02_cleos/03_command-reference/index.md b/docs/02_cleos/03_command-reference/index.md index fe9d4c01af..14336c52f3 100644 --- a/docs/02_cleos/03_command-reference/index.md +++ b/docs/02_cleos/03_command-reference/index.md @@ -12,7 +12,8 @@ Documentation for all `cleos` main commands - [sign](sign.md) - Sign a transaction - [push](push) - Push arbitrary transactions to the blockchain - [multisig](multisig) - Multisig contract commands - + +[//]: # ( THIS IS A COMMENT FOLLOWING LINE HAD JS COMMENTS JS COMMENTS BREAK MDX ) +[//]: # ( wrap wrap - Wrap contract commands ) + - [system](system) - Send eosio.system contract action to the blockchain. diff --git a/docs/02_cleos/03_command-reference/net/connect.md b/docs/02_cleos/03_command-reference/net/connect.md index be0b2af0b3..646762cf1d 100755 --- a/docs/02_cleos/03_command-reference/net/connect.md +++ b/docs/02_cleos/03_command-reference/net/connect.md @@ -4,7 +4,11 @@ cleos net connect [OPTIONS] host ``` **Where:** -* [OPTIONS] = See **Options** in the [**Command Usage**](command-usage) section below. +* [OPTIONS] = See **Options** section TBD + +[//]: # ( THIS IS A COMMENT LINK BELOW IS BROKEN ) +[//]: # (in the **Command Usage** command-usage section below.) + * host = The hostname:port to connect to **Note:** The arguments and options enclosed in square brackets are optional. diff --git a/docs/02_cleos/03_command-reference/net/disconnect.md b/docs/02_cleos/03_command-reference/net/disconnect.md index 29c3039961..d375c4b239 100755 --- a/docs/02_cleos/03_command-reference/net/disconnect.md +++ b/docs/02_cleos/03_command-reference/net/disconnect.md @@ -4,8 +4,10 @@ cleos net disconnect [OPTIONS] host ``` **Where:** -* [OPTIONS] = See **Options** in the [**Command Usage**](command-usage) section below. -* host = The hostname:port to disconnect from +* [OPTIONS] = See **Options**section TBD + +[//]: # ( THIS IS A COMMENT LINK BELOW IS BROKEN ) +[//]: # (in the **Command Usage** command-usage section below.) **Note:** The arguments and options enclosed in square brackets are optional. diff --git a/docs/02_cleos/03_command-reference/net/index.md b/docs/02_cleos/03_command-reference/net/index.md index 5b09ff42f9..e6067dcb4c 100755 --- a/docs/02_cleos/03_command-reference/net/index.md +++ b/docs/02_cleos/03_command-reference/net/index.md @@ -8,11 +8,11 @@ Usage: cleos net SUBCOMMAND ``` ## Subcommands - - - [cleos net connect](connect) start a new connection to a peer - - [cleos net disconnect](disconnect) close an existing connection - - - [cleos net status](status) status of existing connection - - - [cleos net peers](peers) status of all existing peers + - [cleos net connect](connect.md) start a new connection to a peer + + - [cleos net disconnect](disconnect.md) close an existing connection + + - [cleos net status](status.md) status of existing connection + + - [cleos net peers](peers.md) status of all existing peers diff --git a/docs/02_cleos/03_command-reference/net/peers.md b/docs/02_cleos/03_command-reference/net/peers.md index 2814731c75..81b5adc612 100755 --- a/docs/02_cleos/03_command-reference/net/peers.md +++ b/docs/02_cleos/03_command-reference/net/peers.md @@ -4,7 +4,9 @@ cleos net peers [OPTIONS] ``` **Where:** -* [OPTIONS] = See **Options** in the [**Command Usage**](command-usage) section below. +* [OPTIONS] = See **Options** section TBD + +[//]: # (in the **Command Usage** command-usage section below.) **Note:** The arguments and options enclosed in square brackets are optional. diff --git a/docs/02_cleos/03_command-reference/net/status.md b/docs/02_cleos/03_command-reference/net/status.md index f8f45265ec..55b9052a4b 100755 --- a/docs/02_cleos/03_command-reference/net/status.md +++ b/docs/02_cleos/03_command-reference/net/status.md @@ -4,7 +4,11 @@ cleos net status [OPTIONS] host ``` **Where:** -* [OPTIONS] = See **Options** in the [**Command Usage**](command-usage) section below. +* [OPTIONS] = See **Options** section TBD + +[//]: # ( THIS IS A COMMENT LINK BELOW IS BROKEN ) +[//]: # (in the **Command Usage** command-usage section below.) + * host = The hostname:port to query status of connection **Note:** The arguments and options enclosed in square brackets are optional. diff --git a/docs/02_cleos/03_command-reference/set/index.md b/docs/02_cleos/03_command-reference/set/index.md index 1bb8a95799..ff2e281f4c 100755 --- a/docs/02_cleos/03_command-reference/set/index.md +++ b/docs/02_cleos/03_command-reference/set/index.md @@ -12,9 +12,9 @@ Options: ``` ## Subcommands - -- [code](set-code) - create or update the code on an account -- [abi](set-abi) - create or update the abi on an account -- [contract](set-contract) - create or update the contract on an account -- [account](set-account) - set or update blockchain account state -- [action](set-action) - set or update blockchain action state + +- [code](set-code.md) - create or update the code on an account +- [abi](set-abi.md) - create or update the abi on an account +- [contract](set-contract.md) - create or update the contract on an account +- [account](set-account.md) - set or update blockchain account state +- [action](set-action.md) - set or update blockchain action state diff --git a/docs/02_cleos/03_command-reference/system/system-rex.md b/docs/02_cleos/03_command-reference/system/system-rex.md index 8d872d1727..81f0666b34 100755 --- a/docs/02_cleos/03_command-reference/system/system-rex.md +++ b/docs/02_cleos/03_command-reference/system/system-rex.md @@ -4,22 +4,22 @@ Actions related to REX (the resource exchange). ## Subcommands -- [deposit](system-rex-deposit) - Deposit into owner's REX fund by transfering from owner's liquid token balance -- [withdraw](system-rex-withdraw) - Withdraw from owner's REX fund by transfering to owner's liquid token balance -- [buyrex](system-rex-buyrex) - Buy REX using tokens in owner's REX fund -- [lendrex](system-rex-lendrex) - Deposit tokens to REX fund and use the tokens to buy REX -- [unstaketorex](system-rex-unstaketorex) - Buy REX using staked tokens -- [sellrex](system-rex-sellrex) - Sell REX tokens -- [cancelrexorder](system-rex-cancelrexorder) - Cancel queued REX sell order if one exists -- [mvtosavings](system-rex-mvtosavings) - Move REX tokens to savings bucket -- [mvfromsavings](system-rex-mvfromsavings) - Move REX tokens out of savings bucket -- [rentcpu](system-rex-rentcpu) - Rent CPU bandwidth for 30 days -- [rentnet](system-rex-rentnet) - Rent Network bandwidth for 30 days -- [fundcpuloan](system-rex-fundcpuloan) - Deposit into a CPU loan fund -- [fundnetloan](system-rex-fundnetloan) - Deposit into a Network loan fund -- [defundcpuloan](system-rex-defundcpuloan) - Withdraw from a CPU loan fund -- [defundnetloan](system-rex-defundnetloan) - Withdraw from a Network loan fund -- [consolidate](system-rex-consolidate) - Consolidate REX maturity buckets into one that matures in 4 days -- [updaterex](system-rex-updaterex) - Update REX owner vote stake and vote weight -- [rexexec](system-rex-rexexec) - Perform REX maintenance by processing expired loans and unfilled sell orders -- [closerex](system-rex-closerex) - Delete unused REX-related user table entries +- [deposit](system-rex-deposit.md) - Deposit into owner's REX fund by transfering from owner's liquid token balance +- [withdraw](system-rex-withdraw.md) - Withdraw from owner's REX fund by transfering to owner's liquid token balance +- [buyrex](system-rex-buyrex.md) - Buy REX using tokens in owner's REX fund +- [lendrex](system-rex-lendrex.md) - Deposit tokens to REX fund and use the tokens to buy REX +- [unstaketorex](system-rex-unstaketorex.md) - Buy REX using staked tokens +- [sellrex](system-rex-sellrex.md) - Sell REX tokens +- [cancelrexorder](system-rex-cancelrexorder.md) - Cancel queued REX sell order if one exists +- [mvtosavings](system-rex-mvtosavings.md) - Move REX tokens to savings bucket +- [mvfromsavings](system-rex-mvfromsavings.md) - Move REX tokens out of savings bucket +- [rentcpu](system-rex-rentcpu.md) - Rent CPU bandwidth for 30 days +- [rentnet](system-rex-rentnet.md) - Rent Network bandwidth for 30 days +- [fundcpuloan](system-rex-fundcpuloan.md) - Deposit into a CPU loan fund +- [fundnetloan](system-rex-fundnetloan.md) - Deposit into a Network loan fund +- [defundcpuloan](system-rex-defundcpuloan.md) - Withdraw from a CPU loan fund +- [defundnetloan](system-rex-defundnetloan.md) - Withdraw from a Network loan fund +- [consolidate](system-rex-consolidate.md) - Consolidate REX maturity buckets into one that matures in 4 days +- [updaterex](system-rex-updaterex.md) - Update REX owner vote stake and vote weight +- [rexexec](system-rex-rexexec.md) - Perform REX maintenance by processing expired loans and unfilled sell orders +- [closerex](system-rex-closerex.md) - Delete unused REX-related user table entries diff --git a/docs/02_cleos/03_command-reference/system/system-voteproducer.md b/docs/02_cleos/03_command-reference/system/system-voteproducer.md index 4a4af137b2..c63e6c3b7e 100755 --- a/docs/02_cleos/03_command-reference/system/system-voteproducer.md +++ b/docs/02_cleos/03_command-reference/system/system-voteproducer.md @@ -1,5 +1,5 @@ ## Subcommands -- [voteproducer proxy](system-voteproducer-proxy) - Vote your stake through a proxy -- [voteproducer prods](system-voteproducer-prods) - Vote for one or more producers -- [voteproducer approve](system-voteproducer-approve) -Add one producer to list of voted producers -- [voteproducer unapprove](system-voteproducer-unapprove) - Remove one producer from list of voted producers \ No newline at end of file +- [voteproducer proxy](system-voteproducer-proxy.md) - Vote your stake through a proxy +- [voteproducer prods](system-voteproducer-prods.md) - Vote for one or more producers +- [voteproducer approve](system-voteproducer-approve.md) -Add one producer to list of voted producers +- [voteproducer unapprove](system-voteproducer-unapprove.md) - Remove one producer from list of voted producers diff --git a/docs/02_cleos/03_command-reference/version/index.md b/docs/02_cleos/03_command-reference/version/index.md index 14a8b1be4d..dde0850939 100755 --- a/docs/02_cleos/03_command-reference/version/index.md +++ b/docs/02_cleos/03_command-reference/version/index.md @@ -9,7 +9,7 @@ cleos version ``` ## Subcommands -[client](client) - Retrieve version information of the client +[client](client.md) - Retrieve version information of the client ```sh cleos version client diff --git a/docs/03_keosd/15_plugins/wallet_plugin/index.md b/docs/03_keosd/15_plugins/wallet_plugin/index.md index 418189ce1e..03b71af74a 100644 --- a/docs/03_keosd/15_plugins/wallet_plugin/index.md +++ b/docs/03_keosd/15_plugins/wallet_plugin/index.md @@ -21,7 +21,10 @@ None ## Dependencies -* [`http_plugin`](../http_plugin/index.md) +* `http_plugin` + +[//]: # ( THIS IS A COMMENT LINK BELOW IS BROKEN ) +[//]: # ( `http_plugin` ../http_plugin.md ) ### Load Dependency Examples diff --git a/docs/index.md b/docs/index.md index 5ccf7dd462..76a5441fcd 100644 --- a/docs/index.md +++ b/docs/index.md @@ -13,9 +13,11 @@ The basic relationship between these components is illustrated in the diagram be ![EOSIO components](mandel_components.png) Additional EOSIO Resources: -* [EOSIO Utilities](10_utilities/index.md) - Utilities that complement the EOSIO software. -* [Upgrade Guide](20_upgrade-guide/index.md) - EOSIO version/protocol upgrade guide. -* [Release Notes](30_release-notes/index.md) - All release notes for this EOSIO version. +* [EOSIO Utilities](10_utilities/index.md) - Utilities that complement the EOSIO software. + +[//]: # (THIS IS A COMMENT REMOVING BROKEN LINKS) +[//]: #Upgrade-Guide-20_upgrade-guide/index.md-EOSIO-version/protocol-upgrade-guide. +[//]: # (Release Notes 30_release-notes/index.md - All release notes for this EOSIO version.) [[info | What's Next?]] | [Install the EOSIO Software](00_install/index.md) before exploring the sections above. From 6cccdfa98c3616464b019eba1ef6e49b39378a6f Mon Sep 17 00:00:00 2001 From: 766C6164 Date: Sun, 17 Jul 2022 23:02:54 -0400 Subject: [PATCH 08/18] Added FreeBSD build instructions --- docs/00_install/01_build-from-source/index.md | 25 +++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/docs/00_install/01_build-from-source/index.md b/docs/00_install/01_build-from-source/index.md index 343ad80ccc..101f5a5b32 100644 --- a/docs/00_install/01_build-from-source/index.md +++ b/docs/00_install/01_build-from-source/index.md @@ -94,6 +94,31 @@ make -j $(nproc) package After building you may remove the `$HOME/boost1.79` directory, or you may keep it around until next time building the software. +
+ FreeBSD 13.1 Build Instructions + +Install required dependencies: +``` +pkg update && pkg install \ + git \ + cmake \ + curl \ + boost-all \ + python3 \ + openssl \ + llvm11 \ + pkgconf +``` +and perform the build (please note that FreeBSD 13.1 comes with llvm13 by default so you should provide clang11 options to cmake): +``` +git submodule update --init --recursive +mkdir build +cd build +cmake -DCMAKE_CXX_COMPILER=clang++11 -DCMAKE_C_COMPILER=clang11 -DCMAKE_BUILD_TYPE=Release .. +make -j $(nproc) package +``` +
+ ### Running Tests When building from source it's recommended to run at least what we refer to as the "parallelizable tests". Not included by default in the "parallelizable tests" are the WASM spec tests which can add additional coverage and can also be run in parallel. From 61176512ef1842b2b82a441f399ea41800e049d6 Mon Sep 17 00:00:00 2001 From: 766C6164 Date: Tue, 19 Jul 2022 02:26:01 -0400 Subject: [PATCH 09/18] Moved unsupported stuff in a separate file --- .../00_build-unsupported-os.md | 59 +++++++++++++++++++ docs/00_install/01_build-from-source/index.md | 25 -------- docs/00_install/index.md | 4 +- 3 files changed, 62 insertions(+), 26 deletions(-) create mode 100644 docs/00_install/01_build-from-source/00_build-unsupported-os.md diff --git a/docs/00_install/01_build-from-source/00_build-unsupported-os.md b/docs/00_install/01_build-from-source/00_build-unsupported-os.md new file mode 100644 index 0000000000..ee59d0f0f3 --- /dev/null +++ b/docs/00_install/01_build-from-source/00_build-unsupported-os.md @@ -0,0 +1,59 @@ +--- +content_title: Build EOSIO from Source on Other Unix-based OS +--- + +**Please keep in mind that instructions for building from source on other unsupported operating systems provided here should be considered experimental and provided AS-IS on a best-effort basis and may not be fully featured.** + +**A Warning On Parallel Compilation Jobs (`-j` flag)**: When building C/C++ software often the build is performed in parallel via a command such as `make -j $(nproc)` which uses the number of CPU cores as the number of compilation jobs to perform simultaneously. However, be aware that some compilation units (.cpp files) in mandel are extremely complex and will consume nearly 4GB of memory to compile. You may need to reduce the level of parallelization depending on the amount of memory on your build host. e.g. instead of `make -j $(nproc)` run `make -j2`. Failures due to memory exhaustion will typically but not always manifest as compiler crashes. + +Generally we recommend performing what we refer to as a "pinned build" which ensures the compiler and boost version remain the same between builds of different mandel versions (mandel requires these versions remain the same otherwise its state needs to be repopulated from a portable snapshot). + +
+ FreeBSD 13.1 Build Instructions + +Install required dependencies: +``` +pkg update && pkg install \ + git \ + cmake \ + curl \ + boost-all \ + python3 \ + openssl \ + llvm11 \ + pkgconf +``` +and perform the build (please note that FreeBSD 13.1 comes with llvm13 by default so you should provide clang11 options to cmake): +``` +git submodule update --init --recursive +mkdir build +cd build +cmake -DCMAKE_CXX_COMPILER=clang++11 -DCMAKE_C_COMPILER=clang11 -DCMAKE_BUILD_TYPE=Release .. +make -j $(nproc) package +``` +
+ +### Running Tests + +When building from source it's recommended to run at least what we refer to as the "parallelizable tests". Not included by default in the "parallelizable tests" are the WASM spec tests which can add additional coverage and can also be run in parallel. + +``` +cd build + +# "parallelizable tests": the minimum test set that should be run +ctest -j $(nproc) -LE _tests + +# Also consider running the WASM spec tests for more coverage +ctest -j $(nproc) -L wasm_spec_tests +``` + +Some other tests are available and recommended but be aware they can be sensitive to other software running on the same host and they may **SIGKILL** other nodeos instances running on the host. +``` +cd build + +# These tests can't run in parallel but are recommended. +ctest -L "nonparallelizable_tests" + +# These tests can't run in parallel. They also take a long time to run. +ctest -L "long_running_tests" +``` \ No newline at end of file diff --git a/docs/00_install/01_build-from-source/index.md b/docs/00_install/01_build-from-source/index.md index 101f5a5b32..343ad80ccc 100644 --- a/docs/00_install/01_build-from-source/index.md +++ b/docs/00_install/01_build-from-source/index.md @@ -94,31 +94,6 @@ make -j $(nproc) package After building you may remove the `$HOME/boost1.79` directory, or you may keep it around until next time building the software. -
- FreeBSD 13.1 Build Instructions - -Install required dependencies: -``` -pkg update && pkg install \ - git \ - cmake \ - curl \ - boost-all \ - python3 \ - openssl \ - llvm11 \ - pkgconf -``` -and perform the build (please note that FreeBSD 13.1 comes with llvm13 by default so you should provide clang11 options to cmake): -``` -git submodule update --init --recursive -mkdir build -cd build -cmake -DCMAKE_CXX_COMPILER=clang++11 -DCMAKE_C_COMPILER=clang11 -DCMAKE_BUILD_TYPE=Release .. -make -j $(nproc) package -``` -
- ### Running Tests When building from source it's recommended to run at least what we refer to as the "parallelizable tests". Not included by default in the "parallelizable tests" are the WASM spec tests which can add additional coverage and can also be run in parallel. diff --git a/docs/00_install/index.md b/docs/00_install/index.md index 0bfa20716f..23a61b3271 100644 --- a/docs/00_install/index.md +++ b/docs/00_install/index.md @@ -15,7 +15,9 @@ EOSIO currently supports the following operating systems: 3. Ubuntu 22.04 [[info | Note]] -| It may be possible to build and install EOSIO on other Unix-based operating systems. This is not officially supported, though. +| It may be possible to build and install EOSIO on other Unix-based operating systems. We gathered helpful information on the following page but please keep in mind that it is experimental and not officially supported. + +* [Build EOSIO on Other Unix-based Systems](01_build-from-source/00_build-unsupported-os.md) ## Docker Utilities for Node Execution (D.U.N.E.) From 2bbcdae2f63e9345ecd1f8f9f6ff5bc50ccf7258 Mon Sep 17 00:00:00 2001 From: Eric Passmore Date: Thu, 4 Aug 2022 17:52:00 -0700 Subject: [PATCH 10/18] documentation fixes to power developer doc portal * Support MDX parsing * Replace github references to EOS Network Foundation * Replace references to old documentation portal * Fix broken links Markdown files under `docs` and under `tutorial` The developer documentation portal is powered by markdown files. These files are parsed to create a nice looking web site. We use MDX as the parsing engine. MDX requires all html tags are closed. We went through all the files removing unneeded '
' tags, enclosing angle brackets in quotes, and closing img tags. Many times we found documentation pointing to old repositories that had not been updated in years. We updated the links and pointed to repositories that are better maintained. We made sure links to the documentation portal did not leak back to older, previous versions. We found relative links that no longer existed. We made sure to point the links to best location. Sometimes the links broke because were missing a key file extension. We made sure to add back the file extenstion. **Note:** This is essentially a no-op; however summarizing here for anyone following the commit history. Glossary and Protocol Guides were added and removed during the course of development. We had added a Glossary and Protocol Guides , and we decided to utilize the welcome repository as the source for both. commit ba20420c42f2f8bbf3396102d3ac22261028af30 Author: Eric Passmore Date: Thu Aug 4 12:46:52 2022 -0700 Testsnets anchor link was not working rm it commit d5de39dbbe250d2a9878c82de990c086c3b7b122 Author: Eric Passmore Date: Thu Aug 4 10:27:42 2022 -0700 adding missing .md ext commit 9dbb885d2eb308e60a2db909c9aed7b5dcb4289a Author: Eric Passmore Date: Thu Aug 4 10:24:49 2022 -0700 found another eos.io reference to replace commit 6a10c44b5863552c85c283db5b6d24e84b84f2cf Author: Eric Passmore Date: Thu Aug 4 08:47:02 2022 -0700 moved away from eos testnet commit 023c8e50724b766b0b9c8ce859d106101bc90fc8 Merge: 9d486ab51 6514a7d63 Author: Eric Passmore Date: Thu Aug 4 08:33:00 2022 -0700 Merge remote-tracking branch 'origin/main' into documentation-fixes Fixing docs by removing eosio references, need resync with main to catch merge issues early commit 9d486ab51aa399a4e5c7a038c19531071a88e900 Author: Eric Passmore Date: Tue Aug 2 08:19:36 2022 -0700 updated protocol-guides links to include number commit 907d9e2af8796087ba830f10f53df0063d0a621d Author: Eric Passmore Date: Fri Jul 29 16:23:41 2022 -0700 removed general_info replaced by welcome repository markdown commit 07efa3fb831ef2d57f68be0ef3aa21e28c346a80 Merge: 056239ccc d36ca7a52 Author: Eric Passmore Date: Fri Jul 29 07:10:24 2022 -0700 merging with upstream/main keeping up to date commit 056239cccb5e3337b5598364190cd4dc9d16a281 Merge: b921bdf98 b378866ef Author: Eric Passmore Date: Tue Jul 26 17:08:43 2022 -0700 Merge remote-tracking branch 'refs/remotes/origin/documentation-fixes' into documentation-fixes Note pulled in "changes to lower bound description" 766C6164 Resolved Conflicts No Changes: docs/general_info/glossary.md docs/general_info/protocol-guides/consensus_protocol.md docs/general_info/protocol-guides/network_peer_protocol.md docs/general_info/protocol-guides/transactions_protocol.md Changes to be committed: modified: docs/general_info/protocol-guides/accounts_and_permissions.md modified: libraries/chain/include/eosio/chain/webassembly/interface.hpp commit b921bdf987c0206b6704968eaca3bc05c505d469 Author: Eric Passmore Date: Tue Jul 26 16:44:25 2022 -0700 removed eos.io from markdown - Added docs/general_info/glossary.md - Added docs/general_info/protocol-guides - overview only for accounts_and_permissions.md - overview only for transactions_protocol.md - overview only for network_peer_protocol.md - overview only for consensus_protocol.md - Updated glossary.md to relative path (no more eos.io) - Fixed links adding missing .md extenstion - Updated protocol-guides to relative path (no more eos.io) - Included BiosBoot tutorial on main document portal - Fixed or removed broken links inside newly added glossary, guides, and tutorials Note: squashed commits on branch down to single commit, less noise, easier to cherry-pick commit b378866eff4be5cd3986c88a6d6ff39a802fee57 Author: Eric Passmore Date: Tue Jul 26 15:36:42 2022 -0700 adding back more missing .md extenstions, and simplying bios-boot-tutorial commit 2f7c0e65cbf360ba13102c8a5341714c4ce1159d Author: Eric Passmore Date: Tue Jul 26 15:14:16 2022 -0700 fixing more missing .md ext commit 07b1f16962921acdd35d24c87e6a87378c7a10fc Author: Eric Passmore Date: Tue Jul 26 15:03:06 2022 -0700 updated with .md ext commit 002b01ddc81e67d09dba40fae9cc2303b4efed7b Author: Eric Passmore Date: Tue Jul 26 14:29:33 2022 -0700 updated formate for glossary links to include .md commit bf344ae16c76ca1109672b8e9cccc5a69527e3d3 Merge: 3bbb956b5 0cb196b7f Author: Eric Passmore Date: Tue Jul 26 08:48:05 2022 -0700 merging main into documentation-fixes, after removing eso.io references adding glossary and guides commit 3bbb956b524267c788dd9614011abeda1be96b93 Author: Eric Passmore Date: Tue Jul 26 08:47:12 2022 -0700 remove eos.io references, added glossary, guides --- .../00_build-unsupported-os.md | 8 +- docs/00_install/01_build-from-source/index.md | 12 ++- .../03_development-environment/index.md | 8 +- .../03_plugins/history_api_plugin/index.md | 3 - .../03_plugins/net_api_plugin/index.md | 2 +- docs/01_nodeos/03_plugins/net_plugin/index.md | 76 +++++++++---------- ...0_how-to-fast-start-without-old-history.md | 2 +- ...w-to-restore-snapshot-with-full-history.md | 2 +- .../07_concepts/05_storage-and-read-modes.md | 6 +- docs/01_nodeos/08_troubleshooting/index.md | 16 ++-- .../how-to-create-a-wallet.md | 6 +- .../how-to-create-an-account.md | 10 +-- .../how-to-delegate-CPU-resource.md | 6 +- .../how-to-delegate-net-resource.md | 6 +- .../how-to-get-account-information.md | 6 +- .../how-to-get-block-information.md | 10 ++- .../how-to-get-transaction-information.md | 10 +-- .../02_how-to-guides/how-to-import-a-key.md | 10 +-- .../how-to-list-all-key-pairs.md | 10 +-- .../03_command-reference/get/account.md | 6 +- .../03_command-reference/net/peers.md | 2 +- .../03_command-reference/net/status.md | 2 +- .../03_command-reference/set/set-account.md | 2 +- .../03_command-reference/set/set-action.md | 6 +- docs/index.md | 2 +- tutorials/bios-boot-tutorial/README.md | 2 - 26 files changed, 118 insertions(+), 113 deletions(-) mode change 100755 => 100644 docs/02_cleos/03_command-reference/get/account.md mode change 100755 => 100644 docs/02_cleos/03_command-reference/net/peers.md mode change 100755 => 100644 docs/02_cleos/03_command-reference/net/status.md mode change 100755 => 100644 docs/02_cleos/03_command-reference/set/set-account.md mode change 100755 => 100644 docs/02_cleos/03_command-reference/set/set-action.md diff --git a/docs/00_install/01_build-from-source/00_build-unsupported-os.md b/docs/00_install/01_build-from-source/00_build-unsupported-os.md index ee59d0f0f3..a9988c0215 100644 --- a/docs/00_install/01_build-from-source/00_build-unsupported-os.md +++ b/docs/00_install/01_build-from-source/00_build-unsupported-os.md @@ -4,6 +4,10 @@ content_title: Build EOSIO from Source on Other Unix-based OS **Please keep in mind that instructions for building from source on other unsupported operating systems provided here should be considered experimental and provided AS-IS on a best-effort basis and may not be fully featured.** +### Using DUNE + +For the official multi-platform support try [Docker Utilities for Node Execution](https://github.com/eosnetworkfoundation/DUNE) which runs in an ubuntu image via a docker container. + **A Warning On Parallel Compilation Jobs (`-j` flag)**: When building C/C++ software often the build is performed in parallel via a command such as `make -j $(nproc)` which uses the number of CPU cores as the number of compilation jobs to perform simultaneously. However, be aware that some compilation units (.cpp files) in mandel are extremely complex and will consume nearly 4GB of memory to compile. You may need to reduce the level of parallelization depending on the amount of memory on your build host. e.g. instead of `make -j $(nproc)` run `make -j2`. Failures due to memory exhaustion will typically but not always manifest as compiler crashes. Generally we recommend performing what we refer to as a "pinned build" which ensures the compiler and boost version remain the same between builds of different mandel versions (mandel requires these versions remain the same otherwise its state needs to be repopulated from a portable snapshot). @@ -11,7 +15,7 @@ Generally we recommend performing what we refer to as a "pinned build" which ens
FreeBSD 13.1 Build Instructions -Install required dependencies: +Install required dependencies: ``` pkg update && pkg install \ git \ @@ -56,4 +60,4 @@ ctest -L "nonparallelizable_tests" # These tests can't run in parallel. They also take a long time to run. ctest -L "long_running_tests" -``` \ No newline at end of file +``` diff --git a/docs/00_install/01_build-from-source/index.md b/docs/00_install/01_build-from-source/index.md index 343ad80ccc..d2a817d01b 100644 --- a/docs/00_install/01_build-from-source/index.md +++ b/docs/00_install/01_build-from-source/index.md @@ -4,6 +4,10 @@ content_title: Build EOSIO from Source The shell scripts previously recommended for building the software have been removed in favor of a build process entirely driven by CMake. Those wishing to build from source are now responsible for installing the necessary dependencies. The list of dependencies and the recommended build procedure are in the README.md file. Instructions are also included for efficiently running the tests. +### Using DUNE + +As an alternative to building from source try [Docker Utilities for Node Execution](https://github.com/eosnetworkfoundation/DUNE) for the easiest way to get started, and for multi-platform support. + ### Building From Source Recent Ubuntu LTS releases are the only Linux distributions that we fully support. Other Linux distros and other POSIX operating systems (such as macOS) are tended to on a best-effort basis and may not be full featured. Notable requirements to build are: @@ -30,7 +34,7 @@ The binary package will be produced in the mandel build directory that was suppl
Ubuntu 20.04 & 22.04 Build Instructions -Install required dependencies: +Install required dependencies: ``` apt-get update && apt-get install \ build-essential \ @@ -58,7 +62,7 @@ make -j $(nproc) package
Ubuntu 18.04 Build Instructions -Install required dependencies. You will need to build Boost from source on this distribution. +Install required dependencies. You will need to build Boost from source on this distribution. ``` apt-get update && apt-get install \ build-essential \ @@ -74,7 +78,7 @@ apt-get update && apt-get install \ pkg-config \ python3 \ zlib1g-dev - + curl -L https://boostorg.jfrog.io/artifactory/main/release/1.79.0/source/boost_1_79_0.tar.bz2 | tar jx && \ cd boost_1_79_0 && \ ./bootstrap.sh --prefix=$HOME/boost1.79 && \ @@ -117,4 +121,4 @@ ctest -L "nonparallelizable_tests" # These tests can't run in parallel. They also take a long time to run. ctest -L "long_running_tests" -``` \ No newline at end of file +``` diff --git a/docs/01_nodeos/02_usage/03_development-environment/index.md b/docs/01_nodeos/02_usage/03_development-environment/index.md index fcb7f7b463..9305397d45 100644 --- a/docs/01_nodeos/02_usage/03_development-environment/index.md +++ b/docs/01_nodeos/02_usage/03_development-environment/index.md @@ -8,18 +8,18 @@ There are several ways to configure a `nodeos` environment for development and t This is the go-to option for smart contract developers, aspiring Block Producers or Non-Producing Node operators. It has the most simple configuration with the least number of requirements. -* [Configure Nodeos as a Local Single-node Testnet](00_local-single-node-testnet.md) +* [Configure Nodeos as a Local Single-node Testnet](00_local-single-node-testnet.md) ## Local Multi-Node Testnet While this option can technically be used for smart contract development, it may be overkill. This is most beneficial for those who are working on aspects of core development, such as benchmarking, optimization and experimentation. It's also a good option for hands-on learning and concept proofing. * [Configure Nodeos as a Local Two-Node Testnet](01_local-multi-node-testnet.md) -* [Configure Nodeos as a Local 21-Node Testnet](https://github.com/eosnetworkfoundation/mandel/tree/main/tutorials/bios-boot-tutorial) +* [Configure Nodeos as a Local 21-Node Testnet](/tutorials/bios-boot-tutorial.md) -## Official Testnet +## Official Testing Node -The official testnet for testing EOSIO dApps and smart contracts will be available soon +Try [Docker Utilities for Node Execution](https://github.com/eosnetworkfoundation/DUNE) for the easiest way to get started, and for multi-platform support. ## Third-Party Testnets diff --git a/docs/01_nodeos/03_plugins/history_api_plugin/index.md b/docs/01_nodeos/03_plugins/history_api_plugin/index.md index df8e448aca..a506e94b75 100644 --- a/docs/01_nodeos/03_plugins/history_api_plugin/index.md +++ b/docs/01_nodeos/03_plugins/history_api_plugin/index.md @@ -12,9 +12,6 @@ It provides four RPC API endpoints: * get_key_accounts * get_controlled_accounts -[[info | More Info]] -| See HISTORY section of [RPC API](https://developers.eos.io/eosio-nodeos/reference). - The four actions listed above are used by the following `cleos` commands (matching order): * get actions diff --git a/docs/01_nodeos/03_plugins/net_api_plugin/index.md b/docs/01_nodeos/03_plugins/net_api_plugin/index.md index ac7ca7273f..bf6bdfbf0d 100644 --- a/docs/01_nodeos/03_plugins/net_api_plugin/index.md +++ b/docs/01_nodeos/03_plugins/net_api_plugin/index.md @@ -8,7 +8,7 @@ The `net_api_plugin` provides four RPC API endpoints: * connections * status -See [Net API Reference Documentation](https://developers.eos.io/manuals/eos/latest/nodeos/plugins/net_api_plugin/api-reference/index). +See [Net API Reference Documentation](http://docs.eosnetwork.com/reference/mandel-plugins/net_api.html). [[caution | Caution]] | This plugin exposes endpoints that allow management of p2p connections. Running this plugin on a publicly accessible node is not recommended as it can be exploited. diff --git a/docs/01_nodeos/03_plugins/net_plugin/index.md b/docs/01_nodeos/03_plugins/net_plugin/index.md index e7da4beb85..a7762c922c 100644 --- a/docs/01_nodeos/03_plugins/net_plugin/index.md +++ b/docs/01_nodeos/03_plugins/net_plugin/index.md @@ -23,77 +23,77 @@ Config Options for eosio::net_plugin: --p2p-listen-endpoint arg (=0.0.0.0:9876) The actual host:port used to listen for incoming p2p connections. - --p2p-server-address arg An externally accessible host:port for - identifying this node. Defaults to + --p2p-server-address arg An externally accessible host:port for + identifying this node. Defaults to p2p-listen-endpoint. - --p2p-peer-address arg The public endpoint of a peer node to - connect to. Use multiple - p2p-peer-address options as needed to + --p2p-peer-address arg The public endpoint of a peer node to + connect to. Use multiple + p2p-peer-address options as needed to compose a network. Syntax: host:port[:|] - The optional 'trx' and 'blk' - indicates to node that only - transactions 'trx' or blocks 'blk' + The optional 'trx' and 'blk' + indicates to node that only + transactions 'trx' or blocks 'blk' should be sent. Examples: - p2p.eos.io:9876 - p2p.trx.eos.io:9876:trx - p2p.blk.eos.io:9876:blk - + p2p.domain.io:9876 + p2p.trx.domaine.io:9876:trx + p2p.blk.domain.io:9876:blk + --p2p-max-nodes-per-host arg (=1) Maximum number of client nodes from any single IP address - --p2p-accept-transactions arg (=1) Allow transactions received over p2p - network to be evaluated and relayed if + --p2p-accept-transactions arg (=1) Allow transactions received over p2p + network to be evaluated and relayed if valid. --agent-name arg (="EOS Test Agent") The name supplied to identify this node amongst the peers. - --allowed-connection arg (=any) Can be 'any' or 'producers' or - 'specified' or 'none'. If 'specified', - peer-key must be specified at least - once. If only 'producers', peer-key is - not required. 'producers' and + --allowed-connection arg (=any) Can be 'any' or 'producers' or + 'specified' or 'none'. If 'specified', + peer-key must be specified at least + once. If only 'producers', peer-key is + not required. 'producers' and 'specified' may be combined. - --peer-key arg Optional public key of peer allowed to + --peer-key arg Optional public key of peer allowed to connect. May be used multiple times. - --peer-private-key arg Tuple of [PublicKey, WIF private key] + --peer-private-key arg Tuple of [PublicKey, WIF private key] (may specify multiple times) - --max-clients arg (=25) Maximum number of clients from which - connections are accepted, use 0 for no + --max-clients arg (=25) Maximum number of clients from which + connections are accepted, use 0 for no limit - --connection-cleanup-period arg (=30) number of seconds to wait before + --connection-cleanup-period arg (=30) number of seconds to wait before cleaning up dead connections --max-cleanup-time-msec arg (=10) max connection cleanup time per cleanup call in milliseconds --p2p-dedup-cache-expire-time-sec arg (=10) - Maximum time to track transaction for + Maximum time to track transaction for duplicate optimization - --net-threads arg (=2) Number of worker threads in net_plugin + --net-threads arg (=2) Number of worker threads in net_plugin thread pool --sync-fetch-span arg (=100) number of blocks to retrieve in a chunk - from any individual peer during + from any individual peer during synchronization - --use-socket-read-watermark arg (=0) Enable experimental socket read + --use-socket-read-watermark arg (=0) Enable experimental socket read watermark optimization --peer-log-format arg (=["${_name}" ${_ip}:${_port}]) - The string used to format peers when + The string used to format peers when logging messages about them. Variables are escaped with ${}. Available Variables: _name self-reported name - - _id self-reported ID (64 hex + + _id self-reported ID (64 hex characters) - - _sid first 8 characters of + + _sid first 8 characters of _peer.id - + _ip remote IP address of peer - + _port remote port number of peer - + _lip local IP address connected to peer - - _lport local port number connected + + _lport local port number connected to peer ``` diff --git a/docs/01_nodeos/03_plugins/state_history_plugin/10_how-to-fast-start-without-old-history.md b/docs/01_nodeos/03_plugins/state_history_plugin/10_how-to-fast-start-without-old-history.md index 4e1f534483..962b9e711c 100644 --- a/docs/01_nodeos/03_plugins/state_history_plugin/10_how-to-fast-start-without-old-history.md +++ b/docs/01_nodeos/03_plugins/state_history_plugin/10_how-to-fast-start-without-old-history.md @@ -20,7 +20,7 @@ This procedure records the current chain state and future history, without previ 2. Make sure `data/state` does not exist -3. Start `nodeos` with the `--snapshot` option, and the options listed in the [`state_history_plugin`](#index.md). +3. Start `nodeos` with the `--snapshot` option, and the options listed in the [`state_history_plugin`](index.md). 4. Look for `Placing initial state in block n` in the log, where n is the start block number. diff --git a/docs/01_nodeos/03_plugins/state_history_plugin/40_how-to-restore-snapshot-with-full-history.md b/docs/01_nodeos/03_plugins/state_history_plugin/40_how-to-restore-snapshot-with-full-history.md index 6eb2e76db4..52e3b27e5e 100644 --- a/docs/01_nodeos/03_plugins/state_history_plugin/40_how-to-restore-snapshot-with-full-history.md +++ b/docs/01_nodeos/03_plugins/state_history_plugin/40_how-to-restore-snapshot-with-full-history.md @@ -21,7 +21,7 @@ This procedure restores an existing snapshot with full history, so the node can 2. Make sure `data/state` does not exist -3. Start `nodeos` with the `--snapshot` option, and the options listed in the [`state_history_plugin`](#index.md). +3. Start `nodeos` with the `--snapshot` option, and the options listed in the [`state_history_plugin`](index.md). 4. Do not stop `nodeos` until it has received at least 1 block from the network, or it won't be able to restart. diff --git a/docs/01_nodeos/07_concepts/05_storage-and-read-modes.md b/docs/01_nodeos/07_concepts/05_storage-and-read-modes.md index df2a872729..08f1f7ba81 100644 --- a/docs/01_nodeos/07_concepts/05_storage-and-read-modes.md +++ b/docs/01_nodeos/07_concepts/05_storage-and-read-modes.md @@ -17,7 +17,7 @@ Every `nodeos` instance creates some internal files to housekeep the blockchain ## EOSIO Interfaces -EOSIO provides a set of [services](../../) and [interfaces](https://developers.eos.io/manuals/eosio.cdt/latest/files) that enable contract developers to persist state across action, and consequently transaction, boundaries. Contracts may use these services and interfaces for various purposes. For example, `eosio.token` contract keeps balances for all users in the chain database. Each instance of `nodeos` keeps the database in memory, so contracts can read and write data with ease. +EOSIO provides a set of [services](../../) and [interfaces](http://docs.eosnetwork.com/reference/mandel-cdt/files.html) that enable contract developers to persist state across action, and consequently transaction, boundaries. Contracts may use these services and interfaces for various purposes. For example, `eosio.token` contract keeps balances for all users in the chain database. Each instance of `nodeos` keeps the database in memory, so contracts can read and write data with ease. ### Nodeos RPC API @@ -40,7 +40,7 @@ Clients such as `cleos` and the RPC API, will see database state as of the curre Speculative mode is low latency but fragile, there is no guarantee that the transactions reflected in the state will be included in the chain OR that they will reflected in the same order the state implies. -This mode features the lowest latency, but is the least consistent. +This mode features the lowest latency, but is the least consistent. In speculative mode `nodeos` is able to execute transactions which have TaPoS (Transaction as Proof of Stake) pointing to any valid block in a fork considered to be the best fork by this node. @@ -61,7 +61,7 @@ Clients such as `cleos` and the RPC API will see database state as of the curren ### Irreversible Mode -When `nodeos` is configured to be in irreversible read mode, it will still track the most up-to-date blocks in the fork database, but the state will lag behind the current best head block, sometimes referred to as the fork DB head, to always reflect the state of the last irreversible block. +When `nodeos` is configured to be in irreversible read mode, it will still track the most up-to-date blocks in the fork database, but the state will lag behind the current best head block, sometimes referred to as the fork DB head, to always reflect the state of the last irreversible block. Clients such as `cleos` and the RPC API will see database state as of the current head block of the chain. It **will not** include changes made by transactions known to this node but not included in the chain, such as unconfirmed transactions. diff --git a/docs/01_nodeos/08_troubleshooting/index.md b/docs/01_nodeos/08_troubleshooting/index.md index 409ca6c371..7aa22031d8 100644 --- a/docs/01_nodeos/08_troubleshooting/index.md +++ b/docs/01_nodeos/08_troubleshooting/index.md @@ -4,7 +4,7 @@ content_title: Nodeos Troubleshooting ### "Database dirty flag set (likely due to unclean shutdown): replay required" -`nodeos` needs to be shut down cleanly. To ensure this is done, send a `SIGTERM`, `SIGQUIT` or `SIGINT` and wait for the process to shutdown. Failing to do this will result in this error. If you get this error, your only recourse is to replay by starting `nodeos` with `--replay-blockchain` +`nodeos` needs to be shut down cleanly. To ensure this is done, send a `SIGTERM`, `SIGQUIT` or `SIGINT` and wait for the process to shutdown. Failing to do this will result in this error. If you get this error, your only recourse is to replay by starting `nodeos` with `--replay-blockchain` ### "Memory does not match data" Error at Restart @@ -12,15 +12,15 @@ If you get an error such as `St9exception: content of memory does not match data ``` Command Line Options for eosio::chain_plugin: - --force-all-checks do not skip any checks that can be - skipped while replaying irreversible + --force-all-checks do not skip any checks that can be + skipped while replaying irreversible blocks - --replay-blockchain clear chain state database and replay + --replay-blockchain clear chain state database and replay all blocks - --hard-replay-blockchain clear chain state database, recover as - many blocks as possible from the block + --hard-replay-blockchain clear chain state database, recover as + many blocks as possible from the block log, and then replay those blocks - --delete-all-blocks clear chain state database and block + --delete-all-blocks clear chain state database and block log ``` @@ -44,4 +44,4 @@ cleos --url http://localhost:8888 get info | grep server_version ### Error 3070000: WASM Exception Error -If you try to deploy the `eosio.bios` contract or `eosio.system` contract in an attempt to boot an EOSIO-based blockchain and you get the following error or similar: `Publishing contract... Error 3070000: WASM Exception Error Details: env.set_proposed_producers_ex unresolveable`, it is because you have to activate the `PREACTIVATE_FEATURE` protocol first. More details about it and how to enable it can be found in the [Bios Boot Sequence Tutorial](https://developers.eos.io/welcome/latest/tutorials/bios-boot-sequence/#112-set-the-eosiosystem-contract). For more information, you may also visit the [Nodeos Upgrade Guides](https://developers.eos.io/manuals/eos/latest/nodeos/upgrade-guides/). +If you try to deploy the `eosio.bios` contract or `eosio.system` contract in an attempt to boot an EOSIO-based blockchain and you get the following error or similar: `Publishing contract... Error 3070000: WASM Exception Error Details: env.set_proposed_producers_ex unresolveable`, it is because you have to activate the `PREACTIVATE_FEATURE` protocol first. diff --git a/docs/02_cleos/02_how-to-guides/how-to-create-a-wallet.md b/docs/02_cleos/02_how-to-guides/how-to-create-a-wallet.md index 4973217f16..06e3ff199b 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-create-a-wallet.md +++ b/docs/02_cleos/02_how-to-guides/how-to-create-a-wallet.md @@ -13,9 +13,9 @@ Make sure you meet the following requirements: [[info | Note]] | `cleos` is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install `cleos`. -* Understand what an [account](https://developers.eos.io/welcome/latest/glossary/index/#account) is and its role in the blockchain. -* Understand [Accounts and Permissions](https://developers.eos.io/welcome/latest/protocol-guides/accounts_and_permissions) in the protocol documents. -* Understand what a [public](https://developers.eos.io/welcome/latest/glossary/index/#public-key) and [private](https://developers.eos.io/welcome/latest/glossary/index/#private-key) key pair is. +* Understand what an [account](/glossary.md#account) is and its role in the blockchain. +* Understand [Accounts and Permissions](/protocol-guides/04_accounts_and_permissions.md) in the protocol documents. +* Understand what a [public](/glossary.md#public-key) and [private](/glossary.md#private-key) key pair is. ## Steps diff --git a/docs/02_cleos/02_how-to-guides/how-to-create-an-account.md b/docs/02_cleos/02_how-to-guides/how-to-create-an-account.md index 20fc565847..1fd79840ff 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-create-an-account.md +++ b/docs/02_cleos/02_how-to-guides/how-to-create-an-account.md @@ -2,7 +2,7 @@ This how-to guide provides instructions on how to create a new EOSIO blockchain account using the `cleos` CLI tool. You can use accounts to deploy smart contracts and perform other related blockchain operations. Create one or multiple accounts as part of your development environment setup. -The example in this how-to guide creates a new account named **bob**, authorized by the default system account **eosio**, using the `cleos` CLI tool. +The example in this how-to guide creates a new account named **bob**, authorized by the default system account **eosio**, using the `cleos` CLI tool. ## Before you Begin @@ -10,9 +10,9 @@ Make sure you meet the following requirements: * Install the currently supported version of `cleos`. [[info | Note]] -| The cleos tool is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install the cleos tool. -* Learn about [EOSIO Accounts and Permissions](https://developers.eos.io/welcome/v2.1/protocol/accounts_and_permissions) -* Learn about Asymmetric Cryptography - [public key](https://developers.eos.io/welcome/v2.1/glossary/index#public-key) and [private key](https://developers.eos.io/welcome/v2.1/glossary/index#private-key) pairs. +| The cleos tool is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install the cleos tool. +* Learn about [EOSIO Accounts and Permissions](/protocol-guides/04_accounts_and_permissions.md) +* Learn about Asymmetric Cryptography - [public key](/glossary.md#public-key) and [private key](/glossary.md#private-key) pairs. * Create public/private keypairs for the `owner` and `active` permissions of an account. ## Command Reference @@ -31,7 +31,7 @@ cleos create account eosio bob EOS87TQktA5RVse2EguhztfQVEh6XXxBmgkU8b4Y5YnGvtYAo ``` **Where**: * `eosio` = the system account that authorizes the creation of a new account -* `bob` = the name of the new account conforming to [account naming conventions](https://developers.eos.io/welcome/v2.1/protocol-guides/accounts_and_permissions#2-accounts) +* `bob` = the name of the new account conforming to [account naming conventions](/protocol-guides/04_accounts_and_permissions.md#2-accounts) * `EOS87TQ...AoLGNN` = the owner public key or permission level for the new account (**required**) [[info | Note]] | To create a new account in the EOSIO blockchain, an existing account, also referred to as a creator account, is required to authorize the creation of a new account. For a newly created EOSIO blockchain, the default system account used to create a new account is **eosio**. diff --git a/docs/02_cleos/02_how-to-guides/how-to-delegate-CPU-resource.md b/docs/02_cleos/02_how-to-guides/how-to-delegate-CPU-resource.md index 155c738bf6..00d977278a 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-delegate-CPU-resource.md +++ b/docs/02_cleos/02_how-to-guides/how-to-delegate-CPU-resource.md @@ -13,9 +13,9 @@ Make sure you meet the following requirements: | `cleos` is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install `cleos`. * Ensure the reference system contracts from [`eosio.contracts`](https://github.com/eosnetworkfoundation/mandel-contracts) repository is deployed and used to manage system resources. -* Understand what an [account](https://developers.eos.io/welcome/latest/glossary/index/#account) is and its role in the blockchain. -* Understand [CPU bandwidth](https://developers.eos.io/welcome/latest/glossary/index/#cpu) in an EOSIO blockchain. -* Understand [NET bandwidth](https://developers.eos.io/welcome/latest/glossary/index/#net) in an EOSIO blockchain. +* Understand what an [account](/glossary.md#account) is and its role in the blockchain. +* Understand [CPU bandwidth](/glossary.md#cpu) in an EOSIO blockchain. +* Understand [NET bandwidth](/glossary.md#net) in an EOSIO blockchain. ## Steps diff --git a/docs/02_cleos/02_how-to-guides/how-to-delegate-net-resource.md b/docs/02_cleos/02_how-to-guides/how-to-delegate-net-resource.md index ac26f6e52a..c3bd8d8bd8 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-delegate-net-resource.md +++ b/docs/02_cleos/02_how-to-guides/how-to-delegate-net-resource.md @@ -13,9 +13,9 @@ Make sure you meet the following requirements: | `cleos` is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install `cleos`. * Ensure the reference system contracts from [`eosio.contracts`](https://github.com/eosnetworkfoundation/mandel-contracts) repository is deployed and used to manage system resources. -* Understand what an [account](https://developers.eos.io/welcome/latest/glossary/index/#account) is and its role in the blockchain. -* Understand [NET bandwidth](https://developers.eos.io/welcome/latest/glossary/index/#net) in an EOSIO blockchain. -* Understand [CPU bandwidth](https://developers.eos.io/welcome/latest/glossary/index/#cpu) in an EOSIO blockchain. +* Understand what an [account](/glossary.md#account) is and its role in the blockchain. +* Understand [NET bandwidth](/glossary.md#net) in an EOSIO blockchain. +* Understand [CPU bandwidth](/glossary.md#cpu) in an EOSIO blockchain. ## Steps diff --git a/docs/02_cleos/02_how-to-guides/how-to-get-account-information.md b/docs/02_cleos/02_how-to-guides/how-to-get-account-information.md index 7dc5f686d0..1213c0ac51 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-get-account-information.md +++ b/docs/02_cleos/02_how-to-guides/how-to-get-account-information.md @@ -1,15 +1,15 @@ ## Overview -This how-to guide provides instructions on how to query infomation of an EOSIO account. The example in this how-to guide retrieves information of the `eosio` account. +This how-to guide provides instructions on how to query infomation of an EOSIO account. The example in this how-to guide retrieves information of the `eosio` account. ## Before you begin * Install the currently supported version of `cleos` [[info | Note]] -| The cleos tool is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install the cleos tool. +| The cleos tool is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install the cleos tool. -* Acquire functional understanding of [EOSIO Accounts and Permissions](https://developers.eos.io/welcome/v2.1/protocol/accounts_and_permissions) +* Acquire functional understanding of [EOSIO Accounts and Permissions](/protocol-guides/04_accounts_and_permissions.md) ## Command Reference diff --git a/docs/02_cleos/02_how-to-guides/how-to-get-block-information.md b/docs/02_cleos/02_how-to-guides/how-to-get-block-information.md index 7efd62427f..216413ed1e 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-get-block-information.md +++ b/docs/02_cleos/02_how-to-guides/how-to-get-block-information.md @@ -12,8 +12,8 @@ Make sure to meet the following requirements: [[info | Note]] | `cleos` is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install `cleos`. -* Understand what a [block](https://developers.eos.io/welcome/latest/glossary/index/#block) is and its role in the blockchain. -* Understand the [block lifecycle](https://developers.eos.io/welcome/latest/protocol-guides/consensus_protocol/#5-block-lifecycle) in the EOSIO consensus protocol. +* Understand what a [block](/glossary.md#block) is and its role in the blockchain. +* Understand the [block lifecycle](/protocol-guides/01_consensus_protocol.md#5-block-lifecycle) in the EOSIO consensus protocol. ## Steps @@ -34,8 +34,10 @@ Some examples are provided below: **Example Output** ```sh -cleos -u https://api.testnet.eos.io get block 48351112 +cleos -u https://choiceofyourprovider get block 48351112 ``` +Reference to [testnet providers](/resources/index.md) + ```json { "timestamp": "2021-01-28T17:58:59.500", @@ -59,7 +61,7 @@ cleos -u https://api.testnet.eos.io get block 48351112 **Example Output** ```sh -cleos -u https://api.testnet.eos.io get block 02e1c7888a92206573ae38d00e09366c7ba7bc54cd8b7996506f7d2a619c43ba +cleos -u https://choiceofyourprovider get block 02e1c7888a92206573ae38d00e09366c7ba7bc54cd8b7996506f7d2a619c43ba ``` ```json { diff --git a/docs/02_cleos/02_how-to-guides/how-to-get-transaction-information.md b/docs/02_cleos/02_how-to-guides/how-to-get-transaction-information.md index aaf5fd7e74..717d6b225a 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-get-transaction-information.md +++ b/docs/02_cleos/02_how-to-guides/how-to-get-transaction-information.md @@ -2,7 +2,7 @@ This how-to guide provides instructions on how to retrieve infomation of an EOSIO transaction using a transaction ID. -The example in this how-to retrieves transaction information associated with the creation of the account **bob**. +The example in this how-to retrieves transaction information associated with the creation of the account **bob**. ## Before you begin @@ -10,7 +10,7 @@ Make sure you meet the following requirements: * Install the currently supported version of `cleos`. [[info | Note]] | `cleos` is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install `cleos`. -* Understand how transactions work in an EOSIO blockchain. For more information on transactions, see the [Transactions Protocol](https://developers.eos.io/welcome/latest/protocol-guides/transactions_protocol) section. +* Understand how transactions work in an EOSIO blockchain. For more information on transactions, see the [Transactions Protocol](/protocol-guides/02_transactions_protocol.md) section. ## Command Reference @@ -25,7 +25,7 @@ The following step shows how to retrieve transaction information associated with ```sh cleos get transaction 870a6b6e3882061ff0f64016e1eedfdd9439e2499bf978c3fb29fcedadada9b1 ``` -* Where `870a6b6e38...dada9b1`= The transaction ID associated with the creation of account **bob**. +* Where `870a6b6e38...dada9b1`= The transaction ID associated with the creation of account **bob**. **Example Output** @@ -179,7 +179,7 @@ The `cleos` command returns detailed information of the transaction: ## Summary -By following these instructions, you are able to retrieve transaction information using a transaction ID. +By following these instructions, you are able to retrieve transaction information using a transaction ID. ## Trobleshooting @@ -195,4 +195,4 @@ Error Details: History API plugin is not enabled ``` -To troubleshoot this error, enable the [history plugin](../../01_nodeos/03_plugins/history_plugin/index.md) and [history API plugin](../../01_nodeos/03_plugins/history_api_plugin/index.md), then run the command again. +To troubleshoot this error, enable the [history plugin](../../01_nodeos/03_plugins/history_plugin/index.md) and [history API plugin](../../01_nodeos/03_plugins/history_api_plugin/index.md), then run the command again. diff --git a/docs/02_cleos/02_how-to-guides/how-to-import-a-key.md b/docs/02_cleos/02_how-to-guides/how-to-import-a-key.md index 19a8ee0d7d..d2cf0d0f4c 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-import-a-key.md +++ b/docs/02_cleos/02_how-to-guides/how-to-import-a-key.md @@ -1,18 +1,18 @@ ## Overview -This how-to guide provides instructions on how to import a private key into the `keosd` default wallet. You can use the private key to authorize transactions in an EOSIO blockchain. +This how-to guide provides instructions on how to import a private key into the `keosd` default wallet. You can use the private key to authorize transactions in an EOSIO blockchain. ## Before you Begin Make sure you meet the following requirements: -* Create a default wallet using the `cleos wallet create` command. See the [How to Create a Wallet](../02_how-to-guides/how-to-create-a-wallet.md) section for instructions. +* Create a default wallet using the `cleos wallet create` command. See the [How to Create a Wallet](../02_how-to-guides/how-to-create-a-wallet.md) section for instructions. * Open and unlock the created wallet. * Familiarize with the [`cleos wallet import`](../03_command-reference/wallet/import.md) command. * Install the currently supported version of `cleos`. [[info | Note]] | `cleos` is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install `cleos`. -* Understand what a [public key](https://developers.eos.io/welcome/latest/glossary/index/#public-key) and [private key](https://developers.eos.io/welcome/latest/glossary/index/#private-key) is. +* Understand what a [public key](/glossary.md#public-key) and [private key](/glossary.md#private-key) is. ## Command Reference @@ -31,7 +31,7 @@ cleos wallet import private key: ``` -2. Enter the private key and hit Enter. +2. Enter the private key and hit Enter. ```sh *** ``` @@ -44,4 +44,4 @@ imported private key for: EOS8FBXJUfbANf3xeDWPoJxnip3Ych9HjzLBr1VaXRQFdkVAxwLE7 ## Summary -By following these instructions, you are able to import a private key to the default wallet. +By following these instructions, you are able to import a private key to the default wallet. diff --git a/docs/02_cleos/02_how-to-guides/how-to-list-all-key-pairs.md b/docs/02_cleos/02_how-to-guides/how-to-list-all-key-pairs.md index 7a9bb7348f..2241458075 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-list-all-key-pairs.md +++ b/docs/02_cleos/02_how-to-guides/how-to-list-all-key-pairs.md @@ -1,6 +1,6 @@ ## Overview -This how-to guide provides instructions on how to list all public keys and public/private key pairs within the `keosd` default wallet. You can use the public and private keys to authorize transactions in an EOSIO blockchain. +This how-to guide provides instructions on how to list all public keys and public/private key pairs within the `keosd` default wallet. You can use the public and private keys to authorize transactions in an EOSIO blockchain. The example in this how-to guide displays all public keys and public/private key pairs stored within the existing default wallet. @@ -8,13 +8,13 @@ The example in this how-to guide displays all public keys and public/private key Make sure you meet the following requirements: -* Create a default wallet using the `cleos wallet create` command. See the [How to Create a Wallet](../02_how-to-guides/how-to-create-a-wallet.md) section for instructions. +* Create a default wallet using the `cleos wallet create` command. See the [How to Create a Wallet](../02_how-to-guides/how-to-create-a-wallet.md) section for instructions. * [Create a keypair](../03_command-reference/wallet/create_key.md) within the default wallet. * Familiarize with the [`cleos wallet`](../03_command-reference/wallet/index.md) commands. * Install the currently supported version of `cleos`. [[info | Note]] | `cleos` is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install `cleos`. -* Understand what a [public key](https://developers.eos.io/welcome/latest/glossary/index/#public-key) and [private key](https://developers.eos.io/welcome/latest/glossary/index/#private-key) is. +* Understand what a [public key](/glossary.md#public-key) and [private key](/glossary.md#private-key) is. ## Command Reference @@ -71,7 +71,7 @@ cleos wallet private_keys password: ``` -6. Enter the generated password when you created the default wallet: +6. Enter the generated password when you created the default wallet: ```sh *** ``` @@ -86,7 +86,7 @@ password: [[ ``` [[caution | Warning]] -| Never reveal your private keys in a production environment. +| Never reveal your private keys in a production environment. [[info | Note]] | If the above commands does not list any keys, make sure you have created keypairs and imported private keys to your wallet. diff --git a/docs/02_cleos/03_command-reference/get/account.md b/docs/02_cleos/03_command-reference/get/account.md old mode 100755 new mode 100644 index 8f38ebd6c9..4bc32d82cc --- a/docs/02_cleos/03_command-reference/get/account.md +++ b/docs/02_cleos/03_command-reference/get/account.md @@ -17,10 +17,10 @@ cleos get account eosio ``` ```console privileged: true -permissions: +permissions: owner 1: 1 EOS6MRyAjQq8ud7hVNYcfnVPJqcVpscN5So8BhtHuGYqET5GDW5CV active 1: 1 EOS6MRyAjQq8ud7hVNYcfnVPJqcVpscN5So8BhtHuGYqET5GDW5CV -memory: +memory: quota: -1 bytes used: 1.22 Mb net bandwidth: (averaged over 3 days) @@ -106,4 +106,4 @@ cleos get account eosio --json ``` ## See Also -- [Accounts and Permissions](https://developers.eos.io/welcome/latest/protocol/accounts_and_permissions) protocol document. +- [Accounts and Permissions](/protocol-guides/04_accounts_and_permissions.md) protocol document. diff --git a/docs/02_cleos/03_command-reference/net/peers.md b/docs/02_cleos/03_command-reference/net/peers.md old mode 100755 new mode 100644 index 81b5adc612..359f89f792 --- a/docs/02_cleos/03_command-reference/net/peers.md +++ b/docs/02_cleos/03_command-reference/net/peers.md @@ -111,4 +111,4 @@ cleos -u http://127.0.0.1:8001 net peers ] ``` -**Note:** The `last_handshake` field contains the chain state of each connected peer as of the last handshake message with the node. For more information read the [Handshake Message](https://developers.eos.io/welcome/latest/protocol/network_peer_protocol#421-handshake-message) in the *Network Peer Protocol* document. +**Note:** The `last_handshake` field contains the chain state of each connected peer as of the last handshake message with the node. For more information read the [Handshake Message](/protocol-guides/03_network_peer_protocol.md#421-handshake-message) in the *Network Peer Protocol* document. diff --git a/docs/02_cleos/03_command-reference/net/status.md b/docs/02_cleos/03_command-reference/net/status.md old mode 100755 new mode 100644 index 55b9052a4b..4ed8a84bd0 --- a/docs/02_cleos/03_command-reference/net/status.md +++ b/docs/02_cleos/03_command-reference/net/status.md @@ -67,4 +67,4 @@ cleos -u http://127.0.0.1:8002 net status localhost:9001 } ``` -**Note:** The `last_handshake` field contains the chain state of the specified peer as of the last handshake message with the node. For more information read the [Handshake Message](https://developers.eos.io/welcome/latest/protocol/network_peer_protocol#421-handshake-message) in the *Network Peer Protocol* document. +**Note:** The `last_handshake` field contains the chain state of the specified peer as of the last handshake message with the node. For more information read the [Handshake Message](/protocol-guides/03_network_peer_protocol.md#421-handshake-message) in the *Network Peer Protocol* document. diff --git a/docs/02_cleos/03_command-reference/set/set-account.md b/docs/02_cleos/03_command-reference/set/set-account.md old mode 100755 new mode 100644 index e4ed9f6e32..304db1bb0d --- a/docs/02_cleos/03_command-reference/set/set-account.md +++ b/docs/02_cleos/03_command-reference/set/set-account.md @@ -88,4 +88,4 @@ The authority JSON object ... ``` ## See Also -- [Accounts and Permissions](https://developers.eos.io/welcome/latest/protocol/accounts_and_permissions) protocol document. +- [Accounts and Permissions](/protocol-guides/04_accounts_and_permissions.md) protocol document. diff --git a/docs/02_cleos/03_command-reference/set/set-action.md b/docs/02_cleos/03_command-reference/set/set-action.md old mode 100755 new mode 100644 index cb8199739b..5b050d53b0 --- a/docs/02_cleos/03_command-reference/set/set-action.md +++ b/docs/02_cleos/03_command-reference/set/set-action.md @@ -40,7 +40,7 @@ cleos set action permission `-f,--force-unique` - force the transaction to be unique. this will consume extra bandwidth and remove any protections against accidently issuing the same transaction multiple times -`-s,--skip-sign` Specify if unlocked wallet keys +`-s,--skip-sign` Specify if unlocked wallet keys should be used to sign transaction `-j,--json` print result as json @@ -65,9 +65,9 @@ should be used to sign transaction #Link a `voteproducer` action to the 'voting' permissions cleos set action permission sandwichfarm eosio.system voteproducer voting -p sandwichfarm@voting -#Now can execute the transaction with the previously set permissions. +#Now can execute the transaction with the previously set permissions. cleos system voteproducer approve sandwichfarm someproducer -p sandwichfarm@voting ``` ## See Also -- [Accounts and Permissions](https://developers.eos.io/welcome/latest/protocol/accounts_and_permissions) protocol document. +- [Accounts and Permissions](/protocol-guides/04_accounts_and_permissions.md) protocol document. diff --git a/docs/index.md b/docs/index.md index 76a5441fcd..0e98757754 100644 --- a/docs/index.md +++ b/docs/index.md @@ -16,7 +16,7 @@ Additional EOSIO Resources: * [EOSIO Utilities](10_utilities/index.md) - Utilities that complement the EOSIO software. [//]: # (THIS IS A COMMENT REMOVING BROKEN LINKS) -[//]: #Upgrade-Guide-20_upgrade-guide/index.md-EOSIO-version/protocol-upgrade-guide. +[//]: # (Upgrade-Guide-20_upgrade-guide/index.md-EOSIO-version/protocol-upgrade-guide.) [//]: # (Release Notes 30_release-notes/index.md - All release notes for this EOSIO version.) [[info | What's Next?]] diff --git a/tutorials/bios-boot-tutorial/README.md b/tutorials/bios-boot-tutorial/README.md index 970bcf8df4..c40a326470 100644 --- a/tutorials/bios-boot-tutorial/README.md +++ b/tutorials/bios-boot-tutorial/README.md @@ -47,5 +47,3 @@ $ git clone https://github.com/AntelopeIO/leap $ cd ./leap/tutorials/bios-boot-tutorial/ $ python3 bios-boot-tutorial.py --cleos=cleos --nodeos=nodeos --keosd=keosd --contracts-dir="${CONTRACTS_DIRECTORY}" -w -a ``` - -See [Developer Portal: Bios Boot Sequence](https://developers.eos.io/welcome/latest/tutorials/bios-boot-sequence) for additional information. From de0756acce535e58ef52e77d2be517b92901725a Mon Sep 17 00:00:00 2001 From: Eric Passmore Date: Fri, 5 Aug 2022 13:26:50 -0700 Subject: [PATCH 11/18] small fixes per review comments --- docs/01_nodeos/03_plugins/net_api_plugin/index.md | 2 +- docs/01_nodeos/03_plugins/net_plugin/index.md | 6 +++--- docs/01_nodeos/07_concepts/05_storage-and-read-modes.md | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/01_nodeos/03_plugins/net_api_plugin/index.md b/docs/01_nodeos/03_plugins/net_api_plugin/index.md index bf6bdfbf0d..658e643a0a 100644 --- a/docs/01_nodeos/03_plugins/net_api_plugin/index.md +++ b/docs/01_nodeos/03_plugins/net_api_plugin/index.md @@ -8,7 +8,7 @@ The `net_api_plugin` provides four RPC API endpoints: * connections * status -See [Net API Reference Documentation](http://docs.eosnetwork.com/reference/mandel-plugins/net_api.html). +See [Net API Reference Documentation](https://docs.eosnetwork.com/reference/mandel-plugins/net_api.html). [[caution | Caution]] | This plugin exposes endpoints that allow management of p2p connections. Running this plugin on a publicly accessible node is not recommended as it can be exploited. diff --git a/docs/01_nodeos/03_plugins/net_plugin/index.md b/docs/01_nodeos/03_plugins/net_plugin/index.md index a7762c922c..48bf266325 100644 --- a/docs/01_nodeos/03_plugins/net_plugin/index.md +++ b/docs/01_nodeos/03_plugins/net_plugin/index.md @@ -35,9 +35,9 @@ Config Options for eosio::net_plugin: indicates to node that only transactions 'trx' or blocks 'blk' should be sent. Examples: - p2p.domain.io:9876 - p2p.trx.domaine.io:9876:trx - p2p.blk.domain.io:9876:blk + p2p.example.org:9876 + p2p.trx.example.org:9876:trx + p2p.blk.example.org:9876:blk --p2p-max-nodes-per-host arg (=1) Maximum number of client nodes from any single IP address diff --git a/docs/01_nodeos/07_concepts/05_storage-and-read-modes.md b/docs/01_nodeos/07_concepts/05_storage-and-read-modes.md index 08f1f7ba81..c942a3bcb2 100644 --- a/docs/01_nodeos/07_concepts/05_storage-and-read-modes.md +++ b/docs/01_nodeos/07_concepts/05_storage-and-read-modes.md @@ -17,7 +17,7 @@ Every `nodeos` instance creates some internal files to housekeep the blockchain ## EOSIO Interfaces -EOSIO provides a set of [services](../../) and [interfaces](http://docs.eosnetwork.com/reference/mandel-cdt/files.html) that enable contract developers to persist state across action, and consequently transaction, boundaries. Contracts may use these services and interfaces for various purposes. For example, `eosio.token` contract keeps balances for all users in the chain database. Each instance of `nodeos` keeps the database in memory, so contracts can read and write data with ease. +EOSIO provides a set of [services](../../) and [interfaces](https://docs.eosnetwork.com/reference/mandel-cdt/files.html) that enable contract developers to persist state across action, and consequently transaction, boundaries. Contracts may use these services and interfaces for various purposes. For example, `eosio.token` contract keeps balances for all users in the chain database. Each instance of `nodeos` keeps the database in memory, so contracts can read and write data with ease. ### Nodeos RPC API From cd5a76f49f7d075c4a8fe530afb147078e4f08b6 Mon Sep 17 00:00:00 2001 From: Luis Date: Wed, 21 Sep 2022 13:57:13 -0400 Subject: [PATCH 12/18] replace EOSIO refs with Antelope if applicable :doc --- .../00_build-unsupported-os.md | 2 +- docs/00_install/01_build-from-source/index.md | 2 +- docs/00_install/index.md | 14 +++++++------- .../02_node-setups/00_producing-node.md | 8 ++++---- .../02_node-setups/01_non-producing-node.md | 8 ++++---- .../00_local-single-node-testnet.md | 4 ++-- .../01_local-multi-node-testnet.md | 8 ++++---- .../03_development-environment/index.md | 2 +- .../01_nodeos/03_plugins/chain_plugin/index.md | 2 +- .../01_nodeos/03_plugins/login_plugin/index.md | 2 +- .../03_plugins/producer_plugin/index.md | 4 ++-- ...10_how-to-fast-start-without-old-history.md | 2 +- ...ow-to-replay-or-resync-with-full-history.md | 2 +- ...how-to-create-snapshot-with-full-history.md | 2 +- ...ow-to-restore-snapshot-with-full-history.md | 2 +- .../03_plugins/trace_api_plugin/index.md | 8 ++++---- docs/01_nodeos/06_logging/index.md | 4 ++-- .../07_concepts/05_storage-and-read-modes.md | 6 +++--- .../07_concepts/10_context-free-data/index.md | 2 +- docs/01_nodeos/08_troubleshooting/index.md | 4 ++-- docs/01_nodeos/index.md | 6 +++--- .../02_how-to-guides/how-to-create-a-wallet.md | 2 +- .../how-to-create-an-account.md | 10 +++++----- .../how-to-create-key-pairs.md | 6 +++--- .../how-to-delegate-CPU-resource.md | 6 +++--- .../how-to-delegate-net-resource.md | 6 +++--- .../how-to-deploy-a-smart-contract.md | 2 +- .../how-to-get-account-information.md | 10 +++++----- .../how-to-get-block-information.md | 4 ++-- .../how-to-get-transaction-information.md | 6 +++--- .../02_how-to-guides/how-to-import-a-key.md | 4 ++-- .../how-to-list-all-key-pairs.md | 4 ++-- .../03_command-reference/create/account.md | 2 +- .../03_command-reference/net/connect.md | 2 +- .../03_command-reference/net/disconnect.md | 2 +- .../02_cleos/03_command-reference/net/peers.md | 2 +- .../03_command-reference/net/status.md | 2 +- .../03_command-reference/set/set-account.md | 2 +- docs/02_cleos/04_troubleshooting.md | 2 +- docs/02_cleos/index.md | 6 +++--- docs/03_keosd/index.md | 4 ++-- docs/10_utilities/index.md | 6 +++--- docs/index.md | 18 +++++++++--------- 43 files changed, 101 insertions(+), 101 deletions(-) diff --git a/docs/00_install/01_build-from-source/00_build-unsupported-os.md b/docs/00_install/01_build-from-source/00_build-unsupported-os.md index a9988c0215..e5cffe252d 100644 --- a/docs/00_install/01_build-from-source/00_build-unsupported-os.md +++ b/docs/00_install/01_build-from-source/00_build-unsupported-os.md @@ -1,5 +1,5 @@ --- -content_title: Build EOSIO from Source on Other Unix-based OS +content_title: Build Antelope from Source on Other Unix-based OS --- **Please keep in mind that instructions for building from source on other unsupported operating systems provided here should be considered experimental and provided AS-IS on a best-effort basis and may not be fully featured.** diff --git a/docs/00_install/01_build-from-source/index.md b/docs/00_install/01_build-from-source/index.md index d2a817d01b..7cffd45e4a 100644 --- a/docs/00_install/01_build-from-source/index.md +++ b/docs/00_install/01_build-from-source/index.md @@ -1,5 +1,5 @@ --- -content_title: Build EOSIO from Source +content_title: Build Antelope from Source --- The shell scripts previously recommended for building the software have been removed in favor of a build process entirely driven by CMake. Those wishing to build from source are now responsible for installing the necessary dependencies. The list of dependencies and the recommended build procedure are in the README.md file. Instructions are also included for efficiently running the tests. diff --git a/docs/00_install/index.md b/docs/00_install/index.md index 23a61b3271..1d711083d3 100644 --- a/docs/00_install/index.md +++ b/docs/00_install/index.md @@ -1,26 +1,26 @@ --- -content_title: EOSIO Software Installation +content_title: Antelope Software Installation --- -The best way to install and use the EOSIO software is to build it from source: +The best way to install and use the Antelope software is to build it from source: -* [Build EOSIO from Source](01_build-from-source/index.md) +* [Build Antelope from Source](01_build-from-source/index.md) ## Supported Operating Systems -EOSIO currently supports the following operating systems: +Antelope currently supports the following operating systems: 1. Ubuntu 18.04 2. Ubuntu 20.04 3. Ubuntu 22.04 [[info | Note]] -| It may be possible to build and install EOSIO on other Unix-based operating systems. We gathered helpful information on the following page but please keep in mind that it is experimental and not officially supported. +| It may be possible to build and install Antelope on other Unix-based operating systems. We gathered helpful information on the following page but please keep in mind that it is experimental and not officially supported. -* [Build EOSIO on Other Unix-based Systems](01_build-from-source/00_build-unsupported-os.md) +* [Build Antelope on Other Unix-based Systems](01_build-from-source/00_build-unsupported-os.md) ## Docker Utilities for Node Execution (D.U.N.E.) -If you are using different operating system or prefer not to build EOSIO from source you can try our Docker - based set of utilities called DUNE that can get you started with exploring EOSIO and doing contract development pretty much instantly +If you are using different operating system or prefer not to build Antelope from source you can try our Docker - based set of utilities called DUNE that can get you started with exploring Antelope and doing contract development pretty much instantly * [Docker Utilities for Node Execution (D.U.N.E.)](https://github.com/eosnetworkfoundation/DUNE) diff --git a/docs/01_nodeos/02_usage/02_node-setups/00_producing-node.md b/docs/01_nodeos/02_usage/02_node-setups/00_producing-node.md index 7bb7d2a2ba..edcc593276 100644 --- a/docs/01_nodeos/02_usage/02_node-setups/00_producing-node.md +++ b/docs/01_nodeos/02_usage/02_node-setups/00_producing-node.md @@ -7,15 +7,15 @@ content_title: Producing Node Setup ## Goal -This section describes how to set up a producing node within the EOSIO network. A producing node, as its name implies, is a node that is configured to produce blocks in an `EOSIO` based blockchain. This functionality if provided through the `producer_plugin` as well as other [Nodeos Plugins](../../03_plugins/index.md). +This section describes how to set up a producing node within the Antelope network. A producing node, as its name implies, is a node that is configured to produce blocks in an `Antelope` based blockchain. This functionality if provided through the `producer_plugin` as well as other [Nodeos Plugins](../../03_plugins/index.md). ## Before you begin -* [Install the EOSIO software](../../../00_install/index.md) before starting this section. +* [Install the Antelope software](../../../00_install/index.md) before starting this section. * It is assumed that `nodeos`, `cleos`, and `keosd` are accessible through the path. [//]: # ( THIS IS A COMMENT LINK BELOW IS BROKEN ) -[//]: # ( If you built EOSIO using shell scripts, make sure to run the Install Script ../../../00_install/01_build-from-source/01_shell-scripts/03_install-eosio-binaries.md ) +[//]: # ( If you built Antelope using shell scripts, make sure to run the Install Script ../../../00_install/01_build-from-source/01_shell-scripts/03_install-eosio-binaries.md ) * Know how to pass [Nodeos options](../../02_usage/00_nodeos-options.md) to enable or disable functionality. @@ -53,7 +53,7 @@ producer-name = youraccount You will need to set the private key for your producer. The public key should have an authority for the producer account defined above. `signature-provider` is defined with a 3-field tuple: -* `public-key` - A valid EOSIO public key in form of a string. +* `public-key` - A valid Antelope public key in form of a string. * `provider-spec` - It's a string formatted like `:` * `provider-type` - KEY or KEOSD diff --git a/docs/01_nodeos/02_usage/02_node-setups/01_non-producing-node.md b/docs/01_nodeos/02_usage/02_node-setups/01_non-producing-node.md index b85a014c34..b0e5c9cc31 100644 --- a/docs/01_nodeos/02_usage/02_node-setups/01_non-producing-node.md +++ b/docs/01_nodeos/02_usage/02_node-setups/01_non-producing-node.md @@ -4,15 +4,15 @@ content_title: Non-producing Node Setup ## Goal -This section describes how to set up a non-producing node within the EOSIO network. A non-producing node is a node that is not configured to produce blocks, instead it is connected and synchronized with other peers from an `EOSIO` based blockchain, exposing one or more services publicly or privately by enabling one or more [Nodeos Plugins](../../03_plugins/index.md), except the `producer_plugin`. +This section describes how to set up a non-producing node within the Antelope network. A non-producing node is a node that is not configured to produce blocks, instead it is connected and synchronized with other peers from an `Antelope` based blockchain, exposing one or more services publicly or privately by enabling one or more [Nodeos Plugins](../../03_plugins/index.md), except the `producer_plugin`. ## Before you begin -* [Install the EOSIO software](../../../00_install/index.md) before starting this section. +* [Install the Antelope software](../../../00_install/index.md) before starting this section. * It is assumed that `nodeos`, `cleos`, and `keosd` are accessible through the path. [//]: # ( THIS IS A COMMENT NEXT LINK CONTAINS A BROKEN LINK ) -[//]: # ( If you built EOSIO using shell scripts, make sure to run the Install Script ../../../00_install/01_build-from-source/01_shell-scripts/03_install-eosio-binaries.md ) +[//]: # ( If you built Antelope using shell scripts, make sure to run the Install Script ../../../00_install/01_build-from-source/01_shell-scripts/03_install-eosio-binaries.md ) * Know how to pass [Nodeos options](../../02_usage/00_nodeos-options.md) to enable or disable functionality. @@ -41,4 +41,4 @@ nodeos ... --p2p-peer-address=106.10.42.238:9876 ### 2. Enable one or more available plugins -Each available plugin is listed and detailed in the [Nodeos Plugins](../../03_plugins/index.md) section. When `nodeos` starts, it will expose the functionality provided by the enabled plugins it was started with. For example, if you start `nodeos` with [`state_history_plugin`](../../03_plugins/state_history_plugin/index.md) enabled, you will have a non-producing node that offers full blockchain history. If you start `nodeos` with [`http_plugin`](../../03_plugins/http_plugin/index.md) enabled, you will have a non-producing node which exposes the EOSIO RPC API. Therefore, you can extend the basic functionality provided by a non-producing node by enabling any number of existing plugins on top of it. Another aspect to consider is that some plugins have dependencies to other plugins. Therefore, you need to satisfy all dependencies for a plugin in order to enable it. +Each available plugin is listed and detailed in the [Nodeos Plugins](../../03_plugins/index.md) section. When `nodeos` starts, it will expose the functionality provided by the enabled plugins it was started with. For example, if you start `nodeos` with [`state_history_plugin`](../../03_plugins/state_history_plugin/index.md) enabled, you will have a non-producing node that offers full blockchain history. If you start `nodeos` with [`http_plugin`](../../03_plugins/http_plugin/index.md) enabled, you will have a non-producing node which exposes the Antelope RPC API. Therefore, you can extend the basic functionality provided by a non-producing node by enabling any number of existing plugins on top of it. Another aspect to consider is that some plugins have dependencies to other plugins. Therefore, you need to satisfy all dependencies for a plugin in order to enable it. diff --git a/docs/01_nodeos/02_usage/03_development-environment/00_local-single-node-testnet.md b/docs/01_nodeos/02_usage/03_development-environment/00_local-single-node-testnet.md index 4b0f8d1b56..a55d817774 100644 --- a/docs/01_nodeos/02_usage/03_development-environment/00_local-single-node-testnet.md +++ b/docs/01_nodeos/02_usage/03_development-environment/00_local-single-node-testnet.md @@ -12,11 +12,11 @@ This section describes how to set up a single-node blockchain configuration runn ## Before you begin -* [Install the EOSIO software](../../../00_install/index.md) before starting this section. +* [Install the Antelope software](../../../00_install/index.md) before starting this section. * It is assumed that `nodeos`, `cleos`, and `keosd` are accessible through the path. [//]: # (THIS IS A COMMENT, NEXT LINK HAS BROKEN LINK) -[//]: # (If you built EOSIO using shell scripts, make sure to run the Install Script ../../../00_install/01_build-from-source/01_shell-scripts/03_install-eosio-binaries.md .) +[//]: # (If you built Antelope using shell scripts, make sure to run the Install Script ../../../00_install/01_build-from-source/01_shell-scripts/03_install-eosio-binaries.md .) * Know how to pass [Nodeos options](../../02_usage/00_nodeos-options.md) to enable or disable functionality. diff --git a/docs/01_nodeos/02_usage/03_development-environment/01_local-multi-node-testnet.md b/docs/01_nodeos/02_usage/03_development-environment/01_local-multi-node-testnet.md index 698f0414de..52a7c8dfb8 100644 --- a/docs/01_nodeos/02_usage/03_development-environment/01_local-multi-node-testnet.md +++ b/docs/01_nodeos/02_usage/03_development-environment/01_local-multi-node-testnet.md @@ -10,7 +10,7 @@ This section describes how to set up a multi-node blockchain configuration runni ## Before you begin -* [Install the EOSIO software](../../../00_install/index.md) before starting this section. +* [Install the Antelope software](../../../00_install/index.md) before starting this section. * It is assumed that `nodeos`, `cleos`, and `keosd` are accessible through the path. * Know how to pass [Nodeos options](../../02_usage/00_nodeos-options.md) to enable or disable functionality. @@ -20,7 +20,7 @@ Open four "terminal" windows and perform the following steps: 1. [Start the Wallet Manager](#1-start-the-wallet-manager) 2. [Create a Default Wallet](#2-create-a-default-wallet) -3. [Loading the EOSIO Key](#3-loading-the-eosio-key) +3. [Loading the Antelope Key](#3-loading-the-eosio-key) 4. [Start the First Producer Node](#4-start-the-first-producer-node) 5. [Start the Second Producer Node](#5-start-the-second-producer-node) 6. [Get Nodes Info](#6-get-nodes-info) @@ -66,7 +66,7 @@ Without password imported keys will not be retrievable. `keosd` will generate some status output in its window. We will continue to use this second window for subsequent `cleos` commands. -### 3. Loading the EOSIO Key +### 3. Loading the Antelope Key The private blockchain launched in the steps above is created with a default initial key which must be loaded into the wallet. @@ -90,7 +90,7 @@ This creates a special producer, known as the "bios" producer. Assuming everythi ### 5. Start the Second Producer Node -The following commands assume that you are running this tutorial from the `eos\build` directory, from which you ran `./eosio_build.sh` to build the EOSIO binaries. +The following commands assume that you are running this tutorial from the `eos\build` directory, from which you ran `./eosio_build.sh` to build the Antelope binaries. To start additional nodes, you must first load the `eosio.bios` contract. This contract enables you to have direct control over the resource allocation of other accounts and to access other privileged API calls. Return to the second terminal window and run the following command to load the contract: diff --git a/docs/01_nodeos/02_usage/03_development-environment/index.md b/docs/01_nodeos/02_usage/03_development-environment/index.md index 9305397d45..4ed1302c63 100644 --- a/docs/01_nodeos/02_usage/03_development-environment/index.md +++ b/docs/01_nodeos/02_usage/03_development-environment/index.md @@ -23,7 +23,7 @@ Try [Docker Utilities for Node Execution](https://github.com/eosnetworkfoundatio ## Third-Party Testnets -The following third-party testnets are available for testing EOSIO dApps and smart contracts: +The following third-party testnets are available for testing Antelope dApps and smart contracts: * Jungle Testnet [monitor](https://monitor.jungletestnet.io/), [website](https://jungletestnet.io/) * [CryptoKylin Testnet](https://www.cryptokylin.io/) diff --git a/docs/01_nodeos/03_plugins/chain_plugin/index.md b/docs/01_nodeos/03_plugins/chain_plugin/index.md index 9da5921080..1d284edffa 100644 --- a/docs/01_nodeos/03_plugins/chain_plugin/index.md +++ b/docs/01_nodeos/03_plugins/chain_plugin/index.md @@ -1,6 +1,6 @@ ## Description -The `chain_plugin` is a core plugin required to process and aggregate chain data on an EOSIO node. +The `chain_plugin` is a core plugin required to process and aggregate chain data on an Antelope node. ## Usage diff --git a/docs/01_nodeos/03_plugins/login_plugin/index.md b/docs/01_nodeos/03_plugins/login_plugin/index.md index 68df9d4c1e..09ebf2be74 100644 --- a/docs/01_nodeos/03_plugins/login_plugin/index.md +++ b/docs/01_nodeos/03_plugins/login_plugin/index.md @@ -1,6 +1,6 @@ ## Description -The `login_plugin` supports the concept of applications authenticating with the EOSIO blockchain. The `login_plugin` API allows an application to verify whether an account is allowed to sign in order to satisfy a specified authority. +The `login_plugin` supports the concept of applications authenticating with the Antelope blockchain. The `login_plugin` API allows an application to verify whether an account is allowed to sign in order to satisfy a specified authority. ## Usage diff --git a/docs/01_nodeos/03_plugins/producer_plugin/index.md b/docs/01_nodeos/03_plugins/producer_plugin/index.md index 66e1b0077f..6fce1fd71f 100644 --- a/docs/01_nodeos/03_plugins/producer_plugin/index.md +++ b/docs/01_nodeos/03_plugins/producer_plugin/index.md @@ -49,7 +49,7 @@ Config Options for eosio::producer_plugin: = Where: is a string form of - a vaild EOSIO public + a vaild Antelope public key is a string in the @@ -59,7 +59,7 @@ Config Options for eosio::producer_plugin: is KEY, or KEOSD KEY: is a string form of - a valid EOSIO + a valid Antelope private key which maps to the provided public key diff --git a/docs/01_nodeos/03_plugins/state_history_plugin/10_how-to-fast-start-without-old-history.md b/docs/01_nodeos/03_plugins/state_history_plugin/10_how-to-fast-start-without-old-history.md index 962b9e711c..43c9536410 100644 --- a/docs/01_nodeos/03_plugins/state_history_plugin/10_how-to-fast-start-without-old-history.md +++ b/docs/01_nodeos/03_plugins/state_history_plugin/10_how-to-fast-start-without-old-history.md @@ -8,7 +8,7 @@ This procedure records the current chain state and future history, without previ ## Before you begin -* Make sure [EOSIO is installed](../../../00_install/index.md). +* Make sure [Antelope is installed](../../../00_install/index.md). * Learn about [Using Nodeos](../../02_usage/index.md). * Get familiar with [state_history_plugin](../../03_plugins/state_history_plugin/index.md). diff --git a/docs/01_nodeos/03_plugins/state_history_plugin/20_how-to-replay-or-resync-with-full-history.md b/docs/01_nodeos/03_plugins/state_history_plugin/20_how-to-replay-or-resync-with-full-history.md index 9f0a7308f0..8b29bf6919 100644 --- a/docs/01_nodeos/03_plugins/state_history_plugin/20_how-to-replay-or-resync-with-full-history.md +++ b/docs/01_nodeos/03_plugins/state_history_plugin/20_how-to-replay-or-resync-with-full-history.md @@ -8,7 +8,7 @@ This procedure records the entire chain history. ## Before you begin -* Make sure [EOSIO is installed](../../../00_install/index.md). +* Make sure [Antelope is installed](../../../00_install/index.md). * Learn about [Using Nodeos](../../02_usage/index.md). * Get familiar with [state_history_plugin](../../03_plugins/state_history_plugin/index.md). diff --git a/docs/01_nodeos/03_plugins/state_history_plugin/30_how-to-create-snapshot-with-full-history.md b/docs/01_nodeos/03_plugins/state_history_plugin/30_how-to-create-snapshot-with-full-history.md index 19d69e9c28..a81bfe15f5 100644 --- a/docs/01_nodeos/03_plugins/state_history_plugin/30_how-to-create-snapshot-with-full-history.md +++ b/docs/01_nodeos/03_plugins/state_history_plugin/30_how-to-create-snapshot-with-full-history.md @@ -8,7 +8,7 @@ This procedure creates a database containing the chain state, with full history ## Before you begin -* Make sure [EOSIO is installed](../../../00_install/index.md). +* Make sure [Antelope is installed](../../../00_install/index.md). * Learn about [Using Nodeos](../../02_usage/index.md). * Get familiar with [state_history_plugin](../../03_plugins/state_history_plugin/index.md). diff --git a/docs/01_nodeos/03_plugins/state_history_plugin/40_how-to-restore-snapshot-with-full-history.md b/docs/01_nodeos/03_plugins/state_history_plugin/40_how-to-restore-snapshot-with-full-history.md index 52e3b27e5e..364b2f91f7 100644 --- a/docs/01_nodeos/03_plugins/state_history_plugin/40_how-to-restore-snapshot-with-full-history.md +++ b/docs/01_nodeos/03_plugins/state_history_plugin/40_how-to-restore-snapshot-with-full-history.md @@ -8,7 +8,7 @@ This procedure restores an existing snapshot with full history, so the node can ## Before you begin -* Make sure [EOSIO is installed](../../../00_install/index.md). +* Make sure [Antelope is installed](../../../00_install/index.md). * Learn about [Using Nodeos](../../02_usage/index.md). * Get familiar with [state_history_plugin](../../03_plugins/state_history_plugin/index.md). diff --git a/docs/01_nodeos/03_plugins/trace_api_plugin/index.md b/docs/01_nodeos/03_plugins/trace_api_plugin/index.md index 74d1215ec0..b9822780fd 100644 --- a/docs/01_nodeos/03_plugins/trace_api_plugin/index.md +++ b/docs/01_nodeos/03_plugins/trace_api_plugin/index.md @@ -5,11 +5,11 @@ The `trace_api_plugin` provides a consumer-focused long-term API for retrieving ## Purpose -While integrating applications such as block explorers and exchanges with an EOSIO blockchain, the user might require a complete transcript of actions processed by the blockchain, including those spawned from the execution of smart contracts and scheduled transactions. The `trace_api_plugin` serves this need. The purpose of the plugin is to provide: +While integrating applications such as block explorers and exchanges with an Antelope blockchain, the user might require a complete transcript of actions processed by the blockchain, including those spawned from the execution of smart contracts and scheduled transactions. The `trace_api_plugin` serves this need. The purpose of the plugin is to provide: * A transcript of retired actions and related metadata * A consumer-focused long-term API to retrieve blocks -* Maintainable resource commitments at the EOSIO nodes +* Maintainable resource commitments at the Antelope nodes Therefore, one crucial goal of the `trace_api_plugin` is to improve the maintenance of node resources (file system, disk space, memory used, etc.). This goal is different from the existing `history_plugin` which provides far more configurable filtering and querying capabilities, or the existing `state_history_plugin` which provides a binary streaming interface to access structural chain data, action data, as well as state deltas. @@ -101,7 +101,7 @@ nodeos ... --plugin eosio::chain_plugin [options] \ ## Configuration Example -Here is a `nodeos` configuration example for the `trace_api_plugin` when tracing some EOSIO reference contracts: +Here is a `nodeos` configuration example for the `trace_api_plugin` when tracing some Antelope reference contracts: ```sh nodeos --data-dir data_dir --config-dir config_dir --trace-dir traces_dir @@ -191,7 +191,7 @@ If resource usage cannot be effectively managed via the `trace-minimum-irreversi ## Manual Maintenance -The `trace-dir` option defines the directory on the filesystem where the trace log files are stored by the `trace_api_plugin`. These files are stable once the LIB block has progressed past a given slice and then can be deleted at any time to reclaim filesystem space. The deployed EOSIO system will tolerate any out-of-process management system that removes some or all of these files in this directory regardless of what data they represent, or whether there is a running `nodeos` instance accessing them or not. Data which would nominally be available, but is no longer so due to manual maintenance, will result in a HTTP 404 response from the appropriate API endpoint(s). +The `trace-dir` option defines the directory on the filesystem where the trace log files are stored by the `trace_api_plugin`. These files are stable once the LIB block has progressed past a given slice and then can be deleted at any time to reclaim filesystem space. The deployed Antelope system will tolerate any out-of-process management system that removes some or all of these files in this directory regardless of what data they represent, or whether there is a running `nodeos` instance accessing them or not. Data which would nominally be available, but is no longer so due to manual maintenance, will result in a HTTP 404 response from the appropriate API endpoint(s). [[info | For node operators]] | Node operators can take full control over the lifetime of the historical data available in their nodes via the `trace-api-plugin` and the `trace-minimum-irreversible-history-blocks` and `trace-minimum-uncompressed-irreversible-history-blocks` options in conjunction with any external filesystem resource manager. diff --git a/docs/01_nodeos/06_logging/index.md b/docs/01_nodeos/06_logging/index.md index 8a7670e7fb..910db0928a 100644 --- a/docs/01_nodeos/06_logging/index.md +++ b/docs/01_nodeos/06_logging/index.md @@ -6,7 +6,7 @@ Logging for `nodeos` is controlled by the `logging.json` file. CLI options can b ## Appenders -The logging library built into EOSIO supports two appender types: +The logging library built into Antelope supports two appender types: - [Console](#console) - [GELF](#gelf) (Graylog Extended Log Format) @@ -74,7 +74,7 @@ Example: ## Loggers -The logging library built into EOSIO currently supports the following loggers: +The logging library built into Antelope currently supports the following loggers: - `default` - the default logger, always enabled. - `net_plugin_impl` - detailed logging for the net plugin. diff --git a/docs/01_nodeos/07_concepts/05_storage-and-read-modes.md b/docs/01_nodeos/07_concepts/05_storage-and-read-modes.md index c942a3bcb2..0965fdf298 100644 --- a/docs/01_nodeos/07_concepts/05_storage-and-read-modes.md +++ b/docs/01_nodeos/07_concepts/05_storage-and-read-modes.md @@ -2,7 +2,7 @@ content_title: Storage and Read Modes --- -The EOSIO platform stores blockchain information in various data structures at various stages of a transaction's lifecycle. Some of these are described below. The producing node is the `nodeos` instance run by the block producer who is currently creating blocks for the blockchain (which changes every 6 seconds, producing 12 blocks in sequence before switching to another producer.) +The Antelope platform stores blockchain information in various data structures at various stages of a transaction's lifecycle. Some of these are described below. The producing node is the `nodeos` instance run by the block producer who is currently creating blocks for the blockchain (which changes every 6 seconds, producing 12 blocks in sequence before switching to another producer.) ## Blockchain State and Storage @@ -15,9 +15,9 @@ Every `nodeos` instance creates some internal files to housekeep the blockchain * The `pending block` is an in memory block containing transactions as they are processed and pushed into the block; this will/may eventually become the head block. If the `nodeos` instance is the producing node, the pending block is distributed to other `nodeos` instances. * Outside the chain state, block data is cached in RAM until it becomes final/irreversible; especifically the signed block itself. After the last irreversible block (LIB) catches up to the block, that block is then retrieved from the irreversible blocks log. -## EOSIO Interfaces +## Antelope Interfaces -EOSIO provides a set of [services](../../) and [interfaces](https://docs.eosnetwork.com/reference/mandel-cdt/files.html) that enable contract developers to persist state across action, and consequently transaction, boundaries. Contracts may use these services and interfaces for various purposes. For example, `eosio.token` contract keeps balances for all users in the chain database. Each instance of `nodeos` keeps the database in memory, so contracts can read and write data with ease. +Antelope provides a set of [services](../../) and [interfaces](https://docs.eosnetwork.com/reference/mandel-cdt/files.html) that enable contract developers to persist state across action, and consequently transaction, boundaries. Contracts may use these services and interfaces for various purposes. For example, `eosio.token` contract keeps balances for all users in the chain database. Each instance of `nodeos` keeps the database in memory, so contracts can read and write data with ease. ### Nodeos RPC API diff --git a/docs/01_nodeos/07_concepts/10_context-free-data/index.md b/docs/01_nodeos/07_concepts/10_context-free-data/index.md index 0a31072bcb..5ee2aeebba 100644 --- a/docs/01_nodeos/07_concepts/10_context-free-data/index.md +++ b/docs/01_nodeos/07_concepts/10_context-free-data/index.md @@ -4,7 +4,7 @@ link_text: Context-Free Data --- ## Overview -The immutable nature of the blockchain allows data to be stored securely while also enforcing the integrity of such data. However, this benefit also complicates the removal of non-essential data from the blockchain. Consequently, EOSIO blockchains contain a special section within the transaction, called the *context-free data*. As its name implies, data stored in the context-free data section is considered free of previous contexts or dependencies, which makes their potential removal possible. More importantly, such removal can be performed safely without compromising the integrity of the blockchain. +The immutable nature of the blockchain allows data to be stored securely while also enforcing the integrity of such data. However, this benefit also complicates the removal of non-essential data from the blockchain. Consequently, Antelope blockchains contain a special section within the transaction, called the *context-free data*. As its name implies, data stored in the context-free data section is considered free of previous contexts or dependencies, which makes their potential removal possible. More importantly, such removal can be performed safely without compromising the integrity of the blockchain. ## Concept The goal of context-free data is to allow blockchain applications the option to store non-essential information within a transaction. Some examples of context-free data include: diff --git a/docs/01_nodeos/08_troubleshooting/index.md b/docs/01_nodeos/08_troubleshooting/index.md index 7aa22031d8..2d813a018b 100644 --- a/docs/01_nodeos/08_troubleshooting/index.md +++ b/docs/01_nodeos/08_troubleshooting/index.md @@ -28,7 +28,7 @@ Command Line Options for eosio::chain_plugin: Start `nodeos` with `--shared-memory-size-mb 1024`. A 1 GB shared memory file allows approximately half a million transactions. -### What version of EOSIO am I running/connecting to? +### What version of Antelope am I running/connecting to? If defaults can be used, then `cleos get info` will output a block that contains a field called `server_version`. If your `nodeos` is not using the defaults, then you need to know the URL of the `nodeos`. In that case, use the following with your `nodeos` URL: @@ -44,4 +44,4 @@ cleos --url http://localhost:8888 get info | grep server_version ### Error 3070000: WASM Exception Error -If you try to deploy the `eosio.bios` contract or `eosio.system` contract in an attempt to boot an EOSIO-based blockchain and you get the following error or similar: `Publishing contract... Error 3070000: WASM Exception Error Details: env.set_proposed_producers_ex unresolveable`, it is because you have to activate the `PREACTIVATE_FEATURE` protocol first. +If you try to deploy the `eosio.bios` contract or `eosio.system` contract in an attempt to boot an Antelope-based blockchain and you get the following error or similar: `Publishing contract... Error 3070000: WASM Exception Error Details: env.set_proposed_producers_ex unresolveable`, it is because you have to activate the `PREACTIVATE_FEATURE` protocol first. diff --git a/docs/01_nodeos/index.md b/docs/01_nodeos/index.md index 9877dc16a9..c31e5f3a82 100644 --- a/docs/01_nodeos/index.md +++ b/docs/01_nodeos/index.md @@ -4,11 +4,11 @@ content_title: Nodeos ## Introduction -`nodeos` is the core service daemon that runs on every EOSIO node. It can be configured to process smart contracts, validate transactions, produce blocks containing valid transactions, and confirm blocks to record them on the blockchain. +`nodeos` is the core service daemon that runs on every Antelope node. It can be configured to process smart contracts, validate transactions, produce blocks containing valid transactions, and confirm blocks to record them on the blockchain. ## Installation -`nodeos` is distributed as part of the [EOSIO software suite](https://github.com/eosnetworkfoundation/mandel). To install `nodeos`, visit the [EOSIO Software Installation](../00_install/index.md) section. +`nodeos` is distributed as part of the [Antelope software suite](https://github.com/eosnetworkfoundation/mandel). To install `nodeos`, visit the [Antelope Software Installation](../00_install/index.md) section. ## Explore @@ -23,4 +23,4 @@ Navigate the sections below to configure and use `nodeos`. * [Troubleshooting](08_troubleshooting/index.md) - Common `nodeos` troubleshooting questions. [[info | Access Node]] -| A local or remote EOSIO access node running `nodeos` is required for a client application or smart contract to interact with the blockchain. +| A local or remote Antelope access node running `nodeos` is required for a client application or smart contract to interact with the blockchain. diff --git a/docs/02_cleos/02_how-to-guides/how-to-create-a-wallet.md b/docs/02_cleos/02_how-to-guides/how-to-create-a-wallet.md index 06e3ff199b..a69e76c768 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-create-a-wallet.md +++ b/docs/02_cleos/02_how-to-guides/how-to-create-a-wallet.md @@ -11,7 +11,7 @@ Make sure you meet the following requirements: * Install the currently supported version of `cleos`. [[info | Note]] -| `cleos` is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install `cleos`. +| `cleos` is bundled with the Antelope software. [Installing Antelope](../../00_install/index.md) will also install `cleos`. * Understand what an [account](/glossary.md#account) is and its role in the blockchain. * Understand [Accounts and Permissions](/protocol-guides/04_accounts_and_permissions.md) in the protocol documents. diff --git a/docs/02_cleos/02_how-to-guides/how-to-create-an-account.md b/docs/02_cleos/02_how-to-guides/how-to-create-an-account.md index 1fd79840ff..69030e4477 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-create-an-account.md +++ b/docs/02_cleos/02_how-to-guides/how-to-create-an-account.md @@ -1,6 +1,6 @@ ## Overview -This how-to guide provides instructions on how to create a new EOSIO blockchain account using the `cleos` CLI tool. You can use accounts to deploy smart contracts and perform other related blockchain operations. Create one or multiple accounts as part of your development environment setup. +This how-to guide provides instructions on how to create a new Antelope blockchain account using the `cleos` CLI tool. You can use accounts to deploy smart contracts and perform other related blockchain operations. Create one or multiple accounts as part of your development environment setup. The example in this how-to guide creates a new account named **bob**, authorized by the default system account **eosio**, using the `cleos` CLI tool. @@ -10,8 +10,8 @@ Make sure you meet the following requirements: * Install the currently supported version of `cleos`. [[info | Note]] -| The cleos tool is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install the cleos tool. -* Learn about [EOSIO Accounts and Permissions](/protocol-guides/04_accounts_and_permissions.md) +| The cleos tool is bundled with the Antelope software. [Installing Antelope](../../00_install/index.md) will also install the cleos tool. +* Learn about [Antelope Accounts and Permissions](/protocol-guides/04_accounts_and_permissions.md) * Learn about Asymmetric Cryptography - [public key](/glossary.md#public-key) and [private key](/glossary.md#private-key) pairs. * Create public/private keypairs for the `owner` and `active` permissions of an account. @@ -34,7 +34,7 @@ cleos create account eosio bob EOS87TQktA5RVse2EguhztfQVEh6XXxBmgkU8b4Y5YnGvtYAo * `bob` = the name of the new account conforming to [account naming conventions](/protocol-guides/04_accounts_and_permissions.md#2-accounts) * `EOS87TQ...AoLGNN` = the owner public key or permission level for the new account (**required**) [[info | Note]] -| To create a new account in the EOSIO blockchain, an existing account, also referred to as a creator account, is required to authorize the creation of a new account. For a newly created EOSIO blockchain, the default system account used to create a new account is **eosio**. +| To create a new account in the Antelope blockchain, an existing account, also referred to as a creator account, is required to authorize the creation of a new account. For a newly created Antelope blockchain, the default system account used to create a new account is **eosio**. **Example Output** @@ -46,4 +46,4 @@ warning: transaction executed locally, but may not be confirmed by the network y ### Summary -By following these instructions, you are able to create a new EOSIO account in your blockchain environment. +By following these instructions, you are able to create a new Antelope account in your blockchain environment. diff --git a/docs/02_cleos/02_how-to-guides/how-to-create-key-pairs.md b/docs/02_cleos/02_how-to-guides/how-to-create-key-pairs.md index e3e298aefe..16615039c5 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-create-key-pairs.md +++ b/docs/02_cleos/02_how-to-guides/how-to-create-key-pairs.md @@ -1,14 +1,14 @@ ## Overview -This how-to guide provides instructions on how to create a keypair consisting of a public key and a private key for signing transactions in an EOSIO blockchain. +This how-to guide provides instructions on how to create a keypair consisting of a public key and a private key for signing transactions in an Antelope blockchain. ## Before you begin Make sure you meet the following requirements: * Install the currently supported version of `cleos` [[info | Note]] -| The cleos tool is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install the cleos tool. -* Learn about asymmetric cryptography (public and private keypair) in the context of an EOSIO blockchain. +| The cleos tool is bundled with the Antelope software. [Installing Antelope](../../00_install/index.md) will also install the cleos tool. +* Learn about asymmetric cryptography (public and private keypair) in the context of an Antelope blockchain. ## Command Reference diff --git a/docs/02_cleos/02_how-to-guides/how-to-delegate-CPU-resource.md b/docs/02_cleos/02_how-to-guides/how-to-delegate-CPU-resource.md index 00d977278a..65003d0e2e 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-delegate-CPU-resource.md +++ b/docs/02_cleos/02_how-to-guides/how-to-delegate-CPU-resource.md @@ -10,12 +10,12 @@ Make sure you meet the following requirements: * Install the currently supported version of `cleos`. [[info | Note]] -| `cleos` is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install `cleos`. +| `cleos` is bundled with the Antelope software. [Installing Antelope](../../00_install/index.md) will also install `cleos`. * Ensure the reference system contracts from [`eosio.contracts`](https://github.com/eosnetworkfoundation/mandel-contracts) repository is deployed and used to manage system resources. * Understand what an [account](/glossary.md#account) is and its role in the blockchain. -* Understand [CPU bandwidth](/glossary.md#cpu) in an EOSIO blockchain. -* Understand [NET bandwidth](/glossary.md#net) in an EOSIO blockchain. +* Understand [CPU bandwidth](/glossary.md#cpu) in an Antelope blockchain. +* Understand [NET bandwidth](/glossary.md#net) in an Antelope blockchain. ## Steps diff --git a/docs/02_cleos/02_how-to-guides/how-to-delegate-net-resource.md b/docs/02_cleos/02_how-to-guides/how-to-delegate-net-resource.md index c3bd8d8bd8..6db305abdb 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-delegate-net-resource.md +++ b/docs/02_cleos/02_how-to-guides/how-to-delegate-net-resource.md @@ -10,12 +10,12 @@ Make sure you meet the following requirements: * Install the currently supported version of `cleos`. [[info | Note]] -| `cleos` is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install `cleos`. +| `cleos` is bundled with the Antelope software. [Installing Antelope](../../00_install/index.md) will also install `cleos`. * Ensure the reference system contracts from [`eosio.contracts`](https://github.com/eosnetworkfoundation/mandel-contracts) repository is deployed and used to manage system resources. * Understand what an [account](/glossary.md#account) is and its role in the blockchain. -* Understand [NET bandwidth](/glossary.md#net) in an EOSIO blockchain. -* Understand [CPU bandwidth](/glossary.md#cpu) in an EOSIO blockchain. +* Understand [NET bandwidth](/glossary.md#net) in an Antelope blockchain. +* Understand [CPU bandwidth](/glossary.md#cpu) in an Antelope blockchain. ## Steps diff --git a/docs/02_cleos/02_how-to-guides/how-to-deploy-a-smart-contract.md b/docs/02_cleos/02_how-to-guides/how-to-deploy-a-smart-contract.md index 32fcce2c00..c7f0bfb18d 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-deploy-a-smart-contract.md +++ b/docs/02_cleos/02_how-to-guides/how-to-deploy-a-smart-contract.md @@ -1,6 +1,6 @@ ## Goal -Deploy an EOSIO contract +Deploy an Antelope contract ## Before you begin diff --git a/docs/02_cleos/02_how-to-guides/how-to-get-account-information.md b/docs/02_cleos/02_how-to-guides/how-to-get-account-information.md index 1213c0ac51..79d320a8aa 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-get-account-information.md +++ b/docs/02_cleos/02_how-to-guides/how-to-get-account-information.md @@ -1,15 +1,15 @@ ## Overview -This how-to guide provides instructions on how to query infomation of an EOSIO account. The example in this how-to guide retrieves information of the `eosio` account. +This how-to guide provides instructions on how to query infomation of an Antelope account. The example in this how-to guide retrieves information of the `eosio` account. ## Before you begin * Install the currently supported version of `cleos` [[info | Note]] -| The cleos tool is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install the cleos tool. +| The cleos tool is bundled with the Antelope software. [Installing Antelope](../../00_install/index.md) will also install the cleos tool. -* Acquire functional understanding of [EOSIO Accounts and Permissions](/protocol-guides/04_accounts_and_permissions.md) +* Acquire functional understanding of [Antelope Accounts and Permissions](/protocol-guides/04_accounts_and_permissions.md) ## Command Reference @@ -28,7 +28,7 @@ cleos get account eosio ``` **Where**: -* `eosio` = The name of the default system account in the EOSIO blockchain. +* `eosio` = The name of the default system account in the Antelope blockchain. **Example Output** @@ -53,4 +53,4 @@ cpu bandwidth: ``` [[info | Account Fields]] -| Depending on the EOSIO network you are connected, you might see different fields associated with an account. That depends on which system contract has been deployed on the network. +| Depending on the Antelope network you are connected, you might see different fields associated with an account. That depends on which system contract has been deployed on the network. diff --git a/docs/02_cleos/02_how-to-guides/how-to-get-block-information.md b/docs/02_cleos/02_how-to-guides/how-to-get-block-information.md index 216413ed1e..9914cc40b1 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-get-block-information.md +++ b/docs/02_cleos/02_how-to-guides/how-to-get-block-information.md @@ -10,10 +10,10 @@ Make sure to meet the following requirements: * Install the currently supported version of `cleos`. [[info | Note]] -| `cleos` is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install `cleos`. +| `cleos` is bundled with the Antelope software. [Installing Antelope](../../00_install/index.md) will also install `cleos`. * Understand what a [block](/glossary.md#block) is and its role in the blockchain. -* Understand the [block lifecycle](/protocol-guides/01_consensus_protocol.md#5-block-lifecycle) in the EOSIO consensus protocol. +* Understand the [block lifecycle](/protocol-guides/01_consensus_protocol.md#5-block-lifecycle) in the Antelope consensus protocol. ## Steps diff --git a/docs/02_cleos/02_how-to-guides/how-to-get-transaction-information.md b/docs/02_cleos/02_how-to-guides/how-to-get-transaction-information.md index 717d6b225a..e40a2e2225 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-get-transaction-information.md +++ b/docs/02_cleos/02_how-to-guides/how-to-get-transaction-information.md @@ -1,6 +1,6 @@ ## Overview -This how-to guide provides instructions on how to retrieve infomation of an EOSIO transaction using a transaction ID. +This how-to guide provides instructions on how to retrieve infomation of an Antelope transaction using a transaction ID. The example in this how-to retrieves transaction information associated with the creation of the account **bob**. @@ -9,8 +9,8 @@ The example in this how-to retrieves transaction information associated with the Make sure you meet the following requirements: * Install the currently supported version of `cleos`. [[info | Note]] -| `cleos` is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install `cleos`. -* Understand how transactions work in an EOSIO blockchain. For more information on transactions, see the [Transactions Protocol](/protocol-guides/02_transactions_protocol.md) section. +| `cleos` is bundled with the Antelope software. [Installing Antelope](../../00_install/index.md) will also install `cleos`. +* Understand how transactions work in an Antelope blockchain. For more information on transactions, see the [Transactions Protocol](/protocol-guides/02_transactions_protocol.md) section. ## Command Reference diff --git a/docs/02_cleos/02_how-to-guides/how-to-import-a-key.md b/docs/02_cleos/02_how-to-guides/how-to-import-a-key.md index d2cf0d0f4c..cf17414d4b 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-import-a-key.md +++ b/docs/02_cleos/02_how-to-guides/how-to-import-a-key.md @@ -1,6 +1,6 @@ ## Overview -This how-to guide provides instructions on how to import a private key into the `keosd` default wallet. You can use the private key to authorize transactions in an EOSIO blockchain. +This how-to guide provides instructions on how to import a private key into the `keosd` default wallet. You can use the private key to authorize transactions in an Antelope blockchain. ## Before you Begin @@ -11,7 +11,7 @@ Make sure you meet the following requirements: * Familiarize with the [`cleos wallet import`](../03_command-reference/wallet/import.md) command. * Install the currently supported version of `cleos`. [[info | Note]] -| `cleos` is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install `cleos`. +| `cleos` is bundled with the Antelope software. [Installing Antelope](../../00_install/index.md) will also install `cleos`. * Understand what a [public key](/glossary.md#public-key) and [private key](/glossary.md#private-key) is. ## Command Reference diff --git a/docs/02_cleos/02_how-to-guides/how-to-list-all-key-pairs.md b/docs/02_cleos/02_how-to-guides/how-to-list-all-key-pairs.md index 2241458075..afcf1956c3 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-list-all-key-pairs.md +++ b/docs/02_cleos/02_how-to-guides/how-to-list-all-key-pairs.md @@ -1,6 +1,6 @@ ## Overview -This how-to guide provides instructions on how to list all public keys and public/private key pairs within the `keosd` default wallet. You can use the public and private keys to authorize transactions in an EOSIO blockchain. +This how-to guide provides instructions on how to list all public keys and public/private key pairs within the `keosd` default wallet. You can use the public and private keys to authorize transactions in an Antelope blockchain. The example in this how-to guide displays all public keys and public/private key pairs stored within the existing default wallet. @@ -13,7 +13,7 @@ Make sure you meet the following requirements: * Familiarize with the [`cleos wallet`](../03_command-reference/wallet/index.md) commands. * Install the currently supported version of `cleos`. [[info | Note]] -| `cleos` is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install `cleos`. +| `cleos` is bundled with the Antelope software. [Installing Antelope](../../00_install/index.md) will also install `cleos`. * Understand what a [public key](/glossary.md#public-key) and [private key](/glossary.md#private-key) is. ## Command Reference diff --git a/docs/02_cleos/03_command-reference/create/account.md b/docs/02_cleos/03_command-reference/create/account.md index 976c986f56..2dce43ba81 100755 --- a/docs/02_cleos/03_command-reference/create/account.md +++ b/docs/02_cleos/03_command-reference/create/account.md @@ -30,7 +30,7 @@ Options: ``` ## Command -A set of EOSIO keys is required to create an account. The EOSIO keys can be generated by using `cleos create key`. +A set of Antelope keys is required to create an account. The Antelope keys can be generated by using `cleos create key`. ```sh cleos create account inita tester EOS4toFS3YXEQCkuuw1aqDLrtHim86Gz9u3hBdcBw5KNPZcursVHq EOS7d9A3uLe6As66jzN8j44TXJUqJSK3bFjjEEqR4oTvNAB3iM9SA diff --git a/docs/02_cleos/03_command-reference/net/connect.md b/docs/02_cleos/03_command-reference/net/connect.md index 646762cf1d..777a9c4852 100755 --- a/docs/02_cleos/03_command-reference/net/connect.md +++ b/docs/02_cleos/03_command-reference/net/connect.md @@ -30,7 +30,7 @@ Make sure you meet the following requirements: * Install the currently supported version of `cleos`. [[info | Note]] -| `cleos` is bundled with the EOSIO software. [Installing EOSIO](../../../00_install/index.md) will also install the `cleos` and `keosd` command line tools. +| `cleos` is bundled with the Antelope software. [Installing Antelope](../../../00_install/index.md) will also install the `cleos` and `keosd` command line tools. * You have access to a producing node instance with the [`net_api_plugin`](../../../01_nodeos/03_plugins/net_api_plugin/index.md) loaded. ## Examples diff --git a/docs/02_cleos/03_command-reference/net/disconnect.md b/docs/02_cleos/03_command-reference/net/disconnect.md index d375c4b239..1cd269e83b 100755 --- a/docs/02_cleos/03_command-reference/net/disconnect.md +++ b/docs/02_cleos/03_command-reference/net/disconnect.md @@ -28,7 +28,7 @@ Make sure you meet the following requirements: * Install the currently supported version of `cleos`. [[info | Note]] -| `cleos` is bundled with the EOSIO software. [Installing EOSIO](../../../00_install/index.md) will also install the `cleos` and `keosd` command line tools. +| `cleos` is bundled with the Antelope software. [Installing Antelope](../../../00_install/index.md) will also install the `cleos` and `keosd` command line tools. * You have access to a producing node instance with the [`net_api_plugin`](../../../01_nodeos/03_plugins/net_api_plugin/index.md) loaded. ## Examples diff --git a/docs/02_cleos/03_command-reference/net/peers.md b/docs/02_cleos/03_command-reference/net/peers.md index 359f89f792..39bdc5190e 100644 --- a/docs/02_cleos/03_command-reference/net/peers.md +++ b/docs/02_cleos/03_command-reference/net/peers.md @@ -27,7 +27,7 @@ Make sure you meet the following requirements: * Install the currently supported version of `cleos`. [[info | Note]] -| `cleos` is bundled with the EOSIO software. [Installing EOSIO](../../../00_install/index.md) will also install the `cleos` and `keosd` command line tools. +| `cleos` is bundled with the Antelope software. [Installing Antelope](../../../00_install/index.md) will also install the `cleos` and `keosd` command line tools. * You have access to a producing node instance with the [`net_api_plugin`](../../../01_nodeos/03_plugins/net_api_plugin/index.md) loaded. ## Examples diff --git a/docs/02_cleos/03_command-reference/net/status.md b/docs/02_cleos/03_command-reference/net/status.md index 4ed8a84bd0..5a179e1705 100644 --- a/docs/02_cleos/03_command-reference/net/status.md +++ b/docs/02_cleos/03_command-reference/net/status.md @@ -30,7 +30,7 @@ Make sure you meet the following requirements: * Install the currently supported version of `cleos`. [[info | Note]] -| `cleos` is bundled with the EOSIO software. [Installing EOSIO](../../../00_install/index.md) will also install the `cleos` and `keosd` command line tools. +| `cleos` is bundled with the Antelope software. [Installing Antelope](../../../00_install/index.md) will also install the `cleos` and `keosd` command line tools. * You have access to a producing node instance with the [`net_api_plugin`](../../../01_nodeos/03_plugins/net_api_plugin/index.md) loaded. ## Examples diff --git a/docs/02_cleos/03_command-reference/set/set-account.md b/docs/02_cleos/03_command-reference/set/set-account.md index 304db1bb0d..a06a4383eb 100644 --- a/docs/02_cleos/03_command-reference/set/set-account.md +++ b/docs/02_cleos/03_command-reference/set/set-account.md @@ -2,7 +2,7 @@ set parameters dealing with account permissions [[info | JSON input]] -| This command involves specifying JSON input which depends on underlying class definitions. Therefore, such JSON input is subject to change in future versions of the EOSIO software. +| This command involves specifying JSON input which depends on underlying class definitions. Therefore, such JSON input is subject to change in future versions of the Antelope software. ## Positionals - `account` _TEXT_ - The account to set/delete a permission authority for diff --git a/docs/02_cleos/04_troubleshooting.md b/docs/02_cleos/04_troubleshooting.md index 63250119e9..68a673b4f3 100644 --- a/docs/02_cleos/04_troubleshooting.md +++ b/docs/02_cleos/04_troubleshooting.md @@ -20,4 +20,4 @@ Replace API_ENDPOINT and PORT with your remote `nodeos` API endpoint detail ## "Missing Authorizations" -That means you are not using the required authorizations. Most likely you are not using correct EOSIO account or permission level to sign the transaction +That means you are not using the required authorizations. Most likely you are not using correct Antelope account or permission level to sign the transaction diff --git a/docs/02_cleos/index.md b/docs/02_cleos/index.md index fbe3ca8d30..c0d320ad80 100644 --- a/docs/02_cleos/index.md +++ b/docs/02_cleos/index.md @@ -4,11 +4,11 @@ content_title: Cleos ## Introduction -`cleos` is a command line tool that interfaces with the REST API exposed by `nodeos`. Developers can also use `cleos` to deploy and test EOSIO smart contracts. +`cleos` is a command line tool that interfaces with the REST API exposed by `nodeos`. Developers can also use `cleos` to deploy and test Antelope smart contracts. ## Installation -`cleos` is distributed as part of the [EOSIO software suite](https://github.com/eosnetworkfoundation/mandel). To install `cleos` just visit the [EOSIO Software Installation](../00_install/index.md) section. +`cleos` is distributed as part of the [Antelope software suite](https://github.com/eosnetworkfoundation/mandel). To install `cleos` just visit the [Antelope Software Installation](../00_install/index.md) section. ## Using Cleos @@ -23,7 +23,7 @@ cleos --help ``` ```console -Command Line Interface to EOSIO Client +Command Line Interface to Antelope Client Usage: cleos [OPTIONS] SUBCOMMAND Options: diff --git a/docs/03_keosd/index.md b/docs/03_keosd/index.md index cfd45cb9de..7142237112 100644 --- a/docs/03_keosd/index.md +++ b/docs/03_keosd/index.md @@ -8,11 +8,11 @@ content_title: Keosd ## Installation -`keosd` is distributed as part of the [EOSIO software suite](https://github.com/eosnetworkfoundation/mandel). To install `keosd` just visit the [EOSIO Software Installation](../00_install/index.md) section. +`keosd` is distributed as part of the [Antelope software suite](https://github.com/eosnetworkfoundation/mandel). To install `keosd` just visit the [Antelope Software Installation](../00_install/index.md) section. ## Operation When a wallet is unlocked with the corresponding password, `cleos` can request `keosd` to sign a transaction with the appropriate private keys. Also, `keosd` provides support for hardware-based wallets such as Secure Encalve and YubiHSM. [[info | Audience]] -| `keosd` is intended to be used by EOSIO developers only. +| `keosd` is intended to be used by Antelope developers only. diff --git a/docs/10_utilities/index.md b/docs/10_utilities/index.md index 747c95cb72..35e014ffb2 100644 --- a/docs/10_utilities/index.md +++ b/docs/10_utilities/index.md @@ -1,9 +1,9 @@ --- -content_title: EOSIO Utilities -link_text: EOSIO Utilities +content_title: Antelope Utilities +link_text: Antelope Utilities --- -This section contains documentation for additional utilities that complement or extend `nodeos` and potentially other EOSIO software: +This section contains documentation for additional utilities that complement or extend `nodeos` and potentially other Antelope software: * [eosio-blocklog](eosio-blocklog.md) - Low-level utility for node operators to interact with block log files. * [trace_api_util](trace_api_util.md) - Low-level utility for performing tasks associated with the [Trace API](../01_nodeos/03_plugins/trace_api_plugin/index.md). diff --git a/docs/index.md b/docs/index.md index 0e98757754..cad35b6b99 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,23 +1,23 @@ --- -content_title: EOSIO Overview +content_title: Antelope Overview --- -EOSIO is the next-generation blockchain platform for creating and deploying smart contracts and distributed applications. EOSIO comes with a number of programs. The primary ones included in EOSIO are the following: +Antelope is the next-generation blockchain platform for creating and deploying smart contracts and distributed applications. Antelope comes with a number of programs. The primary ones included in Antelope are the following: * [Nodeos](01_nodeos/index.md) - Core service daemon that runs a node for block production, API endpoints, or local development. * [Cleos](02_cleos/index.md) - Command line interface to interact with the blockchain (via `nodeos`) and manage wallets (via `keosd`). -* [Keosd](03_keosd/index.md) - Component that manages EOSIO keys in wallets and provides a secure enclave for digital signing. +* [Keosd](03_keosd/index.md) - Component that manages Antelope keys in wallets and provides a secure enclave for digital signing. The basic relationship between these components is illustrated in the diagram below. -![EOSIO components](mandel_components.png) +![Antelope components](mandel_components.png) -Additional EOSIO Resources: -* [EOSIO Utilities](10_utilities/index.md) - Utilities that complement the EOSIO software. +Additional Antelope Resources: +* [Antelope Utilities](10_utilities/index.md) - Utilities that complement the Antelope software. [//]: # (THIS IS A COMMENT REMOVING BROKEN LINKS) -[//]: # (Upgrade-Guide-20_upgrade-guide/index.md-EOSIO-version/protocol-upgrade-guide.) -[//]: # (Release Notes 30_release-notes/index.md - All release notes for this EOSIO version.) +[//]: # (Upgrade-Guide-20_upgrade-guide/index.md-antelope-version/protocol-upgrade-guide.) +[//]: # (Release Notes 30_release-notes/index.md - All release notes for this Antelope version.) [[info | What's Next?]] -| [Install the EOSIO Software](00_install/index.md) before exploring the sections above. +| [Install the Antelope Software](00_install/index.md) before exploring the sections above. From 1f0b40f1aa6b89196ebf5bf226ba791fc3993d7e Mon Sep 17 00:00:00 2001 From: Luis Date: Wed, 21 Sep 2022 15:47:48 -0400 Subject: [PATCH 13/18] fix existing docs.eosnetwork.com links :doc --- docs/01_nodeos/03_plugins/net_api_plugin/index.md | 2 +- docs/01_nodeos/07_concepts/05_storage-and-read-modes.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/01_nodeos/03_plugins/net_api_plugin/index.md b/docs/01_nodeos/03_plugins/net_api_plugin/index.md index 658e643a0a..af16d5c918 100644 --- a/docs/01_nodeos/03_plugins/net_api_plugin/index.md +++ b/docs/01_nodeos/03_plugins/net_api_plugin/index.md @@ -8,7 +8,7 @@ The `net_api_plugin` provides four RPC API endpoints: * connections * status -See [Net API Reference Documentation](https://docs.eosnetwork.com/reference/mandel-plugins/net_api.html). +See [Net API Reference Documentation](https://docs.eosnetwork.com/leap-plugins/latest/net.api/). [[caution | Caution]] | This plugin exposes endpoints that allow management of p2p connections. Running this plugin on a publicly accessible node is not recommended as it can be exploited. diff --git a/docs/01_nodeos/07_concepts/05_storage-and-read-modes.md b/docs/01_nodeos/07_concepts/05_storage-and-read-modes.md index 0965fdf298..8fb138d5f3 100644 --- a/docs/01_nodeos/07_concepts/05_storage-and-read-modes.md +++ b/docs/01_nodeos/07_concepts/05_storage-and-read-modes.md @@ -17,7 +17,7 @@ Every `nodeos` instance creates some internal files to housekeep the blockchain ## Antelope Interfaces -Antelope provides a set of [services](../../) and [interfaces](https://docs.eosnetwork.com/reference/mandel-cdt/files.html) that enable contract developers to persist state across action, and consequently transaction, boundaries. Contracts may use these services and interfaces for various purposes. For example, `eosio.token` contract keeps balances for all users in the chain database. Each instance of `nodeos` keeps the database in memory, so contracts can read and write data with ease. +Antelope provides a set of [services](../../) and [interfaces](https://docs.eosnetwork.com/cdt/latest/reference/Files/) that enable contract developers to persist state across action, and consequently transaction, boundaries. Contracts may use these services and interfaces for various purposes. For example, `eosio.token` contract keeps balances for all users in the chain database. Each instance of `nodeos` keeps the database in memory, so contracts can read and write data with ease. ### Nodeos RPC API From 2599b8d0d9c0dab6962c1d5c66bb6d94a525a9a4 Mon Sep 17 00:00:00 2001 From: Luis Date: Wed, 21 Sep 2022 16:07:17 -0400 Subject: [PATCH 14/18] curate github and eosnetwork.com links :doc --- docs/00_install/01_build-from-source/00_build-unsupported-os.md | 2 +- docs/00_install/01_build-from-source/index.md | 2 +- docs/00_install/index.md | 2 +- docs/01_nodeos/02_usage/03_development-environment/index.md | 2 +- docs/01_nodeos/03_plugins/txn_test_gen_plugin/index.md | 2 +- docs/01_nodeos/index.md | 2 +- docs/02_cleos/02_how-to-guides/how-to-delegate-CPU-resource.md | 2 +- docs/02_cleos/02_how-to-guides/how-to-delegate-net-resource.md | 2 +- docs/02_cleos/index.md | 2 +- docs/03_keosd/index.md | 2 +- 10 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/00_install/01_build-from-source/00_build-unsupported-os.md b/docs/00_install/01_build-from-source/00_build-unsupported-os.md index e5cffe252d..e0d3c19331 100644 --- a/docs/00_install/01_build-from-source/00_build-unsupported-os.md +++ b/docs/00_install/01_build-from-source/00_build-unsupported-os.md @@ -6,7 +6,7 @@ content_title: Build Antelope from Source on Other Unix-based OS ### Using DUNE -For the official multi-platform support try [Docker Utilities for Node Execution](https://github.com/eosnetworkfoundation/DUNE) which runs in an ubuntu image via a docker container. +For the official multi-platform support try [Docker Utilities for Node Execution](https://github.com/AntelopeIO/DUNE) which runs in an ubuntu image via a docker container. **A Warning On Parallel Compilation Jobs (`-j` flag)**: When building C/C++ software often the build is performed in parallel via a command such as `make -j $(nproc)` which uses the number of CPU cores as the number of compilation jobs to perform simultaneously. However, be aware that some compilation units (.cpp files) in mandel are extremely complex and will consume nearly 4GB of memory to compile. You may need to reduce the level of parallelization depending on the amount of memory on your build host. e.g. instead of `make -j $(nproc)` run `make -j2`. Failures due to memory exhaustion will typically but not always manifest as compiler crashes. diff --git a/docs/00_install/01_build-from-source/index.md b/docs/00_install/01_build-from-source/index.md index 7cffd45e4a..b2a4a63513 100644 --- a/docs/00_install/01_build-from-source/index.md +++ b/docs/00_install/01_build-from-source/index.md @@ -6,7 +6,7 @@ The shell scripts previously recommended for building the software have been rem ### Using DUNE -As an alternative to building from source try [Docker Utilities for Node Execution](https://github.com/eosnetworkfoundation/DUNE) for the easiest way to get started, and for multi-platform support. +As an alternative to building from source try [Docker Utilities for Node Execution](https://github.com/AntelopeIO/DUNE) for the easiest way to get started, and for multi-platform support. ### Building From Source diff --git a/docs/00_install/index.md b/docs/00_install/index.md index 1d711083d3..4e9bf6eff2 100644 --- a/docs/00_install/index.md +++ b/docs/00_install/index.md @@ -23,4 +23,4 @@ Antelope currently supports the following operating systems: If you are using different operating system or prefer not to build Antelope from source you can try our Docker - based set of utilities called DUNE that can get you started with exploring Antelope and doing contract development pretty much instantly -* [Docker Utilities for Node Execution (D.U.N.E.)](https://github.com/eosnetworkfoundation/DUNE) +* [Docker Utilities for Node Execution (D.U.N.E.)](https://github.com/AntelopeIO/DUNE) diff --git a/docs/01_nodeos/02_usage/03_development-environment/index.md b/docs/01_nodeos/02_usage/03_development-environment/index.md index 4ed1302c63..f5efbeef4f 100644 --- a/docs/01_nodeos/02_usage/03_development-environment/index.md +++ b/docs/01_nodeos/02_usage/03_development-environment/index.md @@ -19,7 +19,7 @@ While this option can technically be used for smart contract development, it may ## Official Testing Node -Try [Docker Utilities for Node Execution](https://github.com/eosnetworkfoundation/DUNE) for the easiest way to get started, and for multi-platform support. +Try [Docker Utilities for Node Execution](https://github.com/AntelopeIO/DUNE) for the easiest way to get started, and for multi-platform support. ## Third-Party Testnets diff --git a/docs/01_nodeos/03_plugins/txn_test_gen_plugin/index.md b/docs/01_nodeos/03_plugins/txn_test_gen_plugin/index.md index efbb5a0204..8b784d0a34 100644 --- a/docs/01_nodeos/03_plugins/txn_test_gen_plugin/index.md +++ b/docs/01_nodeos/03_plugins/txn_test_gen_plugin/index.md @@ -4,7 +4,7 @@ The `txn_test_gen_plugin` is used for transaction test purposes. [[info | For More Information]] -For more information, check the [txn_test_gen_plugin/README.md](https://github.com/eosnetworkfoundation/mandel/tree/main/plugins/txn_test_gen_plugin) on the EOSIO/eos repository. +For more information, check the [txn_test_gen_plugin/README.md](https://github.com/AntelopeIO/leap/tree/main/plugins/txn_test_gen_plugin) on the `AntelopeIO/leap` repository. ## Usage diff --git a/docs/01_nodeos/index.md b/docs/01_nodeos/index.md index c31e5f3a82..51d749230e 100644 --- a/docs/01_nodeos/index.md +++ b/docs/01_nodeos/index.md @@ -8,7 +8,7 @@ content_title: Nodeos ## Installation -`nodeos` is distributed as part of the [Antelope software suite](https://github.com/eosnetworkfoundation/mandel). To install `nodeos`, visit the [Antelope Software Installation](../00_install/index.md) section. +`nodeos` is distributed as part of the [Antelope software suite](https://github.com/AntelopeIO/leap). To install `nodeos`, visit the [Antelope Software Installation](../00_install/index.md) section. ## Explore diff --git a/docs/02_cleos/02_how-to-guides/how-to-delegate-CPU-resource.md b/docs/02_cleos/02_how-to-guides/how-to-delegate-CPU-resource.md index 65003d0e2e..ab15bdbfe2 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-delegate-CPU-resource.md +++ b/docs/02_cleos/02_how-to-guides/how-to-delegate-CPU-resource.md @@ -12,7 +12,7 @@ Make sure you meet the following requirements: [[info | Note]] | `cleos` is bundled with the Antelope software. [Installing Antelope](../../00_install/index.md) will also install `cleos`. -* Ensure the reference system contracts from [`eosio.contracts`](https://github.com/eosnetworkfoundation/mandel-contracts) repository is deployed and used to manage system resources. +* Ensure the reference system contracts from [`reference-contracts`](https://github.com/AntelopeIO/reference-contracts) repository is deployed and used to manage system resources. * Understand what an [account](/glossary.md#account) is and its role in the blockchain. * Understand [CPU bandwidth](/glossary.md#cpu) in an Antelope blockchain. * Understand [NET bandwidth](/glossary.md#net) in an Antelope blockchain. diff --git a/docs/02_cleos/02_how-to-guides/how-to-delegate-net-resource.md b/docs/02_cleos/02_how-to-guides/how-to-delegate-net-resource.md index 6db305abdb..c009cb31ca 100644 --- a/docs/02_cleos/02_how-to-guides/how-to-delegate-net-resource.md +++ b/docs/02_cleos/02_how-to-guides/how-to-delegate-net-resource.md @@ -12,7 +12,7 @@ Make sure you meet the following requirements: [[info | Note]] | `cleos` is bundled with the Antelope software. [Installing Antelope](../../00_install/index.md) will also install `cleos`. -* Ensure the reference system contracts from [`eosio.contracts`](https://github.com/eosnetworkfoundation/mandel-contracts) repository is deployed and used to manage system resources. +* Ensure the reference system contracts from [`reference-contracts`](https://github.com/AntelopeIO/reference-contracts) repository is deployed and used to manage system resources. * Understand what an [account](/glossary.md#account) is and its role in the blockchain. * Understand [NET bandwidth](/glossary.md#net) in an Antelope blockchain. * Understand [CPU bandwidth](/glossary.md#cpu) in an Antelope blockchain. diff --git a/docs/02_cleos/index.md b/docs/02_cleos/index.md index c0d320ad80..e779146036 100644 --- a/docs/02_cleos/index.md +++ b/docs/02_cleos/index.md @@ -8,7 +8,7 @@ content_title: Cleos ## Installation -`cleos` is distributed as part of the [Antelope software suite](https://github.com/eosnetworkfoundation/mandel). To install `cleos` just visit the [Antelope Software Installation](../00_install/index.md) section. +`cleos` is distributed as part of the [Antelope software suite](https://github.com/AntelopeIO/leap). To install `cleos` just visit the [Antelope Software Installation](../00_install/index.md) section. ## Using Cleos diff --git a/docs/03_keosd/index.md b/docs/03_keosd/index.md index 7142237112..69bcdcd487 100644 --- a/docs/03_keosd/index.md +++ b/docs/03_keosd/index.md @@ -8,7 +8,7 @@ content_title: Keosd ## Installation -`keosd` is distributed as part of the [Antelope software suite](https://github.com/eosnetworkfoundation/mandel). To install `keosd` just visit the [Antelope Software Installation](../00_install/index.md) section. +`keosd` is distributed as part of the [Antelope software suite](https://github.com/AntelopeIO/leap). To install `keosd` just visit the [Antelope Software Installation](../00_install/index.md) section. ## Operation From 9c8e0d0e76cab15d1780a3ef6e7fbc0c25751248 Mon Sep 17 00:00:00 2001 From: Luis Date: Wed, 21 Sep 2022 17:28:56 -0400 Subject: [PATCH 15/18] replace applicable eosio refs to antelope :doc --- docs/01_nodeos/02_usage/02_node-setups/00_producing-node.md | 2 +- .../02_usage/02_node-setups/01_non-producing-node.md | 2 +- .../00_local-single-node-testnet.md | 2 +- .../03_development-environment/01_local-multi-node-testnet.md | 4 +++- 4 files changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/01_nodeos/02_usage/02_node-setups/00_producing-node.md b/docs/01_nodeos/02_usage/02_node-setups/00_producing-node.md index edcc593276..d53636153e 100644 --- a/docs/01_nodeos/02_usage/02_node-setups/00_producing-node.md +++ b/docs/01_nodeos/02_usage/02_node-setups/00_producing-node.md @@ -15,7 +15,7 @@ This section describes how to set up a producing node within the Antelope networ * It is assumed that `nodeos`, `cleos`, and `keosd` are accessible through the path. [//]: # ( THIS IS A COMMENT LINK BELOW IS BROKEN ) -[//]: # ( If you built Antelope using shell scripts, make sure to run the Install Script ../../../00_install/01_build-from-source/01_shell-scripts/03_install-eosio-binaries.md ) +[//]: # ( If you built Antelope using shell scripts, make sure to run the Install Script ../../../00_install/01_build-from-source/01_shell-scripts/03_install-antelope-binaries.md ) * Know how to pass [Nodeos options](../../02_usage/00_nodeos-options.md) to enable or disable functionality. diff --git a/docs/01_nodeos/02_usage/02_node-setups/01_non-producing-node.md b/docs/01_nodeos/02_usage/02_node-setups/01_non-producing-node.md index b0e5c9cc31..87c0f69493 100644 --- a/docs/01_nodeos/02_usage/02_node-setups/01_non-producing-node.md +++ b/docs/01_nodeos/02_usage/02_node-setups/01_non-producing-node.md @@ -12,7 +12,7 @@ This section describes how to set up a non-producing node within the Antelope ne * It is assumed that `nodeos`, `cleos`, and `keosd` are accessible through the path. [//]: # ( THIS IS A COMMENT NEXT LINK CONTAINS A BROKEN LINK ) -[//]: # ( If you built Antelope using shell scripts, make sure to run the Install Script ../../../00_install/01_build-from-source/01_shell-scripts/03_install-eosio-binaries.md ) +[//]: # ( If you built Antelope using shell scripts, make sure to run the Install Script ../../../00_install/01_build-from-source/01_shell-scripts/03_install-antelope-binaries.md ) * Know how to pass [Nodeos options](../../02_usage/00_nodeos-options.md) to enable or disable functionality. diff --git a/docs/01_nodeos/02_usage/03_development-environment/00_local-single-node-testnet.md b/docs/01_nodeos/02_usage/03_development-environment/00_local-single-node-testnet.md index a55d817774..e94c037d02 100644 --- a/docs/01_nodeos/02_usage/03_development-environment/00_local-single-node-testnet.md +++ b/docs/01_nodeos/02_usage/03_development-environment/00_local-single-node-testnet.md @@ -16,7 +16,7 @@ This section describes how to set up a single-node blockchain configuration runn * It is assumed that `nodeos`, `cleos`, and `keosd` are accessible through the path. [//]: # (THIS IS A COMMENT, NEXT LINK HAS BROKEN LINK) -[//]: # (If you built Antelope using shell scripts, make sure to run the Install Script ../../../00_install/01_build-from-source/01_shell-scripts/03_install-eosio-binaries.md .) +[//]: # (If you built Antelope using shell scripts, make sure to run the Install Script ../../../00_install/01_build-from-source/01_shell-scripts/03_install-antelope-binaries.md .) * Know how to pass [Nodeos options](../../02_usage/00_nodeos-options.md) to enable or disable functionality. diff --git a/docs/01_nodeos/02_usage/03_development-environment/01_local-multi-node-testnet.md b/docs/01_nodeos/02_usage/03_development-environment/01_local-multi-node-testnet.md index 52a7c8dfb8..e14591bb26 100644 --- a/docs/01_nodeos/02_usage/03_development-environment/01_local-multi-node-testnet.md +++ b/docs/01_nodeos/02_usage/03_development-environment/01_local-multi-node-testnet.md @@ -20,7 +20,7 @@ Open four "terminal" windows and perform the following steps: 1. [Start the Wallet Manager](#1-start-the-wallet-manager) 2. [Create a Default Wallet](#2-create-a-default-wallet) -3. [Loading the Antelope Key](#3-loading-the-eosio-key) +3. [Loading the Antelope Key](#3-loading-the-antelope-key) 4. [Start the First Producer Node](#4-start-the-first-producer-node) 5. [Start the Second Producer Node](#5-start-the-second-producer-node) 6. [Get Nodes Info](#6-get-nodes-info) @@ -90,7 +90,9 @@ This creates a special producer, known as the "bios" producer. Assuming everythi ### 5. Start the Second Producer Node + To start additional nodes, you must first load the `eosio.bios` contract. This contract enables you to have direct control over the resource allocation of other accounts and to access other privileged API calls. Return to the second terminal window and run the following command to load the contract: From fcafd0cb1f93ff7e9551b02bdd5163785d973485 Mon Sep 17 00:00:00 2001 From: Luis Date: Thu, 22 Sep 2022 01:22:58 -0400 Subject: [PATCH 16/18] make html comment MDX-compatible for doc6s parsing :doc --- .../01_local-multi-node-testnet.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/01_nodeos/02_usage/03_development-environment/01_local-multi-node-testnet.md b/docs/01_nodeos/02_usage/03_development-environment/01_local-multi-node-testnet.md index e14591bb26..30d2b4a1d0 100644 --- a/docs/01_nodeos/02_usage/03_development-environment/01_local-multi-node-testnet.md +++ b/docs/01_nodeos/02_usage/03_development-environment/01_local-multi-node-testnet.md @@ -90,9 +90,8 @@ This creates a special producer, known as the "bios" producer. Assuming everythi ### 5. Start the Second Producer Node - +[//]: # (don't render for now) +[//]: # (The following commands assume that you are running this tutorial from the `eos\build` directory, from which you ran `./eosio_build.sh` to build the Antelope binaries.) To start additional nodes, you must first load the `eosio.bios` contract. This contract enables you to have direct control over the resource allocation of other accounts and to access other privileged API calls. Return to the second terminal window and run the following command to load the contract: From 55d9bb551cfb6102be94542539c363a0973f7704 Mon Sep 17 00:00:00 2001 From: Luis Date: Thu, 22 Sep 2022 09:50:07 -0400 Subject: [PATCH 17/18] add manual links to plugins API reference --- .../03_plugins/chain_api_plugin/api-reference/index.md | 2 +- .../03_plugins/db_size_api_plugin/api-reference/index.md | 2 +- docs/01_nodeos/03_plugins/net_api_plugin/api-reference/index.md | 2 +- .../03_plugins/producer_api_plugin/api-reference/index.md | 2 +- .../03_plugins/trace_api_plugin/api-reference/index.md | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/01_nodeos/03_plugins/chain_api_plugin/api-reference/index.md b/docs/01_nodeos/03_plugins/chain_api_plugin/api-reference/index.md index 6451c70868..f49aa2c390 100644 --- a/docs/01_nodeos/03_plugins/chain_api_plugin/api-reference/index.md +++ b/docs/01_nodeos/03_plugins/chain_api_plugin/api-reference/index.md @@ -1 +1 @@ - +[Chain API Reference](https://docs.eosnetwork.com/leap-plugins/latest/chain.api/) diff --git a/docs/01_nodeos/03_plugins/db_size_api_plugin/api-reference/index.md b/docs/01_nodeos/03_plugins/db_size_api_plugin/api-reference/index.md index 6451c70868..7b7810fe72 100644 --- a/docs/01_nodeos/03_plugins/db_size_api_plugin/api-reference/index.md +++ b/docs/01_nodeos/03_plugins/db_size_api_plugin/api-reference/index.md @@ -1 +1 @@ - +[DB Size API Reference](https://docs.eosnetwork.com/leap-plugins/latest/db_size.api/) diff --git a/docs/01_nodeos/03_plugins/net_api_plugin/api-reference/index.md b/docs/01_nodeos/03_plugins/net_api_plugin/api-reference/index.md index 6451c70868..842ba652eb 100644 --- a/docs/01_nodeos/03_plugins/net_api_plugin/api-reference/index.md +++ b/docs/01_nodeos/03_plugins/net_api_plugin/api-reference/index.md @@ -1 +1 @@ - +[Net API Reference](https://docs.eosnetwork.com/leap-plugins/latest/net.api/) diff --git a/docs/01_nodeos/03_plugins/producer_api_plugin/api-reference/index.md b/docs/01_nodeos/03_plugins/producer_api_plugin/api-reference/index.md index 6451c70868..80bcc0b7fd 100644 --- a/docs/01_nodeos/03_plugins/producer_api_plugin/api-reference/index.md +++ b/docs/01_nodeos/03_plugins/producer_api_plugin/api-reference/index.md @@ -1 +1 @@ - +[Producer API Reference](https://docs.eosnetwork.com/leap-plugins/latest/producer.api/) diff --git a/docs/01_nodeos/03_plugins/trace_api_plugin/api-reference/index.md b/docs/01_nodeos/03_plugins/trace_api_plugin/api-reference/index.md index 6451c70868..07a171ca7d 100644 --- a/docs/01_nodeos/03_plugins/trace_api_plugin/api-reference/index.md +++ b/docs/01_nodeos/03_plugins/trace_api_plugin/api-reference/index.md @@ -1 +1 @@ - +[Trace API Reference](https://docs.eosnetwork.com/leap-plugins/latest/trace.api/) From c0efca061756d7eb99e20c33ca9ab132ef60c990 Mon Sep 17 00:00:00 2001 From: Eric Passmore Date: Mon, 26 Sep 2022 15:56:28 -0700 Subject: [PATCH 18/18] trace_api docs show all schemas returned - shorted description refered back to developer docs - allow return types for get_blocks any of BlockTraceV0, BlockTraceV1, BlockTraceV2 - BlockTraceV2 can return either Transaction Type V1 or Transaction Type V2 - allow return types for get_transaction_trace any of TransactionTraceV0, TransactionTraceV1, TransactionTraceV2 --- .../trace_api_plugin/trace_api.swagger.yaml | 121 ++---------------- 1 file changed, 10 insertions(+), 111 deletions(-) diff --git a/plugins/trace_api_plugin/trace_api.swagger.yaml b/plugins/trace_api_plugin/trace_api.swagger.yaml index 1531dae149..46bb143496 100644 --- a/plugins/trace_api_plugin/trace_api.swagger.yaml +++ b/plugins/trace_api_plugin/trace_api.swagger.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: title: Trace API - description: This plubing must specifiy one option `trace-rpc-abi` or `no-trace-abis`. These options are provided at nodeos startup on the command line or in config.ini file. Configuration option `trace-rpc-abi` There must be at least one ABI specified OR the flag trace-no-abis must be used. ABIs are specified as "Key=Value" pairs in the form = Where can be an absolute path to a file containing a valid JSON-encoded ABI a relative path from `data-dir` to a file containing a valid JSON-encoded ABI. Configuration option `trace-no-abis` use to indicate that the RPC responses + description: See developer documentation at https://docs.eosnetwork.com for information on enabling this plugin. version: 1.0.0 license: name: MIT @@ -47,7 +47,10 @@ paths: content: application/json: schema: - $ref: "#/component/schema/BLOCK_TRACE" + oneOf: + - $ref: "https://docs.eosnetwork.com/openapi/v2.0/BlockTraceV0.yaml" + - $ref: "https://docs.eosnetwork.com/openapi/v2.0/BlockTraceV1.yaml" + - $ref: "https://docs.eosnetwork.com/openapi/v2.0/BlockTraceV2.yaml" "400": description: Error - requested block number is invalid (not a number, larger than max int) content: @@ -115,7 +118,11 @@ paths: content: application/json: schema: - $ref: "#/component/schema/TRANSACTION_TRACE" + oneOf: + - $ref: "https://docs.eosnetwork.com/openapi/v2.0/TransactionTraceV0.yaml" + - $ref: "https://docs.eosnetwork.com/openapi/v2.0/TransactionTraceV1.yaml" + - $ref: "https://docs.eosnetwork.com/openapi/v2.0/TransactionTraceV2.yaml" + - $ref: "https://docs.eosnetwork.com/openapi/v2.0/TransactionTraceV3.yaml" "400": description: Error - requested block number is invalid (not a number, larger than max int) content: @@ -210,114 +217,6 @@ component: memo: type: string example: "first transfer" - TRANSACTION_HEADER: - type: object - properties: - expiration: - type: string - example: "2019-06-18T00:00:00" - ref_block_num: - type: integer - example: 25 - ref_block_prefix: - type: integer - example: 61809694 - max_net_usage_words: - type: integer - example: 0 - max_cpu_usage_ms: - type: integer - example: 0 - delay_sec: - type: integer - example: 0 - TRANSACTION_TRACE: - type: object - properties: - id: - type: string - $ref: "https://docs.eosnetwork.com/openapi/v2.0/Sha256.yaml" - block_num: - type: integer - example: 31 - block_time: - type: string - example: "2019-06-18T00:00:00" - producer_block_id: - type: string - $ref: "https://docs.eosnetwork.com/openapi/v2.0/Sha256.yaml" - actions: - type: array - items: - $ref: "#/component/schema/TRACE" - status: - type: string - example: executed - cpu_usage_us: - type: integer - example: 669 - net_usage_words: - type: integer - example: 6 - signatures: - type: array - items: - $ref: "https://docs.eosnetwork.com/openapi/v2.0/CppSignature.yaml" - transaction_header: - type: object - $ref: "#/component/schema/TRANSACTION_HEADER" - BLOCK_TRACE: - type: object - properties: - id: - $ref: "https://docs.eosnetwork.com/openapi/v2.0/Sha256.yaml" - number: - type: integer - example: 31 - previous_id: - $ref: "https://docs.eosnetwork.com/openapi/v2.0/Sha256.yaml" - status: - type: string - enum: - - "irreversible" - - "executed" - - "pending" - example: executed - timestamp: - type: string - example: "2019-06-18T00:00:00" - producer: - type: string - example: myproducer - transaction_mroot: - $ref: "https://docs.eosnetwork.com/openapi/v2.0/Sha256.yaml" - action_mroot: - $ref: "https://docs.eosnetwork.com/openapi/v2.0/Sha256.yaml" - schedule_version: - type: integer - example: 1 - transactions: - type: array - items: - type: object - properties: - id: - $ref: "https://docs.eosnetwork.com/openapi/v2.0/Sha256.yaml" - block_num: - type: integer - example: 31 - block_time: - type: string - example: "2019-06-18T00:00:00" - producer_block_id: - $ref: "https://docs.eosnetwork.com/openapi/v2.0/Sha256.yaml" - actions: - type: array - items: - $ref: "#/component/schema/TRACE" - transaction_header: - type: object - $ref: "#/component/schema/TRANSACTION_HEADER" ERROR_DETAILS: type: object properties: