iota-sdk 2.0.0-beta.1

The IOTA SDK provides developers with a seamless experience to develop on IOTA by providing account abstractions and clients to interact with node APIs.
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

// Copyright 2024 IOTA Stiftung
// SPDX-License-Identifier: Apache-2.0

use serde::{Deserialize, Serialize};

use crate::{
    client::{
        api::{
            options::TransactionOptions,
            transaction_builder::transition::{AccountChange, Transitions},
            PreparedTransactionData,
        },
        secret::SecretManage,
        ClientError,
    },
    types::block::output::AccountId,
    utils::serde::string,
    wallet::{types::TransactionWithMetadata, Wallet, WalletError},
};

/// Parameters for beginning a staking period.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct BeginStakingParams {
    /// The account id which will begin staking.
    pub account_id: AccountId,
    /// The amount of tokens to stake.
    #[serde(with = "string")]
    pub staked_amount: u64,
    /// The fixed cost of the validator, which it receives as part of its Mana rewards.
    #[serde(with = "string")]
    pub fixed_cost: u64,
    /// The staking period (in epochs). Will default to the staking unbonding period.
    pub staking_period: Option<u32>,
}

impl<S: 'static + SecretManage> Wallet<S>
where
    WalletError: From<S::Error>,
    ClientError: From<S::Error>,
{
    pub async fn begin_staking(
        &self,
        params: BeginStakingParams,
        options: impl Into<Option<TransactionOptions>> + Send,
    ) -> Result<TransactionWithMetadata, WalletError> {
        let options = options.into();
        let prepared = self.prepare_begin_staking(params, options.clone()).await?;

        self.sign_and_submit_transaction(prepared, options).await
    }

    /// Prepares the transaction for [Wallet::begin_staking()].
    pub async fn prepare_begin_staking(
        &self,
        params: BeginStakingParams,
        options: impl Into<Option<TransactionOptions>> + Send,
    ) -> Result<PreparedTransactionData, WalletError> {
        log::debug!("[TRANSACTION] prepare_begin_staking");

        let change = AccountChange::BeginStaking {
            staked_amount: params.staked_amount,
            fixed_cost: params.fixed_cost,
            staking_period: params.staking_period,
        };

        let mut options = options.into();
        if let Some(options) = options.as_mut() {
            if let Some(transitions) = options.transitions.take() {
                options.transitions = Some(transitions.add_account(params.account_id, change));
            }
        } else {
            options.replace(TransactionOptions {
                transitions: Some(Transitions::new().add_account(params.account_id, change)),
                ..Default::default()
            });
        }

        let transaction = self.prepare_send_outputs(None, options).await?;

        Ok(transaction)
    }
}