Class SidechainInteroperabilityMethod

Hierarchy

BaseInteroperabilityMethod<SidechainInteroperabilityInternalMethod>
- SidechainInteroperabilityMethod

Index

Constructors

Properties

_tokenMethod events internalMethod interoperableCCMethods stores

Methods

addDependencies error getChainAccount getChannel getMessageFeeTokenID getMessageFeeTokenIDFromCCM getMinReturnFeePerByte getOwnChainAccount getTerminatedOutboxAccount getTerminatedStateAccount isChannelActive send terminateChain

Constructors

constructor

new SidechainInteroperabilityMethod(stores: NamedRegistry, events: NamedRegistry, interoperableCCMethods?: Map<string, BaseCCMethod>, internalMethod: SidechainInteroperabilityInternalMethod): SidechainInteroperabilityMethod
Parameters
- stores: NamedRegistry
- events: NamedRegistry
- interoperableCCMethods: Map<string, BaseCCMethod> = ...
- internalMethod: SidechainInteroperabilityInternalMethod
Returns SidechainInteroperabilityMethod
Inherited from BaseInteroperabilityMethod<SidechainInteroperabilityInternalMethod>.constructor
- Defined in framework/src/modules/interoperability/base_interoperability_method.ts:49

Properties

`Protected` _tokenMethod

_tokenMethod: TokenMethod & {
payMessageFee: ((context: MethodContext, payFromAddress: Buffer, fee: bigint, receivingChainID: Buffer) => Promise<void>);
}

`Protected` events

events: NamedRegistry

`Protected` internalMethod

internalMethod: SidechainInteroperabilityInternalMethod

`Protected` `Readonly` interoperableCCMethods

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

`Protected` stores

stores: NamedRegistry

Methods

addDependencies

addDependencies(tokenMethod: TokenMethod & {
payMessageFee: ((context: MethodContext, payFromAddress: Buffer, fee: bigint, receivingChainID: Buffer) => Promise<void>);
}): void
Parameters
- tokenMethod: TokenMethod & {
  payMessageFee: ((context: MethodContext, payFromAddress: Buffer, fee: bigint, receivingChainID: Buffer) => Promise<void>);
  }
Returns void
Inherited from BaseInteroperabilityMethod.addDependencies
- Defined in framework/src/modules/interoperability/base_interoperability_method.ts:58

error

error(context: MethodContext, ccm: CCMsg, errorStatus: number): Promise<void>
Parameters
- context: MethodContext
- ccm: CCMsg
- errorStatus: number
Returns Promise<void>
Inherited from BaseInteroperabilityMethod.error
- Defined in framework/src/modules/interoperability/base_interoperability_method.ts:169

getChainAccount

getChainAccount(context: ImmutableMethodContext, chainID: Buffer): Promise<ChainAccount>
Parameters
- context: ImmutableMethodContext
- chainID: Buffer
Returns Promise<ChainAccount>
Inherited from BaseInteroperabilityMethod.getChainAccount
- Defined in framework/src/modules/interoperability/base_interoperability_method.ts:72

getChannel

getChannel(context: ImmutableMethodContext, chainID: Buffer): Promise<ChannelData>
Parameters
- context: ImmutableMethodContext
- chainID: Buffer
Returns Promise<ChannelData>
Inherited from BaseInteroperabilityMethod.getChannel
- Defined in framework/src/modules/interoperability/base_interoperability_method.ts:79

getMessageFeeTokenID

getMessageFeeTokenID(context: ImmutableMethodContext, chainID: Buffer): Promise<Buffer>
Parameters
- context: ImmutableMethodContext
- chainID: Buffer
Returns Promise<Buffer>
Inherited from BaseInteroperabilityMethod.getMessageFeeTokenID
- Defined in framework/src/modules/interoperability/base_interoperability_method.ts:118

getMessageFeeTokenIDFromCCM

getMessageFeeTokenIDFromCCM(context: ImmutableMethodContext, ccm: CCMsg): Promise<Buffer>
Parameters
- context: ImmutableMethodContext
- ccm: CCMsg
Returns Promise<Buffer>
Inherited from BaseInteroperabilityMethod.getMessageFeeTokenIDFromCCM
- Defined in framework/src/modules/interoperability/base_interoperability_method.ts:126

getMinReturnFeePerByte

getMinReturnFeePerByte(context: ImmutableMethodContext, chainID: Buffer): Promise<bigint>
Parameters
- context: ImmutableMethodContext
- chainID: Buffer
Returns Promise<bigint>
Inherited from BaseInteroperabilityMethod.getMinReturnFeePerByte
- Defined in framework/src/modules/interoperability/base_interoperability_method.ts:134

getOwnChainAccount

getOwnChainAccount(context: ImmutableMethodContext): Promise<OwnChainAccount>
Parameters
- context: ImmutableMethodContext
Returns Promise<OwnChainAccount>
Inherited from BaseInteroperabilityMethod.getOwnChainAccount
- Defined in framework/src/modules/interoperability/base_interoperability_method.ts:83

getTerminatedOutboxAccount

getTerminatedOutboxAccount(context: ImmutableMethodContext, chainID: Buffer): Promise<TerminatedOutboxAccount>
Parameters
- context: ImmutableMethodContext
- chainID: Buffer
Returns Promise<TerminatedOutboxAccount>
Inherited from BaseInteroperabilityMethod.getTerminatedOutboxAccount
- Defined in framework/src/modules/interoperability/base_interoperability_method.ts:91

getTerminatedStateAccount

getTerminatedStateAccount(context: ImmutableMethodContext, chainID: Buffer): Promise<TerminatedStateAccount>
Parameters
- context: ImmutableMethodContext
- chainID: Buffer
Returns Promise<TerminatedStateAccount>
Inherited from BaseInteroperabilityMethod.getTerminatedStateAccount
- Defined in framework/src/modules/interoperability/base_interoperability_method.ts:87

isChannelActive

isChannelActive(context: ImmutableMethodContext, chainID: Buffer): Promise<boolean>
Parameters
- context: ImmutableMethodContext
- chainID: Buffer
Returns Promise<boolean>
- Defined in framework/src/modules/interoperability/sidechain/method.ts:23

send

send(context: MethodContext, sendingAddress: Buffer, module: string, crossChainCommand: string, receivingChainID: Buffer, fee: bigint, params: Buffer, timestamp?: number): Promise<void>
Parameters
- context: MethodContext
- sendingAddress: Buffer
- module: string
- crossChainCommand: string
- receivingChainID: Buffer
- fee: bigint
- params: Buffer
- Optional timestamp: number
Returns Promise<void>
Inherited from BaseInteroperabilityMethod.send
- Defined in framework/src/modules/interoperability/base_interoperability_method.ts:144

terminateChain

terminateChain(context: MethodContext, chainID: Buffer): Promise<void>
Parameters
- context: MethodContext
- chainID: Buffer
Returns Promise<void>
Inherited from BaseInteroperabilityMethod.terminateChain
- Defined in framework/src/modules/interoperability/base_interoperability_method.ts:188

Class SidechainInteroperabilityMethod

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

stores: NamedRegistry

events: NamedRegistry

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

internalMethod: SidechainInteroperabilityInternalMethod

Returns SidechainInteroperabilityMethod

Properties

Protected _tokenMethod

Protected events

Protected internalMethod

Protected Readonly interoperableCCMethods

Protected stores

Methods

addDependencies

Parameters

tokenMethod: TokenMethod & { payMessageFee: ((context: MethodContext, payFromAddress: Buffer, fee: bigint, receivingChainID: Buffer) => Promise<void>); }

Returns void

error

Parameters

context: MethodContext

ccm: CCMsg

errorStatus: number

Returns Promise<void>

getChainAccount

Parameters

context: ImmutableMethodContext

chainID: Buffer

Returns Promise<ChainAccount>

getChannel

Parameters

context: ImmutableMethodContext

chainID: Buffer

Returns Promise<ChannelData>

getMessageFeeTokenID

Parameters

context: ImmutableMethodContext

chainID: Buffer

Returns Promise<Buffer>

getMessageFeeTokenIDFromCCM

Parameters

context: ImmutableMethodContext

ccm: CCMsg

Returns Promise<Buffer>

getMinReturnFeePerByte

Parameters

context: ImmutableMethodContext

chainID: Buffer

Returns Promise<bigint>

getOwnChainAccount

Parameters

context: ImmutableMethodContext

Returns Promise<OwnChainAccount>

getTerminatedOutboxAccount

Parameters

context: ImmutableMethodContext

chainID: Buffer

Returns Promise<TerminatedOutboxAccount>

getTerminatedStateAccount

Parameters

context: ImmutableMethodContext

chainID: Buffer

Returns Promise<TerminatedStateAccount>

isChannelActive

Parameters

context: ImmutableMethodContext

chainID: Buffer

Returns Promise<boolean>

send

Parameters

context: MethodContext

sendingAddress: Buffer

module: string

`Protected` _tokenMethod

`Protected` events

`Protected` internalMethod

`Protected` `Readonly` interoperableCCMethods

`Protected` stores

tokenMethod: TokenMethod & {
payMessageFee: ((context: MethodContext, payFromAddress: Buffer, fee: bigint, receivingChainID: Buffer) => Promise<void>);
}

`Optional` timestamp: number