Skip to content
This repository was archived by the owner on Nov 20, 2023. It is now read-only.

Commit d261531

Browse files
authored
chore:doc:replace secp256k1 to k256 in examples (#30)
* chore:doc:fix k256 examples * chore:doc:rename secp256k1 to k256 * chore:doc:minor tweaks
1 parent 32a5620 commit d261531

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -57,16 +57,16 @@ enr = { version = "*", features = ["serde", "ed25519", "rust-secp256k1"] }
5757

5858
To build an ENR, an `EnrBuilder` is provided.
5959

60-
#### Building an ENR with the default `secp256k1` key type
60+
#### Building an ENR with the default `k256` key type
6161

6262
```rust
63-
use enr::{EnrBuilder, secp256k1};
63+
use enr::{EnrBuilder, k256};
6464
use std::net::Ipv4Addr;
6565
use rand::thread_rng;
6666

67-
// generate a random secp256k1 key
6867
let mut rng = thread_rng();
69-
let key = secp256k1::SecretKey::random(&mut rng);
68+
// generate a random k256 key
69+
let key = k256::ecdsa::SigningKey::random(&mut rng);
7070

7171
let ip = Ipv4Addr::new(192,168,0,1);
7272
let enr = EnrBuilder::new("v4").ip(ip.into()).tcp(8000).build(&key).unwrap();
@@ -84,7 +84,7 @@ Note the `ed25519` feature flag must be set. This makes use of the
8484
use enr::{EnrBuilder, CombinedKey};
8585
use std::net::Ipv4Addr;
8686

87-
// create a new secp256k1 key
87+
// create a new k256 key
8888
let key = CombinedKey::generate_secp256k1();
8989

9090
// or create a new ed25519 key
@@ -103,44 +103,43 @@ Enr fields can be added and modified using the getters/setters on `Enr`. A custo
103103
can be added using `insert` and retrieved with `get`.
104104

105105
```rust
106-
use enr::{EnrBuilder, secp256k1::SecretKey, Enr};
106+
use enr::{EnrBuilder, k256::ecdsa::SigningKey, Enr};
107107
use std::net::Ipv4Addr;
108108
use rand::thread_rng;
109109

110-
// generate a random secp256k1 key
110+
// generate a random k256 key
111111
let mut rng = thread_rng();
112-
let key = SecretKey::random(&mut rng);
112+
let key = SigningKey::random(&mut rng);
113113

114114
let ip = Ipv4Addr::new(192,168,0,1);
115115
let mut enr = EnrBuilder::new("v4").ip(ip.into()).tcp(8000).build(&key).unwrap();
116116

117117
enr.set_tcp(8001, &key);
118118
// set a custom key
119-
enr.insert("custom_key", vec![0,0,1], &key);
119+
enr.insert("custom_key", &vec![0,0,1], &key);
120120

121121
// encode to base64
122122
let base_64_string = enr.to_base64();
123123

124124
// decode from base64
125-
let decoded_enr: Enr = base_64_string.parse().unwrap();
125+
let decoded_enr: Enr<SigningKey> = base_64_string.parse().unwrap();
126126

127127
assert_eq!(decoded_enr.ip(), Some("192.168.0.1".parse().unwrap()));
128128
assert_eq!(decoded_enr.id(), Some("v4".into()));
129129
assert_eq!(decoded_enr.tcp(), Some(8001));
130-
assert_eq!(decoded_enr.get("custom_key"), Some(&vec![0,0,1]));
130+
assert_eq!(decoded_enr.get("custom_key"), Some(vec![0,0,1].as_slice()));
131131
```
132132

133133
#### Encoding/Decoding ENR's of various key types
134134

135135
```rust
136-
use enr::{EnrBuilder, secp256k1::SecretKey, Enr, ed25519_dalek::Keypair, CombinedKey};
136+
use enr::{EnrBuilder, k256::ecdsa::SigningKey, Enr, ed25519_dalek::Keypair, CombinedKey};
137137
use std::net::Ipv4Addr;
138138
use rand::thread_rng;
139-
use rand::Rng;
140139

141-
// generate a random secp256k1 key
140+
// generate a random k256 key
142141
let mut rng = thread_rng();
143-
let key = SecretKey::random(&mut rng);
142+
let key = SigningKey::random(&mut rng);
144143
let ip = Ipv4Addr::new(192,168,0,1);
145144
let enr_secp256k1 = EnrBuilder::new("v4").ip(ip.into()).tcp(8000).build(&key).unwrap();
146145

@@ -156,10 +155,11 @@ let base64_string_ed25519 = enr_ed25519.to_base64();
156155

157156
// decode base64 strings of varying key types
158157
// decode the secp256k1 with default Enr
159-
let decoded_enr_secp256k1: Enr = base64_string_secp256k1.parse().unwrap();
158+
let decoded_enr_secp256k1: Enr<SigningKey> = base64_string_secp256k1.parse().unwrap();
160159
// decode ed25519 ENRs
161160
let decoded_enr_ed25519: Enr<Keypair> = base64_string_ed25519.parse().unwrap();
162161

163162
// use the combined key to be able to decode either
164163
let decoded_enr: Enr<CombinedKey> = base64_string_secp256k1.parse().unwrap();
165164
let decoded_enr: Enr<CombinedKey> = base64_string_ed25519.parse().unwrap();
165+
```

0 commit comments

Comments
 (0)