chore(iota)!: Set active env when adding new env if empty #5330

DaughterOfMars · 2025-02-11T12:57:57Z

Description

Much like #5173, when we call iota client new-env we do not set the active env if there wasn't one already. This PR changes that (and does a little additional cleanup).

Additionally, this PR skips prompting for an env when you call iota client new-env with no config.

Before

iota client new-env --alias mynet --rpc https://api.devnet.iota.cafe 
Config file ["/Users/chloe/.iota/iota_config/client.yaml"] doesn't exist, do you want to connect to an IOTA Full node server [y/N]?y
IOTA Full node server URL (Defaults to IOTA Testnet if not specified) :                             
Select key scheme to generate keypair (0 for ed25519, 1 for secp256k1, 2: for secp256r1):
0
Keys saved as Bech32.
Generated new keypair and alias for address with scheme "ed25519" [recursing-amethyst: 0x039e3fb4e0176d491ff2dd6f5dfa87e2036fa3b61381d789ffc1b0d68e0705a6]
Secret Recovery Phrase : [judge smile grief seat lecture process critic tape firm reform dream real]
Added new IOTA env [mynet] to config.

client.yml

---
keystore:
  File: /Users/chloe/.iota/iota_config/iota.keystore
envs:
  - alias: testnet
    rpc: "https://api.testnet.iota.cafe"
    ws: ~
    basic_auth: ~
    faucet: "https://faucet.testnet.iota.cafe/v1/gas"
  - alias: mynet
    rpc: "https://api.devnet.iota.cafe"
    ws: ~
    basic_auth: ~
    faucet: ~
active_env: testnet
active_address: "0x039e3fb4e0176d491ff2dd6f5dfa87e2036fa3b61381d789ffc1b0d68e0705a6"

After

iota client new-env --alias mynet --rpc https://api.devnet.iota.cafe
Select key scheme to generate keypair (0 for ed25519, 1 for secp256k1, 2: for secp256r1):
0
Keys saved as Bech32.
Generated new keypair and alias for address with scheme "ed25519" [adoring-emerald: 0x784dd4048df1f9b6a64917b9b5c4a441c3d3d12549835836d1801154be435866]
Secret Recovery Phrase : [parrot bullet ice carpet blast seed similar craft toy eager virus flush]
Added new IOTA env [mynet] to config.

client.yml

---
keystore:
  File: /Users/chloe/.iota/iota_config/iota.keystore
envs:
  - alias: mynet
    rpc: "https://api.devnet.iota.cafe"
    ws: ~
    basic_auth: ~
    faucet: ~
active_env: mynet
active_address: "0xe5eea96541b1223b7513d022d5c78025ac7eaade0666ccdfa674d2e293f56325"

vercel · 2025-02-11T12:58:00Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

4 Skipped Deployments

Name	Status	Preview	Updated (UTC)
apps-backend	⬜️ Ignored (Inspect)	Visit Preview	Feb 11, 2025 6:20pm
apps-ui-kit	⬜️ Ignored (Inspect)	Visit Preview	Feb 11, 2025 6:20pm
rebased-explorer	⬜️ Ignored (Inspect)	Visit Preview	Feb 11, 2025 6:20pm
wallet-dashboard	⬜️ Ignored (Inspect)	Visit Preview	Feb 11, 2025 6:20pm

Alex6323 · 2025-02-11T13:26:03Z

crates/iota-sdk/src/iota_client_config.rs

+        if let Some(active_env) = &self.active_env {
+            self.get_env(active_env)
+        } else {
+            self.envs.first()
+        }


should we also set self.active_env to self.envs.first() then? Feels weird that we claim to have an active env but the internal state of the object is different.

It's not a mutable fn and I don't think it should be

Sure, but the API is kind of lying to the user, because the object's internal state doesn't reflect what the method returns.

I don't think that's true. If there's no env the default is the first, which is represented in the state

currently get_active_env() and active_env() (autoimplemented getter) may return different values, and I don't think that's good.

Alex6323 · 2025-02-11T13:39:42Z

crates/iota-sdk/src/iota_client_config.rs

+        if self.get_env(&env.alias).is_none() {
+            if self.active_env.is_none() {
+                self.set_active_env(env.alias.clone());
+            }
+            self.envs.push(env);


I think the environment should also be set to active in case the user tried to add the same environment again.

I'm not sure I understand. You mean if the env exists and they try to add it again?

I don't think I agree

okay then ... I would still update the docs for this method to mention that it also sets the new env as active (but only if it was unknown before)

crates/iota-sdk/src/iota_client_config.rs

thibault-martinez · 2025-02-11T16:01:37Z

crates/iota-sdk/src/iota_client_config.rs

-        } else {
-            self.envs.first()
-        }
+    pub fn get_env(&self, alias: &str) -> Option<&IotaEnv> {


I don't really know how to feel about this change tbh

chore(iota): Set active env when adding new env if empty

874f89b

DaughterOfMars requested a review from a team as a code owner February 11, 2025 12:57

iota-ci added dev-tools Issues related to the Developer Tools Team sc-platform Issues related to the Smart Contract Platform group. labels Feb 11, 2025

thibault-martinez linked an issue Feb 11, 2025 that may be closed by this pull request

Set active env when adding new env if empty #5332

Open

Alex6323 reviewed Feb 11, 2025

View reviewed changes

skip prompting if calling new-env

90167d3

thibault-martinez reviewed Feb 11, 2025

View reviewed changes

crates/iota-sdk/src/iota_client_config.rs Outdated Show resolved Hide resolved

thibault-martinez reviewed Feb 11, 2025

View reviewed changes

DaughterOfMars added 3 commits February 11, 2025 12:22

review

135d703

more clippy

201921a

Replace get_active_env with context version and fix mut access

95c6bf5

DaughterOfMars requested review from a team as code owners February 11, 2025 18:13

DaughterOfMars added 2 commits February 11, 2025 13:14

comment

978e3bb

clippy

f9a099d

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(iota)!: Set active env when adding new env if empty #5330

chore(iota)!: Set active env when adding new env if empty #5330

DaughterOfMars commented Feb 11, 2025 •

edited

Loading

vercel bot commented Feb 11, 2025 •

edited

Loading

Alex6323 Feb 11, 2025

DaughterOfMars Feb 11, 2025

Alex6323 Feb 11, 2025

DaughterOfMars Feb 11, 2025

Alex6323 Feb 11, 2025

Alex6323 Feb 11, 2025 •

edited

Loading

DaughterOfMars Feb 11, 2025

Alex6323 Feb 11, 2025

DaughterOfMars Feb 11, 2025

Alex6323 Feb 11, 2025 •

edited

Loading

thibault-martinez Feb 11, 2025

DaughterOfMars Feb 11, 2025

chore(iota)!: Set active env when adding new env if empty #5330

Are you sure you want to change the base?

chore(iota)!: Set active env when adding new env if empty #5330

Conversation

DaughterOfMars commented Feb 11, 2025 • edited Loading

Description

Before

After

vercel bot commented Feb 11, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Alex6323 Feb 11, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Alex6323 Feb 11, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DaughterOfMars commented Feb 11, 2025 •

edited

Loading

vercel bot commented Feb 11, 2025 •

edited

Loading

Alex6323 Feb 11, 2025 •

edited

Loading

Alex6323 Feb 11, 2025 •

edited

Loading