@notabene/javascript-sdk 2.10.0-next.4 → 2.11.0-next.2
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.
- package/dist/cjs/notabene.cjs +1 -1
- package/dist/cjs/notabene.d.ts +74 -1
- package/dist/cjs/package.json +1 -1
- package/dist/esm/notabene.d.ts +74 -1
- package/dist/esm/notabene.js +18 -18
- package/dist/esm/package.json +1 -1
- package/dist/notabene.d.ts +74 -1
- package/dist/notabene.js +18 -18
- package/docs/README.md +9 -4
- package/docs/_media/TransactionOptions.md +17 -7
- package/docs/_media/getRefreshResult.md +1 -1
- package/docs/ivms/types/enumerations/PayloadVersionCode.md +2 -2
- package/docs/ivms/types/interfaces/PayloadMetadata.md +2 -2
- package/docs/ivms/types/type-aliases/Address.md +1 -1
- package/docs/ivms/types/type-aliases/AddressTypeCode.md +1 -1
- package/docs/ivms/types/type-aliases/Beneficiary.md +1 -1
- package/docs/ivms/types/type-aliases/BeneficiaryVASP.md +1 -1
- package/docs/ivms/types/type-aliases/DateAndPlaceOfBirth.md +1 -1
- package/docs/ivms/types/type-aliases/ISOCountryCode.md +1 -1
- package/docs/ivms/types/type-aliases/ISODate.md +1 -1
- package/docs/ivms/types/type-aliases/IVMS101.md +1 -1
- package/docs/ivms/types/type-aliases/IntermediaryVASP.md +1 -1
- package/docs/ivms/types/type-aliases/LegalPerson.md +1 -1
- package/docs/ivms/types/type-aliases/LegalPersonName.md +1 -1
- package/docs/ivms/types/type-aliases/LegalPersonNameID.md +1 -1
- package/docs/ivms/types/type-aliases/LegalPersonNameTypeCode.md +1 -1
- package/docs/ivms/types/type-aliases/LocalLegalPersonNameID.md +1 -1
- package/docs/ivms/types/type-aliases/LocalNaturalPersonNameID.md +1 -1
- package/docs/ivms/types/type-aliases/NationalIdentification.md +1 -1
- package/docs/ivms/types/type-aliases/NationalIdentifierTypeCode.md +1 -1
- package/docs/ivms/types/type-aliases/NaturalPerson.md +1 -1
- package/docs/ivms/types/type-aliases/NaturalPersonName.md +1 -1
- package/docs/ivms/types/type-aliases/NaturalPersonNameID.md +1 -1
- package/docs/ivms/types/type-aliases/NaturalPersonNameTypeCode.md +1 -1
- package/docs/ivms/types/type-aliases/OriginatingVASP.md +1 -1
- package/docs/ivms/types/type-aliases/Originator.md +1 -1
- package/docs/ivms/types/type-aliases/Person.md +1 -1
- package/docs/ivms/types/type-aliases/TransferPath.md +1 -1
- package/docs/ivms/types/type-aliases/TransliterationMethodCode.md +1 -1
- package/docs/notabene/classes/ConnectionManager.md +5 -5
- package/docs/notabene/classes/EmbeddedComponent.md +17 -17
- package/docs/notabene/classes/default.md +7 -7
- package/docs/notabene/functions/decodeFragmentToObject.md +1 -1
- package/docs/notabene/functions/getRefreshResult.md +1 -1
- package/docs/notabene/interfaces/ConnectionData.md +4 -4
- package/docs/notabene/interfaces/ConnectionMetadata.md +3 -3
- package/docs/notabene/interfaces/ConnectionResponse.md +6 -6
- package/docs/notabene/interfaces/NotabeneConfig.md +5 -5
- package/docs/notabene/type-aliases/ConnectionResult.md +1 -1
- package/docs/notabene/type-aliases/ConnectionStatus.md +1 -1
- package/docs/notabene/type-aliases/MessageCallback.md +1 -1
- package/docs/notabene/type-aliases/TransactionType.md +1 -1
- package/docs/types/README.md +2 -0
- package/docs/types/enumerations/AgentType.md +2 -2
- package/docs/types/enumerations/CMType.md +27 -7
- package/docs/types/enumerations/ErrorIdentifierCode.md +4 -4
- package/docs/types/enumerations/HMType.md +2 -2
- package/docs/types/enumerations/PersonType.md +3 -3
- package/docs/types/enumerations/ProofStatus.md +4 -4
- package/docs/types/enumerations/ProofTypes.md +30 -18
- package/docs/types/enumerations/Status.md +5 -5
- package/docs/types/enumerations/VASPSearchControl.md +2 -2
- package/docs/types/enumerations/ValidationSections.md +4 -4
- package/docs/types/interfaces/Account.md +5 -5
- package/docs/types/interfaces/Agent.md +6 -6
- package/docs/types/interfaces/CallbackOptions.md +2 -2
- package/docs/types/interfaces/ComponentRequest.md +2 -2
- package/docs/types/interfaces/ComponentResponse.md +4 -4
- package/docs/types/interfaces/ConnectionRecord.md +7 -7
- package/docs/types/interfaces/ConnectionRequest.md +3 -3
- package/docs/types/interfaces/Counterparty.md +10 -10
- package/docs/types/interfaces/DeclarationProof.md +6 -6
- package/docs/types/interfaces/Deposit.md +12 -12
- package/docs/types/interfaces/DepositRequest.md +7 -7
- package/docs/types/interfaces/DepositRequestOptions.md +1 -1
- package/docs/types/interfaces/DepositTransaction.md +10 -10
- package/docs/types/interfaces/LegalPerson.md +13 -13
- package/docs/types/interfaces/MicroTransferProof.md +9 -9
- package/docs/types/interfaces/NaturalPerson.md +13 -13
- package/docs/types/interfaces/OwnershipProof.md +4 -4
- package/docs/types/interfaces/RefreshSource.md +2 -2
- package/docs/types/interfaces/Refreshable.md +1 -1
- package/docs/types/interfaces/ScreenshotProof.md +5 -5
- package/docs/types/interfaces/SignatureProof.md +14 -12
- package/docs/types/interfaces/ThresholdOptions.md +3 -3
- package/docs/types/interfaces/Transaction.md +9 -9
- package/docs/types/interfaces/TransactionOptions.md +17 -7
- package/docs/types/interfaces/TransactionResponse.md +9 -9
- package/docs/types/interfaces/VASP.md +19 -9
- package/docs/types/interfaces/Wallet.md +8 -8
- package/docs/types/interfaces/Withdrawal.md +11 -11
- package/docs/types/type-aliases/BlockchainAddress.md +1 -1
- package/docs/types/type-aliases/CAIP10.md +1 -1
- package/docs/types/type-aliases/CAIP19.md +1 -1
- package/docs/types/type-aliases/CAIP2.md +1 -1
- package/docs/types/type-aliases/CAIP220.md +1 -1
- package/docs/types/type-aliases/Cancel.md +1 -1
- package/docs/types/type-aliases/Completed.md +1 -1
- package/docs/types/type-aliases/ComponentMessage.md +5 -2
- package/docs/types/type-aliases/ConnectionOptions.md +1 -1
- package/docs/types/type-aliases/CounterpartyAssistConfig.md +1 -1
- package/docs/types/type-aliases/CryptoCredential.md +1 -1
- package/docs/types/type-aliases/DID.md +1 -1
- package/docs/types/type-aliases/DTI.md +1 -1
- package/docs/types/type-aliases/Destination.md +1 -1
- package/docs/types/type-aliases/Error.md +1 -1
- package/docs/types/type-aliases/FieldOptions.md +2 -2
- package/docs/types/type-aliases/FieldTypes.md +1 -1
- package/docs/types/type-aliases/HostMessage.md +1 -1
- package/docs/types/type-aliases/ISOCurrency.md +1 -1
- package/docs/types/type-aliases/Info.md +37 -0
- package/docs/types/type-aliases/InvalidValue.md +1 -1
- package/docs/types/type-aliases/LEI.md +1 -1
- package/docs/types/type-aliases/LegalPersonFieldName.md +1 -1
- package/docs/types/type-aliases/LegalPersonFields.md +1 -1
- package/docs/types/type-aliases/NationalIdentifierTypeFieldOptions.md +1 -1
- package/docs/types/type-aliases/NaturalPersonFieldName.md +1 -1
- package/docs/types/type-aliases/NaturalPersonFields.md +1 -1
- package/docs/types/type-aliases/NotabeneAsset.md +1 -1
- package/docs/types/type-aliases/Ready.md +1 -1
- package/docs/types/type-aliases/ResizeRequest.md +1 -1
- package/docs/types/type-aliases/Source.md +1 -1
- package/docs/types/type-aliases/Theme.md +1 -1
- package/docs/types/type-aliases/TransactionAsset.md +1 -1
- package/docs/types/type-aliases/TravelAddress.md +1 -1
- package/docs/types/type-aliases/URI.md +1 -1
- package/docs/types/type-aliases/UUID.md +1 -1
- package/docs/types/type-aliases/UpdateValue.md +1 -1
- package/docs/types/type-aliases/V1Asset.md +1 -1
- package/docs/types/type-aliases/V1Transaction.md +1 -1
- package/docs/types/type-aliases/VASPOptions.md +1 -1
- package/docs/types/type-aliases/ValidationError.md +1 -1
- package/docs/types/type-aliases/Warning.md +37 -0
- package/package.json +1 -1
- package/src/notabene.ts +6 -0
- package/src/types.ts +79 -4
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
[**@notabene/javascript-sdk**](../../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / Info
|
|
6
|
+
|
|
7
|
+
# Type Alias: Info
|
|
8
|
+
|
|
9
|
+
> **Info**: `object`
|
|
10
|
+
|
|
11
|
+
Represents an info component message
|
|
12
|
+
|
|
13
|
+
## Type declaration
|
|
14
|
+
|
|
15
|
+
### description?
|
|
16
|
+
|
|
17
|
+
> `optional` **description**: `string`
|
|
18
|
+
|
|
19
|
+
### message
|
|
20
|
+
|
|
21
|
+
> **message**: `string`
|
|
22
|
+
|
|
23
|
+
### type
|
|
24
|
+
|
|
25
|
+
> **type**: [`INFO`](../enumerations/CMType.md#info)
|
|
26
|
+
|
|
27
|
+
## Param
|
|
28
|
+
|
|
29
|
+
Info message
|
|
30
|
+
|
|
31
|
+
## Param
|
|
32
|
+
|
|
33
|
+
Description of the info message
|
|
34
|
+
|
|
35
|
+
## Defined in
|
|
36
|
+
|
|
37
|
+
[types.ts:979](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L979)
|
|
@@ -42,4 +42,4 @@ Array of validation errors
|
|
|
42
42
|
|
|
43
43
|
## Defined in
|
|
44
44
|
|
|
45
|
-
[types.ts:
|
|
45
|
+
[types.ts:955](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L955)
|
|
@@ -12,4 +12,4 @@ A LEI Legal Entity Identifier
|
|
|
12
12
|
|
|
13
13
|
## Defined in
|
|
14
14
|
|
|
15
|
-
[types.ts:226](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
15
|
+
[types.ts:226](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L226)
|
|
@@ -10,4 +10,4 @@
|
|
|
10
10
|
|
|
11
11
|
## Defined in
|
|
12
12
|
|
|
13
|
-
[types.ts:
|
|
13
|
+
[types.ts:462](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L462)
|
|
@@ -12,4 +12,4 @@ Field properties for legal person fields
|
|
|
12
12
|
|
|
13
13
|
## Defined in
|
|
14
14
|
|
|
15
|
-
[types.ts:
|
|
15
|
+
[types.ts:476](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L476)
|
|
@@ -18,4 +18,4 @@ Field properties for national identifier type selection
|
|
|
18
18
|
|
|
19
19
|
## Defined in
|
|
20
20
|
|
|
21
|
-
[types.ts:
|
|
21
|
+
[types.ts:412](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L412)
|
|
@@ -12,4 +12,4 @@ Field names for NaturalPerson
|
|
|
12
12
|
|
|
13
13
|
## Defined in
|
|
14
14
|
|
|
15
|
-
[types.ts:
|
|
15
|
+
[types.ts:397](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L397)
|
|
@@ -12,4 +12,4 @@ Field properties for natural person fields
|
|
|
12
12
|
|
|
13
13
|
## Defined in
|
|
14
14
|
|
|
15
|
-
[types.ts:
|
|
15
|
+
[types.ts:420](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L420)
|
|
@@ -33,4 +33,4 @@ system that may be used alongside CAIP-19 and DTI identifiers.
|
|
|
33
33
|
|
|
34
34
|
## Defined in
|
|
35
35
|
|
|
36
|
-
[types.ts:140](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
36
|
+
[types.ts:140](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L140)
|
|
@@ -18,4 +18,4 @@ Represents a ready component message
|
|
|
18
18
|
|
|
19
19
|
## Defined in
|
|
20
20
|
|
|
21
|
-
[types.ts:
|
|
21
|
+
[types.ts:902](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L902)
|
|
@@ -24,4 +24,4 @@ Represents a resize request component message. This is handled by the library.
|
|
|
24
24
|
|
|
25
25
|
## Defined in
|
|
26
26
|
|
|
27
|
-
[types.ts:
|
|
27
|
+
[types.ts:910](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L910)
|
|
@@ -12,4 +12,4 @@ The source of a transaction
|
|
|
12
12
|
|
|
13
13
|
## Defined in
|
|
14
14
|
|
|
15
|
-
[types.ts:208](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
15
|
+
[types.ts:208](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L208)
|
|
@@ -34,4 +34,4 @@ The theme of the Notabene SDK
|
|
|
34
34
|
|
|
35
35
|
## Defined in
|
|
36
36
|
|
|
37
|
-
[types.ts:238](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
37
|
+
[types.ts:238](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L238)
|
|
@@ -12,4 +12,4 @@ The asset of a transaction either a Notabene asset, a CAIP-19 asset, or a DTI.
|
|
|
12
12
|
|
|
13
13
|
## Defined in
|
|
14
14
|
|
|
15
|
-
[types.ts:146](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
15
|
+
[types.ts:146](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L146)
|
|
@@ -34,4 +34,4 @@ VASPs and blockchain networks while maintaining privacy.
|
|
|
34
34
|
|
|
35
35
|
## Defined in
|
|
36
36
|
|
|
37
|
-
[types.ts:187](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
37
|
+
[types.ts:187](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L187)
|
|
@@ -12,4 +12,4 @@ A Uniform Resource Identifier
|
|
|
12
12
|
|
|
13
13
|
## Defined in
|
|
14
14
|
|
|
15
|
-
[types.ts:214](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
15
|
+
[types.ts:214](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L214)
|
|
@@ -24,4 +24,4 @@ Format: 8-4-4-4-12 hexadecimal digits
|
|
|
24
24
|
|
|
25
25
|
## Defined in
|
|
26
26
|
|
|
27
|
-
[types.ts:40](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
27
|
+
[types.ts:40](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L40)
|
|
@@ -51,4 +51,4 @@ and its configuration without requiring a full reload/reinitialize.
|
|
|
51
51
|
|
|
52
52
|
## Defined in
|
|
53
53
|
|
|
54
|
-
[types.ts:
|
|
54
|
+
[types.ts:1052](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L1052)
|
|
@@ -33,4 +33,4 @@ Used for backwards compatibility with V1 API transaction payloads:
|
|
|
33
33
|
|
|
34
34
|
## Defined in
|
|
35
35
|
|
|
36
|
-
[types.ts:
|
|
36
|
+
[types.ts:671](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L671)
|
|
@@ -54,4 +54,4 @@ Transaction payload suitable for calling Notabene v1 tx/create
|
|
|
54
54
|
|
|
55
55
|
## Defined in
|
|
56
56
|
|
|
57
|
-
[types.ts:
|
|
57
|
+
[types.ts:677](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L677)
|
|
@@ -26,4 +26,4 @@ Options for which VASPs to be searchable
|
|
|
26
26
|
|
|
27
27
|
## Defined in
|
|
28
28
|
|
|
29
|
-
[types.ts:790](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
29
|
+
[types.ts:790](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L790)
|
|
@@ -22,4 +22,4 @@ Validation error
|
|
|
22
22
|
|
|
23
23
|
## Defined in
|
|
24
24
|
|
|
25
|
-
[types.ts:
|
|
25
|
+
[types.ts:747](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L747)
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
[**@notabene/javascript-sdk**](../../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / Warning
|
|
6
|
+
|
|
7
|
+
# Type Alias: Warning
|
|
8
|
+
|
|
9
|
+
> **Warning**: `object`
|
|
10
|
+
|
|
11
|
+
Represents a warning component message
|
|
12
|
+
|
|
13
|
+
## Type declaration
|
|
14
|
+
|
|
15
|
+
### description?
|
|
16
|
+
|
|
17
|
+
> `optional` **description**: `string`
|
|
18
|
+
|
|
19
|
+
### message
|
|
20
|
+
|
|
21
|
+
> **message**: `string`
|
|
22
|
+
|
|
23
|
+
### type
|
|
24
|
+
|
|
25
|
+
> **type**: [`WARNING`](../enumerations/CMType.md#warning)
|
|
26
|
+
|
|
27
|
+
## Param
|
|
28
|
+
|
|
29
|
+
Warning message
|
|
30
|
+
|
|
31
|
+
## Param
|
|
32
|
+
|
|
33
|
+
Description of the warning message
|
|
34
|
+
|
|
35
|
+
## Defined in
|
|
36
|
+
|
|
37
|
+
[types.ts:967](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L967)
|
package/package.json
CHANGED
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
"author": "Notabene <developers@notabene.id>",
|
|
11
11
|
"license": "MIT",
|
|
12
12
|
"packageManager": "yarn@4.5.1",
|
|
13
|
-
"version": "2.
|
|
13
|
+
"version": "2.11.0-next.2",
|
|
14
14
|
"source": "src/notabene.ts",
|
|
15
15
|
"main": "dist/cjs/notabene.cjs",
|
|
16
16
|
"module": "dist/esm/notabene.js",
|
package/src/notabene.ts
CHANGED
|
@@ -13,6 +13,7 @@ import type {
|
|
|
13
13
|
ComponentResponse,
|
|
14
14
|
ConnectionOptions,
|
|
15
15
|
ConnectionRequest,
|
|
16
|
+
CosmosMetadata,
|
|
16
17
|
Counterparty,
|
|
17
18
|
CounterpartyAssistConfig,
|
|
18
19
|
CryptoCredential,
|
|
@@ -45,6 +46,8 @@ import type {
|
|
|
45
46
|
ResizeRequest,
|
|
46
47
|
ScreenshotProof,
|
|
47
48
|
SignatureProof,
|
|
49
|
+
SIWXInput,
|
|
50
|
+
SolanaMetadata,
|
|
48
51
|
Theme,
|
|
49
52
|
ThresholdOptions,
|
|
50
53
|
Transaction,
|
|
@@ -113,6 +116,7 @@ export type {
|
|
|
113
116
|
ComponentResponse,
|
|
114
117
|
ConnectionOptions,
|
|
115
118
|
ConnectionRequest,
|
|
119
|
+
CosmosMetadata,
|
|
116
120
|
Counterparty,
|
|
117
121
|
CounterpartyAssistConfig,
|
|
118
122
|
CryptoCredential,
|
|
@@ -146,6 +150,8 @@ export type {
|
|
|
146
150
|
ResizeRequest,
|
|
147
151
|
ScreenshotProof,
|
|
148
152
|
SignatureProof,
|
|
153
|
+
SIWXInput,
|
|
154
|
+
SolanaMetadata,
|
|
149
155
|
Theme,
|
|
150
156
|
ThresholdOptions,
|
|
151
157
|
Transaction,
|
package/src/types.ts
CHANGED
|
@@ -1109,6 +1109,8 @@ export enum ProofStatus {
|
|
|
1109
1109
|
* - SelfDeclaration: User self-declares ownership without cryptographic proof
|
|
1110
1110
|
* - EIP191: Ethereum personal signature following EIP-191 standard
|
|
1111
1111
|
* - SIWE: Sign-In with Ethereum message signature (EIP-4361)
|
|
1112
|
+
* - SIWX: Sign-In with X message signature
|
|
1113
|
+
* - SOL_SIWX: Sign-In with Solana message signature (SIWE for Solana)
|
|
1112
1114
|
* - EIP712: Ethereum typed data signature following EIP-712 standard
|
|
1113
1115
|
* - BIP137: Bitcoin message signature following BIP-137
|
|
1114
1116
|
* - BIP322: Bitcoin message signature following BIP-322
|
|
@@ -1131,6 +1133,7 @@ export enum ProofTypes {
|
|
|
1131
1133
|
SelfDeclaration = 'self-declaration',
|
|
1132
1134
|
SIWE = 'siwe',
|
|
1133
1135
|
SIWX = 'siwx',
|
|
1136
|
+
SOL_SIWX = 'sol-siwx',
|
|
1134
1137
|
EIP191 = 'eip-191',
|
|
1135
1138
|
EIP712 = 'eip-712',
|
|
1136
1139
|
EIP1271 = 'eip-1271',
|
|
@@ -1142,6 +1145,7 @@ export enum ProofTypes {
|
|
|
1142
1145
|
XRP_ED25519 = 'xrp-ed25519',
|
|
1143
1146
|
XLM_ED25519 = 'xlm-ed25519',
|
|
1144
1147
|
CIP8 = 'cip-8',
|
|
1148
|
+
COSMOS = 'cosmos-ecdsa',
|
|
1145
1149
|
MicroTransfer = 'microtransfer',
|
|
1146
1150
|
Screenshot = 'screenshot',
|
|
1147
1151
|
Connect = 'connect',
|
|
@@ -1176,6 +1180,72 @@ export interface OwnershipProof {
|
|
|
1176
1180
|
address: CAIP10;
|
|
1177
1181
|
}
|
|
1178
1182
|
|
|
1183
|
+
/**
|
|
1184
|
+
* Input for SIWX message signing
|
|
1185
|
+
* Every SIWX message must include the following fields:
|
|
1186
|
+
* - domain
|
|
1187
|
+
* - address
|
|
1188
|
+
* - statement
|
|
1189
|
+
* - uri
|
|
1190
|
+
* - version
|
|
1191
|
+
* - chainId
|
|
1192
|
+
*
|
|
1193
|
+
* Optional fields:
|
|
1194
|
+
* - nonce
|
|
1195
|
+
* - issuedAt
|
|
1196
|
+
* - expirationTime
|
|
1197
|
+
* - notBefore
|
|
1198
|
+
* - requestId
|
|
1199
|
+
* - resources
|
|
1200
|
+
*
|
|
1201
|
+
* @public
|
|
1202
|
+
*/
|
|
1203
|
+
export interface SIWXInput {
|
|
1204
|
+
domain: string;
|
|
1205
|
+
address: string;
|
|
1206
|
+
statement?: string;
|
|
1207
|
+
uri?: string;
|
|
1208
|
+
version?: string;
|
|
1209
|
+
chainId?: string;
|
|
1210
|
+
nonce?: string;
|
|
1211
|
+
issuedAt?: string;
|
|
1212
|
+
expirationTime?: string;
|
|
1213
|
+
notBefore?: string;
|
|
1214
|
+
requestId?: string;
|
|
1215
|
+
resources?: readonly string[];
|
|
1216
|
+
}
|
|
1217
|
+
|
|
1218
|
+
/**
|
|
1219
|
+
* Metadata for Solana SIWX ownership proofs
|
|
1220
|
+
* @remarks
|
|
1221
|
+
* - Includes the account public key and address
|
|
1222
|
+
* - Includes the signed message
|
|
1223
|
+
* - Includes the signature
|
|
1224
|
+
* - Includes the message
|
|
1225
|
+
*
|
|
1226
|
+
* @see {@link SignatureProof} For signature-based proofs
|
|
1227
|
+
* @public
|
|
1228
|
+
*/
|
|
1229
|
+
export interface SolanaMetadata {
|
|
1230
|
+
account: {
|
|
1231
|
+
address: string;
|
|
1232
|
+
publicKey: Uint8Array;
|
|
1233
|
+
};
|
|
1234
|
+
signedMessage: Uint8Array;
|
|
1235
|
+
signature: Uint8Array;
|
|
1236
|
+
message: SIWXInput;
|
|
1237
|
+
}
|
|
1238
|
+
|
|
1239
|
+
/**
|
|
1240
|
+
* Metadata for Cosmos ownership proofs
|
|
1241
|
+
* @remarks
|
|
1242
|
+
* - Includes the public key
|
|
1243
|
+
* @public
|
|
1244
|
+
*/
|
|
1245
|
+
export interface CosmosMetadata {
|
|
1246
|
+
pub_key: { type: string; value: string };
|
|
1247
|
+
}
|
|
1248
|
+
|
|
1179
1249
|
/**
|
|
1180
1250
|
* Interface for signature-based ownership proofs that use cryptographic message signing
|
|
1181
1251
|
*
|
|
@@ -1204,19 +1274,24 @@ export interface SignatureProof extends OwnershipProof {
|
|
|
1204
1274
|
| ProofTypes.ED25519
|
|
1205
1275
|
| ProofTypes.TIP191
|
|
1206
1276
|
| ProofTypes.SIWX
|
|
1277
|
+
| ProofTypes.SOL_SIWX
|
|
1207
1278
|
| ProofTypes.SIWE
|
|
1208
1279
|
| ProofTypes.CIP8
|
|
1209
1280
|
| ProofTypes.XRP_ED25519
|
|
1210
1281
|
| ProofTypes.CONCORDIUM
|
|
1211
|
-
| ProofTypes.XLM_ED25519
|
|
1282
|
+
| ProofTypes.XLM_ED25519
|
|
1283
|
+
| ProofTypes.COSMOS;
|
|
1212
1284
|
|
|
1213
1285
|
proof: string;
|
|
1214
1286
|
attestation: string;
|
|
1215
1287
|
wallet_provider: string;
|
|
1216
1288
|
xpub?: string;
|
|
1217
|
-
chainSpecificData?:
|
|
1218
|
-
|
|
1219
|
-
|
|
1289
|
+
chainSpecificData?:
|
|
1290
|
+
| {
|
|
1291
|
+
cardanoCoseKey?: string; // Cardano COSE key https://cips.cardano.org/cip/CIP-0030
|
|
1292
|
+
}
|
|
1293
|
+
| SolanaMetadata
|
|
1294
|
+
| CosmosMetadata;
|
|
1220
1295
|
}
|
|
1221
1296
|
|
|
1222
1297
|
/**
|