0.0.7 • Published 2 years ago

flare-mcc v0.0.7

Weekly downloads
-
License
MIT
Repository
-
Last release
2 years ago

Multi chain client

Welcome to version 0 of MCC

Naming convention

For types

  1. We use CamelCase
  2. We start with uppercase letter
  3. For abbreviation we only use only use uppercase for first letter UseBTC -> UseBtc

We name interfaces as following:

  1. For method responses
I<ChainAssetName><MethodName>Res
For example:
IUtxoGetTransactionRes
  1. For method inputs
I<ChainAssetName><MethodName>
For example:
IUtxoGetTransaction
  1. For specific parts of method inputs (for example Vin For Utxo transaction creation)
II<ChainAssetName><MethodName>
For example:
IIUtxoVin
  1. For general Data Types
I<ChainAssetName><DataType>
For example:
IUtxoScriptPubKey

To use this with attestor client

  1. Make sure this repo and attester-client repo are in the same root
  2. If you make changes to MCC make sure to rebuild it yarn build
  3. Rebuild the local dependency in attester client with yarn install --force