Skip to content

Commit

Permalink
Merge pull request #5 from anoma/brent/cleanup
Browse files Browse the repository at this point in the history
Cleanup
  • Loading branch information
Fraccaman authored Jul 26, 2024
2 parents ff725db + c15d852 commit 1c3a2d7
Showing 1 changed file with 15 additions and 13 deletions.
28 changes: 15 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
# Namada Mainnet Governance Proposals

Namada mainnet launch is divided into [5 phases](https://namada.net/mainnet-launch). Going though each phase require a governance proposal to active some features. This repository contains the WASM to associate with each governance proposal.
Namada mainnet launch is divided into [5 phases](https://namada.net/mainnet-launch). Progressing from one phase to the next requires a governance proposal to active some features. This repository contains the WASM associated with each governance proposal.

> 🔧 The parameters values are still being decided. 🔧
> 🔧 NOTE: The current parameter values are temporary and still to be determined. 🔧
## Block party -> Staking party
## Block party -> Staking party (Phase 1 -> 2)

Staking rewards are enabled for delegators and validators staking NAM. Public Goods Funding is enabled to support public goods in the Namada ecosystem and beyond. Phase 3 will begin when governance votes to enable transfers and shielding of IBC assets.
Staking rewards are enabled for delegators and validators staking NAM. Public Goods Funding is enabled to support public goods in the Namada ecosystem and beyond.

The reference code can be found in [block_party folder](./block_party/).

## Staking party -> Shielding party
## Staking party -> Shielding party (Phase 2 -> 3)

Transparent and shielded transfers of governance-enabled IBC assets are live. Users can begin shielding assets in the unified shielded set. NAM transfers remain locked until phase 5. Phase 4 will begin when governance votes to enable shielding rewards.
Transparent and shielded transfers of governance-enabled IBC assets are enabled. Users can begin shielding assets in the unified shielded set. NAM transfers remain locked until phase 5 (NAM party).

The reference code can be found in [staking_party folder](./staking_party/).

## Shielding party -> Shielding Reward party
## Shielding party -> Shielding Reward party (Phase 3 -> 4)

Shielding rewards for governance-enabled IBC assets are live. Users begin collecting rewards for shielding assets, which protects their data and helps strengthen Namada’s unified shielded set. Phase 5 will begin when governance votes to enable NAM transfers.
Shielding rewards for governance-enabled IBC assets are enabled. Users begin collecting rewards for shielding assets, which protects their data and helps strengthen Namada’s unified shielded set.

The reference code can be found in [shielding_party folder](./shielding_party/).

## Shielding Reward party -> NAM Party
## Shielding Reward party -> NAM Party (Phase 4 -> 5)

When the Namada community is confident that the network is stable, NAM transfers are enabled. All key protocol functionality is now live. From here on, new features and support for new assets can continue to be added by the community via on-chain governance.

Expand All @@ -31,17 +31,19 @@ The reference code can be found in [shielding_reward_party folder](./shielding_r
# How to build
To generate the wasm artifacts that can be attached to the governance proposal, run:
```
earhtly +build
earthly +build
```

This will create a folder called `artifacts` that contains the WASMs.

You can install `earthly` following the official guide [here](https://earthly.dev/get-earthly).

# How to generate a proposal
Use the python script `build_proposal.py` inside the build directory to build any of the 5 phases proposals:
Use the python script `build_proposal.py` inside the build directory to build any of the four proposals that progress to the next phase:
```
python3 builder/build_proposal.py -d <parameters_path_> -o <output_path>
python3 builder/build_proposal.py -d $PARAMETERS_PATH -o $OUTPUT_PATH
```
To build the phase1 to phase2 proposal:
The `$PARAMETERS_PATH` is a json file that contains some parameters and values needed to properly construct a proposal. For example, to build the phase1 to phase2 proposal:
```
python3 builder/build_proposal.py -d builder/parameters/block-party.json -o proposal.json
```

0 comments on commit 1c3a2d7

Please sign in to comment.