Getting started end-to-end IPC tutorial (#130)

* README for subnet lifecycle

* Apply suggestions from code review

Co-authored-by: Jorge Soares <[email protected]>

* Apply suggestions from code review

Co-authored-by: Jorge Soares <[email protected]>

* address comments and set validator net addr

* wip: checkpoints

* update checkpoint section

* rename ipc_agent to ipc-agent

* pretty print list-subnets. Address comments

* update README. Minor fix in list-subnets

* add instructions for send-value

* Update README.md

* Update README.md

* Apply suggestions from code review

Co-authored-by: Jorge Soares <[email protected]>

---------

Co-authored-by: Jorge Soares <[email protected]>

Cargo.toml

@@ -7,7 +7,7 @@ edition = "2021"
 license-file = "LICENSE"
 
 [package]
-name = "ipc_agent"
+name = "ipc-agent"
 version = "0.1.0"
 edition.workspace = true
 license-file.workspace = true

Dockerfile

@@ -25,8 +25,8 @@ RUN --mount=type=cache,target=$RUSTUP_HOME,from=rust,source=$RUSTUP_HOME \
 # Main stage
 FROM debian:bullseye-slim
 
-COPY --from=builder /app/output/bin/ipc_agent /usr/local/bin/ipc_agent
+COPY --from=builder /app/output/bin/ipc-agent /usr/local/bin/ipc-agent
 
-ENTRYPOINT ["ipc_agent"]
+ENTRYPOINT ["ipc-agent"]
 
 EXPOSE 3030

Makefile

@@ -1,4 +1,4 @@
-.PHONY: all build test lint license check-fmt check-clippy diagrams
+.PHONY: all build test lint license check-fmt check-clippy diagrams install_infra
 
 all: test build
 
@@ -19,6 +19,9 @@ lint: \
 license:
 	./scripts/add_license.sh
 
+install-infra:
+	./scripts/install_infra.sh
+
 check-fmt:
 	cargo fmt --all --check
 

scripts/install_infra.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+#
+# Builds docker image and install the ipc-scripts required to conveniently
+# deploy the infrastructure for IPC subnets.
+rm -rf ./lotus
+git clone https://github.com/consensus-shipyard/lotus.git
+cd ./lotus
+docker build -t eudico .
+cd ..
+mkdir -p ./bin
+cp -r ./lotus/scripts/ipc ./bin/ipc-infra
+rm -rf ./lotus

src/cli/commands/manager/list_subnets.rs

@@ -4,8 +4,11 @@
 
 use async_trait::async_trait;
 use clap::Args;
+use fvm_shared::bigint::BigInt;
+use fvm_shared::econ::TokenAmount;
 use std::collections::HashMap;
 use std::fmt::Debug;
+use std::str::FromStr;
 
 use crate::cli::commands::get_ipc_agent_url;
 use crate::cli::{CommandLineHandler, GlobalArguments};
@@ -39,7 +42,19 @@ impl CommandLineHandler for ListSubnets {
             )
             .await?;
 
-        log::info!("found child subnets: {subnets:?}");
+        for (_, s) in subnets.iter() {
+            let u = BigInt::from_str(&s.stake).unwrap();
+            let stake = TokenAmount::from_atto(u);
+            let u = BigInt::from_str(&s.circ_supply).unwrap();
+            let supply = TokenAmount::from_atto(u);
+            log::info!(
+                "{} - status: {}, collateral: {} FIL, circ.supply: {} FIL",
+                s.id,
+                s.status,
+                stake,
+                supply,
+            );
+        }
 
         Ok(())
     }

src/cli/mod.rs

@@ -9,7 +9,7 @@ mod commands;
 use crate::config::Config;
 pub use commands::cli;
 
-const DEFAULT_CONFIG_PATH: &str = ".ipc_agent/config.toml";
+const DEFAULT_CONFIG_PATH: &str = ".ipc-agent/config.toml";
 
 /// The trait that represents the abstraction of a command line handler. To implement a new command
 /// line operation, implement this trait and register it.
@@ -35,7 +35,7 @@ pub struct GlobalArguments {
     #[arg(
         short,
         long,
-        help = "The toml config file path for IPC Agent, default to ${HOME}/.ipc_agent/config.toml"
+        help = "The toml config file path for IPC Agent, default to ${HOME}/.ipc-agent/config.toml"
     )]
     config_path: Option<String>,
 }

src/lotus/client.rs

@@ -58,7 +58,10 @@ mod methods {
 /// The default gateway actor address
 const GATEWAY_ACTOR_ADDRESS: &str = "t064";
 /// The default state wait confidence value
-const STATE_WAIT_CONFIDENCE: u8 = 5;
+/// TODO: we can afford 2 epochs confidence (and even one)
+/// with Mir, but with Filecoin mainnet this should be increased
+/// in case there are reorgs.
+const STATE_WAIT_CONFIDENCE: u8 = 2;
 /// We dont set a limit on the look back epoch, i.e. check against latest block
 const STATE_WAIT_LOOK_BACK_NO_LIMIT: i8 = -1;
 /// We are not replacing any previous messages.