api3dao / old-api3-docs

Documentation for the API3 Project
https://docs.api3.org/
MIT License
56 stars 29 forks source link

Verify dapiName and datafeedID are byte32 only #1153

Closed wkande closed 1 year ago

wkande commented 1 year ago

It is not clear if dapiName or datafeedId should be encoded values of bytes32, if I am saying this correctly. First move the TIP dialog under the declared parameters in the Parameters section to make the page read better. Then do a PR to get comments that the instructions are valid, a formal review.

I think that the content in the docs for the two function's parameters (links below) are correct for two reasons. This was addressed before by myself and Burak. Second, _dapiName (AVAX/USF) must be bytes32 encoded when using the function readDataFeedWithDapiName().

See the parameters fordataFeedIdToReaderToWhitelistStatus() here.

See the parameters for readerCanReadDataFeed() here.