Skip to content
On this page

Models

GenTimings

Ƭ GenTimings: Object

Type declaration

NameType
genLtstring
genUtimenumber

Defined in:

src/models.ts:26


ContractUpdatesSubscription

Ƭ ContractUpdatesSubscription: Object

Type declaration

NameTypeDescription
statebooleanWhether to listen contract state updates
transactionsbooleanWhether to listen new contract transactions

Defined in:

src/models.ts:34


TransactionsBatchInfo

Ƭ TransactionsBatchInfo: Object

Type declaration

NameType
minLtstring
maxLtstring
batchTypeTransactionsBatchType

Defined in:

src/models.ts:48


TransactionsBatchType

Ƭ TransactionsBatchType: "old" | "new"

Defined in:

src/models.ts:57


Transaction

Ƭ Transaction<Addr>: Object

Type parameters

NameType
AddrAddress

Type declaration

NameType
idTransactionId
prevTransactionId?TransactionId
createdAtnumber
abortedboolean
exitCode?number
resultCode?number
origStatusAccountStatus
endStatusAccountStatus
totalFeesstring
inMessageMessage<Addr>
outMessagesMessage<Addr>[]

Defined in:

src/models.ts:62


TransactionWithAccount

Ƭ TransactionWithAccount<Addr>: Transaction<Addr> & { account: Addr }

Type parameters

NameType
AddrAddress

Defined in:

src/models.ts:79


RawTransaction

Ƭ RawTransaction: Transaction<string>

Defined in:

src/models.ts:84


serializeTransaction

serializeTransaction(transaction): RawTransaction

Parameters

NameType
transactionTransaction<Address>

Returns

RawTransaction

Defined in:

src/models.ts:89


parseTransaction

parseTransaction(transaction): Transaction

Parameters

NameType
transactionRawTransaction

Returns

Transaction

Defined in:

src/models.ts:118


Message

Ƭ Message<Addr>: Object

Type parameters

NameType
AddrAddress

Type declaration

NameType
hashstring
src?Addr
dst?Addr
valuestring
bounceboolean
bouncedboolean
body?string
bodyHash?string

Defined in:

src/models.ts:129


RawMessage

Ƭ RawMessage: Message<string>

Defined in:

src/models.ts:143


serializeMessage

serializeMessage(message): RawMessage

Parameters

NameType
messageMessage<Address>

Returns

RawMessage

Defined in:

src/models.ts:148


parseMessage

parseMessage(message): Message

Parameters

NameType
messageRawMessage

Returns

Message

Defined in:

src/models.ts:165


DelayedMessage

Ƭ DelayedMessage<Addr>: Object

Type parameters

NameType
AddrAddress

Type declaration

NameTypeDescription
hashstringExternal message hash
accountAddrDestination account address (sender for sendMessageDelayed, recipient for sendExternalMessageDelayed)
expireAtnumberMessage expiration timestamp

Defined in:

src/models.ts:176


AccountStatus

Ƭ AccountStatus: "uninit" | "frozen" | "active" | "nonexist"

Defined in:

src/models.ts:194


LastTransactionId

Ƭ LastTransactionId: Object

Type declaration

NameType
isExactboolean
ltstring
hash?string

Defined in:

src/models.ts:199


TransactionId

Ƭ TransactionId: Object

Type declaration

NameType
ltstring
hashstring

Defined in:

src/models.ts:208


Permissions

Ƭ Permissions<Addr>: Object

Type parameters

NameType
AddrAddress

Type declaration

NameType
basictrue
accountInteraction{ address: Addr ; publicKey: string ; contractType: string }
accountInteraction.addressAddr
accountInteraction.publicKeystring
accountInteraction.contractTypestring

Defined in:

src/models.ts:218


RawPermissions

Ƭ RawPermissions: Permissions<string>

Defined in:

src/models.ts:230


parsePermissions

parsePermissions(permissions): Partial<Permissions>

Parameters

NameType
permissionsPartial<RawPermissions>

Returns

Partial<Permissions>

Defined in:

src/models.ts:235


parseAccountInteraction

parseAccountInteraction(accountInteraction): Required<Permissions>["accountInteraction"]

Parameters

NameType
accountInteractionObject
accountInteraction.addressstring
accountInteraction.publicKeystring
accountInteraction.contractTypestring

Returns

Required<Permissions>["accountInteraction"]

Defined in:

src/models.ts:247


Permission

Ƭ Permission: keyof Permissions

Defined in:

src/models.ts:259


PermissionData

Ƭ PermissionData<T, Addr>: Permissions<Addr>[T]

Type parameters

NameType
Textends Permission
AddrAddress

Defined in:

src/models.ts:264


AssetType

Ƭ AssetType: "tip3_token"

Defined in:

src/models.ts:271


AssetTypeParams

Ƭ AssetTypeParams<T, Addr>: T extends "tip3_token" ? { rootContract: Addr } : never

Type parameters

NameType
Textends AssetType
AddrAddress

Defined in:

src/models.ts:276


EncryptionAlgorithm

Ƭ EncryptionAlgorithm: "ChaCha20Poly1305"

Defined in:

src/models.ts:285


EncryptedData

Ƭ EncryptedData: Object

Type declaration

NameTypeDescription
algorithmEncryptionAlgorithm-
sourcePublicKeystringHex encoded encryptor's public key
recipientPublicKeystringHex encoded recipient public key
datastringBase64 encoded data
noncestringBase64 encoded nonce

Defined in:

src/models.ts:290


AbiVersion

Ƭ AbiVersion: "1.0" | "2.0" | "2.1" | "2.2" | "2.3"

Defined in:

src/models.ts:315


TokenValue

Ƭ TokenValue<Addr>: null | boolean | string | number | Addr | { [K in string]: TokenValue<Addr> } | TokenValue<Addr>[] | readonly [TokenValue<Addr>, TokenValue<Addr>][]

Type parameters

NameType
AddrAddress

Defined in:

src/models.ts:320


RawTokenValue

Ƭ RawTokenValue: TokenValue<string>

Defined in:

src/models.ts:333


TokensObject

Ƭ TokensObject<Addr>: { [K in string]: TokenValue<Addr> }

Type parameters

NameType
AddrAddress

Defined in:

src/models.ts:338


RawTokensObject

Ƭ RawTokensObject: TokensObject<string>

Defined in:

src/models.ts:343


FunctionCall

Ƭ FunctionCall<Addr>: Object

Type parameters

NameType
AddrAddress

Type declaration

NameTypeDescription
abistringContract ABI
methodstringSpecific method from specified contract ABI
paramsTokensObject<Addr>Method arguments

Defined in:

src/models.ts:348


AbiParamKind

Ƭ AbiParamKind: AbiParamKindUint | AbiParamKindInt | AbiParamKindVarUint | AbiParamKindVarInt | AbiParamKindTuple | AbiParamKindBool | AbiParamKindCell | AbiParamKindAddress | AbiParamKindBytes | AbiParamKindFixedBytes | AbiParamKindString | AbiParamKindGram | AbiParamKindTime | AbiParamKindExpire | AbiParamKindPublicKey

Defined in:

src/models.ts:394


AbiParam

Ƭ AbiParam: Object

Type declaration

NameType
namestring
typeAbiParamKind | AbiParamKindMap | AbiParamKindArray | AbiParamOptional | AbiParamRef | AbiParamOptionalRef | AbiParamRefOptional
components?AbiParam[]

Defined in:

src/models.ts:414


ReadonlyAbiParam

Ƭ ReadonlyAbiParam: Object

Type declaration

NameType
namestring
typeAbiParamKind | AbiParamKindMap | AbiParamKindArray | AbiParamOptional | AbiParamRef | AbiParamOptionalRef | AbiParamRefOptional
components?readonly ReadonlyAbiParam[]

Defined in:

src/models.ts:430


serializeTokensObject

serializeTokensObject(object): RawTokensObject

Parameters

NameType
objectTokensObject<Address>

Returns

RawTokensObject

Defined in:

src/models.ts:446


parseTokensObject

parseTokensObject(params, object): TokensObject

Parameters

NameType
paramsAbiParam[]
objectRawTokensObject

Returns

TokensObject

Defined in:

src/models.ts:475


parsePartialTokensObject

parsePartialTokensObject(params, object): TokensObject

Parameters

NameType
paramsAbiParam[]
objectPartial<RawTokensObject>

Returns

TokensObject

Defined in:

src/models.ts:486


InputTokenObject

Ƭ InputTokenObject<O>: O extends { name: infer K ; type: infer T ; components?: infer C } ? K extends string ? { [P in K]: InputTokenValue<T, C> } : never : never

Type parameters

Name
O

Defined in:

src/models.ts:595


OutputTokenObject

Ƭ OutputTokenObject<O>: O extends { name: infer K ; type: infer T ; components?: infer C } ? K extends string ? { [P in K]: OutputTokenValue<T, C> } : never : never

Type parameters

Name
O

Defined in:

src/models.ts:604


MergeInputObjectsArray

Ƭ MergeInputObjectsArray<A>: A extends readonly [infer T, ...(infer Ts)] ? InputTokenObject<T> & MergeInputObjectsArray<[...Ts]> : A extends readonly [infer T] ? InputTokenObject<T> : A extends readonly [] ? {} : never

Type parameters

Name
A

Defined in:

src/models.ts:613


MergeOutputObjectsArray

Ƭ MergeOutputObjectsArray<A>: A extends readonly [infer T, ...(infer Ts)] ? OutputTokenObject<T> & MergeOutputObjectsArray<[...Ts]> : A extends readonly [infer T] ? OutputTokenObject<T> : A extends readonly [] ? {} : never

Type parameters

Name
A

Defined in:

src/models.ts:624


AbiFunctionName

Ƭ AbiFunctionName<C>: AbiFunction<C>["name"]

Type parameters

Name
C

Defined in:

src/models.ts:642


AbiEventName

Ƭ AbiEventName<C>: AbiEvent<C>["name"]

Type parameters

Name
C

Defined in:

src/models.ts:646


AbiFieldName

Ƭ AbiFieldName<C>: keyof DecodedAbiFields<C>

Type parameters

Name
C

Defined in:

src/models.ts:650


AbiFunctionInputs

Ƭ AbiFunctionInputs<C, T>: MergeInputObjectsArray<PickFunction<C, T>["inputs"]>

Type parameters

NameType
CC
Textends AbiFunctionName<C>

Defined in:

src/models.ts:658


AbiFunctionInputsWithDefault

Ƭ AbiFunctionInputsWithDefault<C, T>: PickFunction<C, T>["inputs"] extends readonly [] ? void | Record<string, never> : AbiFunctionInputs<C, T>

Type parameters

NameType
CC
Textends AbiFunctionName<C>

Defined in:

src/models.ts:663


DecodedAbiFunctionInputs

Ƭ DecodedAbiFunctionInputs<C, T>: MergeOutputObjectsArray<PickFunction<C, T>["inputs"]>

Type parameters

NameType
CC
Textends AbiFunctionName<C>

Defined in:

src/models.ts:673


DecodedAbiFunctionOutputs

Ƭ DecodedAbiFunctionOutputs<C, T>: MergeOutputObjectsArray<PickFunction<C, T>["outputs"]>

Type parameters

NameType
CC
Textends AbiFunctionName<C>

Defined in:

src/models.ts:679


DecodedAbiEventData

Ƭ DecodedAbiEventData<C, T>: MergeOutputObjectsArray<PickEvent<C, T>["inputs"]>

Type parameters

NameType
CC
Textends AbiEventName<C>

Defined in:

src/models.ts:685


DecodedAbiInitData

Ƭ DecodedAbiInitData<C>: C extends { data: infer D } ? Partial<MergeOutputObjectsArray<D>> : never

Type parameters

Name
C

Defined in:

src/models.ts:690


DecodedAbiFields

Ƭ DecodedAbiFields<C>: C extends { fields: infer F } ? MergeOutputObjectsArray<F> : never

Type parameters

Name
C

Defined in:

src/models.ts:695