@twin.org/dlt-iota 0.0.3-next.13 → 0.0.3-next.15

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 (56) hide show
  1. package/dist/es/index.js +7 -3
  2. package/dist/es/index.js.map +1 -1
  3. package/dist/es/iota.js +104 -89
  4. package/dist/es/iota.js.map +1 -1
  5. package/dist/es/iotaIdentityUtils.js +2 -4
  6. package/dist/es/iotaIdentityUtils.js.map +1 -1
  7. package/dist/es/iotaSmartContractUtils.js +2 -1
  8. package/dist/es/iotaSmartContractUtils.js.map +1 -1
  9. package/dist/es/models/IAdminCapFields.js.map +1 -1
  10. package/dist/es/models/IGasStationExecuteResponse.js.map +1 -1
  11. package/dist/es/models/IIotaControllerCapInfo.js.map +1 -1
  12. package/dist/es/models/IIotaResponseOptions.js.map +1 -1
  13. package/dist/es/models/IMigrationStateFields.js.map +1 -1
  14. package/dist/es/models/ISmartContractObject.js.map +1 -1
  15. package/dist/es/models/ITransactionSigner.js +2 -0
  16. package/dist/es/models/ITransactionSigner.js.map +1 -0
  17. package/dist/es/vaultJwkStorage.js +71 -0
  18. package/dist/es/vaultJwkStorage.js.map +1 -0
  19. package/dist/es/vaultJwtSigner.js +49 -0
  20. package/dist/es/vaultJwtSigner.js.map +1 -0
  21. package/dist/es/vaultSigner.js +60 -0
  22. package/dist/es/vaultSigner.js.map +1 -0
  23. package/dist/es/vaultTransactionSigner.js +74 -0
  24. package/dist/es/vaultTransactionSigner.js.map +1 -0
  25. package/dist/types/index.d.ts +7 -3
  26. package/dist/types/iota.d.ts +13 -28
  27. package/dist/types/iotaIdentityUtils.d.ts +2 -4
  28. package/dist/types/iotaSmartContractUtils.d.ts +0 -1
  29. package/dist/types/models/IAdminCapFields.d.ts +2 -2
  30. package/dist/types/models/IGasStationExecuteResponse.d.ts +1 -3
  31. package/dist/types/models/IIotaControllerCapInfo.d.ts +3 -6
  32. package/dist/types/models/IIotaResponseOptions.d.ts +1 -1
  33. package/dist/types/models/IMigrationStateFields.d.ts +2 -2
  34. package/dist/types/models/ISmartContractObject.d.ts +2 -2
  35. package/dist/types/models/ITransactionSigner.d.ts +27 -0
  36. package/dist/types/vaultJwkStorage.d.ts +50 -0
  37. package/dist/types/vaultJwtSigner.d.ts +26 -0
  38. package/dist/types/vaultSigner.d.ts +32 -0
  39. package/dist/types/vaultTransactionSigner.d.ts +39 -0
  40. package/docs/changelog.md +15 -0
  41. package/docs/reference/classes/Iota.md +30 -82
  42. package/docs/reference/classes/IotaIdentityUtils.md +2 -4
  43. package/docs/reference/classes/IotaSmartContractUtils.md +0 -1
  44. package/docs/reference/classes/VaultJwtSigner.md +71 -0
  45. package/docs/reference/classes/VaultSigner.md +106 -0
  46. package/docs/reference/classes/VaultTransactionSigner.md +122 -0
  47. package/docs/reference/index.md +4 -0
  48. package/docs/reference/interfaces/IAdminCapFields.md +2 -2
  49. package/docs/reference/interfaces/IGasStationExecuteResponse.md +1 -3
  50. package/docs/reference/interfaces/IIotaControllerCapInfo.md +3 -6
  51. package/docs/reference/interfaces/IIotaResponseOptions.md +1 -1
  52. package/docs/reference/interfaces/IMigrationStateFields.md +2 -2
  53. package/docs/reference/interfaces/ISmartContractObject.md +2 -2
  54. package/docs/reference/interfaces/ITransactionSigner.md +67 -0
  55. package/locales/en.json +5 -1
  56. package/package.json +3 -3
package/docs/reference/interfaces/IMigrationStateFields.md CHANGED
@@ -8,13 +8,13 @@ Generic interface representing the storage fields of a MigrationState object.
8
8
 
9
9
  > **id**: `object`
10
10
 
11
- The ID of the MigrationState object.
11
+ The UID wrapper of the MigrationState object.
12
12
 
13
13
  #### id
14
14
 
15
15
  > **id**: `string`
16
16
 
17
- The ID of the MigrationState object.
17
+ The hex string ID of the MigrationState object.
18
18
 
19
19
  ***
20
20
 
package/docs/reference/interfaces/ISmartContractObject.md CHANGED
@@ -8,13 +8,13 @@ Base interface for all smart contract objects with versioning support.
8
8
 
9
9
  > **id**: `object`
10
10
 
11
- The ID of the smart contract object.
11
+ The UID wrapper of the smart contract object.
12
12
 
13
13
  #### id
14
14
 
15
15
  > **id**: `string`
16
16
 
17
- The ID of the smart contract object.
17
+ The hex string ID of the smart contract object.
18
18
 
19
19
  ***
20
20
 
package/docs/reference/interfaces/ITransactionSigner.md ADDED
@@ -0,0 +1,67 @@
1
+ # Interface: ITransactionSigner
2
+
3
+ Interface for a transaction signer backed by a secure key store.
4
+
5
+ ## Methods
6
+
7
+ ### sign() {#sign}
8
+
9
+ > **sign**(`txDataBcs`): `Promise`\<`string`\>
10
+
11
+ Sign the BCS-encoded transaction data and return a serialized IOTA signature string.
12
+
13
+ #### Parameters
14
+
15
+ ##### txDataBcs
16
+
17
+ `Uint8Array`
18
+
19
+ The raw transaction bytes to sign.
20
+
21
+ #### Returns
22
+
23
+ `Promise`\<`string`\>
24
+
25
+ The serialized signature string (scheme flag + signature + public key, base64-encoded).
26
+
27
+ ***
28
+
29
+ ### publicKey() {#publickey}
30
+
31
+ > **publicKey**(): `Promise`\<`PublicKey`\>
32
+
33
+ Get the public key for this signer.
34
+
35
+ #### Returns
36
+
37
+ `Promise`\<`PublicKey`\>
38
+
39
+ The public key.
40
+
41
+ ***
42
+
43
+ ### iotaPublicKeyBytes() {#iotapublickeybytes}
44
+
45
+ > **iotaPublicKeyBytes**(): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
46
+
47
+ Get the IOTA-formatted public key bytes (scheme flag byte followed by the raw key bytes).
48
+
49
+ #### Returns
50
+
51
+ `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
52
+
53
+ The IOTA public key bytes.
54
+
55
+ ***
56
+
57
+ ### keyId() {#keyid}
58
+
59
+ > **keyId**(): `string`
60
+
61
+ Get the key identifier for this signer.
62
+
63
+ #### Returns
64
+
65
+ `string`
66
+
67
+ The key identifier.
package/locales/en.json CHANGED
@@ -10,7 +10,11 @@
10
10
  "gasStationTransactionFailed": "The gas station transaction failed",
11
11
  "dryRunFailed": "The dry run execution failed",
12
12
  "fundingFailed": "Fund the address from faucet failed",
13
- "faucetRateLimit": "Faucet rate limit exceeded"
13
+ "faucetRateLimit": "Faucet rate limit exceeded",
14
+ "missingPublicKey": "The public key is missing for vault key \"{keyName}\""
15
+ },
16
+ "vaultJwkStorage": {
17
+ "generateNotSupported": "Key generation is not supported; keys are managed by the vault"
14
18
  },
15
19
  "iotaIdentityUtils": {
16
20
  "getControllerCapInfoFailed": "Getting the controller capability info for the identity failed",
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "@twin.org/dlt-iota",
3
- "version": "0.0.3-next.13",
3
+ "version": "0.0.3-next.15",
4
4
  "description": "IOTA distributed ledger utilities for clients, transactions, and contract operations.",
5
5
  "repository": {
6
6
  "type": "git",
7
- "url": "git+https://github.com/iotaledger/dlt.git",
7
+ "url": "git+https://github.com/iotaledger/twin-dlt.git",
8
8
  "directory": "packages/dlt-iota"
9
9
  },
10
10
  "author": "cornel.filip@iota.org",
@@ -49,7 +49,7 @@
49
49
  "dlt"
50
50
  ],
51
51
  "bugs": {
52
- "url": "git+https://github.com/iotaledger/dlt/issues"
52
+ "url": "git+https://github.com/iotaledger/twin-dlt/issues"
53
53
  },
54
54
  "homepage": "https://twindev.org"
55
55
  }