near-api 0.8.6

Rust library to interact with NEAR Protocol via RPC API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317

use near_api_types::{AccountId, CryptoHash, Reference};
use near_openapi_client::types::{
    BlockId, CallFunctionByBlockIdRequestType, CallFunctionByFinalityRequestType, Finality,
    FunctionArgs, PublicKey, RpcQueryRequest, StoreKey, ViewAccessKeyByBlockIdRequestType,
    ViewAccessKeyByFinalityRequestType, ViewAccessKeyListByBlockIdRequestType,
    ViewAccessKeyListByFinalityRequestType, ViewAccountByBlockIdRequestType,
    ViewAccountByFinalityRequestType, ViewCodeByBlockIdRequestType, ViewCodeByFinalityRequestType,
    ViewGlobalContractCodeByAccountIdByBlockIdRequestType,
    ViewGlobalContractCodeByAccountIdByFinalityRequestType,
    ViewGlobalContractCodeByBlockIdRequestType, ViewGlobalContractCodeByFinalityRequestType,
    ViewStateByBlockIdRequestType, ViewStateByFinalityRequestType,
};
use serde::{Deserialize, Serialize};

/// Simplified query request structure that eliminates duplication by removing reference types
/// from the enum variants. The reference is provided separately when converting to RPC format.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum QueryRequest {
    /// View account information
    ViewAccount { account_id: AccountId },
    /// View contract code for an account
    ViewCode { account_id: AccountId },
    /// View state of an account with optional proof and key prefix
    ViewState {
        account_id: AccountId,
        #[serde(default, skip_serializing_if = "Option::is_none")]
        include_proof: Option<bool>,
        prefix_base64: StoreKey,
    },
    /// View a specific access key for an account
    ViewAccessKey {
        account_id: AccountId,
        public_key: PublicKey,
    },
    /// View all access keys for an account
    ViewAccessKeyList { account_id: AccountId },
    /// Call a view function on a contract
    CallFunction {
        account_id: AccountId,
        method_name: String,
        args_base64: FunctionArgs,
    },
    /// View global contract code by hash
    ViewGlobalContractCode { code_hash: CryptoHash },
    /// View global contract code by account ID
    ViewGlobalContractCodeByAccountId { account_id: AccountId },
}

impl QueryRequest {
    /// Convert this simplified query request to the OpenAPI RpcQueryRequest enum
    /// This method handles the conversion from our unified Reference type to the appropriate
    /// OpenAPI variant based on the reference type
    pub fn to_rpc_query_request(
        self,
        reference: Reference,
    ) -> near_openapi_client::types::RpcQueryRequest {
        match self {
            Self::ViewAccount { account_id } => {
                match reference {
                    Reference::Final => RpcQueryRequest::ViewAccountByFinality {
                        account_id,
                        finality: Finality::Final,
                        request_type: ViewAccountByFinalityRequestType::ViewAccount,
                    },
                    Reference::NearFinal => RpcQueryRequest::ViewAccountByFinality {
                        account_id,
                        finality: Finality::NearFinal,
                        request_type: ViewAccountByFinalityRequestType::ViewAccount,
                    },
                    Reference::Optimistic => RpcQueryRequest::ViewAccountByFinality {
                        account_id,
                        finality: Finality::Optimistic,
                        request_type: ViewAccountByFinalityRequestType::ViewAccount,
                    },
                    Reference::AtBlock(height) => RpcQueryRequest::ViewAccountByBlockId {
                        account_id,
                        block_id: BlockId::BlockHeight(height),
                        request_type: ViewAccountByBlockIdRequestType::ViewAccount,
                    },
                    Reference::AtBlockHash(hash) => RpcQueryRequest::ViewAccountByBlockId {
                        account_id,
                        block_id: BlockId::CryptoHash(hash.into()),
                        request_type: ViewAccountByBlockIdRequestType::ViewAccount,
                    },
                }
            },
            Self::ViewCode { account_id } => {
                match reference {
                    Reference::Final => RpcQueryRequest::ViewCodeByFinality {
                        account_id,
                        finality: Finality::Final,
                        request_type: ViewCodeByFinalityRequestType::ViewCode,
                    },
                    Reference::NearFinal => RpcQueryRequest::ViewCodeByFinality {
                        account_id,
                        finality: Finality::NearFinal,
                        request_type: ViewCodeByFinalityRequestType::ViewCode,
                    },
                    Reference::Optimistic => RpcQueryRequest::ViewCodeByFinality {
                        account_id,
                        finality: Finality::Optimistic,
                        request_type: ViewCodeByFinalityRequestType::ViewCode,
                    },
                    Reference::AtBlock(height) => RpcQueryRequest::ViewCodeByBlockId {
                        account_id,
                        block_id: BlockId::BlockHeight(height),
                        request_type: ViewCodeByBlockIdRequestType::ViewCode,
                    },
                    Reference::AtBlockHash(hash) => RpcQueryRequest::ViewCodeByBlockId {
                        account_id,
                        block_id: BlockId::CryptoHash(hash.into()),
                        request_type: ViewCodeByBlockIdRequestType::ViewCode,
                    },
                }
            },
            Self::ViewState { account_id, include_proof, prefix_base64 } => {
                match reference {
                    Reference::Final => RpcQueryRequest::ViewStateByFinality {
                        account_id,
                        finality: Finality::Final,
                        include_proof,
                        prefix_base64,
                        request_type: ViewStateByFinalityRequestType::ViewState,
                    },
                    Reference::NearFinal => RpcQueryRequest::ViewStateByFinality {
                        account_id,
                        finality: Finality::NearFinal,
                        include_proof,
                        prefix_base64,
                        request_type: ViewStateByFinalityRequestType::ViewState,
                    },
                    Reference::Optimistic => RpcQueryRequest::ViewStateByFinality {
                        account_id,
                        finality: Finality::Optimistic,
                        include_proof,
                        prefix_base64,
                        request_type: ViewStateByFinalityRequestType::ViewState,
                    },
                    Reference::AtBlock(height) => RpcQueryRequest::ViewStateByBlockId {
                        account_id,
                        block_id: BlockId::BlockHeight(height),
                        include_proof,
                        prefix_base64,
                        request_type: ViewStateByBlockIdRequestType::ViewState,
                    },
                    Reference::AtBlockHash(hash) => RpcQueryRequest::ViewStateByBlockId {
                        account_id,
                        block_id: BlockId::CryptoHash(hash.into()),
                        include_proof,
                        prefix_base64,
                        request_type: ViewStateByBlockIdRequestType::ViewState,
                    },
                }
            },
            Self::ViewAccessKey { account_id, public_key } => {
                match reference {
                    Reference::Final => RpcQueryRequest::ViewAccessKeyByFinality {
                        account_id,
                        public_key,
                        finality: Finality::Final,
                        request_type: ViewAccessKeyByFinalityRequestType::ViewAccessKey,
                    },
                    Reference::Optimistic => RpcQueryRequest::ViewAccessKeyByFinality {
                        account_id,
                        public_key,
                        finality: Finality::Optimistic,
                        request_type: ViewAccessKeyByFinalityRequestType::ViewAccessKey,
                    },
                    Reference::NearFinal => RpcQueryRequest::ViewAccessKeyByFinality {
                        account_id,
                        public_key,
                        finality: Finality::NearFinal,
                        request_type: ViewAccessKeyByFinalityRequestType::ViewAccessKey,
                    },
                    Reference::AtBlock(height) => RpcQueryRequest::ViewAccessKeyByBlockId {
                        account_id,
                        public_key,
                        block_id: BlockId::BlockHeight(height),
                        request_type: ViewAccessKeyByBlockIdRequestType::ViewAccessKey,
                    },
                    Reference::AtBlockHash(hash) => RpcQueryRequest::ViewAccessKeyByBlockId {
                        account_id,
                        public_key,
                        block_id: BlockId::CryptoHash(hash.into()),
                        request_type: ViewAccessKeyByBlockIdRequestType::ViewAccessKey,
                    },
                }
            },
            Self::ViewAccessKeyList { account_id } => {
                match reference {
                    Reference::Final => RpcQueryRequest::ViewAccessKeyListByFinality {
                        account_id,
                        finality: Finality::Final,
                        request_type: ViewAccessKeyListByFinalityRequestType::ViewAccessKeyList,
                    },
                    Reference::Optimistic => RpcQueryRequest::ViewAccessKeyListByFinality {
                        account_id,
                        finality: Finality::Optimistic,
                        request_type: ViewAccessKeyListByFinalityRequestType::ViewAccessKeyList,
                    },
                    Reference::NearFinal => RpcQueryRequest::ViewAccessKeyListByFinality {
                        account_id,
                        finality: Finality::NearFinal,
                        request_type: ViewAccessKeyListByFinalityRequestType::ViewAccessKeyList,
                    },
                    Reference::AtBlock(height) => RpcQueryRequest::ViewAccessKeyListByBlockId {
                        account_id,
                        block_id: BlockId::BlockHeight(height),
                        request_type: ViewAccessKeyListByBlockIdRequestType::ViewAccessKeyList,
                    },
                    Reference::AtBlockHash(hash) => RpcQueryRequest::ViewAccessKeyListByBlockId {
                        account_id,
                        block_id: BlockId::CryptoHash(hash.into()),
                        request_type: ViewAccessKeyListByBlockIdRequestType::ViewAccessKeyList,
                    },
                }
            },
            Self::CallFunction { account_id, method_name, args_base64 } => {
                match reference {
                    Reference::Final => RpcQueryRequest::CallFunctionByFinality {
                        account_id,
                        method_name,
                        args_base64,
                        finality: Finality::Final,
                        request_type: CallFunctionByFinalityRequestType::CallFunction,
                    },
                    Reference::Optimistic => RpcQueryRequest::CallFunctionByFinality {
                        account_id,
                        method_name,
                        args_base64,
                        finality: Finality::Optimistic,
                        request_type: CallFunctionByFinalityRequestType::CallFunction,
                    },
                    Reference::NearFinal => RpcQueryRequest::CallFunctionByFinality {
                        account_id,
                        method_name,
                        args_base64,
                        finality: Finality::NearFinal,
                        request_type: CallFunctionByFinalityRequestType::CallFunction,
                    },
                    Reference::AtBlock(height) => RpcQueryRequest::CallFunctionByBlockId {
                        account_id,
                        method_name,
                        args_base64,
                        block_id: BlockId::BlockHeight(height),
                        request_type: CallFunctionByBlockIdRequestType::CallFunction,
                    },
                    Reference::AtBlockHash(hash) => RpcQueryRequest::CallFunctionByBlockId {
                        account_id,
                        method_name,
                        args_base64,
                        block_id: BlockId::CryptoHash(hash.into()),
                        request_type: CallFunctionByBlockIdRequestType::CallFunction,
                    },
                }
            },
            Self::ViewGlobalContractCode { code_hash } => {
                match reference {
                    Reference::Final => RpcQueryRequest::ViewGlobalContractCodeByFinality {
                        code_hash: code_hash.into(),
                        finality: Finality::Final,
                        request_type: ViewGlobalContractCodeByFinalityRequestType::ViewGlobalContractCode,
                    },
                    Reference::Optimistic => RpcQueryRequest::ViewGlobalContractCodeByFinality {
                        code_hash: code_hash.into(),
                        finality: Finality::Optimistic,
                        request_type: ViewGlobalContractCodeByFinalityRequestType::ViewGlobalContractCode,
                    },
                    Reference::NearFinal => RpcQueryRequest::ViewGlobalContractCodeByFinality {
                        code_hash: code_hash.into(),
                        finality: Finality::NearFinal,
                        request_type: ViewGlobalContractCodeByFinalityRequestType::ViewGlobalContractCode,
                    },
                    Reference::AtBlock(height) => RpcQueryRequest::ViewGlobalContractCodeByBlockId {
                        code_hash: code_hash.into(),
                        block_id: BlockId::BlockHeight(height),
                        request_type: ViewGlobalContractCodeByBlockIdRequestType::ViewGlobalContractCode,
                    },
                    Reference::AtBlockHash(hash) => RpcQueryRequest::ViewGlobalContractCodeByBlockId {
                        code_hash: code_hash.into(),
                        block_id: BlockId::CryptoHash(hash.into()),
                        request_type: ViewGlobalContractCodeByBlockIdRequestType::ViewGlobalContractCode,
                    },
                }
            },
            Self::ViewGlobalContractCodeByAccountId { account_id } => {
                match reference {
                    Reference::Final => RpcQueryRequest::ViewGlobalContractCodeByAccountIdByFinality {
                        account_id,
                        finality: Finality::Final,
                        request_type: ViewGlobalContractCodeByAccountIdByFinalityRequestType::ViewGlobalContractCodeByAccountId,
                    },
                    Reference::Optimistic => RpcQueryRequest::ViewGlobalContractCodeByAccountIdByFinality {
                        account_id,
                        finality: Finality::Optimistic,
                        request_type: ViewGlobalContractCodeByAccountIdByFinalityRequestType::ViewGlobalContractCodeByAccountId,
                    },
                    Reference::NearFinal => RpcQueryRequest::ViewGlobalContractCodeByAccountIdByFinality {
                        account_id,
                        finality: Finality::NearFinal,
                        request_type: ViewGlobalContractCodeByAccountIdByFinalityRequestType::ViewGlobalContractCodeByAccountId,
                    },
                    Reference::AtBlock(height) => RpcQueryRequest::ViewGlobalContractCodeByAccountIdByBlockId {
                        account_id,
                        block_id: BlockId::BlockHeight(height),
                        request_type: ViewGlobalContractCodeByAccountIdByBlockIdRequestType::ViewGlobalContractCodeByAccountId,
                    },
                    Reference::AtBlockHash(hash) => RpcQueryRequest::ViewGlobalContractCodeByAccountIdByBlockId {
                        account_id,
                        block_id: BlockId::CryptoHash(hash.into()),
                        request_type: ViewGlobalContractCodeByAccountIdByBlockIdRequestType::ViewGlobalContractCodeByAccountId,
                    },
                }
            },
        }
    }
}