galoy-cli 0.1.7

A CLI Client for interacting with Galoy Backend
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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

use clap::{Parser, Subcommand};

use crate::client::types::{ReceiveVia, Wallet};
use rust_decimal::Decimal;

#[derive(Parser)]
#[clap(
    version,
    author = "Galoy",
    about = "Galoy CLI",
    long_about = "CLI client to interact with Galoy's APIs"
)]
pub struct Cli {
    #[clap(
        long,
        env = "GALOY_API",
        default_value = "http://localhost:4455/graphql"
    )]
    pub api: String,

    #[clap(subcommand)]
    pub command: Command,
}

#[derive(Subcommand)]
pub enum Command {
    /// Get global values from the instance
    Globals,
    /// Get auth token of an account
    Login {
        #[clap(short, long, value_parser)]
        phone: Option<String>,
        #[clap(long, conflicts_with("phone"))]
        email: bool,
        #[clap(short, long)]
        code: String,
        #[clap(short = 't', long = "two-fa-code", value_parser)]
        two_fa_code: Option<String>,
    },
    /// Logout the current user by removing the auth token
    Logout,
    /// Execute Me query
    Me,
    /// Get WalletId for an account
    DefaultWallet {
        #[clap(value_parser)]
        username: String,
    },
    // Update the default wallet of an account
    SetDefaultWallet {
        #[clap(short, long, value_parser, conflicts_with("wallet_id"))]
        wallet: Option<Wallet>,
        #[clap(long)]
        wallet_id: Option<String>,
    },
    /// Set a username for a new account
    SetUsername {
        #[clap(short, long)]
        username: String,
    },
    /// Fetch the balance of a wallet
    Balance {
        #[clap(long)]
        btc: bool,
        #[clap(long)]
        usd: bool,
        #[clap(long, use_value_delimiter = true)]
        wallet_ids: Vec<String>,
    },
    /// Execute a Payment
    Pay {
        #[clap(short, long)]
        username: Option<String>,
        #[clap(short, long, conflicts_with("username"))]
        onchain_address: Option<String>,
        #[clap(short, long, value_parser)]
        wallet: Wallet,
        #[clap(short, long, required_if_eq("wallet", "usd"))]
        cents: Option<Decimal>,
        #[clap(short, long, required_if_eq("wallet", "btc"))]
        sats: Option<Decimal>,
        #[clap(short, long)]
        memo: Option<String>,
    },
    /// Receive a Payment
    Receive {
        #[clap(short, long, value_parser)]
        wallet: Wallet,
        #[clap(short, long, value_parser)]
        via: ReceiveVia,
    },
    ///
    ///
    /// Execute a batch payment
    ///
    /// This command allows you to perform multiple payments at once using a CSV file. Each line in the CSV file represents a single payment transaction.
    /// Information About Columns Required in the CSV File:
    ///
    /// - username:
    ///     This column determines the Blink username of the recipient.
    ///
    /// - amount:
    ///     Amount that will be sent.
    ///
    /// - currency:
    ///     Indicates the currency of the amount. Can be either USD or SATS. Note: SATS currency only works with BTC wallets.
    ///
    /// - wallet (optional values):
    ///     Specifies the wallet (USD or BTC) to be used for sending the payment. If not provided, the default wallet is used.
    ///
    /// - memo (optional values):
    ///     A message or note to attach with the payment.
    ///
    /// *--* ALL HEADERS NEEDS TO BE IN THIS ORDER, BUT VALUES ARE OPTIONAL FOR "wallet" AND "memo" *--*
    ///
    ///
    /// EXAMPLE :-
    ///
    /// | username  | amount | currency | wallet | memo   |
    ///
    /// |-----------|--------|----------|--------|--------|
    ///
    /// |   user a  |   12   |   USD    |   USD  |        |
    ///
    /// |   user b  |   10   |   SATS   |   BTC  |  memo  |
    ///
    /// |   user a  |   14   |   USD    |   BTC  |        |
    ///
    ///
    Batch {
        #[clap(short, long = "csv")]
        file: String,
        #[clap(action, long)]
        skip_confirmation: bool,
    },
    /// Request a code from a Phone number or Email
    RequestCode {
        #[clap(short, long, value_parser, conflicts_with("email"))]
        phone: Option<String>,
        #[clap(short, long, value_parser)]
        email: Option<String>,
    },
}