/** * This code was AUTOGENERATED using the Codama library. * Please DO NOT EDIT THIS FILE, instead use visitors * to add features, then rerun Codama to update it. * * @see https://github.com/codama-idl/codama */ import { AccountRole, combineCodec, fixDecoderSize, fixEncoderSize, getAddressEncoder, getArrayDecoder, getArrayEncoder, getBytesDecoder, getBytesEncoder, getProgramDerivedAddress, getStructDecoder, getStructEncoder, getU32Decoder, getU32Encoder, SOLANA_ERROR__PROGRAM_CLIENTS__INSUFFICIENT_ACCOUNT_METAS, SolanaError, transformEncoder, type AccountMeta, type AccountSignerMeta, type Address, type FixedSizeCodec, type FixedSizeDecoder, type FixedSizeEncoder, type Instruction, type InstructionWithAccounts, type InstructionWithData, type ReadonlyAccount, type ReadonlyUint8Array, type TransactionSigner, type WritableAccount, type WritableSignerAccount, } from '@solana/kit'; import { getAccountMetaFactory, getAddressFromResolvedInstructionAccount, type ResolvedInstructionAccount, } from '@solana/program-client-core'; import { SAGE_PROGRAM_ADDRESS } from '../programs'; export const PAY_CLAIM_STAKES_RENT_DISCRIMINATOR = new Uint8Array([ 217, 164, 25, 0, 178, 26, 253, 237, ]); export function getPayClaimStakesRentDiscriminatorBytes() { return fixEncoderSize(getBytesEncoder(), 8).encode( PAY_CLAIM_STAKES_RENT_DISCRIMINATOR, ); } export type PayClaimStakesRentInstruction< TProgram extends string = typeof SAGE_PROGRAM_ADDRESS, TAccountFunder extends string | AccountMeta = string, TAccountProfile extends string | AccountMeta = string, TAccountClaimStakeInstance extends string | AccountMeta = string, TAccountCelestialBody extends string | AccountMeta = string, TAccountSystemAndStarbasePlayerSystem extends string | AccountMeta = string, TAccountSystemAndStarbasePlayerStarbasePlayer extends | string | AccountMeta = string, TAccountCurrencyCache extends string | AccountMeta = string, TAccountGame extends string | AccountMeta = string, TAccountXpAccrual extends string | AccountMeta = string, TAccountRentCatalog extends string | AccountMeta = string, TAccountRentAuthority extends string | AccountMeta = string, TAccountRentGridHead extends string | AccountMeta = string, TAccountRentLevelHead extends string | AccountMeta = string, TAccountRentDefHead extends string | AccountMeta = string, TRemainingAccounts extends readonly AccountMeta[] = [], > = Instruction & InstructionWithData & InstructionWithAccounts< [ TAccountFunder extends string ? WritableSignerAccount & AccountSignerMeta : TAccountFunder, TAccountProfile extends string ? ReadonlyAccount : TAccountProfile, TAccountClaimStakeInstance extends string ? WritableAccount : TAccountClaimStakeInstance, TAccountCelestialBody extends string ? WritableAccount : TAccountCelestialBody, TAccountSystemAndStarbasePlayerSystem extends string ? ReadonlyAccount : TAccountSystemAndStarbasePlayerSystem, TAccountSystemAndStarbasePlayerStarbasePlayer extends string ? ReadonlyAccount : TAccountSystemAndStarbasePlayerStarbasePlayer, TAccountCurrencyCache extends string ? WritableAccount : TAccountCurrencyCache, TAccountGame extends string ? ReadonlyAccount : TAccountGame, TAccountXpAccrual extends string ? WritableAccount : TAccountXpAccrual, TAccountRentCatalog extends string ? ReadonlyAccount : TAccountRentCatalog, TAccountRentAuthority extends string ? WritableAccount : TAccountRentAuthority, TAccountRentGridHead extends string ? ReadonlyAccount : TAccountRentGridHead, TAccountRentLevelHead extends string ? ReadonlyAccount : TAccountRentLevelHead, TAccountRentDefHead extends string ? ReadonlyAccount : TAccountRentDefHead, ...TRemainingAccounts, ] >; export type PayClaimStakesRentInstructionData = { discriminator: ReadonlyUint8Array; /** * Rent Option B: the GRID / LEVEL / DEF baseline-record indices at `max(paid_clock, activation_time)` * (read only under an Active catalog). */ rentHints: Array; }; export type PayClaimStakesRentInstructionDataArgs = { /** * Rent Option B: the GRID / LEVEL / DEF baseline-record indices at `max(paid_clock, activation_time)` * (read only under an Active catalog). */ rentHints: Array; }; export function getPayClaimStakesRentInstructionDataEncoder(): FixedSizeEncoder { return transformEncoder( getStructEncoder([ ['discriminator', fixEncoderSize(getBytesEncoder(), 8)], ['rentHints', getArrayEncoder(getU32Encoder(), { size: 3 })], ]), (value) => ({ ...value, discriminator: PAY_CLAIM_STAKES_RENT_DISCRIMINATOR, }), ); } export function getPayClaimStakesRentInstructionDataDecoder(): FixedSizeDecoder { return getStructDecoder([ ['discriminator', fixDecoderSize(getBytesDecoder(), 8)], ['rentHints', getArrayDecoder(getU32Decoder(), { size: 3 })], ]); } export function getPayClaimStakesRentInstructionDataCodec(): FixedSizeCodec< PayClaimStakesRentInstructionDataArgs, PayClaimStakesRentInstructionData > { return combineCodec( getPayClaimStakesRentInstructionDataEncoder(), getPayClaimStakesRentInstructionDataDecoder(), ); } export type PayClaimStakesRentAsyncInput< TAccountFunder extends string = string, TAccountProfile extends string = string, TAccountClaimStakeInstance extends string = string, TAccountCelestialBody extends string = string, TAccountSystemAndStarbasePlayerSystem extends string = string, TAccountSystemAndStarbasePlayerStarbasePlayer extends string = string, TAccountCurrencyCache extends string = string, TAccountGame extends string = string, TAccountXpAccrual extends string = string, TAccountRentCatalog extends string = string, TAccountRentAuthority extends string = string, TAccountRentGridHead extends string = string, TAccountRentLevelHead extends string = string, TAccountRentDefHead extends string = string, > = { /** The funder for any Solana rent payments. */ funder: TransactionSigner; /** The player profile */ profile: Address; /** The claim stake instance */ claimStakeInstance: Address; /** The CelestialBody account containing the claim stake */ celestialBody: Address; /** The [`StarSystem`] account */ systemAndStarbasePlayerSystem: Address; /** The [`StarbasePlayer`] Account */ systemAndStarbasePlayerStarbasePlayer: Address; /** The currency config cache account */ currencyCache?: Address; /** The game account */ game: Address; /** * Building XP ledger (spec §5): REQUIRED by `Game.version == v1` (fail closed) and * rejected on legacy games. Appended after every pre-existing account so legacy * transactions keep their positional prefix. This instruction carries no System * program, so the ledger must already exist (any settle / place / finalize / * production call creates it). */ xpAccrual?: Address; /** The game's rent-catalog PDA (REQUIRED; never created = Disabled). */ rentCatalog: Address; /** The stake's settlement-authority PDA (REQUIRED; never created = never evaluated). */ rentAuthority: Address; /** The stake's GRID source head (required iff the catalog is Active). */ rentGridHead?: Address; /** The stake's system LEVEL source head (required iff the catalog is Active). */ rentLevelHead?: Address; /** The stake's definition DEF source head (required iff the catalog is Active). */ rentDefHead?: Address; rentHints: PayClaimStakesRentInstructionDataArgs['rentHints']; rentPages: Array
; }; export async function getPayClaimStakesRentInstructionAsync< TAccountFunder extends string, TAccountProfile extends string, TAccountClaimStakeInstance extends string, TAccountCelestialBody extends string, TAccountSystemAndStarbasePlayerSystem extends string, TAccountSystemAndStarbasePlayerStarbasePlayer extends string, TAccountCurrencyCache extends string, TAccountGame extends string, TAccountXpAccrual extends string, TAccountRentCatalog extends string, TAccountRentAuthority extends string, TAccountRentGridHead extends string, TAccountRentLevelHead extends string, TAccountRentDefHead extends string, TProgramAddress extends Address = typeof SAGE_PROGRAM_ADDRESS, >( input: PayClaimStakesRentAsyncInput< TAccountFunder, TAccountProfile, TAccountClaimStakeInstance, TAccountCelestialBody, TAccountSystemAndStarbasePlayerSystem, TAccountSystemAndStarbasePlayerStarbasePlayer, TAccountCurrencyCache, TAccountGame, TAccountXpAccrual, TAccountRentCatalog, TAccountRentAuthority, TAccountRentGridHead, TAccountRentLevelHead, TAccountRentDefHead >, config?: { programAddress?: TProgramAddress }, ): Promise< PayClaimStakesRentInstruction< TProgramAddress, TAccountFunder, TAccountProfile, TAccountClaimStakeInstance, TAccountCelestialBody, TAccountSystemAndStarbasePlayerSystem, TAccountSystemAndStarbasePlayerStarbasePlayer, TAccountCurrencyCache, TAccountGame, TAccountXpAccrual, TAccountRentCatalog, TAccountRentAuthority, TAccountRentGridHead, TAccountRentLevelHead, TAccountRentDefHead > > { // Program address. const programAddress = config?.programAddress ?? SAGE_PROGRAM_ADDRESS; // Original accounts. const originalAccounts = { funder: { value: input.funder ?? null, isWritable: true }, profile: { value: input.profile ?? null, isWritable: false }, claimStakeInstance: { value: input.claimStakeInstance ?? null, isWritable: true, }, celestialBody: { value: input.celestialBody ?? null, isWritable: true }, systemAndStarbasePlayerSystem: { value: input.systemAndStarbasePlayerSystem ?? null, isWritable: false, }, systemAndStarbasePlayerStarbasePlayer: { value: input.systemAndStarbasePlayerStarbasePlayer ?? null, isWritable: false, }, currencyCache: { value: input.currencyCache ?? null, isWritable: true }, game: { value: input.game ?? null, isWritable: false }, xpAccrual: { value: input.xpAccrual ?? null, isWritable: true }, rentCatalog: { value: input.rentCatalog ?? null, isWritable: false }, rentAuthority: { value: input.rentAuthority ?? null, isWritable: true }, rentGridHead: { value: input.rentGridHead ?? null, isWritable: false }, rentLevelHead: { value: input.rentLevelHead ?? null, isWritable: false }, rentDefHead: { value: input.rentDefHead ?? null, isWritable: false }, }; const accounts = originalAccounts as Record< keyof typeof originalAccounts, ResolvedInstructionAccount >; // Original args. const args = { ...input }; // Resolve default values. if (!accounts.currencyCache.value) { accounts.currencyCache.value = await getProgramDerivedAddress({ programAddress, seeds: [ getBytesEncoder().encode( new Uint8Array([ 67, 117, 114, 114, 101, 110, 99, 121, 67, 111, 110, 102, 105, 103, ]), ), getAddressEncoder().encode( getAddressFromResolvedInstructionAccount('game', accounts.game.value), ), ], }); } // Remaining accounts. const remainingAccounts: AccountMeta[] = args.rentPages.map((address) => ({ address, role: AccountRole.READONLY, })); const getAccountMeta = getAccountMetaFactory(programAddress, 'programId'); return Object.freeze({ accounts: [ getAccountMeta('funder', accounts.funder), getAccountMeta('profile', accounts.profile), getAccountMeta('claimStakeInstance', accounts.claimStakeInstance), getAccountMeta('celestialBody', accounts.celestialBody), getAccountMeta( 'systemAndStarbasePlayerSystem', accounts.systemAndStarbasePlayerSystem, ), getAccountMeta( 'systemAndStarbasePlayerStarbasePlayer', accounts.systemAndStarbasePlayerStarbasePlayer, ), getAccountMeta('currencyCache', accounts.currencyCache), getAccountMeta('game', accounts.game), getAccountMeta('xpAccrual', accounts.xpAccrual), getAccountMeta('rentCatalog', accounts.rentCatalog), getAccountMeta('rentAuthority', accounts.rentAuthority), getAccountMeta('rentGridHead', accounts.rentGridHead), getAccountMeta('rentLevelHead', accounts.rentLevelHead), getAccountMeta('rentDefHead', accounts.rentDefHead), ...remainingAccounts, ], data: getPayClaimStakesRentInstructionDataEncoder().encode( args as PayClaimStakesRentInstructionDataArgs, ), programAddress, } as PayClaimStakesRentInstruction< TProgramAddress, TAccountFunder, TAccountProfile, TAccountClaimStakeInstance, TAccountCelestialBody, TAccountSystemAndStarbasePlayerSystem, TAccountSystemAndStarbasePlayerStarbasePlayer, TAccountCurrencyCache, TAccountGame, TAccountXpAccrual, TAccountRentCatalog, TAccountRentAuthority, TAccountRentGridHead, TAccountRentLevelHead, TAccountRentDefHead >); } export type PayClaimStakesRentInput< TAccountFunder extends string = string, TAccountProfile extends string = string, TAccountClaimStakeInstance extends string = string, TAccountCelestialBody extends string = string, TAccountSystemAndStarbasePlayerSystem extends string = string, TAccountSystemAndStarbasePlayerStarbasePlayer extends string = string, TAccountCurrencyCache extends string = string, TAccountGame extends string = string, TAccountXpAccrual extends string = string, TAccountRentCatalog extends string = string, TAccountRentAuthority extends string = string, TAccountRentGridHead extends string = string, TAccountRentLevelHead extends string = string, TAccountRentDefHead extends string = string, > = { /** The funder for any Solana rent payments. */ funder: TransactionSigner; /** The player profile */ profile: Address; /** The claim stake instance */ claimStakeInstance: Address; /** The CelestialBody account containing the claim stake */ celestialBody: Address; /** The [`StarSystem`] account */ systemAndStarbasePlayerSystem: Address; /** The [`StarbasePlayer`] Account */ systemAndStarbasePlayerStarbasePlayer: Address; /** The currency config cache account */ currencyCache: Address; /** The game account */ game: Address; /** * Building XP ledger (spec §5): REQUIRED by `Game.version == v1` (fail closed) and * rejected on legacy games. Appended after every pre-existing account so legacy * transactions keep their positional prefix. This instruction carries no System * program, so the ledger must already exist (any settle / place / finalize / * production call creates it). */ xpAccrual?: Address; /** The game's rent-catalog PDA (REQUIRED; never created = Disabled). */ rentCatalog: Address; /** The stake's settlement-authority PDA (REQUIRED; never created = never evaluated). */ rentAuthority: Address; /** The stake's GRID source head (required iff the catalog is Active). */ rentGridHead?: Address; /** The stake's system LEVEL source head (required iff the catalog is Active). */ rentLevelHead?: Address; /** The stake's definition DEF source head (required iff the catalog is Active). */ rentDefHead?: Address; rentHints: PayClaimStakesRentInstructionDataArgs['rentHints']; rentPages: Array
; }; export function getPayClaimStakesRentInstruction< TAccountFunder extends string, TAccountProfile extends string, TAccountClaimStakeInstance extends string, TAccountCelestialBody extends string, TAccountSystemAndStarbasePlayerSystem extends string, TAccountSystemAndStarbasePlayerStarbasePlayer extends string, TAccountCurrencyCache extends string, TAccountGame extends string, TAccountXpAccrual extends string, TAccountRentCatalog extends string, TAccountRentAuthority extends string, TAccountRentGridHead extends string, TAccountRentLevelHead extends string, TAccountRentDefHead extends string, TProgramAddress extends Address = typeof SAGE_PROGRAM_ADDRESS, >( input: PayClaimStakesRentInput< TAccountFunder, TAccountProfile, TAccountClaimStakeInstance, TAccountCelestialBody, TAccountSystemAndStarbasePlayerSystem, TAccountSystemAndStarbasePlayerStarbasePlayer, TAccountCurrencyCache, TAccountGame, TAccountXpAccrual, TAccountRentCatalog, TAccountRentAuthority, TAccountRentGridHead, TAccountRentLevelHead, TAccountRentDefHead >, config?: { programAddress?: TProgramAddress }, ): PayClaimStakesRentInstruction< TProgramAddress, TAccountFunder, TAccountProfile, TAccountClaimStakeInstance, TAccountCelestialBody, TAccountSystemAndStarbasePlayerSystem, TAccountSystemAndStarbasePlayerStarbasePlayer, TAccountCurrencyCache, TAccountGame, TAccountXpAccrual, TAccountRentCatalog, TAccountRentAuthority, TAccountRentGridHead, TAccountRentLevelHead, TAccountRentDefHead > { // Program address. const programAddress = config?.programAddress ?? SAGE_PROGRAM_ADDRESS; // Original accounts. const originalAccounts = { funder: { value: input.funder ?? null, isWritable: true }, profile: { value: input.profile ?? null, isWritable: false }, claimStakeInstance: { value: input.claimStakeInstance ?? null, isWritable: true, }, celestialBody: { value: input.celestialBody ?? null, isWritable: true }, systemAndStarbasePlayerSystem: { value: input.systemAndStarbasePlayerSystem ?? null, isWritable: false, }, systemAndStarbasePlayerStarbasePlayer: { value: input.systemAndStarbasePlayerStarbasePlayer ?? null, isWritable: false, }, currencyCache: { value: input.currencyCache ?? null, isWritable: true }, game: { value: input.game ?? null, isWritable: false }, xpAccrual: { value: input.xpAccrual ?? null, isWritable: true }, rentCatalog: { value: input.rentCatalog ?? null, isWritable: false }, rentAuthority: { value: input.rentAuthority ?? null, isWritable: true }, rentGridHead: { value: input.rentGridHead ?? null, isWritable: false }, rentLevelHead: { value: input.rentLevelHead ?? null, isWritable: false }, rentDefHead: { value: input.rentDefHead ?? null, isWritable: false }, }; const accounts = originalAccounts as Record< keyof typeof originalAccounts, ResolvedInstructionAccount >; // Original args. const args = { ...input }; // Remaining accounts. const remainingAccounts: AccountMeta[] = args.rentPages.map((address) => ({ address, role: AccountRole.READONLY, })); const getAccountMeta = getAccountMetaFactory(programAddress, 'programId'); return Object.freeze({ accounts: [ getAccountMeta('funder', accounts.funder), getAccountMeta('profile', accounts.profile), getAccountMeta('claimStakeInstance', accounts.claimStakeInstance), getAccountMeta('celestialBody', accounts.celestialBody), getAccountMeta( 'systemAndStarbasePlayerSystem', accounts.systemAndStarbasePlayerSystem, ), getAccountMeta( 'systemAndStarbasePlayerStarbasePlayer', accounts.systemAndStarbasePlayerStarbasePlayer, ), getAccountMeta('currencyCache', accounts.currencyCache), getAccountMeta('game', accounts.game), getAccountMeta('xpAccrual', accounts.xpAccrual), getAccountMeta('rentCatalog', accounts.rentCatalog), getAccountMeta('rentAuthority', accounts.rentAuthority), getAccountMeta('rentGridHead', accounts.rentGridHead), getAccountMeta('rentLevelHead', accounts.rentLevelHead), getAccountMeta('rentDefHead', accounts.rentDefHead), ...remainingAccounts, ], data: getPayClaimStakesRentInstructionDataEncoder().encode( args as PayClaimStakesRentInstructionDataArgs, ), programAddress, } as PayClaimStakesRentInstruction< TProgramAddress, TAccountFunder, TAccountProfile, TAccountClaimStakeInstance, TAccountCelestialBody, TAccountSystemAndStarbasePlayerSystem, TAccountSystemAndStarbasePlayerStarbasePlayer, TAccountCurrencyCache, TAccountGame, TAccountXpAccrual, TAccountRentCatalog, TAccountRentAuthority, TAccountRentGridHead, TAccountRentLevelHead, TAccountRentDefHead >); } export type ParsedPayClaimStakesRentInstruction< TProgram extends string = typeof SAGE_PROGRAM_ADDRESS, TAccountMetas extends readonly AccountMeta[] = readonly AccountMeta[], > = { programAddress: Address; accounts: { /** The funder for any Solana rent payments. */ funder: TAccountMetas[0]; /** The player profile */ profile: TAccountMetas[1]; /** The claim stake instance */ claimStakeInstance: TAccountMetas[2]; /** The CelestialBody account containing the claim stake */ celestialBody: TAccountMetas[3]; /** The [`StarSystem`] account */ systemAndStarbasePlayerSystem: TAccountMetas[4]; /** The [`StarbasePlayer`] Account */ systemAndStarbasePlayerStarbasePlayer: TAccountMetas[5]; /** The currency config cache account */ currencyCache: TAccountMetas[6]; /** The game account */ game: TAccountMetas[7]; /** * Building XP ledger (spec §5): REQUIRED by `Game.version == v1` (fail closed) and * rejected on legacy games. Appended after every pre-existing account so legacy * transactions keep their positional prefix. This instruction carries no System * program, so the ledger must already exist (any settle / place / finalize / * production call creates it). */ xpAccrual?: TAccountMetas[8] | undefined; /** The game's rent-catalog PDA (REQUIRED; never created = Disabled). */ rentCatalog: TAccountMetas[9]; /** The stake's settlement-authority PDA (REQUIRED; never created = never evaluated). */ rentAuthority: TAccountMetas[10]; /** The stake's GRID source head (required iff the catalog is Active). */ rentGridHead?: TAccountMetas[11] | undefined; /** The stake's system LEVEL source head (required iff the catalog is Active). */ rentLevelHead?: TAccountMetas[12] | undefined; /** The stake's definition DEF source head (required iff the catalog is Active). */ rentDefHead?: TAccountMetas[13] | undefined; }; data: PayClaimStakesRentInstructionData; }; export function parsePayClaimStakesRentInstruction< TProgram extends string, TAccountMetas extends readonly AccountMeta[], >( instruction: Instruction & InstructionWithAccounts & InstructionWithData, ): ParsedPayClaimStakesRentInstruction { if (instruction.accounts.length < 14) { throw new SolanaError( SOLANA_ERROR__PROGRAM_CLIENTS__INSUFFICIENT_ACCOUNT_METAS, { actualAccountMetas: instruction.accounts.length, expectedAccountMetas: 14, }, ); } let accountIndex = 0; const getNextAccount = () => { const accountMeta = (instruction.accounts as TAccountMetas)[accountIndex]!; accountIndex += 1; return accountMeta; }; const getNextOptionalAccount = () => { const accountMeta = getNextAccount(); return accountMeta.address === SAGE_PROGRAM_ADDRESS ? undefined : accountMeta; }; return { programAddress: instruction.programAddress, accounts: { funder: getNextAccount(), profile: getNextAccount(), claimStakeInstance: getNextAccount(), celestialBody: getNextAccount(), systemAndStarbasePlayerSystem: getNextAccount(), systemAndStarbasePlayerStarbasePlayer: getNextAccount(), currencyCache: getNextAccount(), game: getNextAccount(), xpAccrual: getNextOptionalAccount(), rentCatalog: getNextAccount(), rentAuthority: getNextAccount(), rentGridHead: getNextOptionalAccount(), rentLevelHead: getNextOptionalAccount(), rentDefHead: getNextOptionalAccount(), }, data: getPayClaimStakesRentInstructionDataDecoder().decode( instruction.data, ), }; }