Skip to content

Commit

Permalink
Stellar for AAPI, number of chains, and Node API info
Browse files Browse the repository at this point in the history
  • Loading branch information
galleon8 committed Mar 28, 2024
1 parent 599ce10 commit 8b61728
Show file tree
Hide file tree
Showing 11 changed files with 38 additions and 39 deletions.
2 changes: 1 addition & 1 deletion pages/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"type": "separator",
"title": "Building With Ankr"
},
"rpc-service": "RPC/REST API",
"rpc-service": "Node API",
"advanced-api": "Advanced API",
"node-snapshot": "Blockchain Node Snapshots",
"node-runners": {
Expand Down
2 changes: 1 addition & 1 deletion pages/advanced-api/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Currently, Advanced API works with the following EVM-compatible chains:

**Mainnet**:

* `Avalanche`, `Arbitrum`, `Base`, `BNB Smart Chain`, `Ethereum`, `Fantom`, `Flare`, `Gnosis`, `Linea`, `Optimism`, `Polygon`, `Polygon zkEVM`, `Rollux`, `Scroll`, `Syscoin`.
* `Avalanche`, `Arbitrum`, `Base`, `BNB Smart Chain`, `Ethereum`, `Fantom`, `Flare`, `Gnosis`, `Linea`, `Optimism`, `Polygon`, `Polygon zkEVM`, `Rollux`, `Scroll`, `Stellar`, `Syscoin`.

**Testnet**:

Expand Down
8 changes: 4 additions & 4 deletions pages/advanced-api/query-methods.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { Callout } from "components";
_Query API_ is an Advanced API's collection of methods that comes as a unique feature along with other extensive capabilities provided to our [Premium Plan](/rpc-service/service-plans/#service-plans-comparison) users.
</Callout>

_Query API_ is an access-ready solution that enables your projects to interact with multiple blockchains in a single request. By indexing blockchain data from all eight currently supported chains, searching through large amounts of data is easier and faster than ever before. Query API can boast almost instantaneous processing speeds (due to the key-value filtering supported) for the searches that might ordinarily take hours to process.
_Query API_ is an access-ready solution that enables your projects to interact with multiple blockchains in a single request. By indexing blockchain data on all supported chains, searching through large amounts of data is easier and faster than ever before. Query API can boast almost instantaneous processing speeds (due to the key-value filtering supported) for the searches that might ordinarily take hours to process.

Query API serves to request info on the ranges of blocks (max range is 100) for a full list of block metadata.

Expand Down Expand Up @@ -142,7 +142,7 @@ Build your request using the parameters below.
* `method` (string; required): a method used for the request.
* `params` (object): the data object containing request body parameters:

* `blockchain` (string; required): either of the supported chains (`arbitrum`, `avalanche`, `base`, `bsc`, `eth`, `fantom`, `flare`, `gnosis`, `linea`, `optimism`, `polygon`, `polygon_zkevm`, `rollux`, `scroll`, `syscoin`, `avalanche_fuji`, `eth_goerli`, `optimism_testnet`, `polygon_mumbai`).
* `blockchain` (string; required): either of the supported chains (`arbitrum`, `avalanche`, `base`, `bsc`, `eth`, `fantom`, `flare`, `gnosis`, `linea`, `optimism`, `polygon`, `polygon_zkevm`, `rollux`, `scroll`, `stellar`, `syscoin`, `avalanche_fuji`, `eth_goerli`, `optimism_testnet`, `polygon_mumbai`).
* `decodeLogs` (boolean): set to `true` to decode logs, or to `false` if you don't need this kind of info.
* `decodeTxData` (boolean): set to `true` to decode transaction data, or to `false` if not interested in it.
* `descOrder` (boolean): choose data order, either descending (if `true`) or ascending (if `false`).
Expand Down Expand Up @@ -957,8 +957,8 @@ Build your request using the parameters below.

* `address` (string; required): an address to search for transactions.
* `blockchain` (string): a chain or a combination of chains to query:
* Single chain: `arbitrum`, `avalanche`, `base`, `bsc`, `eth`, `fantom`, `flare`, `gnosis`, `linea`, `optimism`, `polygon`, `polygon_zkevm`, `rollux`, `scroll`, `syscoin`, `avalanche_fuji`, `eth_goerli`, `optimism_testnet`, `polygon_mumbai`.
* Chains combination: `[arbitrum, avalanche, base, bsc, eth, fantom, flare, gnosis, linea, optimism, polygon, polygon_zkevm, rollux, scroll, syscoin, avalanche_fuji, eth_goerli, optimism_testnet, polygon_mumbai]`.
* Single chain: `arbitrum`, `avalanche`, `base`, `bsc`, `eth`, `fantom`, `flare`, `gnosis`, `linea`, `optimism`, `polygon`, `polygon_zkevm`, `rollux`, `scroll`, `stellar`, `syscoin`, `avalanche_fuji`, `eth_goerli`, `optimism_testnet`, `polygon_mumbai`.
* Chains combination: `[arbitrum, avalanche, base, bsc, eth, fantom, flare, gnosis, linea, optimism, polygon, polygon_zkevm, rollux, scroll, stellar, syscoin, avalanche_fuji, eth_goerli, optimism_testnet, polygon_mumbai]`.
* All chains: leave the value empty to query all the chains available.
* `fromBlock` (integer): narrow your search indicating the block number to start from (inclusive; `>= 0`). Supported value formats: hex, decimal, "earliest", "latest".
* `toBlock` (integer): narrow your search indicating the block number to end with (inclusive; `>= 0`). Supported value formats: hex, decimal, "earliest", "latest".
Expand Down
9 changes: 4 additions & 5 deletions pages/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ It has a set of different products for building, earning, gaming, and more — a
This documentation explains how to use Ankr's products and services as a developer as well as a regular Web3 user.
From [public RPC endpoints](https://www.ankr.com/rpc/) that developers have come to know and love, alongside new [Premium and Enterprise plans](https://www.ankr.com/rpc/pricing/) packed with [advanced developer tools](https://www.ankr.com/advanced-api/) — all powered by a globally distributed and decentralized network of nodes.

## RPC/REST API
## Node API
<br/>

<img src="/docs/build/rpc.png" class="responsive-pic" width="600" />

* Access RPC/REST Endpoints via HTTPS or WebSockets.
* Interact with 45+ [supported blockchains](/rpc-service/chains/chains-list/).
* Interact with 50+ [supported blockchains](/rpc-service/chains/chains-list/).
* Test out and get important stats.
* Suitable for Web3 developers and enthusiasts of all skill levels.
<div className="nx-p-4 border border-gray-200 dark:border-gray-900 rounded nx-mt-6">
Expand All @@ -28,7 +28,7 @@ From [public RPC endpoints](https://www.ankr.com/rpc/) that developers have come
<img src="/docs/build/aapi.png" class="responsive-pic" width="600" />

* Access a specifically-tailored collection of JSON-RPC API endpoints.
* Interact with 15 mainnet and 4 testnet chains supported.
* Interact with 16 mainnet and 4 testnet chains supported.
* Use Ankr JavaScript/Python SDKs and React Hooks.
* Tailored to support most popular Web3 scenarios.
<div className="nx-p-4 border border-gray-200 dark:border-gray-900 rounded nx-mt-6">
Expand Down Expand Up @@ -88,9 +88,8 @@ From [public RPC endpoints](https://www.ankr.com/rpc/) that developers have come
* Deploy a fast and secure network.
* Choose additional components from Developer Marketplace.


<div className="nx-p-4 border border-gray-200 dark:border-gray-900 rounded nx-mt-6">
[Bring your project to Web3](scaling-services-introduction/overview)
[Bring your project to Web3](/scaling-services-overview/)
</div>

## Staking
Expand Down
14 changes: 7 additions & 7 deletions pages/rpc-service/getting-started/basics-premium.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Callout } from "components";

# Basics with Premium plan

The [Premium service plan](/rpc-service/service-plans/#service-plans-comparison) enables using the RPC API Endpoints and Advanced APIs at the corresponding [rate limits](/rpc-service/service-plans/#rate-limits). Here is the path to access Premium and start using its functionality:
The [Premium service plan](/rpc-service/service-plans/#service-plans-comparison) enables using the Node API endpoints and Advanced APIs at the corresponding [rate limits](/rpc-service/service-plans/#rate-limits). Here is the path to access Premium and start using its functionality:

> `Interface schema` —> `Sign in` —> `Deposit funds` —> `Use private endpoints`
Expand All @@ -16,7 +16,7 @@ The [Premium service plan](/rpc-service/service-plans/#service-plans-comparison)

## Sign in

RPC Service supports two authentication options:
Web3 API platform supports two authentication options:

<img src="/docs/build/sign-in-method.png" alt="Authentication method" class="responsive-pic" width="500" />

Expand All @@ -27,7 +27,7 @@ RPC Service supports two authentication options:

The Google sign in procedure is the following:

1. Go to the [RPC Service](https://www.ankr.com/rpc/) platform.
1. Go to the [Web3 API](https://www.ankr.com/rpc/) platform.
2. In the top right corner, click **Sign in >** **Continue with Google**, and then select the account to use.

<img src="/docs/build/getting-started/gauth.png" alt="Google authentication" class="responsive-pic" width="400" />
Expand All @@ -43,7 +43,7 @@ Accounts with no transactions can't be used for authentication.

The Ethereum wallet sign in procedure is the following:

1. Go to the [RPC Service](https://www.ankr.com/rpc/) platform.
1. Go to the [Web3 API](https://www.ankr.com/rpc/) platform.
2. In the top right corner, click **Sign in > Continue with ETH Wallet**, select the wallet to use (example: **MetaMask**).

<img src="/docs/build/wallet-select.png" alt="Wallet selection" class="responsive-pic" width="450" />
Expand Down Expand Up @@ -73,7 +73,7 @@ Depending on the [sign-in](/rpc-service/getting-started/basics-premium/#sign-in)
The Ethereum wallet flow has the following parts to it:

* [Initial deposit](/rpc-service/getting-started/basics-premium/#initial-deposit)
* [Subsequent top ups](/rpc-service/getting-started/basics-premium/#subsequent-top-ups)
* [Subsequent top-ups](/rpc-service/getting-started/basics-premium/#subsequent-top-ups)

#### Initial deposit

Expand All @@ -93,7 +93,7 @@ The initial top-up process is the following:

Congrats — you've made payment in ANKR tokens to get the API Credits into your account, and you're all set for using _Premium_ services.

#### Subsequent top ups
#### Subsequent top-ups

As always the case, one day your account balance goes low — that's just the fact of life — and you need to top it up to continue querying blockchains:

Expand Down Expand Up @@ -138,7 +138,7 @@ The initial top-up process is the following:

Congrats — you've made a USD payment to get the API Credits into your account, and you're all set for using _Premium_ services.

#### Subsequent top ups
#### Subsequent top-ups

If you've selected the **One time** payment option upon the [initial deposit](/rpc-service/getting-started/basics-premium/#initial-deposit-1), then one day your account balance goes low — that's just the fact of life — and you need to top it up to continue querying blockchains:

Expand Down
2 changes: 1 addition & 1 deletion pages/rpc-service/getting-started/basics-public.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { Callout } from "components";

What's available for the [Public service plan](/rpc-service/service-plans/#service-plans-comparison) user:

* RPC/REST API and Advanced API at the corresponding [rate limits](/rpc-service/service-plans/#rate-limits).
* Node API and Advanced API at the corresponding [rate limits](/rpc-service/service-plans/#rate-limits).
* Connection code snippets.
* Query checker.
* Public usage data (stats on requests from all Public service users).
Expand Down
12 changes: 6 additions & 6 deletions pages/rpc-service/getting-started/intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,34 +2,34 @@ import { Callout } from "components";

# Intro

Getting Started docs will help you land on your feet safely and orient yourself on the unfamiliar territory of our RPC Service platform in no time.
Getting Started docs will help you land on your feet safely and orient yourself on the unfamiliar territory of our Web3 API platform in no time.

Here is your map to our basics:

> `Iterface schema``Public: basics``Premium: basics``Business accounts``Projects`
* [`Interface schema`](/rpc-service/getting-started/intro/#interface-schema) — your way around RPC Service interface.
* [`Interface schema`](/rpc-service/getting-started/intro/#interface-schema) — your way around Web3 API interface.
* [`Public: basics`](/rpc-service/getting-started/basics-public/) — your way around Public endpoints for blockchain interaction.
* [`Premium: basics`](/rpc-service/getting-started/basics-premium/) — your way around Premium endpoints for blockchain interaction.
* [`Business accounts`](/rpc-service/getting-started/business-accounts/) — your way around user accounts structuring your business.
* [`Projects`](/rpc-service/getting-started/projects/) — your way around multiple projects with IP whitelisting.

## Interface schema

Here you'll find information on what you can expect from all the main panes you're working with on the RPC Service platform.
Here you'll find information on what you can expect from all the main panes you're working with on the Web3 API platform.

Here are panes you usually work with:

> [`RPC/REST API (Endpoints)`](/rpc-service/getting-started/intro/#rpcrest-api)[`Andvanced API`](/rpc-service/getting-started/intro/#advanced-api)[`Dashboard`](/rpc-service/getting-started/intro/#dashboard)[`Settings`](/rpc-service/getting-started/intro/#settings)[`Billing`](/rpc-service/getting-started/intro/#billing)
> [`Node API (Endpoints)`](/rpc-service/getting-started/intro/#node-api)[`Andvanced API`](/rpc-service/getting-started/intro/#advanced-api)[`Dashboard`](/rpc-service/getting-started/intro/#dashboard)[`Settings`](/rpc-service/getting-started/intro/#settings)[`Billing`](/rpc-service/getting-started/intro/#billing)
### RPC/REST API
### Node API

Once you type down `ankr.com/rpc` in your browser and press `Enter`, you'll find yourself in the **Endpoints** pane. This is your starting point to empower your Web3 project with blockchain interaction capabilities.
<br/>

<img src="/docs/build/ui-schema.png" alt="UI Schema" class="responsive-pic" width="600" />

You usually start as a [Public plan](/rpc-service/service-plans/) user, meaning that you haven't signed in to our platform yet and can only use free RPC API endpoints and Advanced API with the corresponding [features](/rpc-service/service-plans/#feature-list) and [rate limits](/rpc-service/service-plans/#rate-limits) available.
You usually start as a [Public plan](/rpc-service/service-plans/) user, meaning that you haven't signed in to our platform yet and can only use free Node API endpoints and Advanced API with the corresponding [features](/rpc-service/service-plans/#feature-list) and [rate limits](/rpc-service/service-plans/#rate-limits) available.

For a Public plan user, the following actions are available from the start:

Expand Down
10 changes: 5 additions & 5 deletions pages/rpc-service/getting-started/team-accounts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Only Premium users registered on our platform via Google or GitHub account can u

To create a team account, follow these steps:

1. [Sign in](/rpc-service/getting-started/basics-premium/#sign-in) to the [RPC Service](https://www.ankr.com/rpc/) platform.
1. [Sign in](/rpc-service/getting-started/basics-premium/#sign-in) to the [Web3 API](https://www.ankr.com/rpc/) platform.
2. Click the **Accounts** menu > **+ Create team account** to start the procedure.
<img src="/docs/build/getting-started/account-menu.png" class="responsive-pic" width="800" />

Expand Down Expand Up @@ -67,7 +67,7 @@ Currently, only users with **Google email addresses** can be added as teammates.

To invite teammates (max.: `20`) to a team account, follow these steps:

1. [Sign in](/rpc-service/getting-started/basics-premium/#sign-in) to the [RPC Service](https://www.ankr.com/rpc/) platform.
1. [Sign in](/rpc-service/getting-started/basics-premium/#sign-in) to the [Web3 API](https://www.ankr.com/rpc/) platform.
2. Click the **Accounts** menu > **Manage team accounts** to open the **Team accounts** pane.
<img src="/docs/build/getting-started/manage-accounts.png" class="responsive-pic" width="800" />
3. In the **Team accounts** pane, click **Invite** to open the **Invite teammates** dialog.
Expand All @@ -84,7 +84,7 @@ Congrats — you've just added teammates to a team account. The selected teammat

To edit teammates' access roles, do the following:

1. [Sign in](/rpc-service/getting-started/basics-premium/#sign-in) to the [RPC Service](https://www.ankr.com/rpc/) platform.
1. [Sign in](/rpc-service/getting-started/basics-premium/#sign-in) to the [Web3 API](https://www.ankr.com/rpc/) platform.
2. Click the **Accounts** menu > **Manage team accounts** to open the **Team accounts** pane.
<img src="/docs/build/getting-started/manage-accounts.png" class="responsive-pic" width="800" />
3. In the **Team accounts** pane, click the required account to expand its contents.
Expand All @@ -100,7 +100,7 @@ Congrats — you've just edited your teammate's access role. The teammate will r

To switch your current account, do the following:

1. [Sign in](/rpc-service/getting-started/basics-premium/#sign-in) to the [RPC Service](https://www.ankr.com/rpc/) platform.
1. [Sign in](/rpc-service/getting-started/basics-premium/#sign-in) to the [Web3 API](https://www.ankr.com/rpc/) platform.
2. Click the **Accounts** menu and select the account you'd like to switch to.
<img src="/docs/build/getting-started/switch-accounts.png" class="responsive-pic" width="800" />

Expand All @@ -122,7 +122,7 @@ Congrats — you've just joined the team and can collaborate according to your a

To switch between the team accounts you belong to and exercise the corresponding access rights granted, do the following:

1. [Sign in](/rpc-service/getting-started/basics-premium/#sign-in) to the [RPC Service](https://www.ankr.com/rpc/) platform.
1. [Sign in](/rpc-service/getting-started/basics-premium/#sign-in) to the [Web3 API](https://www.ankr.com/rpc/) platform.
2. Click the **Accounts** menu and select the account you'd like to switch to.
<img src="/docs/build/getting-started/switch-accounts.png" class="responsive-pic" width="800" />

Expand Down
12 changes: 6 additions & 6 deletions pages/rpc-service/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,20 @@ import { Callout } from "components";
Ankr provides the top-performing globally-distributed decentralized infrastructure of nodes to empower your Web3 projects with blockchain interaction capabilities.

> **Your project requires blockchain interaction?**<br/>
> Head straight to **[RPC Service](https://www.ankr.com/rpc/)**.
> Head straight to **[Web3 API platform](https://www.ankr.com/rpc/)**.
<br/>
<img src="/docs/build/rpc.png" class="responsive-pic" width="800" />

## RPC Service
## Web3 API Service

*RPC Service (https://www.ankr.com/rpc/)* — a platform that provides access to our top-class nodes infrastructure to query the vast list of [supported chains](/rpc-service/chains/chains-list/), monitor requested data telemetry, and test the RPC API methods you require before actually using them.
*Web3 API Service (https://www.ankr.com/rpc/)* — a platform that provides access to our top-class nodes infrastructure to query the vast list of [supported chains](/rpc-service/chains/chains-list/), monitor requested data telemetry, and test the RPC API methods you require before actually using them.

Our [RPC Service](https://www.ankr.com/rpc/) platform has the following solutions to offer:
Our [Web3 API](https://www.ankr.com/rpc/) platform has the following solutions to offer:

* *[RPC/REST API](/rpc-service/getting-started/intro/#rpcrest-api)* — the endpoints that enable your Web3 projects to start interacting with an extensive list of [supported blockchains](/rpc-service/chains/chains-list/), give access to viewing the usage statistics for the data queried, and provide the means for RPC API methods testing.
* *[Node API](/rpc-service/getting-started/intro/#node-api)* — the endpoints that enable your Web3 projects to start interacting with an extensive list of [supported blockchains](/rpc-service/chains/chains-list/), give access to viewing the usage statistics for the data queried, and provide the means for RPC API methods testing.

* *[Advanced API](/advanced-api/overview)* — a ready-to-use indexed collection of endpoints that supports simultaneous querying of multiple blockchains (15 mainnet and 4 testnet chains available) for the most popular Web3 scenarios at near-instant speeds; available via [JavaScript](/advanced-api/javascript-sdk)/[Python](/advanced-api/python-sdk) SDKs and [React Hooks](/advanced-api/react-hooks). Advanced API also gives you access to the usage statistics for the data queried.
* *[Advanced API](/advanced-api/overview)* — a ready-to-use indexed collection of endpoints that supports simultaneous querying of multiple blockchains (16 mainnet and 4 testnet chains available) for the most popular Web3 scenarios at near-instant speeds; available via [JavaScript](/advanced-api/javascript-sdk)/[Python](/advanced-api/python-sdk) SDKs and [React Hooks](/advanced-api/react-hooks). Advanced API also gives you access to the usage statistics for the data queried.

> Learn using our platform in the [Getting Started](/rpc-service/getting-started/intro/) docs.
Expand Down
Loading

0 comments on commit 8b61728

Please sign in to comment.