Skip to content

Commit

Permalink
docs(wasm): mention genesis customization possibilities (#105)
Browse files Browse the repository at this point in the history
  • Loading branch information
julienrbrt authored Jun 18, 2024
1 parent 2403871 commit 9588a9c
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 39 deletions.
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,28 +47,28 @@ ignite scaffold app <name> && cd <name>
ignite app install -g $(pwd)
```

### **Contribution Prerequisites**
### Contribution Prerequisites

- Familiarity with Git and GitHub.
- Understanding of the project's technology stack and goals.

## **Community**
## Community

- Join the community conversations on [Discord](https://discord.com/invite/ignite) or [X/Twitter](https://twitter.com/ignite).
- Follow the project's progress and updates.

## **Pull Request Process**
## Pull Request Process*

- Update the README.md or documentation with details of changes to the interface, if applicable.
- Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent.
- The pull request will be merged once it's reviewed and approved by the maintainers.

## **License**

**TODO**
See [LICENSE](LICENSE) for more information.

## **Questions?**
## Questions?

If you have any questions about contributing, please feel free to contact us.

Thank you for your interest in contributing to Ignite Apps!
Thank you for your interest in contributing to Ignite Apps!
2 changes: 1 addition & 1 deletion rollkit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This Ignite App is aimed to extend [Ignite CLI](https://github.com/ignite/cli) a
```sh
ignite s chain gm --address-prefix gm --minimal
cd gm
ignite app install -g github.com/ignite/apps/rollkit@rollkit/v0.2.0
ignite app install -g github.com/ignite/apps/rollkit@rollkit
ignite rollkit add
ignite chain build
ignite rollkit init
Expand Down
9 changes: 6 additions & 3 deletions tools/debug/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ go run tools/debug/main.go <COMMAND>
```

e.g:

```shell
go run tools/debug/main.go explorer <ARGS>
```
Expand All @@ -20,15 +21,17 @@ go run tools/debug/main.go hermes <ARGS>
## Developer instruction

- Replace the app repo for a local folder into the `tools/debug/go.mod`.

```go.mod
replace (
github.com/ignite/apps/explorer => ../../explorer
github.com/ignite/apps/hermes => ../../hermes
github.com/ignite/apps/<MY-APP> => ../../<MY-APP>
github.com/ignite/apps/explorer => ../../explorer
github.com/ignite/apps/hermes => ../../hermes
github.com/ignite/apps/<MY-APP> => ../../<MY-APP>
)
```

- Add the command to be debugged.

```go
rootCmd.AddCommand(
explorer.NewExplorer(),
Expand Down
48 changes: 19 additions & 29 deletions wasm/README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,28 @@
# **Wasm**
# Wasm

Wasm is an Ignite App developed to extend the [Ignite CLI](https://github.com/ignite/cli), enabling developers to integrate CosmWasm smart contracts into their blockchain projects with ease. This app adds commands for adding and configuring CosmWasm support within your chain.

The app adds `ignite wasm` commands to add a [CosmWasm](https://cosmwasm.com/) integration into a chain.

## **Features**
## Features

- Easily add CosmWasm integration to your blockchain.
- Streamline the process of configuring Wasm for your chain.
- Develop and test CosmWasm smart contracts in your Ignite CLI project.

## **Prerequisites**
## Prerequisites

- Ignite CLI version v28.3.0 or greater.
- Or migrate your chain using the [Ignite migration guides](https://docs.ignite.com/migration).
- Ignite CLI version v28.3.0 or greater.
- Or migrate your chain using the [Ignite migration guides](https://docs.ignite.com/migration).
- Knowledge of blockchain development and smart contracts.

## **Installation**

- Install the Wasm app:
## Installation

```shell
ignite app install -g github.com/ignite/apps/wasm
```

- You must scaffold a new chain with version `v28.2.1` or greater.
## Usage

- Navigate to your chain's directory and execute the following command to add Wasm support:

Expand All @@ -40,27 +38,19 @@ ignite wasm config

Remember, all commands should be executed within your chain directory.

## **Developer instruction**
## Configuration

To contribute to the Wasm app or use a local version, follow these steps:
In order to configure CosmWasm as permissioned in your chain, you can add the following configuration to your chain's `config.yaml` file:

```shell
git clone github.com/ignite/apps && cd apps/wasm
```yaml
genesis:
app_state:
wasm:
params:
code_upload_access:
addresses: []
permission: "Nobody"
instantiate_default_permission: "Nobody"
```
Add the app to the global config:

```shell
ignite app add -g /absolute/path/to/app/wasm # or use $(pwd)
```

The `ignite wasm` command is now available with the local version of the app.

1. **Develop and Test:**
- Make changes to the app code as needed.
- Run **`ignite wasm`** to recompile the app and test your changes.

## **Support and Contributions**

For support and contributions, please visit the [Wasm App GitHub repository](https://github.com/ignite/apps/wasm).
We welcome contributions from the community, including bug reports, feature requests, and code contributions.
Read [CosmosWasm docs](https://github.com/CosmWasm/wasmd/blob/21b048d54e395ff9168e5c3037356a73797500ba/x/wasm/Governance.md?plain=1#L27-L48) for more information on the `code_upload_access` configuration.

0 comments on commit 9588a9c

Please sign in to comment.