Skip to content

Commit

Permalink
Merge pull request #190 from galacticcouncil/main
Browse files Browse the repository at this point in the history
Rebrand
  • Loading branch information
jak-pan authored Jun 5, 2024
2 parents 81ac7f4 + a2091dc commit d328bf8
Show file tree
Hide file tree
Showing 166 changed files with 252 additions and 7,905 deletions.
96 changes: 41 additions & 55 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -1,65 +1,51 @@
name: docs
name: Deploy to GitHub Pages

on:
pull_request:
branches: [main]
push:
branches: [main]
branches:
- main
# Review gh actions docs if you want to further define triggers, paths, etc
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on

jobs:
checks:
if: github.event_name != 'push'
build:
name: Build Docusaurus
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
- uses: actions/checkout@v4
with:
node-version: '19.x'
- name: Test Build
run: |
if [ -e yarn.lock ]; then
npm install yarn -g
yarn install --frozen-lockfile
elif [ -e package-lock.json ]; then
npm ci
else
npm i
fi
npm run build
gh-release:
if: github.event_name != 'pull_request'
fetch-depth: 0
- uses: actions/setup-node@v4
with:
node-version: 18
cache: yarn

- name: Install dependencies
run: yarn install --frozen-lockfile
- name: Build website
run: yarn build

- name: Upload Build Artifact
uses: actions/upload-pages-artifact@v3
with:
path: build

deploy:
name: Deploy to GitHub Pages
needs: build

# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source

# Deploy to the github-pages environment
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: '19.x'
- name: Add key to allow access to repository
env:
SSH_AUTH_SOCK: /tmp/ssh_agent.sock
run: |
mkdir -p ~/.ssh
ssh-keyscan github.com >> ~/.ssh/known_hosts
echo "${{ secrets.GH_PAGES_DEPLOY }}" > ~/.ssh/id_rsa
chmod 600 ~/.ssh/id_rsa
cat <<EOT >> ~/.ssh/config
Host github.com
HostName github.com
IdentityFile ~/.ssh/id_rsa
EOT
- name: Release to GitHub Pages
env:
USE_SSH: true
GIT_USER: git
run: |
git config --global user.email "[email protected]"
git config --global user.name "gh-actions"
if [ -e yarn.lock ]; then
npm install yarn -g
yarn install --frozen-lockfile
elif [ -e package-lock.json ]; then
npm ci
else
npm i
fi
npx docusaurus deploy
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# HydraDX-docs
# Hydration-docs

## Installation

Expand Down
8 changes: 4 additions & 4 deletions docs/bonds.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ title: Bonds

import useBaseUrl from '@docusaurus/useBaseUrl';

The HydraDX Protocol uses **Bonds** as part of its strategy to **grow and diversify its Protocol-owned liquidity (POL)**. For this purpose, the HydraDX Governance can at any time decide to **issue a given amount of bonds** which will be traded against assets that the HydraDX Treasury wishes to accumulate.
The Hydration Protocol uses **Bonds** as part of its strategy to **grow and diversify its Protocol-owned liquidity (POL)**. For this purpose, the Hydration Governance can at any time decide to **issue a given amount of bonds** which will be traded against assets that the Hydration Treasury wishes to accumulate.

All HDX bonds have a **maturity date**, which marks the moment when the bond can be **swapped against the underlying asset (HDX)**. The HydraDX Protocol can decide the manner in which bonds are sold: For example, it can host a **dynamically priced LBP event**, or simply place an **OTC order against a fixed price**. Once acquired, bonds are **transferrable and tradeable on the secondary market** (e.g. OTC), also before they have reached maturity.
All HDX bonds have a **maturity date**, which marks the moment when the bond can be **swapped against the underlying asset (HDX)**. The Hydration Protocol can decide the manner in which bonds are sold: For example, it can host a **dynamically priced LBP event**, or simply place an **OTC order against a fixed price**. Once acquired, bonds are **transferrable and tradeable on the secondary market** (e.g. OTC), also before they have reached maturity.

On this page you will find more info about bonds, including the process of a bonds campaign. For step-by-step guidance on how to participate in a bonds LBP, please visit [this guide](/howto_bonds_lbp).

Expand All @@ -17,9 +17,9 @@ The concept of bonds was first pioneered by OlympusDAO in 2021 as a tool which w

## The Process of a Bonds Campaign

The first step of a Bonds campaign is the issuance of the bonds by the Protocol. Any member of the HydraDX Community can initiate a governance discussion and a referendum to issue a given amount of bonds with a predefined maturity date, in order to obtain a given asset as POL.
The first step of a Bonds campaign is the issuance of the bonds by the Protocol. Any member of the Hydration Community can initiate a governance discussion and a referendum to issue a given amount of bonds with a predefined maturity date, in order to obtain a given asset as POL.

Once bonds are issued, the HydraDX Governance must decide on the method of trade. One option is to host a dedicated LBP event, which limited in time and allows for dynamic pricing thanks to the interplay between time-based weights shifting and demand (more info in our [LBP docs](/lbp)). Another option is for the Protocol to place an OTC order against a predefined price per bond.
Once bonds are issued, the Hydration Governance must decide on the method of trade. One option is to host a dedicated LBP event, which limited in time and allows for dynamic pricing thanks to the interplay between time-based weights shifting and demand (more info in our [LBP docs](/lbp)). Another option is for the Protocol to place an OTC order against a predefined price per bond.

<div style={{textAlign: 'center'}}>
<img alt="metadata" src={useBaseUrl('/bonds/bonds-screen.jpg')} width="800px" />
Expand Down
10 changes: 5 additions & 5 deletions docs/bridge_from_ethereum.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ import useBaseUrl from '@docusaurus/useBaseUrl';

Bridging assets from the Ethereum ecosystem is easy using the [Wormhole](https://wormhole.com/) bridge which is implemented by the [Moonbeam network](https://moonbeam.network/).

When bridging an asset, Wormhole will lock it on the source network and mint an equivalent amount of Wormhole-wrapped assets on the Moonbeam network. The assets are then transferred to the HydraDX chain where they can be used for trading. In a few clicks and seamlessly.
When bridging an asset, Wormhole will lock it on the source network and mint an equivalent amount of Wormhole-wrapped assets on the Moonbeam network. The assets are then transferred to the Hydration chain where they can be used for trading. In a few clicks and seamlessly.

To bridge assets from Ethereum to HydraDX, follow the steps below.
To bridge assets from Ethereum to Hydration, follow the steps below.

### Prerequisites

Expand All @@ -19,14 +19,14 @@ To bridge assets from Ethereum to HydraDX, follow the steps below.

### Step-by-step
1. Navigate to the [Carrier UI](https://www.carrier.so/)
2. As Destination, select `HydraDX`
2. As Destination, select `Hydration`
3. Connect your Ethereum wallet
4. Connect your HydraDX wallet
4. Connect your Hydration wallet
5. Select the asset you wish to bridge and the amount
6. Click on `Settings` and turn on `Auto Relay`
7. Confirm and sign the transaction

Once finalized, the assets will appear in your HydraDX wallet.
Once finalized, the assets will appear in your Hydration wallet.

<div style={{textAlign: 'center'}}>
<img alt="metadata" src={useBaseUrl('/howto_bridge/mb3.jpg')} width="600px" />
Expand Down
6 changes: 3 additions & 3 deletions docs/build_dev_chain.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ title: Set up a Development Chain

import useBaseUrl from '@docusaurus/useBaseUrl';

This section runs you through the process of setting up a local HydraDX chain instance for development.
This section runs you through the process of setting up a local Hydration chain instance for development.

## 01 Install dependencies {#01-install-dependencies}

To prepare a local HydraDX chain instance for development, your machine needs to cover all dependencies for running a Substrate chain. You will need to install a Rust developer environment and make sure that it is configured properly for compiling Substrate runtime code to the WebAssembly (Wasm) target.
To prepare a local Hydration chain instance for development, your machine needs to cover all dependencies for running a Substrate chain. You will need to install a Rust developer environment and make sure that it is configured properly for compiling Substrate runtime code to the WebAssembly (Wasm) target.

You can install and configure all dependencies manually following the [Substrate guide](https://substrate.dev/docs/en/knowledgebase/getting-started), or you could let this script do all the work for you:

Expand Down Expand Up @@ -52,7 +52,7 @@ $ RUST_LOG=debug RUST_BACKTRACE=1 ./target/release/hydra-dx -lruntime=debug --de

## 04 Connect to your local chain instance {#04-connect-to-your-local-chain-instance}

You can connect to your HydraDX development node using Polkadot/apps and changing network to `Development`. You can also use this link:
You can connect to your Hydration development node using Polkadot/apps and changing network to `Development`. You can also use this link:
https://polkadot.js.org/apps/?rpc=ws%3A%2F%2F127.0.0.1%3A9944#/explorer

<img alt="connect to node" src={useBaseUrl('/building/connect-to-node.jpg')} />
16 changes: 8 additions & 8 deletions docs/claim.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ If your xHDX tokens are stored in Coinbase Wallet or Trust Wallet, you will need

## Claim process {#claim-process}

After making sure that you have fulfilled the prerequisites described above, you can navigate to the [HydraDX Claim app](https://claim.hydradx.io) and proceed with the claim process.
After making sure that you have fulfilled the prerequisites described above, you can navigate to the [Hydration Claim app](https://claim.hydradx.io) and proceed with the claim process.

During the claim process, you will use your xHDX tokens (ERC-20) to claim your share of HDX tokens.

### 00 Authorize {#00-authorize}

The HydraDX Claim app will request authorization from the Polkadot.js browser extension.
The Hydration Claim app will request authorization from the Polkadot.js browser extension.

:::warning

Expand All @@ -33,7 +33,7 @@ Make sure that you are not the victim of a phishing attack and pay attention to

<img alt="authorize" src={useBaseUrl('/claim/authorize.jpg')} />

After authorizing, you will be prompted to update the metadata for the Polkadot.js browser extension. This will allow Polkadot.js to create HydraDX-specific addresses which are required to complete the claim process.
After authorizing, you will be prompted to update the metadata for the Polkadot.js browser extension. This will allow Polkadot.js to create Hydration-specific addresses which are required to complete the claim process.

<img alt="authorize" src={useBaseUrl('/claim/metadata.jpg')} />

Expand All @@ -55,7 +55,7 @@ You are not eligible for a gas refund if you have obtained your xHDX at some oth

In the second step, you will be asked to select your HDX address.

To create a new HDX address, open the Polkadot.js browser extension and click on the + sign to create a new account. In the first step of account creation, you will see the 12-word mnemonic phrase which can be used to recover your account. After saving your seed phrase in a secure place, click on *Next step*. Here, you should change the **Network** by selecting the option **HydraDX Snakenet**. Enter a name and password for your account, and finish the account creation.
To create a new HDX address, open the Polkadot.js browser extension and click on the + sign to create a new account. In the first step of account creation, you will see the 12-word mnemonic phrase which can be used to recover your account. After saving your seed phrase in a secure place, click on *Next step*. Here, you should change the **Network** by selecting the option **Hydration**. Enter a name and password for your account, and finish the account creation.

<img alt="authorize" src={useBaseUrl('/claim/create-account.png')} />

Expand All @@ -65,13 +65,13 @@ Make sure that you back up your recovery seed phrase by storing it in a safe pla

:::

After creating your HDX account, you should be able to select it in the HydraDX Claim app. After doing so, the app should provide you with an overview of the ETH and HDX addresses used for the claim process. Click on next to proceed to signing the message.
After creating your HDX account, you should be able to select it in the Claim app. After doing so, the app should provide you with an overview of the ETH and HDX addresses used for the claim process. Click on next to proceed to signing the message.

<img alt="authorize" src={useBaseUrl('/claim/claim-02.jpg')} />

### 03 Sign {#03-sign}

In the third step of the claim process using the HydraDX Claim app, you will be provided with the option to sign the message for using your xHDX tokens to claim HDX.
In the third step of the claim process using the Claim app, you will be provided with the option to sign the message for using your xHDX tokens to claim HDX.

:::note

Expand All @@ -83,7 +83,7 @@ Depending on the choice you have made in the first step, you have two options to

* If you are using **Metamask**, after clicking the *Sign* button you will be prompted by Metamask to sign the message. Follow the instructions in Metamask.

* If you have entered your ETH address manually, you will need to sign the message through the external wallet that holds the private keys of your xHDX tokens. Once you have signed the message, copy the signature (starting with *0x*) to the respective field in the HydraDX Claim app.
* If you have entered your ETH address manually, you will need to sign the message through the external wallet that holds the private keys of your xHDX tokens. Once you have signed the message, copy the signature (starting with *0x*) to the respective field in the Claim app.

<img alt="authorize" src={useBaseUrl('/claim/claim-03.jpg')} />

Expand All @@ -95,4 +95,4 @@ After signing the message with the wallet holding your xHDX tokens, the Polkadot

You have now completed the claim process, thereby officially becoming an HDX owner!

You can check your balance using Polkadot/apps connected to the HydraDX network: https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Frpc.hydradx.cloud#/accounts
You can check your balance using Polkadot/apps connected to the Hydration network: https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Frpc.hydradx.cloud#/accounts
8 changes: 4 additions & 4 deletions docs/collator_setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ title: Set up a Collator Node

import useBaseUrl from '@docusaurus/useBaseUrl';

This is a step-by-step how-to so you can get your HydraDX collator up and running. In this guide, we use Ubuntu 20.04 LTS.
This is a step-by-step how-to so you can get your Hydration collator up and running. In this guide, we use Ubuntu 20.04 LTS.

## Required technical specifications {#technical-specifications}

The following technical specifications are required as a minimum for running a HydraDX collator node:
The following technical specifications are required as a minimum for running a Hydration collator node:

* OS: Ubuntu 20.04
* CPU: Intel Core i7-7700K @ 4.5Ghz (or equivalent single core performance)
Expand Down Expand Up @@ -85,7 +85,7 @@ chown hydra:hydra /var/lib/hydradx
Make sure you have enough volume for your `base-path` by using `df -h` command.
:::

Note that `--prometheus-external` is optional, but we highly recommend it so you can be able to export prometheus metrics and monitor your node's health through Grafana. For more details about monitoring, please visit [this link](https://docs.hydradx.io/node_monitoring/).
Note that `--prometheus-external` is optional, but we highly recommend it so you can be able to export prometheus metrics and monitor your node's health through Grafana. For more details about monitoring, please visit [this link](https://docs.hydration.net/node_monitoring/).

If you need to monitor both the `parachain` and `relaychain` metrics, `--prometheus-external`option should be setup in both parts. You also need to set a separate port for the relaychain part as follows: `--prometheus-port YOUR_CUSTOM_PORT_NUMBER`

Expand Down Expand Up @@ -122,7 +122,7 @@ Once done, you will have an output similar to:

## Set your session key

To associate the generated session keys with your Controller account, navigate to the following menu item in the [Polkadot/apps](https://polkadot.js.org/apps/?rpc=wss%253A%252F%252Frpc.hydradx.cloud#/extrinsics) on the Polkadot parachain HydraDX: *Developer* > *Extrinsics*.
To associate the generated session keys with your Controller account, navigate to the following menu item in the [Polkadot/apps](https://polkadot.js.org/apps/?rpc=wss%253A%252F%252Frpc.hydradx.cloud#/extrinsics) on the Polkadot parachain Hydration: *Developer* > *Extrinsics*.

Fill in the fields:

Expand Down
2 changes: 1 addition & 1 deletion docs/create_account.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ To create a new HDX address, open the Polkadot.js browser extension and click on

You will be displayed a 12-word mnemonic phrase which can be used to recover your account. Make sure that you backup your seed phrase in a secure location. Click on `Next step` and fill in the following information:

* **Network**: Please select `HydraDX Snakenet`
* **Network**: Please select `Hydration`
* **Descriptive name of the account**
* **Password**

Expand Down
Loading

0 comments on commit d328bf8

Please sign in to comment.