Options
All
  • Public
  • Public/Protected
  • All
Menu

Node.js bindings for DAML

Index

Namespaces

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

Call

Call<Request, Response>: (request: Request, callback: Callback<Response>) => ClientCancellableCall

Type parameters

  • Request

  • Response

Type declaration

Callback

Callback<A>: (error: Error | null, response?: A) => void

Type parameters

  • A

Type declaration

    • (error: Error | null, response?: A): void
    • Parameters

      • error: Error | null
      • Optional response: A

      Returns void

Command

A command can either create a new contract or exercise a choice on an existing contract.

Uses the commandType string type tag to differentiate between types in the union.

Event

An event in the flat transaction stream can either be the creation or the archiving of a contract.

In the transaction service the events are restricted to the events visible for the parties specified in the transaction filter. Each event message type below contains a witnessParties field which indicates the subset of the requested parties that can see the event in question. In the flat transaction stream you'll only receive events that have witnesses.

Uses the eventType string type tag to differentiate between types in the union.

LedgerOffset

Uses the offsetType string type tag to differentiate between types in the union.

OptionalFields

OptionalFields<K, V>: Record<OptionalKeys<K>, V>

Type parameters

  • K: object

  • V

OptionalFieldsValidators

OptionalFieldsValidators<K>: OptionalFields<K, Validation>

Type parameters

  • K: object

OptionalKeys

OptionalKeys<T>: {} extends {} ? {} extends U ? never : U : never

Extracts optional keys as a string type union

Type parameters

  • T

PromisifiedCall

PromisifiedCall<Request, Response>: (request?: Request) => Promise<Response>

Type parameters

  • Request

  • Response

Type declaration

    • (request?: Request): Promise<Response>
    • Parameters

      Returns Promise<Response>

RequiredFields

RequiredFields<K, V>: Record<RequiredKeys<K>, V>

Type parameters

  • K: object

  • V

RequiredFieldsValidators

RequiredFieldsValidators<K>: RequiredFields<K, Validation>

Type parameters

  • K: object

RequiredKeys

RequiredKeys<T>: {} extends {} ? {} extends U ? never : U : never

Extracts required keys as a string type union

Type parameters

  • T

TreeEvent

Each tree event message type below contains a witnessParties field which indicates the subset of the requested parties that can see the event in question.

Note that transaction trees might contain events with no witness parties, which were included simply because they were children of events which have witnesses.

ValidationError

Value

Encodes values that the ledger accepts as command arguments and emits as contract arguments.

Uses the valueType string type tag to differentiate between types in the union.

To express values in a more concise way, you can have a look at the ValueHelpers.

Variables

ActiveContractsServiceService

ActiveContractsServiceService: { getActiveContracts: object } = exports['com.daml.ledger.api.v1.ActiveContractsService'] = {// Returns a stream of the latest snapshot of active contracts.// If there are no active contracts, the stream returns a single GetActiveContractsResponse message with the offset at which the snapshot has been taken.// Clients SHOULD use the offset in the last GetActiveContractsResponse message to continue streaming transactions with the transaction service.// Clients SHOULD NOT assume that the set of active contracts they receive reflects the state at the ledger end.getActiveContracts: {path: '/com.daml.ledger.api.v1.ActiveContractsService/GetActiveContracts',requestStream: false,responseStream: true,requestType: com_daml_ledger_api_v1_active_contracts_service_pb.GetActiveContractsRequest,responseType: com_daml_ledger_api_v1_active_contracts_service_pb.GetActiveContractsResponse,requestSerialize: serialize_com_daml_ledger_api_v1_GetActiveContractsRequest,requestDeserialize: deserialize_com_daml_ledger_api_v1_GetActiveContractsRequest,responseSerialize: serialize_com_daml_ledger_api_v1_GetActiveContractsResponse,responseDeserialize: deserialize_com_daml_ledger_api_v1_GetActiveContractsResponse,},}

Type declaration

Const AllocatePartyRequestValidation

AllocatePartyRequestValidation: ObjectValidation<AllocatePartyRequest> = object<AllocatePartyRequest>('AllocatePartyRequest', noFields, optional)

Const AnyValidation

AnyValidation: ObjectValidation<Any> = object<Any>('Any', required, noFields)

Const ArchivedEventValidation

ArchivedEventValidation: ObjectValidation<ArchivedEvent> = object<ArchivedEvent>('ArchivedEvent', required, noFields)

Const BoolValueValidation

BoolValueValidation: ObjectValidation<BoolValue> = object<BoolValue>('BoolValue', () => {return {valueType: string('bool'),bool: native('boolean')}}, noFields)

Const CheckpointValidation

CheckpointValidation: ObjectValidation<Checkpoint> = object<Checkpoint>('Checkpoint', required, noFields)

CommandCompletionServiceService

CommandCompletionServiceService: { completionEnd: object; completionStream: object } = exports['com.daml.ledger.api.v1.CommandCompletionService'] = {// Subscribe to command completion events.completionStream: {path: '/com.daml.ledger.api.v1.CommandCompletionService/CompletionStream',requestStream: false,responseStream: true,requestType: com_daml_ledger_api_v1_command_completion_service_pb.CompletionStreamRequest,responseType: com_daml_ledger_api_v1_command_completion_service_pb.CompletionStreamResponse,requestSerialize: serialize_com_daml_ledger_api_v1_CompletionStreamRequest,requestDeserialize: deserialize_com_daml_ledger_api_v1_CompletionStreamRequest,responseSerialize: serialize_com_daml_ledger_api_v1_CompletionStreamResponse,responseDeserialize: deserialize_com_daml_ledger_api_v1_CompletionStreamResponse,},// Returns the offset after the latest completion.completionEnd: {path: '/com.daml.ledger.api.v1.CommandCompletionService/CompletionEnd',requestStream: false,responseStream: false,requestType: com_daml_ledger_api_v1_command_completion_service_pb.CompletionEndRequest,responseType: com_daml_ledger_api_v1_command_completion_service_pb.CompletionEndResponse,requestSerialize: serialize_com_daml_ledger_api_v1_CompletionEndRequest,requestDeserialize: deserialize_com_daml_ledger_api_v1_CompletionEndRequest,responseSerialize: serialize_com_daml_ledger_api_v1_CompletionEndResponse,responseDeserialize: deserialize_com_daml_ledger_api_v1_CompletionEndResponse,},}

Type declaration

CommandServiceService

CommandServiceService: { submitAndWait: object; submitAndWaitForTransaction: object; submitAndWaitForTransactionId: object; submitAndWaitForTransactionTree: object } = exports['com.daml.ledger.api.v1.CommandService'] = {// Submits a single composite command and waits for its result.// Returns ``RESOURCE_EXHAUSTED`` if the number of in-flight commands reached the maximum (if a limit is configured).// Propagates the gRPC error of failed submissions including DAML interpretation errors.submitAndWait: {path: '/com.daml.ledger.api.v1.CommandService/SubmitAndWait',requestStream: false,responseStream: false,requestType: com_daml_ledger_api_v1_command_service_pb.SubmitAndWaitRequest,responseType: google_protobuf_empty_pb.Empty,requestSerialize: serialize_com_daml_ledger_api_v1_SubmitAndWaitRequest,requestDeserialize: deserialize_com_daml_ledger_api_v1_SubmitAndWaitRequest,responseSerialize: serialize_google_protobuf_Empty,responseDeserialize: deserialize_google_protobuf_Empty,},// Submits a single composite command, waits for its result, and returns the transaction id.// Returns ``RESOURCE_EXHAUSTED`` if the number of in-flight commands reached the maximum (if a limit is configured).// Propagates the gRPC error of failed submissions including DAML interpretation errors.submitAndWaitForTransactionId: {path: '/com.daml.ledger.api.v1.CommandService/SubmitAndWaitForTransactionId',requestStream: false,responseStream: false,requestType: com_daml_ledger_api_v1_command_service_pb.SubmitAndWaitRequest,responseType: com_daml_ledger_api_v1_command_service_pb.SubmitAndWaitForTransactionIdResponse,requestSerialize: serialize_com_daml_ledger_api_v1_SubmitAndWaitRequest,requestDeserialize: deserialize_com_daml_ledger_api_v1_SubmitAndWaitRequest,responseSerialize: serialize_com_daml_ledger_api_v1_SubmitAndWaitForTransactionIdResponse,responseDeserialize: deserialize_com_daml_ledger_api_v1_SubmitAndWaitForTransactionIdResponse,},// Submits a single composite command, waits for its result, and returns the transaction.// Returns ``RESOURCE_EXHAUSTED`` if the number of in-flight commands reached the maximum (if a limit is configured).// Propagates the gRPC error of failed submissions including DAML interpretation errors.submitAndWaitForTransaction: {path: '/com.daml.ledger.api.v1.CommandService/SubmitAndWaitForTransaction',requestStream: false,responseStream: false,requestType: com_daml_ledger_api_v1_command_service_pb.SubmitAndWaitRequest,responseType: com_daml_ledger_api_v1_command_service_pb.SubmitAndWaitForTransactionResponse,requestSerialize: serialize_com_daml_ledger_api_v1_SubmitAndWaitRequest,requestDeserialize: deserialize_com_daml_ledger_api_v1_SubmitAndWaitRequest,responseSerialize: serialize_com_daml_ledger_api_v1_SubmitAndWaitForTransactionResponse,responseDeserialize: deserialize_com_daml_ledger_api_v1_SubmitAndWaitForTransactionResponse,},// Submits a single composite command, waits for its result, and returns the transaction tree.// Returns ``RESOURCE_EXHAUSTED`` if the number of in-flight commands reached the maximum (if a limit is configured).// Propagates the gRPC error of failed submissions including DAML interpretation errors.submitAndWaitForTransactionTree: {path: '/com.daml.ledger.api.v1.CommandService/SubmitAndWaitForTransactionTree',requestStream: false,responseStream: false,requestType: com_daml_ledger_api_v1_command_service_pb.SubmitAndWaitRequest,responseType: com_daml_ledger_api_v1_command_service_pb.SubmitAndWaitForTransactionTreeResponse,requestSerialize: serialize_com_daml_ledger_api_v1_SubmitAndWaitRequest,requestDeserialize: deserialize_com_daml_ledger_api_v1_SubmitAndWaitRequest,responseSerialize: serialize_com_daml_ledger_api_v1_SubmitAndWaitForTransactionTreeResponse,responseDeserialize: deserialize_com_daml_ledger_api_v1_SubmitAndWaitForTransactionTreeResponse,},}

Type declaration

CommandSubmissionServiceService

CommandSubmissionServiceService: { submit: object } = exports['com.daml.ledger.api.v1.CommandSubmissionService'] = {// Submit a single composite command.submit: {path: '/com.daml.ledger.api.v1.CommandSubmissionService/Submit',requestStream: false,responseStream: false,requestType: com_daml_ledger_api_v1_command_submission_service_pb.SubmitRequest,responseType: google_protobuf_empty_pb.Empty,requestSerialize: serialize_com_daml_ledger_api_v1_SubmitRequest,requestDeserialize: deserialize_com_daml_ledger_api_v1_SubmitRequest,responseSerialize: serialize_google_protobuf_Empty,responseDeserialize: deserialize_google_protobuf_Empty,},}

Type declaration

Const CommandValidation

CommandValidation: UnionValidation<"commandType", {}> = union('Command', 'commandType', values)

Const CommandsValidation

CommandsValidation: ObjectValidation<Commands> = object<Commands>('Commands', required, optional)

Const CompletionEndResponseValidation

CompletionEndResponseValidation: ObjectValidation<CompletionEndResponse> = object<CompletionEndResponse>('CompletionEndResponse', required, noFields)

Const CompletionStreamRequestValidation

CompletionStreamRequestValidation: ObjectValidation<CompletionStreamRequest> = object<CompletionStreamRequest>('CompletionStreamRequest', required, optional)

Const CompletionStreamResponseValidation

CompletionStreamResponseValidation: ObjectValidation<CompletionStreamResponse> = object<CompletionStreamResponse>('CompletionStreamResponse', noFields, optional)

Const CompletionValidation

CompletionValidation: ObjectValidation<Completion> = object<Completion>('Completion', required, optional)

ConfigManagementServiceService

ConfigManagementServiceService: { getTimeModel: object; setTimeModel: object } = exports['com.daml.ledger.api.v1.admin.ConfigManagementService'] = {// Return the currently active time model and the current configuration generation.getTimeModel: {path: '/com.daml.ledger.api.v1.admin.ConfigManagementService/GetTimeModel',requestStream: false,responseStream: false,requestType: com_daml_ledger_api_v1_admin_config_management_service_pb.GetTimeModelRequest,responseType: com_daml_ledger_api_v1_admin_config_management_service_pb.GetTimeModelResponse,requestSerialize: serialize_com_daml_ledger_api_v1_admin_GetTimeModelRequest,requestDeserialize: deserialize_com_daml_ledger_api_v1_admin_GetTimeModelRequest,responseSerialize: serialize_com_daml_ledger_api_v1_admin_GetTimeModelResponse,responseDeserialize: deserialize_com_daml_ledger_api_v1_admin_GetTimeModelResponse,},// Set the ledger time model.// In case of failure this method responds with:// - INVALID_ARGUMENT if arguments are invalid, or the provided configuration generation// does not match the current active configuration generation. The caller is expected// to retry by again fetching current time model using 'GetTimeModel', applying changes// and resubmitting.// - ABORTED if the request is rejected or times out. Note that a timed out request may// have still been committed to the ledger. Application should re-query the current// time model before retrying.// - UNIMPLEMENTED if this method is not supported by the backing ledger.setTimeModel: {path: '/com.daml.ledger.api.v1.admin.ConfigManagementService/SetTimeModel',requestStream: false,responseStream: false,requestType: com_daml_ledger_api_v1_admin_config_management_service_pb.SetTimeModelRequest,responseType: com_daml_ledger_api_v1_admin_config_management_service_pb.SetTimeModelResponse,requestSerialize: serialize_com_daml_ledger_api_v1_admin_SetTimeModelRequest,requestDeserialize: deserialize_com_daml_ledger_api_v1_admin_SetTimeModelRequest,responseSerialize: serialize_com_daml_ledger_api_v1_admin_SetTimeModelResponse,responseDeserialize: deserialize_com_daml_ledger_api_v1_admin_SetTimeModelResponse,},}

Type declaration

Const ContractIdValueValidation

ContractIdValueValidation: ObjectValidation<ContractIdValue> = object<ContractIdValue>('ContractIdValue', () => {return {valueType: string('contractId'),contractId: native('string')}}, noFields)

Const CreateAndExerciseCommandValidation

CreateAndExerciseCommandValidation: ObjectValidation<CreateAndExerciseCommand> = object<CreateAndExerciseCommand>('CreateAndExerciseCommand', required, noFields)

Const CreateCommandValidation

CreateCommandValidation: ObjectValidation<CreateCommand> = object<CreateCommand>('CreateCommand', required, noFields)

Const CreatedEventValidation

CreatedEventValidation: ObjectValidation<CreatedEvent> = object<CreatedEvent>('CreatedEvent', required, optional)

Const DateValueValidation

DateValueValidation: ObjectValidation<DateValue> = object<DateValue>('DateValue', () => {return {valueType: string('date'),date: integerString}}, noFields)

Const DecimalValueValidation

DecimalValueValidation: ObjectValidation<DecimalValue> = object<DecimalValue>('DecimalValue', () => {return {valueType: string('decimal'),decimal: native('string')}}, noFields)

Const DurationValidation

DurationValidation: ObjectValidation<Duration> = object<Duration>('Duration', required, noFields)

Const EnumValueValidation

EnumValueValidation: ObjectValidation<EnumValue> = object<EnumValue>('EnumValue', () => {return {valueType: string('enum'),constructor: native('string')}}, () => {return {enumId: IdentifierValidation}})

Const EventValidation

EventValidation: UnionValidation<"eventType", {}> = union('Event', 'eventType', values)

Const ExerciseCommandValidation

ExerciseCommandValidation: ObjectValidation<ExerciseCommand> = object<ExerciseCommand>('ExerciseCommand', required, noFields)

Const ExercisedEventValidation

ExercisedEventValidation: ObjectValidation<ExercisedEvent> = object<ExercisedEvent>('ExercisedEvent', required, optional)

Const FiltersValidation

FiltersValidation: ObjectValidation<Filters> = object<Filters>('Filters', noFields, optional)

Const GetActiveContractsRequestValidation

GetActiveContractsRequestValidation: ObjectValidation<GetActiveContractsRequest> = object<GetActiveContractsRequest>('GetActiveContractsRequest', required, optional)

Const GetActiveContractsResponseValidation

GetActiveContractsResponseValidation: ObjectValidation<GetActiveContractsResponse> = object<GetActiveContractsResponse>('GetActiveContractsResponse', required, optional)

Const GetFlatTransactionResponseValidation

GetFlatTransactionResponseValidation: ObjectValidation<GetFlatTransactionResponse> = object<GetFlatTransactionResponse>('GetFlatTransactionResponse', required, noFields)

Const GetLedgerConfigurationResponseValidation

GetLedgerConfigurationResponseValidation: ObjectValidation<GetLedgerConfigurationResponse> = object<GetLedgerConfigurationResponse>('GetLedgerConfigurationResponse', required, noFields)

Const GetLedgerEndResponseValidation

GetLedgerEndResponseValidation: ObjectValidation<GetLedgerEndResponse> = object<GetLedgerEndResponse>('GetLedgerEndResponse', required, noFields)

Const GetLedgerIdentityResponseValidation

GetLedgerIdentityResponseValidation: ObjectValidation<GetLedgerIdentityResponse> = object<GetLedgerIdentityResponse>('GetLedgerIdentityResponse', required, noFields)

Const GetPackageResponseValidation

GetPackageResponseValidation: ObjectValidation<GetPackageResponse> = object<GetPackageResponse>('GetPackageResponse', required, noFields)

Const GetPackageStatusResponseValidation

GetPackageStatusResponseValidation: ObjectValidation<GetPackageStatusResponse> = object<GetPackageStatusResponse>('GetPackageStatusResponse', required, noFields)

Const GetTimeResponseValidation

GetTimeResponseValidation: ObjectValidation<GetTimeResponse> = object<GetTimeResponse>('GetTimeResponse', required, noFields)

Const GetTransactionByEventIdRequestValidation

GetTransactionByEventIdRequestValidation: ObjectValidation<GetTransactionByEventIdRequest> = object<GetTransactionByEventIdRequest>('GetTransactionByEventIdRequest', required, noFields)

Const GetTransactionByIdRequestValidation

GetTransactionByIdRequestValidation: ObjectValidation<GetTransactionByIdRequest> = object<GetTransactionByIdRequest>('GetTransactionByIdRequest', required, noFields)

Const GetTransactionResponseValidation

GetTransactionResponseValidation: ObjectValidation<GetTransactionResponse> = object<GetTransactionResponse>('GetTransactionResponse', required, noFields)

Const GetTransactionTreesResponseValidation

GetTransactionTreesResponseValidation: ObjectValidation<GetTransactionTreesResponse> = object<GetTransactionTreesResponse>('GetTransactionTreesResponse', required, noFields)

Const GetTransactionsRequestValidation

GetTransactionsRequestValidation: ObjectValidation<GetTransactionsRequest> = object<GetTransactionsRequest>('GetTransactionsRequest', required, optional)

Const GetTransactionsResponseValidation

GetTransactionsResponseValidation: ObjectValidation<GetTransactionsResponse> = object<GetTransactionsResponse>('GetTransactionsResponse', required, noFields)

Const HashFunctionValidation

HashFunctionValidation: Validation = enumeration(HashFunction, 'HashFunction')

HealthService

HealthService: { check: object; watch: object } = exports['grpc.health.v1.Health'] = {// If the requested service is unknown, the call will fail with status// NOT_FOUND.check: {path: '/grpc.health.v1.Health/Check',requestStream: false,responseStream: false,requestType: grpc_health_v1_health_pb.HealthCheckRequest,responseType: grpc_health_v1_health_pb.HealthCheckResponse,requestSerialize: serialize_grpc_health_v1_HealthCheckRequest,requestDeserialize: deserialize_grpc_health_v1_HealthCheckRequest,responseSerialize: serialize_grpc_health_v1_HealthCheckResponse,responseDeserialize: deserialize_grpc_health_v1_HealthCheckResponse,},// Performs a watch for the serving status of the requested service.// The server will immediately send back a message indicating the current// serving status. It will then subsequently send a new message whenever// the service's serving status changes.//// If the requested service is unknown when the call is received, the// server will send a message setting the serving status to// SERVICE_UNKNOWN but will *not* terminate the call. If at some// future point, the serving status of the service becomes known, the// server will send a new message with the service's serving status.//// If the call terminates with status UNIMPLEMENTED, then clients// should assume this method is not supported and should not retry the// call. If the call terminates with any other status (including OK),// clients should retry the call with appropriate exponential backoff.watch: {path: '/grpc.health.v1.Health/Watch',requestStream: false,responseStream: true,requestType: grpc_health_v1_health_pb.HealthCheckRequest,responseType: grpc_health_v1_health_pb.HealthCheckResponse,requestSerialize: serialize_grpc_health_v1_HealthCheckRequest,requestDeserialize: deserialize_grpc_health_v1_HealthCheckRequest,responseSerialize: serialize_grpc_health_v1_HealthCheckResponse,responseDeserialize: deserialize_grpc_health_v1_HealthCheckResponse,},}

Type declaration

Const IdentifierValidation

IdentifierValidation: ObjectValidation<Identifier> = object<Identifier>('Identifier', required, noFields)

Const InclusiveFiltersValidation

InclusiveFiltersValidation: ObjectValidation<InclusiveFilters> = object<InclusiveFilters>('InclusiveFilters', required, noFields)

Const Int64ValueValidation

Int64ValueValidation: ObjectValidation<Int64Value> = object<Int64Value>('Int64Value', () => {return {valueType: string('int64'),int64: integerString}}, noFields)

LedgerConfigurationServiceService

LedgerConfigurationServiceService: { getLedgerConfiguration: object } = exports['com.daml.ledger.api.v1.LedgerConfigurationService'] = {// Returns the latest configuration as the first response, and publishes configuration updates in the same stream.getLedgerConfiguration: {path: '/com.daml.ledger.api.v1.LedgerConfigurationService/GetLedgerConfiguration',requestStream: false,responseStream: true,requestType: com_daml_ledger_api_v1_ledger_configuration_service_pb.GetLedgerConfigurationRequest,responseType: com_daml_ledger_api_v1_ledger_configuration_service_pb.GetLedgerConfigurationResponse,requestSerialize: serialize_com_daml_ledger_api_v1_GetLedgerConfigurationRequest,requestDeserialize: deserialize_com_daml_ledger_api_v1_GetLedgerConfigurationRequest,responseSerialize: serialize_com_daml_ledger_api_v1_GetLedgerConfigurationResponse,responseDeserialize: deserialize_com_daml_ledger_api_v1_GetLedgerConfigurationResponse,},}

Type declaration

Const LedgerConfigurationValidation

LedgerConfigurationValidation: ObjectValidation<LedgerConfiguration> = object<LedgerConfiguration>('LedgerConfiguration', required, noFields)

LedgerIdentityServiceService

LedgerIdentityServiceService: { getLedgerIdentity: object } = exports['com.daml.ledger.api.v1.LedgerIdentityService'] = {// Clients may call this RPC to return the identifier of the ledger they are connected to.getLedgerIdentity: {path: '/com.daml.ledger.api.v1.LedgerIdentityService/GetLedgerIdentity',requestStream: false,responseStream: false,requestType: com_daml_ledger_api_v1_ledger_identity_service_pb.GetLedgerIdentityRequest,responseType: com_daml_ledger_api_v1_ledger_identity_service_pb.GetLedgerIdentityResponse,requestSerialize: serialize_com_daml_ledger_api_v1_GetLedgerIdentityRequest,requestDeserialize: deserialize_com_daml_ledger_api_v1_GetLedgerIdentityRequest,responseSerialize: serialize_com_daml_ledger_api_v1_GetLedgerIdentityResponse,responseDeserialize: deserialize_com_daml_ledger_api_v1_GetLedgerIdentityResponse,},}

Type declaration

Const LedgerOffsetAbsoluteValidation

LedgerOffsetAbsoluteValidation: ObjectValidation<LedgerOffsetAbsolute> = object<LedgerOffsetAbsolute>('LedgerOffsetAbsolute', () => ({offsetType: string('absolute'),absolute: native('string')}), noFields)

Const LedgerOffsetBoundaryValidation

LedgerOffsetBoundaryValidation: ObjectValidation<LedgerOffsetBoundary> = object<LedgerOffsetBoundary>('LedgerOffsetBoundary', () => ({offsetType: string('boundary'),boundary: enumeration(LedgerOffsetBoundaryValue, 'LedgerOffsetBoundaryValue')}), noFields)

Const LedgerOffsetValidation

LedgerOffsetValidation: UnionValidation<"offsetType", {}> = union('LedgerOffset', 'offsetType', values)

Const ListPackagesResponseValidation

ListPackagesResponseValidation: ObjectValidation<ListPackagesResponse> = object<ListPackagesResponse>('ListPackagesResponse', required, noFields)

Const ListValueValidation

ListValueValidation: ObjectValidation<ListValue> = object<ListValue>('ListValue', () => {return {valueType: string('list'),list: array(ValueValidation)}}, noFields)

Const MapValueValidation

MapValueValidation: ObjectValidation<MapValue> = object<MapValue>('MapValue', () => {return {valueType: string('map'),map: record(ValueValidation)}}, noFields)

Const OptionalValueValidation

OptionalValueValidation: ObjectValidation<OptionalValue> = object<OptionalValue>('OptionalValue', () => {return {valueType: string('optional')}}, () => {return {optional: ValueValidation}})

PackageManagementServiceService

PackageManagementServiceService: { listKnownPackages: object; uploadDarFile: object } = exports['com.daml.ledger.api.v1.admin.PackageManagementService'] = {// Returns the details of all DAML-LF packages known to the backing// participant.// This request will always succeed.listKnownPackages: {path: '/com.daml.ledger.api.v1.admin.PackageManagementService/ListKnownPackages',requestStream: false,responseStream: false,requestType: com_daml_ledger_api_v1_admin_package_management_service_pb.ListKnownPackagesRequest,responseType: com_daml_ledger_api_v1_admin_package_management_service_pb.ListKnownPackagesResponse,requestSerialize: serialize_com_daml_ledger_api_v1_admin_ListKnownPackagesRequest,requestDeserialize: deserialize_com_daml_ledger_api_v1_admin_ListKnownPackagesRequest,responseSerialize: serialize_com_daml_ledger_api_v1_admin_ListKnownPackagesResponse,responseDeserialize: deserialize_com_daml_ledger_api_v1_admin_ListKnownPackagesResponse,},// Upload a DAR file to the backing participant.// Depending on the ledger implementation this might also make the package// available on the whole ledger. This call might not be supported by some// ledger implementations. Canton could be an example, where uploading a DAR// is not sufficient to render it usable, it must be activated first.// This call may:// - Succeed, if the package was successfully uploaded, or if the same package// was already uploaded before.// - Respond with UNIMPLEMENTED, if DAR package uploading is not supported by// the backing participant.// - Respond with INVALID_ARGUMENT, if the DAR file is too big or malformed.// The maximum supported size is implementation specific.uploadDarFile: {path: '/com.daml.ledger.api.v1.admin.PackageManagementService/UploadDarFile',requestStream: false,responseStream: false,requestType: com_daml_ledger_api_v1_admin_package_management_service_pb.UploadDarFileRequest,responseType: com_daml_ledger_api_v1_admin_package_management_service_pb.UploadDarFileResponse,requestSerialize: serialize_com_daml_ledger_api_v1_admin_UploadDarFileRequest,requestDeserialize: deserialize_com_daml_ledger_api_v1_admin_UploadDarFileRequest,responseSerialize: serialize_com_daml_ledger_api_v1_admin_UploadDarFileResponse,responseDeserialize: deserialize_com_daml_ledger_api_v1_admin_UploadDarFileResponse,},}

Type declaration

PackageServiceService

PackageServiceService: { getPackage: object; getPackageStatus: object; listPackages: object } = exports['com.daml.ledger.api.v1.PackageService'] = {// Returns the identifiers of all supported packages.listPackages: {path: '/com.daml.ledger.api.v1.PackageService/ListPackages',requestStream: false,responseStream: false,requestType: com_daml_ledger_api_v1_package_service_pb.ListPackagesRequest,responseType: com_daml_ledger_api_v1_package_service_pb.ListPackagesResponse,requestSerialize: serialize_com_daml_ledger_api_v1_ListPackagesRequest,requestDeserialize: deserialize_com_daml_ledger_api_v1_ListPackagesRequest,responseSerialize: serialize_com_daml_ledger_api_v1_ListPackagesResponse,responseDeserialize: deserialize_com_daml_ledger_api_v1_ListPackagesResponse,},// Returns the contents of a single package, or a ``NOT_FOUND`` error if the requested package is unknown.getPackage: {path: '/com.daml.ledger.api.v1.PackageService/GetPackage',requestStream: false,responseStream: false,requestType: com_daml_ledger_api_v1_package_service_pb.GetPackageRequest,responseType: com_daml_ledger_api_v1_package_service_pb.GetPackageResponse,requestSerialize: serialize_com_daml_ledger_api_v1_GetPackageRequest,requestDeserialize: deserialize_com_daml_ledger_api_v1_GetPackageRequest,responseSerialize: serialize_com_daml_ledger_api_v1_GetPackageResponse,responseDeserialize: deserialize_com_daml_ledger_api_v1_GetPackageResponse,},// Returns the status of a single package.getPackageStatus: {path: '/com.daml.ledger.api.v1.PackageService/GetPackageStatus',requestStream: false,responseStream: false,requestType: com_daml_ledger_api_v1_package_service_pb.GetPackageStatusRequest,responseType: com_daml_ledger_api_v1_package_service_pb.GetPackageStatusResponse,requestSerialize: serialize_com_daml_ledger_api_v1_GetPackageStatusRequest,requestDeserialize: deserialize_com_daml_ledger_api_v1_GetPackageStatusRequest,responseSerialize: serialize_com_daml_ledger_api_v1_GetPackageStatusResponse,responseDeserialize: deserialize_com_daml_ledger_api_v1_GetPackageStatusResponse,},}

Type declaration

Const PackageStatusValidation

PackageStatusValidation: Validation = enumeration(PackageStatus, 'PackageStatus')

PartyManagementServiceService

PartyManagementServiceService: { allocateParty: object; getParticipantId: object; getParties: object; listKnownParties: object } = exports['com.daml.ledger.api.v1.admin.PartyManagementService'] = {// Return the identifier of the backing participant.// All horizontally scaled replicas should return the same id.// This method is expected to succeed provided the backing participant is// healthy, otherwise it responds with INTERNAL grpc error.// daml-on-sql: returns an identifier supplied on command line at launch time// daml-on-kv-ledger: as above// canton: returns globally unique identifier of the backing participantgetParticipantId: {path: '/com.daml.ledger.api.v1.admin.PartyManagementService/GetParticipantId',requestStream: false,responseStream: false,requestType: com_daml_ledger_api_v1_admin_party_management_service_pb.GetParticipantIdRequest,responseType: com_daml_ledger_api_v1_admin_party_management_service_pb.GetParticipantIdResponse,requestSerialize: serialize_com_daml_ledger_api_v1_admin_GetParticipantIdRequest,requestDeserialize: deserialize_com_daml_ledger_api_v1_admin_GetParticipantIdRequest,responseSerialize: serialize_com_daml_ledger_api_v1_admin_GetParticipantIdResponse,responseDeserialize: deserialize_com_daml_ledger_api_v1_admin_GetParticipantIdResponse,},// Get the party details of the given parties. Only known parties will be// returned in the list.// This request will always succeed.getParties: {path: '/com.daml.ledger.api.v1.admin.PartyManagementService/GetParties',requestStream: false,responseStream: false,requestType: com_daml_ledger_api_v1_admin_party_management_service_pb.GetPartiesRequest,responseType: com_daml_ledger_api_v1_admin_party_management_service_pb.GetPartiesResponse,requestSerialize: serialize_com_daml_ledger_api_v1_admin_GetPartiesRequest,requestDeserialize: deserialize_com_daml_ledger_api_v1_admin_GetPartiesRequest,responseSerialize: serialize_com_daml_ledger_api_v1_admin_GetPartiesResponse,responseDeserialize: deserialize_com_daml_ledger_api_v1_admin_GetPartiesResponse,},// List the parties known by the backing participant.// The list returned contains parties whose ledger access is facilitated by// backing participant and the ones maintained elsewhere.// This request will always succeed.listKnownParties: {path: '/com.daml.ledger.api.v1.admin.PartyManagementService/ListKnownParties',requestStream: false,responseStream: false,requestType: com_daml_ledger_api_v1_admin_party_management_service_pb.ListKnownPartiesRequest,responseType: com_daml_ledger_api_v1_admin_party_management_service_pb.ListKnownPartiesResponse,requestSerialize: serialize_com_daml_ledger_api_v1_admin_ListKnownPartiesRequest,requestDeserialize: deserialize_com_daml_ledger_api_v1_admin_ListKnownPartiesRequest,responseSerialize: serialize_com_daml_ledger_api_v1_admin_ListKnownPartiesResponse,responseDeserialize: deserialize_com_daml_ledger_api_v1_admin_ListKnownPartiesResponse,},// Adds a new party to the set managed by the backing participant.// Caller specifies a party identifier suggestion, the actual identifier// allocated might be different and is implementation specific.// This call may:// - Succeed, in which case the actual allocated identifier is visible in// the response.// - Respond with UNIMPLEMENTED if synchronous party allocation is not// supported by the backing participant.// - Respond with INVALID_ARGUMENT if the provided hint and/or display name// is invalid on the given ledger (see below).// daml-on-sql: suggestion's uniqueness is checked and call rejected if the// identifier is already present// daml-on-kv-ledger: suggestion's uniqueness is checked by the validators in// the consensus layer and call rejected if the identifier is already present.// canton: completely different globally unique identifier is allocated.// Behind the scenes calls to an internal protocol are made. As that protocol// is richer than the the surface protocol, the arguments take implicit valuesallocateParty: {path: '/com.daml.ledger.api.v1.admin.PartyManagementService/AllocateParty',requestStream: false,responseStream: false,requestType: com_daml_ledger_api_v1_admin_party_management_service_pb.AllocatePartyRequest,responseType: com_daml_ledger_api_v1_admin_party_management_service_pb.AllocatePartyResponse,requestSerialize: serialize_com_daml_ledger_api_v1_admin_AllocatePartyRequest,requestDeserialize: deserialize_com_daml_ledger_api_v1_admin_AllocatePartyRequest,responseSerialize: serialize_com_daml_ledger_api_v1_admin_AllocatePartyResponse,responseDeserialize: deserialize_com_daml_ledger_api_v1_admin_AllocatePartyResponse,},}

Type declaration

Const PartyValueValidation

PartyValueValidation: ObjectValidation<PartyValue> = object<PartyValue>('PartyValue', () => {return {valueType: string('party'),party: native('string')}}, noFields)

Const RecordValidation

RecordValidation: ObjectValidation<Record> = object<Record>('Record', required, optional)

Const RecordValueValidation

RecordValueValidation: ObjectValidation<RecordValue> = object<RecordValue>('RecordValue', () => {return {valueType: string('record'),fields: record(ValueValidation)}}, () => {return {recordId: IdentifierValidation}})

ResetServiceService

ResetServiceService: { reset: object } = exports['com.daml.ledger.api.v1.testing.ResetService'] = {// Resets the ledger state. Note that loaded DARs won't be removed -- this only rolls back the// ledger to genesis.reset: {path: '/com.daml.ledger.api.v1.testing.ResetService/Reset',requestStream: false,responseStream: false,requestType: com_daml_ledger_api_v1_testing_reset_service_pb.ResetRequest,responseType: google_protobuf_empty_pb.Empty,requestSerialize: serialize_com_daml_ledger_api_v1_testing_ResetRequest,requestDeserialize: deserialize_com_daml_ledger_api_v1_testing_ResetRequest,responseSerialize: serialize_google_protobuf_Empty,responseDeserialize: deserialize_google_protobuf_Empty,},}

Type declaration

Const SetTimeRequestValidation

SetTimeRequestValidation: ObjectValidation<SetTimeRequest> = object<SetTimeRequest>('SetTimeRequest', required, noFields)

Const StatusValidation

StatusValidation: ObjectValidation<Status> = object<Status>('Status', required, noFields)

Const SubmitAndWaitForTransactionIdResponseValidation

SubmitAndWaitForTransactionIdResponseValidation: ObjectValidation<SubmitAndWaitForTransactionIdResponse> = object<SubmitAndWaitForTransactionIdResponse>('SubmitAndWaitForTransactionIdResponse', required, noFields)

Const SubmitAndWaitForTransactionResponseValidation

SubmitAndWaitForTransactionResponseValidation: ObjectValidation<SubmitAndWaitForTransactionResponse> = object<SubmitAndWaitForTransactionResponse>('SubmitAndWaitForTransactionResponse', required, noFields)

Const SubmitAndWaitForTransactionTreeResponseValidation

SubmitAndWaitForTransactionTreeResponseValidation: ObjectValidation<SubmitAndWaitForTransactionTreeResponse> = object<SubmitAndWaitForTransactionTreeResponse>('SubmitAndWaitForTransactionTreeResponse', required, noFields)

Const SubmitAndWaitRequestValidation

SubmitAndWaitRequestValidation: ObjectValidation<SubmitAndWaitRequest> = object<SubmitAndWaitRequest>('SubmitAndWaitRequest', required, noFields)

Const SubmitRequestValidation

SubmitRequestValidation: ObjectValidation<SubmitRequest> = object<SubmitRequest>('SubmitRequest', required, noFields)

Const TextValueValidation

TextValueValidation: ObjectValidation<TextValue> = object<TextValue>('TextValue', () => {return {valueType: string('text'),text: native('string')}}, noFields)

TimeServiceService

TimeServiceService: { getTime: object; setTime: object } = exports['com.daml.ledger.api.v1.testing.TimeService'] = {// Returns a stream of time updates.// Always returns at least one response, where the first one is the current time.// Subsequent responses are emitted whenever the ledger server's time is updated.getTime: {path: '/com.daml.ledger.api.v1.testing.TimeService/GetTime',requestStream: false,responseStream: true,requestType: com_daml_ledger_api_v1_testing_time_service_pb.GetTimeRequest,responseType: com_daml_ledger_api_v1_testing_time_service_pb.GetTimeResponse,requestSerialize: serialize_com_daml_ledger_api_v1_testing_GetTimeRequest,requestDeserialize: deserialize_com_daml_ledger_api_v1_testing_GetTimeRequest,responseSerialize: serialize_com_daml_ledger_api_v1_testing_GetTimeResponse,responseDeserialize: deserialize_com_daml_ledger_api_v1_testing_GetTimeResponse,},// Allows clients to change the ledger's clock in an atomic get-and-set operation.setTime: {path: '/com.daml.ledger.api.v1.testing.TimeService/SetTime',requestStream: false,responseStream: false,requestType: com_daml_ledger_api_v1_testing_time_service_pb.SetTimeRequest,responseType: google_protobuf_empty_pb.Empty,requestSerialize: serialize_com_daml_ledger_api_v1_testing_SetTimeRequest,requestDeserialize: deserialize_com_daml_ledger_api_v1_testing_SetTimeRequest,responseSerialize: serialize_google_protobuf_Empty,responseDeserialize: deserialize_google_protobuf_Empty,},}

Type declaration

Const TimestampValidation

TimestampValidation: ObjectValidation<Timestamp> = object<Timestamp>('Timestamp', required, noFields)

Const TimestampValueValidation

TimestampValueValidation: ObjectValidation<TimestampValue> = object<TimestampValue>('TimestampValue', () => {return {valueType: string('timestamp'),timestamp: integerString}}, noFields)

Const TransactionFilterValidation

TransactionFilterValidation: ObjectValidation<TransactionFilter> = object<TransactionFilter>('TransactionFilter', required, noFields)

TransactionServiceService

TransactionServiceService: { getFlatTransactionByEventId: object; getFlatTransactionById: object; getLedgerEnd: object; getTransactionByEventId: object; getTransactionById: object; getTransactionTrees: object; getTransactions: object } = exports['com.daml.ledger.api.v1.TransactionService'] = {// Read the ledger's filtered transaction stream for a set of parties.getTransactions: {path: '/com.daml.ledger.api.v1.TransactionService/GetTransactions',requestStream: false,responseStream: true,requestType: com_daml_ledger_api_v1_transaction_service_pb.GetTransactionsRequest,responseType: com_daml_ledger_api_v1_transaction_service_pb.GetTransactionsResponse,requestSerialize: serialize_com_daml_ledger_api_v1_GetTransactionsRequest,requestDeserialize: deserialize_com_daml_ledger_api_v1_GetTransactionsRequest,responseSerialize: serialize_com_daml_ledger_api_v1_GetTransactionsResponse,responseDeserialize: deserialize_com_daml_ledger_api_v1_GetTransactionsResponse,},// Read the ledger's complete transaction tree stream for a set of parties.getTransactionTrees: {path: '/com.daml.ledger.api.v1.TransactionService/GetTransactionTrees',requestStream: false,responseStream: true,requestType: com_daml_ledger_api_v1_transaction_service_pb.GetTransactionsRequest,responseType: com_daml_ledger_api_v1_transaction_service_pb.GetTransactionTreesResponse,requestSerialize: serialize_com_daml_ledger_api_v1_GetTransactionsRequest,requestDeserialize: deserialize_com_daml_ledger_api_v1_GetTransactionsRequest,responseSerialize: serialize_com_daml_ledger_api_v1_GetTransactionTreesResponse,responseDeserialize: deserialize_com_daml_ledger_api_v1_GetTransactionTreesResponse,},// Lookup a transaction tree by the ID of an event that appears within it.// Returns ``NOT_FOUND`` if no such transaction exists.// For looking up a transaction instead of a transaction tree, please see GetFlatTransactionByEventIdgetTransactionByEventId: {path: '/com.daml.ledger.api.v1.TransactionService/GetTransactionByEventId',requestStream: false,responseStream: false,requestType: com_daml_ledger_api_v1_transaction_service_pb.GetTransactionByEventIdRequest,responseType: com_daml_ledger_api_v1_transaction_service_pb.GetTransactionResponse,requestSerialize: serialize_com_daml_ledger_api_v1_GetTransactionByEventIdRequest,requestDeserialize: deserialize_com_daml_ledger_api_v1_GetTransactionByEventIdRequest,responseSerialize: serialize_com_daml_ledger_api_v1_GetTransactionResponse,responseDeserialize: deserialize_com_daml_ledger_api_v1_GetTransactionResponse,},// Lookup a transaction tree by its ID.// Returns ``NOT_FOUND`` if no such transaction exists.// For looking up a transaction instead of a transaction tree, please see GetFlatTransactionByIdgetTransactionById: {path: '/com.daml.ledger.api.v1.TransactionService/GetTransactionById',requestStream: false,responseStream: false,requestType: com_daml_ledger_api_v1_transaction_service_pb.GetTransactionByIdRequest,responseType: com_daml_ledger_api_v1_transaction_service_pb.GetTransactionResponse,requestSerialize: serialize_com_daml_ledger_api_v1_GetTransactionByIdRequest,requestDeserialize: deserialize_com_daml_ledger_api_v1_GetTransactionByIdRequest,responseSerialize: serialize_com_daml_ledger_api_v1_GetTransactionResponse,responseDeserialize: deserialize_com_daml_ledger_api_v1_GetTransactionResponse,},// Lookup a transaction by the ID of an event that appears within it.// Returns ``NOT_FOUND`` if no such transaction exists.getFlatTransactionByEventId: {path: '/com.daml.ledger.api.v1.TransactionService/GetFlatTransactionByEventId',requestStream: false,responseStream: false,requestType: com_daml_ledger_api_v1_transaction_service_pb.GetTransactionByEventIdRequest,responseType: com_daml_ledger_api_v1_transaction_service_pb.GetFlatTransactionResponse,requestSerialize: serialize_com_daml_ledger_api_v1_GetTransactionByEventIdRequest,requestDeserialize: deserialize_com_daml_ledger_api_v1_GetTransactionByEventIdRequest,responseSerialize: serialize_com_daml_ledger_api_v1_GetFlatTransactionResponse,responseDeserialize: deserialize_com_daml_ledger_api_v1_GetFlatTransactionResponse,},// Lookup a transaction by its ID.// Returns ``NOT_FOUND`` if no such transaction exists.getFlatTransactionById: {path: '/com.daml.ledger.api.v1.TransactionService/GetFlatTransactionById',requestStream: false,responseStream: false,requestType: com_daml_ledger_api_v1_transaction_service_pb.GetTransactionByIdRequest,responseType: com_daml_ledger_api_v1_transaction_service_pb.GetFlatTransactionResponse,requestSerialize: serialize_com_daml_ledger_api_v1_GetTransactionByIdRequest,requestDeserialize: deserialize_com_daml_ledger_api_v1_GetTransactionByIdRequest,responseSerialize: serialize_com_daml_ledger_api_v1_GetFlatTransactionResponse,responseDeserialize: deserialize_com_daml_ledger_api_v1_GetFlatTransactionResponse,},// Get the current ledger end.// Subscriptions started with the returned offset will serve transactions created after this RPC was called.getLedgerEnd: {path: '/com.daml.ledger.api.v1.TransactionService/GetLedgerEnd',requestStream: false,responseStream: false,requestType: com_daml_ledger_api_v1_transaction_service_pb.GetLedgerEndRequest,responseType: com_daml_ledger_api_v1_transaction_service_pb.GetLedgerEndResponse,requestSerialize: serialize_com_daml_ledger_api_v1_GetLedgerEndRequest,requestDeserialize: deserialize_com_daml_ledger_api_v1_GetLedgerEndRequest,responseSerialize: serialize_com_daml_ledger_api_v1_GetLedgerEndResponse,responseDeserialize: deserialize_com_daml_ledger_api_v1_GetLedgerEndResponse,},}

Type declaration

Const TransactionTreeValidation

TransactionTreeValidation: ObjectValidation<TransactionTree> = object<TransactionTree>('TransactionTree', required, optional)

Const TransactionValidation

TransactionValidation: ObjectValidation<Transaction> = object<Transaction>('Transaction', required, optional)

Const TreeEventValidation

TreeEventValidation: UnionValidation<"eventType", {}> = union('TreeEvent', 'eventType', values)

Const UnitValueValidation

UnitValueValidation: ObjectValidation<UnitValue> = object<UnitValue>('UnitValue', () => {return {valueType: string('unit')}}, noFields)

Const UploadDarFileRequestValidation

UploadDarFileRequestValidation: ObjectValidation<UploadDarFileRequest> = object<UploadDarFileRequest>('UploadDarFileRequest', required, noFields)

Const ValueValidation

ValueValidation: UnionValidation<"valueType", {}> = union('Value', 'valueType', values)

Const VariantValidation

VariantValidation: ObjectValidation<Variant> = object<Variant>('Variant', required, optional)

Const VariantValueValidation

VariantValueValidation: ObjectValidation<VariantValue> = object<VariantValue>('VariantValue', () => {return {valueType: string('variant'),constructor: native('string'),value: ValueValidation,}}, () => {return {variantId: IdentifierValidation,};})

com_daml_ledger_api_v1_active_contracts_service_pb

com_daml_ledger_api_v1_active_contracts_service_pb: "/home/moritz/daml-js/src/generated/com/daml/ledger/api/v1/active_contracts_service_pb" = require('../../../../../com/daml/ledger/api/v1/active_contracts_service_pb.js')

com_daml_ledger_api_v1_admin_config_management_service_pb

com_daml_ledger_api_v1_admin_config_management_service_pb: "/home/moritz/daml-js/src/generated/com/daml/ledger/api/v1/admin/config_management_service_pb" = require('../../../../../../com/daml/ledger/api/v1/admin/config_management_service_pb.js')

com_daml_ledger_api_v1_admin_package_management_service_pb

com_daml_ledger_api_v1_admin_package_management_service_pb: "/home/moritz/daml-js/src/generated/com/daml/ledger/api/v1/admin/package_management_service_pb" = require('../../../../../../com/daml/ledger/api/v1/admin/package_management_service_pb.js')

com_daml_ledger_api_v1_admin_party_management_service_pb

com_daml_ledger_api_v1_admin_party_management_service_pb: "/home/moritz/daml-js/src/generated/com/daml/ledger/api/v1/admin/party_management_service_pb" = require('../../../../../../com/daml/ledger/api/v1/admin/party_management_service_pb.js')

com_daml_ledger_api_v1_command_completion_service_pb

com_daml_ledger_api_v1_command_completion_service_pb: "/home/moritz/daml-js/src/generated/com/daml/ledger/api/v1/command_completion_service_pb" = require('../../../../../com/daml/ledger/api/v1/command_completion_service_pb.js')

com_daml_ledger_api_v1_command_service_pb

com_daml_ledger_api_v1_command_service_pb: "/home/moritz/daml-js/src/generated/com/daml/ledger/api/v1/command_service_pb" = require('../../../../../com/daml/ledger/api/v1/command_service_pb.js')

com_daml_ledger_api_v1_command_submission_service_pb

com_daml_ledger_api_v1_command_submission_service_pb: "/home/moritz/daml-js/src/generated/com/daml/ledger/api/v1/command_submission_service_pb" = require('../../../../../com/daml/ledger/api/v1/command_submission_service_pb.js')

com_daml_ledger_api_v1_commands_pb

com_daml_ledger_api_v1_commands_pb: "/home/moritz/daml-js/src/generated/com/daml/ledger/api/v1/commands_pb" = require('../../../../../com/daml/ledger/api/v1/commands_pb.js')

com_daml_ledger_api_v1_completion_pb

com_daml_ledger_api_v1_completion_pb: "/home/moritz/daml-js/src/generated/com/daml/ledger/api/v1/completion_pb" = require('../../../../../com/daml/ledger/api/v1/completion_pb.js')

com_daml_ledger_api_v1_event_pb

com_daml_ledger_api_v1_event_pb: "/home/moritz/daml-js/src/generated/com/daml/ledger/api/v1/event_pb" = require('../../../../../com/daml/ledger/api/v1/event_pb.js')

com_daml_ledger_api_v1_ledger_configuration_service_pb

com_daml_ledger_api_v1_ledger_configuration_service_pb: "/home/moritz/daml-js/src/generated/com/daml/ledger/api/v1/ledger_configuration_service_pb" = require('../../../../../com/daml/ledger/api/v1/ledger_configuration_service_pb.js')

com_daml_ledger_api_v1_ledger_identity_service_pb

com_daml_ledger_api_v1_ledger_identity_service_pb: "/home/moritz/daml-js/src/generated/com/daml/ledger/api/v1/ledger_identity_service_pb" = require('../../../../../com/daml/ledger/api/v1/ledger_identity_service_pb.js')

com_daml_ledger_api_v1_ledger_offset_pb

com_daml_ledger_api_v1_ledger_offset_pb: "/home/moritz/daml-js/src/generated/com/daml/ledger/api/v1/ledger_offset_pb" = require('../../../../../com/daml/ledger/api/v1/ledger_offset_pb.js')

com_daml_ledger_api_v1_package_service_pb

com_daml_ledger_api_v1_package_service_pb: "/home/moritz/daml-js/src/generated/com/daml/ledger/api/v1/package_service_pb" = require('../../../../../com/daml/ledger/api/v1/package_service_pb.js')

com_daml_ledger_api_v1_testing_reset_service_pb

com_daml_ledger_api_v1_testing_reset_service_pb: "/home/moritz/daml-js/src/generated/com/daml/ledger/api/v1/testing/reset_service_pb" = require('../../../../../../com/daml/ledger/api/v1/testing/reset_service_pb.js')

com_daml_ledger_api_v1_testing_time_service_pb

com_daml_ledger_api_v1_testing_time_service_pb: "/home/moritz/daml-js/src/generated/com/daml/ledger/api/v1/testing/time_service_pb" = require('../../../../../../com/daml/ledger/api/v1/testing/time_service_pb.js')

com_daml_ledger_api_v1_trace_context_pb

com_daml_ledger_api_v1_trace_context_pb: "/home/moritz/daml-js/src/generated/com/daml/ledger/api/v1/trace_context_pb" = require('../../../../../com/daml/ledger/api/v1/trace_context_pb.js')

com_daml_ledger_api_v1_transaction_filter_pb

com_daml_ledger_api_v1_transaction_filter_pb: "/home/moritz/daml-js/src/generated/com/daml/ledger/api/v1/transaction_filter_pb" = require('../../../../../com/daml/ledger/api/v1/transaction_filter_pb.js')

com_daml_ledger_api_v1_transaction_pb

com_daml_ledger_api_v1_transaction_pb: "/home/moritz/daml-js/src/generated/com/daml/ledger/api/v1/transaction_pb" = require('../../../../../com/daml/ledger/api/v1/transaction_pb.js')

com_daml_ledger_api_v1_transaction_service_pb

com_daml_ledger_api_v1_transaction_service_pb: "/home/moritz/daml-js/src/generated/com/daml/ledger/api/v1/transaction_service_pb" = require('../../../../../com/daml/ledger/api/v1/transaction_service_pb.js')

com_daml_ledger_api_v1_value_pb

com_daml_ledger_api_v1_value_pb: "/home/moritz/daml-js/src/generated/com/daml/ledger/api/v1/value_pb" = require('../../../../../com/daml/ledger/api/v1/value_pb.js')

com_digitalasset_daml_lf_1_8_daml_lf_0_pb

com_digitalasset_daml_lf_1_8_daml_lf_0_pb: "/home/moritz/daml-js/src/generated/com/digitalasset/daml_lf_1_8/daml_lf_0_pb" = require('../../../com/digitalasset/daml_lf_1_8/daml_lf_0_pb.js')

com_digitalasset_daml_lf_1_8_daml_lf_1_pb

com_digitalasset_daml_lf_1_8_daml_lf_1_pb: "/home/moritz/daml-js/src/generated/com/digitalasset/daml_lf_1_8/daml_lf_1_pb" = require('../../../com/digitalasset/daml_lf_1_8/daml_lf_1_pb.js')

global

global: any = Function('return this')()

goog

goog: "/home/moritz/daml-js/node_modules/@types/google-protobuf/index" = jspb

google_protobuf_any_pb

google_protobuf_any_pb: "/home/moritz/daml-js/node_modules/@types/google-protobuf/google/protobuf/any_pb" = require('google-protobuf/google/protobuf/any_pb.js')

google_protobuf_duration_pb

google_protobuf_duration_pb: "/home/moritz/daml-js/node_modules/@types/google-protobuf/google/protobuf/duration_pb" = require('google-protobuf/google/protobuf/duration_pb.js')

google_protobuf_empty_pb

google_protobuf_empty_pb: "/home/moritz/daml-js/node_modules/@types/google-protobuf/google/protobuf/empty_pb" = require('google-protobuf/google/protobuf/empty_pb.js')

google_protobuf_timestamp_pb

google_protobuf_timestamp_pb: "/home/moritz/daml-js/node_modules/@types/google-protobuf/google/protobuf/timestamp_pb" = require('google-protobuf/google/protobuf/timestamp_pb.js')

google_protobuf_wrappers_pb

google_protobuf_wrappers_pb: "/home/moritz/daml-js/node_modules/@types/google-protobuf/google/protobuf/wrappers_pb" = require('google-protobuf/google/protobuf/wrappers_pb.js')

google_rpc_status_pb

google_rpc_status_pb: "/home/moritz/daml-js/src/generated/google/rpc/status_pb" = require('../../../../../google/rpc/status_pb.js')

grpc_health_v1_health_pb

grpc_health_v1_health_pb: "/home/moritz/daml-js/src/generated/grpc/health/v1/health_pb" = require('../../../grpc/health/v1/health_pb.js')

jspb

jspb: "/home/moritz/daml-js/node_modules/@types/google-protobuf/index" = require('google-protobuf')
fileoverview
enhanceable
suppress

{messageConventions} JS Compiler reports an error if a variable or field starts with 'MSG_' and isn't a translatable message.

fileoverview
enhanceable
suppress

{messageConventions} JS Compiler reports an error if a variable or field starts with 'MSG_' and isn't a translatable message.

fileoverview
enhanceable
suppress

{messageConventions} JS Compiler reports an error if a variable or field starts with 'MSG_' and isn't a translatable message.

fileoverview
enhanceable
suppress

{messageConventions} JS Compiler reports an error if a variable or field starts with 'MSG_' and isn't a translatable message.

fileoverview
enhanceable
suppress

{messageConventions} JS Compiler reports an error if a variable or field starts with 'MSG_' and isn't a translatable message.

fileoverview
enhanceable
suppress

{messageConventions} JS Compiler reports an error if a variable or field starts with 'MSG_' and isn't a translatable message.

fileoverview
enhanceable
suppress

{messageConventions} JS Compiler reports an error if a variable or field starts with 'MSG_' and isn't a translatable message.

fileoverview
enhanceable
suppress

{messageConventions} JS Compiler reports an error if a variable or field starts with 'MSG_' and isn't a translatable message.

fileoverview
enhanceable
suppress

{messageConventions} JS Compiler reports an error if a variable or field starts with 'MSG_' and isn't a translatable message.

fileoverview
enhanceable
suppress

{messageConventions} JS Compiler reports an error if a variable or field starts with 'MSG_' and isn't a translatable message.

fileoverview
enhanceable
suppress

{messageConventions} JS Compiler reports an error if a variable or field starts with 'MSG_' and isn't a translatable message.

fileoverview
enhanceable
suppress

{messageConventions} JS Compiler reports an error if a variable or field starts with 'MSG_' and isn't a translatable message.

fileoverview
enhanceable
suppress

{messageConventions} JS Compiler reports an error if a variable or field starts with 'MSG_' and isn't a translatable message.

fileoverview
enhanceable
suppress

{messageConventions} JS Compiler reports an error if a variable or field starts with 'MSG_' and isn't a translatable message.

fileoverview
enhanceable
suppress

{messageConventions} JS Compiler reports an error if a variable or field starts with 'MSG_' and isn't a translatable message.

fileoverview
enhanceable
suppress

{messageConventions} JS Compiler reports an error if a variable or field starts with 'MSG_' and isn't a translatable message.

fileoverview
enhanceable
suppress

{messageConventions} JS Compiler reports an error if a variable or field starts with 'MSG_' and isn't a translatable message.

fileoverview
enhanceable
suppress

{messageConventions} JS Compiler reports an error if a variable or field starts with 'MSG_' and isn't a translatable message.

fileoverview
enhanceable
suppress

{messageConventions} JS Compiler reports an error if a variable or field starts with 'MSG_' and isn't a translatable message.

fileoverview
enhanceable
suppress

{messageConventions} JS Compiler reports an error if a variable or field starts with 'MSG_' and isn't a translatable message.

fileoverview
enhanceable
suppress

{messageConventions} JS Compiler reports an error if a variable or field starts with 'MSG_' and isn't a translatable message.

fileoverview
enhanceable
suppress

{messageConventions} JS Compiler reports an error if a variable or field starts with 'MSG_' and isn't a translatable message.

fileoverview
enhanceable
suppress

{messageConventions} JS Compiler reports an error if a variable or field starts with 'MSG_' and isn't a translatable message.

fileoverview
enhanceable
suppress

{messageConventions} JS Compiler reports an error if a variable or field starts with 'MSG_' and isn't a translatable message.

fileoverview
enhanceable
suppress

{messageConventions} JS Compiler reports an error if a variable or field starts with 'MSG_' and isn't a translatable message.

fileoverview
enhanceable
suppress

{messageConventions} JS Compiler reports an error if a variable or field starts with 'MSG_' and isn't a translatable message.

Functions

array

buildErrorMessage

checkOptional

  • checkOptional(object: any, optional: {}, node: ValidationTree): void

checkRequired

  • checkRequired(object: any, required: {}, node: ValidationTree): void

checkUnexpected

deserialize_com_daml_ledger_api_v1_CompletionEndRequest

  • deserialize_com_daml_ledger_api_v1_CompletionEndRequest(buffer_arg: any): CompletionEndRequest
  • Parameters

    • buffer_arg: any

    Returns CompletionEndRequest

deserialize_com_daml_ledger_api_v1_CompletionEndResponse

  • deserialize_com_daml_ledger_api_v1_CompletionEndResponse(buffer_arg: any): CompletionEndResponse
  • Parameters

    • buffer_arg: any

    Returns CompletionEndResponse

deserialize_com_daml_ledger_api_v1_CompletionStreamRequest

  • deserialize_com_daml_ledger_api_v1_CompletionStreamRequest(buffer_arg: any): CompletionStreamRequest
  • Parameters

    • buffer_arg: any

    Returns CompletionStreamRequest

deserialize_com_daml_ledger_api_v1_CompletionStreamResponse

  • deserialize_com_daml_ledger_api_v1_CompletionStreamResponse(buffer_arg: any): CompletionStreamResponse
  • Parameters

    • buffer_arg: any

    Returns CompletionStreamResponse

deserialize_com_daml_ledger_api_v1_GetActiveContractsRequest

  • deserialize_com_daml_ledger_api_v1_GetActiveContractsRequest(buffer_arg: any): GetActiveContractsRequest
  • Parameters

    • buffer_arg: any

    Returns GetActiveContractsRequest

deserialize_com_daml_ledger_api_v1_GetActiveContractsResponse

  • deserialize_com_daml_ledger_api_v1_GetActiveContractsResponse(buffer_arg: any): GetActiveContractsResponse
  • Parameters

    • buffer_arg: any

    Returns GetActiveContractsResponse

deserialize_com_daml_ledger_api_v1_GetFlatTransactionResponse

  • deserialize_com_daml_ledger_api_v1_GetFlatTransactionResponse(buffer_arg: any): GetFlatTransactionResponse
  • Parameters

    • buffer_arg: any

    Returns GetFlatTransactionResponse

deserialize_com_daml_ledger_api_v1_GetLedgerConfigurationRequest

  • deserialize_com_daml_ledger_api_v1_GetLedgerConfigurationRequest(buffer_arg: any): GetLedgerConfigurationRequest
  • Parameters

    • buffer_arg: any

    Returns GetLedgerConfigurationRequest

deserialize_com_daml_ledger_api_v1_GetLedgerConfigurationResponse

  • deserialize_com_daml_ledger_api_v1_GetLedgerConfigurationResponse(buffer_arg: any): GetLedgerConfigurationResponse
  • Parameters

    • buffer_arg: any

    Returns GetLedgerConfigurationResponse

deserialize_com_daml_ledger_api_v1_GetLedgerEndRequest

  • deserialize_com_daml_ledger_api_v1_GetLedgerEndRequest(buffer_arg: any): GetLedgerEndRequest
  • Parameters

    • buffer_arg: any

    Returns GetLedgerEndRequest

deserialize_com_daml_ledger_api_v1_GetLedgerEndResponse

  • deserialize_com_daml_ledger_api_v1_GetLedgerEndResponse(buffer_arg: any): GetLedgerEndResponse
  • Parameters

    • buffer_arg: any

    Returns GetLedgerEndResponse

deserialize_com_daml_ledger_api_v1_GetLedgerIdentityRequest

  • deserialize_com_daml_ledger_api_v1_GetLedgerIdentityRequest(buffer_arg: any): GetLedgerIdentityRequest
  • Parameters

    • buffer_arg: any

    Returns GetLedgerIdentityRequest

deserialize_com_daml_ledger_api_v1_GetLedgerIdentityResponse

  • deserialize_com_daml_ledger_api_v1_GetLedgerIdentityResponse(buffer_arg: any): GetLedgerIdentityResponse
  • Parameters

    • buffer_arg: any

    Returns GetLedgerIdentityResponse

deserialize_com_daml_ledger_api_v1_GetPackageRequest

  • deserialize_com_daml_ledger_api_v1_GetPackageRequest(buffer_arg: any): GetPackageRequest
  • Parameters

    • buffer_arg: any

    Returns GetPackageRequest

deserialize_com_daml_ledger_api_v1_GetPackageResponse

  • deserialize_com_daml_ledger_api_v1_GetPackageResponse(buffer_arg: any): GetPackageResponse
  • Parameters

    • buffer_arg: any

    Returns GetPackageResponse

deserialize_com_daml_ledger_api_v1_GetPackageStatusRequest

  • deserialize_com_daml_ledger_api_v1_GetPackageStatusRequest(buffer_arg: any): GetPackageStatusRequest
  • Parameters

    • buffer_arg: any

    Returns GetPackageStatusRequest

deserialize_com_daml_ledger_api_v1_GetPackageStatusResponse

  • deserialize_com_daml_ledger_api_v1_GetPackageStatusResponse(buffer_arg: any): GetPackageStatusResponse
  • Parameters

    • buffer_arg: any

    Returns GetPackageStatusResponse

deserialize_com_daml_ledger_api_v1_GetTransactionByEventIdRequest

  • deserialize_com_daml_ledger_api_v1_GetTransactionByEventIdRequest(buffer_arg: any): GetTransactionByEventIdRequest
  • Parameters

    • buffer_arg: any

    Returns GetTransactionByEventIdRequest

deserialize_com_daml_ledger_api_v1_GetTransactionByIdRequest

  • deserialize_com_daml_ledger_api_v1_GetTransactionByIdRequest(buffer_arg: any): GetTransactionByIdRequest
  • Parameters

    • buffer_arg: any

    Returns GetTransactionByIdRequest

deserialize_com_daml_ledger_api_v1_GetTransactionResponse

  • deserialize_com_daml_ledger_api_v1_GetTransactionResponse(buffer_arg: any): GetTransactionResponse
  • Parameters

    • buffer_arg: any

    Returns GetTransactionResponse

deserialize_com_daml_ledger_api_v1_GetTransactionTreesResponse

  • deserialize_com_daml_ledger_api_v1_GetTransactionTreesResponse(buffer_arg: any): GetTransactionTreesResponse
  • Parameters

    • buffer_arg: any

    Returns GetTransactionTreesResponse

deserialize_com_daml_ledger_api_v1_GetTransactionsRequest

  • deserialize_com_daml_ledger_api_v1_GetTransactionsRequest(buffer_arg: any): GetTransactionsRequest
  • Parameters

    • buffer_arg: any

    Returns GetTransactionsRequest

deserialize_com_daml_ledger_api_v1_GetTransactionsResponse

  • deserialize_com_daml_ledger_api_v1_GetTransactionsResponse(buffer_arg: any): GetTransactionsResponse
  • Parameters

    • buffer_arg: any

    Returns GetTransactionsResponse

deserialize_com_daml_ledger_api_v1_ListPackagesRequest

  • deserialize_com_daml_ledger_api_v1_ListPackagesRequest(buffer_arg: any): ListPackagesRequest
  • Parameters

    • buffer_arg: any

    Returns ListPackagesRequest

deserialize_com_daml_ledger_api_v1_ListPackagesResponse

  • deserialize_com_daml_ledger_api_v1_ListPackagesResponse(buffer_arg: any): ListPackagesResponse
  • Parameters

    • buffer_arg: any

    Returns ListPackagesResponse

deserialize_com_daml_ledger_api_v1_SubmitAndWaitForTransactionIdResponse

  • deserialize_com_daml_ledger_api_v1_SubmitAndWaitForTransactionIdResponse(buffer_arg: any): SubmitAndWaitForTransactionIdResponse
  • Parameters

    • buffer_arg: any

    Returns SubmitAndWaitForTransactionIdResponse

deserialize_com_daml_ledger_api_v1_SubmitAndWaitForTransactionResponse

  • deserialize_com_daml_ledger_api_v1_SubmitAndWaitForTransactionResponse(buffer_arg: any): SubmitAndWaitForTransactionResponse
  • Parameters

    • buffer_arg: any

    Returns SubmitAndWaitForTransactionResponse

deserialize_com_daml_ledger_api_v1_SubmitAndWaitForTransactionTreeResponse

  • deserialize_com_daml_ledger_api_v1_SubmitAndWaitForTransactionTreeResponse(buffer_arg: any): SubmitAndWaitForTransactionTreeResponse
  • Parameters

    • buffer_arg: any

    Returns SubmitAndWaitForTransactionTreeResponse

deserialize_com_daml_ledger_api_v1_SubmitAndWaitRequest

  • deserialize_com_daml_ledger_api_v1_SubmitAndWaitRequest(buffer_arg: any): SubmitAndWaitRequest
  • Parameters

    • buffer_arg: any

    Returns SubmitAndWaitRequest

deserialize_com_daml_ledger_api_v1_SubmitRequest

  • deserialize_com_daml_ledger_api_v1_SubmitRequest(buffer_arg: any): SubmitRequest
  • Parameters

    • buffer_arg: any

    Returns SubmitRequest

deserialize_com_daml_ledger_api_v1_admin_AllocatePartyRequest

  • deserialize_com_daml_ledger_api_v1_admin_AllocatePartyRequest(buffer_arg: any): AllocatePartyRequest
  • Parameters

    • buffer_arg: any

    Returns AllocatePartyRequest

deserialize_com_daml_ledger_api_v1_admin_AllocatePartyResponse

  • deserialize_com_daml_ledger_api_v1_admin_AllocatePartyResponse(buffer_arg: any): AllocatePartyResponse
  • Parameters

    • buffer_arg: any

    Returns AllocatePartyResponse

deserialize_com_daml_ledger_api_v1_admin_GetParticipantIdRequest

  • deserialize_com_daml_ledger_api_v1_admin_GetParticipantIdRequest(buffer_arg: any): GetParticipantIdRequest
  • Parameters

    • buffer_arg: any

    Returns GetParticipantIdRequest

deserialize_com_daml_ledger_api_v1_admin_GetParticipantIdResponse

  • deserialize_com_daml_ledger_api_v1_admin_GetParticipantIdResponse(buffer_arg: any): GetParticipantIdResponse
  • Parameters

    • buffer_arg: any

    Returns GetParticipantIdResponse

deserialize_com_daml_ledger_api_v1_admin_GetPartiesRequest

  • deserialize_com_daml_ledger_api_v1_admin_GetPartiesRequest(buffer_arg: any): GetPartiesRequest
  • Parameters

    • buffer_arg: any

    Returns GetPartiesRequest

deserialize_com_daml_ledger_api_v1_admin_GetPartiesResponse

  • deserialize_com_daml_ledger_api_v1_admin_GetPartiesResponse(buffer_arg: any): GetPartiesResponse
  • Parameters

    • buffer_arg: any

    Returns GetPartiesResponse

deserialize_com_daml_ledger_api_v1_admin_GetTimeModelRequest

  • deserialize_com_daml_ledger_api_v1_admin_GetTimeModelRequest(buffer_arg: any): GetTimeModelRequest
  • Parameters

    • buffer_arg: any

    Returns GetTimeModelRequest

deserialize_com_daml_ledger_api_v1_admin_GetTimeModelResponse

  • deserialize_com_daml_ledger_api_v1_admin_GetTimeModelResponse(buffer_arg: any): GetTimeModelResponse
  • Parameters

    • buffer_arg: any

    Returns GetTimeModelResponse

deserialize_com_daml_ledger_api_v1_admin_ListKnownPackagesRequest

  • deserialize_com_daml_ledger_api_v1_admin_ListKnownPackagesRequest(buffer_arg: any): ListKnownPackagesRequest
  • Parameters

    • buffer_arg: any

    Returns ListKnownPackagesRequest

deserialize_com_daml_ledger_api_v1_admin_ListKnownPackagesResponse

  • deserialize_com_daml_ledger_api_v1_admin_ListKnownPackagesResponse(buffer_arg: any): ListKnownPackagesResponse
  • Parameters

    • buffer_arg: any

    Returns ListKnownPackagesResponse

deserialize_com_daml_ledger_api_v1_admin_ListKnownPartiesRequest

  • deserialize_com_daml_ledger_api_v1_admin_ListKnownPartiesRequest(buffer_arg: any): ListKnownPartiesRequest
  • Parameters

    • buffer_arg: any

    Returns ListKnownPartiesRequest

deserialize_com_daml_ledger_api_v1_admin_ListKnownPartiesResponse

  • deserialize_com_daml_ledger_api_v1_admin_ListKnownPartiesResponse(buffer_arg: any): ListKnownPartiesResponse
  • Parameters

    • buffer_arg: any

    Returns ListKnownPartiesResponse

deserialize_com_daml_ledger_api_v1_admin_SetTimeModelRequest

  • deserialize_com_daml_ledger_api_v1_admin_SetTimeModelRequest(buffer_arg: any): SetTimeModelRequest
  • Parameters

    • buffer_arg: any

    Returns SetTimeModelRequest

deserialize_com_daml_ledger_api_v1_admin_SetTimeModelResponse

  • deserialize_com_daml_ledger_api_v1_admin_SetTimeModelResponse(buffer_arg: any): SetTimeModelResponse
  • Parameters

    • buffer_arg: any

    Returns SetTimeModelResponse

deserialize_com_daml_ledger_api_v1_admin_UploadDarFileRequest

  • deserialize_com_daml_ledger_api_v1_admin_UploadDarFileRequest(buffer_arg: any): UploadDarFileRequest
  • Parameters

    • buffer_arg: any

    Returns UploadDarFileRequest

deserialize_com_daml_ledger_api_v1_admin_UploadDarFileResponse

  • deserialize_com_daml_ledger_api_v1_admin_UploadDarFileResponse(buffer_arg: any): UploadDarFileResponse
  • Parameters

    • buffer_arg: any

    Returns UploadDarFileResponse

deserialize_com_daml_ledger_api_v1_testing_GetTimeRequest

  • deserialize_com_daml_ledger_api_v1_testing_GetTimeRequest(buffer_arg: any): GetTimeRequest
  • Parameters

    • buffer_arg: any

    Returns GetTimeRequest

deserialize_com_daml_ledger_api_v1_testing_GetTimeResponse

  • deserialize_com_daml_ledger_api_v1_testing_GetTimeResponse(buffer_arg: any): GetTimeResponse
  • Parameters

    • buffer_arg: any

    Returns GetTimeResponse

deserialize_com_daml_ledger_api_v1_testing_ResetRequest

  • deserialize_com_daml_ledger_api_v1_testing_ResetRequest(buffer_arg: any): ResetRequest
  • Parameters

    • buffer_arg: any

    Returns ResetRequest

deserialize_com_daml_ledger_api_v1_testing_SetTimeRequest

  • deserialize_com_daml_ledger_api_v1_testing_SetTimeRequest(buffer_arg: any): SetTimeRequest
  • Parameters

    • buffer_arg: any

    Returns SetTimeRequest

deserialize_google_protobuf_Empty

  • deserialize_google_protobuf_Empty(buffer_arg: any): Empty
  • Parameters

    • buffer_arg: any

    Returns Empty

deserialize_grpc_health_v1_HealthCheckRequest

  • deserialize_grpc_health_v1_HealthCheckRequest(buffer_arg: any): HealthCheckRequest
  • Parameters

    • buffer_arg: any

    Returns HealthCheckRequest

deserialize_grpc_health_v1_HealthCheckResponse

  • deserialize_grpc_health_v1_HealthCheckResponse(buffer_arg: any): HealthCheckResponse
  • Parameters

    • buffer_arg: any

    Returns HealthCheckResponse

enumeration

  • enumeration(enumeration: {}, type: string): Validation

forward

  • forward<A, B>(callback: Callback<B>, error: Error | null, response: A, process: (_: A) => B): void
  • Type parameters

    • A

    • B

    Parameters

    • callback: Callback<B>
    • error: Error | null
    • response: A
    • process: (_: A) => B
        • (_: A): B
        • Parameters

          • _: A

          Returns B

    Returns void

forwardVoidResponse

  • forwardVoidResponse(callback: Callback<void>, error: Error | null): void

init

isValid

native

  • native(type: "number" | "string" | "boolean"): Validation

Const noFields

  • noFields(): {}

object

optional

promisify

  • promisify<Request, Response>(call: Call<Request, Response>): PromisifiedCall<Request, Response>

record

required

serialize_com_daml_ledger_api_v1_CompletionEndRequest

  • serialize_com_daml_ledger_api_v1_CompletionEndRequest(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_CompletionEndResponse

  • serialize_com_daml_ledger_api_v1_CompletionEndResponse(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_CompletionStreamRequest

  • serialize_com_daml_ledger_api_v1_CompletionStreamRequest(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_CompletionStreamResponse

  • serialize_com_daml_ledger_api_v1_CompletionStreamResponse(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_GetActiveContractsRequest

  • serialize_com_daml_ledger_api_v1_GetActiveContractsRequest(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_GetActiveContractsResponse

  • serialize_com_daml_ledger_api_v1_GetActiveContractsResponse(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_GetFlatTransactionResponse

  • serialize_com_daml_ledger_api_v1_GetFlatTransactionResponse(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_GetLedgerConfigurationRequest

  • serialize_com_daml_ledger_api_v1_GetLedgerConfigurationRequest(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_GetLedgerConfigurationResponse

  • serialize_com_daml_ledger_api_v1_GetLedgerConfigurationResponse(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_GetLedgerEndRequest

  • serialize_com_daml_ledger_api_v1_GetLedgerEndRequest(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_GetLedgerEndResponse

  • serialize_com_daml_ledger_api_v1_GetLedgerEndResponse(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_GetLedgerIdentityRequest

  • serialize_com_daml_ledger_api_v1_GetLedgerIdentityRequest(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_GetLedgerIdentityResponse

  • serialize_com_daml_ledger_api_v1_GetLedgerIdentityResponse(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_GetPackageRequest

  • serialize_com_daml_ledger_api_v1_GetPackageRequest(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_GetPackageResponse

  • serialize_com_daml_ledger_api_v1_GetPackageResponse(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_GetPackageStatusRequest

  • serialize_com_daml_ledger_api_v1_GetPackageStatusRequest(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_GetPackageStatusResponse

  • serialize_com_daml_ledger_api_v1_GetPackageStatusResponse(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_GetTransactionByEventIdRequest

  • serialize_com_daml_ledger_api_v1_GetTransactionByEventIdRequest(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_GetTransactionByIdRequest

  • serialize_com_daml_ledger_api_v1_GetTransactionByIdRequest(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_GetTransactionResponse

  • serialize_com_daml_ledger_api_v1_GetTransactionResponse(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_GetTransactionTreesResponse

  • serialize_com_daml_ledger_api_v1_GetTransactionTreesResponse(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_GetTransactionsRequest

  • serialize_com_daml_ledger_api_v1_GetTransactionsRequest(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_GetTransactionsResponse

  • serialize_com_daml_ledger_api_v1_GetTransactionsResponse(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_ListPackagesRequest

  • serialize_com_daml_ledger_api_v1_ListPackagesRequest(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_ListPackagesResponse

  • serialize_com_daml_ledger_api_v1_ListPackagesResponse(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_SubmitAndWaitForTransactionIdResponse

  • serialize_com_daml_ledger_api_v1_SubmitAndWaitForTransactionIdResponse(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_SubmitAndWaitForTransactionResponse

  • serialize_com_daml_ledger_api_v1_SubmitAndWaitForTransactionResponse(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_SubmitAndWaitForTransactionTreeResponse

  • serialize_com_daml_ledger_api_v1_SubmitAndWaitForTransactionTreeResponse(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_SubmitAndWaitRequest

  • serialize_com_daml_ledger_api_v1_SubmitAndWaitRequest(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_SubmitRequest

  • serialize_com_daml_ledger_api_v1_SubmitRequest(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_admin_AllocatePartyRequest

  • serialize_com_daml_ledger_api_v1_admin_AllocatePartyRequest(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_admin_AllocatePartyResponse

  • serialize_com_daml_ledger_api_v1_admin_AllocatePartyResponse(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_admin_GetParticipantIdRequest

  • serialize_com_daml_ledger_api_v1_admin_GetParticipantIdRequest(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_admin_GetParticipantIdResponse

  • serialize_com_daml_ledger_api_v1_admin_GetParticipantIdResponse(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_admin_GetPartiesRequest

  • serialize_com_daml_ledger_api_v1_admin_GetPartiesRequest(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_admin_GetPartiesResponse

  • serialize_com_daml_ledger_api_v1_admin_GetPartiesResponse(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_admin_GetTimeModelRequest

  • serialize_com_daml_ledger_api_v1_admin_GetTimeModelRequest(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_admin_GetTimeModelResponse

  • serialize_com_daml_ledger_api_v1_admin_GetTimeModelResponse(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_admin_ListKnownPackagesRequest

  • serialize_com_daml_ledger_api_v1_admin_ListKnownPackagesRequest(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_admin_ListKnownPackagesResponse

  • serialize_com_daml_ledger_api_v1_admin_ListKnownPackagesResponse(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_admin_ListKnownPartiesRequest

  • serialize_com_daml_ledger_api_v1_admin_ListKnownPartiesRequest(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_admin_ListKnownPartiesResponse

  • serialize_com_daml_ledger_api_v1_admin_ListKnownPartiesResponse(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_admin_SetTimeModelRequest

  • serialize_com_daml_ledger_api_v1_admin_SetTimeModelRequest(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_admin_SetTimeModelResponse

  • serialize_com_daml_ledger_api_v1_admin_SetTimeModelResponse(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_admin_UploadDarFileRequest

  • serialize_com_daml_ledger_api_v1_admin_UploadDarFileRequest(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_admin_UploadDarFileResponse

  • serialize_com_daml_ledger_api_v1_admin_UploadDarFileResponse(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_testing_GetTimeRequest

  • serialize_com_daml_ledger_api_v1_testing_GetTimeRequest(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_testing_GetTimeResponse

  • serialize_com_daml_ledger_api_v1_testing_GetTimeResponse(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_testing_ResetRequest

  • serialize_com_daml_ledger_api_v1_testing_ResetRequest(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_com_daml_ledger_api_v1_testing_SetTimeRequest

  • serialize_com_daml_ledger_api_v1_testing_SetTimeRequest(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_google_protobuf_Empty

  • serialize_google_protobuf_Empty(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_grpc_health_v1_HealthCheckRequest

  • serialize_grpc_health_v1_HealthCheckRequest(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

serialize_grpc_health_v1_HealthCheckResponse

  • serialize_grpc_health_v1_HealthCheckResponse(arg: any): Buffer
  • Parameters

    • arg: any

    Returns Buffer

spellOutError

string

typeOf

  • typeOf(value: any): "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "null" | "object" | "function" | "array"
  • Parameters

    • value: any

    Returns "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "null" | "object" | "function" | "array"

union

  • union<Tag, A>(type: string, tag: Tag, values: () => {}): UnionValidation<Tag, A>

values

  • values(): {}

valuesOf

  • valuesOf(enumeration: {}): string[]

Object literals

Const AllocatePartyRequestCodec

AllocatePartyRequestCodec: object

deserialize

serialize

Const AllocatePartyResponseCodec

AllocatePartyResponseCodec: object

deserialize

serialize

Const AnyCodec

AnyCodec: object

deserialize

  • deserialize(message: PbAny): Any

serialize

  • serialize(object: Any): PbAny

Const ArchivedEventCodec

ArchivedEventCodec: object

deserialize

serialize

Const CheckpointCodec

CheckpointCodec: object

deserialize

serialize

Const CommandCodec

CommandCodec: object

deserialize

  • deserialize(message: PbCommand): Command

serialize

  • serialize(object: Command): PbCommand

Const CommandsCodec

CommandsCodec: object

deserialize

  • deserialize(commands: PbCommands): Commands

serialize

  • serialize(commands: Commands): PbCommands

Const CompletionCodec

CompletionCodec: object

deserialize

serialize

Const CompletionEndResponseCodec

CompletionEndResponseCodec: object

deserialize

serialize

Const CompletionStreamRequestCodec

CompletionStreamRequestCodec: object

deserialize

serialize

Const CompletionStreamResponseCodec

CompletionStreamResponseCodec: object

deserialize

serialize

Const CreateAndExerciseCommandCodec

CreateAndExerciseCommandCodec: object

deserialize

serialize

Const CreateCommandCodec

CreateCommandCodec: object

deserialize

serialize

Const CreatedEventCodec

CreatedEventCodec: object

deserialize

serialize

Const DurationCodec

DurationCodec: object

deserialize

  • deserialize(message: PbDuration): Duration

serialize

  • serialize(object: Duration): PbDuration

Const EventCodec

EventCodec: object

deserialize

  • deserialize(message: PbEvent): Event

serialize

  • serialize(object: Event): PbEvent

Const ExerciseCommandCodec

ExerciseCommandCodec: object

deserialize

serialize

Const ExercisedEventCodec

ExercisedEventCodec: object

deserialize

serialize

Const FiltersCodec

FiltersCodec: object

deserialize

  • deserialize(filters: PbFilters): Filters

serialize

  • serialize(filter: Filters): PbFilters

Const GetActiveContractsRequestCodec

GetActiveContractsRequestCodec: object

deserialize

serialize

Const GetActiveContractsResponseCodec

GetActiveContractsResponseCodec: object

deserialize

serialize

Const GetFlatTransactionResponseCodec

GetFlatTransactionResponseCodec: object

deserialize

serialize

Const GetLedgerConfigurationResponseCodec

GetLedgerConfigurationResponseCodec: object

deserialize

serialize

Const GetLedgerEndResponseCodec

GetLedgerEndResponseCodec: object

deserialize

serialize

Const GetLedgerIdentityResponseCodec

GetLedgerIdentityResponseCodec: object

deserialize

serialize

Const GetPackageResponseCodec

GetPackageResponseCodec: object

deserialize

serialize

Const GetPackageStatusResponseCodec

GetPackageStatusResponseCodec: object

deserialize

serialize

Const GetParticipantIdResponseCodec

GetParticipantIdResponseCodec: object

deserialize

serialize

Const GetTimeResponseCodec

GetTimeResponseCodec: object

deserialize

serialize

Const GetTransactionByEventIdRequestCodec

GetTransactionByEventIdRequestCodec: object

deserialize

serialize

Const GetTransactionByIdRequestCodec

GetTransactionByIdRequestCodec: object

deserialize

serialize

Const GetTransactionResponseCodec

GetTransactionResponseCodec: object

deserialize

serialize

Const GetTransactionTreesResponseCodec

GetTransactionTreesResponseCodec: object

deserialize

serialize

Const GetTransactionsRequestCodec

GetTransactionsRequestCodec: object

deserialize

serialize

Const GetTransactionsResponseCodec

GetTransactionsResponseCodec: object

deserialize

serialize

Const HumanReadableReporter

HumanReadableReporter: object

render

Const IdentifierCodec

IdentifierCodec: object

deserialize

  • deserialize(identifier: PbIdentifier): Identifier

serialize

Const InclusiveFiltersCodec

InclusiveFiltersCodec: object

deserialize

serialize

Const JSONReporter

JSONReporter: object

render

Const LedgerConfigurationCodec

LedgerConfigurationCodec: object

deserialize

serialize

Const LedgerOffsetCodec

LedgerOffsetCodec: object

deserialize

serialize

Const ListKnownPackageResponseCodec

ListKnownPackageResponseCodec: object

deserialize

serialize

Const ListKnownPartiesResponseCodec

ListKnownPartiesResponseCodec: object

deserialize

serialize

Const ListPackagesResponseCodec

ListPackagesResponseCodec: object

deserialize

serialize

Const PackageDetailsCodec

PackageDetailsCodec: object

deserialize

serialize

Const PackageStatusCodec

PackageStatusCodec: object

deserialize

serialize

Const PartyDetailsCodec

PartyDetailsCodec: object

deserialize

serialize

Const RecordCodec

RecordCodec: object

deserialize

  • deserialize(record: PbRecord): Record

serialize

  • serialize(record: Record): PbRecord

Const SetTimeRequestCodec

SetTimeRequestCodec: object

deserialize

serialize

Const StatusCodec

StatusCodec: object

deserialize

  • deserialize(message: PbStatus): Status

serialize

  • serialize(object: Status): PbStatus

Const SubmitAndWaitForTransactionIdResponseCodec

SubmitAndWaitForTransactionIdResponseCodec: object

deserialize

serialize

Const SubmitAndWaitForTransactionResponseCodec

SubmitAndWaitForTransactionResponseCodec: object

deserialize

serialize

Const SubmitAndWaitForTransactionTreeResponseCodec

SubmitAndWaitForTransactionTreeResponseCodec: object

deserialize

serialize

Const SubmitAndWaitRequestCodec

SubmitAndWaitRequestCodec: object

deserialize

serialize

Const SubmitRequestCodec

SubmitRequestCodec: object

deserialize

serialize

Const TimestampCodec

TimestampCodec: object

deserialize

  • deserialize(timestamp: PbTimestamp): Timestamp

serialize

  • serialize(timestamp: Timestamp): PbTimestamp

Const TransactionCodec

TransactionCodec: object

deserialize

serialize

Const TransactionFilterCodec

TransactionFilterCodec: object

deserialize

serialize

Const TransactionTreeCodec

TransactionTreeCodec: object

deserialize

serialize

Const TreeEventCodec

TreeEventCodec: object

deserialize

  • deserialize(message: PbTreeEvent): TreeEvent

serialize

Const UploadDarFileRequestCodec

UploadDarFileRequestCodec: object

deserialize

serialize

Const ValueCodec

ValueCodec: object

deserialize

  • deserialize(value: PbValue): Value

serialize

  • serialize(object: Value): PbValue

Const ValueHelpers

ValueHelpers: object

These helpers are thought to make expressing DAML values more concise.

To use them, you can either require them

const daml = require('@digitalasset/daml-ledger').daml;

or import them

import { daml } from '@digitalasset/daml-ledger';

none

none: OptionalValue = none

The only possible value of an empty optional value

Example:

daml.none

is

{
    valueType: 'optional'
}

unit

unit: UnitValue = unit

The only possible value of type unit as the underlying representation

Example:

daml.unit

is

{
    valueType: 'unit'
}

bool

  • Wraps a plain boolean into the underlying representation of boolean values on the ledger

    Example:

    daml.boolean(true)

    becomes

    {
        valueType: 'bool',
        bool: true
    }

    Parameters

    • value: boolean

    Returns BoolValue

contractId

  • Wraps a string into the underlying representation of contract identifiers.

    Example:

    daml.contractId('00fb4a445c10')

    becomes

    {
        valueType: 'contractId',
        contractId: '00fb4a445c10'
    }

    Parameters

    • value: string

    Returns ContractIdValue

date

  • date(value: Date | string | number): DateValue
  • If given a {@link Date}, wraps its value into the underlying representation for timestamp.

    If given a number or bigint, casts it to the corresponding string value.

    If given a string, passes through unchanged. Pay extra caution when using this approach.

    ATTENTION: plain JavaScript numbers lose precision outside the [-2^53, 2^53] range.

    Examples:

    daml.date(new Date('1971-01-01'))

    becomes

    {
        valueType: 'date',
        date: '365'
    }

    daml.date('1000000') // strings go through unchanged

    becomes

    {
        valueType: 'date',
        date: '1000000'
    }

    daml.timestamp('1970-01-01') // CAUTION: STRING GO THROUGH UNCHANGED

    becomes

    {
        valueType: 'date',
        date: '1970-01-01' // CAUTION: THIS WILL BE A RUNTIME ERROR
    }

    daml.date(1000000)

    becomes

    {
        valueType: 'date',
        date: '1000000'
    }

    Parameters

    • value: Date | string | number

    Returns DateValue

decimal

  • Wraps either a string, number or bigint in the underlying arbitrary precision decimal representation

    ATTENTION: plain JavaScript numbers lose precision outside the [-2^53, 2^53] range.

    Example:

    daml.decimal(99898)

    becomes

    {
        valueType: 'decimal',
        decimal: '99898'
    }

    Parameters

    • value: string | number | bigint

    Returns DecimalValue

enum

  • Wraps a constructor into the underlying representation for enums

    Example:

    daml.enum('Red');

    becomes

    {
        valueType: 'enum',
        constructor: 'Red'
    }

    Parameters

    Returns EnumValue

int64

  • int64(value: string | number | bigint): Int64Value
  • Wraps either a string, number or bigint in the underlying signed 64-bit integer representation

    ATTENTION: plain JavaScript numbers lose precision outside the [-2^53, 2^53] range.

    Example:

    daml.int64(99898)

    becomes

    {
        valueType: 'int64',
        int64: '99898'
    }

    Parameters

    • value: string | number | bigint

    Returns Int64Value

list

  • Wraps an array of Values into the underlying representation for lists

    Example:

    daml.list([
        daml.text('hello'),
        daml.text('world'),
    ]);

    becomes

    {
        valueType: 'list',
        list: [
            { valueType: 'text', text: 'hello' },
            { valueType: 'text', text: 'world' }
        ]
    }

    Parameters

    Returns ListValue

map

  • Turns a plain object with Values into the underlying representation for maps

    Example:

    daml.map({
        a: daml.text('hello'),
        b: daml.text('world'),
    });

    becomes

    {
        valueType: 'map',
        map: {
            a: { valueType: 'text', text: 'hello' },
            b: { valueType: 'text', text: 'world' }
        }
    }

    Parameters

    Returns MapValue

party

  • Wraps a string into the underlying representation of parties.

    Example:

    daml.party('Alice')

    becomes

    {
        valueType: 'party',
        party: 'Alice'
    }

    Parameters

    • value: string

    Returns PartyValue

record

  • Turns a plain object with Values into the underlying representation for records

    Example:

    daml.record({
        a: daml.text('hello'),
        b: daml.text('world'),
    });

    becomes

    {
        valueType: 'record',
        fields: {
            a: { valueType: 'text', text: 'hello' },
            b: { valueType: 'text', text: 'world' }
        }
    }

    Parameters

    Returns RecordValue

some

  • Wraps a Value into the underlying representation for optional values

    Examples:

    daml.some(daml.text('hello, world'))

    becomes

    {
        valueType: 'optional',
        optional: {
            valueType: 'text',
            text: 'hello, world'
         }
    }

    Parameters

    Returns OptionalValue

text

  • Wraps a string into the underlying representation of text.

    Example:

    daml.text('hello, world')

    becomes

    {
        valueType: 'text',
        text: 'hello, world'
    }

    Parameters

    • value: string

    Returns TextValue

timestamp

  • If given a {@link Date}, wraps its value into the underlying representation for timestamp.

    If given a number or bigint, casts it to the corresponding string value.

    If given a string, passes through unchanged. Pay extra caution when using this approach.

    ATTENTION: plain JavaScript numbers lose precision outside the [-2^53, 2^53] range.

    Examples:

    daml.timestamp(new Date('1970-01-01T00:00:01Z'))

    becomes

    {
        valueType: 'timestamp',
        timestamp: '1000000'
    }

    daml.timestamp('1000000') // strings go through unchanged

    becomes

    {
        valueType: 'timestamp',
        timestamp: '1000000'
    }

    daml.timestamp('1970-01-01T00:00:01Z') // CAUTION: STRING GO THROUGH UNCHANGED

    becomes

    {
        valueType: 'timestamp',
        timestamp: '1970-01-01T00:00:01Z' // CAUTION: THIS WILL BE A RUNTIME ERROR
    }

    daml.timestamp(1000000)

    becomes

    {
        valueType: 'timestamp',
        timestamp: '1000000'
    }

    Parameters

    • value: Date | string | number | bigint

    Returns TimestampValue

tuple

  • Turns an array of Values into the underlying representation for DAML tuples

    Example:

    daml.tuple([
        daml.text('hello'),
        daml.text('world'),
    ]);

    becomes

    {
        valueType: 'record',
        fields: {
            0: { valueType: 'text', text: 'hello' },
            1: { valueType: 'text', text: 'world' }
        }
    }

    Parameters

    Returns RecordValue

variant

  • Wraps a constructor and a Value into the underlying representation for variants

    Example:

    daml.variant('Person', daml.text('Alice')));

    becomes

    {
        valueType: 'variant',
        value: {
            valueType: 'text',
            text: 'Alice'
         }
    }

    Parameters

    Returns VariantValue

Const VariantCodec

VariantCodec: object

deserialize

  • deserialize(message: PbVariant): Variant

serialize

  • serialize(object: Variant): PbVariant

Const integerString

integerString: object

type

type: string = "integerString"

validate

Const none

none: object

valueType

valueType: "optional" = "optional"

Const unit

unit: object

valueType

valueType: "unit" = "unit"

Generated using TypeDoc