Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ORA1727 Update consumer docs to be up to date with working backend #28

Merged
merged 2 commits into from
Jun 29, 2024
Merged

ORA1727 Update consumer docs to be up to date with working backend #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9f50849
Update existing-consumers.mdx
br4e Jun 29, 2024
0349b47
Update walkthrough-use-topic-inference.mdx
br4e Jun 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pages/devs/existing-consumers.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
## Consumer Contract Deployments

You can find the deployed consumer contracts by looking at the latest saved deployments in the repository:
- [Sepolia](https://sepolia.etherscan.io/address/0x08f305A3449F51BFd79D7582A1630304664B1474#code)
- [Sepolia](https://sepolia.etherscan.io/address/0x8E45fbef38DaC54e32AfB27AC8cBab30E6818ce6#code)
- [Arbitrum One](https://arbiscan.io/address/0x6032f0862A2c36D0390c348EeCc2ACcDccDa785a#code)

## Deploying to additional chains
Expand Down
29 changes: 27 additions & 2 deletions pages/devs/walkthrough-use-topic-inference.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,40 @@ Follow these instructions to bring the most recent inference data on-chain for a
## Step by Step Guide:

1. Create an Upshot API key by [creating an account](https://developer.upshot.xyz/signup).
2. [Call the Consumer Inference API](./offchain-query-existing-workers#yuga-index-levels-id2) using the `topicId` found in the [deployed topics list](./existing-topics) and the correct chainId. For example, if you use sepolia, you would provide `ethereum-11155111`.
2. Call the Consumer Inference API using the `topicId` found in the [deployed topics list](./existing-topics) and the correct chainId. For example, if you use sepolia, you would provide `ethereum-11155111`.

```shell
curl -X 'GET' --url 'https://api.upshot.xyz/v2/allora/consumer/<chainId>?allora_topic_id=<topicId>' -H 'accept: application/json' -H 'x-api-key: <apiKey>'
```

Here is an example response:
```json
{
"request_id": "409de397-99f8-4911-91ed-74e6fe748115",
"status": true,
"data": {
"signature": "0x8165fff89ca07fadff3f4e27b200bd3eae2132055aa8f0a224832446505c0662033b3038c9694000af60d4e9fbf8504cd9729b9841db286f45070a9c92f2531d1c",
"inference_data": {
"network_inference": "61022689135670660000000",
"confidence_interval_percentiles": [],
"confidence_interval_values": [],
"topic_id": "11",
"timestamp": 1719688595,
"extra_data": "0x"
}
}
}
```


3. Construct a call to the Allora Consumer contract on the chain of your choice (options listed under [deployments](./existing-consumers)) using the returned `signature` and `network-inference` as follows:

## Creating the Transaction:

Note you be doing something more like `callProtocolFunctionWithAlloraTopicInference` in the example above, so you would want to construct your call to that contract in a similar way to the following:

```typescript
await alloraConsumer.verifyData({
await alloraConsumer.verifyNetworkInference({
signature: signature,
networkInference: {
networkInference: networkInference,
Expand Down
Loading