@acc-toppings/api-postgres-plugin 中文文档教程

发布于 5年前 浏览 15 项目主页 更新于 3年前

api-postgres-plugin NPM Version

使用 pg 的 RESTful API 服务从由 (history-tools)fill-pg 和 SHiP-plugin 编写的 POstgresDB 获取数据。

Currently Available API Functions

下面的 API 函数都接受一个参数,一个查询,它基本上是一个包含几个键的对象,这些键由查询数据库的必要值组成。

get_action_details

根据 block_num(区块编号)、id(交易 ID)和 action_ordinal 获取特定操作的详细信息。

  • block_num - string or number
  • id - string
  • action_ordinal - number

get_actions

Get the list of actions based on certain criteria:

  • account_name - string - if this value is passed then it fetches latest 100 transactions for smart contract account_name
  • records_count - string - Number of actions to fetch (default is 100)

get_all_permissions

根据要显示的records_count 的数量获取所有最后权限的列表。

  • records_count - string
  • account_name - if this is passed then fetches the permission for only that account_name

get_block_details

根据 id_or_num 和 RPC endpoint 指示的 ID 或编号获取块的详细信息以获取操作负载。

  • endpoint - string
  • id_or_num - string

get_blocks

根据特定条件

  • show_empty - string - Whether to show empty blocks or not
  • records_count - string - Number of blocks to show

getpermissionsbypublickey

获取区块列表: 根据其 public_key

  • public_key - string

get_smart_contracts

获取权限列表 根据要显示的 records_count 数量获取所有可用智能合约的列表。

  • records_count - string

get_transaction_details

根据其 id 和 RPC endpoint 获取特定事务的详细信息以获取操作负载。

  • id - string
  • endpoint - string

get_transactions

根据特定条件获取交易列表:

  • records_count - string - Number of transactions to show

api-postgres-plugin NPM Version

RESTful API service making use of pg obtain data from POstgresDB which written by (history-tools)fill-pg with SHiP-plugin.

Currently Available API Functions

The following API functions all accept a single parameter, a query which is basically an object containing several keys composed of the necessary values to query the database.

get_action_details

Get the details of a particular action based on its block_num (block number), id (transaction id) and action_ordinal.

  • block_num - string or number
  • id - string
  • action_ordinal - number

get_actions

Get the list of actions based on certain criteria:

  • account_name - string - if this value is passed then it fetches latest 100 transactions for smart contract account_name
  • records_count - string - Number of actions to fetch (default is 100)

get_all_permissions

Get the list of all last permissions based on the number of records_count to show.

  • records_count - string
  • account_name - if this is passed then fetches the permission for only that account_name

get_block_details

Get the details of the block based on its ID or number as indicated by id_or_num and RPC endpoint to fetch action payload.

  • endpoint - string
  • id_or_num - string

get_blocks

Get the list of blocks based on certain criteria:

  • show_empty - string - Whether to show empty blocks or not
  • records_count - string - Number of blocks to show

getpermissionsbypublickey

Get the list of permissions based on its public_key

  • public_key - string

get_smart_contracts

Get the list of all available smart contracts based on the number of records_count to show.

  • records_count - string

get_transaction_details

Get the details for a particular transaction based on its id and RPC endpoint to fetch action payload.

  • id - string
  • endpoint - string

get_transactions

Get the list of transactions based on certain criteria:

  • records_count - string - Number of transactions to show
    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
    原文