@twin.org/wallet-connector-iota 0.0.1-next.3

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 IOTA Stiftung.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,21 @@
+# TWIN Wallet Connector IOTA
+
+Wallet connector implementation using IOTA.
+
+## Installation
+
+```shell
+npm install @twin.org/wallet-connector-iota
+```
+
+## Examples
+
+Usage of the APIs is shown in the examples [docs/examples.md](docs/examples.md)
+
+## Reference
+
+Detailed reference documentation for the API can be found in [docs/reference/index.md](docs/reference/index.md)
+
+## Changelog
+
+The changes between each version can be found in [docs/changelog.md](docs/changelog.md)

package/dist/cjs/index.cjs

@@ -0,0 +1,264 @@
+'use strict';
+
+var index_js = require('@iota/sdk-wasm/node/lib/index.js');
+var core = require('@twin.org/core');
+var dltIota = require('@twin.org/dlt-iota');
+var crypto = require('@twin.org/crypto');
+var vaultModels = require('@twin.org/vault-models');
+var walletModels = require('@twin.org/wallet-models');
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Class for performing faucet operations on IOTA.
+ */
+class IotaFaucetConnector {
+    /**
+     * The namespace supported by the wallet connector.
+     */
+    static NAMESPACE = "iota";
+    /**
+     * Runtime name for the class.
+     */
+    CLASS_NAME = "IotaFaucetConnector";
+    /**
+     * The configuration to use for tangle operations.
+     * @internal
+     */
+    _config;
+    /**
+     * The IOTA Wallet client.
+     * @internal
+     */
+    _client;
+    /**
+     * Create a new instance of IotaFaucetConnector.
+     * @param options The options for the connector.
+     * @param options.config The configuration to use.
+     */
+    constructor(options) {
+        core.Guards.object(this.CLASS_NAME, "options", options);
+        core.Guards.object(this.CLASS_NAME, "options.config", options.config);
+        core.Guards.object(this.CLASS_NAME, "options.config.clientOptions", options.config.clientOptions);
+        core.Guards.stringValue(this.CLASS_NAME, "options.config.endpoint", options.config.endpoint);
+        this._config = options.config;
+    }
+    /**
+     * Fund the wallet from the faucet.
+     * @param identity The identity of the user to access the vault keys.
+     * @param address The bech32 encoded address of the address to fund.
+     * @param timeoutInSeconds The timeout in seconds to wait for the funding to complete.
+     * @returns The amount added to the address by the faucet.
+     */
+    async fundAddress(identity, address, timeoutInSeconds = 60) {
+        core.Guards.stringValue(this.CLASS_NAME, "identity", identity);
+        try {
+            const client = await this.createClient();
+            const oldBalance = await this.getBalance(address);
+            await client.requestFundsFromFaucet(this._config.endpoint, address);
+            const numTries = Math.ceil(timeoutInSeconds / 5);
+            for (let i = 0; i < numTries; i++) {
+                const newBalance = await this.getBalance(address);
+                if (newBalance > oldBalance) {
+                    // The balance increased so we can return the new balance
+                    return newBalance - oldBalance;
+                }
+                // Still waiting for the balance to update so wait and try again
+                await new Promise(resolve => setTimeout(resolve, 5000));
+            }
+        }
+        catch (error) {
+            throw new core.GeneralError(this.CLASS_NAME, "fundingFailed", undefined, dltIota.Iota.extractPayloadError(error));
+        }
+        return 0n;
+    }
+    /**
+     * Calculate the balance on an address.
+     * @param address The bech32 encoded address to get the balance.
+     * @returns The amount available on the wallet address.
+     * @internal
+     */
+    async getBalance(address) {
+        const client = await this.createClient();
+        const outputIds = await client.basicOutputIds([
+            { address },
+            { hasExpiration: false },
+            { hasTimelock: false },
+            { hasStorageDepositReturn: false }
+        ]);
+        const outputs = await client.getOutputs(outputIds.items);
+        let totalAmount = BigInt(0);
+        for (const output of outputs) {
+            totalAmount += output.output.getAmount();
+        }
+        return totalAmount;
+    }
+    /**
+     * Create a client for the IOTA network.
+     * @returns The client.
+     * @internal
+     */
+    async createClient() {
+        if (!this._client) {
+            this._client = new index_js.Client(this._config.clientOptions);
+        }
+        return this._client;
+    }
+}
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Class for performing wallet operations on IOTA.
+ */
+class IotaWalletConnector {
+    /**
+     * The namespace supported by the wallet connector.
+     */
+    static NAMESPACE = "iota";
+    /**
+     * Runtime name for the class.
+     */
+    CLASS_NAME = "IotaWalletConnector";
+    /**
+     * The configuration to use for tangle operations.
+     * @internal
+     */
+    _config;
+    /**
+     * The vault for the mnemonic or seed.
+     * @internal
+     */
+    _vaultConnector;
+    /**
+     * The IOTA faucet.
+     * @internal
+     */
+    _faucetConnector;
+    /**
+     * Create a new instance of IotaWalletConnector.
+     * @param options The options for the wallet connector.
+     * @param options.vaultConnectorType Vault connector to use for wallet secrets, defaults to "vault".
+     * @param options.faucetConnectorType Optional faucet for requesting funds, defaults to "faucet".
+     * @param options.config The configuration to use.
+     */
+    constructor(options) {
+        core.Guards.object(this.CLASS_NAME, "options", options);
+        core.Guards.object(this.CLASS_NAME, "options.config", options.config);
+        core.Guards.object(this.CLASS_NAME, "options.config.clientOptions", options.config.clientOptions);
+        this._vaultConnector = vaultModels.VaultConnectorFactory.get(options?.vaultConnectorType ?? "vault");
+        this._faucetConnector = walletModels.FaucetConnectorFactory.getIfExists(options?.faucetConnectorType ?? "faucet");
+        this._config = options.config;
+        dltIota.Iota.populateConfig(this._config);
+    }
+    /**
+     * Create a new wallet.
+     * @param identity The identity of the user to access the vault keys.
+     * @returns Nothing.
+     */
+    async create(identity) {
+        core.Guards.stringValue(this.CLASS_NAME, "identity", identity);
+        const mnemonic = crypto.Bip39.randomMnemonic();
+        await this._vaultConnector.setSecret(dltIota.Iota.buildMnemonicKey(this._config, identity), mnemonic);
+        const seed = crypto.Bip39.mnemonicToSeed(mnemonic);
+        await this._vaultConnector.setSecret(dltIota.Iota.buildSeedKey(this._config, identity), core.Converter.bytesToBase64(seed));
+    }
+    /**
+     * Get the addresses for the requested range.
+     * @param identity The identity of the user to access the vault keys.
+     * @param accountIndex The account index to get the addresses for.
+     * @param startAddressIndex The start index for the addresses.
+     * @param count The number of addresses to generate.
+     * @returns The list of addresses.
+     */
+    async getAddresses(identity, accountIndex, startAddressIndex, count) {
+        return dltIota.Iota.getAddresses(this._config, this._vaultConnector, identity, accountIndex, startAddressIndex, count);
+    }
+    /**
+     * Get the balance for an address in a wallet.
+     * @param identity The identity of the user to access the vault keys.
+     * @param address The bech32 encoded address.
+     * @returns The balance of the wallet address.
+     */
+    async getBalance(identity, address) {
+        core.Guards.stringValue(this.CLASS_NAME, "identity", identity);
+        core.Guards.stringValue(this.CLASS_NAME, "address", address);
+        const client = new index_js.Client(this._config.clientOptions);
+        const outputIds = await client.basicOutputIds([
+            { address },
+            { hasExpiration: false },
+            { hasTimelock: false },
+            { hasStorageDepositReturn: false }
+        ]);
+        const outputs = await client.getOutputs(outputIds.items);
+        let totalAmount = BigInt(0);
+        for (const output of outputs) {
+            totalAmount += output.output.getAmount();
+        }
+        return totalAmount;
+    }
+    /**
+     * Ensure the balance for an address in a wallet.
+     * @param identity The identity of the user to access the vault keys.
+     * @param address The bech32 encoded address.
+     * @param ensureBalance The balance to ensure on the address.
+     * @param timeoutInSeconds The timeout in seconds to wait for the funding to complete.
+     * @returns True if the balance has been ensured.
+     */
+    async ensureBalance(identity, address, ensureBalance, timeoutInSeconds) {
+        core.Guards.stringValue(this.CLASS_NAME, "identity", identity);
+        core.Guards.stringValue(this.CLASS_NAME, "address", address);
+        core.Guards.bigint(this.CLASS_NAME, "ensureBalance", ensureBalance);
+        if (this._faucetConnector) {
+            let retryCount = 10;
+            let currentBalance = await this.getBalance(identity, address);
+            while (currentBalance < ensureBalance && retryCount > 0) {
+                const addedBalance = await this._faucetConnector.fundAddress(identity, address, timeoutInSeconds);
+                if (addedBalance === 0n) {
+                    // The balance has not increased, so return.
+                    return false;
+                }
+                currentBalance += addedBalance;
+                if (currentBalance < ensureBalance) {
+                    // The balance has increased but is still not enough, wait a second and try again.
+                    await new Promise(resolve => setTimeout(resolve, 1000));
+                    retryCount--;
+                }
+            }
+            return currentBalance >= ensureBalance;
+        }
+        return false;
+    }
+    /**
+     * Transfer funds to an address.
+     * @param identity The identity of the user to access the vault keys.
+     * @param addressSource The bech32 encoded address to send the funds from.
+     * @param addressDest The bech32 encoded address to send the funds to.
+     * @param amount The amount to transfer.
+     * @returns An identifier for the transfer if there was one.
+     */
+    async transfer(identity, addressSource, addressDest, amount) {
+        core.Guards.stringValue(this.CLASS_NAME, "identity", identity);
+        core.Guards.stringValue(this.CLASS_NAME, "addressSource", addressSource);
+        core.Guards.stringValue(this.CLASS_NAME, "addressDest", addressDest);
+        core.Guards.bigint(this.CLASS_NAME, "amount", amount);
+        try {
+            const client = new index_js.Client(this._config.clientOptions);
+            const inputs = await client.findInputs([addressSource], amount);
+            const blockDetails = await dltIota.Iota.prepareAndPostTransaction(this._config, this._vaultConnector, identity, client, {
+                inputs,
+                output: {
+                    address: addressDest,
+                    amount: amount.toString()
+                }
+            });
+            return blockDetails.blockId;
+        }
+        catch (error) {
+            throw new core.GeneralError(this.CLASS_NAME, "transferFailed", undefined, dltIota.Iota.extractPayloadError(error));
+        }
+    }
+}
+
+exports.IotaFaucetConnector = IotaFaucetConnector;
+exports.IotaWalletConnector = IotaWalletConnector;

package/dist/esm/index.mjs

@@ -0,0 +1,261 @@
+import { Client } from '@iota/sdk-wasm/node/lib/index.js';
+import { Guards, GeneralError, Converter } from '@twin.org/core';
+import { Iota } from '@twin.org/dlt-iota';
+import { Bip39 } from '@twin.org/crypto';
+import { VaultConnectorFactory } from '@twin.org/vault-models';
+import { FaucetConnectorFactory } from '@twin.org/wallet-models';
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Class for performing faucet operations on IOTA.
+ */
+class IotaFaucetConnector {
+    /**
+     * The namespace supported by the wallet connector.
+     */
+    static NAMESPACE = "iota";
+    /**
+     * Runtime name for the class.
+     */
+    CLASS_NAME = "IotaFaucetConnector";
+    /**
+     * The configuration to use for tangle operations.
+     * @internal
+     */
+    _config;
+    /**
+     * The IOTA Wallet client.
+     * @internal
+     */
+    _client;
+    /**
+     * Create a new instance of IotaFaucetConnector.
+     * @param options The options for the connector.
+     * @param options.config The configuration to use.
+     */
+    constructor(options) {
+        Guards.object(this.CLASS_NAME, "options", options);
+        Guards.object(this.CLASS_NAME, "options.config", options.config);
+        Guards.object(this.CLASS_NAME, "options.config.clientOptions", options.config.clientOptions);
+        Guards.stringValue(this.CLASS_NAME, "options.config.endpoint", options.config.endpoint);
+        this._config = options.config;
+    }
+    /**
+     * Fund the wallet from the faucet.
+     * @param identity The identity of the user to access the vault keys.
+     * @param address The bech32 encoded address of the address to fund.
+     * @param timeoutInSeconds The timeout in seconds to wait for the funding to complete.
+     * @returns The amount added to the address by the faucet.
+     */
+    async fundAddress(identity, address, timeoutInSeconds = 60) {
+        Guards.stringValue(this.CLASS_NAME, "identity", identity);
+        try {
+            const client = await this.createClient();
+            const oldBalance = await this.getBalance(address);
+            await client.requestFundsFromFaucet(this._config.endpoint, address);
+            const numTries = Math.ceil(timeoutInSeconds / 5);
+            for (let i = 0; i < numTries; i++) {
+                const newBalance = await this.getBalance(address);
+                if (newBalance > oldBalance) {
+                    // The balance increased so we can return the new balance
+                    return newBalance - oldBalance;
+                }
+                // Still waiting for the balance to update so wait and try again
+                await new Promise(resolve => setTimeout(resolve, 5000));
+            }
+        }
+        catch (error) {
+            throw new GeneralError(this.CLASS_NAME, "fundingFailed", undefined, Iota.extractPayloadError(error));
+        }
+        return 0n;
+    }
+    /**
+     * Calculate the balance on an address.
+     * @param address The bech32 encoded address to get the balance.
+     * @returns The amount available on the wallet address.
+     * @internal
+     */
+    async getBalance(address) {
+        const client = await this.createClient();
+        const outputIds = await client.basicOutputIds([
+            { address },
+            { hasExpiration: false },
+            { hasTimelock: false },
+            { hasStorageDepositReturn: false }
+        ]);
+        const outputs = await client.getOutputs(outputIds.items);
+        let totalAmount = BigInt(0);
+        for (const output of outputs) {
+            totalAmount += output.output.getAmount();
+        }
+        return totalAmount;
+    }
+    /**
+     * Create a client for the IOTA network.
+     * @returns The client.
+     * @internal
+     */
+    async createClient() {
+        if (!this._client) {
+            this._client = new Client(this._config.clientOptions);
+        }
+        return this._client;
+    }
+}
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Class for performing wallet operations on IOTA.
+ */
+class IotaWalletConnector {
+    /**
+     * The namespace supported by the wallet connector.
+     */
+    static NAMESPACE = "iota";
+    /**
+     * Runtime name for the class.
+     */
+    CLASS_NAME = "IotaWalletConnector";
+    /**
+     * The configuration to use for tangle operations.
+     * @internal
+     */
+    _config;
+    /**
+     * The vault for the mnemonic or seed.
+     * @internal
+     */
+    _vaultConnector;
+    /**
+     * The IOTA faucet.
+     * @internal
+     */
+    _faucetConnector;
+    /**
+     * Create a new instance of IotaWalletConnector.
+     * @param options The options for the wallet connector.
+     * @param options.vaultConnectorType Vault connector to use for wallet secrets, defaults to "vault".
+     * @param options.faucetConnectorType Optional faucet for requesting funds, defaults to "faucet".
+     * @param options.config The configuration to use.
+     */
+    constructor(options) {
+        Guards.object(this.CLASS_NAME, "options", options);
+        Guards.object(this.CLASS_NAME, "options.config", options.config);
+        Guards.object(this.CLASS_NAME, "options.config.clientOptions", options.config.clientOptions);
+        this._vaultConnector = VaultConnectorFactory.get(options?.vaultConnectorType ?? "vault");
+        this._faucetConnector = FaucetConnectorFactory.getIfExists(options?.faucetConnectorType ?? "faucet");
+        this._config = options.config;
+        Iota.populateConfig(this._config);
+    }
+    /**
+     * Create a new wallet.
+     * @param identity The identity of the user to access the vault keys.
+     * @returns Nothing.
+     */
+    async create(identity) {
+        Guards.stringValue(this.CLASS_NAME, "identity", identity);
+        const mnemonic = Bip39.randomMnemonic();
+        await this._vaultConnector.setSecret(Iota.buildMnemonicKey(this._config, identity), mnemonic);
+        const seed = Bip39.mnemonicToSeed(mnemonic);
+        await this._vaultConnector.setSecret(Iota.buildSeedKey(this._config, identity), Converter.bytesToBase64(seed));
+    }
+    /**
+     * Get the addresses for the requested range.
+     * @param identity The identity of the user to access the vault keys.
+     * @param accountIndex The account index to get the addresses for.
+     * @param startAddressIndex The start index for the addresses.
+     * @param count The number of addresses to generate.
+     * @returns The list of addresses.
+     */
+    async getAddresses(identity, accountIndex, startAddressIndex, count) {
+        return Iota.getAddresses(this._config, this._vaultConnector, identity, accountIndex, startAddressIndex, count);
+    }
+    /**
+     * Get the balance for an address in a wallet.
+     * @param identity The identity of the user to access the vault keys.
+     * @param address The bech32 encoded address.
+     * @returns The balance of the wallet address.
+     */
+    async getBalance(identity, address) {
+        Guards.stringValue(this.CLASS_NAME, "identity", identity);
+        Guards.stringValue(this.CLASS_NAME, "address", address);
+        const client = new Client(this._config.clientOptions);
+        const outputIds = await client.basicOutputIds([
+            { address },
+            { hasExpiration: false },
+            { hasTimelock: false },
+            { hasStorageDepositReturn: false }
+        ]);
+        const outputs = await client.getOutputs(outputIds.items);
+        let totalAmount = BigInt(0);
+        for (const output of outputs) {
+            totalAmount += output.output.getAmount();
+        }
+        return totalAmount;
+    }
+    /**
+     * Ensure the balance for an address in a wallet.
+     * @param identity The identity of the user to access the vault keys.
+     * @param address The bech32 encoded address.
+     * @param ensureBalance The balance to ensure on the address.
+     * @param timeoutInSeconds The timeout in seconds to wait for the funding to complete.
+     * @returns True if the balance has been ensured.
+     */
+    async ensureBalance(identity, address, ensureBalance, timeoutInSeconds) {
+        Guards.stringValue(this.CLASS_NAME, "identity", identity);
+        Guards.stringValue(this.CLASS_NAME, "address", address);
+        Guards.bigint(this.CLASS_NAME, "ensureBalance", ensureBalance);
+        if (this._faucetConnector) {
+            let retryCount = 10;
+            let currentBalance = await this.getBalance(identity, address);
+            while (currentBalance < ensureBalance && retryCount > 0) {
+                const addedBalance = await this._faucetConnector.fundAddress(identity, address, timeoutInSeconds);
+                if (addedBalance === 0n) {
+                    // The balance has not increased, so return.
+                    return false;
+                }
+                currentBalance += addedBalance;
+                if (currentBalance < ensureBalance) {
+                    // The balance has increased but is still not enough, wait a second and try again.
+                    await new Promise(resolve => setTimeout(resolve, 1000));
+                    retryCount--;
+                }
+            }
+            return currentBalance >= ensureBalance;
+        }
+        return false;
+    }
+    /**
+     * Transfer funds to an address.
+     * @param identity The identity of the user to access the vault keys.
+     * @param addressSource The bech32 encoded address to send the funds from.
+     * @param addressDest The bech32 encoded address to send the funds to.
+     * @param amount The amount to transfer.
+     * @returns An identifier for the transfer if there was one.
+     */
+    async transfer(identity, addressSource, addressDest, amount) {
+        Guards.stringValue(this.CLASS_NAME, "identity", identity);
+        Guards.stringValue(this.CLASS_NAME, "addressSource", addressSource);
+        Guards.stringValue(this.CLASS_NAME, "addressDest", addressDest);
+        Guards.bigint(this.CLASS_NAME, "amount", amount);
+        try {
+            const client = new Client(this._config.clientOptions);
+            const inputs = await client.findInputs([addressSource], amount);
+            const blockDetails = await Iota.prepareAndPostTransaction(this._config, this._vaultConnector, identity, client, {
+                inputs,
+                output: {
+                    address: addressDest,
+                    amount: amount.toString()
+                }
+            });
+            return blockDetails.blockId;
+        }
+        catch (error) {
+            throw new GeneralError(this.CLASS_NAME, "transferFailed", undefined, Iota.extractPayloadError(error));
+        }
+    }
+}
+
+export { IotaFaucetConnector, IotaWalletConnector };

package/dist/types/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./iotaFaucetConnector";
+export * from "./iotaWalletConnector";
+export * from "./models/IIotaFaucetConnectorConfig";
+export * from "./models/IIotaWalletConnectorConfig";

package/dist/types/iotaFaucetConnector.d.ts

@@ -0,0 +1,31 @@
+import type { IFaucetConnector } from "@twin.org/wallet-models";
+import type { IIotaFaucetConnectorConfig } from "./models/IIotaFaucetConnectorConfig";
+/**
+ * Class for performing faucet operations on IOTA.
+ */
+export declare class IotaFaucetConnector implements IFaucetConnector {
+    /**
+     * The namespace supported by the wallet connector.
+     */
+    static readonly NAMESPACE: string;
+    /**
+     * Runtime name for the class.
+     */
+    readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of IotaFaucetConnector.
+     * @param options The options for the connector.
+     * @param options.config The configuration to use.
+     */
+    constructor(options: {
+        config: IIotaFaucetConnectorConfig;
+    });
+    /**
+     * Fund the wallet from the faucet.
+     * @param identity The identity of the user to access the vault keys.
+     * @param address The bech32 encoded address of the address to fund.
+     * @param timeoutInSeconds The timeout in seconds to wait for the funding to complete.
+     * @returns The amount added to the address by the faucet.
+     */
+    fundAddress(identity: string, address: string, timeoutInSeconds?: number): Promise<bigint>;
+}

package/dist/types/iotaWalletConnector.d.ts

@@ -0,0 +1,67 @@
+import { type IWalletConnector } from "@twin.org/wallet-models";
+import type { IIotaWalletConnectorConfig } from "./models/IIotaWalletConnectorConfig";
+/**
+ * Class for performing wallet operations on IOTA.
+ */
+export declare class IotaWalletConnector implements IWalletConnector {
+    /**
+     * The namespace supported by the wallet connector.
+     */
+    static readonly NAMESPACE: string;
+    /**
+     * Runtime name for the class.
+     */
+    readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of IotaWalletConnector.
+     * @param options The options for the wallet connector.
+     * @param options.vaultConnectorType Vault connector to use for wallet secrets, defaults to "vault".
+     * @param options.faucetConnectorType Optional faucet for requesting funds, defaults to "faucet".
+     * @param options.config The configuration to use.
+     */
+    constructor(options: {
+        vaultConnectorType?: string;
+        faucetConnectorType?: string;
+        config: IIotaWalletConnectorConfig;
+    });
+    /**
+     * Create a new wallet.
+     * @param identity The identity of the user to access the vault keys.
+     * @returns Nothing.
+     */
+    create(identity: string): Promise<void>;
+    /**
+     * Get the addresses for the requested range.
+     * @param identity The identity of the user to access the vault keys.
+     * @param accountIndex The account index to get the addresses for.
+     * @param startAddressIndex The start index for the addresses.
+     * @param count The number of addresses to generate.
+     * @returns The list of addresses.
+     */
+    getAddresses(identity: string, accountIndex: number, startAddressIndex: number, count: number): Promise<string[]>;
+    /**
+     * Get the balance for an address in a wallet.
+     * @param identity The identity of the user to access the vault keys.
+     * @param address The bech32 encoded address.
+     * @returns The balance of the wallet address.
+     */
+    getBalance(identity: string, address: string): Promise<bigint>;
+    /**
+     * Ensure the balance for an address in a wallet.
+     * @param identity The identity of the user to access the vault keys.
+     * @param address The bech32 encoded address.
+     * @param ensureBalance The balance to ensure on the address.
+     * @param timeoutInSeconds The timeout in seconds to wait for the funding to complete.
+     * @returns True if the balance has been ensured.
+     */
+    ensureBalance(identity: string, address: string, ensureBalance: bigint, timeoutInSeconds?: number): Promise<boolean>;
+    /**
+     * Transfer funds to an address.
+     * @param identity The identity of the user to access the vault keys.
+     * @param addressSource The bech32 encoded address to send the funds from.
+     * @param addressDest The bech32 encoded address to send the funds to.
+     * @param amount The amount to transfer.
+     * @returns An identifier for the transfer if there was one.
+     */
+    transfer(identity: string, addressSource: string, addressDest: string, amount: bigint): Promise<string | undefined>;
+}

package/dist/types/models/IIotaFaucetConnectorConfig.d.ts

@@ -0,0 +1,14 @@
+import type { IClientOptions } from "@iota/sdk-wasm/node/lib/index.js";
+/**
+ * Configuration for the IOTA Faucet Connector.
+ */
+export interface IIotaFaucetConnectorConfig {
+    /**
+     * The configuration for the client.
+     */
+    clientOptions: IClientOptions;
+    /**
+     * The endpoint for the faucet.
+     */
+    endpoint: string;
+}

package/dist/types/models/IIotaWalletConnectorConfig.d.ts

@@ -0,0 +1,5 @@
+import type { IIotaConfig } from "@twin.org/dlt-iota";
+/**
+ * Configuration for the IOTA Wallet Connector.
+ */
+export type IIotaWalletConnectorConfig = IIotaConfig;

package/docs/changelog.md

@@ -0,0 +1,5 @@
+# @twin.org/wallet-connector-iota - Changelog
+
+## v0.0.1-next.3
+
+- Initial Release

package/docs/examples.md

@@ -0,0 +1 @@
+# @twin.org/wallet-connector-iota - Examples

package/docs/reference/classes/IotaFaucetConnector.md

@@ -0,0 +1,81 @@
+# Class: IotaFaucetConnector
+
+Class for performing faucet operations on IOTA.
+
+## Implements
+
+- `IFaucetConnector`
+
+## Constructors
+
+### new IotaFaucetConnector()
+
+> **new IotaFaucetConnector**(`options`): [`IotaFaucetConnector`](IotaFaucetConnector.md)
+
+Create a new instance of IotaFaucetConnector.
+
+#### Parameters
+
+• **options**
+
+The options for the connector.
+
+• **options.config**: [`IIotaFaucetConnectorConfig`](../interfaces/IIotaFaucetConnectorConfig.md)
+
+The configuration to use.
+
+#### Returns
+
+[`IotaFaucetConnector`](IotaFaucetConnector.md)
+
+## Properties
+
+### NAMESPACE
+
+> `readonly` `static` **NAMESPACE**: `string` = `"iota"`
+
+The namespace supported by the wallet connector.
+
+***
+
+### CLASS\_NAME
+
+> `readonly` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+#### Implementation of
+
+`IFaucetConnector.CLASS_NAME`
+
+## Methods
+
+### fundAddress()
+
+> **fundAddress**(`identity`, `address`, `timeoutInSeconds`): `Promise`\<`bigint`\>
+
+Fund the wallet from the faucet.
+
+#### Parameters
+
+• **identity**: `string`
+
+The identity of the user to access the vault keys.
+
+• **address**: `string`
+
+The bech32 encoded address of the address to fund.
+
+• **timeoutInSeconds**: `number` = `60`
+
+The timeout in seconds to wait for the funding to complete.
+
+#### Returns
+
+`Promise`\<`bigint`\>
+
+The amount added to the address by the faucet.
+
+#### Implementation of
+
+`IFaucetConnector.fundAddress`

package/docs/reference/classes/IotaWalletConnector.md

@@ -0,0 +1,217 @@
+# Class: IotaWalletConnector
+
+Class for performing wallet operations on IOTA.
+
+## Implements
+
+- `IWalletConnector`
+
+## Constructors
+
+### new IotaWalletConnector()
+
+> **new IotaWalletConnector**(`options`): [`IotaWalletConnector`](IotaWalletConnector.md)
+
+Create a new instance of IotaWalletConnector.
+
+#### Parameters
+
+• **options**
+
+The options for the wallet connector.
+
+• **options.vaultConnectorType?**: `string`
+
+Vault connector to use for wallet secrets, defaults to "vault".
+
+• **options.faucetConnectorType?**: `string`
+
+Optional faucet for requesting funds, defaults to "faucet".
+
+• **options.config**: `IIotaConfig`
+
+The configuration to use.
+
+#### Returns
+
+[`IotaWalletConnector`](IotaWalletConnector.md)
+
+## Properties
+
+### NAMESPACE
+
+> `readonly` `static` **NAMESPACE**: `string` = `"iota"`
+
+The namespace supported by the wallet connector.
+
+***
+
+### CLASS\_NAME
+
+> `readonly` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+#### Implementation of
+
+`IWalletConnector.CLASS_NAME`
+
+## Methods
+
+### create()
+
+> **create**(`identity`): `Promise`\<`void`\>
+
+Create a new wallet.
+
+#### Parameters
+
+• **identity**: `string`
+
+The identity of the user to access the vault keys.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IWalletConnector.create`
+
+***
+
+### getAddresses()
+
+> **getAddresses**(`identity`, `accountIndex`, `startAddressIndex`, `count`): `Promise`\<`string`[]\>
+
+Get the addresses for the requested range.
+
+#### Parameters
+
+• **identity**: `string`
+
+The identity of the user to access the vault keys.
+
+• **accountIndex**: `number`
+
+The account index to get the addresses for.
+
+• **startAddressIndex**: `number`
+
+The start index for the addresses.
+
+• **count**: `number`
+
+The number of addresses to generate.
+
+#### Returns
+
+`Promise`\<`string`[]\>
+
+The list of addresses.
+
+#### Implementation of
+
+`IWalletConnector.getAddresses`
+
+***
+
+### getBalance()
+
+> **getBalance**(`identity`, `address`): `Promise`\<`bigint`\>
+
+Get the balance for an address in a wallet.
+
+#### Parameters
+
+• **identity**: `string`
+
+The identity of the user to access the vault keys.
+
+• **address**: `string`
+
+The bech32 encoded address.
+
+#### Returns
+
+`Promise`\<`bigint`\>
+
+The balance of the wallet address.
+
+#### Implementation of
+
+`IWalletConnector.getBalance`
+
+***
+
+### ensureBalance()
+
+> **ensureBalance**(`identity`, `address`, `ensureBalance`, `timeoutInSeconds`?): `Promise`\<`boolean`\>
+
+Ensure the balance for an address in a wallet.
+
+#### Parameters
+
+• **identity**: `string`
+
+The identity of the user to access the vault keys.
+
+• **address**: `string`
+
+The bech32 encoded address.
+
+• **ensureBalance**: `bigint`
+
+The balance to ensure on the address.
+
+• **timeoutInSeconds?**: `number`
+
+The timeout in seconds to wait for the funding to complete.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the balance has been ensured.
+
+#### Implementation of
+
+`IWalletConnector.ensureBalance`
+
+***
+
+### transfer()
+
+> **transfer**(`identity`, `addressSource`, `addressDest`, `amount`): `Promise`\<`undefined` \| `string`\>
+
+Transfer funds to an address.
+
+#### Parameters
+
+• **identity**: `string`
+
+The identity of the user to access the vault keys.
+
+• **addressSource**: `string`
+
+The bech32 encoded address to send the funds from.
+
+• **addressDest**: `string`
+
+The bech32 encoded address to send the funds to.
+
+• **amount**: `bigint`
+
+The amount to transfer.
+
+#### Returns
+
+`Promise`\<`undefined` \| `string`\>
+
+An identifier for the transfer if there was one.
+
+#### Implementation of
+
+`IWalletConnector.transfer`

package/docs/reference/index.md

@@ -0,0 +1,14 @@
+# @twin.org/wallet-connector-iota
+
+## Classes
+
+- [IotaFaucetConnector](classes/IotaFaucetConnector.md)
+- [IotaWalletConnector](classes/IotaWalletConnector.md)
+
+## Interfaces
+
+- [IIotaFaucetConnectorConfig](interfaces/IIotaFaucetConnectorConfig.md)
+
+## Type Aliases
+
+- [IIotaWalletConnectorConfig](type-aliases/IIotaWalletConnectorConfig.md)

package/docs/reference/interfaces/IIotaFaucetConnectorConfig.md

@@ -0,0 +1,19 @@
+# Interface: IIotaFaucetConnectorConfig
+
+Configuration for the IOTA Faucet Connector.
+
+## Properties
+
+### clientOptions
+
+> **clientOptions**: `IClientOptions`
+
+The configuration for the client.
+
+***
+
+### endpoint
+
+> **endpoint**: `string`
+
+The endpoint for the faucet.

package/docs/reference/type-aliases/IIotaWalletConnectorConfig.md

@@ -0,0 +1,5 @@
+# Type Alias: IIotaWalletConnectorConfig
+
+> **IIotaWalletConnectorConfig**: `IIotaConfig`
+
+Configuration for the IOTA Wallet Connector.

package/locales/en.json

@@ -0,0 +1,13 @@
+{
+	"error": {
+		"iotaWalletConnector": {
+			"transferFailed": "The wallet transfer failed.",
+			"inclusionFailed": "The transaction generated was not included in a reasonable amount of time",
+			"insufficientFunds": "There were insufficient funds to complete the operation"
+		},
+		"iotaFaucetConnector": {
+			"fundingFailed": "Fund the address from faucet failed",
+			"insufficientFunds": "There were insufficient funds to complete the operation"
+		}
+	}
+}

package/package.json

@@ -0,0 +1,74 @@
+{
+	"name": "@twin.org/wallet-connector-iota",
+	"version": "0.0.1-next.3",
+	"description": "Wallet connector implementation using IOTA",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/wallet.git",
+		"directory": "packages/wallet-connector-iota"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"scripts": {
+		"clean": "rimraf dist coverage docs/reference",
+		"build": "tspc",
+		"test": "vitest --run --config ./vitest.config.ts --no-cache",
+		"coverage": "vitest --run --coverage --config ./vitest.config.ts --no-cache",
+		"bundle:esm": "rollup --config rollup.config.mjs --environment MODULE:esm",
+		"bundle:cjs": "rollup --config rollup.config.mjs --environment MODULE:cjs",
+		"bundle": "npm run bundle:esm && npm run bundle:cjs",
+		"docs:clean": "rimraf docs/reference",
+		"docs:generate": "typedoc",
+		"docs": "npm run docs:clean && npm run docs:generate",
+		"dist": "npm run clean && npm run build && npm run test && npm run bundle && npm run docs"
+	},
+	"dependencies": {
+		"@twin.org/core": "next",
+		"@twin.org/crypto": "next",
+		"@twin.org/dlt-iota": "next",
+		"@twin.org/nameof": "next",
+		"@twin.org/vault-models": "next",
+		"@twin.org/wallet-models": "0.0.1-next.3",
+		"@iota/sdk-wasm": "1.1.3"
+	},
+	"devDependencies": {
+		"@twin.org/nameof-transformer": "next",
+		"@twin.org/entity": "next",
+		"@twin.org/entity-storage-connector-memory": "next",
+		"@twin.org/vault-connector-entity-storage": "next",
+		"@vitest/coverage-v8": "2.1.1",
+		"copyfiles": "2.4.1",
+		"dotenv": "16.4.5",
+		"rimraf": "6.0.1",
+		"rollup": "4.22.0",
+		"rollup-plugin-copy": "3.5.0",
+		"rollup-plugin-typescript2": "0.36.0",
+		"ts-patch": "3.2.1",
+		"typedoc": "0.26.7",
+		"typedoc-plugin-markdown": "4.2.7",
+		"typescript": "5.6.2",
+		"vitest": "2.1.1"
+	},
+	"main": "./dist/cjs/index.cjs",
+	"module": "./dist/esm/index.mjs",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"require": "./dist/cjs/index.cjs",
+			"import": "./dist/esm/index.mjs",
+			"types": "./dist/types/index.d.ts"
+		},
+		"./locales": "./locales"
+	},
+	"files": [
+		"dist/cjs",
+		"dist/esm",
+		"dist/types",
+		"locales",
+		"docs"
+	]
+}