Enum SafeModuleSubcommands

pub enum SafeModuleSubcommands {
    Create {
        network_provider: NetworkProviderArgs,
        local_identity: IdentityFileArgs,
        node_address: Option<String>,
        admin_address: Option<String>,
        threshold: u32,
        allowance: Option<f64>,
        hopr_amount: Option<f64>,
        native_amount: Option<f64>,
        private_key: PrivateKeyArgs,
        manager_private_key: ManagerPrivateKeyArgs,
    },
    Migrate {
        network_provider: NetworkProviderArgs,
        local_identity: IdentityFileArgs,
        node_address: Option<String>,
        safe_address: String,
        module_address: String,
        allowance: Option<f64>,
        private_key: PrivateKeyArgs,
        manager_private_key: ManagerPrivateKeyArgs,
    },
    Move {
        network_provider: NetworkProviderArgs,
        local_identity: IdentityFileArgs,
        node_address: Option<String>,
        old_module_address: String,
        new_safe_address: String,
        new_module_address: String,
        private_key: PrivateKeyArgs,
        manager_private_key: ManagerPrivateKeyArgs,
    },
    Debug {
        network_provider: NetworkProviderArgs,
        local_identity: IdentityFileArgs,
        node_address: Option<String>,
        safe_address: String,
        module_address: String,
    },
}

CLI arguments for hopli safe-module

Variants

Create

Create safe and module proxy if nothing exists

Fields

network_provider: NetworkProviderArgs

Network name, contracts config file root, and customized provider, if available

local_identity: IdentityFileArgs

Arguments to locate identity file(s) of HOPR node(s)

node_address: Option<String>

node addresses

admin_address: Option<String>

admin addresses

threshold: u32

Threshold for the generated safe

allowance: Option<f64>

Allowance of the channel contract to manage HOPR tokens on behalf of deployed safe

hopr_amount: Option<f64>

The amount of HOPR tokens (in floating number) to be funded to the new safe

native_amount: Option<f64>

The amount of native tokens (in floating number) to be funded per node

private_key: PrivateKeyArgs

Access to the private key, of which the wallet either contains sufficient assets as the source of funds or it can mint necessary tokens

manager_private_key: ManagerPrivateKeyArgs

Access to the private key, of which the wallet has MANAGER_ROLE of network registry If provided, this wallet will grant the created safe access to the network registry

Migrate

Migrate safe and module to a new network

Fields

network_provider: NetworkProviderArgs

Network name, contracts config file root, and customized provider, if available

local_identity: IdentityFileArgs

Arguments to locate identity file(s) of HOPR node(s)

node_address: Option<String>

node addresses

safe_address: String

safe address that the nodes move to

module_address: String

module address that the nodes move to

allowance: Option<f64>

Allowance of the channel contract to manage HOPR tokens on behalf of deployed safe

private_key: PrivateKeyArgs

Access to the private key, of which the wallet either contains sufficient assets as the source of funds or it can mint necessary tokens

manager_private_key: ManagerPrivateKeyArgs

Access to the private key, of which the wallet has MANAGER_ROLE of network registry If provided, this wallet will grant the created safe access to the network registry

Move

Move nodes to one single safe and module pair

Fields

network_provider: NetworkProviderArgs

Network name, contracts config file root, and customized provider, if available

local_identity: IdentityFileArgs

Arguments to locate identity file(s) of HOPR node(s)

node_address: Option<String>

node addresses

old_module_address: String

old module addresses

new_safe_address: String

safe address that the nodes move to

new_module_address: String

module address that the nodes move to

private_key: PrivateKeyArgs

Access to the private key, of which the wallet either contains sufficient assets as the source of funds or it can mint necessary tokens

manager_private_key: ManagerPrivateKeyArgs

Access to the private key, of which the wallet has MANAGER_ROLE of network registry If provided, this wallet will grant the created safe access to the network registry

Debug

Debug safe and module setup

Fields

network_provider: NetworkProviderArgs

Network name, contracts config file root, and customized provider, if available

local_identity: IdentityFileArgs

Arguments to locate identity file(s) of HOPR node(s)

node_address: Option<String>

node addresses

safe_address: String

safe address that the nodes move to

module_address: String

module address that the nodes move to

Implementations

impl SafeModuleSubcommands

pub async fn execute_safe_module_creation( network_provider: NetworkProviderArgs, local_identity: IdentityFileArgs, node_address: Option<String>, admin_address: Option<String>, threshold: u32, allowance: Option<f64>, hopr_amount: Option<f64>, native_amount: Option<f64>, private_key: PrivateKeyArgs, manager_private_key: ManagerPrivateKeyArgs, ) -> Result<(), HelperErrors>

Execute the command, which quickly create necessary staking wallets and execute necessary on-chain transactions to setup a HOPR node.

1. Create a safe instance and a node management module instance:
2. Set default permissions for the module
3. Include node as a member with restricted permission on sending assets
4. transfer some HOPR token to the new safe (directly)
5. transfer some native tokens to nodes

pub async fn execute_safe_module_moving( network_provider: NetworkProviderArgs, local_identity: IdentityFileArgs, node_address: Option<String>, old_module_address: String, new_safe_address: String, new_module_address: String, private_key: PrivateKeyArgs, manager_private_key: ManagerPrivateKeyArgs, ) -> Result<(), HelperErrors>

Execute the command, which moves nodes to a new managing safe and module pair Note that it does not register the node with the new safe on NodeSafeRegistry, because it is an action that nodes need to do on-start.

pub async fn execute_safe_module_migration( network_provider: NetworkProviderArgs, local_identity: IdentityFileArgs, node_address: Option<String>, safe_address: String, module_address: String, allowance: Option<f64>, private_key: PrivateKeyArgs, manager_private_key: ManagerPrivateKeyArgs, ) -> Result<(), HelperErrors>

Execute the command, which migrates nodes to a new network Note that it does not register the node with the new safe on NodeSafeRegistry, because it is an action that nodes need to do on-start.

pub async fn execute_safe_module_debugging( network_provider: NetworkProviderArgs, local_identity: IdentityFileArgs, node_address: Option<String>, safe_address: String, module_address: String, ) -> Result<(), HelperErrors>

Execute the command to debug the following:

1. node xDAI balance
2. If node has been included on Network Registry
3. If node and safe are associated on Node Safe Registry
4. If Safe is owned by the correct owner(s)
5. Safe’s wxHOPR balance and allowance
6. if node is included in the module
7. If the channel contract is included as a target
8. If the announce contract is included as a target
9. If safe is the owner of the module

Trait Implementations

impl Clone for SafeModuleSubcommands

fn clone(&self) -> SafeModuleSubcommands

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Cmd for SafeModuleSubcommands

fn run(self) -> Result<(), HelperErrors>

Run the execute_safe_module_creation function

async fn async_run(self) -> Result<(), HelperErrors>

impl CommandFactory for SafeModuleSubcommands

fn command<'b>() -> Command

Build a [Command] that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a [Command] that can update self.

impl Debug for SafeModuleSubcommands

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromArgMatches for SafeModuleSubcommands

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for SafeModuleSubcommands

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::exit] on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, [exit][Error::exit] on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, [exit][Error::exit] on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.

impl Subcommand for SafeModuleSubcommands

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand