@twin.org/dlt-iota 0.0.2-next.1 → 0.0.2-next.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/dist/cjs/index.cjs +7 -7
  2. package/dist/esm/index.mjs +7 -7
  3. package/dist/types/iota.d.ts +7 -7
  4. package/docs/changelog.md +14 -0
  5. package/docs/reference/classes/Iota.md +10 -10
  6. package/package.json +3 -3
package/dist/cjs/index.cjs CHANGED
@@ -105,7 +105,7 @@ class Iota {
105
105
  * Prepare and post a transaction.
106
106
  * @param config The configuration.
107
107
  * @param vaultConnector The vault connector.
108
- * @param loggingConnector The logging connector.
108
+ * @param logging The logging component.
109
109
  * @param identity The identity of the user to access the vault keys.
110
110
  * @param client The client instance.
111
111
  * @param source The source address.
@@ -114,7 +114,7 @@ class Iota {
114
114
  * @param options The transaction options.
115
115
  * @returns The transaction result.
116
116
  */
117
- static async prepareAndPostValueTransaction(config, vaultConnector, loggingConnector, identity, client, source, amount, recipient, options) {
117
+ static async prepareAndPostValueTransaction(config, vaultConnector, logging, identity, client, source, amount, recipient, options) {
118
118
  try {
119
119
  const txb = new transactions.Transaction();
120
120
  const [coin] = txb.splitCoins(txb.gas, [txb.pure.u64(amount)]);
@@ -123,7 +123,7 @@ class Iota {
123
123
  if (core.Is.object(config.gasStation)) {
124
124
  return await this.prepareAndPostGasStationTransaction(config, vaultConnector, identity, client, source, txb);
125
125
  }
126
- const result = await this.prepareAndPostTransaction(config, vaultConnector, loggingConnector, identity, client, source, txb, options);
126
+ const result = await this.prepareAndPostTransaction(config, vaultConnector, logging, identity, client, source, txb, options);
127
127
  return result;
128
128
  }
129
129
  catch (error) {
@@ -134,7 +134,7 @@ class Iota {
134
134
  * Prepare and post a transaction.
135
135
  * @param config The configuration.
136
136
  * @param vaultConnector The vault connector.
137
- * @param loggingConnector The logging connector.
137
+ * @param logging The logging component.
138
138
  * @param identity The identity of the user to access the vault keys.
139
139
  * @param client The client instance.
140
140
  * @param owner The owner of the address.
@@ -142,7 +142,7 @@ class Iota {
142
142
  * @param options The transaction options.
143
143
  * @returns The transaction response.
144
144
  */
145
- static async prepareAndPostTransaction(config, vaultConnector, loggingConnector, identity, client, owner, transaction, options) {
145
+ static async prepareAndPostTransaction(config, vaultConnector, logging, identity, client, owner, transaction, options) {
146
146
  // Check if gas station configuration is present
147
147
  if (core.Is.object(config.gasStation)) {
148
148
  return this.prepareAndPostGasStationTransaction(config, vaultConnector, identity, client, owner, transaction, options);
@@ -150,7 +150,7 @@ class Iota {
150
150
  // Traditional transaction flow
151
151
  // Dry run the transaction if cost logging is enabled to get the gas and storage costs
152
152
  if (core.Is.stringValue(options?.dryRunLabel)) {
153
- await Iota.dryRunTransaction(client, loggingConnector, transaction, owner, options.dryRunLabel);
153
+ await Iota.dryRunTransaction(client, logging, transaction, owner, options.dryRunLabel);
154
154
  }
155
155
  const seed = await this.getSeed(config, vaultConnector, identity);
156
156
  const addressKeyPair = Iota.findAddress(config.maxAddressScanRange ?? Iota.DEFAULT_SCAN_RANGE, config.coinType ?? Iota.DEFAULT_COIN_TYPE, seed, owner);
@@ -296,7 +296,7 @@ class Iota {
296
296
  /**
297
297
  * Dry run a transaction and log the results.
298
298
  * @param client The IOTA client.
299
- * @param logging The logging connector.
299
+ * @param logging The logging component.
300
300
  * @param txb The transaction to dry run.
301
301
  * @param sender The sender address.
302
302
  * @param operation The operation to log.
package/dist/esm/index.mjs CHANGED
@@ -103,7 +103,7 @@ class Iota {
103
103
  * Prepare and post a transaction.
104
104
  * @param config The configuration.
105
105
  * @param vaultConnector The vault connector.
106
- * @param loggingConnector The logging connector.
106
+ * @param logging The logging component.
107
107
  * @param identity The identity of the user to access the vault keys.
108
108
  * @param client The client instance.
109
109
  * @param source The source address.
@@ -112,7 +112,7 @@ class Iota {
112
112
  * @param options The transaction options.
113
113
  * @returns The transaction result.
114
114
  */
115
- static async prepareAndPostValueTransaction(config, vaultConnector, loggingConnector, identity, client, source, amount, recipient, options) {
115
+ static async prepareAndPostValueTransaction(config, vaultConnector, logging, identity, client, source, amount, recipient, options) {
116
116
  try {
117
117
  const txb = new Transaction();
118
118
  const [coin] = txb.splitCoins(txb.gas, [txb.pure.u64(amount)]);
@@ -121,7 +121,7 @@ class Iota {
121
121
  if (Is.object(config.gasStation)) {
122
122
  return await this.prepareAndPostGasStationTransaction(config, vaultConnector, identity, client, source, txb);
123
123
  }
124
- const result = await this.prepareAndPostTransaction(config, vaultConnector, loggingConnector, identity, client, source, txb, options);
124
+ const result = await this.prepareAndPostTransaction(config, vaultConnector, logging, identity, client, source, txb, options);
125
125
  return result;
126
126
  }
127
127
  catch (error) {
@@ -132,7 +132,7 @@ class Iota {
132
132
  * Prepare and post a transaction.
133
133
  * @param config The configuration.
134
134
  * @param vaultConnector The vault connector.
135
- * @param loggingConnector The logging connector.
135
+ * @param logging The logging component.
136
136
  * @param identity The identity of the user to access the vault keys.
137
137
  * @param client The client instance.
138
138
  * @param owner The owner of the address.
@@ -140,7 +140,7 @@ class Iota {
140
140
  * @param options The transaction options.
141
141
  * @returns The transaction response.
142
142
  */
143
- static async prepareAndPostTransaction(config, vaultConnector, loggingConnector, identity, client, owner, transaction, options) {
143
+ static async prepareAndPostTransaction(config, vaultConnector, logging, identity, client, owner, transaction, options) {
144
144
  // Check if gas station configuration is present
145
145
  if (Is.object(config.gasStation)) {
146
146
  return this.prepareAndPostGasStationTransaction(config, vaultConnector, identity, client, owner, transaction, options);
@@ -148,7 +148,7 @@ class Iota {
148
148
  // Traditional transaction flow
149
149
  // Dry run the transaction if cost logging is enabled to get the gas and storage costs
150
150
  if (Is.stringValue(options?.dryRunLabel)) {
151
- await Iota.dryRunTransaction(client, loggingConnector, transaction, owner, options.dryRunLabel);
151
+ await Iota.dryRunTransaction(client, logging, transaction, owner, options.dryRunLabel);
152
152
  }
153
153
  const seed = await this.getSeed(config, vaultConnector, identity);
154
154
  const addressKeyPair = Iota.findAddress(config.maxAddressScanRange ?? Iota.DEFAULT_SCAN_RANGE, config.coinType ?? Iota.DEFAULT_COIN_TYPE, seed, owner);
@@ -294,7 +294,7 @@ class Iota {
294
294
  /**
295
295
  * Dry run a transaction and log the results.
296
296
  * @param client The IOTA client.
297
- * @param logging The logging connector.
297
+ * @param logging The logging component.
298
298
  * @param txb The transaction to dry run.
299
299
  * @param sender The sender address.
300
300
  * @param operation The operation to log.
package/dist/types/iota.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  import { IotaClient, type IotaTransactionBlockResponse } from "@iota/iota-sdk/client";
2
2
  import { Transaction } from "@iota/iota-sdk/transactions";
3
3
  import { type IError } from "@twin.org/core";
4
- import type { ILoggingConnector } from "@twin.org/logging-models";
4
+ import type { ILoggingComponent } from "@twin.org/logging-models";
5
5
  import type { IVaultConnector } from "@twin.org/vault-models";
6
6
  import type { IGasReservationResult } from "./models/IGasReservationResult";
7
7
  import type { IIotaConfig } from "./models/IIotaConfig";
@@ -70,7 +70,7 @@ export declare class Iota {
70
70
  * Prepare and post a transaction.
71
71
  * @param config The configuration.
72
72
  * @param vaultConnector The vault connector.
73
- * @param loggingConnector The logging connector.
73
+ * @param logging The logging component.
74
74
  * @param identity The identity of the user to access the vault keys.
75
75
  * @param client The client instance.
76
76
  * @param source The source address.
@@ -79,12 +79,12 @@ export declare class Iota {
79
79
  * @param options The transaction options.
80
80
  * @returns The transaction result.
81
81
  */
82
- static prepareAndPostValueTransaction(config: IIotaConfig, vaultConnector: IVaultConnector, loggingConnector: ILoggingConnector | undefined, identity: string, client: IotaClient, source: string, amount: bigint, recipient: string, options?: IIotaResponseOptions): Promise<IotaTransactionBlockResponse>;
82
+ static prepareAndPostValueTransaction(config: IIotaConfig, vaultConnector: IVaultConnector, logging: ILoggingComponent | undefined, identity: string, client: IotaClient, source: string, amount: bigint, recipient: string, options?: IIotaResponseOptions): Promise<IotaTransactionBlockResponse>;
83
83
  /**
84
84
  * Prepare and post a transaction.
85
85
  * @param config The configuration.
86
86
  * @param vaultConnector The vault connector.
87
- * @param loggingConnector The logging connector.
87
+ * @param logging The logging component.
88
88
  * @param identity The identity of the user to access the vault keys.
89
89
  * @param client The client instance.
90
90
  * @param owner The owner of the address.
@@ -92,7 +92,7 @@ export declare class Iota {
92
92
  * @param options The transaction options.
93
93
  * @returns The transaction response.
94
94
  */
95
- static prepareAndPostTransaction(config: IIotaConfig, vaultConnector: IVaultConnector, loggingConnector: ILoggingConnector | undefined, identity: string, client: IotaClient, owner: string, transaction: Transaction, options?: IIotaResponseOptions): Promise<IotaTransactionBlockResponse>;
95
+ static prepareAndPostTransaction(config: IIotaConfig, vaultConnector: IVaultConnector, logging: ILoggingComponent | undefined, identity: string, client: IotaClient, owner: string, transaction: Transaction, options?: IIotaResponseOptions): Promise<IotaTransactionBlockResponse>;
96
96
  /**
97
97
  * Get the seed from the vault.
98
98
  * @param config The configuration to use.
@@ -146,13 +146,13 @@ export declare class Iota {
146
146
  /**
147
147
  * Dry run a transaction and log the results.
148
148
  * @param client The IOTA client.
149
- * @param logging The logging connector.
149
+ * @param logging The logging component.
150
150
  * @param txb The transaction to dry run.
151
151
  * @param sender The sender address.
152
152
  * @param operation The operation to log.
153
153
  * @returns void.
154
154
  */
155
- static dryRunTransaction(client: IotaClient, logging: ILoggingConnector | undefined, txb: Transaction, sender: string, operation: string): Promise<IIotaDryRun>;
155
+ static dryRunTransaction(client: IotaClient, logging: ILoggingComponent | undefined, txb: Transaction, sender: string, operation: string): Promise<IIotaDryRun>;
156
156
  /**
157
157
  * Wait for a transaction to be indexed and available over the API.
158
158
  * @param client The IOTA client instance.
package/docs/changelog.md CHANGED
@@ -1,5 +1,19 @@
1
1
  # @twin.org/dlt-iota - Changelog
2
2
 
3
+ ## [0.0.2-next.3](https://github.com/twinfoundation/dlt/compare/dlt-iota-v0.0.2-next.2...dlt-iota-v0.0.2-next.3) (2025-08-20)
4
+
5
+
6
+ ### Features
7
+
8
+ * update framework core ([79fc4b9](https://github.com/twinfoundation/dlt/commit/79fc4b961bd755437cad98d733ca9e25476bc03f))
9
+
10
+ ## [0.0.2-next.2](https://github.com/twinfoundation/dlt/compare/dlt-iota-v0.0.2-next.1...dlt-iota-v0.0.2-next.2) (2025-07-25)
11
+
12
+
13
+ ### Miscellaneous Chores
14
+
15
+ * **dlt-iota:** Synchronize repo versions
16
+
3
17
  ## [0.0.2-next.1](https://github.com/twinfoundation/dlt/compare/dlt-iota-v0.0.2-next.0...dlt-iota-v0.0.2-next.1) (2025-07-16)
4
18
 
5
19
 
package/docs/reference/classes/Iota.md CHANGED
@@ -204,7 +204,7 @@ The key pair containing private key and public key.
204
204
 
205
205
  ### prepareAndPostValueTransaction()
206
206
 
207
- > `static` **prepareAndPostValueTransaction**(`config`, `vaultConnector`, `loggingConnector`, `identity`, `client`, `source`, `amount`, `recipient`, `options?`): `Promise`\<`IotaTransactionBlockResponse`\>
207
+ > `static` **prepareAndPostValueTransaction**(`config`, `vaultConnector`, `logging`, `identity`, `client`, `source`, `amount`, `recipient`, `options?`): `Promise`\<`IotaTransactionBlockResponse`\>
208
208
 
209
209
  Prepare and post a transaction.
210
210
 
@@ -222,11 +222,11 @@ The configuration.
222
222
 
223
223
  The vault connector.
224
224
 
225
- ##### loggingConnector
225
+ ##### logging
226
226
 
227
- The logging connector.
227
+ The logging component.
228
228
 
229
- `undefined` | `ILoggingConnector`
229
+ `undefined` | `ILoggingComponent`
230
230
 
231
231
  ##### identity
232
232
 
@@ -274,7 +274,7 @@ The transaction result.
274
274
 
275
275
  ### prepareAndPostTransaction()
276
276
 
277
- > `static` **prepareAndPostTransaction**(`config`, `vaultConnector`, `loggingConnector`, `identity`, `client`, `owner`, `transaction`, `options?`): `Promise`\<`IotaTransactionBlockResponse`\>
277
+ > `static` **prepareAndPostTransaction**(`config`, `vaultConnector`, `logging`, `identity`, `client`, `owner`, `transaction`, `options?`): `Promise`\<`IotaTransactionBlockResponse`\>
278
278
 
279
279
  Prepare and post a transaction.
280
280
 
@@ -292,11 +292,11 @@ The configuration.
292
292
 
293
293
  The vault connector.
294
294
 
295
- ##### loggingConnector
295
+ ##### logging
296
296
 
297
- The logging connector.
297
+ The logging component.
298
298
 
299
- `undefined` | `ILoggingConnector`
299
+ `undefined` | `ILoggingComponent`
300
300
 
301
301
  ##### identity
302
302
 
@@ -549,9 +549,9 @@ The IOTA client.
549
549
 
550
550
  ##### logging
551
551
 
552
- The logging connector.
552
+ The logging component.
553
553
 
554
- `undefined` | `ILoggingConnector`
554
+ `undefined` | `ILoggingComponent`
555
555
 
556
556
  ##### txb
557
557
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/dlt-iota",
3
- "version": "0.0.2-next.1",
3
+ "version": "0.0.2-next.3",
4
4
  "description": "DLT helpers for use with IOTA",
5
5
  "repository": {
6
6
  "type": "git",
@@ -14,8 +14,8 @@
14
14
  "node": ">=20.0.0"
15
15
  },
16
16
  "dependencies": {
17
- "@iota/bcs": "1.1.0",
18
- "@iota/iota-sdk": "1.4.0",
17
+ "@iota/bcs": "1.2.0",
18
+ "@iota/iota-sdk": "1.5.0",
19
19
  "@twin.org/core": "next",
20
20
  "@twin.org/crypto": "next",
21
21
  "@twin.org/logging-models": "next",