turnkey_client 0.5.0

A Rust client to interact with the Turnkey API.
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

# `turnkey_client`

This crate contains an HTTP client to interact with the Turnkey API ([documentation](https://docs.turnkey.com/api-reference/overview)).

## Usage

To make a request to Turnkey:

```rust,no_run
use turnkey_client::generated::SignRawPayloadIntentV2;
use turnkey_client::generated::immutable::common::v1::HashFunction;
use turnkey_client::generated::immutable::common::v1::PayloadEncoding;

// You can load your API key from a file or from env
let api_key = turnkey_client::TurnkeyP256ApiKey::from_strings("<private key hex>", None).expect("api key creation failed");

// Create a new client:
let client = turnkey_client::TurnkeyClient::builder().api_key(api_key).build().expect("client builder failed");

// Make a request (for example, a signature request)
let request = client.sign_raw_payload(
    "your-turnkey-organization-id".to_string(),
    client.current_timestamp(),
    SignRawPayloadIntentV2 {
        sign_with: "0x123456".to_string(), // Turnkey address
        payload: "hello from TKHQ".to_string(),
        encoding: PayloadEncoding::TextUtf8,
        hash_function: HashFunction::Keccak256, // assuming ETH
    },
);

// You can then call `request.await?` to get the signature result
```

## Advanced usage

The Turnkey client uses `reqwest` under the hood. To access the `reqwest` builder, use the following:
```rust
let api_key = turnkey_client::TurnkeyP256ApiKey::generate();

let client = turnkey_client::TurnkeyClient::builder()
    .api_key(api_key)
    .with_reqwest_builder(|b| b.connection_verbose(true));
```

Additional `reqwest` features can be enabled in your `Cargo.toml`:
```toml
[dependencies]
turnkey_client = { version = "0.0.2", features = ["reqwest_native_tls", "reqwest_brotli", "reqwest_zstd", "reqwest_hickory_dns"] }
```