CROSS-CHAIN LIQUIDITY PROTOCOL BUILT ON SUBSTRATE

Please follow the contributions guidelines as outlined in docs/CONTRIBUTING.md. We are welcoming and friendly community please follow our Code of Conduct.

Follow these steps to prepare a local Substrate development environment 🛠️

Install all the required dependencies with a single command (be patient, this can take up to 30 minutes).

curl https://getsubstrate.io -sSf | bash -s -- --fast

Find manual setup instructions at the Substrate Developer Hub.

Once the development environment is set up, build the node. This command will build the Wasm and native code:

cargo build --release

Relay chain repository (polkadot) has to be built in ../polkadot Install polkadot-launch utility used to start network.

npm install -g polkadot-launch

Start local testnet with 4 relay chain validators and HydraDX as a parachain with 2 collators.

cd ./rococo-local
polkadot-launch config.json

Observe HydraDX logs

multitail 99*.log

Relay chain repository (polkadot) has to be built in ../polkadot Grab zombienet utility used to start network from releases

Start local testnet with 4 relay chain validators and HydraDX as a parachain with 2 collators.

cd ./rococo-local
zombienet --provider native config-zombienet.json

In the case of starting a testnet using the polkadot-launch tool, we don't have an option to communicate to its internal commands that we would like to use the testing runtime. To overcome this limitation, rename the binary so it starts with the testing prefix, e.g. testing-hydradx. Such a binary always uses the testing runtime, even if the --runtime testing option is not specified.

Start local testnet with testing runtime

cd ./rococo-local
polkadot-launch testing-config.json

Start local testnet with testing runtime using Zombienet

cd ./rococo-local
zombienet --provider native testing-config-zombienet.json

Go to the polkadot apps at https://dotapps.io

Then open settings screen -> developer and paste

NOTE - FixedU128 type is not yet implemented for polkadot apps. Balance is a measure so price can be reasonably selected. If using polkadot apps to create pool:

• 1 Mega Units equals 1:1 price
• 20 Mega Units equals 20:1 price
• 50 Kilo Units equals 0.05:1 price

{
  "types": [
    {
      "AssetPair": {
        "asset_in": "AssetId",
        "asset_out": "AssetId"
      },
      "Amount": "i128",
      "AmountOf": "Amount",
      "Address": "AccountId",
      "OrmlAccountData": {
        "free": "Balance",
        "frozen": "Balance",
        "reserved": "Balance"
      },
      "BlockNumber": "u32",
      "BalanceInfo": {
        "amount": "Balance",
        "assetId": "AssetId"
      },
      "Chain": {
        "genesisHash": "Vec<u8>",
        "lastBlockHash": "Vec<u8>"
      },
      "CurrencyId": "AssetId",
      "CurrencyIdOf": "AssetId",
      "Intention": {
        "who": "AccountId",
        "asset_sell": "AssetId",
        "asset_buy": "AssetId",
        "amount": "Balance",
        "discount": "bool",
        "sell_or_buy": "IntentionType"
      },
      "IntentionId": "Hash",
      "IntentionType": {
        "_enum": [
          "SELL",
          "BUY"
        ]
      },
      "LookupSource": "AccountId",
      "OrderedSet": "Vec<AssetId>",
      "Price": "Balance",
      "Fee": {
        "numerator": "u32",
        "denominator": "u32"
      },
      "VestingScheduleOf": {
        "start": "BlockNumber",
        "period": "BlockNumber",
        "period_count": "u32",
        "per_period": "Balance"
      }
    }
  ],
  "alias": {
    "tokens": {
      "AccountData": "OrmlAccountData"
    }
  }
}

Connect to the

• Hacknet: wss://hack.hydradx.io:9944
• Stakenet: wss://rpc-01.snakenet.hydradx.io
• or local node – if you are on chromium based browser, set chrome://flags/#allow-insecure-localhost

Prerequisites: rust/cargo, python 3.8+

With the following script it is possible to run a simple performance check. It might be useful to determine whether your machine is suitable to run HydraDX node.

From the top-level node directory:

./scripts/check_performance.sh

This will run series of benchmarks ( which may take a while). The output will show benchmark results of HydraDX pallets and comparison against reference values.

The most interesting information would be the difference between the HydraDx benchmark value and the local machine's benchmark.

If the difference is >= 0, performance is similar or better. However, if the difference < 0 - your machine might not suitable to run HydraDX node. Contact HydraDX devs to discuss the results.

The try-runtime tool can be used to test storage migrations and runtime upgrades against state from a real chain. Run the following command to test against the state on HydraDX

cargo run --release --features=try-runtime try-runtime --no-spec-name-check on-runtime-upgrade live --uri wss://rpc.hydradx.cloud:443

or against HydraDX testnet on Rococo

cargo run --release --features=try-runtime try-runtime --no-spec-name-check on-runtime-upgrade live --uri wss://rococo-hydradx-rpc.hydration.dev:443

@apopiak for great reviews #87 and support.