Nodejs single account wallet (#1580)

* Nodejs single account wallet * Remove unused import * Fix address() method * Bring back .env.example, format * Fix merge * Rename sync options, docs --------- Co-authored-by: Thibault Martinez <[email protected]>
iotaledger · Nov 9, 2023 · b0660db · b0660db
1 parent 640328b
commit b0660db
Show file tree

Hide file tree

Showing 18 changed files with 6,244 additions and 6,490 deletions.
diff --git a/bindings/core/src/lib.rs b/bindings/core/src/lib.rs
@@ -18,6 +18,7 @@ pub use iota_sdk;
 use iota_sdk::{
     client::secret::{SecretManager, SecretManagerDto},
     types::block::address::Bech32Address,
+    utils::serde::bip44::option_bip44,
     wallet::{ClientOptions, Wallet},
 };
 use serde::Deserialize;
@@ -45,6 +46,7 @@ pub fn init_logger(config: String) -> std::result::Result<(), fern_logger::Error
 pub struct WalletOptions {
     pub address: Option<Bech32Address>,
     pub alias: Option<String>,
+    #[serde(with = "option_bip44", default)]
     pub bip_path: Option<Bip44>,
     pub client_options: Option<ClientOptions>,
     #[derivative(Debug(format_with = "OmittedDebug::omitted_fmt"))]

diff --git a/bindings/core/src/method_handler/secret_manager.rs b/bindings/core/src/method_handler/secret_manager.rs
@@ -8,7 +8,7 @@ use iota_sdk::client::secret::stronghold::StrongholdSecretManager;
 use iota_sdk::{
     client::{
         api::{GetAddressesOptions, PreparedTransactionData},
-        secret::{DowncastSecretManager, SecretManage, SignBlock},
+        secret::{DowncastSecretManager, SecretManage, SecretManager, SignBlock},
     },
     types::{
         block::{address::ToBech32Ext, core::UnsignedBlock, unlock::Unlock, SignedBlockDto},
@@ -124,6 +124,13 @@ where
             if let Some(secret_manager) = secret_manager.downcast::<StrongholdSecretManager>() {
                 secret_manager.store_mnemonic(mnemonic).await?;
                 Response::Ok
+            } else if let Some(secret_manager) = secret_manager.downcast::<SecretManager>() {
+                if let SecretManager::Stronghold(secret_manager) = secret_manager {
+                    secret_manager.store_mnemonic(mnemonic).await?;
+                    Response::Ok
+                } else {
+                    return Err(iota_sdk::client::Error::SecretManagerMismatch.into());
+                }
             } else {
                 return Err(iota_sdk::client::Error::SecretManagerMismatch.into());
             }

diff --git a/.../accounts_and_addresses/create-account.ts → ...s/accounts_and_addresses/create-wallet.ts b/.../accounts_and_addresses/create-account.ts → ...s/accounts_and_addresses/create-wallet.ts
@@ -1,15 +1,21 @@
 // Copyright 2023 IOTA Stiftung
 // SPDX-License-Identifier: Apache-2.0
 
-import { Wallet, CoinType, initLogger, WalletOptions } from '@iota/sdk';
+import {
+    Wallet,
+    CoinType,
+    initLogger,
+    WalletOptions,
+    SecretManager,
+} from '@iota/sdk';
 
 // This example uses secrets in environment variables for simplicity which should not be done in production.
 require('dotenv').config({ path: '.env' });
 
 // Run with command:
-// yarn run-example ./how_tos/accounts_and_addresses/create-account.ts
+// yarn run-example ./how_tos/accounts_and_addresses/create-wallet.ts
 
-// This example creates a new database and account.
+// This example creates a new database and wallet.
 async function run() {
     initLogger();
     for (const envVar of [
@@ -24,32 +30,47 @@ async function run() {
         }
 
     try {
+        const strongholdSecretManager = {
+            stronghold: {
+                snapshotPath: process.env.STRONGHOLD_SNAPSHOT_PATH,
+                password: process.env.STRONGHOLD_PASSWORD,
+            },
+        };
+
+        const secretManager = new SecretManager(strongholdSecretManager);
+
+        // A mnemonic can be generated with `Utils.generateMnemonic()`.
+        // Store the mnemonic in the Stronghold snapshot, this needs to be done only the first time.
+        // The mnemonic can't be retrieved from the Stronghold file, so make a backup in a secure place!
+        await secretManager.storeMnemonic(process.env.MNEMONIC as string);
+
+        const wallet_address = await secretManager.generateEd25519Addresses({
+            coinType: CoinType.IOTA,
+            accountIndex: 0,
+            range: {
+                start: 0,
+                end: 1,
+            },
+            bech32Hrp: 'tst',
+        });
+
         const walletOptions: WalletOptions = {
+            address: wallet_address[0],
             storagePath: process.env.WALLET_DB_PATH,
             clientOptions: {
                 nodes: [process.env.NODE_URL as string],
             },
-            coinType: CoinType.Shimmer,
-            secretManager: {
-                stronghold: {
-                    snapshotPath: process.env.STRONGHOLD_SNAPSHOT_PATH,
-                    password: process.env.STRONGHOLD_PASSWORD,
-                },
+            bipPath: {
+                coinType: CoinType.IOTA,
             },
+            secretManager: strongholdSecretManager,
         };
 
         const wallet = new Wallet(walletOptions);
 
-        // A mnemonic can be generated with `Utils.generateMnemonic()`.
-        // Store the mnemonic in the Stronghold snapshot, this needs to be done only the first time.
-        // The mnemonic can't be retrieved from the Stronghold file, so make a backup in a secure place!
-        await wallet.storeMnemonic(process.env.MNEMONIC as string);
-
-        // Create a new account
-        const account = await wallet.createAccount({
-            alias: 'Alice',
-        });
-        console.log('Generated new account:', account.getMetadata().alias);
+        console.log(
+            'Generated wallet with address: ' + (await wallet.address()),
+        );
     } catch (error) {
         console.error('Error: ', error);
     }

diff --git a/bindings/nodejs/lib/types/wallet/account.ts b/bindings/nodejs/lib/types/wallet/account.ts
diff --git a/bindings/nodejs/lib/types/wallet/address.ts b/bindings/nodejs/lib/types/wallet/address.ts
@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { SlotIndex } from '../block/slot';
-import { Bech32Address, NftId, OutputId, TokenId } from '../block';
+import { Bech32Address, NftId, TokenId } from '../block';
 import { NumericString, u256, u64 } from '../utils';
 
 /** A Bip44 address */
@@ -35,18 +35,6 @@ export interface SendParams {
     expiration?: SlotIndex;
 }
 
-/** Address with unspent outputs */
-export interface AddressWithUnspentOutputs {
-    /** The Bech32 address. */
-    address: Bech32Address;
-    /** The address key index. */
-    keyIndex: number;
-    /** Whether the address is a public or an internal (change) address. */
-    internal: boolean;
-    /** The IDs of associated unspent outputs. */
-    outputIds: OutputId[];
-}
-
 /** Address with native tokens */
 export interface SendNativeTokensParams {
     /** The Bech32 address. */

diff --git a/bindings/nodejs/lib/types/wallet/bridge/account.ts b/bindings/nodejs/lib/types/wallet/bridge/account.ts
@@ -1,7 +1,6 @@
 // Copyright 2023 IOTA Stiftung
 // SPDX-License-Identifier: Apache-2.0
 
-import type { SyncOptions, FilterOptions } from '../account';
 import type {
     SendParams,
     SendNativeTokensParams,
@@ -25,10 +24,12 @@ import type {
 } from '../participation';
 import type { ConsolidationParams } from '../consolidation-params';
 import {
+    FilterOptions,
     HexEncodedAmount,
     NumericString,
     Output,
     OutputId,
+    SyncOptions,
     TokenId,
     TransactionId,
 } from '../../';