Common Structures

common-structures

The objects are in the request or response of multiple Komodo DeFi SDK methods have been grouped into the following sections:

• Activation Common Structures: Details on activation modes, parameters, and server configurations for various coin types.
• Enums: Enumerated values used across multiple methods, such as swap types, order statuses, and key policies.
• Lightning Common Structures: Objects for Lightning Network operations, including channel and payment configurations.
• NFT Common Structures: Structures for non-fungible token (NFT) operations, filters, and metadata.
• Order Common Structures: Structures for orderbook entries, order data, and related parameters.
• Swap Common Structures: Objects and events related to atomic swaps, including event types and swap status.
  • Maker Events: Step-by-step events and outcomes for atomic swaps from the maker's perspective.
  • Taker Events: Step-by-step events and outcomes for atomic swaps from the taker's perspective.
• Wallet Common Structures: Structures for wallet operations, address derivation, balances, and key management.

Structures which are used in more than one section are listed below:

EventStreamConfig

The EventStreamConfig object defines which events will be streamed to the client:

Configurable events, and how to enable them, is detailed in the streaming methods doc

An example of the event stream output can then be viewed in https://github.com/KomodoPlatform/komodo-defi-framework/blob/main/examples/sse/index.html?id=CLIENT_ID

The CLIENT_ID value used in the url must match the client_id value used when enabling streaming events. In the case of a single client only, defining the client_id is not required (it will default to 0).

{
    "access_control_allow_origin": "*",
    "worker_path": "index.js"
}

FilterCriteria

The 'FilterCriteria' object allows you to filter the results based on specific parameters.

{
  "filter": {
    "status": "completed",
    "date_from": "2024-01-01T00:00:00Z",
    "date_to": "2024-07-01T00:00:00Z",
    "my_coin": "BTC",
    "other_coin": "ETH",
    "from_timestamp": 1672531200,
    "to_timestamp": 1704067200
  }
}

FractionalValue

The FractionalValue object includes a numerator and denominator values for a given price or amount:

{
    "numer": "4561782244811",
    "denom": "4000000"
}

NumericFormatsValue

The NumericFormatsValue returns a price or amount in three different formats: fraction, rational, and decimal.

{
  "decimal": "0.0001",
  "rational": [
    [1, [1]],
    [1, [10000]]
  ],
  "fraction": {
    "numer": "1",
    "denom": "10000"
  }
}

PagingOptions

The PagingOptions object includes options of page selection to consult when looking for recent swaps:

{
  "paging_options": {
    "from_uuid": null,
    "limit": 10,
    "page_number": 1
  }
}

Pagination

For requests which return many results, pagination offsets may be applied. ** Use either value, not both. **

{
    "PageNumber": 1
}

{
    "FromId": 4
}

RationalValue

The Komodo DeFi SDK now offers the num-rational crate feature which allows for higher precision numeric values to represent order volumes and prices in a unique format as explained below:

[
  [1, [0, 1]],
  [1, [1]]
]

StreamingConfig

You can optionally apply more detailed configuration to event streaming methods.

{
    "stream_interval_seconds": 33.3
}

{
    "estimate_every": 33.3,
    "estimate_type": "Provider"
}

SyncStatus

SyncStatusExtended

{
    "sync_status": {
      "state": "NotStarted"
    }
}

{
    "sync_status": {
      "additional_info": {
        "transactions_left": 126
      },
      "state": "InProgress"
    }
}

{
    "sync_status": {
      "state": "Finished"
    }
}

WcConnNs

The WcConnNs object contains details of approved chains, methods and events while connected via WalletConnect.

{
	"chains": [
		"eip155:1",      // ETH
		"eip155:56",     // BNB
		"eip155:137",    // POLYGON
		"eip155:43114"   // AVAX
	],
	"methods": [
		"eth_sendTransaction",
		"eth_signTransaction",
		"personal_sign"
	],
	"events": [
		"accountsChanged",
		"chainChanged"
	]
}

{
	"chains": [
		"cosmos:cosmoshub-4",
		"cosmos:osmosis-1",
		"cosmos:irishub-1"
	],
	"methods": [
	  	"cosmos_signDirect",
		  "cosmos_signAmino",
		  "cosmos_getAccounts"
	],
	"events": []
}

WcSession

The WcSession object contains details of active WalletConnect sessions.

Within each session object, there are a some values which are required as input in other WalletConnect methods:

• pairing_topic: Only used when initally connecting with external wallets/dapps.
• topic: Once connected, this is use for communications with the connected external wallet/dapp.

ErrorResponse