@abcpros/bch-js 中文文档教程

Question

bch-js

bch-js 是一个 JavaScript npm 库，用于创建可以与比特币现金 (BCH) 区块链交互的 Web 和移动应用程序。 它可以免费使用，但需要在 FullStack.cash 上有一个帐户才能提高速率限制。 从这篇文章了解更多关于全栈比特币现金开发的信息。

Quick Start Videos:

以下是两个 YouTube 演练视频，可帮助您入门：

• Introduction to bch-js and the bch-js-examples repository
• Working with the FullStack.cash JWT token

Quick Links

• npm Library
• Documentation
• Examples
• bchn.fullstack.cash - The REST API this library talks to by default.
• FullStack.cash - cloud-based infrastructure for application developers.
• FullStack.cash Account - Get your API key to unlock increased rate limits.
• Permissionless Software Foundation - The organization that maintains this library.

Quick Notes

• 安装库：npm install @psf/bch-js

• 在您的代码中实例化该库：

const BCHJS = require("@psf/bch-js")
let bchjs = new BCHJS() // Defaults to BCHN network.

// testnet
bchjs = new BCHJS({ restURL: 'https://testnet3.fullstack.cash/v4/' })

该库旨在与 bch-api REST API，以及 FullStack.cash。 restURL 属性可以更改以适用于不同

• BCHN Mainnet REST API server: https://bchn.fullstack.cash/v4/
• ABC Mainnet REST API server: https://abc.fullstack.cash/v4/
• Testnet3 REST API server: https://testnet3.fullstack.cash/v4/
• Check server status: https://metrics.fullstack.cash

API Key

的比特币现金网络：bch-api< /a> FullStack.cash 托管的 REST API 使用 JWT 代币支付增加的费用 与后端服务器交互时的速率限制。 如果您想了解系统即服务，请参阅这篇文章 -所有的。 JWT 令牌可以隐式或显式提供给 bch-js。

• Implicitly: bch-js will detect your JWT token if you set the BCHJSTOKEN environment variable.
• Explicitly: You can directly feed in the JWT token with the apiToken property when instantiating the library. Here is an example:

const BCHJS = require("@psf/bch-js")
let bchjs = new BCHJS({
  restURL: 'https://bchn.fullstack.cash/v5/',
  apiToken: 'eyJhbGciO...' // Your JWT token here.
})

Gatsby

bch-js 包含在这个 gatsby-ipfs-template 中，用于构建可以交互的不可审查的网络应用程序与区块链。 在构建 Gatsby（或其他使用 Webpack 的前端应用程序）时，您需要根据 这个问题：

exports.onCreateWebpackConfig = ({ actions }) => {
  actions.setWebpackConfig({
    node: {
      fs: 'empty'
    }
  })
}

这是因为bch-js中新增的IPFS类使用fs库上传文件，Gatsby不支持。

我们还提供 minimal-slp-wallet-web 作为支持 SLP 的基本比特币现金钱包，对于前端项目。 bch-js 被封装在类库的实例化中。

Features

• 使用 ECMAScript 2017 标准 JavaScript 代替 TypeScript。 作品 本机使用 node.js v10 或更高版本。

• 完整的 SLP 令牌支持：bch-js 完全支持所有 SLP 令牌功能，包括发送、铸币和创世交易。 它还完全支持不可替代代币 (NFT) 的所有方面。

• 语义发布 使用语义版本控制的持续交付。

• Greenkeeper 自动依赖管理 自动维护最新、最安全的依赖项。

• IPFS 上传所有文件和依赖项，以进行备份 依赖项，以防它们无法从 GitHub 或 npm 访问。

Documentation:

这个库的完整文档可以在这里找到：

• Documentation

bch-js 使用 APIDOC 以便文档和工作代码 住在同一个存储库中。 生成文档：

• npm run docs
• Open the generated docs/index.html file in a web browser.

Support

有问题吗？ 需要帮忙？ 加入我们的社区支持 Telegram 频道

IPFS Releases

此存储库的副本也发布在 IPFS 上。

• v4.5.4: QmWv3pxJy3MH8vU5nLUVyzqFxfNKXLQQEnz1rgStNuQijd

License

麻省理工学院