@twin.org/dlt-iota 0.0.3-next.9 → 0.9.0

package/docs/reference/classes/Iota.md

@@ -88,43 +88,111 @@ The configuration to populate.
 
 ***
 
-### getAddresses() {#getaddresses}
+### storeMnemonic() {#storemnemonic}
 
-> `static` **getAddresses**(`seed`, `coinType`, `accountIndex`, `startAddressIndex`, `count`, `isInternal?`): `string`[]
+> `static` **storeMnemonic**(`vaultConnector`, `config`, `identity`, `mnemonic`, `accountIndex`): `Promise`\<`string`\>
 
-Get addresses for the identity.
+Store a mnemonic in the vault, derive and store the seed, and pre-cache the first keypair chunk.
 
 #### Parameters
 
-##### seed
+##### vaultConnector
+
+`IVaultConnector`
 
-`Uint8Array`
+The vault connector.
+
+##### config
 
-The seed to use for generating addresses.
+[`IIotaConfig`](../interfaces/IIotaConfig.md)
 
-##### coinType
+The configuration.
 
-`number`
+##### identity
+
+`string`
+
+The identity of the user to access the vault keys.
+
+##### mnemonic
 
-The coin type to use.
+`string` \| `undefined`
+
+The mnemonic to store, if undefined a new one will be generated and returned.
 
 ##### accountIndex
 
 `number`
 
-The account index to get the addresses for.
+The account index to pre-cache.
 
-##### startAddressIndex
+#### Returns
+
+`Promise`\<`string`\>
+
+The mnemonic that was stored.
+
+***
+
+### publicKeyToAddress() {#publickeytoaddress}
+
+> `static` **publicKeyToAddress**(`publicKey`): `string`
+
+Derive an address from a public key.
+
+#### Parameters
+
+##### publicKey
+
+`Uint8Array`
+
+The public key to derive the address from.
+
+#### Returns
+
+`string`
+
+The derived address.
+
+***
+
+### getAddress() {#getaddress}
+
+> `static` **getAddress**(`vaultConnector`, `config`, `identity`, `accountIndex`, `startAddressIndex`, `isInternal?`): `Promise`\<`string`\>
+
+Get address for the identity.
+
+#### Parameters
+
+##### vaultConnector
+
+`IVaultConnector`
+
+The vault connector.
+
+##### config
+
+`Pick`\<[`IIotaConfig`](../interfaces/IIotaConfig.md), `"coinType"` \| `"vaultMnemonicId"` \| `"vaultSeedId"`\>
+
+The configuration.
+
+##### identity
+
+`string`
+
+The identity of the user to access the vault keys.
+
+##### accountIndex
 
 `number`
 
-The start index for the addresses.
+The account index to get the addresses for.
 
-##### count
+##### startAddressIndex
 
 `number`
 
-The number of addresses to generate.
+The start index for the addresses.
 
 ##### isInternal?
 
@@ -134,63 +202,113 @@ Whether the addresses are internal.
 
 #### Returns
 
-`string`[]
+`Promise`\<`string`\>
 
-The list of addresses.
+The address.
 
 ***
 
-### getKeyPair() {#getkeypair}
+### getAddresses() {#getaddresses}
 
-> `static` **getKeyPair**(`seed`, `coinType`, `accountIndex`, `addressIndex`, `isInternal?`): `object`
+> `static` **getAddresses**(`vaultConnector`, `config`, `identity`, `accountIndex`, `startAddressIndex`, `count`, `isInternal?`): `Promise`\<`string`[]\>
 
-Get a key pair for the specified index.
+Get addresses for the identity.
 
 #### Parameters
 
-##### seed
+##### vaultConnector
 
-`Uint8Array`
+`IVaultConnector`
 
-The seed to use for generating the key pair.
+The vault connector.
 
-##### coinType
+##### config
 
-`number`
+`Pick`\<[`IIotaConfig`](../interfaces/IIotaConfig.md), `"coinType"` \| `"vaultMnemonicId"` \| `"vaultSeedId"`\>
 
-The coin type to use.
+The configuration.
+
+##### identity
+
+`string`
+
+The identity of the user to access the vault keys.
 
 ##### accountIndex
 
 `number`
 
-The account index to get the key pair for.
+The account index to get the addresses for.
 
-##### addressIndex
+##### startAddressIndex
+
+`number`
+
+The start index for the addresses.
+
+##### count
 
 `number`
 
-The address index to get the key pair for.
+The number of addresses to generate.
 
 ##### isInternal?
 
 `boolean`
 
-Whether the address is internal.
+Whether the addresses are internal.
 
 #### Returns
 
-`object`
+`Promise`\<`string`[]\>
+
+The list of addresses.
+
+***
 
-The key pair containing private key and public key.
+### getTransactionSigner() {#gettransactionsigner}
 
-##### privateKey
+> `static` **getTransactionSigner**(`vaultConnector`, `config`, `identity`, `accountIndex`, `addressIndex`): `Promise`\<[`VaultTransactionSigner`](VaultTransactionSigner.md)\>
 
-> **privateKey**: `Uint8Array`
+Get a vault-backed transaction signer for the given identity and key indices.
 
-##### publicKey
+#### Parameters
+
+##### vaultConnector
+
+`IVaultConnector`
+
+The vault connector.
+
+##### config
 
-> **publicKey**: `Uint8Array`
+[`IIotaConfig`](../interfaces/IIotaConfig.md)
+
+The configuration.
+
+##### identity
+
+`string`
+
+The identity of the user to access the vault keys.
+
+##### accountIndex
+
+`number`
+
+The account index.
+
+##### addressIndex
+
+`number`
+
+The address index within the account.
+
+#### Returns
+
+`Promise`\<[`VaultTransactionSigner`](VaultTransactionSigner.md)\>
+
+A VaultTransactionSigner for the specified key.
 
 ***
 
@@ -342,96 +460,6 @@ The transaction response.
 
 ***
 
-### getSeed() {#getseed}
-
-> `static` **getSeed**(`config`, `vaultConnector`, `identity`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
-
-Get the seed from the vault.
-
-#### Parameters
-
-##### config
-
-[`IIotaConfig`](../interfaces/IIotaConfig.md)
-
-The configuration to use.
-
-##### vaultConnector
-
-`IVaultConnector`
-
-The vault connector to use.
-
-##### identity
-
-`string`
-
-The identity of the user to access the vault keys.
-
-#### Returns
-
-`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
-
-The seed.
-
-***
-
-### findAddress() {#findaddress}
-
-> `static` **findAddress**(`maxScanRange`, `coinType`, `seed`, `address`): `object`
-
-Find the address in the seed.
-
-#### Parameters
-
-##### maxScanRange
-
-`number`
-
-The maximum range to scan.
-
-##### coinType
-
-`number`
-
-The coin type to use.
-
-##### seed
-
-`Uint8Array`
-
-The seed to use.
-
-##### address
-
-`string`
-
-The address to find.
-
-#### Returns
-
-`object`
-
-The address key pair.
-
-##### address
-
-> **address**: `string`
-
-##### privateKey
-
-> **privateKey**: `Uint8Array`
-
-##### publicKey
-
-> **publicKey**: `Uint8Array`
-
-#### Throws
-
-Error if the address is not found.
-
-***
-
 ### extractPayloadError() {#extractpayloaderror}
 
 > `static` **extractPayloadError**(`error`): `IError`
@@ -455,62 +483,6 @@ The extracted error.
 
 ***
 
-### buildMnemonicKey() {#buildmnemonickey}
-
-> `static` **buildMnemonicKey**(`identity`, `vaultMnemonicId?`): `string`
-
-Get the key for storing the mnemonic.
-
-#### Parameters
-
-##### identity
-
-`string`
-
-The identity to use.
-
-##### vaultMnemonicId?
-
-`string`
-
-The mnemonic ID to use.
-
-#### Returns
-
-`string`
-
-The mnemonic key.
-
-***
-
-### buildSeedKey() {#buildseedkey}
-
-> `static` **buildSeedKey**(`identity`, `vaultSeedId?`): `string`
-
-Get the key for storing the seed.
-
-#### Parameters
-
-##### identity
-
-`string`
-
-The identity to use.
-
-##### vaultSeedId?
-
-`string`
-
-The seed ID to use.
-
-#### Returns
-
-`string`
-
-The seed key.
-
-***
-
 ### packageExistsOnNetwork() {#packageexistsonnetwork}
 
 > `static` **packageExistsOnNetwork**(`client`, `packageId`): `Promise`\<`boolean`\>
@@ -581,7 +553,7 @@ The operation to log.
 
 `Promise`\<[`IIotaDryRun`](../interfaces/IIotaDryRun.md)\>
 
-void.
+The dry run result including status, costs, events, and object changes.
 
 ***
 
@@ -669,6 +641,28 @@ True if the error is an abort error, false otherwise.
 
 ***
 
+### extractAbortCode() {#extractabortcode}
+
+> `static` **extractAbortCode**(`response`): `number` \| `undefined`
+
+Extracts the abort code from a transaction result if the transaction was aborted.
+
+#### Parameters
+
+##### response
+
+`IotaTransactionBlockResponse`
+
+The transaction result to extract the abort code from.
+
+#### Returns
+
+`number` \| `undefined`
+
+The abort code if the transaction was aborted, or undefined if it was not an abort error or the code could not be extracted.
+
+***
+
 ### prepareAndPostGasStationTransaction() {#prepareandpostgasstationtransaction}
 
 > `static` **prepareAndPostGasStationTransaction**(`config`, `vaultConnector`, `identity`, `client`, `owner`, `transaction`, `options?`): `Promise`\<`IotaTransactionBlockResponse`\>
@@ -729,7 +723,7 @@ The transaction response.
 
 ### reserveGas() {#reservegas}
 
-> `static` **reserveGas**(`config`, `gasBudget`): `Promise`\<[`IGasReservationResult`](../interfaces/IGasReservationResult.md)\>
+> `static` **reserveGas**(`config`): `Promise`\<[`IGasReservationResult`](../interfaces/IGasReservationResult.md)\>
 
 Reserve gas from the gas station.
 
@@ -741,12 +735,6 @@ Reserve gas from the gas station.
 
 The configuration containing gas station settings.
 
-##### gasBudget
-
-`number`
-
-The gas budget to reserve.
-
 #### Returns
 
 `Promise`\<[`IGasReservationResult`](../interfaces/IGasReservationResult.md)\>
@@ -844,3 +832,151 @@ Response options including confirmation behavior.
 `Promise`\<`IotaTransactionBlockResponse`\>
 
 The transaction response (confirmed if waitForConfirmation is true).
+
+***
+
+### fundAddress() {#fundaddress}
+
+> `static` **fundAddress**(`config`, `faucetUrl`, `identity`, `address`, `timeoutInSeconds?`): `Promise`\<`bigint`\>
+
+Fund an address with IOTA from the faucet.
+
+#### Parameters
+
+##### config
+
+[`IIotaConfig`](../interfaces/IIotaConfig.md)
+
+The configuration containing endpoint information.
+
+##### faucetUrl
+
+`string`
+
+The URL of the faucet to request funds from.
+
+##### identity
+
+`string`
+
+The identity of the user to access the vault keys.
+
+##### address
+
+`string`
+
+The address to fund.
+
+##### timeoutInSeconds?
+
+`number` = `60`
+
+The timeout in seconds to wait for the funding to complete.
+
+#### Returns
+
+`Promise`\<`bigint`\>
+
+The amount funded.
+
+***
+
+### ensureBalance() {#ensurebalance}
+
+> `static` **ensureBalance**(`config`, `faucetUrl`, `identity`, `address`, `ensureBalance`, `timeoutInSeconds?`): `Promise`\<`boolean`\>
+
+Ensure the balance for the given address is at least the given amount.
+
+#### Parameters
+
+##### config
+
+[`IIotaConfig`](../interfaces/IIotaConfig.md)
+
+The configuration containing endpoint information.
+
+##### faucetUrl
+
+`string` \| `undefined`
+
+The URL of the faucet to request funds from.
+
+##### identity
+
+`string`
+
+The identity of the user to access the vault keys.
+
+##### address
+
+`string`
+
+The address to ensure the balance for.
+
+##### ensureBalance
+
+`bigint`
+
+The minimum balance to ensure.
+
+##### timeoutInSeconds?
+
+`number`
+
+Optional timeout in seconds, defaults to 10 seconds.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the balance is at least the given amount, false otherwise.
+
+***
+
+### getBalance() {#getbalance}
+
+> `static` **getBalance**(`config`, `address`): `Promise`\<`bigint`\>
+
+Get the balance for the given address.
+
+#### Parameters
+
+##### config
+
+[`IIotaConfig`](../interfaces/IIotaConfig.md)
+
+The configuration containing endpoint information.
+
+##### address
+
+`string`
+
+The address to get the balance for.
+
+#### Returns
+
+`Promise`\<`bigint`\>
+
+The balance of the given address.
+
+***
+
+### transactionFromBytes() {#transactionfrombytes}
+
+> `static` **transactionFromBytes**(`bytes`): `Transaction`
+
+Create a transaction instance from the given bytes.
+
+#### Parameters
+
+##### bytes
+
+`Uint8Array`
+
+The transaction bytes to create the transaction from.
+
+#### Returns
+
+`Transaction`
+
+The transaction instance created from the given bytes.

package/docs/reference/classes/IotaIdentityUtils.md

@@ -1,7 +1,6 @@
 # Class: IotaIdentityUtils
 
-Utility class for resolving IOTA Identity on-chain objects required by
-the NFT mint_with_identity() Move contract function.
+Utility class for resolving IOTA Identity on-chain objects and controller tokens.
 
 ## Constructors
 
@@ -27,8 +26,7 @@ Runtime name for the class.
 
 > `static` **getControllerCapInfo**(`identityId`, `controllerAddress`, `client`): `Promise`\<[`IIotaControllerCapInfo`](../interfaces/IIotaControllerCapInfo.md)\>
 
-Resolve the on-chain object IDs for an identity and its controller token.
-Returns the IDs needed to call mint_with_identity() on the NFT Move contract.
+Resolves the on-chain object IDs for an identity and its controller token.
 
 #### Parameters