bitski 0.1.0

Bitski Rust SDK
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

# Bitski Rust SDK

## Install

```toml
bitski = "0.1.0"
bitski-provider = "0.1.0"
```

## Connect via OAuth

Can auth via your Bitski credentials and return a web3 provider.

```rust,no_run
fn main() {
    let bitski = bitski::Bitski::from_env().expect("Could not initialize");
    let network = "mainnet";
    let provider = bitski
        .get_provider(network)
        .expect("Could not get provider");
}
```

## Local node with Anvil

If you would like to use a local node, i.e. during tests, add a dependency on
the `bitski-local` package:

```toml
bitski = { git = "https://github.com/BitskiCo/bitski-rs" }
bitski-local = { git = "https://github.com/BitskiCo/bitski-rs" }
```

This installs [Anvil](https://github.com/foundry-rs/foundry/tree/master/anvil),
an Ethereum node written in Rust that can be used for testing RPC calls,
contract interactions, etc. It can be run directly in your Rust program, so a
CLI program like Ganache or Hardhat Network aren't needed.

```rust,ignore
use bitski::Bitski;
use bitski_local::{Anvil, BitskiLocalExt};

fn main() {
    // Start an Anvil node at `localhost:8545` and initialize a provider
    let _anvil = Anvil::new(None).await;
    let bitski = Bitski::new_local_mode(None);

    // Or, specify a port to run on
    // let anvil = Anvil::new(Some(8888)).await;
    // let bitski = Bitski::new_local_mode(Some(anvil.rpc_url.clone()));

    // Get a web3 provider
    let web3 = bitski
        .into_inner()
        .get_web3_test_mode("anvil")
        .expect("Could not get web3 provider");
}
```