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

package/docs/reference/classes/IotaSmartContractUtils.md

@@ -1,7 +1,6 @@
 # Class: IotaSmartContractUtils
 
 Utility class providing common smart contract operations for IOTA-based contracts.
-This class uses composition pattern to provide shared functionality without inheritance complexity.
 
 ## Constructors
 
@@ -25,7 +24,7 @@ Runtime name for the class.
 
 ### migrateSmartContract() {#migratesmartcontract}
 
-> `static` **migrateSmartContract**(`config`, `client`, `vaultConnector`, `walletConnector`, `logging`, `gasBudget`, `identity`, `objectId`, `namespace`, `packageId`, `deploymentConfig`, `walletAddressIndex?`): `Promise`\<`void`\>
+> `static` **migrateSmartContract**(`config`, `client`, `vaultConnector`, `logging`, `gasBudget`, `identity`, `objectId`, `namespace`, `packageId`, `deploymentConfig`, `accountAddressIndex?`, `walletAddressIndex?`): `Promise`\<`void`\>
 
 Migrate a smart contract object to the current version using admin privileges.
 This is a generic migration method that works with any IOTA smart contract.
@@ -50,12 +49,6 @@ The IOTA client instance.
 
 The vault connector for key management.
 
-##### walletConnector
-
-`IWalletConnector`
-
-The wallet connector for address generation.
-
 ##### logging
 
 `ILoggingComponent` \| `undefined`
@@ -98,6 +91,12 @@ The deployed package ID for the contract.
 
 The deployment configuration containing object IDs.
 
+##### accountAddressIndex?
+
+`number`
+
+Optional account address index for the controller.
+
 ##### walletAddressIndex?
 
 `number`
@@ -114,7 +113,7 @@ Promise that resolves when migration is complete.
 
 ### enableMigration() {#enablemigration}
 
-> `static` **enableMigration**(`config`, `client`, `vaultConnector`, `walletConnector`, `logging`, `gasBudget`, `identity`, `namespace`, `packageId`, `deploymentConfig`, `walletAddressIndex?`): `Promise`\<`void`\>
+> `static` **enableMigration**(`config`, `client`, `vaultConnector`, `logging`, `gasBudget`, `identity`, `namespace`, `packageId`, `deploymentConfig`, `accountAddressIndex?`, `walletAddressIndex?`): `Promise`\<`void`\>
 
 Enable migration operations using admin privileges.
 
@@ -138,12 +137,6 @@ The IOTA client instance.
 
 The vault connector for key management.
 
-##### walletConnector
-
-`IWalletConnector`
-
-The wallet connector for address generation.
-
 ##### logging
 
 `ILoggingComponent` \| `undefined`
@@ -180,6 +173,12 @@ The deployed package ID for the contract.
 
 The deployment configuration containing object IDs.
 
+##### accountAddressIndex?
+
+`number`
+
+Optional account address index for the controller.
+
 ##### walletAddressIndex?
 
 `number`
@@ -196,7 +195,7 @@ Promise that resolves when migration is enabled.
 
 ### disableMigration() {#disablemigration}
 
-> `static` **disableMigration**(`config`, `client`, `vaultConnector`, `walletConnector`, `logging`, `gasBudget`, `identity`, `namespace`, `packageId`, `deploymentConfig`, `walletAddressIndex?`): `Promise`\<`void`\>
+> `static` **disableMigration**(`config`, `client`, `vaultConnector`, `logging`, `gasBudget`, `identity`, `namespace`, `packageId`, `deploymentConfig`, `accountAddressIndex?`, `walletAddressIndex?`): `Promise`\<`void`\>
 
 Disable migration operations using admin privileges.
 
@@ -220,12 +219,6 @@ The IOTA client instance.
 
 The vault connector for key management.
 
-##### walletConnector
-
-`IWalletConnector`
-
-The wallet connector for address generation.
-
 ##### logging
 
 `ILoggingComponent` \| `undefined`
@@ -262,6 +255,12 @@ The deployed package ID for the contract.
 
 The deployment configuration containing object IDs.
 
+##### accountAddressIndex?
+
+`number`
+
+Optional account address index for the controller.
+
 ##### walletAddressIndex?
 
 `number`
@@ -278,7 +277,7 @@ Promise that resolves when migration is disabled.
 
 ### isMigrationActive() {#ismigrationactive}
 
-> `static` **isMigrationActive**(`config`, `client`, `namespace`, `packageId`, `deploymentConfig`, `identity`, `walletConnector`, `walletAddressIndex?`): `Promise`\<`boolean`\>
+> `static` **isMigrationActive**(`config`, `client`, `vaultConnector`, `namespace`, `packageId`, `deploymentConfig`, `identity`, `accountAddressIndex?`, `walletAddressIndex?`): `Promise`\<`boolean`\>
 
 Check if migration is currently active for a smart contract.
 
@@ -296,6 +295,12 @@ The IOTA configuration.
 
 The IOTA client instance.
 
+##### vaultConnector
+
+`IVaultConnector`
+
+The vault connector for key management.
+
 ##### namespace
 
 `string`
@@ -320,17 +325,17 @@ The deployment configuration containing object IDs.
 
 The identity for MigrationState discovery.
 
-##### walletConnector
+##### accountAddressIndex?
 
-`IWalletConnector`
+`number`
 
-The wallet connector for address generation.
+Optional account address index for the controller.
 
 ##### walletAddressIndex?
 
 `number`
 
-Optional wallet address index.
+Optional wallet address index for the controller.
 
 #### Returns
 
@@ -342,7 +347,7 @@ True if migration is enabled, false otherwise.
 
 ### getCurrentContractVersion() {#getcurrentcontractversion}
 
-> `static` **getCurrentContractVersion**(`config`, `client`, `namespace`, `packageId`, `identity`, `walletConnector`, `walletAddressIndex?`): `Promise`\<`number`\>
+> `static` **getCurrentContractVersion**(`config`, `client`, `vaultConnector`, `namespace`, `packageId`, `identity`, `accountAddressIndex?`, `walletAddressIndex?`): `Promise`\<`number`\>
 
 Get the current contract version from the deployed smart contract.
 
@@ -360,6 +365,12 @@ The IOTA configuration.
 
 The IOTA client instance.
 
+##### vaultConnector
+
+`IVaultConnector`
+
+The vault connector for key management.
+
 ##### namespace
 
 `string`
@@ -378,17 +389,17 @@ The deployed package ID for the contract.
 
 The identity for package controller address.
 
-##### walletConnector
+##### accountAddressIndex?
 
-`IWalletConnector`
+`number`
 
-The wallet connector for address generation.
+Optional account address index for the controller.
 
 ##### walletAddressIndex?
 
 `number`
 
-Optional wallet address index.
+Optional wallet address index for the controller.
 
 #### Returns
 
@@ -400,7 +411,7 @@ The current version number of the contract.
 
 ### validateObjectVersion() {#validateobjectversion}
 
-> `static` **validateObjectVersion**\<`T`\>(`config`, `client`, `namespace`, `packageId`, `identity`, `objectId`, `walletConnector`, `versionExtractor`, `walletAddressIndex?`): `Promise`\<`boolean`\>
+> `static` **validateObjectVersion**\<`T`\>(`config`, `client`, `vaultConnector`, `namespace`, `packageId`, `identity`, `objectId`, `versionExtractor`, `accountAddressIndex?`, `walletAddressIndex?`): `Promise`\<`boolean`\>
 
 Validate that an object version is compatible with the current contract.
 
@@ -424,6 +435,12 @@ The IOTA configuration.
 
 The IOTA client instance.
 
+##### vaultConnector
+
+`IVaultConnector`
+
+The vault connector for key management.
+
 ##### namespace
 
 `string`
@@ -448,23 +465,23 @@ The identity for version checking.
 
 The object ID to validate.
 
-##### walletConnector
-
-`IWalletConnector`
-
-The wallet connector for address generation.
-
 ##### versionExtractor
 
 (`content`) => `number`
 
 Function to extract version from object content.
 
+##### accountAddressIndex?
+
+`number`
+
+Optional account address index for the controller.
+
 ##### walletAddressIndex?
 
 `number`
 
-Optional wallet address index.
+Optional wallet address index for the controller.
 
 #### Returns
 

package/docs/reference/classes/VaultJwtSigner.md

@@ -0,0 +1,71 @@
+# Class: VaultJwtSigner
+
+Factory that creates a vault-backed StorageSigner for IOTA Identity operations.
+The private key never leaves the vault — only the raw signing operation is delegated.
+
+The returned StorageSigner is a genuine WASM object, satisfying the internal validation
+that IdentityClient.create() performs on the signer's iotaPublicKeyBytes() path.
+
+## Constructors
+
+### Constructor
+
+> **new VaultJwtSigner**(): `VaultJwtSigner`
+
+#### Returns
+
+`VaultJwtSigner`
+
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### create() {#create}
+
+> `static` **create**(`vaultConnector`, `config`, `identity`, `accountIndex`, `addressIndex`): `Promise`\<`StorageSigner`\>
+
+Create a StorageSigner whose cryptographic operations are backed by the vault connector.
+
+#### Parameters
+
+##### vaultConnector
+
+`IVaultConnector`
+
+The vault connector.
+
+##### config
+
+[`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`\<`StorageSigner`\>
+
+A StorageSigner backed by the vault for the specified key.

package/docs/reference/classes/VaultSigner.md

@@ -0,0 +1,106 @@
+# Class: VaultSigner
+
+A signer that delegates all signing to the vault connector, ensuring the private key
+is never exposed to application code.
+
+## Extends
+
+- `Signer`
+
+## Constructors
+
+### Constructor
+
+> **new VaultSigner**(`vaultConnector`, `keyName`, `publicKey`): `VaultSigner`
+
+Create a new VaultSigner.
+
+#### Parameters
+
+##### vaultConnector
+
+`IVaultConnector`
+
+The vault connector used to perform signing operations.
+
+##### keyName
+
+`string`
+
+The name of the key in the vault to use for signing.
+
+##### publicKey
+
+`Uint8Array`
+
+The public key bytes corresponding to the vault key.
+
+#### Returns
+
+`VaultSigner`
+
+#### Overrides
+
+`Signer.constructor`
+
+## Methods
+
+### getKeyScheme() {#getkeyscheme}
+
+> **getKeyScheme**(): `SignatureScheme`
+
+Get the key scheme.
+
+#### Returns
+
+`SignatureScheme`
+
+The signature scheme.
+
+#### Overrides
+
+`Signer.getKeyScheme`
+
+***
+
+### getPublicKey() {#getpublickey}
+
+> **getPublicKey**(): `Ed25519PublicKey`
+
+Get the public key.
+
+#### Returns
+
+`Ed25519PublicKey`
+
+The Ed25519 public key.
+
+#### Overrides
+
+`Signer.getPublicKey`
+
+***
+
+### sign() {#sign}
+
+> **sign**(`bytes`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
+
+Sign the provided bytes via the vault connector.
+
+#### Parameters
+
+##### bytes
+
+`Uint8Array`
+
+The bytes to sign.
+
+#### Returns
+
+`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
+
+The raw Ed25519 signature bytes.
+
+#### Overrides
+
+`Signer.sign`

package/docs/reference/classes/VaultTransactionSigner.md

@@ -0,0 +1,122 @@
+# Class: VaultTransactionSigner
+
+A transaction signer that delegates all signing operations to the vault connector,
+ensuring the private key is never exposed to application code.
+
+## Implements
+
+- [`ITransactionSigner`](../interfaces/ITransactionSigner.md)
+
+## Constructors
+
+### Constructor
+
+> **new VaultTransactionSigner**(`vaultConnector`, `keyName`, `publicKey`): `VaultTransactionSigner`
+
+Create a new VaultTransactionSigner.
+
+#### Parameters
+
+##### vaultConnector
+
+`IVaultConnector`
+
+The vault connector used to perform signing operations.
+
+##### keyName
+
+`string`
+
+The name of the key in the vault to use for signing.
+
+##### publicKey
+
+`Uint8Array`
+
+The public key bytes corresponding to the vault key.
+
+#### Returns
+
+`VaultTransactionSigner`
+
+## Methods
+
+### sign() {#sign}
+
+> **sign**(`txDataBcs`): `Promise`\<`string`\>
+
+Sign the BCS-encoded transaction data.
+Applies the TransactionData intent, hashes the result, signs via the vault,
+and returns a serialized IOTA signature string.
+
+#### Parameters
+
+##### txDataBcs
+
+`Uint8Array`
+
+The raw transaction bytes to sign.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The serialized signature string.
+
+#### Implementation of
+
+[`ITransactionSigner`](../interfaces/ITransactionSigner.md).[`sign`](../interfaces/ITransactionSigner.md#sign)
+
+***
+
+### publicKey() {#publickey}
+
+> **publicKey**(): `Promise`\<`PublicKey`\>
+
+Get the public key for this signer.
+
+#### Returns
+
+`Promise`\<`PublicKey`\>
+
+The Ed25519 public key.
+
+#### Implementation of
+
+[`ITransactionSigner`](../interfaces/ITransactionSigner.md).[`publicKey`](../interfaces/ITransactionSigner.md#publickey)
+
+***
+
+### iotaPublicKeyBytes() {#iotapublickeybytes}
+
+> **iotaPublicKeyBytes**(): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
+
+Get the IOTA-formatted public key bytes (scheme flag byte followed by the raw key bytes).
+
+#### Returns
+
+`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
+
+The IOTA public key bytes.
+
+#### Implementation of
+
+[`ITransactionSigner`](../interfaces/ITransactionSigner.md).[`iotaPublicKeyBytes`](../interfaces/ITransactionSigner.md#iotapublickeybytes)
+
+***
+
+### keyId() {#keyid}
+
+> **keyId**(): `string`
+
+Get the vault key name used by this signer.
+
+#### Returns
+
+`string`
+
+The key name.
+
+#### Implementation of
+
+[`ITransactionSigner`](../interfaces/ITransactionSigner.md).[`keyId`](../interfaces/ITransactionSigner.md#keyid)

package/docs/reference/index.md

@@ -5,6 +5,9 @@
 - [Iota](classes/Iota.md)
 - [IotaIdentityUtils](classes/IotaIdentityUtils.md)
 - [IotaSmartContractUtils](classes/IotaSmartContractUtils.md)
+- [VaultJwtSigner](classes/VaultJwtSigner.md)
+- [VaultSigner](classes/VaultSigner.md)
+- [VaultTransactionSigner](classes/VaultTransactionSigner.md)
 
 ## Interfaces
 
@@ -21,6 +24,7 @@
 - [IIotaResponseOptions](interfaces/IIotaResponseOptions.md)
 - [IMigrationStateFields](interfaces/IMigrationStateFields.md)
 - [ISmartContractObject](interfaces/ISmartContractObject.md)
+- [ITransactionSigner](interfaces/ITransactionSigner.md)
 
 ## Type Aliases
 

package/docs/reference/interfaces/IAdminCapFields.md

@@ -8,10 +8,10 @@ Generic interface representing the storage fields of an AdminCap object.
 
 > **id**: `object`
 
-The ID of the AdminCap object.
+The UID wrapper of the AdminCap object.
 
 #### id
 
 > **id**: `string`
 
-The ID of the AdminCap object.
+The hex string ID of the AdminCap object.

package/docs/reference/interfaces/IGasStationExecuteResponse.md

@@ -9,14 +9,12 @@ Interface for the gas station execute transaction response.
 > **effects**: `object`
 
 The transaction effects from the IOTA network.
-This contains the full IOTA transaction effects object.
 
 #### Index Signature
 
 \[`key`: `string`\]: `unknown`
 
-Additional effects data from the IOTA network.
-This includes messageVersion, status, executedEpoch, gasUsed, etc.
+Additional fields from the IOTA network effects object.
 
 #### transactionDigest
 

package/docs/reference/interfaces/IIotaConfig.md

@@ -113,6 +113,20 @@ The default gas budget for all transactions (including sponsored and direct).
 
 ***
 
+### gasReservationDuration? {#gasreservationduration}
+
+> `optional` **gasReservationDuration?**: `number`
+
+The default gas reservation duration in seconds for all transactions (including sponsored and direct).
+
+#### Default
+
+```ts
+60
+```
+
+***
+
 ### enableCostLogging? {#enablecostlogging}
 
 > `optional` **enableCostLogging?**: `boolean`

package/docs/reference/interfaces/IIotaControllerCapInfo.md

@@ -1,6 +1,6 @@
 # Interface: IIotaControllerCapInfo
 
-On-chain object IDs needed to call mint_with_identity() on the NFT Move contract.
+On-chain object IDs for an identity and its associated controller token.
 
 ## Properties
 
@@ -8,8 +8,7 @@ On-chain object IDs needed to call mint_with_identity() on the NFT Move contract
 
 > **identityObjectId**: `string`
 
-The on-chain Object ID of the Identity Move object (hex string, e.g. "0x...").
-Used as the Identity argument in mint_with_identity().
+The on-chain object ID of the Identity Move object (hex string, e.g. "0x...").
 
 ***
 
@@ -17,6 +16,4 @@ Used as the Identity argument in mint_with_identity().
 
 > **controllerCapObjectId**: `string`
 
-The on-chain Object ID of the ControllerToken Move object (hex string, e.g. "0x...").
-Proves that the controller address controls identityObjectId.
-Used as the ControllerCap argument in mint_with_identity().
+The on-chain object ID of the ControllerToken Move object (hex string, e.g. "0x...").

package/docs/reference/interfaces/IIotaResponseOptions.md

@@ -1,6 +1,6 @@
 # Interface: IIotaResponseOptions
 
-Configuration for IOTA.
+Options for controlling transaction execution and response behaviour.
 
 ## Extends
 

package/docs/reference/interfaces/IMigrationStateFields.md

@@ -8,13 +8,13 @@ Generic interface representing the storage fields of a MigrationState object.
 
 > **id**: `object`
 
-The ID of the MigrationState object.
+The UID wrapper of the MigrationState object.
 
 #### id
 
 > **id**: `string`
 
-The ID of the MigrationState object.
+The hex string ID of the MigrationState object.
 
 ***
 

package/docs/reference/interfaces/ISmartContractObject.md

@@ -8,13 +8,13 @@ Base interface for all smart contract objects with versioning support.
 
 > **id**: `object`
 
-The ID of the smart contract object.
+The UID wrapper of the smart contract object.
 
 #### id
 
 > **id**: `string`
 
-The ID of the smart contract object.
+The hex string ID of the smart contract object.
 
 ***