Open Cap Table Protocol Canton SDK - v0.2.224
    Preparing search index...

    Class OcpContractError

    Errors from Canton/DAML contract interactions.

    Thrown when contract operations fail, such as exercising a choice, fetching contract data, or when expected results are not found in transaction trees.

    throw new OcpContractError('UpdateCapTable result not found in transaction tree', {
      contractId: capTableContractId,
      choice: 'UpdateCapTable',
      code: OcpErrorCodes.RESULT_NOT_FOUND,
    });

    try {
      await ocp.OpenCapTable.capTable.update(...).execute();
    } catch (error) {
      if (error instanceof OcpContractError) {
        console.error(`Contract error on ${error.choice}: ${error.message}`);
        console.error(`Contract ID: ${error.contractId}`);
      }
    }

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    cause? choice? code contractId? message name stack? templateId? stackTraceLimit

    Methods

    captureStackTrace prepareStackTrace

    Constructors

    Properties

    cause?: Error

    The original error that caused this error, if any

    choice?: string

    The choice being exercised when the error occurred

    code: OcpErrorCode

    Error code for programmatic handling

    contractId?: string

    The contract ID involved in the error

    message: string
    name: string
    stack?: string
    templateId?: string

    The DAML template ID

    stackTraceLimit: number

    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.

    Methods

    • 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
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods