From 3713ded3b07023500e2bd31de150d0a14ebb39e8 Mon Sep 17 00:00:00 2001 From: Shady Khalifa Date: Wed, 10 Jan 2024 12:48:12 +0200 Subject: [PATCH 1/3] Update README and remove outdated links --- README.md | 54 +++++++++++++++++++++++++----------------------------- 1 file changed, 25 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 1dfd8bd58..2df6be485 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@

The Tangle Network

- An MPC based governance system for cross-chain zero-knowledge applications. + An MPC-as-a-service blockchain infrastructure for empowering cross-chain and zero-knowledge applications development.

@@ -27,8 +27,8 @@
  • Getting Started
  • Prerequisites
  • Installation using Nix
    • -
  • Run Standalone Testnet
    • -
  • Running Standalone Node with Webb Relayer
    • +
  • Run Tangle Testnet
    • +
  • Troubleshooting
  • Contributing
  • License
    • @@ -36,12 +36,13 @@

    Getting Started

    -The Tangle Network contains runtimes for standalone node featuring Webb's DKG and privacy pallet protocols.If you would like to familiarize yourself with Tangle and DKG protocol check out following repo and docs: +Tangle, Built on Substrate, Tangle Network empowers privacy-enhancing and governance-decentralized applications, incorporating cross-chain functionality, EVM compatibility, advanced governance systems, and ZK applications into a unified ecosystem. -- [Dkg Substrate Protocol](https://github.com/webb-tools/dkg-substrate) -- [Tangle Docs](https://docs.webb.tools/docs/tangle-network/overview/) -- [Tangle Website](https://tangle.webb.tools/) +If you would like to familiarize yourself with Tangle Network check out following repo and docs: +- [Webb Gadgets](https://github.com/webb-tools/gadgets) +- [Tangle Docs](https://docs.webb.tools/docs/tangle-network/overview/) +- [Tangle Website](https://tangle.webb.tools/)

    Prerequisites

    @@ -55,6 +56,7 @@ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh # Configure source ~/.cargo/env ``` + Great! Now your Rust environment is ready! **Note:** You may need additional dependencies, checkout [substrate.io](https://docs.substrate.io/v3/getting-started/installation) for more information. @@ -67,29 +69,34 @@ If you want to use Nix for development, please follow following instructions 3. If you have [`direnv`](https://github.com/nix-community/nix-direnv#installation) installed, everything should work out of the box. 4. Alternatively, you can run `nix flake develop` in the root of this repo to get a shell with all the dependencies installed. - -

    Run Standalone Local Testnet

    +

    Run Tangle Testnet

    1. Build `tangle` node. + ```bash - cargo build --release + cargo build --release ``` -2. Execute tangle network setup script. + +2. Execute tangle network setup script to run it locally. + ```bash ./scripts/run-standalone-local.sh --clean ``` -This should start the local testnet, you can view the logs in /tmp directory for all the authorities and use [polkadotJS](https://polkadot.js.org/apps/#/explorer) to view the running testnet. +This should start the local testnet, you can view the logs in /tmp directory for all the authorities and use [polkadotJS](https://polkadot.js.org/apps/#/explorer) to view the running testnet. -

    Run Standalone Node with Webb Relayer

    +3. To Start validating on the live testnet please visit [Starting a validator on Tangle docs](https://docs.tangle.tools/docs/node/validator/requirements). -Tangle standalone node ships with [Webb Relayer](https://github.com/webb-tools/relayer) in the node itself, which is useful to run them together. -For instructions on how to run Tangle Standalone Node with Webb Relayer, Please refer to [this document](./RELAYER.md). +

    Troubleshooting

    -

    Run Standalone Node with Light Client

    +The linking phase may fail due to not finding libgmp (i.e., "could not find library -lgmp") when building on a mac M1. To fix this problem, run: -Tangle standalone node ships with [Webb Light Client](https://github.com/webb-tools/pallet-eth2-light-client) in the node itself, which is useful to run them together. -For instructions on how to run Tangle Standalone Node with Webb Light Client, Please refer to [this document](./light-client-configs/LIGHT-CLIENT.md). +```bash +brew install gmp +# make sure to run the commands below each time when starting a new env, or, append them to .zshrc +export LIBRARY_PATH=$LIBRARY_PATH:/opt/homebrew/lib +export INCLUDE_PATH=$INCLUDE_PATH:/opt/homebrew/include +```

    Contributing

    @@ -102,14 +109,3 @@ If you have a contribution in mind, please check out our [Contribution Guide](./ Licensed under GNU General Public License v3.0. Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the GNU General Public License v3.0 license, shall be licensed as above, without any additional terms or conditions. - -## Troubleshooting -The linking phase may fail due to not finding libgmp (i.e., "could not find library -lgmp") when building on a mac M1. To fix this problem, run: - -```bash -brew install gmp -# make sure to run the commands below each time when starting a new env, or, append them to .zshrc -export LIBRARY_PATH=$LIBRARY_PATH:/opt/homebrew/lib -export INCLUDE_PATH=$INCLUDE_PATH:/opt/homebrew/include -``` - From 50eca43eaf66d35f444c037b6712a0a866ece9f9 Mon Sep 17 00:00:00 2001 From: Shady Khalifa Date: Wed, 10 Jan 2024 12:51:18 +0200 Subject: [PATCH 2/3] Update links --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2df6be485..349353655 100644 --- a/README.md +++ b/README.md @@ -41,8 +41,8 @@ Tangle, Built on Substrate, Tangle Network empowers privacy-enhancing and govern If you would like to familiarize yourself with Tangle Network check out following repo and docs: - [Webb Gadgets](https://github.com/webb-tools/gadgets) -- [Tangle Docs](https://docs.webb.tools/docs/tangle-network/overview/) -- [Tangle Website](https://tangle.webb.tools/) +- [Tangle Docs](https://docs.tangle.tools/docs) +- [Tangle Website](https://tangle.tools/)

    Prerequisites

    From f7411b3c68a636d59ef3e7b51f4fc956a388c3bf Mon Sep 17 00:00:00 2001 From: shekohex Date: Wed, 10 Jan 2024 10:58:39 +0000 Subject: [PATCH 3/3] Update README.md Co-authored-by: 1xstj <106580853+1xstj@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 349353655..6aab016e4 100644 --- a/README.md +++ b/README.md @@ -74,7 +74,7 @@ If you want to use Nix for development, please follow following instructions 1. Build `tangle` node. ```bash - cargo build --release + cargo build --release --features testnet ``` 2. Execute tangle network setup script to run it locally.