Everscale Inpage Provider

Appearance

On this page

Contract ​

DelayedMessageExecution ​

Ƭ DelayedMessageExecution: Object

Type declaration ​

NameTypeDescription
messageHashstringExternal message hash
expireAtnumberMessage expiration timestamp
transactionPromise<Transaction>Transaction promise (it will be rejected if the message has expired)

Defined in:

src/contract.ts:455

ContractMethods ​

Ƭ ContractMethods<C>: { [K in AbiFunctionName<C>]: Function }

Type parameters ​

Name
C

Defined in:

src/contract.ts:473

ContractFields ​

Ƭ ContractFields<C>: { [K in AbiFieldName<C>]: Function }

Type parameters ​

Name
C

Defined in:

src/contract.ts:482

GetContractFieldsParams ​

Ƭ GetContractFieldsParams: Object

Type declaration ​

NameTypeDescription
cachedState?FullContractStateCached contract state
allowPartial?booleanDon't fail if something is left in a cell after unpacking

Defined in:

src/contract.ts:917

ContractFunction ​

Ƭ ContractFunction: Object

Type declaration ​

NameType
namestring
inputs?AbiParam[]
outputs?AbiParam[]

Defined in:

src/contract.ts:931

SendInternalParams ​

Ƭ SendInternalParams: Object

Type declaration ​

NameTypeDescription
fromAddressPreferred wallet address. It is the same address as the accountInteraction.address, but it must be explicitly provided
amountstringAmount of nano EVER to send
bounce?booleanDefault ts true
stateInit?stringOptional base64 encoded TVC NOTE: If the selected contract do not support stateInit in the internal message, an error is returned

Defined in:

src/contract.ts:936

SendInternalWithResultParams ​

Ƭ SendInternalWithResultParams: SendInternalParams & { subscriber?: Subscriber }

Defined in:

src/contract.ts:962

SendExternalParams ​

Ƭ SendExternalParams: Object

Type declaration ​

NameTypeDescription
publicKeystringThe public key of the preferred account. It is the same publicKey as the accountInteraction.publicKey, but it must be explicitly provided
stateInit?stringOptional base64 encoded TVC
local?booleanWhether to run this message locally. Default: false
executorParams?{ disableSignatureCheck?: boolean ; overrideBalance?: string | number }Optional executor parameters used during local contract execution
executorParams.disableSignatureCheck?booleanIf true, signature verification always succeds
executorParams.overrideBalance?string | numberExplicit account balance in nano EVER
withoutSignature?booleanWhether to prepare this message without signature. Default: false

Defined in:

src/contract.ts:972

SendExternalDelayedParams ​

Ƭ SendExternalDelayedParams: Object

Type declaration ​

NameTypeDescription
publicKeystringThe public key of the preferred account. It is the same publicKey as the accountInteraction.publicKey, but it must be explicitly provided
stateInit?stringOptional base64 encoded TVC

Defined in:

src/contract.ts:1008

CallParams ​

Ƭ CallParams: Object

Type declaration ​

NameTypeDescription
cachedState?FullContractStateCached contract state
responsible?booleanWhether to run the method locally as responsible. This will use internal message with unlimited account balance.

Defined in:

src/contract.ts:1023

ExecuteExternalParams ​

Ƭ ExecuteExternalParams: Object

Type declaration ​

NameTypeDescription
cachedState?FullContractStateCached contract state
publicKeystringThe public key of the signer.
stateInit?stringOptional base64 encoded TVC
executorParams?{ disableSignatureCheck?: boolean ; overrideBalance?: string | number }Optional executor parameters used during local contract execution
executorParams.disableSignatureCheck?booleanIf true, signature verification always succeeds
executorParams.overrideBalance?string | numberExplicit account balance in nano EVER
withoutSignature?booleanWhether to prepare this message without signature. Default: false

Defined in:

src/contract.ts:1039

ExecuteInternalParams ​

Ƭ ExecuteInternalParams: Object

Type declaration ​

NameTypeDescription
cachedState?FullContractStateCached contract state
stateInit?stringOptional base64 encoded TVC
senderAddressMessage source address
amountstringAmount of nano EVER to attach to the message
bounce?booleanWhether to bounce message back on error. Default: false
bounced?booleanWhether the constructed message is bounced. Default: false
executorParams?{ disableSignatureCheck?: boolean ; overrideBalance?: string | number }Optional executor parameters used during local contract execution
executorParams.disableSignatureCheck?booleanIf true, signature verification always succeeds
executorParams.overrideBalance?string | numberExplicit account balance in nano EVER

Defined in:

src/contract.ts:1074

GetPastEventParams ​

Ƭ GetPastEventParams<Abi, E>: Object

Type parameters ​

NameType
AbiAbi
Eextends AbiEventName<Abi>

Type declaration ​

NameType
filter?E | EventsFilter<Abi, AbiEventName<Abi>>
range?EventsRange
limit?number
continuation?TransactionId

Defined in:

src/contract.ts:1117

WaitForEventParams ​

Ƭ WaitForEventParams<Abi, E>: Object

Type parameters ​

NameType
AbiAbi
Eextends AbiEventName<Abi>

Type declaration ​

NameType
filter?E | EventsFilter<Abi, E>
range?EventsRange
subscriber?Subscriber

Defined in:

src/contract.ts:1127

EventsBatch ​

Ƭ EventsBatch<Abi, E>: Object

Type parameters ​

NameType
AbiAbi
Eextends AbiEventName<Abi>

Type declaration ​

NameType
eventsDecodedEventWithTransaction<Abi, E>[]
continuation?TransactionId

Defined in:

src/contract.ts:1136

EventsFilter ​

Ƭ EventsFilter<Abi, E>: (event: DecodedEventWithTransaction<Abi, E>) => Promise<boolean> | boolean

Type parameters ​

NameType
AbiAbi
Eextends AbiEventName<Abi> = AbiEventName<Abi>

Type declaration ​

▸ (event): Promise<boolean> | boolean

Parameters ​
NameType
eventDecodedEventWithTransaction<Abi, E>
Returns ​

Promise<boolean> | boolean

Defined in:

src/contract.ts:1144

DecodedEventWithTransaction ​

Ƭ DecodedEventWithTransaction<Abi, E>: DecodedEvent<Abi, E> & { transaction: Transaction }

Type parameters ​

NameType
AbiAbi
Eextends AbiEventName<Abi>

Defined in:

src/contract.ts:1151

EventsRange ​

Ƭ EventsRange: Object

Type declaration ​

NameType
fromLt?string
fromUtime?number
toLt?string
toUtime?number

Defined in:

src/contract.ts:1158

DecodeTransactionParams ​

Ƭ DecodeTransactionParams<Abi>: Object

Type parameters ​

Name
Abi

Type declaration ​

NameType
transactionTransaction
methodsUniqueArray<AbiFunctionName<Abi>[]>

Defined in:

src/contract.ts:1168

DecodedTransaction ​

Ƭ DecodedTransaction<Abi, T>: T extends AbiFunctionName<Abi> ? { method: T ; input: DecodedAbiFunctionInputs<Abi, T> ; output: DecodedAbiFunctionOutputs<Abi, T> } : never

Type parameters ​

Name
Abi
T

Defined in:

src/contract.ts:1176

DecodeInputParams ​

Ƭ DecodeInputParams<Abi>: Object

Type parameters ​

Name
Abi

Type declaration ​

NameType
bodystring
methodsUniqueArray<AbiFunctionName<Abi>[]>
internalboolean

Defined in:

src/contract.ts:1183

DecodedInput ​

Ƭ DecodedInput<Abi, T>: T extends AbiFunctionName<Abi> ? { method: T ; input: DecodedAbiFunctionInputs<Abi, T> } : never

Type parameters ​

Name
Abi
T

Defined in:

src/contract.ts:1192

DecodeOutputParams ​

Ƭ DecodeOutputParams<Abi>: Object

Type parameters ​

Name
Abi

Type declaration ​

NameTypeDescription
bodystringBase64 encoded message body BOC
methodsUniqueArray<AbiFunctionName<Abi>[]>-

Defined in:

src/contract.ts:1199

DecodeEventParams ​

Ƭ DecodeEventParams<Abi>: Object

Type parameters ​

Name
Abi

Type declaration ​

NameTypeDescription
bodystringBase64 encoded message body BOC
eventsUniqueArray<AbiEventName<Abi>[]>-

Defined in:

src/contract.ts:1210

DecodedOutput ​

Ƭ DecodedOutput<Abi, T>: T extends AbiFunctionName<Abi> ? { method: T ; output: DecodedAbiFunctionOutputs<Abi, T> } : never

Type parameters ​

Name
Abi
T

Defined in:

src/contract.ts:1221

DecodeTransactionEventsParams ​

Ƭ DecodeTransactionEventsParams: Object

Type declaration ​

NameType
transactionTransaction

Defined in:

src/contract.ts:1228

DecodedEvent ​

Ƭ DecodedEvent<Abi, T>: T extends AbiEventName<Abi> ? { event: T ; data: DecodedAbiEventData<Abi, T> } : never

Type parameters ​

Name
Abi
T

Defined in:

src/contract.ts:1235

ExecutorOutput ​

Ƭ ExecutorOutput<O>: Object

Type parameters ​

Name
O

Type declaration ​

NameTypeDescription
transactionTransactionExecuted transaction
newStateFullContractState | undefinedContract state after the executed transaction
outputO | undefinedParsed function call output

Defined in:

src/contract.ts:1242