Split

Learn how to interact with your Split contract in the SDK.

Create a Split Contract

Deploys a new Split contract

React

const sdk = useSDK();

const contractAddress = await sdk.deployer.deploySplit({
  name: "My Split",
  primary_sale_recipient: "your-address",
  recipients: [
   {
     address: "your-address",
     sharesBps: 80 * 100, // 80%
   },
   {
     address: "another-address",
     sharesBps: 20 * 100, // 20%
   },
  ],
});

View in React SDK Documentation

Javascript

const contractAddress = await sdk.deployer.deploySplit({
  name: "My Split",
  primary_sale_recipient: "your-address",
  recipients: [
   {
     address: "your-address",
     sharesBps: 80 * 100, // 80%
   },
   {
     address: "another-address",
     sharesBps: 20 * 100, // 20%
   },
  ],
});

View in Javascript SDK Documentation

Python

This feature is missing a code snippet or might not be supported yet.
Check the Python SDK Reference for more information.
Reach out on Discord for further assistance!

Go

This feature is missing a code snippet or might not be supported yet.
Check the Go SDK Reference for more information.
Reach out on Discord for further assistance!

Unity

This feature is missing a code snippet or might not be supported yet.
Check the Unity SDK Reference for more information.
Reach out on Discord for further assistance!

---

Getting the contract in your application

To start using your Split contract inside your application, you'll need to use its contract address. You can get the contract address from the dashboard.

React

This feature is missing a code snippet or might not be supported yet.
Check the React SDK Reference for more information.
Reach out on Discord for further assistance!

Javascript

import { ThirdwebSDK } from "@thirdweb-dev/sdk";

const sdk = new ThirdwebSDK("{{chainName}}");
const contract = await sdk.getContract("{{contract_address}}", "split");

Python

This feature is missing a code snippet or might not be supported yet.
Check the Python SDK Reference for more information.
Reach out on Discord for further assistance!

Go

This feature is missing a code snippet or might not be supported yet.
Check the Go SDK Reference for more information.
Reach out on Discord for further assistance!

Unity

// Split is not yet supported in Unity. Reach out to us on Discord if you need this feature! Split contract = sdk.GetContract("{{contract_address}}").split

---

View Recipients

Get Recipients of this splits contract

React

const recipients = await contract.getAllRecipients();
console.log(recipients);

View in React SDK Documentation

Javascript

const recipients = await contract.getAllRecipients();
console.log(recipients);

View in Javascript SDK Documentation

Python

This feature is missing a code snippet or might not be supported yet.
Check the Python SDK Reference for more information.
Reach out on Discord for further assistance!

Go

This feature is missing a code snippet or might not be supported yet.
Check the Go SDK Reference for more information.
Reach out on Discord for further assistance!

Unity

// Split is not yet supported in Unity. You can still use the contrat.Read and contract.Write functions to call functions directly.

---

View Balance

Native Token Balance

Use this if you have been tokens native to the network (e.g., Ether on the Ethereum network).

Get Funds owed to a particular wallet

React

// The address to check the funds of
const address = "{{wallet_address}}";
const funds = await contract.balanceOf(address);
console.log(funds);

View in React SDK Documentation

Javascript

// The address to check the funds of
const address = "{{wallet_address}}";
const funds = await contract.balanceOf(address);
console.log(funds);

View in Javascript SDK Documentation

Python

This feature is missing a code snippet or might not be supported yet.
Check the Python SDK Reference for more information.
Reach out on Discord for further assistance!

Go

This feature is missing a code snippet or might not be supported yet.
Check the Go SDK Reference for more information.
Reach out on Discord for further assistance!

Unity

// Split is not yet supported in Unity. You can still use the contrat.Read and contract.Write functions to call functions directly.

---

Non-Native Token Balance

Use this if you have been sent custom tokens to the address.

Get non-native Token Funds owed to a particular wallet

React

// The address to check the funds of
const address = "{{wallet_address}}";
// The address of the currency to check the contracts funds of
const tokenAddress = "0x..."
const funds = await contract.balanceOfToken(address, tokenAddress);
console.log(funds);

View in React SDK Documentation

Javascript

// The address to check the funds of
const address = "{{wallet_address}}";
// The address of the currency to check the contracts funds of
const tokenAddress = "0x..."
const funds = await contract.balanceOfToken(address, tokenAddress);
console.log(funds);

View in Javascript SDK Documentation

Python

This feature is missing a code snippet or might not be supported yet.
Check the Python SDK Reference for more information.
Reach out on Discord for further assistance!

Go

This feature is missing a code snippet or might not be supported yet.
Check the Go SDK Reference for more information.
Reach out on Discord for further assistance!

Unity

// Split is not yet supported in Unity. You can still use the contrat.Read and contract.Write functions to call functions directly.

---

Distribute funds

This distributes funds held by the contract to all recipients.

Native Token

React

await contract.distribute();

View in React SDK Documentation

Javascript

await contract.distribute();

View in Javascript SDK Documentation

Python

This feature is missing a code snippet or might not be supported yet.
Check the Python SDK Reference for more information.
Reach out on Discord for further assistance!

Go

This feature is missing a code snippet or might not be supported yet.
Check the Go SDK Reference for more information.
Reach out on Discord for further assistance!

Unity

// Split is not yet supported in Unity. You can still use the contrat.Read and contract.Write functions to call functions directly.

---

Non-Native Token

React

// The address of the currency to distribute funds
const tokenAddress = "0x..."
await contract.distributeToken(tokenAddress);

View in React SDK Documentation

Javascript

// The address of the currency to distribute funds
const tokenAddress = "0x..."
await contract.distributeToken(tokenAddress);

View in Javascript SDK Documentation

Python

This feature is missing a code snippet or might not be supported yet.
Check the Python SDK Reference for more information.
Reach out on Discord for further assistance!

Go

This feature is missing a code snippet or might not be supported yet.
Check the Go SDK Reference for more information.
Reach out on Discord for further assistance!

Unity

// Split is not yet supported in Unity. You can still use the contrat.Read and contract.Write functions to call functions directly.

---

Withdraw Funds

React

// the wallet address that wants to withdraw their funds
const walletAddress = "{{wallet_address}}"
await contract.withdraw(walletAddress);

View in React SDK Documentation

Javascript

// the wallet address that wants to withdraw their funds
const walletAddress = "{{wallet_address}}"
await contract.withdraw(walletAddress);

View in Javascript SDK Documentation

Python

This feature is missing a code snippet or might not be supported yet.
Check the Python SDK Reference for more information.
Reach out on Discord for further assistance!

Go

This feature is missing a code snippet or might not be supported yet.
Check the Go SDK Reference for more information.
Reach out on Discord for further assistance!

Unity

// Split is not yet supported in Unity. You can still use the contrat.Read and contract.Write functions to call functions directly.