Skip to content

Commit 5b51899

Browse files
committed
typos
1 parent 2f85133 commit 5b51899

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

docs/docs/developing/commit-module.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ sidebar_position: 2
44

55
# Commit Module
66

7-
While a module can be written in any language, we currently provide some utils for Rust, with the goal of supporting more generalized APIs and simplify development in languages other than Rust.
7+
While a module can be written in any language, we currently provide some utilities for Rust, with the goal of supporting more generalized APIs and simplify development in languages other than Rust.
88

99
:::note
1010
Commit-Boost is still in alpha development, all APIs are subject to change
@@ -25,7 +25,7 @@ use commit_boost::prelude::*;
2525
## Config
2626
Your module will likely need a configuration for the Node Operator to customize. This will have to be in the `cb-config.toml` file, in the correct `[[module]]` section. In the module, you can define and load your config as follows.
2727

28-
First define all the parameters needed in a struct:
28+
First, define all the parameters needed in a struct:
2929
```rust
3030
#[derive(Debug, Deserialize)]
3131
struct ExtraConfig {
@@ -109,7 +109,7 @@ You can use the `prometheus` crate to create a custom registry and metrics, for
109109

110110
```rust
111111
static ref MY_CUSTOM_REGISTRY: Registry = Registry::new_custom(Some("da_commit".to_string()), None).unwrap();
112-
static ref SIG_RECEIVED_COUNTER: IntCounter = IntCounter::new("signature_received", "successful signatures requests received").unwrap();
112+
static ref SIG_RECEIVED_COUNTER: IntCounter = IntCounter::new("signature_received", "successful signature requests received").unwrap();
113113
```
114114

115115
### Start Metrics Provider
@@ -125,4 +125,4 @@ All that is left is to use the metrics throughout your code:
125125
```rust
126126
SIG_RECEIVED_COUNTER.inc();
127127
```
128-
These will automatically scraped by the Prometheus service running, and exposed on port `9090`. We plan to allow developers to ship pre-made dashboards together with their modules, to allow Node Operators to have an improved oversight on the modules they are running.
128+
These will be automatically scraped by the Prometheus service running, and exposed on port `9090`. We plan to allow developers to ship pre-made dashboards together with their modules, to allow Node Operators to have an improved oversight on the modules they are running.

docs/docs/get_started/running/binary.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ For loading keys we currently support:
3535
- `CB_MODULE_ID`: required, unique id of the module
3636

3737
#### Commit modules
38-
- `CB_SIGNER_URL`: requred, url to the signer module server
38+
- `CB_SIGNER_URL`: required, url to the signer module server
3939
- `CB_SIGNER_JWT`: required, jwt to use to for signature requests (needs to match what is in `CB_JWTS`)
4040

4141
#### Events modules

0 commit comments

Comments
 (0)