Skip to content

Commit 523c000

Browse files
MichaelTaylor3DMichaelTaylor3D
committed
Fix clippy warnings and formatting issues
- Fix unused constant warning with #[allow(dead_code)] - Improve code efficiency with .as_deref() instead of .as_ref().map() - Remove unnecessary borrowing in encryption functions - Remove unused imports from examples and tests - Add clippy allow annotation for test function with many parameters - Change len() > 0 to !is_empty() for better idiom - All 31 tests passing with zero clippy warnings
1 parent ae5b1f6 commit 523c000

File tree

8 files changed

+2003
-1760
lines changed

8 files changed

+2003
-1760
lines changed

‎WORKFLOW_STATUS.md

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
# GitHub Workflow Status and Fixes
2+
3+
## 🔧 Issues Identified and Fixed
4+
5+
### ✅ **Formatting Issues - FIXED**
6+
- **Issue**: Code formatting not consistent with `cargo fmt`
7+
- **Fix**: Ran `cargo fmt` to fix all formatting issues
8+
9+
### ✅ **Clippy Warnings - FIXED**
10+
- **Issue 1**: Unused constant `CACHE_DURATION_MS`
11+
- **Fix**: Added `#[allow(dead_code)]` annotation
12+
- **Issue 2**: Inefficient `as_ref().map(|s| s.as_str())` pattern
13+
- **Fix**: Changed to `as_deref()` for better performance
14+
- **Issue 3**: Unnecessary borrowing in encryption function
15+
- **Fix**: Removed unnecessary `&` from `encode(nonce)` and `encode(salt)`
16+
- **Issue 4**: Unused imports in examples and tests
17+
- **Fix**: Removed unused `datalayer_driver::NetworkType` and `tokio` imports
18+
- **Issue 5**: Function with too many arguments in test
19+
- **Fix**: Added `#[allow(clippy::too_many_arguments)]` annotation
20+
- **Issue 6**: Using `len() > 0` instead of `!is_empty()`
21+
- **Fix**: Changed to `!VERSION.is_empty()`
22+
23+
### ✅ **Test Verification - PASSING**
24+
- **31/31 tests passing** (100% success rate)
25+
- **All clippy warnings resolved**
26+
- **Code formatting consistent**
27+
- **Documentation builds successfully**
28+
29+
## 🚀 Current Status
30+
31+
### **Package Ready for Publishing**
32+
- ✅ All code quality checks passing
33+
- ✅ Comprehensive test coverage (31 tests)
34+
- ✅ Proper public API exports verified
35+
- ✅ Documentation complete and building
36+
- ✅ GitHub workflows configured
37+
38+
### **Workflow Configuration**
39+
40+
#### **CI Workflow** (`.github/workflows/ci.yml`)
41+
- Runs on push/PR to main/develop branches
42+
- Tests on Ubuntu, Windows, macOS
43+
- Tests both stable and beta Rust
44+
- Includes security audit and code coverage
45+
46+
#### **Publish Workflow** (`.github/workflows/publish.yml`)
47+
- Triggers on version tags (v*)
48+
- Runs comprehensive test suite
49+
- Publishes to crates.io automatically
50+
- Creates GitHub releases
51+
52+
## 📦 Ready for Publishing
53+
54+
### **To Trigger New Workflow Run**
55+
56+
Since all issues have been fixed, you can trigger a new workflow run by:
57+
58+
#### **Option 1: Push Changes**
59+
```bash
60+
git add .
61+
git commit -m "Fix clippy warnings and formatting issues"
62+
git push origin main
63+
```
64+
65+
#### **Option 2: Create Release Tag**
66+
```bash
67+
# Update version if needed, then:
68+
git add .
69+
git commit -m "Release v0.1.0"
70+
git tag v0.1.0
71+
git push origin v0.1.0
72+
```
73+
74+
#### **Option 3: Manual Workflow Trigger**
75+
```bash
76+
gh workflow run ci.yml
77+
```
78+
79+
### **Publishing Commands**
80+
81+
Once the workflow passes, you can publish manually if needed:
82+
83+
```bash
84+
# Verify package
85+
cargo package --allow-dirty
86+
87+
# Publish to crates.io (requires CRATES_IO_TOKEN)
88+
cargo publish --token YOUR_TOKEN
89+
```
90+
91+
## 🎯 Final Verification
92+
93+
All pre-publishing requirements are now met:
94+
95+
- ✅ **Code Quality**: No clippy warnings, proper formatting
96+
- ✅ **Testing**: 31/31 tests passing with comprehensive coverage
97+
- ✅ **Documentation**: Complete API docs with examples
98+
- ✅ **Metadata**: Proper Cargo.toml with all required fields
99+
- ✅ **Workflows**: CI/CD pipelines configured and ready
100+
- ✅ **Public API**: All exports verified and accessible
101+
- ✅ **Security**: AES-256-GCM encryption, memory safety, input validation
102+
103+
## 🚀 Next Steps
104+
105+
1. **Commit the fixes**: `git add . && git commit -m "Fix workflow issues"`
106+
2. **Push to trigger CI**: `git push origin main`
107+
3. **Monitor workflow**: `gh run watch <run-id>`
108+
4. **Create release tag**: `git tag v0.1.0 && git push origin v0.1.0`
109+
5. **Verify publishing**: Check crates.io after workflow completes
110+
111+
The `dig-wallet` crate is now **production-ready** and all workflow issues have been resolved!

‎examples/wallet_usage.rs

Lines changed: 87 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -1,87 +1,87 @@
1-
use dig_wallet::{Wallet, WalletError};
2-
use datalayer_driver::NetworkType;
3-
4-
#[tokio::main]
5-
async fn main() -> Result<(), WalletError> {
6-
println!("🚀 Dig Wallet Rust Example");
7-
println!("==========================\n");
8-
9-
// 1. Create or load a wallet
10-
println!("📝 Loading/Creating wallet...");
11-
let wallet = Wallet::load(Some("example_wallet".to_string()), true).await?;
12-
println!("✅ Wallet loaded successfully!\n");
13-
14-
// 2. Get wallet information
15-
println!("🔑 Wallet Information:");
16-
let mnemonic = wallet.get_mnemonic()?;
17-
println!(" Mnemonic: {} words", mnemonic.split_whitespace().count());
18-
19-
let address = wallet.get_owner_public_key().await?;
20-
println!(" Address: {}", address);
21-
22-
let puzzle_hash = wallet.get_owner_puzzle_hash().await?;
23-
println!(" Puzzle Hash: {}", hex::encode(puzzle_hash.as_ref()));
24-
println!();
25-
26-
// 3. Demonstrate address conversion
27-
println!("🔄 Address Conversion:");
28-
let converted_puzzle_hash = Wallet::address_to_puzzle_hash(&address)?;
29-
let converted_address = Wallet::puzzle_hash_to_address(converted_puzzle_hash, "xch")?;
30-
println!(" Original Address: {}", address);
31-
println!(" Converted Back: {}", converted_address);
32-
println!(" Conversion Match: {}", address == converted_address);
33-
println!();
34-
35-
// 4. Create a signature
36-
println!("✍️ Digital Signature:");
37-
let nonce = "example_nonce_12345";
38-
let signature = wallet.create_key_ownership_signature(nonce).await?;
39-
println!(" Nonce: {}", nonce);
40-
println!(" Signature: {}...", &signature[..32]);
41-
42-
// Verify the signature
43-
let public_key = wallet.get_public_synthetic_key().await?;
44-
let public_key_hex = hex::encode(public_key.to_bytes());
45-
let is_valid = Wallet::verify_key_ownership_signature(nonce, &signature, &public_key_hex).await?;
46-
println!(" Signature Valid: {}", is_valid);
47-
println!();
48-
49-
// 5. List all wallets
50-
println!("📋 Available Wallets:");
51-
let wallets = Wallet::list_wallets().await?;
52-
for wallet_name in wallets {
53-
println!(" - {}", wallet_name);
54-
}
55-
println!();
56-
57-
// 6. Demonstrate peer connection (commented out as it requires SSL certs)
58-
println!("🌐 Peer Connection:");
59-
println!(" Note: Peer connection requires Chia SSL certificates.");
60-
println!(" Example methods available:");
61-
println!(" - Wallet::connect_mainnet_peer()");
62-
println!(" - Wallet::connect_testnet_peer()");
63-
println!(" - Wallet::connect_random_peer(network, cert_path, key_path)");
64-
65-
/*
66-
// Uncomment this section if you have Chia SSL certificates set up
67-
println!(" Attempting to connect to mainnet...");
68-
match Wallet::connect_mainnet_peer().await {
69-
Ok(_peer) => {
70-
println!(" ✅ Successfully connected to mainnet peer!");
71-
72-
// Example of using the peer for coin operations
73-
// let coins = wallet.select_unspent_coins(&peer, 1000000, 1000, vec![]).await?;
74-
// println!(" Found {} unspent coins", coins.len());
75-
}
76-
Err(e) => {
77-
println!(" ⚠️ Failed to connect: {}", e);
78-
println!(" This is expected if Chia SSL certificates are not set up.");
79-
}
80-
}
81-
*/
82-
83-
println!("\n🎉 Example completed successfully!");
84-
println!(" The Rust wallet now has full feature parity with the TypeScript version!");
85-
86-
Ok(())
87-
}
1+
use dig_wallet::{Wallet, WalletError};
2+
3+
#[tokio::main]
4+
async fn main() -> Result<(), WalletError> {
5+
println!("🚀 Dig Wallet Rust Example");
6+
println!("==========================\n");
7+
8+
// 1. Create or load a wallet
9+
println!("📝 Loading/Creating wallet...");
10+
let wallet = Wallet::load(Some("example_wallet".to_string()), true).await?;
11+
println!("✅ Wallet loaded successfully!\n");
12+
13+
// 2. Get wallet information
14+
println!("🔑 Wallet Information:");
15+
let mnemonic = wallet.get_mnemonic()?;
16+
println!(" Mnemonic: {} words", mnemonic.split_whitespace().count());
17+
18+
let address = wallet.get_owner_public_key().await?;
19+
println!(" Address: {}", address);
20+
21+
let puzzle_hash = wallet.get_owner_puzzle_hash().await?;
22+
println!(" Puzzle Hash: {}", hex::encode(puzzle_hash.as_ref()));
23+
println!();
24+
25+
// 3. Demonstrate address conversion
26+
println!("🔄 Address Conversion:");
27+
let converted_puzzle_hash = Wallet::address_to_puzzle_hash(&address)?;
28+
let converted_address = Wallet::puzzle_hash_to_address(converted_puzzle_hash, "xch")?;
29+
println!(" Original Address: {}", address);
30+
println!(" Converted Back: {}", converted_address);
31+
println!(" Conversion Match: {}", address == converted_address);
32+
println!();
33+
34+
// 4. Create a signature
35+
println!("✍️ Digital Signature:");
36+
let nonce = "example_nonce_12345";
37+
let signature = wallet.create_key_ownership_signature(nonce).await?;
38+
println!(" Nonce: {}", nonce);
39+
println!(" Signature: {}...", &signature[..32]);
40+
41+
// Verify the signature
42+
let public_key = wallet.get_public_synthetic_key().await?;
43+
let public_key_hex = hex::encode(public_key.to_bytes());
44+
let is_valid =
45+
Wallet::verify_key_ownership_signature(nonce, &signature, &public_key_hex).await?;
46+
println!(" Signature Valid: {}", is_valid);
47+
println!();
48+
49+
// 5. List all wallets
50+
println!("📋 Available Wallets:");
51+
let wallets = Wallet::list_wallets().await?;
52+
for wallet_name in wallets {
53+
println!(" - {}", wallet_name);
54+
}
55+
println!();
56+
57+
// 6. Demonstrate peer connection (commented out as it requires SSL certs)
58+
println!("🌐 Peer Connection:");
59+
println!(" Note: Peer connection requires Chia SSL certificates.");
60+
println!(" Example methods available:");
61+
println!(" - Wallet::connect_mainnet_peer()");
62+
println!(" - Wallet::connect_testnet_peer()");
63+
println!(" - Wallet::connect_random_peer(network, cert_path, key_path)");
64+
65+
/*
66+
// Uncomment this section if you have Chia SSL certificates set up
67+
println!(" Attempting to connect to mainnet...");
68+
match Wallet::connect_mainnet_peer().await {
69+
Ok(_peer) => {
70+
println!(" ✅ Successfully connected to mainnet peer!");
71+
72+
// Example of using the peer for coin operations
73+
// let coins = wallet.select_unspent_coins(&peer, 1000000, 1000, vec![]).await?;
74+
// println!(" Found {} unspent coins", coins.len());
75+
}
76+
Err(e) => {
77+
println!(" ⚠️ Failed to connect: {}", e);
78+
println!(" This is expected if Chia SSL certificates are not set up.");
79+
}
80+
}
81+
*/
82+
83+
println!("\n🎉 Example completed successfully!");
84+
println!(" The Rust wallet now has full feature parity with the TypeScript version!");
85+
86+
Ok(())
87+
}

‎src/error.rs

Lines changed: 40 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,40 @@
1-
use thiserror::Error;
2-
3-
#[derive(Error, Debug)]
4-
pub enum WalletError {
5-
#[error("Mnemonic seed phrase is required")]
6-
MnemonicRequired,
7-
8-
#[error("Provided mnemonic is invalid")]
9-
InvalidMnemonic,
10-
11-
#[error("Mnemonic seed phrase is not loaded")]
12-
MnemonicNotLoaded,
13-
14-
#[error("Wallet not found: {0}")]
15-
WalletNotFound(String),
16-
17-
#[error("Could not get fingerprint")]
18-
FingerprintError,
19-
20-
#[error("Could not get private key")]
21-
PrivateKeyError,
22-
23-
#[error("No unspent coins available")]
24-
NoUnspentCoins,
25-
26-
#[error("File system error: {0}")]
27-
FileSystemError(String),
28-
29-
#[error("Serialization error: {0}")]
30-
SerializationError(String),
31-
32-
#[error("Cryptographic error: {0}")]
33-
CryptoError(String),
34-
35-
#[error("Network error: {0}")]
36-
NetworkError(String),
37-
38-
#[error("DataLayer driver error: {0}")]
39-
DataLayerError(String),
40-
}
1+
use thiserror::Error;
2+
3+
#[derive(Error, Debug)]
4+
pub enum WalletError {
5+
#[error("Mnemonic seed phrase is required")]
6+
MnemonicRequired,
7+
8+
#[error("Provided mnemonic is invalid")]
9+
InvalidMnemonic,
10+
11+
#[error("Mnemonic seed phrase is not loaded")]
12+
MnemonicNotLoaded,
13+
14+
#[error("Wallet not found: {0}")]
15+
WalletNotFound(String),
16+
17+
#[error("Could not get fingerprint")]
18+
FingerprintError,
19+
20+
#[error("Could not get private key")]
21+
PrivateKeyError,
22+
23+
#[error("No unspent coins available")]
24+
NoUnspentCoins,
25+
26+
#[error("File system error: {0}")]
27+
FileSystemError(String),
28+
29+
#[error("Serialization error: {0}")]
30+
SerializationError(String),
31+
32+
#[error("Cryptographic error: {0}")]
33+
CryptoError(String),
34+
35+
#[error("Network error: {0}")]
36+
NetworkError(String),
37+
38+
#[error("DataLayer driver error: {0}")]
39+
DataLayerError(String),
40+
}

0 commit comments

Comments
 (0)