Merge branch 'master' into integration/dorado

fetchai · Mar 15, 2022 · 4e8b637 · 4e8b637
2 parents 5c69bb0 + 32af1b6
commit 4e8b637
Show file tree

Hide file tree

Showing 14 changed files with 155 additions and 23 deletions.
diff --git a/.github/workflows/docs_pr_preview.yml b/.github/workflows/docs_pr_preview.yml
@@ -0,0 +1,55 @@
+name: Documentation Preview
+
+on:
+  pull_request:
+    branches:
+      - master
+    paths:
+      - 'docs/**'
+
+jobs:
+  build:
+    name: Docs Ephemerial Build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Use python 3.9
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.9'
+
+      - name: Install Dependencies
+        run: cd docs && pip3 install pipenv && pipenv install
+
+      - name: Build
+        run: cd docs && pipenv run mkdocs build
+
+      - name: Archive Production Artifact
+        uses: actions/upload-artifact@master
+        with:
+          name: dist
+          path: docs/site
+
+  deploy:
+    name: Docs Ephemerial Deploy
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Download Artifact
+        uses: actions/download-artifact@master
+        with:
+          name: dist
+          path: docs/site
+
+      - uses: FirebaseExtended/action-hosting-deploy@v0
+        with:
+          repoToken: "${{ secrets.GITHUB_TOKEN }}"
+          firebaseServiceAccount: "${{ secrets.FIREBASE_SERVICE_ACCOUNT }}"
+          expires: 5d
+          projectId: fetch-docs-preview
+          entryPoint: docs/
diff --git a/docs/.firebaserc b/docs/.firebaserc
@@ -0,0 +1,5 @@
+{
+  "projects": {
+    "default": "fetch-docs-preview"
+  }
+}
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1,2 @@
+site/
+.firebase/
diff --git a/docs/Dockerfile b/docs/Dockerfile
@@ -0,0 +1,10 @@
+FROM python:3.9-slim
+RUN pip3 install pipenv
+
+WORKDIR /app
+ADD Pipfile Pipfile.lock /app/
+RUN pipenv install --system --deploy
+RUN mkdir /app/site
+
+ENTRYPOINT [ "mkdocs" ]
+CMD ["build"]
diff --git a/docs/build-docker.sh b/docs/build-docker.sh
@@ -0,0 +1,12 @@
+#!/bin/bash
+set -e
+
+TAG_NAME=fetchd-docs-build:latest
+
+# ensure the output folder is created
+mkdir -p site
+
+# build the latest image
+docker build -t "${TAG_NAME}" .
+
+docker run --rm -v "${PWD}:/app" "${TAG_NAME}"
diff --git a/docs/docs/cli-introduction.md b/docs/docs/cli-introduction.md
@@ -11,17 +11,17 @@ While some users will want to connect a node to the network and sync the entire
 To connect to the mainnet run the following configuration steps:
 
 ```bash
-fetchd config chain-id fetchhub-2
+fetchd config chain-id fetchhub-3
 fetchd config node https://rpc-fetchhub.fetch.ai:443
 ```
 
-### Connecting to stargateworld network
+### Connecting to capricorn network
 
 To connect to the stargateworld network run the following configuration steps:
 
 ```bash
-fetchd config chain-id stargateworld-3
-fetchd config node https://rpc-stargateworld.fetch.ai:443
+fetchd config chain-id capricorn-1
+fetchd config node https://rpc-capricorn.fetch.ai:443
 ```
 
 Checkout the [Network Information](../networks/) page for more detailed information on the available networks.
diff --git a/docs/docs/cli-multisig.md b/docs/docs/cli-multisig.md
@@ -52,10 +52,10 @@ fetchd tx bank send <business_key address> <vendor address> 1000atestfet --gener
 	
 # This transaction file (transfer.json) is then made available for
 # the first keyholder to sign, 'fred'
-fetchd tx sign transfer.json --chain-id stargateworld-1 --from fred --multisig <address of business_key> > transfer_fredsigned.json
+fetchd tx sign transfer.json --chain-id capricorn-1 --from fred --multisig <address of business_key> > transfer_fredsigned.json
 
 # This is repeated for 'ted'
-fetchd tx sign transfer.json --chain-id stargateworld-1 --from ted --multisig <address of business_key> > transfer_tedsigned.json
+fetchd tx sign transfer.json --chain-id capricorn-1 --from ted --multisig <address of business_key> > transfer_tedsigned.json
 
 # These two files are then collated together and used as inputs to the
 # multisign command to create a fully signed transaction

diff --git a/docs/docs/cli-tokens.md b/docs/docs/cli-tokens.md
@@ -73,7 +73,7 @@ height: "0"
 info: ""
 logs: []
 raw_log: 'signature verification failed; please verify account number (5815) and chain-id
-  (stargateworld-1): unauthorized'
+  (capricorn-1): unauthorized'
 timestamp: ""
 tx: null
 txhash: 23701B052B423D63EB4AC94773B5B8227B03A576692A57999E92F2554F2372D4

diff --git a/docs/docs/delegator-guide-cli.md b/docs/docs/delegator-guide-cli.md
@@ -11,7 +11,7 @@ The following command can be used to retrieve the current staking holdings of al
 fetchd query staking validators
 ```
 
-On `stargateworld` network, this will produce an output similar to the following, describing the status of all the existing validators:
+On `capricorn` network, this will produce an output similar to the following, describing the status of all the existing validators:
 
 ```text
 - |
@@ -84,7 +84,7 @@ From a validator address, we can retrieve the list of delegations it received:
 fetchd query staking delegations-to fetchvaloper1z72rph6l5j6ex83n4urputykawcqg6t98xul2w
 ```
 
-Here is a sample of delegations `validator5` received on `stargateworld`:
+Here is a sample of delegations `validator5` received on `capricorn`:
 
 ```text
 - delegation:
@@ -153,7 +153,7 @@ To retrieve all the outstanding rewards for an address, issue the following comm
 fetchd query distribution rewards fetch15fn3meky8ktfry3qm73xkpjckzw4dazxpfx34m
 ```
 
-This address having delegated tokens to 2 validators on `stargateworld`, it produces the following output:
+This address having delegated tokens to 2 validators on `capricorn`, it produces the following output:
 
 ```text
 rewards:

diff --git a/docs/docs/index.md b/docs/docs/index.md
@@ -18,8 +18,6 @@ fetch1almpjpf769p23k0v4m5eglvzr4jupsjs66vxf4
 
 Block explorer and token tap: [https://explore-agent-land.fetch.ai/](https://explore-agent-land.fetch.ai/)
 
-Understanding building block relationships: [https://docs.fetch.ai/aea/oef-ledger/](https://docs.fetch.ai/aea/oef-ledger/)
-
 For more detailed information, have a look at our [network](./networks/) information page.
 
 ## Roadmap for Smart Contracts

diff --git a/docs/docs/joining-a-testnet.md b/docs/docs/joining-a-testnet.md
@@ -21,13 +21,13 @@ fetchd config chain-id <chain-id>
 fetchd config node <rpc url>
 ```
 
-### Stargate example
+### Capricorn example
 
-In the case of the Stargate network this would be as follows:
+In the case of the Capricorn network this would be as follows:
 
 ```bash
-fetchd config chain-id stargateworld-3
-fetchd config node https://rpc-stargateworld.fetch.ai:443
+fetchd config chain-id capricorn-1
+fetchd config node https://rpc-capricorn.fetch.ai:443
 ```
 
 ### Configuring the server `fetchd`
@@ -52,19 +52,19 @@ Finally connect fetchd to the network by getting it to connect to a seed node fo
 fetchd start --p2p.seeds=<network seed peers>
 ```
 
-**Stargate Example**
+**Capricorn Example**
 
-Less abstractly then, if you wants to connect to the Stargate test net for example, you would need to run the following steps:
+Less abstractly then, if you wants to connect to the Capricorn test net for example, you would need to run the following steps:
 
 ```bash
 # init
-fetchd init my-first-fetch-node --chain-id stargateworld-3
+fetchd init my-first-fetch-node --chain-id capricorn-1
 
 # genesis
-curl https://rpc-stargateworld.fetch.ai/genesis | jq '.result.genesis' > ~/.fetchd/config/genesis.json
+curl https://rpc-capricorn.fetch.ai:443 | jq '.result.genesis' > ~/.fetchd/config/genesis.json
 
 # start
-fetchd start --p2p.seeds=0831c7f4cb4b12fe02b35cc682c7edb03f6df36c@connect-stargateworld.t-v2-london-c.fetch-ai.com:36656
+fetchd start --p2p.seeds=fec822ecf6e503a694a709ce663fd0c6da5fda3e@connect-capricorn.fetch.ai:36956
 ```
 
 Your local node will then start to synchronise itself with the network, replaying all blocks and transactions up to the current block. Depending on the age of the network and your hard disk speed, this could take a while. 

diff --git a/docs/docs/networks.md b/docs/docs/networks.md
@@ -7,6 +7,8 @@ The chain identifier of our production network is fetchhub-3.
 | Parameter      | Value                                                                                      |
 | -------------- | ------------------------------------------------------------------------------------------ |
 | Chain ID       | fetchhub-3                                                                                 |
+| Block range    | 4,504,601 -->                                                                              |
+| Date range     | 08/02/2022 -->                                                                   |
 | Denomination   | afet                                                                                       |
 | Decimals       | 18 (1fet = 1000000000000000000afet)                                                        |
 | Version        | [v0.9.x (fetchcli >= v0.9.0)](https://github.com/fetchai/fetchd/tree/release/v0.9.x)       |
@@ -17,6 +19,44 @@ The chain identifier of our production network is fetchhub-3.
 | Token Faucet   | N/A                                                                                        |
 | Seed Node(s)   | 5f3fa6404a67b664be07d0e133a00c1600967396@connect-fetchhub.fetch.ai:36756                   |
 
+## Mainnet Archives
+
+Archived data for previous mainnet versions.
+
+### Fetchhub-2 archive
+
+| Parameter      | Value                                                                                      |
+| -------------- | ------------------------------------------------------------------------------------------ |
+| Chain ID       | fetchhub-2                                                                                 |
+| Block range    | 2,436,701 --> 4,504,600                                                                    |
+| Date range     | 15/09/2021 --> 08/02/2022                                                                  |
+| Denomination   | afet                                                                                       |
+| Decimals       | 18 (1fet = 1000000000000000000afet)                                                        |
+| Version        | [v0.8.7](https://github.com/fetchai/fetchd/tree/v0.8.7)                                    |
+| RPC Endpoint   | <https://rpc-fetchhub2-archive.fetch.ai:443>                                               |
+| GRPC Endpoint  | <https://grpc-fetchhub2-archive.fetch.ai:443>                                              |
+| REST Endpoint  | <https://rest-fetchhub2-archive.fetch.ai:443>                                              |
+| Block Explorer | [https://explore-fetchhub2-archive.fetch.ai](https://explore-fetchhub2-archive.fetch.ai)   |
+| Token Faucet   | N/A                                                                                        |
+| Seed Node(s)   | N/A                                                                                        |
+
+### Fetchhub-1 archive
+
+| Parameter      | Value                                                                                      |
+| -------------- | ------------------------------------------------------------------------------------------ |
+| Chain ID       | fetchhub-1                                                                                 |
+| Block range    | 1 --> 2,436,700                                                                            |
+| Date range     | 31/03/2021 --> 15/09/2021                                                                  |
+| Denomination   | afet                                                                                       |
+| Decimals       | 18 (1fet = 1000000000000000000afet)                                                        |
+| Version        | [v0.7.4](https://github.com/fetchai/fetchd/tree/v0.7.4)                                    |
+| RPC Endpoint   | <https://rpc-fetchhub1-archive.fetch.ai:443>                                               |
+| GRPC Endpoint  | N/A                                                                                        |
+| REST Endpoint  | <https://rest-fetchhub1-archive.fetch.ai:443>                                              |
+| Block Explorer | [https://explore-fetchhub1-archive.fetch.ai](https://explore-fetchhub1-archive.fetch.ai)   |
+| Token Faucet   | N/A                                                                                        |
+| Seed Node(s)   | N/A                                                                                        |
+
 ## Test Nets
 
 ### Capricorn

diff --git a/docs/docs/validators/setup.md b/docs/docs/validators/setup.md
@@ -19,7 +19,7 @@ fetchd tx staking create-validator \
   --from=<key_name>
 ```
 
-** Stargateworld Example **
+** Capricorn Example **
 
 Before trying to create a validator you should verify that you have some tokens available beforehand. The easiest way to do this is via the [CLI](../../cli-tokens/).
 
@@ -30,7 +30,7 @@ fetchd tx staking create-validator \
   --amount=1000000000000000000atestfet \
   --pubkey=$(fetchd tendermint show-validator) \
   --moniker="my-test-validator" \
-  --chain-id=stargateworld-3 \
+  --chain-id=capricorn-1 \
   --commission-rate="0.10" \
   --commission-max-rate="0.20" \
   --commission-max-change-rate="0.01" \

diff --git a/docs/firebase.json b/docs/firebase.json
@@ -0,0 +1,10 @@
+{
+  "hosting": {
+    "public": "site",
+    "ignore": [
+      "firebase.json",
+      "**/.*",
+      "**/node_modules/**"
+    ]
+  }
+}