Skip to content

Commit 9448396

Browse files
sergeradsergerad
committed
Expand get_account_inputs comment
1 parent f7eacbe commit 9448396

5 files changed

Lines changed: 15 additions & 11 deletions

File tree

‎crates/ntx-builder/src/store.rs‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,10 @@ impl StoreClient {
150150
}
151151

152152
/// Get the inputs for an account at a given block number from the store.
153+
///
154+
/// Retrieves account details from the store. The retrieved details are limited to the account
155+
/// code, account header, and storage header. The vault and storage slots are not required for
156+
/// the purposes of the NTX Builder.
153157
#[instrument(target = COMPONENT, name = "store.client.get_account_inputs", skip_all, err)]
154158
pub async fn get_account_inputs(
155159
&self,

‎crates/proto/src/generated/rpc.rs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ pub struct MaybeNoteScript {
9393
#[prost(message, optional, tag = "1")]
9494
pub script: ::core::option::Option<super::note::NoteScript>,
9595
}
96-
/// Returns the latest state proof of the specified account.
96+
/// Defines the request for account details.
9797
#[derive(Clone, PartialEq, ::prost::Message)]
9898
pub struct AccountRequest {
9999
/// ID of the account for which we want to get data
@@ -747,7 +747,7 @@ pub mod api_client {
747747
req.extensions_mut().insert(GrpcMethod::new("rpc.Api", "CheckNullifiers"));
748748
self.inner.unary(req, path, codec).await
749749
}
750-
/// Returns the latest state proof of the specified account.
750+
/// Returns the latest details of the specified account.
751751
pub async fn get_account(
752752
&mut self,
753753
request: impl tonic::IntoRequest<super::AccountRequest>,
@@ -1147,7 +1147,7 @@ pub mod api_server {
11471147
tonic::Response<super::CheckNullifiersResponse>,
11481148
tonic::Status,
11491149
>;
1150-
/// Returns the latest state proof of the specified account.
1150+
/// Returns the latest details of the specified account.
11511151
async fn get_account(
11521152
&self,
11531153
request: tonic::Request<super::AccountRequest>,

‎crates/proto/src/generated/store.rs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -459,7 +459,7 @@ pub mod rpc_client {
459459
req.extensions_mut().insert(GrpcMethod::new("store.Rpc", "CheckNullifiers"));
460460
self.inner.unary(req, path, codec).await
461461
}
462-
/// Returns the latest state proof of the specified account.
462+
/// Returns the latest details the specified account.
463463
pub async fn get_account(
464464
&mut self,
465465
request: impl tonic::IntoRequest<super::super::rpc::AccountRequest>,
@@ -788,7 +788,7 @@ pub mod rpc_server {
788788
tonic::Response<super::super::rpc::CheckNullifiersResponse>,
789789
tonic::Status,
790790
>;
791-
/// Returns the latest state proof of the specified account.
791+
/// Returns the latest details the specified account.
792792
async fn get_account(
793793
&self,
794794
request: tonic::Request<super::super::rpc::AccountRequest>,
@@ -2461,7 +2461,7 @@ pub mod ntx_builder_client {
24612461
.insert(GrpcMethod::new("store.NtxBuilder", "GetNetworkAccountIds"));
24622462
self.inner.unary(req, path, codec).await
24632463
}
2464-
/// Returns the latest state proof of the specified account.
2464+
/// Returns the latest details of the specified account.
24652465
pub async fn get_account(
24662466
&mut self,
24672467
request: impl tonic::IntoRequest<super::super::rpc::AccountRequest>,
@@ -2619,7 +2619,7 @@ pub mod ntx_builder_server {
26192619
tonic::Response<super::NetworkAccountIdList>,
26202620
tonic::Status,
26212621
>;
2622-
/// Returns the latest state proof of the specified account.
2622+
/// Returns the latest details of the specified account.
26232623
async fn get_account(
26242624
&self,
26252625
request: tonic::Request<super::super::rpc::AccountRequest>,

‎proto/proto/internal/store.proto‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ service Rpc {
3131
// Verify proofs against the nullifier tree root in the latest block header.
3232
rpc CheckNullifiers(rpc.NullifierList) returns (rpc.CheckNullifiersResponse) {}
3333

34-
// Returns the latest state proof of the specified account.
34+
// Returns the latest details the specified account.
3535
rpc GetAccount(rpc.AccountRequest) returns (rpc.AccountResponse) {}
3636

3737
// Returns raw block data for the specified block number.
@@ -267,7 +267,7 @@ service NtxBuilder {
267267
// Returns a list of all network account ids.
268268
rpc GetNetworkAccountIds(rpc.BlockRange) returns (NetworkAccountIdList) {}
269269

270-
// Returns the latest state proof of the specified account.
270+
// Returns the latest details of the specified account.
271271
rpc GetAccount(rpc.AccountRequest) returns (rpc.AccountResponse) {}
272272

273273
// Returns the script for a note by its root.

‎proto/proto/rpc.proto‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ service Api {
3030
// Verify proofs against the nullifier tree root in the latest block header.
3131
rpc CheckNullifiers(NullifierList) returns (CheckNullifiersResponse) {}
3232

33-
// Returns the latest state proof of the specified account.
33+
// Returns the latest details of the specified account.
3434
rpc GetAccount(AccountRequest) returns (AccountResponse) {}
3535

3636
// Returns raw block data for the specified block number.
@@ -219,7 +219,7 @@ message MaybeNoteScript {
219219
// GET ACCOUNT PROOF
220220
// ================================================================================================
221221

222-
// Returns the latest state proof of the specified account.
222+
// Defines the request for account details.
223223
message AccountRequest {
224224
// Request the details for a public account.
225225
message AccountDetailRequest {

0 commit comments

Comments
 (0)