Skip to content

Commit ccf3ea2

Browse files
chore(deps): bump clap from 4.5.42 to 4.5.43 (#691)
* chore(deps): bump clap from 4.5.42 to 4.5.43 Bumps [clap](https://github.com/clap-rs/clap) from 4.5.42 to 4.5.43. - [Release notes](https://github.com/clap-rs/clap/releases) - [Changelog](https://github.com/clap-rs/clap/blob/master/CHANGELOG.md) - [Commits](clap-rs/clap@clap_complete-v4.5.42...clap_complete-v4.5.43) --- updated-dependencies: - dependency-name: clap dependency-version: 4.5.43 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> * clippy * clippy --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Jorge Antonio <matroid@outlook.com>
1 parent b9089a6 commit ccf3ea2

4 files changed

Lines changed: 61 additions & 61 deletions

File tree

Cargo.lock

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ blake3 = "1.8.2"
3333
bytes = "1.10.0"
3434
chrono = "0.4.41"
3535
ciborium = "0.2.2"
36-
clap = "4.5.41"
36+
clap = "4.5.43"
3737
config = "0.14.0"
3838
dashmap = "6.1.0"
3939
dotenvy = "0.15.7"

atoma-sui/src/client.rs

Lines changed: 40 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -133,9 +133,9 @@ impl Client {
133133
///
134134
/// # Arguments
135135
///
136-
/// * `gas` - Optional ObjectID to use as gas for the transaction. If None, the system will
136+
/// * `gas` - Optional `ObjectID` to use as gas for the transaction. If None, the system will
137137
/// automatically select a gas object.
138-
/// * `gas_budget` - Optional gas budget for the transaction. If None, defaults to GAS_BUDGET
138+
/// * `gas_budget` - Optional gas budget for the transaction. If None, defaults to `GAS_BUDGET`
139139
/// constant (5,000,000 MIST = 0.005 SUI).
140140
/// * `gas_price` - Optional gas price for the transaction. If None, uses the network's
141141
/// reference gas price.
@@ -233,9 +233,9 @@ impl Client {
233233
///
234234
/// * `model_name` - The name of the model to subscribe to
235235
/// * `echelon` - The echelon level for the subscription (0-255)
236-
/// * `node_badge_id` - Optional ObjectID of the node badge. If None, uses the client's stored badge
237-
/// * `gas` - Optional ObjectID to use as gas for the transaction
238-
/// * `gas_budget` - Optional gas budget for the transaction. If None, defaults to GAS_BUDGET
236+
/// * `node_badge_id` - Optional `ObjectID` of the node badge. If None, uses the client's stored badge
237+
/// * `gas` - Optional `ObjectID` to use as gas for the transaction
238+
/// * `gas_budget` - Optional gas budget for the transaction. If None, defaults to `GAS_BUDGET`
239239
/// * `gas_price` - Optional gas price for the transaction. If None, uses network's reference price
240240
///
241241
/// # Returns
@@ -347,11 +347,11 @@ impl Client {
347347
/// # Arguments
348348
///
349349
/// * `task_small_id` - The small ID of the task to subscribe to
350-
/// * `node_badge_id` - Optional Node badge ID of the node. If None, uses the client's stored badge ID
350+
/// * `node_badge_id` - Optional `ObjectID` of the node badge. If None, uses the client's stored badge ID
351351
/// * `price_per_one_million_compute_units` - The price per compute unit the node is willing to charge
352-
/// * `gas` - Optional ObjectID to use as gas for the transaction
353-
/// * `gas_budget` - Optional gas budget for the transaction. If None, defaults to GAS_BUDGET
354-
/// * `gas_price` - Optional gas price for the transaction. If None, uses network's reference price
352+
/// * `gas` - Optional `ObjectID` to use as gas for the transaction
353+
/// * `gas_budget` - Optional gas budget for the transaction. If None, defaults to `GAS_BUDGET`
354+
/// * `gas_price` - Optional gas price for the transaction. If None, uses the network's reference price
355355
///
356356
/// # Returns
357357
///
@@ -461,11 +461,11 @@ impl Client {
461461
/// # Arguments
462462
///
463463
/// * `task_small_id` - The small ID of the task to update the subscription for
464-
/// * `node_badge_id` - Optional Node badge ID of the node. If None, uses the client's stored badge ID
464+
/// * `node_badge_id` - Optional `ObjectID` of the node badge. If None, uses the client's stored badge ID
465465
/// * `price_per_one_million_compute_units` - The new price per compute unit for the task subscription
466-
/// * `gas` - Optional ObjectID to use as gas for the transaction
467-
/// * `gas_budget` - Optional gas budget for the transaction. If None, defaults to GAS_BUDGET
468-
/// * `gas_price` - Optional gas price for the transaction. If None, uses network's reference price
466+
/// * `gas` - Optional `ObjectID` to use as gas for the transaction
467+
/// * `gas_budget` - Optional gas budget for the transaction. If None, defaults to `GAS_BUDGET`
468+
/// * `gas_price` - Optional gas price for the transaction. If None, uses the network's reference price
469469
///
470470
/// # Returns
471471
///
@@ -582,10 +582,10 @@ impl Client {
582582
/// # Arguments
583583
///
584584
/// * `task_small_id` - The small ID of the task to unsubscribe from
585-
/// * `node_badge_id` - Optional Node badge ID of the node. If None, uses the client's stored badge ID
586-
/// * `gas` - Optional ObjectID to use as gas for the transaction
587-
/// * `gas_budget` - Optional gas budget for the transaction. If None, defaults to GAS_BUDGET
588-
/// * `gas_price` - Optional gas price for the transaction. If None, uses network's reference price
585+
/// * `node_badge_id` - Optional `ObjectID` of the node badge. If None, uses the client's stored badge ID
586+
/// * `gas` - Optional `ObjectID` to use as gas for the transaction
587+
/// * `gas_budget` - Optional gas budget for the transaction. If None, defaults to `GAS_BUDGET`
588+
/// * `gas_price` - Optional gas price for the transaction. If None, uses the network's reference price
589589
///
590590
/// # Returns
591591
///
@@ -689,13 +689,13 @@ impl Client {
689689
/// # Arguments
690690
///
691691
/// * `stack_small_id` - The small ID of the stack to settle
692-
/// * `node_badge_id` - Optional Node badge ID of the node. If None, uses the client's stored badge ID
692+
/// * `node_badge_id` - Optional `ObjectID` of the node badge. If None, uses the client's stored badge ID
693693
/// * `num_claimed_compute_units` - The number of compute units being claimed for this stack
694694
/// * `committed_stack_proof` - The proof data for the committed stack
695695
/// * `stack_merkle_leaf` - The merkle leaf data for the stack
696-
/// * `gas` - Optional ObjectID to use as gas for the transaction
697-
/// * `gas_budget` - Optional gas budget for the transaction. If None, defaults to GAS_BUDGET
698-
/// * `gas_price` - Optional gas price for the transaction. If None, uses network's reference price
696+
/// * `gas` - Optional `ObjectID` to use as gas for the transaction
697+
/// * `gas_budget` - Optional gas budget for the transaction. If None, defaults to `GAS_BUDGET`
698+
/// * `gas_price` - Optional gas price for the transaction. If None, uses the network's reference price
699699
///
700700
/// # Returns
701701
///
@@ -815,12 +815,12 @@ impl Client {
815815
/// # Arguments
816816
///
817817
/// * `stack_small_id` - The small ID of the stack being attested
818-
/// * `node_badge_id` - Optional Node badge ID of the node. If None, uses the client's stored badge ID
818+
/// * `node_badge_id` - Optional `ObjectID` of the node badge. If None, uses the client's stored badge ID
819819
/// * `committed_stack_proof` - The proof data for the committed stack
820820
/// * `stack_merkle_leaf` - The merkle leaf data for the stack
821-
/// * `gas` - Optional ObjectID to use as gas for the transaction
822-
/// * `gas_budget` - Optional gas budget for the transaction. If None, defaults to GAS_BUDGET
823-
/// * `gas_price` - Optional gas price for the transaction. If None, uses network's reference price
821+
/// * `gas` - Optional `ObjectID` to use as gas for the transaction
822+
/// * `gas_budget` - Optional gas budget for the transaction. If None, defaults to `GAS_BUDGET`
823+
/// * `gas_price` - Optional gas price for the transaction. If None, uses the network's reference price
824824
///
825825
/// # Returns
826826
///
@@ -936,11 +936,11 @@ impl Client {
936936
/// # Arguments
937937
///
938938
/// * `stack_small_id` - The small ID of the stack being disputed
939-
/// * `node_badge_id` - Optional Node badge ID of the node. If None, uses the client's stored badge ID
939+
/// * `node_badge_id` - Optional `ObjectID` of the node badge. If None, uses the client's stored badge ID
940940
/// * `committed_stack_proof` - The proof data for the committed stack that supports the dispute
941-
/// * `gas` - Optional ObjectID to use as gas for the transaction
942-
/// * `gas_budget` - Optional gas budget for the transaction. If None, defaults to GAS_BUDGET
943-
/// * `gas_price` - Optional gas price for the transaction. If None, uses network's reference price
941+
/// * `gas` - Optional `ObjectID` to use as gas for the transaction
942+
/// * `gas_budget` - Optional gas budget for the transaction. If None, defaults to `GAS_BUDGET`
943+
/// * `gas_price` - Optional gas price for the transaction. If None, uses the network's reference price
944944
///
945945
/// # Returns
946946
///
@@ -1050,10 +1050,10 @@ impl Client {
10501050
/// # Arguments
10511051
///
10521052
/// * `settled_ticket_ids` - A vector of ticket IDs that have been settled and are ready for claiming
1053-
/// * `node_badge_id` - Optional Node badge ID of the node. If None, uses the client's stored badge ID
1054-
/// * `gas` - Optional ObjectID to use as gas for the transaction
1055-
/// * `gas_budget` - Optional gas budget for the transaction. If None, defaults to GAS_BUDGET
1056-
/// * `gas_price` - Optional gas price for the transaction. If None, uses network's reference price
1053+
/// * `node_badge_id` - Optional `ObjectID` of the node badge. If None, uses the client's stored badge ID
1054+
/// * `gas` - Optional `ObjectID` to use as gas for the transaction
1055+
/// * `gas_budget` - Optional gas budget for the transaction. If None, defaults to `GAS_BUDGET`
1056+
/// * `gas_price` - Optional gas price for the transaction. If None, uses the network's reference price
10571057
///
10581058
/// # Returns
10591059
///
@@ -1159,11 +1159,11 @@ impl Client {
11591159
/// # Arguments
11601160
///
11611161
/// * `stack_small_ids` - A vector of stack small IDs that have been settled and are ready for claiming
1162-
/// * `node_badge_id` - Optional Node badge ID of the node. If None, uses the client's stored badge ID
1162+
/// * `node_badge_id` - Optional `ObjectID` of the node badge. If None, uses the client's stored badge ID
11631163
/// * `num_claimed_compute_units` - A vector of the number of compute units claimed for each stack
1164-
/// * `gas` - Optional ObjectID to use as gas for the transaction
1165-
/// * `gas_budget` - Optional gas budget for the transaction. If None, defaults to GAS_BUDGET
1166-
/// * `gas_price` - Optional gas price for the transaction. If None, uses network's reference price
1164+
/// * `gas` - Optional `ObjectID` to use as gas for the transaction
1165+
/// * `gas_budget` - Optional gas budget for the transaction. If None, defaults to `GAS_BUDGET`
1166+
/// * `gas_price` - Optional gas price for the transaction. If None, uses the network's reference price
11671167
///
11681168
/// # Returns
11691169
///
@@ -1304,10 +1304,10 @@ impl Client {
13041304
/// * `key_rotation_counter` - The key rotation counter value
13051305
/// * `device_type` - The device type identifier (as a u16)
13061306
/// * `task_small_id` - Optional small ID of the task
1307-
/// * `gas` - Optional ObjectID to use as gas for the transaction. If None, the system will
1307+
/// * `gas` - Optional `ObjectID` to use as gas for the transaction. If None, the system will
13081308
/// automatically select a gas object
1309-
/// * `gas_budget` - Optional gas budget for the transaction. If None, defaults to GAS_BUDGET
1310-
/// * `gas_price` - Optional gas price for the transaction. If None, uses network's reference price
1309+
/// * `gas_budget` - Optional gas budget for the transaction. If None, defaults to `GAS_BUDGET`
1310+
/// * `gas_price` - Optional gas price for the transaction. If None, uses the network's reference price
13111311
///
13121312
/// # Returns
13131313
///

atoma-sui/src/subscriber.rs

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -142,26 +142,26 @@ impl Subscriber {
142142
)
143143
}
144144

145-
/// Builds a SuiClient based on the provided configuration.
145+
/// Builds a `SuiClient` based on the provided configuration.
146146
///
147-
/// This asynchronous method creates a new SuiClient instance using the settings
148-
/// specified in the AtomaSuiConfig. It sets up the client with the
147+
/// This asynchronous method creates a new `SuiClient` instance using the settings
148+
/// specified in the `AtomaSuiConfig`. It sets up the client with the
149149
/// configured request timeout and HTTP RPC node address.
150150
///
151151
/// # Arguments
152152
///
153-
/// * `config` - A reference to a AtomaSuiConfig containing the necessary
153+
/// * `config` - A reference to a `AtomaSuiConfig` containing the necessary
154154
/// configuration parameters.
155155
///
156156
/// # Returns
157157
///
158-
/// * `Result<SuiClient>` - A Result containing the newly created SuiClient if successful,
159-
/// or a SuiEventSubscriberError if the client creation fails.
158+
/// * `Result<SuiClient>` - A `Result` containing the newly created `SuiClient` if successful,
159+
/// or a `SuiEventSubscriberError` if the client creation fails.
160160
///
161161
/// # Errors
162162
///
163163
/// This function will return an error if:
164-
/// * The SuiClient cannot be built with the provided configuration.
164+
/// * The `SuiClient` cannot be built with the provided configuration.
165165
/// * There's a network issue when connecting to the specified RPC node.
166166
#[instrument(level = "info", skip_all, fields(
167167
http_rpc_node_addr = %config.http_rpc_node_addr()
@@ -182,13 +182,13 @@ impl Subscriber {
182182
///
183183
/// 1. Stack Retrieval:
184184
/// - Receives transaction digests and responds with compute units information
185-
/// - Processes StackCreatedEvents from transactions and forwards them to the state manager
185+
/// - Processes `StackCreatedEvents` from transactions and forwards them to the state manager
186186
///
187187
/// 2. Event Processing:
188188
/// - Queries for new events using the configured filter and cursor
189189
/// - Parses and filters events based on node and task IDs
190190
/// - Forwards relevant events to the state manager
191-
/// - Updates the cursor periodically (every CURSOR_FILE_UPDATE_ITERATIONS)
191+
/// - Updates the cursor periodically (every `CURSOR_FILE_UPDATE_ITERATIONS`)
192192
/// - Implements backoff when no new events are available
193193
///
194194
/// 3. Shutdown Handling:
@@ -202,7 +202,7 @@ impl Subscriber {
202202
/// # Errors
203203
///
204204
/// This method may return an error if:
205-
/// * There's a failure in building the Sui client
205+
/// * There's a failure in building the `SuiClient`
206206
/// * Event querying encounters an error
207207
/// * Stack retrieval operations fail
208208
/// * Event processing fails
@@ -212,7 +212,7 @@ impl Subscriber {
212212
/// # Errors
213213
///
214214
/// This method may return an error if:
215-
/// * The Sui client cannot be built
215+
/// * The `SuiClient` cannot be built
216216
/// * Event querying encounters an error
217217
/// * Stack retrieval operations fail
218218
/// * Event processing fails
@@ -222,7 +222,7 @@ impl Subscriber {
222222
/// # Panics
223223
///
224224
/// This method may panic if:
225-
/// * The Sui client cannot be built
225+
/// * The `SuiClient` cannot be built
226226
/// * Event querying encounters an error
227227
/// * Stack retrieval operations fail
228228
#[instrument(level = "trace", skip_all, fields(package_id))]
@@ -433,7 +433,7 @@ impl Subscriber {
433433
/// # Examples
434434
///
435435
/// ```rust,ignore
436-
/// # use your_crate::{AtomaEventIdentifier, AtomaEvent, SuiEventSubscriber};
436+
/// # use atoma_sui::{AtomaEventIdentifier, AtomaEvent, SuiEventSubscriber};
437437
/// # async fn example(subscriber: &SuiEventSubscriber) -> Result<(), Box<dyn std::error::Error>> {
438438
/// let event_id = AtomaEventIdentifier::TaskRegisteredEvent;
439439
/// let event = AtomaEvent::TaskRegisteredEvent(/* ... */);
@@ -559,7 +559,7 @@ fn write_cursor_to_toml_file(cursor: Option<EventID>, path: &str) -> Result<()>
559559
///
560560
/// * `event` - A reference to the `AtomaEvent` enum indicating the type of event to handle
561561
/// * `value` - The serialized event data as a `serde_json::Value`
562-
/// * `db` - A reference to the SQLite connection pool for database operations
562+
/// * `db` - A reference to the `SQLite` connection pool for database operations
563563
/// * `node_small_ids` - A slice of node IDs that are relevant for the current context
564564
///
565565
/// # Returns
@@ -686,15 +686,15 @@ async fn parse_event(
686686
}
687687
}
688688

689-
/// Filters an Atoma event based on a list of node small IDs.
689+
/// Filters an `AtomaEvent` based on a list of node small IDs.
690690
///
691691
/// This function checks if the given event is related to any of the nodes specified by their small IDs.
692692
/// For node-specific events (like registration, subscriptions, etc.), it returns true only if the
693693
/// event's node small ID is in the provided list. For all other event types, it returns true.
694694
///
695695
/// # Arguments
696696
///
697-
/// * `event` - Reference to the Atoma event to filter
697+
/// * `event` - Reference to the `AtomaEvent` to filter
698698
/// * `node_small_ids` - Slice containing the node small IDs to filter by
699699
///
700700
/// # Returns

0 commit comments

Comments
 (0)