update type names and add dust_allowed field

bindings/nodejs/README.md

@@ -332,7 +332,7 @@ Gets the UTXO outputs associated with the given address.
 
 **Returns** a promise resolving to a list of output ids.
 
-#### getAddressBalance(address): Promise<number>
+#### getAddressBalance(address): Promise<AddressBalance>
 
 Gets the balance of the given address.
 
@@ -885,6 +885,14 @@ Gets the metadata of the given message.
 | index | <code>string</code>     | Indexation key  |
 | data  | <code>Uint8Array</code> | Indexation data |
 
+##### AddressBalance
+
+| Field        | Type                 | Description            |
+| ------------ | -------------------- | ---------------------- |
+| address      | <code>string</code>  | Bech32 encoded address |
+| balance      | <code>number</code>  | Address balance        |
+| dustAllowed  | <code>boolean</code> | Dust allowed           |
+
 ### MessageMetadata
 
 | Field                      | Type                              | Description                                               |

bindings/nodejs/lib/types/models.d.ts

@@ -52,7 +52,7 @@ export declare interface BrokerOptions {
 export declare type Address = 'string'
 
 export declare interface AddressBalance {
-  type: number
   address: Address
   balance: number
+  dust_allowed: boolean
 }

bindings/nodejs/native/src/classes/client/api.rs

@@ -7,7 +7,7 @@ use super::MessageDto;
 
 use crate::classes::client::dto::MessageWrapper;
 use iota::{
-    Address, AddressOutputsOptions, ClientMiner, MessageBuilder, MessageId, Parents, Seed, TransactionId, UTXOInput,
+    Address, AddressOutputsOptions, ClientMiner, MessageBuilder, MessageId, Parents, Seed, TransactionId, UtxoInput,
 };
 use neon::prelude::*;
 
@@ -20,7 +20,7 @@ pub(crate) enum Api {
         parents: Option<Vec<MessageId>>,
         account_index: Option<usize>,
         initial_address_index: Option<usize>,
-        inputs: Vec<UTXOInput>,
+        inputs: Vec<UtxoInput>,
         outputs: Vec<(Address, u64)>,
         dust_allowance_outputs: Vec<(Address, u64)>,
     },
@@ -57,9 +57,9 @@ pub(crate) enum Api {
     GetMessageMetadata(MessageId),
     GetRawMessage(MessageId),
     GetMessageChildren(MessageId),
-    GetOutput(UTXOInput),
+    GetOutput(UtxoInput),
     FindOutputs {
-        outputs: Vec<UTXOInput>,
+        outputs: Vec<UtxoInput>,
         addresses: Vec<String>,
     },
     GetAddressBalance(String),

bindings/nodejs/native/src/classes/client/dto.rs

@@ -2,9 +2,9 @@
 // SPDX-License-Identifier: Apache-2.0
 
 use iota::{
-    AddressDto, BalanceForAddressResponse as AddressBalancePair, Ed25519Signature, Essence, IndexationPayload, Input,
+    AddressDto, BalanceAddressResponse as AddressBalancePair, Ed25519Signature, Essence, IndexationPayload, Input,
     Message, MessageId, Output, OutputDto as BeeOutput, OutputResponse as OutputMetadata, Payload, ReferenceUnlock,
-    RegularEssence, SignatureUnlock, TransactionPayload, UTXOInput, UnlockBlock, UnlockBlocks,
+    RegularEssence, SignatureUnlock, TransactionPayload, UnlockBlock, UnlockBlocks, UtxoInput,
 };
 use serde::{Deserialize, Serialize};
 
@@ -37,7 +37,7 @@ impl TryFrom<MessageRegularEssenceDto> for RegularEssence {
             .into_vec()
             .into_iter()
             .map(|input| {
-                UTXOInput::from_str(&input)
+                UtxoInput::from_str(&input)
                     .unwrap_or_else(|_| panic!("invalid input: {}", input))
                     .into()
             })
@@ -214,13 +214,15 @@ impl From<OutputMetadata> for OutputMetadataDto {
 pub(super) struct AddressBalanceDto {
     address: String,
     balance: u64,
+    dustAllowed: bool,
 }
 
 impl From<AddressBalancePair> for AddressBalanceDto {
     fn from(value: AddressBalancePair) -> Self {
         Self {
             address: value.address.to_string(),
             balance: value.balance,
+            dustAllowed: value.dust_allowed,
         }
     }
 }

bindings/nodejs/native/src/classes/client/message_sender.rs

@@ -1,7 +1,7 @@
 // Copyright 2021 IOTA Stiftung
 // SPDX-License-Identifier: Apache-2.0
 
-use iota::{Address, MessageId, Seed, TransactionId, UTXOInput};
+use iota::{Address, MessageId, Seed, TransactionId, UtxoInput};
 use neon::prelude::*;
 
 use super::{parse_address, Api, ClientTask};
@@ -16,7 +16,7 @@ pub struct MessageSender {
     seed: Option<String>,
     account_index: Option<usize>,
     initial_address_index: Option<usize>,
-    inputs: Vec<UTXOInput>,
+    inputs: Vec<UtxoInput>,
     input_range: Range<usize>,
     outputs: Vec<(Address, u64)>,
     dust_allowance_outputs: Vec<(Address, u64)>,
@@ -174,7 +174,7 @@ declare_types! {
                 let mut this = cx.this();
                 let guard = cx.lock();
                 let inputs = &mut this.borrow_mut(&guard).inputs;
-                inputs.push(UTXOInput::new(transaction_id, index).expect("invalid UTXO input"));
+                inputs.push(UtxoInput::new(transaction_id, index).expect("invalid UTXO input"));
             }
 
             Ok(cx.this().upcast())

bindings/nodejs/native/src/classes/client/mod.rs

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 use iota::{
-    message::prelude::{Address, MessageId, TransactionId, UTXOInput},
+    message::prelude::{Address, MessageId, TransactionId, UtxoInput},
     AddressOutputsOptions, OutputType, Seed,
 };
 use neon::prelude::*;
@@ -357,7 +357,7 @@ declare_types! {
 
         method getOutput(mut cx) {
             let output_id = cx.argument::<JsString>(0)?.value();
-            let output_id = UTXOInput::from_str(output_id.as_str()).expect("invalid output id");
+            let output_id = UtxoInput::from_str(output_id.as_str()).expect("invalid output id");
             let cb = cx.argument::<JsFunction>(1)?;
             {
                 let this = cx.this();
@@ -379,7 +379,7 @@ declare_types! {
             let mut outputs = vec![];
             for js_output_id in js_output_ids {
                 let output_id: Handle<JsString> = js_output_id.downcast_or_throw(&mut cx)?;
-                let output_id = UTXOInput::from_str(output_id.value().as_str()).expect("invalid output id");
+                let output_id = UtxoInput::from_str(output_id.value().as_str()).expect("invalid output id");
                 outputs.push(output_id);
             }
 

bindings/python/README.md

@@ -247,17 +247,17 @@ Gets the UTXO outputs associated with the given output id.
 
 **Returns** the OutputResponse[#outputresponse].
 
-#### get_address_balance(address): BalanceForAddressResponse
+#### get_address_balance(address): BalanceAddressResponse
 
 Gets the balance in the address.
 
 | Param     | Type                   | Default                | Description               |
 | --------- | ---------------------- | ---------------------- | ------------------------- |
 | [address] | <code>list[str]</code> | <code>undefined</code> | The address Bech32 string |
 
-**Returns** the [BalanceForAddressResponse](#balanceforaddressresponse).
+**Returns** the [BalanceAddressResponse](#BalanceAddressResponse).
 
-#### get_address_outputs(address, options (optional)): list[UTXOInput]
+#### get_address_outputs(address, options (optional)): list[UtxoInput]
 
 Gets the UTXO outputs associated with the given address.
 
@@ -266,7 +266,7 @@ Gets the UTXO outputs associated with the given address.
 | [address] | <code>str</code>                                               | <code>undefined</code> | The address Bech32 string |
 | [options] | <code>[[AddressOutputsOptions](#addressoutputsoptions)]</code> | <code>undefined</code> | The query filters         |
 
-**Returns** the list of [UTXOInput](#utxoinput).
+**Returns** the list of [UtxoInput](#UtxoInput).
 
 #### find_outputs(output_ids (optional), addresses (optional)): list[OutputResponse]
 
@@ -564,7 +564,7 @@ message_metadata_response = {
 
 Please refer to [LedgerInclusionStateDto](#ledgerinclusionstatedto) for the details of this type.
 
-#### BalanceForAddressResponse
+#### BalanceAddressResponse
 
 A dict with the following key/value pairs.
 
@@ -584,6 +584,7 @@ A dict with the following key/value pairs.
 address_balance_pair = {
     'address': str,
     'balance': int
+    'dust_allowed': bool
 }
 ```
 
@@ -633,7 +634,7 @@ treasuryResponse = {
 }
 ```
 
-#### UTXOInput
+#### UtxoInput
 
 A dict with the following key/value pairs.
 

bindings/python/native/src/client/full_node_api.rs

@@ -2,12 +2,12 @@
 // SPDX-License-Identifier: Apache-2.0
 
 use crate::client::{
-    error::Result, AddressOutputsOptions, BalanceForAddressResponse, Client, InfoResponse, Message, MilestoneDto,
-    MilestoneUTXOChanges, OutputResponse, PeerDto, ReceiptDto, TreasuryResponse, UTXOInput,
+    error::Result, AddressOutputsOptions, BalanceAddressResponse, Client, InfoResponse, Message, MilestoneDto,
+    MilestoneUTXOChanges, OutputResponse, PeerDto, ReceiptDto, TreasuryResponse, UtxoInput,
 };
 use iota::{
     ClientMiner as RustClientMiner, MessageBuilder as RustMessageBuilder, MessageId as RustMessageId, Parents,
-    TransactionId as RustTransactionId, UTXOInput as RustUTXOInput,
+    TransactionId as RustTransactionId, UtxoInput as RustUtxoInput,
 };
 use pyo3::prelude::*;
 
@@ -53,12 +53,12 @@ impl Client {
         Ok(crate::block_on(async { self.client.post_message(&msg).await })?.to_string())
     }
     fn get_output(&self, output_id: String) -> Result<OutputResponse> {
-        Ok(crate::block_on(async { self.client.get_output(&RustUTXOInput::from_str(&output_id)?).await })?.into())
+        Ok(crate::block_on(async { self.client.get_output(&RustUtxoInput::from_str(&output_id)?).await })?.into())
     }
-    fn get_address_balance(&self, address: &str) -> Result<BalanceForAddressResponse> {
+    fn get_address_balance(&self, address: &str) -> Result<BalanceAddressResponse> {
         Ok(crate::block_on(async { self.client.get_address().balance(&String::from(address)).await })?.into())
     }
-    fn get_address_outputs(&self, address: &str, options: Option<AddressOutputsOptions>) -> Result<Vec<UTXOInput>> {
+    fn get_address_outputs(&self, address: &str, options: Option<AddressOutputsOptions>) -> Result<Vec<UtxoInput>> {
         let outputs = crate::block_on(async {
             self.client
                 .get_address()
@@ -68,7 +68,7 @@ impl Client {
         Ok((*outputs)
             .to_vec()
             .iter()
-            .map(|output| UTXOInput {
+            .map(|output| UtxoInput {
                 transaction_id: output.output_id().transaction_id().as_ref().to_vec(),
                 index: output.output_id().index(),
             })
@@ -79,10 +79,10 @@ impl Client {
         output_ids: Option<Vec<String>>,
         addresses: Option<Vec<String>>,
     ) -> Result<Vec<OutputResponse>> {
-        let output_ids: Vec<RustUTXOInput> = output_ids
+        let output_ids: Vec<RustUtxoInput> = output_ids
             .unwrap_or_default()
             .iter()
-            .map(|input| RustUTXOInput::from_str(input).unwrap_or_else(|_| panic!("invalid input: {}", input)))
+            .map(|input| RustUtxoInput::from_str(input).unwrap_or_else(|_| panic!("invalid input: {}", input)))
             .collect();
         let addresses: Vec<String> = addresses
             .unwrap_or_default()

bindings/python/native/src/client/high_level_api.rs

@@ -6,7 +6,7 @@ use crate::client::{
     AddressBalancePair, Client, Input, Message, MessageMetadataResponse, Output,
 };
 use iota::{
-    MessageId as RustMessageId, Seed as RustSeed, TransactionId as RustTransactionId, UTXOInput as RustUTXOInput,
+    MessageId as RustMessageId, Seed as RustSeed, TransactionId as RustTransactionId, UtxoInput as RustUtxoInput,
 };
 use pyo3::{exceptions, prelude::*};
 use std::{
@@ -50,7 +50,7 @@ impl Client {
         }
         if let Some(inputs) = inputs {
             for input in inputs {
-                send_builder = send_builder.with_input(RustUTXOInput::new(
+                send_builder = send_builder.with_input(RustUtxoInput::new(
                     RustTransactionId::from_str(&input.transaction_id[..])?,
                     input.index,
                 )?);
@@ -286,6 +286,7 @@ impl Client {
             .map(|address_balance| AddressBalancePair {
                 address: address_balance.address.clone(),
                 balance: address_balance.balance,
+                dust_allowed: address_balance.dust_allowed,
             })
             .collect())
     }

bindings/python/native/src/client/mod.rs

@@ -10,9 +10,9 @@ use iota::{Api, BrokerOptions as RustBrokerOptions, Client as RustClient};
 use pyo3::prelude::*;
 use std::{collections::HashMap, time::Duration};
 use types::{
-    AddressBalancePair, AddressOutputsOptions, BalanceForAddressResponse, BrokerOptions, InfoResponse, Input, Message,
+    AddressBalancePair, AddressOutputsOptions, BalanceAddressResponse, BrokerOptions, InfoResponse, Input, Message,
     MessageMetadataResponse, MilestoneDto, MilestoneUTXOChanges, Output, OutputResponse, PeerDto, ReceiptDto,
-    TreasuryResponse, UTXOInput, BECH32_HRP,
+    TreasuryResponse, UtxoInput, BECH32_HRP,
 };
 
 /// Client builder