API Client

1import {
2  createAndRegisterLaunch,
3  CreateLaunchInput,
4  genesis,
5} from '@metaplex-foundation/genesis'
6import { createUmi } from '@metaplex-foundation/umi-bundle-defaults'
7import { keypairIdentity } from '@metaplex-foundation/umi'
8
9const umi = createUmi('https://api.mainnet-beta.solana.com')
10  .use(genesis())
11
12// Use keypairIdentity to set a wallet when running server-side:
13// umi.use(keypairIdentity(myKeypair))
14
15const input: CreateLaunchInput = {
16  wallet: umi.identity.publicKey,
17  token: {
18    name: 'My Token',
19    symbol: 'MTK',
20    image: 'https://gateway.irys.xyz/...',
21  },
22  launchType: 'launchpool',
23  launch: {
24    launchpool: {
25      tokenAllocation: 500_000_000,
26      depositStartTime: new Date(Date.now() + 48 * 60 * 60 * 1000),
27      raiseGoal: 250,
28      raydiumLiquidityBps: 5000,
29      fundsRecipient: umi.identity.publicKey,
30    },
31  },
32}
33
34const result = await createAndRegisterLaunch(umi, {}, input)
35console.log(`Launch live at: ${result.launch.link}`)

1import {
2  createAndRegisterLaunch,
3  SignAndSendOptions,
4} from '@metaplex-foundation/genesis'
5
6// Assumes umi and input from the Easy Mode example.
7
8const options: SignAndSendOptions = {
9  txSender: async (transactions) => {
10    // Replace myCustomSign / myCustomSend with your own
11    // signing and sending implementation.
12    const signatures: Uint8Array[] = []
13    for (const tx of transactions) {
14      const signed = await myCustomSign(tx)   // your signer
15      const sig = await myCustomSend(signed)   // your sender
16      signatures.push(sig)
17    }
18    return signatures
19  },
20}
21
22const result = await createAndRegisterLaunch(umi, {}, input, options)
23console.log(`Launch live at: ${result.launch.link}`)

1import {
2  createLaunch,
3  registerLaunch,
4} from '@metaplex-foundation/genesis'
5
6// Assumes umi and input from the Easy Mode example.
7
8// Step 1: Get unsigned transactions from the API
9const createResult = await createLaunch(umi, {}, input)
10
11// Step 2: Sign and send each transaction
12for (const tx of createResult.transactions) {
13  const signedTx = await umi.identity.signTransaction(tx)
14  const signature = await umi.rpc.sendTransaction(signedTx, {
15    commitment: 'confirmed',
16    preflightCommitment: 'confirmed',
17  })
18  await umi.rpc.confirmTransaction(signature, {
19    commitment: 'confirmed',
20    strategy: {
21      type: 'blockhash',
22      ...createResult.blockhash,
23    },
24  })
25}
26
27// Step 3: Register the launch
28const registerResult = await registerLaunch(umi, {}, {
29  genesisAccount: createResult.genesisAccount,
30  createLaunchInput: input,
31})
32console.log(`Launch live at: ${registerResult.launch.link}`)

1import { claimCreatorRewards } from '@metaplex-foundation/genesis'
2import { base58 } from '@metaplex-foundation/umi/serializers'
3import { createUmi } from '@metaplex-foundation/umi-bundle-defaults'
4import { keypairIdentity } from '@metaplex-foundation/umi'
5
6const umi = createUmi('https://api.mainnet-beta.solana.com')
7const keypair = umi.eddsa.createKeypairFromSecretKey(mySecretKeyBytes)
8umi.use(keypairIdentity(keypair))
9
10const result = await claimCreatorRewards(umi, {}, {
11  wallet: umi.identity.publicKey,
12  network: 'solana-mainnet',
13  // payer is optional — defaults to `wallet` on the server.
14  // Set it to have a different wallet cover rent and transaction fees.
15  // payer: umi.identity.publicKey,
16})
17
18for (const tx of result.transactions) {
19  const signed = await umi.identity.signTransaction(tx)
20  const signature = await umi.rpc.sendTransaction(signed, {
21    preflightCommitment: 'confirmed',
22  })
23  await umi.rpc.confirmTransaction(signature, {
24    strategy: { type: 'blockhash', ...result.blockhash },
25    commitment: 'confirmed',
26  })
27  console.log('Claimed:', base58.deserialize(signature)[0])
28}
29
30// Claimed: 5uGGYEMmjP2HpyFCvLPNpVDSQEBtUE3LR6ZQFqhJxQSh5FbKacSyN8nQmAJowuFs6BTCdwzoFyyJz8Y2hQx8kPxo
31// Claimed: 3TAroVovEap1ZEAJYq3WiDZoMK3GU3soCdrhvZJNg6b9EANqvWrVcDGNffm7mD8wvtpR7ynWQBcbrmz8AK6nrhfy

1import {
2  claimCreatorRewards,
3  isGenesisApiError,
4  isGenesisApiNetworkError,
5} from '@metaplex-foundation/genesis'
6
7// Assumes umi is configured with a keypair identity.
8
9try {
10  const result = await claimCreatorRewards(umi, {}, {
11    wallet: umi.identity.publicKey,
12    network: 'solana-mainnet',
13  })
14  console.log(`Claimable transactions: ${result.transactions.length}`)
15} catch (err) {
16  if (isGenesisApiError(err)) {
17    // The API returns HTTP 400 with
18    //   { "error": { "message": "No rewards available to claim" } }
19    // when the wallet has no unclaimed creator rewards. Match on the message
20    // (or statusCode === 400) to handle this as a success case rather than a
21    // failure.
22    if (err.message === 'No rewards available to claim') {
23      console.log('Nothing to claim right now.')
24    } else {
25      console.error('API error:', err.statusCode, err.message)
26    }
27  } else if (isGenesisApiNetworkError(err)) {
28    console.error('Network error:', err.cause.message)
29  } else {
30    throw err
31  }
32}
33
34// Nothing to claim right now.

1import {
2  createAndRegisterLaunch,
3  CreateLaunchInput,
4  genesis,
5} from '@metaplex-foundation/genesis'
6import { createUmi } from '@metaplex-foundation/umi-bundle-defaults'
7import { keypairIdentity } from '@metaplex-foundation/umi'
8
9const umi = createUmi('https://api.mainnet-beta.solana.com')
10  .use(genesis())
11
12// Use keypairIdentity to set a wallet when running server-side:
13// umi.use(keypairIdentity(myKeypair))
14
15const input: CreateLaunchInput = {
16  wallet: umi.identity.publicKey,
17  token: {
18    name: 'My Token',
19    symbol: 'MTK',
20    image: 'https://gateway.irys.xyz/...',
21    description: 'A project token with locked allocations.',
22    externalLinks: {
23      website: 'https://example.com',
24      twitter: '@mytoken',
25    },
26  },
27  launchType: 'launchpool',
28  launch: {
29    launchpool: {
30      tokenAllocation: 500_000_000,
31      depositStartTime: new Date('2026-04-01T00:00:00Z'),
32      raiseGoal: 250,
33      raydiumLiquidityBps: 5000,
34      fundsRecipient: 'FundsRecipientWallet...',
35    },
36    lockedAllocations: [
37      {
38        name: 'Team',
39        recipient: 'TeamWallet...',
40        tokenAmount: 100_000_000,
41        vestingStartTime: new Date('2026-04-05T00:00:00Z'),
42        vestingDuration: { value: 1, unit: 'YEAR' },
43        unlockSchedule: 'MONTH',
44        cliff: {
45          duration: { value: 3, unit: 'MONTH' },
46          unlockAmount: 10_000_000,
47        },
48      },
49    ],
50  },
51}
52
53const result = await createAndRegisterLaunch(umi, {}, input)
54console.log(`Launch live at: ${result.launch.link}`)

1import {
2  createAndRegisterLaunch,
3  isGenesisApiError,
4  isGenesisApiNetworkError,
5  isGenesisValidationError,
6} from '@metaplex-foundation/genesis'
7
8// Assumes umi and input from the Easy Mode example.
9
10try {
11  const result = await createAndRegisterLaunch(umi, {}, input)
12  console.log(`Launch live at: ${result.launch.link}`)
13} catch (err) {
14  if (isGenesisValidationError(err)) {
15    console.error(`Invalid input "${err.field}":`, err.message)
16  } else if (isGenesisApiError(err)) {
17    console.error('API error:', err.statusCode, err.responseBody)
18  } else if (isGenesisApiNetworkError(err)) {
19    console.error('Network error:', err.cause.message)
20  } else {
21    throw err
22  }
23}