Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Curate eosio refs, and github, eosnetwork links [docs] #204

Merged
merged 6 commits into from
Sep 22, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
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.**

### 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.

Expand Down
4 changes: 2 additions & 2 deletions docs/00_install/01_build-from-source/index.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
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.

### 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

Expand Down
16 changes: 8 additions & 8 deletions docs/00_install/index.md
Original file line number Diff line number Diff line change
@@ -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)
* [Docker Utilities for Node Execution (D.U.N.E.)](https://github.com/AntelopeIO/DUNE)
8 changes: 4 additions & 4 deletions docs/01_nodeos/02_usage/02_node-setups/00_producing-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -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-antelope-binaries.md )

* Know how to pass [Nodeos options](../../02_usage/00_nodeos-options.md) to enable or disable functionality.

Expand Down Expand Up @@ -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>:<data>`
* `provider-type` - KEY or KEOSD

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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-antelope-binaries.md )

* Know how to pass [Nodeos options](../../02_usage/00_nodeos-options.md) to enable or disable functionality.

Expand Down Expand Up @@ -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.
Original file line number Diff line number Diff line change
Expand Up @@ -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-antelope-binaries.md .)

* Know how to pass [Nodeos options](../../02_usage/00_nodeos-options.md) to enable or disable functionality.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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-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)
Expand Down Expand Up @@ -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.

Expand All @@ -90,7 +90,8 @@ 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.
[//]: # (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:

Expand Down
4 changes: 2 additions & 2 deletions docs/01_nodeos/02_usage/03_development-environment/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ 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

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/)
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<!-- THIS IS A PLACEHOLDER, WILL BE REPLACED BY REDOC INSTANCE -->
[Chain API Reference](https://docs.eosnetwork.com/leap-plugins/latest/chain.api/)
2 changes: 1 addition & 1 deletion docs/01_nodeos/03_plugins/chain_plugin/index.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<!-- THIS IS A PLACEHOLDER, WILL BE REPLACED BY REDOC INSTANCE -->
[DB Size API Reference](https://docs.eosnetwork.com/leap-plugins/latest/db_size.api/)
2 changes: 1 addition & 1 deletion docs/01_nodeos/03_plugins/login_plugin/index.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<!-- THIS IS A PLACEHOLDER, WILL BE REPLACED BY REDOC INSTANCE -->
[Net API Reference](https://docs.eosnetwork.com/leap-plugins/latest/net.api/)
2 changes: 1 addition & 1 deletion docs/01_nodeos/03_plugins/net_api_plugin/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<!-- THIS IS A PLACEHOLDER, WILL BE REPLACED BY REDOC INSTANCE -->
[Producer API Reference](https://docs.eosnetwork.com/leap-plugins/latest/producer.api/)
4 changes: 2 additions & 2 deletions docs/01_nodeos/03_plugins/producer_plugin/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Config Options for eosio::producer_plugin:
<public-key>=<provider-spec>
Where:
<public-key> is a string form of
a vaild EOSIO public
a vaild Antelope public
key

<provider-spec> is a string in the
Expand All @@ -59,7 +59,7 @@ Config Options for eosio::producer_plugin:
<provider-type> is KEY, or KEOSD

KEY:<data> is a string form of
a valid EOSIO
a valid Antelope
private key which
maps to the provided
public key
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<!-- THIS IS A PLACEHOLDER, WILL BE REPLACED BY REDOC INSTANCE -->
[Trace API Reference](https://docs.eosnetwork.com/leap-plugins/latest/trace.api/)
Loading