iota-sdk 1.0.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

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

use serde::{Deserialize, Serialize};

use crate::{
    client::api::input_selection::{Burn, BurnDto},
    types::block::{
        output::OutputId,
        payload::{dto::TaggedDataPayloadDto, tagged_data::TaggedDataPayload},
        Error,
    },
    wallet::account::types::address::AccountAddress,
};

/// Options for transactions
#[derive(Debug, Clone, Default)]
pub struct TransactionOptions {
    pub remainder_value_strategy: RemainderValueStrategy,
    pub tagged_data_payload: Option<TaggedDataPayload>,
    // If custom inputs are provided only they are used. If also other additional inputs should be used,
    // `mandatory_inputs` should be used instead.
    pub custom_inputs: Option<Vec<OutputId>>,
    pub mandatory_inputs: Option<Vec<OutputId>>,
    pub burn: Option<Burn>,
    pub note: Option<String>,
    pub allow_micro_amount: bool,
}

impl TransactionOptions {
    /// Conversion from TransactionOptionsDto to TransactionOptions.
    pub fn try_from_dto(value: TransactionOptionsDto) -> Result<Self, Error> {
        Ok(Self {
            remainder_value_strategy: value.remainder_value_strategy,
            tagged_data_payload: value.tagged_data_payload.map(TaggedDataPayload::try_from).transpose()?,
            custom_inputs: value.custom_inputs,
            mandatory_inputs: value.mandatory_inputs,
            burn: value.burn.map(Burn::try_from).transpose()?,
            note: value.note,
            allow_micro_amount: value.allow_micro_amount,
        })
    }
}

/// Dto for transaction options
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
#[serde(rename_all = "camelCase")]
pub struct TransactionOptionsDto {
    #[serde(default)]
    pub remainder_value_strategy: RemainderValueStrategy,
    #[serde(default)]
    pub tagged_data_payload: Option<TaggedDataPayloadDto>,
    // If custom inputs are provided only they are used. If also other additional inputs should be used,
    // `mandatory_inputs` should be used instead.
    #[serde(default)]
    pub custom_inputs: Option<Vec<OutputId>>,
    #[serde(default)]
    pub mandatory_inputs: Option<Vec<OutputId>>,
    pub burn: Option<BurnDto>,
    pub note: Option<String>,
    #[serde(default)]
    pub allow_micro_amount: bool,
}

#[allow(clippy::enum_variant_names)]
/// The strategy to use for the remainder value management when sending funds.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(tag = "strategy", content = "value")]
pub enum RemainderValueStrategy {
    /// Keep the remainder value on the source address.
    ReuseAddress,
    /// Move the remainder value to a change address.
    ChangeAddress,
    /// Move the remainder value to any specified address.
    CustomAddress(AccountAddress),
}

impl Default for RemainderValueStrategy {
    fn default() -> Self {
        Self::ReuseAddress
    }
}