Merge branch '1.1' into chore/bindings-cleanup-is-alive

.github/workflows/bindings-nodejs.yml

@@ -94,6 +94,11 @@ jobs:
           yarn
           yarn build
 
+      - name: Test types module webpack compatibility
+        working-directory: bindings/nodejs/
+        run: |
+          yarn run test-webpack
+
   lint:
     name: Lint
     if: ${{ ! github.event.schedule }}

bindings/core/Cargo.toml

@@ -40,3 +40,4 @@ participation = ["iota-sdk/participation"]
 rocksdb = ["iota-sdk/rocksdb"]
 storage = ["iota-sdk/storage"]
 stronghold = ["iota-sdk/stronghold"]
+private_key_secret_manager = ["iota-sdk/private_key_secret_manager"]

bindings/core/src/method/utils.rs

@@ -156,4 +156,7 @@ pub enum UtilsMethod {
     /// Creates a UTXOInput from outputId.
     #[serde(rename_all = "camelCase")]
     OutputIdToUtxoInput { output_id: OutputId },
+    /// Returns the hex representation of the serialized output bytes.
+    #[serde(rename_all = "camelCase")]
+    OutputHexBytes { output: OutputDto },
 }

bindings/core/src/method_handler/utils.rs

@@ -16,6 +16,7 @@ use iota_sdk::{
         TryFromDto,
     },
 };
+use packable::PackableExt;
 
 use crate::{method::UtilsMethod, response::Response, Result};
 
@@ -109,6 +110,10 @@ pub(crate) fn call_utils_method_internal(method: UtilsMethod) -> Result<Response
             Response::Bool(public_key.verify_keccak256(&signature, &message))
         }
         UtilsMethod::OutputIdToUtxoInput { output_id } => Response::Input((&UtxoInput::from(output_id)).into()),
+        UtilsMethod::OutputHexBytes { output } => {
+            let output = Output::try_from_dto(output)?;
+            Response::HexBytes(prefix_hex::encode(output.pack_to_vec()))
+        }
     };
     Ok(response)
 }

bindings/core/src/response.rs

@@ -228,6 +228,8 @@ pub enum Response {
     NodeInfoWrapper(NodeInfoWrapper),
     /// Response for [`Bech32ToHex`](crate::method::UtilsMethod::Bech32ToHex)
     HexAddress(String),
+    /// Response for [`OutputHexBytes`](crate::method::UtilsMethod::OutputHexBytes)
+    HexBytes(String),
     /// Response for [`CallPluginRoute`](crate::method::ClientMethod::CallPluginRoute)
     CustomJson(serde_json::Value),
 

bindings/nodejs-old/examples/ledger_nano.js

@@ -3,7 +3,7 @@ require('dotenv').config({ path: path.resolve(__dirname, '.env') });
 const { AccountManager, CoinType } = require('@iota/wallet');
 
 // In this example we will create addresses with a ledger nano hardware wallet
-// To use the ledger nano simulator clone https://github.com/iotaledger/ledger-shimmer-app, run `git submodule init && git submodule update --recursive`,
+// To use the ledger nano simulator clone https://github.com/iotaledger/ledger-iota-app, run `git submodule init && git submodule update --recursive`,
 // then `./build.sh -m nanos|nanox|nanosplus -s` and use `true` for `LedgerNano`.
 
 async function run() {

bindings/nodejs/CHANGELOG.md

@@ -19,13 +19,33 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Security -->
 
-## 1.1.0 - 2023-MM-DD
+## 1.1.0-rc.1 - 2023-09-26
+
+### Fixed
+
+- Import of bindings through types;
+
+## 1.1.0-rc.0 - 2023-09-25
 
 ### Added
 
 - `Account::{burn(), consolidateOutputs(), createAliasOutput(), meltNativeToken(), mintNativeToken(), createNativeToken(), mintNfts(), sendTransaction(), sendNativeTokens(), sendNft()}` methods;
 - `Client::outputIds()` method;
 - `GenericQueryParameter, UnlockableByAddress` types;
+- `Irc27Metadata` and `Irc30Metadata` helpers;
+- `Utils::outputHexBytes`;
+- `PrivateKeySecretManager`;
+
+## 1.0.12 - 2023-09-25
+
+### Changed
+
+- Made `TransactionOptions.allowMicroAmount` optional;
+
+### Fixed
+
+- Parsing of `RegularTransactionEssence.payload`;
+- Don't error if custom remainder address is provided with ledger nano;
 
 ## 1.0.11 - 2023-09-14
 

bindings/nodejs/Cargo.toml

@@ -26,6 +26,7 @@ iota-sdk-bindings-core = { path = "../core", default-features = false, features
     "participation",
     "rocksdb",
     "mqtt",
+    "private_key_secret_manager"
 ] }
 
 log = { version = "0.4.20", default-features = false }

bindings/nodejs/examples/client/15-build-nft-output.ts

@@ -12,6 +12,7 @@ import {
     SenderFeature,
     Ed25519Address,
     IssuerFeature,
+    Irc27Metadata,
 } from '@iota/sdk';
 require('dotenv').config({ path: '.env' });
 
@@ -35,14 +36,11 @@ async function run() {
             'rms1qpllaj0pyveqfkwxmnngz2c488hfdtmfrj3wfkgxtk4gtyrax0jaxzt70zy',
         );
 
-        // IOTA NFT Standard - IRC27: https://github.com/iotaledger/tips/blob/main/tips/TIP-0027/tip-0027.md
-        const tip27ImmutableMetadata = {
-            standard: 'IRC27',
-            version: 'v1.0',
-            type: 'image/jpeg',
-            uri: 'https://mywebsite.com/my-nft-files-1.jpeg',
-            name: 'My NFT #0001',
-        };
+        const tip27ImmutableMetadata = new Irc27Metadata(
+            'image/jpeg',
+            'https://mywebsite.com/my-nft-files-1.jpeg',
+            'My NFT #0001',
+        );
 
         const nftOutput = await client.buildNftOutput({
             // NftId needs to be null the first time
@@ -52,9 +50,7 @@ async function run() {
             ],
             immutableFeatures: [
                 new IssuerFeature(new Ed25519Address(hexAddress)),
-                new MetadataFeature(
-                    utf8ToHex(JSON.stringify(tip27ImmutableMetadata)),
-                ),
+                tip27ImmutableMetadata.asFeature(),
             ],
             features: [
                 new SenderFeature(new Ed25519Address(hexAddress)),

bindings/nodejs/examples/how_tos/native_tokens/create.ts

@@ -1,7 +1,7 @@
 // Copyright 2023 IOTA Stiftung
 // SPDX-License-Identifier: Apache-2.0
 
-import { CreateNativeTokenParams, utf8ToHex } from '@iota/sdk';
+import { CreateNativeTokenParams, Irc30Metadata } from '@iota/sdk';
 
 import { getUnlockedWallet } from '../../wallet/common';
 
@@ -51,11 +51,17 @@ async function run() {
 
         console.log('Preparing transaction to create native token...');
 
+        const metadata = new Irc30Metadata(
+            'My Native Token',
+            'MNT',
+            10,
+        ).withDescription('A native token to test the iota-sdk.');
+
         // If we omit the AccountAddress field the first address of the account is used by default
         const params: CreateNativeTokenParams = {
             circulatingSupply: CIRCULATING_SUPPLY,
             maximumSupply: MAXIMUM_SUPPLY,
-            foundryMetadata: utf8ToHex('Hello, World!'),
+            foundryMetadata: metadata.asHex(),
         };
 
         const prepared = await account.prepareCreateNativeToken(params);

bindings/nodejs/examples/how_tos/nft_collection/01_mint_collection_nft.ts

@@ -1,7 +1,7 @@
 // Copyright 2023 IOTA Stiftung
 // SPDX-License-Identifier: Apache-2.0
 
-import { MintNftParams, NftId, utf8ToHex, Utils, Wallet } from '@iota/sdk';
+import { MintNftParams, NftId, Utils, Wallet, Irc27Metadata } from '@iota/sdk';
 require('dotenv').config({ path: '.env' });
 
 // The NFT collection size
@@ -48,9 +48,7 @@ async function run() {
         // Create the metadata with another index for each
         for (let index = 0; index < NFT_COLLECTION_SIZE; index++) {
             const params: MintNftParams = {
-                immutableMetadata: utf8ToHex(
-                    getImmutableMetadata(index, issuerNftId),
-                ),
+                immutableMetadata: getImmutableMetadata(index).asHex(),
                 // The NFT address from the NFT we minted in mint_issuer_nft example
                 issuer,
             };
@@ -97,21 +95,18 @@ async function run() {
     process.exit(0);
 }
 
-function getImmutableMetadata(index: number, issuerNftId: NftId) {
-    // Note: we use parse and stringify to remove all unnecessary whitespace
-    return JSON.stringify(
-        JSON.parse(`{
-        "standard":"IRC27",
-        "version":"v1.0",
-        "type":"video/mp4",
-        "uri":"ipfs://wrongcVm9fx47YXNTkhpMEYSxCD3Bqh7PJYr7eo5Ywrong",
-        "name":"Shimmer OG NFT ${index}",
-        "description":"The Shimmer OG NFT was handed out 1337 times by the IOTA Foundation to celebrate the official launch of the Shimmer Network.",
-        "issuerName":"IOTA Foundation",
-        "collectionId":"${issuerNftId}",
-        "collectionName":"Shimmer OG"
-    }`),
-    );
+function getImmutableMetadata(index: number) {
+    return new Irc27Metadata(
+        'video/mp4',
+        'https://ipfs.io/ipfs/QmPoYcVm9fx47YXNTkhpMEYSxCD3Bqh7PJYr7eo5YjLgiT',
+        `Shimmer OG NFT ${index}`,
+    )
+        .withDescription(
+            'The Shimmer OG NFT was handed out 1337 times by the IOTA Foundation \
+        to celebrate the official launch of the Shimmer Network.',
+        )
+        .withIssuerName('IOTA Foundation')
+        .withCollectionName('Shimmer OG');
 }
 
 run();

bindings/nodejs/examples/how_tos/nfts/mint_nft.ts

@@ -10,6 +10,7 @@ import {
     utf8ToHex,
     Utils,
     Wallet,
+    Irc27Metadata,
 } from '@iota/sdk';
 require('dotenv').config({ path: '.env' });
 
@@ -18,8 +19,6 @@ const NFT1_OWNER_ADDRESS =
     'rms1qpszqzadsym6wpppd6z037dvlejmjuke7s24hm95s9fg9vpua7vluaw60xu';
 // The metadata of the first minted NFT
 const NFT1_METADATA = utf8ToHex('some NFT metadata');
-// The immutable metadata of the first minted NFT
-const NFT1_IMMUTABLE_METADATA = utf8ToHex('some NFT immutable metadata');
 // The tag of the first minted NFT
 const NFT1_TAG = utf8ToHex('some NFT tag');
 // The base coin amount we sent with the second NFT
@@ -52,13 +51,19 @@ async function run() {
         // We need to unlock stronghold.
         await wallet.setStrongholdPassword(process.env.STRONGHOLD_PASSWORD);
 
+        const metadata = new Irc27Metadata(
+            'video/mp4',
+            'https://ipfs.io/ipfs/QmPoYcVm9fx47YXNTkhpMEYSxCD3Bqh7PJYr7eo5YjLgiT',
+            'Shimmer OG NFT',
+        ).withDescription('The original Shimmer NFT');
+
         const params: MintNftParams = {
             address: NFT1_OWNER_ADDRESS, // Remove or change to senderAddress to send to self
             sender: senderAddress,
             metadata: NFT1_METADATA,
             tag: NFT1_TAG,
             issuer: senderAddress,
-            immutableMetadata: NFT1_IMMUTABLE_METADATA,
+            immutableMetadata: metadata.asHex(),
         };
         let transaction = await account.mintNfts([params]);
         console.log(`Transaction sent: ${transaction.transactionId}`);

bindings/nodejs/examples/secret_manager/ledger-nano.ts

@@ -8,7 +8,7 @@ require('dotenv').config({ path: '.env' });
 // yarn run-example ./secret_manager/ledger-nano.ts
 
 // In this example we will get the ledger status and generate an address
-// To use the ledger nano simulator clone https://github.com/iotaledger/ledger-shimmer-app, run `git submodule init && git submodule update --recursive`,
+// To use the ledger nano simulator clone https://github.com/iotaledger/ledger-iota-app, run `git submodule init && git submodule update --recursive`,
 // then `./build.sh -m nanos|nanox|nanosplus -s` and use `true` in `LedgerSecretManager::new(true)`.
 async function run() {
     initLogger();

bindings/nodejs/lib/types/block/output/index.ts

@@ -5,3 +5,5 @@ export * from './feature';
 export * from './unlock-condition';
 export * from './output';
 export * from './token-scheme';
+export * from './irc-27';
+export * from './irc-30';