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

package/packages/transact/src/transactions/signed-transaction-meta.js

@@ -0,0 +1,132 @@
+const require_address = require('../../../common/src/codecs/primitives/address.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_array = require('../../../common/src/codecs/composite/array.js');
+const require_object_model = require('../../../common/src/codecs/models/object-model.js');
+const require_transaction = require('./transaction.js');
+
+//#region packages/transact/src/transactions/signed-transaction-meta.ts
+const MultisigSignatureMeta = {
+	name: "MultisigSignature",
+	kind: "object",
+	fields: [
+		{
+			name: "version",
+			wireKey: "v",
+			optional: false,
+			codec: require_number.numberCodec
+		},
+		{
+			name: "threshold",
+			wireKey: "thr",
+			optional: false,
+			codec: require_number.numberCodec
+		},
+		{
+			name: "subsignatures",
+			wireKey: "subsig",
+			optional: false,
+			codec: new require_array.ArrayCodec(new require_object_model.ObjectModelCodec({
+				name: "MultisigSubsignature",
+				kind: "object",
+				fields: [{
+					name: "publicKey",
+					wireKey: "pk",
+					optional: false,
+					codec: require_fixed_bytes.fixedBytes32Codec
+				}, {
+					name: "signature",
+					wireKey: "s",
+					optional: true,
+					codec: require_fixed_bytes.fixedBytes64Codec
+				}]
+			}))
+		}
+	]
+};
+const LogicSignatureMeta = {
+	name: "LogicSignature",
+	kind: "object",
+	fields: [
+		{
+			name: "logic",
+			wireKey: "l",
+			optional: false,
+			codec: require_bytes.bytesCodec
+		},
+		{
+			name: "args",
+			wireKey: "arg",
+			optional: true,
+			codec: require_array.bytesArrayCodec
+		},
+		{
+			name: "sig",
+			wireKey: "sig",
+			optional: true,
+			codec: require_fixed_bytes.fixedBytes64Codec
+		},
+		{
+			name: "msig",
+			wireKey: "msig",
+			optional: true,
+			codec: new require_object_model.ObjectModelCodec(MultisigSignatureMeta)
+		},
+		{
+			name: "lmsig",
+			wireKey: "lmsig",
+			optional: true,
+			codec: new require_object_model.ObjectModelCodec(MultisigSignatureMeta)
+		}
+	]
+};
+const multiSignatureCodec = new require_object_model.ObjectModelCodec(MultisigSignatureMeta);
+const logicSignatureCodec = new require_object_model.ObjectModelCodec(LogicSignatureMeta);
+/**
+* Metadata for SignedTransaction
+*/
+const SignedTransactionMeta = {
+	name: "SignedTransaction",
+	kind: "object",
+	fields: [
+		{
+			name: "txn",
+			wireKey: "txn",
+			optional: false,
+			codec: require_transaction.transactionCodec
+		},
+		{
+			name: "sig",
+			wireKey: "sig",
+			optional: true,
+			codec: require_fixed_bytes.fixedBytes64Codec
+		},
+		{
+			name: "msig",
+			wireKey: "msig",
+			optional: true,
+			codec: multiSignatureCodec
+		},
+		{
+			name: "lsig",
+			wireKey: "lsig",
+			optional: true,
+			codec: logicSignatureCodec
+		},
+		{
+			name: "authAddress",
+			wireKey: "sgnr",
+			optional: true,
+			codec: require_address.addressCodec
+		}
+	]
+};
+const signedTransactionCodec = new require_object_model.ObjectModelCodec(SignedTransactionMeta);
+
+//#endregion
+exports.SignedTransactionMeta = SignedTransactionMeta;
+exports.logicSignatureCodec = logicSignatureCodec;
+exports.multiSignatureCodec = multiSignatureCodec;
+exports.signedTransactionCodec = signedTransactionCodec;
+//# sourceMappingURL=signed-transaction-meta.js.map

package/packages/transact/src/transactions/signed-transaction-meta.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"signed-transaction-meta.js","names":["MultisigSignatureMeta: ObjectModelMetadata<MultisigSignature>","numberCodec","ArrayCodec","ObjectModelCodec","fixedBytes32Codec","fixedBytes64Codec","LogicSignatureMeta: ObjectModelMetadata<LogicSignature>","bytesCodec","bytesArrayCodec","SignedTransactionMeta: ObjectModelMetadata<SignedTransaction>","transactionCodec","addressCodec"],"sources":["../../../../../packages/transact/src/transactions/signed-transaction-meta.ts"],"sourcesContent":["import type { ObjectModelMetadata } from '@algorandfoundation/algokit-common'\nimport {\n  ArrayCodec,\n  ObjectModelCodec,\n  addressCodec,\n  bytesArrayCodec,\n  bytesCodec,\n  fixedBytes32Codec,\n  fixedBytes64Codec,\n  numberCodec,\n} from '@algorandfoundation/algokit-common'\nimport { LogicSignature, MultisigSignature, MultisigSubsignature, SignedTransaction } from './signed-transaction'\nimport { transactionCodec } from './transaction'\n\nconst MultisigSubsignatureMeta: ObjectModelMetadata<MultisigSubsignature> = {\n  name: 'MultisigSubsignature',\n  kind: 'object',\n  fields: [\n    { name: 'publicKey', wireKey: 'pk', optional: false, codec: fixedBytes32Codec },\n    { name: 'signature', wireKey: 's', optional: true, codec: fixedBytes64Codec },\n  ],\n}\n\nconst MultisigSignatureMeta: ObjectModelMetadata<MultisigSignature> = {\n  name: 'MultisigSignature',\n  kind: 'object',\n  fields: [\n    { name: 'version', wireKey: 'v', optional: false, codec: numberCodec },\n    { name: 'threshold', wireKey: 'thr', optional: false, codec: numberCodec },\n    {\n      name: 'subsignatures',\n      wireKey: 'subsig',\n      optional: false,\n      codec: new ArrayCodec(new ObjectModelCodec(MultisigSubsignatureMeta)),\n    },\n  ],\n}\n\nconst LogicSignatureMeta: ObjectModelMetadata<LogicSignature> = {\n  name: 'LogicSignature',\n  kind: 'object',\n  fields: [\n    { name: 'logic', wireKey: 'l', optional: false, codec: bytesCodec },\n    { name: 'args', wireKey: 'arg', optional: true, codec: bytesArrayCodec },\n    { name: 'sig', wireKey: 'sig', optional: true, codec: fixedBytes64Codec },\n    {\n      name: 'msig',\n      wireKey: 'msig',\n      optional: true,\n      codec: new ObjectModelCodec(MultisigSignatureMeta),\n    },\n    {\n      name: 'lmsig',\n      wireKey: 'lmsig',\n      optional: true,\n      codec: new ObjectModelCodec(MultisigSignatureMeta),\n    },\n  ],\n}\n\nexport const multiSignatureCodec = new ObjectModelCodec<MultisigSignature>(MultisigSignatureMeta)\nexport const logicSignatureCodec = new ObjectModelCodec<LogicSignature>(LogicSignatureMeta)\n\n/**\n * Metadata for SignedTransaction\n */\nexport const SignedTransactionMeta: ObjectModelMetadata<SignedTransaction> = {\n  name: 'SignedTransaction',\n  kind: 'object',\n  fields: [\n    {\n      name: 'txn',\n      wireKey: 'txn',\n      optional: false,\n      codec: transactionCodec,\n    },\n    { name: 'sig', wireKey: 'sig', optional: true, codec: fixedBytes64Codec },\n    {\n      name: 'msig',\n      wireKey: 'msig',\n      optional: true,\n      codec: multiSignatureCodec,\n    },\n    {\n      name: 'lsig',\n      wireKey: 'lsig',\n      optional: true,\n      codec: logicSignatureCodec,\n    },\n    { name: 'authAddress', wireKey: 'sgnr', optional: true, codec: addressCodec },\n  ],\n}\n\nexport const signedTransactionCodec = new ObjectModelCodec<SignedTransaction>(SignedTransactionMeta)\n"],"mappings":";;;;;;;;;AAuBA,MAAMA,wBAAgE;CACpE,MAAM;CACN,MAAM;CACN,QAAQ;EACN;GAAE,MAAM;GAAW,SAAS;GAAK,UAAU;GAAO,OAAOC;GAAa;EACtE;GAAE,MAAM;GAAa,SAAS;GAAO,UAAU;GAAO,OAAOA;GAAa;EAC1E;GACE,MAAM;GACN,SAAS;GACT,UAAU;GACV,OAAO,IAAIC,yBAAW,IAAIC,sCAnB4C;IAC1E,MAAM;IACN,MAAM;IACN,QAAQ,CACN;KAAE,MAAM;KAAa,SAAS;KAAM,UAAU;KAAO,OAAOC;KAAmB,EAC/E;KAAE,MAAM;KAAa,SAAS;KAAK,UAAU;KAAM,OAAOC;KAAmB,CAC9E;IACF,CAYyE,CAAC;GACtE;EACF;CACF;AAED,MAAMC,qBAA0D;CAC9D,MAAM;CACN,MAAM;CACN,QAAQ;EACN;GAAE,MAAM;GAAS,SAAS;GAAK,UAAU;GAAO,OAAOC;GAAY;EACnE;GAAE,MAAM;GAAQ,SAAS;GAAO,UAAU;GAAM,OAAOC;GAAiB;EACxE;GAAE,MAAM;GAAO,SAAS;GAAO,UAAU;GAAM,OAAOH;GAAmB;EACzE;GACE,MAAM;GACN,SAAS;GACT,UAAU;GACV,OAAO,IAAIF,sCAAiB,sBAAsB;GACnD;EACD;GACE,MAAM;GACN,SAAS;GACT,UAAU;GACV,OAAO,IAAIA,sCAAiB,sBAAsB;GACnD;EACF;CACF;AAED,MAAa,sBAAsB,IAAIA,sCAAoC,sBAAsB;AACjG,MAAa,sBAAsB,IAAIA,sCAAiC,mBAAmB;;;;AAK3F,MAAaM,wBAAgE;CAC3E,MAAM;CACN,MAAM;CACN,QAAQ;EACN;GACE,MAAM;GACN,SAAS;GACT,UAAU;GACV,OAAOC;GACR;EACD;GAAE,MAAM;GAAO,SAAS;GAAO,UAAU;GAAM,OAAOL;GAAmB;EACzE;GACE,MAAM;GACN,SAAS;GACT,UAAU;GACV,OAAO;GACR;EACD;GACE,MAAM;GACN,SAAS;GACT,UAAU;GACV,OAAO;GACR;EACD;GAAE,MAAM;GAAe,SAAS;GAAQ,UAAU;GAAM,OAAOM;GAAc;EAC9E;CACF;AAED,MAAa,yBAAyB,IAAIR,sCAAoC,sBAAsB"}

package/packages/transact/src/transactions/signed-transaction-meta.mjs

@@ -0,0 +1,129 @@
+import { addressCodec } from "../../../common/src/codecs/primitives/address.mjs";
+import { bytesCodec } from "../../../common/src/codecs/primitives/bytes.mjs";
+import { fixedBytes32Codec, fixedBytes64Codec } from "../../../common/src/codecs/primitives/fixed-bytes.mjs";
+import { numberCodec } from "../../../common/src/codecs/primitives/number.mjs";
+import { ArrayCodec, bytesArrayCodec } from "../../../common/src/codecs/composite/array.mjs";
+import { ObjectModelCodec } from "../../../common/src/codecs/models/object-model.mjs";
+import { transactionCodec } from "./transaction.mjs";
+
+//#region packages/transact/src/transactions/signed-transaction-meta.ts
+const MultisigSignatureMeta = {
+	name: "MultisigSignature",
+	kind: "object",
+	fields: [
+		{
+			name: "version",
+			wireKey: "v",
+			optional: false,
+			codec: numberCodec
+		},
+		{
+			name: "threshold",
+			wireKey: "thr",
+			optional: false,
+			codec: numberCodec
+		},
+		{
+			name: "subsignatures",
+			wireKey: "subsig",
+			optional: false,
+			codec: new ArrayCodec(new ObjectModelCodec({
+				name: "MultisigSubsignature",
+				kind: "object",
+				fields: [{
+					name: "publicKey",
+					wireKey: "pk",
+					optional: false,
+					codec: fixedBytes32Codec
+				}, {
+					name: "signature",
+					wireKey: "s",
+					optional: true,
+					codec: fixedBytes64Codec
+				}]
+			}))
+		}
+	]
+};
+const LogicSignatureMeta = {
+	name: "LogicSignature",
+	kind: "object",
+	fields: [
+		{
+			name: "logic",
+			wireKey: "l",
+			optional: false,
+			codec: bytesCodec
+		},
+		{
+			name: "args",
+			wireKey: "arg",
+			optional: true,
+			codec: bytesArrayCodec
+		},
+		{
+			name: "sig",
+			wireKey: "sig",
+			optional: true,
+			codec: fixedBytes64Codec
+		},
+		{
+			name: "msig",
+			wireKey: "msig",
+			optional: true,
+			codec: new ObjectModelCodec(MultisigSignatureMeta)
+		},
+		{
+			name: "lmsig",
+			wireKey: "lmsig",
+			optional: true,
+			codec: new ObjectModelCodec(MultisigSignatureMeta)
+		}
+	]
+};
+const multiSignatureCodec = new ObjectModelCodec(MultisigSignatureMeta);
+const logicSignatureCodec = new ObjectModelCodec(LogicSignatureMeta);
+/**
+* Metadata for SignedTransaction
+*/
+const SignedTransactionMeta = {
+	name: "SignedTransaction",
+	kind: "object",
+	fields: [
+		{
+			name: "txn",
+			wireKey: "txn",
+			optional: false,
+			codec: transactionCodec
+		},
+		{
+			name: "sig",
+			wireKey: "sig",
+			optional: true,
+			codec: fixedBytes64Codec
+		},
+		{
+			name: "msig",
+			wireKey: "msig",
+			optional: true,
+			codec: multiSignatureCodec
+		},
+		{
+			name: "lsig",
+			wireKey: "lsig",
+			optional: true,
+			codec: logicSignatureCodec
+		},
+		{
+			name: "authAddress",
+			wireKey: "sgnr",
+			optional: true,
+			codec: addressCodec
+		}
+	]
+};
+const signedTransactionCodec = new ObjectModelCodec(SignedTransactionMeta);
+
+//#endregion
+export { SignedTransactionMeta, logicSignatureCodec, multiSignatureCodec, signedTransactionCodec };
+//# sourceMappingURL=signed-transaction-meta.mjs.map

package/packages/transact/src/transactions/signed-transaction-meta.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"signed-transaction-meta.mjs","names":["MultisigSignatureMeta: ObjectModelMetadata<MultisigSignature>","LogicSignatureMeta: ObjectModelMetadata<LogicSignature>","SignedTransactionMeta: ObjectModelMetadata<SignedTransaction>"],"sources":["../../../../../packages/transact/src/transactions/signed-transaction-meta.ts"],"sourcesContent":["import type { ObjectModelMetadata } from '@algorandfoundation/algokit-common'\nimport {\n  ArrayCodec,\n  ObjectModelCodec,\n  addressCodec,\n  bytesArrayCodec,\n  bytesCodec,\n  fixedBytes32Codec,\n  fixedBytes64Codec,\n  numberCodec,\n} from '@algorandfoundation/algokit-common'\nimport { LogicSignature, MultisigSignature, MultisigSubsignature, SignedTransaction } from './signed-transaction'\nimport { transactionCodec } from './transaction'\n\nconst MultisigSubsignatureMeta: ObjectModelMetadata<MultisigSubsignature> = {\n  name: 'MultisigSubsignature',\n  kind: 'object',\n  fields: [\n    { name: 'publicKey', wireKey: 'pk', optional: false, codec: fixedBytes32Codec },\n    { name: 'signature', wireKey: 's', optional: true, codec: fixedBytes64Codec },\n  ],\n}\n\nconst MultisigSignatureMeta: ObjectModelMetadata<MultisigSignature> = {\n  name: 'MultisigSignature',\n  kind: 'object',\n  fields: [\n    { name: 'version', wireKey: 'v', optional: false, codec: numberCodec },\n    { name: 'threshold', wireKey: 'thr', optional: false, codec: numberCodec },\n    {\n      name: 'subsignatures',\n      wireKey: 'subsig',\n      optional: false,\n      codec: new ArrayCodec(new ObjectModelCodec(MultisigSubsignatureMeta)),\n    },\n  ],\n}\n\nconst LogicSignatureMeta: ObjectModelMetadata<LogicSignature> = {\n  name: 'LogicSignature',\n  kind: 'object',\n  fields: [\n    { name: 'logic', wireKey: 'l', optional: false, codec: bytesCodec },\n    { name: 'args', wireKey: 'arg', optional: true, codec: bytesArrayCodec },\n    { name: 'sig', wireKey: 'sig', optional: true, codec: fixedBytes64Codec },\n    {\n      name: 'msig',\n      wireKey: 'msig',\n      optional: true,\n      codec: new ObjectModelCodec(MultisigSignatureMeta),\n    },\n    {\n      name: 'lmsig',\n      wireKey: 'lmsig',\n      optional: true,\n      codec: new ObjectModelCodec(MultisigSignatureMeta),\n    },\n  ],\n}\n\nexport const multiSignatureCodec = new ObjectModelCodec<MultisigSignature>(MultisigSignatureMeta)\nexport const logicSignatureCodec = new ObjectModelCodec<LogicSignature>(LogicSignatureMeta)\n\n/**\n * Metadata for SignedTransaction\n */\nexport const SignedTransactionMeta: ObjectModelMetadata<SignedTransaction> = {\n  name: 'SignedTransaction',\n  kind: 'object',\n  fields: [\n    {\n      name: 'txn',\n      wireKey: 'txn',\n      optional: false,\n      codec: transactionCodec,\n    },\n    { name: 'sig', wireKey: 'sig', optional: true, codec: fixedBytes64Codec },\n    {\n      name: 'msig',\n      wireKey: 'msig',\n      optional: true,\n      codec: multiSignatureCodec,\n    },\n    {\n      name: 'lsig',\n      wireKey: 'lsig',\n      optional: true,\n      codec: logicSignatureCodec,\n    },\n    { name: 'authAddress', wireKey: 'sgnr', optional: true, codec: addressCodec },\n  ],\n}\n\nexport const signedTransactionCodec = new ObjectModelCodec<SignedTransaction>(SignedTransactionMeta)\n"],"mappings":";;;;;;;;;AAuBA,MAAMA,wBAAgE;CACpE,MAAM;CACN,MAAM;CACN,QAAQ;EACN;GAAE,MAAM;GAAW,SAAS;GAAK,UAAU;GAAO,OAAO;GAAa;EACtE;GAAE,MAAM;GAAa,SAAS;GAAO,UAAU;GAAO,OAAO;GAAa;EAC1E;GACE,MAAM;GACN,SAAS;GACT,UAAU;GACV,OAAO,IAAI,WAAW,IAAI,iBAnB4C;IAC1E,MAAM;IACN,MAAM;IACN,QAAQ,CACN;KAAE,MAAM;KAAa,SAAS;KAAM,UAAU;KAAO,OAAO;KAAmB,EAC/E;KAAE,MAAM;KAAa,SAAS;KAAK,UAAU;KAAM,OAAO;KAAmB,CAC9E;IACF,CAYyE,CAAC;GACtE;EACF;CACF;AAED,MAAMC,qBAA0D;CAC9D,MAAM;CACN,MAAM;CACN,QAAQ;EACN;GAAE,MAAM;GAAS,SAAS;GAAK,UAAU;GAAO,OAAO;GAAY;EACnE;GAAE,MAAM;GAAQ,SAAS;GAAO,UAAU;GAAM,OAAO;GAAiB;EACxE;GAAE,MAAM;GAAO,SAAS;GAAO,UAAU;GAAM,OAAO;GAAmB;EACzE;GACE,MAAM;GACN,SAAS;GACT,UAAU;GACV,OAAO,IAAI,iBAAiB,sBAAsB;GACnD;EACD;GACE,MAAM;GACN,SAAS;GACT,UAAU;GACV,OAAO,IAAI,iBAAiB,sBAAsB;GACnD;EACF;CACF;AAED,MAAa,sBAAsB,IAAI,iBAAoC,sBAAsB;AACjG,MAAa,sBAAsB,IAAI,iBAAiC,mBAAmB;;;;AAK3F,MAAaC,wBAAgE;CAC3E,MAAM;CACN,MAAM;CACN,QAAQ;EACN;GACE,MAAM;GACN,SAAS;GACT,UAAU;GACV,OAAO;GACR;EACD;GAAE,MAAM;GAAO,SAAS;GAAO,UAAU;GAAM,OAAO;GAAmB;EACzE;GACE,MAAM;GACN,SAAS;GACT,UAAU;GACV,OAAO;GACR;EACD;GACE,MAAM;GACN,SAAS;GACT,UAAU;GACV,OAAO;GACR;EACD;GAAE,MAAM;GAAe,SAAS;GAAQ,UAAU;GAAM,OAAO;GAAc;EAC9E;CACF;AAED,MAAa,yBAAyB,IAAI,iBAAoC,sBAAsB"}

package/packages/transact/src/transactions/signed-transaction.d.ts

@@ -0,0 +1,126 @@
+import { Address } from "../../../common/src/address.js";
+import { Transaction } from "./transaction.js";
+
+//#region packages/transact/src/transactions/signed-transaction.d.ts
+
+/**
+ * Represents a signed Algorand transaction
+ */
+type SignedTransaction = {
+  /**
+   * The transaction that has been signed.
+   */
+  txn: Transaction;
+  /**
+   * Optional Ed25519 signature authorizing the transaction.
+   */
+  sig?: Uint8Array;
+  /**
+   * Optional multisignature signature for the transaction.
+   */
+  msig?: MultisigSignature;
+  /**
+   * Optional logic signature for the transaction.
+   */
+  lsig?: LogicSignature;
+  /**
+   * Optional auth address applicable if the transaction sender is a rekeyed account.
+   */
+  authAddress?: Address;
+};
+/**
+ * Represents a single subsignature in a multisignature transaction.
+ *
+ * Each subsignature contains the public key of a participant and an optional signature.
+ */
+type MultisigSubsignature = {
+  /**
+   * Public key of a keypair account participant that is sub-signing a multisignature transaction.
+   */
+  publicKey: Uint8Array;
+  /**
+   * Optional Ed25519 signature for the transaction.
+   */
+  signature?: Uint8Array;
+};
+/**
+ * Represents an Algorand multisignature signature.
+ *
+ * A multisignature signature is defined by a version, a threshold, and a list of participating addresses.
+ * The version indicates the multisig protocol version, while the threshold specifies the minimum number of signatures required to authorize a transaction.
+ * While technically this accepts `Address` types, it is expected that these will be the addresses of Ed25519 public keys.
+ */
+type MultisigSignature = {
+  /**
+   * Multisig version.
+   */
+  version: number;
+  /**
+   * Minimum number of signatures required.
+   */
+  threshold: number;
+  /**
+   * Array of subsignatures
+   */
+  subsignatures: Array<MultisigSubsignature>;
+};
+/**
+ * Logic signature structure
+ */
+type LogicSignature = {
+  /**
+   * Logic signature program
+   */
+  logic: Uint8Array;
+  /**
+   * Logic signature arguments
+   */
+  args?: Uint8Array[];
+  /**
+   * Signature for delegated logic sig
+   */
+  sig?: Uint8Array;
+  /**
+   * Legacy multisig for delegated logic sig
+   */
+  msig?: MultisigSignature;
+  /**
+   * Multisig for delegated logic sig
+   */
+  lmsig?: MultisigSignature;
+};
+/**
+ * Encode signed transactions to MsgPack for sending on the network.
+ *
+ * This method performs canonical encoding. No domain separation prefix is applicable.
+ *
+ * @param signedTransaction - The signed transaction to encode
+ * @returns The MsgPack encoded bytes or an error if encoding fails.
+ */
+declare function encodeSignedTransaction(signedTransaction: SignedTransaction): Uint8Array;
+/**
+ * Encode signed transactions to MsgPack for sending on the network.
+ *
+ *  This method performs canonical encoding. No domain separation prefix is applicable.
+ *
+ * @param signedTransactions - A collection of signed transactions to encode
+ * @returns A collection of MsgPack encoded bytes or an error if encoding fails.
+ */
+declare function encodeSignedTransactions(signedTransactions: SignedTransaction[]): Uint8Array[];
+/**
+ * Decodes MsgPack bytes into a signed transaction.
+ *
+ * @param encodedSignedTransaction - The MsgPack encoded signed transaction bytes
+ * @returns The decoded SignedTransaction or an error if decoding fails.
+ */
+declare function decodeSignedTransaction(encodedSignedTransaction: Uint8Array): SignedTransaction;
+/**
+ * Decodes a collection of MsgPack bytes into a signed transaction collection.
+ *
+ * @param encodedSignedTransactions - A collection of MsgPack encoded bytes, each representing a signed transaction.
+ * @returns A collection of decoded signed transactions or an error if decoding fails.
+ */
+declare function decodeSignedTransactions(encodedSignedTransactions: Uint8Array[]): SignedTransaction[];
+//#endregion
+export { LogicSignature, MultisigSignature, MultisigSubsignature, SignedTransaction, decodeSignedTransaction, decodeSignedTransactions, encodeSignedTransaction, encodeSignedTransactions };
+//# sourceMappingURL=signed-transaction.d.ts.map

package/packages/transact/src/transactions/signed-transaction.js

@@ -0,0 +1,67 @@
+const require_msgpack = require('../../../common/src/msgpack.js');
+const require_transaction = require('./transaction.js');
+const require_signed_transaction_meta = require('./signed-transaction-meta.js');
+
+//#region packages/transact/src/transactions/signed-transaction.ts
+/**
+* Encode signed transactions to MsgPack for sending on the network.
+*
+* This method performs canonical encoding. No domain separation prefix is applicable.
+*
+* @param signedTransaction - The signed transaction to encode
+* @returns The MsgPack encoded bytes or an error if encoding fails.
+*/
+function encodeSignedTransaction(signedTransaction) {
+	validateSignedTransaction(signedTransaction);
+	return require_msgpack.encodeMsgpack(require_signed_transaction_meta.signedTransactionCodec.encode(signedTransaction, "msgpack"));
+}
+/**
+* Encode signed transactions to MsgPack for sending on the network.
+*
+*  This method performs canonical encoding. No domain separation prefix is applicable.
+*
+* @param signedTransactions - A collection of signed transactions to encode
+* @returns A collection of MsgPack encoded bytes or an error if encoding fails.
+*/
+function encodeSignedTransactions(signedTransactions) {
+	return signedTransactions.map((st) => encodeSignedTransaction(st));
+}
+/**
+* Decodes MsgPack bytes into a signed transaction.
+*
+* @param encodedSignedTransaction - The MsgPack encoded signed transaction bytes
+* @returns The decoded SignedTransaction or an error if decoding fails.
+*/
+function decodeSignedTransaction(encodedSignedTransaction) {
+	const decodedData = require_msgpack.decodeMsgpack(encodedSignedTransaction);
+	return require_signed_transaction_meta.signedTransactionCodec.decode(decodedData, "msgpack");
+}
+/**
+* Decodes a collection of MsgPack bytes into a signed transaction collection.
+*
+* @param encodedSignedTransactions - A collection of MsgPack encoded bytes, each representing a signed transaction.
+* @returns A collection of decoded signed transactions or an error if decoding fails.
+*/
+function decodeSignedTransactions(encodedSignedTransactions) {
+	return encodedSignedTransactions.map((est) => decodeSignedTransaction(est));
+}
+/**
+* Validate a signed transaction structure
+*/
+function validateSignedTransaction(signedTransaction) {
+	require_transaction.validateTransaction(signedTransaction.txn);
+	const setSigCount = [
+		signedTransaction.sig,
+		signedTransaction.msig,
+		signedTransaction.lsig
+	].filter((sig) => sig !== void 0).length;
+	if (setSigCount > 1) throw new Error(`Only one signature type can be set, found ${setSigCount}`);
+	if (signedTransaction.sig && signedTransaction.sig.length !== 64) throw new Error("Signature must be 64 bytes");
+}
+
+//#endregion
+exports.decodeSignedTransaction = decodeSignedTransaction;
+exports.decodeSignedTransactions = decodeSignedTransactions;
+exports.encodeSignedTransaction = encodeSignedTransaction;
+exports.encodeSignedTransactions = encodeSignedTransactions;
+//# sourceMappingURL=signed-transaction.js.map

package/packages/transact/src/transactions/signed-transaction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"signed-transaction.js","names":["encodeMsgpack","signedTransactionCodec","decodeMsgpack"],"sources":["../../../../../packages/transact/src/transactions/signed-transaction.ts"],"sourcesContent":["import type { Address } from '@algorandfoundation/algokit-common'\nimport { decodeMsgpack, encodeMsgpack } from '@algorandfoundation/algokit-common'\nimport { signedTransactionCodec } from './signed-transaction-meta'\nimport { Transaction, validateTransaction } from './transaction'\n\n/**\n * Represents a signed Algorand transaction\n */\nexport type SignedTransaction = {\n  /**\n   * The transaction that has been signed.\n   */\n  txn: Transaction\n\n  /**\n   * Optional Ed25519 signature authorizing the transaction.\n   */\n  sig?: Uint8Array\n\n  /**\n   * Optional multisignature signature for the transaction.\n   */\n  msig?: MultisigSignature\n\n  /**\n   * Optional logic signature for the transaction.\n   */\n  lsig?: LogicSignature\n\n  /**\n   * Optional auth address applicable if the transaction sender is a rekeyed account.\n   */\n  authAddress?: Address\n}\n\n/**\n * Represents a single subsignature in a multisignature transaction.\n *\n * Each subsignature contains the public key of a participant and an optional signature.\n */\nexport type MultisigSubsignature = {\n  /**\n   * Public key of a keypair account participant that is sub-signing a multisignature transaction.\n   */\n  publicKey: Uint8Array\n\n  /**\n   * Optional Ed25519 signature for the transaction.\n   */\n  signature?: Uint8Array\n}\n\n/**\n * Represents an Algorand multisignature signature.\n *\n * A multisignature signature is defined by a version, a threshold, and a list of participating addresses.\n * The version indicates the multisig protocol version, while the threshold specifies the minimum number of signatures required to authorize a transaction.\n * While technically this accepts `Address` types, it is expected that these will be the addresses of Ed25519 public keys.\n */\nexport type MultisigSignature = {\n  /**\n   * Multisig version.\n   */\n  version: number\n\n  /**\n   * Minimum number of signatures required.\n   */\n  threshold: number\n\n  /**\n   * Array of subsignatures\n   */\n  subsignatures: Array<MultisigSubsignature>\n}\n\n/**\n * Logic signature structure\n */\nexport type LogicSignature = {\n  /**\n   * Logic signature program\n   */\n  logic: Uint8Array\n\n  /**\n   * Logic signature arguments\n   */\n  args?: Uint8Array[]\n\n  /**\n   * Signature for delegated logic sig\n   */\n  sig?: Uint8Array\n\n  /**\n   * Legacy multisig for delegated logic sig\n   */\n  msig?: MultisigSignature\n\n  /**\n   * Multisig for delegated logic sig\n   */\n  lmsig?: MultisigSignature\n}\n\n/**\n * Encode signed transactions to MsgPack for sending on the network.\n *\n * This method performs canonical encoding. No domain separation prefix is applicable.\n *\n * @param signedTransaction - The signed transaction to encode\n * @returns The MsgPack encoded bytes or an error if encoding fails.\n */\nexport function encodeSignedTransaction(signedTransaction: SignedTransaction): Uint8Array {\n  validateSignedTransaction(signedTransaction)\n  const encodingData = signedTransactionCodec.encode(signedTransaction, 'msgpack')\n  return encodeMsgpack(encodingData)\n}\n\n/**\n * Encode signed transactions to MsgPack for sending on the network.\n *\n *  This method performs canonical encoding. No domain separation prefix is applicable.\n *\n * @param signedTransactions - A collection of signed transactions to encode\n * @returns A collection of MsgPack encoded bytes or an error if encoding fails.\n */\nexport function encodeSignedTransactions(signedTransactions: SignedTransaction[]): Uint8Array[] {\n  return signedTransactions.map((st) => encodeSignedTransaction(st))\n}\n\n/**\n * Decodes MsgPack bytes into a signed transaction.\n *\n * @param encodedSignedTransaction - The MsgPack encoded signed transaction bytes\n * @returns The decoded SignedTransaction or an error if decoding fails.\n */\nexport function decodeSignedTransaction(encodedSignedTransaction: Uint8Array): SignedTransaction {\n  const decodedData = decodeMsgpack(encodedSignedTransaction)\n  return signedTransactionCodec.decode(decodedData, 'msgpack')\n}\n\n/**\n * Decodes a collection of MsgPack bytes into a signed transaction collection.\n *\n * @param encodedSignedTransactions - A collection of MsgPack encoded bytes, each representing a signed transaction.\n * @returns A collection of decoded signed transactions or an error if decoding fails.\n */\nexport function decodeSignedTransactions(encodedSignedTransactions: Uint8Array[]): SignedTransaction[] {\n  return encodedSignedTransactions.map((est) => decodeSignedTransaction(est))\n}\n\n/**\n * Validate a signed transaction structure\n */\nfunction validateSignedTransaction(signedTransaction: SignedTransaction): void {\n  validateTransaction(signedTransaction.txn)\n\n  // Validate that only one signature type is set\n  const sigTypes = [signedTransaction.sig, signedTransaction.msig, signedTransaction.lsig]\n  const setSigCount = sigTypes.filter((sig) => sig !== undefined).length\n\n  if (setSigCount > 1) {\n    throw new Error(`Only one signature type can be set, found ${setSigCount}`)\n  }\n\n  // Validate signature lengths\n  if (signedTransaction.sig && signedTransaction.sig.length !== 64) {\n    throw new Error('Signature must be 64 bytes')\n  }\n}\n"],"mappings":";;;;;;;;;;;;;AAkHA,SAAgB,wBAAwB,mBAAkD;AACxF,2BAA0B,kBAAkB;AAE5C,QAAOA,8BADcC,uDAAuB,OAAO,mBAAmB,UAAU,CAC9C;;;;;;;;;;AAWpC,SAAgB,yBAAyB,oBAAuD;AAC9F,QAAO,mBAAmB,KAAK,OAAO,wBAAwB,GAAG,CAAC;;;;;;;;AASpE,SAAgB,wBAAwB,0BAAyD;CAC/F,MAAM,cAAcC,8BAAc,yBAAyB;AAC3D,QAAOD,uDAAuB,OAAO,aAAa,UAAU;;;;;;;;AAS9D,SAAgB,yBAAyB,2BAA8D;AACrG,QAAO,0BAA0B,KAAK,QAAQ,wBAAwB,IAAI,CAAC;;;;;AAM7E,SAAS,0BAA0B,mBAA4C;AAC7E,yCAAoB,kBAAkB,IAAI;CAI1C,MAAM,cADW;EAAC,kBAAkB;EAAK,kBAAkB;EAAM,kBAAkB;EAAK,CAC3D,QAAQ,QAAQ,QAAQ,OAAU,CAAC;AAEhE,KAAI,cAAc,EAChB,OAAM,IAAI,MAAM,6CAA6C,cAAc;AAI7E,KAAI,kBAAkB,OAAO,kBAAkB,IAAI,WAAW,GAC5D,OAAM,IAAI,MAAM,6BAA6B"}

package/packages/transact/src/transactions/signed-transaction.mjs

@@ -0,0 +1,64 @@
+import { decodeMsgpack, encodeMsgpack } from "../../../common/src/msgpack.mjs";
+import { validateTransaction } from "./transaction.mjs";
+import { signedTransactionCodec } from "./signed-transaction-meta.mjs";
+
+//#region packages/transact/src/transactions/signed-transaction.ts
+/**
+* Encode signed transactions to MsgPack for sending on the network.
+*
+* This method performs canonical encoding. No domain separation prefix is applicable.
+*
+* @param signedTransaction - The signed transaction to encode
+* @returns The MsgPack encoded bytes or an error if encoding fails.
+*/
+function encodeSignedTransaction(signedTransaction) {
+	validateSignedTransaction(signedTransaction);
+	return encodeMsgpack(signedTransactionCodec.encode(signedTransaction, "msgpack"));
+}
+/**
+* Encode signed transactions to MsgPack for sending on the network.
+*
+*  This method performs canonical encoding. No domain separation prefix is applicable.
+*
+* @param signedTransactions - A collection of signed transactions to encode
+* @returns A collection of MsgPack encoded bytes or an error if encoding fails.
+*/
+function encodeSignedTransactions(signedTransactions) {
+	return signedTransactions.map((st) => encodeSignedTransaction(st));
+}
+/**
+* Decodes MsgPack bytes into a signed transaction.
+*
+* @param encodedSignedTransaction - The MsgPack encoded signed transaction bytes
+* @returns The decoded SignedTransaction or an error if decoding fails.
+*/
+function decodeSignedTransaction(encodedSignedTransaction) {
+	const decodedData = decodeMsgpack(encodedSignedTransaction);
+	return signedTransactionCodec.decode(decodedData, "msgpack");
+}
+/**
+* Decodes a collection of MsgPack bytes into a signed transaction collection.
+*
+* @param encodedSignedTransactions - A collection of MsgPack encoded bytes, each representing a signed transaction.
+* @returns A collection of decoded signed transactions or an error if decoding fails.
+*/
+function decodeSignedTransactions(encodedSignedTransactions) {
+	return encodedSignedTransactions.map((est) => decodeSignedTransaction(est));
+}
+/**
+* Validate a signed transaction structure
+*/
+function validateSignedTransaction(signedTransaction) {
+	validateTransaction(signedTransaction.txn);
+	const setSigCount = [
+		signedTransaction.sig,
+		signedTransaction.msig,
+		signedTransaction.lsig
+	].filter((sig) => sig !== void 0).length;
+	if (setSigCount > 1) throw new Error(`Only one signature type can be set, found ${setSigCount}`);
+	if (signedTransaction.sig && signedTransaction.sig.length !== 64) throw new Error("Signature must be 64 bytes");
+}
+
+//#endregion
+export { decodeSignedTransaction, decodeSignedTransactions, encodeSignedTransaction, encodeSignedTransactions };
+//# sourceMappingURL=signed-transaction.mjs.map

package/packages/transact/src/transactions/signed-transaction.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"signed-transaction.mjs","names":[],"sources":["../../../../../packages/transact/src/transactions/signed-transaction.ts"],"sourcesContent":["import type { Address } from '@algorandfoundation/algokit-common'\nimport { decodeMsgpack, encodeMsgpack } from '@algorandfoundation/algokit-common'\nimport { signedTransactionCodec } from './signed-transaction-meta'\nimport { Transaction, validateTransaction } from './transaction'\n\n/**\n * Represents a signed Algorand transaction\n */\nexport type SignedTransaction = {\n  /**\n   * The transaction that has been signed.\n   */\n  txn: Transaction\n\n  /**\n   * Optional Ed25519 signature authorizing the transaction.\n   */\n  sig?: Uint8Array\n\n  /**\n   * Optional multisignature signature for the transaction.\n   */\n  msig?: MultisigSignature\n\n  /**\n   * Optional logic signature for the transaction.\n   */\n  lsig?: LogicSignature\n\n  /**\n   * Optional auth address applicable if the transaction sender is a rekeyed account.\n   */\n  authAddress?: Address\n}\n\n/**\n * Represents a single subsignature in a multisignature transaction.\n *\n * Each subsignature contains the public key of a participant and an optional signature.\n */\nexport type MultisigSubsignature = {\n  /**\n   * Public key of a keypair account participant that is sub-signing a multisignature transaction.\n   */\n  publicKey: Uint8Array\n\n  /**\n   * Optional Ed25519 signature for the transaction.\n   */\n  signature?: Uint8Array\n}\n\n/**\n * Represents an Algorand multisignature signature.\n *\n * A multisignature signature is defined by a version, a threshold, and a list of participating addresses.\n * The version indicates the multisig protocol version, while the threshold specifies the minimum number of signatures required to authorize a transaction.\n * While technically this accepts `Address` types, it is expected that these will be the addresses of Ed25519 public keys.\n */\nexport type MultisigSignature = {\n  /**\n   * Multisig version.\n   */\n  version: number\n\n  /**\n   * Minimum number of signatures required.\n   */\n  threshold: number\n\n  /**\n   * Array of subsignatures\n   */\n  subsignatures: Array<MultisigSubsignature>\n}\n\n/**\n * Logic signature structure\n */\nexport type LogicSignature = {\n  /**\n   * Logic signature program\n   */\n  logic: Uint8Array\n\n  /**\n   * Logic signature arguments\n   */\n  args?: Uint8Array[]\n\n  /**\n   * Signature for delegated logic sig\n   */\n  sig?: Uint8Array\n\n  /**\n   * Legacy multisig for delegated logic sig\n   */\n  msig?: MultisigSignature\n\n  /**\n   * Multisig for delegated logic sig\n   */\n  lmsig?: MultisigSignature\n}\n\n/**\n * Encode signed transactions to MsgPack for sending on the network.\n *\n * This method performs canonical encoding. No domain separation prefix is applicable.\n *\n * @param signedTransaction - The signed transaction to encode\n * @returns The MsgPack encoded bytes or an error if encoding fails.\n */\nexport function encodeSignedTransaction(signedTransaction: SignedTransaction): Uint8Array {\n  validateSignedTransaction(signedTransaction)\n  const encodingData = signedTransactionCodec.encode(signedTransaction, 'msgpack')\n  return encodeMsgpack(encodingData)\n}\n\n/**\n * Encode signed transactions to MsgPack for sending on the network.\n *\n *  This method performs canonical encoding. No domain separation prefix is applicable.\n *\n * @param signedTransactions - A collection of signed transactions to encode\n * @returns A collection of MsgPack encoded bytes or an error if encoding fails.\n */\nexport function encodeSignedTransactions(signedTransactions: SignedTransaction[]): Uint8Array[] {\n  return signedTransactions.map((st) => encodeSignedTransaction(st))\n}\n\n/**\n * Decodes MsgPack bytes into a signed transaction.\n *\n * @param encodedSignedTransaction - The MsgPack encoded signed transaction bytes\n * @returns The decoded SignedTransaction or an error if decoding fails.\n */\nexport function decodeSignedTransaction(encodedSignedTransaction: Uint8Array): SignedTransaction {\n  const decodedData = decodeMsgpack(encodedSignedTransaction)\n  return signedTransactionCodec.decode(decodedData, 'msgpack')\n}\n\n/**\n * Decodes a collection of MsgPack bytes into a signed transaction collection.\n *\n * @param encodedSignedTransactions - A collection of MsgPack encoded bytes, each representing a signed transaction.\n * @returns A collection of decoded signed transactions or an error if decoding fails.\n */\nexport function decodeSignedTransactions(encodedSignedTransactions: Uint8Array[]): SignedTransaction[] {\n  return encodedSignedTransactions.map((est) => decodeSignedTransaction(est))\n}\n\n/**\n * Validate a signed transaction structure\n */\nfunction validateSignedTransaction(signedTransaction: SignedTransaction): void {\n  validateTransaction(signedTransaction.txn)\n\n  // Validate that only one signature type is set\n  const sigTypes = [signedTransaction.sig, signedTransaction.msig, signedTransaction.lsig]\n  const setSigCount = sigTypes.filter((sig) => sig !== undefined).length\n\n  if (setSigCount > 1) {\n    throw new Error(`Only one signature type can be set, found ${setSigCount}`)\n  }\n\n  // Validate signature lengths\n  if (signedTransaction.sig && signedTransaction.sig.length !== 64) {\n    throw new Error('Signature must be 64 bytes')\n  }\n}\n"],"mappings":";;;;;;;;;;;;;AAkHA,SAAgB,wBAAwB,mBAAkD;AACxF,2BAA0B,kBAAkB;AAE5C,QAAO,cADc,uBAAuB,OAAO,mBAAmB,UAAU,CAC9C;;;;;;;;;;AAWpC,SAAgB,yBAAyB,oBAAuD;AAC9F,QAAO,mBAAmB,KAAK,OAAO,wBAAwB,GAAG,CAAC;;;;;;;;AASpE,SAAgB,wBAAwB,0BAAyD;CAC/F,MAAM,cAAc,cAAc,yBAAyB;AAC3D,QAAO,uBAAuB,OAAO,aAAa,UAAU;;;;;;;;AAS9D,SAAgB,yBAAyB,2BAA8D;AACrG,QAAO,0BAA0B,KAAK,QAAQ,wBAAwB,IAAI,CAAC;;;;;AAM7E,SAAS,0BAA0B,mBAA4C;AAC7E,qBAAoB,kBAAkB,IAAI;CAI1C,MAAM,cADW;EAAC,kBAAkB;EAAK,kBAAkB;EAAM,kBAAkB;EAAK,CAC3D,QAAQ,QAAQ,QAAQ,OAAU,CAAC;AAEhE,KAAI,cAAc,EAChB,OAAM,IAAI,MAAM,6CAA6C,cAAc;AAI7E,KAAI,kBAAkB,OAAO,kBAAkB,IAAI,WAAW,GAC5D,OAAM,IAAI,MAAM,6BAA6B"}

package/packages/transact/src/transactions/state-proof.d.ts

@@ -0,0 +1,64 @@
+//#region packages/transact/src/transactions/state-proof.d.ts
+/**
+ * State proof transaction specific fields
+ */
+type StateProofTransactionFields = {
+  /** State proof type */
+  stateProofType?: number;
+  /** State proof */
+  stateProof?: StateProof;
+  /** State proof message */
+  message?: StateProofMessage;
+};
+type StateProof = {
+  sigCommit: Uint8Array;
+  signedWeight: bigint;
+  sigProofs: MerkleArrayProof;
+  partProofs: MerkleArrayProof;
+  merkleSignatureSaltVersion: number;
+  reveals: Map<bigint, Reveal>;
+  positionsToReveal: bigint[];
+};
+type MerkleArrayProof = {
+  path: Uint8Array[];
+  hashFactory: HashFactory;
+  treeDepth: number;
+};
+type HashFactory = {
+  hashType: number;
+};
+type MerkleSignatureVerifier = {
+  commitment: Uint8Array;
+  keyLifetime: bigint;
+};
+type Participant = {
+  verifier: MerkleSignatureVerifier;
+  weight: bigint;
+};
+type FalconVerifier = {
+  publicKey: Uint8Array;
+};
+type FalconSignatureStruct = {
+  signature: Uint8Array;
+  vectorCommitmentIndex: bigint;
+  proof: MerkleArrayProof;
+  verifyingKey: FalconVerifier;
+};
+type SigslotCommit = {
+  sig: FalconSignatureStruct;
+  lowerSigWeight: bigint;
+};
+type Reveal = {
+  sigslot: SigslotCommit;
+  participant: Participant;
+};
+type StateProofMessage = {
+  blockHeadersCommitment: Uint8Array;
+  votersCommitment: Uint8Array;
+  lnProvenWeight: bigint;
+  firstAttestedRound: bigint;
+  lastAttestedRound: bigint;
+};
+//#endregion
+export { FalconSignatureStruct, FalconVerifier, HashFactory, MerkleArrayProof, MerkleSignatureVerifier, Participant, Reveal, SigslotCommit, StateProof, StateProofMessage, StateProofTransactionFields };
+//# sourceMappingURL=state-proof.d.ts.map

package/packages/transact/src/transactions/transaction-meta.d.ts

@@ -0,0 +1,14 @@
+import { ObjectModelMetadata } from "../../../common/src/codecs/types.js";
+import { ObjectModelCodec } from "../../../common/src/codecs/models/object-model.js";
+import { TransactionParams } from "./transaction.js";
+
+//#region packages/transact/src/transactions/transaction-meta.d.ts
+
+/**
+ * Metadata for TransactionParams
+ */
+declare const TransactionParamsMeta: ObjectModelMetadata<TransactionParams>;
+declare const transactionParamsCodec: ObjectModelCodec<TransactionParams>;
+//#endregion
+export { TransactionParamsMeta, transactionParamsCodec };
+//# sourceMappingURL=transaction-meta.d.ts.map