Introduce new 'Exchange Bot' for swapping between currencies

Cargo.toml

@@ -18,6 +18,8 @@ members = [
     "backend/canisters/community/impl",
     "backend/canisters/cycles_dispenser/api",
     "backend/canisters/cycles_dispenser/impl",
+    "backend/canisters/exchange_bot/api",
+    "backend/canisters/exchange_bot/impl",
     "backend/canisters/group/api",
     "backend/canisters/group/c2c_client",
     "backend/canisters/group/client",
@@ -103,6 +105,7 @@ members = [
     "backend/libraries/human_readable",
     "backend/libraries/human_readable_derive",
     "backend/libraries/icdex_client",
+    "backend/libraries/icpswap_client",
     "backend/libraries/index_store",
     "backend/libraries/instruction_counts_log",
     "backend/libraries/ledger_utils",

backend/bots/examples/icp_dispenser/impl/src/lifecycle/heartbeat.rs

@@ -68,7 +68,11 @@ mod process_pending_actions {
 
     async fn send_messages(recipient: UserId, messages: Vec<BotMessage>) {
         let bot_name = read_state(|state| state.data.bot_name.clone());
-        let args = user_canister::c2c_handle_bot_messages::Args { bot_name, messages };
+        let args = user_canister::c2c_handle_bot_messages::Args {
+            bot_name,
+            bot_display_name: None,
+            messages,
+        };
 
         let response = user_canister_c2c_client::c2c_handle_bot_messages(recipient.into(), &args).await;
         if response.is_err() {

backend/bots/examples/satoshi_dice/impl/src/jobs/process_pending_actions.rs

@@ -57,6 +57,7 @@ async fn process_action(action: Action) {
                 CanisterId::from(user_id),
                 &user_canister::c2c_handle_bot_messages::Args {
                     bot_name: read_state(|state| state.data.username.clone()),
+                    bot_display_name: None,
                     messages: messages
                         .into_iter()
                         .map(|m| BotMessage {

backend/canister_installer/Cargo.toml

@@ -10,6 +10,7 @@ candid = { workspace = true }
 canister_agent_utils = { path = "../libraries/canister_agent_utils" }
 clap = { workspace = true, features = ["derive"] }
 cycles_dispenser_canister = { path = "../canisters/cycles_dispenser/api" }
+exchange_bot_canister = { path = "../canisters/exchange_bot/api" }
 futures = { workspace = true }
 group_canister = { path = "../canisters/group/api" }
 group_index_canister = { path = "../canisters/group_index/api" }

backend/canister_installer/local-bin/exchange_bot.wasm.gz

@@ -0,0 +1 @@
+../../../wasms/exchange_bot.wasm.gz

backend/canister_installer/src/lib.rs

@@ -31,7 +31,8 @@ async fn install_service_canisters_impl(
         set_controllers(management_canister, &canister_ids.storage_index, controllers.clone()),
         set_controllers(management_canister, &canister_ids.cycles_dispenser, controllers.clone()),
         set_controllers(management_canister, &canister_ids.registry, controllers.clone()),
-        set_controllers(management_canister, &canister_ids.market_maker, controllers),
+        set_controllers(management_canister, &canister_ids.market_maker, controllers.clone()),
+        set_controllers(management_canister, &canister_ids.exchange_bot, controllers),
         set_controllers(
             management_canister,
             &canister_ids.local_user_index,
@@ -170,6 +171,16 @@ async fn install_service_canisters_impl(
         test_mode,
     };
 
+    let exchange_bot_canister_wasm = get_canister_wasm(CanisterName::ExchangeBot, version);
+    let exchange_bot_init_args = exchange_bot_canister::init::Args {
+        governance_principals: vec![principal],
+        user_index_canister_id: canister_ids.user_index,
+        local_user_index_canister_id: canister_ids.local_user_index,
+        cycles_dispenser_canister_id: canister_ids.cycles_dispenser,
+        wasm_version: version,
+        test_mode,
+    };
+
     futures::future::join5(
         install_wasm(
             management_canister,
@@ -204,7 +215,7 @@ async fn install_service_canisters_impl(
     )
     .await;
 
-    futures::future::join4(
+    futures::future::join5(
         install_wasm(
             management_canister,
             &canister_ids.storage_index,
@@ -229,6 +240,12 @@ async fn install_service_canisters_impl(
             &market_maker_canister_wasm.module,
             market_maker_init_args,
         ),
+        install_wasm(
+            management_canister,
+            &canister_ids.exchange_bot,
+            &exchange_bot_canister_wasm.module,
+            exchange_bot_init_args,
+        ),
     )
     .await;
 

backend/canister_installer/src/main.rs

@@ -20,6 +20,7 @@ async fn main() {
         cycles_dispenser: opts.cycles_dispenser,
         registry: opts.registry,
         market_maker: opts.market_maker,
+        exchange_bot: opts.exchange_bot,
         nns_root: opts.nns_root,
         nns_governance: opts.nns_governance,
         nns_internet_identity: opts.nns_internet_identity,
@@ -80,6 +81,9 @@ struct Opts {
     #[arg(long)]
     market_maker: CanisterId,
 
+    #[arg(long)]
+    exchange_bot: CanisterId,
+
     #[arg(long)]
     nns_root: CanisterId,
 

backend/canister_upgrader/Cargo.toml

@@ -10,6 +10,7 @@ candid = { workspace = true }
 canister_agent_utils = { path = "../libraries/canister_agent_utils" }
 clap = { workspace = true, features = ["derive"] }
 cycles_dispenser_canister = { path = "../canisters/cycles_dispenser/api" }
+exchange_bot_canister = { path = "../canisters/exchange_bot/api" }
 group_canister = { path = "../canisters/group/api" }
 group_index_canister = { path = "../canisters/group_index/api" }
 group_index_canister_client = { path = "../canisters/group_index/client" }

backend/canister_upgrader/local-bin/exchange_bot.wasm.gz

@@ -0,0 +1 @@
+../../../wasms/exchange_bot.wasm.gz

backend/canister_upgrader/src/lib.rs

@@ -178,6 +178,25 @@ pub async fn upgrade_market_maker_canister(
     println!("Market maker canister upgraded");
 }
 
+pub async fn upgrade_exchange_bot_canister(
+    identity: Box<dyn Identity>,
+    url: String,
+    exchange_bot_canister_id: CanisterId,
+    version: BuildVersion,
+) {
+    upgrade_top_level_canister(
+        identity,
+        url,
+        exchange_bot_canister_id,
+        version,
+        exchange_bot_canister::post_upgrade::Args { wasm_version: version },
+        CanisterName::ExchangeBot,
+    )
+    .await;
+
+    println!("Exchange bot canister upgraded");
+}
+
 pub async fn upgrade_local_group_index_canister(
     identity: Box<dyn Identity>,
     url: String,

backend/canister_upgrader/src/main.rs

@@ -14,6 +14,7 @@ async fn main() {
         CanisterName::CyclesDispenser => {
             upgrade_cycles_dispenser_canister(identity, opts.url, opts.cycles_dispenser, opts.version).await
         }
+        CanisterName::ExchangeBot => upgrade_exchange_bot_canister(identity, opts.url, opts.exchange_bot, opts.version).await,
         CanisterName::Group => upgrade_group_canister(identity, opts.url, opts.group_index, opts.version).await,
         CanisterName::LocalGroupIndex => {
             upgrade_local_group_index_canister(identity, opts.url, opts.group_index, opts.version).await
@@ -80,6 +81,9 @@ struct Opts {
     #[arg(long)]
     market_maker: CanisterId,
 
+    #[arg(long)]
+    exchange_bot: CanisterId,
+
     #[arg(long)]
     canister_to_upgrade: CanisterName,
 

backend/canisters/community/impl/src/jobs/mod.rs

@@ -1,7 +1,7 @@
-pub mod import_groups;
-
 use crate::RuntimeState;
 
+pub mod import_groups;
+
 pub(crate) fn start(state: &RuntimeState) {
     import_groups::start_job_if_required(state);
 }

backend/canisters/exchange_bot/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+
+## [unreleased]

backend/canisters/exchange_bot/api/Cargo.toml

@@ -0,0 +1,15 @@
+[package]
+name = "exchange_bot_canister"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+bot_api = { path = "../../../bots/api" }
+candid = { workspace = true }
+candid_gen = { path = "../../../libraries/candid_gen" }
+human_readable = { path = "../../../libraries/human_readable" }
+serde = { workspace = true }
+types = { path = "../../../libraries/types" }
+user_index_canister = { path = "../../user_index/api" }

backend/canisters/exchange_bot/api/can.did

@@ -0,0 +1,13 @@
+import "../../../libraries/types/can.did";
+
+type InitArgs = record {
+    governance_principals : vec CanisterId;
+    user_index_canister_id : CanisterId;
+    local_user_index_canister_id : CanisterId;
+    cycles_dispenser_canister_id : CanisterId;
+    wasm_version : BuildVersion;
+    test_mode : bool;
+};
+
+service : {
+};

backend/canisters/exchange_bot/api/src/lib.rs

@@ -0,0 +1,22 @@
+use candid::CandidType;
+use serde::{Deserialize, Serialize};
+use std::fmt::{Display, Formatter};
+
+mod lifecycle;
+mod updates;
+
+pub use lifecycle::*;
+pub use updates::*;
+
+#[derive(CandidType, Serialize, Deserialize, Clone, Copy, Debug, Eq, PartialEq)]
+pub enum ExchangeId {
+    ICPSwap,
+}
+
+impl Display for ExchangeId {
+    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
+        match self {
+            ExchangeId::ICPSwap => f.write_str("ICPSwap"),
+        }
+    }
+}

backend/canisters/exchange_bot/api/src/lifecycle/init.rs

@@ -0,0 +1,13 @@
+use candid::{CandidType, Principal};
+use serde::{Deserialize, Serialize};
+use types::{BuildVersion, CanisterId};
+
+#[derive(CandidType, Serialize, Deserialize, Debug)]
+pub struct Args {
+    pub governance_principals: Vec<Principal>,
+    pub user_index_canister_id: CanisterId,
+    pub local_user_index_canister_id: CanisterId,
+    pub cycles_dispenser_canister_id: CanisterId,
+    pub wasm_version: BuildVersion,
+    pub test_mode: bool,
+}

backend/canisters/exchange_bot/api/src/lifecycle/mod.rs

@@ -0,0 +1,2 @@
+pub mod init;
+pub mod post_upgrade;

backend/canisters/exchange_bot/api/src/lifecycle/post_upgrade.rs

@@ -0,0 +1,8 @@
+use candid::CandidType;
+use serde::{Deserialize, Serialize};
+use types::BuildVersion;
+
+#[derive(CandidType, Serialize, Deserialize, Debug)]
+pub struct Args {
+    pub wasm_version: BuildVersion,
+}

backend/canisters/exchange_bot/api/src/main.rs

@@ -0,0 +1,5 @@
+#[allow(deprecated)]
+fn main() {
+    candid::export_service!();
+    std::print!("{}", __export_service());
+}

backend/canisters/exchange_bot/api/src/updates/handle_direct_message.rs

@@ -0,0 +1 @@
+pub use bot_api::handle_direct_message::{Response::*, *};

backend/canisters/exchange_bot/api/src/updates/mod.rs

@@ -0,0 +1,2 @@
+pub mod handle_direct_message;
+pub mod register_bot;

backend/canisters/exchange_bot/api/src/updates/register_bot.rs

@@ -0,0 +1 @@
+pub use user_index_canister::c2c_register_bot::*;