Skip to content
This repository has been archived by the owner on Jul 19, 2021. It is now read-only.

Latest commit

 

History

History
58 lines (41 loc) · 2.31 KB

swifttx.md

File metadata and controls

58 lines (41 loc) · 2.31 KB
Raw

##SwiftX Technical Information

SwiftX has been integrated into the Core Daemon in two ways:

  • "push" notifications (ZMQ and -swifttxnotify cmd-line/config option);
  • RPC commands.

####ZMQ

When a "Transaction Lock" occurs the hash of the related transaction is broadcasted through ZMQ using both the zmqpubrawtxlock and zmqpubhashtxlock channels.

  • zmqpubrawtxlock: publishes the raw transaction when locked via SwiftX
  • zmqpubhashtxlock: publishes the transaction hash when locked via SwiftX

This mechanism has been integrated into Bitcore-Node-Oasis which allows for notification to be broadcast through Insight API in one of two ways:

  • WebSocket:
  • API:

####Command line option

When a wallet SwiftX transaction is successfully locked a shell command provided in this option is executed (%s in <cmd> is replaced by TxID):

-swifttxnotify=<cmd>

####RPC

Details pertaining to an observed "Transaction Lock" can also be retrieved through RPC, it’s important however to understand the underlying mechanism.

By default, the Oasis Core daemon will launch using the following constant:

static const int DEFAULT_SWIFTTX_DEPTH = 5;

This value can be overridden by passing the following argument to the Oasis Core daemon:

-swifttxdepth=<n>

The key thing to understand is that this value indicates the number of "confirmations" a successful Transaction Lock represents. When Wallet RPC commands are performed (such as listsinceblock) this attribute is taken into account when returning information about the transaction. The value in confirmations field you see through RPC is showing the number of "Blockchain Confirmations" + "SwiftX Depth" (assuming the funds were sent via SwiftX).

There is also a field named bcconfirmations. The value in this field represents the total number of "Blockchain Confirmations" for a given transaction without taking into account whether it was SwiftX or not.

Examples

  • SwiftX transaction just occurred:
    • confirmations: 5
    • bcconfirmations: 0
  • SwiftX transaction received one confirmation from blockchain:
    • confirmations: 6
    • bcconfirmations: 1
  • non-SwiftX transaction just occurred:
    • confirmations: 0
    • bcconfirmations: 0
  • non-SwiftX transaction received one confirmation from blockchain:
    • confirmations: 1
    • bcconfirmations: 1