Class OcpContextManager

Manager for OCP operation context.

Provides methods to set, get, and clear cached context values.

Implements

OcpContext

Index

Constructors

constructor

new OcpContextManager(): OcpContextManager
Returns OcpContextManager

Accessors

capTableContractId

get capTableContractId(): string | null
Get the cached cap table contract ID

Returns string | null
Implementation of OcpContext.capTableContractId
- Defined in src/OcpClient.ts:217

featuredAppRight

get featuredAppRight(): | {
    contractId: string;
    createdEventBlob: string;
    synchronizerId: string;
    templateId: string;
}
| null
Get the cached FeaturedAppRight disclosed contract details

Returns
    | {
        contractId: string;
        createdEventBlob: string;
        synchronizerId: string;
        templateId: string;
    }
    | null
Implementation of OcpContext.featuredAppRight
- Defined in src/OcpClient.ts:207

issuerParty

get issuerParty(): string | null
Get the cached issuer party ID

Returns string | null
Implementation of OcpContext.issuerParty
- Defined in src/OcpClient.ts:212

Methods

clear

clear(): void
Clear all cached context values

Returns void
- Defined in src/OcpClient.ts:307

isReadyForBatchOperations

isReadyForBatchOperations(): boolean
Check if the context has all required values for batch operations

Returns boolean
- Defined in src/OcpClient.ts:314

requireCapTableContractId

requireCapTableContractId(): string
Get the cap table contract ID or throw if not set.

Returns string
Throws
OcpValidationError if cap table contract ID has not been set
- Defined in src/OcpClient.ts:295

requireFeaturedAppRight

requireFeaturedAppRight(): {
    contractId: string;
    createdEventBlob: string;
    synchronizerId: string;
    templateId: string;
}
Get the FeaturedAppRight or throw if not set.

Returns {
    contractId: string;
    createdEventBlob: string;
    synchronizerId: string;
    templateId: string;
}
Throws
OcpValidationError if FeaturedAppRight has not been set
- Defined in src/OcpClient.ts:265

requireIssuerParty

requireIssuerParty(): string
Get the issuer party or throw if not set.

Returns string
Throws
OcpValidationError if issuer party has not been set
- Defined in src/OcpClient.ts:280

setAll

setAll(context: Partial<OcpContext>): void
Set all context values at once.
Parameters
- context: Partial<OcpContext>
  Partial context object with values to set
Returns void
- Defined in src/OcpClient.ts:249

setCapTableContractId

setCapTableContractId(contractId: string): void
Set the cap table contract ID.
Parameters
- contractId: string
  The contract ID to cache
Returns void
- Defined in src/OcpClient.ts:241

setFeaturedAppRight

setFeaturedAppRight(
    details: {
        contractId: string;
        createdEventBlob: string;
        synchronizerId: string;
        templateId: string;
    },
): void
Set the FeaturedAppRight disclosed contract details.
Parameters
- details: {
      contractId: string;
      createdEventBlob: string;
      synchronizerId: string;
      templateId: string;
  }
  The disclosed contract details to cache
Returns void
- Defined in src/OcpClient.ts:225

setIssuerParty

setIssuerParty(partyId: string): void
Set the issuer party ID.
Parameters
- partyId: string
  The party ID to cache
Returns void
- Defined in src/OcpClient.ts:233

Class OcpContextManager

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns OcpContextManager

Accessors

capTableContractId

Returns string | null

featuredAppRight

Returns | { contractId: string; createdEventBlob: string; synchronizerId: string; templateId: string; } | null

issuerParty

Returns string | null

Methods

clear

Returns void

isReadyForBatchOperations

Returns boolean

requireCapTableContractId

Returns string

Throws

requireFeaturedAppRight

Returns { contractId: string; createdEventBlob: string; synchronizerId: string; templateId: string;}

Throws

requireIssuerParty

Returns string

Throws

setAll

Parameters

Returns void

setCapTableContractId

Parameters

Returns void

setFeaturedAppRight

Parameters

Returns void

setIssuerParty

Parameters

Returns void

Settings

On This Page

Returns
| {
contractId: string;
createdEventBlob: string;
synchronizerId: string;
templateId: string;
}
| null

Returns {
contractId: string;
createdEventBlob: string;
synchronizerId: string;
templateId: string;
}