Class ChainConnectorPlugin

Hierarchy

  • BasePlugin<ChainConnectorPluginConfig>
    • ChainConnectorPlugin

Constructors

constructor

Properties

_ccuFrequency _ccuSaveLimit _chainConnectorPluginDB _chainConnectorStore _isReceivingChainMainchain _isSaveCCU _lastCertificate _maxCCUSize _ownChainID _receivingChainClient _receivingChainID _registrationHeight _sendingChainClient configSchema endpoint logger

Accessors

apiClient appConfig config dataPath events name nodeModulePath

Methods

_cleanup _computeCCUParams _deleteBlockHandler _findNextCertificate _initializeReceivingChainClient _newBlockHandler _saveDataOnNewBlock _submitCCU init load unload

Constructors

constructor

Properties

Private _ccuFrequency

_ccuFrequency: number

Private _ccuSaveLimit

_ccuSaveLimit: number

Private _chainConnectorPluginDB

_chainConnectorPluginDB: Database

Private _chainConnectorStore

_chainConnectorStore: ChainConnectorStore

Private _isReceivingChainMainchain

_isReceivingChainMainchain: boolean

Private _isSaveCCU

_isSaveCCU: boolean

Private _lastCertificate

_lastCertificate: LastCertificate

Private _maxCCUSize

_maxCCUSize: number

Private _ownChainID

_ownChainID: Buffer

Private _receivingChainClient

_receivingChainClient: APIClient

Private _receivingChainID

_receivingChainID: Buffer

Private _registrationHeight

_registrationHeight: number

Private _sendingChainClient

_sendingChainClient: APIClient

configSchema

configSchema: {
    $id: string;
    default: {
        ccuFrequency: number;
        ccuSaveLimit: number;
        isSaveCCU: boolean;
        maxCCUSize: number;
        registrationHeight: number;
    };
    properties: {
        ccuFee: {
            description: string;
            format: string;
            type: string;
        };
        ccuFrequency: {
            description: string;
            type: string;
        };
        ccuSaveLimit: {
            description: string;
            minimum: number;
            type: string;
        };
        encryptedPrivateKey: {
            description: string;
            type: string;
        };
        isSaveCCU: {
            description: string;
            type: string;
        };
        maxCCUSize: {
            description: string;
            maximum: number;
            minimum: number;
            type: string;
        };
        receivingChainID: {
            description: string;
            type: string;
        };
        receivingChainIPCPath: {
            description: string;
            type: string;
        };
        receivingChainWsURL: {
            description: string;
            type: string;
        };
        registrationHeight: {
            description: string;
            minimum: number;
            type: string;
        };
    };
    required: string[];
    type: string;
} = configSchema

Type declaration

  • $id: string
  • default: {
        ccuFrequency: number;
        ccuSaveLimit: number;
        isSaveCCU: boolean;
        maxCCUSize: number;
        registrationHeight: number;
    }
    • ccuFrequency: number
    • ccuSaveLimit: number
    • isSaveCCU: boolean
    • maxCCUSize: number
    • registrationHeight: number
  • properties: {
        ccuFee: {
            description: string;
            format: string;
            type: string;
        };
        ccuFrequency: {
            description: string;
            type: string;
        };
        ccuSaveLimit: {
            description: string;
            minimum: number;
            type: string;
        };
        encryptedPrivateKey: {
            description: string;
            type: string;
        };
        isSaveCCU: {
            description: string;
            type: string;
        };
        maxCCUSize: {
            description: string;
            maximum: number;
            minimum: number;
            type: string;
        };
        receivingChainID: {
            description: string;
            type: string;
        };
        receivingChainIPCPath: {
            description: string;
            type: string;
        };
        receivingChainWsURL: {
            description: string;
            type: string;
        };
        registrationHeight: {
            description: string;
            minimum: number;
            type: string;
        };
    }
    • ccuFee: {
          description: string;
          format: string;
          type: string;
      }
      • description: string
      • format: string
      • type: string
    • ccuFrequency: {
          description: string;
          type: string;
      }
      • description: string
      • type: string
    • ccuSaveLimit: {
          description: string;
          minimum: number;
          type: string;
      }
      • description: string
      • minimum: number
      • type: string
    • encryptedPrivateKey: {
          description: string;
          type: string;
      }
      • description: string
      • type: string
    • isSaveCCU: {
          description: string;
          type: string;
      }
      • description: string
      • type: string
    • maxCCUSize: {
          description: string;
          maximum: number;
          minimum: number;
          type: string;
      }
      • description: string
      • maximum: number
      • minimum: number
      • type: string
    • receivingChainID: {
          description: string;
          type: string;
      }
      • description: string
      • type: string
    • receivingChainIPCPath: {
          description: string;
          type: string;
      }
      • description: string
      • type: string
    • receivingChainWsURL: {
          description: string;
          type: string;
      }
      • description: string
      • type: string
    • registrationHeight: {
          description: string;
          minimum: number;
          type: string;
      }
      • description: string
      • minimum: number
      • type: string
  • required: string[]
  • type: string

endpoint

endpoint: Endpoint = ...

Protected logger

logger: Logger

Accessors

apiClient

  • get apiClient(): APIClient

  • Returns APIClient

appConfig

  • get appConfig(): ApplicationConfigForPlugin

  • Returns ApplicationConfigForPlugin

config

  • get config(): T

  • Returns T

dataPath

  • get dataPath(): string

  • Returns string

events

  • get events(): string[]

  • Returns string[]

name

  • get name(): string

  • Returns string

nodeModulePath

Methods

Private _cleanup

Private _computeCCUParams

  • _computeCCUParams(blockHeaders: BlockHeader[], aggregateCommits: AggregateCommit[], validatorsHashPreimage: ValidatorsData[], ccmsFromEvents: CCMsFromEvents[]): Promise<undefined | {
        ccuParams: CrossChainUpdateTransactionParams;
        lastCCMToBeSent: undefined | LastSentCCMWithHeight;
    }>

  • See

    https://github.com/LiskHQ/lips/blob/main/proposals/lip-0053.md#cross-chain-update-transaction-properties This function computes CCU params especially, certificate, activeValidatorsUpdate and inboxUpdate

    • Uses either lastCertificate or newCertificate
    • When lastCertificate, it only computes pending CCMs if any else it skips CCU creation
    • When newCertificate it computes certificate, activeValidatorsUpdate and inboxUpdate

    Parameters

    • blockHeaders: BlockHeader[]
    • aggregateCommits: AggregateCommit[]
    • validatorsHashPreimage: ValidatorsData[]
    • ccmsFromEvents: CCMsFromEvents[]

    Returns Promise<undefined | {
        ccuParams: CrossChainUpdateTransactionParams;
        lastCCMToBeSent: undefined | LastSentCCMWithHeight;
    }>

Private _deleteBlockHandler

Private _findNextCertificate

Private _initializeReceivingChainClient

Private _newBlockHandler

Private _saveDataOnNewBlock

  • _saveDataOnNewBlock(newBlockHeader: BlockHeader): Promise<{
        aggregateCommits: AggregateCommit[];
        blockHeaders: BlockHeader[];
        crossChainMessages: CCMsFromEvents[];
        validatorsHashPreimage: ValidatorsData[];
    }>

  • This function saves block header, aggregateCommit, validatorsHashPreimage and crossChainMessages for a new block

    Parameters

    • newBlockHeader: BlockHeader

    Returns Promise<{
        aggregateCommits: AggregateCommit[];
        blockHeaders: BlockHeader[];
        crossChainMessages: CCMsFromEvents[];
        validatorsHashPreimage: ValidatorsData[];
    }>

Private _submitCCU

init

load

unload

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc