Categorygithub.com/proximax-storage/go-xpx-chain-sync
modulepackage
1.1.4
Repository: https://github.com/proximax-storage/go-xpx-chain-sync.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
11
Dependents
5
Files
891 SLOC

# README

Catapult SDK Transaction Syncer

Utility repository for Catapult SDK which allow announcing transactions synchronously.

TODOS:

  1. Add examples
  2. Improve testing coverage
  3. Add errors
  4. Better Readme
  5. FIX code TODOS
  6. Logging?

# Functions

Announce announces transaction, waits till it confirmed and returns hash or error if any.
AnnounceFullSync fully synchronise work with Syncer and handles all the incoming Results Also it is a reference on how to handle Results for different manipulation and for any kind of business logic.
AnnounceFullSyncMany announces and waits till success or error for every transaction returns slices of hashes and errors with results of announcing.
AnnounceMany announces transactions, waits till they all confirmed and returns hashes or error for every.
WSTimeout option specifies.
No description provided by the author
No description provided by the author
No description provided by the author
NewTransactionSyncer creates new instance of TransactionSyncer.
No description provided by the author
WithHttpClient option configures Catapult SDK client to work with passed one.
No description provided by the author
No description provided by the author
WSTimeout option specifies websocket connection timeout on start-up.

# Variables

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Change those values if needed depending on the catapult version and used consensus.
Change those values if needed depending on the catapult version and used consensus.

# Structs

No description provided by the author
AnnounceResult is a struct which defines result of announcing txn.
ConfirmationResult is a struct which shows result of transaction confirmation.
No description provided by the author
No description provided by the author

# Interfaces

Result interface is a result of transaction manipulation.
No description provided by the author

# Type aliases

No description provided by the author
Option types.