Skip to content

Commit f506660

Browse files
Update README.md
1 parent f100b30 commit f506660

File tree

1 file changed

+6
-10
lines changed

1 file changed

+6
-10
lines changed

rust/threshold-schnorr/README.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,7 @@ make test
5151
```
5252

5353
#### What this does
54-
- `make deploy` deploys the canister code on the local version of the IC
55-
- `npm install @noble/curves` installs a test javascript dependency
56-
- `make test` deploys and tests the canister code on the local version of the IC
54+
- `make deploy` deploys the canister code on the local version of the IC.
5755

5856
If deployment was successful, you should see something like this:
5957

@@ -66,8 +64,6 @@ URLs:
6664

6765
If you open the URL in a web browser, you will see a web UI that shows the
6866
`sign`, and `verify` methods, those are rendered in the web UI.
69-
public methods the canister exposes. Since the canister exposes `public_key` and
70-
`sign`, those are rendered in the web UI.
7167

7268
## Deploying the canister on the mainnet
7369

@@ -80,7 +76,7 @@ To deploy this canister the mainnet, one needs to do two things:
8076

8177
Deploying to the Internet Computer requires [cycles](https://internetcomputer.org/docs/current/developer-docs/getting-started/tokens-and-cycles) (the equivalent of "gas" on other blockchains).
8278

83-
#### Update management canister ID reference for testing
79+
### Update management canister ID reference for testing
8480

8581
The latest version of `dfx`, `v0.24.3`, does not yet support
8682
`opt_merkle_tree_root_hex` that is not `None`. Therefore, for local tests, [the
@@ -96,7 +92,7 @@ automatically with `make mock`, which will install the chain-key testing caniste
9692
and use it instead of the management canister. Note that `dfx` should be running
9793
to successfully run `make mock`.
9894

99-
#### Update source code with the right key ID
95+
### Update source code with the right key ID
10096

10197
To deploy the sample code, the canister needs the right key ID for the right environment. Specifically, one needs to replace the value of the `key_id` in the `src/schnorr_example_rust/src/lib.rs` file of the sample code. Before deploying to mainnet, one should modify the code to use the right name of the `key_id`.
10298

@@ -113,8 +109,8 @@ the key ID as follows and can be deployed locally:
113109
`SchnorrKeyIds::TestKeyLocalDevelopment.to_key_id(algorithm)`
114110

115111
IMPORTANT: To deploy to IC mainnet, one needs to replace `"dfx_test_key"` with
116-
either "test_key_1"` or `"key_1"` depending on the desired intent. Both uses of
117-
key ID in `src/schnorr_example_rust/src/main.mo` must be consistent.
112+
either `"test_key_1"` or `"key_1"` depending on the desired intent. Both uses of
113+
key ID in `src/schnorr_example_rust/src/lib.rs` must be consistent.
118114

119115
### Deploying
120116

@@ -274,7 +270,7 @@ async fn sign(
274270

275271
For completeness of the example, we show that the created signatures can be
276272
verified with the public key corresponding to the same canister and derivation
277-
path path. Note that the first byte of the BIP340 public key needs to be removed for
273+
path. Note that the first byte of the BIP340 public key needs to be removed for
278274
verification, which is done by the verification function below internally.
279275

280276
```rust

0 commit comments

Comments
 (0)