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

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 (60) 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 +356 -93
  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 +31 -27
  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/IIotaConfig.js.map +1 -1
  12. package/dist/es/models/IIotaControllerCapInfo.js.map +1 -1
  13. package/dist/es/models/IIotaResponseOptions.js.map +1 -1
  14. package/dist/es/models/IMigrationStateFields.js.map +1 -1
  15. package/dist/es/models/ISmartContractObject.js.map +1 -1
  16. package/dist/es/models/ITransactionSigner.js +2 -0
  17. package/dist/es/models/ITransactionSigner.js.map +1 -0
  18. package/dist/es/vaultJwkStorage.js +71 -0
  19. package/dist/es/vaultJwkStorage.js.map +1 -0
  20. package/dist/es/vaultJwtSigner.js +49 -0
  21. package/dist/es/vaultJwtSigner.js.map +1 -0
  22. package/dist/es/vaultSigner.js +60 -0
  23. package/dist/es/vaultSigner.js.map +1 -0
  24. package/dist/es/vaultTransactionSigner.js +74 -0
  25. package/dist/es/vaultTransactionSigner.js.map +1 -0
  26. package/dist/types/index.d.ts +7 -3
  27. package/dist/types/iota.d.ts +82 -53
  28. package/dist/types/iotaIdentityUtils.d.ts +2 -4
  29. package/dist/types/iotaSmartContractUtils.d.ts +18 -17
  30. package/dist/types/models/IAdminCapFields.d.ts +2 -2
  31. package/dist/types/models/IGasStationExecuteResponse.d.ts +1 -3
  32. package/dist/types/models/IIotaConfig.d.ts +5 -0
  33. package/dist/types/models/IIotaControllerCapInfo.d.ts +3 -6
  34. package/dist/types/models/IIotaResponseOptions.d.ts +1 -1
  35. package/dist/types/models/IMigrationStateFields.d.ts +2 -2
  36. package/dist/types/models/ISmartContractObject.d.ts +2 -2
  37. package/dist/types/models/ITransactionSigner.d.ts +27 -0
  38. package/dist/types/vaultJwkStorage.d.ts +50 -0
  39. package/dist/types/vaultJwtSigner.d.ts +26 -0
  40. package/dist/types/vaultSigner.d.ts +32 -0
  41. package/dist/types/vaultTransactionSigner.d.ts +39 -0
  42. package/docs/changelog.md +112 -0
  43. package/docs/examples.md +6 -13
  44. package/docs/reference/classes/Iota.md +325 -189
  45. package/docs/reference/classes/IotaIdentityUtils.md +2 -4
  46. package/docs/reference/classes/IotaSmartContractUtils.md +57 -40
  47. package/docs/reference/classes/VaultJwtSigner.md +71 -0
  48. package/docs/reference/classes/VaultSigner.md +106 -0
  49. package/docs/reference/classes/VaultTransactionSigner.md +122 -0
  50. package/docs/reference/index.md +4 -0
  51. package/docs/reference/interfaces/IAdminCapFields.md +2 -2
  52. package/docs/reference/interfaces/IGasStationExecuteResponse.md +1 -3
  53. package/docs/reference/interfaces/IIotaConfig.md +14 -0
  54. package/docs/reference/interfaces/IIotaControllerCapInfo.md +3 -6
  55. package/docs/reference/interfaces/IIotaResponseOptions.md +1 -1
  56. package/docs/reference/interfaces/IMigrationStateFields.md +2 -2
  57. package/docs/reference/interfaces/ISmartContractObject.md +2 -2
  58. package/docs/reference/interfaces/ITransactionSigner.md +67 -0
  59. package/locales/en.json +7 -1
  60. package/package.json +12 -12
@@ -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
@@ -8,7 +8,13 @@
8
8
  "transactionFailed": "The transaction failed",
9
9
  "addressNotFound": "The address is missing could not be found from the seed \"{address}\"",
10
10
  "gasStationTransactionFailed": "The gas station transaction failed",
11
- "dryRunFailed": "The dry run execution failed"
11
+ "dryRunFailed": "The dry run execution failed",
12
+ "fundingFailed": "Fund the address from faucet failed",
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"
12
18
  },
13
19
  "iotaIdentityUtils": {
14
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.9",
3
+ "version": "0.9.0",
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",
@@ -15,15 +15,15 @@
15
15
  },
16
16
  "dependencies": {
17
17
  "@iota/bcs": "1.6.0",
18
- "@iota/identity-wasm": "1.9.5-beta.1",
19
- "@iota/iota-sdk": "1.13.0",
20
- "@twin.org/core": "next",
21
- "@twin.org/crypto": "next",
22
- "@twin.org/logging-models": "next",
23
- "@twin.org/nameof": "next",
24
- "@twin.org/vault-models": "next",
25
- "@twin.org/wallet-models": "next",
26
- "@twin.org/web": "next"
18
+ "@iota/identity-wasm": "1.9.6-beta.1",
19
+ "@iota/iota-sdk": "1.14.0",
20
+ "@twin.org/core": "^0.9.0",
21
+ "@twin.org/crypto": "^0.9.0",
22
+ "@twin.org/logging-models": "^0.9.0",
23
+ "@twin.org/nameof": "^0.9.0",
24
+ "@twin.org/vault-models": "^0.9.0",
25
+ "@twin.org/wallet-models": "^0.9.0-next.1",
26
+ "@twin.org/web": "^0.9.0"
27
27
  },
28
28
  "main": "./dist/es/index.js",
29
29
  "types": "./dist/types/index.d.ts",
@@ -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
  }