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
称号范例
(可选的)abiProviderAbiProvider
(可选的)authorityProviderAuthorityProvider
(可选的)chainIdstring
rpcJsonRpc
signatureProviderSignatureProvider
(可选的)textDecoderTextDecoder
(可选的)textEncoderTextEncoder

返回: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中。

参数:

称号范例
bufferser.SerialBuffer
typestring

返回:any

deserializeActions

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

定义于eosjs-api.ts:187

从十六进制转换操纵

参数:

称号范例
actionsser.Action[]

返回:Promise<ser.Action[]>

deserializeTransaction

deserializeTransaction(transaction: Uint8Array): any

定义于eosjs-api.ts:171

从二进制转换生意业务,将操纵保存为十六进制

参数:

称号范例
transactionUint8Array

返回: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,须要时提取

参数:

称号范例默认值
accountNamestring
Default value reloadbooleanfalse

返回:Promise<Abi>

getCachedAbi

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

定义于eosjs-api.ts:93

以二进制和结构化情势猎取abi,须要时提取

参数:

称号范例默认值
accountNamestring
Default value reloadbooleanfalse

返回:Promise<CachedAbi>

getContract

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

定义于eosjs-api.ts:130

猎取序列化合约中的操纵所需的数据

参数:

称号范例默认值
accountNamestring
Default value reloadbooleanfalse

返回:Promise<ser.Contract>

getTransactionAbis

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

定义于eosjs-api.ts:119

猎取生意业务所需的abi

参数:

称号范例默认值
transactionany
Default value reloadbooleanfalse

返回:Promise<BinaryAbi[]>

pushSignedTransaction

pushSignedTransaction(__namedParameters: object): Promise<any>

定义于eosjs-api.ts:259

播送已署名的生意业务

__namedParameters:object

称号范例
serializedTransactionUint8Array
signaturesstring[]

返回:Promise<any>

rawAbiToJson

rawAbiToJson(rawAbi: Uint8Array): Abi

定义于eosjs-api.ts:79

将abi作为Uint8Array解码为json

参数:

称号范例
rawAbiUint8Array

返回:Abi

serialize

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

定义于eosjs-api.ts:146

value转换为二进制情势,type必需是内置的abi范例或许在transaction.abi.json中。

参数:

称号范例
bufferser.SerialBuffer
typestring
valueany

返回:void

serializeActions

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

定义于eosjs-api.ts:178

将操纵转换为十六进制

参数:

称号范例
actionsser.Action[]

返回:Promise<ser.SerializedAction[]>

serializeTransaction

serializeTransaction(transaction: any): Uint8Array

定义于eosjs-api.ts:156

将生意业务转换为二进制

参数:

称号范例
transactionany

返回:Uint8Array

transact

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

定义于eosjs-api.ts:216

建立并可挑选播送生意业务

定名参数:

  • broadcast:播送此生意业务?
  • sign:署名此生意业务?
  • 假如blocksBehindexpireSeconds都存在,然后提取块头背面的blockBehind块,将其用作TAPoS的援用,并在该块的时候expireSeconds以后逾期生意业务。

参数:

transaction:any

Default value __namedParameters:object

称号范例默认值
blocksBehindnumber
broadcastbooleantrue
expireSecondsnumber
signbooleantrue

返回:假如broadcast,则Promise<any>节点相应,假如!broadcast{signatures, serializedTransaction}

上一篇:读取区块链

下一篇:API接口

    原文作者:博弈
    原文地址: https://segmentfault.com/a/1190000017713147
    本文转自网络文章,转载此文章仅为分享知识,如有侵权,请联系博主进行删除。
点赞