├── .github
├── dependabro.yml
└── workflows
│ ├── build.yml
│ ├── check-docs.yml
│ ├── deploy-docs.yml
│ ├── integration.yml
│ ├── lint.yml
│ └── unit-test.yml
├── .gitignore
├── .golangci.yml
├── CHANGELOG.md
├── LICENSE
├── Makefile
├── README.md
├── cmd
├── constants.go
└── root_cmd.go
├── docs
├── .eslintrc.js
├── .gitignore
├── README.md
├── babel.config.js
├── components.json
├── docs
│ ├── 00-intro.md
│ ├── 01-setup-env.md
│ ├── 02-example-repo.md
│ ├── 03-scaffold-suite.md
│ ├── 04-add-contracts.md
│ ├── 05-custom-tests.md
│ └── images
│ │ └── scaffold-prompt.png
├── docusaurus.config.ts
├── package-lock.json
├── package.json
├── sidebars.ts
├── src
│ ├── components
│ │ ├── HighlightBox.tsx
│ │ ├── HighlightTag.tsx
│ │ ├── HomepageFeatures
│ │ │ ├── index.tsx
│ │ │ └── styles.module.css
│ │ └── ui
│ │ │ └── hover-card.tsx
│ ├── css
│ │ ├── custom.css
│ │ └── globals.css
│ ├── lib
│ │ └── utils.ts
│ ├── pages
│ │ ├── index.module.css
│ │ ├── index.tsx
│ │ └── markdown-page.md
│ └── theme
│ │ └── CodeBlock
│ │ └── index.tsx
├── static
│ ├── .nojekyll
│ └── img
│ │ ├── cosmwasm-logo.svg
│ │ ├── cw-ica-controller.svg
│ │ ├── easy_deploy.svg
│ │ ├── focus.svg
│ │ ├── ibc-logo-black.svg
│ │ ├── icons
│ │ ├── hi-coffee-icon.svg
│ │ ├── hi-info-icon.svg
│ │ ├── hi-note-icon.svg
│ │ ├── hi-prerequisite-icon.svg
│ │ ├── hi-reading-icon.svg
│ │ ├── hi-star-icon.svg
│ │ ├── hi-target-icon.svg
│ │ ├── hi-tip-icon.svg
│ │ └── hi-warn-icon.svg
│ │ ├── logo.svg
│ │ ├── universal_support.svg
│ │ └── white-ibc-logo.svg
├── tailwind.config.js
└── tsconfig.json
├── go-codegen.svg
├── go.mod
├── go.sum
├── integration_test
├── go.mod
├── go.sum
├── integration_test.go
├── testdata
│ ├── account-nft.json
│ ├── axone-objectarium.json
│ ├── cw-ica-controller.json
│ ├── cw2981-royalties.json
│ ├── cw3-fixed-multisig.json
│ ├── cw4-group.json
│ ├── cw721-base.json
│ ├── cyberpunk.json
│ ├── dao-dao-core.json
│ ├── hackatom.json
│ ├── ics721.json
│ └── map-test.json
└── tools.go
├── main.go
├── pkg
├── codegen
│ ├── codegen.go
│ ├── codegentests
│ │ ├── cwics721_test.go
│ │ └── tuple_test.go
│ ├── definitions.go
│ ├── execute.go
│ ├── instantiate.go
│ ├── oneof.go
│ ├── properties.go
│ ├── querier.go
│ └── responses.go
├── go
│ ├── cmd
│ │ └── gocmd.go
│ └── module
│ │ └── gomodule.go
├── interchaintest
│ ├── codegen.go
│ ├── files.go
│ └── generators.go
├── schemas
│ ├── cosmwasm.go
│ ├── schema.go
│ ├── testdata
│ │ └── cw-ica-controller.json
│ └── types.go
├── types
│ ├── logger.go
│ └── version.go
└── xgenny
│ ├── cp.go
│ ├── plush.go
│ ├── randstr.go
│ └── runner.go
└── templates
└── interchaintestv8
├── chainconfig
├── embed.go
├── files
│ └── chainconfig
│ │ ├── chain_config.go.plush
│ │ ├── encoding.go.plush
│ │ └── genesis.go.plush
├── options.go
└── utils.go
├── e2esuite
├── embed.go
├── files
│ └── e2esuite
│ │ ├── constants.go.plush
│ │ ├── diagnostics.go.plush
│ │ ├── grpc_query.go.plush
│ │ ├── suite.go.plush
│ │ └── utils.go.plush
├── options.go
└── utils.go
├── embed.go
├── files
├── .gitignore.plush
├── .golangci.yml.plush
├── README.md.plush
├── basic_test.go.plush
├── contract_test.go.plush
├── go.mod.plush
└── go.sum.plush
├── github
├── embed.go
├── files
│ └── e2e.yml.plush
└── options.go
├── options.go
├── placeholders.go
├── testvalues
├── embed.go
├── files
│ └── testvalues
│ │ └── values.go.plush
└── options.go
└── types
├── embed.go
├── files
└── types
│ ├── contract.go.plush
│ └── {{contractName}}
│ └── contract.go.plush
├── options.go
└── placeholders.go
/.github/dependabro.yml:
--------------------------------------------------------------------------------
1 | version: 2
2 | updates:
3 | - package-ecosystem: "gomod"
4 | directory: "/"
5 | schedule:
6 | interval: "daily"
7 |
--------------------------------------------------------------------------------
/.github/workflows/build.yml:
--------------------------------------------------------------------------------
1 | name: build
2 | on:
3 | push:
4 | branches: [main]
5 | pull_request:
6 | paths:
7 | - '**.go'
8 | - '.github/workflows/build.yml'
9 | permissions:
10 | contents: read
11 | jobs:
12 | build:
13 | name: Build
14 | runs-on: ubuntu-latest
15 | steps:
16 | - uses: actions/setup-go@v4
17 | with:
18 | go-version: "1.21"
19 | - uses: actions/checkout@v4
20 | - name: Build
21 | run: make build
22 |
--------------------------------------------------------------------------------
/.github/workflows/check-docs.yml:
--------------------------------------------------------------------------------
1 | # This check-docs workflow was created based on instructions from:
2 | # https://docusaurus.io/docs/deployment
3 | name: Check docs build
4 | # This workflow runs when a PR is labeled with `docs`
5 | # This will check if the docs build successfully by running `npm run build`
6 | on:
7 | pull_request:
8 | branches:
9 | - main
10 | paths:
11 | - 'docs/**'
12 | - '.github/workflows/check-docs.yml'
13 |
14 | jobs:
15 | check-docs-build:
16 | name: Check docs build
17 | runs-on: ubuntu-latest
18 | steps:
19 | - uses: actions/checkout@v4
20 | - uses: actions/setup-node@v4
21 | with:
22 | node-version: 18
23 | cache: npm
24 | cache-dependency-path: docs/package-lock.json
25 |
26 | - name: Install dependencies
27 | run: cd docs && npm ci
28 | - name: Test build website
29 | run: cd docs && npm run build
30 |
--------------------------------------------------------------------------------
/.github/workflows/deploy-docs.yml:
--------------------------------------------------------------------------------
1 | # This deploy-docs workflow was created based on instructions from:
2 | # https://docusaurus.io/docs/deployment
3 | name: Deploy to GitHub Pages
4 |
5 | on:
6 | push:
7 | branches:
8 | - main
9 | # Review gh actions docs if you want to further define triggers, paths, etc
10 | # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
11 |
12 | permissions:
13 | contents: write
14 |
15 | jobs:
16 | deploy:
17 | name: Deploy to GitHub Pages
18 | runs-on: ubuntu-latest
19 | steps:
20 | - uses: actions/checkout@v4
21 | with:
22 | fetch-depth: 0
23 | - uses: actions/setup-node@v4
24 | with:
25 | node-version: 18
26 | cache: npm
27 | cache-dependency-path: docs/package-lock.json
28 |
29 | - name: Install dependencies
30 | run: cd docs && npm ci
31 | - name: Build website
32 | run: cd docs && npm run build
33 |
34 | # Popular action to deploy to GitHub Pages:
35 | # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
36 | - name: Deploy to GitHub Pages
37 | uses: peaceiris/actions-gh-pages@v3
38 | with:
39 | github_token: ${{ secrets.GITHUB_TOKEN }}
40 | # Build output to publish to the `gh-pages` branch:
41 | publish_dir: ./docs/build
42 | # The following lines assign commit authorship to the official
43 | # GH-Actions bot for deploys to `gh-pages` branch:
44 | # https://github.com/actions/checkout/issues/13#issuecomment-724415212
45 | # The GH actions bot is used by default if you didn't specify the two fields.
46 | # You can swap them out with your own user credentials.
47 | user_name: github-actions[bot]
48 | user_email: 41898282+github-actions[bot]@users.noreply.github.com
49 |
--------------------------------------------------------------------------------
/.github/workflows/integration.yml:
--------------------------------------------------------------------------------
1 | name: integration-tests
2 | on:
3 | push:
4 | branches: [main]
5 | pull_request:
6 | paths:
7 | - '**.go'
8 | - '.github/workflows/integration.yml'
9 | - '**.plush'
10 | permissions:
11 | contents: read
12 | jobs:
13 | test:
14 | strategy:
15 | fail-fast: false
16 | matrix:
17 | test:
18 | # List your tests here
19 | - TestWithMySuite/TestMessageComposer
20 | - TestWithMySuite/TestQueryClient
21 | - TestWithMySuite/TestInterchaintestScaffold
22 | name: ${{ matrix.test }}
23 | runs-on: ubuntu-latest
24 | steps:
25 | - uses: actions/setup-go@v4
26 | with:
27 | go-version: "1.21"
28 | - uses: actions/checkout@v4
29 | - name: golangci-lint
30 | uses: golangci/golangci-lint-action@v3.7.0
31 | with:
32 | version: v1.54
33 | args: --timeout 5m
34 | working-directory: integration_test
35 | - name: Build
36 | run: make build
37 | - name: Run Tests
38 | run: |
39 | cd integration_test
40 | go test -v -mod=readonly . -run=${{ matrix.test }}
41 |
--------------------------------------------------------------------------------
/.github/workflows/lint.yml:
--------------------------------------------------------------------------------
1 | name: lint
2 | on:
3 | push:
4 | branches: [main]
5 | pull_request:
6 | paths:
7 | - '**.go'
8 | - '.github/workflows/lint.yml'
9 | permissions:
10 | contents: read
11 | jobs:
12 | golangci:
13 | name: golangci-lint
14 | runs-on: ubuntu-latest
15 | steps:
16 | - uses: actions/setup-go@v4
17 | with:
18 | go-version: "1.21"
19 | - uses: actions/checkout@v4
20 | - name: golangci-lint
21 | uses: golangci/golangci-lint-action@v3.7.0
22 | with:
23 | version: v1.54
24 | args: --timeout 5m
25 |
--------------------------------------------------------------------------------
/.github/workflows/unit-test.yml:
--------------------------------------------------------------------------------
1 | name: unit-test
2 | on:
3 | push:
4 | branches: [main]
5 | pull_request:
6 | paths:
7 | - '**.go'
8 | - '.github/workflows/unit-test.yml'
9 | permissions:
10 | contents: read
11 | jobs:
12 | test:
13 | name: Unit Test go-codegen
14 | runs-on: ubuntu-latest
15 | steps:
16 | - uses: actions/setup-go@v4
17 | with:
18 | go-version: "1.21"
19 | - uses: actions/checkout@v4
20 | - name: Unit Test go-codegen
21 | run: make unit-test
22 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Ignore build directory
2 | build/
3 |
--------------------------------------------------------------------------------
/.golangci.yml:
--------------------------------------------------------------------------------
1 | run:
2 | tests: true
3 | timeout: 10m
4 |
5 | linters:
6 | disable-all: true
7 | enable:
8 | - exportloopref
9 | - errcheck
10 | - gci
11 | - goconst
12 | - gocritic
13 | - gofumpt
14 | - gosec
15 | - gosimple
16 | - govet
17 | - ineffassign
18 | - misspell
19 | - nakedret
20 | - staticcheck
21 | - thelper
22 | - typecheck
23 | - stylecheck
24 | - revive
25 | - tenv
26 | - unconvert
27 | # Prefer unparam over revive's unused param. It is more thorough in its checking.
28 | - unparam
29 | - unused
30 | - misspell
31 |
32 | issues:
33 | exclude-rules:
34 | - text: 'differs only by capitalization to method'
35 | linters:
36 | - revive
37 | - text: 'Use of weak random number generator'
38 | linters:
39 | - gosec
40 | - linters:
41 | - staticcheck
42 | text: "SA1019:" # silence errors on usage of deprecated funcs
43 |
44 | max-issues-per-linter: 10000
45 | max-same-issues: 10000
46 |
47 | linters-settings:
48 | gci:
49 | sections:
50 | - standard # Standard section: captures all standard packages.
51 | - default # Default section: contains all imports that could not be matched to another section type.
52 | - blank # blank imports
53 | - dot # dot imports
54 | - prefix(github.com/srdtrk/go-codegen)
55 | custom-order: true
56 | revive:
57 | enable-all-rules: true
58 | # Do NOT whine about the following, full explanation found in:
59 | # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#description-of-available-rules
60 | rules:
61 | - name: use-any
62 | disabled: true
63 | - name: if-return
64 | disabled: true
65 | - name: max-public-structs
66 | disabled: true
67 | - name: cognitive-complexity
68 | disabled: true
69 | - name: argument-limit
70 | disabled: true
71 | - name: cyclomatic
72 | disabled: true
73 | - name: file-header
74 | disabled: true
75 | - name: function-length
76 | disabled: true
77 | - name: function-result-limit
78 | disabled: true
79 | - name: line-length-limit
80 | disabled: true
81 | - name: flag-parameter
82 | disabled: true
83 | - name: add-constant
84 | disabled: true
85 | - name: empty-lines
86 | disabled: true
87 | - name: banned-characters
88 | disabled: true
89 | - name: deep-exit
90 | disabled: true
91 | - name: confusing-results
92 | disabled: true
93 | - name: unused-parameter
94 | disabled: true
95 | - name: modifies-value-receiver
96 | disabled: true
97 | - name: early-return
98 | disabled: true
99 | - name: confusing-naming
100 | disabled: true
101 | - name: defer
102 | disabled: true
103 | # Disabled in favour of unparam.
104 | - name: unused-parameter
105 | disabled: true
106 | - name: unhandled-error
107 | disabled: false
108 | arguments:
109 | - 'fmt.Printf'
110 | - 'fmt.Print'
111 | - 'fmt.Println'
112 | - 'myFunction'
113 |
--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | # Changelog
2 |
3 | ## [Unreleased]
4 |
5 | ## v0.2.5 (2024-06-22)
6 |
7 | - Removed `GetModuleAddress` helper function from the generated test suite [#88](https://github.com/srdtrk/go-codegen/issues/88)
8 | - Fixed diagnostics upload in the generated test suite [#91](https://github.com/srdtrk/go-codegen/issues/91)
9 | - Depracated `--contract-name` flag to `--package-name` and `-p` in `interchaintest add-contract` command [#81](https://github.com/srdtrk/go-codegen/issues/81)
10 | - Fixed the generation of oneOf when a title is set [#92](https://github.com/srdtrk/go-codegen/pull/92)
11 |
12 | ## v0.2.4 (2024-06-07)
13 |
14 | - Fixed the geenration of some incorrectly formated query responses [#79](https://github.com/srdtrk/go-codegen/pull/79)
15 | - Allow `MigrateMsg` to be an enum [#79](https://github.com/srdtrk/go-codegen/pull/79)
16 | - Bumped go and golangci-lint versions in the autogenerated github actions. [#65](https://github.com/srdtrk/go-codegen/issues/65) and [#68](https://github.com/srdtrk/go-codegen/issues/68)
17 | - Fixed unnecessary override of `contract_test.go`. [#66](https://github.com/srdtrk/go-codegen/issues/66)
18 | - Fixed the use of incorrect package name in `contract_test.go`. [#82](https://github.com/srdtrk/go-codegen/issues/82)
19 |
20 | ## v0.2.3 (2024-06-05)
21 |
22 | - Removed custom gas from StoreCode in auto-generated test suite [#67](https://github.com/srdtrk/go-codegen/issues/67)
23 | - Allow migrate messages to be enums. [#74](https://github.com/srdtrk/go-codegen/pull/74)
24 | - Fixed a problem with generating messages in `dao-dao-core`. [#75](https://github.com/srdtrk/go-codegen/issues/75)
25 |
26 | ## v0.2.2 (2024-05-20)
27 |
28 | - Fixed issue [#61](https://github.com/srdtrk/go-codegen/issues/61)
29 | - Added the testvalues package to the generated test suite [#60](https://github.com/srdtrk/go-codegen/issues/60)
30 |
31 | ## v0.2.1 (2024-05-19)
32 |
33 | - Fixed issue [#56](https://github.com/srdtrk/go-codegen/issues/56)
34 | - Updated the `interchaintest` library to the latest version (v8.3.0) [#53](https://github.com/srdtrk/go-codegen/issues/53)
35 |
36 | ## v0.2.0 (2024-05-17)
37 |
38 | - Added support for generating a gRPC query client [#14](https://github.com/srdtrk/go-codegen/issues/14)
39 | - Added support for generating an [`interchaintest`](https://github.com/strangelove-ventures/interchaintest) based test suite [#45](https://github.com/srdtrk/go-codegen/issues/45).
40 | - Various API breaking changes on the CLI commands and go packages.
41 |
42 | ## v0.1.3 (2024-04-22)
43 |
44 | - Fixed issue [#30](https://github.com/srdtrk/go-codegen/issues/30)
45 |
46 | ## v0.1.2 (2024-04-19)
47 |
48 | - Fixed issue [#26](https://github.com/srdtrk/go-codegen/issues/26)
49 |
50 | ## v0.1.1 (2024-02-14)
51 |
52 | - Added LICENSE file
53 | - Added a `version` command to the CLI
54 |
55 | ## v0.1.0 (2024-02-14)
56 |
57 | Initial release
58 |
--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
1 | # Makefile for building go-codegen
2 |
3 | # Target directory for the build output
4 | BUILD_DIR := build
5 |
6 | .PHONY: build
7 |
8 | build:
9 | @echo "Building go-codegen..."
10 | @go build -o $(BUILD_DIR)/go-codegen main.go
11 | @echo "Build complete!"
12 |
13 | .PHONY: unit-test
14 |
15 | unit-test:
16 | @echo "Running unit tests..."
17 | @go test -v -mod=readonly ./...
18 | @echo "Unit tests complete!"
19 |
20 | .PHONY: integration-tests
21 |
22 | integration-tests:
23 | @echo "Running integration tests..."
24 | @cd integration_test && go test -v -mod=readonly -run=TestWithMySuite/TestMessageComposer
25 | @cd integration_test && go test -v -mod=readonly -run=TestWithMySuite/TestInterchaintestScaffold
26 | @echo "Integration tests complete!"
27 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # go-codegen
2 |
3 | Generate Go code for your CosmWasm smart contracts.
4 |
5 |
6 | 
7 |
8 |
9 |
10 |
11 | [](https://github.com/srdtrk/go-codegen/tree/main/integration_test)
12 | [](https://github.com/srdtrk/go-codegen/releases/latest)
13 | [](https://github.com/srdtrk/go-codegen/blob/main/LICENSE)
14 | [](https://github.com/srdtrk/go-codegen)
15 |
16 |
17 | ```
18 | go install github.com/srdtrk/go-codegen@latest
19 | ```
20 |
21 | The quickest way to generate Go code for your CosmWasm smart contracts. Currently, this tool supports generating:
22 |
23 | - Message types
24 | - A gRPC query client
25 | - An [`interchaintest`](https://github.com/strangelove-ventures/interchaintest) based test suite
26 |
27 | **You can find a tutorial on how to use this tool's interchaintest feature [here](https://srdtrk.github.io/go-codegen/).**
28 |
29 | ## Usage
30 |
31 | In order to generate Go code for your CosmWasm smart contract, you need to have its full API exported as a JSON file
32 | using [`cosmwasm-schema`](https://crates.io/crates/cosmwasm-schema).
33 | Once you have the JSON file, you can use it to generate the Go code.
34 |
35 | Note that you can learn more about how to use this tool by running `go-codegen help` or `-h` flag with any command.
36 |
37 | ### Generate messages
38 |
39 | ```sh
40 | go-codegen generate messages /path/to/contract-api.json --output /path/to/output.go --package-name mypackage
41 | ```
42 |
43 | This will generate the Go code in the specified optional output directory, if not specified, it will generate the code in `msgs.go` in the current directory.
44 | Package name is also optional, if not specified, it will use the name of the contract.
45 |
46 | ### Generate gRPC query client
47 |
48 | ```sh
49 | go-codegen generate query-client /path/to/contract-api.json -o /path/to/output.go -p mypackage
50 | ```
51 |
52 | This will generate the Go code in the specified optional output directory, if not specified, it will generate the code in `query.go` in the current directory. Package name is also optional, if not specified, it will use the name of the contract. The generated code depends on the generated messages, the [wasmd package](https://pkg.go.dev/github.com/CosmWasm/wasmd), and the [grpc package](https://pkg.go.dev/google.golang.org/grpc). You can install them by running `go get github.com/CosmWasm/wasmd@latest` (or `go get github.com/CosmWasm/wasmd@v0.50.0` for a specific version) and `go get google.golang.org/grpc@latest` (or `go get google.golang.org/grpc@v1.63.3` for a specific version).
53 |
54 | ### Generate interchaintest test suite
55 |
56 | ```sh
57 | go-codegen interchaintest scaffold
58 | ```
59 |
60 | This will launch an interactive prompt to guide you through the process of generating the test suite.
61 | The scaffolded test suite will include a basic test and instructions on how to run it. This test suite will not contain any contract specific code, or tests, you will need to add them using `add-contract` command.
62 |
63 | ### Adding a contract to the interchaintest test suite
64 |
65 | ```sh
66 | go-codegen interchaintest add-contract /path/to/contract-api.json --suite-dir /path/to/suite
67 | ```
68 |
69 | This will add a contract to the test suite. The suite directory is the directory where the test suite is located. If not specified, it will use the current directory. The contract API JSON file is the same file that was used to generate the messages and query client.
70 |
71 | Note that you can find a tutorial on how to use this tool's interchaintest feature [here](https://srdtrk.github.io/go-codegen/).
72 |
73 | ## Acknowledgements
74 |
75 | The Go Gopher mascot was created by [Renee French](https://reneefrench.blogspot.com/) and is licensed under the [Creative Commons 4.0 Attribution License](https://creativecommons.org/licenses/by/4.0/).
76 | I've modified the original image to include the logo of [`ts-codegen`](https://github.com/CosmWasm/ts-codegen).
77 |
--------------------------------------------------------------------------------
/cmd/constants.go:
--------------------------------------------------------------------------------
1 | package cmd
2 |
3 | const (
4 | OutputFlag = "output"
5 | PackageNameFlag = "package-name"
6 |
7 | YesFlag = "yes"
8 | SuiteDirFlag = "suite-dir"
9 | ContractNameFlag = "contract-name"
10 | MessagesOnlyFlag = "messages-only"
11 |
12 | DebugFlag = "debug"
13 | )
14 |
--------------------------------------------------------------------------------
/docs/.eslintrc.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | "env": {
3 | "browser": true,
4 | "es2021": true
5 | },
6 | "extends": [
7 | "eslint:recommended",
8 | "plugin:@typescript-eslint/recommended",
9 | "plugin:react/recommended"
10 | ],
11 | "overrides": [
12 | {
13 | "env": {
14 | "node": true
15 | },
16 | "files": [
17 | ".eslintrc.{js,cjs}"
18 | ],
19 | "parserOptions": {
20 | "sourceType": "script"
21 | }
22 | }
23 | ],
24 | "parser": "@typescript-eslint/parser",
25 | "parserOptions": {
26 | "ecmaVersion": "latest",
27 | "sourceType": "module"
28 | },
29 | "plugins": [
30 | "@typescript-eslint",
31 | "react"
32 | ],
33 | "rules": {
34 | "react/prop-types": "off"
35 | }
36 | }
37 |
--------------------------------------------------------------------------------
/docs/.gitignore:
--------------------------------------------------------------------------------
1 | # Dependencies
2 | /node_modules
3 |
4 | # Production
5 | /build
6 |
7 | # Generated files
8 | .docusaurus
9 | .cache-loader
10 |
11 | # Misc
12 | .DS_Store
13 | .env.local
14 | .env.development.local
15 | .env.test.local
16 | .env.production.local
17 |
18 | npm-debug.log*
19 | yarn-debug.log*
20 | yarn-error.log*
21 |
--------------------------------------------------------------------------------
/docs/README.md:
--------------------------------------------------------------------------------
1 | # Website
2 |
3 | This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
4 |
5 | ### Installation
6 |
7 | ```
8 | $ npm i
9 | ```
10 |
11 | ### Local Development
12 |
13 | ```
14 | $ npm start
15 | ```
16 |
17 | This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
18 |
19 | ### Build
20 |
21 | ```
22 | $ npm run build
23 | ```
24 |
25 | This command generates static content into the `build` directory and can be served using any static contents hosting service.
26 |
--------------------------------------------------------------------------------
/docs/babel.config.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
3 | };
4 |
--------------------------------------------------------------------------------
/docs/components.json:
--------------------------------------------------------------------------------
1 | {
2 | "$schema": "https://ui.shadcn.com/schema.json",
3 | "style": "default",
4 | "rsc": false,
5 | "tsx": true,
6 | "tailwind": {
7 | "config": "tailwind.config.js",
8 | "css": "src/css/globals.css",
9 | "baseColor": "slate",
10 | "cssVariables": true,
11 | "prefix": ""
12 | },
13 | "aliases": {
14 | "components": "@/components",
15 | "utils": "@/lib/utils"
16 | }
17 | }
18 |
--------------------------------------------------------------------------------
/docs/docs/00-intro.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Introduction
3 | sidebar_label: Introduction
4 | sidebar_position: 0
5 | slug: /
6 | ---
7 |
8 | import HighlightTag from '@site/src/components/HighlightTag';
9 | import HighlightBox from '@site/src/components/HighlightBox';
10 |
11 | # `go-codegen` Interchaintest Tutorial
12 |
13 |
14 |
15 | This is a tutorial for writing end-to-end test suite for IBC enabled CosmWasm applications using go-codegen.
16 | Powered by [interchaintest](https://github.com/strangelove-ventures/interchaintest).
17 |
18 |
19 |
20 | - Basic knowledge of [golang](https://go.dev/)
21 | - Basic knowledge of [CosmWasm](https://cosmwasm.com/)
22 | - Basic knowledge of [github actions](https://github.com/features/actions)
23 |
24 |
25 |
26 | ## Context
27 |
28 | ### What is go-codegen?
29 |
30 | go-codegen is a tool that generates go code for CosmWasm applications. It can currently generate the following:
31 |
32 | - Message definitions for a contract.
33 | - gRPC query client for a contract.
34 | - An end-to-end test suite for a contract based on interchaintest.
35 |
36 |
37 |
38 | `interchaintest` is a framework for testing blockchain functionality and interoperability between chains, primarily with the Inter-Blockchain Communication (IBC) protocol.
39 |
40 | It can quickly spin up custom testnets and dev environments to test IBC, Relayer setup, chain infrastructure, smart contracts, etc. Interchaintest orchestrates Go tests that utilize Docker containers for multiple IBC-compatible blockchains.
41 |
42 | In order to ship production-grade software for the Interchain, we needed sophisticated developer tooling...but IBC and Web3 have a lot of moving parts, which can lead to a steep learning curve and all sorts of pain.
43 |
44 | - repeatedly building repo-specific, Docker- and shell-based testing solutions,
45 | - duplication of effort, and
46 | - difficulty in repurposing existing testing harnesses for new problem domains.
47 |
48 | Read more about interchaintest in its [README.md](https://github.com/strangelove-ventures/interchaintest/blob/main/README.md).
49 |
50 |
51 |
52 | ### Why use this over other scripting solutions?
53 |
54 | - **Go as a Scripting Language**
55 | - **Local Testing Environment:** The testing framework operates entirely locally, mirroring a production environment closely. This ensures that tests are reliable and can be seamlessly integrated into continuous integration (CI) pipelines.
56 | - **Industry Adoption:** Interchaintest, the underlying framework, is widely adopted by leading projects and core teams in the CosmWasm ecosystem, including Strangelove, the IBC team, Noble, DAODAO, and others.
57 | - **Funding and Support:** The development of Interchaintest is supported by the Interchain Foundation (ICF), ensuring ongoing improvements and stability.
58 |
59 | By using go-codegen, your CosmWasm application can benefit from a well-supported, reliable, widely-adopted testing framework.
60 |
61 | ## Scope
62 |
63 | This tutorial will cover spinning up a local testing environment with interchaintest. We will be testing [cw-ica-controller](https://github.com/srdtrk/cw-ica-controller) to control a native interchain account in the host chain.
64 |
65 |
66 |
67 | In this tutorial, you will:
68 |
69 | - Compile a CosmWasm contract into wasm and generate its JSON schema
70 | - Scaffold an end-to-end testsuite with github actions consisting of two chains using go-codegen.
71 | - Add our contract to the testsuite using go-codegen.
72 | - Create a transfer channel between the two chains.
73 | - Create an IBC channel between the contract and the counterparty go module.
74 | - Send an ICA transaction and verify it.
75 |
76 |
77 |
--------------------------------------------------------------------------------
/docs/docs/01-setup-env.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Set Up Your Work Environment
3 | sidebar_label: Set Up Your Work Environment
4 | sidebar_position: 1
5 | slug: /setup-env
6 | ---
7 |
8 | import HighlightBox from '@site/src/components/HighlightBox';
9 |
10 | # Set Up Your Work Environment
11 |
12 | On this page, you can find helpful links to set up your work environment.
13 |
14 |
15 |
16 | In this section, you can find all you need to install:
17 |
18 | - [Git](https://git-scm.com/)
19 | - [Go v1.22.3](https://go.dev/)
20 | - [go-codegen v0.2.2](https://github.com/srdtrk/go-codegen)
21 | - [Docker](https://www.docker.com/)
22 | - [Rust and Cargo](https://www.rust-lang.org/)
23 | - [just](https://just.systems/) (optional)
24 |
25 |
26 |
27 |
28 |
29 | On a general note, it is advisable to prepare a separate project folder to keep all your Cosmos exercises.
30 |
31 |
32 |
33 | ## Git
34 |
35 | Install Git following the instructions on the [Git website](https://git-scm.com/). Test if Git is installed by running the following command:
36 |
37 | ```bash
38 | git --version
39 | ```
40 |
41 | ## Go
42 |
43 | Install the latest version of Go following the instructions on the [Go website](https://go.dev/). Test if Go is installed by running the following command:
44 |
45 | ```bash
46 | go version
47 | ```
48 |
49 | ## go-codegen
50 |
51 | Install go-codegen by following the instructions on the [README.md](https://github.com/srdtrk/go-codegen/blob/main/README.md) or by using the command below.
52 |
53 | ```bash
54 | go install github.com/srdtrk/go-codegen@v0.2.2
55 | ```
56 |
57 | Test if go-codegen is installed by running the following command:
58 |
59 | ```bash
60 | go-codegen version
61 | ```
62 |
63 | ## Docker
64 |
65 | Install Docker following the instructions on the [Docker documentation](https://docs.docker.com/get-docker/). Test if Docker is installed by running the following command:
66 |
67 | ```bash
68 | docker --version
69 | ```
70 |
71 | ## Rust and Cargo
72 |
73 | Install Rust and Cargo following the instructions on the [Rust book](https://doc.rust-lang.org/book/ch01-01-installation.html). Test if Rust is installed by running the following commands:
74 |
75 | ```bash
76 | cargo --version
77 | ```
78 |
79 | ## just
80 |
81 |
82 |
83 | [Just](https://just.systems/) is a handy `make` alternative written in Rust. It is optional but recommended for this tutorial. Instead of writing a `Makefile`, you can write a `justfile` to automate your tasks.
84 |
85 |
86 |
87 | Install just following the instructions on the [just manual](https://just.systems/man/en/chapter_4.html) or by using the command below.
88 |
89 | ```bash
90 | cargo install just
91 | ```
92 |
93 | Test if just is installed by running the following command:
94 |
95 | ```bash
96 | just --version
97 | ```
98 |
99 |
100 |
101 | If you don't want to install `just`, you can simply run the commands in the `justfile` manually.
102 |
103 |
104 |
--------------------------------------------------------------------------------
/docs/docs/02-example-repo.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Setup the Example Contract Repository
3 | sidebar_label: Setup the Example Contract Repository
4 | sidebar_position: 2
5 | slug: /example-repo
6 | ---
7 |
8 | import HighlightBox from '@site/src/components/HighlightBox';
9 |
10 | # Clone the Example Contract Repository
11 |
12 | In this tutorial, we will be creating a test suite for an example CosmWasm contract using go-codegen. We first need to clone the repository containing the example contract.
13 |
14 | You may also fork the repository to your GitHub account and clone it from there. This will allow you to push changes to your forked repository and test github actions in your forked repository.
15 |
16 | ```sh
17 | git clone https://github.com/srdtrk/awesomwasm-2024-workshop
18 | cd awesomwasm-2024-workshop
19 | ```
20 |
21 | Now, create and checkout a new branch for the tutorial:
22 |
23 | ```sh
24 | git checkout -b tutorial
25 | ```
26 |
27 | You may take a look at the repository to familiarize yourself, but we will not be making any changes to the contract code in this tutorial.
28 |
29 |
30 |
31 | This contract contains one main contract and two testing contracts in the `testing` directory. We will be using all three contracts in our test suite.
32 |
33 |
34 |
35 | ### Build the Contracts
36 |
37 | To build the contracts, we use the [`cosmwasm/optimizer`](https://github.com/CosmWasm/optimizer) docker image version `0.15.1`.
38 |
39 | ```sh
40 | just build-optimize
41 | ```
42 |
43 | ```sh
44 | just build-test-contracts
45 | ```
46 |
47 | ### Generate CosmWasm Schemas
48 |
49 | To use go-codegen, we need to generate the CosmWasm schema for the contracts. We can do this by running the following command:
50 |
51 | ```sh
52 | just generate-schemas
53 | ```
54 |
55 |
56 |
57 | At this point, you may explore go-codegen by running generate commands. For example:
58 |
59 | ```sh
60 | go-codegen generate messages schema/cw-ica-controller.json
61 | ```
62 |
63 | And you can explore the generated `msgs.go` file in the root directory. Then remove it:
64 |
65 | ```sh
66 | rm msgs.go
67 | ```
68 |
69 |
70 |
71 |
72 |
73 | Build and schema artifacts are not committed to the repository due to `.gitignore` settings.
74 |
75 |
76 |
--------------------------------------------------------------------------------
/docs/docs/03-scaffold-suite.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Scaffold a Test Suite
3 | sidebar_label: Scaffold a Test Suite
4 | sidebar_position: 3
5 | slug: /scaffold-suite
6 | ---
7 |
8 | import HighlightBox from '@site/src/components/HighlightBox';
9 | import CodeBlock from '@theme/CodeBlock';
10 |
11 | # Scaffold a Test Suite with go-codegen
12 |
13 | In go-codegen, a test suite is a go project that contains test cases for an application. The test suite is independent of the application and contracts can be added to the test suite independently. This allows for testing multiple contracts in a single test suite.
14 |
15 | To scaffold the test suite, run the following command:
16 |
17 |
18 | {`go-codegen interchaintest scaffold`}
19 |
20 |
21 | This command will open an interactive prompt that will guide you through the process of creating a test suite. The prompt will ask you to provide the following information:
22 |
23 | 
24 |
25 | - **Go Module Name**: The name of the Go module for the test suite.
26 | - **Output Directory**: The directory where the test suite will be created.
27 | - **Number of Chains to Scaffold**: The number of chains to scaffold in the test suite.
28 | - **Github Actions**: Whether to scaffold Github Actions for the test suite.
29 |
30 | For this tutorial, we use the default values with github actions enabled.
31 |
32 |
33 |
34 | The go module name doesn't matter as it is not published to the Go module registry. It is only required to be a valid Go module name.
35 |
36 |
37 |
38 | The generated test suite will contain the following files and directories:
39 |
40 | ```text
41 | e2e/interchaintestv8
42 | ├── README.md
43 | ├── basic_test.go
44 | ├── chainconfig
45 | │ ├── chain_config.go
46 | │ ├── encoding.go
47 | │ └── genesis.go
48 | ├── e2esuite
49 | │ ├── constants.go
50 | │ ├── diagnostics.go
51 | │ ├── grpc_query.go
52 | │ ├── suite.go
53 | │ └── utils.go
54 | ├── go.mod
55 | ├── go.sum
56 | ├── testvalues
57 | │ └── values.go
58 | └── types
59 | └── contract.go
60 | .github
61 | └── workflows
62 | └── e2e.yml
63 |
64 | 7 directories, 15 files
65 | ```
66 |
67 | The test suite comes with a `basic_test.go` which you can run already without any contracts. You can test this by running:
68 |
69 | ```sh
70 | cd e2e/interchaintestv8
71 | go test -v . -run=TestWithBasicTestSuite/TestBasic
72 | ```
73 |
74 | The testsuite contains 4 go packages:
75 |
76 | - `chainconfig`: Contains the chain configuration for the test suite. Currently, the only autogenerated chain is `wasmd` v0.50.0
77 | - `e2esuite`: Contains the core components of the testsuite, such as setting up chains, relayer, and important utility functions.
78 | - `testvalues`: Contains the test value constants for the test suite.
79 | - `types`: Contains the contract types for the test suite. We will populate this directory with the contract types for the contracts we want to test.
80 | - `basic_test.go`: Contains a basic test suite that can be run without any contracts.
81 |
82 |
83 |
84 | Take some time to explore the test suite and `basic_test.go`. A good exercise is to bump the version of the `wasmd` chain to `v0.51.0` which uses CosmWasm v2, and see how the test suite behaves.
85 |
86 | To test github actions, you can open a pull request to your forked repository and see the actions run.
87 |
88 |
89 |
90 |
91 |
92 | Although currently the test suite only contains the `wasmd` image, you can change the chain configuration manually. We want to have options to scaffold additional chains in the future.
93 |
94 | For example, the following repositories contain the chain configurations for other chains while still using the same test suite:
95 |
96 | - [ibc-go-simd](https://github.com/srdtrk/cw-ica-controller/blob/d6b033092071e37f2dd015b58810a02257a92b6b/e2e/interchaintestv8/chainconfig/chain_config.go#L34-L55)
97 | - [osmosis](https://github.com/chelofinance/cw-icq-controller/blob/3540483852bc0de8f0166b675d2573c5571b80e1/e2e/interchaintest/chainconfig/chain_config.go#L85-L109)
98 |
99 |
100 |
--------------------------------------------------------------------------------
/docs/docs/04-add-contracts.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Add Contracts to the Test Suite
3 | sidebar_label: Add Contracts to the Test Suite
4 | sidebar_position: 4
5 | slug: /add-contracts
6 | ---
7 |
8 | import HighlightBox from '@site/src/components/HighlightBox';
9 | import CodeBlock from '@theme/CodeBlock';
10 |
11 | # Add Contracts to the Test Suite
12 |
13 | It's time to add the contracts to the test suite. It might be helpful to give a brief overview of the contracts before adding them to the test suite.
14 |
15 | ## Overview of `cw-ica-controller`
16 |
17 | CosmWasm Interchain Account Controller is a pure CosmWasm implementation of the [ICS-27 controller specifications](https://github.com/cosmos/ibc/tree/main/spec/app/ics-027-interchain-accounts). It can therefore directly create and control accounts in the counterparty `icahost` module.
18 |
19 | 
20 |
21 | This contract was designed to be instantiated by other contracts that wish to control accounts in a counterparty chain. Learn more about the contract in its repository: [srdtrk/cw-ica-controller](https://github.com/srdtrk/cw-ica-controller).
22 |
23 |
24 |
25 | There are a couple important things to note about this contract:
26 |
27 | - Since this contract was designed to be instantiated by other contracts, it does have the capability to make callbacks to an external contract on channel and packet lifecycle events. This is what the `callback-counter` test contract is for.
28 |
29 | ```rust reference
30 | https://github.com/srdtrk/awesomwasm-2024-workshop/blob/90ab7f61c743ec26c22fe3a1f3b8fac140a19a39/src/types/callbacks.rs#L15-L46
31 | ```
32 |
33 | - This contract automatically initiates the channel opening handshake when it is instantiated and doesn't allow any relayers to initiate the handshake.
34 |
35 | ```rust reference
36 | https://github.com/srdtrk/awesomwasm-2024-workshop/blob/90ab7f61c743ec26c22fe3a1f3b8fac140a19a39/src/types/msg.rs#L8-L21
37 | ```
38 |
39 |
40 |
41 | ## Add the Contracts
42 |
43 | In this test, we will only add the `cw-ica-controller` and `callback-counter` contracts to the test suite. To add the `cw-ica-controller` contract to the test suite, run the following command from the root of the workshop repository:
44 |
45 |
46 | {`go-codegen interchaintest add-contract schema/cw-ica-controller.json --suite-dir e2e/interchaintestv8`}
47 |
48 |
49 | This command will generate the following files:
50 |
51 | ```text
52 | e2e/interchaintestv8/
53 | ├── contract_test.go
54 | └── types
55 | └── cwicacontroller
56 | ├── contract.go
57 | ├── msgs.go
58 | └── query.go
59 | ```
60 |
61 | `contract_test.go` contains an example test case for instantiating the generated contract. This file is only generated if it doesn't already exist in the test suite when the `add-contract` command is run.
62 |
63 | You can also add the `callback-counter` contract to the test suite by running the following command:
64 |
65 |
66 | {`go-codegen interchaintest add-contract testing/contracts/callback-counter/schema/callback-counter.json --suite-dir e2e/interchaintestv8`}
67 |
68 |
69 | This command will generate the following files:
70 |
71 | ```text
72 | e2e/interchaintestv8/types/callbackcounter
73 | ├── contract.go
74 | ├── msgs.go
75 | └── query.go
76 | ```
77 |
78 | This will not modify the `contract_test.go` and the
79 |
80 |
81 |
82 | Explore the generated files to understand how the contracts are added to the test suite.
83 |
84 | Run the generated test and understand why it fails.
85 |
86 | ```sh
87 | cd e2e/interchaintestv8
88 | go test -v . -run=TestWithContractTestSuite/TestContract
89 | ```
90 |
91 |
92 |
93 |
94 |
95 | Github Actions will not run the test in the generated `contract_test.go` file. To do this, you need to add the test to the `.github/workflows/e2e.yml` file. Moreover, when running the generated test in Github Actions, you will need to build all the contracts before running the test.
96 |
97 |
98 | {`# ...
99 | build:
100 | strategy:
101 | fail-fast: false
102 | matrix:
103 | test:
104 | # List your tests here
105 | - TestWithBasicTestSuite/TestBasic
106 | # plus-diff-line
107 | + - TestWithContractTestSuite/TestContract
108 | name: \${{ matrix.test }}
109 | runs-on: ubuntu-latest
110 | steps:
111 | - name: Checkout sources
112 | uses: actions/checkout@v3
113 | // minus-diff-start
114 | - # You can build your contract here, you can either use docker or a custom cargo script:
115 | - # We've provided examples for both below:
116 | - #
117 | - # - name: Build Contracts with Docker
118 | - # run: |
119 | - # docker run --rm -v "$(pwd)":/code \
120 | - # --mount type=volume,source="$(basename "$(pwd)")_cache",target=/code/target \
121 | - # --mount type=volume,source=registry_cache,target=/usr/local/cargo/registry \
122 | - # cosmwasm/optimizer:0.15.1
123 | - # - name: Install cargo-run-script
124 | - # uses: actions-rs/cargo@v1
125 | - # with:
126 | - # command: install
127 | - # args: cargo-run-script
128 | - # - name: Build Optimized Contract
129 | - # uses: actions-rs/cargo@v1
130 | - # with:
131 | - # command: run-script
132 | - # args: optimize
133 | // minus-diff-end
134 | // plus-diff-start
135 | + - name: Install just
136 | + uses: extractions/setup-just@v2
137 | + - name: Build Test Contracts with Docker
138 | + run: just build-test-contracts
139 | + - name: Build Optimized Contract
140 | + run: just build-optimize
141 | // plus-diff-end
142 | - name: Setup Go
143 | uses: actions/setup-go@v4
144 | \# ...
145 | `}
146 |
147 |
148 |
149 |
150 |
--------------------------------------------------------------------------------
/docs/docs/05-custom-tests.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Custom Tests
3 | sidebar_label: Custom Tests
4 | sidebar_position: 5
5 | slug: /custom-tests
6 | ---
7 |
8 | import HighlightBox from '@site/src/components/HighlightBox';
9 |
10 | # Custom Tests
11 |
12 | In this section, I will give you a test for the `cw-ica-controller` contract. This test demonstrates how to create a new interchain account, fund it, and then stake some tokens with it. And then we will go over this test file line by line to understand the logic behind it.
13 |
14 | Replace the contents of `e2e/interchaintestv8/contract_test.go` with the following code:
15 |
16 | ```go reference
17 | https://github.com/srdtrk/awesomwasm-2024-workshop/blob/bbd0b9de946bc8a0680398e2dccf11e220c8c1d8/e2e/interchaintestv8/contract_test.go
18 | ```
19 |
20 | You need to run `go mod tidy` to update the indirect dependencies.
21 |
22 | ```sh
23 | go mod tidy
24 | ```
25 |
26 | ## Organization
27 |
28 | The tests are organized into subtests using the `s.Run` method. This method takes a test name and a test function as arguments. The test function is executed when the test is run.
29 |
30 | ```go reference
31 | https://github.com/srdtrk/awesomwasm-2024-workshop/blob/bbd0b9de946bc8a0680398e2dccf11e220c8c1d8/e2e/interchaintestv8/contract_test.go#L55
32 | ```
33 |
34 |
35 |
36 | Using the `s.Run` method to organize your tests into subtests makes it easier to understand the purpose of each test and helps you to identify the failing test quickly.
37 |
38 | Notice that each `s.Run` call is also wrapped by a `s.Require().True` call. This is because without this, sequential subtests will be executed even if the previous subtest fails. You may abstain from doing this if you want to run the subtests even if one of them fails.
39 |
40 |
41 |
42 | ## Test Logic
43 |
44 | We will do a line-by-line analysis of the test logic.
45 |
46 | We first call the underlying test suite's setup method. This is where the chains, relayers, connections, and accounts are initialized.
47 |
48 | ```go reference
49 | https://github.com/srdtrk/awesomwasm-2024-workshop/blob/bbd0b9de946bc8a0680398e2dccf11e220c8c1d8/e2e/interchaintestv8/contract_test.go#L45
50 | ```
51 |
52 | ### UploadAndInstantiateContracts Subtest
53 |
54 | Since contract upload and instantiation logic is inside `s.Run`, we define variables for the instantiated contracts outside of the `s.Run` method to use them in the subsequent subtests.
55 |
56 | ```go reference
57 | https://github.com/srdtrk/awesomwasm-2024-workshop/blob/bbd0b9de946bc8a0680398e2dccf11e220c8c1d8/e2e/interchaintestv8/contract_test.go#L49-L54
58 | ```
59 |
60 |
61 |
62 | Although here we are storing the instantiated contracts in variables, it is advisable to store them in the `ContractTestSuite` struct to make them accessible to all test functions. It might also be helpful to move contract upload and instantiation logic to the `ContractTestSuite`'s `SetupTest` method.
63 |
64 | This is what is done in the `cw-ica-controller`'s actual test suite. There are a lot of test functions there, which is also a good reference for writing custom tests.
65 |
66 | ```go reference
67 | https://github.com/srdtrk/cw-ica-controller/blob/d6b033092071e37f2dd015b58810a02257a92b6b/e2e/interchaintestv8/contract_test.go#L34-L46
68 | ```
69 |
70 |
71 |
72 | Then we open a subtest to upload and instantiate both the `cw-ica-controller` and `callback-counter` contracts. We first upload the `callback-counter` contract:
73 |
74 | ```go reference
75 | https://github.com/srdtrk/awesomwasm-2024-workshop/blob/bbd0b9de946bc8a0680398e2dccf11e220c8c1d8/e2e/interchaintestv8/contract_test.go#L57
76 | ```
77 |
78 | Then we instantiate the `callback-counter` contract:
79 |
80 | ```go reference
81 | https://github.com/srdtrk/awesomwasm-2024-workshop/blob/bbd0b9de946bc8a0680398e2dccf11e220c8c1d8/e2e/interchaintestv8/contract_test.go#L60
82 | ```
83 |
84 | Notice that the `callback-counter` takes no arguments in its instantiation.
85 |
86 | Then we upload and instantiate the `cw-ica-controller` contract:
87 |
88 | ```go reference
89 | https://github.com/srdtrk/awesomwasm-2024-workshop/blob/bbd0b9de946bc8a0680398e2dccf11e220c8c1d8/e2e/interchaintestv8/contract_test.go#L64-L80
90 | ```
91 |
92 |
93 |
94 | Recall that the `cw-ica-controller` initiates the channel opening handshake upon its instantiation. This is why we wait for 5 blocks after the instantiation to ensure that the handshake is completed.
95 |
96 | ```go reference
97 | https://github.com/srdtrk/awesomwasm-2024-workshop/blob/bbd0b9de946bc8a0680398e2dccf11e220c8c1d8/e2e/interchaintestv8/contract_test.go#L83
98 | ```
99 |
100 |
101 |
102 | ### Verify_ChannelOpenHandshake Subtest
103 |
104 | The next subtest is a set of assertions to ensure that the interchain account was created successfully:
105 |
106 | ```go reference
107 | https://github.com/srdtrk/awesomwasm-2024-workshop/blob/bbd0b9de946bc8a0680398e2dccf11e220c8c1d8/e2e/interchaintestv8/contract_test.go#L87-L108
108 | ```
109 |
110 |
111 |
112 | Notice the use of the autogenerated query client for both the `cw-ica-controller` and `callback-counter` contracts. This is the recommended way to query the contracts although you can also use the `.Query` method on the contract instance.
113 |
114 | ```go reference
115 | https://github.com/srdtrk/awesomwasm-2024-workshop/blob/bbd0b9de946bc8a0680398e2dccf11e220c8c1d8/e2e/interchaintestv8/contract_test.go#L89
116 | ```
117 |
118 |
119 |
120 | ### Test_CosmosMsg_Delegate Subtest
121 |
122 | In the next subtest, we fund the interchain account and stake some tokens with it. We fund the interchain account using the `s.FundAddressChainB` method, which can be found in [`e2e/interchaintestv8/e2esuite/utils.go`](https://github.com/srdtrk/awesomwasm-2024-workshop/blob/bbd0b9de946bc8a0680398e2dccf11e220c8c1d8/e2e/interchaintestv8/e2esuite/utils.go).
123 |
124 | ```go reference
125 | https://github.com/srdtrk/awesomwasm-2024-workshop/blob/bbd0b9de946bc8a0680398e2dccf11e220c8c1d8/e2e/interchaintestv8/contract_test.go#L111-L117
126 | ```
127 |
128 | Next, we construct the execute message to stake tokens with the interchain account:
129 |
130 | ```go reference
131 | https://github.com/srdtrk/awesomwasm-2024-workshop/blob/bbd0b9de946bc8a0680398e2dccf11e220c8c1d8/e2e/interchaintestv8/contract_test.go#L118-L139
132 | ```
133 |
134 | Then we use the `contract.Execute` method to execute the message, and we wait for 5 blocks to ensure that the IBC packet lifecycle is completed:
135 |
136 | ```go reference
137 | https://github.com/srdtrk/awesomwasm-2024-workshop/blob/bbd0b9de946bc8a0680398e2dccf11e220c8c1d8/e2e/interchaintestv8/contract_test.go#L141-L146
138 | ```
139 |
140 | The rest of the subtest is a set of assertions to ensure that the delegation was successful:
141 |
142 | ```go reference
143 | https://github.com/srdtrk/awesomwasm-2024-workshop/blob/bbd0b9de946bc8a0680398e2dccf11e220c8c1d8/e2e/interchaintestv8/contract_test.go#L147-L165
144 | ```
145 |
146 | Thank you for reading this tutorial. I hope you found it helpful.
147 |
--------------------------------------------------------------------------------
/docs/docs/images/scaffold-prompt.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/srdtrk/go-codegen/ed67358133db1fbf79e1b307a3b64cc618d50322/docs/docs/images/scaffold-prompt.png
--------------------------------------------------------------------------------
/docs/docusaurus.config.ts:
--------------------------------------------------------------------------------
1 | import { themes as prismThemes } from 'prism-react-renderer';
2 | import type { Config } from '@docusaurus/types';
3 | import type * as Preset from '@docusaurus/preset-classic';
4 |
5 | const config: Config = {
6 | title: 'go-codegen',
7 | tagline: 'Generate Go code for your CosmWasm smart contracts.',
8 | favicon: 'img/logo.svg',
9 |
10 | // Set the production url of your site here
11 | url: 'https://srdtrk.github.io',
12 | // Set the // pathname under which your site is served
13 | // For GitHub pages deployment, it is often '//'
14 | baseUrl: '/go-codegen/',
15 |
16 | // GitHub pages deployment config.
17 | // If you aren't using GitHub pages, you don't need these.
18 | organizationName: 'srdtrk', // Usually your GitHub org/user name.
19 | projectName: 'go-codegen', // Usually your repo name.
20 |
21 | onBrokenLinks: 'throw',
22 | onBrokenMarkdownLinks: 'warn',
23 |
24 | // Even if you don't use internationalization, you can use this field to set
25 | // useful metadata like html lang. For example, if your site is Chinese, you
26 | // may want to replace "en" with "zh-Hans".
27 | i18n: {
28 | defaultLocale: 'en',
29 | locales: ['en'],
30 | },
31 |
32 | presets: [
33 | [
34 | 'classic',
35 | {
36 | docs: {
37 | sidebarPath: './sidebars.ts',
38 | // Please change this to your repo.
39 | // Remove this to remove the "edit this page" links.
40 | editUrl:
41 | 'https://github.com/srdtrk/go-codegen/tree/main/docs',
42 | // Routed the docs to the root path
43 | routeBasePath: "/tutorial",
44 | sidebarCollapsed: false,
45 | },
46 | theme: {
47 | customCss: './src/css/custom.css',
48 | },
49 | } satisfies Preset.Options,
50 | ],
51 | ],
52 |
53 | themes: [
54 | 'docusaurus-theme-github-codeblock',
55 | [
56 | require.resolve("@easyops-cn/docusaurus-search-local"),
57 | /** @type {import("@easyops-cn/docusaurus-search-local").PluginOptions} */
58 | ({
59 | // ... Your options.
60 | // `hashed` is recommended as long-term-cache of index file is possible.
61 | hashed: true,
62 | // For Docs using Chinese, The `language` is recommended to set to:
63 | // ```
64 | // language: ["en", "zh"],
65 | // ```
66 | }),
67 | ],
68 | ],
69 |
70 | themeConfig: {
71 | // Replace with your project's social card
72 | // image: 'https://opengraph.githubassets.com/946cd03a2431502cb8cdbb579ca48c56e2c4060ca5ff0b25e13739f3fc08b512/srdtrk/cw-ica-controller',
73 | navbar: {
74 | title: 'go-codegen',
75 | logo: {
76 | alt: 'Logo',
77 | src: 'img/logo.svg',
78 | },
79 | items: [
80 | {
81 | type: 'docSidebar',
82 | sidebarId: 'docsSidebar',
83 | position: 'left',
84 | label: 'Tutorial',
85 | },
86 | {
87 | href: 'https://github.com/srdtrk/go-codegen',
88 | label: 'GitHub',
89 | position: 'right',
90 | },
91 | ],
92 | },
93 | footer: {
94 | style: 'dark',
95 | links: [
96 | {
97 | title: 'Tutorial',
98 | items: [
99 | {
100 | label: 'Tutorial',
101 | to: '/tutorial',
102 | },
103 | ],
104 | },
105 | {
106 | title: 'Community',
107 | items: [
108 | {
109 | label: 'Twitter',
110 | href: 'https://twitter.com/srdtrk',
111 | },
112 | ],
113 | },
114 | {
115 | title: 'More',
116 | items: [
117 | {
118 | label: 'GitHub',
119 | href: 'https://github.com/srdtrk/go-codegen',
120 | },
121 | ],
122 | },
123 | ],
124 | copyright: `Copyright © ${new Date().getFullYear()}. Built with Docusaurus.`,
125 | },
126 | prism: {
127 | theme: prismThemes.github,
128 | darkTheme: prismThemes.dracula,
129 | additionalLanguages: ["protobuf", "go-module", "yaml", "toml", "rust"],
130 | magicComments: [
131 | // Remember to extend the default highlight class name as well!
132 | {
133 | className: 'theme-code-block-highlighted-line',
134 | line: 'highlight-next-line',
135 | block: { start: 'highlight-start', end: 'highlight-end' },
136 | },
137 | {
138 | className: 'code-block-minus-diff-line',
139 | line: 'minus-diff-line',
140 | block: { start: 'minus-diff-start', end: 'minus-diff-end' },
141 | },
142 | {
143 | className: 'code-block-plus-diff-line',
144 | line: 'plus-diff-line',
145 | block: { start: 'plus-diff-start', end: 'plus-diff-end' },
146 | },
147 | ],
148 | },
149 | colorMode: {
150 | defaultMode: 'dark',
151 | },
152 | // github codeblock theme configuration
153 | codeblock: {
154 | showGithubLink: true,
155 | githubLinkLabel: 'View on GitHub',
156 | showRunmeLink: false,
157 | runmeLinkLabel: 'Checkout via Runme'
158 | },
159 | } satisfies Preset.ThemeConfig,
160 | plugins: [
161 | // eslint-disable-next-line @typescript-eslint/no-unused-vars
162 | async function myPlugin(context, options) {
163 | return {
164 | name: "docusaurus-tailwindcss",
165 | configurePostCss(postcssOptions) {
166 | // eslint-disable-next-line @typescript-eslint/no-var-requires
167 | postcssOptions.plugins.push(require("postcss-import"));
168 | // eslint-disable-next-line @typescript-eslint/no-var-requires
169 | postcssOptions.plugins.push(require("tailwindcss/nesting"));
170 | // eslint-disable-next-line @typescript-eslint/no-var-requires
171 | postcssOptions.plugins.push(require("tailwindcss"));
172 | // eslint-disable-next-line @typescript-eslint/no-var-requires
173 | postcssOptions.plugins.push(require("autoprefixer"));
174 | return postcssOptions;
175 | },
176 | };
177 | },
178 | ],
179 | };
180 |
181 | export default config;
182 |
--------------------------------------------------------------------------------
/docs/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "docs",
3 | "version": "0.0.0",
4 | "private": true,
5 | "scripts": {
6 | "docusaurus": "docusaurus",
7 | "start": "docusaurus start",
8 | "build": "docusaurus build",
9 | "swizzle": "docusaurus swizzle",
10 | "deploy": "docusaurus deploy",
11 | "clear": "docusaurus clear",
12 | "serve": "docusaurus serve",
13 | "write-translations": "docusaurus write-translations",
14 | "write-heading-ids": "docusaurus write-heading-ids",
15 | "typecheck": "tsc"
16 | },
17 | "dependencies": {
18 | "@docusaurus/core": "^3.3.2",
19 | "@docusaurus/plugin-client-redirects": "^3.3.2",
20 | "@docusaurus/preset-classic": "^3.3.2",
21 | "@easyops-cn/docusaurus-search-local": "^0.40.1",
22 | "@mdx-js/react": "^3.0.0",
23 | "@radix-ui/react-hover-card": "^1.0.7",
24 | "class-variance-authority": "^0.7.0",
25 | "clsx": "^2.1.0",
26 | "docusaurus-theme-github-codeblock": "^2.0.2",
27 | "lucide-react": "^0.316.0",
28 | "prism-react-renderer": "^2.3.0",
29 | "react": "^18.0.0",
30 | "react-dom": "^18.0.0",
31 | "tailwind-merge": "^2.2.1",
32 | "tailwindcss-animate": "^1.0.7"
33 | },
34 | "devDependencies": {
35 | "@docusaurus/module-type-aliases": "^3.3.2",
36 | "@docusaurus/tsconfig": "^3.3.2",
37 | "@docusaurus/types": "^3.3.2",
38 | "@typescript-eslint/eslint-plugin": "^6.20.0",
39 | "@typescript-eslint/parser": "^6.20.0",
40 | "eslint": "^8.56.0",
41 | "eslint-config-standard-with-typescript": "^43.0.1",
42 | "eslint-plugin-import": "^2.29.1",
43 | "eslint-plugin-n": "^16.6.2",
44 | "eslint-plugin-promise": "^6.1.1",
45 | "eslint-plugin-react": "^7.33.2",
46 | "tailwindcss": "^3.4.1",
47 | "typescript": "~5.2.2"
48 | },
49 | "browserslist": {
50 | "production": [
51 | ">0.5%",
52 | "not dead",
53 | "not op_mini all"
54 | ],
55 | "development": [
56 | "last 3 chrome version",
57 | "last 3 firefox version",
58 | "last 5 safari version"
59 | ]
60 | },
61 | "engines": {
62 | "node": ">=18.0"
63 | }
64 | }
65 |
--------------------------------------------------------------------------------
/docs/sidebars.ts:
--------------------------------------------------------------------------------
1 | import type { SidebarsConfig } from '@docusaurus/plugin-content-docs';
2 |
3 | /**
4 | * Creating a sidebar enables you to:
5 | - create an ordered group of docs
6 | - render a sidebar for each doc of that group
7 | - provide next/previous navigation
8 |
9 | The sidebars can be generated from the filesystem, or explicitly defined here.
10 |
11 | Create as many sidebars as you want.
12 | */
13 | const sidebars: SidebarsConfig = {
14 | // By default, Docusaurus generates a sidebar from the docs folder structure
15 | docsSidebar: [{ type: 'autogenerated', dirName: '.' }],
16 |
17 | // But you can create a sidebar manually
18 | /*
19 | tutorialSidebar: [
20 | 'intro',
21 | 'hello',
22 | {
23 | type: 'category',
24 | label: 'Tutorial',
25 | items: ['tutorial-basics/create-a-document'],
26 | },
27 | ],
28 | */
29 | };
30 |
31 | export default sidebars;
32 |
--------------------------------------------------------------------------------
/docs/src/components/HighlightBox.tsx:
--------------------------------------------------------------------------------
1 | import React from "react";
2 |
3 | import ReadingIcon from "@site/static/img/icons/hi-reading-icon.svg";
4 | import PrereqIcon from "@site/static/img/icons/hi-prerequisite-icon.svg";
5 | import TargetIcon from "@site/static/img/icons/hi-target-icon.svg";
6 | import StarIcon from "@site/static/img/icons/hi-star-icon.svg";
7 | import TipIcon from "@site/static/img/icons/hi-tip-icon.svg";
8 | import NoteIcon from "@site/static/img/icons/hi-note-icon.svg";
9 | import CoffeeIcon from "@site/static/img/icons/hi-coffee-icon.svg";
10 | import InfoIcon from "@site/static/img/icons/hi-info-icon.svg";
11 | import WarnIcon from "@site/static/img/icons/hi-warn-icon.svg";
12 |
13 | const typeToStyles = {
14 | tip: {
15 | color1: "#336667",
16 | color2: "#00B067",
17 | icon: ,
18 | darkMode: true,
19 | },
20 | reading: {
21 | color1: "#F46800",
22 | color2: "#F24CF4",
23 | icon: ,
24 | darkMode: false,
25 | },
26 | info: {
27 | color1: "#336667",
28 | color2: "#00B067",
29 | icon: ,
30 | darkMode: true,
31 | },
32 | warn: {
33 | color1: "#00B067",
34 | color2: "#FFD303",
35 | icon: ,
36 | darkMode: false,
37 | },
38 | warning: {
39 | color1: "#00B067",
40 | color2: "#FFD303",
41 | icon: ,
42 | darkMode: false,
43 | },
44 | synopsis: {
45 | color1: "#1c1c1c",
46 | color2: "#1c1c1c",
47 | icon: null,
48 | darkMode: true,
49 | },
50 | prerequisite: {
51 | color1: "lightgray",
52 | color2: "lightgray",
53 | icon: ,
54 | darkMode: false,
55 | },
56 | learning: {
57 | color1: "#6836D0",
58 | color2: "#05BDFC",
59 | icon: ,
60 | darkMode: true,
61 | },
62 | "best-practice": {
63 | color1: "#6836D0",
64 | color2: "#6836D0",
65 | icon: ,
66 | darkMode: true,
67 | },
68 | remember: {
69 | color1: "#6D0000",
70 | color2: "#F66800",
71 | icon: ,
72 | darkMode: true,
73 | },
74 | note: {
75 | color1: "#F69900",
76 | color2: "#FFCE15",
77 | icon: ,
78 | darkMode: false,
79 | },
80 | docs: {
81 | color1: "#6836D0",
82 | color2: "#F44CF6",
83 | icon: ,
84 | darkMode: true,
85 | },
86 | // add as many types as you like
87 | };
88 |
89 | const gradientStyles = ({ color1, color2 }) => ({
90 | background: `linear-gradient(78.06deg, ${color1} 1.14%, ${color2} 98.88%)`,
91 | border: 0,
92 | borderRadius: 16,
93 | padding: "0 30px",
94 | display: "flex",
95 | width: "100%",
96 | // alignItems: "center",
97 | justifyContent: "start",
98 | marginBottom: 20,
99 | fontSize: 18,
100 | // flexWrap: "wrap",
101 | flexDirection: "column",
102 | });
103 |
104 | function HighlightBox({ type, title, children }) {
105 | const styles = typeToStyles[type] || typeToStyles.info; // default to 'info' if type doesn't exist
106 |
107 | const codeStyle = {
108 | backgroundColor: 'var(--docusaurus-highlighted-code-line-bg)',
109 | };
110 | const iconStyles = {
111 | alignSelf: "center",
112 | filter: styles.darkMode ? "brightness(0) invert(1)" : "brightness(0)",
113 | };
114 | const titleStyle = {
115 | marginTop: "10px",
116 | marginLeft: "10px",
117 | color: styles.darkMode ? "#e6e6e6" : "black",
118 | };
119 | const childrenStyle = {
120 | color: styles.darkMode ? "#e6e6e6" : "black",
121 | marginBottom: "10px",
122 | };
123 |
124 | const childrenWithStyles = React.Children.map(children, child => {
125 | if (child.type === 'code') {
126 | return React.cloneElement(child, {
127 | style: codeStyle,
128 | });
129 | }
130 | return child;
131 | });
132 |
133 | return (
134 | // TODO: fix linter error here
135 |
136 |
143 |
144 |
{styles.icon}
145 |
{title}
146 |
147 |
{childrenWithStyles}
148 |
54 |
55 |
56 |
57 |
58 |
{title}
59 |
{description}
60 |
61 |
69 |
70 | {FeatureList.map((props, idx) => (
71 |
72 | ))}
73 |
74 |
17 |
18 | {siteConfig.title}
19 |
20 |
{siteConfig.tagline}
21 |
22 |
23 |
26 | Tutorial
27 |
28 |
29 |
30 |