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.

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

initial #49

Merged
merged 13 commits into from
Aug 12, 2024
1 change: 0 additions & 1 deletion pages/devs/consumers/offchain-query-existing-topics.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@ Let's break down this request body:
- This request queries the index topic (topic `1`), on Allora Testnet, as specified by the head URL (https://heads.testnet-1.testnet.allora.network/api/v1/functions/execute).
- We specify the `function_id` and `method` fields to indicate that we want to solicit inferences in a particular way (this concerns the internals of the worker nodes). These values can be recovered by following [this step-by-step guide](/devs/workers/deploy-worker/build-and-deploy-worker-from-scratch).
- We pass in the input `ETH` to specify we want prices for Ethereum in particular, which is defined by the [`default_arg` of the topic](/devs/topic-creators/how-to-create-topic#creating-your-first-topic).
- `number_of_nodes: -1` indicates that we don't care how many nodes respond, so long as they respond to [roll call](https://blockless.network/docs/protocol/networking/execution#acquiring-the-execution-binary-pre-cache) within `timeout: 2` seconds of the request broadcast.

<Callout type="warning">
Inferences returned by the method above are considered [Unsafe Requests](/devs/consumers#unsafe-requests).
Expand Down
2 changes: 1 addition & 1 deletion pages/devs/consumers/walkthrough-use-topic-inference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ 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 using the `topicId` found in the [deployed topics list](/devs/getting-started/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](/devs/get-started/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>'
Expand Down
27 changes: 18 additions & 9 deletions pages/devs/get-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,22 +12,31 @@ Allora is a decentralized network that leverages the power of collective partici

Here are the main repositories you'll need to get started with Allora:

### Allora Inference Base
### Allora Offchain Node

The [Allora Inference Base Image](https://github.com/allora-network/allora-inference-base) allows model providers to participate in the Allora network. This repo is the base for worker nodes (for providing inferences) and head nodes (which coordinate requests and aggregate results).
The [Allora Offchain Node](https://github.com/allora-network/allora-offchain-node) allows inference and data providers to participate in the Allora network. This repo is the base for both forecast and inference worker nodes, as well as reputers.

### Allora Chain
#### Workers
- [Deploy a Worker](/devs/workers/deploy-worker/build-and-deploy-worker-from-scratch)

The [Allora chain](https://github.com/allora-network/allora-chain) is a Cosmos Hub chain that forms the core of the Allora network. This repository contains the blockchain's codebase and is useful for validators.
##### Walkthroughs

You can use the [Allorad CLI tool](/devs/get-started/installation/cli) to query the chain and make transactions.
- [Basic Coin Prediction Worker](/devs/workers/walkthroughs/walkthrough-price-prediction-worker)
- [Hugging Face Worker](/devs/workers/walkthroughs/walkthrough-hugging-face-worker)

#### Reputers

- [Deploy a Reputer](/devs/reputers/reputers)

### Worker Repositories
##### Walkthroughs

The Hugging Face and Price Prediction worker examples below show how to provide inferences for different topics on Allora.
- [Coin Prediction Reputer](/devs/reputers/coin-prediction-reputer)

- [Hugging Face](https://github.com/allora-network/allora-huggingface-walkthrough)
- [Price Prediction](https://github.com/allora-network/basic-coin-prediction-node)
### Allora Chain

The [Allora chain](https://github.com/allora-network/allora-chain) is a Cosmos Hub chain that forms the core of the Allora network. This repository contains the blockchain's codebase and is useful for validators.

You can use the [Allorad CLI tool](/devs/get-started/installation/cli) to query the chain and make transactions.

### Allora Consumer Contracts

Expand Down
2 changes: 1 addition & 1 deletion pages/devs/get-started/_meta.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"setup-wallet": "Setup Wallet",
"installation": "Installation",
"cli": "Installation",
"basic-usage": "Basic Usage",
"existing-topics": "Existing Topics"
}
4 changes: 0 additions & 4 deletions pages/devs/get-started/installation/_meta.json

This file was deleted.

9 changes: 0 additions & 9 deletions pages/devs/get-started/installation/blockless.mdx

This file was deleted.

2 changes: 1 addition & 1 deletion pages/devs/get-started/setup-wallet.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { Callout } from 'nextra/components'

## Create Wallet

Follow the instructions [here](/devs/get-started/installation/cli) to install our CLI tool `allorad`, which is needed to create a wallet.
Follow the instructions [here](/devs/get-started/cli) to install our CLI tool `allorad`, which is needed to create a wallet.

Prior to executing transactions, a wallet must be created by running:

Expand Down
1 change: 0 additions & 1 deletion pages/devs/reference/_meta.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
{
"allorad": "allorad",
"module-accounts": "Module Accounts",
"blockless": "Blockless",
"params": "Parameters"
}
7 changes: 0 additions & 7 deletions pages/devs/reference/blockless/_meta.json

This file was deleted.

11 changes: 0 additions & 11 deletions pages/devs/reference/blockless/allora-b7s-extension.mdx

This file was deleted.

20 changes: 0 additions & 20 deletions pages/devs/reference/blockless/allora-compute-node.mdx

This file was deleted.

80 changes: 0 additions & 80 deletions pages/devs/reference/blockless/b7s-concepts.mdx

This file was deleted.

84 changes: 0 additions & 84 deletions pages/devs/reference/blockless/b7s-usage.mdx

This file was deleted.

Loading
Loading