Update MetadataFeature (#1764)

* Refactor MetadataFeature * Fix no_std * Fix IRC27/30 * Address some TODOs * Some fixes * Address comments * Use is_ascii_graphic * Handle potential > u8 type * Add explicit is_empty() check * Update packable * Accept IntoIterator in MetadataFeature::new() * Simply Metadata::new usage in more places * Update comment * Add TryFrom<Vec<(Vec<u8>, Vec<u8>)>> for MetadataFeature, uncomment test * One more place * Update sdk/src/types/block/rand/output/feature.rs Co-authored-by: Thibault Martinez <[email protected]> * Update cli/src/wallet_cli/mod.rs Co-authored-by: Thibault Martinez <[email protected]> * Update error name * Change foundry_metadata, add TODOs * Update test * Update example * Update example * Return error for duplicated keys * Remove duplicated validation * Update cli commands * Temporarily allow broken doc links * Address review comments * Apply suggestions from code review * sorry * Refactor try from impls * Update sdk/src/types/block/output/feature/metadata.rs * Update sdk/src/types/block/output/feature/metadata.rs * Add MetadataFeature tests * Allow setting foundry metadata key * Manual packable impl for MetadataFeature for length verification * Add MetadataBTreeMap types * Derive packable again * Add +1 for type byte * Update tests * fmt * Improve error message * Add import * Use CounterUnpacker, fix rand_metadata_feature(), fix entry count type, fix rand_mana_allotment() * Align key * improvements * Small fixes, improvements, clippy * no_std * Fix doc comment * Review suggestions * Consistentency * Remove unwrap --------- Co-authored-by: Thibault Martinez <[email protected]> Co-authored-by: Thibault Martinez <[email protected]> Co-authored-by: Alex Coats <[email protected]>
iotaledger · Jan 17, 2024 · b809589 · b809589
1 parent 60d7eb2
commit b809589
Show file tree

Hide file tree

Showing 40 changed files with 1,108 additions and 703 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/bindings/core/Cargo.toml b/bindings/core/Cargo.toml
@@ -23,7 +23,7 @@ iota-crypto = { version = "0.23.0", default-features = false, features = [
     "bip44",
 ] }
 log = { version = "0.4.20", default-features = false }
-packable = { version = "0.10.0", default-features = false }
+packable = { version = "0.10.1", default-features = false }
 prefix-hex = { version = "0.7.1", default-features = false }
 primitive-types = { version = "0.12.2", default-features = false }
 serde = { version = "1.0.195", default-features = false }

diff --git a/bindings/core/src/method/wallet.rs b/bindings/core/src/method/wallet.rs
@@ -8,12 +8,12 @@ use crypto::keys::bip44::Bip44;
 use derivative::Derivative;
 #[cfg(feature = "events")]
 use iota_sdk::wallet::events::types::{WalletEvent, WalletEventType};
-#[cfg(feature = "participation")]
-use iota_sdk::{
-    client::node_manager::node::Node,
-    types::api::plugins::participation::types::{ParticipationEventId, ParticipationEventType},
-    wallet::types::participation::ParticipationEventRegistrationOptions,
-};
+// #[cfg(feature = "participation")]
+// use iota_sdk::{
+//     client::node_manager::node::Node,
+//     types::api::plugins::participation::types::{ParticipationEventId, ParticipationEventType},
+//     wallet::types::participation::ParticipationEventRegistrationOptions,
+// };
 use iota_sdk::{
     client::{
         api::{input_selection::Burn, PreparedTransactionDataDto, SignedTransactionDataDto},
@@ -122,12 +122,12 @@ pub enum WalletMethod {
     /// Expected response: [`SentTransaction`](crate::Response::SentTransaction)
     #[serde(rename_all = "camelCase")]
     ClaimOutputs { output_ids_to_claim: Vec<OutputId> },
-    /// Removes a previously registered participation event from local storage.
-    /// Expected response: [`Ok`](crate::Response::Ok)
-    #[cfg(feature = "participation")]
-    #[cfg_attr(docsrs, doc(cfg(feature = "participation")))]
-    #[serde(rename_all = "camelCase")]
-    DeregisterParticipationEvent { event_id: ParticipationEventId },
+    // /// Removes a previously registered participation event from local storage.
+    // /// Expected response: [`Ok`](crate::Response::Ok)
+    // #[cfg(feature = "participation")]
+    // #[cfg_attr(docsrs, doc(cfg(feature = "participation")))]
+    // #[serde(rename_all = "camelCase")]
+    // DeregisterParticipationEvent { event_id: ParticipationEventId },
     /// Get the wallet address.
     /// Expected response: [`Address`](crate::Response::Address)
     GetAddress,
@@ -147,48 +147,48 @@ pub enum WalletMethod {
     /// Expected response: [`OutputData`](crate::Response::OutputData)
     #[serde(rename_all = "camelCase")]
     GetOutput { output_id: OutputId },
-    /// Expected response: [`ParticipationEvent`](crate::Response::ParticipationEvent)
-    #[cfg(feature = "participation")]
-    #[cfg_attr(docsrs, doc(cfg(feature = "participation")))]
-    #[serde(rename_all = "camelCase")]
-    GetParticipationEvent { event_id: ParticipationEventId },
-    /// Expected response: [`ParticipationEventIds`](crate::Response::ParticipationEventIds)
-    #[cfg(feature = "participation")]
-    #[cfg_attr(docsrs, doc(cfg(feature = "participation")))]
-    #[serde(rename_all = "camelCase")]
-    GetParticipationEventIds {
-        node: Node,
-        event_type: Option<ParticipationEventType>,
-    },
-    /// Expected response:
-    /// [`ParticipationEventStatus`](crate::Response::ParticipationEventStatus)
-    #[cfg(feature = "participation")]
-    #[cfg_attr(docsrs, doc(cfg(feature = "participation")))]
-    #[serde(rename_all = "camelCase")]
-    GetParticipationEventStatus { event_id: ParticipationEventId },
-    /// Expected response: [`ParticipationEvents`](crate::Response::ParticipationEvents)
-    #[cfg(feature = "participation")]
-    #[cfg_attr(docsrs, doc(cfg(feature = "participation")))]
-    GetParticipationEvents,
-    /// Calculates a participation overview for the wallet. If event_ids are provided, only return outputs and tracked
-    /// participations for them.
-    /// Expected response: [`ParticipationOverview`](crate::Response::ParticipationOverview)
-    #[cfg(feature = "participation")]
-    #[cfg_attr(docsrs, doc(cfg(feature = "participation")))]
-    #[serde(rename_all = "camelCase")]
-    GetParticipationOverview {
-        event_ids: Option<Vec<ParticipationEventId>>,
-    },
+    // /// Expected response: [`ParticipationEvent`](crate::Response::ParticipationEvent)
+    // #[cfg(feature = "participation")]
+    // #[cfg_attr(docsrs, doc(cfg(feature = "participation")))]
+    // #[serde(rename_all = "camelCase")]
+    // GetParticipationEvent { event_id: ParticipationEventId },
+    // /// Expected response: [`ParticipationEventIds`](crate::Response::ParticipationEventIds)
+    // #[cfg(feature = "participation")]
+    // #[cfg_attr(docsrs, doc(cfg(feature = "participation")))]
+    // #[serde(rename_all = "camelCase")]
+    // GetParticipationEventIds {
+    //     node: Node,
+    //     event_type: Option<ParticipationEventType>,
+    // },
+    // /// Expected response:
+    // /// [`ParticipationEventStatus`](crate::Response::ParticipationEventStatus)
+    // #[cfg(feature = "participation")]
+    // #[cfg_attr(docsrs, doc(cfg(feature = "participation")))]
+    // #[serde(rename_all = "camelCase")]
+    // GetParticipationEventStatus { event_id: ParticipationEventId },
+    // /// Expected response: [`ParticipationEvents`](crate::Response::ParticipationEvents)
+    // #[cfg(feature = "participation")]
+    // #[cfg_attr(docsrs, doc(cfg(feature = "participation")))]
+    // GetParticipationEvents,
+    // /// Calculates a participation overview for the wallet. If event_ids are provided, only return outputs and
+    // tracked /// participations for them.
+    // /// Expected response: [`ParticipationOverview`](crate::Response::ParticipationOverview)
+    // #[cfg(feature = "participation")]
+    // #[cfg_attr(docsrs, doc(cfg(feature = "participation")))]
+    // #[serde(rename_all = "camelCase")]
+    // GetParticipationOverview {
+    //     event_ids: Option<Vec<ParticipationEventId>>,
+    // },
     /// Get the [`TransactionWithMetadata`](iota_sdk::wallet::types::TransactionWithMetadata) of a transaction stored
     /// in the wallet.
     /// Expected response: [`Transaction`](crate::Response::Transaction)
     #[serde(rename_all = "camelCase")]
     GetTransaction { transaction_id: TransactionId },
-    /// Get the wallet's total voting power (voting or NOT voting).
-    /// Expected response: [`VotingPower`](crate::Response::VotingPower)
-    #[cfg(feature = "participation")]
-    #[cfg_attr(docsrs, doc(cfg(feature = "participation")))]
-    GetVotingPower,
+    // /// Get the wallet's total voting power (voting or NOT voting).
+    // /// Expected response: [`VotingPower`](crate::Response::VotingPower)
+    // #[cfg(feature = "participation")]
+    // #[cfg_attr(docsrs, doc(cfg(feature = "participation")))]
+    // GetVotingPower,
     /// Returns the implicit account creation address of the wallet if it is Ed25519 based.
     /// Expected response: [`Bech32Address`](crate::Response::Bech32Address)
     ImplicitAccountCreationAddress,
@@ -246,26 +246,26 @@ pub enum WalletMethod {
         params: CreateNativeTokenParams,
         options: Option<TransactionOptions>,
     },
-    /// Reduces a wallet's "voting power" by a given amount.
-    /// This will stop voting, but the voting data isn't lost and calling `Vote` without parameters will revote.
-    /// Expected response: [`PreparedTransaction`](crate::Response::PreparedTransaction)
-    #[cfg(feature = "participation")]
-    #[cfg_attr(docsrs, doc(cfg(feature = "participation")))]
-    PrepareDecreaseVotingPower {
-        #[serde(with = "iota_sdk::utils::serde::string")]
-        amount: u64,
-    },
-    /// Designates a given amount of tokens towards a wallet's "voting power" by creating a
-    /// special output, which is really a basic one with some metadata.
-    /// This will stop voting in most cases (if there is a remainder output), but the voting data isn't lost and
-    /// calling `Vote` without parameters will revote. Expected response:
-    /// Expected response: [`PreparedTransaction`](crate::Response::PreparedTransaction)
-    #[cfg(feature = "participation")]
-    #[cfg_attr(docsrs, doc(cfg(feature = "participation")))]
-    PrepareIncreaseVotingPower {
-        #[serde(with = "iota_sdk::utils::serde::string")]
-        amount: u64,
-    },
+    // /// Reduces a wallet's "voting power" by a given amount.
+    // /// This will stop voting, but the voting data isn't lost and calling `Vote` without parameters will revote.
+    // /// Expected response: [`PreparedTransaction`](crate::Response::PreparedTransaction)
+    // #[cfg(feature = "participation")]
+    // #[cfg_attr(docsrs, doc(cfg(feature = "participation")))]
+    // PrepareDecreaseVotingPower {
+    //     #[serde(with = "iota_sdk::utils::serde::string")]
+    //     amount: u64,
+    // },
+    // /// Designates a given amount of tokens towards a wallet's "voting power" by creating a
+    // /// special output, which is really a basic one with some metadata.
+    // /// This will stop voting in most cases (if there is a remainder output), but the voting data isn't lost and
+    // /// calling `Vote` without parameters will revote. Expected response:
+    // /// Expected response: [`PreparedTransaction`](crate::Response::PreparedTransaction)
+    // #[cfg(feature = "participation")]
+    // #[cfg_attr(docsrs, doc(cfg(feature = "participation")))]
+    // PrepareIncreaseVotingPower {
+    //     #[serde(with = "iota_sdk::utils::serde::string")]
+    //     amount: u64,
+    // },
     /// Prepare to melt native tokens. This happens with the foundry output which minted them, by increasing it's
     /// `melted_tokens` field.
     /// Expected response: [`PreparedTransaction`](crate::Response::PreparedTransaction)
@@ -318,36 +318,36 @@ pub enum WalletMethod {
         params: Vec<SendNftParams>,
         options: Option<TransactionOptions>,
     },
-    /// Stop participating for an event.
-    /// Expected response: [`PreparedTransaction`](crate::Response::PreparedTransaction)
-    #[cfg(feature = "participation")]
-    #[cfg_attr(docsrs, doc(cfg(feature = "participation")))]
-    #[serde(rename_all = "camelCase")]
-    PrepareStopParticipating { event_id: ParticipationEventId },
+    // /// Stop participating for an event.
+    // /// Expected response: [`PreparedTransaction`](crate::Response::PreparedTransaction)
+    // #[cfg(feature = "participation")]
+    // #[cfg_attr(docsrs, doc(cfg(feature = "participation")))]
+    // #[serde(rename_all = "camelCase")]
+    // PrepareStopParticipating { event_id: ParticipationEventId },
     /// Prepare transaction.
     /// Expected response: [`PreparedTransaction`](crate::Response::PreparedTransaction)
     PrepareTransaction {
         outputs: Vec<Output>,
         options: Option<TransactionOptions>,
     },
-    /// Vote for a participation event.
-    /// Expected response: [`PreparedTransaction`](crate::Response::PreparedTransaction)
-    #[cfg(feature = "participation")]
-    #[cfg_attr(docsrs, doc(cfg(feature = "participation")))]
-    #[serde(rename_all = "camelCase")]
-    PrepareVote {
-        event_id: Option<ParticipationEventId>,
-        answers: Option<Vec<u8>>,
-    },
-    /// Stores participation information locally and returns the event.
-    ///
-    /// This will NOT store the node url and auth inside the client options.
-    /// Expected response: [`ParticipationEvents`](crate::Response::ParticipationEvents)
-    #[cfg(feature = "participation")]
-    #[cfg_attr(docsrs, doc(cfg(feature = "participation")))]
-    RegisterParticipationEvents {
-        options: ParticipationEventRegistrationOptions,
-    },
+    // /// Vote for a participation event.
+    // /// Expected response: [`PreparedTransaction`](crate::Response::PreparedTransaction)
+    // #[cfg(feature = "participation")]
+    // #[cfg_attr(docsrs, doc(cfg(feature = "participation")))]
+    // #[serde(rename_all = "camelCase")]
+    // PrepareVote {
+    //     event_id: Option<ParticipationEventId>,
+    //     answers: Option<Vec<u8>>,
+    // },
+    // /// Stores participation information locally and returns the event.
+    // ///
+    // /// This will NOT store the node url and auth inside the client options.
+    // /// Expected response: [`ParticipationEvents`](crate::Response::ParticipationEvents)
+    // #[cfg(feature = "participation")]
+    // #[cfg_attr(docsrs, doc(cfg(feature = "participation")))]
+    // RegisterParticipationEvents {
+    //     options: ParticipationEventRegistrationOptions,
+    // },
     /// Reissues a transaction sent from the wallet for a provided transaction id until it's
     /// included (referenced by a milestone). Returns the included block id.
     /// Expected response: [`BlockId`](crate::Response::BlockId)