@twin.org/wallet-connector-entity-storage 0.0.1-next.10

package/docs/reference/classes/EntityStorageWalletConnector.md

@@ -0,0 +1,237 @@
+# Class: EntityStorageWalletConnector
+
+Class for performing wallet operations using in-memory storage.
+
+## Implements
+
+- `IWalletConnector`
+
+## Constructors
+
+### new EntityStorageWalletConnector()
+
+> **new EntityStorageWalletConnector**(`options`?): [`EntityStorageWalletConnector`](EntityStorageWalletConnector.md)
+
+Create a new instance of EntityStorageWalletConnector.
+
+#### Parameters
+
+##### options?
+
+[`IEntityStorageWalletConnectorConstructorOptions`](../interfaces/IEntityStorageWalletConnectorConstructorOptions.md)
+
+The options for the wallet connector.
+
+#### Returns
+
+[`EntityStorageWalletConnector`](EntityStorageWalletConnector.md)
+
+## Properties
+
+### NAMESPACE
+
+> `readonly` `static` **NAMESPACE**: `string` = `"entity-storage"`
+
+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/classes/WalletAddress.md

@@ -0,0 +1,37 @@
+# Class: WalletAddress
+
+Class describing a wallet address.
+
+## Constructors
+
+### new WalletAddress()
+
+> **new WalletAddress**(): [`WalletAddress`](WalletAddress.md)
+
+#### Returns
+
+[`WalletAddress`](WalletAddress.md)
+
+## Properties
+
+### address
+
+> **address**: `string`
+
+The address in the wallet.
+
+***
+
+### identity
+
+> **identity**: `string`
+
+The identity of the owner.
+
+***
+
+### balance
+
+> **balance**: `string`
+
+The balance of the wallet as bigint.

package/docs/reference/functions/initSchema.md

@@ -0,0 +1,9 @@
+# Function: initSchema()
+
+> **initSchema**(): `void`
+
+Initialize the schema for the wallet entity storage connector.
+
+## Returns
+
+`void`

package/docs/reference/index.md

@@ -0,0 +1,17 @@
+# @twin.org/wallet-connector-entity-storage
+
+## Classes
+
+- [WalletAddress](classes/WalletAddress.md)
+- [EntityStorageFaucetConnector](classes/EntityStorageFaucetConnector.md)
+- [EntityStorageWalletConnector](classes/EntityStorageWalletConnector.md)
+
+## Interfaces
+
+- [IEntityStorageFaucetConnectorConstructorOptions](interfaces/IEntityStorageFaucetConnectorConstructorOptions.md)
+- [IEntityStorageWalletConnectorConfig](interfaces/IEntityStorageWalletConnectorConfig.md)
+- [IEntityStorageWalletConnectorConstructorOptions](interfaces/IEntityStorageWalletConnectorConstructorOptions.md)
+
+## Functions
+
+- [initSchema](functions/initSchema.md)

package/docs/reference/interfaces/IEntityStorageFaucetConnectorConstructorOptions.md

@@ -0,0 +1,17 @@
+# Interface: IEntityStorageFaucetConnectorConstructorOptions
+
+Options for the entity storage faucet connector.
+
+## Properties
+
+### walletAddressEntityStorageType?
+
+> `optional` **walletAddressEntityStorageType**: `string`
+
+The entity storage type for wallet addresses.
+
+#### Default
+
+```ts
+wallet-address
+```

package/docs/reference/interfaces/IEntityStorageWalletConnectorConfig.md

@@ -0,0 +1,45 @@
+# Interface: IEntityStorageWalletConnectorConfig
+
+Configuration for the Entity Storage Wallet Connector.
+
+## Properties
+
+### vaultMnemonicId?
+
+> `optional` **vaultMnemonicId**: `string`
+
+The id of the entry in the vault containing the mnemonic.
+
+#### Default
+
+```ts
+mnemonic
+```
+
+***
+
+### coinType?
+
+> `optional` **coinType**: `number`
+
+The coin type.
+
+#### Default
+
+```ts
+9999
+```
+
+***
+
+### bech32Hrp?
+
+> `optional` **bech32Hrp**: `string`
+
+The bech32 human readable part for the addresses.
+
+#### Default
+
+```ts
+ent
+```

package/docs/reference/interfaces/IEntityStorageWalletConnectorConstructorOptions.md

@@ -0,0 +1,53 @@
+# Interface: IEntityStorageWalletConnectorConstructorOptions
+
+Options for the entity storage wallet connector.
+
+## Properties
+
+### vaultConnectorType?
+
+> `optional` **vaultConnectorType**: `string`
+
+Vault connector to use for wallet secrets.
+
+#### Default
+
+```ts
+vault
+```
+
+***
+
+### faucetConnectorType?
+
+> `optional` **faucetConnectorType**: `string`
+
+Optional faucet for requesting funds.
+
+#### Default
+
+```ts
+faucet
+```
+
+***
+
+### walletAddressEntityStorageType?
+
+> `optional` **walletAddressEntityStorageType**: `string`
+
+The entity storage for wallets.
+
+#### Default
+
+```ts
+wallet-address
+```
+
+***
+
+### config?
+
+> `optional` **config**: [`IEntityStorageWalletConnectorConfig`](IEntityStorageWalletConnectorConfig.md)
+
+The configuration for the wallet connector.

package/locales/en.json

@@ -0,0 +1,7 @@
+{
+	"error": {
+		"entityStorageWalletConnector": {
+			"insufficientFunds": "There are insufficient funds in the wallet."
+		}
+	}
+}

package/package.json

@@ -0,0 +1,43 @@
+{
+	"name": "@twin.org/wallet-connector-entity-storage",
+	"version": "0.0.1-next.10",
+	"description": "Wallet connector implementation using entity storage",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/wallet.git",
+		"directory": "packages/wallet-connector-entity-storage"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"dependencies": {
+		"@twin.org/core": "next",
+		"@twin.org/crypto": "next",
+		"@twin.org/entity": "next",
+		"@twin.org/entity-storage-models": "next",
+		"@twin.org/nameof": "next",
+		"@twin.org/vault-models": "next",
+		"@twin.org/wallet-models": "0.0.1-next.10"
+	},
+	"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/*.json": "./locales/*.json"
+	},
+	"files": [
+		"dist/cjs",
+		"dist/esm",
+		"dist/types",
+		"locales",
+		"docs"
+	]
+}