Skip to main content

​
Prerequisites

Before integrating with Sonar, ensure you have:

Echo Application

An approved application to use Sonar. Apply here if you haven’t already.

Technical Setup

You will need to be able to create a website and deploy smart contracts to an EVM-compatible blockchain.

Legal Requirements

Understanding of your jurisdiction’s securities laws and compliance requirements for token sales.

​
Step 1 - Access the Founder Dashboard

Once your application is approved, access the Echo Founder Dashboard to:
  1. Configure your sale: Configure basic sale parameters
  2. Configure compliance settings: Set KYC/KYB and accreditation requirements
  3. Get integration credentials: Copy your Sale UUID and OAuth Client UUID from the integration section

​
Step 2 - Configure Your Sale Settings

In the founder dashboard, configure settings for your sale. You can change these later on if you need to.

​
Step 3 - Setup your website

The easiest way to get started is to clone one of our example websites: 
git clone https://github.com/sunrisedotdev/sonar-example-nextjs
Copy or edit the .env.local file to set your sale UUID and OAuth client UUID. This template is configured to use Next.js, React, and Wagmi. It makes use of the @echoxyz/sonar-core and @echoxyz/sonar-react libraries to integrate Sonar. If you want to use a different framework, you can use the @echoxyz/sonar-core library directly. Alterantively, you can create your own website if any framework you like.
  • Wrap your app with the Sonar provider alongside your wallet provider
  • Create a page at your redirect URI to handle OAuth callbacks
  • Add authentication buttons to your app

​
Step 4 - Test the Integration

Make sure your website is configured and running.
  1. Test OAuth flow
    • Click “Sign in with Sonar”
    • Complete authentication on Sonar
    • Verify you’re redirected back successfully
  2. Check entity status
    • Connect a wallet
    • Verify entity data loads correctly
    • Test with different wallet addresses

​
Next Steps

Now that you have basic integration working, familiarize yourself with key concepts and choose your implementation path:

Key Concepts

Understand entities, permits, and the compliance flow

Smart Contract Integration

Implement permit validation in your sale contract

Frontend Integration

Add Sonar authentication and permit generation to your app

Smart Contract Integration

Learn how to implement purchase permits and signature verification in your sale contract.

Frontend Integration

Choose your frontend framework and implement the complete purchase flow.

​
Getting Help

If you encounter issues during setup:
⌘I