@did-btcr2/aggregation 0.1.0

package/dist/types/messages/bodies.d.ts

@@ -0,0 +1,177 @@
+/**
+ * Per-message-type body interfaces and a discriminated {@link AggregationMessage}
+ * union.
+ *
+ * {@link BaseBody} remains the superset-of-all-fields body type used by the
+ * raw {@link BaseMessage} class (see `base.ts`). The narrow interfaces here
+ * describe what each specific message type is *required* to carry and are
+ * exposed alongside type guards for consumers who want compile-time narrowing.
+ *
+ * Guards validate both `type` and the presence of required body fields so they
+ * are safe to use on messages that have round-tripped through JSON / a relay.
+ */
+import type { SerializedSMTProof } from '@did-btcr2/smt';
+import type { CohortConditions } from '../conditions.js';
+import type { BaseMessage } from './base.js';
+import { AGGREGATED_NONCE, AUTHORIZATION_REQUEST, COHORT_ADVERT, COHORT_OPT_IN, COHORT_OPT_IN_ACCEPT, COHORT_READY, DISTRIBUTE_AGGREGATED_DATA, FALLBACK_AUTHORIZATION_REQUEST, FALLBACK_SIGNATURE, NONCE_CONTRIBUTION, SIGNATURE_AUTHORIZATION, SUBMIT_NONINCLUDED, SUBMIT_UPDATE, VALIDATION_ACK } from './constants.js';
+export interface CohortAdvertBody extends CohortConditions {
+    cohortId: string;
+    network: string;
+    communicationPk: Uint8Array;
+}
+export interface CohortOptInBody {
+    cohortId: string;
+    participantPk: Uint8Array;
+    communicationPk: Uint8Array;
+}
+export interface CohortOptInAcceptBody {
+    cohortId: string;
+}
+export interface CohortReadyBody {
+    cohortId: string;
+    beaconAddress: string;
+    cohortKeys: Array<Uint8Array>;
+}
+export interface SubmitUpdateBody {
+    cohortId: string;
+    signedUpdate: Record<string, unknown>;
+}
+/**
+ * A member declines to submit an update this round (cooperative non-inclusion).
+ * Carries only the cohortId; membership is proven by the signed transport
+ * envelope (the sender DID), so no payload is needed.
+ */
+export interface SubmitNonIncludedBody {
+    cohortId: string;
+}
+export interface DistributeAggregatedDataBody {
+    cohortId: string;
+    beaconType: string;
+    signalBytesHex: string;
+    casAnnouncement?: Record<string, string>;
+    smtProof?: Record<string, unknown> | SerializedSMTProof;
+}
+export interface ValidationAckBody {
+    cohortId: string;
+    approved: boolean;
+}
+export interface AuthorizationRequestBody {
+    cohortId: string;
+    sessionId: string;
+    pendingTx: string;
+    prevOutScriptHex: string;
+    prevOutValue: string;
+}
+export interface NonceContributionBody {
+    cohortId: string;
+    sessionId: string;
+    nonceContribution: Uint8Array;
+}
+export interface AggregatedNonceBody {
+    cohortId: string;
+    sessionId: string;
+    aggregatedNonce: Uint8Array;
+}
+export interface SignatureAuthorizationBody {
+    cohortId: string;
+    sessionId: string;
+    partialSignature: Uint8Array;
+}
+/**
+ * Service asks members to authorize the k-of-n fallback (script-path) spend of
+ * the SAME beacon transaction (ADR 042). Carries the unsigned tx and the spent
+ * output so each member recomputes the script-path sighash itself. The fallback
+ * leaf script is included for cross-check; members recompute it from their own
+ * cohort state.
+ */
+export interface FallbackAuthorizationRequestBody {
+    cohortId: string;
+    sessionId: string;
+    pendingTx: string;
+    prevOutScriptHex: string;
+    prevOutValue: string;
+    fallbackLeafScriptHex: string;
+}
+/**
+ * A member's standalone BIP-340 signature over the fallback script-path sighash.
+ * `signerPk` is the member's x-only key (which CHECKSIGADD slot it satisfies).
+ */
+export interface FallbackSignatureBody {
+    cohortId: string;
+    sessionId: string;
+    signerPk: Uint8Array;
+    fallbackSignature: Uint8Array;
+}
+export type CohortAdvertMessage = BaseMessage & {
+    type: typeof COHORT_ADVERT;
+    body: CohortAdvertBody;
+};
+export type CohortOptInMessage = BaseMessage & {
+    type: typeof COHORT_OPT_IN;
+    body: CohortOptInBody;
+};
+export type CohortOptInAcceptMessage = BaseMessage & {
+    type: typeof COHORT_OPT_IN_ACCEPT;
+    body: CohortOptInAcceptBody;
+};
+export type CohortReadyMessage = BaseMessage & {
+    type: typeof COHORT_READY;
+    body: CohortReadyBody;
+};
+export type SubmitUpdateMessage = BaseMessage & {
+    type: typeof SUBMIT_UPDATE;
+    body: SubmitUpdateBody;
+};
+export type SubmitNonIncludedMessage = BaseMessage & {
+    type: typeof SUBMIT_NONINCLUDED;
+    body: SubmitNonIncludedBody;
+};
+export type DistributeAggregatedDataMessage = BaseMessage & {
+    type: typeof DISTRIBUTE_AGGREGATED_DATA;
+    body: DistributeAggregatedDataBody;
+};
+export type ValidationAckMessage = BaseMessage & {
+    type: typeof VALIDATION_ACK;
+    body: ValidationAckBody;
+};
+export type AuthorizationRequestMessage = BaseMessage & {
+    type: typeof AUTHORIZATION_REQUEST;
+    body: AuthorizationRequestBody;
+};
+export type NonceContributionMessage = BaseMessage & {
+    type: typeof NONCE_CONTRIBUTION;
+    body: NonceContributionBody;
+};
+export type AggregatedNonceMessage = BaseMessage & {
+    type: typeof AGGREGATED_NONCE;
+    body: AggregatedNonceBody;
+};
+export type SignatureAuthorizationMessage = BaseMessage & {
+    type: typeof SIGNATURE_AUTHORIZATION;
+    body: SignatureAuthorizationBody;
+};
+export type FallbackAuthorizationRequestMessage = BaseMessage & {
+    type: typeof FALLBACK_AUTHORIZATION_REQUEST;
+    body: FallbackAuthorizationRequestBody;
+};
+export type FallbackSignatureMessage = BaseMessage & {
+    type: typeof FALLBACK_SIGNATURE;
+    body: FallbackSignatureBody;
+};
+/** Discriminated union of every well-formed aggregation message. */
+export type AggregationMessage = CohortAdvertMessage | CohortOptInMessage | CohortOptInAcceptMessage | CohortReadyMessage | SubmitUpdateMessage | SubmitNonIncludedMessage | DistributeAggregatedDataMessage | ValidationAckMessage | AuthorizationRequestMessage | NonceContributionMessage | AggregatedNonceMessage | SignatureAuthorizationMessage | FallbackAuthorizationRequestMessage | FallbackSignatureMessage;
+export declare function isCohortAdvertMessage(m: BaseMessage): m is CohortAdvertMessage;
+export declare function isCohortOptInMessage(m: BaseMessage): m is CohortOptInMessage;
+export declare function isCohortOptInAcceptMessage(m: BaseMessage): m is CohortOptInAcceptMessage;
+export declare function isCohortReadyMessage(m: BaseMessage): m is CohortReadyMessage;
+export declare function isSubmitUpdateMessage(m: BaseMessage): m is SubmitUpdateMessage;
+export declare function isSubmitNonIncludedMessage(m: BaseMessage): m is SubmitNonIncludedMessage;
+export declare function isDistributeAggregatedDataMessage(m: BaseMessage): m is DistributeAggregatedDataMessage;
+export declare function isValidationAckMessage(m: BaseMessage): m is ValidationAckMessage;
+export declare function isAuthorizationRequestMessage(m: BaseMessage): m is AuthorizationRequestMessage;
+export declare function isNonceContributionMessage(m: BaseMessage): m is NonceContributionMessage;
+export declare function isAggregatedNonceMessage(m: BaseMessage): m is AggregatedNonceMessage;
+export declare function isSignatureAuthorizationMessage(m: BaseMessage): m is SignatureAuthorizationMessage;
+export declare function isFallbackAuthorizationRequestMessage(m: BaseMessage): m is FallbackAuthorizationRequestMessage;
+export declare function isFallbackSignatureMessage(m: BaseMessage): m is FallbackSignatureMessage;
+//# sourceMappingURL=bodies.d.ts.map

package/dist/types/messages/bodies.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bodies.d.ts","sourceRoot":"","sources":["../../../src/messages/bodies.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAGzD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,EACL,gBAAgB,EAChB,qBAAqB,EACrB,aAAa,EACb,aAAa,EACb,oBAAoB,EACpB,YAAY,EACZ,0BAA0B,EAC1B,8BAA8B,EAC9B,kBAAkB,EAClB,kBAAkB,EAClB,uBAAuB,EACvB,kBAAkB,EAClB,aAAa,EACb,cAAc,EACf,MAAM,gBAAgB,CAAC;AAIxB,MAAM,WAAW,gBAAiB,SAAQ,gBAAgB;IACxD,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,UAAU,CAAC;CAC7B;AAED,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,UAAU,CAAC;IAC1B,eAAe,EAAE,UAAU,CAAC;CAC7B;AAED,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;CAC/B;AAID,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACvC;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,4BAA4B;IAC3C,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,kBAAkB,CAAC;CACzD;AAED,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;CACnB;AAID,MAAM,WAAW,wBAAwB;IACvC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,gBAAgB,EAAE,MAAM,CAAC;IACzB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,iBAAiB,EAAE,UAAU,CAAC;CAC/B;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,EAAE,UAAU,CAAC;CAC7B;AAED,MAAM,WAAW,0BAA0B;IACzC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,gBAAgB,EAAE,UAAU,CAAC;CAC9B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,gCAAgC;IAC/C,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,gBAAgB,EAAE,MAAM,CAAC;IACzB,YAAY,EAAE,MAAM,CAAC;IACrB,qBAAqB,EAAE,MAAM,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,UAAU,CAAC;IACrB,iBAAiB,EAAE,UAAU,CAAC;CAC/B;AAID,MAAM,MAAM,mBAAmB,GAAG,WAAW,GAAG;IAAE,IAAI,EAAE,OAAO,aAAa,CAAC;IAAC,IAAI,EAAE,gBAAgB,CAAA;CAAE,CAAC;AACvG,MAAM,MAAM,kBAAkB,GAAG,WAAW,GAAG;IAAE,IAAI,EAAE,OAAO,aAAa,CAAC;IAAC,IAAI,EAAE,eAAe,CAAA;CAAE,CAAC;AACrG,MAAM,MAAM,wBAAwB,GAAG,WAAW,GAAG;IAAE,IAAI,EAAE,OAAO,oBAAoB,CAAC;IAAC,IAAI,EAAE,qBAAqB,CAAA;CAAE,CAAC;AACxH,MAAM,MAAM,kBAAkB,GAAG,WAAW,GAAG;IAAE,IAAI,EAAE,OAAO,YAAY,CAAC;IAAC,IAAI,EAAE,eAAe,CAAA;CAAE,CAAC;AACpG,MAAM,MAAM,mBAAmB,GAAG,WAAW,GAAG;IAAE,IAAI,EAAE,OAAO,aAAa,CAAC;IAAC,IAAI,EAAE,gBAAgB,CAAA;CAAE,CAAC;AACvG,MAAM,MAAM,wBAAwB,GAAG,WAAW,GAAG;IAAE,IAAI,EAAE,OAAO,kBAAkB,CAAC;IAAC,IAAI,EAAE,qBAAqB,CAAA;CAAE,CAAC;AACtH,MAAM,MAAM,+BAA+B,GAAG,WAAW,GAAG;IAAE,IAAI,EAAE,OAAO,0BAA0B,CAAC;IAAC,IAAI,EAAE,4BAA4B,CAAA;CAAE,CAAC;AAC5I,MAAM,MAAM,oBAAoB,GAAG,WAAW,GAAG;IAAE,IAAI,EAAE,OAAO,cAAc,CAAC;IAAC,IAAI,EAAE,iBAAiB,CAAA;CAAE,CAAC;AAC1G,MAAM,MAAM,2BAA2B,GAAG,WAAW,GAAG;IAAE,IAAI,EAAE,OAAO,qBAAqB,CAAC;IAAC,IAAI,EAAE,wBAAwB,CAAA;CAAE,CAAC;AAC/H,MAAM,MAAM,wBAAwB,GAAG,WAAW,GAAG;IAAE,IAAI,EAAE,OAAO,kBAAkB,CAAC;IAAC,IAAI,EAAE,qBAAqB,CAAA;CAAE,CAAC;AACtH,MAAM,MAAM,sBAAsB,GAAG,WAAW,GAAG;IAAE,IAAI,EAAE,OAAO,gBAAgB,CAAC;IAAC,IAAI,EAAE,mBAAmB,CAAA;CAAE,CAAC;AAChH,MAAM,MAAM,6BAA6B,GAAG,WAAW,GAAG;IAAE,IAAI,EAAE,OAAO,uBAAuB,CAAC;IAAC,IAAI,EAAE,0BAA0B,CAAA;CAAE,CAAC;AACrI,MAAM,MAAM,mCAAmC,GAAG,WAAW,GAAG;IAAE,IAAI,EAAE,OAAO,8BAA8B,CAAC;IAAC,IAAI,EAAE,gCAAgC,CAAA;CAAE,CAAC;AACxJ,MAAM,MAAM,wBAAwB,GAAG,WAAW,GAAG;IAAE,IAAI,EAAE,OAAO,kBAAkB,CAAC;IAAC,IAAI,EAAE,qBAAqB,CAAA;CAAE,CAAC;AAEtH,oEAAoE;AACpE,MAAM,MAAM,kBAAkB,GAC1B,mBAAmB,GACnB,kBAAkB,GAClB,wBAAwB,GACxB,kBAAkB,GAClB,mBAAmB,GACnB,wBAAwB,GACxB,+BAA+B,GAC/B,oBAAoB,GACpB,2BAA2B,GAC3B,wBAAwB,GACxB,sBAAsB,GACtB,6BAA6B,GAC7B,mCAAmC,GACnC,wBAAwB,CAAC;AAqC7B,wBAAgB,qBAAqB,CAAC,CAAC,EAAE,WAAW,GAAG,CAAC,IAAI,mBAAmB,CA0B9E;AAED,wBAAgB,oBAAoB,CAAC,CAAC,EAAE,WAAW,GAAG,CAAC,IAAI,kBAAkB,CAK5E;AAED,wBAAgB,0BAA0B,CAAC,CAAC,EAAE,WAAW,GAAG,CAAC,IAAI,wBAAwB,CAExF;AAED,wBAAgB,oBAAoB,CAAC,CAAC,EAAE,WAAW,GAAG,CAAC,IAAI,kBAAkB,CAK5E;AAED,wBAAgB,qBAAqB,CAAC,CAAC,EAAE,WAAW,GAAG,CAAC,IAAI,mBAAmB,CAI9E;AAED,wBAAgB,0BAA0B,CAAC,CAAC,EAAE,WAAW,GAAG,CAAC,IAAI,wBAAwB,CAExF;AAED,wBAAgB,iCAAiC,CAAC,CAAC,EAAE,WAAW,GAAG,CAAC,IAAI,+BAA+B,CAKtG;AAED,wBAAgB,sBAAsB,CAAC,CAAC,EAAE,WAAW,GAAG,CAAC,IAAI,oBAAoB,CAIhF;AAED,wBAAgB,6BAA6B,CAAC,CAAC,EAAE,WAAW,GAAG,CAAC,IAAI,2BAA2B,CAO9F;AAED,wBAAgB,0BAA0B,CAAC,CAAC,EAAE,WAAW,GAAG,CAAC,IAAI,wBAAwB,CAKxF;AAED,wBAAgB,wBAAwB,CAAC,CAAC,EAAE,WAAW,GAAG,CAAC,IAAI,sBAAsB,CAKpF;AAED,wBAAgB,+BAA+B,CAAC,CAAC,EAAE,WAAW,GAAG,CAAC,IAAI,6BAA6B,CAKlG;AAED,wBAAgB,qCAAqC,CAAC,CAAC,EAAE,WAAW,GAAG,CAAC,IAAI,mCAAmC,CAQ9G;AAED,wBAAgB,0BAA0B,CAAC,CAAC,EAAE,WAAW,GAAG,CAAC,IAAI,wBAAwB,CAMxF"}

package/dist/types/messages/constants.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Message type URLs for the did:btcr2 Aggregate Beacon protocol.
+ *
+ * Naming follows the spec (https://dcdpr.github.io/did-btcr2/beacons/aggregate-beacons.html):
+ * - Step 1 (Cohort Formation): COHORT_ADVERT, COHORT_OPT_IN, COHORT_OPT_IN_ACCEPT, COHORT_READY
+ * - Step 2 (Update Submission): SUBMIT_UPDATE
+ * - Step 3 (Aggregate & Validate): DISTRIBUTE_AGGREGATED_DATA, VALIDATION_ACK
+ * - Step 4 (Sign & Broadcast): AUTHORIZATION_REQUEST, NONCE_CONTRIBUTION,
+ *   AGGREGATED_NONCE, SIGNATURE_AUTHORIZATION
+ * - Step 4 fallback (k-of-n script path, ADR 042): FALLBACK_AUTHORIZATION_REQUEST,
+ *   FALLBACK_SIGNATURE
+ */
+export declare const AGGREGATION_MESSAGE_PREFIX = "https://btcr2.dev/aggregation";
+export declare const COHORT_ADVERT = "https://btcr2.dev/aggregation/keygen/cohort_advert";
+export declare const COHORT_OPT_IN = "https://btcr2.dev/aggregation/keygen/cohort_opt_in";
+export declare const COHORT_OPT_IN_ACCEPT = "https://btcr2.dev/aggregation/keygen/cohort_opt_in_accept";
+export declare const COHORT_READY = "https://btcr2.dev/aggregation/keygen/cohort_ready";
+export declare const SUBMIT_UPDATE = "https://btcr2.dev/aggregation/update/submit_update";
+/** A member with no update this round declines explicitly (cooperative non-inclusion). */
+export declare const SUBMIT_NONINCLUDED = "https://btcr2.dev/aggregation/update/submit_nonincluded";
+export declare const DISTRIBUTE_AGGREGATED_DATA = "https://btcr2.dev/aggregation/update/distribute_aggregated_data";
+export declare const VALIDATION_ACK = "https://btcr2.dev/aggregation/update/validation_ack";
+export declare const AUTHORIZATION_REQUEST = "https://btcr2.dev/aggregation/sign/authorization_request";
+export declare const NONCE_CONTRIBUTION = "https://btcr2.dev/aggregation/sign/nonce_contribution";
+export declare const AGGREGATED_NONCE = "https://btcr2.dev/aggregation/sign/aggregated_nonce";
+export declare const SIGNATURE_AUTHORIZATION = "https://btcr2.dev/aggregation/sign/signature_authorization";
+/** Service asks members to sign the fallback (k-of-n) script path of the beacon tx. */
+export declare const FALLBACK_AUTHORIZATION_REQUEST = "https://btcr2.dev/aggregation/sign/fallback_authorization_request";
+/** A member returns a standalone BIP-340 signature over the fallback script-path sighash. */
+export declare const FALLBACK_SIGNATURE = "https://btcr2.dev/aggregation/sign/fallback_signature";
+//# sourceMappingURL=constants.d.ts.map

package/dist/types/messages/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/messages/constants.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,0BAA0B,kCAAkC,CAAC;AAG1E,eAAO,MAAM,aAAa,uDAAuD,CAAC;AAClF,eAAO,MAAM,aAAa,uDAAuD,CAAC;AAClF,eAAO,MAAM,oBAAoB,8DAA8D,CAAC;AAChG,eAAO,MAAM,YAAY,sDAAsD,CAAC;AAGhF,eAAO,MAAM,aAAa,uDAAuD,CAAC;AAClF,0FAA0F;AAC1F,eAAO,MAAM,kBAAkB,4DAA4D,CAAC;AAC5F,eAAO,MAAM,0BAA0B,oEAAoE,CAAC;AAC5G,eAAO,MAAM,cAAc,wDAAwD,CAAC;AAGpF,eAAO,MAAM,qBAAqB,6DAA6D,CAAC;AAChG,eAAO,MAAM,kBAAkB,0DAA0D,CAAC;AAC1F,eAAO,MAAM,gBAAgB,wDAAwD,CAAC;AACtF,eAAO,MAAM,uBAAuB,+DAA+D,CAAC;AAKpG,uFAAuF;AACvF,eAAO,MAAM,8BAA8B,sEAAsE,CAAC;AAClH,6FAA6F;AAC7F,eAAO,MAAM,kBAAkB,0DAA0D,CAAC"}

package/dist/types/messages/factories.d.ts

@@ -0,0 +1,217 @@
+import type { CohortConditions } from '../conditions.js';
+import { BaseMessage } from './base.js';
+/**
+ * Step 1: Cohort Formation
+ * Factory functions for creating messages related to the cohort formation step, where cohorts are
+ * formed and participants opt in to join the cohort.
+ */
+type CohortAdvertMessage = CohortConditions & {
+    from: string;
+    cohortId: string;
+    network: string;
+    communicationPk: Uint8Array;
+};
+type CohortOptInMessage = {
+    from: string;
+    to: string;
+    cohortId: string;
+    participantPk: Uint8Array;
+    communicationPk: Uint8Array;
+};
+type CohortOptInAcceptMessage = {
+    from: string;
+    to: string;
+    cohortId: string;
+};
+type CohortReadyMessage = {
+    from: string;
+    to: string;
+    cohortId: string;
+    beaconAddress: string;
+    cohortKeys: Array<Uint8Array>;
+};
+/**
+ * Factory function for creating a Cohort Advert message, which is used to announce the formation of
+ * a new cohort and invite participants to join.
+ * @param {CohortAdvertMessage} fields - The fields required to create a Cohort Advert message.
+ * @returns {BaseMessage} The created Cohort Advert message.
+ */
+export declare function createCohortAdvertMessage(fields: CohortAdvertMessage): BaseMessage;
+/**
+ * Factory function for creating a Cohort Opt-In message, which is sent by a participant to express
+ * interest in joining a cohort.
+ * @param {CohortOptInMessage} fields - The fields required to create a Cohort Opt-In message, which
+ * is sent by a participant to express interest in joining a cohort.
+ * @returns {BaseMessage} The created Cohort Opt-In message.
+ */
+export declare function createCohortOptInMessage(fields: CohortOptInMessage): BaseMessage;
+export declare function createCohortOptInAcceptMessage(fields: CohortOptInAcceptMessage): BaseMessage;
+export declare function createCohortReadyMessage(fields: CohortReadyMessage): BaseMessage;
+/**
+ * Step 2: Update Submission
+ * Factory functions for creating messages related to the update submission step, where participants
+ * submit their signed updates for aggregation.
+ */
+type SubmitUpdateMessage = {
+    from: string;
+    to: string;
+    cohortId: string;
+    signedUpdate: Record<string, unknown>;
+};
+/**
+ * Factory function for creating a Submit Update message, which is sent by a participant to submit
+ * their signed update for aggregation.
+ * @param {SubmitUpdateMessage} fields - The fields required to create a Submit Update message,
+ * which is sent by a participant to submit their signed update for aggregation.
+ * @returns {BaseMessage} The created Submit Update message.
+ */
+export declare function createSubmitUpdateMessage(fields: SubmitUpdateMessage): BaseMessage;
+type SubmitNonIncludedMessage = {
+    from: string;
+    to: string;
+    cohortId: string;
+};
+/**
+ * Factory for a Submit Non-Included message: a member declares it has no update
+ * this round (cooperative non-inclusion). Membership is proven by the signed
+ * envelope, so the body carries only the cohortId.
+ */
+export declare function createSubmitNonIncludedMessage(fields: SubmitNonIncludedMessage): BaseMessage;
+/**
+ * Step 3: Aggregate & Validate
+ * Factory functions for creating messages related to the aggregate and validate step, where
+ * participants aggregate their updates and validate the aggregated data.
+ */
+type DistributeAggregatedDataMessage = {
+    from: string;
+    to: string;
+    cohortId: string;
+    beaconType: string;
+    signalBytesHex: string;
+    casAnnouncement?: Record<string, string>;
+    smtProof?: Record<string, unknown>;
+};
+type ValidationAckMessage = {
+    from: string;
+    to: string;
+    cohortId: string;
+    approved: boolean;
+};
+/**
+ * Factory function for creating a Distribute Aggregated Data message, which is sent by the
+ * aggregator to distribute the aggregated data to participants for validation.
+ * @param {DistributeAggregatedDataMessage} fields - The fields required to create a Distribute
+ * Aggregated Data message, which is sent by the aggregator to distribute the aggregated data to
+ * participants for validation.
+ * @returns {BaseMessage} The created Distribute Aggregated Data message.
+ */
+export declare function createDistributeAggregatedDataMessage(fields: DistributeAggregatedDataMessage): BaseMessage;
+/**
+ * Factory function for creating a Validation Acknowledgment message, which is sent by a participant
+ * to acknowledge.
+ * @param {ValidationAckMessage} fields - The fields required to create a Validation Acknowledgment
+ * message, which is sent by a participant to acknowledge the validation of the aggregated data.
+ * @returns {BaseMessage} The created Validation Acknowledgment message.
+ */
+export declare function createValidationAckMessage(fields: ValidationAckMessage): BaseMessage;
+/**
+ * Step 4: Signing
+ * Factory functions for creating messages related to the signing step, where participants request
+ * signatures, contribute nonces, and authorize signatures.
+ */
+type AuthorizationRequestMessage = {
+    from: string;
+    to: string;
+    cohortId: string;
+    sessionId: string;
+    pendingTx: string;
+    prevOutScriptHex: string;
+    prevOutValue: string;
+};
+type NonceContributionMessage = {
+    from: string;
+    to: string;
+    cohortId: string;
+    sessionId: string;
+    nonceContribution: Uint8Array;
+};
+type AggregatedNonceMessage = {
+    from: string;
+    to: string;
+    cohortId: string;
+    sessionId: string;
+    aggregatedNonce: Uint8Array;
+};
+type SignatureAuthorizationMessage = {
+    from: string;
+    to: string;
+    cohortId: string;
+    sessionId: string;
+    partialSignature: Uint8Array;
+};
+/**
+ * Factory function for creating an Authorization Request message, which is sent by a participant to
+ * request authorization for their signature.
+ * @param {AuthorizationRequestMessage} fields - The fields required to create an Authorization
+ * Request message, which is sent by a participant to request authorization for their signature.
+ * @returns {BaseMessage} The created Authorization Request message.
+ */
+export declare function createAuthorizationRequestMessage(fields: AuthorizationRequestMessage): BaseMessage;
+/**
+ * Factory function for creating a Nonce Contribution message, which is sent by a participant to
+ * contribute their nonce for the signature aggregation process.
+ * @param {NonceContributionMessage} fields - The fields required to create a Nonce Contribution
+ * message, which is sent by a participant to contribute their nonce for the signature aggregation
+ * process.
+ * @returns {BaseMessage} The created Nonce Contribution message.
+ */
+export declare function createNonceContributionMessage(fields: NonceContributionMessage): BaseMessage;
+/**
+ * Factory function for creating an Aggregated Nonce message, which is sent by the aggregator to
+ * distribute the aggregated nonce to participants for the signature aggregation process.
+ * @param {AggregatedNonceMessage} fields - The fields required to create an Aggregated Nonce
+ * message, which is sent by the aggregator to distribute the aggregated nonce to participants for
+ * the signature aggregation process.
+ * @returns {BaseMessage} The created Aggregated Nonce message.
+ */
+export declare function createAggregatedNonceMessage(fields: AggregatedNonceMessage): BaseMessage;
+/**
+ * Factory function for creating a Signature Authorization message, which is sent by a participant
+ * to authorize their partial signature for the signature aggregation process.
+ * @param {SignatureAuthorizationMessage} fields - The fields required to create a Signature
+ * Authorization message, which is sent by a participant to authorize their partial signature for
+ * the signature aggregation process.
+ * @returns {BaseMessage} The created Signature Authorization message.
+ */
+export declare function createSignatureAuthorizationMessage(fields: SignatureAuthorizationMessage): BaseMessage;
+type FallbackAuthorizationRequestMessage = {
+    from: string;
+    to: string;
+    cohortId: string;
+    sessionId: string;
+    pendingTx: string;
+    prevOutScriptHex: string;
+    prevOutValue: string;
+    fallbackLeafScriptHex: string;
+};
+type FallbackSignatureMessage = {
+    from: string;
+    to: string;
+    cohortId: string;
+    sessionId: string;
+    signerPk: Uint8Array;
+    fallbackSignature: Uint8Array;
+};
+/**
+ * Factory for a Fallback Authorization Request: the service asks members to
+ * authorize the k-of-n script-path spend of the beacon transaction when the
+ * optimistic n-of-n key path stalls (ADR 042).
+ */
+export declare function createFallbackAuthorizationRequestMessage(fields: FallbackAuthorizationRequestMessage): BaseMessage;
+/**
+ * Factory for a Fallback Signature: a member's standalone BIP-340 signature over
+ * the fallback script-path sighash (no nonce round).
+ */
+export declare function createFallbackSignatureMessage(fields: FallbackSignatureMessage): BaseMessage;
+export {};
+//# sourceMappingURL=factories.d.ts.map

package/dist/types/messages/factories.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"factories.d.ts","sourceRoot":"","sources":["../../../src/messages/factories.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACzD,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAkBxC;;;;GAIG;AACH,KAAK,mBAAmB,GAAG,gBAAgB,GAAG;IAC5C,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,UAAU,CAAC;CAC7B,CAAC;AACF,KAAK,kBAAkB,GAAG;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,UAAU,CAAC;IAC1B,eAAe,EAAE,UAAU,CAAC;CAC7B,CAAC;AACF,KAAK,wBAAwB,GAAG;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AACF,KAAK,kBAAkB,GAAG;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;CAC/B,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,mBAAmB,GAAG,WAAW,CAGlF;AAED;;;;;;GAMG;AACH,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,kBAAkB,GAAG,WAAW,CAGhF;AAED,wBAAgB,8BAA8B,CAAC,MAAM,EAAE,wBAAwB,GAAG,WAAW,CAG5F;AAED,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,kBAAkB,GAAG,WAAW,CAGhF;AAED;;;;GAIG;AACH,KAAK,mBAAmB,GAAG;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACvC,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,mBAAmB,GAAG,WAAW,CAGlF;AAED,KAAK,wBAAwB,GAAG;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,8BAA8B,CAAC,MAAM,EAAE,wBAAwB,GAAG,WAAW,CAG5F;AAED;;;;GAIG;AAEH,KAAK,+BAA+B,GAAG;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC,CAAC;AACF,KAAK,oBAAoB,GAAG;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,qCAAqC,CACnD,MAAM,EAAE,+BAA+B,GACtC,WAAW,CAGb;AAED;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CAAC,MAAM,EAAE,oBAAoB,GAAG,WAAW,CAGpF;AAED;;;;GAIG;AAEH,KAAK,2BAA2B,GAAG;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,gBAAgB,EAAE,MAAM,CAAC;IACzB,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AACF,KAAK,wBAAwB,GAAG;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,iBAAiB,EAAE,UAAU,CAAC;CAC/B,CAAC;AACF,KAAK,sBAAsB,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,EAAE,UAAU,CAAC;CAC7B,CAAC;AACF,KAAK,6BAA6B,GAAG;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,gBAAgB,EAAE,UAAU,CAAC;CAC9B,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,iCAAiC,CAAC,MAAM,EAAE,2BAA2B,GAAG,WAAW,CAGlG;AAED;;;;;;;GAOG;AACH,wBAAgB,8BAA8B,CAAC,MAAM,EAAE,wBAAwB,GAAG,WAAW,CAG5F;AAED;;;;;;;GAOG;AACH,wBAAgB,4BAA4B,CAAC,MAAM,EAAE,sBAAsB,GAAG,WAAW,CAGxF;AAED;;;;;;;GAOG;AACH,wBAAgB,mCAAmC,CAAC,MAAM,EAAE,6BAA6B,GAAG,WAAW,CAGtG;AAED,KAAK,mCAAmC,GAAG;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,gBAAgB,EAAE,MAAM,CAAC;IACzB,YAAY,EAAE,MAAM,CAAC;IACrB,qBAAqB,EAAE,MAAM,CAAC;CAC/B,CAAC;AACF,KAAK,wBAAwB,GAAG;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,UAAU,CAAC;IACrB,iBAAiB,EAAE,UAAU,CAAC;CAC/B,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,yCAAyC,CAAC,MAAM,EAAE,mCAAmC,GAAG,WAAW,CAGlH;AAED;;;GAGG;AACH,wBAAgB,8BAA8B,CAAC,MAAM,EAAE,wBAAwB,GAAG,WAAW,CAG5F"}

package/dist/types/messages/guards.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Checks if the provided type is a valid aggregation message type.
+ */
+export declare function isAggregationMessageType(type: string): boolean;
+/** Checks if the message type belongs to the keygen phase. */
+export declare function isKeygenMessageType(type: string): boolean;
+/** Checks if the message type belongs to the update phase. */
+export declare function isUpdateMessageType(type: string): boolean;
+/** Checks if the message type belongs to the signing phase. */
+export declare function isSignMessageType(type: string): boolean;
+//# sourceMappingURL=guards.d.ts.map

package/dist/types/messages/guards.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"guards.d.ts","sourceRoot":"","sources":["../../../src/messages/guards.ts"],"names":[],"mappings":"AAwCA;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAE9D;AAED,8DAA8D;AAC9D,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEzD;AAED,8DAA8D;AAC9D,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEzD;AAED,+DAA+D;AAC/D,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEvD"}

package/dist/types/messages/index.d.ts

@@ -0,0 +1,6 @@
+export * from './base.js';
+export * from './bodies.js';
+export * from './constants.js';
+export * from './factories.js';
+export * from './guards.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/messages/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/messages/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC"}

package/dist/types/participant.d.ts

@@ -0,0 +1,162 @@
+import type { SignedBTCR2Update } from '@did-btcr2/cryptosuite';
+import type { SerializedSMTProof } from '@did-btcr2/smt';
+import type { CohortConditions } from './conditions.js';
+import type { BaseMessage } from './messages/base.js';
+import type { ParticipantCohortPhaseType } from './phases.js';
+import type { AggregationSigner } from './signer.js';
+/**
+ * Cohort advert as discovered by the participant (UI: list of joinable cohorts).
+ * Carries the advertised {@link CohortConditions} (beaconType, minParticipants,
+ * maxParticipants, costs, ...) so a `shouldJoin` decision can inspect them.
+ */
+export interface CohortAdvert extends CohortConditions {
+    cohortId: string;
+    serviceDid: string;
+    network: string;
+    serviceCommunicationPk: Uint8Array;
+}
+/** Joined cohort info, available after the cohort is finalized. */
+export interface JoinedCohortInfo {
+    cohortId: string;
+    serviceDid: string;
+    beaconAddress: string;
+    cohortKeys: Array<Uint8Array>;
+}
+/** Aggregated data awaiting participant validation (UI: review for approval). */
+export interface PendingValidation {
+    cohortId: string;
+    beaconType: string;
+    signalBytesHex: string;
+    casAnnouncement?: Record<string, string>;
+    smtProof?: SerializedSMTProof;
+    /** Canonical hash of this participant's update; empty for a decliner. */
+    expectedHash: string;
+    matches: boolean;
+    /** True if this participant submitted an update; false if it declined (non-inclusion). */
+    included: boolean;
+}
+/** Pending signing request (UI: review tx for approval). */
+export interface PendingSigningRequest {
+    cohortId: string;
+    sessionId: string;
+    pendingTxHex: string;
+    /** Hex-encoded scriptPubKey of the UTXO being spent. Required for BIP-341 sighash. */
+    prevOutScriptHex: string;
+    prevOutValue: string;
+}
+/**
+ * Pending fallback signing request (UI: review the fallback spend for approval).
+ * The service fell back to the k-of-n script path; the member signs the SAME
+ * beacon transaction over the fallback script-path sighash (ADR 042).
+ */
+export interface PendingFallbackRequest {
+    cohortId: string;
+    sessionId: string;
+    pendingTxHex: string;
+    prevOutScriptHex: string;
+    prevOutValue: string;
+    /** Fallback leaf script, hex (advisory; the member recomputes it from its own cohort). */
+    fallbackLeafScriptHex: string;
+}
+export interface AggregationParticipantParams {
+    did: string;
+    /**
+     * The participant's MuSig2 signing capability. The raw secret is materialized
+     * only for the duration of a single nonce/partial-sign operation (see ADR 038);
+     * pass a {@link KeyPairAggregationSigner} to back it with an in-memory keypair.
+     */
+    signer: AggregationSigner;
+}
+/**
+ * Sans-I/O state machine for an Aggregation Participant.
+ *
+ * Manages multiple cohorts simultaneously. The client app drives the state
+ * machine via `receive()` (for incoming messages) and explicit action methods
+ * (for user decisions). All outgoing messages are returned for the caller to
+ * send via whatever transport.
+ *
+ * @class AggregationParticipant
+ */
+export declare class AggregationParticipant {
+    #private;
+    readonly did: string;
+    constructor({ did, signer }: AggregationParticipantParams);
+    /** The participant's compressed (33-byte) MuSig2 public key. Not secret. */
+    get publicKey(): Uint8Array;
+    /**
+     * Process an incoming message. Updates internal state but never produces
+     * outgoing messages: those come exclusively from action methods.
+     */
+    receive(message: BaseMessage): void;
+    /** Cohorts the participant has discovered but not yet joined. */
+    get discoveredCohorts(): ReadonlyMap<string, CohortAdvert>;
+    /**
+     * User action: join a discovered cohort.
+     * Returns the opt-in message to send.
+     */
+    joinCohort(cohortId: string): BaseMessage[];
+    /** Cohorts that have been finalized: beacon address available. */
+    get joinedCohorts(): ReadonlyMap<string, JoinedCohortInfo>;
+    /**
+     * User action: submit a signed BTCR2 update for inclusion in the cohort's
+     * aggregated signal.
+     */
+    submitUpdate(cohortId: string, signedUpdate: SignedBTCR2Update): BaseMessage[];
+    /**
+     * User action: decline to submit an update this round (cooperative
+     * non-inclusion). The member stays in the cohort and still signs; it will be
+     * absent from the CAS Announcement Map, or carry a non-inclusion leaf in the
+     * SMT. Returns the SUBMIT_NONINCLUDED message to send.
+     */
+    declineUpdate(cohortId: string): BaseMessage[];
+    /** Aggregated data awaiting user validation. */
+    get pendingValidations(): ReadonlyMap<string, PendingValidation>;
+    /**
+     * The validated aggregated data retained for a cohort, regardless of phase.
+     * Unlike {@link pendingValidations} (which lists only cohorts still awaiting
+     * the validate decision), this returns the stored validation, including the
+     * participant's sidecar (the CAS Announcement map or its SMT inclusion proof),
+     * so it is still readable once the cohort reaches Complete. Returns
+     * undefined before aggregated data has been received.
+     */
+    getValidation(cohortId: string): PendingValidation | undefined;
+    /**
+     * User action: approve aggregated data and send validation ack.
+     */
+    approveValidation(cohortId: string): BaseMessage[];
+    /**
+     * User action: reject aggregated data and send rejection ack.
+     */
+    rejectValidation(cohortId: string): BaseMessage[];
+    /** Signing requests awaiting user approval. */
+    get pendingSigningRequests(): ReadonlyMap<string, PendingSigningRequest>;
+    /**
+     * User action: approve signing and generate nonce contribution.
+     */
+    approveNonce(cohortId: string): BaseMessage[];
+    /**
+     * User action: generate and return the partial signature.
+     * In most UIs this is automatic after AwaitingPartialSig, but exposing it
+     * as an explicit action lets the client UI confirm before signing if desired.
+     */
+    generatePartialSignature(cohortId: string): BaseMessage[];
+    /** Fallback signing requests awaiting user approval (UI: review the fallback spend). */
+    get pendingFallbackRequests(): ReadonlyMap<string, PendingFallbackRequest>;
+    /**
+     * User action: authorize the fallback spend. Recomputes the k-of-n fallback
+     * leaf from the member's OWN cohort state (not the service-provided script),
+     * computes the BIP-341 script-path sighash over the requested transaction, and
+     * returns a standalone BIP-340 signature (no nonce round). The member completes
+     * once it has contributed; the service needs only k of these.
+     */
+    approveFallback(cohortId: string): BaseMessage[];
+    getCohortPhase(cohortId: string): ParticipantCohortPhaseType | undefined;
+    /**
+     * Zeroize any retained MuSig2 secret nonces across all cohorts. The raw
+     * signing key is never held here (it lives behind the {@link AggregationSigner}
+     * and is wiped per-operation), but an abandoned signing session can still hold
+     * a secret nonce; call this on teardown to clear it deterministically.
+     */
+    clearSecrets(): void;
+}
+//# sourceMappingURL=participant.d.ts.map

package/dist/types/participant.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"participant.d.ts","sourceRoot":"","sources":["../../src/participant.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,KAAK,EAAE,kBAAkB,EAAC,MAAM,gBAAgB,CAAC;AAMxD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAIxD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAqBtD,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,aAAa,CAAC;AAE9D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AA2BrD;;;;GAIG;AACH,MAAM,WAAW,YAAa,SAAQ,gBAAgB;IACpD,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,sBAAsB,EAAE,UAAU,CAAC;CACpC;AAED,mEAAmE;AACnE,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;CAC/B;AAED,iFAAiF;AACjF,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzC,QAAQ,CAAC,EAAE,kBAAkB,CAAC;IAC9B,yEAAyE;IACzE,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,OAAO,CAAC;IACjB,0FAA0F;IAC1F,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,4DAA4D;AAC5D,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,sFAAsF;IACtF,gBAAgB,EAAE,MAAM,CAAC;IACzB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,gBAAgB,EAAE,MAAM,CAAC;IACzB,YAAY,EAAE,MAAM,CAAC;IACrB,0FAA0F;IAC1F,qBAAqB,EAAE,MAAM,CAAC;CAC/B;AAsBD,MAAM,WAAW,4BAA4B;IAC3C,GAAG,EAAE,MAAM,CAAC;IACZ;;;;OAIG;IACH,MAAM,EAAE,iBAAiB,CAAC;CAC3B;AAED;;;;;;;;;GASG;AACH,qBAAa,sBAAsB;;IACjC,SAAgB,GAAG,EAAE,MAAM,CAAC;gBAQhB,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,4BAA4B;IAKzD,4EAA4E;IAC5E,IAAW,SAAS,IAAI,UAAU,CAEjC;IAGD;;;OAGG;IACI,OAAO,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI;IAmC1C,iEAAiE;IACjE,IAAW,iBAAiB,IAAI,WAAW,CAAC,MAAM,EAAE,YAAY,CAAC,CAQhE;IAyBD;;;OAGG;IACI,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,WAAW,EAAE;IA4ClD,kEAAkE;IAClE,IAAW,aAAa,IAAI,WAAW,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAahE;IAqBD;;;OAGG;IACI,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,iBAAiB,GAAG,WAAW,EAAE;IAsBrF;;;;;OAKG;IACI,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,WAAW,EAAE;IAuBrD,gDAAgD;IAChD,IAAW,kBAAkB,IAAI,WAAW,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAQtE;IAED;;;;;;;OAOG;IACI,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,iBAAiB,GAAG,SAAS;IA8CrE;;OAEG;IACI,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,WAAW,EAAE;IAiBzD;;OAEG;IACI,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,WAAW,EAAE;IAkBxD,+CAA+C;IAC/C,IAAW,sBAAsB,IAAI,WAAW,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAQ9E;IAiDD;;OAEG;IACI,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,WAAW,EAAE;IAqEpD;;;;OAIG;IACI,wBAAwB,CAAC,QAAQ,EAAE,MAAM,GAAG,WAAW,EAAE;IA+BhE,wFAAwF;IACxF,IAAW,uBAAuB,IAAI,WAAW,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAQhF;IAqCD;;;;;;OAMG;IACI,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,WAAW,EAAE;IA8ChD,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,0BAA0B,GAAG,SAAS;IAI/E;;;;;OAKG;IACI,YAAY,IAAI,IAAI;CAK5B"}