Index
Classes
Interfaces
Functions
- arrayToHex
- blockTimestampToDate
- checkDateParse
- checkRange
- createInitialTypes
- createType
- dateToBlockTimestamp
- dateToTimePoint
- dateToTimePointSec
- deserializeAction
- deserializeActionData
- deserializeArray
- deserializeExtension
- deserializeOptional
- deserializeStruct
- deserializeUnknown
- deserializeVariant
- getType
- getTypesFromAbi
- hexToUint8Array
- serializeAction
- serializeActionData
- serializeArray
- serializeExtension
- serializeOptional
- serializeStruct
- serializeUnknown
- serializeVariant
- stringToSymbol
- supportedAbiVersion
- symbolToString
- timePointSecToDate
- timePointToDate
- transactionHeader
Functions
arrayToHex
▸ arrayToHex(data: Uint8Array): string
Defined in eosjs-serialize.ts:592
Convert binary data to hex
Parameters:
| Name | Type |
|---|---|
| data | Uint8Array |
Returns: string
blockTimestampToDate
▸ blockTimestampToDate(slot: number): string
Defined in eosjs-serialize.ts:569
Convert block_timestamp_type (half-seconds since a different epoch) to to date in ISO format
Parameters:
| Name | Type |
|---|---|
| slot | number |
Returns: string
checkDateParse
▸ checkDateParse(date: string): number
Defined in eosjs-serialize.ts:533
Parameters:
| Name | Type |
|---|---|
| date | string |
Returns: number
checkRange
▸ checkRange(orig: number, converted: number): number
Defined in eosjs-serialize.ts:765
Parameters:
| Name | Type |
|---|---|
| orig | number |
| converted | number |
Returns: number
createInitialTypes
▸ createInitialTypes(): Map<string, Type>
Defined in eosjs-serialize.ts:776
Create the set of types built-in to the abi format
Returns: Map<string, Type>
createType
▸ createType(attrs: CreateTypeArgs): Type
Defined in eosjs-serialize.ts:749
Parameters:
| Name | Type |
|---|---|
| attrs | CreateTypeArgs |
Returns: Type
dateToBlockTimestamp
▸ dateToBlockTimestamp(date: string): number
Defined in eosjs-serialize.ts:564
Convert date in ISO format to block_timestamp_type (half-seconds since a different epoch)
Parameters:
| Name | Type |
|---|---|
| date | string |
Returns: number
dateToTimePoint
▸ dateToTimePoint(date: string): number
Defined in eosjs-serialize.ts:542
Convert date in ISO format to time_point (miliseconds since epoch)
Parameters:
| Name | Type |
|---|---|
| date | string |
Returns: number
dateToTimePointSec
▸ dateToTimePointSec(date: string): number
Defined in eosjs-serialize.ts:553
Convert date in ISO format to time_point_sec (seconds since epoch)
Parameters:
| Name | Type |
|---|---|
| date | string |
Returns: number
deserializeAction
▸ deserializeAction(contract: Contract, account: string, name: string, authorization: Authorization[], data: string | Uint8Array | number[], textEncoder: TextEncoder, textDecoder: TextDecoder): Action
Defined in eosjs-serialize.ts:1104
Deserialize action. If data is a string, then it's assumed to be in hex.
Parameters:
| Name | Type |
|---|---|
| contract | Contract |
| account | string |
| name | string |
| authorization | Authorization[] |
| data | string | Uint8Array | number[] |
| textEncoder | TextEncoder |
| textDecoder | TextDecoder |
Returns: Action
deserializeActionData
▸ deserializeActionData(contract: Contract, account: string, name: string, data: string | Uint8Array | number[], textEncoder: TextEncoder, textDecoder: TextDecoder): any
Defined in eosjs-serialize.ts:1088
Deserialize action data. If data is a string, then it's assumed to be in hex.
Parameters:
| Name | Type |
|---|---|
| contract | Contract |
| account | string |
| name | string |
| data | string | Uint8Array | number[] |
| textEncoder | TextEncoder |
| textDecoder | TextDecoder |
Returns: any
deserializeArray
▸ deserializeArray(this: Type, buffer: SerialBuffer, state?: SerializerState, allowExtensions?: boolean): any[]
Defined in eosjs-serialize.ts:700
Parameters:
| Name | Type |
|---|---|
| this | Type |
| buffer | SerialBuffer |
Optional state |
SerializerState |
Optional allowExtensions |
boolean |
Returns: any[]
deserializeExtension
▸ deserializeExtension(this: Type, buffer: SerialBuffer, state?: SerializerState, allowExtensions?: boolean): any
Defined in eosjs-serialize.ts:732
Parameters:
| Name | Type |
|---|---|
| this | Type |
| buffer | SerialBuffer |
Optional state |
SerializerState |
Optional allowExtensions |
boolean |
Returns: any
deserializeOptional
▸ deserializeOptional(this: Type, buffer: SerialBuffer, state?: SerializerState, allowExtensions?: boolean): any
Defined in eosjs-serialize.ts:719
Parameters:
| Name | Type |
|---|---|
| this | Type |
| buffer | SerialBuffer |
Optional state |
SerializerState |
Optional allowExtensions |
boolean |
Returns: any
deserializeStruct
▸ deserializeStruct(this: Type, buffer: SerialBuffer, state?: SerializerState, allowExtensions?: boolean): any
Defined in eosjs-serialize.ts:653
Parameters:
| Name | Type | Default value |
|---|---|---|
| this | Type | - |
| buffer | SerialBuffer | - |
Default value state |
SerializerState | new SerializerState() |
Default value allowExtensions |
boolean |
true |
Returns: any
deserializeUnknown
▸ deserializeUnknown(buffer: SerialBuffer): SerialBuffer
Defined in eosjs-serialize.ts:624
Parameters:
| Name | Type |
|---|---|
| buffer | SerialBuffer |
Returns: SerialBuffer
deserializeVariant
▸ deserializeVariant(this: Type, buffer: SerialBuffer, state?: SerializerState, allowExtensions?: boolean): any[]
Defined in eosjs-serialize.ts:683
Parameters:
| Name | Type |
|---|---|
| this | Type |
| buffer | SerialBuffer |
Optional state |
SerializerState |
Optional allowExtensions |
boolean |
Returns: any[]
getType
▸ getType(types: Map<string, Type>, name: string): Type
Defined in eosjs-serialize.ts:974
Get type from types
Parameters:
| Name | Type |
|---|---|
| types | Map<string, Type> |
| name | string |
Returns: Type
getTypesFromAbi
▸ getTypesFromAbi(initialTypes: Map<string, Type>, abi: Abi): Map<string, Type>
Defined in eosjs-serialize.ts:1014
Get types from abi
Parameters:
| Name | Type | Description |
|---|---|---|
| initialTypes | Map<string, Type> |
Set of types to build on. In most cases, it's best to fill this from a fresh call to `getTypesFromAbi()`. |
| abi | Abi |
Returns: Map<string, Type>
hexToUint8Array
▸ hexToUint8Array(hex: string): Uint8Array
Defined in eosjs-serialize.ts:601
Convert hex to binary data
Parameters:
| Name | Type |
|---|---|
| hex | string |
Returns: Uint8Array
serializeAction
▸ serializeAction(contract: Contract, account: string, name: string, authorization: Authorization[], data: any, textEncoder: TextEncoder, textDecoder: TextDecoder): SerializedAction
Defined in eosjs-serialize.ts:1076
Return action in serialized form
Parameters:
| Name | Type |
|---|---|
| contract | Contract |
| account | string |
| name | string |
| authorization | Authorization[] |
| data | any |
| textEncoder | TextEncoder |
| textDecoder | TextDecoder |
Returns: SerializedAction
serializeActionData
▸ serializeActionData(contract: Contract, account: string, name: string, data: any, textEncoder: TextEncoder, textDecoder: TextDecoder): string
Defined in eosjs-serialize.ts:1064
Convert action data to serialized form (hex)
Parameters:
| Name | Type |
|---|---|
| contract | Contract |
| account | string |
| name | string |
| data | any |
| textEncoder | TextEncoder |
| textDecoder | TextDecoder |
Returns: string
serializeArray
▸ serializeArray(this: Type, buffer: SerialBuffer, data: any[], state?: SerializerState, allowExtensions?: boolean): void
Defined in eosjs-serialize.ts:692
Parameters:
| Name | Type |
|---|---|
| this | Type |
| buffer | SerialBuffer |
| data | any[] |
Optional state |
SerializerState |
Optional allowExtensions |
boolean |
Returns: void
serializeExtension
▸ serializeExtension(this: Type, buffer: SerialBuffer, data: any, state?: SerializerState, allowExtensions?: boolean): void
Defined in eosjs-serialize.ts:727
Parameters:
| Name | Type |
|---|---|
| this | Type |
| buffer | SerialBuffer |
| data | any |
Optional state |
SerializerState |
Optional allowExtensions |
boolean |
Returns: void
serializeOptional
▸ serializeOptional(this: Type, buffer: SerialBuffer, data: any, state?: SerializerState, allowExtensions?: boolean): void
Defined in eosjs-serialize.ts:709
Parameters:
| Name | Type |
|---|---|
| this | Type |
| buffer | SerialBuffer |
| data | any |
Optional state |
SerializerState |
Optional allowExtensions |
boolean |
Returns: void
serializeStruct
▸ serializeStruct(this: Type, buffer: SerialBuffer, data: any, state?: SerializerState, allowExtensions?: boolean): void
Defined in eosjs-serialize.ts:628
Parameters:
| Name | Type | Default value |
|---|---|---|
| this | Type | - |
| buffer | SerialBuffer | - |
| data | any |
- |
Default value state |
SerializerState | new SerializerState() |
Default value allowExtensions |
boolean |
true |
Returns: void
serializeUnknown
▸ serializeUnknown(buffer: SerialBuffer, data: any): SerialBuffer
Defined in eosjs-serialize.ts:620
Parameters:
| Name | Type |
|---|---|
| buffer | SerialBuffer |
| data | any |
Returns: SerialBuffer
serializeVariant
▸ serializeVariant(this: Type, buffer: SerialBuffer, data: any, state?: SerializerState, allowExtensions?: boolean): void
Defined in eosjs-serialize.ts:670
Parameters:
| Name | Type |
|---|---|
| this | Type |
| buffer | SerialBuffer |
| data | any |
Optional state |
SerializerState |
Optional allowExtensions |
boolean |
Returns: void
stringToSymbol
▸ stringToSymbol(s: string): object
Defined in eosjs-serialize.ts:575
Convert string to Symbol. format: precision,NAME.
Parameters:
| Name | Type |
|---|---|
| s | string |
Returns: object
supportedAbiVersion
▸ supportedAbiVersion(version: string): boolean
Defined in eosjs-serialize.ts:529
Is this a supported ABI version?
Parameters:
| Name | Type |
|---|---|
| version | string |
Returns: boolean
symbolToString
▸ symbolToString(__namedParameters: object): string
Defined in eosjs-serialize.ts:587
Convert Symbol to string. format: precision,NAME.
Parameters:
__namedParameters: object
| Name | Type |
|---|---|
| name | string |
| precision | number |
Returns: string
timePointSecToDate
▸ timePointSecToDate(sec: number): string
Defined in eosjs-serialize.ts:558
Convert time_point_sec (seconds since epoch) to to date in ISO format
Parameters:
| Name | Type |
|---|---|
| sec | number |
Returns: string
timePointToDate
▸ timePointToDate(us: number): string
Defined in eosjs-serialize.ts:547
Convert time_point (miliseconds since epoch) to date in ISO format
Parameters:
| Name | Type |
|---|---|
| us | number |
Returns: string
transactionHeader
▸ transactionHeader(refBlock: BlockTaposInfo, expireSeconds: number): object
Defined in eosjs-serialize.ts:1055
TAPoS: Return transaction fields which reference refBlock and expire expireSeconds after refBlock.timestamp
Parameters:
| Name | Type |
|---|---|
| refBlock | BlockTaposInfo |
| expireSeconds | number |
Returns: object