forge_wallet 0.1.3

The rust language implementation of forge_wallet
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

### Intro
`forge_wallet` implement by `Rust`. Based on [forge_crypter](https://crates.io/crates/forge_crypter), [forge_hasher](https://crates.io/crates/forge_hasher), [forge_signer](https://crates.io/crates/forge_signer), [forge_did](https://crates.io/crates/forge_did).

The crate provides some help functions to help user create wallet.

### Struct Wallet
```rust
    pub struct Wallet {
        pub w_type: WalletType,
        pub sk: Vec<u8>,
        pub pk: Vec<u8>,
        pub address: String,
    }
```

### API
- ` create_default_wallet() -> Result<Wallet>`
- ` from_wallet_type(w_type: &WalletType) -> Result<Wallet>`
- ` from_address(addr: &str) -> Result<Wallet>`
- ` from_pk(pk: &[u8], w_type: &WalletType) -> Result<Wallet>`
- ` from_sk(sk: &[u8], w_type: &WalletType) -> Result<Wallet>`
- ` from_json(j: Value) -> Result<Wallet>`
- ` to_json(&self) -> Result<Value>`
- ` verify(&self, message: &[u8], signature: &[u8]) -> Result<bool>`
- ` hash(&self, message: &[u8]) -> Result<Vec<u8>>`
- ` sign(&self, message: &[u8]) -> Result<Vec<u8>>`
- ` format_wallet(&mut self) -> Result<()>`
- ` is_valid(wallet: &Wallet) -> bool`

### Usage

```rust
    let wallet_type = WalletType {
            role_type: Some(RoleType::Application),
            key_type: Some(KeyType::Ed25519),
            hash_type: Some(HashType::Sha3),
        };
    let wallet = from_wallet_type(&wallet_type)?;
    assert_eq!(wallet, from_sk(&wallet.sk, &wallet_type)?);

    let message = b"hello rust";
    let signature = wallet.sign(message)?;
    assert!(wallet.verify(message, &signature))?;
```