​
Install the SDK

npm install @chipi-pay/chipi-sdk

​
Create your Organization in our Dashboard to get your keys

Go to Dashboard

Get your keys and some statistics from your app.

​
Get your API Keys

Once you have registered and logged into the dashboard, go to the Configure tab. There you will find your App ID, Public Key, and Secret Key.

Note: Keep your Secret Key safe and never share it or expose it in your frontend code.

​
Setup the Provider

The first step is to wrap your application with the ChipiProvider component. This provider initializes the SDK and makes all the hooks available throughout your application.

Create a providers file (e.g., app/providers.tsx for Next.js):

// app/providers.tsx

// Initialize SDK
import { ChipiProvider } from "@chipi-pay/chipi-sdk";

const CHIPI_PUBLIC_KEY = process.env.NEXT_PUBLIC_CHIPI_PUBLIC_KEY!;
const CHIPI_APP_ID = process.env.NEXT_PUBLIC_CHIPI_APP_ID!;
const CHIPI_SECRET_KEY = process.env.CHIPI_SECRET_KEY!;

if (!CHIPI_PUBLIC_KEY || !CHIPI_APP_ID || !CHIPI_SECRET_KEY) {
  throw new Error("Some Key is not set");
}

export function Providers({ children }: { children: React.ReactNode }) {
  return (
    <ChipiProvider
      config={{
        apiKey: "CHIPI_PUBLIC_KEY",
        secretKey: "CHIPI_SECRET_KEY",
        appId: "CHIPI_APP_ID"
      }}
    >
      {children}
    </ChipiProvider>
  );
}

Then import and use this provider in your layout file (e.g., app/layout.tsx for Next.js):

// app/layout.tsx
import { Providers } from './providers';

export default function RootLayout({
  children,
}: {
  children: React.ReactNode;
}) {
  return (
    <html lang="en">
      <body>
        <Providers>
          {children}
        </Providers>
      </body>
    </html>
  );
}

This setup:

  1. Initializes the SDK with our Avnu Paymaster Provider
  2. Connects to StarkNet Mainnet via our RPC endpoint
  3. Makes all Chipi SDK hooks available throughout your application
  4. Sets up the wallet management infrastructure

​
Additional Steps

  1. Obtain Your OAuth Provider API Keys
    We recommend Clerk or a similar service to streamline social login with providers like Google, X, or Meta. Once configured, you can pass user tokens to the Chipi SDK for invisible wallet creation.

​
Wanna Deep Dive?

Expand your knowledge with these resources:

Learn to Ship Your First Smart Contract

Get a quick introduction to building on StarkNet.

Sponsor Transactions

Discover how to cover users’ gas fees with Avnu’s paymaster.

Set Up Clerk + Next.js

Seamlessly integrate social login into your Next.js project.

See Our Live Demo

Check out a full example of the Chipi SDK in action.