Skip to content
← Open Cap Table Protocol OCP Canton SDK

Reference

Equity compensation exercise — get

Load OCF TX_EQUITY_COMPENSATION_EXERCISE from Canton by contract id via ocp.OpenCapTable.equityCompensationExercise.get.

This page documents the read path for Equity compensation exercise as exposed on OcpClient under OpenCapTable.equityCompensationExercise. Use it to hydrate dashboards, reconciliation jobs, or tests from the canonical on-chain OCF record.

Import and receiver

  • Import: OcpClient, toContractId from @open-captable-protocol/canton.
  • Receiver: ocp.OpenCapTable.equityCompensationExercise.get.

Minimal example

import { OcpClient, toContractId } from '@open-captable-protocol/canton';

const result = await ocp.OpenCapTable.equityCompensationExercise.get({
  contractId: toContractId('EQUITYCOMPENSATIONEXERCISE_CONTRACT_ID'),
  readAs: optionalObserverParties,
});

const { data, contractId } = result;
// data.object_type === 'TX_EQUITY_COMPENSATION_EXERCISE';

Parameters

  • contractId (required) — Canton contract identifier for this transaction or stakeholder event.
  • readAs (optional) — Additional parties whose ledger visibility should be merged for resolution when the ledger client defaults are not enough.

Returns

A ContractResult with data (OCF payload including object_type: 'TX_EQUITY_COMPENSATION_EXERCISE') and contractId echoing the queried handle.

Errors

Malformed payloads or mismatched templates surface as OcpParseError, OcpContractError, or OcpValidationError from the underlying reader (singleContractRead / ledger). Missing contracts follow the Canton client’s not-found semantics (often surfaced as ledger errors).

Auth and disclosure

Reads use the ledger client passed into OcpClient (JWT / connection auth). No write authorization is exercised. Disclosure for stakeholders may still require careful readAs on multi-party windows.

Source (SDK)