ProofNotImplementedError

SIP Protocol API Reference / ProofNotImplementedError

Class: ProofNotImplementedError

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:217

Error thrown when a proof function is called but not yet implemented

This error indicates that real ZK proof generation is required but not available.

Example

// Use ProofProvider for proof generation
const provider = new NoirProofProvider(config)
await provider.initialize()
const result = await provider.generateFundingProof(params)

Extends

ProofError

Constructors

Constructor

new ProofNotImplementedError(proofType, specReference): ProofNotImplementedError

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:220

Parameters

proofType

"funding" | "validity" | "fulfillment" | "viewing"

specReference

string

Returns

ProofNotImplementedError

Overrides

ProofError.constructor

Properties

code

readonly code: ErrorCode

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:108

Machine-readable error code

Inherited from

ProofError.code

context?

readonly optional context: Record<string, unknown>

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:110

Additional debugging context

Inherited from

ProofError.context

timestamp

readonly timestamp: Date

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:112

Timestamp when error was created

Inherited from

ProofError.timestamp

proofType?

readonly optional proofType: "funding" | "validity" | "fulfillment" | "viewing"

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:197

The type of proof involved

Inherited from

ProofError.proofType

specReference

readonly specReference: string

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:219

Reference to the specification document

stackTraceLimit

static stackTraceLimit: number

Defined in: @types/node/globals.d.ts:68

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

ProofError.stackTraceLimit

name

name: string

Defined in: typescript/lib/lib.es5.d.ts:1076

Inherited from

ProofError.name

message

message: string

Defined in: typescript/lib/lib.es5.d.ts:1077

Inherited from

ProofError.message

stack?

optional stack: string

Defined in: typescript/lib/lib.es5.d.ts:1078

Inherited from

ProofError.stack

Methods

toJSON()

toJSON(): SerializedError

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:120

Serialize error for logging or transmission

Returns

SerializedError

Inherited from

ProofError.toJSON

toString()

toString(): string

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:124

Create a string representation for logging

Returns

string

Inherited from

ProofError.toString

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: @types/node/globals.d.ts:52

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

ProofError.captureStackTrace

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: @types/node/globals.d.ts:56

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

ProofError.prepareStackTrace