AbstractSDK · Kayanski · Jan 24, 2024 · Jan 24, 2024 · Jan 24, 2024 · Jan 25, 2024
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,5 +1,10 @@
 [workspace]
-members = ["packages/*", "contracts/accessories/*", "contracts/main/*"]
+members = [
+  "packages/*",
+  "contracts/accessories/*",
+  "contracts/main/*",
+  "scripts",
+]
 
 [workspace.package]
 edition = "2021"
@@ -20,10 +25,11 @@ panic = 'abort'
 rpath = false
 
 [workspace.dependencies]
-polytone = { path = "packages/polytone", version = "1.0.0" }
-polytone-proxy = { path = "contracts/main/proxy", version = "1.0.0" }
-polytone-note = { path = "contracts/main/note", version = "1.0.0" }
-polytone-voice = { path = "contracts/main/voice", version = "1.0.0" }
+polytone = { package = "abstract-polytone", path = "packages/polytone", version = "1.0.0" }
+polytone-proxy = { package = "abstract-polytone-proxy", path = "contracts/main/proxy", version = "3.0.0" }
+polytone-note = { package = "abstract-polytone-note", path = "contracts/main/note", version = "3.0.0" }
+polytone-voice = { package = "abstract-polytone-voice", path = "contracts/main/voice", version = "3.0.0" }
+cw-orch-polytone = { package = "abstract-cw-orch-polytone", path = "packages/cw-orch-polytone", version = "4.0.1" }
 
 cosmwasm-schema = "1.2.1"
 cosmwasm-std = { version = "1.5.0", features = ["ibc3"] }
@@ -40,7 +46,9 @@ thiserror = "1.0.31"
 sha2 = "0.10.6"
 
 # dev-dependencies
+
+cw-orch = { version = "0.24.0" }
+cw-orch-interchain = { version = "0.3.0" }
+
 cw-multi-test = "0.16.2"
-polytone-tester = { path = "tests/polytone-tester" }
 anyhow = { version = "1.0.51" }
-cw-orch = { version = "0.20.0" }
diff --git a/DEPLOY.md b/DEPLOY.md
@@ -0,0 +1,101 @@
+# Deployment
+
+In order to deploy a Polytone connection between 2 chains (e.g. archway and osmosis), you should follow the following steps.
+
+> **NOTE**: Keep in min that Polytone connections go only one way. This tutorial allows you to control an account on chain `dst_chain` from `src_chain` but not the other way around!
+
+## Prerequesistes
+
+In order to be able to deploy polytone and create a connection, the two chains you want to link together should both include polytone contracts uploaded.
+
+### Building the contracts
+
+If the artifacts are not present in the repository, run the following command to build them and optimize them :
+
+```bash
+./devtools/optimize.sh
+```
+
+### Uploading all the contracts on the chain
+
+We offer the possibility to upload all contracts to a specific chain in [`scripts/src/bin/upload_contracts.rs`](scripts/src/bin/upload_contracts.rs). Simply change the chain variable to the chain on which you want to deploy the contracts.
+
+## Contract instantiation
+
+We will instantiate a `note` contract on `src_chain` and a `voice` on `dst_chain`.
+
+To do so, use [`scripts/src/bin/instantiate_chains.rs`](scripts/src/bin/instantiate_chains.rs). Change the `src_chain` and `dst_chain` variables accordingly.
+
+You can specify optional addresses that will own the contracts migration rights with the `src_admin_addr` and `dst_admin_addr` variables.
+
+## Channel creation
+
+Finally you need to create a channel between the two contracts.
+
+### Hermes setup
+
+1. [Install hermes following the official tutorial](https://hermes.informal.systems/quick-start/installation.html)
+2. If you're using mainnets, you can setup the relayer using the following command:
+
+    ```bash
+    hermes config auto --chains archway osmosis
+    ```
+
+3. You need to add your mnemonics or account keys to the relayer on both chains. [Follow this tutorial to learn how to add keys](https://hermes.informal.systems/tutorials/production/setup-hermes.html#setup-accounts).
+4. You might need to adjust the `key_name` variables in the `$HOME/.hermes/config.toml` file to the name of the key you created.
+5. You may need to config the `max_gas` variables in the `$HOME/.hermes/config.toml` file because they are not set correctly by default (some errors in the following steps will guid you in that direct). We advise you to setup the `max_gas` paramter to `1000000` on both chains for a correct channel creation process.
+
+### Channel command
+
+You may now create a channel with:
+
+```bash
+hermes create channel --a-chain <src-chain-id> --a-connection <connection-id> --a-port wasm.<src-note-contract-address> --b-port wasm.<dst-voice-contract-address> --channel-version polytone-1
+```
+
+e.g.
+
+```bash
+hermes create channel --a-chain archway-1 --a-connection connection-1 --a-port wasm.archway1zla0cm4sjytmktj4skrdm00hlars6q4jgkeqz5wy0tlftzu494tsqpkhuj --b-port wasm.osmo1kju3qsgcfwfuhqdrwm623xrf7hn3lmp2scaznxn75r3mlv36x4xsc7lnz2 --channel-version polytone-1
+```
+
+In return you should get all the channel ids you need (on the `src_chain` and on the `dst_chain`).
+
+### Testing
+
+You can make sure everything is setup correctly by using [`scripts/src/bin/verify_deployment.rs`](scripts/src/bin/verify_deployment.rs).
+This creates a transaction with empty sent messages across polytone. If the relayer is setup correctly, it should relay the packets succesfully with an `Ok` acknowledgment sent back
+
+### Setting up hermes to relay only packets on this channel
+
+Use the following configuration for each chain you want to relay on to limit the channel to the channel you just created.
+
+```toml
+[chains.packet_filter]
+policy = "allow"
+list = [
+    [
+    "wasm.<contract-address>",
+    "<created-channel-id>",
+],
+]
+```
+
+## Deploy Matrix
+
+| From\To  | Osmosis | Archway | Terra | Juno | Neutron | Stargaze | Kujira | Migaloo |
+|---       |----|----|----|----|----|----|----|----|
+| Osmosis  | ❌ | ✅ | 🟢 | 🟢 | 🟢 | 🟢 | ✅ | 🟢 |
+| Archway  | ✅ | ❌ | ✅ | ✅ | ✅ | ✅ | ✅ |    |
+| Terra    | ✅ | ✅ | ❌ | ✅ | ✅ |    | ✅ |    |
+| Juno     | 🟢 | ✅ | 🟢 | ❌ |    | 🟢 | ✅ | 🟢 |
+| Neutron  | 🟢 | ✅ | 🟢 |    | ❌ | 🟢 | ✅ |    |
+| Stargaze | 🟢 | ✅ |    | 🟢 | 🟢 | ❌ | ✅ | 🟢 |
+| Kujira   | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ |    |
+| Migaloo  | 🟢 |    |    | 🟢 |    | 🟢 |    | ❌ |
+
+✅: Deployed by Abstract
+
+❌: No reason to deploy
+
+🟢: Deployed by DA0DA0
diff --git a/contracts/accessories/listener/src/contract.rs b/contracts/accessories/listener/src/contract.rs
@@ -1,6 +1,6 @@
 #[cfg(not(feature = "library"))]
 use cosmwasm_std::entry_point;
-use cosmwasm_std::{to_binary, Binary, Deps, DepsMut, Env, MessageInfo, Response, StdResult};
+use cosmwasm_std::{to_json_binary, Binary, Deps, DepsMut, Env, MessageInfo, Response, StdResult};
 use cw2::set_contract_version;
 
 use crate::error::ContractError;
@@ -60,11 +60,11 @@ pub fn execute(
 #[cfg_attr(not(feature = "library"), entry_point)]
 pub fn query(deps: Deps, _env: Env, msg: QueryMsg) -> StdResult<Binary> {
     match msg {
-        QueryMsg::Note {} => to_binary(&NOTE.load(deps.storage)?),
+        QueryMsg::Note {} => to_json_binary(&NOTE.load(deps.storage)?),
         QueryMsg::Result {
             initiator,
             initiator_msg,
-        } => to_binary(&ResultResponse {
+        } => to_json_binary(&ResultResponse {
             callback: RESULTS.load(deps.storage, (initiator, initiator_msg))?,
         }),
     }

diff --git a/contracts/accessories/listener/src/tests.rs b/contracts/accessories/listener/src/tests.rs
@@ -1,4 +1,4 @@
-use cosmwasm_std::{to_binary, Addr, Empty, Uint64};
+use cosmwasm_std::{to_json_binary, Addr, Empty, Uint64};
 
 use cw_multi_test::{App, Contract, ContractWrapper, Executor};
 use polytone::callbacks::{Callback, CallbackMessage};
@@ -87,7 +87,7 @@ fn test() {
     // Allows note to execute callback.
     let callback = CallbackMessage {
         initiator: Addr::unchecked(INITIATOR_ADDR),
-        initiator_msg: to_binary(INITIATOR_MSG).unwrap(),
+        initiator_msg: to_json_binary(INITIATOR_MSG).unwrap(),
         result: Callback::Execute(Result::Err("ERROR".to_string())),
     };
     app.execute_contract(
@@ -118,7 +118,7 @@ fn test() {
             listener,
             &QueryMsg::Result {
                 initiator: INITIATOR_ADDR.to_string(),
-                initiator_msg: to_binary(INITIATOR_MSG).unwrap().to_string(),
+                initiator_msg: to_json_binary(INITIATOR_MSG).unwrap().to_string(),
             },
         )
         .unwrap();

diff --git a/contracts/accessories/polytone-tester/src/contract.rs b/contracts/accessories/polytone-tester/src/contract.rs
@@ -1,7 +1,7 @@
 #[cfg(not(feature = "library"))]
 use cosmwasm_std::entry_point;
 use cosmwasm_std::{
-    to_binary, Binary, Deps, DepsMut, Env, MessageInfo, Response, StdResult, WasmMsg,
+    to_json_binary, Binary, Deps, DepsMut, Env, MessageInfo, Response, StdResult, WasmMsg,
 };
 use cw2::set_contract_version;
 
@@ -58,7 +58,7 @@ pub fn execute(
         }
         ExecuteMsg::RunOutOfGas {} => Ok(Response::default().add_message(WasmMsg::Execute {
             contract_addr: env.contract.address.into_string(),
-            msg: to_binary(&ExecuteMsg::RunOutOfGas {}).unwrap(),
+            msg: to_json_binary(&ExecuteMsg::RunOutOfGas {}).unwrap(),
             funds: vec![],
         })),
     }
@@ -67,10 +67,10 @@ pub fn execute(
 #[cfg_attr(not(feature = "library"), entry_point)]
 pub fn query(deps: Deps, _env: Env, msg: QueryMsg) -> StdResult<Binary> {
     match msg {
-        QueryMsg::History {} => to_binary(&CallbackHistoryResponse {
+        QueryMsg::History {} => to_json_binary(&CallbackHistoryResponse {
             history: CALLBACK_HISTORY.load(deps.storage)?,
         }),
-        QueryMsg::HelloHistory {} => to_binary(&HelloHistoryResponse {
+        QueryMsg::HelloHistory {} => to_json_binary(&HelloHistoryResponse {
             history: HELLO_CALL_HISTORY.load(deps.storage)?,
         }),
     }

diff --git a/contracts/main/note/Cargo.toml b/contracts/main/note/Cargo.toml
@@ -1,12 +1,12 @@
 [package]
-name         = "polytone-note"
-authors      = ["ekez <[email protected]>"]
-description  = "Sends messages to be executed on other chains over IBC."
-edition      = { workspace = true }
-license      = { workspace = true }
+name = "abstract-polytone-note"
+authors = ["ekez <[email protected]>"]
+description = "Sends messages to be executed on other chains over IBC."
+edition = { workspace = true }
+license = { workspace = true }
 rust-version = { workspace = true }
-repository   = { workspace = true }
-version      = { workspace = true }
+repository = { workspace = true }
+version = "3.0.0"
 
 [lib]
 crate-type = ["cdylib", "rlib"]
@@ -16,31 +16,30 @@ crate-type = ["cdylib", "rlib"]
 backtraces = ["cosmwasm-std/backtraces"]
 # disables #[entry_point] (i.e. instantiate/execute/query) export
 library = []
-interface = ["dep:cw-orch"]
 
 # This is here inspite of the warnings to make sure it is not missed
 # if the contract is taken out of the workspace
 [profile.release]
-codegen-units    = 1
-debug            = false
+codegen-units = 1
+debug = false
 debug-assertions = false
-incremental      = false
-lto              = true
-opt-level        = 3
-overflow-checks  = true    # very important, do not turn these off.
-panic            = 'abort'
-rpath            = false
+incremental = false
+lto = true
+opt-level = 3
+overflow-checks = true   # very important, do not turn these off.
+panic = 'abort'
+rpath = false
 
 [dependencies]
 cosmwasm-schema = { workspace = true }
-cosmwasm-std    = { workspace = true }
+cosmwasm-std = { workspace = true }
 cw-storage-plus = { workspace = true }
-cw-utils        = { workspace = true }
-cw2             = { workspace = true }
-thiserror       = { workspace = true }
-polytone        = { workspace = true }
-cw-orch         = { workspace = true, optional = true }
+cw-utils = { workspace = true }
+cw2 = { workspace = true }
+thiserror = { workspace = true }
+polytone = { workspace = true }
+cw-orch = { workspace = true }
 
 [dev-dependencies]
 cw-multi-test = { workspace = true }
-anyhow        = { workspace = true }
+anyhow = { workspace = true }
diff --git a/contracts/main/note/src/bin/schema.rs b/contracts/main/note/src/bin/schema.rs
@@ -1,6 +1,6 @@
 use cosmwasm_schema::write_api;
 
-use polytone_note::msg::{ExecuteMsg, InstantiateMsg, QueryMsg};
+use abstract_polytone_note::msg::{ExecuteMsg, InstantiateMsg, QueryMsg};
 
 fn main() {
     write_api! {

diff --git a/contracts/main/note/src/contract.rs b/contracts/main/note/src/contract.rs
@@ -1,7 +1,8 @@
 #[cfg(not(feature = "library"))]
 use cosmwasm_std::entry_point;
 use cosmwasm_std::{
-    to_binary, Binary, Deps, DepsMut, Env, IbcMsg, IbcTimeout, MessageInfo, Response, StdResult,
+    to_json_binary, Binary, Deps, DepsMut, Env, IbcMsg, IbcTimeout, MessageInfo, Response,
+    StdResult,
 };
 use cw2::set_contract_version;
 use polytone::callbacks::CallbackRequestType;
@@ -106,7 +107,7 @@ pub fn execute(
         .add_attribute("method", "execute")
         .add_message(IbcMsg::SendPacket {
             channel_id,
-            data: to_binary(&ibc::Packet {
+            data: to_json_binary(&ibc::Packet {
                 sender: info.sender.into_string(),
                 msg,
             })
@@ -118,18 +119,18 @@ pub fn execute(
 #[cfg_attr(not(feature = "library"), entry_point)]
 pub fn query(deps: Deps, _env: Env, msg: QueryMsg) -> StdResult<Binary> {
     match msg {
-        QueryMsg::ActiveChannel => to_binary(&CHANNEL.may_load(deps.storage)?),
-        QueryMsg::Pair => to_binary(&CONNECTION_REMOTE_PORT.may_load(deps.storage)?.map(
+        QueryMsg::ActiveChannel => to_json_binary(&CHANNEL.may_load(deps.storage)?),
+        QueryMsg::Pair => to_json_binary(&CONNECTION_REMOTE_PORT.may_load(deps.storage)?.map(
             |(connection_id, remote_port)| Pair {
                 connection_id,
                 remote_port,
             },
         )),
-        QueryMsg::RemoteAddress { local_address } => to_binary(&accounts::query_account(
+        QueryMsg::RemoteAddress { local_address } => to_json_binary(&accounts::query_account(
             deps.storage,
             deps.api.addr_validate(&local_address)?,
         )?),
-        QueryMsg::BlockMaxGas => to_binary(&BLOCK_MAX_GAS.load(deps.storage)?),
+        QueryMsg::BlockMaxGas => to_json_binary(&BLOCK_MAX_GAS.load(deps.storage)?),
     }
 }
 

diff --git a/contracts/main/note/src/msg.rs b/contracts/main/note/src/msg.rs
@@ -23,12 +23,12 @@ pub struct InstantiateMsg {
 }
 
 #[cw_serde]
-#[cfg_attr(feature = "interface", derive(cw_orch::ExecuteFns))] // cw-orch automatic
+#[derive(cw_orch::ExecuteFns)] // cw-orch automatic
 pub enum ExecuteMsg {
     /// Performs the requested queries on the voice chain and returns
     /// a callback of Vec<QuerierResult>, or ACK-FAIL if unmarshalling
     /// any of the query requests fails.
-    #[cfg_attr(feature = "interface", fn_name("ibc_query"))]
+    #[cw_orch(fn_name("ibc_query"))]
     Query {
         msgs: Vec<QueryRequest<Empty>>,
         callback: CallbackRequest,
@@ -45,7 +45,7 @@ pub enum ExecuteMsg {
     /// perform no additional actions, pass an empty list to
     /// `msgs`. Accounts are queryable via the `RemoteAddress {
     /// local_address }` query after they have been created.
-    #[cfg_attr(feature = "interface", fn_name("ibc_execute"))]
+    #[cw_orch(fn_name("ibc_execute"))]
     Execute {
         msgs: Vec<CosmosMsg<Empty>>,
         callback: Option<CallbackRequest>,
@@ -54,8 +54,7 @@ pub enum ExecuteMsg {
 }
 
 #[cw_serde]
-#[derive(QueryResponses)]
-#[cfg_attr(feature = "interface", derive(cw_orch::QueryFns))] // cw-orch automatic
+#[derive(QueryResponses, cw_orch::QueryFns)] // cw-orch automatic
 pub enum QueryMsg {
     /// This channel this note is currently connected to, or none if
     /// no channel is connected.

diff --git a/contracts/main/note/src/tests.rs b/contracts/main/note/src/tests.rs
@@ -1,6 +1,6 @@
 use cosmwasm_std::{
     testing::{mock_dependencies, mock_env, mock_info},
-    to_binary, Uint64, WasmMsg,
+    to_json_binary, Uint64, WasmMsg,
 };
 
 use crate::{
@@ -35,7 +35,7 @@ fn simple_note() {
             on_behalf_of: None,
             msgs: vec![WasmMsg::Execute {
                 contract_addr: "some_addr".to_string(),
-                msg: to_binary("some_msg").unwrap(),
+                msg: to_json_binary("some_msg").unwrap(),
                 funds: vec![],
             }
             .into()],