全部产品

JS SDK 快速开始

本文以 0.2.27 版本的 JS SDK 为例,通过示例阐述如何快速使用 JS SDK 进行合约开发。

说明:JS SDK 0.3.8 与 0.2.27 版本保持兼容,本快速开始同时适用于以上两个版本。

准备环境

安装 SDK

  • Node.js 官网 下载并安装 Node.js(推荐使用 v10.11.0 及以上版本)。
  • 安装 JS SDK。下载 JS SDK V0.2.27 安装包 至项目目录,然后在项目目录中安装。

    1. npm i alipay-mychain-0.2.27.tgz --save

准备 SSL 连接文件

要与 BaaS 平台建立 SSL 连接,需准备三个证书文件:ca.crtclient.keyclient.crt

如果您尚未在合约链申请证书,可按照 快速开始 的操作说明去生成和申请证书相关文件。

文件 说明 来源
ca.crt 合约链的认证 CA,客户端用来验证合约链服务身份 通过 BaaS 平台下载。
client.key RSA 密钥 通过 BaaS 提供的 密钥生成工具 生成。
client.crt RSA 证书,与 client.key 是一对 使用 BaaS 提供的 密钥生成工具 生成证书请求文件 client.csr,提交请求文件到 BaaS 平台申请证书,申请成功后可下载此 .crt 文件。

准备合约链的账户

在合约链上提交交易时,需要使用一个已经在链上存在的账户,JS SDK 需要使用账户的 账户名称私钥文件

账户可通过 BaaS 平台申请创建。参考 快速开始 的过程,需要填写创建的账户名称、账户公钥和恢复公钥,其中与账户公钥对应的 user.key 文件就是账户的私钥文件,对此私钥文件进行转换,方便在 JS SDK 中使用。

  1. openssl ec -in user.key -passin pass:${key_password} -passout pass:${key_password} -aes256 -out user.pem

说明:将 ${key_password} 替换为私钥密码。

获取链节点 IP 和端口号

要与合约链交互,您需要获取链节点的 IP 地址和端口号。在 BaaS 平台,通过查看目标合约链详情,在区块浏览器中查看节点详情,可获取链节点的 IP 地址和端口号。

使用 JS SDK

快速创建一个访问区块链的实例 chain,并使用 QueryLastBlock 验证该实例与区块链节点的连接状况。

  1. const Chain = require("@alipay/mychain/index.node") //在 node 环境使用 TLS 协议
  2. const fs = require("fs")
  3. const accountKey = fs.readFileSync("./certs/user.pem", { encoding: "utf8" })
  4. const accountPassword = "123abc" //需要替换为自定义的 user.pem 密码
  5. const keyInfo = Chain.utils.getKeyInfo(accountKey, accountPassword)
  6. //可打印私钥和公钥,使用 16 进制
  7. //console.log('private key:', keyInfo.privateKey.toString('hex'))
  8. //console.log('public key:', keyInfo.publicKey.toString('hex'))
  9. const passphrase = "123abc" //需要替换为自定义的 client.key 密码
  10. //配置选项
  11. let opt = {
  12. host: '127.0.0.1', //目标区块链网络节点的 IP
  13. port: 18130, //端口号
  14. timeout: 30000, //连接超时时间配置
  15. cert: fs.readFileSync("./certs/client.crt", { encoding: "utf8" }),
  16. ca: fs.readFileSync("./certs/ca.crt", { encoding: "utf8" }),
  17. key: fs.readFileSync("./certs/client.key", { encoding: "utf8" }),
  18. userPublicKey: keyInfo.publicKey,
  19. userPrivateKey: keyInfo.privateKey,
  20. userRecoverPublicKey: keyInfo.publicKey,
  21. userRecoverPrivateKey: keyInfo.privateKey,
  22. passphrase: passphrase
  23. }
  24. //初始化一个连接实例
  25. const chain = Chain(opt)
  26. //调用 API 查询最新的一个区块数据
  27. chain.ctr.QueryLastBlock({}, (err, data) => {
  28. console.log('raw data:', data) //区块结构数据
  29. console.log('block hash:', data.block.block_header.hash) //区块哈希
  30. console.log('block number:', data.block.block_header.block_number) //区块高度
  31. })

成功运行结果参考:

  1. raw data: { msg_type: 58,
  2. sequence: 1,
  3. return_code: 0,
  4. group_id: '0x0000000000000000000000000000000000000000',
  5. block:
  6. { block_header:
  7. { hash:
  8. '0xe99d8958a45e8c87a7b10efc259828f06fe083995be52997f5d310f2b6d073a6',
  9. version: 2,
  10. block_number: 84265,
  11. parent_hash:
  12. '0x918b263a8e6c6fff594b89570970ef4bef24cf93aeed5347f7b250b070857c4b',
  13. transaction_root:
  14. '0x0000000000000000000000000000000000000000000000000000000000000000',
  15. receipt_root:
  16. '0x0000000000000000000000000000000000000000000000000000000000000000',
  17. state_root:
  18. '0x9f71cb9ce960e5637bad6da5be8daa2d7e557942208f241a60589b2de98e6c71',
  19. gas_used: 0,
  20. timestamp: 1547382477852,
  21. log_bloom:
  22. '0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000' },
  23. block_body:
  24. { transaction_list: [],
  25. receipt_list: [],
  26. consensus_proof:
  27. '0xf8f2f8c9b8419746989382c1613c6c3ce98bf79ac92a8d69952c22f4064194869c53b4075d517cfc98eda861212687e49b186c08d196770bd356762fa2a88d0288c0556f271a01b84138a97446a75c76a31d24880c343407bd7bc24608685c494240ac603cad62201a01a423718661b24e517ee6f6b2fee6d356b57833305860700cca81b0238f870400b841eaf508392d9098a3e7fb46f6f7aa4b53311e5a0d13e300d02025af7453ea130a6c27407c1da254578cae80ed498d4807587883f837c1716b0be8ae02cf955d6000e61e83014929a0e200d8bee723d820022d5c5a1f8fe6b521c0a4fff0b5ec03a7c6061276d68b58' } },
  28. api: 'QueryLastBlock' }
  29. block hash: 0xe99d8958a45e8c87a7b10efc259828f06fe083995be52997f5d310f2b6d073a6
  30. block number: 84265

说明
运行结果示例中包含字段 return_code,此字段结果为 0,表示执行成功,否则其值为错误码。后文介绍的交易回执(receipt)中 result 字段也是类似含义,详细错误码信息参见 合约链错误码

JS SDK 引用说明

不同运行环境下, JS SDK 的引用方式稍有不同:

  • Node 环境:

    1. const Chain = require("@alipay/mychain/index.node")
  • Web 环境:

    1. const Chain = require("@alipay/mychain")

配置项说明

在初始化与区块链连接的实例之前,可进行选项配置,各配置项的具体说明如下。

说明

  • 如无特别说明,配置项的数据类型默认为 string 类型。
  • 配置项中配置了账户相关的 Key 信息,包括账户公私钥、账户恢复公私钥。链的连接实例默认使用配置项中的账户 Key 信息进行交易签名。如果要切换账户,需要重新配置账户 Key 相关选项。详情参见 创建账户 中切换账户配置的使用示例。
配置项 必填 配置说明 示例值
host true 区块链节点的 IP 或者主机名。使用 TLS 时为 IP 地址;使用 HTTPS 时为主机名。 127.0.0.1https://www.alipay.comhttps://127.0.0.1
port true 区块链节点开放连接的端口号,类型为 number。 18130
clients false 可设置多个 host:port,作为主节点(首个为主节点),次节点备份,当主节点出现连接问题,SDK 会切换到列表其它节点重试连接。如果配置此参数,可不用设置 host 和 port 参数。 [{host:’127.0.0.1’,port:18130},
{host:’127.0.0.2’,port:18130}]
timeout true 与区块链节点连接的超时时间配置,单位毫秒,类型为 number。 30000
ca true 目标合约链的根证书。 在 BaaS 平台申请通过后下载,详情参考 快速开始
cert true 客户端证书文件。 在 BaaS 平台申请通过后下载,详情参考 快速开始
key true 客户端生成的私钥文件,用于生成证书请求文件,进而申请证书。 使用 BaaS 提供 密钥生成工具 生成,详情参考 快速开始
userPublicKey true 账户公钥,字符串内容为 16 进制。 0x971c77d38bf220572fe8294d7884b184adeeb9bac4d61c1b3e1e924575e526152145763eaba40c8713c82cc2961fba98f71c8b93984d4e3d10b2ff53ea039551
userPrivateKey true 账户私钥,字符串内容为 16 进制。 0x4015e39643765014b874dbd35a53f1a01418c66f7c47da35f3a84122c743d9a3
userRecoverPublicKey true 账户恢复公钥,字符串内容为 16 进制。 0xb961f6a1a43b9e7aa368be8d093ed7bec2d0ff85ff7646ec968d86bd546151efbd037cfe09933684b5c98978a1593074cdff465de3a3620089f5634911bf7b2e
userRecoverPrivateKey true 账户恢复私钥,字符串内容为 16 进制。 0x44a973e5286f1d3513561360bb0214235425b942a4649c7d371f780ca1ee0e80
passphrase true TLS 或 HTTPS 链接的 client.key 文件的自定义密码。 123abc
checkServerIdentity false 针对 TLS 协议的配置,类型为 boolean,含义为是否启用对服务端 hostname 的检查,即对比服务端证书的 CN 字段与 hostname 是否匹配,默认值为 false。 false
tx_querycount false 对于交易类型,提交交易后会调用 QueryTransactionReceipt 查询收据,此配置可设定重试的次数,类型为 number,默认值为 3。 5
tx_querytime false 对于交易类型,提交交易后会调用 QueryTransactionReceipt 查询收据,此配置可设定重试的时间间隔,类型为 number,单位为毫秒,默认值为 3000。 200