/**
 * 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,
  getU16Decoder,
  getU16Encoder,
  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 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 FINALIZE_BUILDING_CHANGES_DISCRIMINATOR = new Uint8Array([
  134, 221, 22, 139, 156, 20, 169, 103,
]);

export function getFinalizeBuildingChangesDiscriminatorBytes() {
  return fixEncoderSize(getBytesEncoder(), 8).encode(
    FINALIZE_BUILDING_CHANGES_DISCRIMINATOR,
  );
}

export type FinalizeBuildingChangesInstruction<
  TProgram extends string = typeof SAGE_PROGRAM_ADDRESS,
  TAccountGame extends string | AccountMeta<string> = string,
  TAccountProfileValidationSigner extends string | AccountMeta<string> = string,
  TAccountProfileValidationProfile extends string | AccountMeta<string> =
    string,
  TAccountProfileValidationCertificate extends string | AccountMeta<string> =
    string,
  TAccountProfileValidationProgram extends string | AccountMeta<string> =
    'C4PRoFNroxxzdgeCoM31LJjYRg7kT6ymogSTAT99iD1u',
  TAccountCharacter extends string | AccountMeta<string> = string,
  TAccountClaimStakeInstance extends string | AccountMeta<string> = string,
  TAccountSystemAndStarbasePlayerSystem extends string | AccountMeta<string> =
    string,
  TAccountSystemAndStarbasePlayerStarbasePlayer extends
    | string
    | AccountMeta<string> = string,
  TAccountCelestialBody extends string | AccountMeta<string> = string,
  TAccountCurrencyCache extends string | AccountMeta<string> = string,
  TAccountSystemProgram extends string | AccountMeta<string> =
    '11111111111111111111111111111111',
  TAccountXpBudget extends string | AccountMeta<string> = string,
  TAccountXpBudgetConfig extends string | AccountMeta<string> = string,
  TAccountXpAccrual extends string | AccountMeta<string> = string,
  TAccountRentCatalog extends string | AccountMeta<string> = string,
  TAccountRentAuthority extends string | AccountMeta<string> = string,
  TAccountRentGridHead extends string | AccountMeta<string> = string,
  TAccountRentLevelHead extends string | AccountMeta<string> = string,
  TAccountRentDefHead extends string | AccountMeta<string> = string,
  TRemainingAccounts extends readonly AccountMeta<string>[] = [],
> = Instruction<TProgram> &
  InstructionWithData<ReadonlyUint8Array> &
  InstructionWithAccounts<
    [
      TAccountGame extends string
        ? ReadonlyAccount<TAccountGame>
        : TAccountGame,
      TAccountProfileValidationSigner extends string
        ? ReadonlySignerAccount<TAccountProfileValidationSigner> &
            AccountSignerMeta<TAccountProfileValidationSigner>
        : TAccountProfileValidationSigner,
      TAccountProfileValidationProfile extends string
        ? WritableAccount<TAccountProfileValidationProfile>
        : TAccountProfileValidationProfile,
      TAccountProfileValidationCertificate extends string
        ? ReadonlyAccount<TAccountProfileValidationCertificate>
        : TAccountProfileValidationCertificate,
      TAccountProfileValidationProgram extends string
        ? ReadonlyAccount<TAccountProfileValidationProgram>
        : TAccountProfileValidationProgram,
      TAccountCharacter extends string
        ? WritableAccount<TAccountCharacter>
        : TAccountCharacter,
      TAccountClaimStakeInstance extends string
        ? WritableAccount<TAccountClaimStakeInstance>
        : TAccountClaimStakeInstance,
      TAccountSystemAndStarbasePlayerSystem extends string
        ? ReadonlyAccount<TAccountSystemAndStarbasePlayerSystem>
        : TAccountSystemAndStarbasePlayerSystem,
      TAccountSystemAndStarbasePlayerStarbasePlayer extends string
        ? WritableAccount<TAccountSystemAndStarbasePlayerStarbasePlayer>
        : TAccountSystemAndStarbasePlayerStarbasePlayer,
      TAccountCelestialBody extends string
        ? WritableAccount<TAccountCelestialBody>
        : TAccountCelestialBody,
      TAccountCurrencyCache extends string
        ? WritableAccount<TAccountCurrencyCache>
        : TAccountCurrencyCache,
      TAccountSystemProgram extends string
        ? ReadonlyAccount<TAccountSystemProgram>
        : TAccountSystemProgram,
      TAccountXpBudget extends string
        ? WritableAccount<TAccountXpBudget>
        : TAccountXpBudget,
      TAccountXpBudgetConfig extends string
        ? ReadonlyAccount<TAccountXpBudgetConfig>
        : TAccountXpBudgetConfig,
      TAccountXpAccrual extends string
        ? WritableAccount<TAccountXpAccrual>
        : TAccountXpAccrual,
      TAccountRentCatalog extends string
        ? ReadonlyAccount<TAccountRentCatalog>
        : TAccountRentCatalog,
      TAccountRentAuthority extends string
        ? WritableAccount<TAccountRentAuthority>
        : TAccountRentAuthority,
      TAccountRentGridHead extends string
        ? ReadonlyAccount<TAccountRentGridHead>
        : TAccountRentGridHead,
      TAccountRentLevelHead extends string
        ? ReadonlyAccount<TAccountRentLevelHead>
        : TAccountRentLevelHead,
      TAccountRentDefHead extends string
        ? ReadonlyAccount<TAccountRentDefHead>
        : TAccountRentDefHead,
      ...TRemainingAccounts,
    ]
  >;

export type FinalizeBuildingChangesInstructionData = {
  discriminator: ReadonlyUint8Array;
  /** The index of the key in the player profile */
  keyIndex: number;
  /**
   * Rent Option B: the GRID / LEVEL / DEF baseline-record indices at `max(paid_clock, activation_time)`
   * (read only under an Active catalog).
   */
  rentHints: Array<number>;
};

export type FinalizeBuildingChangesInstructionDataArgs = {
  /** The index of the key in the player profile */
  keyIndex: number;
  /**
   * Rent Option B: the GRID / LEVEL / DEF baseline-record indices at `max(paid_clock, activation_time)`
   * (read only under an Active catalog).
   */
  rentHints: Array<number>;
};

export function getFinalizeBuildingChangesInstructionDataEncoder(): FixedSizeEncoder<FinalizeBuildingChangesInstructionDataArgs> {
  return transformEncoder(
    getStructEncoder([
      ['discriminator', fixEncoderSize(getBytesEncoder(), 8)],
      ['keyIndex', getU16Encoder()],
      ['rentHints', getArrayEncoder(getU32Encoder(), { size: 3 })],
    ]),
    (value) => ({
      ...value,
      discriminator: FINALIZE_BUILDING_CHANGES_DISCRIMINATOR,
    }),
  );
}

export function getFinalizeBuildingChangesInstructionDataDecoder(): FixedSizeDecoder<FinalizeBuildingChangesInstructionData> {
  return getStructDecoder([
    ['discriminator', fixDecoderSize(getBytesDecoder(), 8)],
    ['keyIndex', getU16Decoder()],
    ['rentHints', getArrayDecoder(getU32Decoder(), { size: 3 })],
  ]);
}

export function getFinalizeBuildingChangesInstructionDataCodec(): FixedSizeCodec<
  FinalizeBuildingChangesInstructionDataArgs,
  FinalizeBuildingChangesInstructionData
> {
  return combineCodec(
    getFinalizeBuildingChangesInstructionDataEncoder(),
    getFinalizeBuildingChangesInstructionDataDecoder(),
  );
}

export type FinalizeBuildingChangesAsyncInput<
  TAccountGame extends string = string,
  TAccountProfileValidationSigner extends string = string,
  TAccountProfileValidationProfile extends string = string,
  TAccountProfileValidationCertificate extends string = string,
  TAccountProfileValidationProgram extends string = string,
  TAccountCharacter extends string = string,
  TAccountClaimStakeInstance extends string = string,
  TAccountSystemAndStarbasePlayerSystem extends string = string,
  TAccountSystemAndStarbasePlayerStarbasePlayer extends string = string,
  TAccountCelestialBody extends string = string,
  TAccountCurrencyCache extends string = string,
  TAccountSystemProgram extends string = string,
  TAccountXpBudget extends string = string,
  TAccountXpBudgetConfig 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 game account */
  game: Address<TAccountGame>;
  profileValidationSigner: TransactionSigner<TAccountProfileValidationSigner>;
  profileValidationProfile: Address<TAccountProfileValidationProfile>;
  profileValidationCertificate?: Address<TAccountProfileValidationCertificate>;
  profileValidationProgram?: Address<TAccountProfileValidationProgram>;
  /** The player character */
  character?: Address<TAccountCharacter>;
  /** The claim stake instance to modify the buildings of */
  claimStakeInstance: Address<TAccountClaimStakeInstance>;
  /** The [`StarSystem`] account */
  systemAndStarbasePlayerSystem: Address<TAccountSystemAndStarbasePlayerSystem>;
  /** The [`StarbasePlayer`] Account */
  systemAndStarbasePlayerStarbasePlayer: Address<TAccountSystemAndStarbasePlayerStarbasePlayer>;
  /** The CelestialBody account containing the claim stake */
  celestialBody: Address<TAccountCelestialBody>;
  /** The currency config cache account */
  currencyCache?: Address<TAccountCurrencyCache>;
  /** The Solana System program */
  systemProgram?: Address<TAccountSystemProgram>;
  xpBudget?: Address<TAccountXpBudget>;
  xpBudgetConfig?: Address<TAccountXpBudgetConfig>;
  /**
   * Per-structure Building XP ledger (spec §5). REQUIRED by `Game.version == v1`
   * (fail closed), rejected on legacy games: finalization is an observation of the
   * structure, and the new composition only accrues once its construction completes.
   */
  xpAccrual?: Address<TAccountXpAccrual>;
  /** The game's rent-catalog PDA (REQUIRED; never created = Disabled). */
  rentCatalog: Address<TAccountRentCatalog>;
  /** The stake's settlement-authority PDA (REQUIRED; never created = never evaluated). */
  rentAuthority: Address<TAccountRentAuthority>;
  /** The stake's GRID source head (required iff the catalog is Active). */
  rentGridHead?: Address<TAccountRentGridHead>;
  /** The stake's system LEVEL source head (required iff the catalog is Active). */
  rentLevelHead?: Address<TAccountRentLevelHead>;
  /** The stake's definition DEF source head (required iff the catalog is Active). */
  rentDefHead?: Address<TAccountRentDefHead>;
  keyIndex: FinalizeBuildingChangesInstructionDataArgs['keyIndex'];
  rentHints: FinalizeBuildingChangesInstructionDataArgs['rentHints'];
  rentPages: Array<Address>;
};

export async function getFinalizeBuildingChangesInstructionAsync<
  TAccountGame extends string,
  TAccountProfileValidationSigner extends string,
  TAccountProfileValidationProfile extends string,
  TAccountProfileValidationCertificate extends string,
  TAccountProfileValidationProgram extends string,
  TAccountCharacter extends string,
  TAccountClaimStakeInstance extends string,
  TAccountSystemAndStarbasePlayerSystem extends string,
  TAccountSystemAndStarbasePlayerStarbasePlayer extends string,
  TAccountCelestialBody extends string,
  TAccountCurrencyCache extends string,
  TAccountSystemProgram extends string,
  TAccountXpBudget extends string,
  TAccountXpBudgetConfig 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: FinalizeBuildingChangesAsyncInput<
    TAccountGame,
    TAccountProfileValidationSigner,
    TAccountProfileValidationProfile,
    TAccountProfileValidationCertificate,
    TAccountProfileValidationProgram,
    TAccountCharacter,
    TAccountClaimStakeInstance,
    TAccountSystemAndStarbasePlayerSystem,
    TAccountSystemAndStarbasePlayerStarbasePlayer,
    TAccountCelestialBody,
    TAccountCurrencyCache,
    TAccountSystemProgram,
    TAccountXpBudget,
    TAccountXpBudgetConfig,
    TAccountXpAccrual,
    TAccountRentCatalog,
    TAccountRentAuthority,
    TAccountRentGridHead,
    TAccountRentLevelHead,
    TAccountRentDefHead
  >,
  config?: { programAddress?: TProgramAddress },
): Promise<
  FinalizeBuildingChangesInstruction<
    TProgramAddress,
    TAccountGame,
    TAccountProfileValidationSigner,
    TAccountProfileValidationProfile,
    TAccountProfileValidationCertificate,
    TAccountProfileValidationProgram,
    TAccountCharacter,
    TAccountClaimStakeInstance,
    TAccountSystemAndStarbasePlayerSystem,
    TAccountSystemAndStarbasePlayerStarbasePlayer,
    TAccountCelestialBody,
    TAccountCurrencyCache,
    TAccountSystemProgram,
    TAccountXpBudget,
    TAccountXpBudgetConfig,
    TAccountXpAccrual,
    TAccountRentCatalog,
    TAccountRentAuthority,
    TAccountRentGridHead,
    TAccountRentLevelHead,
    TAccountRentDefHead
  >
> {
  // Program address.
  const programAddress = config?.programAddress ?? SAGE_PROGRAM_ADDRESS;

  // Original accounts.
  const originalAccounts = {
    game: { value: input.game ?? null, isWritable: false },
    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 },
    claimStakeInstance: {
      value: input.claimStakeInstance ?? null,
      isWritable: true,
    },
    systemAndStarbasePlayerSystem: {
      value: input.systemAndStarbasePlayerSystem ?? null,
      isWritable: false,
    },
    systemAndStarbasePlayerStarbasePlayer: {
      value: input.systemAndStarbasePlayerStarbasePlayer ?? null,
      isWritable: true,
    },
    celestialBody: { value: input.celestialBody ?? null, isWritable: true },
    currencyCache: { value: input.currencyCache ?? null, isWritable: true },
    systemProgram: { value: input.systemProgram ?? null, isWritable: false },
    xpBudget: { value: input.xpBudget ?? null, isWritable: true },
    xpBudgetConfig: { value: input.xpBudgetConfig ?? 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.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.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),
        ),
      ],
    });
  }
  if (!accounts.systemProgram.value) {
    accounts.systemProgram.value =
      '11111111111111111111111111111111' as Address<'11111111111111111111111111111111'>;
  }

  // Remaining accounts.
  const remainingAccounts: AccountMeta[] = args.rentPages.map((address) => ({
    address,
    role: AccountRole.READONLY,
  }));

  const getAccountMeta = getAccountMetaFactory(programAddress, 'programId');
  return Object.freeze({
    accounts: [
      getAccountMeta('game', accounts.game),
      getAccountMeta(
        'profileValidationSigner',
        accounts.profileValidationSigner,
      ),
      getAccountMeta(
        'profileValidationProfile',
        accounts.profileValidationProfile,
      ),
      getAccountMeta(
        'profileValidationCertificate',
        accounts.profileValidationCertificate,
      ),
      getAccountMeta(
        'profileValidationProgram',
        accounts.profileValidationProgram,
      ),
      getAccountMeta('character', accounts.character),
      getAccountMeta('claimStakeInstance', accounts.claimStakeInstance),
      getAccountMeta(
        'systemAndStarbasePlayerSystem',
        accounts.systemAndStarbasePlayerSystem,
      ),
      getAccountMeta(
        'systemAndStarbasePlayerStarbasePlayer',
        accounts.systemAndStarbasePlayerStarbasePlayer,
      ),
      getAccountMeta('celestialBody', accounts.celestialBody),
      getAccountMeta('currencyCache', accounts.currencyCache),
      getAccountMeta('systemProgram', accounts.systemProgram),
      getAccountMeta('xpBudget', accounts.xpBudget),
      getAccountMeta('xpBudgetConfig', accounts.xpBudgetConfig),
      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: getFinalizeBuildingChangesInstructionDataEncoder().encode(
      args as FinalizeBuildingChangesInstructionDataArgs,
    ),
    programAddress,
  } as FinalizeBuildingChangesInstruction<
    TProgramAddress,
    TAccountGame,
    TAccountProfileValidationSigner,
    TAccountProfileValidationProfile,
    TAccountProfileValidationCertificate,
    TAccountProfileValidationProgram,
    TAccountCharacter,
    TAccountClaimStakeInstance,
    TAccountSystemAndStarbasePlayerSystem,
    TAccountSystemAndStarbasePlayerStarbasePlayer,
    TAccountCelestialBody,
    TAccountCurrencyCache,
    TAccountSystemProgram,
    TAccountXpBudget,
    TAccountXpBudgetConfig,
    TAccountXpAccrual,
    TAccountRentCatalog,
    TAccountRentAuthority,
    TAccountRentGridHead,
    TAccountRentLevelHead,
    TAccountRentDefHead
  >);
}

export type FinalizeBuildingChangesInput<
  TAccountGame extends string = string,
  TAccountProfileValidationSigner extends string = string,
  TAccountProfileValidationProfile extends string = string,
  TAccountProfileValidationCertificate extends string = string,
  TAccountProfileValidationProgram extends string = string,
  TAccountCharacter extends string = string,
  TAccountClaimStakeInstance extends string = string,
  TAccountSystemAndStarbasePlayerSystem extends string = string,
  TAccountSystemAndStarbasePlayerStarbasePlayer extends string = string,
  TAccountCelestialBody extends string = string,
  TAccountCurrencyCache extends string = string,
  TAccountSystemProgram extends string = string,
  TAccountXpBudget extends string = string,
  TAccountXpBudgetConfig 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 game account */
  game: Address<TAccountGame>;
  profileValidationSigner: TransactionSigner<TAccountProfileValidationSigner>;
  profileValidationProfile: Address<TAccountProfileValidationProfile>;
  profileValidationCertificate?: Address<TAccountProfileValidationCertificate>;
  profileValidationProgram?: Address<TAccountProfileValidationProgram>;
  /** The player character */
  character: Address<TAccountCharacter>;
  /** The claim stake instance to modify the buildings of */
  claimStakeInstance: Address<TAccountClaimStakeInstance>;
  /** The [`StarSystem`] account */
  systemAndStarbasePlayerSystem: Address<TAccountSystemAndStarbasePlayerSystem>;
  /** The [`StarbasePlayer`] Account */
  systemAndStarbasePlayerStarbasePlayer: Address<TAccountSystemAndStarbasePlayerStarbasePlayer>;
  /** The CelestialBody account containing the claim stake */
  celestialBody: Address<TAccountCelestialBody>;
  /** The currency config cache account */
  currencyCache: Address<TAccountCurrencyCache>;
  /** The Solana System program */
  systemProgram?: Address<TAccountSystemProgram>;
  xpBudget?: Address<TAccountXpBudget>;
  xpBudgetConfig?: Address<TAccountXpBudgetConfig>;
  /**
   * Per-structure Building XP ledger (spec §5). REQUIRED by `Game.version == v1`
   * (fail closed), rejected on legacy games: finalization is an observation of the
   * structure, and the new composition only accrues once its construction completes.
   */
  xpAccrual?: Address<TAccountXpAccrual>;
  /** The game's rent-catalog PDA (REQUIRED; never created = Disabled). */
  rentCatalog: Address<TAccountRentCatalog>;
  /** The stake's settlement-authority PDA (REQUIRED; never created = never evaluated). */
  rentAuthority: Address<TAccountRentAuthority>;
  /** The stake's GRID source head (required iff the catalog is Active). */
  rentGridHead?: Address<TAccountRentGridHead>;
  /** The stake's system LEVEL source head (required iff the catalog is Active). */
  rentLevelHead?: Address<TAccountRentLevelHead>;
  /** The stake's definition DEF source head (required iff the catalog is Active). */
  rentDefHead?: Address<TAccountRentDefHead>;
  keyIndex: FinalizeBuildingChangesInstructionDataArgs['keyIndex'];
  rentHints: FinalizeBuildingChangesInstructionDataArgs['rentHints'];
  rentPages: Array<Address>;
};

export function getFinalizeBuildingChangesInstruction<
  TAccountGame extends string,
  TAccountProfileValidationSigner extends string,
  TAccountProfileValidationProfile extends string,
  TAccountProfileValidationCertificate extends string,
  TAccountProfileValidationProgram extends string,
  TAccountCharacter extends string,
  TAccountClaimStakeInstance extends string,
  TAccountSystemAndStarbasePlayerSystem extends string,
  TAccountSystemAndStarbasePlayerStarbasePlayer extends string,
  TAccountCelestialBody extends string,
  TAccountCurrencyCache extends string,
  TAccountSystemProgram extends string,
  TAccountXpBudget extends string,
  TAccountXpBudgetConfig 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: FinalizeBuildingChangesInput<
    TAccountGame,
    TAccountProfileValidationSigner,
    TAccountProfileValidationProfile,
    TAccountProfileValidationCertificate,
    TAccountProfileValidationProgram,
    TAccountCharacter,
    TAccountClaimStakeInstance,
    TAccountSystemAndStarbasePlayerSystem,
    TAccountSystemAndStarbasePlayerStarbasePlayer,
    TAccountCelestialBody,
    TAccountCurrencyCache,
    TAccountSystemProgram,
    TAccountXpBudget,
    TAccountXpBudgetConfig,
    TAccountXpAccrual,
    TAccountRentCatalog,
    TAccountRentAuthority,
    TAccountRentGridHead,
    TAccountRentLevelHead,
    TAccountRentDefHead
  >,
  config?: { programAddress?: TProgramAddress },
): FinalizeBuildingChangesInstruction<
  TProgramAddress,
  TAccountGame,
  TAccountProfileValidationSigner,
  TAccountProfileValidationProfile,
  TAccountProfileValidationCertificate,
  TAccountProfileValidationProgram,
  TAccountCharacter,
  TAccountClaimStakeInstance,
  TAccountSystemAndStarbasePlayerSystem,
  TAccountSystemAndStarbasePlayerStarbasePlayer,
  TAccountCelestialBody,
  TAccountCurrencyCache,
  TAccountSystemProgram,
  TAccountXpBudget,
  TAccountXpBudgetConfig,
  TAccountXpAccrual,
  TAccountRentCatalog,
  TAccountRentAuthority,
  TAccountRentGridHead,
  TAccountRentLevelHead,
  TAccountRentDefHead
> {
  // Program address.
  const programAddress = config?.programAddress ?? SAGE_PROGRAM_ADDRESS;

  // Original accounts.
  const originalAccounts = {
    game: { value: input.game ?? null, isWritable: false },
    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 },
    claimStakeInstance: {
      value: input.claimStakeInstance ?? null,
      isWritable: true,
    },
    systemAndStarbasePlayerSystem: {
      value: input.systemAndStarbasePlayerSystem ?? null,
      isWritable: false,
    },
    systemAndStarbasePlayerStarbasePlayer: {
      value: input.systemAndStarbasePlayerStarbasePlayer ?? null,
      isWritable: true,
    },
    celestialBody: { value: input.celestialBody ?? null, isWritable: true },
    currencyCache: { value: input.currencyCache ?? null, isWritable: true },
    systemProgram: { value: input.systemProgram ?? null, isWritable: false },
    xpBudget: { value: input.xpBudget ?? null, isWritable: true },
    xpBudgetConfig: { value: input.xpBudgetConfig ?? 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.profileValidationProgram.value) {
    accounts.profileValidationProgram.value =
      'C4PRoFNroxxzdgeCoM31LJjYRg7kT6ymogSTAT99iD1u' as Address<'C4PRoFNroxxzdgeCoM31LJjYRg7kT6ymogSTAT99iD1u'>;
  }
  if (!accounts.systemProgram.value) {
    accounts.systemProgram.value =
      '11111111111111111111111111111111' as Address<'11111111111111111111111111111111'>;
  }

  // Remaining accounts.
  const remainingAccounts: AccountMeta[] = args.rentPages.map((address) => ({
    address,
    role: AccountRole.READONLY,
  }));

  const getAccountMeta = getAccountMetaFactory(programAddress, 'programId');
  return Object.freeze({
    accounts: [
      getAccountMeta('game', accounts.game),
      getAccountMeta(
        'profileValidationSigner',
        accounts.profileValidationSigner,
      ),
      getAccountMeta(
        'profileValidationProfile',
        accounts.profileValidationProfile,
      ),
      getAccountMeta(
        'profileValidationCertificate',
        accounts.profileValidationCertificate,
      ),
      getAccountMeta(
        'profileValidationProgram',
        accounts.profileValidationProgram,
      ),
      getAccountMeta('character', accounts.character),
      getAccountMeta('claimStakeInstance', accounts.claimStakeInstance),
      getAccountMeta(
        'systemAndStarbasePlayerSystem',
        accounts.systemAndStarbasePlayerSystem,
      ),
      getAccountMeta(
        'systemAndStarbasePlayerStarbasePlayer',
        accounts.systemAndStarbasePlayerStarbasePlayer,
      ),
      getAccountMeta('celestialBody', accounts.celestialBody),
      getAccountMeta('currencyCache', accounts.currencyCache),
      getAccountMeta('systemProgram', accounts.systemProgram),
      getAccountMeta('xpBudget', accounts.xpBudget),
      getAccountMeta('xpBudgetConfig', accounts.xpBudgetConfig),
      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: getFinalizeBuildingChangesInstructionDataEncoder().encode(
      args as FinalizeBuildingChangesInstructionDataArgs,
    ),
    programAddress,
  } as FinalizeBuildingChangesInstruction<
    TProgramAddress,
    TAccountGame,
    TAccountProfileValidationSigner,
    TAccountProfileValidationProfile,
    TAccountProfileValidationCertificate,
    TAccountProfileValidationProgram,
    TAccountCharacter,
    TAccountClaimStakeInstance,
    TAccountSystemAndStarbasePlayerSystem,
    TAccountSystemAndStarbasePlayerStarbasePlayer,
    TAccountCelestialBody,
    TAccountCurrencyCache,
    TAccountSystemProgram,
    TAccountXpBudget,
    TAccountXpBudgetConfig,
    TAccountXpAccrual,
    TAccountRentCatalog,
    TAccountRentAuthority,
    TAccountRentGridHead,
    TAccountRentLevelHead,
    TAccountRentDefHead
  >);
}

export type ParsedFinalizeBuildingChangesInstruction<
  TProgram extends string = typeof SAGE_PROGRAM_ADDRESS,
  TAccountMetas extends readonly AccountMeta[] = readonly AccountMeta[],
> = {
  programAddress: Address<TProgram>;
  accounts: {
    /** The game account */
    game: TAccountMetas[0];
    profileValidationSigner: TAccountMetas[1];
    profileValidationProfile: TAccountMetas[2];
    profileValidationCertificate?: TAccountMetas[3] | undefined;
    profileValidationProgram: TAccountMetas[4];
    /** The player character */
    character: TAccountMetas[5];
    /** The claim stake instance to modify the buildings of */
    claimStakeInstance: TAccountMetas[6];
    /** The [`StarSystem`] account */
    systemAndStarbasePlayerSystem: TAccountMetas[7];
    /** The [`StarbasePlayer`] Account */
    systemAndStarbasePlayerStarbasePlayer: TAccountMetas[8];
    /** The CelestialBody account containing the claim stake */
    celestialBody: TAccountMetas[9];
    /** The currency config cache account */
    currencyCache: TAccountMetas[10];
    /** The Solana System program */
    systemProgram: TAccountMetas[11];
    xpBudget?: TAccountMetas[12] | undefined;
    xpBudgetConfig?: TAccountMetas[13] | undefined;
    /**
     * Per-structure Building XP ledger (spec §5). REQUIRED by `Game.version == v1`
     * (fail closed), rejected on legacy games: finalization is an observation of the
     * structure, and the new composition only accrues once its construction completes.
     */
    xpAccrual?: TAccountMetas[14] | undefined;
    /** The game's rent-catalog PDA (REQUIRED; never created = Disabled). */
    rentCatalog: TAccountMetas[15];
    /** The stake's settlement-authority PDA (REQUIRED; never created = never evaluated). */
    rentAuthority: TAccountMetas[16];
    /** The stake's GRID source head (required iff the catalog is Active). */
    rentGridHead?: TAccountMetas[17] | undefined;
    /** The stake's system LEVEL source head (required iff the catalog is Active). */
    rentLevelHead?: TAccountMetas[18] | undefined;
    /** The stake's definition DEF source head (required iff the catalog is Active). */
    rentDefHead?: TAccountMetas[19] | undefined;
  };
  data: FinalizeBuildingChangesInstructionData;
};

export function parseFinalizeBuildingChangesInstruction<
  TProgram extends string,
  TAccountMetas extends readonly AccountMeta[],
>(
  instruction: Instruction<TProgram> &
    InstructionWithAccounts<TAccountMetas> &
    InstructionWithData<ReadonlyUint8Array>,
): ParsedFinalizeBuildingChangesInstruction<TProgram, TAccountMetas> {
  if (instruction.accounts.length < 20) {
    throw new SolanaError(
      SOLANA_ERROR__PROGRAM_CLIENTS__INSUFFICIENT_ACCOUNT_METAS,
      {
        actualAccountMetas: instruction.accounts.length,
        expectedAccountMetas: 20,
      },
    );
  }
  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: {
      game: getNextAccount(),
      profileValidationSigner: getNextAccount(),
      profileValidationProfile: getNextAccount(),
      profileValidationCertificate: getNextOptionalAccount(),
      profileValidationProgram: getNextAccount(),
      character: getNextAccount(),
      claimStakeInstance: getNextAccount(),
      systemAndStarbasePlayerSystem: getNextAccount(),
      systemAndStarbasePlayerStarbasePlayer: getNextAccount(),
      celestialBody: getNextAccount(),
      currencyCache: getNextAccount(),
      systemProgram: getNextAccount(),
      xpBudget: getNextOptionalAccount(),
      xpBudgetConfig: getNextOptionalAccount(),
      xpAccrual: getNextOptionalAccount(),
      rentCatalog: getNextAccount(),
      rentAuthority: getNextAccount(),
      rentGridHead: getNextOptionalAccount(),
      rentLevelHead: getNextOptionalAccount(),
      rentDefHead: getNextOptionalAccount(),
    },
    data: getFinalizeBuildingChangesInstructionDataDecoder().decode(
      instruction.data,
    ),
  };
}