collection

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

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

Event and struct types of this Move module: @typemove/aptos › 0x4::collection

Extends

Constructors

Constructor

new collection(options: AptosBindOptions): collection;

Parameters

ParameterType
optionsAptosBindOptions

Returns

collection

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


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


onEventBurn()

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

Parameters

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

Returns

collection


onEventBurnEvent()

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

Parameters

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

Returns

collection


onEventConcurrentBurnEvent()

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

Parameters

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

Returns

collection


onEventConcurrentMintEvent()

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

Parameters

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

Returns

collection


onEventMint()

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

Parameters

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

Returns

collection


onEventMintEvent()

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

Parameters

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

Returns

collection


onEventMutation()

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

Parameters

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

Returns

collection


onEventMutationEvent()

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

Parameters

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

Returns

collection


onEventMutatorRef()

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

Parameters

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

Returns

collection


onEventSetMaxSupply()

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

Parameters

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

Returns

collection


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

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

collection

On this page