Skip to content
Union Payments

Prover.ts

This module provides the Prover service.

Added in v0.4.0

models

Section titled “models”

Options

Section titled “Options”

Signature

export declare const Options: S.Struct<{
  proverUrl: S.optionalWith<S.Union<[typeof S.URLFromSelf, typeof S.URL]>, { default: () => URL }>
}>

Added in v0.4.0

Options (type alias)

Section titled “Options (type alias)”

Signature

export type Options = typeof Options.Type

Added in v0.4.0

Proof

Section titled “Proof”

Signature

export declare const Proof: S.Struct<{
  proof: S.Tuple<
    [
      typeof S.String,
      typeof S.String,
      typeof S.String,
      typeof S.String,
      typeof S.String,
      typeof S.String,
      typeof S.String,
      typeof S.String
    ]
  >
  commitments: S.Tuple2<typeof S.String, typeof S.String>
  commitmentPok: S.Tuple2<typeof S.String, typeof S.String>
  publicInputs: S.Array$<typeof S.String>
}>

Added in v0.4.0

Proof (type alias)

Section titled “Proof (type alias)”

Signature

export type Proof = typeof Proof.Type

Added in v0.4.0

ProofFromBytes

Section titled “ProofFromBytes”

Signature

export declare const ProofFromBytes: S.transform<
  S.transform<typeof S.Uint8ArrayFromSelf, typeof S.String>,
  S.transform<
    S.SchemaClass<unknown, string, never>,
    S.Struct<{
      proof: S.Tuple<
        [
          typeof S.String,
          typeof S.String,
          typeof S.String,
          typeof S.String,
          typeof S.String,
          typeof S.String,
          typeof S.String,
          typeof S.String
        ]
      >
      commitments: S.Tuple2<typeof S.String, typeof S.String>
      commitmentPok: S.Tuple2<typeof S.String, typeof S.String>
      publicInputs: S.Array$<typeof S.String>
    }>
  >
>

Added in v0.4.0

ProofResult (interface)

Section titled “ProofResult (interface)”

Result from the prover server after proof generation.

Signature

export interface ProofResult {
  /** Whether proof generation succeeded */
  success: boolean
  /** Serialized proof data (only present on success) */
  proofJson?: Uint8Array
  /** Error message (only present on failure) */
  error?: string
  /** Timestamp when the proof was created */
  createdAt?: Date
}

Added in v0.4.0

WitnessData (interface)

Section titled “WitnessData (interface)”

Signature

export interface WitnessData {
  secret: Hex
  dstChainId: bigint
  beneficiaries: [Address, Address, Address, Address]
  beneficiary: Address
  redeemAmount: bigint
  alreadyRedeemed: bigint
  lightClients: LightClientData[]
  selectedClientIndex: number
  mptProof: MptProofData
  srcZAssetAddress: Domain.ZAssetAddress
  mappingSlot: Hex
}

Added in v0.4.0

refinements

Section titled “refinements”

isDone

Section titled “isDone”

Signature

export declare const isDone: P.Refinement<
  | { value: GenProver.Pending; case: "pending" }
  | { value: GenProver.Done; case: "done" }
  | { value: GenProver.Failed; case: "failed" }
  | { case: undefined; value?: undefined },
  { value: GenProver.Done; case: "done" }
>

Added in v0.4.0

isFailed

Section titled “isFailed”

Signature

export declare const isFailed: P.Refinement<
  | { value: GenProver.Pending; case: "pending" }
  | { value: GenProver.Done; case: "done" }
  | { value: GenProver.Failed; case: "failed" }
  | { case: undefined; value?: undefined },
  { value: GenProver.Failed; case: "failed" }
>

Added in v0.4.0

isPending

Section titled “isPending”

Signature

export declare const isPending: P.Refinement<
  | { value: GenProver.Pending; case: "pending" }
  | { value: GenProver.Done; case: "done" }
  | { value: GenProver.Failed; case: "failed" }
  | { case: undefined; value?: undefined },
  { value: GenProver.Pending; case: "pending" }
>

Added in v0.4.0

services

Section titled “services”

Prover (class)

Section titled “Prover (class)”

Prover client for communicating with the prover gRPC-web server Uses @connectrpc/connect-web to communicate with the gRPC-web server.

Signature

export declare class Prover

Added in v0.4.0