Polkadot-API (PAPI) 简介与使用指南

2025-02-11 19:58

来源链接

订阅此专栏

收藏此文章

在 Polkadot 生态系统中，去中心化应用（dApp）、网页和钱包的开发者通常使用 JavaScript 和 TypeScript 进行开发。与基于 Polkadot SDK 的区块链进行交互，传统上主要依赖于 Polkadot JS 库。然而，最近波卡生态中出现了一款备受关注的新工具——Polkadot-API (PAPI)，它提供了更现代化、模块化的开发体验，并针对轻客户端进行了优化。本文将介绍 PAPI 的特点、环境搭建、基本用法以及其在实际开发中的优势。

PAPI 的特点

Polkadot-API（PAPI）是一个为去中心化应用程序（dApp）开发者提供的模块化、可组合的库，专门针对“轻客户端优先”方法设计。其目标是提供一套全面的工具，帮助开发者构建高效、完全去中心化的应用程序。PAPI 具备以下特点：

轻客户端优化：通过新版本的 JSON-RPC 规范支持完全去中心化的交互。
强大的 TypeScript 支持：通过链上元数据自动生成类型定义和文档，简化开发工作，并实现无缝访问链上存储、常量、交易、事件和运行时调用。
多链兼容性：允许开发者同时连接多个区块链，并提供多描述符支持和运行时更新兼容性检查。
性能优化：利用原生 BigInt 类型、动态导入和模块化子路径来避免捆绑不必要的资源，从而提高性能。
灵活的 API 选项：支持基于承诺和可观察的 API，方便与 Polkadot.js 集成，并可通过浏览器扩展或私钥提供签名选项。

这一切使得 PAPI 成为构建去中心化应用程序的理想工具，既提高开发效率，又优化了应用的性能和可扩展性。从实际使用来看，PAPI 最吸引人的特点之一是它能够基于链的 Metadata 轻松生成 TypeScript 类型定义，详细文档可参考 Polkadot 官方文档，或访问 PAPI 官方网站。

🔗Polkadot 官方文档 :

https://docs.polkadot.com/develop/toolkit/api-libraries/papi/

🔗PAPI 官方网站: https://papi.how/

环境搭建

安装依赖

首先我们需要按照它，通过 npm 或者 yarn。

npm i polkadot-apiyarn add polkadot-api

获取链的 Metadata

像波卡的 relay chain，在脚本中已经有了默认的支持，可以直接使用名字来获取，当你运行帮助，可以得到列表, polkadot，kusama 以及它们的系统平行链都有。

npx papi add -hUsage: polkadot-api add [options] <key>
Add a new chain spec to the list
Arguments:  key                         Key identifier for the chain spec
Options:  --config <filename>         Source for the config file  -f, --file <filename>       Source from metadata encoded file  -w, --wsUrl <URL>           Source from websocket url  -c, --chainSpec <filename>  Source from chain spec file  -n, --name <name>           Source from a well-known chain (choices:   "ksmcc3", "ksmcc3_asset_hub", "ksmcc3_bridge_hub", "ksmcc3_encointer",   "ksmcc3_people", "paseo", "paseo_asset_hub", "paseo_people", "polkadot",   "polkadot_asset_hub", "polkadot_bridge_hub", "polkadot_collectives",   "polkadot_people", "rococo_v2_2", "rococo_v2_2_asset_hub",   "rococo_v2_2_bridge_hub", "rococo_v2_2_people", "westend2",  "westend2_asset_hub",           "westend2_bridge_hub", "westend2_collectives",   "westend2_people")

在添加的时候可以给一个名字

npx papi add dot -n polkadot

也可以添加一个不在列表里面的链，使用 -w 选项。我们启动本地服务器一条链，使用默认端口，并添加。

npx papi add asset -w ws://10.0.0.11:9944

在成功的添加后，项目目录下会出现一个隐藏目录，名字是.papi ,里面会根据获取的 Metadata 生成类型文件。

它的原理是在 packagejson 里面增加一个依赖，包含 descriptor。

 "dependencies": {   "@polkadot-api/descriptors": "file:.papi/descriptors",

编程体验

为了查看后台日志方便调试，代码都是和本地的节点进行交互。从官方文档来看，client 是支持不同的模式的，比如 Smoldot，这里只演示基本的 web 方式。

获取 Client API

首先通过 ws provider 指定链的 RPC 节点地址和端口，然后初始化一个 client。所以的类型是通过 getTypedApi 方法来获取的，这种获取的方式十分便捷，对于习惯强类型编程的开发者非常友好。

类型的定义就是上一个步骤使用命令生成的。

import { asset } from '@polkadot-api/descriptors';import { createClient } from 'polkadot-api';import { getWsProvider } from 'polkadot-api/ws-provider/web';

async function main() {   const provider = getWsProvider('ws://10.0.0.11:9944');   const client = createClient(provider);   const dotApi = client.getTypedApi(asset);

得到常量和变量

然后通过 api 可以简单和链交互，这里获取 balances 里面的一个常量和变量。代码分别打印出帐号的最小余额和帐号 Alice 的可用余额。

import { asset } from '@polkadot-api/descriptors';import { createClient } from 'polkadot-api';import { getWsProvider } from 'polkadot-api/ws-provider/web';

async function main() {   const provider = getWsProvider('ws://10.0.0.11:9944');   const client = createClient(provider);   const dotApi = client.getTypedApi(asset);   const existentialDeposit = (await    dotApi.constants.Balances.ExistentialDeposit()).toString();   console.log(existentialDeposit);   const balance = await    dotApi.query.System.Account.getValue("5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY");   console.log(balance["data"]["free"].toString());}
main()

‍发送交易

这里完成一个最简单的从 Alice 到 Bob 的转账操作。得到 api 后，我们分别导入 Alice 和 Bob 二个帐号，并初始化 Alice 的 signer，把 Bob 的 public key 转换成 MultiAddress 的格式。最后签名并发送这个交易。

import { MultiAddress } from "@polkadot-api/descriptors"import { asset } from '@polkadot-api/descriptors';import { createClient } from 'polkadot-api';import { getWsProvider } from 'polkadot-api/ws-provider/web';import { getPolkadotSigner } from "polkadot-api/signer"import {   sr25519,   DEV_PHRASE,   entropyToMiniSecret,   mnemonicToEntropy, ss58Address} from "@polkadot-labs/hdkd-helpers"import { sr25519CreateDerive } from "@polkadot-labs/hdkd"

async function main() {  const provider = getWsProvider('ws://10.0.0.11:9944');   const client = createClient(provider);   const dotApi = client.getTypedApi(asset);

   const entropy = mnemonicToEntropy(DEV_PHRASE)   const miniSecret = entropyToMiniSecret(entropy)   const derive = sr25519CreateDerive(miniSecret)

   const alice = derive("//Alice")   const bob = derive("//Bob")   const signer = getPolkadotSigner(alice.publicKey, "Sr25519", alice.sign)

   const dest = MultiAddress.Id(ss58Address(bob.publicKey))   const result = await dotApi.tx.Balances.transfer_keep_alive({       dest,       value: BigInt(123),   }).signAndSubmit(signer)   console.log(result)}main()

当交易成功完成后，结果的格式如下

{       txHash: '0x803428a07a2e1c6de378e84a01249bc4f237df546a719bcd369e0418800f54cc',       block: {           index: 2,           number: 1162,                      hash: '0x17aeb0944a33b848655c6fc3945bae1a3bd436e5fe92b0f15a2d7fe027764cc7'       },       ok: true,       events: [           { type: 'Balances', value: [Object], topics: [] },           { type: 'Balances', value: [Object], topics: [] },           { type: 'Balances', value: [Object], topics: [] },           { type: 'Treasury', value: [Object], topics: [] },           { type: 'Balances', value: [Object], topics: [] },           { type: 'TransactionPayment', value: [Object], topics: [] },           { type: 'System', value: [Object], topics: [] }       ]   }

监听事件

在 Dapp 的开发中，对事件的处理也是必不可少的，下面的代码演示链如何获取。

import { asset } from '@polkadot-api/descriptors';import { createClient } from 'polkadot-api';import { getWsProvider } from 'polkadot-api/ws-provider/web';

async function main() {   const provider = getWsProvider('ws://10.0.0.11:9944');   const client = createClient(provider);   const dotApi = client.getTypedApi(asset);   dotApi.event.Balances.Transfer.watch().pipe().forEach(console.log)}main()

获取的事件格式如下。对于监听还可以应用一些 Filter，可以通过发送者，接收者地址过滤等等，这些可以自己去尝试。

{       meta: {           phase: { type: 'ApplyExtrinsic', value: 2 },           block: {           hash: '0x9aa50c25fcc0801ab98d588a8faf8648a98b51adc01ebe2816e381348e6275c2',           number: 1078,           parent: '0xcf12ee84af9eff68b525d1d0c6a6b032accc914e80f05ed78b4d62d8170e076c'           }       },       payload: {           from: '5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY',           to: '5FHneW46xGXgs5mUiveU4sbTyGBzmstUspZC92UhjJM694ty',           amount: 1000000000000n       }   }

总结

PAPI 相较于传统的 Polkadot JS 库，提供了更现代化的开发体验，特别是对 TypeScript 类型定义的自动生成，使得开发者能够更清晰地理解链上数据结构，极大地提高了开发效率。其模块化设计、轻客户端优先的策略以及多链兼容性，使其成为 Polkadot 生态中值得关注的新工具。当然，由于 PAPI 仍在持续优化中，开发者在使用过程中可能会遇到一些 bug，欢迎大家积极反馈并贡献 PR。希望 PAPI 能进一步推动波卡生态发展，为开发者提供更便捷的区块链交互方式！

「区块链技术开发入门 17 期」
正式开启报名

由 OneBlock+ 和 Polkadot 联合推出的「区块链技术开发入门 17 期 | Polkadot 上的 Solidity 开发」 即将启程！本期课程将于 2025 年 3 月 7 日 正式开课，历时 6 周，包含 6 个录播课时、6 个 Task 任务及多个 Workshop。通过系统化学习与实践，助你深入探索区块链技术，开启加密未来的新篇章！

✨ 本期课程完全免费开放，采用申请入学制，名额有限！立即点击下方链接填写申请表，审核通过后我们将主动联系你，锁定学习席位！

🔗 立即申请入学：

https://wj.qq.com/s2/17653871/18t2/

免责声明：由 PaperMoon 提供并包含在本文中的材料仅用于学习目的，它们不构成财务或投资建议，也不应被解读为任何商业决策的指导。我们建议读者在做出任何投资或商业相关的决定之前，进行独立研究并咨询专业人士。PaperMoon 对根据本文内容采取的任何行动不承担任何责任。

About Us

关于我们

OneBlock+ 作为区块链的人才聚集地，是全球领先的 Substrate 开发者社区。我们将提供专业的技术文章和开发课程，并组织研讨会、黑客松创业大赛等交流实践活动，从而帮助开发者掌握 Substrate 技术、深入探索 Web3 领域。同时，OneBlock+ 还为 Web3 优质项目提供技术指导、人才资源等多重创业支持，促使更多开发团队使用 Substrate 技术框架构建未来开放网络。

Twitter: https://twitter.com/OneBlock_
Medium: https://medium.com/@OneBlockplus
Telegram: https://t.me/oneblock_dev
Discord: https://discord.gg/fE8deY4UbP
Bilibili: https://space.bilibili.com/1650224419
YouTube: https://www.youtube.com/channel/UCWo2r3wA6brw3ztr-JmzyXA

来源链接

【免责声明】市场有风险，投资需谨慎。本文不构成投资建议，用户应考虑本文中的任何意见、观点或结论是否符合其特定状况。据此投资，责任自负。

数据请求中