algosdk 3.7.0 → 3.9.0-beta.1

package/src/logicsig.ts

@@ -68,8 +68,22 @@ export function sanityCheckProgram(program: Uint8Array) {
   }
 }
 
+/**
+ * The domain-separation prefix prepended to a program before it is hashed into
+ * an escrow address, or signed for delegation by a single ed25519 account.
+ */
 export const PROGRAM_TAG = new TextEncoder().encode('Program');
+
+/**
+ * The domain-separation prefix prepended to a post-quantum delegating account's
+ * address and a program before the program is signed for delegation.
+ */
 export const PQ_PROGRAM_TAG = new TextEncoder().encode('PQProgram');
+
+/**
+ * The domain-separation prefix prepended to a delegating multisig account's
+ * address and a program before the program is signed for delegation.
+ */
 export const MSIG_PROGRAM_TAG = new TextEncoder().encode('MsigProgram');
 
 /**
@@ -112,6 +126,11 @@ export class LogicSig implements encoding.Encodable {
   sig?: Uint8Array;
   msig?: EncodedMultisig;
   lmsig?: EncodedMultisig;
+  /**
+   * The post-quantum delegation signature, if the delegating account is a
+   * post-quantum account. At most one of `sig`, `msig`, `lmsig` and `pqsig` may
+   * be set.
+   */
   pqsig?: EncodedPQSig;
 
   constructor(program: Uint8Array, programArgs?: Array<Uint8Array> | null) {
@@ -276,6 +295,11 @@ export class LogicSig implements encoding.Encodable {
   /**
    * Signs this LogicSig for delegation using the given signer.
    *
+   * @remarks
+   * Re-signing an already-signed LogicSig is allowed, and replaces the previous
+   * delegation signature. At most one of `sig`, `msig`, `lmsig` and `pqsig` may
+   * be set, so any signature left over from an earlier call is cleared.
+   *
    * @param signer - The signer to delegate to
    * @param msig - Optional multisig account the signer is a subsigner of
    * @returns The address the signer signed as. When `msig` is omitted this is
@@ -283,10 +307,9 @@ export class LogicSig implements encoding.Encodable {
    *   subsigner, not the multisig, so the delegating account is
    *   `multisigAddress(msig)`. Either way it is an authorizing address, which
    *   is not necessarily the address a signer sends transactions from.
-   *
-   * Re-signing an already-signed LogicSig is allowed, and replaces the previous
-   * delegation signature. At most one of `sig`, `msig`, `lmsig` and `pqsig` may
-   * be set, so any signature left over from an earlier call is cleared.
+   * @throws If the signer returns a signature of the wrong kind for the
+   *   requested delegation, or an `lmsig` whose version, threshold or public
+   *   keys do not match `msig`
    */
   async signWithSigner(
     signer: DelegatedLsigSigner,
@@ -360,6 +383,24 @@ export class LogicSig implements encoding.Encodable {
     this.lmsig.subsig[index].s = sig;
   }
 
+  /**
+   * Appends an additional subsignature to this LogicSig's existing multisig
+   * delegation.
+   *
+   * @remarks
+   * The multisig preimage is taken from the `lmsig` already on this LogicSig,
+   * so {@link signWithSigner} must have been called with an `msig` argument
+   * first. The signer must hold a key belonging to that multisig.
+   *
+   * A signature already collected from another member is never silently
+   * replaced: if the signer returns a different signature for a subsig that is
+   * already filled in, this throws instead.
+   *
+   * @param signer - The signer to append a subsignature from
+   * @throws If there is no multisig on this LogicSig, if the signer returns no
+   *   signature, a signature for a key outside the multisig, or one that
+   *   conflicts with a signature already collected
+   */
   async appendToMultisigWithSigner(signer: DelegatedLsigSigner) {
     if (this.lmsig === undefined) {
       throw new Error('no multisig present');
@@ -475,8 +516,15 @@ export class LogicSig implements encoding.Encodable {
    * Signs arbitrary data for use with the `ed25519verify` opcode from within
    * this LogicSig's program.
    *
+   * @remarks
+   * This does not modify the LogicSig or delegate it; the LogicSig is only used
+   * for the address that domain-separates the signature. The program is
+   * responsible for verifying the returned signature against the signer's
+   * public key.
+   *
    * @param signer - The signer to sign the data with
    * @param data - The data to sign
+   * @returns A promise which resolves to the raw signature over the data
    */
   async signDataWithSigner(signer: ProgramDataSigner, data: Uint8Array) {
     return signer(data, this);
@@ -656,6 +704,22 @@ export class LogicSigAccount implements encoding.Encodable {
     this.lsig.sign(secretKey, msig);
   }
 
+  /**
+   * Turns this LogicSigAccount into a delegated LogicSig, signed by one member
+   * of a delegating multisig account.
+   *
+   * @remarks
+   * This produces a LogicSig with a single subsignature filled in. Unless the
+   * multisig's threshold is 1, call {@link LogicSigAccount.appendToMultisigWithSigner}
+   * with the remaining members' signers before the LogicSig can authorize
+   * transactions.
+   *
+   * If the delegating account is not a multisig, use
+   * {@link LogicSigAccount.signWithSigner} instead.
+   *
+   * @param msig - The multisig delegating to this LogicSig
+   * @param signer - The signer of one member of `msig`
+   */
   async signMultisigWithSigner(
     msig: MultisigMetadata,
     signer: DelegatedLsigSigner
@@ -676,6 +740,16 @@ export class LogicSigAccount implements encoding.Encodable {
     this.lsig.appendToMultisig(secretKey);
   }
 
+  /**
+   * Adds an additional signature from a member of the delegating multisig
+   * account.
+   *
+   * @remarks
+   * {@link LogicSigAccount.signMultisigWithSigner} must have been called first
+   * to establish the multisig this signature belongs to.
+   *
+   * @param signer - The signer of another member of the delegating multisig account
+   */
   async appendToMultisigWithSigner(signer: DelegatedLsigSigner) {
     await this.lsig.appendToMultisigWithSigner(signer);
   }
@@ -697,8 +771,17 @@ export class LogicSigAccount implements encoding.Encodable {
 
   /**
    * Turns this LogicSigAccount into a delegated LogicSig, signed by the given
-   * signer. If the delegating account is a multisig account, use
-   * `signMultisigWithSigner` instead.
+   * signer. This type of LogicSig has the authority to sign transactions on
+   * behalf of another account, called the delegating account.
+   *
+   * @remarks
+   * If the delegating account is a multisig account, use
+   * {@link LogicSigAccount.signMultisigWithSigner} instead.
+   *
+   * The delegating account is taken to be the address the signer reports having
+   * signed as, not any sending address the signer advertises: for a rekeyed
+   * account the latter is the address it sends transactions from, which is not
+   * the account authorizing this delegation.
    *
    * @param signer - The signer of the delegating account.
    */
@@ -720,6 +803,10 @@ export function logicSigFromByte(encoded: Uint8Array): LogicSig {
   return encoding.decodeMsgpack(encoded, LogicSig);
 }
 
+/**
+ * The domain-separation prefix prepended, along with the program's address, to
+ * data signed for verification by the `ed25519verify` opcode.
+ */
 export const SIGN_PROGRAM_DATA_PREFIX = new TextEncoder().encode('ProgData');
 
 /**

package/src/main.ts

@@ -67,6 +67,7 @@ export {
 } from './encoding/binarydata.js';
 export { encodeUint64, decodeUint64 } from './encoding/uint64.js';
 export { parseJSON, ParseJSONOptions, stringifyJSON } from './utils/utils.js';
+export { couldBeCurvePoint } from './utils/ed25519-check.js';
 export { default as generateAccount } from './account.js';
 export * from './types/block.js';
 export * from './types/statedelta.js';

package/src/mnemonic/mnemonic.ts

@@ -198,6 +198,8 @@ const PQ_KEY_PREFIX = new TextEncoder().encode('PQK');
  * @param mn - A 25-word Algorand mnemonic
  * @param scheme - The 2-byte ASCII PQ scheme identifier (e.g. "f1" for Falcon-1024)
  * @returns The 32-byte seed to hand to the scheme's key generator
+ * @throws If `mn` is not a valid 25-word mnemonic, or if `scheme` is not
+ *   exactly {@link PQ_SCHEME_SIZE} bytes
  */
 export function pq25WordMnemonicToSeed(
   mn: string,

package/src/pq-signer.ts

@@ -14,12 +14,49 @@ import { Transaction } from './transaction.js';
 import { EncodedPQSig } from './types/transactions/encoded.js';
 import { concatArrays } from './utils/utils.js';
 
+/**
+ * A post-quantum public key, its scheme identifier, and a function that signs
+ * raw bytes with the corresponding secret key.
+ *
+ * @remarks
+ * `pqSigner` receives the exact bytes to sign, with every domain-separation
+ * prefix already applied, so it can be backed by a key that never leaves a
+ * wallet, HSM or hardware device.
+ */
 export interface PQSigningKey {
+  /** The 2-byte ASCII PQ scheme identifier (e.g. "f1" for Falcon-1024). */
   pqScheme: Uint8Array;
+  /** The scheme's canonical public key. */
   pqPublicKey: Uint8Array;
+  /** Signs the given bytes verbatim with the corresponding secret key. */
   pqSigner: (bytesToSign: Uint8Array) => Promise<Uint8Array>;
 }
 
+/**
+ * Build the full set of signers for a post-quantum key from a function that
+ * signs raw bytes with it.
+ *
+ * @remarks
+ * The account address is derived from the scheme and public key via
+ * {@link addressFromPQKey}, so it does not have to be supplied. Every signature
+ * produced carries the scheme, canonical salt and public key alongside the
+ * signature bytes, which is what lets the network recover the authorizing
+ * address from the signature alone.
+ *
+ * PQ schemes cannot participate in multisig, so `delegatedLsigSigner` throws if
+ * given an `msig` argument, and no `mxBytesSigner` or `programDataSigner` is
+ * returned — signing arbitrary bytes and program data are ed25519-only
+ * operations.
+ *
+ * @param signingKey - The scheme, public key and raw signing function to build the signers from
+ * @param sendingAddress - The address transactions are sent from. Defaults to
+ *   the derived PQ address; supply it when the PQ key is the auth address of a
+ *   rekeyed account, in which case the produced transactions carry the derived
+ *   address in their `sgnr` field.
+ * @returns An address bundled with transaction, empty transaction and delegated
+ *   LogicSig signers
+ * @throws If `pqScheme` is not exactly 2 bytes
+ */
 export function addressWithSignersFromRawPQSigner(
   signingKey: PQSigningKey,
   sendingAddress?: Address

package/src/signer.ts

@@ -36,10 +36,25 @@ export type TransactionSigner = (
   indexesToSign: number[]
 ) => Promise<Uint8Array[]>;
 
+/**
+ * An address paired with a signer able to sign transactions on its behalf.
+ *
+ * @remarks
+ * `address` is the address transactions are sent from, which is not necessarily
+ * the address that authorizes them: for a rekeyed account the two differ, and
+ * `txnSigner` sets the transaction's `sgnr` field accordingly.
+ */
 export interface AddressWithTransactionSigner extends Addressable {
   txnSigner: TransactionSigner;
 }
 
+/**
+ * An address paired with a signer that produces placeholder signatures for it.
+ *
+ * @remarks
+ * Useful for post-quantum accounts, whose real signatures are large and slow to
+ * produce, when only a simulation of the group is needed.
+ */
 export interface AddressWithEmptyTransactionSigner extends Addressable {
   /**
    * A TransactionSigner that produces unsigned (or placeholder-signed)
@@ -49,11 +64,26 @@ export interface AddressWithEmptyTransactionSigner extends Addressable {
   emptyTxnSigner: TransactionSigner;
 }
 
-/** Function for signing logic signatures for delegation
- *  @param lsig - The logic signature that is being signed for delegation
- *  @param msig - Optional multisig account that should be set when a public key is signing as a subsigner of a multisig
- *  @returns The address of the delegator
- * */
+/**
+ * This type represents a function which can sign a LogicSig for delegation.
+ *
+ * @remarks
+ * Exactly one of `sig`, `lmsig` and `pqsig` is returned, according to the kind
+ * of key the signer holds and whether `msig` was supplied:
+ *
+ * - `sig` - an ed25519 signature from a single delegating account
+ * - `lmsig` - a multisig containing this signer's subsignature, returned when
+ *   `msig` is supplied
+ * - `pqsig` - a post-quantum signature from a single delegating account
+ *
+ * @param lsig - The logic signature that is being signed for delegation
+ * @param msig - Optional multisig account that should be set when a public key is signing as a subsigner of a multisig
+ * @returns A promise which resolves to the signature and the address that
+ *   produced it. When `msig` is omitted this is the delegating account; when
+ *   `msig` is supplied it is the individual subsigner rather than the multisig.
+ *   Either way it is an authorizing address, which is not necessarily the
+ *   address the signer sends transactions from.
+ */
 export type DelegatedLsigSigner = (
   lsig: LogicSig,
   msig?: MultisigMetadata
@@ -65,21 +95,54 @@ export type DelegatedLsigSigner = (
   )
 >;
 
+/**
+ * An address paired with a signer able to delegate a LogicSig to it.
+ */
 export interface AddressWithDelegatedLsigSigner extends Addressable {
   delegatedLsigSigner: DelegatedLsigSigner;
 }
 
+/**
+ * This type represents a function which can sign arbitrary bytes, for use with
+ * {@link verifyBytes}.
+ *
+ * @remarks
+ * The implementation is responsible for prepending the "MX" domain-separation
+ * prefix ({@link SIGN_BYTES_PREFIX}) before signing, so `bytesToSign` is the
+ * caller's bytes alone.
+ *
+ * @param bytesToSign - The bytes to sign, without any domain-separation prefix
+ * @returns A promise which resolves to the raw signature
+ */
 export type MxBytesSigner = (bytesToSign: Uint8Array) => Promise<Uint8Array>;
 
+/**
+ * An address paired with a signer able to sign arbitrary bytes on its behalf.
+ */
 export interface AddressWithMxBytesSigner extends Addressable {
   mxBytesSigner: MxBytesSigner;
 }
 
+/**
+ * This type represents a function which can sign data for use with the
+ * `ed25519verify` opcode from within a LogicSig's program.
+ *
+ * @remarks
+ * The implementation is responsible for prepending the "ProgData" prefix
+ * ({@link SIGN_PROGRAM_DATA_PREFIX}) and the LogicSig's address before signing.
+ *
+ * @param data - The data to sign, without any prefix
+ * @param lsig - The LogicSig whose program will verify the signature
+ * @returns A promise which resolves to the raw signature
+ */
 export type ProgramDataSigner = (
   data: Uint8Array,
   lsig: LogicSig
 ) => Promise<Uint8Array>;
 
+/**
+ * An address paired with a signer able to sign program data on its behalf.
+ */
 export interface AddressWithProgramDataSigner extends Addressable {
   programDataSigner: ProgramDataSigner;
 }

package/src/signing.ts

@@ -8,6 +8,11 @@ import { LogicSig, LogicSigAccount, sanityCheckProgram } from './logicsig.js';
 import { addressFromMultisigPreImg } from './multisig.js';
 import type { TransactionSigner } from './signer.js';
 
+/**
+ * The domain-separation prefix prepended to arbitrary bytes before signing them
+ * with {@link signBytes}, so that such a signature can never be mistaken for a
+ * signature over a transaction or a program.
+ */
 export const SIGN_BYTES_PREFIX = Uint8Array.from([77, 88]); // "MX"
 
 /**
@@ -34,6 +39,23 @@ export function signTransaction(txn: Transaction, sk: Uint8Array) {
   };
 }
 
+/**
+ * signTransactionWithSigner signs a single transaction with the given signer.
+ *
+ * @remarks
+ * This is the replacement for the deprecated {@link signTransaction}, which can
+ * only sign with a raw ed25519 secret key. Because a `TransactionSigner` signs
+ * a group, the transaction is passed as a one-element group and the single
+ * result is returned.
+ *
+ * The decoded `stxn` is returned alongside the blob so callers can read what
+ * the signer produced — its `sig`, `pqsig` or `msig` field, and the `sgnr` field
+ * naming the key that signed when it is not the transaction sender.
+ *
+ * @param txn - the transaction to sign
+ * @param signer - the signer to sign with
+ * @returns an object with blob, txID and stxn properties
+ */
 export async function signTransactionWithSigner(
   txn: Transaction,
   signer: TransactionSigner

package/src/types/block.ts

@@ -112,6 +112,10 @@ export class TxnCommitments implements Encodable {
         key: 'txn256', // sha256Commitment
         valueSchema: new FixedLengthByteArraySchema(32),
       },
+      {
+        key: 'txn512', // sha512Commitment
+        valueSchema: new FixedLengthByteArraySchema(64),
+      },
     ])
   );
 
@@ -126,12 +130,19 @@ export class TxnCommitments implements Encodable {
    */
   public sha256Commitment: Uint8Array;
 
+  /**
+   * Root of transaction vector commitment merkle tree using SHA512 hash function
+   */
+  public sha512Commitment: Uint8Array;
+
   constructor(params: {
     nativeSha512_256Commitment: Uint8Array;
     sha256Commitment: Uint8Array;
+    sha512Commitment?: Uint8Array;
   }) {
     this.nativeSha512_256Commitment = params.nativeSha512_256Commitment;
     this.sha256Commitment = params.sha256Commitment;
+    this.sha512Commitment = params.sha512Commitment ?? new Uint8Array(64);
   }
 
   // eslint-disable-next-line class-methods-use-this
@@ -143,6 +154,7 @@ export class TxnCommitments implements Encodable {
     return new Map<string, unknown>([
       ['txn', this.nativeSha512_256Commitment],
       ['txn256', this.sha256Commitment],
+      ['txn512', this.sha512Commitment],
     ]);
   }
 
@@ -153,6 +165,7 @@ export class TxnCommitments implements Encodable {
     return new TxnCommitments({
       nativeSha512_256Commitment: data.get('txn'),
       sha256Commitment: data.get('txn256'),
+      sha512Commitment: data.get('txn512'),
     });
   }
 }
@@ -509,6 +522,10 @@ export class BlockHeader implements Encodable {
         key: 'prev', // branch
         valueSchema: new BlockHashSchema(),
       },
+      {
+        key: 'prev512', // branch512
+        valueSchema: new FixedLengthByteArraySchema(64),
+      },
       {
         key: 'seed', // seed
         valueSchema: new ByteArraySchema(),
@@ -574,6 +591,14 @@ export class BlockHeader implements Encodable {
         valueSchema: ParticipationUpdates.encodingSchema,
         embedded: true,
       },
+      {
+        key: 'ld', // load
+        valueSchema: new Uint64Schema(),
+      },
+      {
+        key: 'ct', // congestionTax
+        valueSchema: new Uint64Schema(),
+      },
     ])
   );
 
@@ -587,6 +612,11 @@ export class BlockHeader implements Encodable {
    */
   public branch: Uint8Array;
 
+  /**
+   * Previous block hash, using SHA-512
+   */
+  public branch512: Uint8Array;
+
   /**
    * Sortition seed
    */
@@ -655,9 +685,22 @@ export class BlockHeader implements Encodable {
 
   public participationUpdates: ParticipationUpdates;
 
+  /**
+   * Load is the degree to which a block is full. Currently, it is based on the number of bytes in
+   * the final block, compared to the maximum allowed. It is expressed as a fixed-point integer with
+   * 6 digits of precision. So, 1,000,000 is a completely full block.
+   */
+  public load: bigint;
+
+  /**
+   * CongestionTax is the fee required, beyond the MinFee, for "normal" transactions in this block.
+   */
+  public congestionTax: bigint;
+
   public constructor(params: {
     round: bigint;
     branch: Uint8Array;
+    branch512?: Uint8Array;
     seed: Uint8Array;
     txnCommitments: TxnCommitments;
     timestamp: bigint;
@@ -673,9 +716,12 @@ export class BlockHeader implements Encodable {
     txnCounter: bigint;
     stateproofTracking: Map<number, StateProofTrackingData>;
     participationUpdates: ParticipationUpdates;
+    load?: bigint;
+    congestionTax?: bigint;
   }) {
     this.round = params.round;
     this.branch = params.branch;
+    this.branch512 = params.branch512 ?? new Uint8Array(64);
     this.seed = params.seed;
     this.txnCommitments = params.txnCommitments;
     this.timestamp = params.timestamp;
@@ -691,6 +737,8 @@ export class BlockHeader implements Encodable {
     this.txnCounter = params.txnCounter;
     this.stateproofTracking = params.stateproofTracking;
     this.participationUpdates = params.participationUpdates;
+    this.load = params.load ?? BigInt(0);
+    this.congestionTax = params.congestionTax ?? BigInt(0);
   }
 
   // eslint-disable-next-line class-methods-use-this
@@ -702,6 +750,7 @@ export class BlockHeader implements Encodable {
     const data = new Map<string, unknown>([
       ['rnd', this.round],
       ['prev', this.branch],
+      ['prev512', this.branch512],
       ['seed', this.seed],
       ['ts', this.timestamp],
       ['gen', this.genesisID],
@@ -711,6 +760,8 @@ export class BlockHeader implements Encodable {
       ['bi', this.bonus],
       ['pp', this.proposerPayout],
       ['tc', this.txnCounter],
+      ['ld', this.load],
+      ['ct', this.congestionTax],
       [
         'spt',
         convertMap(this.stateproofTracking, (key, value) => [
@@ -736,6 +787,7 @@ export class BlockHeader implements Encodable {
     return new BlockHeader({
       round: data.get('rnd'),
       branch: data.get('prev'),
+      branch512: data.get('prev512'),
       seed: data.get('seed'),
       txnCommitments: TxnCommitments.fromEncodingData(data),
       timestamp: data.get('ts'),
@@ -757,6 +809,8 @@ export class BlockHeader implements Encodable {
         ]
       ),
       participationUpdates: ParticipationUpdates.fromEncodingData(data),
+      load: data.get('ld'),
+      congestionTax: data.get('ct'),
     });
   }
 }