Getting Started
The @up-provider library lets dApps run as mini-apps on Grid and allows parent applications to one-click-connect to your mini-app.
Installation
npm install @lukso/up-provider
Usage in mini-apps
Below are the examples of how to use the up-provider with different libraries:
- viem
- ethers
- web3
import { createClientUPProvider } from '@lukso/up-provider';
import { createWalletClient, createPublicClient, custom } from 'viem';
import { lukso } from 'viem/chains';
// Construct the up-provider
const provider = createClientUPProvider();
// Create public client if you need direct connection to RPC
const publicClient = createPublicClient({
chain: lukso,
transport: http(),
});
// Create wallet client to connect to provider
const walletClient = createWalletClient({
chain: lukso,
transport: custom(provider),
});
import { createClientUPProvider } from '@lukso/up-provider'
import { type Eip1193Provider, ethers } from 'ethers'
// Create the up-provider
const provider = createClientUPProvider()
// Wrap provider into ethers for usage.
const browserProvider = new ethers.BrowserProvider(upProvider as unknown as Eip1193Provider)
import { createClientUPProvider } from '@lukso/up-provider';
import Web3, { type EthExecutionAPI, type SupportedProviders } from 'web3';
// Create the up-provider
const provider = createClientUPProvider();
// Wrap provider into web3 for usage.
const web3 = new Web3(provider as SupportedProviders<EthExecutionAPI>);