Models
GenTimings
Ƭ GenTimings: Object
Type declaration
| Name | Type |
|---|---|
genLt | string |
genUtime | number |
Defined in:
ContractUpdatesSubscription
Ƭ ContractUpdatesSubscription: Object
Type declaration
| Name | Type | Description |
|---|---|---|
state | boolean | Whether to listen contract state updates |
transactions | boolean | Whether to listen new contract transactions |
Defined in:
TransactionsBatchInfo
Ƭ TransactionsBatchInfo: Object
Type declaration
| Name | Type |
|---|---|
minLt | string |
maxLt | string |
batchType | TransactionsBatchType |
Defined in:
TransactionsBatchType
Ƭ TransactionsBatchType: "old" | "new"
Defined in:
Transaction
Ƭ Transaction<Addr>: Object
Type parameters
| Name | Type |
|---|---|
Addr | Address |
Type declaration
| Name | Type |
|---|---|
id | TransactionId |
prevTransactionId? | TransactionId |
createdAt | number |
aborted | boolean |
exitCode? | number |
resultCode? | number |
origStatus | AccountStatus |
endStatus | AccountStatus |
totalFees | string |
inMessage | Message<Addr> |
outMessages | Message<Addr>[] |
Defined in:
TransactionWithAccount
Ƭ TransactionWithAccount<Addr>: Transaction<Addr> & { account: Addr }
Type parameters
| Name | Type |
|---|---|
Addr | Address |
Defined in:
RawTransaction
Ƭ RawTransaction: Transaction<string>
Defined in:
serializeTransaction
▸ serializeTransaction(transaction): RawTransaction
Parameters
| Name | Type |
|---|---|
transaction | Transaction<Address> |
Returns
Defined in:
parseTransaction
▸ parseTransaction(transaction): Transaction
Parameters
| Name | Type |
|---|---|
transaction | RawTransaction |
Returns
Defined in:
Message
Ƭ Message<Addr>: Object
Type parameters
| Name | Type |
|---|---|
Addr | Address |
Type declaration
| Name | Type |
|---|---|
hash | string |
src? | Addr |
dst? | Addr |
value | string |
bounce | boolean |
bounced | boolean |
body? | string |
bodyHash? | string |
Defined in:
RawMessage
Ƭ RawMessage: Message<string>
Defined in:
serializeMessage
▸ serializeMessage(message): RawMessage
Parameters
| Name | Type |
|---|---|
message | Message<Address> |
Returns
Defined in:
parseMessage
▸ parseMessage(message): Message
Parameters
| Name | Type |
|---|---|
message | RawMessage |
Returns
Defined in:
DelayedMessage
Ƭ DelayedMessage<Addr>: Object
Type parameters
| Name | Type |
|---|---|
Addr | Address |
Type declaration
| Name | Type | Description |
|---|---|---|
hash | string | External message hash |
account | Addr | Destination account address (sender for sendMessageDelayed, recipient for sendExternalMessageDelayed) |
expireAt | number | Message expiration timestamp |
Defined in:
AccountStatus
Ƭ AccountStatus: "uninit" | "frozen" | "active" | "nonexist"
Defined in:
LastTransactionId
Ƭ LastTransactionId: Object
Type declaration
| Name | Type |
|---|---|
isExact | boolean |
lt | string |
hash? | string |
Defined in:
TransactionId
Ƭ TransactionId: Object
Type declaration
| Name | Type |
|---|---|
lt | string |
hash | string |
Defined in:
Permissions
Ƭ Permissions<Addr>: Object
Type parameters
| Name | Type |
|---|---|
Addr | Address |
Type declaration
| Name | Type |
|---|---|
basic | true |
accountInteraction | { address: Addr ; publicKey: string ; contractType: string } |
accountInteraction.address | Addr |
accountInteraction.publicKey | string |
accountInteraction.contractType | string |
Defined in:
RawPermissions
Ƭ RawPermissions: Permissions<string>
Defined in:
parsePermissions
▸ parsePermissions(permissions): Partial<Permissions>
Parameters
| Name | Type |
|---|---|
permissions | Partial<RawPermissions> |
Returns
Partial<Permissions>
Defined in:
parseAccountInteraction
▸ parseAccountInteraction(accountInteraction): Required<Permissions>["accountInteraction"]
Parameters
| Name | Type |
|---|---|
accountInteraction | Object |
accountInteraction.address | string |
accountInteraction.publicKey | string |
accountInteraction.contractType | string |
Returns
Required<Permissions>["accountInteraction"]
Defined in:
Permission
Ƭ Permission: keyof Permissions
Defined in:
PermissionData
Ƭ PermissionData<T, Addr>: Permissions<Addr>[T]
Type parameters
| Name | Type |
|---|---|
T | extends Permission |
Addr | Address |
Defined in:
AssetType
Ƭ AssetType: "tip3_token"
Defined in:
AssetTypeParams
Ƭ AssetTypeParams<T, Addr>: T extends "tip3_token" ? { rootContract: Addr } : never
Type parameters
| Name | Type |
|---|---|
T | extends AssetType |
Addr | Address |
Defined in:
EncryptionAlgorithm
Ƭ EncryptionAlgorithm: "ChaCha20Poly1305"
Defined in:
EncryptedData
Ƭ EncryptedData: Object
Type declaration
| Name | Type | Description |
|---|---|---|
algorithm | EncryptionAlgorithm | - |
sourcePublicKey | string | Hex encoded encryptor's public key |
recipientPublicKey | string | Hex encoded recipient public key |
data | string | Base64 encoded data |
nonce | string | Base64 encoded nonce |
Defined in:
AbiVersion
Ƭ AbiVersion: "1.0" | "2.0" | "2.1" | "2.2" | "2.3"
Defined in:
TokenValue
Ƭ TokenValue<Addr>: null | boolean | string | number | Addr | { [K in string]: TokenValue<Addr> } | TokenValue<Addr>[] | readonly [TokenValue<Addr>, TokenValue<Addr>][]
Type parameters
| Name | Type |
|---|---|
Addr | Address |
Defined in:
RawTokenValue
Ƭ RawTokenValue: TokenValue<string>
Defined in:
TokensObject
Ƭ TokensObject<Addr>: { [K in string]: TokenValue<Addr> }
Type parameters
| Name | Type |
|---|---|
Addr | Address |
Defined in:
RawTokensObject
Ƭ RawTokensObject: TokensObject<string>
Defined in:
FunctionCall
Ƭ FunctionCall<Addr>: Object
Type parameters
| Name | Type |
|---|---|
Addr | Address |
Type declaration
| Name | Type | Description |
|---|---|---|
abi | string | Contract ABI |
method | string | Specific method from specified contract ABI |
params | TokensObject<Addr> | Method arguments |
Defined in:
AbiParamKind
Ƭ AbiParamKind: AbiParamKindUint | AbiParamKindInt | AbiParamKindVarUint | AbiParamKindVarInt | AbiParamKindTuple | AbiParamKindBool | AbiParamKindCell | AbiParamKindAddress | AbiParamKindBytes | AbiParamKindFixedBytes | AbiParamKindString | AbiParamKindGram | AbiParamKindTime | AbiParamKindExpire | AbiParamKindPublicKey
Defined in:
AbiParam
Ƭ AbiParam: Object
Type declaration
| Name | Type |
|---|---|
name | string |
type | AbiParamKind | AbiParamKindMap | AbiParamKindArray | AbiParamOptional | AbiParamRef | AbiParamOptionalRef | AbiParamRefOptional |
components? | AbiParam[] |
Defined in:
ReadonlyAbiParam
Ƭ ReadonlyAbiParam: Object
Type declaration
| Name | Type |
|---|---|
name | string |
type | AbiParamKind | AbiParamKindMap | AbiParamKindArray | AbiParamOptional | AbiParamRef | AbiParamOptionalRef | AbiParamRefOptional |
components? | readonly ReadonlyAbiParam[] |
Defined in:
serializeTokensObject
▸ serializeTokensObject(object): RawTokensObject
Parameters
| Name | Type |
|---|---|
object | TokensObject<Address> |
Returns
Defined in:
parseTokensObject
▸ parseTokensObject(params, object): TokensObject
Parameters
| Name | Type |
|---|---|
params | AbiParam[] |
object | RawTokensObject |
Returns
Defined in:
parsePartialTokensObject
▸ parsePartialTokensObject(params, object): TokensObject
Parameters
| Name | Type |
|---|---|
params | AbiParam[] |
object | Partial<RawTokensObject> |
Returns
Defined in:
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:
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:
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:
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:
AbiFunctionName
Ƭ AbiFunctionName<C>: AbiFunction<C>["name"]
Type parameters
| Name |
|---|
C |
Defined in:
AbiEventName
Ƭ AbiEventName<C>: AbiEvent<C>["name"]
Type parameters
| Name |
|---|
C |
Defined in:
AbiFieldName
Ƭ AbiFieldName<C>: keyof DecodedAbiFields<C>
Type parameters
| Name |
|---|
C |
Defined in:
AbiFunctionInputs
Ƭ AbiFunctionInputs<C, T>: MergeInputObjectsArray<PickFunction<C, T>["inputs"]>
Type parameters
| Name | Type |
|---|---|
C | C |
T | extends AbiFunctionName<C> |
Defined in:
AbiFunctionInputsWithDefault
Ƭ AbiFunctionInputsWithDefault<C, T>: PickFunction<C, T>["inputs"] extends readonly [] ? void | Record<string, never> : AbiFunctionInputs<C, T>
Type parameters
| Name | Type |
|---|---|
C | C |
T | extends AbiFunctionName<C> |
Defined in:
DecodedAbiFunctionInputs
Ƭ DecodedAbiFunctionInputs<C, T>: MergeOutputObjectsArray<PickFunction<C, T>["inputs"]>
Type parameters
| Name | Type |
|---|---|
C | C |
T | extends AbiFunctionName<C> |
Defined in:
DecodedAbiFunctionOutputs
Ƭ DecodedAbiFunctionOutputs<C, T>: MergeOutputObjectsArray<PickFunction<C, T>["outputs"]>
Type parameters
| Name | Type |
|---|---|
C | C |
T | extends AbiFunctionName<C> |
Defined in:
DecodedAbiEventData
Ƭ DecodedAbiEventData<C, T>: MergeOutputObjectsArray<PickEvent<C, T>["inputs"]>
Type parameters
| Name | Type |
|---|---|
C | C |
T | extends AbiEventName<C> |
Defined in:
DecodedAbiInitData
Ƭ DecodedAbiInitData<C>: C extends { data: infer D } ? Partial<MergeOutputObjectsArray<D>> : never
Type parameters
| Name |
|---|
C |
Defined in:
DecodedAbiFields
Ƭ DecodedAbiFields<C>: C extends { fields: infer F } ? MergeOutputObjectsArray<F> : never
Type parameters
| Name |
|---|
C |
Defined in: