Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add modified readme to wasm App #62

Merged
merged 1 commit into from
Feb 27, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 44 additions & 15 deletions wasm/README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,66 @@
# Wasm
# **Wasm**

`wasm` is an app developed for [Ignite CLI](https://github.com/ignite/cli).
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.

## How to use
## **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**

- Ignite CLI version v28.2.1 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:

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

- You must scaffold a new chain with version `v28.2.1` or greater. Or migrate your chain using the [Ignite migration guides](https://docs.ignite.com/migration).
- You must scaffold a new chain with version `v28.2.1` or greater.

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

- Now you can add a Wasm support to your chain by running this command into the chain directory:
```shell
ignite wasm add
```

- The command will automatically add the Wasm integration into your code and the Wasm config into your chain config. But if your chain is not initiated yet, the chain config does not exist, so you need to add the Wasm config later running:
This command integrates Wasm into your chain's code and configuration. If your chain configuration does not exist yet (for non-initiated chains), you'll need to add the Wasm configuration manually:

```shell
ignite wasm add
ignite wasm config
```

_All commands should be run in the chain directory._
Remember, all commands should be executed within your chain directory.

## **Developer instruction**

To contribute to the Wasm app or use a local version, follow these steps:

```shell
git clone github.com/ignite/apps && cd apps/wasm
```

Add the app to the global config:

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

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

- clone this repo locally
- Run `ignite app add -g /absolute/path/to/app/wasm` to add the app to global config
- `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.

Then repeat the following loop:
## **Support and Contributions**

- Hack on the app code
- Rerun `ignite wasm` to recompile the app and test
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.
Loading