- web3.js
- web3.version - 版本信息
- web3.modules - 子模块集合对象
- web3.setProvider - 设置服务提供器
- web3.providers - 服务提供器集合对象
- web3.givenProvider - 原生服务提供器
- web3.currentProvider - 当前服务提供器
- web3.BatchRequest - 批量请求
- web3.extend - 模块继承
- web3.eth.defaultAccount - 默认账户
- web3.eth.defaultBlock - 默认块
- web3.eth.getProtocolVersion - 返回协议版本信息
- web3.eth.isSyncing - 检查节点是否同步
- web3.eth.getCoinbase - 返回挖矿收益账户
- web3.eth.isMining - 检查节点是否在挖矿
- web3.eth.getHashrate - 返回节点旳哈希计算速度
- web3.eth.getGasPrice - 返回当前gas价格
- web3.eth.getAccounts - 返回账户列表
- web3.eth.getBlockNumber - 返回当前块编号
- web3.eth.getBalance - 返回指定账户余额
- web3.eth.getStorageAt - 返回指定地址存储内容
- web3.eth.getCode - 返回指定地址的代码
- web3.eth.getBlock - 返回指定块
- web3.eth.getBlockTransactionCount - 返回指定块中的交易数量
- web3.eth.getUncle - 返回指定叔伯块
- web3.eth.getTransaction - 返回指定交易对象
- web3.eth.getTransactionFromBlock - 返回块中指定交易对象
- web3.eth.getTransactionReceipt - 返回指定交易的收据
- web3.eth.getTransactionCount - 返回指定地址发生的交易数量
- web3.eth.sendTransaction - 发送交易
- web3.eth.sendSignedTransaction - 发送已签名交易
- web3.eth.sign - 为数据生成签名
- web3.eth.signTransaction - 为交易生成签名
- web3.eth.call - 执行消息调用
- web3.eth.estimateGas - 估算gas用量
- web3.eth.getPastLogs - 返回历史日志
- web3.eth.getCompilers - 返回可用编译器清单
- web3.eth.getWork - 返回当前挖矿工作情况
- web3.eth.subscribe - 订阅链上事件
- web3.eth.Contract - 合约构造函数
- web3.eth.accounts - 账户管理与交易签名
- web3.eth.accounts.create - 创建账户
- web3.eth.accounts.privateKeyToAccount - 使用指定私钥创建账户
- web3.eth.accounts.recoverTransaction - 提取交易的签名账户
- web3.eth.accounts.hashMessage - 计算消息的哈希
- web3.eth.accounts.sign - 为数据生成签名
- web3.eth.accounts.recover - 提取数据的签名账户
- web3.eth.accounts.encrypt - 加密指定私钥
- web3.eth.accounts.decrypt - 解密keystore对象
- web3.eth.accounts.wallet - 钱包对象
- web3.eth.accounts.wallet.create - 在钱包中创建账户
- web3.eth.accounts.wallet.add - 向钱包添加已有账户
- web3.eth.accounts.wallet.remove - 从钱包中移除指定账户
- web3.eth.accounts.wallet.clear - 清空钱包
- web3.eth.accounts.wallet.encrypt - 加密钱包
- web3.eth.accounts.wallet.decrypt - 解密钱包
- web3.eth.accounts.wallet.save - 保存钱包
- web3.eth.accounts.wallet.load - 载入钱包
- web3.eth.personal - 账户交互
- web3.eth.abi - ABI管理
- web3.utils - 辅助工具函数集
- web3.utils.randomHex - 生成伪随机16进制字符串
- web3.utils._ - underscore接口
- web3.utils.BN - BN.js接口
- web3.utils.isBN - 检查给定参数是否BN对象
- web3.utils.isBigNumber - 检查给定参数是否为BigNumber对象
- web3.utils.sha3 - 计算sha3哈希值
- web3.utils.soliditySha3 - solidity方式计算sha3哈希
- web3.utils.isHex - 检查给定参数是否为16进制
- web3.utils.isHexStrict - 严格模式16进制检查
- web3.utils.isAddress - 检查给定参数是否为有效地址
- web3.utils.toChecksumAddress - 转换为校验和地址
- web3.utils.checkAddressChecksum - 校验地址
- web3.utils.toHex - 转换为16进制字符串
- web3.utils.hexToNumberString - 转换为10进制数值字符串
- web3.utils.hexToNumber - 转换为数值
- web3.utils.numberToHex - 数值转换为16进制表示
- web3.utils.hexToUtf8 - 16进制字符串转换为utf-8
- web3.utils.hexToAscii - 16进制字符串转换为ascii
- web3.utils.utf8ToHex - utf-8字符串转换为16进制
- web3.utils.asciiToHex - ascii字符串转换为16进制
- web3.utils.hexToBytes - 16进制字符串转换为字节数组
- web3.utils.toWei - 转换到wei
- web3.utils.fromWei - 从wei转换到其他以太单位
- web3.utils.unitMap - 以太单位换算表
- web3.utils.padLeft - 左侧零补齐
- web3.utils.padRight - 右侧零补齐
- web3.*.net - 网络交互
- web3.eth.Iban - 创建Iban对象
- web3.eth.Iban.toAddress - 将iban对象转换为以太坊地址
- web3.eth.Iban.toIban - 将以太坊地址转换为Iban对象
- web3.eth.Iban.toAddress - 将iban对象转换为以太坊地址
- web3.eth.Iban.fromEthereumAddress - 将以太坊地址转换为Iban对象
- web3.eth.Iban.fromBban - 使用Bban地址创建Iban对象
- web3.eth.Iban.createIndirect - 创建间接Iban对象
- web3.eth.Iban.isValid - 检查给定Iban地址是否有效
- web3.eth.Iban.isDirect - 检查是否采用直接编码方案
- web3.eth.Iban.isIndirect - 检查是否采用间接编码方案
- web3.eth.Iban.institution - 返回Iban的机构名称
- web3.eth.Iban.client - 返回Iban的客户账号
- web3.eth.Iban.toAddress - 实例方法
- web3.eth.Iban.toString - 返回Iban地址字符串
- web3.shh - whisper协议交互
- web3.shh.getVersion - 返回whisper协议版本
- web3.shh.getInfo - 返回whisper节点信息
- web3.shh.setMaxMessageSize - 设置whisper消息大小上限
- web3.shh.setMinPoW - 设置节点最小PoW
- web3.shh.markTrustedPeer - 标记可信节点
- web3.shh.newKeyPair - 创建密钥对
- web3.shh.addPrivateKey - 使用私钥创建密钥对
- web3.shh.deleteKeyPair - 删除指定密钥对
- web3.shh.hasKeyPair - 检查节点是否有指定密钥对
- web3.shh.getPublicKey - 返回公钥
- web3.shh.getPrivateKey - 返回私钥
- web3.shh.newSymKey - 创建对称密钥
- web3.shh.addSymKey - 添加对称密钥
- web3.shh.generateSymKeyFromPassword - 使用指定密码生成对称密钥
- web3.shh.hasSymKey - 检查是否有指定对称密钥
- web3.shh.getSymKey - 返回对称密钥
- web3.shh.post - 发送whisper消息
- web3.shh.subscribe - 订阅whisper消息
- web3.shh.clearSubscriptions - 清理订阅
- web3.shh.newMessageFilter - 创建消息过滤器
- web3.shh.deleteMessageFilter - 删除消息过滤器
- web3.shh.getFilterMessages - 读取新消息
- web3.bzz - Swarm交互
文章来源于网络收集而来,版权归原创者所有,如有侵权请及时联系!
web3.shh.subscribe - 订阅whisper消息
订阅收到的whisper消息。
调用:
web3.shh.subscribe('messages', options [, callback])
参数:
- "messages" - String: 订阅类型
options
:Object - 订阅选项,有如下字段:- symKeyID - String: 用于消息解密的对称密钥
- privateKeyID - String: 用于消息解密的私钥
- sig - String ,可选,签名的公钥,用于验证
- topics- Array,可选,用于过滤消息的主题数组, 每个主题必须是4字节长的16进制字符串
- minPow - Number ,可选,处理收到的消息所需的最小PoW
- allowP2P - Boolean ,可选,是否允许处理端对端消息
callback
- Function: 可选的回调函数,其第一个参数为错误对象,第二个参数为返回值(optional) Optional callback, returns an error object as first parameter and the result as second. Will be called for each incoming subscription, and the subscription itself as 3 parameter.
通知返回值:
Object
- 接收到的消息,其结构如下:
- hash - String: 封装后消息的哈希签名
- sig - String: 用于对消息进行签名的公钥
- recipientPublicKey - String: 接收人的公钥
- timestamp - String: 消息创建的unix时间戳
- ttl - Number: 以秒为单位的消息存活时间
- topic - String: 4字节的16进制字符串,消息主题.
- payload - String: 解密的负载
- padding - Number: 可选,补齐长度
- pow - Number: PoW值
示例代码:
web3.shh.subscribe('messages', {
symKeyID: 'bf31b9ffc2387e18636e0a3d0c56b023264c16e78a2adcba1303cefc685e610f',
sig: '0x04d1574d4eab8f3dde4d2dc7ed2c4d699d77cbbdd09167b8fffa099652ce4df00c4c6e0263eafe05007a46fdf0c8d32b11aeabcd3abbc7b2bc2bb967368a68e9c6',
ttl: 20,
topics: ['0xffddaa11'],
minPow: 0.8,
}, function(error, message, subscription){
console.log(message);
> {
"hash": "0x4158eb81ad8e30cfcee67f20b1372983d388f1243a96e39f94fd2797b1e9c78e",
"padding": "0xc15f786f34e5cef0fef6ce7c1185d799ecdb5ebca72b3310648c5588db2e99a0d73301c7a8d90115a91213f0bc9c72295fbaf584bf14dc97800550ea53577c9fb57c0249caeb081733b4e605cdb1a6011cee8b6d8fddb972c2b90157e23ba3baae6c68d4f0b5822242bb2c4cd821b9568d3033f10ec1114f641668fc1083bf79ebb9f5c15457b538249a97b22a4bcc4f02f06dec7318c16758f7c008001c2e14eba67d26218ec7502ad6ba81b2402159d7c29b068b8937892e3d4f0d4ad1fb9be5e66fb61d3d21a1c3163bce74c0a9d16891e2573146aa92ecd7b91ea96a6987ece052edc5ffb620a8987a83ac5b8b6140d8df6e92e64251bf3a2cec0cca",
"payload": "0xdeadbeaf",
"pow": 0.5371803278688525,
"recipientPublicKey": null,
"sig": null,
"timestamp": 1496991876,
"topic": "0x01020304",
"ttl": 50
}
})
// or
.on('data', function(message){ ... });
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论