@notabene/javascript-sdk 2.0.1 → 2.0.3

package/docs/types/interfaces/SignatureProof.md

@@ -0,0 +1,115 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / SignatureProof
+
+# Interface: SignatureProof
+
+Interface for signature-based ownership proofs that use cryptographic message signing
+
+## Remarks
+
+Extends the base OwnershipProface to add signature-specific properties:
+- Supports multiple signature standards like EIP-191, EIP-712, BIP-137, SIWE
+- Includes the cryptographic proof signature string
+- Contains an attestation message that was signed
+- Records which wallet provider was used for signing
+
+The signature proves ownership by demonstrating control of the private keys
+associated with the claimed address.
+
+## See
+
+ - [ProofTypes](../enumerations/ProofTypes.md) For supported signature types
+ - [OwnershipProof](OwnershipProof.md) For base proof properties
+
+## Extends
+
+- [`OwnershipProof`](OwnershipProof.md)
+
+## Properties
+
+### address
+
+> **address**: \`$\{string\}:$\{string\}:$\{string\}\`
+
+#### Inherited from
+
+[`OwnershipProof`](OwnershipProof.md).[`address`](OwnershipProof.md#address)
+
+#### Defined in
+
+[types.ts:1019](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L1019)
+
+***
+
+### attestation
+
+> **attestation**: `string`
+
+#### Defined in
+
+[types.ts:1051](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L1051)
+
+***
+
+### did
+
+> **did**: \`did:$\{string\}:$\{string\}\`
+
+#### Inherited from
+
+[`OwnershipProof`](OwnershipProof.md).[`did`](OwnershipProof.md#did)
+
+#### Defined in
+
+[types.ts:1018](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L1018)
+
+***
+
+### proof
+
+> **proof**: `string`
+
+#### Defined in
+
+[types.ts:1050](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L1050)
+
+***
+
+### status
+
+> **status**: [`ProofStatus`](../enumerations/ProofStatus.md)
+
+#### Inherited from
+
+[`OwnershipProof`](OwnershipProof.md).[`status`](OwnershipProof.md#status)
+
+#### Defined in
+
+[types.ts:1017](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L1017)
+
+***
+
+### type
+
+> **type**: [`SIWE`](../enumerations/ProofTypes.md#siwe) \| [`SIWX`](../enumerations/ProofTypes.md#siwx) \| [`EIP191`](../enumerations/ProofTypes.md#eip191) \| [`EIP712`](../enumerations/ProofTypes.md#eip712) \| [`EIP1271`](../enumerations/ProofTypes.md#eip1271) \| [`BIP137`](../enumerations/ProofTypes.md#bip137) \| [`BIP137_XPUB`](../enumerations/ProofTypes.md#bip137_xpub) \| [`ED25519`](../enumerations/ProofTypes.md#ed25519)
+
+#### Overrides
+
+[`OwnershipProof`](OwnershipProof.md).[`type`](OwnershipProof.md#type)
+
+#### Defined in
+
+[types.ts:1040](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L1040)
+
+***
+
+### wallet\_provider
+
+> **wallet\_provider**: `string`
+
+#### Defined in
+
+[types.ts:1052](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L1052)

package/docs/types/interfaces/ThresholdOptions.md

@@ -0,0 +1,47 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / ThresholdOptions
+
+# Interface: ThresholdOptions
+
+Specify what to do under the provided threshold.
+
+Eg. to allow self-declaration for all transactions under 1000 EUR
+
+Note to support threshold you MUST include the Asset Price in the Transaction
+
+## See
+
+[Transaction](Transaction.md) Transaction object
+
+## Properties
+
+### currency
+
+> **currency**: `string`
+
+#### Defined in
+
+[types.ts:737](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L737)
+
+***
+
+### proofTypes?
+
+> `optional` **proofTypes**: [`ProofTypes`](../enumerations/ProofTypes.md)[]
+
+#### Defined in
+
+[types.ts:738](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L738)
+
+***
+
+### threshold
+
+> **threshold**: `number`
+
+#### Defined in
+
+[types.ts:736](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L736)

package/docs/types/interfaces/Transaction.md

@@ -0,0 +1,136 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / Transaction
+
+# Interface: Transaction
+
+Core transaction interface representing a crypto asset transfer between parties
+
+## Remarks
+
+Extends ComponentRequest to add transaction-specific properties:
+- agent: The entity facilitating/executing the transaction
+- counterparty: The other party involved in the transaction
+- asset: The cryptocurrency or token being transferred
+- amountDecimal: The amount to transfer in decimal format
+- proof: Optional ownership proof verifying control of involved addresses
+- assetPrice: Optional price information in a fiat currency
+
+This interface serves as the base for specific transaction types like:
+- Withdrawals for sending assets out
+- Deposits for receiving assets
+- Deposit requests for requesting asset transfers
+
+## See
+
+ - [Withdrawal](Withdrawal.md) For withdrawal-specific transaction properties
+ - [Deposit](Deposit.md) For deposit-specific transaction properties
+ - [Agent](Agent.md) For agent details
+ - [Counterparty](Counterparty.md) For counterparty information
+
+## Extends
+
+- [`ComponentRequest`](ComponentRequest.md)
+
+## Extended by
+
+- [`Withdrawal`](Withdrawal.md)
+- [`Deposit`](Deposit.md)
+
+## Properties
+
+### agent
+
+> **agent**: [`Agent`](Agent.md)
+
+#### Defined in
+
+[types.ts:522](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L522)
+
+***
+
+### amountDecimal
+
+> **amountDecimal**: `number`
+
+#### Defined in
+
+[types.ts:525](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L525)
+
+***
+
+### asset
+
+> **asset**: `string`
+
+#### Defined in
+
+[types.ts:524](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L524)
+
+***
+
+### assetPrice?
+
+> `optional` **assetPrice**: `object`
+
+#### currency
+
+> **currency**: `string`
+
+#### price
+
+> **price**: `number`
+
+#### Defined in
+
+[types.ts:527](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L527)
+
+***
+
+### counterparty
+
+> **counterparty**: [`Counterparty`](Counterparty.md)
+
+#### Defined in
+
+[types.ts:523](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L523)
+
+***
+
+### customer?
+
+> `optional` **customer**: [`Counterparty`](Counterparty.md)
+
+#### Inherited from
+
+[`ComponentRequest`](ComponentRequest.md).[`customer`](ComponentRequest.md#customer)
+
+#### Defined in
+
+[types.ts:495](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L495)
+
+***
+
+### proof?
+
+> `optional` **proof**: [`OwnershipProof`](OwnershipProof.md)
+
+#### Defined in
+
+[types.ts:526](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L526)
+
+***
+
+### requestId?
+
+> `optional` **requestId**: `string`
+
+#### Inherited from
+
+[`ComponentRequest`](ComponentRequest.md).[`requestId`](ComponentRequest.md#requestid)
+
+#### Defined in
+
+[types.ts:494](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L494)

package/docs/types/interfaces/TransactionOptions.md

@@ -0,0 +1,93 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / TransactionOptions
+
+# Interface: TransactionOptions
+
+Configuration options for Transaction components
+
+## Properties
+
+### allowedAgentTypes?
+
+> `optional` **allowedAgentTypes**: [`AgentType`](../enumerations/AgentType.md)[]
+
+#### Defined in
+
+[types.ts:754](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L754)
+
+***
+
+### allowedCounterpartyTypes?
+
+> `optional` **allowedCounterpartyTypes**: [`PersonType`](../enumerations/PersonType.md)[]
+
+#### Defined in
+
+[types.ts:755](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L755)
+
+***
+
+### fields?
+
+> `optional` **fields**: [`FieldTypes`](../type-aliases/FieldTypes.md)
+
+#### Defined in
+
+[types.ts:756](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L756)
+
+***
+
+### hide?
+
+> `optional` **hide**: [`ValidationSections`](../enumerations/ValidationSections.md)[]
+
+#### Defined in
+
+[types.ts:758](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L758)
+
+***
+
+### proofs?
+
+> `optional` **proofs**: `object`
+
+#### deminimis?
+
+> `optional` **deminimis**: [`ThresholdOptions`](ThresholdOptions.md)
+
+#### fallbacks?
+
+> `optional` **fallbacks**: [`ProofTypes`](../enumerations/ProofTypes.md)[]
+
+#### microTransfer?
+
+> `optional` **microTransfer**: `object`
+
+#### microTransfer.amountSubunits
+
+> **amountSubunits**: `string`
+
+#### microTransfer.destination
+
+> **destination**: `string`
+
+#### microTransfer.timeout?
+
+> `optional` **timeout**: `number`
+
+#### Defined in
+
+[types.ts:745](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L745)
+
+***
+
+### vasps?
+
+> `optional` **vasps**: [`VASPOptions`](../type-aliases/VASPOptions.md)
+
+#### Defined in
+
+[types.ts:757](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L757)

package/docs/types/interfaces/TransactionResponse.md

@@ -0,0 +1,130 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / TransactionResponse
+
+# Interface: TransactionResponse\<V\>
+
+Response interface for transaction-related operations
+
+## Remarks
+
+Extends ComponentResponse to add transaction-specific response data:
+- value: The resulting transaction value of generic type V
+- ivms101: IVMS 101 travel rule data for the transaction
+- proof: Optional ownership proof details if required
+- txCreate: Optional V1 transaction payload for legacy API compatibility
+
+## See
+
+ - [ComponentResponse](ComponentResponse.md) For base response properties
+ - [IVMS101](../../ivms/types/type-aliases/IVMS101.md) For travel rule data structure
+ - [OwnershipProof](OwnershipProof.md) For proof details
+ - [V1Transaction](../type-aliases/V1Transaction.md) For legacy transaction format
+
+## Extends
+
+- [`ComponentResponse`](ComponentResponse.md)
+
+## Type Parameters
+
+• **V**
+
+Type of the transaction value being returned
+
+## Properties
+
+### errors
+
+> **errors**: [`ValidationError`](../type-aliases/ValidationError.md)[]
+
+#### Inherited from
+
+[`ComponentResponse`](ComponentResponse.md).[`errors`](ComponentResponse.md#errors)
+
+#### Defined in
+
+[types.ts:645](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L645)
+
+***
+
+### ivms101
+
+> **ivms101**: [`IVMS101`](../../ivms/types/type-aliases/IVMS101.md)
+
+#### Defined in
+
+[types.ts:668](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L668)
+
+***
+
+### proof?
+
+> `optional` **proof**: [`OwnershipProof`](OwnershipProof.md)
+
+#### Defined in
+
+[types.ts:669](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L669)
+
+***
+
+### requestID
+
+> **requestID**: `string`
+
+#### Inherited from
+
+[`ComponentResponse`](ComponentResponse.md).[`requestID`](ComponentResponse.md#requestid)
+
+#### Defined in
+
+[types.ts:642](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L642)
+
+***
+
+### status
+
+> **status**: [`Status`](../enumerations/Status.md)
+
+#### Inherited from
+
+[`ComponentResponse`](ComponentResponse.md).[`status`](ComponentResponse.md#status)
+
+#### Defined in
+
+[types.ts:644](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L644)
+
+***
+
+### txCreate?
+
+> `optional` **txCreate**: [`V1Transaction`](../type-aliases/V1Transaction.md)
+
+#### Defined in
+
+[types.ts:670](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L670)
+
+***
+
+### valid
+
+> **valid**: `boolean`
+
+#### Inherited from
+
+[`ComponentResponse`](ComponentResponse.md).[`valid`](ComponentResponse.md#valid)
+
+#### Defined in
+
+[types.ts:643](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L643)
+
+***
+
+### value
+
+> **value**: `V`
+
+#### Defined in
+
+[types.ts:667](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L667)

package/docs/types/interfaces/VASP.md

@@ -0,0 +1,127 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / VASP
+
+# Interface: VASP
+
+A VASP agent acting on behalf of the counterparty
+
+## Extends
+
+- [`Agent`](Agent.md)
+
+## Properties
+
+### countryOfRegistration?
+
+> `optional` **countryOfRegistration**: `string`
+
+#### Defined in
+
+[types.ts:301](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L301)
+
+***
+
+### did
+
+> **did**: \`did:$\{string\}:$\{string\}\`
+
+#### Inherited from
+
+[`Agent`](Agent.md).[`did`](Agent.md#did)
+
+#### Defined in
+
+[types.ts:258](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L258)
+
+***
+
+### lei?
+
+> `optional` **lei**: `string`
+
+#### Defined in
+
+[types.ts:298](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L298)
+
+***
+
+### logo?
+
+> `optional` **logo**: `string`
+
+#### Overrides
+
+[`Agent`](Agent.md).[`logo`](Agent.md#logo)
+
+#### Defined in
+
+[types.ts:299](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L299)
+
+***
+
+### name?
+
+> `optional` **name**: `string`
+
+#### Inherited from
+
+[`Agent`](Agent.md).[`name`](Agent.md#name)
+
+#### Defined in
+
+[types.ts:262](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L262)
+
+***
+
+### type
+
+> **type**: [`AgentType`](../enumerations/AgentType.md)
+
+#### Inherited from
+
+[`Agent`](Agent.md).[`type`](Agent.md#type)
+
+#### Defined in
+
+[types.ts:259](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L259)
+
+***
+
+### url?
+
+> `optional` **url**: `string`
+
+#### Inherited from
+
+[`Agent`](Agent.md).[`url`](Agent.md#url)
+
+#### Defined in
+
+[types.ts:261](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L261)
+
+***
+
+### verified?
+
+> `optional` **verified**: `boolean`
+
+#### Inherited from
+
+[`Agent`](Agent.md).[`verified`](Agent.md#verified)
+
+#### Defined in
+
+[types.ts:263](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L263)
+
+***
+
+### website?
+
+> `optional` **website**: `string`
+
+#### Defined in
+
+[types.ts:300](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L300)