/** * 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 { combineCodec, fixDecoderSize, fixEncoderSize, getAddressEncoder, getBytesDecoder, getBytesEncoder, getProgramDerivedAddress, getStructDecoder, getStructEncoder, getU16Decoder, getU16Encoder, 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 ReadonlySignerAccount, type ReadonlyUint8Array, type TransactionSigner, type WritableAccount, } from '@solana/kit'; import { getAccountMetaFactory, getAddressFromResolvedInstructionAccount, type ResolvedInstructionAccount, } from '@solana/program-client-core'; import { SAGE_PROGRAM_ADDRESS } from '../programs'; export const SCAN_DISCRIMINATOR = new Uint8Array([ 133, 46, 125, 252, 48, 236, 164, 72, ]); export function getScanDiscriminatorBytes() { return fixEncoderSize(getBytesEncoder(), 8).encode(SCAN_DISCRIMINATOR); } export type ScanInstruction< TProgram extends string = typeof SAGE_PROGRAM_ADDRESS, TAccountProfileValidationSigner extends string | AccountMeta = string, TAccountProfileValidationProfile extends string | AccountMeta = string, TAccountProfileValidationCertificate extends string | AccountMeta = string, TAccountProfileValidationProgram extends string | AccountMeta = 'C4PRoFNroxxzdgeCoM31LJjYRg7kT6ymogSTAT99iD1u', TAccountCharacter extends string | AccountMeta = string, TAccountFleet extends string | AccountMeta = string, TAccountScanPattern extends string | AccountMeta = string, TAccountGame extends string | AccountMeta = string, TAccountInstructionsSysvar extends string | AccountMeta = 'Sysvar1nstructions1111111111111111111111111', TAccountRecentSlothashes extends string | AccountMeta = string, TAccountCrewBinding extends string | AccountMeta = string, TAccountRegionTracker extends string | AccountMeta = string, TAccountEncounterCommit extends string | AccountMeta = string, TAccountEncounterPool extends string | AccountMeta = string, TAccountXpBudget extends string | AccountMeta = string, TAccountXpBudgetConfig extends string | AccountMeta = string, TRemainingAccounts extends readonly AccountMeta[] = [], > = Instruction & InstructionWithData & InstructionWithAccounts< [ TAccountProfileValidationSigner extends string ? ReadonlySignerAccount & AccountSignerMeta : TAccountProfileValidationSigner, TAccountProfileValidationProfile extends string ? WritableAccount : TAccountProfileValidationProfile, TAccountProfileValidationCertificate extends string ? ReadonlyAccount : TAccountProfileValidationCertificate, TAccountProfileValidationProgram extends string ? ReadonlyAccount : TAccountProfileValidationProgram, TAccountCharacter extends string ? WritableAccount : TAccountCharacter, TAccountFleet extends string ? WritableAccount : TAccountFleet, TAccountScanPattern extends string ? ReadonlyAccount : TAccountScanPattern, TAccountGame extends string ? ReadonlyAccount : TAccountGame, TAccountInstructionsSysvar extends string ? ReadonlyAccount : TAccountInstructionsSysvar, TAccountRecentSlothashes extends string ? ReadonlyAccount : TAccountRecentSlothashes, TAccountCrewBinding extends string ? WritableAccount : TAccountCrewBinding, TAccountRegionTracker extends string ? ReadonlyAccount : TAccountRegionTracker, TAccountEncounterCommit extends string ? WritableAccount : TAccountEncounterCommit, TAccountEncounterPool extends string ? ReadonlyAccount : TAccountEncounterPool, TAccountXpBudget extends string ? WritableAccount : TAccountXpBudget, TAccountXpBudgetConfig extends string ? ReadonlyAccount : TAccountXpBudgetConfig, ...TRemainingAccounts, ] >; export type ScanInstructionData = { discriminator: ReadonlyUint8Array; keyIndex: number; }; export type ScanInstructionDataArgs = { keyIndex: number }; export function getScanInstructionDataEncoder(): FixedSizeEncoder { return transformEncoder( getStructEncoder([ ['discriminator', fixEncoderSize(getBytesEncoder(), 8)], ['keyIndex', getU16Encoder()], ]), (value) => ({ ...value, discriminator: SCAN_DISCRIMINATOR }), ); } export function getScanInstructionDataDecoder(): FixedSizeDecoder { return getStructDecoder([ ['discriminator', fixDecoderSize(getBytesDecoder(), 8)], ['keyIndex', getU16Decoder()], ]); } export function getScanInstructionDataCodec(): FixedSizeCodec< ScanInstructionDataArgs, ScanInstructionData > { return combineCodec( getScanInstructionDataEncoder(), getScanInstructionDataDecoder(), ); } export type ScanAsyncInput< TAccountProfileValidationSigner extends string = string, TAccountProfileValidationProfile extends string = string, TAccountProfileValidationCertificate extends string = string, TAccountProfileValidationProgram extends string = string, TAccountCharacter extends string = string, TAccountFleet extends string = string, TAccountScanPattern extends string = string, TAccountGame extends string = string, TAccountInstructionsSysvar extends string = string, TAccountRecentSlothashes extends string = string, TAccountCrewBinding extends string = string, TAccountRegionTracker extends string = string, TAccountEncounterCommit extends string = string, TAccountEncounterPool extends string = string, TAccountXpBudget extends string = string, TAccountXpBudgetConfig extends string = string, > = { profileValidationSigner: TransactionSigner; profileValidationProfile: Address; profileValidationCertificate?: Address; profileValidationProgram?: Address; character?: Address; fleet: Address; scanPattern: Address; game: Address; instructionsSysvar?: Address; recentSlothashes: Address; crewBinding?: Address; regionTracker?: Address; /** Optional (Phase 2 — encounter): the caller's per-character [`EncounterCommit`], stamped when an encounter arms. */ encounterCommit?: Address; /** * Optional (Phase 2 — encounter): the `(region, faction)` [`EncounterPool`] the caller is arming. Its * faction is PINNED into the commit here — before the reveal's future hash exists — so it can't be * steered after the entropy is knowable. Validated active + same-region at scan; reveal requires the * revealed pool's faction to match. Must be supplied with `region_tracker` + `encounter_commit` to arm. */ encounterPool?: Address; xpBudget?: Address; xpBudgetConfig?: Address; keyIndex: ScanInstructionDataArgs['keyIndex']; }; export async function getScanInstructionAsync< TAccountProfileValidationSigner extends string, TAccountProfileValidationProfile extends string, TAccountProfileValidationCertificate extends string, TAccountProfileValidationProgram extends string, TAccountCharacter extends string, TAccountFleet extends string, TAccountScanPattern extends string, TAccountGame extends string, TAccountInstructionsSysvar extends string, TAccountRecentSlothashes extends string, TAccountCrewBinding extends string, TAccountRegionTracker extends string, TAccountEncounterCommit extends string, TAccountEncounterPool extends string, TAccountXpBudget extends string, TAccountXpBudgetConfig extends string, TProgramAddress extends Address = typeof SAGE_PROGRAM_ADDRESS, >( input: ScanAsyncInput< TAccountProfileValidationSigner, TAccountProfileValidationProfile, TAccountProfileValidationCertificate, TAccountProfileValidationProgram, TAccountCharacter, TAccountFleet, TAccountScanPattern, TAccountGame, TAccountInstructionsSysvar, TAccountRecentSlothashes, TAccountCrewBinding, TAccountRegionTracker, TAccountEncounterCommit, TAccountEncounterPool, TAccountXpBudget, TAccountXpBudgetConfig >, config?: { programAddress?: TProgramAddress }, ): Promise< ScanInstruction< TProgramAddress, TAccountProfileValidationSigner, TAccountProfileValidationProfile, TAccountProfileValidationCertificate, TAccountProfileValidationProgram, TAccountCharacter, TAccountFleet, TAccountScanPattern, TAccountGame, TAccountInstructionsSysvar, TAccountRecentSlothashes, TAccountCrewBinding, TAccountRegionTracker, TAccountEncounterCommit, TAccountEncounterPool, TAccountXpBudget, TAccountXpBudgetConfig > > { // Program address. const programAddress = config?.programAddress ?? SAGE_PROGRAM_ADDRESS; // Original accounts. const originalAccounts = { profileValidationSigner: { value: input.profileValidationSigner ?? null, isWritable: false, }, profileValidationProfile: { value: input.profileValidationProfile ?? null, isWritable: true, }, profileValidationCertificate: { value: input.profileValidationCertificate ?? null, isWritable: false, }, profileValidationProgram: { value: input.profileValidationProgram ?? null, isWritable: false, }, character: { value: input.character ?? null, isWritable: true }, fleet: { value: input.fleet ?? null, isWritable: true }, scanPattern: { value: input.scanPattern ?? null, isWritable: false }, game: { value: input.game ?? null, isWritable: false }, instructionsSysvar: { value: input.instructionsSysvar ?? null, isWritable: false, }, recentSlothashes: { value: input.recentSlothashes ?? null, isWritable: false, }, crewBinding: { value: input.crewBinding ?? null, isWritable: true }, regionTracker: { value: input.regionTracker ?? null, isWritable: false }, encounterCommit: { value: input.encounterCommit ?? null, isWritable: true }, encounterPool: { value: input.encounterPool ?? null, isWritable: false }, xpBudget: { value: input.xpBudget ?? null, isWritable: true }, xpBudgetConfig: { value: input.xpBudgetConfig ?? null, isWritable: false }, }; const accounts = originalAccounts as Record< keyof typeof originalAccounts, ResolvedInstructionAccount >; // Original args. const args = { ...input }; // Resolve default values. if (!accounts.profileValidationProgram.value) { accounts.profileValidationProgram.value = 'C4PRoFNroxxzdgeCoM31LJjYRg7kT6ymogSTAT99iD1u' as Address<'C4PRoFNroxxzdgeCoM31LJjYRg7kT6ymogSTAT99iD1u'>; } if (!accounts.character.value) { accounts.character.value = await getProgramDerivedAddress({ programAddress, seeds: [ getBytesEncoder().encode( new Uint8Array([67, 104, 97, 114, 97, 99, 116, 101, 114]), ), getAddressEncoder().encode( getAddressFromResolvedInstructionAccount( 'profileValidationProfile', accounts.profileValidationProfile.value, ), ), getAddressEncoder().encode( getAddressFromResolvedInstructionAccount('game', accounts.game.value), ), ], }); } if (!accounts.instructionsSysvar.value) { accounts.instructionsSysvar.value = 'Sysvar1nstructions1111111111111111111111111' as Address<'Sysvar1nstructions1111111111111111111111111'>; } const getAccountMeta = getAccountMetaFactory(programAddress, 'programId'); return Object.freeze({ accounts: [ getAccountMeta( 'profileValidationSigner', accounts.profileValidationSigner, ), getAccountMeta( 'profileValidationProfile', accounts.profileValidationProfile, ), getAccountMeta( 'profileValidationCertificate', accounts.profileValidationCertificate, ), getAccountMeta( 'profileValidationProgram', accounts.profileValidationProgram, ), getAccountMeta('character', accounts.character), getAccountMeta('fleet', accounts.fleet), getAccountMeta('scanPattern', accounts.scanPattern), getAccountMeta('game', accounts.game), getAccountMeta('instructionsSysvar', accounts.instructionsSysvar), getAccountMeta('recentSlothashes', accounts.recentSlothashes), getAccountMeta('crewBinding', accounts.crewBinding), getAccountMeta('regionTracker', accounts.regionTracker), getAccountMeta('encounterCommit', accounts.encounterCommit), getAccountMeta('encounterPool', accounts.encounterPool), getAccountMeta('xpBudget', accounts.xpBudget), getAccountMeta('xpBudgetConfig', accounts.xpBudgetConfig), ], data: getScanInstructionDataEncoder().encode( args as ScanInstructionDataArgs, ), programAddress, } as ScanInstruction< TProgramAddress, TAccountProfileValidationSigner, TAccountProfileValidationProfile, TAccountProfileValidationCertificate, TAccountProfileValidationProgram, TAccountCharacter, TAccountFleet, TAccountScanPattern, TAccountGame, TAccountInstructionsSysvar, TAccountRecentSlothashes, TAccountCrewBinding, TAccountRegionTracker, TAccountEncounterCommit, TAccountEncounterPool, TAccountXpBudget, TAccountXpBudgetConfig >); } export type ScanInput< TAccountProfileValidationSigner extends string = string, TAccountProfileValidationProfile extends string = string, TAccountProfileValidationCertificate extends string = string, TAccountProfileValidationProgram extends string = string, TAccountCharacter extends string = string, TAccountFleet extends string = string, TAccountScanPattern extends string = string, TAccountGame extends string = string, TAccountInstructionsSysvar extends string = string, TAccountRecentSlothashes extends string = string, TAccountCrewBinding extends string = string, TAccountRegionTracker extends string = string, TAccountEncounterCommit extends string = string, TAccountEncounterPool extends string = string, TAccountXpBudget extends string = string, TAccountXpBudgetConfig extends string = string, > = { profileValidationSigner: TransactionSigner; profileValidationProfile: Address; profileValidationCertificate?: Address; profileValidationProgram?: Address; character: Address; fleet: Address; scanPattern: Address; game: Address; instructionsSysvar?: Address; recentSlothashes: Address; crewBinding?: Address; regionTracker?: Address; /** Optional (Phase 2 — encounter): the caller's per-character [`EncounterCommit`], stamped when an encounter arms. */ encounterCommit?: Address; /** * Optional (Phase 2 — encounter): the `(region, faction)` [`EncounterPool`] the caller is arming. Its * faction is PINNED into the commit here — before the reveal's future hash exists — so it can't be * steered after the entropy is knowable. Validated active + same-region at scan; reveal requires the * revealed pool's faction to match. Must be supplied with `region_tracker` + `encounter_commit` to arm. */ encounterPool?: Address; xpBudget?: Address; xpBudgetConfig?: Address; keyIndex: ScanInstructionDataArgs['keyIndex']; }; export function getScanInstruction< TAccountProfileValidationSigner extends string, TAccountProfileValidationProfile extends string, TAccountProfileValidationCertificate extends string, TAccountProfileValidationProgram extends string, TAccountCharacter extends string, TAccountFleet extends string, TAccountScanPattern extends string, TAccountGame extends string, TAccountInstructionsSysvar extends string, TAccountRecentSlothashes extends string, TAccountCrewBinding extends string, TAccountRegionTracker extends string, TAccountEncounterCommit extends string, TAccountEncounterPool extends string, TAccountXpBudget extends string, TAccountXpBudgetConfig extends string, TProgramAddress extends Address = typeof SAGE_PROGRAM_ADDRESS, >( input: ScanInput< TAccountProfileValidationSigner, TAccountProfileValidationProfile, TAccountProfileValidationCertificate, TAccountProfileValidationProgram, TAccountCharacter, TAccountFleet, TAccountScanPattern, TAccountGame, TAccountInstructionsSysvar, TAccountRecentSlothashes, TAccountCrewBinding, TAccountRegionTracker, TAccountEncounterCommit, TAccountEncounterPool, TAccountXpBudget, TAccountXpBudgetConfig >, config?: { programAddress?: TProgramAddress }, ): ScanInstruction< TProgramAddress, TAccountProfileValidationSigner, TAccountProfileValidationProfile, TAccountProfileValidationCertificate, TAccountProfileValidationProgram, TAccountCharacter, TAccountFleet, TAccountScanPattern, TAccountGame, TAccountInstructionsSysvar, TAccountRecentSlothashes, TAccountCrewBinding, TAccountRegionTracker, TAccountEncounterCommit, TAccountEncounterPool, TAccountXpBudget, TAccountXpBudgetConfig > { // Program address. const programAddress = config?.programAddress ?? SAGE_PROGRAM_ADDRESS; // Original accounts. const originalAccounts = { profileValidationSigner: { value: input.profileValidationSigner ?? null, isWritable: false, }, profileValidationProfile: { value: input.profileValidationProfile ?? null, isWritable: true, }, profileValidationCertificate: { value: input.profileValidationCertificate ?? null, isWritable: false, }, profileValidationProgram: { value: input.profileValidationProgram ?? null, isWritable: false, }, character: { value: input.character ?? null, isWritable: true }, fleet: { value: input.fleet ?? null, isWritable: true }, scanPattern: { value: input.scanPattern ?? null, isWritable: false }, game: { value: input.game ?? null, isWritable: false }, instructionsSysvar: { value: input.instructionsSysvar ?? null, isWritable: false, }, recentSlothashes: { value: input.recentSlothashes ?? null, isWritable: false, }, crewBinding: { value: input.crewBinding ?? null, isWritable: true }, regionTracker: { value: input.regionTracker ?? null, isWritable: false }, encounterCommit: { value: input.encounterCommit ?? null, isWritable: true }, encounterPool: { value: input.encounterPool ?? null, isWritable: false }, xpBudget: { value: input.xpBudget ?? null, isWritable: true }, xpBudgetConfig: { value: input.xpBudgetConfig ?? null, isWritable: false }, }; const accounts = originalAccounts as Record< keyof typeof originalAccounts, ResolvedInstructionAccount >; // Original args. const args = { ...input }; // Resolve default values. if (!accounts.profileValidationProgram.value) { accounts.profileValidationProgram.value = 'C4PRoFNroxxzdgeCoM31LJjYRg7kT6ymogSTAT99iD1u' as Address<'C4PRoFNroxxzdgeCoM31LJjYRg7kT6ymogSTAT99iD1u'>; } if (!accounts.instructionsSysvar.value) { accounts.instructionsSysvar.value = 'Sysvar1nstructions1111111111111111111111111' as Address<'Sysvar1nstructions1111111111111111111111111'>; } const getAccountMeta = getAccountMetaFactory(programAddress, 'programId'); return Object.freeze({ accounts: [ getAccountMeta( 'profileValidationSigner', accounts.profileValidationSigner, ), getAccountMeta( 'profileValidationProfile', accounts.profileValidationProfile, ), getAccountMeta( 'profileValidationCertificate', accounts.profileValidationCertificate, ), getAccountMeta( 'profileValidationProgram', accounts.profileValidationProgram, ), getAccountMeta('character', accounts.character), getAccountMeta('fleet', accounts.fleet), getAccountMeta('scanPattern', accounts.scanPattern), getAccountMeta('game', accounts.game), getAccountMeta('instructionsSysvar', accounts.instructionsSysvar), getAccountMeta('recentSlothashes', accounts.recentSlothashes), getAccountMeta('crewBinding', accounts.crewBinding), getAccountMeta('regionTracker', accounts.regionTracker), getAccountMeta('encounterCommit', accounts.encounterCommit), getAccountMeta('encounterPool', accounts.encounterPool), getAccountMeta('xpBudget', accounts.xpBudget), getAccountMeta('xpBudgetConfig', accounts.xpBudgetConfig), ], data: getScanInstructionDataEncoder().encode( args as ScanInstructionDataArgs, ), programAddress, } as ScanInstruction< TProgramAddress, TAccountProfileValidationSigner, TAccountProfileValidationProfile, TAccountProfileValidationCertificate, TAccountProfileValidationProgram, TAccountCharacter, TAccountFleet, TAccountScanPattern, TAccountGame, TAccountInstructionsSysvar, TAccountRecentSlothashes, TAccountCrewBinding, TAccountRegionTracker, TAccountEncounterCommit, TAccountEncounterPool, TAccountXpBudget, TAccountXpBudgetConfig >); } export type ParsedScanInstruction< TProgram extends string = typeof SAGE_PROGRAM_ADDRESS, TAccountMetas extends readonly AccountMeta[] = readonly AccountMeta[], > = { programAddress: Address; accounts: { profileValidationSigner: TAccountMetas[0]; profileValidationProfile: TAccountMetas[1]; profileValidationCertificate?: TAccountMetas[2] | undefined; profileValidationProgram: TAccountMetas[3]; character: TAccountMetas[4]; fleet: TAccountMetas[5]; scanPattern: TAccountMetas[6]; game: TAccountMetas[7]; instructionsSysvar: TAccountMetas[8]; recentSlothashes: TAccountMetas[9]; crewBinding?: TAccountMetas[10] | undefined; regionTracker?: TAccountMetas[11] | undefined; /** Optional (Phase 2 — encounter): the caller's per-character [`EncounterCommit`], stamped when an encounter arms. */ encounterCommit?: TAccountMetas[12] | undefined; /** * Optional (Phase 2 — encounter): the `(region, faction)` [`EncounterPool`] the caller is arming. Its * faction is PINNED into the commit here — before the reveal's future hash exists — so it can't be * steered after the entropy is knowable. Validated active + same-region at scan; reveal requires the * revealed pool's faction to match. Must be supplied with `region_tracker` + `encounter_commit` to arm. */ encounterPool?: TAccountMetas[13] | undefined; xpBudget?: TAccountMetas[14] | undefined; xpBudgetConfig?: TAccountMetas[15] | undefined; }; data: ScanInstructionData; }; export function parseScanInstruction< TProgram extends string, TAccountMetas extends readonly AccountMeta[], >( instruction: Instruction & InstructionWithAccounts & InstructionWithData, ): ParsedScanInstruction { if (instruction.accounts.length < 16) { throw new SolanaError( SOLANA_ERROR__PROGRAM_CLIENTS__INSUFFICIENT_ACCOUNT_METAS, { actualAccountMetas: instruction.accounts.length, expectedAccountMetas: 16, }, ); } 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: { profileValidationSigner: getNextAccount(), profileValidationProfile: getNextAccount(), profileValidationCertificate: getNextOptionalAccount(), profileValidationProgram: getNextAccount(), character: getNextAccount(), fleet: getNextAccount(), scanPattern: getNextAccount(), game: getNextAccount(), instructionsSysvar: getNextAccount(), recentSlothashes: getNextAccount(), crewBinding: getNextOptionalAccount(), regionTracker: getNextOptionalAccount(), encounterCommit: getNextOptionalAccount(), encounterPool: getNextOptionalAccount(), xpBudget: getNextOptionalAccount(), xpBudgetConfig: getNextOptionalAccount(), }, data: getScanInstructionDataDecoder().decode(instruction.data), }; }