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
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
use std::collections::BTreeMap;
use near_api_types::{
AccountId, Data, EpochReference, NearGas, NearToken, Reference,
stake::{RewardFeeFraction, StakingPoolInfo, UserStakeBalance},
};
use near_openapi_client::types::{RpcQueryError, RpcQueryResponse};
use crate::{
NetworkConfig,
advanced::{
ResponseHandler, RpcBuilder, query_request::QueryRequest, query_rpc::SimpleQueryRpc,
validator_rpc::SimpleValidatorRpc,
},
common::{
query::{
CallResultHandler, MultiQueryHandler, MultiRequestBuilder, PostprocessHandler,
RequestBuilder, RpcType, RpcValidatorHandler, ViewStateHandler,
},
utils::{from_base64, near_data_to_near_token, to_base64},
},
config::RetryResponse,
contract::Contract,
errors::{QueryCreationError, QueryError, SendRequestError},
transactions::ConstructTransaction,
};
/// A wrapper struct that simplifies interactions with the [Staking Pool](https://github.com/near/core-contracts/tree/master/staking-pool) standard on behalf of the account.
///
/// Delegation is a wrapper that provides the functionality to manage user account stake in
/// the staking pool.
#[derive(Clone, Debug)]
pub struct Delegation(pub AccountId);
impl Delegation {
/// Returns the underlying account ID for this delegation.
///
/// # Example
/// ```rust,no_run
/// use near_api::*;
///
/// # fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let delegation = Staking::delegation("alice.testnet".parse()?);
/// let account_id = delegation.account_id();
/// println!("Account ID: {}", account_id);
/// # Ok(())
/// # }
/// ```
pub const fn account_id(&self) -> &AccountId {
&self.0
}
/// Converts this delegation to an Account for account-related operations.
///
/// # Example
/// ```rust,no_run
/// use near_api::*;
///
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let delegation = Staking::delegation("alice.testnet".parse()?);
/// let account = delegation.as_account();
/// let account_info = account.view().fetch_from_testnet().await?;
/// println!("Account balance: {}", account_info.data.amount);
/// # Ok(())
/// # }
/// ```
pub fn as_account(&self) -> crate::account::Account {
crate::account::Account(self.0.clone())
}
/// Prepares a new contract query (`get_account_staked_balance`) for fetching the staked balance ([NearToken]) of the account on the staking pool.
///
/// The call depends that the contract implements [`StakingPool`](https://github.com/near/core-contracts/tree/master/staking-pool)
///
/// ## Example
/// ```rust,no_run
/// use near_api::*;
///
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let balance = Staking::delegation("alice.testnet".parse()?)
/// .view_staked_balance("pool.testnet".parse()?)
/// .fetch_from_testnet()
/// .await?;
/// println!("Staked balance: {:?}", balance);
/// # Ok(())
/// # }
/// ```
pub fn view_staked_balance(
&self,
pool: AccountId,
) -> RequestBuilder<PostprocessHandler<NearToken, CallResultHandler<u128>>> {
Contract(pool)
.call_function(
"get_account_staked_balance",
serde_json::json!({
"account_id": self.0.clone(),
}),
)
.read_only()
.map(near_data_to_near_token)
}
/// Prepares a new contract query (`get_account_unstaked_balance`) for fetching the unstaked(free, not used for staking) balance ([NearToken]) of the account on the staking pool.
///
/// The call depends that the contract implements [`StakingPool`](https://github.com/near/core-contracts/tree/master/staking-pool)
///
/// ## Example
/// ```rust,no_run
/// use near_api::*;
///
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let balance = Staking::delegation("alice.testnet".parse()?)
/// .view_unstaked_balance("pool.testnet".parse()?)
/// .fetch_from_testnet()
/// .await?;
/// println!("Unstaked balance: {:?}", balance);
/// # Ok(())
/// # }
/// ```
pub fn view_unstaked_balance(
&self,
pool: AccountId,
) -> RequestBuilder<PostprocessHandler<NearToken, CallResultHandler<u128>>> {
Contract(pool)
.call_function(
"get_account_unstaked_balance",
serde_json::json!({
"account_id": self.0.clone(),
}),
)
.read_only()
.map(near_data_to_near_token)
}
/// Prepares a new contract query (`get_account_total_balance`) for fetching the total balance ([NearToken]) of the account (free + staked) on the staking pool.
///
/// The call depends that the contract implements [`StakingPool`](https://github.com/near/core-contracts/tree/master/staking-pool)
///
/// ## Example
/// ```rust,no_run
/// use near_api::*;
///
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let balance = Staking::delegation("alice.testnet".parse()?)
/// .view_total_balance("pool.testnet".parse()?)
/// .fetch_from_testnet()
/// .await?;
/// println!("Total balance: {:?}", balance);
/// # Ok(())
/// # }
/// ```
pub fn view_total_balance(
&self,
pool: AccountId,
) -> RequestBuilder<PostprocessHandler<NearToken, CallResultHandler<u128>>> {
Contract(pool)
.call_function(
"get_account_total_balance",
serde_json::json!({
"account_id": self.0.clone(),
}),
)
.read_only()
.map(near_data_to_near_token)
}
/// Returns a full information about the staked balance ([UserStakeBalance]) of the account on the staking pool.
///
/// This is a complex query that requires 3 calls (get_account_staked_balance, get_account_unstaked_balance, get_account_total_balance) to the staking pool contract.
/// The call depends that the contract implements [`StakingPool`](https://github.com/near/core-contracts/tree/master/staking-pool)
///
/// ## Example
/// ```rust,no_run
/// use near_api::*;
///
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let balance = Staking::delegation("alice.testnet".parse()?)
/// .view_balance("pool.testnet".parse()?)
/// .fetch_from_testnet()
/// .await?;
/// println!("Balance: {:?}", balance);
/// # Ok(())
/// # }
/// ```
#[allow(clippy::type_complexity)]
pub fn view_balance(
&self,
pool: AccountId,
) -> MultiRequestBuilder<
PostprocessHandler<
UserStakeBalance,
MultiQueryHandler<(
CallResultHandler<NearToken>,
CallResultHandler<NearToken>,
CallResultHandler<NearToken>,
)>,
>,
> {
let postprocess = MultiQueryHandler::default();
MultiRequestBuilder::new(postprocess, Reference::Optimistic)
.add_query_builder(self.view_staked_balance(pool.clone()))
.add_query_builder(self.view_unstaked_balance(pool.clone()))
.add_query_builder(self.view_total_balance(pool))
.map(
|(staked, unstaked, total): (Data<NearToken>, Data<NearToken>, Data<NearToken>)| {
UserStakeBalance {
staked: staked.data,
unstaked: unstaked.data,
total: total.data,
}
},
)
}
/// Prepares a new contract query (`is_account_unstaked_balance_available`) for checking if the unstaked balance of the account is available for withdrawal.
///
/// Some pools configures minimum withdrawal period in epochs, so the balance is not available for withdrawal immediately.
///
/// The call depends that the contract implements [`StakingPool`](https://github.com/near/core-contracts/tree/master/staking-pool)
///
/// ## Example
/// ```rust,no_run
/// use near_api::*;
///
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let is_available = Staking::delegation("alice.testnet".parse()?)
/// .is_account_unstaked_balance_available_for_withdrawal("pool.testnet".parse()?)
/// .fetch_from_testnet()
/// .await?;
/// println!("Is available: {:?}", is_available);
/// # Ok(())
/// # }
/// ```
pub fn is_account_unstaked_balance_available_for_withdrawal(
&self,
pool: AccountId,
) -> RequestBuilder<CallResultHandler<bool>> {
Contract(pool)
.call_function(
"is_account_unstaked_balance_available",
serde_json::json!({
"account_id": self.0.clone(),
}),
)
.read_only()
}
/// Prepares a new transaction contract call (`deposit`) for depositing funds into the staking pool.
/// Please note that your deposit is not staked, and it will be allocated as unstaked (free) balance.
///
/// Please note that this call will deposit your account tokens into the contract, so you will not be able to use them for other purposes.
///
/// The call depends that the contract implements [`StakingPool`](https://github.com/near/core-contracts/tree/master/staking-pool)
///
/// ## Example
/// ```rust,no_run
/// use near_api::*;
///
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let result = Staking::delegation("alice.testnet".parse()?)
/// .deposit("pool.testnet".parse()?, NearToken::from_near(1))
/// .with_signer(Signer::from_ledger()?)
/// .send_to_testnet()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn deposit(&self, pool: AccountId, amount: NearToken) -> ConstructTransaction {
Contract(pool)
.call_function("deposit", ())
.transaction()
.gas(NearGas::from_tgas(50))
.deposit(amount)
.with_signer_account(self.0.clone())
}
/// Prepares a new transaction contract call (`deposit_and_stake`) for depositing funds into the staking pool and staking them.
///
/// Please note that this call will deposit your account tokens into the contract, so you will not be able to use them for other purposes.
/// Also, after you have staked your funds, if you decide to withdraw them, you might need to wait for the two lockup period to end.
/// * Mandatory lockup before able to unstake
/// * Optional lockup before able to withdraw (depends on the pool configuration)
///
/// The call depends that the contract implements [`StakingPool`](https://github.com/near/core-contracts/tree/master/staking-pool)
///
/// ## Example
/// ```rust,no_run
/// use near_api::*;
///
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let result = Staking::delegation("alice.testnet".parse()?)
/// .deposit_and_stake("pool.testnet".parse()?, NearToken::from_near(1))
/// .with_signer(Signer::from_ledger()?)
/// .send_to_testnet()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn deposit_and_stake(&self, pool: AccountId, amount: NearToken) -> ConstructTransaction {
Contract(pool)
.call_function("deposit_and_stake", ())
.transaction()
.gas(NearGas::from_tgas(50))
.deposit(amount)
.with_signer_account(self.0.clone())
}
/// Prepares a new transaction contract call (`stake`) for staking funds into the staking pool.
///
/// Please note that this call will use your unstaked balance. This means that you have to have enough balance already deposited into the contract.
/// This won't use your native account tokens, but just reallocate your balance inside the contract.
/// Please also be aware that once you have staked your funds, you might not be able to withdraw them until the lockup periods end.
/// * Mandatory lockup before able to unstake
/// * Optional lockup before able to withdraw (depends on the pool configuration)
///
/// The call depends that the contract implements [`StakingPool`](https://github.com/near/core-contracts/tree/master/staking-pool)
///
/// ## Example
/// ```rust,no_run
/// use near_api::*;
///
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let result = Staking::delegation("alice.testnet".parse()?)
/// .stake("pool.testnet".parse()?, NearToken::from_near(1))
/// .with_signer(Signer::from_ledger()?)
/// .send_to_testnet()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn stake(&self, pool: AccountId, amount: NearToken) -> ConstructTransaction {
let args = serde_json::json!({
"amount": amount,
});
Contract(pool)
.call_function("stake", args)
.transaction()
.gas(NearGas::from_tgas(50))
.with_signer_account(self.0.clone())
}
/// Prepares a new transaction contract call (`stake_all`) for staking all available unstaked balance into the staking pool.
///
/// Please note that once you have staked your funds, you might not be able to withdraw them until the lockup periods end.
/// * Mandatory lockup before able to unstake
/// * Optional lockup before able to withdraw (depends on the pool configuration)
///
/// The call depends that the contract implements [`StakingPool`](https://github.com/near/core-contracts/tree/master/staking-pool)
///
/// ## Example
/// ```rust,no_run
/// use near_api::*;
///
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// Staking::delegation("alice.testnet".parse()?)
/// .stake_all("pool.testnet".parse()?)
/// .with_signer(Signer::from_ledger()?)
/// .send_to_testnet()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn stake_all(&self, pool: AccountId) -> ConstructTransaction {
Contract(pool)
.call_function("stake_all", ())
.transaction()
.gas(NearGas::from_tgas(50))
.with_signer_account(self.0.clone())
}
/// Prepares a new transaction contract call (`unstake`) for unstaking funds and returning them to your unstaked balance.
///
/// The contract will check if the minimum epoch height condition is met.
///
/// The call depends that the contract implements [`StakingPool`](https://github.com/near/core-contracts/tree/master/staking-pool)
///
/// ## Example
/// ```rust,no_run
/// use near_api::*;
///
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let result = Staking::delegation("alice.testnet".parse()?)
/// .unstake("pool.testnet".parse()?, NearToken::from_near(1))
/// .with_signer(Signer::from_ledger()?)
/// .send_to_testnet()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn unstake(&self, pool: AccountId, amount: NearToken) -> ConstructTransaction {
let args = serde_json::json!({
"amount": amount,
});
Contract(pool)
.call_function("unstake", args)
.transaction()
.gas(NearGas::from_tgas(50))
.with_signer_account(self.0.clone())
}
/// Prepares a new transaction contract call (`unstake_all`) for unstaking all available staked balance and returning them to your unstaked balance.
///
/// The contract will check if the minimum epoch height condition is met.
///
/// The call depends that the contract implements [`StakingPool`](https://github.com/near/core-contracts/tree/master/staking-pool)
///
/// ## Example
/// ```rust,no_run
/// use near_api::*;
///
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let result = Staking::delegation("alice.testnet".parse()?)
/// .unstake_all("pool.testnet".parse()?)
/// .with_signer(Signer::from_ledger()?)
/// .send_to_testnet()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn unstake_all(&self, pool: AccountId) -> ConstructTransaction {
Contract(pool)
.call_function("unstake_all", ())
.transaction()
.gas(NearGas::from_tgas(50))
.with_signer_account(self.0.clone())
}
/// Prepares a new transaction contract call (`withdraw`) for withdrawing funds from the staking pool into your account.
///
/// Some pools configures minimum withdrawal period in epochs, so the balance is not available for withdrawal immediately.
///
/// The call depends that the contract implements [`StakingPool`](https://github.com/near/core-contracts/tree/master/staking-pool)
///
/// ## Example
/// ```rust,no_run
/// use near_api::*;
///
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let result = Staking::delegation("alice.testnet".parse()?)
/// .withdraw("pool.testnet".parse()?, NearToken::from_near(1))
/// .with_signer(Signer::from_ledger()?)
/// .send_to_testnet()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn withdraw(&self, pool: AccountId, amount: NearToken) -> ConstructTransaction {
let args = serde_json::json!({
"amount": amount,
});
Contract(pool)
.call_function("withdraw", args)
.transaction()
.gas(NearGas::from_tgas(50))
.with_signer_account(self.0.clone())
}
/// Prepares a new transaction contract call (`withdraw_all`) for withdrawing all available staked balance from the staking pool into your account.
///
/// Some pools configures minimum withdrawal period in epochs, so the balance is not available for withdrawal immediately.
///
/// The call depends that the contract implements [`StakingPool`](https://github.com/near/core-contracts/tree/master/staking-pool)
///
/// ## Example
/// ```rust,no_run
/// use near_api::*;
///
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let result = Staking::delegation("alice.testnet".parse()?)
/// .withdraw_all("pool.testnet".parse()?)
/// .with_signer(Signer::from_ledger()?)
/// .send_to_testnet()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn withdraw_all(&self, pool: AccountId) -> ConstructTransaction {
Contract(pool)
.call_function("withdraw_all", ())
.transaction()
.gas(NearGas::from_tgas(50))
.with_signer_account(self.0.clone())
}
}
/// Staking-related interactions with the NEAR Protocol and the staking pools.
///
/// The [`Staking`] struct provides methods to interact with NEAR staking, including querying staking pools, validators, and delegators,
/// as well as delegating and withdrawing from staking pools.
///
/// # Examples
///
/// ```rust,no_run
/// use near_api::*;
///
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let staking_pools = Staking::active_staking_pools().fetch_from_testnet().await?;
/// println!("Staking pools: {:?}", staking_pools);
/// # Ok(())
/// # }
/// ```
#[derive(Clone, Debug)]
pub struct Staking {}
impl Staking {
/// Returns a list of active staking pools ([std::collections::BTreeSet]<[AccountId]>]) by querying the staking pools factory contract.
///
/// Please note that it might fail on the mainnet as the staking pool factory is super huge.
///
/// ## Example
/// ```rust,no_run
/// use near_api::*;
///
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let staking_pools = Staking::active_staking_pools().fetch_from_testnet().await?;
/// println!("Staking pools: {:?}", staking_pools);
/// # Ok(())
/// # }
/// ```
pub fn active_staking_pools() -> RpcBuilder<ActiveStakingPoolQuery, ActiveStakingHandler> {
RpcBuilder::new(
ActiveStakingPoolQuery,
Reference::Optimistic,
ActiveStakingHandler,
)
}
/// Returns a list of validators and their stake ([near_api_types::RpcValidatorResponse]) for the current epoch.
///
/// ## Example
/// ```rust,no_run
/// use near_api::*;
///
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let validators = Staking::epoch_validators_info().fetch_from_testnet().await?;
/// println!("Validators: {:?}", validators);
/// # Ok(())
/// # }
/// ```
pub fn epoch_validators_info() -> RequestBuilder<RpcValidatorHandler> {
RequestBuilder::new(
SimpleValidatorRpc,
EpochReference::Latest,
RpcValidatorHandler,
)
}
/// Returns a map of validators and their stake ([BTreeMap<AccountId, NearToken>]) for the current epoch.
///
/// ## Example
/// ```rust,no_run
/// use near_api::*;
///
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let validators = Staking::validators_stake().fetch_from_testnet().await?;
/// println!("Validators: {:?}", validators);
/// # Ok(())
/// # }
/// ```
pub fn validators_stake()
-> RequestBuilder<PostprocessHandler<BTreeMap<AccountId, NearToken>, RpcValidatorHandler>> {
RequestBuilder::new(
SimpleValidatorRpc,
EpochReference::Latest,
RpcValidatorHandler,
)
.map(|validator_response| {
validator_response
.current_proposals
.into_iter()
.map(|validator_stake_view| {
(validator_stake_view.account_id, validator_stake_view.stake)
})
.chain(validator_response.current_validators.into_iter().map(
|current_epoch_validator_info| {
(
current_epoch_validator_info.account_id,
current_epoch_validator_info.stake,
)
},
))
.chain(validator_response.next_validators.into_iter().map(
|next_epoch_validator_info| {
(
next_epoch_validator_info.account_id,
next_epoch_validator_info.stake,
)
},
))
.collect::<BTreeMap<_, NearToken>>()
})
}
/// Prepares a new contract query (`get_reward_fee_fraction`) for fetching the reward fee fraction of the staking pool ([Data]<[RewardFeeFraction]>).
///
/// The call depends that the contract implements [`StakingPool`](https://github.com/near/core-contracts/tree/master/staking-pool)
///
/// ## Example
/// ```rust,no_run
/// use near_api::*;
///
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let reward_fee = Staking::staking_pool_reward_fee("pool.testnet".parse()?)
/// .fetch_from_testnet().await?;
/// println!("Reward fee: {:?}", reward_fee);
/// # Ok(())
/// # }
/// ```
pub fn staking_pool_reward_fee(
pool: AccountId,
) -> RequestBuilder<CallResultHandler<RewardFeeFraction>> {
Contract(pool)
.call_function("get_reward_fee_fraction", ())
.read_only()
}
/// Prepares a new contract query (`get_number_of_accounts`) for fetching the number of delegators of the staking pool ([Data]<[u64]>).
///
/// The call depends that the contract implements [`StakingPool`](https://github.com/near/core-contracts/tree/master/staking-pool)
///
/// ## Example
/// ```rust,no_run
/// use near_api::*;
///
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let delegators = Staking::staking_pool_delegators("pool.testnet".parse()?)
/// .fetch_from_testnet()
/// .await?;
/// println!("Delegators: {:?}", delegators);
/// # Ok(())
/// # }
/// ```
pub fn staking_pool_delegators(pool: AccountId) -> RequestBuilder<CallResultHandler<u64>> {
Contract(pool)
.call_function("get_number_of_accounts", ())
.read_only()
}
/// Prepares a new contract query (`get_total_staked_balance`) for fetching the total stake of the staking pool ([NearToken]).
///
/// The call depends that the contract implements [`StakingPool`](https://github.com/near/core-contracts/tree/master/staking-pool)
///
/// ## Example
/// ```rust,no_run
/// use near_api::*;
///
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let total_stake = Staking::staking_pool_total_stake("pool.testnet".parse()?)
/// .fetch_from_testnet()
/// .await?;
/// println!("Total stake: {:?}", total_stake);
/// # Ok(())
/// # }
/// ```
pub fn staking_pool_total_stake(
pool: AccountId,
) -> RequestBuilder<PostprocessHandler<NearToken, CallResultHandler<u128>>> {
Contract(pool)
.call_function("get_total_staked_balance", ())
.read_only()
.map(near_data_to_near_token)
}
/// Returns a full information about the staking pool ([StakingPoolInfo]).
///
/// This is a complex query that requires 3 calls (get_reward_fee_fraction, get_number_of_accounts, get_total_staked_balance) to the staking pool contract.
/// The call depends that the contract implements [`StakingPool`](https://github.com/near/core-contracts/tree/master/staking-pool)
///
/// ## Example
/// ```rust,no_run
/// use near_api::*;
///
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let staking_pool_info = Staking::staking_pool_info("pool.testnet".parse()?)
/// .fetch_from_testnet()
/// .await?;
/// println!("Staking pool info: {:?}", staking_pool_info);
/// # Ok(())
/// # }
/// ```
#[allow(clippy::type_complexity)]
pub fn staking_pool_info(
pool: AccountId,
) -> MultiRequestBuilder<
PostprocessHandler<
StakingPoolInfo,
MultiQueryHandler<(
CallResultHandler<RewardFeeFraction>,
CallResultHandler<u64>,
CallResultHandler<u128>,
)>,
>,
> {
let pool_clone = pool.clone();
let handler = MultiQueryHandler::new((
CallResultHandler::default(),
CallResultHandler::default(),
CallResultHandler::default(),
));
MultiRequestBuilder::new(handler, Reference::Optimistic)
.add_query_builder(Self::staking_pool_reward_fee(pool.clone()))
.add_query_builder(Self::staking_pool_delegators(pool.clone()))
.add_query_builder(Self::staking_pool_total_stake(pool))
.map(move |(reward_fee, delegators, total_stake)| {
let total = near_data_to_near_token(total_stake);
StakingPoolInfo {
validator_id: pool_clone.clone(),
fee: Some(reward_fee.data),
delegators: Some(delegators.data),
stake: total,
}
})
}
/// Returns a new [`Delegation`] struct for interacting with the staking pool on behalf of the account.
pub const fn delegation(account_id: AccountId) -> Delegation {
Delegation(account_id)
}
}
#[derive(Clone, Debug)]
pub struct ActiveStakingPoolQuery;
#[async_trait::async_trait]
impl RpcType for ActiveStakingPoolQuery {
type RpcReference = <SimpleQueryRpc as RpcType>::RpcReference;
type Response = <SimpleQueryRpc as RpcType>::Response;
type Error = <SimpleQueryRpc as RpcType>::Error;
async fn send_query(
&self,
client: &near_openapi_client::Client,
network: &NetworkConfig,
reference: &Reference,
) -> RetryResponse<RpcQueryResponse, SendRequestError<RpcQueryError>> {
let Some(account_id) = network.staking_pools_factory_account_id.clone() else {
return RetryResponse::Critical(SendRequestError::RequestCreationError(
QueryCreationError::StakingPoolFactoryNotDefined,
));
};
let request = QueryRequest::ViewState {
account_id,
prefix_base64: near_api_types::StoreKey(to_base64(b"se")),
include_proof: Some(false),
};
SimpleQueryRpc { request }
.send_query(client, network, reference)
.await
}
}
#[derive(Clone, Debug)]
pub struct ActiveStakingHandler;
#[async_trait::async_trait]
impl ResponseHandler for ActiveStakingHandler {
type Query = ActiveStakingPoolQuery;
type Response = std::collections::BTreeSet<AccountId>;
fn process_response(
&self,
response: Vec<RpcQueryResponse>,
) -> core::result::Result<Self::Response, QueryError<RpcQueryError>> {
let query_result = ViewStateHandler {}.process_response(response)?;
Ok(query_result
.data
.values
.into_iter()
.filter_map(|item| borsh::from_slice(&from_base64(&item.value).ok()?).ok())
.collect())
}
}