@ome-labs/wasm 0.0.0-stage → 0.1.0

package/dist/main/node/ome_wasm.d.ts

@@ -0,0 +1,614 @@
+/* tslint:disable */
+/* eslint-disable */
+// Generated from crates/wasm by `pnpm --filter @ome-labs/wasm generate`. Do not edit.
+
+import type {
+    ErrorKind,
+    Hex32,
+    Hex64,
+    HexBytes,
+    Joiner,
+    Manifest,
+    MemberPartials,
+    Point,
+    Secret,
+    VaultConfig,
+} from "@ome-labs/api";
+
+/**
+ * A vault as the bindings check proposals against it: its committee manifest and the config note read from the
+ * chain.
+ */
+export type VaultInput = {
+    /**
+     * The committee manifest the keeper serves.
+     */
+    manifest: Manifest;
+    /**
+     * The vault's config note.
+     */
+    config: VaultConfig;
+};
+
+/**
+ * The chain a transaction is bound to, from the node.
+ */
+export type Chain = {
+    /**
+     * L1 chain id, as a field.
+     */
+    chainId: Hex32;
+    /**
+     * Rollup version, as a field.
+     */
+    version: Hex32;
+};
+
+/**
+ * How a viewing share maps to a share of the address secret.
+ */
+export type AddressContext = {
+    /**
+     * The vault address.
+     */
+    address: Hex32;
+    /**
+     * `1` or `-1`: the sign Aztec applies to the address secret.
+     */
+    sign: number;
+    /**
+     * `preaddress · G + Ivpk`, normalised to positive `y`.
+     */
+    addressPoint: Point;
+};
+
+/**
+ * A threshold ECDH batch to verify and combine: the keeper's `ecdh.batch` responses with what they answer.
+ */
+export type CombineRequest = {
+    /**
+     * Committee epoch the partials are bound to.
+     */
+    epoch: number;
+    /**
+     * Vault preaddress.
+     */
+    preaddress: Hex32;
+    /**
+     * Group incoming viewing key `Ivpk`.
+     */
+    ivpk: Point;
+    /**
+     * Verification shares `Y_i` in member order.
+     */
+    verificationShares: Array<Point>;
+    /**
+     * Viewing threshold `t_v`.
+     */
+    threshold: number;
+    /**
+     * Input points, in the order the partials answer them.
+     */
+    inputs: Array<Point>;
+    /**
+     * Members' partials.
+     */
+    responses: Array<MemberPartials>;
+};
+
+/**
+ * Combined points.
+ */
+export type CombineResult = {
+    /**
+     * `address_secret · input` for each input, in order.
+     */
+    points: Array<Point>;
+    /**
+     * Members whose response was malformed or carried an invalid proof.
+     */
+    invalidMembers: Array<number>;
+};
+
+/**
+ * Where a call runs.
+ */
+export type CallKind = "private" | "public";
+
+/**
+ * One call of a vault transaction.
+ */
+export type Call = {
+    /**
+     * The function signature, when known; it must hash to `selector`.
+     */
+    signature: string | null;
+    /**
+     * Target contract.
+     */
+    to: Hex32;
+    /**
+     * Function selector.
+     */
+    selector: number;
+    /**
+     * Private or public.
+     */
+    kind: CallKind;
+    /**
+     * The call may not modify state.
+     */
+    isStatic: boolean;
+    /**
+     * Hide the vault as `msg_sender` (public calls only).
+     */
+    hideMsgSender: boolean;
+    /**
+     * Encoded arguments.
+     */
+    args: Array<Hex32>;
+};
+
+/**
+ * The calls a payload carries, and the PXE's execution data.
+ */
+export type ExecutionRequest = {
+    /**
+     * At most five calls; none is a cancellation.
+     */
+    calls: Array<Call>;
+    /**
+     * Execution data the signatures do not cover.
+     */
+    extras: HexBytes;
+};
+
+/**
+ * What a member proposes.
+ */
+export type Draft = {
+    /**
+     * The calls.
+     */
+    calls: Array<Call>;
+    /**
+     * Execution data the signatures do not cover.
+     */
+    extras: HexBytes;
+    /**
+     * Entrypoint nonce; cancelling burns it.
+     */
+    txNonce: Hex32;
+    /**
+     * Approval deadline, Unix seconds.
+     */
+    expiresAt: number;
+    /**
+     * Summary shown to the members.
+     */
+    summary: string;
+    /**
+     * Proposing member (1-based).
+     */
+    proposer: number;
+};
+
+/**
+ * A proposal ready to store with the keeper (`proposals.put`, `payloads.put`).
+ */
+export type BuiltProposal = {
+    /**
+     * Proposal id.
+     */
+    id: Hex32;
+    /**
+     * The proposal's canonical encoding.
+     */
+    proposal: HexBytes;
+    /**
+     * The payload's canonical encoding.
+     */
+    payload: HexBytes;
+    /**
+     * Outer hash the approvals sign over.
+     */
+    outerHash: Hex32;
+    /**
+     * The message an approval signs.
+     */
+    approvalMessage: Hex32;
+};
+
+/**
+ * A decoded proposal.
+ */
+export type ProposalInfo = {
+    /**
+     * Proposal id.
+     */
+    id: Hex32;
+    /**
+     * Config version it was made under.
+     */
+    configVersion: number;
+    /**
+     * Outer hash.
+     */
+    outerHash: Hex32;
+    /**
+     * Deadline, Unix seconds.
+     */
+    expiresAt: number;
+    /**
+     * Entrypoint nonce.
+     */
+    txNonce: Hex32;
+    /**
+     * Fee method; Ome proposals use only `0` (external).
+     */
+    feeMethod: number;
+    /**
+     * Hash of the referenced payload.
+     */
+    payloadHash: Hex32;
+    /**
+     * Length of the referenced payload.
+     */
+    payloadLen: number;
+    /**
+     * Summary.
+     */
+    summary: string;
+    /**
+     * Proposing member.
+     */
+    proposer: number;
+};
+
+/**
+ * A decoded approval.
+ */
+export type ApprovalInfo = {
+    /**
+     * Proposal id.
+     */
+    proposal: Hex32;
+    /**
+     * Signer slot, 0-based.
+     */
+    slot: number;
+    /**
+     * Schnorr signature.
+     */
+    signature: Hex64;
+};
+
+/**
+ * A decoded rejection.
+ */
+export type RejectionInfo = {
+    /**
+     * Proposal id.
+     */
+    proposal: Hex32;
+    /**
+     * Signer slot, 0-based.
+     */
+    slot: number;
+    /**
+     * Reason shown to the members.
+     */
+    reason: string;
+    /**
+     * Schnorr signature.
+     */
+    signature: Hex64;
+};
+
+/**
+ * Where a proposal stands.
+ */
+export type TallyStatus = "pending" | "approved" | "blocked" | "expired";
+
+/**
+ * A vote the tally refused.
+ */
+export type RefusedVote = {
+    /**
+     * Position in the approvals or rejections given.
+     */
+    index: number;
+    /**
+     * Whether it was an approval.
+     */
+    approval: boolean;
+    /**
+     * Why.
+     */
+    reason: string;
+};
+
+/**
+ * The votes on a proposal.
+ */
+export type TallyResult = {
+    /**
+     * Where it stands.
+     */
+    status: TallyStatus;
+    /**
+     * Counted approvals.
+     */
+    approvals: number;
+    /**
+     * Counted rejections.
+     */
+    rejections: number;
+    /**
+     * The spending threshold `k`.
+     */
+    needed: number;
+    /**
+     * Votes that did not verify.
+     */
+    refused: Array<RefusedVote>;
+    /**
+     * The 49-field auth witness, once approved.
+     */
+    witness: Array<Hex32> | null;
+};
+
+/**
+ * A proposed membership rotation: the new signers, spending threshold and committee from the reshare.
+ */
+export type Rotation = {
+    /**
+     * New signer keys in slot order.
+     */
+    signers: Array<Point>;
+    /**
+     * New spending threshold `k`.
+     */
+    threshold: number;
+    /**
+     * New viewing threshold `t_v`.
+     */
+    viewingThreshold: number;
+    /**
+     * The verification shares the reshare produced.
+     */
+    verificationShares: Array<Point>;
+};
+
+/**
+ * A threshold choice members should make knowingly.
+ */
+export type Warning = "single-signer" | "no-spare-signer" | "two-can-read" | "no-spare-viewer";
+
+/**
+ * A committee dealt from one secret, for tests (`@ome-labs/wasm/testing`).
+ */
+export type DealtCommittee = {
+    /**
+     * Group key: the secret times the generator.
+     */
+    groupKey: Point;
+    /**
+     * Members' viewing shares, in member order.
+     */
+    shares: Array<Hex32>;
+    /**
+     * Members' verification shares, in member order.
+     */
+    verificationShares: Array<Point>;
+};
+
+/** What every function throws: an `Error` named `OmeWasmError` with the API error kind. */
+export interface OmeWasmError extends Error {
+    name: "OmeWasmError";
+    kind: ErrorKind;
+}
+
+
+
+/**
+ * An opened signing key. It signs only proposals `ome-protocol` accepts, and is wiped when freed.
+ */
+export class UnlockedSigner {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Approves a proposal after checking it (as `checkProposal`); a rotation is refused here, see `approveRotation`.
+     * Returns the approval to store with the keeper.
+     */
+    approve(vault: VaultInput, chain: Chain, proposal: HexBytes, payload: HexBytes, now: number): HexBytes;
+    /**
+     * Approves a membership rotation the member reviewed: the payload must be the `rotate_membership` call for
+     * `rotation`, plus at most fee payment calls to one of `feePayers` (the fee payer contracts this member's own
+     * configuration trusts), and the rotation must pass the contract's rules and hold the vault's key.
+     */
+    approveRotation(vault: VaultInput, chain: Chain, proposal: HexBytes, payload: HexBytes, rotation: Rotation, feePayers: Hex32[], now: number): HexBytes;
+    /**
+     * Approves a signer swap: the payload must be one `rotate_membership` call that replaces one member's key and
+     * changes nothing else, plus at most fee payment calls to one of `feePayers`. Returns the approval to store with
+     * the keeper.
+     */
+    approveSignerSwap(vault: VaultInput, chain: Chain, proposal: HexBytes, payload: HexBytes, feePayers: Hex32[], now: number): HexBytes;
+    /**
+     * Opens a sealed signer.
+     */
+    static open(sealed: string, secret: Secret): UnlockedSigner;
+    /**
+     * The public key, as it appears in the vault's signer set.
+     */
+    publicKey(): Point;
+    /**
+     * Rejects a proposal with a reason shown to the other members. Returns the rejection to store with the keeper.
+     */
+    reject(vault: VaultInput, proposal: HexBytes, reason: string): HexBytes;
+}
+
+/**
+ * The address context of a preaddress and group incoming viewing key: the vault address and the sign Aztec applies.
+ */
+export function addressContext(preaddress: Hex32, ivpk: Point): AddressContext;
+
+/**
+ * Each member's public share of the address secret, `A_i`, from its verification share, in member order.
+ */
+export function addressPublicShares(preaddress: Hex32, ivpk: Point, verificationShares: Point[]): Point[];
+
+/**
+ * The entrypoint's app payload hash (the authwit's inner hash).
+ */
+export function appPayloadHash(calls: Call[], txNonce: Hex32): Hex32;
+
+/**
+ * What each signer signs to approve: `Poseidon2("ome.approval.v0", [vault, outerHash, configVersion, expiresAt])`.
+ */
+export function approvalMessage(vault: Hex32, outerHash: Hex32, configVersion: number, expiresAt: number): Hex32;
+
+/**
+ * Builds a proposal and its payload from a draft, computing the outer hash from the calls.
+ */
+export function buildProposal(vault: VaultInput, chain: Chain, draft: Draft): BuiltProposal;
+
+/**
+ * Checks a received proposal before review: the payload is the one referenced, hashes to the outer hash on this vault
+ * and chain, the config is current, the deadline has not passed and fees stay off the vault. Returns the calls.
+ */
+export function checkProposal(vault: VaultInput, chain: Chain, proposal: HexBytes, payload: HexBytes, now: number): ExecutionRequest;
+
+/**
+ * Checks a rotation against the vault as the contract would, and returns the config it would store.
+ */
+export function checkRotation(vault: VaultInput, rotation: Rotation): VaultConfig;
+
+/**
+ * The commitment to the viewing committee: `t_v` and the verification shares in member order.
+ */
+export function committeeCommitment(viewingThreshold: number, shares: Point[]): Hex32;
+
+/**
+ * The Feldman commitments of a committee's polynomial, `C_0 … C_{t_v - 1}`: the `committee_polynomial` argument of
+ * `rotate_membership`, which the contract checks every share against and `C_0` against the vault's `Ivpk`.
+ */
+export function committeePolynomial(viewingThreshold: number, verificationShares: Point[]): Point[];
+
+/**
+ * An approval's fields. The signature is not checked; see [`verify_approval`].
+ */
+export function decodeApproval(approval: HexBytes): ApprovalInfo;
+
+/**
+ * The newcomer a join request names, after checking that its keeper signed it. The member planning the rotation
+ * still confirms out of band that it came from the person they mean to add.
+ */
+export function decodeJoinRequest(request: string): Joiner;
+
+/**
+ * A proposal's fields.
+ */
+export function decodeProposal(proposal: HexBytes): ProposalInfo;
+
+/**
+ * A rejection's fields. The signature is not checked; see [`verify_rejection`].
+ */
+export function decodeRejection(rejection: HexBytes): RejectionInfo;
+
+/**
+ * The 49-field auth witness: signer keys, one signature per slot (`null` where the signer did not approve) and the
+ * deadline.
+ */
+export function encodeWitness(signerKeys: Point[], signatures: (Hex64 | null)[], expiresAt: number): Hex32[];
+
+/**
+ * The tagging secret for the vault's own unconstrained notes in committee epoch `epoch`, derived from that epoch's
+ * ceremony transcript (the founding DKG, then each reshare), so a member removed earlier cannot derive it.
+ */
+export function epochTaggingSecret(vault: Hex32, epoch: number, transcript: Hex64): Point;
+
+/**
+ * Generates a signing key and returns it sealed (the JSON document to store). A passphrase seals with Argon2id.
+ */
+export function generateSigner(secret: Secret): string;
+
+/**
+ * The outer hash the vault authorizes for `calls` with `txNonce` on `vault` and `chain`.
+ */
+export function outerHash(vault: Hex32, chain: Chain, txNonce: Hex32, calls: Call[]): Hex32;
+
+/**
+ * The risks of spending threshold `k`, viewing threshold `t_v` and `n` members. None blocks a vault.
+ */
+export function policyWarnings(threshold: number, viewingThreshold: number, members: number): Warning[];
+
+/**
+ * Aztec's preaddress `Poseidon2([publicKeysHash, partialAddress], 993442748)`.
+ */
+export function preaddress(publicKeysHash: Hex32, partialAddress: Hex32): Hex32;
+
+/**
+ * What a member signs to reject proposal `proposalId`.
+ */
+export function rejectionMessage(vault: Hex32, proposalId: Hex32): Hex32;
+
+/**
+ * The `rotate_membership` call that performs a rotation, to propose.
+ */
+export function rotationCall(vault: VaultInput, rotation: Rotation): Call;
+
+/**
+ * The public key of a sealed signer, readable without the secret.
+ */
+export function sealedPublicKey(sealed: string): Point;
+
+/**
+ * The key a passphrase derives for this sealed signer, checked by opening it. Keep it behind the platform's
+ * keychain or biometrics and unlock with `{ key }` without running Argon2id again.
+ */
+export function sealingKey(sealed: string, passphrase: string): Hex32;
+
+/**
+ * A function's selector from its signature, e.g. `transfer_private_to_private((Field),(Field),u128,Field)`.
+ */
+export function selector(signature: string): number;
+
+/**
+ * The commitment to the ordered signer keys stored in the config note.
+ */
+export function signerSetCommitment(keys: Point[]): Hex32;
+
+/**
+ * The signer slot a payload's `rotate_membership` call swaps, if it is a signer swap of the vault (one key replaced,
+ * the committee and thresholds unchanged); `null` for a payload that rotates nothing or reshares.
+ */
+export function signerSwapSlot(vault: VaultInput, payload: HexBytes): number | null;
+
+/**
+ * Counts the votes on a proposal at `now`: each slot's first valid vote counts, invalid ones are listed, and the
+ * witness is built once `k` members approved.
+ */
+export function tally(vault: VaultInput, proposal: HexBytes, approvals: HexBytes[], rejections: HexBytes[], now: number): TallyResult;
+
+/**
+ * Verifies every partial and combines `t_v` valid ones per input. Fails if an input lacks `t_v` valid partials.
+ */
+export function verifyAndCombine(request: CombineRequest): CombineResult;
+
+/**
+ * Throws unless `approval` is for `proposal` and signed by the key in its slot.
+ */
+export function verifyApproval(vault: VaultInput, proposal: HexBytes, approval: HexBytes): void;
+
+/**
+ * Throws unless `rejection` is for `proposal` and signed by the key in its slot.
+ */
+export function verifyRejection(vault: VaultInput, proposal: HexBytes, rejection: HexBytes): void;
+
+/**
+ * Throws unless the verification shares interpolate to `groupKey`: the reshared committee still holds the vault's
+ * viewing key.
+ */
+export function verifyRotationShares(groupKey: Point, viewingThreshold: number, verificationShares: Point[]): void;