Thirdweb

https://portal.thirdweb.com/
Admin
Thirdweb is a comprehensive web3 development platform providing SDKs, APIs, and tools for building...
Tokens:744,289
Snippets:8,358
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### .NET Package Installation

Source: https://portal.thirdweb.com/dotnet/getting-started

Installs the Thirdweb SDK via the NuGet package manager.

```bash
dotnet add package Thirdweb
```

--------------------------------

### Install the contracts package using Forge

Source: https://portal.thirdweb.com/tokens/build/get-started

Command to install the thirdweb contracts package into an existing Forge project.

```bash
forge install https://github.com/thirdweb-dev/contracts

```

--------------------------------

### Example of inheriting and using a base contract (ERC721Base)

Source: https://portal.thirdweb.com/tokens/build/get-started

A Solidity smart contract example demonstrating inheritance from ERC721Base and implementing its constructor.

```solidity
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;

import "@thirdweb-dev/contracts/base/ERC721Base.sol";

contract MyNFT is ERC721Base {
    constructor(
        address _defaultAdmin,
        string memory _name,
        string memory _symbol,
        address _royaltyRecipient,
        uint128 _royaltyBps
    ) ERC721Base(_defaultAdmin, _name, _symbol, _royaltyRecipient, _royaltyBps) {}
}

```

--------------------------------

### Install thirdweb and its React Native adapter packages

Source: https://portal.thirdweb.com/react-native/v5/getting-started

Installs the necessary thirdweb packages for React Native development.

```bash
npx expo install thirdweb @thirdweb-dev/react-native-adapter
```

--------------------------------

### Example of inheriting base contracts and extensions (ERC721Base and Permissions)

Source: https://portal.thirdweb.com/tokens/build/get-started

A Solidity smart contract example demonstrating inheritance from both ERC721Base and the Permissions extension.

```solidity
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;

import "@thirdweb-dev/contracts/base/ERC721Base.sol";
import "@thirdweb-dev/contracts/extension/Permissions.sol";

contract MyNFT is ERC721Base, Permissions {
    constructor(
        address _defaultAdmin,
        string memory _name,
        string memory _symbol,
        address _royaltyRecipient,
        uint128 _royaltyBps
    ) ERC721Base(_defaultAdmin, _name, _symbol, _royaltyRecipient, _royaltyBps) {}
}

```

--------------------------------

### Setup

Source: https://portal.thirdweb.com/wallets/session-keys

First, let's set up the necessary imports and configuration:

```typescript
import {
  createThirdwebClient,
  getContract,
  sendTransaction,
  prepareTransaction,
} from "thirdweb";
import { sepolia } from "thirdweb/chains";
import {
  inAppWallet,
  createSessionKey,
} from "thirdweb/wallets/in-app";

// Configure your client
const client = createThirdwebClient({
  clientId: "your-client-id",
  secretKey: "your-secret-key", // Only use in server environments
});

// Your session key account address
const sessionKeyAccountAddress = "0x..."; // Replace with your session key address (server wallet)
```

--------------------------------

### Complete Example

Source: https://portal.thirdweb.com/engine/v3/guides/session-keys

This comprehensive example demonstrates the entire process of setting up and executing a transaction with a session key, including account generation, smart wallet configuration, session key verification, and transaction execution.

```typescript
import {
  generateAccount,
  smartWallet,
  sendTransaction,
  getContract,
  createThirdwebClient,
} from "thirdweb";
import { sepolia } from "thirdweb/chains";
import { getAllActiveSigners } from "thirdweb/extensions/erc4337";
import { Engine } from "thirdweb/engine";
 
async function executeTransactionWithSessionKey() {
  // Configuration
  const client = createThirdwebClient({
    clientId: "your-client-id",
    secretKey: "your-secret-key",
  });
 
  const sessionKeyAccountAddress = "0x..."; // Your session key address
  const targetAddress = "0x..."; // Target address for the final transaction
 
  try {
    // Step 1: Create personal account
    const personalAccount = await generateAccount({ client });
 
    // Step 2: Configure smart wallet
    const smart = smartWallet({
      chain: sepolia,
      sessionKey: {
        address: sessionKeyAccountAddress,
        permissions: {
          approvedTargets: "*",
        },
      },
      sponsorGas: true,
    });
 
    // Step 3: Connect smart account
    const smartAccount = await smart.connect({
      client,
      personalAccount,
    });
 
    // Step 4: Verify session key
    const signers = await getAllActiveSigners({
      contract: getContract({
        address: smartAccount.address,
        chain: sepolia,
        client,
      }),
    });
 
    const isSessionKeyActive = signers
      .map((s) => s.signer)
      .includes(sessionKeyAccountAddress);
 
    if (!isSessionKeyActive) {
      throw new Error("Session key is not active");
    }
 
    // Step 5: Create server wallet
    const serverWallet = Engine.serverWallet({
      address: sessionKeyAccountAddress,
      chain: sepolia,
      client,
      executionOptions: {
        entrypointVersion: "0.6",
        signerAddress: sessionKeyAccountAddress,
        smartAccountAddress: smartAccount.address,
        type: "ERC4337",
      },
      vaultAccessToken: process.env.VAULT_TOKEN as string,
    });
 
    // Step 6: Execute transaction
    const tx = await sendTransaction({
      account: serverWallet,
      transaction: {
        chain: sepolia,
        client,
        to: targetAddress,
        value: 0n,
      },
    });
 
    console.log("Transaction successful:", tx.transactionHash);
    return tx;
  } catch (error) {
    console.error("Error executing transaction:", error);
    throw error;
  }
}
 
// Execute the function
executeTransactionWithSessionKey()
  .then((tx) => console.log("Done!", tx.transactionHash))
  .catch((error) => console.error("Failed:", error));
```

--------------------------------

### Complete Example: Setup and Use Session Key with ERC-7702

Source: https://portal.thirdweb.com/wallets/session-keys

This comprehensive example shows the full process of setting up a session key using ERC-7702, including creating the smart EOA, granting permissions, and executing a transaction.

```typescript
import {
  createThirdwebClient,
  getContract,
  sendTransaction,
  prepareTransaction,
} from "thirdweb";
import { sepolia } from "thirdweb/chains";
import {
  inAppWallet,
  createSessionKey,
} from "thirdweb/wallets/in-app";
import { Engine } from "thirdweb/engine";
 
async function setupSessionKeyWith7702() {
  // Configuration
  const client = createThirdwebClient({
    clientId: "your-client-id",
    secretKey: "your-secret-key",
  });
 
  const sessionKeyAccountAddress = "0x..."; // Your session key address (server wallet)

  try {
    // Step 1: Create 7702 Smart EOA
    const wallet = inAppWallet({
      executionMode: {
        mode: "EIP7702",
        sponsorGas: true,
      },
    });
 
    const account = await wallet.connect({
      chain: sepolia,
      client: client,
      strategy: "google",
    });
 
    console.log("Upgraded EOA created:", account.address);
 
    // Step 2: Get account contract
    const accountContract = getContract({
      address: account.address,
      chain: sepolia,
      client: client,
    });
 
    // Step 3: Create session key
    const sessionTx = await sendTransaction({
      account: account,
      transaction: createSessionKey({
        account: account,
        contract: accountContract,
        sessionKeyAddress: sessionKeyAccountAddress,
        durationInSeconds: 86400, // 1 day
        grantFullPermissions: true,
      }),
    });
 
    console.log("Session key created:", sessionTx.transactionHash);
 
    // Step 4: Use the session key with Engine
    const serverWallet = Engine.serverWallet({
      address: sessionKeyAccountAddress,
      chain: sepolia,
      client: client,
      executionOptions: {
        type: "EIP7702",
        sessionKeyAddress: sessionKeyAccountAddress,
        accountAddress: account.address,
      },
    });
 
    // Execute a transaction with the session key
    const tx = await sendTransaction({
      account: serverWallet,
      transaction: prepareTransaction({
        chain: sepolia,
        client: client,
        to: "0x...", // Target address
        value: 0n,
      }),
    });
 
    console.log("Transaction successful:", tx.transactionHash);
    return tx;
  } catch (error) {
    console.error("Error:", error);
    throw error;
  }
}
 
// Execute the function
setupSessionKeyWith7702()
  .then((tx) => console.log("Done!", tx.transactionHash))
  .catch((error) => console.error("Failed:", error));
```

--------------------------------

### Create a new project with the thirdweb CLI

Source: https://portal.thirdweb.com/tokens/build/get-started

Command to create a new project using the thirdweb CLI.

```bash
npx thirdweb create contract

```

--------------------------------

### Setup the ThirdwebProvider

Source: https://portal.thirdweb.com/react/v5/getting-started

Wrap your application with ThirdwebProvider at the root to manage state like active wallet and chain.

```tsx
// src/main.tsx
import { ThirdwebProvider } from "thirdweb/react";

function Main() {
  return (
    <ThirdwebProvider>
      <App />
    </ThirdwebProvider>
  );
}

```

--------------------------------

### WebGL Local Server Setup

Source: https://portal.thirdweb.com/unity/v6/build-instructions

Example setup for testing In-App or Ecosystem Wallet Social Login locally using Node.js and Express to set the 'Cross-Origin-Opener-Policy' header.

```javascript
// YourWebGLOutputFolder/server.js
const express = require("express");
const app = express();
const port = 8000;

app.use((req, res, next) => {
  res.header(
    "Cross-Origin-Opener-Policy",
    "same-origin-allow-popups",
  );
  next();
});

app.use(express.static("."));
app.listen(port, () =>
  console.log(`Server running on http://localhost:${port}`),
);

// run it with `node server.js`

```

--------------------------------

### Example prompt: Get wallet balance

Source: https://portal.thirdweb.com/ai/mcp

An example prompt for checking a wallet's balance.

```shell
What's the balance of treasury wallet?

```

--------------------------------

### Step 2: Get Account Contract

Source: https://portal.thirdweb.com/wallets/session-keys

Create a contract instance for the deployed smart EOA:

```typescript
const accountContract = getContract({
  address: account.address,
  chain: sepolia,
  client: client,
});
```

--------------------------------

### Initialize Thirdweb Client

Source: https://portal.thirdweb.com/dotnet/getting-started

Creates a new instance of the Thirdweb client for different application types.

```csharp
// For Web Applications
var client = ThirdwebClient.Create(clientId: "yourClientId");

// For Native Applications
var client = ThirdwebClient.Create(clientId: "yourClientId", bundleId: "yourBundleId");

// For Backend Applications
var client = ThirdwebClient.Create(secretKey: "yourSecretKey");
```

--------------------------------

### Interact With A Wallet

Source: https://portal.thirdweb.com/wallets/quickstart

Get the wallet address using useActiveAccount and read the wallet balance using useWalletBalance.

```typescript
import { useActiveAccount, useWalletBalance } from "thirdweb/react";

export default function MyComponent() {
  // 1. get wallet address
  const account = useActiveAccount();
  console.log("wallet address", account?.address);

  // 2. get wallet balance
  const { data: balance, isLoading } = useWalletBalance({
    client,
    chain,
    address: account?.address,
  });
  console.log(
    "wallet balance",
    balance?.displayValue,
    balance?.symbol,
  );
}
```

--------------------------------

### Example Usage

Source: https://portal.thirdweb.com/typescript/v5/getBuyWithFiatStatus

This example shows how to get the status of a buy with fiat transaction.

```typescript
// step 1 - get a quote
const fiatQuote = await getBuyWithFiatQuote(fiatQuoteParams);

// step 2 - open the on-ramp provider UI
window.open(quote.onRampLink, "_blank");

// step 3 - keep calling getBuyWithFiatStatus while the status is in one of the pending states
const fiatStatus = await getBuyWithFiatStatus({
  client,
  intentId: fiatQuote.intentId,
});

// when the fiatStatus.status is "ON_RAMP_TRANSFER_COMPLETED" - the process is complete

```

--------------------------------

### Smart Wallet Upgrades

Source: https://portal.thirdweb.com/unity/v6/migration-guide

Example of upgrading to a smart wallet in v6.

```csharp
var personalWallet = await PrivateKeyWallet.Generate(client);
var smartWallet = await ThirdwebManager.Instance.UpgradeToSmartWallet(
    personalWallet,
    chainId: new BigInteger(421614),
    smartWalletOptions: new SmartWalletOptions(sponsorGas: true)
);
```

--------------------------------

### Setup Imports and Configuration

Source: https://portal.thirdweb.com/engine/v3/guides/session-keys

Imports necessary functions from the thirdweb SDK and configures the client, session key address, and target address.

```typescript
import {
  generateAccount,
  smartWallet,
  sendTransaction,
  getContract,
  createThirdwebClient,
} from "thirdweb";
import { sepolia } from "thirdweb/chains";
import { getAllActiveSigners } from "thirdweb/extensions/erc4337";
import { Engine } from "thirdweb/engine";

// Configure your client
const client = createThirdwebClient({
  clientId: "your-client-id",
  secretKey: "your-secret-key", // Only use in server environments
});

// Your session key account address
const sessionKeyAccountAddress = "0x..."; // Replace with your session key address

// Target address for transactions
const targetAddress = "0x..."; // Replace with your target address

```

--------------------------------

### Solana Token Deployment API - Quick Start

Source: https://portal.thirdweb.com/changelog

Example cURL command to deploy a basic SPL Token on Solana devnet using the thirdweb API.

```bash
curl -X POST "https://api.thirdweb.com/v1/solana/deploy" \
  -H "Content-Type: application/json" \
  -H "x-secret-key: YOUR_SECRET_KEY" \
  -d '{ \
    "from": "YOUR_WALLET_ADDRESS", \
    "chainId": "solana:devnet", \
    "name": "My Token", \
    "symbol": "MTK", \
    "decimals": 9 \
  }'

```

--------------------------------

### Set up the Client, Provider and ConnectButton

Source: https://portal.thirdweb.com/wallets/quickstart

Initialize the SDK with your client ID, wrap your application with the ThirdwebProvider, and add a ConnectButton.

```typescript
import { createThirdwebClient } from "thirdweb";
import { ThirdwebProvider, ConnectButton } from "thirdweb/react";

export const client = createThirdwebClient({ clientId: <your_client_id> });

export default function App() {
  return (
    <ThirdwebProvider>
      <ConnectButton client={client} />
    </ThirdwebProvider>
  );
}
```

--------------------------------

### Install the thirdweb SDK

Source: https://portal.thirdweb.com/typescript/v5/getting-started

Install the SDK using your preferred package manager.

```bash
npm i thirdweb
```

--------------------------------

### Install required peer dependencies for React Native SDK

Source: https://portal.thirdweb.com/react-native/v5/getting-started

Installs essential peer dependencies required by the thirdweb React Native SDK.

```bash
npx expo install react-native-get-random-values @react-native-community/netinfo expo-application @react-native-async-storage/async-storage expo-web-browser expo-linking react-native-aes-gcm-crypto react-native-quick-crypto amazon-cognito-identity-js @coinbase/wallet-mobile-sdk react-native-mmkv react-native-svg @walletconnect/react-native-compat react-native-passkey
```

--------------------------------

### Quick start

Source: https://portal.thirdweb.com/dotnet/wallets/server-wallet

Instantiate a server wallet by providing the client and label.

```.cs
var client = ThirdwebClient.Create(secretKey: Environment.GetEnvironmentVariable("THIRDWEB_SECRET_KEY"));

var wallet = await ServerWallet.Create(
    client: client,
    label: "production-deployer"
);

Console.WriteLine($"Server wallet ready at {await wallet.GetAddress()}.");
```

--------------------------------

### Send Test Transaction (cURL)

Source: https://portal.thirdweb.com/engine/v3/get-started

Example cURL command to send a test transaction using the thirdweb Transactions API.

```curl
curl -X POST "https://engine.thirdweb.com/v1/write/contract" \
	-H "Content-Type: application/json" \
	-H "x-secret-key: <your-project-secret-key>" \
	-H "x-vault-access-token: <your-vault-access-token>" \
	-d '{
		"executionOptions": {
			"from": "<your-server-wallet-address>",
			"chainId": "84532"
		},
		"params": [
			{
				"contractAddress": "0x...",
				"method": "function mintTo(address to, uint256 amount)",
				"params": ["0x...", "100"]
			}
		]
	}'
```

--------------------------------

### Complete Workflow Example

Source: https://portal.thirdweb.com/changelog

Example demonstrating the complete workflow of signing and then broadcasting a Solana transaction using cURL and jq.

```bash
# Step 1: Sign the transaction
SIGNED_TX=$(curl -X POST https://api.thirdweb.com/v1/solana/sign-transaction \
  -H "Content-Type: application/json" \
  -H "x-secret-key: YOUR_SECRET_KEY" \
  -d '{
    "from": "8JBLmveV4YF5AQ7EVnKJgyj6etGgVkPp3tYqQMTu3p5B",
    "chainId": "solana:devnet",
    "instructions": [...] 
  }' | jq -r '.result.signedTransaction')
 
# Step 2: Broadcast the signed transaction
curl -X POST https://api.thirdweb.com/v1/solana/broadcast-transaction \
  -H "Content-Type: application/json" \
  -H "x-secret-key: YOUR_SECRET_KEY" \
  -d "{
    \"chainId\": \"solana:devnet\",
    \"signedTransaction\": \"$SIGNED_TX\" 
  }"
```

--------------------------------

### Run the Application

Source: https://portal.thirdweb.com/contracts/arbitrum-stylus/zk-mint

Navigate to the app directory and start the development server.

```bash
cd app
pnpm dev
# Visit http://localhost:3000

```

--------------------------------

### Example of overriding the mintTo function

Source: https://portal.thirdweb.com/tokens/build/get-started

This example demonstrates how to override the `mintTo` function from `ERC721Base` to add custom logic, restricting minting to one NFT per wallet, and using `super` to call the original parent function.

```solidity
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0; 

import "@thirdweb-dev/contracts/base/ERC721Base.sol";
import "@thirdweb-dev/contracts/extension/Permissions.sol";

contract MyNFT is ERC721Base, Permissions {
    constructor(
        address _defaultAdmin,
        string memory _name,
        string memory _symbol,
        address _royaltyRecipient,
        uint128 _royaltyBps
    ) ERC721Base(_defaultAdmin, _name, _symbol, _royaltyRecipient, _royaltyBps) {}

    function mintTo(address _to, string memory _tokenURI) public override {
        require(balanceOf(_to) < 1, "only 1 NFT per wallet!");
        super.mintTo(_to, _tokenURI);
    }
}
```

--------------------------------

### Import thirdweb hooks, extensions, and wallets

Source: https://portal.thirdweb.com/react-native/v5/getting-started

Example of importing necessary components from the thirdweb package for use in a React Native application.

```javascript
// import thirdweb hooks, extensions, provider and wallets as usual
import { ThirdwebProvider } from "thirdweb/react";
import { balanceOf, claimTo } from "thirdweb/extensions/erc721";
import { inAppWallet } from "thirdweb/wallets/in-app";
```

--------------------------------

### Overriding the _canMint function with Permissions extension

Source: https://portal.thirdweb.com/tokens/build/get-started

A Solidity smart contract example overriding the _canMint function to use the Permissions extension, allowing only those with MINTER_ROLE to mint.

```solidity
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;

import "@thirdweb-dev/contracts/base/ERC721Base.sol";
import "@thirdweb-dev/contracts/extension/Permissions.sol";

contract MyNFT is ERC721Base, Permissions {
    bytes32 private constant MINTER_ROLE = keccak256("MINTER_ROLE");

    constructor(
        address _defaultAdmin,
        string memory _name,
        string memory _symbol,
        address _royaltyRecipient,
        uint128 _royaltyBps
    ) ERC721Base(_defaultAdmin, _name, _symbol, _royaltyRecipient, _royaltyBps) {}

    /**
     *  `_canMint` is a function available in `ERC721Base`.
     *
     *  It is called every time a wallet tries to mint NFTs on this
     *  contract, and lets you define the condition in which an
     *  attempt to mint NFTs should be permitted, or rejected.
     *
     *  By default, `ERC721Base` only lets the contract's owner mint
     *  NFTs. Here, we override that functionality.
     *
     *  We use the `Permissions` extension to specify that anyone holding
     *  "MINTER_ROLE" should be able to mint NFTs.
     */
    function _canMint() internal view override returns (bool) {
        return hasRole(MINTER_ROLE, msg.sender);
    }
}

```

--------------------------------

### Example prompt: Create a server wallet

Source: https://portal.thirdweb.com/ai/mcp

An example prompt for creating a server wallet.

```shell
Create a server wallet called treasury

```

--------------------------------

### ConnectButton with only In-App Wallets as Smart Accounts

Source: https://portal.thirdweb.com/react/v5/account-abstraction/get-started

This example configures the ConnectButton so that only in-app wallets are converted to smart accounts. External wallets will not be converted.

```typescript
import { createThirdwebClient } from "thirdweb";
import { sepolia } from "thirdweb/chains";
import { ThirdwebProvider, ConnectButton } from "thirdweb/react";
import { inAppWallet, createWallet } from "thirdweb/wallets";

const client = createThirdwebClient({
  clientId: "YOUR_CLIENT_ID",
});

const wallets = [
  inAppWallet({
    // only configure smart accounts for in-app wallets
    smartAccount: {
      chain: sepolia,
      sponsorGas: true,
    },
  }),
  // other external wallets will not become smart accounts
  createWallet("io.metamask"),
  createWallet("rainbow.me"),
];

export default function App() {
  return (
    <ThirdwebProvider>
      <ConnectButton client={client} wallets={wallets} />
    </ThirdwebProvider>
  );
}
```

--------------------------------

### ConnectButton with Account Abstraction

Source: https://portal.thirdweb.com/react/v5/account-abstraction/get-started

This example shows how to use the ConnectButton component with the `accountAbstraction` property to automatically convert connected wallets to smart accounts. It also demonstrates how to enable sponsored transactions.

```typescript
import { createThirdwebClient } from "thirdweb";
import { sepolia } from "thirdweb/chains";
import { ThirdwebProvider, ConnectButton } from "thirdweb/react";

const client = createThirdwebClient({
  clientId: "YOUR_CLIENT_ID",
});

export default function App() {
  return (
    <ThirdwebProvider>
      <ConnectButton
        client={client}
        accountAbstraction={{
          chain: sepolia, // the chain where your smart accounts will be or is deployed
          sponsorGas: true, // enable or disable sponsored transactions
        }}
      />
    </ThirdwebProvider>
  );
}
```

--------------------------------

### Custom UI with useConnect hook

Source: https://portal.thirdweb.com/react/v5/account-abstraction/get-started

This example demonstrates how to use the `useConnect` hook to connect to smart accounts and build a custom UI. It shows how to configure `accountAbstraction` for the hook and initiate the connection process.

```typescript
import { useConnect } from "thirdweb/react";
import { inAppWallet } from "thirdweb/wallets";
import { sepolia } from "thirdweb/chains";

function App() {
  // 1. set the `accountAbstraction` configuration to convert wallets to smart accounts
  const { connect } = useConnect({
    client,
    accountAbstraction: {
      chain: sepolia, // the chain where your smart accounts will be or is deployed
      sponsorGas: true, // enable or disable sponsored transactions
    },
  });

  const connectToSmartAccount = async () => {
    // 2. connect with the admin wallet of the smart account
    connect(async () => {
      const wallet = inAppWallet(); // or any other wallet
      await wallet.connect({
        client,
        chain: sepolia,
        strategy: "google",
      });
      return wallet;
    });
  };

  return (
    <button onClick={() => connectToSmartAccount()}>Connect</button>
  );
}
```

--------------------------------

### Send a Transaction

Source: https://portal.thirdweb.com/wallets/quickstart

Prepare and send a transaction using extensions, getContract, and useSendTransaction.

```typescript
import { getContract } from "thirdweb";
import { sepolia } from "thirdweb/chains";
import { useSendTransaction } from "thirdweb/react";
// 1. import the extension you want to use
import { transfer } from "thirdweb/extensions/erc20";

// 2. define the target contract
const USDC = getContract({
  client,
  address: USDC_ADDRESS,
  chain: sepolia,
});

export default function MyComponent() {
  // 3. call the useSendTransaction hook
  const { mutate: sendTransaction, isPending } = useSendTransaction();

  const onClick = () => {
    // 4. execute the transaction (send 15 USDC to the target address)
    const transaction = transfer({
      contract: USDC,
      amount: 15,
      to: "0x...",
    });
    sendTransaction(transaction);
  };
}
```

--------------------------------

### Get Installed Modules

Source: https://portal.thirdweb.com/llms-full.txt

Retrieves the list of modules currently installed on a contract.

```ts
import { getInstalledModules } from "thirdweb/extensions/modules";
 
const result = await getInstalledModules({
  contract,
});
```

```ts
function getInstalledModules(options: BaseTransactionOptions) : Promise<readonly Array<{ config: { callbackFunctions: readonly Array<{ selector: `0x${string}` }>; fallbackFunctions: readonly Array<{ permissionBits: bigint; selector: `0x${string}` }>; registerInstallationCallback: boolean; requiredInterfaces: readonly Array<`0x${string}`>; supportedInterfaces: readonly Array<`0x${string}`> }; implementation: string }>>
```

```ts
let options: { contract: ThirdwebContract<abi> } & T;
```

```ts
let returnType: Promise<readonly Array<{ config: { callbackFunctions: readonly Array<{ selector: `0x${string}` }>; fallbackFunctions: readonly Array<{ permissionBits: bigint; selector: `0x${string}` }>; registerInstallationCallback: boolean; requiredInterfaces: readonly Array<`0x${string}`>; supportedInterfaces: readonly Array<`0x${string}`> }; implementation: string }>>
```

--------------------------------

### Setup Core Contract

Source: https://portal.thirdweb.com/tokens/modular-contracts/get-started/create-core-contract

This snippet shows the basic structure for setting up a core contract, including the `supportsInterface` function.

```solidity
    ) public view override returns (bool) {
        return interfaceId == 0x00000001 || super.supportsInterface(interfaceId);
    }
}

```

--------------------------------

### Usage with options

Source: https://portal.thirdweb.com/cli/build

Shows the general usage of the thirdweb CLI with available options.

```bash
npx thirdweb [options]
```

--------------------------------

### Get a contract

Source: https://portal.thirdweb.com/typescript/v5/contract

Example of how to get a contract instance using the thirdweb SDK.

```typescript
import { getContract } from "thirdweb";
import { ethereum } from "thirdweb/chains";

// get a contract
const contract = getContract({
  // the client you have created via `createThirdwebClient()`
  client,
  // the chain the contract is deployed on
  chain: ethereum,
  // the contract's address
  address: "0x123...",
  // OPTIONAL: the contract's abi
  abi: [...],
});
```

--------------------------------

### Setup the ThirdwebProvider

Source: https://portal.thirdweb.com/react/v5/in-app-wallet/build-your-own-ui

This will ensure that the wallet is available to all components in your app, handle connection states and auto-connection on page load.

```javascript
import { ThirdwebProvider } from "thirdweb/react";
 
<ThirdwebProvider>
  <YourApp />
</ThirdwebProvider>;
```

--------------------------------

### Get Balance

Source: https://portal.thirdweb.com/dotnet/wallets/actions/getbalance

Example usage for getting the native token balance or an ERC20 token balance.

```csharp
// Get native balance
BigInteger nativeBalance = await wallet.GetBalance(chainId);
 
// Get ERC20 token balance
BigInteger tokenBalance = await wallet.GetBalance(chainId, erc20ContractAddress);
```

--------------------------------

### Example prompt: List server wallets

Source: https://portal.thirdweb.com/ai/mcp

An example prompt for listing server wallets.

```shell
List my server wallets

```

--------------------------------

### Setup a GET route at /login

Source: https://portal.thirdweb.com/wallets/auth/frameworks/react-express

Set up a GET route at /login to fetch the login payload.

```javascript
app.get("/login", async (req, res) => {
  const address = req.query.address;
  const chainId = req.query.chainId;

  if (!address) {
    return res.status(400).send("Address is required");
  }

  return res.send(
    await thirdwebAuth.generatePayload({
      address,
      chainId: chainId ? parseInt(chainId) : undefined,
    }),
  );
});

```

--------------------------------

### Example ERC721A Contract

Source: https://portal.thirdweb.com/contracts/build/extensions/erc-721/ERC721

An example smart contract demonstrating inheritance from ERC721A and basic constructor setup.

```solidity
// SPDX-License-Identifier: MIT\npragma solidity ^0.8.0;\n\nimport "@thirdweb-dev/contracts/eip/ERC721A.sol";\n\ncontract Contract is ERC721A {\n    constructor(\n        string memory _name,\n        string memory _symbol\n    )\n        ERC721A(\n            _name,\n            _symbol\n        )\n    {}\n}
```

--------------------------------

### Install a new module

Source: https://portal.thirdweb.com/typescript/v5/modular/upgrade

Example of installing a new module, specifically RoyaltyERC721, with specified parameters.

```typescript
import { RoyaltyERC721 } from "thirdweb/modules";

const transaction = RoyaltyERC721.install({
  contract: coreContract,
  account,
  params: {
    royaltyRecipient: account.address,
    royaltyBps: 100n,
    transferValidator: ZERO_ADDRESS,
  },
});

```

--------------------------------

### Create Wallet Example

Source: https://portal.thirdweb.com/wallets/solana

Example of creating a new Solana wallet using the thirdweb API.

```bash
curl -X POST "https://api.thirdweb.com/v1/solana/wallets" \
  -H "Content-Type: application/json" \
  -H "x-secret-key: YOUR_SECRET_KEY" \
  -d '{"label": "treasury-wallet"}'

```

--------------------------------

### Response for Get Swap Quote

Source: https://portal.thirdweb.com/changelog/solana-token-swaps-via-api

Example response for the GET /v1/solana/swap endpoint.

```json
{
  "result": {
    "inputMint": "So11111111111111111111111111111111111111112",
    "outputMint": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
    "inputAmount": "100000000",
    "outputAmount": "15423156",
    "inputUsdValue": 15.45,
    "outputUsdValue": 15.42,
    "slippageBps": 34,
    "requestId": "019a5f00-fab2-747d-bba2-b77f993314a0"
  }
}
```

--------------------------------

### Create a new project

Source: https://portal.thirdweb.com/cli/create

Run this command to start creating a new project.

```bash
npx thirdweb create
```

--------------------------------

### Get transfer policies for a signer

Source: https://portal.thirdweb.com/dotnet/wallets/actions/gettransferpolicies7702

Example of how to get and examine transfer policies for a signer on an EIP-7702 account.

```csharp
var transferPolicies = await ecosystemWallet.GetTransferPoliciesForSigner(
    chainId: 1,
    signerAddress: "0x1234567890123456789012345678901234567890"
);
 
foreach (var policy in transferPolicies)
{
    string tokenType = policy.Target == "0x0000000000000000000000000000000000000000" 
        ? "ETH" 
        : $"Token {policy.Target}";
        
    Console.WriteLine($"Can transfer {tokenType}");
    Console.WriteLine($"Max per transfer: {policy.MaxValuePerUse}");
    Console.WriteLine($"Limit type: {policy.ValueLimit.LimitType}");
}
```

--------------------------------

### eth_maxPriorityFeePerGas Example

Source: https://portal.thirdweb.com/typescript/v5/eth_maxPriorityFeePerGas

Example of how to use the eth_maxPriorityFeePerGas function to get the maximum priority fee per gas.

```typescript
import { getRpcClient, eth_maxPriorityFeePerGas } from "thirdweb/rpc";
const rpcRequest = getRpcClient({ client, chain });
const maxPriorityFeePerGas = await eth_maxPriorityFeePerGas(rpcRequest);
```

--------------------------------

### RainbowKit Initialization

Source: https://portal.thirdweb.com/react/v5/rainbow-kit-migrate

Example of initializing RainbowKit.

```typescript
import "@rainbow-me/rainbowkit/styles.css";
import {
  getDefaultConfig,
  RainbowKitProvider,
} from "@rainbow-me/rainbowkit";
import { WagmiProvider } from "wagmi";
import {
  mainnet,
  polygon,
  optimism,
  arbitrum,
  base,
} from "wagmi/chains";
import {
  QueryClientProvider,
  QueryClient,
} from "@tanstack/react-query";
 
const config = getDefaultConfig({
  appName: "My RainbowKit App",
  projectId: "YOUR_PROJECT_ID",
  chains: [mainnet, polygon, optimism, arbitrum, base],
  ssr: true, // If your dApp uses server side rendering (SSR)
});
const queryClient = new QueryClient();
 
const App = () => {
  return (
    <WagmiProvider config={config}>
      <QueryClientProvider client={queryClient}>
        <RainbowKitProvider>{/* Your App */}</RainbowKitProvider>
      </QueryClientProvider>
    </WagmiProvider>
  );
};

```

--------------------------------

### Example ERC721A Smart Contract

Source: https://portal.thirdweb.com/tokens/build/extensions/erc-721/ERC721

An example smart contract demonstrating inheritance from the ERC721A extension and basic constructor setup.

```solidity
// SPDX-License-Identifier: MIT\npragma solidity ^0.8.0;\n\nimport "@thirdweb-dev/contracts/eip/ERC721A.sol";\n\ncontract Contract is ERC721A {\n    constructor(\n        string memory _name,\n        string memory _symbol\n    )\n        ERC721A(\n            _name,\n            _symbol\n        )\n    {}
}
```

--------------------------------

### getInstalledWallets

Source: https://portal.thirdweb.com/llms-full.txt

Get all currently installed wallets using EIP-6963.

```APIDOC
## getInstalledWallets

### Description
Get all currently installed wallets. Uses EIP-6963 to discover installed browser extension wallets.

### Signature
`function getInstalledWallets(): Array<Wallet>;`

### Returns
- **Array<Wallet>** - A list of installed wallets.
```

--------------------------------

### React App Setup

Source: https://portal.thirdweb.com/wallets/auth

Basic setup for the ThirdwebProvider in a React application.

```typescript
import { ThirdwebProvider } from "thirdweb/react";
 
export default function App() {
  return <ThirdwebProvider>{/* Your app here */}</ThirdwebProvider>;
}
```

--------------------------------

### Get Swap Quote

Source: https://portal.thirdweb.com/changelog/solana-token-swaps-via-api

Example of how to get a quote for swapping Solana tokens without executing the transaction.

```curl
curl -X GET "https://api.thirdweb.com/v1/solana/swap?address=YOUR_WALLET_ADDRESS&tokenIn=So11111111111111111111111111111111111111112&tokenOut=EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v&amount=100000000&chainId=solana:mainnet" \
  -H "x-secret-key: YOUR_SECRET_KEY"
```

--------------------------------

### Get session expiration for a signer

Source: https://portal.thirdweb.com/dotnet/wallets/actions/getsessionexpiration7702

Example of how to get the session expiration timestamp for a signer and convert it to a readable DateTime, then check its validity and remaining time.

```csharp
// Get session expiration for a signer
var expirationTimestamp = await ecosystemWallet.GetSessionExpirationForSigner(
    chainId: 1,
    signerAddress: "0x1234567890123456789012345678901234567890"
);
 
// Convert to DateTime for readability
var expirationDateTime = DateTimeOffset.FromUnixTimeSeconds((long)expirationTimestamp);
Console.WriteLine($"Session expires at: {expirationDateTime}");
 
// Check if session is still valid
var currentTime = DateTimeOffset.UtcNow.ToUnixTimeSeconds();
bool isValid = expirationTimestamp > currentTime;
Console.WriteLine($"Session is valid: {isValid}");
 
if (isValid)
{
    var timeRemaining = expirationDateTime - DateTimeOffset.UtcNow;
    Console.WriteLine($"Time remaining: {timeRemaining.TotalHours:F1} hours");
}
```

--------------------------------

### thirdweb Initialization

Source: https://portal.thirdweb.com/react/v5/rainbow-kit-migrate

Example of initializing thirdweb.

```typescript
import { ThirdwebProvider } from "thirdweb/react";
 
const App = () => {
  return <ThirdwebProvider>{/* Your App */}</ThirdwebProvider>;
};

```

--------------------------------

### Get the connected wallet information

Source: https://portal.thirdweb.com/react/v5/getting-started

Retrieve the connected wallet's address and balance using hooks like useActiveAccount and useWalletBalance.

```tsx
import { useActiveAccount, useWalletBalance } from "thirdweb/react";

export default function App() {
  const account = useActiveAccount();
  const { data: balance, isLoading } = useWalletBalance({
    client,
    chain,
    address: account.address,
  });

  return (
    <div>
      <p>Wallet address: {account.address}</p>
      <p>
        Wallet balance: {balance?.displayValue} {balance?.symbol}
      </p>
    </div>
  );
}

```

--------------------------------

### Install Forge and Modular Contracts

Source: https://portal.thirdweb.com/tokens/modular-contracts/get-started/create-core-contract

Install Forge from Foundry and add the modular contract framework.

```bash
forge init
forge install thirdweb-dev/modular-contracts --no-commit
```

--------------------------------

### Get Installed Wallets

Source: https://portal.thirdweb.com/llms-full.txt

Retrieves a list of browser extension wallets using EIP-6963.

```ts
function getInstalledWallets(): Array<Wallet>;
```

```ts
let returnType: Array<Wallet>;
```

--------------------------------

### Instantiate ThirdwebContract

Source: https://portal.thirdweb.com/unity/v6/contracts

Example of how to get a ThirdwebContract instance using the ThirdwebManager.

```csharp
var contract = await ThirdwebManager.Instance.GetContract(
	address: "contract-address", 
	chainId: 1, 
	abi: "optional-abi"
);

```

--------------------------------

### Example Usage

Source: https://portal.thirdweb.com/typescript/v5/buy/prepare

Prepares a quote for a buy request.

```typescript
import { Bridge, NATIVE_TOKEN_ADDRESS } from "thirdweb";

const quote = await Bridge.Buy.prepare({
  originChainId: 1,
  originTokenAddress: NATIVE_TOKEN_ADDRESS,
  destinationChainId: 10,
  destinationTokenAddress: NATIVE_TOKEN_ADDRESS,
  amount: toWei("0.01"),
  sender: "0x...",
  receiver: "0x...",
  client: thirdwebClient,
});
```

--------------------------------

### Example Usage

Source: https://portal.thirdweb.com/typescript/v5/eth_getTransactionCount

Demonstrates how to use the eth_getTransactionCount function to get the transaction count for an address.

```typescript
import { getRpcClient, eth_getTransactionCount } from "thirdweb/rpc";
const rpcRequest = getRpcClient({ client, chain });
const transactionCount = await eth_getTransactionCount(rpcRequest, {
  address: "0x...",
});
```

--------------------------------

### Create Server Wallet

Source: https://portal.thirdweb.com/llms-full.txt

Demonstrates how to initialize a new server wallet using the Engine SDK.

```ts
import { Engine } from "thirdweb";
 
const serverWallet = await Engine.createServerWallet({
  client,
  label: "My Server Wallet",
});
console.log(serverWallet.address);
console.log(serverWallet.smartAccountAddress);
```

```ts
function createServerWallet(
  params: CreateServerWalletArgs,
): Promise<{
  address: string;
  createdAt: string;
  label?: string;
  smartAccountAddress?: string;
}>;
```

--------------------------------

### Example Usage

Source: https://portal.thirdweb.com/typescript/v5/eth_blockNumber

Demonstrates how to use the eth_blockNumber function to get the current block number.

```typescript
import { getRpcClient, eth_blockNumber } from "thirdweb/rpc";
const rpcRequest = getRpcClient({ client, chain });
const blockNumber = await eth_blockNumber(rpcRequest);
```

--------------------------------

### Example prompt: List contracts

Source: https://portal.thirdweb.com/ai/mcp

An example prompt for listing contracts.

```shell
List my contracts

```

--------------------------------

### Create a new project with the thirdweb CLI

Source: https://portal.thirdweb.com/react/v5

Quickly create a new project using the thirdweb CLI.

```bash
npx thirdweb create app
```

--------------------------------

### Customize metro.config.js

Source: https://portal.thirdweb.com/react-native/v5/getting-started

Command to create or customize the metro.config.js file.

```bash
npx expo customize metro.config.js
```

--------------------------------

### Install thirdweb v4 SDKs

Source: https://portal.thirdweb.com/react/v5/migrate/installation

Installation command for the thirdweb v4 SDKs.

```bash
npm i @thirdweb-dev/sdk @thirdweb-dev/react ethers@5.7.2
```

--------------------------------

### Get User Auth Details

Source: https://portal.thirdweb.com/dotnet/wallets/actions/getuserauthdetails

Example of how to call the GetUserAuthDetails method on the ecosystemWallet object.

```csharp
var result = ecosystemWallet.GetUserAuthDetails();
```

--------------------------------

### Install thirdweb v5 SDK

Source: https://portal.thirdweb.com/react/v5/migrate/installation

Installation command for the latest thirdweb v5 SDK.

```bash
npm i thirdweb
```

--------------------------------

### DefaultEngine.ini Configuration

Source: https://portal.thirdweb.com/unreal-engine/getting-started

Configuration settings for the Thirdweb plugin in the DefaultEngine.ini file.

```ini
[/Script/Thirdweb.ThirdwebRuntimeSettings]
ClientID=
BundleID=
```

--------------------------------

### Default ConnectEmbed Setup

Source: https://portal.thirdweb.com/llms-full.txt

Initialize the thirdweb client and render the ConnectEmbed component.

```tsx
import { createThirdwebClient } from "thirdweb";
import { ConnectEmbed } from "thirdweb/react";
 
const client = createThirdwebClient({ clientId: "YOUR_CLIENT_ID" });
 
<ConnectEmbed client={client} />;
```

--------------------------------

### Example operation

Source: https://portal.thirdweb.com/dotnet/api/quickstart

Contract metadata is the canonical example for low-level reads. The same pattern applies to other namespaces like `/v1/wallets/*`, `/v1/payments/*`, or `/ai/chat`—swap the method call but keep your authenticated client.

```csharp
// using Newtonsoft.Json;

var metadata = await client.Api.GetContractMetadataAsync(
	chainId: 1,
	address: "0xBd3531dA5CF5857e7CfAA92426877b022e612cf8"
);

Console.WriteLine($"ABI: {JsonConvert.SerializeObject(metadata.Result.Output.Abi, Formatting.Indented)}");
Console.WriteLine($"Compiler version: {metadata.Result.Compiler.Version}");

```

--------------------------------

### smartWallet(createOptions)

Source: https://portal.thirdweb.com/llms-full.txt

Initializes a smart wallet configuration with the specified options, including chain, gas sponsorship, and factory settings.

```APIDOC
## smartWallet(createOptions)

### Description
Creates a configuration for an ERC4337 smart wallet. This function returns a wallet instance that can be connected using an admin account.

### Signature
`function smartWallet(createOptions: SmartWalletOptions): Wallet<"smart">;`

### Parameters
- **createOptions** (SmartWalletOptions) - Required - Configuration object including chain, sponsorGas, factoryAddress, and optional overrides.
```

--------------------------------

### With Read Only

Source: https://portal.thirdweb.com/react/v5/extensions/use

This example demonstrates how to use the `use` hook to get a read-only contract instance.

```typescript
import { use } from "@thirdweb-dev/react";

function MyComponent() {
  const contract = use("0x1234567890abcdef1234567890abcdef12345678", null, true);

  const handleClick = async () => {
    if (contract) {
      const name = await contract.name();
      console.log(name);
    }
  };

  return (
    <button onClick={handleClick}>
      Get Contract Name
    </button>
  );
}
```

--------------------------------

### Create a new project with options

Source: https://portal.thirdweb.com/cli/create

You can also specify options to customize the project creation process.

```bash
npx thirdweb create [options] [projectPath]
```

--------------------------------

### Explanation of peer dependencies

Source: https://portal.thirdweb.com/react-native/v5/getting-started

Details the purpose of each peer dependency required by the SDK.

```javascript
// needed for wallet connect
react-native-get-random-values
@react-native-community/netinfo
expo-application

// needed wallet connect + in-app wallet
@react-native-async-storage/async-storage

// needed for inapp wallet
expo-web-browser // for oauth flows
amazon-cognito-identity-js // for authentication
react-native-aes-gcm-crypto // for encryption
react-native-quick-crypto@0.7.0-rc.6 // for fast hashing

// needed for coinbase wallet
@coinbase/wallet-mobile-sdk
react-native-mmkv

// needed for UI components
react-native-svg
```

--------------------------------

### Execute transactions with useSendTransaction

Source: https://portal.thirdweb.com/react/v5/getting-started

Send transactions by preparing them with prepareContractCall and executing them with useSendTransaction.

```tsx
import { client } from "./client";
import { getContract } from "thirdweb";
import { sepolia } from "thirdweb/chains";
import { useSendTransaction } from "thirdweb/react";

const contract = getContract({
  client,
  address: "0x...",
  chain: sepolia,
});

export default function App() {
  const { mutate: sendTransaction } = useSendTransaction();

  const onClick = async () => {
    const transaction = prepareContractCall({
      contract,
      method: "function mint(address to)",
      params: ["0x..."], // type safe params
    });
    sendTransaction(transaction);
  };

  return (
    <div>
      <button onClick={onClick}>Mint</button>
    </div>
  );
}

```

--------------------------------

### ThirdwebProvider v5 Setup

Source: https://portal.thirdweb.com/react/v5/migrate/installation

Basic setup for the ThirdwebProvider in v5.

```jsx
import { ThirdwebProvider } from "thirdweb/react";

<ThirdwebProvider>...</ThirdwebProvider>;
```

--------------------------------

### Account Initialization Example

Source: https://portal.thirdweb.com/contracts/build/base-contracts/erc-4337/account-factory

Example of how to initialize an account contract with additional data.

```solidity
function initializeAccount(
    address _admin,
    bytes calldata _data
) public override initializer {
    Account.initialize(_admin, _data);
}
```

--------------------------------

### ConnectButton Default Setup

Source: https://portal.thirdweb.com/llms-full.txt

Initializes the ConnectButton with a thirdweb client instance.

```tsx
import { createThirdwebClient } from "thirdweb";
import { ConnectButton } from "thirdweb/react";
 
const client = createThirdwebClient({ clientId: "YOUR_CLIENT_ID" });
 
<ConnectButton client={client} />;
```

--------------------------------

### Example Usage

Source: https://portal.thirdweb.com/typescript/v5/deploy/prepareDirectDeployTransaction

Prepares a direct deploy transaction with ABI.

```typescript
import { prepareDirectDeployTransaction } from "thirdweb/deploys";
import { ethereum } from "thirdweb/chains";
const tx = prepareDirectDeployTransaction({
  client,
  chain: ethereum,
  bytecode: "0x...",
  constructorAbi: {
    inputs: [{ type: "uint256", name: "value" }],
    type: "constructor",
  },
  constructorParams: [123],
});
```

--------------------------------

### Example Usage

Source: https://portal.thirdweb.com/typescript/v5/eth_gasPrice

Demonstrates how to import and use the `eth_gasPrice` function to get the current gas price.

```typescript
import { getRpcClient, eth_gasPrice } from "thirdweb/rpc";
const rpcRequest = getRpcClient({ client, chain });
const gasPrice = await eth_gasPrice(rpcRequest);
```

--------------------------------

### Interact with Smart Contracts

Source: https://portal.thirdweb.com/dotnet/getting-started

Reads data from a smart contract using the initialized Thirdweb client.

```csharp
var contract = await ThirdwebContract.Create(client: client, address: "contractAddress", chain: chainId);
var readResult = await contract.Read<string>(contract, "methodName");
Console.WriteLine($"Contract read result: {readResult}");
```
Tokens:
Raw