Skip to content

Commit

Permalink
fix: update docs links
Browse files Browse the repository at this point in the history
docs.api3.org -> airnode-docs.api3.org
  • Loading branch information
dcroote committed Jan 29, 2025
1 parent 7f60e83 commit b594b3b
Show file tree
Hide file tree
Showing 26 changed files with 71 additions and 67 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ Airnode is a fully-serverless oracle node that is designed specifically for API

## Documentation

You can find an overview of Airnode in the [documentation](https://docs.api3.org/explore/airnode/what-is-airnode.html).
You can find an overview of Airnode in the
[documentation](https://airnode-docs.api3.org/reference/airnode/latest/understand/).

## For developers

Expand All @@ -19,11 +20,11 @@ This is a monorepo managed by [Lerna](https://github.com/lerna/lerna).

[**airnode-abi**:](https://github.com/api3dao/airnode/tree/master/packages/airnode-abi) Encoding and decoding utilities
for Airnode according to the
[Airnode ABI specifications](https://docs.api3.org/reference/airnode/latest/specifications/airnode-abi.html)
[Airnode ABI specifications](https://airnode-docs.api3.org/reference/airnode/latest/specifications/airnode-abi.html)

[**airnode-adapter**:](https://github.com/api3dao/airnode/tree/master/packages/airnode-adapter) Used for building
requests from an [Oracle Integration Specification (OIS)](https://docs.api3.org/reference/ois/latest/), executing them,
parsing the responses, but also converting and encoding them for on chain purposes
requests from an [Oracle Integration Specification (OIS)](https://airnode-docs.api3.org/reference/ois/latest/),
executing them, parsing the responses, but also converting and encoding them for on chain purposes

[**airnode-admin**:](https://github.com/api3dao/airnode/tree/master/packages/airnode-admin) A package/CLI tool to
interact with the Airnode contracts across chains
Expand Down
6 changes: 3 additions & 3 deletions packages/airnode-abi/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# `@api3/airnode-abi`

> Encoding and decoding utilities for Airnode according to the
> [Airnode ABI specifications](https://docs.api3.org/reference/airnode/latest/specifications/airnode-abi.html)
> [Airnode ABI specifications](https://airnode-docs.api3.org/reference/airnode/latest/specifications/airnode-abi.html)
## Documentation

Expand All @@ -11,5 +11,5 @@ then grouped and encoded as the rest of the body.

For more information see the API3 Documentation.

- [Airnode ABI Reference](https://docs.api3.org/reference/airnode/latest/packages/airnode-abi.html)
- [Airnode ABI Specifications](https://docs.api3.org/reference/airnode/latest/specifications/airnode-abi.html)
- [Airnode ABI Reference](https://airnode-docs.api3.org/reference/airnode/latest/packages/airnode-abi.html)
- [Airnode ABI Specifications](https://airnode-docs.api3.org/reference/airnode/latest/specifications/airnode-abi.html)
6 changes: 3 additions & 3 deletions packages/airnode-adapter/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# `@api3/airnode-adapter`

> Used for building requests from an
> [Oracle Integration Specification (OIS)](https://docs.api3.org/reference/ois/latest/), executing them, parsing the
> responses, but also converting and encoding them for on chain purposes
> [Oracle Integration Specification (OIS)](https://airnode-docs.api3.org/reference/ois/latest/), executing them, parsing
> the responses, but also converting and encoding them for on chain purposes
## Documentation

The adapter documentation describing relevant user facing parts can be found in
[adapter docs](https://docs.api3.org/reference/airnode/latest/packages/adapter.html).
[adapter docs](https://airnode-docs.api3.org/reference/airnode/latest/packages/adapter.html).
2 changes: 1 addition & 1 deletion packages/airnode-admin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
## Documentation

You can find documentation on how to use the admin CLI package in the
[admin CLI docs](https://docs.api3.org/reference/airnode/latest/packages/admin-cli.html).
[admin CLI docs](https://airnode-docs.api3.org/reference/airnode/latest/packages/admin-cli.html).

## For developers

Expand Down
2 changes: 1 addition & 1 deletion packages/airnode-admin/docker/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Airnode admin CLI Docker image

**This README is intended for the developers. Documentation on how to use the airnode-admin image is in the
[docs](https://docs.api3.org/reference/airnode/latest/docker/admin-cli-image.html).**
[docs](https://airnode-docs.api3.org/reference/airnode/latest/docker/admin-cli-image.html).**

This documentation focuses on the Airnode admin CLI Docker image, not the Airnode admin CLI itself. If you want to learn
more about the admin CLI, please read [its documentation](../README.md).
Expand Down
4 changes: 2 additions & 2 deletions packages/airnode-deployer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
## Documentation

You can find documentation on how to use the deployer in the
[deployer docs](https://docs.api3.org/reference/airnode/latest/docker/deployer-image.html).
[deployer docs](https://airnode-docs.api3.org/reference/airnode/latest/docker/deployer-image.html).

## For developers

Expand All @@ -22,7 +22,7 @@ Instructions on how to build and use the deployer CLI from source:
[required_version](https://github.com/api3dao/airnode/blob/master/packages/airnode-deployer/terraform/aws/backend.tf#L2)
of terraform modules used.
2. Prepare necessary cloud credentials. See the
[instructions in the docs](https://docs.api3.org/reference/airnode/latest/docker/deployer-image.html#cloud-provider-credentials).
[instructions in the docs](https://airnode-docs.api3.org/reference/airnode/latest/docker/deployer-image.html#cloud-provider-credentials).
3. Make sure `config.json` and `secrets.env` are available in the `config` directory. You can use the provided example
`config.json` and `secrets.env` templates to get started quickly, but you will need to edit these with your own API
details and secrets.
Expand Down
5 changes: 3 additions & 2 deletions packages/airnode-deployer/docker/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Airnode deployer Docker image

**This README is intended for the developers. Documentation on how to use the deployer image is in the
[docs](https://docs.api3.org/reference/airnode/latest/docker/deployer-image.html).**
[docs](https://airnode-docs.api3.org/reference/airnode/latest/docker/deployer-image.html).**

This documentation focuses on the Airnode deployer Docker image, not the Airnode deployer itself. If you want to learn
more about the Deployer, please read [its documentation](../README.md).
Expand All @@ -17,4 +17,5 @@ yarn docker:build:local
> If building on windows ensure that the `entrypoint.sh` file uses `LF` line endings. Otherwise the image will not be
> built correctly.
The usage is documented in the [docs](https://docs.api3.org/reference/airnode/latest/docker/deployer-image.html).
The usage is documented in the
[docs](https://airnode-docs.api3.org/reference/airnode/latest/docker/deployer-image.html).
38 changes: 20 additions & 18 deletions packages/airnode-examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Currently, all of the examples utilize the RRP protocol. The example RRP flow co
requester

If you would like to know more about RRP, read the
[API3 docs](https://docs.api3.org/reference/airnode/latest/concepts/).
[API3 docs](https://airnode-docs.api3.org/reference/airnode/latest/concepts/).

### Available examples

Expand All @@ -38,16 +38,18 @@ reserved parameters. The following list orders integrations alphabetically:
- [coingecko](https://github.com/api3dao/airnode/blob/master/packages/airnode-examples/integrations/coingecko) -
unauthenticated cryptocurrency price request.
- [coingecko-cross-chain-authorizer](https://github.com/api3dao/airnode/blob/master/packages/airnode-examples/integrations/coingecko) -
demonstration of a cross-chain [authorizer](https://docs.api3.org/reference/airnode/latest/concepts/authorizers.html).
demonstration of a cross-chain
[authorizer](https://airnode-docs.api3.org/reference/airnode/latest/concepts/authorizers.html).
- [coingecko-http-gateways](https://github.com/api3dao/airnode/tree/master/packages/airnode-examples/integrations/coingecko-http-gateways) -
demonstration of the
[HTTP gateway and HTTP signed data gateway](https://docs.api3.org/reference/airnode/latest/understand/http-gateways.html).
[HTTP gateway and HTTP signed data gateway](https://airnode-docs.api3.org/reference/airnode/latest/understand/http-gateways.html).
- [coingecko-post-processing](https://github.com/api3dao/airnode/tree/master/packages/airnode-examples/integrations/coingecko-post-processing) -
demonstration of the [post-processing](https://docs.api3.org/reference/ois/latest/processing.html) feature.
demonstration of the [post-processing](https://airnode-docs.api3.org/reference/ois/latest/processing.html) feature.
- [coingecko-pre-processing](https://github.com/api3dao/airnode/tree/master/packages/airnode-examples/integrations/coingecko-pre-processing) -
demonstration of the [pre-processing](https://docs.api3.org/reference/ois/latest/processing.html) feature.
demonstration of the [pre-processing](https://airnode-docs.api3.org/reference/ois/latest/processing.html) feature.
- [coingecko-template](https://github.com/api3dao/airnode/tree/master/packages/airnode-examples/integrations/coingecko-template) -
demonstration of [template](https://docs.api3.org/reference/airnode/latest/developers/using-templates.html) requests.
demonstration of [template](https://airnode-docs.api3.org/reference/airnode/latest/developers/using-templates.html)
requests.
- [failing-example](https://github.com/api3dao/airnode/tree/master/packages/airnode-examples/integrations/failing-example) -
demonstration of Airnode error handling through an invalid request.
- [relay-security-schemes](https://github.com/api3dao/airnode/tree/master/packages/airnode-examples/integrations/relay-security-schemes) -
Expand Down Expand Up @@ -119,9 +121,9 @@ deploy the contracts and make transactions, so make sure it is funded. The recom

#### 4. (Only if using local blockchain) Deploy the RRP contract

The [RRP contract](https://docs.api3.org/reference/airnode/latest/concepts/#airnoderrpv0-sol) is a contract through
which the [requester](https://docs.api3.org/reference/airnode/latest/concepts/requester.html) triggers a request for
Airnode. This contract is common for all Airnodes and requesters on a chain.
The [RRP contract](https://airnode-docs.api3.org/reference/airnode/latest/concepts/#airnoderrpv0-sol) is a contract
through which the [requester](https://airnode-docs.api3.org/reference/airnode/latest/concepts/requester.html) triggers a
request for Airnode. This contract is common for all Airnodes and requesters on a chain.

If you are using a local blockchain, deploy the contract using the first command below. Otherwise, the contract deployed
by API3 on the chosen chain will be used automatically. The second command, also optional if using a public blockchain,
Expand All @@ -137,7 +139,7 @@ yarn deploy-rrp-dry-run
If you intend to deploy Airnode on AWS, you will need to specify the credentials which will be used by the
[deployer](https://github.com/api3dao/airnode/tree/master/packages/airnode-deployer). If you are not sure where to find
these or how to create an AWS account, see
[the following docs section](https://docs.api3.org/reference/airnode/latest/understand/configuring.html#aws-setup-aws-deployment-only).
[the following docs section](https://airnode-docs.api3.org/reference/airnode/latest/understand/configuring.html#aws-setup-aws-deployment-only).

After you know the secrets, run the following script to specify them:

Expand All @@ -156,7 +158,7 @@ your project by pairing it with your credit card. The amount of resources used b
within the free tier, which means no charges will be incurred.

If you are not sure how to create a GCP service account, see or download the access key for it,
[the following docs section](https://docs.api3.org/reference/airnode/latest/understand/configuring.html#gcp-setup-gcp-deployment-only).
[the following docs section](https://airnode-docs.api3.org/reference/airnode/latest/understand/configuring.html#gcp-setup-gcp-deployment-only).

Store the access key file as `gcp.json` in the integration directory - e.g. if you have chosen the `coingecko`
integration, store the file as `integrations/coingecko/gcp.json`.
Expand Down Expand Up @@ -190,8 +192,8 @@ yarn create-airnode-secrets
>
> The `create-airnode-secrets` script will handle this for you on Mac, Windows, and WSL.
Refer to the [documentation](https://docs.api3.org/reference/airnode/latest/understand/configuring.html) for more
details.
Refer to the [documentation](https://airnode-docs.api3.org/reference/airnode/latest/understand/configuring.html) for
more details.

#### 9. (Only if deploying to a cloud provider) Deploy Airnode

Expand Down Expand Up @@ -244,11 +246,11 @@ yarn deploy-requester

#### 12. Derive and fund the sponsor wallet

Airnode requests require a [sponsor](https://docs.api3.org/reference/airnode/latest/concepts/sponsor.html), which will
pay for the response transaction made by Airnode. Each sponsor has a dedicated wallet for a given Airnode. This wallet
is called a "sponsor wallet" and can be derived from a sponsor address and Airnode's extended public key with the
[admin CLI package](https://github.com/api3dao/airnode/tree/master/packages/airnode-admin). Refer to the
[documentation](https://docs.api3.org/reference/airnode/latest/developers/requesters-sponsors.html#how-to-derive-a-sponsor-wallet)
Airnode requests require a [sponsor](https://airnode-docs.api3.org/reference/airnode/latest/concepts/sponsor.html),
which will pay for the response transaction made by Airnode. Each sponsor has a dedicated wallet for a given Airnode.
This wallet is called a "sponsor wallet" and can be derived from a sponsor address and Airnode's extended public key
with the [admin CLI package](https://github.com/api3dao/airnode/tree/master/packages/airnode-admin). Refer to the
[documentation](https://airnode-docs.api3.org/reference/airnode/latest/developers/requesters-sponsors.html#how-to-derive-a-sponsor-wallet)
for more details.

To derive and fund the sponsor wallet, run:
Expand Down
2 changes: 1 addition & 1 deletion packages/airnode-examples/aws.example.env
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# For further information see:
# https://docs.api3.org/reference/airnode/latest/understand/configuring.html#aws-setup-aws-deployment-only
# https://airnode-docs.api3.org/reference/airnode/latest/understand/configuring.html#aws-setup-aws-deployment-only
AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
AWS_SESSION_TOKEN=
8 changes: 4 additions & 4 deletions packages/airnode-examples/integrations/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ Each integration consist of a these files:

- `config.example.json` - An example configuration file for this integration.
- `create-config.ts` - A file that will be called by `create-airnode-config.ts` to create the `config.json` file. See
the [docs](https://docs.api3.org/reference/airnode/latest/understand/configuring.html#creating-config-json) for
details.
the [docs](https://airnode-docs.api3.org/reference/airnode/latest/understand/configuring.html#creating-config-json)
for details.
- `create-secrets.ts` - A file that will be called by `create-airnode-secrets.ts` to create the `secrets.env` file. See
the [docs](https://docs.api3.org/reference/airnode/latest/understand/configuring.html#creating-secrets-env) for
details.
the [docs](https://airnode-docs.api3.org/reference/airnode/latest/understand/configuring.html#creating-secrets-env)
for details.
- `README.md` - Should explain what the particular integration is about.
- `request-utils.ts` - This file contains functions which are necessary to make the Airnode request.
- `secrets.example.env` - An example file listing the necessary secret values of `secrets.env` file.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ preferred method: a request header named `X-CMC_PRO_API_KEY`. Your API key, whic
is provided as a value via interpolation of the `CMC_PRO_API_KEY` variable defined in `secrets.env`.

For more information about how the Airnode is configured refer to the
[docs](https://docs.api3.org/reference/airnode/latest/understand/configuring.html).
[docs](https://airnode-docs.api3.org/reference/airnode/latest/understand/configuring.html).
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The only difference is that this integration allows the endpoint to return eithe
gateway or HTTP signed data gateway, respectively.

For more details, see the documentation for the
[HTTP gateways](https://docs.api3.org/reference/airnode/latest/understand/http-gateways.html).
[HTTP gateways](https://airnode-docs.api3.org/reference/airnode/latest/understand/http-gateways.html).

## HTTP gateway

Expand Down Expand Up @@ -47,7 +47,7 @@ curl -X POST -H 'Content-Type: application/json' -d '{"parameters": {"coinId": "
### Encode parameters

The coingecko endpoint expects a parameter `coinId` which needs to be passed to the signed data gateway encoded using
[Airnode ABI](https://docs.api3.org/reference/airnode/latest/specifications/airnode-abi.html).
[Airnode ABI](https://airnode-docs.api3.org/reference/airnode/latest/specifications/airnode-abi.html).

We have encoded two basic parameter types:

Expand All @@ -74,7 +74,7 @@ Before making the request, you need to replace the following placeholders:
command
- `<ENDPOINT_ID>` - You can find this value in `config.json` under `triggers.httpSignedData[0].endpointId` path. It can
be derived using the Admin CLI command `derive-endpoint-id` described further
[here](https://docs.api3.org/reference/airnode/latest/packages/admin-cli.html#derive-endpoint-id)
[here](https://airnode-docs.api3.org/reference/airnode/latest/packages/admin-cli.html#derive-endpoint-id)

The correct command may look like this:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Coingecko post-processing integration example

This is a basic example showcasing how to use
[postprocessing](https://docs.api3.org/reference/ois/latest/processing.html) to enable an advanced use case which
modifies the CoinGecko API response before sending the response on chain.
[postprocessing](https://airnode-docs.api3.org/reference/ois/latest/processing.html) to enable an advanced use case
which modifies the CoinGecko API response before sending the response on chain.

The `config.json` defines a single callable endpoint, called `coinsMarketData` which you can call with different coin
IDs to determine the average current price and average 30 days percentage change.
Expand All @@ -18,4 +18,4 @@ Overall the process looks like this:
5. Airnode submits the encoded value on chain.

For more information about how the Airnode is configured refer to the
[docs](https://docs.api3.org/reference/airnode/latest/understand/configuring.html).
[docs](https://airnode-docs.api3.org/reference/airnode/latest/understand/configuring.html).
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Coingecko pre-processing integration example

This is a basic example showcasing how to use
[preprocessing](https://docs.api3.org/reference/ois/latest/processing.html) to enable an advanced use case which
[preprocessing](https://airnode-docs.api3.org/reference/ois/latest/processing.html) to enable an advanced use case which
modifies the endpoint parameters before making the API request to CoinGecko API.

The `config.json` defines a single callable endpoint, called `coinHistoryData` which you can call with different coin ID
Expand All @@ -16,4 +16,4 @@ Overall the process looks like this:
4. Airnode makes the API call, waits for response, encodes the value and finally submits it on chain.

For more information about how the Airnode is configured refer to the
[docs](https://docs.api3.org/reference/airnode/latest/understand/configuring.html).
[docs](https://airnode-docs.api3.org/reference/airnode/latest/understand/configuring.html).
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Coingecko example showing Airnode template request

This example showcases how to use Airnode
[template](https://docs.api3.org/reference/airnode/latest/concepts/template.html) requests. This example defines a
template inside `config.json`, which is used to call the Airnode endpoint called `coinMarketData`. This endpoint can be
called to determine the current price of some crypto currency. This template defines parameters to retrieve the current
price of Ethereum. See the `create-template-on-chain.ts` and `create-config.ts` files for more details.
[template](https://airnode-docs.api3.org/reference/airnode/latest/concepts/template.html) requests. This example defines
a template inside `config.json`, which is used to call the Airnode endpoint called `coinMarketData`. This endpoint can
be called to determine the current price of some crypto currency. This template defines parameters to retrieve the
current price of Ethereum. See the `create-template-on-chain.ts` and `create-config.ts` files for more details.

To run this example, follow the generic examples README. However, before making a template request (before running
`yarn make-request`), you must make sure the template is deployed. The easiest way to ensure this is to re-deploy the
Expand Down
Loading

0 comments on commit b594b3b

Please sign in to comment.