函数

# readBeacon()

Table of Contents

读取Beacon非常简单直接。 而对于链上智能合约,函数readBeacon() (opens new window)收到的msg.sender 必须加入白名单中。

::: 提示 获取白名单

请联系API3 Business Development API Team (opens new window)(API3业务开发API团队)了解Beacon白名单。

:::

从链下代码(_使用类似于 ether.js_的库) 调用不受白名单的约束。 链下代码的讨论不在本文档的范围内。

# 示例代码

从GitHub 储存库beacon-reader-example (opens new window)中还有一个读取Beacon的合约另一个示例。

// SPDX-License-Identifier: MIT
pragma solidity ^0.8.3;

import "@api3/airnode-protocol/contracts/rrp/requesters/interfaces/IRrpBeaconServer.sol";
contract mySmartContract {

    function myGetBeaconValue(
        address _beaconContractAddress,
        bytes32 _beaconId
    ) external {
        int224 private value;
        uint32 private timestamp;

        // Calling the BeaconServer for a Beacon value.
        (value, timestamp) =
            RrpBeaconServer(_beaconContractAddress).readBeacon(_beaconId);
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

# 参数

readBeacon(bytes32 _bearaconId)

  • bytes32 beaconId - 为其检索的Beacon的ID。

# 返回

  • int224 value - Beacon的值。
  • data.timestamp - 与 Beacon 值关联的时间戳。

::: 提示 请注意:

RrpBeaconServer.sol合约将已经报告的数据点转为 int224。 如果这有问题(因为报告的的数据可能不适用于224位或者它是完全不同的类型,比如 bytes32),请不要使用此合约,并使用其自定义版本。 合约的时间戳转为uint32,这意味着它不会以当前形式在past-2106工作。 如果还是有问题,请考虑将时间戳转为更大容量的类型。

:::

如果Beacon的 timestamp 为0,这意味着它从未被写入。 新的Beacon有可能就会面临这样的情况。 因此,如果 timestamp 为0,value字段中的0值无效。

通常而言,请确保检查Beacon的时间戳是否足够新,并且忽略timestamp为0的Beacon。

Last Updated: 6/16/2022, 4:36:08 PM