stake

Class in @sentio/sdk/aptos/builtin › _0x1

Defined in @sentio/sdk/aptos/builtin › _0x1

Event and struct types of this Move module: @typemove/aptos › 0x1::stake

Extends

Constructors

Constructor

new stake(options: AptosBindOptions): stake;

Parameters

ParameterType
optionsAptosBindOptions

Returns

stake

Overrides

AptosBaseProcessor.constructor

Properties

PropertyModifierTypeDefault valueInherited from
callHandlerspublicCallHandler<AptCall>[][]AptosBaseProcessor.callHandlers
coderpublicMoveCoderundefinedAptosBaseProcessor.coder
configpublicIndexConfigureundefinedAptosBaseProcessor.config
eventHandlerspublicEventHandler<AptEvent>[][]AptosBaseProcessor.eventHandlers
moduleNamereadonlystringundefinedAptosBaseProcessor.moduleName
resourceChangeHandlerspublicResourceChangeHandler<AptResource>[][]AptosBaseProcessor.resourceChangeHandlers
transactionIntervalHandlerspublicTransactionIntervalHandler[][]AptosBaseProcessor.transactionIntervalHandlers
DEFAULT_OPTIONSstaticAptosBindOptionsundefined-

Methods

getChainId()

getChainId(): string;

Returns

string

Inherited from

AptosBaseProcessor.getChainId


onEntryAddStake()

onEntryAddStake(
   func: (call: AddStakePayload, ctx: AptosContext) => void, 
   filter?: CallFilter, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, AddStakePayload>
): stake;

Parameters

ParameterType
func(call: AddStakePayload, ctx: AptosContext) => void
filter?CallFilter
handlerOptions?HandlerOptions<MoveFetchConfig, AddStakePayload>

Returns

stake


onEntryIncreaseLockup()

onEntryIncreaseLockup(
   func: (call: IncreaseLockupPayload, ctx: AptosContext) => void, 
   filter?: CallFilter, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, IncreaseLockupPayload>
): stake;

Parameters

ParameterType
func(call: IncreaseLockupPayload, ctx: AptosContext) => void
filter?CallFilter
handlerOptions?HandlerOptions<MoveFetchConfig, IncreaseLockupPayload>

Returns

stake


onEntryInitializeStakeOwner()

onEntryInitializeStakeOwner(
   func: (call: InitializeStakeOwnerPayload, ctx: AptosContext) => void, 
   filter?: CallFilter, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, InitializeStakeOwnerPayload>
): stake;

Parameters

ParameterType
func(call: InitializeStakeOwnerPayload, ctx: AptosContext) => void
filter?CallFilter
handlerOptions?HandlerOptions<MoveFetchConfig, InitializeStakeOwnerPayload>

Returns

stake


onEntryInitializeValidator()

onEntryInitializeValidator(
   func: (call: InitializeValidatorPayload, ctx: AptosContext) => void, 
   filter?: CallFilter, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, InitializeValidatorPayload>
): stake;

Parameters

ParameterType
func(call: InitializeValidatorPayload, ctx: AptosContext) => void
filter?CallFilter
handlerOptions?HandlerOptions<MoveFetchConfig, InitializeValidatorPayload>

Returns

stake


onEntryJoinValidatorSet()

onEntryJoinValidatorSet(
   func: (call: JoinValidatorSetPayload, ctx: AptosContext) => void, 
   filter?: CallFilter, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, JoinValidatorSetPayload>
): stake;

Parameters

ParameterType
func(call: JoinValidatorSetPayload, ctx: AptosContext) => void
filter?CallFilter
handlerOptions?HandlerOptions<MoveFetchConfig, JoinValidatorSetPayload>

Returns

stake


onEntryLeaveValidatorSet()

onEntryLeaveValidatorSet(
   func: (call: LeaveValidatorSetPayload, ctx: AptosContext) => void, 
   filter?: CallFilter, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, LeaveValidatorSetPayload>
): stake;

Parameters

ParameterType
func(call: LeaveValidatorSetPayload, ctx: AptosContext) => void
filter?CallFilter
handlerOptions?HandlerOptions<MoveFetchConfig, LeaveValidatorSetPayload>

Returns

stake


onEntryReactivateStake()

onEntryReactivateStake(
   func: (call: ReactivateStakePayload, ctx: AptosContext) => void, 
   filter?: CallFilter, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, ReactivateStakePayload>
): stake;

Parameters

ParameterType
func(call: ReactivateStakePayload, ctx: AptosContext) => void
filter?CallFilter
handlerOptions?HandlerOptions<MoveFetchConfig, ReactivateStakePayload>

Returns

stake


onEntryRotateConsensusKey()

onEntryRotateConsensusKey(
   func: (call: RotateConsensusKeyPayload, ctx: AptosContext) => void, 
   filter?: CallFilter, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, RotateConsensusKeyPayload>
): stake;

Parameters

ParameterType
func(call: RotateConsensusKeyPayload, ctx: AptosContext) => void
filter?CallFilter
handlerOptions?HandlerOptions<MoveFetchConfig, RotateConsensusKeyPayload>

Returns

stake


onEntrySetDelegatedVoter()

onEntrySetDelegatedVoter(
   func: (call: SetDelegatedVoterPayload, ctx: AptosContext) => void, 
   filter?: CallFilter, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, SetDelegatedVoterPayload>
): stake;

Parameters

ParameterType
func(call: SetDelegatedVoterPayload, ctx: AptosContext) => void
filter?CallFilter
handlerOptions?HandlerOptions<MoveFetchConfig, SetDelegatedVoterPayload>

Returns

stake


onEntrySetOperator()

onEntrySetOperator(
   func: (call: SetOperatorPayload, ctx: AptosContext) => void, 
   filter?: CallFilter, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, SetOperatorPayload>
): stake;

Parameters

ParameterType
func(call: SetOperatorPayload, ctx: AptosContext) => void
filter?CallFilter
handlerOptions?HandlerOptions<MoveFetchConfig, SetOperatorPayload>

Returns

stake


onEntryUnlock()

onEntryUnlock(
   func: (call: UnlockPayload, ctx: AptosContext) => void, 
   filter?: CallFilter, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, UnlockPayload>
): stake;

Parameters

ParameterType
func(call: UnlockPayload, ctx: AptosContext) => void
filter?CallFilter
handlerOptions?HandlerOptions<MoveFetchConfig, UnlockPayload>

Returns

stake


onEntryUpdateNetworkAndFullnodeAddresses()

onEntryUpdateNetworkAndFullnodeAddresses(
   func: (call: UpdateNetworkAndFullnodeAddressesPayload, ctx: AptosContext) => void, 
   filter?: CallFilter, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, UpdateNetworkAndFullnodeAddressesPayload>
): stake;

Parameters

ParameterType
func(call: UpdateNetworkAndFullnodeAddressesPayload, ctx: AptosContext) => void
filter?CallFilter
handlerOptions?HandlerOptions<MoveFetchConfig, UpdateNetworkAndFullnodeAddressesPayload>

Returns

stake


onEntryWithdraw()

onEntryWithdraw(
   func: (call: WithdrawPayload, ctx: AptosContext) => void, 
   filter?: CallFilter, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, WithdrawPayload>
): stake;

Parameters

ParameterType
func(call: WithdrawPayload, ctx: AptosContext) => void
filter?CallFilter
handlerOptions?HandlerOptions<MoveFetchConfig, WithdrawPayload>

Returns

stake


onEvent()

onEvent(handler: (event: Event, ctx: AptosContext) => void, handlerOptions?: HandlerOptions<MoveFetchConfig, Event>): this;

Parameters

ParameterType
handler(event: Event, ctx: AptosContext) => void
handlerOptions?HandlerOptions<MoveFetchConfig, Event>

Returns

this

Inherited from

AptosBaseProcessor.onEvent


onEventAddStake()

onEventAddStake(
   func: (event: AddStakeInstance, ctx: AptosContext) => void, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, AddStakeInstance>, 
   eventFilter?: Omit<EventFilter, "account" | "type">
): stake;

Parameters

ParameterType
func(event: AddStakeInstance, ctx: AptosContext) => void
handlerOptions?HandlerOptions<MoveFetchConfig, AddStakeInstance>
eventFilter?Omit<EventFilter, "account" | "type">

Returns

stake


onEventAddStakeEvent()

onEventAddStakeEvent(
   func: (event: AddStakeEventInstance, ctx: AptosContext) => void, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, AddStakeEventInstance>, 
   eventFilter?: Omit<EventFilter, "account" | "type">
): stake;

Parameters

ParameterType
func(event: AddStakeEventInstance, ctx: AptosContext) => void
handlerOptions?HandlerOptions<MoveFetchConfig, AddStakeEventInstance>
eventFilter?Omit<EventFilter, "account" | "type">

Returns

stake


onEventDistributeRewards()

onEventDistributeRewards(
   func: (event: DistributeRewardsInstance, ctx: AptosContext) => void, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, DistributeRewardsInstance>, 
   eventFilter?: Omit<EventFilter, "account" | "type">
): stake;

Parameters

ParameterType
func(event: DistributeRewardsInstance, ctx: AptosContext) => void
handlerOptions?HandlerOptions<MoveFetchConfig, DistributeRewardsInstance>
eventFilter?Omit<EventFilter, "account" | "type">

Returns

stake


onEventDistributeRewardsEvent()

onEventDistributeRewardsEvent(
   func: (event: DistributeRewardsEventInstance, ctx: AptosContext) => void, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, DistributeRewardsEventInstance>, 
   eventFilter?: Omit<EventFilter, "account" | "type">
): stake;

Parameters

ParameterType
func(event: DistributeRewardsEventInstance, ctx: AptosContext) => void
handlerOptions?HandlerOptions<MoveFetchConfig, DistributeRewardsEventInstance>
eventFilter?Omit<EventFilter, "account" | "type">

Returns

stake


onEventDistributeTransactionFee()

onEventDistributeTransactionFee(
   func: (event: DistributeTransactionFeeInstance, ctx: AptosContext) => void, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, DistributeTransactionFeeInstance>, 
   eventFilter?: Omit<EventFilter, "account" | "type">
): stake;

Parameters

ParameterType
func(event: DistributeTransactionFeeInstance, ctx: AptosContext) => void
handlerOptions?HandlerOptions<MoveFetchConfig, DistributeTransactionFeeInstance>
eventFilter?Omit<EventFilter, "account" | "type">

Returns

stake


onEventIncreaseLockup()

onEventIncreaseLockup(
   func: (event: IncreaseLockupInstance, ctx: AptosContext) => void, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, IncreaseLockupInstance>, 
   eventFilter?: Omit<EventFilter, "account" | "type">
): stake;

Parameters

ParameterType
func(event: IncreaseLockupInstance, ctx: AptosContext) => void
handlerOptions?HandlerOptions<MoveFetchConfig, IncreaseLockupInstance>
eventFilter?Omit<EventFilter, "account" | "type">

Returns

stake


onEventIncreaseLockupEvent()

onEventIncreaseLockupEvent(
   func: (event: IncreaseLockupEventInstance, ctx: AptosContext) => void, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, IncreaseLockupEventInstance>, 
   eventFilter?: Omit<EventFilter, "account" | "type">
): stake;

Parameters

ParameterType
func(event: IncreaseLockupEventInstance, ctx: AptosContext) => void
handlerOptions?HandlerOptions<MoveFetchConfig, IncreaseLockupEventInstance>
eventFilter?Omit<EventFilter, "account" | "type">

Returns

stake


onEventIndividualValidatorPerformance()

onEventIndividualValidatorPerformance(
   func: (event: IndividualValidatorPerformanceInstance, ctx: AptosContext) => void, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, IndividualValidatorPerformanceInstance>, 
   eventFilter?: Omit<EventFilter, "account" | "type">
): stake;

Parameters

ParameterType
func(event: IndividualValidatorPerformanceInstance, ctx: AptosContext) => void
handlerOptions?HandlerOptions<MoveFetchConfig, IndividualValidatorPerformanceInstance>
eventFilter?Omit<EventFilter, "account" | "type">

Returns

stake


onEventJoinValidatorSet()

onEventJoinValidatorSet(
   func: (event: JoinValidatorSetInstance, ctx: AptosContext) => void, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, JoinValidatorSetInstance>, 
   eventFilter?: Omit<EventFilter, "account" | "type">
): stake;

Parameters

ParameterType
func(event: JoinValidatorSetInstance, ctx: AptosContext) => void
handlerOptions?HandlerOptions<MoveFetchConfig, JoinValidatorSetInstance>
eventFilter?Omit<EventFilter, "account" | "type">

Returns

stake


onEventJoinValidatorSetEvent()

onEventJoinValidatorSetEvent(
   func: (event: JoinValidatorSetEventInstance, ctx: AptosContext) => void, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, JoinValidatorSetEventInstance>, 
   eventFilter?: Omit<EventFilter, "account" | "type">
): stake;

Parameters

ParameterType
func(event: JoinValidatorSetEventInstance, ctx: AptosContext) => void
handlerOptions?HandlerOptions<MoveFetchConfig, JoinValidatorSetEventInstance>
eventFilter?Omit<EventFilter, "account" | "type">

Returns

stake


onEventLeaveValidatorSet()

onEventLeaveValidatorSet(
   func: (event: LeaveValidatorSetInstance, ctx: AptosContext) => void, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, LeaveValidatorSetInstance>, 
   eventFilter?: Omit<EventFilter, "account" | "type">
): stake;

Parameters

ParameterType
func(event: LeaveValidatorSetInstance, ctx: AptosContext) => void
handlerOptions?HandlerOptions<MoveFetchConfig, LeaveValidatorSetInstance>
eventFilter?Omit<EventFilter, "account" | "type">

Returns

stake


onEventLeaveValidatorSetEvent()

onEventLeaveValidatorSetEvent(
   func: (event: LeaveValidatorSetEventInstance, ctx: AptosContext) => void, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, LeaveValidatorSetEventInstance>, 
   eventFilter?: Omit<EventFilter, "account" | "type">
): stake;

Parameters

ParameterType
func(event: LeaveValidatorSetEventInstance, ctx: AptosContext) => void
handlerOptions?HandlerOptions<MoveFetchConfig, LeaveValidatorSetEventInstance>
eventFilter?Omit<EventFilter, "account" | "type">

Returns

stake


onEventReactivateStake()

onEventReactivateStake(
   func: (event: ReactivateStakeInstance, ctx: AptosContext) => void, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, ReactivateStakeInstance>, 
   eventFilter?: Omit<EventFilter, "account" | "type">
): stake;

Parameters

ParameterType
func(event: ReactivateStakeInstance, ctx: AptosContext) => void
handlerOptions?HandlerOptions<MoveFetchConfig, ReactivateStakeInstance>
eventFilter?Omit<EventFilter, "account" | "type">

Returns

stake


onEventReactivateStakeEvent()

onEventReactivateStakeEvent(
   func: (event: ReactivateStakeEventInstance, ctx: AptosContext) => void, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, ReactivateStakeEventInstance>, 
   eventFilter?: Omit<EventFilter, "account" | "type">
): stake;

Parameters

ParameterType
func(event: ReactivateStakeEventInstance, ctx: AptosContext) => void
handlerOptions?HandlerOptions<MoveFetchConfig, ReactivateStakeEventInstance>
eventFilter?Omit<EventFilter, "account" | "type">

Returns

stake


onEventRegisterValidatorCandidate()

onEventRegisterValidatorCandidate(
   func: (event: RegisterValidatorCandidateInstance, ctx: AptosContext) => void, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, RegisterValidatorCandidateInstance>, 
   eventFilter?: Omit<EventFilter, "account" | "type">
): stake;

Parameters

ParameterType
func(event: RegisterValidatorCandidateInstance, ctx: AptosContext) => void
handlerOptions?HandlerOptions<MoveFetchConfig, RegisterValidatorCandidateInstance>
eventFilter?Omit<EventFilter, "account" | "type">

Returns

stake


onEventRegisterValidatorCandidateEvent()

onEventRegisterValidatorCandidateEvent(
   func: (event: RegisterValidatorCandidateEventInstance, ctx: AptosContext) => void, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, RegisterValidatorCandidateEventInstance>, 
   eventFilter?: Omit<EventFilter, "account" | "type">
): stake;

Parameters

ParameterType
func(event: RegisterValidatorCandidateEventInstance, ctx: AptosContext) => void
handlerOptions?HandlerOptions<MoveFetchConfig, RegisterValidatorCandidateEventInstance>
eventFilter?Omit<EventFilter, "account" | "type">

Returns

stake


onEventRotateConsensusKey()

onEventRotateConsensusKey(
   func: (event: RotateConsensusKeyInstance, ctx: AptosContext) => void, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, RotateConsensusKeyInstance>, 
   eventFilter?: Omit<EventFilter, "account" | "type">
): stake;

Parameters

ParameterType
func(event: RotateConsensusKeyInstance, ctx: AptosContext) => void
handlerOptions?HandlerOptions<MoveFetchConfig, RotateConsensusKeyInstance>
eventFilter?Omit<EventFilter, "account" | "type">

Returns

stake


onEventRotateConsensusKeyEvent()

onEventRotateConsensusKeyEvent(
   func: (event: RotateConsensusKeyEventInstance, ctx: AptosContext) => void, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, RotateConsensusKeyEventInstance>, 
   eventFilter?: Omit<EventFilter, "account" | "type">
): stake;

Parameters

ParameterType
func(event: RotateConsensusKeyEventInstance, ctx: AptosContext) => void
handlerOptions?HandlerOptions<MoveFetchConfig, RotateConsensusKeyEventInstance>
eventFilter?Omit<EventFilter, "account" | "type">

Returns

stake


onEventSetOperator()

onEventSetOperator(
   func: (event: SetOperatorInstance, ctx: AptosContext) => void, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, SetOperatorInstance>, 
   eventFilter?: Omit<EventFilter, "account" | "type">
): stake;

Parameters

ParameterType
func(event: SetOperatorInstance, ctx: AptosContext) => void
handlerOptions?HandlerOptions<MoveFetchConfig, SetOperatorInstance>
eventFilter?Omit<EventFilter, "account" | "type">

Returns

stake


onEventSetOperatorEvent()

onEventSetOperatorEvent(
   func: (event: SetOperatorEventInstance, ctx: AptosContext) => void, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, SetOperatorEventInstance>, 
   eventFilter?: Omit<EventFilter, "account" | "type">
): stake;

Parameters

ParameterType
func(event: SetOperatorEventInstance, ctx: AptosContext) => void
handlerOptions?HandlerOptions<MoveFetchConfig, SetOperatorEventInstance>
eventFilter?Omit<EventFilter, "account" | "type">

Returns

stake


onEventUnlockStake()

onEventUnlockStake(
   func: (event: UnlockStakeInstance, ctx: AptosContext) => void, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, UnlockStakeInstance>, 
   eventFilter?: Omit<EventFilter, "account" | "type">
): stake;

Parameters

ParameterType
func(event: UnlockStakeInstance, ctx: AptosContext) => void
handlerOptions?HandlerOptions<MoveFetchConfig, UnlockStakeInstance>
eventFilter?Omit<EventFilter, "account" | "type">

Returns

stake


onEventUnlockStakeEvent()

onEventUnlockStakeEvent(
   func: (event: UnlockStakeEventInstance, ctx: AptosContext) => void, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, UnlockStakeEventInstance>, 
   eventFilter?: Omit<EventFilter, "account" | "type">
): stake;

Parameters

ParameterType
func(event: UnlockStakeEventInstance, ctx: AptosContext) => void
handlerOptions?HandlerOptions<MoveFetchConfig, UnlockStakeEventInstance>
eventFilter?Omit<EventFilter, "account" | "type">

Returns

stake


onEventUpdateNetworkAndFullnodeAddresses()

onEventUpdateNetworkAndFullnodeAddresses(
   func: (event: UpdateNetworkAndFullnodeAddressesInstance, ctx: AptosContext) => void, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, UpdateNetworkAndFullnodeAddressesInstance>, 
   eventFilter?: Omit<EventFilter, "account" | "type">
): stake;

Parameters

ParameterType
func(event: UpdateNetworkAndFullnodeAddressesInstance, ctx: AptosContext) => void
handlerOptions?HandlerOptions<MoveFetchConfig, UpdateNetworkAndFullnodeAddressesInstance>
eventFilter?Omit<EventFilter, "account" | "type">

Returns

stake


onEventUpdateNetworkAndFullnodeAddressesEvent()

onEventUpdateNetworkAndFullnodeAddressesEvent(
   func: (event: UpdateNetworkAndFullnodeAddressesEventInstance, ctx: AptosContext) => void, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, UpdateNetworkAndFullnodeAddressesEventInstance>, 
   eventFilter?: Omit<EventFilter, "account" | "type">
): stake;

Parameters

ParameterType
func(event: UpdateNetworkAndFullnodeAddressesEventInstance, ctx: AptosContext) => void
handlerOptions?HandlerOptions<MoveFetchConfig, UpdateNetworkAndFullnodeAddressesEventInstance>
eventFilter?Omit<EventFilter, "account" | "type">

Returns

stake


onEventValidatorSetLivenessFallback()

onEventValidatorSetLivenessFallback(
   func: (event: ValidatorSetLivenessFallbackInstance, ctx: AptosContext) => void, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, ValidatorSetLivenessFallbackInstance>, 
   eventFilter?: Omit<EventFilter, "account" | "type">
): stake;

Parameters

ParameterType
func(event: ValidatorSetLivenessFallbackInstance, ctx: AptosContext) => void
handlerOptions?HandlerOptions<MoveFetchConfig, ValidatorSetLivenessFallbackInstance>
eventFilter?Omit<EventFilter, "account" | "type">

Returns

stake


onEventWithdrawStake()

onEventWithdrawStake(
   func: (event: WithdrawStakeInstance, ctx: AptosContext) => void, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, WithdrawStakeInstance>, 
   eventFilter?: Omit<EventFilter, "account" | "type">
): stake;

Parameters

ParameterType
func(event: WithdrawStakeInstance, ctx: AptosContext) => void
handlerOptions?HandlerOptions<MoveFetchConfig, WithdrawStakeInstance>
eventFilter?Omit<EventFilter, "account" | "type">

Returns

stake


onEventWithdrawStakeEvent()

onEventWithdrawStakeEvent(
   func: (event: WithdrawStakeEventInstance, ctx: AptosContext) => void, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, WithdrawStakeEventInstance>, 
   eventFilter?: Omit<EventFilter, "account" | "type">
): stake;

Parameters

ParameterType
func(event: WithdrawStakeEventInstance, ctx: AptosContext) => void
handlerOptions?HandlerOptions<MoveFetchConfig, WithdrawStakeEventInstance>
eventFilter?Omit<EventFilter, "account" | "type">

Returns

stake


onResourceChange()

Call Signature

onResourceChange<T>(
   handler: (changes: ResourceChange<T>[], ctx: AptosResourcesContext) => PromiseOrVoid, 
   typeDesc: 
  | string
  | TypeDescriptor<T>, 
   handlerOptions?: HandlerOptions<object, ResourceChange<T>[]>
): this;
Type Parameters
Type Parameter
T
Parameters
ParameterType
handler(changes: ResourceChange<T>[], ctx: AptosResourcesContext) => PromiseOrVoid
typeDesc| string | TypeDescriptor<T>
handlerOptions?HandlerOptions<object, ResourceChange<T>[]>
Returns

this

Inherited from

AptosBaseProcessor.onResourceChange

Call Signature

onResourceChange<Descs extends readonly (
  | string
  | TypeDescriptor<any>)[]>(
   handler: (changes: ResourceChange<ExtractDescriptorType<Descs[number]>>[], ctx: AptosResourcesContext) => PromiseOrVoid, 
   typeDesc: [...Descs[]], 
   handlerOptions?: HandlerOptions<object, ResourceChange<ExtractDescriptorType<Descs[number]>>[]>
): this;
Type Parameters
Type Parameter
Descs extends readonly ( | string | TypeDescriptor<any>)[]
Parameters
ParameterType
handler(changes: ResourceChange<ExtractDescriptorType<Descs[number]>>[], ctx: AptosResourcesContext) => PromiseOrVoid
typeDesc[...Descs[]]
handlerOptions?HandlerOptions<object, ResourceChange<ExtractDescriptorType<Descs[number]>>[]>
Returns

this

Inherited from

AptosBaseProcessor.onResourceChange


onTimeInterval()

onTimeInterval(
   handler: (transaction: UserTransactionResponse, ctx: AptosContext) => PromiseOrVoid, 
   timeIntervalInMinutes?: number, 
   backfillTimeIntervalInMinutes?: number, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, UserTransactionResponse>
): this;

Parameters

ParameterTypeDefault value
handler(transaction: UserTransactionResponse, ctx: AptosContext) => PromiseOrVoidundefined
timeIntervalInMinutesnumber60
backfillTimeIntervalInMinutesnumber240
handlerOptions?HandlerOptions<MoveFetchConfig, UserTransactionResponse>undefined

Returns

this

Inherited from

AptosBaseProcessor.onTimeInterval


onTransaction()

onTransaction(
   handler: (transaction: UserTransactionResponse, ctx: AptosContext) => PromiseOrVoid, 
   transactionFilter?: object, 
   handleOptions?: HandlerOptions<MoveFetchConfig, UserTransactionResponse>
): this;

Parameters

ParameterType
handler(transaction: UserTransactionResponse, ctx: AptosContext) => PromiseOrVoid
transactionFilter?{ includeFailed?: boolean; sender?: string; }
transactionFilter.includeFailed?boolean
transactionFilter.sender?string
handleOptions?HandlerOptions<MoveFetchConfig, UserTransactionResponse>

Returns

this

Inherited from

AptosBaseProcessor.onTransaction


onVersionInterval()

onVersionInterval(
   handler: (transaction: UserTransactionResponse, context: AptosContext) => PromiseOrVoid, 
   versionInterval?: number, 
   backfillVersionInterval?: number, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, UserTransactionResponse>
): this;

Parameters

ParameterTypeDefault value
handler(transaction: UserTransactionResponse, context: AptosContext) => PromiseOrVoidundefined
versionIntervalnumber100000
backfillVersionIntervalnumber400000
handlerOptions?HandlerOptions<MoveFetchConfig, UserTransactionResponse>undefined

Returns

this

Inherited from

AptosBaseProcessor.onVersionInterval


bind()

static bind(options?: Partial<AptosBindOptions>): stake;

For a given function, creates a bound function that has the same body as the original function. The this object of the bound function is associated with the specified object, and has the specified initial parameters.

Parameters

ParameterType
optionsPartial<AptosBindOptions>

Returns

stake

On this page

ExtendsConstructorsConstructorParametersReturnsOverridesPropertiesMethodsgetChainId()ReturnsInherited fromonEntryAddStake()ParametersReturnsonEntryIncreaseLockup()ParametersReturnsonEntryInitializeStakeOwner()ParametersReturnsonEntryInitializeValidator()ParametersReturnsonEntryJoinValidatorSet()ParametersReturnsonEntryLeaveValidatorSet()ParametersReturnsonEntryReactivateStake()ParametersReturnsonEntryRotateConsensusKey()ParametersReturnsonEntrySetDelegatedVoter()ParametersReturnsonEntrySetOperator()ParametersReturnsonEntryUnlock()ParametersReturnsonEntryUpdateNetworkAndFullnodeAddresses()ParametersReturnsonEntryWithdraw()ParametersReturnsonEvent()ParametersReturnsInherited fromonEventAddStake()ParametersReturnsonEventAddStakeEvent()ParametersReturnsonEventDistributeRewards()ParametersReturnsonEventDistributeRewardsEvent()ParametersReturnsonEventDistributeTransactionFee()ParametersReturnsonEventIncreaseLockup()ParametersReturnsonEventIncreaseLockupEvent()ParametersReturnsonEventIndividualValidatorPerformance()ParametersReturnsonEventJoinValidatorSet()ParametersReturnsonEventJoinValidatorSetEvent()ParametersReturnsonEventLeaveValidatorSet()ParametersReturnsonEventLeaveValidatorSetEvent()ParametersReturnsonEventReactivateStake()ParametersReturnsonEventReactivateStakeEvent()ParametersReturnsonEventRegisterValidatorCandidate()ParametersReturnsonEventRegisterValidatorCandidateEvent()ParametersReturnsonEventRotateConsensusKey()ParametersReturnsonEventRotateConsensusKeyEvent()ParametersReturnsonEventSetOperator()ParametersReturnsonEventSetOperatorEvent()ParametersReturnsonEventUnlockStake()ParametersReturnsonEventUnlockStakeEvent()ParametersReturnsonEventUpdateNetworkAndFullnodeAddresses()ParametersReturnsonEventUpdateNetworkAndFullnodeAddressesEvent()ParametersReturnsonEventValidatorSetLivenessFallback()ParametersReturnsonEventWithdrawStake()ParametersReturnsonEventWithdrawStakeEvent()ParametersReturnsonResourceChange()Call SignatureType ParametersParametersReturnsInherited fromCall SignatureType ParametersParametersReturnsInherited fromonTimeInterval()ParametersReturnsInherited fromonTransaction()ParametersReturnsInherited fromonVersionInterval()ParametersReturnsInherited frombind()ParametersReturns