Splits Code Examples

Easy copy and paste snippets to use thirdweb Splits module

Copy codeconst app = sdk.getAppModule("<APP_MODULE_ADDRESS>");

const deploySplitModule = async () => {
  try {
    const splitsModule = await app.deploySplitsModule({
      name: "Splits",
      description: "Splits Module",
    
      // Array of recipients and the shares we want to split with
      // the total number of shares = 5
      // therefore `<RECIPIENT_ADDRESS_1>` will recieve 20% of the royalties
      // and `<RECIPIENT_ADDRESS_2>` will recieve 80% of the royalties
      recipientSplits: [
        {
          address: "<RECIPIENT_ADDRESS_1>",
          shares: 1,
        },
        {
          address: "<RECIPIENT_ADDRESS_2>",
          shares: 4,
        },
      ],
    });
    
    // In order to use a splits module, you must set it as the 
    // recipient when deploying a module
    await app.deployNftModule({
      name: "My NFT",
      symbol: "NFT",
      sellerFeeBasisPoints: 0,
      // use the address of the splits module as the recipient.
      feeRecipient: splitsModule.address,
    });
  } catch (err) {
    console.log(err);
  }
}

deploySplitModule()
// `feeRecipient` will be the address of the Splits module

Note: Minimum version needed from the sdk is @3rdweb/sdk@1.39.0

Copy codeconst deployRoyaltySplitsModule = async () => {
  try {
    await app.deployRoyaltySplitsModule({
      name: "Royalty Split",
      description: "Royalty Splits Module",

      // Array of recipients and the shares we want to split with
      // the total number of shares = 5
      // therefore `<RECIPIENT_ADDRESS_1>` will recieve 20% of the royalties
      // and `<RECIPIENT_ADDRESS_2>` will recieve 80% of the royalties
      recipientSplits: [
        {
          address: "<RECIPIENT_ADDRESS_1>",
          shares: 1,
        },
        {
          address: "<RECIPIENT_ADDRESS_2>",
          shares: 4,
        },
      ],
    });
  } catch (error) {
    console.log(error);
  }
};

deployRoyaltySplitsModule();

Replace <APP_MODULE_ADDRESS> with the address of the app under the NFT Collection module was created.

Replace <ROYALTY_SPLITS_ADDRESS> with the new recipient address, it needs to be a Royalty Splits module module.

Copy codeconst changeRecipient = async () => {
  // Updating the fee recipient requires the use of the app module
  // that the target module is deployed in
  const appModule = sdk.getAppModule("<APP_MODULE_ADDRESS>");
  await appModule.setModuleRoyaltyTreasury("<MODULE_ADDRESS>", "<ROYALTY_SPLITS_ADDRESS>");
}

changeRecipient()

Copy codeconst withdraw = async (walletAddress) => {
  try {
    await splits.withdraw(walletAddress);
  } catch (error) {
    console.log('Failed to withdraw. Error: ', error);
  }
};

withdraw('<WALLET_ADDRESS>');

Copy codeconst getRecipientSplitPercentages = async (walletAddress) => {
  try {
    await splits.getRecipientSplitPercentage(walletAddress);
  } catch (error) {
    console.log('Failed to get split percentages. Error: ', error);
  }
};

getRecipientSplitPercentages('<WALLET_ADDRESS>');

Copy codeconst getAllRecipients = async () => {
  try {
    await splits.getAllRecipients();
  } catch (error) {
    console.log('Failed to get all recipients. Error: ', error);
  }
};

getAllRecipients();

Copy codeconst get = async () => {
  try {
    await splits.get();
  } catch (error) {
    console.log('Failed to get. Error: ', error);
  }
};

get();

Copy codeconst distribute = async () => {
  try {
    await splits.distribute();
  } catch (error) {
    console.log('Failed to distribute. Error: ', error);
  }
};

distribute();

Copy codeconst getBalanceOfTokenForAllRecipients = async (tokenAddress) => {
  try {
    await splits.balanceOfTokenAllRecipients(tokenAddress);
  } catch (error) {
    console.log(
      'Failed to get balances of a token for all recipients: ',
      error
    );
  }
};

getBalanceOfTokenForAllRecipients('<TOKEN_ADDRESS>');

Copy codeconst getBalanceOfToken = async (walletAddress, tokenAddress) => {
  try {
    await splits.balanceOfToken(walletAddress, tokenAddress);
  } catch (error) {
    console.log('Failed to get balance of token for wallet. Error: ', error);
  }
};

getBalanceOfToken('<WALLET_ADDRESS>', '<TOKEN_ADDRESS>');

Copy codeconst getBalanceOfAllRecipients = async () => {
  try {
    await splits.balanceOfAllRecipients();
  } catch (error) {
    console.log('Failed to get balance of all recipients: ', error);
  }
};

getBalanceOfAllRecipients();

Copy codeconst getBalanceOf = async (walletAddress) => {
  try {
    await splits.balanceOf(walletAddress);
  } catch (error) {
    console.log('Failed to get get balance of address. Error: ', error);
  }
};

getBalanceOf('<WALLET_ADDRESS');