Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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 app/_meta.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ export default {
items: {
_1:{
title: 'Avail old API docs',
href: 'http://old-api.docs.availproject.org/',
href: 'https://old-api.docs.availproject.org/',
},
},
},
Expand Down
4 changes: 2 additions & 2 deletions app/da/api-reference/avail-bridge-api/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,14 +36,14 @@ To ensure network stability and security, the Avail network is generally subject
1. The Avail VectorX bridge can be used to pass messages and tokens between \
Avail DA Turing - Ethereum Sepolia (testnet bridge),
and between Avail DA mainnet - Ethereum mainnet (mainnet bridge).
2. You can check out a complete list of endpoints required to use the bridge API in the [networks page](/docs/networks#for-devs).
2. You can check out a complete list of endpoints required to use the bridge API in the [networks page](/da/networks#for-devs).
</Callout>

<Callout type="info">
**TWO WAYS OF USING THE BRIDGE API**<br/>
1. You can build and run the bridge API locally using the instructions outlined in this repo:
[availproject/bridge-api](https://github.com/availproject/bridge-api)
2. We have included two public endpoints for the bridge API in the [networks page](/docs/networks#for-devs) that you can use.
2. We have included two public endpoints for the bridge API in the [networks page](/da/networks#for-devs) that you can use.
For the sake of simplicity that is what we will be using in this guide.
3. For the sake of simplicity, we will use the Turing testnet bridge API in this guide.
</Callout>
Expand Down
2 changes: 1 addition & 1 deletion app/da/api-reference/avail-lc-api/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ a light client instance available for public use running in the `Light-client` m
be called via an LC running in the `Light-client` mode, devs can use our public endpoint.
2. For methods that require an LC running in the `App-client` mode, you will need to run a local instance of the Avail LC.
3. You can check out or docs for [instructions on running your own instance
of the Avail light client](/docs/operate-a-node/run-a-light-client/0010-light-client)
of the Avail light client](/da/operate-a-node/run-a-light-client/0010-light-client)
4. The LC API is exposed by default through `localhost:7007` by default.
</Callout>

Expand Down
2 changes: 1 addition & 1 deletion app/da/api-reference/avail-lc-api/v1-deprecated/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ import { Callout } from 'nextra/components'
**V1 HAS BEEN DEPRECATED**<br />
The Avail light client API has been upgraded, and all the latest methods work under the path `/v2`.
They provide all the features of `V1`, and more.
Please refer to the [Avail light client API reference](/api-reference/avail-lc-api) for detailed information.
Please refer to the [Avail light client API reference](/da/api-reference/avail-lc-api) for detailed information.
</Callout>
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ import { Callout } from 'nextra/components'
# Fetch block data if available
<Callout type="info">
**LOOKING FOR INSTRUCTIONS ON HOW TO RUN YOUR OWN LIGHT CLIENT?**<br/>
You can check out [our docs here](/docs/operate-a-node/run-a-light-client/0010-light-client#running-the-light-client) for instructions on how to run your own light client.
You can check out [our docs here](/da/operate-a-node/run-a-light-client/0010-light-client#running-the-light-client) for instructions on how to run your own light client.
</Callout>
<Callout type="warning">
**Note:**<br/>
Light client must be running in `app-mode`to retrieve data. [Click here](/docs/operate-a-node/run-a-light-client/0010-light-client#setting-your-identity-using-identitytoml) for instructions on how to run an Avail Light Client in `app-mode`.
Light client must be running in `app-mode`to retrieve data. [Click here](/da/operate-a-node/run-a-light-client/0010-light-client#setting-your-identity-using-identitytoml) for instructions on how to run an Avail Light Client in `app-mode`.
</Callout>
<br/>
Gets the block data if available.
Expand Down Expand Up @@ -121,7 +121,7 @@ If no data is available in the block against the configured `app_id` in `app-mod
The next few methods are used to submit data to the Avail network. But to use them:

1. you need to configure an `identity.toml` file which will contain the seed phrase
for an account that has some `AVAIL` tokens. You can learn how to do that [here](/docs/operate-a-node/run-a-light-client/0010-light-client#setting-your-identity-using-identitytoml).
for an account that has some `AVAIL` tokens. You can learn how to do that [here](/da/operate-a-node/run-a-light-client/0010-light-client#setting-your-identity-using-identitytoml).

2. You will also need to run the Avail LC in app-client mode. The command to do all this will
look something like this:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { Callout } from 'nextra/components'
# Fetch the header for a specific block if available
<Callout type="info">
**LOOKING FOR INSTRUCTIONS ON HOW TO RUN YOUR OWN LIGHT CLIENT?**<br/>
You can check out [our docs here](/docs/operate-a-node/run-a-light-client/0010-light-client#running-the-light-client) for instructions on how to run your own light client.
You can check out [our docs here](/da/operate-a-node/run-a-light-client/0010-light-client#running-the-light-client) for instructions on how to run your own light client.
</Callout>

Gets the header for a specifc block if available.
Expand Down
2 changes: 1 addition & 1 deletion app/da/api-reference/avail-lc-api/v2-blocks/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { Callout } from 'nextra/components'
# Fetch specified block status and confidence if applicable
<Callout type="info">
**LOOKING FOR INSTRUCTIONS ON HOW TO RUN YOUR OWN LIGHT CLIENT?**<br/>
You can check out [our docs here](/docs/operate-a-node/run-a-light-client/0010-light-client#running-the-light-client) for instructions on how to run your own light client.
You can check out [our docs here](/da/operate-a-node/run-a-light-client/0010-light-client#running-the-light-client) for instructions on how to run your own light client.
</Callout>

Gets specified block status and confidence if applicable.
Expand Down
2 changes: 1 addition & 1 deletion app/da/api-reference/avail-lc-api/v2-status/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { Callout } from 'nextra/components'
# Fetch current status and active modes of the light client
<Callout type="info">
**LOOKING FOR INSTRUCTIONS ON HOW TO RUN YOUR OWN LIGHT CLIENT?**<br/>
You can check out [our docs here](/docs/operate-a-node/run-a-light-client/0010-light-client#running-the-light-client) for instructions on how to run your own light client.
You can check out [our docs here](/da/operate-a-node/run-a-light-client/0010-light-client#running-the-light-client) for instructions on how to run your own light client.
</Callout>

Gets current status and active modes of the light client.
Expand Down
4 changes: 2 additions & 2 deletions app/da/api-reference/avail-lc-api/v2-submit/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ import { Callout } from 'nextra/components'
# Submit data to Avail DA
<Callout type="info">
**LOOKING FOR INSTRUCTIONS ON HOW TO RUN YOUR OWN LIGHT CLIENT?**<br/>
You can check out [our docs here](/docs/operate-a-node/run-a-light-client/0010-light-client#running-the-light-client) for instructions on how to run your own light client.
You can check out [our docs here](/da/operate-a-node/run-a-light-client/0010-light-client#running-the-light-client) for instructions on how to run your own light client.
</Callout>

<Callout type="warning">
**Note:**<br/>
Light client must be running in `app-mode`to retrieve data. [Click here](/docs/operate-a-node/run-a-light-client/0010-light-client#setting-your-identity-using-identitytoml) for instructions on how to run an Avail Light Client in `app-mode`.
Light client must be running in `app-mode`to retrieve data. [Click here](/da/operate-a-node/run-a-light-client/0010-light-client#setting-your-identity-using-identitytoml) for instructions on how to run an Avail Light Client in `app-mode`.
</Callout>

> Submits application data to the avail network
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ You can use this method to actually connect to Avail light client web socket. Mu

To connect to the Avail LC websocket API, you need:

1. Access to a [running Light Client](/docs/operate-a-node/run-a-light-client/0010-light-client#running-the-light-client).
1. Access to a [running Light Client](/da/operate-a-node/run-a-light-client/0010-light-client#running-the-light-client).
2. A subscription ID generated using the [`v2/subscriptions`](#v2subscriptions) method.
3. to run this wscat command in the terminal:

Expand Down
2 changes: 1 addition & 1 deletion app/da/api-reference/avail-lc-api/v2-version/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { Callout } from 'nextra/components'

<Callout type="info">
**LOOKING FOR INSTRUCTIONS ON HOW TO RUN YOUR OWN LIGHT CLIENT?**<br/>
You can check out [our docs here](/docs/operate-a-node/run-a-light-client/0010-light-client#running-the-light-client) for instructions on how to run your own light client.
You can check out [our docs here](/da/operate-a-node/run-a-light-client/0010-light-client#running-the-light-client) for instructions on how to run your own light client.
</Callout>

Gets the version of the light client binary, and the version of the Avail node it is connected to.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import { Callout } from 'nextra/components'
1. Avail builds on top of the [Polkadot SDK](https://docs.polkadot.com/develop/parachains/intro-polkadot-sdk/#substrate) (formerly known as Substrate)
and implements most of it's underlying calls and extrinsics.
2. The `author_submitAndWatchExtrinsic` RPC call is known to be buggy and unreliable, and as such, not recommended for use.
3. We recommend most devs [use our dedicated SDKs](/api-reference/avail-node-api) instead of trying to use this RPC call directly.
3. We recommend most devs [use our dedicated SDKs](/da/api-reference/avail-node-api) instead of trying to use this RPC call directly.
4. You can read more about the problem in this Github issue: https://github.com/paritytech/subxt/issues/1668
5. Since the problem is upstream, we can't fix it directly.
6. We will keep this page updated with any new information :)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,5 @@ import { Callout } from 'nextra/components'
<Callout type="info">
**KNOW THE DIFFERENCE**<br/>
1. `author_submitExtrinsic` & `author_submitAndWatchExtrinsic` are different RPC calls that serve different, but similar purposes.
2. We recommend not using the latter directly either. You can read about the problems with it [in this page in our docs](/api-reference/avail-node-api/author-submit-and-watch-extrinsic).
2. We recommend not using the latter directly either. You can read about the problems with it [in this page in our docs](/da/api-reference/avail-node-api/author-submit-and-watch-extrinsic).
</Callout>
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ hash is returned.

<Callout type="info">
1. You will need to set up the dev environment required to run this example.
For instructions, [check out our docs here](/api-reference/avail-node-api#setting-up-the-dev-environment).
For instructions, [check out our docs here](/da/api-reference/avail-node-api#setting-up-the-dev-environment).

2. If you're sending an extrinsic (i.e conducting a transaction) you will need to replace the demo seed phrase with your own seed phrase.
The rest of the code should work as is.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ hash is returned.

<Callout type="info">
1. You will need to set up the dev environment required to run this example.
For instructions, [check out our docs here](/api-reference/avail-node-api#setting-up-the-dev-environment).
For instructions, [check out our docs here](/da/api-reference/avail-node-api#setting-up-the-dev-environment).

2. If you're sending an extrinsic (i.e conducting a transaction) you will need to replace the demo seed phrase with your own seed phrase.
The rest of the code should work as is.
Expand Down
4 changes: 2 additions & 2 deletions app/da/api-reference/avail-node-api/da-app-keys/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { Callout, Steps, Tabs } from 'nextra/components'

<Callout type="info">
`App Ids` are core to the dev experience on Avail DA, and we highly recommend you understand how they work before you start working with them.
You can check out [our docs for the same](/docs/build-with-avail/interact-with-avail-da/app-id).
You can check out [our docs for the same](/da/build-with-availinteract-with-avail-da/app-id).
</Callout>

# Fetch an AppID from Avail DA
Expand Down Expand Up @@ -48,7 +48,7 @@ On failure, a reason for failure is returned. On sucess, the returned JSON objec

<Callout type="info">
1. You will need to set up the dev environment required to run this example.
For instructions, [check out our docs here](/api-reference/avail-node-api#setting-up-the-dev-environment).
For instructions, [check out our docs here](/da/api-reference/avail-node-api#setting-up-the-dev-environment).

2. If you're sending an extrinsic (i.e conducting a transaction) you will need to replace the demo seed phrase with your own seed phrase.
The rest of the code should work as is.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { Callout, Steps, Tabs } from 'nextra/components'

<Callout type="info">
`App Ids` are core to the dev experience on Avail DA, and we highly recommend you understand how they work before you start working with them.
You can check out [our docs for the same](/docs/build-with-avail/interact-with-avail-da/app-id).
You can check out [our docs for the same](/da/build-with-availinteract-with-avail-da/app-id).
</Callout>

# Create a new App ID on Avail DA
Expand Down Expand Up @@ -56,7 +56,7 @@ On failure, a reason of failure is returned. On Success, ApplicationKeyCreated e

<Callout type="info">
1. You will need to set up the dev environment required to run this example.
For instructions, [check out our docs here](/api-reference/avail-node-api#setting-up-the-dev-environment).
For instructions, [check out our docs here](/da/api-reference/avail-node-api#setting-up-the-dev-environment).

2. If you're sending an extrinsic (i.e conducting a transaction) you will need to replace the demo seed phrase with your own seed phrase.
The rest of the code should work as is.
Expand Down
4 changes: 2 additions & 2 deletions app/da/api-reference/avail-node-api/da-next-app-id/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { Callout, Steps, Tabs } from 'nextra/components'

<Callout type="info">
`App Ids` are core to the dev experience on Avail DA, and we highly recommend you understand how they work before you start working with them.
You can check out [our docs for the same](/docs/build-with-avail/interact-with-avail-da/app-id).
You can check out [our docs for the same](/da/build-with-availinteract-with-avail-da/app-id).
</Callout>

# Fetch the next available App ID on Avail DA
Expand Down Expand Up @@ -44,7 +44,7 @@ You can use this method to fetch the next available `app_id` for your awesome ro

<Callout type="info">
1. You will need to set up the dev environment required to run this example.
For instructions, [check out our docs here](/api-reference/avail-node-api#setting-up-the-dev-environment).
For instructions, [check out our docs here](/da/api-reference/avail-node-api#setting-up-the-dev-environment).

2. If you're sending an extrinsic (i.e conducting a transaction) you will need to replace the demo seed phrase with your own seed phrase.
The rest of the code should work as is.
Expand Down
4 changes: 2 additions & 2 deletions app/da/api-reference/avail-node-api/da-submit-data/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ On failure, a reason of failure is returned. On Success, DataSubmitted event, tr

<Callout type="info">
1. You will need to set up the dev environment required to run this example.
For instructions, [check out our docs here](/api-reference/avail-node-api#setting-up-the-dev-environment).
For instructions, [check out our docs here](/da/api-reference/avail-node-api#setting-up-the-dev-environment).

2. If you're sending an extrinsic (i.e conducting a transaction) you will need to replace the demo seed phrase with your own seed phrase.
The rest of the code should work as is.
Expand All @@ -60,7 +60,7 @@ The rest of the code should work as is.
<Callout type="info">
**PLEASE NOTE**<br/>
1. You can submit data to Avail DA using a specific `app_id` that you created. If you don't know how,
read more [in our docs here](/api-reference/avail-node-api/da-create-application-key).<br/>
read more [in our docs here](/da/api-reference/avail-node-api/da-create-application-key).<br/>

2. You can submit data to **ANY** `app_id`, even if you didn't create it. This however does not contitute an
attack vector since the rollups building on top of Avail DA can always filter out DA submissions.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ This object contains the details of the transaction and your newly created nomin

<Callout type="info">
1. You will need to set up the dev environment required to run this example.
For instructions, [check out our docs here](/api-reference/avail-node-api#setting-up-the-dev-environment).
For instructions, [check out our docs here](/da/api-reference/avail-node-api#setting-up-the-dev-environment).

2. If you're sending an extrinsic (i.e conducting a transaction) you will need to replace the demo seed phrase with your own seed phrase.
The rest of the code should work as is.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ This object contains the details of the transaction and your newly created nomin

<Callout type="info">
1. You will need to set up the dev environment required to run this example.
For instructions, [check out our docs here](/api-reference/avail-node-api#setting-up-the-dev-environment).
For instructions, [check out our docs here](/da/api-reference/avail-node-api#setting-up-the-dev-environment).

2. If you're sending an extrinsic (i.e conducting a transaction) you will need to replace the demo seed phrase with your own seed phrase.
The rest of the code should work as is.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ This object contains the details of the transaction and some information about t

<Callout type="info">
1. You will need to set up the dev environment required to run this example.
For instructions, [check out our docs here](/api-reference/avail-node-api#setting-up-the-dev-environment).
For instructions, [check out our docs here](/da/api-reference/avail-node-api#setting-up-the-dev-environment).

2. If you're sending an extrinsic (i.e conducting a transaction) you will need to replace the demo seed phrase with your own seed phrase.
The rest of the code should work as is.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ This object contains the details of the transaction and the nomination pool.

<Callout type="info">
1. You will need to set up the dev environment required to run this example.
For instructions, [check out our docs here](/api-reference/avail-node-api#setting-up-the-dev-environment).
For instructions, [check out our docs here](/da/api-reference/avail-node-api#setting-up-the-dev-environment).

2. If you're sending an extrinsic (i.e conducting a transaction) you will need to replace the demo seed phrase with your own seed phrase.
The rest of the code should work as is.
Expand Down
2 changes: 1 addition & 1 deletion app/da/api-reference/avail-node-api/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ Just run `deno run --allow-net your-file-name.ts` to run your `avail-js` code wi
in the project.

3. The examples in this reference will interact with the Turing testnet of Avail DA, and will use the correspponding endpoint.
You can use the [networks page](/docs/networks) to find endpoints for mainnet if you need to.
You can use the [networks page](/da/networks) to find endpoints for mainnet if you need to.

</Tabs.Tab>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ On-chain name of method: `staking_activeEra`

<Callout type="info">
1. You will need to set up the dev environment required to run this example.
For instructions, [check out our docs here](/api-reference/avail-node-api#setting-up-the-dev-environment).
For instructions, [check out our docs here](/da/api-reference/avail-node-api#setting-up-the-dev-environment).

2. If you're sending an extrinsic (i.e conducting a transaction) you will need to replace the demo seed phrase with your own seed phrase.
The rest of the code should work as is.
Expand Down
2 changes: 1 addition & 1 deletion app/da/api-reference/avail-node-api/staking-bond/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ On failure, a reason of failure is returned. On Success, Bonded event, transacti

<Callout type="info">
1. You will need to set up the dev environment required to run this example.
For instructions, [check out our docs here](/api-reference/avail-node-api#setting-up-the-dev-environment).
For instructions, [check out our docs here](/da/api-reference/avail-node-api#setting-up-the-dev-environment).

2. If you're sending an extrinsic (i.e conducting a transaction) you will need to replace the demo seed phrase with your own seed phrase.
The rest of the code should work as is.
Expand Down
2 changes: 1 addition & 1 deletion app/da/api-reference/avail-node-api/staking-chill/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ On failure, a reason of failure is returned. On Success, Chilled event, transact

<Callout type="info">
1. You will need to set up the dev environment required to run this example.
For instructions, [check out our docs here](/api-reference/avail-node-api#setting-up-the-dev-environment).
For instructions, [check out our docs here](/da/api-reference/avail-node-api#setting-up-the-dev-environment).

2. If you're sending an extrinsic (i.e conducting a transaction) you will need to replace the demo seed phrase with your own seed phrase.
The rest of the code should work as is.
Expand Down
Loading