Clearnode Sandbox Environment - Frequently Asked Questions

[nksazonov]

Clearnode Sandbox Environment

The Clearnode Sandbox Environment is a testnet version of the Clearnode infrastructure that allows developers to test their Yellow
Apps without using real-value cryptocurrencies. This sandbox environment supports popular testnets like Sepolia, enabling safe development and testing of applications built on the Clearnode protocol before deploying to production.

Before posting your question, please read the information below.

🎯 Benefits of using the Sandbox:

• Test Yellow Apps without risking real cryptocurrency
• Access to popular testnets like Sepolia
• Same API functionality as production environment
• Free test tokens available through the faucet
• Safe environment for development and debugging

❓ How do I migrate my Yellow App from Production Clearnode to the Sandbox?

Simply replace the WebSocket RPC URL in your application configuration. Change from the production endpoint to:
wss://clearnet-sandbox.yellow.com/ws.

Additionally, if your app directly interacts with Nitrolite Smart Contracts (though this should typically be handled through the
NitroliteClient SDK), make sure to update the contract addresses and chain configurations to match the testnet deployments.

❓ Is there a user interface to view my opened channels in the Sandbox?

Currently, there is no Sandbox App Store available for browsing opened channels and ledger transactions. However, the development team is actively working on implementing this feature and will provide updates as it becomes available.

❓ How can I check my balance, opened channels, and other account information in the Sandbox?

The Sandbox Clearnode exposes the same GET endpoints as the Production environment for retrieving user information. You can use:

1. Clearnode API endpoints - Refer to the Clearnode API documentation for detailed information on available endpoints like
   get_channels, get_ledger_balances, get_ledger_transactions, etc.
2. Cerebro CLI tool - This command-line interface can be used to query Clearnode information. A tutorial recording is available to help you get started with the CLI.

❓ Which test tokens does the Sandbox support and how do I obtain them?

The Sandbox Clearnode supports Yellow Test USD, a custom test token designed specifically for the sandbox environment. You can request these tokens through the Faucet App, which adds them directly to your Clearnode unified balance.

To request test tokens run:

curl -XPOST https://clearnet-sandbox.yellow.com/faucet/requestTokens -d '{"userAddress":"<your_address>"}'

The faucet provides 10 Test USD per request to your unified balance on the Clearnode (NOT on-chain).

❓ How to get test tokens on-chain

To obtain test tokens on-chain, you need to withdraw Yellow Test USD from your Clearnode unified balance to a supported testnet.
Here's the process:

1. First, get test tokens in your unified balance using the Faucet App:
   curl -XPOST https://clearnet-sandbox.yellow.com/faucet/requestTokens -d '{"userAddress":"<your_address>"}'
2. Create a channel (probably with "0" deposit as you may not have the test token to deposit yet) on your desired testnet (like Sepolia) using the create_channel API endpoint
3. Withdraw the tokens from the channel to your on-chain wallet address using the close_channel or resize_channel endpoints,
   specifying your wallet address as the funds_destination

This process moves the Yellow Test USD from your off-chain Clearnode balance to actual testnet tokens that you can use for on-chain testing, smart contract interactions, or other testnet activities.