Skip to content

Commit 34763cd

Browse files
committed
feat: rename cli
1 parent 4d38335 commit 34763cd

15 files changed

Lines changed: 23 additions & 23 deletions

File tree

.github/copilot-instructions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ LedgerFlow is a blockchain-based payment gateway built on stablecoins (USDC) pro
1313
- **ledgerflow-indexer-evm/**: EVM event monitoring (Rust/Alloy) - listens for DepositReceived events
1414
- **ledgerflow-indexer-aptos/**: Aptos event monitoring (Rust) - monitors Move-based deposits
1515
- **ledgerflow-bot/**: Telegram bot frontend (Rust/Teloxide) - user interface for payment requests
16-
- **ledgerflow-cli/**: Command-line tools (Rust/Clap) - developer utilities
16+
- **ledgerflow-eth-cli/**: Command-line tools (Rust/Clap) - developer utilities
1717
- **ledgerflow-migrations/**: Database schema management (SQL) - unified PostgreSQL schema
1818

1919
### Critical Data Flow

.github/workflows/rust_lint.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ on:
55
paths:
66
- 'ledgerflow-balancer/**'
77
- 'ledgerflow-bot/**'
8-
- 'ledgerflow-cli/**'
8+
- 'ledgerflow-eth-cli/**'
99
- 'ledgerflow-indexer/**'
1010
- 'Cargo.toml'
1111
- 'Cargo.lock'
@@ -14,7 +14,7 @@ on:
1414
paths:
1515
- 'ledgerflow-balancer/**'
1616
- 'ledgerflow-bot/**'
17-
- 'ledgerflow-cli/**'
17+
- 'ledgerflow-eth-cli/**'
1818
- 'ledgerflow-indexer/**'
1919
- 'Cargo.toml'
2020
- 'Cargo.lock'

Cargo.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
members = [
33
"ledgerflow-balancer",
44
"ledgerflow-bot",
5-
"ledgerflow-cli",
5+
"ledgerflow-eth-cli",
66
"ledgerflow-indexer-evm",
77
"ledgerflow-indexer-aptos",
88
"ledgerflow-migrations",

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ ledgerflow/ # Project root directory
6464
│ └── ... # Aptos contract-related files
6565
├── ledgerflow-balancer/ # Backend service (business logic core)
6666
├── ledgerflow-bot/ # Telegram Bot (user frontend)
67-
├── ledgerflow-cli/ # Command-line tool
67+
├── ledgerflow-eth-cli/ # Command-line tool for Ethereum
6868
├── ledgerflow-indexer/ # Event indexer (on-chain monitoring)
6969
├── ledgerflow-migrations/ # Database schema management
7070
└── ... # Workspace configuration
@@ -139,7 +139,7 @@ For detailed usage instructions, please refer to the README.md files in each mod
139139
- [Backend Service Configuration](./ledgerflow-balancer/README.md)
140140
- [Telegram Bot Setup](./ledgerflow-bot/README.md)
141141
- [Event Indexer Configuration](./ledgerflow-indexer/README.md)
142-
- [Command Line Tool Usage](./ledgerflow-cli/README.md)
142+
- [Command Line Tool Usage](./ledgerflow-eth-cli/README.md)
143143

144144
## 🔮 Future Vision
145145

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
[package]
2-
name = "ledgerflow-cli"
2+
name = "ledgerflow-eth-cli"
33
version = "0.1.0"
44
edition = "2024"
5-
description = "CLI tool for interacting with LedgerFlow PaymentVault contract"
5+
description = "CLI tool for interacting with LedgerFlow PaymentVault contract on Ethereum"
66

77
[dependencies]
88
alloy = { workspace = true, features = ["full"] }
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ check:
3838
# Run with example parameters (requires environment variables)
3939
example-deposit:
4040
@echo "Running example deposit..."
41-
@./target/release/ledgerflow-cli deposit \
41+
@./target/release/ledgerflow-eth-cli deposit \
4242
--rpc-url "${RPC_URL}" \
4343
--private-key "${PRIVATE_KEY}" \
4444
--contract-address "${VAULT_ADDRESS}" \
@@ -47,7 +47,7 @@ example-deposit:
4747

4848
example-permit:
4949
@echo "Running example permit deposit..."
50-
@./target/release/ledgerflow-cli deposit-with-permit \
50+
@./target/release/ledgerflow-eth-cli deposit-with-permit \
5151
--rpc-url "${RPC_URL}" \
5252
--private-key "${PRIVATE_KEY}" \
5353
--contract-address "${VAULT_ADDRESS}" \
@@ -57,7 +57,7 @@ example-permit:
5757

5858
example-withdraw:
5959
@echo "Running example withdrawal..."
60-
@./target/release/ledgerflow-cli withdraw \
60+
@./target/release/ledgerflow-eth-cli withdraw \
6161
--rpc-url "${RPC_URL}" \
6262
--private-key "${PRIVATE_KEY}" \
6363
--contract-address "${VAULT_ADDRESS}"
Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# LedgerFlow CLI
1+
# LedgerFlow ETH CLI
22

3-
A command-line interface for interacting with the LedgerFlow PaymentVault smart contract using Rust and Alloy.
3+
A command-line interface for interacting with the LedgerFlow PaymentVault smart contract on Ethereum using Rust and Alloy.
44

55
## Features
66

@@ -13,7 +13,7 @@ A command-line interface for interacting with the LedgerFlow PaymentVault smart
1313
## Installation
1414

1515
```bash
16-
cd ledgerflow-cli
16+
cd ledgerflow-eth-cli
1717
cargo build --release
1818
```
1919

@@ -24,7 +24,7 @@ cargo build --release
2424
Requires prior USDC approval to the PaymentVault contract:
2525

2626
```bash
27-
./target/release/ledgerflow-cli deposit \
27+
./target/release/ledgerflow-eth-cli deposit \
2828
--rpc-url "https://sepolia.unichain.org" \
2929
--private-key "0x..." \
3030
--contract-address "0x..." \
@@ -37,7 +37,7 @@ Requires prior USDC approval to the PaymentVault contract:
3737
Combines approval and deposit in a single transaction:
3838

3939
```bash
40-
./target/release/ledgerflow-cli deposit-with-permit \
40+
./target/release/ledgerflow-eth-cli deposit-with-permit \
4141
--rpc-url "https://sepolia.unichain.org" \
4242
--private-key "0x..." \
4343
--contract-address "0x..." \
@@ -51,7 +51,7 @@ Combines approval and deposit in a single transaction:
5151
Withdraw all USDC from the vault:
5252

5353
```bash
54-
./target/release/ledgerflow-cli withdraw \
54+
./target/release/ledgerflow-eth-cli withdraw \
5555
--rpc-url "https://sepolia.unichain.org" \
5656
--private-key "0x..." \
5757
--contract-address "0x..."
@@ -112,7 +112,7 @@ export RPC_URL="https://sepolia.unichain.org"
112112
export VAULT_ADDRESS="0x742d35Cc6634C0532925a3b8D11C5d2B7e5B3F6E"
113113

114114
# Use with CLI
115-
./target/release/ledgerflow-cli deposit \
115+
./target/release/ledgerflow-eth-cli deposit \
116116
--rpc-url "$RPC_URL" \
117117
--private-key "$PRIVATE_KEY" \
118118
--contract-address "$VAULT_ADDRESS" \
@@ -134,7 +134,7 @@ ORDERS=(
134134

135135
for order in "${ORDERS[@]}"; do
136136
echo "Depositing for order: $order"
137-
./target/release/ledgerflow-cli deposit-with-permit \
137+
./target/release/ledgerflow-eth-cli deposit-with-permit \
138138
--rpc-url "$RPC_URL" \
139139
--private-key "$PRIVATE_KEY" \
140140
--contract-address "$VAULT_ADDRESS" \

0 commit comments

Comments
 (0)