@algorandfoundation/algokit-utils 9.2.0 → 10.0.0-alpha.10

package/transactions/common.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.mjs","names":[],"sources":["../../src/transactions/common.ts"],"sourcesContent":["import { SuggestedParams } from '@algorandfoundation/algokit-algod-client'\nimport { Address, ReadableAddress, getAddress, getOptionalAddress } from '@algorandfoundation/algokit-common'\nimport { AddressWithTransactionSigner, SendingAddress, TransactionSigner } from '@algorandfoundation/algokit-transact'\nimport { encodeLease } from '../transaction'\nimport { AlgoAmount } from '../types/amount'\n\n/** Common parameters for defining a transaction. */\nexport type CommonTransactionParams = {\n  /** The address sending the transaction, optionally with an attached signer. */\n  sender: SendingAddress\n  /** The function used to sign transaction(s); if not specified then\n   *  an attempt will be made to find a registered signer for the\n   *  given `sender` or use a default signer (if configured).\n   */\n  signer?: TransactionSigner | AddressWithTransactionSigner\n  /** Change the signing key of the sender to the given address.\n   *\n   * **Warning:** Please be careful with this parameter and be sure to read the [official rekey guidance](https://dev.algorand.co/concepts/accounts/rekeying).\n   */\n  rekeyTo?: ReadableAddress\n  /** Note to attach to the transaction. Max of 1000 bytes. */\n  note?: Uint8Array | string\n  /** Prevent multiple transactions with the same lease being included within the validity window.\n   *\n   * A [lease](https://dev.algorand.co/concepts/transactions/leases)\n   *  enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).\n   */\n  lease?: Uint8Array | string\n  /** The static transaction fee. In most cases you want to use `extraFee` unless setting the fee to 0 to be covered by another transaction. */\n  staticFee?: AlgoAmount\n  /** The fee to pay IN ADDITION to the suggested fee. Useful for manually covering inner transaction fees. */\n  extraFee?: AlgoAmount\n  /** Throw an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods. */\n  maxFee?: AlgoAmount\n  /** How many rounds the transaction should be valid for, if not specified then the registered default validity window will be used. */\n  validityWindow?: number | bigint\n  /**\n   * Set the first round this transaction is valid.\n   * If left undefined, the value from algod will be used.\n   *\n   * We recommend you only set this when you intentionally want this to be some time in the future.\n   */\n  firstValidRound?: bigint\n  /** The last round this transaction is valid. It is recommended to use `validityWindow` instead. */\n  lastValidRound?: bigint\n}\n\nexport type TransactionCommonData = {\n  sender: Address\n  fee?: bigint\n  firstValid: bigint\n  lastValid: bigint\n  genesisHash?: Uint8Array\n  genesisId?: string\n  note?: Uint8Array\n  rekeyTo?: Address\n  lease?: Uint8Array\n  group?: Uint8Array\n}\n\nexport const ensureString = (data?: string | Uint8Array) => {\n  if (data === undefined) return undefined\n  const encoder = new TextEncoder()\n  return typeof data === 'string' ? encoder.encode(data) : data\n}\n\nexport const buildTransactionCommonData = (\n  commonParams: CommonTransactionParams,\n  suggestedParams: SuggestedParams,\n  defaultValidityWindow: bigint,\n) => {\n  const firstValid = commonParams.firstValidRound ?? suggestedParams.firstValid\n  const lease = commonParams.lease === undefined ? undefined : encodeLease(commonParams.lease)\n  const note = ensureString(commonParams.note)\n\n  return {\n    sender: getAddress(commonParams.sender),\n    rekeyTo: getOptionalAddress(commonParams.rekeyTo),\n    note: note,\n    lease: lease,\n    fee: commonParams.staticFee?.microAlgos,\n    genesisId: suggestedParams.genesisId,\n    genesisHash: suggestedParams.genesisHash,\n    firstValid,\n    lastValid:\n      commonParams.lastValidRound ??\n      (commonParams.validityWindow !== undefined ? firstValid + BigInt(commonParams.validityWindow) : firstValid + defaultValidityWindow),\n    group: undefined,\n  } satisfies TransactionCommonData\n}\n"],"mappings":";;;;AA4DA,MAAa,gBAAgB,SAA+B;AAC1D,KAAI,SAAS,OAAW,QAAO;CAC/B,MAAM,UAAU,IAAI,aAAa;AACjC,QAAO,OAAO,SAAS,WAAW,QAAQ,OAAO,KAAK,GAAG;;AAG3D,MAAa,8BACX,cACA,iBACA,0BACG;CACH,MAAM,aAAa,aAAa,mBAAmB,gBAAgB;CACnE,MAAM,QAAQ,aAAa,UAAU,SAAY,SAAY,YAAY,aAAa,MAAM;CAC5F,MAAM,OAAO,aAAa,aAAa,KAAK;AAE5C,QAAO;EACL,QAAQ,WAAW,aAAa,OAAO;EACvC,SAAS,mBAAmB,aAAa,QAAQ;EAC3C;EACC;EACP,KAAK,aAAa,WAAW;EAC7B,WAAW,gBAAgB;EAC3B,aAAa,gBAAgB;EAC7B;EACA,WACE,aAAa,mBACZ,aAAa,mBAAmB,SAAY,aAAa,OAAO,aAAa,eAAe,GAAG,aAAa;EAC/G,OAAO;EACR"}

package/transactions/fee-coverage.js

@@ -0,0 +1,115 @@
+
+//#region src/transactions/fee-coverage.ts
+let FeeDeltaType = /* @__PURE__ */ function(FeeDeltaType$1) {
+	FeeDeltaType$1[FeeDeltaType$1["Deficit"] = 0] = "Deficit";
+	FeeDeltaType$1[FeeDeltaType$1["Surplus"] = 1] = "Surplus";
+	return FeeDeltaType$1;
+}({});
+const FeeDelta = {
+	fromBigInt(value) {
+		if (value > 0n) return {
+			type: FeeDeltaType.Deficit,
+			data: value
+		};
+		else if (value < 0n) return {
+			type: FeeDeltaType.Surplus,
+			data: -value
+		};
+	},
+	toBigInt(delta) {
+		return delta.type === FeeDeltaType.Deficit ? delta.data : -delta.data;
+	},
+	isDeficit(delta) {
+		return delta.type === FeeDeltaType.Deficit;
+	},
+	isSurplus(delta) {
+		return delta.type === FeeDeltaType.Surplus;
+	},
+	amount(delta) {
+		return delta.data;
+	},
+	add(lhs, rhs) {
+		return FeeDelta.fromBigInt(FeeDelta.toBigInt(lhs) + FeeDelta.toBigInt(rhs));
+	}
+};
+var CoveredPriority = class CoveredPriority {
+	getPriorityType() {
+		return 0;
+	}
+	getDeficitAmount() {
+		return 0n;
+	}
+	compare(other) {
+		const typeDiff = this.getPriorityType() - other.getPriorityType();
+		if (typeDiff !== 0) return typeDiff;
+		return 0;
+	}
+	equals(other) {
+		return other instanceof CoveredPriority;
+	}
+};
+var ModifiableDeficitPriority = class ModifiableDeficitPriority {
+	constructor(deficit) {
+		this.deficit = deficit;
+	}
+	getPriorityType() {
+		return 1;
+	}
+	getDeficitAmount() {
+		return this.deficit;
+	}
+	compare(other) {
+		const typeDiff = this.getPriorityType() - other.getPriorityType();
+		if (typeDiff !== 0) return typeDiff;
+		if (other instanceof ModifiableDeficitPriority) return Number(this.deficit - other.deficit);
+		return 0;
+	}
+	equals(other) {
+		return other instanceof ModifiableDeficitPriority && this.deficit === other.deficit;
+	}
+};
+var ImmutableDeficitPriority = class ImmutableDeficitPriority {
+	constructor(deficit) {
+		this.deficit = deficit;
+	}
+	getPriorityType() {
+		return 2;
+	}
+	getDeficitAmount() {
+		return this.deficit;
+	}
+	compare(other) {
+		const typeDiff = this.getPriorityType() - other.getPriorityType();
+		if (typeDiff !== 0) return typeDiff;
+		if (other instanceof ImmutableDeficitPriority) return Number(this.deficit - other.deficit);
+		return 0;
+	}
+	equals(other) {
+		return other instanceof ImmutableDeficitPriority && this.deficit === other.deficit;
+	}
+};
+const FeePriority = {
+	Covered: new CoveredPriority(),
+	ModifiableDeficit(deficit) {
+		return new ModifiableDeficitPriority(deficit);
+	},
+	ImmutableDeficit(deficit) {
+		return new ImmutableDeficitPriority(deficit);
+	}
+};
+function calculateInnerFeeDelta(innerTransactions, minTransactionFee = 1000n, acc) {
+	if (!innerTransactions) return acc;
+	return innerTransactions.reduceRight((acc$1, innerTxn) => {
+		const recursiveDelta = calculateInnerFeeDelta(innerTxn.innerTxns, minTransactionFee, acc$1);
+		const txnFeeDelta = FeeDelta.fromBigInt(minTransactionFee - (innerTxn.txn.txn.fee ?? 0n));
+		const currentFeeDelta = FeeDelta.fromBigInt((recursiveDelta ? FeeDelta.toBigInt(recursiveDelta) : 0n) + (txnFeeDelta ? FeeDelta.toBigInt(txnFeeDelta) : 0n));
+		if (currentFeeDelta && FeeDelta.isSurplus(currentFeeDelta)) return;
+		return currentFeeDelta;
+	}, acc);
+}
+
+//#endregion
+exports.FeeDelta = FeeDelta;
+exports.FeePriority = FeePriority;
+exports.calculateInnerFeeDelta = calculateInnerFeeDelta;
+//# sourceMappingURL=fee-coverage.js.map

package/transactions/fee-coverage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fee-coverage.js","names":["deficit: bigint","acc"],"sources":["../../src/transactions/fee-coverage.ts"],"sourcesContent":["import { PendingTransactionResponse } from '@algorandfoundation/algokit-algod-client'\n\nexport enum FeeDeltaType {\n  Deficit,\n  Surplus,\n}\n\nexport type DeficitFeeDelta = {\n  type: FeeDeltaType.Deficit\n  data: bigint\n}\n\nexport type SurplusFeeDelta = {\n  type: FeeDeltaType.Surplus\n  data: bigint\n}\n\nexport type FeeDelta = DeficitFeeDelta | SurplusFeeDelta\nexport const FeeDelta = {\n  fromBigInt(value: bigint): FeeDelta | undefined {\n    if (value > 0n) {\n      return { type: FeeDeltaType.Deficit, data: value }\n    } else if (value < 0n) {\n      return { type: FeeDeltaType.Surplus, data: -value }\n    }\n    return undefined\n  },\n  toBigInt(delta: FeeDelta): bigint {\n    return delta.type === FeeDeltaType.Deficit ? delta.data : -delta.data\n  },\n  isDeficit(delta: FeeDelta): boolean {\n    return delta.type === FeeDeltaType.Deficit\n  },\n  isSurplus(delta: FeeDelta): boolean {\n    return delta.type === FeeDeltaType.Surplus\n  },\n  amount(delta: FeeDelta): bigint {\n    return delta.data\n  },\n  add(lhs: FeeDelta, rhs: FeeDelta): FeeDelta | undefined {\n    return FeeDelta.fromBigInt(FeeDelta.toBigInt(lhs) + FeeDelta.toBigInt(rhs))\n  },\n}\n\nclass CoveredPriority {\n  getPriorityType(): number {\n    return 0\n  }\n\n  getDeficitAmount(): bigint {\n    return 0n\n  }\n\n  compare(other: FeePriority): number {\n    const typeDiff = this.getPriorityType() - other.getPriorityType()\n    if (typeDiff !== 0) {\n      return typeDiff\n    }\n    // For same type (which can only be Covered), they're equal\n    return 0\n  }\n\n  equals(other: FeePriority): boolean {\n    return other instanceof CoveredPriority\n  }\n}\n\nclass ModifiableDeficitPriority {\n  constructor(public readonly deficit: bigint) {}\n\n  getPriorityType(): number {\n    return 1\n  }\n\n  getDeficitAmount(): bigint {\n    return this.deficit\n  }\n\n  compare(other: FeePriority): number {\n    const typeDiff = this.getPriorityType() - other.getPriorityType()\n    if (typeDiff !== 0) {\n      return typeDiff\n    }\n    // For same type, compare deficit amounts (larger deficit = higher priority)\n    if (other instanceof ModifiableDeficitPriority) {\n      return Number(this.deficit - other.deficit)\n    }\n    return 0\n  }\n\n  equals(other: FeePriority): boolean {\n    return other instanceof ModifiableDeficitPriority && this.deficit === other.deficit\n  }\n}\n\nclass ImmutableDeficitPriority {\n  constructor(public readonly deficit: bigint) {}\n\n  getPriorityType(): number {\n    return 2\n  }\n\n  getDeficitAmount(): bigint {\n    return this.deficit\n  }\n\n  compare(other: FeePriority): number {\n    const typeDiff = this.getPriorityType() - other.getPriorityType()\n    if (typeDiff !== 0) {\n      return typeDiff\n    }\n    // For same type, compare deficit amounts (larger deficit = higher priority)\n    if (other instanceof ImmutableDeficitPriority) {\n      return Number(this.deficit - other.deficit)\n    }\n    return 0\n  }\n\n  equals(other: FeePriority): boolean {\n    return other instanceof ImmutableDeficitPriority && this.deficit === other.deficit\n  }\n}\n\n// Priority levels for fee coverage with deficit amounts\n// ImmutableDeficit > ModifiableDeficit > Covered\n// Within same priority type, larger deficits have higher priority\nexport type FeePriority = CoveredPriority | ModifiableDeficitPriority | ImmutableDeficitPriority\nexport const FeePriority = {\n  Covered: new CoveredPriority(),\n  ModifiableDeficit(deficit: bigint): ModifiableDeficitPriority {\n    return new ModifiableDeficitPriority(deficit)\n  },\n  ImmutableDeficit(deficit: bigint): ImmutableDeficitPriority {\n    return new ImmutableDeficitPriority(deficit)\n  },\n} as const\n\nexport function calculateInnerFeeDelta(\n  innerTransactions?: PendingTransactionResponse[],\n  minTransactionFee: bigint = 1000n,\n  acc?: FeeDelta,\n): FeeDelta | undefined {\n  if (!innerTransactions) {\n    return acc\n  }\n\n  // Surplus inner transaction fees do not pool up to the parent transaction.\n  // Additionally surplus inner transaction fees only pool from sibling transactions\n  // that are sent prior to a given inner transaction, hence why we iterate in reverse order.\n  return innerTransactions.reduceRight((acc, innerTxn) => {\n    const recursiveDelta = calculateInnerFeeDelta(innerTxn.innerTxns, minTransactionFee, acc)\n\n    // Inner transactions don't require per byte fees\n    const txnFeeDelta = FeeDelta.fromBigInt(minTransactionFee - (innerTxn.txn.txn.fee ?? 0n))\n\n    const currentFeeDelta = FeeDelta.fromBigInt(\n      (recursiveDelta ? FeeDelta.toBigInt(recursiveDelta) : 0n) + (txnFeeDelta ? FeeDelta.toBigInt(txnFeeDelta) : 0n),\n    )\n\n    // If after the recursive inner fee calculations we have a surplus,\n    // return undefined to avoid pooling up surplus fees, which is not allowed.\n    if (currentFeeDelta && FeeDelta.isSurplus(currentFeeDelta)) {\n      return undefined\n    }\n\n    return currentFeeDelta\n  }, acc)\n}\n"],"mappings":";;AAEA,IAAY,wDAAL;AACL;AACA;;;AAcF,MAAa,WAAW;CACtB,WAAW,OAAqC;AAC9C,MAAI,QAAQ,GACV,QAAO;GAAE,MAAM,aAAa;GAAS,MAAM;GAAO;WACzC,QAAQ,GACjB,QAAO;GAAE,MAAM,aAAa;GAAS,MAAM,CAAC;GAAO;;CAIvD,SAAS,OAAyB;AAChC,SAAO,MAAM,SAAS,aAAa,UAAU,MAAM,OAAO,CAAC,MAAM;;CAEnE,UAAU,OAA0B;AAClC,SAAO,MAAM,SAAS,aAAa;;CAErC,UAAU,OAA0B;AAClC,SAAO,MAAM,SAAS,aAAa;;CAErC,OAAO,OAAyB;AAC9B,SAAO,MAAM;;CAEf,IAAI,KAAe,KAAqC;AACtD,SAAO,SAAS,WAAW,SAAS,SAAS,IAAI,GAAG,SAAS,SAAS,IAAI,CAAC;;CAE9E;AAED,IAAM,kBAAN,MAAM,gBAAgB;CACpB,kBAA0B;AACxB,SAAO;;CAGT,mBAA2B;AACzB,SAAO;;CAGT,QAAQ,OAA4B;EAClC,MAAM,WAAW,KAAK,iBAAiB,GAAG,MAAM,iBAAiB;AACjE,MAAI,aAAa,EACf,QAAO;AAGT,SAAO;;CAGT,OAAO,OAA6B;AAClC,SAAO,iBAAiB;;;AAI5B,IAAM,4BAAN,MAAM,0BAA0B;CAC9B,YAAY,AAAgBA,SAAiB;EAAjB;;CAE5B,kBAA0B;AACxB,SAAO;;CAGT,mBAA2B;AACzB,SAAO,KAAK;;CAGd,QAAQ,OAA4B;EAClC,MAAM,WAAW,KAAK,iBAAiB,GAAG,MAAM,iBAAiB;AACjE,MAAI,aAAa,EACf,QAAO;AAGT,MAAI,iBAAiB,0BACnB,QAAO,OAAO,KAAK,UAAU,MAAM,QAAQ;AAE7C,SAAO;;CAGT,OAAO,OAA6B;AAClC,SAAO,iBAAiB,6BAA6B,KAAK,YAAY,MAAM;;;AAIhF,IAAM,2BAAN,MAAM,yBAAyB;CAC7B,YAAY,AAAgBA,SAAiB;EAAjB;;CAE5B,kBAA0B;AACxB,SAAO;;CAGT,mBAA2B;AACzB,SAAO,KAAK;;CAGd,QAAQ,OAA4B;EAClC,MAAM,WAAW,KAAK,iBAAiB,GAAG,MAAM,iBAAiB;AACjE,MAAI,aAAa,EACf,QAAO;AAGT,MAAI,iBAAiB,yBACnB,QAAO,OAAO,KAAK,UAAU,MAAM,QAAQ;AAE7C,SAAO;;CAGT,OAAO,OAA6B;AAClC,SAAO,iBAAiB,4BAA4B,KAAK,YAAY,MAAM;;;AAQ/E,MAAa,cAAc;CACzB,SAAS,IAAI,iBAAiB;CAC9B,kBAAkB,SAA4C;AAC5D,SAAO,IAAI,0BAA0B,QAAQ;;CAE/C,iBAAiB,SAA2C;AAC1D,SAAO,IAAI,yBAAyB,QAAQ;;CAE/C;AAED,SAAgB,uBACd,mBACA,oBAA4B,OAC5B,KACsB;AACtB,KAAI,CAAC,kBACH,QAAO;AAMT,QAAO,kBAAkB,aAAa,OAAK,aAAa;EACtD,MAAM,iBAAiB,uBAAuB,SAAS,WAAW,mBAAmBC,MAAI;EAGzF,MAAM,cAAc,SAAS,WAAW,qBAAqB,SAAS,IAAI,IAAI,OAAO,IAAI;EAEzF,MAAM,kBAAkB,SAAS,YAC9B,iBAAiB,SAAS,SAAS,eAAe,GAAG,OAAO,cAAc,SAAS,SAAS,YAAY,GAAG,IAC7G;AAID,MAAI,mBAAmB,SAAS,UAAU,gBAAgB,CACxD;AAGF,SAAO;IACN,IAAI"}

package/transactions/fee-coverage.mjs

@@ -0,0 +1,112 @@
+//#region src/transactions/fee-coverage.ts
+let FeeDeltaType = /* @__PURE__ */ function(FeeDeltaType$1) {
+	FeeDeltaType$1[FeeDeltaType$1["Deficit"] = 0] = "Deficit";
+	FeeDeltaType$1[FeeDeltaType$1["Surplus"] = 1] = "Surplus";
+	return FeeDeltaType$1;
+}({});
+const FeeDelta = {
+	fromBigInt(value) {
+		if (value > 0n) return {
+			type: FeeDeltaType.Deficit,
+			data: value
+		};
+		else if (value < 0n) return {
+			type: FeeDeltaType.Surplus,
+			data: -value
+		};
+	},
+	toBigInt(delta) {
+		return delta.type === FeeDeltaType.Deficit ? delta.data : -delta.data;
+	},
+	isDeficit(delta) {
+		return delta.type === FeeDeltaType.Deficit;
+	},
+	isSurplus(delta) {
+		return delta.type === FeeDeltaType.Surplus;
+	},
+	amount(delta) {
+		return delta.data;
+	},
+	add(lhs, rhs) {
+		return FeeDelta.fromBigInt(FeeDelta.toBigInt(lhs) + FeeDelta.toBigInt(rhs));
+	}
+};
+var CoveredPriority = class CoveredPriority {
+	getPriorityType() {
+		return 0;
+	}
+	getDeficitAmount() {
+		return 0n;
+	}
+	compare(other) {
+		const typeDiff = this.getPriorityType() - other.getPriorityType();
+		if (typeDiff !== 0) return typeDiff;
+		return 0;
+	}
+	equals(other) {
+		return other instanceof CoveredPriority;
+	}
+};
+var ModifiableDeficitPriority = class ModifiableDeficitPriority {
+	constructor(deficit) {
+		this.deficit = deficit;
+	}
+	getPriorityType() {
+		return 1;
+	}
+	getDeficitAmount() {
+		return this.deficit;
+	}
+	compare(other) {
+		const typeDiff = this.getPriorityType() - other.getPriorityType();
+		if (typeDiff !== 0) return typeDiff;
+		if (other instanceof ModifiableDeficitPriority) return Number(this.deficit - other.deficit);
+		return 0;
+	}
+	equals(other) {
+		return other instanceof ModifiableDeficitPriority && this.deficit === other.deficit;
+	}
+};
+var ImmutableDeficitPriority = class ImmutableDeficitPriority {
+	constructor(deficit) {
+		this.deficit = deficit;
+	}
+	getPriorityType() {
+		return 2;
+	}
+	getDeficitAmount() {
+		return this.deficit;
+	}
+	compare(other) {
+		const typeDiff = this.getPriorityType() - other.getPriorityType();
+		if (typeDiff !== 0) return typeDiff;
+		if (other instanceof ImmutableDeficitPriority) return Number(this.deficit - other.deficit);
+		return 0;
+	}
+	equals(other) {
+		return other instanceof ImmutableDeficitPriority && this.deficit === other.deficit;
+	}
+};
+const FeePriority = {
+	Covered: new CoveredPriority(),
+	ModifiableDeficit(deficit) {
+		return new ModifiableDeficitPriority(deficit);
+	},
+	ImmutableDeficit(deficit) {
+		return new ImmutableDeficitPriority(deficit);
+	}
+};
+function calculateInnerFeeDelta(innerTransactions, minTransactionFee = 1000n, acc) {
+	if (!innerTransactions) return acc;
+	return innerTransactions.reduceRight((acc$1, innerTxn) => {
+		const recursiveDelta = calculateInnerFeeDelta(innerTxn.innerTxns, minTransactionFee, acc$1);
+		const txnFeeDelta = FeeDelta.fromBigInt(minTransactionFee - (innerTxn.txn.txn.fee ?? 0n));
+		const currentFeeDelta = FeeDelta.fromBigInt((recursiveDelta ? FeeDelta.toBigInt(recursiveDelta) : 0n) + (txnFeeDelta ? FeeDelta.toBigInt(txnFeeDelta) : 0n));
+		if (currentFeeDelta && FeeDelta.isSurplus(currentFeeDelta)) return;
+		return currentFeeDelta;
+	}, acc);
+}
+
+//#endregion
+export { FeeDelta, FeePriority, calculateInnerFeeDelta };
+//# sourceMappingURL=fee-coverage.mjs.map

package/transactions/fee-coverage.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"fee-coverage.mjs","names":["deficit: bigint","acc"],"sources":["../../src/transactions/fee-coverage.ts"],"sourcesContent":["import { PendingTransactionResponse } from '@algorandfoundation/algokit-algod-client'\n\nexport enum FeeDeltaType {\n  Deficit,\n  Surplus,\n}\n\nexport type DeficitFeeDelta = {\n  type: FeeDeltaType.Deficit\n  data: bigint\n}\n\nexport type SurplusFeeDelta = {\n  type: FeeDeltaType.Surplus\n  data: bigint\n}\n\nexport type FeeDelta = DeficitFeeDelta | SurplusFeeDelta\nexport const FeeDelta = {\n  fromBigInt(value: bigint): FeeDelta | undefined {\n    if (value > 0n) {\n      return { type: FeeDeltaType.Deficit, data: value }\n    } else if (value < 0n) {\n      return { type: FeeDeltaType.Surplus, data: -value }\n    }\n    return undefined\n  },\n  toBigInt(delta: FeeDelta): bigint {\n    return delta.type === FeeDeltaType.Deficit ? delta.data : -delta.data\n  },\n  isDeficit(delta: FeeDelta): boolean {\n    return delta.type === FeeDeltaType.Deficit\n  },\n  isSurplus(delta: FeeDelta): boolean {\n    return delta.type === FeeDeltaType.Surplus\n  },\n  amount(delta: FeeDelta): bigint {\n    return delta.data\n  },\n  add(lhs: FeeDelta, rhs: FeeDelta): FeeDelta | undefined {\n    return FeeDelta.fromBigInt(FeeDelta.toBigInt(lhs) + FeeDelta.toBigInt(rhs))\n  },\n}\n\nclass CoveredPriority {\n  getPriorityType(): number {\n    return 0\n  }\n\n  getDeficitAmount(): bigint {\n    return 0n\n  }\n\n  compare(other: FeePriority): number {\n    const typeDiff = this.getPriorityType() - other.getPriorityType()\n    if (typeDiff !== 0) {\n      return typeDiff\n    }\n    // For same type (which can only be Covered), they're equal\n    return 0\n  }\n\n  equals(other: FeePriority): boolean {\n    return other instanceof CoveredPriority\n  }\n}\n\nclass ModifiableDeficitPriority {\n  constructor(public readonly deficit: bigint) {}\n\n  getPriorityType(): number {\n    return 1\n  }\n\n  getDeficitAmount(): bigint {\n    return this.deficit\n  }\n\n  compare(other: FeePriority): number {\n    const typeDiff = this.getPriorityType() - other.getPriorityType()\n    if (typeDiff !== 0) {\n      return typeDiff\n    }\n    // For same type, compare deficit amounts (larger deficit = higher priority)\n    if (other instanceof ModifiableDeficitPriority) {\n      return Number(this.deficit - other.deficit)\n    }\n    return 0\n  }\n\n  equals(other: FeePriority): boolean {\n    return other instanceof ModifiableDeficitPriority && this.deficit === other.deficit\n  }\n}\n\nclass ImmutableDeficitPriority {\n  constructor(public readonly deficit: bigint) {}\n\n  getPriorityType(): number {\n    return 2\n  }\n\n  getDeficitAmount(): bigint {\n    return this.deficit\n  }\n\n  compare(other: FeePriority): number {\n    const typeDiff = this.getPriorityType() - other.getPriorityType()\n    if (typeDiff !== 0) {\n      return typeDiff\n    }\n    // For same type, compare deficit amounts (larger deficit = higher priority)\n    if (other instanceof ImmutableDeficitPriority) {\n      return Number(this.deficit - other.deficit)\n    }\n    return 0\n  }\n\n  equals(other: FeePriority): boolean {\n    return other instanceof ImmutableDeficitPriority && this.deficit === other.deficit\n  }\n}\n\n// Priority levels for fee coverage with deficit amounts\n// ImmutableDeficit > ModifiableDeficit > Covered\n// Within same priority type, larger deficits have higher priority\nexport type FeePriority = CoveredPriority | ModifiableDeficitPriority | ImmutableDeficitPriority\nexport const FeePriority = {\n  Covered: new CoveredPriority(),\n  ModifiableDeficit(deficit: bigint): ModifiableDeficitPriority {\n    return new ModifiableDeficitPriority(deficit)\n  },\n  ImmutableDeficit(deficit: bigint): ImmutableDeficitPriority {\n    return new ImmutableDeficitPriority(deficit)\n  },\n} as const\n\nexport function calculateInnerFeeDelta(\n  innerTransactions?: PendingTransactionResponse[],\n  minTransactionFee: bigint = 1000n,\n  acc?: FeeDelta,\n): FeeDelta | undefined {\n  if (!innerTransactions) {\n    return acc\n  }\n\n  // Surplus inner transaction fees do not pool up to the parent transaction.\n  // Additionally surplus inner transaction fees only pool from sibling transactions\n  // that are sent prior to a given inner transaction, hence why we iterate in reverse order.\n  return innerTransactions.reduceRight((acc, innerTxn) => {\n    const recursiveDelta = calculateInnerFeeDelta(innerTxn.innerTxns, minTransactionFee, acc)\n\n    // Inner transactions don't require per byte fees\n    const txnFeeDelta = FeeDelta.fromBigInt(minTransactionFee - (innerTxn.txn.txn.fee ?? 0n))\n\n    const currentFeeDelta = FeeDelta.fromBigInt(\n      (recursiveDelta ? FeeDelta.toBigInt(recursiveDelta) : 0n) + (txnFeeDelta ? FeeDelta.toBigInt(txnFeeDelta) : 0n),\n    )\n\n    // If after the recursive inner fee calculations we have a surplus,\n    // return undefined to avoid pooling up surplus fees, which is not allowed.\n    if (currentFeeDelta && FeeDelta.isSurplus(currentFeeDelta)) {\n      return undefined\n    }\n\n    return currentFeeDelta\n  }, acc)\n}\n"],"mappings":";AAEA,IAAY,wDAAL;AACL;AACA;;;AAcF,MAAa,WAAW;CACtB,WAAW,OAAqC;AAC9C,MAAI,QAAQ,GACV,QAAO;GAAE,MAAM,aAAa;GAAS,MAAM;GAAO;WACzC,QAAQ,GACjB,QAAO;GAAE,MAAM,aAAa;GAAS,MAAM,CAAC;GAAO;;CAIvD,SAAS,OAAyB;AAChC,SAAO,MAAM,SAAS,aAAa,UAAU,MAAM,OAAO,CAAC,MAAM;;CAEnE,UAAU,OAA0B;AAClC,SAAO,MAAM,SAAS,aAAa;;CAErC,UAAU,OAA0B;AAClC,SAAO,MAAM,SAAS,aAAa;;CAErC,OAAO,OAAyB;AAC9B,SAAO,MAAM;;CAEf,IAAI,KAAe,KAAqC;AACtD,SAAO,SAAS,WAAW,SAAS,SAAS,IAAI,GAAG,SAAS,SAAS,IAAI,CAAC;;CAE9E;AAED,IAAM,kBAAN,MAAM,gBAAgB;CACpB,kBAA0B;AACxB,SAAO;;CAGT,mBAA2B;AACzB,SAAO;;CAGT,QAAQ,OAA4B;EAClC,MAAM,WAAW,KAAK,iBAAiB,GAAG,MAAM,iBAAiB;AACjE,MAAI,aAAa,EACf,QAAO;AAGT,SAAO;;CAGT,OAAO,OAA6B;AAClC,SAAO,iBAAiB;;;AAI5B,IAAM,4BAAN,MAAM,0BAA0B;CAC9B,YAAY,AAAgBA,SAAiB;EAAjB;;CAE5B,kBAA0B;AACxB,SAAO;;CAGT,mBAA2B;AACzB,SAAO,KAAK;;CAGd,QAAQ,OAA4B;EAClC,MAAM,WAAW,KAAK,iBAAiB,GAAG,MAAM,iBAAiB;AACjE,MAAI,aAAa,EACf,QAAO;AAGT,MAAI,iBAAiB,0BACnB,QAAO,OAAO,KAAK,UAAU,MAAM,QAAQ;AAE7C,SAAO;;CAGT,OAAO,OAA6B;AAClC,SAAO,iBAAiB,6BAA6B,KAAK,YAAY,MAAM;;;AAIhF,IAAM,2BAAN,MAAM,yBAAyB;CAC7B,YAAY,AAAgBA,SAAiB;EAAjB;;CAE5B,kBAA0B;AACxB,SAAO;;CAGT,mBAA2B;AACzB,SAAO,KAAK;;CAGd,QAAQ,OAA4B;EAClC,MAAM,WAAW,KAAK,iBAAiB,GAAG,MAAM,iBAAiB;AACjE,MAAI,aAAa,EACf,QAAO;AAGT,MAAI,iBAAiB,yBACnB,QAAO,OAAO,KAAK,UAAU,MAAM,QAAQ;AAE7C,SAAO;;CAGT,OAAO,OAA6B;AAClC,SAAO,iBAAiB,4BAA4B,KAAK,YAAY,MAAM;;;AAQ/E,MAAa,cAAc;CACzB,SAAS,IAAI,iBAAiB;CAC9B,kBAAkB,SAA4C;AAC5D,SAAO,IAAI,0BAA0B,QAAQ;;CAE/C,iBAAiB,SAA2C;AAC1D,SAAO,IAAI,yBAAyB,QAAQ;;CAE/C;AAED,SAAgB,uBACd,mBACA,oBAA4B,OAC5B,KACsB;AACtB,KAAI,CAAC,kBACH,QAAO;AAMT,QAAO,kBAAkB,aAAa,OAAK,aAAa;EACtD,MAAM,iBAAiB,uBAAuB,SAAS,WAAW,mBAAmBC,MAAI;EAGzF,MAAM,cAAc,SAAS,WAAW,qBAAqB,SAAS,IAAI,IAAI,OAAO,IAAI;EAEzF,MAAM,kBAAkB,SAAS,YAC9B,iBAAiB,SAAS,SAAS,eAAe,GAAG,OAAO,cAAc,SAAS,SAAS,YAAY,GAAG,IAC7G;AAID,MAAI,mBAAmB,SAAS,UAAU,gBAAgB,CACxD;AAGF,SAAO;IACN,IAAI"}

package/transactions/key-registration.d.ts

@@ -0,0 +1,27 @@
+import { CommonTransactionParams } from "./common.js";
+
+//#region src/transactions/key-registration.d.ts
+
+/** Parameters to define an online key registration transaction. */
+type OnlineKeyRegistrationParams = CommonTransactionParams & {
+  /** The root participation public key */
+  voteKey: Uint8Array;
+  /** The VRF public key */
+  selectionKey: Uint8Array;
+  /** The first round that the participation key is valid. Not to be confused with the `firstValid` round of the keyreg transaction */
+  voteFirst: bigint;
+  /** The last round that the participation key is valid. Not to be confused with the `lastValid` round of the keyreg transaction */
+  voteLast: bigint;
+  /** This is the dilution for the 2-level participation key. It determines the interval (number of rounds) for generating new ephemeral keys */
+  voteKeyDilution: bigint;
+  /** The 64 byte state proof public key commitment */
+  stateProofKey?: Uint8Array;
+};
+/** Parameters to define an offline key registration transaction. */
+type OfflineKeyRegistrationParams = CommonTransactionParams & {
+  /** Prevent this account from ever participating again. The account will also no longer earn rewards */
+  preventAccountFromEverParticipatingAgain?: boolean;
+};
+//#endregion
+export { OfflineKeyRegistrationParams, OnlineKeyRegistrationParams };
+//# sourceMappingURL=key-registration.d.ts.map

package/transactions/key-registration.js

@@ -0,0 +1,30 @@
+const require_transaction_type = require('../packages/transact/src/transactions/transaction-type.js');
+const require_transaction = require('../packages/transact/src/transactions/transaction.js');
+const require_common = require('./common.js');
+
+//#region src/transactions/key-registration.ts
+const buildKeyReg = (params, suggestedParams, defaultValidityWindow) => {
+	const commonData = require_common.buildTransactionCommonData(params, suggestedParams, defaultValidityWindow);
+	if ("voteKey" in params) return new require_transaction.Transaction({
+		...commonData,
+		type: require_transaction_type.TransactionType.KeyRegistration,
+		keyRegistration: {
+			voteKey: params.voteKey,
+			selectionKey: params.selectionKey,
+			voteFirst: params.voteFirst,
+			voteLast: params.voteLast,
+			voteKeyDilution: params.voteKeyDilution,
+			nonParticipation: false,
+			stateProofKey: params.stateProofKey
+		}
+	});
+	else return new require_transaction.Transaction({
+		...commonData,
+		type: require_transaction_type.TransactionType.KeyRegistration,
+		keyRegistration: { nonParticipation: params.preventAccountFromEverParticipatingAgain }
+	});
+};
+
+//#endregion
+exports.buildKeyReg = buildKeyReg;
+//# sourceMappingURL=key-registration.js.map

package/transactions/key-registration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"key-registration.js","names":["buildTransactionCommonData","Transaction","TransactionType"],"sources":["../../src/transactions/key-registration.ts"],"sourcesContent":["import { SuggestedParams } from '@algorandfoundation/algokit-algod-client'\nimport { Transaction, TransactionType } from '@algorandfoundation/algokit-transact'\nimport { CommonTransactionParams, buildTransactionCommonData } from './common'\n\n/** Parameters to define an online key registration transaction. */\nexport type OnlineKeyRegistrationParams = CommonTransactionParams & {\n  /** The root participation public key */\n  voteKey: Uint8Array\n  /** The VRF public key */\n  selectionKey: Uint8Array\n  /** The first round that the participation key is valid. Not to be confused with the `firstValid` round of the keyreg transaction */\n  voteFirst: bigint\n  /** The last round that the participation key is valid. Not to be confused with the `lastValid` round of the keyreg transaction */\n  voteLast: bigint\n  /** This is the dilution for the 2-level participation key. It determines the interval (number of rounds) for generating new ephemeral keys */\n  voteKeyDilution: bigint\n  /** The 64 byte state proof public key commitment */\n  stateProofKey?: Uint8Array\n}\n\n/** Parameters to define an offline key registration transaction. */\nexport type OfflineKeyRegistrationParams = CommonTransactionParams & {\n  /** Prevent this account from ever participating again. The account will also no longer earn rewards */\n  preventAccountFromEverParticipatingAgain?: boolean\n}\n\nexport const buildKeyReg = (\n  params: OnlineKeyRegistrationParams | OfflineKeyRegistrationParams,\n  suggestedParams: SuggestedParams,\n  defaultValidityWindow: bigint,\n): Transaction => {\n  const commonData = buildTransactionCommonData(params, suggestedParams, defaultValidityWindow)\n  if ('voteKey' in params) {\n    return new Transaction({\n      ...commonData,\n      type: TransactionType.KeyRegistration,\n      keyRegistration: {\n        voteKey: params.voteKey,\n        selectionKey: params.selectionKey,\n        voteFirst: params.voteFirst,\n        voteLast: params.voteLast,\n        voteKeyDilution: params.voteKeyDilution,\n        nonParticipation: false,\n        stateProofKey: params.stateProofKey,\n      },\n    })\n  } else {\n    return new Transaction({\n      ...commonData,\n      type: TransactionType.KeyRegistration,\n      keyRegistration: {\n        nonParticipation: params.preventAccountFromEverParticipatingAgain,\n      },\n    })\n  }\n}\n"],"mappings":";;;;;AA0BA,MAAa,eACX,QACA,iBACA,0BACgB;CAChB,MAAM,aAAaA,0CAA2B,QAAQ,iBAAiB,sBAAsB;AAC7F,KAAI,aAAa,OACf,QAAO,IAAIC,gCAAY;EACrB,GAAG;EACH,MAAMC,yCAAgB;EACtB,iBAAiB;GACf,SAAS,OAAO;GAChB,cAAc,OAAO;GACrB,WAAW,OAAO;GAClB,UAAU,OAAO;GACjB,iBAAiB,OAAO;GACxB,kBAAkB;GAClB,eAAe,OAAO;GACvB;EACF,CAAC;KAEF,QAAO,IAAID,gCAAY;EACrB,GAAG;EACH,MAAMC,yCAAgB;EACtB,iBAAiB,EACf,kBAAkB,OAAO,0CAC1B;EACF,CAAC"}

package/transactions/key-registration.mjs

@@ -0,0 +1,30 @@
+import { TransactionType } from "../packages/transact/src/transactions/transaction-type.mjs";
+import { Transaction } from "../packages/transact/src/transactions/transaction.mjs";
+import { buildTransactionCommonData } from "./common.mjs";
+
+//#region src/transactions/key-registration.ts
+const buildKeyReg = (params, suggestedParams, defaultValidityWindow) => {
+	const commonData = buildTransactionCommonData(params, suggestedParams, defaultValidityWindow);
+	if ("voteKey" in params) return new Transaction({
+		...commonData,
+		type: TransactionType.KeyRegistration,
+		keyRegistration: {
+			voteKey: params.voteKey,
+			selectionKey: params.selectionKey,
+			voteFirst: params.voteFirst,
+			voteLast: params.voteLast,
+			voteKeyDilution: params.voteKeyDilution,
+			nonParticipation: false,
+			stateProofKey: params.stateProofKey
+		}
+	});
+	else return new Transaction({
+		...commonData,
+		type: TransactionType.KeyRegistration,
+		keyRegistration: { nonParticipation: params.preventAccountFromEverParticipatingAgain }
+	});
+};
+
+//#endregion
+export { buildKeyReg };
+//# sourceMappingURL=key-registration.mjs.map

package/transactions/key-registration.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"key-registration.mjs","names":[],"sources":["../../src/transactions/key-registration.ts"],"sourcesContent":["import { SuggestedParams } from '@algorandfoundation/algokit-algod-client'\nimport { Transaction, TransactionType } from '@algorandfoundation/algokit-transact'\nimport { CommonTransactionParams, buildTransactionCommonData } from './common'\n\n/** Parameters to define an online key registration transaction. */\nexport type OnlineKeyRegistrationParams = CommonTransactionParams & {\n  /** The root participation public key */\n  voteKey: Uint8Array\n  /** The VRF public key */\n  selectionKey: Uint8Array\n  /** The first round that the participation key is valid. Not to be confused with the `firstValid` round of the keyreg transaction */\n  voteFirst: bigint\n  /** The last round that the participation key is valid. Not to be confused with the `lastValid` round of the keyreg transaction */\n  voteLast: bigint\n  /** This is the dilution for the 2-level participation key. It determines the interval (number of rounds) for generating new ephemeral keys */\n  voteKeyDilution: bigint\n  /** The 64 byte state proof public key commitment */\n  stateProofKey?: Uint8Array\n}\n\n/** Parameters to define an offline key registration transaction. */\nexport type OfflineKeyRegistrationParams = CommonTransactionParams & {\n  /** Prevent this account from ever participating again. The account will also no longer earn rewards */\n  preventAccountFromEverParticipatingAgain?: boolean\n}\n\nexport const buildKeyReg = (\n  params: OnlineKeyRegistrationParams | OfflineKeyRegistrationParams,\n  suggestedParams: SuggestedParams,\n  defaultValidityWindow: bigint,\n): Transaction => {\n  const commonData = buildTransactionCommonData(params, suggestedParams, defaultValidityWindow)\n  if ('voteKey' in params) {\n    return new Transaction({\n      ...commonData,\n      type: TransactionType.KeyRegistration,\n      keyRegistration: {\n        voteKey: params.voteKey,\n        selectionKey: params.selectionKey,\n        voteFirst: params.voteFirst,\n        voteLast: params.voteLast,\n        voteKeyDilution: params.voteKeyDilution,\n        nonParticipation: false,\n        stateProofKey: params.stateProofKey,\n      },\n    })\n  } else {\n    return new Transaction({\n      ...commonData,\n      type: TransactionType.KeyRegistration,\n      keyRegistration: {\n        nonParticipation: params.preventAccountFromEverParticipatingAgain,\n      },\n    })\n  }\n}\n"],"mappings":";;;;;AA0BA,MAAa,eACX,QACA,iBACA,0BACgB;CAChB,MAAM,aAAa,2BAA2B,QAAQ,iBAAiB,sBAAsB;AAC7F,KAAI,aAAa,OACf,QAAO,IAAI,YAAY;EACrB,GAAG;EACH,MAAM,gBAAgB;EACtB,iBAAiB;GACf,SAAS,OAAO;GAChB,cAAc,OAAO;GACrB,WAAW,OAAO;GAClB,UAAU,OAAO;GACjB,iBAAiB,OAAO;GACxB,kBAAkB;GAClB,eAAe,OAAO;GACvB;EACF,CAAC;KAEF,QAAO,IAAI,YAAY;EACrB,GAAG;EACH,MAAM,gBAAgB;EACtB,iBAAiB,EACf,kBAAkB,OAAO,0CAC1B;EACF,CAAC"}

package/transactions/method-call.d.ts

@@ -0,0 +1,45 @@
+import { ABIValue } from "../packages/abi/src/abi-value.js";
+import { ABIMethod } from "../packages/abi/src/abi-method.js";
+import { Transaction } from "../packages/transact/src/transactions/transaction.js";
+import { Expand } from "../types/expand.js";
+import { AppCreateParams, AppDeleteParams, AppMethodCallParams, AppUpdateParams } from "./app-call.js";
+import { TransactionWithSigner } from "../transaction/transaction.js";
+
+//#region src/transactions/method-call.d.ts
+
+/** Parameters to define an ABI method call create transaction. */
+type AppCreateMethodCall = Expand<AppMethodCall<AppCreateParams>>;
+/** Parameters to define an ABI method call update transaction. */
+type AppUpdateMethodCall = Expand<AppMethodCall<AppUpdateParams>>;
+/** Parameters to define an ABI method call delete transaction. */
+type AppDeleteMethodCall = Expand<AppMethodCall<AppDeleteParams>>;
+/** Parameters to define an ABI method call transaction. */
+type AppCallMethodCall = Expand<AppMethodCall<AppMethodCallParams>>;
+type ProcessedAppCreateMethodCall = Expand<Omit<AppCreateMethodCall, 'args'> & {
+  args?: (ABIValue | undefined)[];
+}>;
+type ProcessedAppUpdateMethodCall = Expand<Omit<AppUpdateMethodCall, 'args'> & {
+  args?: (ABIValue | undefined)[];
+}>;
+type ProcessedAppCallMethodCall = Expand<Omit<AppCallMethodCall, 'args'> & {
+  args?: (ABIValue | undefined)[];
+}>;
+/** Types that can be used to define a transaction argument for an ABI call transaction. */
+type AppMethodCallTransactionArgument = TransactionWithSigner | Transaction | Promise<Transaction> | AppMethodCall<AppCreateParams> | AppMethodCall<AppUpdateParams> | AppMethodCall<AppMethodCallParams>;
+/** Parameters to define an ABI method call. */
+type AppMethodCall<T> = Expand<Omit<T, 'args'>> & {
+  /** The ABI method to call */
+  method: ABIMethod;
+  /** Arguments to the ABI method, either:
+   * * An ABI value
+   * * A transaction with explicit signer
+   * * A transaction (where the signer will be automatically assigned)
+   * * An unawaited transaction (e.g. from algorand.createTransaction.{transactionType}())
+   * * Another method call (via method call params object)
+   * * undefined (this represents a placeholder transaction argument that is fulfilled by another method call argument)
+   */
+  args?: (ABIValue | TransactionWithSigner | Transaction | Promise<Transaction> | AppMethodCall<AppCreateParams> | AppMethodCall<AppUpdateParams> | AppMethodCall<AppMethodCallParams> | undefined)[];
+};
+//#endregion
+export { AppCallMethodCall, AppCreateMethodCall, AppDeleteMethodCall, AppMethodCall, AppMethodCallTransactionArgument, AppUpdateMethodCall, ProcessedAppCallMethodCall, ProcessedAppCreateMethodCall, ProcessedAppUpdateMethodCall };
+//# sourceMappingURL=method-call.d.ts.map