@algorandfoundation/algokit-utils 10.0.0-alpha.8 → 10.0.0-beta.1

package/packages/algod_client/src/models/block.d.ts

@@ -4,35 +4,24 @@ import { SignedTransaction } from "../../../transact/src/transactions/signed-tra
 //#region packages/algod_client/src/models/block.d.ts
 /** BlockEvalDelta represents a TEAL value delta (block/msgpack wire keys). */
 type BlockEvalDelta = {
-  /** [at] delta action. */
-  action: number;
-  /** [bs] bytes value. */
-  bytes?: Uint8Array;
-  /** [ui] uint value. */
+  /** [at] delta action. */action: number; /** [bs] bytes value. */
+  bytes?: Uint8Array; /** [ui] uint value. */
   uint?: bigint;
 };
 /**
  * State changes from application execution, including inner transactions and logs.
  */
 type BlockAppEvalDelta = {
-  /** [gd] Global state delta for the application. */
-  globalDelta?: Map<Uint8Array, BlockEvalDelta>;
-  /** [ld] Local state deltas keyed by address index. */
-  localDeltas?: Map<number, Map<Uint8Array, BlockEvalDelta>>;
-  /** [itx] Inner transactions produced by this application execution. */
-  innerTxns?: SignedTxnWithAD[];
-  /** [sa] Shared accounts referenced by local deltas. */
-  sharedAccounts?: Address[];
-  /** [lg] Application log outputs. */
+  /** [gd] Global state delta for the application. */globalDelta?: Map<Uint8Array, BlockEvalDelta>; /** [ld] Local state deltas keyed by address index. */
+  localDeltas?: Map<number, Map<Uint8Array, BlockEvalDelta>>; /** [itx] Inner transactions produced by this application execution. */
+  innerTxns?: SignedTxnWithAD[]; /** [sa] Shared accounts referenced by local deltas. */
+  sharedAccounts?: Address[]; /** [lg] Application log outputs. */
   logs?: Uint8Array[];
 };
 /** Tracking metadata for a specific StateProofType. */
 type BlockStateProofTrackingData = {
-  /** [v] Vector commitment root of state proof voters. */
-  stateProofVotersCommitment?: Uint8Array;
-  /** [t] Online total weight during state proof round. */
-  stateProofOnlineTotalWeight?: bigint;
-  /** [n] Next round for which state proofs are accepted. */
+  /** [v] Vector commitment root of state proof voters. */stateProofVotersCommitment?: Uint8Array; /** [t] Online total weight during state proof round. */
+  stateProofOnlineTotalWeight?: bigint; /** [n] Next round for which state proofs are accepted. */
   stateProofNextRound?: bigint;
 };
 type ApplyData = {
@@ -49,9 +38,7 @@ type ApplyData = {
  * SignedTxnWithAD is a SignedTransaction with additional ApplyData.
  */
 type SignedTxnWithAD = {
-  /** The signed transaction. */
-  signedTxn: SignedTransaction;
-  /** Apply data containing transaction execution information. */
+  /** The signed transaction. */signedTxn: SignedTransaction; /** Apply data containing transaction execution information. */
   applyData?: ApplyData;
 };
 /**
@@ -63,84 +50,65 @@ type SignedTxnInBlock = {
   hasGenesisHash?: boolean;
 };
 type ParticipationUpdates = {
-  /** [partupdrmv] Expired participation accounts. */
-  expiredParticipationAccounts?: string[];
-  /** [partupdabs] Absent participation accounts. */
-  absentParticipationAccounts?: string[];
+  /** [partupdrmv] Expired participation accounts. */expiredParticipationAccounts: string[]; /** [partupdabs] Absent participation accounts. */
+  absentParticipationAccounts: string[];
 };
-type BlockHeader = {
-  /** [rnd] Round number. */
-  round?: bigint;
-  /** [prev] Previous block hash. */
-  previousBlockHash?: Uint8Array;
-  /** [prev512] Previous block hash using SHA-512. */
-  previousBlockHash512?: Uint8Array;
-  /** [seed] Sortition seed. */
-  seed?: Uint8Array;
-  /** [txn] Root of transaction merkle tree using SHA512_256. */
-  transactionsRoot?: Uint8Array;
-  /** [txn256] Root of transaction vector commitment using SHA256. */
-  transactionsRootSha256?: Uint8Array;
-  /** [txn512] Root of transaction vector commitment using SHA512. */
-  transactionsRootSha512?: Uint8Array;
-  /** [ts] Block timestamp in seconds since epoch. */
-  timestamp?: bigint;
-  /** [gen] Genesis ID. */
-  genesisId?: string;
-  /** [gh] Genesis hash. */
-  genesisHash?: Uint8Array;
-  /** [prp] Proposer address. */
-  proposer?: Address;
-  /** [fc] Fees collected in this block. */
-  feesCollected?: bigint;
-  /** [bi] Bonus incentive for block proposal. */
-  bonus?: bigint;
-  /** [pp] Proposer payout. */
-  proposerPayout?: bigint;
-  /** [fees] FeeSink address. */
-  feeSink?: Address;
-  /** [rwd] RewardsPool address. */
-  rewardsPool?: Address;
-  /** [earn] Rewards level. */
-  rewardsLevel?: bigint;
-  /** [rate] Rewards rate. */
-  rewardsRate?: bigint;
-  /** [frac] Rewards residue. */
-  rewardsResidue?: bigint;
-  /** [rwcalr] Rewards recalculation round. */
-  rewardsRecalculationRound?: bigint;
-  /** [proto] Current consensus protocol. */
-  currentProtocol?: string;
-  /** [nextproto] Next proposed protocol. */
-  nextProtocol?: string;
-  /** [nextyes] Next protocol approvals. */
-  nextProtocolApprovals?: bigint;
-  /** [nextbefore] Next protocol vote deadline. */
-  nextProtocolVoteBefore?: bigint;
-  /** [nextswitch] Next protocol switch round. */
+/** Transaction commitment hashes for the block. */
+type TxnCommitments = {
+  /** [txn] Root of transaction merkle tree using SHA512_256. */nativeSha512_256Commitment: Uint8Array; /** [txn256] Root of transaction vector commitment using SHA256. */
+  sha256Commitment?: Uint8Array; /** [txn512] Root of transaction vector commitment using SHA512. */
+  sha512Commitment?: Uint8Array;
+};
+/** Reward distribution state for the block. */
+type RewardState = {
+  /** [fees] FeeSink address. */feeSink: Address; /** [rwd] RewardsPool address. */
+  rewardsPool: Address; /** [earn] Rewards level. */
+  rewardsLevel: bigint; /** [rate] Rewards rate. */
+  rewardsRate: bigint; /** [frac] Rewards residue. */
+  rewardsResidue: bigint; /** [rwcalr] Rewards recalculation round. */
+  rewardsRecalculationRound: bigint;
+};
+/** Protocol upgrade state for the block. */
+type UpgradeState = {
+  /** [proto] Current consensus protocol. */currentProtocol: string; /** [nextproto] Next proposed protocol. */
+  nextProtocol?: string; /** [nextyes] Next protocol approvals. */
+  nextProtocolApprovals?: bigint; /** [nextbefore] Next protocol vote deadline. */
+  nextProtocolVoteBefore?: bigint; /** [nextswitch] Next protocol switch round. */
   nextProtocolSwitchOn?: bigint;
-  /** [upgradeprop] Upgrade proposal. */
-  upgradePropose?: string;
-  /** [upgradedelay] Upgrade delay in rounds. */
-  upgradeDelay?: bigint;
-  /** [upgradeyes] Upgrade approval flag. */
+};
+/** Protocol upgrade vote parameters for the block. */
+type UpgradeVote = {
+  /** [upgradeprop] Upgrade proposal. */upgradePropose?: string; /** [upgradedelay] Upgrade delay in rounds. */
+  upgradeDelay?: bigint; /** [upgradeyes] Upgrade approval flag. */
   upgradeApprove?: boolean;
-  /** [tc] Transaction counter. */
-  txnCounter?: bigint;
-  /** [spt] State proof tracking data keyed by state proof type. */
-  stateProofTracking?: Map<number, BlockStateProofTrackingData>;
-  /** Represents participation account data that needs to be checked/acted on by the network */
-  participationUpdates?: ParticipationUpdates;
+};
+type BlockHeader = {
+  /** [rnd] Round number. */round: bigint; /** [prev] Previous block hash. */
+  previousBlockHash: Uint8Array; /** [prev512] Previous block hash using SHA-512. */
+  previousBlockHash512?: Uint8Array; /** [seed] Sortition seed. */
+  seed: Uint8Array; /** Authenticates the set of transactions appearing in the block. */
+  txnCommitments: TxnCommitments; /** [ts] Block timestamp in seconds since epoch. */
+  timestamp: bigint; /** [gen] Genesis ID. */
+  genesisId: string; /** [gh] Genesis hash. */
+  genesisHash: Uint8Array; /** [prp] Proposer address. */
+  proposer?: Address; /** [fc] Fees collected in this block. */
+  feesCollected?: bigint; /** [bi] Bonus incentive for block proposal. */
+  bonus?: bigint; /** [pp] Proposer payout. */
+  proposerPayout?: bigint; /** Reward distribution state. */
+  rewardState: RewardState; /** Protocol upgrade state. */
+  upgradeState: UpgradeState; /** Protocol upgrade vote parameters. */
+  upgradeVote?: UpgradeVote; /** [tc] Transaction counter. */
+  txnCounter?: bigint; /** [spt] State proof tracking data keyed by state proof type. */
+  stateProofTracking?: Map<number, BlockStateProofTrackingData>; /** Represents participation account data that needs to be checked/acted on by the network */
+  participationUpdates: ParticipationUpdates;
 };
 /**
  * Block contains the BlockHeader and the list of transactions (Payset).
  */
 type Block = {
-  /** The block information (Header) */
-  header: BlockHeader;
-  /** [txns] Block transactions (Payset). */
-  payset?: SignedTxnInBlock[];
+  /** The block information (Header) */header: BlockHeader; /** [txns] Block transactions (Payset). */
+  payset: SignedTxnInBlock[];
 };
 //#endregion
-export { ApplyData, Block, BlockAppEvalDelta, BlockEvalDelta, BlockHeader, BlockStateProofTrackingData, ParticipationUpdates, SignedTxnInBlock, SignedTxnWithAD };
+export { ApplyData, Block, BlockAppEvalDelta, BlockEvalDelta, BlockHeader, BlockStateProofTrackingData, ParticipationUpdates, RewardState, SignedTxnInBlock, SignedTxnWithAD, TxnCommitments, UpgradeState, UpgradeVote };
 //# sourceMappingURL=block.d.ts.map

package/packages/algod_client/src/models/block.js

@@ -1,14 +1,14 @@
-const require_address = require('../../../common/src/codecs/primitives/address.js');
-const require_bigint = require('../../../common/src/codecs/primitives/bigint.js');
-const require_boolean = require('../../../common/src/codecs/primitives/boolean.js');
-const require_bytes = require('../../../common/src/codecs/primitives/bytes.js');
-const require_number = require('../../../common/src/codecs/primitives/number.js');
-const require_string = require('../../../common/src/codecs/primitives/string.js');
-const require_array = require('../../../common/src/codecs/composite/array.js');
-const require_map = require('../../../common/src/codecs/composite/map.js');
-const require_object_model = require('../../../common/src/codecs/models/object-model.js');
-const require_signed_transaction_meta = require('../../../transact/src/transactions/signed-transaction-meta.js');
-
+const require_address = require("../../../common/src/codecs/primitives/address.js");
+const require_bigint = require("../../../common/src/codecs/primitives/bigint.js");
+const require_boolean = require("../../../common/src/codecs/primitives/boolean.js");
+const require_bytes = require("../../../common/src/codecs/primitives/bytes.js");
+const require_fixed_bytes = require("../../../common/src/codecs/primitives/fixed-bytes.js");
+const require_number = require("../../../common/src/codecs/primitives/number.js");
+const require_string = require("../../../common/src/codecs/primitives/string.js");
+const require_array = require("../../../common/src/codecs/composite/array.js");
+const require_map = require("../../../common/src/codecs/composite/map.js");
+const require_object_model = require("../../../common/src/codecs/models/object-model.js");
+const require_signed_transaction_meta = require("../../../transact/src/transactions/signed-transaction-meta.js");
 //#region packages/algod_client/src/models/block.ts
 const BlockEvalDeltaMeta = {
 	name: "BlockEvalDelta",
@@ -193,143 +193,89 @@ const ParticipationUpdatesMeta = {
 	fields: [{
 		name: "expiredParticipationAccounts",
 		wireKey: "partupdrmv",
-		optional: true,
+		optional: false,
 		codec: require_array.addressArrayCodec
 	}, {
 		name: "absentParticipationAccounts",
 		wireKey: "partupdabs",
-		optional: true,
+		optional: false,
 		codec: require_array.addressArrayCodec
 	}]
 };
-const BlockHeaderMeta = {
-	name: "BlockHeader",
+const TxnCommitmentsMeta = {
+	name: "TxnCommitments",
 	kind: "object",
 	fields: [
 		{
-			name: "round",
-			wireKey: "rnd",
-			optional: true,
-			codec: require_bigint.bigIntCodec
-		},
-		{
-			name: "previousBlockHash",
-			wireKey: "prev",
-			optional: true,
-			codec: require_bytes.bytesCodec
-		},
-		{
-			name: "previousBlockHash512",
-			wireKey: "prev512",
-			optional: true,
-			codec: require_bytes.bytesCodec
-		},
-		{
-			name: "seed",
-			wireKey: "seed",
-			optional: true,
-			codec: require_bytes.bytesCodec
-		},
-		{
-			name: "transactionsRoot",
+			name: "nativeSha512_256Commitment",
 			wireKey: "txn",
 			optional: false,
-			codec: require_bytes.bytesCodec
+			codec: require_fixed_bytes.fixedBytes32Codec
 		},
 		{
-			name: "transactionsRootSha256",
+			name: "sha256Commitment",
 			wireKey: "txn256",
 			optional: true,
-			codec: require_bytes.bytesCodec
+			codec: require_fixed_bytes.fixedBytes32Codec
 		},
 		{
-			name: "transactionsRootSha512",
+			name: "sha512Commitment",
 			wireKey: "txn512",
 			optional: true,
-			codec: require_bytes.bytesCodec
-		},
-		{
-			name: "timestamp",
-			wireKey: "ts",
-			optional: true,
-			codec: require_bigint.bigIntCodec
-		},
-		{
-			name: "genesisId",
-			wireKey: "gen",
-			optional: true,
-			codec: require_string.stringCodec
-		},
-		{
-			name: "genesisHash",
-			wireKey: "gh",
-			optional: true,
-			codec: require_bytes.bytesCodec
-		},
-		{
-			name: "proposer",
-			wireKey: "prp",
-			optional: true,
-			codec: require_address.addressCodec
-		},
-		{
-			name: "feesCollected",
-			wireKey: "fc",
-			optional: true,
-			codec: require_bigint.bigIntCodec
-		},
-		{
-			name: "bonus",
-			wireKey: "bi",
-			optional: true,
-			codec: require_bigint.bigIntCodec
-		},
-		{
-			name: "proposerPayout",
-			wireKey: "pp",
-			optional: true,
-			codec: require_bigint.bigIntCodec
-		},
+			codec: require_fixed_bytes.fixedBytes64Codec
+		}
+	]
+};
+const RewardStateMeta = {
+	name: "RewardState",
+	kind: "object",
+	fields: [
 		{
 			name: "feeSink",
 			wireKey: "fees",
-			optional: true,
+			optional: false,
 			codec: require_address.addressCodec
 		},
 		{
 			name: "rewardsPool",
 			wireKey: "rwd",
-			optional: true,
+			optional: false,
 			codec: require_address.addressCodec
 		},
 		{
 			name: "rewardsLevel",
 			wireKey: "earn",
-			optional: true,
+			optional: false,
 			codec: require_bigint.bigIntCodec
 		},
 		{
 			name: "rewardsRate",
 			wireKey: "rate",
-			optional: true,
+			optional: false,
 			codec: require_bigint.bigIntCodec
 		},
 		{
 			name: "rewardsResidue",
 			wireKey: "frac",
-			optional: true,
+			optional: false,
 			codec: require_bigint.bigIntCodec
 		},
 		{
 			name: "rewardsRecalculationRound",
 			wireKey: "rwcalr",
-			optional: true,
+			optional: false,
 			codec: require_bigint.bigIntCodec
-		},
+		}
+	]
+};
+const UpgradeStateMeta = {
+	name: "UpgradeState",
+	kind: "object",
+	fields: [
 		{
 			name: "currentProtocol",
 			wireKey: "proto",
-			optional: true,
+			optional: false,
 			codec: require_string.stringCodec
 		},
 		{
@@ -355,7 +301,13 @@ const BlockHeaderMeta = {
 			wireKey: "nextswitch",
 			optional: true,
 			codec: require_bigint.bigIntCodec
-		},
+		}
+	]
+};
+const UpgradeVoteMeta = {
+	name: "UpgradeVote",
+	kind: "object",
+	fields: [
 		{
 			name: "upgradePropose",
 			wireKey: "upgradeprop",
@@ -373,24 +325,6 @@ const BlockHeaderMeta = {
 			wireKey: "upgradeyes",
 			optional: true,
 			codec: require_boolean.booleanCodec
-		},
-		{
-			name: "txnCounter",
-			wireKey: "tc",
-			optional: true,
-			codec: require_bigint.bigIntCodec
-		},
-		{
-			name: "stateProofTracking",
-			wireKey: "spt",
-			optional: true,
-			codec: new require_map.MapCodec(require_number.numberCodec, new require_object_model.ObjectModelCodec(BlockStateProofTrackingDataMeta))
-		},
-		{
-			name: "participationUpdates",
-			flattened: true,
-			optional: true,
-			codec: new require_object_model.ObjectModelCodec(ParticipationUpdatesMeta)
 		}
 	]
 };
@@ -401,15 +335,156 @@ const BlockMeta = {
 		name: "header",
 		flattened: true,
 		optional: false,
-		codec: new require_object_model.ObjectModelCodec(BlockHeaderMeta)
+		codec: new require_object_model.ObjectModelCodec({
+			name: "BlockHeader",
+			kind: "object",
+			fields: [
+				{
+					name: "round",
+					wireKey: "rnd",
+					optional: false,
+					codec: require_bigint.bigIntCodec
+				},
+				{
+					name: "previousBlockHash",
+					wireKey: "prev",
+					optional: false,
+					codec: require_fixed_bytes.fixedBytes32Codec
+				},
+				{
+					name: "previousBlockHash512",
+					wireKey: "prev512",
+					optional: true,
+					codec: require_fixed_bytes.fixedBytes64Codec
+				},
+				{
+					name: "seed",
+					wireKey: "seed",
+					optional: false,
+					codec: require_bytes.bytesCodec
+				},
+				{
+					name: "txnCommitments",
+					flattened: true,
+					optional: false,
+					codec: new require_object_model.ObjectModelCodec(TxnCommitmentsMeta)
+				},
+				{
+					name: "timestamp",
+					wireKey: "ts",
+					optional: false,
+					codec: require_bigint.bigIntCodec
+				},
+				{
+					name: "genesisId",
+					wireKey: "gen",
+					optional: false,
+					codec: require_string.stringCodec
+				},
+				{
+					name: "genesisHash",
+					wireKey: "gh",
+					optional: false,
+					codec: require_fixed_bytes.fixedBytes32Codec
+				},
+				{
+					name: "proposer",
+					wireKey: "prp",
+					optional: true,
+					codec: require_address.addressCodec
+				},
+				{
+					name: "feesCollected",
+					wireKey: "fc",
+					optional: true,
+					codec: require_bigint.bigIntCodec
+				},
+				{
+					name: "bonus",
+					wireKey: "bi",
+					optional: true,
+					codec: require_bigint.bigIntCodec
+				},
+				{
+					name: "proposerPayout",
+					wireKey: "pp",
+					optional: true,
+					codec: require_bigint.bigIntCodec
+				},
+				{
+					name: "rewardState",
+					flattened: true,
+					optional: false,
+					codec: new require_object_model.ObjectModelCodec(RewardStateMeta)
+				},
+				{
+					name: "upgradeState",
+					flattened: true,
+					optional: false,
+					codec: new require_object_model.ObjectModelCodec(UpgradeStateMeta)
+				},
+				{
+					name: "upgradeVote",
+					flattened: true,
+					optional: true,
+					codec: new require_object_model.ObjectModelCodec(UpgradeVoteMeta)
+				},
+				{
+					name: "txnCounter",
+					wireKey: "tc",
+					optional: true,
+					codec: require_bigint.bigIntCodec
+				},
+				{
+					name: "stateProofTracking",
+					wireKey: "spt",
+					optional: true,
+					codec: new require_map.MapCodec(require_number.numberCodec, new require_object_model.ObjectModelCodec(BlockStateProofTrackingDataMeta))
+				},
+				{
+					name: "participationUpdates",
+					flattened: true,
+					optional: false,
+					codec: new require_object_model.ObjectModelCodec(ParticipationUpdatesMeta)
+				}
+			]
+		})
 	}, {
 		name: "payset",
 		wireKey: "txns",
-		optional: true,
+		optional: false,
 		codec: new require_array.ArrayCodec(new require_object_model.ObjectModelCodec(SignedTxnInBlockMeta))
 	}]
 };
-
+/**
+* Custom codec for Block that populates genesis information on transactions after decoding.
+*
+* When blocks are returned from algod, transactions may not include the genesisId
+* and genesisHash fields even though they are required for correct transaction ID calculation.
+* The block contains `hasGenesisId` and `hasGenesisHash` flags that indicate whether these
+* fields should be populated from the block header.
+*
+* This codec automatically populates these fields after decoding to ensure transaction IDs
+* can be calculated correctly.
+*/
+var BlockCodec = class extends require_object_model.ObjectModelCodec {
+	constructor() {
+		super(BlockMeta);
+	}
+	fromEncoded(value, format) {
+		const block = super.fromEncoded(value, format);
+		const genesisId = block.header.genesisId;
+		const genesisHash = block.header.genesisHash;
+		for (const txnInBlock of block.payset ?? []) {
+			const txn = txnInBlock.signedTxn.signedTxn.txn;
+			if (txnInBlock.hasGenesisId && txn.genesisId === void 0) txn.genesisId = genesisId;
+			if (txnInBlock.hasGenesisHash !== false && txn.genesisHash === void 0) txn.genesisHash = genesisHash;
+		}
+		return block;
+	}
+};
+const blockCodec = new BlockCodec();
 //#endregion
-exports.BlockMeta = BlockMeta;
+exports.blockCodec = blockCodec;
+
 //# sourceMappingURL=block.js.map