snarkos-cli 4.6.2

Command-line interface for snarkOS
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

// Copyright (c) 2019-2026 Provable Inc.
// This file is part of the snarkOS library.

// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at:

// http://www.apache.org/licenses/LICENSE-2.0

// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use snarkos_node::{bft::MEMORY_POOL_PORT, router::DEFAULT_NODE_PORT};

use snarkvm::{console::network::Network, prelude::PrivateKey};

use anyhow::Result;
use rand::SeedableRng;
use rand_chacha::ChaChaRng;
use std::net::{Ipv4Addr, SocketAddr, SocketAddrV4};

/// The development mode RNG seed.
pub const DEVELOPMENT_MODE_RNG_SEED: u64 = 1234567890u64;

/// The development mode number of genesis committee members.
pub const DEVELOPMENT_MODE_NUM_GENESIS_COMMITTEE_MEMBERS: u16 = 4;

/// The number of validators a devnet client connects to by default.
pub const DEVNET_NUM_VALIDATORS_PER_CLIENT: u16 = 2;

/// Get the private key for a validator in development mode.
pub fn get_development_key<N: Network>(index: u16) -> Result<PrivateKey<N>> {
    // Sample the private key of this node.
    // Initialize the (fixed) RNG.
    let mut rng = ChaChaRng::seed_from_u64(DEVELOPMENT_MODE_RNG_SEED);
    // Iterate through 'dev' address instances to match the account.
    for _ in 0..index {
        let _ = PrivateKey::<N>::new(&mut rng)?;
    }

    PrivateKey::<N>::new(&mut rng)
}

/// Returns the indicies of validators a particular devnet client will connect to.
pub fn get_devnet_validators_for_client(dev: u16, num_validators: u16) -> Vec<u16> {
    (0..DEVNET_NUM_VALIDATORS_PER_CLIENT).map(|i| (dev + i) % num_validators).collect()
}

/// Returns the gateway address a particular devnet validator will listen on.
pub fn get_devnet_gateway_address_for_validator(dev: u16) -> SocketAddr {
    SocketAddr::V4(SocketAddrV4::new(Ipv4Addr::LOCALHOST, MEMORY_POOL_PORT + dev))
}

/// Returns the router address a particular devnet validator will list on.
pub fn get_devnet_router_address_for_node(dev: u16) -> SocketAddr {
    SocketAddr::V4(SocketAddrV4::new(Ipv4Addr::LOCALHOST, DEFAULT_NODE_PORT + dev))
}