Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dymensionxyz/dymension
Dymension Hub
https://github.com/dymensionxyz/dymension
blockchain cosmos-sdk dymension hub settlement-layer
Last synced: 2 months ago
JSON representation
Dymension Hub
- Host: GitHub
- URL: https://github.com/dymensionxyz/dymension
- Owner: dymensionxyz
- License: other
- Created: 2022-07-10T11:10:17.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T11:41:20.000Z (2 months ago)
- Last Synced: 2024-10-29T11:43:26.086Z (2 months ago)
- Topics: blockchain, cosmos-sdk, dymension, hub, settlement-layer
- Language: Go
- Homepage: https://dymension.xyz
- Size: 33.4 MB
- Stars: 366
- Watchers: 17
- Forks: 340
- Open Issues: 100
-
Metadata Files:
- Readme: readme.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-ccamel - dymensionxyz/dymension - Dymension Hub (Go)
README
# Dymension Hub
## Overview
Welcome to the Dymension Hub, the **Settlement Layer of the Dymension protocol**.
This guide will walk you through the steps required to set up and run a Dymension Hub full node.
## Table of Contents
- [Dymension Hub](#dymension-hub)
- [Overview](#overview)
- [Table of Contents](#table-of-contents)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Initializing `dymd`](#initializing-dymd)
- [Running the Chain](#running-the-chain)
- [Bootstrapping liquidity pools](#bootstrapping-liquidity-pools)
- [Adding incentives](#adding-incentives)
- [Creating incentives streams](#creating-incentives-streams)
- [Locking tokens](#locking-tokens)
- [check rewards](#check-rewards)
- [Debugging Container](#debugging-container)
- [Developer](#developer)
- [Setup push hooks](#setup-push-hooks)
## Prerequisites
- [Go (v1.18 or above)](https://go.dev/doc/install)
## Installation
Clone `dymension`:
```sh
git clone https://github.com/dymensionxyz/dymension.git
cd dymension
make install
```
Check that the dymd binaries have been successfully installed:
```sh
dymd version
```
If the dymd command is not found an error message is returned,
confirm that your [GOPATH](https://go.dev/doc/gopath_code#GOPATH) is correctly configured by running the following command:
```sh
export PATH=$PATH:$(go env GOPATH)/bin
```
## Initializing `dymd`
- Using the setup script:
This method is preferred as it is preconfigured to support [running rollapps locally](https://github.com/dymensionxyz/roller)
```sh
bash scripts/setup_local.sh
```
- Manually:
First, set the following environment variables:
```sh
export CHAIN_ID="dymension_100-1"
export KEY_NAME="hub-user"
export MONIKER_NAME="local"
```
Second, create genesis and init dymension chain:
```sh
dymd init "$MONIKER_NAME" --chain-id "$CHAIN_ID"
```
Third, set parameters to ensure denom is udym:
```sh
bash scripts/set_params.sh
```
Then, add genesis account and provide token to the account:
```sh
dymd keys add "$KEY_NAME" --keyring-backend test
dymd add-genesis-account "$(dymd keys show "$KEY_NAME" -a --keyring-backend test)" 1000dym
dymd gentx "$KEY_NAME" 670dym --chain-id "$CHAIN_ID" --keyring-backend test
dymd collect-gentxs
```
## Running the Chain
Now start the chain!
```sh
dymd start
```
You should have a running local node!
## Bootstrapping liquidity pools
To bootstrap the `GAMM` module with pools:
```sh
sh scripts/pools/pools_bootstrap.sh
```
## Adding incentives
### Creating incentives streams
After creating the pools above, we create 3 incentive streams through gov:
```sh
sh scripts/incentives/fund_incentives.sh
```
Wait for the gov proposal to pass, and validate with:
```sh
dymd q streamer streams
```
The last stream is community-driven and governed by `x/sponsorship`.
### Locking tokens
To get incentives, we need to lock the LP tokens:
```sh
sh scripts/incentives/lockup_bootstrap.sh
```
validate with:
```sh
dymd q lockup module-balance
```
### Checking rewards
Every minute a share of the rewards will be distributed!
validate with:
```sh
dymd q incentives active-gauges
# alternatively, watch the output - you will see the "amount" change every minute
# watch -n1 -d "dymd q incentives active-gauges --output json | jq '.data[] | { "id": .id, "coins": .coins } '"
```
### Updating a community-driven distribution
The following script casts two votes for a community-driven distribution.
```sh
sh scripts/incentives/sponsorship_vote.sh
```
This will change the corresponding stream distribution at the end of the current epoch.
```sh
dymd q streamer streams
```
The community-driven distribution may be queried with:
```sh
dymd q sponsorship distribution
```
## Debugging Container
Pre-requisite:
Install [Docker](https://docs.docker.com/get-docker/)
Install [VSCode](https://code.visualstudio.com/)
Install [VSCode Go extension](https://marketplace.visualstudio.com/items?itemName=golang.go)
Install [Delve](https://github.com/go-delve/delve)
To debug, you can use the following command to run the debug container:
```sh
make docker-run-debug
```
Then you can run the debugger with the following config for `launch.json` in VSCode:
```json
{
"version": "0.2.0",
"configurations": [
{
"name": "Dymension Debug Container",
"type": "go",
"request": "attach",
"mode": "remote",
"port": 4000,
"host": "127.0.0.1",
"debugAdapter": "legacy" // To be removed in the future after https://github.com/golang/vscode-go/issues/3096 is fixed
}
]
}
```
After that, you can run the debugger and set breakpoints in the code.
Example:
Add breakpoint to `ctx` in `x/eibc/keeper/grpc_query.go` :
```go
func (q Querier) Params(goCtx context.Context, req *types.QueryParamsRequest) (*types.QueryParamsResponse, error) {
if req == nil {
return nil, status.Error(codes.InvalidArgument, "invalid request")
}
ctx := sdk.UnwrapSDKContext(goCtx)
return &types.QueryParamsResponse{Params: q.GetParams(ctx)}, nil
}
```
Open your browser and go to `http://localhost:1318/dymensionxyz/dymension/eibc/params` and you will see debugger stop and print the value at the breakpoint.
## Developer
For support, join our [Discord](http://discord.gg/dymension) community and find us in the Developer section. See [Contribution guidelines](./Contributing.md).
### Setup push hooks
To setup push hooks, run the following command:
```sh
./scripts/setup_push_hooks.sh
```