diff --git a/SUMMARY.md b/SUMMARY.md index fb86d16f..13fb8c3b 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -51,9 +51,9 @@ * [Storage Specifications](developers/storage.md) * [Fine-Grained Permissions](developers/fg-permissions.md) * [Retrieve datatoken/data NFT addresses & Chain ID](developers/retrieve-datatoken-address.md) + * [Get API Keys for Blockchain Access](developers/get-api-keys-for-blockchain-access.md) * [Barge](developers/barge/README.md) * [Local Setup](developers/barge/local-setup-ganache.md) - * [Obtaining API Keys for Blockchain Access](developers/obtaining-api-keys-for-blockchain-access.md) * [Build a Marketplace](developers/build-a-marketplace/README.md) * [Forking Ocean Market](developers/build-a-marketplace/forking-ocean-market.md) * [Customising a Market](developers/build-a-marketplace/customising-your-market.md) diff --git a/developers/barge/local-setup-ganache.md b/developers/barge/local-setup-ganache.md index 99efd979..feb138ad 100644 --- a/developers/barge/local-setup-ganache.md +++ b/developers/barge/local-setup-ganache.md @@ -6,24 +6,17 @@ description: 🧑🏽‍💻 Your Local Development Environment for Ocean Protoc **Functionalities of Barge** -Barge offers several functionalities that enable developers to create and test the Ocean Protocol infrastructure efficiently. Here its key components: +Barge offers several functionalities that enable developers to create and test the Ocean Protocol infrastructure efficiently. Here are its key components: -| Functionality | Description | -| ------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| Aquarius | A metadata storage and retrieval service for Ocean Protocol. Allows indexing and querying of metadata. | -| Provider | A service that facilitates interaction between users and the Ocean Protocol network. | -| Ganache | A local Ethereum blockchain network for testing and development purposes. | -| TheGraph | A decentralized indexing and querying protocol used for building subgraphs in Ocean Protocol. | -| ocean-contracts | Smart contracts repository for Ocean Protocol. Deploys and manages the necessary contracts for local development. | -| Customization and Options | Barge provides various options to customize component versions, log levels, and enable/disable specific blocks. | +
FunctionalityDescription
AquariusA metadata storage and retrieval service for Ocean Protocol. Allows indexing and querying of metadata.
ProviderA service that facilitates interaction between users and the Ocean Protocol network.
GanacheA local Ethereum blockchain network for testing and development purposes.
TheGraphA decentralized indexing and querying protocol used for building subgraphs in Ocean Protocol.
ocean-contractsSmart contracts repository for Ocean Protocol. Deploys and manages the necessary contracts for local development.
Customization and OptionsBarge provides various options to customize component versions, log levels, and enable/disable specific blocks.
-Barge makes it easy for developers to get started with Ocean Protocol by providing a comprehensive local development environment. With its modular and user-friendly design, developers can focus on building and testing their applications without worrying about the intricacies of the underlying infrastructure. +Barge helps developers to get started with Ocean Protocol by providing a local development environment. With its modular and user-friendly design, developers can focus on building and testing their applications without worrying about the intricacies of the underlying infrastructure. To use Barge, you can follow the instructions in the [Barge repository](https://github.com/oceanprotocol/barge). Before getting started, make sure you have the following prerequisites: -* Linux or macOS operating system. Barge does not currently support Windows, but you can run it inside a Linux virtual machine or use the Windows Subsystem for Linux (WSL). +* **Linux** or **macOS** operating system. Barge does not currently support Windows, but you can run it inside a Linux virtual machine or use the Windows Subsystem for Linux (WSL). * Docker installed on your system. You can download and install Docker from the [Docker website](https://www.docker.com/get-started). On Linux, you may need to allow non-root users to run Docker. On Windows or macOS, it is recommended to increase the memory allocated to Docker to 4 GB (default is 2 GB). * Docker Compose, which is used to manage the Docker containers. You can find installation instructions in the [Docker Compose documentation](https://docs.docker.com/compose/). diff --git a/developers/get-api-keys-for-blockchain-access.md b/developers/get-api-keys-for-blockchain-access.md new file mode 100644 index 00000000..be3e4394 --- /dev/null +++ b/developers/get-api-keys-for-blockchain-access.md @@ -0,0 +1,21 @@ +--- +description: 🧑🏽‍💻 Remote Development Environment for Ocean Protocol +--- + +# Get API Keys for Blockchain Access + +This article points out an alternative for configuring remote networks on Ocean Protocol components: the libraries, Provider, Aquarius, Subgraph, without using Barge services. + +### Get API key for Ethereum node provider + +Ocean Protocol's smart contracts are deployed on EVM-compatible networks. Using an API key provided by a third-party Ethereum node provider allows you to interact with the Ocean Protocol's smart contracts on the supported networks without requiring you to host a local node. + +Choose any API provider of your choice. Some of the commonly used are: + +* [Infura](https://infura.io/) +* [Alchemy](https://www.alchemy.com/) +* [Moralis](https://moralis.io/) + +The supported networks are listed [here](../discover/networks/). + +Let's configure the remote setup for the mentioned components in the following sections.