Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add the "pop up contracts-node" command #185

Merged
merged 3 commits into from
May 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 6 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,12 +137,10 @@ Build the Smart Contract:
pop build contract -p ./my_contract
```

To deploy a Smart Contract you need a chain running. For testing purposes one option is to
run [substrate-contracts-node](https://github.com/paritytech/substrate-contracts-node):
To deploy a Smart Contract you need a chain running. For testing purposes you can simply spawn a contract node:

```sh
cargo install contracts-node
substrate-contracts-node
pop up contracts-node
```

> :information_source: We plan to automate this in the future.
Expand Down Expand Up @@ -192,16 +190,15 @@ pop call contract -p ./my_contract --contract $INSTANTIATED_CONTRACT_ADDRESS --m
## E2E testing

For end-to-end testing you will need to have a Substrate node with `pallet contracts`.
You do not need to run it in the background since the node is started for each test independently.
To install the latest version:
Pop provides the latest version out-of-the-box by running:

```
cargo install contracts-node --git https://github.com/paritytech/substrate-contracts-node.git
```sh
pop up contracts-node
```

If you want to run any other node with `pallet-contracts` you need to change `CONTRACTS_NODE` environment variable:

```
```sh
export CONTRACTS_NODE="YOUR_CONTRACTS_NODE_PATH"
AlexD10S marked this conversation as resolved.
Show resolved Hide resolved
```

Expand Down
1 change: 1 addition & 0 deletions crates/pop-cli/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ contract = [
"dep:pop-contracts",
"dep:sp-core",
"dep:sp-weights",
"dep:dirs",
]
parachain = [
"dep:pop-parachains",
Expand Down
31 changes: 31 additions & 0 deletions crates/pop-cli/src/commands/up/contracts_node.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
// SPDX-License-Identifier: GPL-3.0

use clap::Args;
use cliclack::{clear_screen, intro, set_theme};
use duct::cmd;

use crate::style::{style, Theme};

const BIN_NAME: &str = "substrate-contracts-node";

#[derive(Args)]
pub(crate) struct ContractsNodeCommand;
impl ContractsNodeCommand {
pub(crate) async fn execute(&self) -> anyhow::Result<()> {
clear_screen()?;
intro(format!("{}: Launch a contracts node", style(" Pop CLI ").black().on_magenta()))?;
set_theme(Theme);

let cache = crate::cache()?;
let cached_file = cache.join("bin").join(BIN_NAME);
if !cached_file.exists() {
cmd(
"cargo",
vec!["install", "--root", cache.display().to_string().as_str(), "contracts-node"],
)
.run()?;
}
cmd(cached_file.display().to_string().as_str(), Vec::<&str>::new()).run()?;
Ok(())
}
}
6 changes: 6 additions & 0 deletions crates/pop-cli/src/commands/up/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

#[cfg(feature = "contract")]
mod contract;
#[cfg(feature = "contract")]
mod contracts_node;
#[cfg(feature = "parachain")]
mod parachain;

Expand All @@ -24,4 +26,8 @@ pub(crate) enum UpCommands {
/// Deploy a smart contract to a node.
#[clap(alias = "c")]
Contract(contract::UpContractCommand),
#[cfg(feature = "contract")]
/// Deploy a contracts node.
#[clap(alias = "n")]
ContractsNode(contracts_node::ContractsNodeCommand),
}
11 changes: 7 additions & 4 deletions crates/pop-cli/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,16 @@ compile_error!("feature \"contract\" or feature \"parachain\" must be enabled");
mod commands;
mod style;

#[cfg(feature = "parachain")]
use anyhow::anyhow;
use anyhow::Result;
use clap::{Parser, Subcommand};
use commands::*;
#[cfg(feature = "telemetry")]
use pop_telemetry::{config_file_path, record_cli_command, record_cli_used, Telemetry};
use serde_json::{json, Value};
#[cfg(feature = "parachain")]
use std::{env::args, fs::create_dir_all, path::PathBuf};
#[cfg(feature = "telemetry")]
use std::env::args;
use std::{fs::create_dir_all, path::PathBuf};

#[derive(Parser)]
#[command(author, version, about, styles=style::get_styles())]
Expand Down Expand Up @@ -98,6 +98,8 @@ async fn main() -> Result<()> {
up::UpCommands::Parachain(cmd) => cmd.execute().await.map(|_| Value::Null),
#[cfg(feature = "contract")]
up::UpCommands::Contract(cmd) => cmd.execute().await.map(|_| Value::Null),
#[cfg(feature = "contract")]
up::UpCommands::ContractsNode(cmd) => cmd.execute().await.map(|_| Value::Null),
},
#[cfg(feature = "contract")]
Commands::Test(args) => match &args.command {
Expand Down Expand Up @@ -131,7 +133,7 @@ async fn main() -> Result<()> {
// map result from Result<Value> to Result<()>
res.map(|_| ())
}
#[cfg(feature = "parachain")]

fn cache() -> Result<PathBuf> {
let cache_path = dirs::cache_dir()
.ok_or(anyhow!("the cache directory could not be determined"))?
Expand All @@ -158,6 +160,7 @@ fn init() -> Result<Option<Telemetry>> {
Ok(maybe_tel)
}

#[cfg(feature = "telemetry")]
fn parse_args(args: Vec<String>) -> (String, String) {
// command is always present as clap will print help if not set
let command = args.get(1).expect("expected command missing").to_string();
Expand Down
Loading