Class DamlLedgerClient

A LedgerClient implementation that connects to an existing Ledger and provides clients to query it. To use the DamlLedgerClient call the static connect method, passing an instance of LedgerClientOptions with the host, port and (for secure connection) the necessary certificates.

Hierarchy

DamlLedgerClient

Implements

LedgerClient

Index

Properties

ledgerId

Accessors

Methods

connect

Properties

Readonly ledgerId

ledgerId: string

Accessors

activeContractsClient

get activeContractsClient(): ActiveContractsClient

- Defined in src/client/DamlLedgerClient.ts:161
Returns ActiveContractsClient

commandClient

get commandClient(): CommandClient

- Defined in src/client/DamlLedgerClient.ts:165
Returns CommandClient

commandCompletionClient

get commandCompletionClient(): CommandCompletionClient

- Defined in src/client/DamlLedgerClient.ts:169
Returns CommandCompletionClient

commandSubmissionClient

get commandSubmissionClient(): CommandSubmissionClient

- Defined in src/client/DamlLedgerClient.ts:173
Returns CommandSubmissionClient

ledgerConfigurationClient

get ledgerConfigurationClient(): LedgerConfigurationClient

- Defined in src/client/DamlLedgerClient.ts:185
Returns LedgerConfigurationClient

ledgerIdentityClient

get ledgerIdentityClient(): LedgerIdentityClient

- Defined in src/client/DamlLedgerClient.ts:177
Returns LedgerIdentityClient

packageClient

get packageClient(): PackageClient

- Defined in src/client/DamlLedgerClient.ts:181
Returns PackageClient

packageManagementClient

get packageManagementClient(): PackageManagementClient

- Defined in src/client/DamlLedgerClient.ts:205
Returns PackageManagementClient

partyManagementClient

get partyManagementClient(): PartyManagementClient

- Defined in src/client/DamlLedgerClient.ts:201
Returns PartyManagementClient

resetClient

get resetClient(): ResetClient

- Defined in src/client/DamlLedgerClient.ts:197
Returns ResetClient

timeClient

get timeClient(): TimeClient

- Defined in src/client/DamlLedgerClient.ts:189
Returns TimeClient

transactionClient

get transactionClient(): TransactionClient

- Defined in src/client/DamlLedgerClient.ts:193
Returns TransactionClient

Methods

Static connect

connect(options: LedgerClientOptions): Promise<LedgerClient>
connect(options: LedgerClientOptions, callback: Callback<LedgerClient>): void

- Defined in src/client/DamlLedgerClient.ts:261
Connects a new instance of the DamlLedgerClient to the

Parameters
- options: LedgerClientOptions
  
  The host, port and certificates needed to reach the ledger
Returns Promise<LedgerClient>
- Defined in src/client/DamlLedgerClient.ts:262
Parameters
- options: LedgerClientOptions
- callback: Callback<LedgerClient>
Returns void

Generated using TypeDoc