Skip to content

Commit 188da29

Browse files
prestwichdylanlott
authored andcommitted
nits: doc updates
1 parent e84fa00 commit 188da29

File tree

2 files changed

+5
-6
lines changed

2 files changed

+5
-6
lines changed

src/config.rs

+4-5
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,8 @@ use alloy::{
1010
},
1111
},
1212
};
13-
use std::{borrow::Cow, env, num, str::FromStr};
14-
1513
use signet_zenith::Zenith;
14+
use std::{borrow::Cow, env, num, str::FromStr};
1615

1716
// Keys for .env variables that need to be set to configure the builder.
1817
const HOST_CHAIN_ID: &str = "HOST_CHAIN_ID";
@@ -125,7 +124,7 @@ impl ConfigError {
125124
}
126125
}
127126

128-
/// Defines a full provider.
127+
/// Type alias for the provider used in the builder.
129128
pub type Provider = FillProvider<
130129
JoinFill<
131130
JoinFill<
@@ -138,7 +137,7 @@ pub type Provider = FillProvider<
138137
Ethereum,
139138
>;
140139

141-
/// Defines a provider type used to read-only.
140+
/// Type alias for the provider used in the builder, without a wallet.
142141
pub type WalletlessProvider = FillProvider<
143142
JoinFill<
144143
Identity,
@@ -148,7 +147,7 @@ pub type WalletlessProvider = FillProvider<
148147
Ethereum,
149148
>;
150149

151-
/// Defines a [`Zenith`] instance that is generic over [`Provider`]
150+
/// A [`Zenith`] contract instance using [`Provider`] as the provider.
152151
pub type ZenithInstance<P = Provider> = Zenith::ZenithInstance<(), P, alloy::network::Ethereum>;
153152

154153
impl BuilderConfig {

src/lib.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,5 +27,5 @@ pub mod tasks;
2727
/// Utilities.
2828
pub mod utils;
2929

30-
/// Anonymous crate dependency imports.
30+
// Anonymous import suppresses warnings about unused imports.
3131
use openssl as _;

0 commit comments

Comments
 (0)