vesting

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::vesting

Extends

Constructors

Constructor

new vesting(options: AptosBindOptions): vesting;

Parameters

ParameterType
optionsAptosBindOptions

Returns

vesting

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


onEntryAdminWithdraw()

onEntryAdminWithdraw(
   func: (call: AdminWithdrawPayload, ctx: AptosContext) => void, 
   filter?: CallFilter, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, AdminWithdrawPayload>
): vesting;

Parameters

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

Returns

vesting


onEntryDistribute()

onEntryDistribute(
   func: (call: DistributePayload, ctx: AptosContext) => void, 
   filter?: CallFilter, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, DistributePayload>
): vesting;

Parameters

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

Returns

vesting


onEntryDistributeMany()

onEntryDistributeMany(
   func: (call: DistributeManyPayload, ctx: AptosContext) => void, 
   filter?: CallFilter, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, DistributeManyPayload>
): vesting;

Parameters

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

Returns

vesting


onEntryResetBeneficiary()

onEntryResetBeneficiary(
   func: (call: ResetBeneficiaryPayload, ctx: AptosContext) => void, 
   filter?: CallFilter, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, ResetBeneficiaryPayload>
): vesting;

Parameters

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

Returns

vesting


onEntryResetLockup()

onEntryResetLockup(
   func: (call: ResetLockupPayload, ctx: AptosContext) => void, 
   filter?: CallFilter, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, ResetLockupPayload>
): vesting;

Parameters

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

Returns

vesting


onEntrySetBeneficiary()

onEntrySetBeneficiary(
   func: (call: SetBeneficiaryPayload, ctx: AptosContext) => void, 
   filter?: CallFilter, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, SetBeneficiaryPayload>
): vesting;

Parameters

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

Returns

vesting


onEntrySetBeneficiaryForOperator()

onEntrySetBeneficiaryForOperator(
   func: (call: SetBeneficiaryForOperatorPayload, ctx: AptosContext) => void, 
   filter?: CallFilter, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, SetBeneficiaryForOperatorPayload>
): vesting;

Parameters

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

Returns

vesting


onEntrySetBeneficiaryResetter()

onEntrySetBeneficiaryResetter(
   func: (call: SetBeneficiaryResetterPayload, ctx: AptosContext) => void, 
   filter?: CallFilter, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, SetBeneficiaryResetterPayload>
): vesting;

Parameters

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

Returns

vesting


onEntrySetManagementRole()

onEntrySetManagementRole(
   func: (call: SetManagementRolePayload, ctx: AptosContext) => void, 
   filter?: CallFilter, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, SetManagementRolePayload>
): vesting;

Parameters

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

Returns

vesting


onEntryTerminateVestingContract()

onEntryTerminateVestingContract(
   func: (call: TerminateVestingContractPayload, ctx: AptosContext) => void, 
   filter?: CallFilter, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, TerminateVestingContractPayload>
): vesting;

Parameters

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

Returns

vesting


onEntryUnlockRewards()

onEntryUnlockRewards(
   func: (call: UnlockRewardsPayload, ctx: AptosContext) => void, 
   filter?: CallFilter, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, UnlockRewardsPayload>
): vesting;

Parameters

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

Returns

vesting


onEntryUnlockRewardsMany()

onEntryUnlockRewardsMany(
   func: (call: UnlockRewardsManyPayload, ctx: AptosContext) => void, 
   filter?: CallFilter, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, UnlockRewardsManyPayload>
): vesting;

Parameters

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

Returns

vesting


onEntryUpdateCommissionPercentage()

onEntryUpdateCommissionPercentage(
   func: (call: UpdateCommissionPercentagePayload, ctx: AptosContext) => void, 
   filter?: CallFilter, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, UpdateCommissionPercentagePayload>
): vesting;

Parameters

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

Returns

vesting


onEntryUpdateOperator()

onEntryUpdateOperator(
   func: (call: UpdateOperatorPayload, ctx: AptosContext) => void, 
   filter?: CallFilter, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, UpdateOperatorPayload>
): vesting;

Parameters

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

Returns

vesting


onEntryUpdateOperatorWithSameCommission()

onEntryUpdateOperatorWithSameCommission(
   func: (call: UpdateOperatorWithSameCommissionPayload, ctx: AptosContext) => void, 
   filter?: CallFilter, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, UpdateOperatorWithSameCommissionPayload>
): vesting;

Parameters

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

Returns

vesting


onEntryUpdateVoter()

onEntryUpdateVoter(
   func: (call: UpdateVoterPayload, ctx: AptosContext) => void, 
   filter?: CallFilter, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, UpdateVoterPayload>
): vesting;

Parameters

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

Returns

vesting


onEntryVest()

onEntryVest(
   func: (call: VestPayload, ctx: AptosContext) => void, 
   filter?: CallFilter, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, VestPayload>
): vesting;

Parameters

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

Returns

vesting


onEntryVestMany()

onEntryVestMany(
   func: (call: VestManyPayload, ctx: AptosContext) => void, 
   filter?: CallFilter, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, VestManyPayload>
): vesting;

Parameters

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

Returns

vesting


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


onEventAdminWithdraw()

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

Parameters

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

Returns

vesting


onEventAdminWithdrawEvent()

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

Parameters

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

Returns

vesting


onEventCreateVestingContract()

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

Parameters

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

Returns

vesting


onEventCreateVestingContractEvent()

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

Parameters

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

Returns

vesting


onEventDistribute()

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

Parameters

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

Returns

vesting


onEventDistributeEvent()

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

Parameters

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

Returns

vesting


onEventResetLockup()

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

Parameters

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

Returns

vesting


onEventResetLockupEvent()

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

Parameters

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

Returns

vesting


onEventSetBeneficiary()

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

Parameters

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

Returns

vesting


onEventSetBeneficiaryEvent()

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

Parameters

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

Returns

vesting


onEventTerminate()

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

Parameters

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

Returns

vesting


onEventTerminateEvent()

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

Parameters

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

Returns

vesting


onEventUnlockRewards()

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

Parameters

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

Returns

vesting


onEventUnlockRewardsEvent()

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

Parameters

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

Returns

vesting


onEventUpdateOperator()

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

Parameters

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

Returns

vesting


onEventUpdateOperatorEvent()

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

Parameters

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

Returns

vesting


onEventUpdateVoter()

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

Parameters

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

Returns

vesting


onEventUpdateVoterEvent()

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

Parameters

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

Returns

vesting


onEventVest()

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

Parameters

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

Returns

vesting


onEventVestEvent()

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

Parameters

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

Returns

vesting


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>): vesting;

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

vesting

On this page

ExtendsConstructorsConstructorParametersReturnsOverridesPropertiesMethodsgetChainId()ReturnsInherited fromonEntryAdminWithdraw()ParametersReturnsonEntryDistribute()ParametersReturnsonEntryDistributeMany()ParametersReturnsonEntryResetBeneficiary()ParametersReturnsonEntryResetLockup()ParametersReturnsonEntrySetBeneficiary()ParametersReturnsonEntrySetBeneficiaryForOperator()ParametersReturnsonEntrySetBeneficiaryResetter()ParametersReturnsonEntrySetManagementRole()ParametersReturnsonEntryTerminateVestingContract()ParametersReturnsonEntryUnlockRewards()ParametersReturnsonEntryUnlockRewardsMany()ParametersReturnsonEntryUpdateCommissionPercentage()ParametersReturnsonEntryUpdateOperator()ParametersReturnsonEntryUpdateOperatorWithSameCommission()ParametersReturnsonEntryUpdateVoter()ParametersReturnsonEntryVest()ParametersReturnsonEntryVestMany()ParametersReturnsonEvent()ParametersReturnsInherited fromonEventAdminWithdraw()ParametersReturnsonEventAdminWithdrawEvent()ParametersReturnsonEventCreateVestingContract()ParametersReturnsonEventCreateVestingContractEvent()ParametersReturnsonEventDistribute()ParametersReturnsonEventDistributeEvent()ParametersReturnsonEventResetLockup()ParametersReturnsonEventResetLockupEvent()ParametersReturnsonEventSetBeneficiary()ParametersReturnsonEventSetBeneficiaryEvent()ParametersReturnsonEventTerminate()ParametersReturnsonEventTerminateEvent()ParametersReturnsonEventUnlockRewards()ParametersReturnsonEventUnlockRewardsEvent()ParametersReturnsonEventUpdateOperator()ParametersReturnsonEventUpdateOperatorEvent()ParametersReturnsonEventUpdateVoter()ParametersReturnsonEventUpdateVoterEvent()ParametersReturnsonEventVest()ParametersReturnsonEventVestEvent()ParametersReturnsonResourceChange()Call SignatureType ParametersParametersReturnsInherited fromCall SignatureType ParametersParametersReturnsInherited fromonTimeInterval()ParametersReturnsInherited fromonTransaction()ParametersReturnsInherited fromonVersionInterval()ParametersReturnsInherited frombind()ParametersReturns