Class UnlockCommand

Hierarchy

BaseCommand
- UnlockCommand

Index

Constructors

Properties

_posTokenID _punishmentLockingPeriods _roundLength _tokenMethod events schema stores

Accessors

Methods

addDependencies execute init verify?

Constructors

constructor

new UnlockCommand(stores: NamedRegistry, events: NamedRegistry): UnlockCommand
Parameters
- stores: NamedRegistry
- events: NamedRegistry
Returns UnlockCommand
Inherited from BaseCommand.constructor
- Defined in framework/src/modules/base_command.ts:29

Properties

`Private` _posTokenID

_posTokenID: Buffer

`Private` _punishmentLockingPeriods

_punishmentLockingPeriods: PunishmentLockingPeriods

`Private` _roundLength

_roundLength: number

`Private` _tokenMethod

_tokenMethod: TokenMethod

`Protected` events

events: NamedRegistry

schema

schema: Schema = emptySchema

`Protected` stores

stores: NamedRegistry

Accessors

name

get name(): string
Returns string
Inherited from BaseCommand.name
- Defined in framework/src/modules/base_command.ts:23

Methods

addDependencies

addDependencies(args: UnlockCommandDependencies): void
Parameters
- args: UnlockCommandDependencies
Returns void
- Defined in framework/src/modules/pos/commands/unlock.ts:35

execute

execute(context: CommandExecuteContext<undefined>): Promise<void>
Parameters
- context: CommandExecuteContext<undefined>
Returns Promise<void>
Overrides BaseCommand.execute
- Defined in framework/src/modules/pos/commands/unlock.ts:49

init

init(args: {
    posTokenID: Buffer;
    punishmentLockingPeriods: PunishmentLockingPeriods;
    roundLength: number;
}): void
Parameters
- args: {
      posTokenID: Buffer;
      punishmentLockingPeriods: PunishmentLockingPeriods;
      roundLength: number;
  }
  - posTokenID: Buffer
  - punishmentLockingPeriods: PunishmentLockingPeriods
  - roundLength: number
Returns void
- Defined in framework/src/modules/pos/commands/unlock.ts:39

`Optional` verify

verify(context: CommandVerifyContext<unknown>): Promise<VerificationResult>
Parameters
- context: CommandVerifyContext<unknown>
Returns Promise<VerificationResult>
Inherited from BaseCommand.verify
- Defined in framework/src/modules/base_command.ts:31

Generated using TypeDoc