token

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

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

Event and struct types of this Move module: @typemove/aptos › 0x3::token

Extends

Constructors

Constructor

new token(options: AptosBindOptions): token;

Parameters

ParameterType
optionsAptosBindOptions

Returns

token

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


onEntryBurn()

onEntryBurn(
   func: (call: BurnPayload, ctx: AptosContext) => void, 
   filter?: CallFilter, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, BurnPayload>
): token;

Parameters

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

Returns

token


onEntryBurnByCreator()

onEntryBurnByCreator(
   func: (call: BurnByCreatorPayload, ctx: AptosContext) => void, 
   filter?: CallFilter, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, BurnByCreatorPayload>
): token;

Parameters

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

Returns

token


onEntryCreateCollectionScript()

onEntryCreateCollectionScript(
   func: (call: CreateCollectionScriptPayload, ctx: AptosContext) => void, 
   filter?: CallFilter, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, CreateCollectionScriptPayload>
): token;

Parameters

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

Returns

token


onEntryCreateTokenScript()

onEntryCreateTokenScript(
   func: (call: CreateTokenScriptPayload, ctx: AptosContext) => void, 
   filter?: CallFilter, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, CreateTokenScriptPayload>
): token;

Parameters

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

Returns

token


onEntryDirectTransferScript()

onEntryDirectTransferScript(
   func: (call: DirectTransferScriptPayload, ctx: AptosContext) => void, 
   filter?: CallFilter, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, DirectTransferScriptPayload>
): token;

Parameters

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

Returns

token


onEntryInitializeTokenScript()

onEntryInitializeTokenScript(
   func: (call: InitializeTokenScriptPayload, ctx: AptosContext) => void, 
   filter?: CallFilter, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, InitializeTokenScriptPayload>
): token;

Parameters

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

Returns

token


onEntryMintScript()

onEntryMintScript(
   func: (call: MintScriptPayload, ctx: AptosContext) => void, 
   filter?: CallFilter, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, MintScriptPayload>
): token;

Parameters

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

Returns

token


onEntryMutateTokenProperties()

onEntryMutateTokenProperties(
   func: (call: MutateTokenPropertiesPayload, ctx: AptosContext) => void, 
   filter?: CallFilter, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, MutateTokenPropertiesPayload>
): token;

Parameters

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

Returns

token


onEntryOptInDirectTransfer()

onEntryOptInDirectTransfer(
   func: (call: OptInDirectTransferPayload, ctx: AptosContext) => void, 
   filter?: CallFilter, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, OptInDirectTransferPayload>
): token;

Parameters

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

Returns

token


onEntryTransferWithOptIn()

onEntryTransferWithOptIn(
   func: (call: TransferWithOptInPayload, ctx: AptosContext) => void, 
   filter?: CallFilter, 
   handlerOptions?: HandlerOptions<MoveFetchConfig, TransferWithOptInPayload>
): token;

Parameters

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

Returns

token


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">
): token;

Parameters

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

Returns

token


onEventBurnToken()

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

Parameters

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

Returns

token


onEventBurnTokenEvent()

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

Parameters

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

Returns

token


onEventCreateCollection()

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

Parameters

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

Returns

token


onEventCreateCollectionEvent()

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

Parameters

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

Returns

token


onEventCreateTokenData()

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

Parameters

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

Returns

token


onEventCreateTokenDataEvent()

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

Parameters

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

Returns

token


onEventDeposit()

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

Parameters

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

Returns

token


onEventDepositEvent()

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

Parameters

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

Returns

token


onEventMint()

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

Parameters

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

Returns

token


onEventMintToken()

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

Parameters

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

Returns

token


onEventMintTokenEvent()

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

Parameters

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

Returns

token


onEventMutatePropertyMap()

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

Parameters

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

Returns

token


onEventMutateTokenPropertyMap()

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

Parameters

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

Returns

token


onEventMutateTokenPropertyMapEvent()

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

Parameters

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

Returns

token


onEventTokenDataCreation()

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

Parameters

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

Returns

token


onEventTokenDeposit()

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

Parameters

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

Returns

token


onEventTokenWithdraw()

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

Parameters

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

Returns

token


onEventWithdraw()

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

Parameters

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

Returns

token


onEventWithdrawCapability()

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

Parameters

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

Returns

token


onEventWithdrawEvent()

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

Parameters

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

Returns

token


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

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

token

On this page

ExtendsConstructorsConstructorParametersReturnsOverridesPropertiesMethodsgetChainId()ReturnsInherited fromonEntryBurn()ParametersReturnsonEntryBurnByCreator()ParametersReturnsonEntryCreateCollectionScript()ParametersReturnsonEntryCreateTokenScript()ParametersReturnsonEntryDirectTransferScript()ParametersReturnsonEntryInitializeTokenScript()ParametersReturnsonEntryMintScript()ParametersReturnsonEntryMutateTokenProperties()ParametersReturnsonEntryOptInDirectTransfer()ParametersReturnsonEntryTransferWithOptIn()ParametersReturnsonEvent()ParametersReturnsInherited fromonEventBurn()ParametersReturnsonEventBurnToken()ParametersReturnsonEventBurnTokenEvent()ParametersReturnsonEventCreateCollection()ParametersReturnsonEventCreateCollectionEvent()ParametersReturnsonEventCreateTokenData()ParametersReturnsonEventCreateTokenDataEvent()ParametersReturnsonEventDeposit()ParametersReturnsonEventDepositEvent()ParametersReturnsonEventMint()ParametersReturnsonEventMintToken()ParametersReturnsonEventMintTokenEvent()ParametersReturnsonEventMutatePropertyMap()ParametersReturnsonEventMutateTokenPropertyMap()ParametersReturnsonEventMutateTokenPropertyMapEvent()ParametersReturnsonEventTokenDataCreation()ParametersReturnsonEventTokenDeposit()ParametersReturnsonEventTokenWithdraw()ParametersReturnsonEventWithdraw()ParametersReturnsonEventWithdrawCapability()ParametersReturnsonEventWithdrawEvent()ParametersReturnsonResourceChange()Call SignatureType ParametersParametersReturnsInherited fromCall SignatureType ParametersParametersReturnsInherited fromonTimeInterval()ParametersReturnsInherited fromonTransaction()ParametersReturnsInherited fromonVersionInterval()ParametersReturnsInherited frombind()ParametersReturns