@twin.org/wallet-connector-entity-storage 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 Entity Storage
+
+Wallet connector implementation using entity storage.
+
+## Installation
+
+```shell
+npm install @twin.org/wallet-connector-entity-storage
+```
+
+## 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,312 @@
+'use strict';
+
+var entity = require('@twin.org/entity');
+var core = require('@twin.org/core');
+var entityStorageModels = require('@twin.org/entity-storage-models');
+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 describing a wallet address.
+ */
+exports.WalletAddress = class WalletAddress {
+    /**
+     * The address in the wallet.
+     */
+    address;
+    /**
+     * The identity of the owner.
+     */
+    identity;
+    /**
+     * The balance of the wallet as bigint.
+     */
+    balance;
+};
+__decorate([
+    entity.property({ type: "string", isPrimary: true }),
+    __metadata("design:type", String)
+], exports.WalletAddress.prototype, "address", void 0);
+__decorate([
+    entity.property({ type: "string" }),
+    __metadata("design:type", String)
+], exports.WalletAddress.prototype, "identity", void 0);
+__decorate([
+    entity.property({ type: "string" }),
+    __metadata("design:type", String)
+], exports.WalletAddress.prototype, "balance", void 0);
+exports.WalletAddress = __decorate([
+    entity.entity()
+], exports.WalletAddress);
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Class for performing faucet operations using entity storage.
+ */
+class EntityStorageFaucetConnector {
+    /**
+     * The namespace supported by the wallet connector.
+     */
+    static NAMESPACE = "entity-storage";
+    /**
+     * Runtime name for the class.
+     */
+    CLASS_NAME = "EntityStorageFaucetConnector";
+    /**
+     * The entity storage for wallets.
+     * @internal
+     */
+    _walletAddressEntityStorage;
+    /**
+     * Create a new instance of EntityStorageFaucetConnector.
+     * @param options The options for the wallet connector.
+     * @param options.walletAddressEntityStorageType The entity storage type for wallet addresses, defaults to "wallet-address".
+     */
+    constructor(options) {
+        this._walletAddressEntityStorage = entityStorageModels.EntityStorageConnectorFactory.get(options?.walletAddressEntityStorageType ?? "wallet-address");
+    }
+    /**
+     * 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);
+        core.Guards.stringValue(this.CLASS_NAME, "address", address);
+        let walletAddress = await this._walletAddressEntityStorage.get(address);
+        if (core.Is.empty(walletAddress)) {
+            walletAddress = {
+                balance: "0",
+                identity,
+                address
+            };
+        }
+        const maxFundAmount = 1000000000n;
+        const balance = core.Coerce.bigint(walletAddress.balance) ?? 0n;
+        walletAddress.balance = (balance + maxFundAmount).toString();
+        await this._walletAddressEntityStorage.set(walletAddress);
+        return maxFundAmount;
+    }
+}
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Class for performing wallet operations using in-memory storage.
+ */
+class EntityStorageWalletConnector {
+    /**
+     * The namespace supported by the wallet connector.
+     */
+    static NAMESPACE = "entity-storage";
+    /**
+     * Default name for the mnemonic secret.
+     * @internal
+     */
+    static _DEFAULT_MNEMONIC_SECRET_NAME = "mnemonic";
+    /**
+     * Default coin type.
+     * @internal
+     */
+    static _DEFAULT_COIN_TYPE = 9999;
+    /**
+     * Default bech32 hrp.
+     * @internal
+     */
+    static _DEFAULT_BECH32_HRP = "ent";
+    /**
+     * Runtime name for the class.
+     */
+    CLASS_NAME = "EntityStorageWalletConnector";
+    /**
+     * The vault for the mnemonic.
+     * @internal
+     */
+    _vaultConnector;
+    /**
+     * The faucet.
+     * @internal
+     */
+    _faucetConnector;
+    /**
+     * The entity storage for wallets.
+     * @internal
+     */
+    _walletAddressEntityStorage;
+    /**
+     * The configuration to use for tangle operations.
+     * @internal
+     */
+    _config;
+    /**
+     * Create a new instance of EntityStorageWalletConnector.
+     * @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.walletAddressEntityStorageType The entity storage for wallets, defaults to "wallet-address".
+     * @param options.config The configuration to use.
+     */
+    constructor(options) {
+        this._vaultConnector = vaultModels.VaultConnectorFactory.get(options?.vaultConnectorType ?? "vault");
+        this._faucetConnector = walletModels.FaucetConnectorFactory.getIfExists(options?.faucetConnectorType ?? "faucet");
+        this._walletAddressEntityStorage = entityStorageModels.EntityStorageConnectorFactory.get(options?.walletAddressEntityStorageType ?? "wallet-address");
+        this._config = options?.config ?? {};
+        this._config.coinType ??= EntityStorageWalletConnector._DEFAULT_COIN_TYPE;
+        this._config.bech32Hrp ??= EntityStorageWalletConnector._DEFAULT_BECH32_HRP;
+    }
+    /**
+     * 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(this.buildMnemonicKey(identity), mnemonic);
+    }
+    /**
+     * 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) {
+        core.Guards.stringValue(this.CLASS_NAME, "identity", identity);
+        core.Guards.integer(this.CLASS_NAME, "startAddressIndex", startAddressIndex);
+        core.Guards.integer(this.CLASS_NAME, "count", count);
+        const mnemonic = await this._vaultConnector.getSecret(this.buildMnemonicKey(identity));
+        const seed = crypto.Bip39.mnemonicToSeed(mnemonic);
+        const keyPairs = [];
+        for (let i = startAddressIndex; i < startAddressIndex + count; i++) {
+            const addressKeyPair = crypto.Bip44.addressBech32(seed, crypto.KeyType.Ed25519, this._config.bech32Hrp ?? EntityStorageWalletConnector._DEFAULT_BECH32_HRP, this._config.coinType ?? EntityStorageWalletConnector._DEFAULT_COIN_TYPE, accountIndex, false, i);
+            keyPairs.push(addressKeyPair.address);
+        }
+        return keyPairs;
+    }
+    /**
+     * 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, "address", address);
+        const walletAddress = await this._walletAddressEntityStorage.get(address);
+        return core.Coerce.bigint(walletAddress?.balance) ?? 0n;
+    }
+    /**
+     * 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 and try again.
+                    await new Promise(resolve => setTimeout(resolve, 100));
+                    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);
+        const walletAddresses = await this._walletAddressEntityStorage.query({
+            logicalOperator: entity.LogicalOperator.And,
+            conditions: [
+                {
+                    property: "identity",
+                    comparison: entity.ComparisonOperator.Equals,
+                    value: identity
+                },
+                {
+                    property: "address",
+                    comparison: entity.ComparisonOperator.Equals,
+                    value: addressSource
+                }
+            ]
+        });
+        let walletAddress;
+        let balance = 0n;
+        if (walletAddresses.entities.length > 0) {
+            walletAddress = walletAddresses.entities[0];
+            balance = BigInt(walletAddress.balance);
+            walletAddress.balance = (BigInt(walletAddress.balance) - amount).toString();
+        }
+        if (balance < amount) {
+            throw new core.GeneralError(this.CLASS_NAME, "insufficientFunds");
+        }
+        if (!core.Is.empty(walletAddress)) {
+            await this._walletAddressEntityStorage.set(walletAddress);
+            let destWalletAddress = await this._walletAddressEntityStorage.get(addressDest);
+            if (core.Is.empty(destWalletAddress)) {
+                destWalletAddress = {
+                    balance: "0",
+                    identity: "",
+                    address: addressDest
+                };
+            }
+            destWalletAddress.balance = (BigInt(destWalletAddress.balance) + amount).toString();
+            await this._walletAddressEntityStorage.set(destWalletAddress);
+        }
+        return undefined;
+    }
+    /**
+     * Build the key name to access the mnemonic in the vault.
+     * @param identity The identity of the user to access the vault keys.
+     * @returns The vault key.
+     * @internal
+     */
+    buildMnemonicKey(identity) {
+        return `${identity}/${this._config.vaultMnemonicId ?? EntityStorageWalletConnector._DEFAULT_MNEMONIC_SECRET_NAME}`;
+    }
+}
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Initialize the schema for the wallet entity storage connector.
+ */
+function initSchema() {
+    entity.EntitySchemaFactory.register("WalletAddress", () => entity.EntitySchemaHelper.getSchema(exports.WalletAddress));
+}
+
+exports.EntityStorageFaucetConnector = EntityStorageFaucetConnector;
+exports.EntityStorageWalletConnector = EntityStorageWalletConnector;
+exports.initSchema = initSchema;