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接口