Class MainchainInteroperabilityModule

Hierarchy

BaseInteroperabilityModule
- MainchainInteroperabilityModule

Index

Constructors

Properties

_crossChainUpdateCommand _messageRecoveryCommand _messageRecoveryInitializationCommand _sidechainRegistrationCommand _stateRecoveryCommand _terminateSidechainForLivenessCommand commands crossChainCommand crossChainMethod endpoint events internalMethod interoperableCCCommands interoperableCCMethods method offchainStores stores tokenMethod

Accessors

name

Constructors

constructor

new MainchainInteroperabilityModule(): MainchainInteroperabilityModule
Returns MainchainInteroperabilityModule
Inherited from BaseInteroperabilityModule.constructor
- Defined in framework/src/modules/interoperability/base_interoperability_module.ts:58

Properties

`Private` `Readonly` _crossChainUpdateCommand

_crossChainUpdateCommand: SubmitMainchainCrossChainUpdateCommand = ...

`Private` `Readonly` _messageRecoveryCommand

_messageRecoveryCommand: RecoverMessageCommand = ...

`Private` `Readonly` _messageRecoveryInitializationCommand

_messageRecoveryInitializationCommand: InitializeMessageRecoveryCommand = ...

`Private` `Readonly` _sidechainRegistrationCommand

_sidechainRegistrationCommand: RegisterSidechainCommand = ...

`Private` `Readonly` _stateRecoveryCommand

_stateRecoveryCommand: RecoverStateCommand = ...

`Private` `Readonly` _terminateSidechainForLivenessCommand

_terminateSidechainForLivenessCommand: TerminateSidechainForLivenessCommand = ...

commands

crossChainCommand

crossChainCommand: (MainchainCCChannelTerminatedCommand | MainchainCCRegistrationCommand)[] = ...

crossChainMethod

crossChainMethod: MainchainCCMethod = ...

endpoint

endpoint: MainchainInteroperabilityEndpoint = ...

events

events: NamedRegistry = ...

`Protected` internalMethod

internalMethod: MainchainInteroperabilityInternalMethod = ...

`Protected` interoperableCCCommands

interoperableCCCommands: Map<string, BaseCCCommand<unknown>[]> = ...

`Protected` interoperableCCMethods

interoperableCCMethods: Map<string, BaseCCMethod> = ...

method

method: MainchainInteroperabilityMethod = ...

offchainStores

offchainStores: NamedRegistry = ...

stores

stores: NamedRegistry = ...

`Protected` tokenMethod

tokenMethod: TokenMethod

Accessors

name

get name(): string
Returns string
Inherited from BaseInteroperabilityModule.name
- Defined in framework/src/modules/interoperability/base_interoperability_module.ts:94

Methods

`Private` _verifyChainData

_verifyChainData(ctx: GenesisBlockExecuteContext, chainInfo: ChainInfo, terminatedStateAccounts: TerminatedStateAccountWithChainID[]): void
Parameters
- ctx: GenesisBlockExecuteContext
- chainInfo: ChainInfo
- terminatedStateAccounts: TerminatedStateAccountWithChainID[]
Returns void
- Defined in framework/src/modules/interoperability/mainchain/module.ts:317

`Protected` _verifyChainID

_verifyChainID(chainID: Buffer, mainchainID: Buffer, prefix: string): void
Parameters
- chainID: Buffer
- mainchainID: Buffer
- prefix: string
Returns void
Inherited from BaseInteroperabilityModule._verifyChainID
- Defined in framework/src/modules/interoperability/base_interoperability_module.ts:177

`Private` _verifyChainInfos

_verifyChainInfos(ctx: GenesisBlockExecuteContext, chainInfos: ChainInfo[], terminatedStateAccounts: TerminatedStateAccountWithChainID[]): void
Parameters
- ctx: GenesisBlockExecuteContext
- chainInfos: ChainInfo[]
- terminatedStateAccounts: TerminatedStateAccountWithChainID[]
Returns void
- Defined in framework/src/modules/interoperability/mainchain/module.ts:284

`Protected` _verifyChainValidators

_verifyChainValidators(chainInfo: ChainInfo): void
Parameters
- chainInfo: ChainInfo
Returns void
Inherited from BaseInteroperabilityModule._verifyChainValidators
- Defined in framework/src/modules/interoperability/base_interoperability_module.ts:124

`Protected` _verifyChannelData

_verifyChannelData(ctx: GenesisBlockExecuteContext, chainInfo: ChainInfo): void
Parameters
- ctx: GenesisBlockExecuteContext
- chainInfo: ChainInfo
Returns void
Inherited from BaseInteroperabilityModule._verifyChannelData
- Defined in framework/src/modules/interoperability/base_interoperability_module.ts:105

`Private` _verifyTerminatedOutboxAccounts

_verifyTerminatedOutboxAccounts(_chainInfos: ChainInfo[], terminatedStateAccounts: TerminatedStateAccountWithChainID[], terminatedOutboxAccounts: TerminatedOutboxAccountWithChainID[]): void
Parameters
- _chainInfos: ChainInfo[]
- terminatedStateAccounts: TerminatedStateAccountWithChainID[]
- terminatedOutboxAccounts: TerminatedOutboxAccountWithChainID[]
Returns void
- Defined in framework/src/modules/interoperability/mainchain/module.ts:404

`Private` _verifyTerminatedStateAccounts

_verifyTerminatedStateAccounts(chainInfos: ChainInfo[], terminatedStateAccounts: TerminatedStateAccountWithChainID[], mainchainID: Buffer): void
Parameters
- chainInfos: ChainInfo[]
- terminatedStateAccounts: TerminatedStateAccountWithChainID[]
- mainchainID: Buffer
Returns void
- Defined in framework/src/modules/interoperability/mainchain/module.ts:354

`Protected` _verifyTerminatedStateAccountsIDs

_verifyTerminatedStateAccountsIDs(chainIDs: Buffer[]): void
Parameters
- chainIDs: Buffer[]
Returns void
Inherited from BaseInteroperabilityModule._verifyTerminatedStateAccountsIDs
- Defined in framework/src/modules/interoperability/base_interoperability_module.ts:189

addDependencies

addDependencies(tokenMethod: TokenMethod, feeMethod: FeeMethod): void
Parameters
- tokenMethod: TokenMethod
- feeMethod: FeeMethod
Returns void
- Defined in framework/src/modules/interoperability/mainchain/module.ts:153

`Optional` afterCommandExecute

afterCommandExecute(context: TransactionExecuteContext): Promise<void>
Parameters
- context: TransactionExecuteContext
Returns Promise<void>
Inherited from BaseInteroperabilityModule.afterCommandExecute
- Defined in framework/src/modules/base_module.ts:83

`Optional` afterTransactionsExecute

afterTransactionsExecute(context: BlockAfterExecuteContext): Promise<void>
Parameters
- context: BlockAfterExecuteContext
Returns Promise<void>
Inherited from BaseInteroperabilityModule.afterTransactionsExecute
- Defined in framework/src/modules/base_module.ts:87

`Protected` baseMetadata

baseMetadata(): {
    assets: never[];
    commands: {
        name: string;
        params: Schema;
    }[];
    endpoints: never[];
    events: {
        data: Schema;
        name: string;
    }[];
    stores: {
        data: Schema;
        key: string;
    }[];
}
Returns {
    assets: never[];
    commands: {
        name: string;
        params: Schema;
    }[];
    endpoints: never[];
    events: {
        data: Schema;
        name: string;
    }[];
    stores: {
        data: Schema;
        key: string;
    }[];
}
- assets: never[]
- commands: {
  name: string;
  params: Schema;
  }[]
- endpoints: never[]
- events: {
  data: Schema;
  name: string;
  }[]
- stores: {
  data: Schema;
  key: string;
  }[]
Inherited from BaseInteroperabilityModule.baseMetadata
- Defined in framework/src/modules/base_module.ts:91

`Optional` beforeCommandExecute

beforeCommandExecute(context: TransactionExecuteContext): Promise<void>
Parameters
- context: TransactionExecuteContext
Returns Promise<void>
Inherited from BaseInteroperabilityModule.beforeCommandExecute
- Defined in framework/src/modules/base_module.ts:82

`Optional` beforeTransactionsExecute

beforeTransactionsExecute(context: BlockExecuteContext): Promise<void>
Parameters
- context: BlockExecuteContext
Returns Promise<void>
Inherited from BaseInteroperabilityModule.beforeTransactionsExecute
- Defined in framework/src/modules/base_module.ts:86

`Optional` finalizeGenesisState

finalizeGenesisState(ctx: GenesisBlockExecuteContext): Promise<void>
Parameters
- ctx: GenesisBlockExecuteContext
Returns Promise<void>
Inherited from BaseInteroperabilityModule.finalizeGenesisState
- Defined in framework/src/modules/interoperability/base_interoperability_module.ts:273

`Optional` init

init(args: ModuleInitArgs): Promise<void>
Parameters
- args: ModuleInitArgs
Returns Promise<void>
Inherited from BaseInteroperabilityModule.init
- Defined in framework/src/modules/base_module.ts:78

initGenesisState

initGenesisState(ctx: GenesisBlockExecuteContext): Promise<void>
Parameters
- ctx: GenesisBlockExecuteContext
Returns Promise<void>
Overrides BaseInteroperabilityModule.initGenesisState
- Defined in framework/src/modules/interoperability/mainchain/module.ts:232

`Optional` insertAssets

insertAssets(context: InsertAssetContext): Promise<void>
Parameters
- context: InsertAssetContext
Returns Promise<void>
Inherited from BaseInteroperabilityModule.insertAssets
- Defined in framework/src/modules/base_module.ts:79

metadata

metadata(): ModuleMetadata
Returns ModuleMetadata
Overrides BaseInteroperabilityModule.metadata
- Defined in framework/src/modules/interoperability/mainchain/module.ts:160

processGenesisState

processGenesisState(ctx: GenesisBlockExecuteContext, genesisInteroperability: GenesisInteroperability): Promise<void>
Parameters
- ctx: GenesisBlockExecuteContext
- genesisInteroperability: GenesisInteroperability
Returns Promise<void>
Overrides BaseInteroperabilityModule.processGenesisState
- Defined in framework/src/modules/interoperability/mainchain/module.ts:436

registerInteroperableModule

registerInteroperableModule(module: BaseInteroperableModule): void
Parameters
- module: BaseInteroperableModule
Returns void
Inherited from BaseInteroperabilityModule.registerInteroperableModule
- Defined in framework/src/modules/interoperability/base_interoperability_module.ts:98

`Optional` verifyAssets

verifyAssets(context: BlockVerifyContext): Promise<void>
Parameters
- context: BlockVerifyContext
Returns Promise<void>
Inherited from BaseInteroperabilityModule.verifyAssets
- Defined in framework/src/modules/base_module.ts:80

`Optional` verifyTransaction

verifyTransaction(context: TransactionVerifyContext): Promise<VerificationResult>
Parameters
- context: TransactionVerifyContext
Returns Promise<VerificationResult>
Inherited from BaseInteroperabilityModule.verifyTransaction
- Defined in framework/src/modules/base_module.ts:81

Class MainchainInteroperabilityModule

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns MainchainInteroperabilityModule

Properties

Private Readonly _crossChainUpdateCommand

Private Readonly _messageRecoveryCommand

Private Readonly _messageRecoveryInitializationCommand

Private Readonly _sidechainRegistrationCommand

Private Readonly _stateRecoveryCommand

Private Readonly _terminateSidechainForLivenessCommand

commands

crossChainCommand

crossChainMethod

endpoint

events

Protected internalMethod

Protected interoperableCCCommands

Protected interoperableCCMethods

method

offchainStores

stores

Protected tokenMethod

Accessors

name

Returns string

Methods

Private _verifyChainData

Parameters

ctx: GenesisBlockExecuteContext

chainInfo: ChainInfo

terminatedStateAccounts: TerminatedStateAccountWithChainID[]

Returns void

Protected _verifyChainID

Parameters

chainID: Buffer

mainchainID: Buffer

prefix: string

Returns void

Private _verifyChainInfos

Parameters

ctx: GenesisBlockExecuteContext

chainInfos: ChainInfo[]

terminatedStateAccounts: TerminatedStateAccountWithChainID[]

Returns void

Protected _verifyChainValidators

Parameters

chainInfo: ChainInfo

Returns void

Protected _verifyChannelData

Parameters

ctx: GenesisBlockExecuteContext

chainInfo: ChainInfo

Returns void

Private _verifyTerminatedOutboxAccounts

Parameters

_chainInfos: ChainInfo[]

terminatedStateAccounts: TerminatedStateAccountWithChainID[]

terminatedOutboxAccounts: TerminatedOutboxAccountWithChainID[]

Returns void

Private _verifyTerminatedStateAccounts

Parameters

chainInfos: ChainInfo[]

terminatedStateAccounts: TerminatedStateAccountWithChainID[]

mainchainID: Buffer

Returns void

Protected _verifyTerminatedStateAccountsIDs

Parameters

chainIDs: Buffer[]

Returns void

addDependencies

Parameters

tokenMethod: TokenMethod

feeMethod: FeeMethod

`Private` `Readonly` _crossChainUpdateCommand

`Private` `Readonly` _messageRecoveryCommand

`Private` `Readonly` _messageRecoveryInitializationCommand

`Private` `Readonly` _sidechainRegistrationCommand

`Private` `Readonly` _stateRecoveryCommand

`Private` `Readonly` _terminateSidechainForLivenessCommand

`Protected` internalMethod

`Protected` interoperableCCCommands

`Protected` interoperableCCMethods

`Protected` tokenMethod

`Private` _verifyChainData

`Protected` _verifyChainID

`Private` _verifyChainInfos

`Protected` _verifyChainValidators

`Protected` _verifyChannelData

`Private` _verifyTerminatedOutboxAccounts

`Private` _verifyTerminatedStateAccounts

`Protected` _verifyTerminatedStateAccountsIDs

`Optional` afterCommandExecute

`Optional` afterTransactionsExecute

`Protected` baseMetadata

Returns {
assets: never[];
commands: {
name: string;
params: Schema;
}[];
endpoints: never[];
events: {
data: Schema;
name: string;
}[];
stores: {
data: Schema;
key: string;
}[];
}

commands: {
name: string;
params: Schema;
}[]

events: {
data: Schema;
name: string;
}[]

stores: {
data: Schema;
key: string;
}[]

`Optional` beforeCommandExecute

`Optional` beforeTransactionsExecute

`Optional` finalizeGenesisState

`Optional` init

`Optional` insertAssets

`Optional` verifyAssets

`Optional` verifyTransaction