eosjs 文檔（API）

API

類

• Api

變量

• abiAbi
• transactionAbi

變量

<Const> abiAbi

• abiAbi：any = require('../src/abi.abi.json')

定義於eosjs-api.ts:12

<Const> transactionAbi

• transactionAbi：any = require('../src/transaction.abi.json')

定義於eosjs-api.ts:14

構造函數

new Api(args: object): Api

定義於eosjs-api.ts:45

參數：

args: object

• rpc：發出RPC調用
• authorityProvider：獲取在交易中知足權限所需的公鑰
• abiProvider：以原始形式供應ABI（二進制）
• signatureProvider：簽名交易
• chainId：標識鏈
• textEncoder：要使用的TextEncoder實例，若是在瀏覽器中運行，則傳入null
• textDecoder：要使用的TextDecoder實例，若是在瀏覽器中運行，則傳入null

名稱	類型
（可選的）abiProvider	AbiProvider
（可選的）authorityProvider	AuthorityProvider
（可選的）chainId	string
rpc	JsonRpc
signatureProvider	SignatureProvider
（可選的）textDecoder	TextDecoder
（可選的）textEncoder	TextEncoder

返回：Api

屬性

abiProvider

• abiProvider：AbiProvider

定義於eosjs-api.ts:24

以原始形式供應ABI（二進制）

abiTypes

• abiTypes：Map<string, ser.Type>

定義於eosjs-api.ts:36

在二進制和結構化形式之間轉換abi文件（abi.abi.json）

authorityProvider

• authorityProvider：AuthorityProvider

定義於eosjs-api.ts:21

獲取知足transaction權限所需的availableKeys子集

cachedAbis

• cachedAbis：Map<string, CachedAbi> = new Map()

定義於eosjs-api.ts:45

提取abi

chainId

• chainId：string

定義於eosjs-api.ts:30

標識鏈

contracts

• contracts：Map<string, Contract> = new Map()

定義於eosjs-api.ts:42

保存序列化合約操做所需的信息

rpc

• rpc：JsonRpc

定義於eosjs-api.ts:18

發出RPC調用

signatureProvider

• signatureProvider：SignatureProvider

定義於eosjs-api.ts:27

簽名交易

textDecoder

• textDecoder：TextDecoder

定義於eosjs-api.ts:33

textEncoder

• textEncoder：TextEncoder

定義於eosjs-api.ts:32

transactionTypes

• transactionTypes：Map<string, ser.Type>

定義於eosjs-api.ts:39

在二進制和結構化形式之間轉換交易（transaction.abi.json）

方法

deserialize

deserialize(buffer: ser.SerialBuffer, type: string): any

定義於eosjs-api.ts:151

將buffer中的數據轉換爲結構化形式，type必須是內置的abi類型或者在transaction.abi.json中。

參數：

名稱	類型
buffer	ser.SerialBuffer
type	string

返回：any

deserializeActions

deserializeActions(actions: ser.Action[]): Promise<ser.Action[]>

定義於eosjs-api.ts:187

從十六進制轉換操做

參數：

名稱	類型
actions	ser.Action[]

返回：Promise<ser.Action[]>

deserializeTransaction

deserializeTransaction(transaction: Uint8Array): any

定義於eosjs-api.ts:171

從二進制轉換交易，將操做保留爲十六進制

參數：

名稱	類型
transaction	Uint8Array

返回：any

deserializeTransactionWithActions

deserializeTransactionWithActions(transaction: Uint8Array | string): Promise<any>

定義於eosjs-api.ts:196

從二進制轉換交易，同時反序列化操做

參數：

名稱	類型
transaction	Uint8Array | string

返回：Promise<any>

getAbi

getAbi(accountName: string, reload?: boolean): Promise<Abi>

定義於eosjs-api.ts:114

以結構化形式獲取abi，須要時提取

參數：

名稱	類型	默認值
accountName	string	-
Default value reload	boolean	false

返回：Promise<Abi>

getCachedAbi

getCachedAbi(accountName: string, reload?: boolean): Promise<CachedAbi>

定義於eosjs-api.ts:93

以二進制和結構化形式獲取abi，須要時提取

參數：

名稱	類型	默認值
accountName	string	-
Default value reload	boolean	false

返回：Promise<CachedAbi>

getContract

getContract(accountName: string, reload?: boolean): Promise<ser.Contract>

定義於eosjs-api.ts:130

獲取序列化合約中的操做所需的數據

參數：

名稱	類型	默認值
accountName	string	-
Default value reload	boolean	false

返回：Promise<ser.Contract>

getTransactionAbis

getTransactionAbis(transaction: any, reload?: boolean): Promise<BinaryAbi[]>

定義於eosjs-api.ts:119

獲取交易所需的abi

參數：

名稱	類型	默認值
transaction	any	-
Default value reload	boolean	false

返回：Promise<BinaryAbi[]>

pushSignedTransaction

pushSignedTransaction(__namedParameters: object): Promise<any>

定義於eosjs-api.ts:259

廣播已簽名的交易

__namedParameters：object

名稱	類型
serializedTransaction	Uint8Array
signatures	string[]

返回：Promise<any>

rawAbiToJson

rawAbiToJson(rawAbi: Uint8Array): Abi

定義於eosjs-api.ts:79

將abi做爲Uint8Array解碼爲json

參數：

名稱	類型
rawAbi	Uint8Array

返回：Abi

serialize

serialize(buffer: ser.SerialBuffer, type: string, value: any): void

定義於eosjs-api.ts:146

將value轉換爲二進制形式，type必須是內置的abi類型或者在transaction.abi.json中。

參數：

名稱	類型
buffer	ser.SerialBuffer
type	string
value	any

返回：void

serializeActions

serializeActions(actions: ser.Action[]): Promise<ser.SerializedAction[]>

定義於eosjs-api.ts:178

將操做轉換爲十六進制

參數：

名稱	類型
actions	ser.Action[]

返回：Promise<ser.SerializedAction[]>

serializeTransaction

serializeTransaction(transaction: any): Uint8Array

定義於eosjs-api.ts:156

將交易轉換爲二進制

參數：

名稱	類型
transaction	any

返回：Uint8Array

transact

transact(transaction: any, __namedParameters?: object): Promise<any>

定義於eosjs-api.ts:216

建立並可選擇廣播交易

命名參數：

• broadcast：廣播此交易？
• sign：簽名此交易？
• 若是blocksBehind和expireSeconds都存在，而後提取塊頭後面的blockBehind塊，將其用做TAPoS的引用，並在該塊的時間expireSeconds以後過時交易。

參數：

transaction：any

Default value __namedParameters：object

名稱	類型	默認值
blocksBehind	number	-
broadcast	boolean	true
expireSeconds	number	-
sign	boolean	true

返回：若是broadcast，則Promise<any>節點響應，若是!broadcast 則{signatures, serializedTransaction}。

---

上一篇：讀取區塊鏈

下一篇：API接口