Class StakeCommand

Hierarchy

BaseCommand
- StakeCommand

Index

Constructors

Constructors

constructor

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

Properties

`Private` _baseStakeAmount

_baseStakeAmount: bigint

`Private` _factorSelfStakes

_factorSelfStakes: number

`Private` _internalMethod

_internalMethod: InternalMethod

`Private` _maxNumberPendingUnlocks

_maxNumberPendingUnlocks: number

`Private` _maxNumberSentStakes

_maxNumberSentStakes: number

`Private` _posTokenID

_posTokenID: Buffer

`Private` _tokenMethod

_tokenMethod: TokenMethod

`Protected` events

events: NamedRegistry

schema

schema: {
    $id: string;
    properties: {
        stakes: {
            fieldNumber: number;
            items: {
                properties: {
                    amount: {
                        dataType: string;
                        fieldNumber: number;
                    };
                    validatorAddress: {
                        dataType: string;
                        fieldNumber: number;
                        format: string;
                    };
                };
                required: string[];
                type: string;
            };
            maxItems: number;
            minItems: number;
            type: string;
        };
    };
    required: string[];
    type: string;
} = stakeCommandParamsSchema

Type declaration

$id: string
properties: {
    stakes: {
        fieldNumber: number;
        items: {
            properties: {
                amount: {
                    dataType: string;
                    fieldNumber: number;
                };
                validatorAddress: {
                    dataType: string;
                    fieldNumber: number;
                    format: string;
                };
            };
            required: string[];
            type: string;
        };
        maxItems: number;
        minItems: number;
        type: string;
    };
}
- stakes: {
      fieldNumber: number;
      items: {
          properties: {
              amount: {
                  dataType: string;
                  fieldNumber: number;
              };
              validatorAddress: {
                  dataType: string;
                  fieldNumber: number;
                  format: string;
              };
          };
          required: string[];
          type: string;
      };
      maxItems: number;
      minItems: number;
      type: string;
  }
  - fieldNumber: number
  - items: {
        properties: {
            amount: {
                dataType: string;
                fieldNumber: number;
            };
            validatorAddress: {
                dataType: string;
                fieldNumber: number;
                format: string;
            };
        };
        required: string[];
        type: string;
    }
    - properties: {
          amount: {
              dataType: string;
              fieldNumber: number;
          };
          validatorAddress: {
              dataType: string;
              fieldNumber: number;
              format: string;
          };
      }
      - amount: {
        dataType: string;
        fieldNumber: number;
        }
        
        dataType: string
        
        fieldNumber: number
      - validatorAddress: {
            dataType: string;
            fieldNumber: number;
            format: string;
        }
        
        dataType: string
        
        fieldNumber: number
        
        format: string
    - required: string[]
    - type: string
  - maxItems: number
  - minItems: number
  - type: string
required: string[]
type: string

`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: {
internalMethod: InternalMethod;
tokenMethod: TokenMethod;
}): void
Parameters
- args: {
  internalMethod: InternalMethod;
  tokenMethod: TokenMethod;
  }
  - internalMethod: InternalMethod
  - tokenMethod: TokenMethod
Returns void
- Defined in framework/src/modules/pos/commands/stake.ts:45

execute

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

init

init(args: {
    baseStakeAmount: bigint;
    factorSelfStakes: number;
    maxNumberPendingUnlocks: number;
    maxNumberSentStakes: number;
    posTokenID: Buffer;
}): void
Parameters
- args: {
      baseStakeAmount: bigint;
      factorSelfStakes: number;
      maxNumberPendingUnlocks: number;
      maxNumberSentStakes: number;
      posTokenID: Buffer;
  }
  - baseStakeAmount: bigint
  - factorSelfStakes: number
  - maxNumberPendingUnlocks: number
  - maxNumberSentStakes: number
  - posTokenID: Buffer
Returns void
- Defined in framework/src/modules/pos/commands/stake.ts:50

verify

verify(context: CommandVerifyContext<StakeTransactionParams>): Promise<VerificationResult>
Parameters
- context: CommandVerifyContext<StakeTransactionParams>
Returns Promise<VerificationResult>
Overrides BaseCommand.verify
- Defined in framework/src/modules/pos/commands/stake.ts:65

Class StakeCommand

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

stores: NamedRegistry

events: NamedRegistry

Returns StakeCommand

Properties

Private _baseStakeAmount

Private _factorSelfStakes

Private _internalMethod

Private _maxNumberPendingUnlocks

Private _maxNumberSentStakes

Private _posTokenID

Private _tokenMethod

Protected events

schema

Type declaration

$id: string

properties: { stakes: { fieldNumber: number; items: { properties: { amount: { dataType: string; fieldNumber: number; }; validatorAddress: { dataType: string; fieldNumber: number; format: string; }; }; required: string[]; type: string; }; maxItems: number; minItems: number; type: string; }; }

stakes: { fieldNumber: number; items: { properties: { amount: { dataType: string; fieldNumber: number; }; validatorAddress: { dataType: string; fieldNumber: number; format: string; }; }; required: string[]; type: string; }; maxItems: number; minItems: number; type: string; }

fieldNumber: number

items: { properties: { amount: { dataType: string; fieldNumber: number; }; validatorAddress: { dataType: string; fieldNumber: number; format: string; }; }; required: string[]; type: string; }

properties: { amount: { dataType: string; fieldNumber: number; }; validatorAddress: { dataType: string; fieldNumber: number; format: string; }; }

amount: { dataType: string; fieldNumber: number; }

dataType: string

fieldNumber: number

validatorAddress: { dataType: string; fieldNumber: number; format: string; }

dataType: string

fieldNumber: number

format: string

required: string[]

type: string

maxItems: number

minItems: number

type: string

required: string[]

type: string

Protected stores

Accessors

name

Returns string

Methods

addDependencies

Parameters

args: { internalMethod: InternalMethod; tokenMethod: TokenMethod; }

internalMethod: InternalMethod

tokenMethod: TokenMethod

Returns void

execute

Parameters

context: CommandExecuteContext<StakeTransactionParams>

Returns Promise<void>

init

Parameters

args: { baseStakeAmount: bigint; factorSelfStakes: number; maxNumberPendingUnlocks: number; maxNumberSentStakes: number; posTokenID: Buffer; }

baseStakeAmount: bigint

factorSelfStakes: number

maxNumberPendingUnlocks: number

maxNumberSentStakes: number

posTokenID: Buffer

Returns void

verify

Parameters

context: CommandVerifyContext<StakeTransactionParams>

Returns Promise<VerificationResult>

Settings

Member Visibility

Theme

On This Page

`Private` _baseStakeAmount

`Private` _factorSelfStakes

`Private` _internalMethod

`Private` _maxNumberPendingUnlocks

`Private` _maxNumberSentStakes

`Private` _posTokenID

`Private` _tokenMethod

`Protected` events

properties: {
stakes: {
fieldNumber: number;
items: {
properties: {
amount: {
dataType: string;
fieldNumber: number;
};
validatorAddress: {
dataType: string;
fieldNumber: number;
format: string;
};
};
required: string[];
type: string;
};
maxItems: number;
minItems: number;
type: string;
};
}

stakes: {
fieldNumber: number;
items: {
properties: {
amount: {
dataType: string;
fieldNumber: number;
};
validatorAddress: {
dataType: string;
fieldNumber: number;
format: string;
};
};
required: string[];
type: string;
};
maxItems: number;
minItems: number;
type: string;
}

items: {
properties: {
amount: {
dataType: string;
fieldNumber: number;
};
validatorAddress: {
dataType: string;
fieldNumber: number;
format: string;
};
};
required: string[];
type: string;
}

properties: {
amount: {
dataType: string;
fieldNumber: number;
};
validatorAddress: {
dataType: string;
fieldNumber: number;
format: string;
};
}

amount: {
dataType: string;
fieldNumber: number;
}

validatorAddress: {
dataType: string;
fieldNumber: number;
format: string;
}

`Protected` stores

args: {
internalMethod: InternalMethod;
tokenMethod: TokenMethod;
}

args: {
baseStakeAmount: bigint;
factorSelfStakes: number;
maxNumberPendingUnlocks: number;
maxNumberSentStakes: number;
posTokenID: Buffer;
}