Installation

The TIX Protocol TypeScript SDK provides a complete interface for interacting with the on-chain program.

Installation

npm

npm install @tixprotocol/sdk

yarn

yarn add @tixprotocol/sdk

Dependencies

The SDK requires the following peer dependencies:

{
  "@solana/web3.js": "^1.87.0",
  "@solana/spl-token": "^0.3.0"
}

Install them if not already in your project:

npm install @solana/web3.js @solana/spl-token

Basic Setup

import { Connection, Keypair, PublicKey } from "@solana/web3.js";
import {
  // Address derivation
  protocolConfigPda,
  integratorPda,
  eventPda,
  permitPagePda,
  listingPda,

  // Instruction builders
  registerEvent,
  issuePermit,
  issuePermits,
  transferPermit,
  listTicket,
  acceptOffer,
  cancelListing,
  markUsed,
  markVoid,

  // Account fetchers
  getProtocolConfig,
  getIntegrator,
  getEvent,
  getPermit,
  getListing,
} from "@tixprotocol/sdk";

// Connect to Solana
const connection = new Connection("https://api.devnet.solana.com", "confirmed");

// Load your integrator keypair
const integratorAuthority = Keypair.fromSecretKey(/* your secret key */);

Configuration

Program ID

The SDK uses a constant PROGRAM_ID. Ensure it matches the deployed program:

import { PROGRAM_ID } from "@tixprotocol/sdk";

console.log(`Program ID: ${PROGRAM_ID.toBase58()}`);

USDC Mint

Configure the USDC mint for your network:

// Devnet USDC (example)
const USDC_MINT_DEVNET = new PublicKey(
  "Gh9ZwEmdLJ8DscKNTkTqPbNwLNNBjuSzaG9Vp2KGtKJr"
);

// Mainnet USDC
const USDC_MINT_MAINNET = new PublicKey(
  "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v"
);

Quick Start Example

import { Connection, Keypair } from "@solana/web3.js";
import { registerEvent, issuePermits, getEvent } from "@tixprotocol/sdk";

async function quickStart() {
  const connection = new Connection("https://api.devnet.solana.com");

  // Load your integrator keypair (provided during onboarding)
  const integrator = Keypair.fromSecretKey(/* your secret key */);

  // 1. Create event
  const { tx: eventTx, event } = await registerEvent({
    connection,
    payer: integrator.publicKey,
    integratorIdentity: integrator.publicKey,
    integratorAuthority: integrator.publicKey,
    eventId: 1n,
    totalSupply: 1000n,
    royaltyBps: 500,
    minRoyaltyFloor: 100_000n,
    royaltyRecipients: [],
  });
  eventTx.sign([integrator]);
  await connection.sendTransaction(eventTx);

  // 2. Issue tickets
  const buyers = [buyer1.publicKey, buyer2.publicKey];
  const issueTx = await issuePermits({
    connection,
    payer: integrator.publicKey,
    integratorIdentity: integrator.publicKey,
    integratorAuthority: integrator.publicKey,
    eventId: 1n,
    buyers,
  });
  issueTx.sign([integrator]);
  await connection.sendTransaction(issueTx);

  // 3. Check event state
  const eventState = await getEvent(connection, event);
  console.log(`Minted: ${eventState.minted}/${eventState.totalSupply}`);
}

Error Handling

import { AnchorError } from "@coral-xyz/anchor";

try {
  const tx = await issuePermits({
    /* ... */
  });
  tx.sign([signer]);
  await connection.sendTransaction(tx);
} catch (error) {
  if (error instanceof AnchorError) {
    console.error(`Anchor error: ${error.error.errorCode.code}`);
    console.error(`Message: ${error.error.errorMessage}`);
  } else {
    console.error("Transaction failed:", error);
  }
}

Next Steps

• Address Derivation — PDA helper functions

• Instruction Builders — All available instructions

• Account Fetchers — Reading on-chain state

• Code Examples — Complete examples