doc: documentation

.editorconfig

@@ -9,3 +9,6 @@ insert_final_newline = true
 
 [*.rs]
 indent_size = 4
+
+[*.ts]
+indent_size = 2

.gitattributes

@@ -0,0 +1,4 @@
+/.yarn/**            linguist-vendored
+/.yarn/releases/*    binary
+/.yarn/plugins/**/*  binary
+/.pnp.*              binary linguist-generated

.gitignore

@@ -28,3 +28,15 @@ Cargo.lock
 .idea/
 
 **/*.profraw
+
+# Script setup
+
+config.yaml
+config.*.yaml
+!config.example.yaml
+
+context/*.config.json
+
+tmp/
+dist/
+node_modules/

Makefile

@@ -8,7 +8,7 @@ clean:
 install: install-dev
 
 install-dev: install-prod
-	cargo install --force cw-optimizoor beaker
+	cargo install --force cargo-llvm-cov cw-optimizoor beaker
 
 install-prod:
 	cargo install --force cosmwasm-check

README.md

@@ -1,77 +1,97 @@
-# cw-hyperlane
+# CW Hyperlane
 
 [![codecov](https://codecov.io/gh/many-things/cw-hyperlane/branch/main/graph/badge.svg?token=SGYE7FBTAO)](https://codecov.io/gh/many-things/cw-hyperlane)
 [![crates.io](https://img.shields.io/crates/v/hpl-interface)](https://crates.io/crates/hpl-interface)
 
-> This project is under active development...!
+## Table of Contents
+
+- [Architecture](#architecture)
+- [Project Structure](#project-structure)
+- [Prerequisites](#prerequisites)
+- [How to build](#how-to-build)
+- [How to test](#how-to-test)
+
+## Architecture
+
+![Architecture](./asset/hyperlane-all.png)
 
 ## Prerequisites
 
 - rust (wasm32-wasm32-unknown target)
 - go 1.20 or higher
-- grcov
+- llvm-cov
 
 ## How to build
 
 ```bash
-cargo build
+make install-dev
 
-cargo wasm
+make build
 ```
 
 ## How to test
 
 ```bash
-# testing
-cargo test
-
-# coverage
-export RUSTFLAGS="-Cinstrument-coverage"
-export LLVM_PROFILE_FILE="eddy-%p-%m.profraw"
+cargo test --workspace --exclude hpl-tests
 
-cargo build
-
-cargo test
-
-grcov . -s . --binary-path ./target/debug/ -t lcov --branch --ignore-not-existing -o ./target/debug/coverage/
+cargo llvm-cov --workspace --exclude hpl-tests
 ```
 
-## Deploy Sequence
-
-1. Deploy [Mailbox](./contracts/core/mailbox)
-
-2. Deploy [Validator Announce](./contracts/core/va)
-
-3. Deploy hooks to use with Mailbox (default hook, required hook)
-
-   - [interchain gas paymaster (IGP)](./contracts/igps/core)
-
-   - [IGP oracle](./contracts/igps/oracle)
-
-   - [merkle](./contracts/hooks/merkle)
-
-   - [pausable](./contracts/hooks/pausable)
-
-   - [domain routing](./contracts/hooks/routing)
-
-   - [domain routing custom](./contracts/hooks/routing-custom)
-
-   - [domain routing fallback](./contracts/hooks/routing-fallback)
-
-   - For testing: [mock hook](./contracts/mocks/mock-hook)
-
-4. Deploy isms to use with Mailbox (defualt ism)
-
-   - [multisig ism](./contracts/isms/multisig)
-
-   - [routing ism](./contracts/isms/routing)
-
-   - [aggregate ism](./contracts/isms/aggregate)
-
-   - [pausable](./contracts/isms/pausable)
-
-   - For testing: [mock ism](./contracts/mocks/mock-ism)
-
-5. Set deployed hooks and isms to Mailbox
-
-6. Deployment for core protocol is done! You can deploy some contracts on the top.
+## How to deploy
+
+[Go to README of ./example](./example/README.md)
+
+[Go to README of ./script](./script/README.md)
+
+## Project Structure
+
+```text
+├── contracts
+│   │
+│   ├── core
+│   │   ├── mailbox
+│   │   └── va
+│   │
+│   ├── hooks
+│   │   ├── aggregate
+│   │   ├── fee # protocol fee
+│   │   ├── merkle
+│   │   ├── pausable
+│   │   ├── routing
+│   │   ├── routing-custom
+│   │   └── routing-fallback
+│   │
+│   ├── igps # also this is a part of `hook`
+│   │   ├── core
+│   │   └── oracle
+│   │
+│   ├── isms
+│   │   ├── aggregate
+│   │   ├── multisig
+│   │   ├── pausable
+│   │   └── routing
+│   │
+│   ├── mocks # for testing
+│   │   ├── mock-hook
+│   │   ├── mock-ism
+│   │   └── mock-msg-receiver
+│   │
+│   └── warp
+│       ├── cw20
+│       └── native
+│
+├── integration-test
+│
+├── packages
+│   │
+│   ├── connection # same as `MailboxClient` of evm implementation
+│   ├── interface # package for contract interfaces (external)
+│   ├── ownable
+│   ├── pausable
+│   └── router
+│
+├── scripts # useful scripts for development (e.g. code uploading. contract deployment)
+│
+└── ts
+    └── sdk # typescript sdk for contract integration. (auto generated via ts-codegen)
+```

codegen.ts

@@ -0,0 +1,37 @@
+import * as fs from "fs";
+import codegen from "@cosmwasm/ts-codegen";
+import path from "path";
+
+const SCHEMA_DIR = process.env.SCHEMA_DIR || path.join(process.cwd(), "schema");
+
+const capitalize = (str: string): string =>
+  str.charAt(0).toUpperCase() + str.slice(1);
+
+const contracts = fs
+  .readdirSync(SCHEMA_DIR, { withFileTypes: true })
+  .filter((c) => !c.isDirectory())
+  .map((c) => ({
+    name: c.name.replace(".json", ""),
+    dir: SCHEMA_DIR,
+  }));
+
+codegen({
+  contracts,
+  outPath: "./dist/",
+
+  // options are completely optional ;)
+  options: {
+    bundle: {
+      bundleFile: "index.ts",
+      scope: "contracts",
+    },
+    client: {
+      enabled: true,
+    },
+    messageComposer: {
+      enabled: true,
+    },
+  },
+}).then(() => {
+  console.log("✨ all done!");
+});

config.example.yaml

@@ -0,0 +1,149 @@
+networks:
+  - id: "localwasmd"
+    hrp: "uwasm"
+    endpoint:
+      rpc: "http://localhost:26657"
+      rest: "http://localhost:1317"
+      grpc: "http://localhost:9090"
+    gas:
+      price: "0.025"
+      denom: "uwasm"
+    domain: 1063 # localwasmd -> ascii / decimal -> sum
+
+  - id: "localosmosis"
+    hrp: "osmo"
+    endpoint:
+      rpc: "http://localhost:26657"
+      rest: "http://localhost:1317"
+      grpc: "http://localhost:9090"
+    gas:
+      price: "0.025"
+      denom: "uosmo"
+    domain: 1304 # localosmosis -> ascii / decimal -> sum
+
+  - id: "localneutron"
+    hrp: "neutron"
+    endpoint:
+      rpc: "http://localhost:26657"
+      rest: "http://localhost:1317"
+      grpc: "http://localhost:9090"
+    gas:
+      price: "0.025"
+      denom: "untrn"
+    domain: 1302
+
+signer: deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef
+
+deploy:
+  ism:
+    # # hpl_ism_multisig with default validator setup (signer = validator, threshold = 1)
+    # - 5
+    # - 420
+    # - 421613
+
+    # # hpl_ism_multisig
+    # type: multisig
+    # owner: <signer>
+    # validators:
+    #   5:
+    #     addrs:
+    #       - 2F47b319809A58bBBFa8e706171762eFBF168A62
+    #     threshold: 1
+    #   420:
+    #     addrs:
+    #       - 2F47b319809A58bBBFa8e706171762eFBF168A62
+    #     threshold: 1
+    #   421613:
+    #     addrs:
+    #       - 2F47b319809A58bBBFa8e706171762eFBF168A62
+    #     threshold: 1
+
+    # # hpl_test_mock_ism
+    # type: "mock"
+
+    # # hpl_ism_aggregate
+    # type: "aggregate"
+    # owner: <signer>
+    # isms:
+    #   - type: "mock"
+    #   - type: "multisig"
+    #   ...
+
+    # # hpl_ism_routing
+    # type: "routing"
+    # owner: <signer>
+    # isms:
+    #   5:
+    #     type: "mock"
+    #   420:
+    #     type: "multisig"
+    #     ...
+    #   421613:
+    #     type: "aggregate"
+    #     ...
+
+  hooks:
+    default:
+      # same as required field.
+    required:
+      # # hpl_test_mock_hook
+      # type: "mock"
+
+      # # hpl_hook_fee
+      # type: "fee"
+      # owner: <signer> # you can use "<signer>" alias to owner field.
+      # fee:
+      #   denom: uosmo
+      #   amount: 1
+
+      # # hpl_hook_merkle
+      # type: "merkle"
+
+      # # hpl_hook_pausable
+      # type: "pausable"
+      # owner: <signer>
+      # paused: false
+
+      # # hpl_igp + hpl_igp_oracle
+      # type: "igp"
+      # token: "uosmo" # or default to gas token (in this case, uosmo will be set)
+      # configs:
+      #   5:
+      #     exchange_rate: 1.0
+      #     gas_price: 40000
+      #   420:
+      #     exchange_rate: 1.4
+      #     gas_price: 10322
+      #   ...
+
+      # # hpl_hook_aggregate
+      # type: aggregate
+      # owner: <signer>
+      # hooks:
+      #   - type: merkle
+      #   - type: pausable
+      #     owner: <signer>
+      #     paused: false
+      #   - type: fee
+      #     owner: <signer>
+      #     fee:
+      #       denom: uosmo
+      #       amount: 1
+
+      # # hpl_hook_routing / hpl_hook_routing_custom / hpl_hook_routing_fallback
+      # type: "routing"
+      # owner: <signer>
+      # hooks:
+      #   5:
+      #     type: fee
+      #     owner: <signer>
+      #     fee:
+      #       denom: uosmo
+      #       amount: 1
+      #   420:
+      #     type: "mock"
+      # custom_hooks: # optional
+      #   5:
+      #     recipient: osmo1g3q542hpttdrj9aaczsq0tkl0uyfk7nkydklz6
+      #     hook: osmo1g3q542hpttdrj9aaczsq0tkl0uyfk7nkydklz6
+      # fallback_hook: osmo1g3q542hpttdrj9aaczsq0tkl0uyfk7nkydklz6 # optional

context/neutron-1.json

@@ -0,0 +1,21 @@
+{
+  "artifacts": {
+    "hpl_hook_aggregate": 405,
+    "hpl_hook_merkle": 406,
+    "hpl_hook_pausable": 407,
+    "hpl_hook_routing": 408,
+    "hpl_hook_routing_custom": 409,
+    "hpl_hook_routing_fallback": 410,
+    "hpl_igp": 433,
+    "hpl_igp_oracle": 412,
+    "hpl_ism_aggregate": 413,
+    "hpl_ism_multisig": 431,
+    "hpl_ism_routing": 415,
+    "hpl_mailbox": 416,
+    "hpl_test_mock_hook": 417,
+    "hpl_test_mock_msg_receiver": 418,
+    "hpl_validator_announce": 432,
+    "hpl_warp_cw20": 420,
+    "hpl_warp_native": 421
+  }
+}