@notabene/javascript-sdk 2.0.1 → 2.0.3

package/docs/types/interfaces/Wallet.md

@@ -0,0 +1,117 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / Wallet
+
+# Interface: Wallet
+
+A wallet agent acting on behalf of the counterparty
+
+## Extends
+
+- [`Agent`](Agent.md)
+
+## Properties
+
+### 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)
+
+***
+
+### logo?
+
+> `optional` **logo**: `string`
+
+#### Inherited from
+
+[`Agent`](Agent.md).[`logo`](Agent.md#logo)
+
+#### Defined in
+
+[types.ts:260](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L260)
+
+***
+
+### 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)
+
+***
+
+### proof
+
+> **proof**: [`OwnershipProof`](OwnershipProof.md)
+
+#### Defined in
+
+[types.ts:309](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L309)
+
+***
+
+### 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)
+
+***
+
+### wallet\_connect\_id?
+
+> `optional` **wallet\_connect\_id**: `string`
+
+#### Defined in
+
+[types.ts:310](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L310)

package/docs/types/interfaces/Withdrawal.md

@@ -0,0 +1,147 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / Withdrawal
+
+# Interface: Withdrawal
+
+An object representing a withdrawal transaction
+
+## Extends
+
+- `BeneficiaryFields`.[`Transaction`](Transaction.md)
+
+## Properties
+
+### agent
+
+> **agent**: [`Agent`](Agent.md)
+
+#### Inherited from
+
+[`Transaction`](Transaction.md).[`agent`](Transaction.md#agent)
+
+#### Defined in
+
+[types.ts:522](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L522)
+
+***
+
+### amountDecimal
+
+> **amountDecimal**: `number`
+
+#### Inherited from
+
+[`Transaction`](Transaction.md).[`amountDecimal`](Transaction.md#amountdecimal)
+
+#### Defined in
+
+[types.ts:525](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L525)
+
+***
+
+### asset
+
+> **asset**: `string`
+
+#### Inherited from
+
+[`Transaction`](Transaction.md).[`asset`](Transaction.md#asset)
+
+#### 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`
+
+#### Inherited from
+
+[`Transaction`](Transaction.md).[`assetPrice`](Transaction.md#assetprice)
+
+#### Defined in
+
+[types.ts:527](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L527)
+
+***
+
+### counterparty
+
+> **counterparty**: [`Counterparty`](Counterparty.md)
+
+#### Inherited from
+
+[`Transaction`](Transaction.md).[`counterparty`](Transaction.md#counterparty)
+
+#### 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
+
+[`Transaction`](Transaction.md).[`customer`](Transaction.md#customer)
+
+#### Defined in
+
+[types.ts:495](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L495)
+
+***
+
+### destination?
+
+> `optional` **destination**: `string`
+
+#### Inherited from
+
+`BeneficiaryFields.destination`
+
+#### Defined in
+
+[types.ts:460](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L460)
+
+***
+
+### proof?
+
+> `optional` **proof**: [`OwnershipProof`](OwnershipProof.md)
+
+#### Inherited from
+
+[`Transaction`](Transaction.md).[`proof`](Transaction.md#proof)
+
+#### 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
+
+[`Transaction`](Transaction.md).[`requestId`](Transaction.md#requestid)
+
+#### Defined in
+
+[types.ts:494](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L494)

package/docs/types/type-aliases/BlockchainAddress.md

@@ -0,0 +1,36 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / BlockchainAddress
+
+# Type Alias: BlockchainAddress
+
+> **BlockchainAddress**: `string`
+
+A native blockchain address string
+
+## Remarks
+
+Represents a blockchain address in the native format specific to a particular chain.
+This could be an Ethereum address, Bitcoin address, or other chain-specific format.
+The address format and validation rules depend on the underlying blockchain.
+
+## Examples
+
+```ts
+"0x742d35Cc6634C0532925a3b844Bc454e4438f44e" // Ethereum address
+```
+
+```ts
+"1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa" // Bitcoin address
+```
+
+```ts
+"cosmos1t2uflqwqe0fsj0shcfkrvpukewcw40yjj6hdc0" // Cosmos address
+@public
+```
+
+## Defined in
+
+[types.ts:166](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L166)

package/docs/types/type-aliases/CAIP10.md

@@ -0,0 +1,39 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / CAIP10
+
+# Type Alias: CAIP10
+
+> **CAIP10**: \`$\{CAIP2\}:$\{string\}\`
+
+Chain Agnostic Account Identifier (CAIP-10)
+Represents an account/address on a specific blockchain following the CAIP-10 specification.
+Extends CAIP-2 by adding the account address specific to that chain.
+
+Format: `{caip2}:{address}`
+- caip2: The CAIP-2 chain identifier (e.g. 'eip155:1')
+- address: Chain-specific account address format
+
+## Examples
+
+```ts
+"eip155:1:0x742d35Cc6634C0532925a3b844Bc454e4438f44e" // Ethereum account on mainnet
+```
+
+```ts
+"bip122:000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f:128Lkh3S7CkDTBZ8W7BbpsN3YYizJMp8p6" // Bitcoin account on mainnet
+```
+
+```ts
+"cosmos:cosmoshub-3:cosmos1t2uflqwqe0fsj0shcfkrvpukewcw40yjj6hdc0" // Cosmos account
+```
+
+## See
+
+[CAIP-10 Specification](https://github.com/ChainAgnostic/CAIPs/blob/master/CAIPs/caip-10.md)
+
+## Defined in
+
+[types.ts:73](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L73)

package/docs/types/type-aliases/CAIP19.md

@@ -0,0 +1,40 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / CAIP19
+
+# Type Alias: CAIP19
+
+> **CAIP19**: \`$\{CAIP2\}/$\{string\}:$\{string\}\`
+
+Chain Agnostic Asset Identifier (CAIP-19)
+Represents an asset/token on a specific blockchain following the CAIP-19 specification.
+Extends CAIP-2 by adding asset type and identifier information.
+
+Format: `{caip2}/{asset_namespace}:{asset_reference}`
+- caip2: The CAIP-2 chain identifier (e.g. 'eip155:1')
+- asset_namespace: The asset standard (e.g. 'erc20', 'erc721', 'slip44')
+- asset_reference: Chain/standard-specific asset identifier
+
+## Examples
+
+```ts
+"eip155:1/erc20:0x6b175474e89094c44da98b954eedeac495271d0f" // DAI token on Ethereum mainnet
+```
+
+```ts
+"eip155:1/erc721:0x06012c8cf97BEaD5deAe237070F9587f8E7A266d" // CryptoKitties NFT contract
+```
+
+```ts
+"cosmos:cosmoshub-3/slip44:118" // ATOM token on Cosmos Hub
+```
+
+## See
+
+[CAIP-19 Specification](https://github.com/ChainAgnostic/CAIPs/blob/master/CAIPs/caip-19.md)
+
+## Defined in
+
+[types.ts:91](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L91)

package/docs/types/type-aliases/CAIP2.md

@@ -0,0 +1,39 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / CAIP2
+
+# Type Alias: CAIP2
+
+> **CAIP2**: \`$\{string\}:$\{string\}\`
+
+Chain Agnostic Blockchain Identifier (CAIP-2)
+Represents a blockchain in a chain-agnostic way following the CAIP-2 specification.
+The identifier consists of a namespace and reference separated by a colon.
+
+Format: `namespace:reference`
+- namespace: Represents the blockchain namespace (e.g. 'eip155', 'bip122', 'cosmos')
+- reference: Chain-specific identifier within that namespace
+
+## Examples
+
+```ts
+"eip155:1" // Ethereum Mainnet
+```
+
+```ts
+"bip122:000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f" // Bitcoin Mainnet
+```
+
+```ts
+"cosmos:cosmoshub-3" // Cosmos Hub Mainnet
+```
+
+## See
+
+[CAIP-2 Specification](https://github.com/ChainAgnostic/CAIPs/blob/master/CAIPs/caip-2.md)
+
+## Defined in
+
+[types.ts:56](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L56)

package/docs/types/type-aliases/CAIP220.md

@@ -0,0 +1,15 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / CAIP220
+
+# Type Alias: CAIP220
+
+> **CAIP220**: `string`
+
+Chain Agnostic Payload Identifier
+
+## Defined in
+
+[types.ts:97](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L97)

package/docs/types/type-aliases/Cancel.md

@@ -0,0 +1,23 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / Cancel
+
+# Type Alias: Cancel
+
+> **Cancel**: `object`
+
+**`Internal`**
+
+Represents a cancel component message
+
+## Type declaration
+
+### type
+
+> **type**: [`CANCEL`](../enumerations/CMType.md#cancel)
+
+## Defined in
+
+[types.ts:826](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L826)

package/docs/types/type-aliases/Completed.md

@@ -0,0 +1,35 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / Completed
+
+# Type Alias: Completed\<T\>
+
+> **Completed**\<`T`\>: `object`
+
+Represents a completed component message
+
+## Type Parameters
+
+• **T**
+
+The overall Value type being returned
+
+## Type declaration
+
+### response
+
+> **response**: [`TransactionResponse`](../interfaces/TransactionResponse.md)\<`T`\>
+
+### type
+
+> **type**: [`COMPLETE`](../enumerations/CMType.md#complete)
+
+## Param
+
+The Response object which wraps T
+
+## Defined in
+
+[types.ts:790](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L790)

package/docs/types/type-aliases/ComponentMessage.md

@@ -0,0 +1,41 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / ComponentMessage
+
+# Type Alias: ComponentMessage\<T\>
+
+> **ComponentMessage**\<`T`\>: [`Completed`](Completed.md)\<`T`\> \| [`Cancel`](Cancel.md) \| [`Error`](Error.md) \| [`Ready`](Ready.md) \| [`ResizeRequest`](ResizeRequest.md) \| [`InvalidValue`](InvalidValue.md)\<`T`\>
+
+Union type representing all possible messages that can be sent from a component
+
+## Type Parameters
+
+• **T**
+
+The value type that will be returned in Completed messages
+
+## Remarks
+
+Components communicate their state and results back to the host application
+through these message types:
+- Completed: Operation finished successfully with response data
+- Cancel: User cancelled the operation
+- Error: Operation failed with error message
+- Ready: Component initialized and ready for use
+- ResizeRequest: Component needs to adjust its dimensions
+- InvalidValue: Validation failed with current partial value
+
+## See
+
+ - [Completed](Completed.md) For successful completion message format
+ - [Cancel](Cancel.md) For cancellation message format
+ - [Error](Error.md) For error message format
+ - [Ready](Ready.md) For ready message format
+ - [ResizeRequest](ResizeRequest.md) For resize message format
+ - [InvalidValue](InvalidValue.md) For validation failure message format
+
+## Defined in
+
+[types.ts:866](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L866)

package/docs/types/type-aliases/ConnectionOptions.md

@@ -0,0 +1,15 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / ConnectionOptions
+
+# Type Alias: ConnectionOptions
+
+> **ConnectionOptions**: `Omit`\<[`TransactionOptions`](../interfaces/TransactionOptions.md), `"allowedAgentTypes"` \| `"allowedCounterpartyTypes"` \| `"vasps"` \| `"fields"` \| `"hide"`\>
+
+An object representing options for a Connection Request
+
+## Defined in
+
+[types.ts:574](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L574)

package/docs/types/type-aliases/CryptoCredential.md

@@ -0,0 +1,15 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / CryptoCredential
+
+# Type Alias: CryptoCredential
+
+> **CryptoCredential**: \`$\{string\}.$\{string\}.mastercard\`
+
+A crypto credential
+
+## Defined in
+
+[types.ts:191](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L191)

package/docs/types/type-aliases/DID.md

@@ -0,0 +1,15 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / DID
+
+# Type Alias: DID
+
+> **DID**: \`did:$\{string\}:$\{string\}\`
+
+A Decentralized Identifier
+
+## Defined in
+
+[types.ts:219](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L219)

package/docs/types/type-aliases/DTI.md

@@ -0,0 +1,38 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / DTI
+
+# Type Alias: DTI
+
+> **DTI**: `string`
+
+Digital Token Identifier (DTI) following ISO 24165 standard
+
+## Remarks
+
+A standardized identifier for digital assets and cryptocurrencies. The DTI system
+provides unique and unambiguous identification of digital tokens, supporting interoperability
+and clarity in financial markets.
+
+Format: `DTI[NNNNN]` where N is a digit
+
+## Examples
+
+```ts
+"DTI00001" // Example DTI for Bitcoin
+```
+
+```ts
+"DTI00002" // Example DTI for Ethereum
+```
+
+## See
+
+ - [Digital Token Identifier Foundation](https://dtif.org/)
+ - [ISO 24165](https://www.iso.org/standard/77895.html)
+
+## Defined in
+
+[types.ts:117](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L117)

package/docs/types/type-aliases/Destination.md

@@ -0,0 +1,15 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / Destination
+
+# Type Alias: Destination
+
+> **Destination**: [`BlockchainAddress`](BlockchainAddress.md) \| [`CAIP10`](CAIP10.md) \| [`CryptoCredential`](CryptoCredential.md) \| [`TravelAddress`](TravelAddress.md)
+
+The destination of a transaction either a blockchain address, a CAIP-19 address, or a travel address.
+
+## Defined in
+
+[types.ts:197](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L197)

package/docs/types/type-aliases/Error.md

@@ -0,0 +1,29 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / Error
+
+# Type Alias: Error
+
+> **Error**: `object`
+
+Represents an error component message
+
+## Type declaration
+
+### message
+
+> **message**: `string`
+
+### type
+
+> **type**: [`ERROR`](../enumerations/CMType.md#error)
+
+## Param
+
+Error message
+
+## Defined in
+
+[types.ts:817](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L817)

package/docs/types/type-aliases/FieldOptions.md

@@ -0,0 +1,15 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / FieldOptions
+
+# Type Alias: FieldOptions
+
+> **FieldOptions**: `boolean` \| `object`
+
+Field properties
+
+## Defined in
+
+[types.ts:686](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L686)