@notabene/javascript-sdk 2.8.0-next.3 → 2.8.0-next.4

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 (118) hide show
  1. package/dist/cjs/notabene.d.ts +1 -1
  2. package/dist/cjs/package.json +1 -1
  3. package/dist/esm/notabene.d.ts +1 -1
  4. package/dist/esm/package.json +1 -1
  5. package/dist/notabene.d.ts +1 -1
  6. package/docs/_media/TransactionOptions.md +6 -6
  7. package/docs/ivms/types/enumerations/PayloadVersionCode.md +2 -2
  8. package/docs/ivms/types/interfaces/PayloadMetadata.md +2 -2
  9. package/docs/ivms/types/type-aliases/Address.md +1 -1
  10. package/docs/ivms/types/type-aliases/AddressTypeCode.md +1 -1
  11. package/docs/ivms/types/type-aliases/Beneficiary.md +1 -1
  12. package/docs/ivms/types/type-aliases/BeneficiaryVASP.md +1 -1
  13. package/docs/ivms/types/type-aliases/DateAndPlaceOfBirth.md +1 -1
  14. package/docs/ivms/types/type-aliases/ISOCountryCode.md +1 -1
  15. package/docs/ivms/types/type-aliases/ISODate.md +1 -1
  16. package/docs/ivms/types/type-aliases/IVMS101.md +1 -1
  17. package/docs/ivms/types/type-aliases/IntermediaryVASP.md +1 -1
  18. package/docs/ivms/types/type-aliases/LegalPerson.md +1 -1
  19. package/docs/ivms/types/type-aliases/LegalPersonName.md +1 -1
  20. package/docs/ivms/types/type-aliases/LegalPersonNameID.md +1 -1
  21. package/docs/ivms/types/type-aliases/LegalPersonNameTypeCode.md +1 -1
  22. package/docs/ivms/types/type-aliases/LocalLegalPersonNameID.md +1 -1
  23. package/docs/ivms/types/type-aliases/LocalNaturalPersonNameID.md +1 -1
  24. package/docs/ivms/types/type-aliases/NationalIdentification.md +1 -1
  25. package/docs/ivms/types/type-aliases/NationalIdentifierTypeCode.md +1 -1
  26. package/docs/ivms/types/type-aliases/NaturalPerson.md +1 -1
  27. package/docs/ivms/types/type-aliases/NaturalPersonName.md +1 -1
  28. package/docs/ivms/types/type-aliases/NaturalPersonNameID.md +1 -1
  29. package/docs/ivms/types/type-aliases/NaturalPersonNameTypeCode.md +1 -1
  30. package/docs/ivms/types/type-aliases/OriginatingVASP.md +1 -1
  31. package/docs/ivms/types/type-aliases/Originator.md +1 -1
  32. package/docs/ivms/types/type-aliases/Person.md +1 -1
  33. package/docs/ivms/types/type-aliases/TransferPath.md +1 -1
  34. package/docs/ivms/types/type-aliases/TransliterationMethodCode.md +1 -1
  35. package/docs/notabene/README.md +30 -0
  36. package/docs/notabene/classes/EmbeddedComponent.md +17 -17
  37. package/docs/notabene/classes/default.md +7 -7
  38. package/docs/notabene/functions/decodeFragmentToObject.md +1 -1
  39. package/docs/notabene/interfaces/NotabeneConfig.md +5 -5
  40. package/docs/notabene/type-aliases/MessageCallback.md +1 -1
  41. package/docs/types/README.md +2 -0
  42. package/docs/types/enumerations/AgentType.md +2 -2
  43. package/docs/types/enumerations/CMType.md +7 -7
  44. package/docs/types/enumerations/ErrorIdentifierCode.md +4 -4
  45. package/docs/types/enumerations/HMType.md +2 -2
  46. package/docs/types/enumerations/PersonType.md +3 -3
  47. package/docs/types/enumerations/ProofStatus.md +4 -4
  48. package/docs/types/enumerations/ProofTypes.md +36 -14
  49. package/docs/types/enumerations/Status.md +5 -5
  50. package/docs/types/enumerations/VASPSearchControl.md +2 -2
  51. package/docs/types/enumerations/ValidationSections.md +4 -4
  52. package/docs/types/interfaces/Agent.md +6 -6
  53. package/docs/types/interfaces/CallbackOptions.md +2 -2
  54. package/docs/types/interfaces/ComponentRequest.md +2 -2
  55. package/docs/types/interfaces/ComponentResponse.md +4 -4
  56. package/docs/types/interfaces/ConnectionRecord.md +7 -7
  57. package/docs/types/interfaces/ConnectionRequest.md +3 -3
  58. package/docs/types/interfaces/Counterparty.md +10 -10
  59. package/docs/types/interfaces/DeclarationProof.md +6 -6
  60. package/docs/types/interfaces/Deposit.md +25 -11
  61. package/docs/types/interfaces/DepositRequest.md +7 -7
  62. package/docs/types/interfaces/DepositRequestOptions.md +1 -1
  63. package/docs/types/interfaces/DepositTransaction.md +9 -9
  64. package/docs/types/interfaces/LegalPerson.md +13 -13
  65. package/docs/types/interfaces/MicroTransferProof.md +9 -9
  66. package/docs/types/interfaces/NaturalPerson.md +13 -13
  67. package/docs/types/interfaces/OwnershipProof.md +4 -4
  68. package/docs/types/interfaces/RefreshSource.md +27 -0
  69. package/docs/types/interfaces/Refreshable.md +22 -0
  70. package/docs/types/interfaces/ScreenshotProof.md +5 -5
  71. package/docs/types/interfaces/SignatureProof.md +23 -9
  72. package/docs/types/interfaces/ThresholdOptions.md +3 -3
  73. package/docs/types/interfaces/Transaction.md +8 -8
  74. package/docs/types/interfaces/TransactionOptions.md +6 -6
  75. package/docs/types/interfaces/TransactionResponse.md +9 -9
  76. package/docs/types/interfaces/VASP.md +9 -9
  77. package/docs/types/interfaces/Wallet.md +8 -8
  78. package/docs/types/interfaces/Withdrawal.md +24 -10
  79. package/docs/types/type-aliases/BlockchainAddress.md +1 -1
  80. package/docs/types/type-aliases/CAIP10.md +1 -1
  81. package/docs/types/type-aliases/CAIP19.md +1 -1
  82. package/docs/types/type-aliases/CAIP2.md +1 -1
  83. package/docs/types/type-aliases/CAIP220.md +1 -1
  84. package/docs/types/type-aliases/Cancel.md +1 -1
  85. package/docs/types/type-aliases/Completed.md +1 -1
  86. package/docs/types/type-aliases/ComponentMessage.md +1 -1
  87. package/docs/types/type-aliases/ConnectionOptions.md +1 -1
  88. package/docs/types/type-aliases/CryptoCredential.md +1 -1
  89. package/docs/types/type-aliases/DID.md +1 -1
  90. package/docs/types/type-aliases/DTI.md +1 -1
  91. package/docs/types/type-aliases/Destination.md +1 -1
  92. package/docs/types/type-aliases/Error.md +1 -1
  93. package/docs/types/type-aliases/FieldOptions.md +2 -2
  94. package/docs/types/type-aliases/FieldTypes.md +1 -1
  95. package/docs/types/type-aliases/HostMessage.md +1 -1
  96. package/docs/types/type-aliases/ISOCurrency.md +1 -1
  97. package/docs/types/type-aliases/InvalidValue.md +1 -1
  98. package/docs/types/type-aliases/LEI.md +1 -1
  99. package/docs/types/type-aliases/LegalPersonFieldName.md +1 -1
  100. package/docs/types/type-aliases/LegalPersonFields.md +1 -1
  101. package/docs/types/type-aliases/NaturalPersonFieldName.md +1 -1
  102. package/docs/types/type-aliases/NaturalPersonFields.md +1 -1
  103. package/docs/types/type-aliases/NotabeneAsset.md +1 -1
  104. package/docs/types/type-aliases/Ready.md +1 -1
  105. package/docs/types/type-aliases/ResizeRequest.md +1 -1
  106. package/docs/types/type-aliases/Source.md +1 -1
  107. package/docs/types/type-aliases/Theme.md +1 -1
  108. package/docs/types/type-aliases/TransactionAsset.md +1 -1
  109. package/docs/types/type-aliases/TravelAddress.md +1 -1
  110. package/docs/types/type-aliases/URI.md +1 -1
  111. package/docs/types/type-aliases/UUID.md +1 -1
  112. package/docs/types/type-aliases/UpdateValue.md +1 -1
  113. package/docs/types/type-aliases/V1Asset.md +1 -1
  114. package/docs/types/type-aliases/V1Transaction.md +1 -1
  115. package/docs/types/type-aliases/VASPOptions.md +1 -1
  116. package/docs/types/type-aliases/ValidationError.md +1 -1
  117. package/package.json +1 -1
  118. package/src/types.ts +1 -0
@@ -18,7 +18,7 @@ The authentication token for the Notabene API
18
18
 
19
19
  #### Defined in
20
20
 
21
- [notabene.ts:153](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/notabene.ts#L153)
21
+ [notabene.ts:163](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/notabene.ts#L163)
22
22
 
23
23
  ***
24
24
 
@@ -30,7 +30,7 @@ The locale to use for the UX components
30
30
 
31
31
  #### Defined in
32
32
 
33
- [notabene.ts:168](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/notabene.ts#L168)
33
+ [notabene.ts:178](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/notabene.ts#L178)
34
34
 
35
35
  ***
36
36
 
@@ -42,7 +42,7 @@ The URL of the Notabene API node
42
42
 
43
43
  #### Defined in
44
44
 
45
- [notabene.ts:148](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/notabene.ts#L148)
45
+ [notabene.ts:158](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/notabene.ts#L158)
46
46
 
47
47
  ***
48
48
 
@@ -54,7 +54,7 @@ Custom theme configuration for the UX components
54
54
 
55
55
  #### Defined in
56
56
 
57
- [notabene.ts:163](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/notabene.ts#L163)
57
+ [notabene.ts:173](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/notabene.ts#L173)
58
58
 
59
59
  ***
60
60
 
@@ -66,4 +66,4 @@ The URL of the Notabene UX components
66
66
 
67
67
  #### Defined in
68
68
 
69
- [notabene.ts:158](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/notabene.ts#L158)
69
+ [notabene.ts:168](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/notabene.ts#L168)
@@ -30,4 +30,4 @@ The message object containing the component data and type
30
30
 
31
31
  ## Defined in
32
32
 
33
- [utils/MessageEventManager.ts:11](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/utils/MessageEventManager.ts#L11)
33
+ [utils/MessageEventManager.ts:11](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/utils/MessageEventManager.ts#L11)
@@ -39,6 +39,8 @@
39
39
  - [MicroTransferProof](interfaces/MicroTransferProof.md)
40
40
  - [NaturalPerson](interfaces/NaturalPerson.md)
41
41
  - [OwnershipProof](interfaces/OwnershipProof.md)
42
+ - [Refreshable](interfaces/Refreshable.md)
43
+ - [RefreshSource](interfaces/RefreshSource.md)
42
44
  - [ScreenshotProof](interfaces/ScreenshotProof.md)
43
45
  - [SignatureProof](interfaces/SignatureProof.md)
44
46
  - [ThresholdOptions](interfaces/ThresholdOptions.md)
@@ -16,7 +16,7 @@ The type of Agent. Either a wallet or a VASP
16
16
 
17
17
  #### Defined in
18
18
 
19
- [types.ts:250](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L250)
19
+ [types.ts:250](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L250)
20
20
 
21
21
  ***
22
22
 
@@ -26,4 +26,4 @@ The type of Agent. Either a wallet or a VASP
26
26
 
27
27
  #### Defined in
28
28
 
29
- [types.ts:251](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L251)
29
+ [types.ts:251](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L251)
@@ -27,7 +27,7 @@ between the host and component.
27
27
 
28
28
  #### Defined in
29
29
 
30
- [types.ts:809](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L809)
30
+ [types.ts:825](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L825)
31
31
 
32
32
  ***
33
33
 
@@ -37,7 +37,7 @@ between the host and component.
37
37
 
38
38
  #### Defined in
39
39
 
40
- [types.ts:803](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L803)
40
+ [types.ts:819](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L819)
41
41
 
42
42
  ***
43
43
 
@@ -47,7 +47,7 @@ between the host and component.
47
47
 
48
48
  #### Defined in
49
49
 
50
- [types.ts:808](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L808)
50
+ [types.ts:824](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L824)
51
51
 
52
52
  ***
53
53
 
@@ -57,7 +57,7 @@ between the host and component.
57
57
 
58
58
  #### Defined in
59
59
 
60
- [types.ts:807](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L807)
60
+ [types.ts:823](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L823)
61
61
 
62
62
  ***
63
63
 
@@ -67,7 +67,7 @@ between the host and component.
67
67
 
68
68
  #### Defined in
69
69
 
70
- [types.ts:806](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L806)
70
+ [types.ts:822](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L822)
71
71
 
72
72
  ***
73
73
 
@@ -77,7 +77,7 @@ between the host and component.
77
77
 
78
78
  #### Defined in
79
79
 
80
- [types.ts:804](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L804)
80
+ [types.ts:820](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L820)
81
81
 
82
82
  ***
83
83
 
@@ -87,4 +87,4 @@ between the host and component.
87
87
 
88
88
  #### Defined in
89
89
 
90
- [types.ts:805](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L805)
90
+ [types.ts:821](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L821)
@@ -16,7 +16,7 @@ Represents an error identifier code
16
16
 
17
17
  #### Defined in
18
18
 
19
- [types.ts:845](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L845)
19
+ [types.ts:861](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L861)
20
20
 
21
21
  ***
22
22
 
@@ -26,7 +26,7 @@ Represents an error identifier code
26
26
 
27
27
  #### Defined in
28
28
 
29
- [types.ts:848](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L848)
29
+ [types.ts:864](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L864)
30
30
 
31
31
  ***
32
32
 
@@ -36,7 +36,7 @@ Represents an error identifier code
36
36
 
37
37
  #### Defined in
38
38
 
39
- [types.ts:846](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L846)
39
+ [types.ts:862](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L862)
40
40
 
41
41
  ***
42
42
 
@@ -46,4 +46,4 @@ Represents an error identifier code
46
46
 
47
47
  #### Defined in
48
48
 
49
- [types.ts:847](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L847)
49
+ [types.ts:863](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L863)
@@ -22,7 +22,7 @@ from the host application.
22
22
 
23
23
  #### Defined in
24
24
 
25
- [types.ts:926](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L926)
25
+ [types.ts:942](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L942)
26
26
 
27
27
  ***
28
28
 
@@ -32,4 +32,4 @@ from the host application.
32
32
 
33
33
  #### Defined in
34
34
 
35
- [types.ts:925](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L925)
35
+ [types.ts:941](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L941)
@@ -32,7 +32,7 @@ apply to each type.
32
32
 
33
33
  #### Defined in
34
34
 
35
- [types.ts:290](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L290)
35
+ [types.ts:290](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L290)
36
36
 
37
37
  ***
38
38
 
@@ -42,7 +42,7 @@ apply to each type.
42
42
 
43
43
  #### Defined in
44
44
 
45
- [types.ts:289](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L289)
45
+ [types.ts:289](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L289)
46
46
 
47
47
  ***
48
48
 
@@ -52,4 +52,4 @@ apply to each type.
52
52
 
53
53
  #### Defined in
54
54
 
55
- [types.ts:291](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L291)
55
+ [types.ts:291](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L291)
@@ -24,7 +24,7 @@ Represents the different states that an ownership proof can be in during and aft
24
24
 
25
25
  #### Defined in
26
26
 
27
- [types.ts:995](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L995)
27
+ [types.ts:1011](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L1011)
28
28
 
29
29
  ***
30
30
 
@@ -34,7 +34,7 @@ Represents the different states that an ownership proof can be in during and aft
34
34
 
35
35
  #### Defined in
36
36
 
37
- [types.ts:996](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L996)
37
+ [types.ts:1012](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L1012)
38
38
 
39
39
  ***
40
40
 
@@ -44,7 +44,7 @@ Represents the different states that an ownership proof can be in during and aft
44
44
 
45
45
  #### Defined in
46
46
 
47
- [types.ts:994](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L994)
47
+ [types.ts:1010](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L1010)
48
48
 
49
49
  ***
50
50
 
@@ -54,4 +54,4 @@ Represents the different states that an ownership proof can be in during and aft
54
54
 
55
55
  #### Defined in
56
56
 
57
- [types.ts:997](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L997)
57
+ [types.ts:1013](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L1013)
@@ -19,9 +19,11 @@ Supported proof types:
19
19
  - BIP322: Bitcoin message signature following BIP-322
20
20
  - TIP191: Tron message signing
21
21
  - ED25519: Ed25519 signature (used in Solana)
22
+ - XRP_ED25519: Ed25519 signature (used in XRP)
22
23
  - XPUB: Extended public key signature for HD wallets
23
24
  - MicroTransfer: Proof via small blockchain transaction
24
25
  - Screenshot: Image proof of ownership/access
26
+ - CIP8: Cardano message signing standard (CIP-8)
25
27
 
26
28
  ## See
27
29
 
@@ -38,7 +40,7 @@ Supported proof types:
38
40
 
39
41
  #### Defined in
40
42
 
41
- [types.ts:1030](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L1030)
43
+ [types.ts:1048](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L1048)
42
44
 
43
45
  ***
44
46
 
@@ -48,7 +50,7 @@ Supported proof types:
48
50
 
49
51
  #### Defined in
50
52
 
51
- [types.ts:1032](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L1032)
53
+ [types.ts:1050](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L1050)
52
54
 
53
55
  ***
54
56
 
@@ -58,7 +60,17 @@ Supported proof types:
58
60
 
59
61
  #### Defined in
60
62
 
61
- [types.ts:1031](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L1031)
63
+ [types.ts:1049](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L1049)
64
+
65
+ ***
66
+
67
+ ### CIP8
68
+
69
+ > **CIP8**: `"cip-8"`
70
+
71
+ #### Defined in
72
+
73
+ [types.ts:1054](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L1054)
62
74
 
63
75
  ***
64
76
 
@@ -68,7 +80,7 @@ Supported proof types:
68
80
 
69
81
  #### Defined in
70
82
 
71
- [types.ts:1037](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L1037)
83
+ [types.ts:1057](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L1057)
72
84
 
73
85
  ***
74
86
 
@@ -78,7 +90,7 @@ Supported proof types:
78
90
 
79
91
  #### Defined in
80
92
 
81
- [types.ts:1034](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L1034)
93
+ [types.ts:1052](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L1052)
82
94
 
83
95
  ***
84
96
 
@@ -88,7 +100,7 @@ Supported proof types:
88
100
 
89
101
  #### Defined in
90
102
 
91
- [types.ts:1029](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L1029)
103
+ [types.ts:1047](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L1047)
92
104
 
93
105
  ***
94
106
 
@@ -98,7 +110,7 @@ Supported proof types:
98
110
 
99
111
  #### Defined in
100
112
 
101
- [types.ts:1027](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L1027)
113
+ [types.ts:1045](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L1045)
102
114
 
103
115
  ***
104
116
 
@@ -108,7 +120,7 @@ Supported proof types:
108
120
 
109
121
  #### Defined in
110
122
 
111
- [types.ts:1028](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L1028)
123
+ [types.ts:1046](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L1046)
112
124
 
113
125
  ***
114
126
 
@@ -118,7 +130,7 @@ Supported proof types:
118
130
 
119
131
  #### Defined in
120
132
 
121
- [types.ts:1035](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L1035)
133
+ [types.ts:1055](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L1055)
122
134
 
123
135
  ***
124
136
 
@@ -128,7 +140,7 @@ Supported proof types:
128
140
 
129
141
  #### Defined in
130
142
 
131
- [types.ts:1036](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L1036)
143
+ [types.ts:1056](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L1056)
132
144
 
133
145
  ***
134
146
 
@@ -138,7 +150,7 @@ Supported proof types:
138
150
 
139
151
  #### Defined in
140
152
 
141
- [types.ts:1024](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L1024)
153
+ [types.ts:1042](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L1042)
142
154
 
143
155
  ***
144
156
 
@@ -148,7 +160,7 @@ Supported proof types:
148
160
 
149
161
  #### Defined in
150
162
 
151
- [types.ts:1025](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L1025)
163
+ [types.ts:1043](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L1043)
152
164
 
153
165
  ***
154
166
 
@@ -158,7 +170,7 @@ Supported proof types:
158
170
 
159
171
  #### Defined in
160
172
 
161
- [types.ts:1026](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L1026)
173
+ [types.ts:1044](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L1044)
162
174
 
163
175
  ***
164
176
 
@@ -168,4 +180,14 @@ Supported proof types:
168
180
 
169
181
  #### Defined in
170
182
 
171
- [types.ts:1033](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L1033)
183
+ [types.ts:1051](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L1051)
184
+
185
+ ***
186
+
187
+ ### XRP\_ED25519
188
+
189
+ > **XRP\_ED25519**: `"xrp-ed25519"`
190
+
191
+ #### Defined in
192
+
193
+ [types.ts:1053](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L1053)
@@ -16,7 +16,7 @@ The verification status of a transaction
16
16
 
17
17
  #### Defined in
18
18
 
19
- [types.ts:597](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L597)
19
+ [types.ts:612](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L612)
20
20
 
21
21
  ***
22
22
 
@@ -26,7 +26,7 @@ The verification status of a transaction
26
26
 
27
27
  #### Defined in
28
28
 
29
- [types.ts:593](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L593)
29
+ [types.ts:608](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L608)
30
30
 
31
31
  ***
32
32
 
@@ -36,7 +36,7 @@ The verification status of a transaction
36
36
 
37
37
  #### Defined in
38
38
 
39
- [types.ts:595](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L595)
39
+ [types.ts:610](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L610)
40
40
 
41
41
  ***
42
42
 
@@ -46,7 +46,7 @@ The verification status of a transaction
46
46
 
47
47
  #### Defined in
48
48
 
49
- [types.ts:596](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L596)
49
+ [types.ts:611](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L611)
50
50
 
51
51
  ***
52
52
 
@@ -56,4 +56,4 @@ The verification status of a transaction
56
56
 
57
57
  #### Defined in
58
58
 
59
- [types.ts:594](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L594)
59
+ [types.ts:609](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L609)
@@ -21,7 +21,7 @@ VASP Visibility Control representing allow/deny behaviour for VASP visibility
21
21
 
22
22
  #### Defined in
23
23
 
24
- [types.ts:725](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L725)
24
+ [types.ts:741](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L741)
25
25
 
26
26
  ***
27
27
 
@@ -31,4 +31,4 @@ VASP Visibility Control representing allow/deny behaviour for VASP visibility
31
31
 
32
32
  #### Defined in
33
33
 
34
- [types.ts:726](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L726)
34
+ [types.ts:742](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L742)
@@ -20,7 +20,7 @@ Sections in a WithdrawalAssist screen
20
20
 
21
21
  #### Defined in
22
22
 
23
- [types.ts:748](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L748)
23
+ [types.ts:764](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L764)
24
24
 
25
25
  ***
26
26
 
@@ -32,7 +32,7 @@ Sections in a WithdrawalAssist screen
32
32
 
33
33
  #### Defined in
34
34
 
35
- [types.ts:745](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L745)
35
+ [types.ts:761](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L761)
36
36
 
37
37
  ***
38
38
 
@@ -44,7 +44,7 @@ Sections in a WithdrawalAssist screen
44
44
 
45
45
  #### Defined in
46
46
 
47
- [types.ts:747](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L747)
47
+ [types.ts:763](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L763)
48
48
 
49
49
  ***
50
50
 
@@ -56,4 +56,4 @@ Sections in a WithdrawalAssist screen
56
56
 
57
57
  #### Defined in
58
58
 
59
- [types.ts:746](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L746)
59
+ [types.ts:762](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L762)
@@ -21,7 +21,7 @@ Who is the agent acting on behalf of the counterparty
21
21
 
22
22
  #### Defined in
23
23
 
24
- [types.ts:259](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L259)
24
+ [types.ts:259](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L259)
25
25
 
26
26
  ***
27
27
 
@@ -31,7 +31,7 @@ Who is the agent acting on behalf of the counterparty
31
31
 
32
32
  #### Defined in
33
33
 
34
- [types.ts:261](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L261)
34
+ [types.ts:261](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L261)
35
35
 
36
36
  ***
37
37
 
@@ -41,7 +41,7 @@ Who is the agent acting on behalf of the counterparty
41
41
 
42
42
  #### Defined in
43
43
 
44
- [types.ts:263](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L263)
44
+ [types.ts:263](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L263)
45
45
 
46
46
  ***
47
47
 
@@ -51,7 +51,7 @@ Who is the agent acting on behalf of the counterparty
51
51
 
52
52
  #### Defined in
53
53
 
54
- [types.ts:260](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L260)
54
+ [types.ts:260](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L260)
55
55
 
56
56
  ***
57
57
 
@@ -61,7 +61,7 @@ Who is the agent acting on behalf of the counterparty
61
61
 
62
62
  #### Defined in
63
63
 
64
- [types.ts:262](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L262)
64
+ [types.ts:262](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L262)
65
65
 
66
66
  ***
67
67
 
@@ -71,4 +71,4 @@ Who is the agent acting on behalf of the counterparty
71
71
 
72
72
  #### Defined in
73
73
 
74
- [types.ts:264](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L264)
74
+ [types.ts:264](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L264)
@@ -16,7 +16,7 @@ Options for callback and redirect URIs
16
16
 
17
17
  #### Defined in
18
18
 
19
- [types.ts:977](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L977)
19
+ [types.ts:993](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L993)
20
20
 
21
21
  ***
22
22
 
@@ -26,4 +26,4 @@ Options for callback and redirect URIs
26
26
 
27
27
  #### Defined in
28
28
 
29
- [types.ts:978](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L978)
29
+ [types.ts:994](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L994)
@@ -37,7 +37,7 @@ This interface is extended by specific request types like:
37
37
 
38
38
  #### Defined in
39
39
 
40
- [types.ts:496](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L496)
40
+ [types.ts:496](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L496)
41
41
 
42
42
  ***
43
43
 
@@ -47,4 +47,4 @@ This interface is extended by specific request types like:
47
47
 
48
48
  #### Defined in
49
49
 
50
- [types.ts:495](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L495)
50
+ [types.ts:495](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L495)
@@ -38,7 +38,7 @@ This interface is extended by specific response types like:
38
38
 
39
39
  #### Defined in
40
40
 
41
- [types.ts:656](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L656)
41
+ [types.ts:671](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L671)
42
42
 
43
43
  ***
44
44
 
@@ -48,7 +48,7 @@ This interface is extended by specific response types like:
48
48
 
49
49
  #### Defined in
50
50
 
51
- [types.ts:653](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L653)
51
+ [types.ts:668](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L668)
52
52
 
53
53
  ***
54
54
 
@@ -58,7 +58,7 @@ This interface is extended by specific response types like:
58
58
 
59
59
  #### Defined in
60
60
 
61
- [types.ts:655](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L655)
61
+ [types.ts:670](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L670)
62
62
 
63
63
  ***
64
64
 
@@ -68,4 +68,4 @@ This interface is extended by specific response types like:
68
68
 
69
69
  #### Defined in
70
70
 
71
- [types.ts:654](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7c1287c0f294e150fbd0ad5bc728bba0920f5ad7/src/types.ts#L654)
71
+ [types.ts:669](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L669)