@c7-digital/ledger 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (98) hide show
  1. package/BUILD.md +125 -0
  2. package/LICENSE +17 -0
  3. package/README.md +97 -0
  4. package/lib/scripts/build.d.ts +9 -0
  5. package/lib/scripts/build.js +366 -0
  6. package/lib/scripts/enhance-types.d.ts +3 -0
  7. package/lib/scripts/enhance-types.js +174 -0
  8. package/lib/scripts/generate-asyncapi-types.d.ts +9 -0
  9. package/lib/scripts/generate-asyncapi-types.js +129 -0
  10. package/lib/scripts/generate-schema-modules.d.ts +3 -0
  11. package/lib/scripts/generate-schema-modules.js +33 -0
  12. package/lib/src/TemplateEmitterMap.d.ts +40 -0
  13. package/lib/src/TemplateEmitterMap.js +57 -0
  14. package/lib/src/client.d.ts +55 -0
  15. package/lib/src/client.js +62 -0
  16. package/lib/src/generated/api.d.ts +7147 -0
  17. package/lib/src/generated/api.js +1 -0
  18. package/lib/src/generated/async-api.d.ts +1665 -0
  19. package/lib/src/generated/async-api.js +1 -0
  20. package/lib/src/generated/asyncapi-schema.d.ts +1 -0
  21. package/lib/src/generated/asyncapi-schema.js +2233 -0
  22. package/lib/src/generated/openapi-schema.d.ts +1 -0
  23. package/lib/src/generated/openapi-schema.js +7321 -0
  24. package/lib/src/generated/sdk-version.d.ts +1 -0
  25. package/lib/src/generated/sdk-version.js +3 -0
  26. package/lib/src/index.d.ts +8 -0
  27. package/lib/src/index.js +8 -0
  28. package/lib/src/ledger.d.ts +188 -0
  29. package/lib/src/ledger.js +849 -0
  30. package/lib/src/ledger.test.d.ts +1 -0
  31. package/lib/src/ledger.test.js +23 -0
  32. package/lib/src/logger.d.ts +41 -0
  33. package/lib/src/logger.js +56 -0
  34. package/lib/src/multistream.d.ts +47 -0
  35. package/lib/src/multistream.js +123 -0
  36. package/lib/src/translate.d.ts +5 -0
  37. package/lib/src/translate.js +30 -0
  38. package/lib/src/types.d.ts +201 -0
  39. package/lib/src/types.js +1 -0
  40. package/lib/src/util.d.ts +3 -0
  41. package/lib/src/util.js +7 -0
  42. package/lib/src/validation.d.ts +27 -0
  43. package/lib/src/validation.js +182 -0
  44. package/lib/src/valueTypes.d.ts +34 -0
  45. package/lib/src/valueTypes.js +76 -0
  46. package/lib/src/websocket.d.ts +69 -0
  47. package/lib/src/websocket.js +125 -0
  48. package/lib/tsconfig.tsbuildinfo +1 -0
  49. package/lib-lite/scripts/build.d.ts +9 -0
  50. package/lib-lite/scripts/build.js +366 -0
  51. package/lib-lite/scripts/enhance-types.d.ts +3 -0
  52. package/lib-lite/scripts/enhance-types.js +174 -0
  53. package/lib-lite/scripts/generate-asyncapi-types.d.ts +9 -0
  54. package/lib-lite/scripts/generate-asyncapi-types.js +129 -0
  55. package/lib-lite/scripts/generate-schema-modules.d.ts +3 -0
  56. package/lib-lite/scripts/generate-schema-modules.js +33 -0
  57. package/lib-lite/src/TemplateEmitterMap.d.ts +40 -0
  58. package/lib-lite/src/TemplateEmitterMap.js +57 -0
  59. package/lib-lite/src/client.d.ts +55 -0
  60. package/lib-lite/src/client.js +62 -0
  61. package/lib-lite/src/generated/api.d.ts +7147 -0
  62. package/lib-lite/src/generated/api.js +1 -0
  63. package/lib-lite/src/generated/async-api.d.ts +1665 -0
  64. package/lib-lite/src/generated/async-api.js +1 -0
  65. package/lib-lite/src/generated/asyncapi-schema.d.ts +1 -0
  66. package/lib-lite/src/generated/asyncapi-schema.js +2 -0
  67. package/lib-lite/src/generated/openapi-schema.d.ts +1 -0
  68. package/lib-lite/src/generated/openapi-schema.js +2 -0
  69. package/lib-lite/src/generated/sdk-version.d.ts +1 -0
  70. package/lib-lite/src/generated/sdk-version.js +3 -0
  71. package/lib-lite/src/index.d.ts +8 -0
  72. package/lib-lite/src/index.js +8 -0
  73. package/lib-lite/src/ledger.d.ts +188 -0
  74. package/lib-lite/src/ledger.js +849 -0
  75. package/lib-lite/src/ledger.test.d.ts +1 -0
  76. package/lib-lite/src/ledger.test.js +23 -0
  77. package/lib-lite/src/logger.d.ts +41 -0
  78. package/lib-lite/src/logger.js +56 -0
  79. package/lib-lite/src/multistream.d.ts +47 -0
  80. package/lib-lite/src/multistream.js +123 -0
  81. package/lib-lite/src/translate.d.ts +5 -0
  82. package/lib-lite/src/translate.js +30 -0
  83. package/lib-lite/src/types.d.ts +201 -0
  84. package/lib-lite/src/types.js +1 -0
  85. package/lib-lite/src/util.d.ts +3 -0
  86. package/lib-lite/src/util.js +7 -0
  87. package/lib-lite/src/validation.d.ts +14 -0
  88. package/lib-lite/src/validation.js +31 -0
  89. package/lib-lite/src/valueTypes.d.ts +34 -0
  90. package/lib-lite/src/valueTypes.js +76 -0
  91. package/lib-lite/src/websocket.d.ts +69 -0
  92. package/lib-lite/src/websocket.js +125 -0
  93. package/lib-lite/tsconfig.temp.tsbuildinfo +1 -0
  94. package/package.json +72 -0
  95. package/scripts/build.ts +456 -0
  96. package/scripts/enhance-types.ts +223 -0
  97. package/scripts/generate-asyncapi-types.ts +158 -0
  98. package/scripts/generate-schema-modules.ts +52 -0
@@ -0,0 +1 @@
1
+ export declare const OPENAPI_SCHEMA = "openapi: 3.0.3\ninfo:\n title: JSON Ledger API HTTP endpoints\n version: 3.4.7\npaths:\n /v2/commands/submit-and-wait:\n post:\n description: Submit a batch of commands and wait for the completion details\n operationId: postV2CommandsSubmit-and-wait\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCommands'\n required: true\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/SubmitAndWaitResponse'\n '400':\n description: 'Invalid value for: body, Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/commands/submit-and-wait-for-transaction:\n post:\n description: Submit a batch of commands and wait for the transaction response\n operationId: postV2CommandsSubmit-and-wait-for-transaction\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsSubmitAndWaitForTransactionRequest'\n required: true\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsSubmitAndWaitForTransactionResponse'\n '400':\n description: 'Invalid value for: body, Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/commands/submit-and-wait-for-reassignment:\n post:\n description: Submit a batch of reassignment commands and wait for the reassignment\n response\n operationId: postV2CommandsSubmit-and-wait-for-reassignment\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/SubmitAndWaitForReassignmentRequest'\n required: true\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsSubmitAndWaitForReassignmentResponse'\n '400':\n description: 'Invalid value for: body, Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/commands/submit-and-wait-for-transaction-tree:\n post:\n description: Submit a batch of commands and wait for the transaction trees response.\n Provided for backwards compatibility, it will be removed in the Canton version\n 3.5.0, use submit-and-wait-for-transaction instead.\n operationId: postV2CommandsSubmit-and-wait-for-transaction-tree\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCommands'\n required: true\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsSubmitAndWaitForTransactionTreeResponse'\n '400':\n description: 'Invalid value for: body, Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n deprecated: true\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/commands/async/submit:\n post:\n description: Submit a command asynchronously\n operationId: postV2CommandsAsyncSubmit\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCommands'\n required: true\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/SubmitResponse'\n '400':\n description: 'Invalid value for: body, Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/commands/async/submit-reassignment:\n post:\n description: Submit reassignment command asynchronously\n operationId: postV2CommandsAsyncSubmit-reassignment\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/SubmitReassignmentRequest'\n required: true\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/SubmitReassignmentResponse'\n '400':\n description: 'Invalid value for: body, Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/commands/completions:\n post:\n description: |-\n Query completions list (blocking call)\n Notice: This endpoint should be used for small results set.\n When number of results exceeded node configuration limit (`http-list-max-elements-limit`)\n there will be an error (`413 Content Too Large`) returned.\n Increasing this limit may lead to performance issues and high memory consumption.\n Consider using websockets (asyncapi) for better efficiency with larger results.\n operationId: postV2CommandsCompletions\n parameters:\n - name: limit\n in: query\n description: maximum number of elements to return, this param is ignored if\n is bigger than server setting\n required: false\n schema:\n type: integer\n format: int64\n - name: stream_idle_timeout_ms\n in: query\n description: timeout to complete and send result if no new elements are received\n (for open ended streams)\n required: false\n schema:\n type: integer\n format: int64\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/CompletionStreamRequest'\n required: true\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n type: array\n items:\n $ref: '#/components/schemas/CompletionStreamResponse'\n '400':\n description: 'Invalid value for: body, Invalid value for: query parameter\n limit, Invalid value for: query parameter stream_idle_timeout_ms, Invalid\n value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/events/events-by-contract-id:\n post:\n description: Get events by contract Id\n operationId: postV2EventsEvents-by-contract-id\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GetEventsByContractIdRequest'\n required: true\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsGetEventsByContractIdResponse'\n '400':\n description: 'Invalid value for: body, Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/version:\n get:\n description: Get the version details of the participant node\n operationId: getV2Version\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GetLedgerApiVersionResponse'\n '400':\n description: 'Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/dars/validate:\n post:\n description: Validates a DAR for upgrade-compatibility against the current vetting\n state on the target synchronizer\n operationId: postV2DarsValidate\n parameters:\n - name: synchronizerId\n in: query\n required: false\n schema:\n type: string\n requestBody:\n content:\n application/octet-stream:\n schema:\n type: string\n format: binary\n required: true\n responses:\n '200':\n description: ''\n '400':\n description: 'Invalid value for: body, Invalid value for: query parameter\n synchronizerId, Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/dars:\n post:\n description: Upload a DAR to the participant node\n operationId: postV2Dars\n parameters:\n - name: vetAllPackages\n in: query\n required: false\n schema:\n type: boolean\n - name: synchronizerId\n in: query\n required: false\n schema:\n type: string\n requestBody:\n content:\n application/octet-stream:\n schema:\n type: string\n format: binary\n required: true\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/UploadDarFileResponse'\n '400':\n description: 'Invalid value for: body, Invalid value for: query parameter\n vetAllPackages, Invalid value for: query parameter synchronizerId, Invalid\n value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/packages:\n get:\n description: List all packages uploaded on the participant node\n operationId: getV2Packages\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ListPackagesResponse'\n '400':\n description: 'Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n post:\n description: Upload a DAR to the participant node. Behaves the same as /dars.\n This endpoint will be deprecated and removed in a future release.\n operationId: postV2Packages\n parameters:\n - name: vetAllPackages\n in: query\n required: false\n schema:\n type: boolean\n - name: synchronizerId\n in: query\n required: false\n schema:\n type: string\n requestBody:\n content:\n application/octet-stream:\n schema:\n type: string\n format: binary\n required: true\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/UploadDarFileResponse'\n '400':\n description: 'Invalid value for: body, Invalid value for: query parameter\n vetAllPackages, Invalid value for: query parameter synchronizerId, Invalid\n value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/packages/{package-id}:\n get:\n description: Download the package for the requested package-id\n operationId: getV2PackagesPackage-id\n parameters:\n - name: package-id\n in: path\n required: true\n schema:\n type: string\n responses:\n '200':\n description: ''\n headers:\n Canton-Package-Hash:\n required: true\n schema:\n type: string\n content:\n application/octet-stream:\n schema:\n type: string\n format: binary\n '400':\n description: 'Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/packages/{package-id}/status:\n get:\n description: Get package status\n operationId: getV2PackagesPackage-idStatus\n parameters:\n - name: package-id\n in: path\n required: true\n schema:\n type: string\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GetPackageStatusResponse'\n '400':\n description: 'Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/package-vetting:\n get:\n description: List vetted packages\n operationId: getV2Package-vetting\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ListVettedPackagesRequest'\n required: true\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ListVettedPackagesResponse'\n '400':\n description: 'Invalid value for: body, Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n post:\n description: Update vetted packages\n operationId: postV2Package-vetting\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/UpdateVettedPackagesRequest'\n required: true\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/UpdateVettedPackagesResponse'\n '400':\n description: 'Invalid value for: body, Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/parties:\n get:\n description: List all known parties.\n operationId: getV2Parties\n parameters:\n - name: pageSize\n in: query\n description: maximum number of elements in a returned page\n required: false\n schema:\n type: integer\n format: int32\n - name: pageToken\n in: query\n description: token - to continue results from a given page, leave empty to\n start from the beginning of the list, obtain token from the result of previous\n page\n required: false\n schema:\n type: string\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ListKnownPartiesResponse'\n '400':\n description: 'Invalid value for: query parameter pageSize, Invalid value\n for: query parameter pageToken, Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n post:\n description: Allocate a new party to the participant node\n operationId: postV2Parties\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/AllocatePartyRequest'\n required: true\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/AllocatePartyResponse'\n '400':\n description: 'Invalid value for: body, Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/parties/external/allocate:\n post:\n description: Allocate a new external party\n operationId: postV2PartiesExternalAllocate\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/AllocateExternalPartyRequest'\n required: true\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/AllocateExternalPartyResponse'\n '400':\n description: 'Invalid value for: body, Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/parties/participant-id:\n get:\n description: Get participant id\n operationId: getV2PartiesParticipant-id\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GetParticipantIdResponse'\n '400':\n description: 'Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/parties/{party}:\n get:\n description: Get party details\n operationId: getV2PartiesParty\n parameters:\n - name: party\n in: path\n required: true\n schema:\n type: string\n - name: identity-provider-id\n in: query\n required: false\n schema:\n type: string\n - name: parties\n in: query\n required: false\n schema:\n type: array\n items:\n type: string\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GetPartiesResponse'\n '400':\n description: 'Invalid value for: query parameter identity-provider-id, Invalid\n value for: query parameter parties, Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n patch:\n description: Allocate a new party to the participant node\n operationId: patchV2PartiesParty\n parameters:\n - name: party\n in: path\n required: true\n schema:\n type: string\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/UpdatePartyDetailsRequest'\n required: true\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/UpdatePartyDetailsResponse'\n '400':\n description: 'Invalid value for: body, Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/parties/external/generate-topology:\n post:\n description: Generate a topology for an external party\n operationId: postV2PartiesExternalGenerate-topology\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GenerateExternalPartyTopologyRequest'\n required: true\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GenerateExternalPartyTopologyResponse'\n '400':\n description: 'Invalid value for: body, Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/state/active-contracts:\n post:\n description: |-\n Query active contracts list (blocking call).\n Querying active contracts is an expensive operation and if possible should not be repeated often.\n Consider querying active contracts initially (for a given offset)\n and then repeatedly call one of `/v2/updates/...`endpoints to get subsequent modifications.\n You can also use websockets to get updates with better performance.\n\n Notice: This endpoint should be used for small results set.\n When number of results exceeded node configuration limit (`http-list-max-elements-limit`)\n there will be an error (`413 Content Too Large`) returned.\n Increasing this limit may lead to performance issues and high memory consumption.\n Consider using websockets (asyncapi) for better efficiency with larger results.\n operationId: postV2StateActive-contracts\n parameters:\n - name: limit\n in: query\n description: maximum number of elements to return, this param is ignored if\n is bigger than server setting\n required: false\n schema:\n type: integer\n format: int64\n - name: stream_idle_timeout_ms\n in: query\n description: timeout to complete and send result if no new elements are received\n (for open ended streams)\n required: false\n schema:\n type: integer\n format: int64\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GetActiveContractsRequest'\n required: true\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n type: array\n items:\n $ref: '#/components/schemas/JsGetActiveContractsResponse'\n '400':\n description: 'Invalid value for: body, Invalid value for: query parameter\n limit, Invalid value for: query parameter stream_idle_timeout_ms, Invalid\n value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/state/connected-synchronizers:\n get:\n description: Get connected synchronizers\n operationId: getV2StateConnected-synchronizers\n parameters:\n - name: party\n in: query\n required: false\n schema:\n type: string\n - name: participantId\n in: query\n required: false\n schema:\n type: string\n - name: identityProviderId\n in: query\n required: false\n schema:\n type: string\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GetConnectedSynchronizersResponse'\n '400':\n description: 'Invalid value for: query parameter party, Invalid value for:\n query parameter participantId, Invalid value for: query parameter identityProviderId,\n Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/state/ledger-end:\n get:\n description: Get ledger end\n operationId: getV2StateLedger-end\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GetLedgerEndResponse'\n '400':\n description: 'Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/state/latest-pruned-offsets:\n get:\n description: Get latest pruned offsets\n operationId: getV2StateLatest-pruned-offsets\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GetLatestPrunedOffsetsResponse'\n '400':\n description: 'Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/updates:\n post:\n description: |-\n Query updates list (blocking call)\n Notice: This endpoint should be used for small results set.\n When number of results exceeded node configuration limit (`http-list-max-elements-limit`)\n there will be an error (`413 Content Too Large`) returned.\n Increasing this limit may lead to performance issues and high memory consumption.\n Consider using websockets (asyncapi) for better efficiency with larger results.\n operationId: postV2Updates\n parameters:\n - name: limit\n in: query\n description: maximum number of elements to return, this param is ignored if\n is bigger than server setting\n required: false\n schema:\n type: integer\n format: int64\n - name: stream_idle_timeout_ms\n in: query\n description: timeout to complete and send result if no new elements are received\n (for open ended streams)\n required: false\n schema:\n type: integer\n format: int64\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GetUpdatesRequest'\n required: true\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n type: array\n items:\n $ref: '#/components/schemas/JsGetUpdatesResponse'\n '400':\n description: 'Invalid value for: body, Invalid value for: query parameter\n limit, Invalid value for: query parameter stream_idle_timeout_ms, Invalid\n value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/updates/flats:\n post:\n description: |-\n Query flat transactions update list (blocking call). Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates instead.\n Notice: This endpoint should be used for small results set.\n When number of results exceeded node configuration limit (`http-list-max-elements-limit`)\n there will be an error (`413 Content Too Large`) returned.\n Increasing this limit may lead to performance issues and high memory consumption.\n Consider using websockets (asyncapi) for better efficiency with larger results.\n operationId: postV2UpdatesFlats\n parameters:\n - name: limit\n in: query\n description: maximum number of elements to return, this param is ignored if\n is bigger than server setting\n required: false\n schema:\n type: integer\n format: int64\n - name: stream_idle_timeout_ms\n in: query\n description: timeout to complete and send result if no new elements are received\n (for open ended streams)\n required: false\n schema:\n type: integer\n format: int64\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GetUpdatesRequest'\n required: true\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n type: array\n items:\n $ref: '#/components/schemas/JsGetUpdatesResponse'\n '400':\n description: 'Invalid value for: body, Invalid value for: query parameter\n limit, Invalid value for: query parameter stream_idle_timeout_ms, Invalid\n value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n deprecated: true\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/updates/trees:\n post:\n description: |-\n Query update transactions tree list (blocking call). Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates instead.\n Notice: This endpoint should be used for small results set.\n When number of results exceeded node configuration limit (`http-list-max-elements-limit`)\n there will be an error (`413 Content Too Large`) returned.\n Increasing this limit may lead to performance issues and high memory consumption.\n Consider using websockets (asyncapi) for better efficiency with larger results.\n operationId: postV2UpdatesTrees\n parameters:\n - name: limit\n in: query\n description: maximum number of elements to return, this param is ignored if\n is bigger than server setting\n required: false\n schema:\n type: integer\n format: int64\n - name: stream_idle_timeout_ms\n in: query\n description: timeout to complete and send result if no new elements are received\n (for open ended streams)\n required: false\n schema:\n type: integer\n format: int64\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GetUpdatesRequest'\n required: true\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n type: array\n items:\n $ref: '#/components/schemas/JsGetUpdateTreesResponse'\n '400':\n description: 'Invalid value for: body, Invalid value for: query parameter\n limit, Invalid value for: query parameter stream_idle_timeout_ms, Invalid\n value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n deprecated: true\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/updates/transaction-tree-by-offset/{offset}:\n get:\n description: Get transaction tree by offset. Provided for backwards compatibility,\n it will be removed in the Canton version 3.5.0, use v2/updates/update-by-offset\n instead.\n operationId: getV2UpdatesTransaction-tree-by-offsetOffset\n parameters:\n - name: offset\n in: path\n required: true\n schema:\n type: integer\n format: int64\n - name: parties\n in: query\n required: false\n schema:\n type: array\n items:\n type: string\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsGetTransactionTreeResponse'\n '400':\n description: 'Invalid value for: path parameter offset, Invalid value for:\n query parameter parties, Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n deprecated: true\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/updates/transaction-by-offset:\n post:\n description: Get transaction by offset. Provided for backwards compatibility,\n it will be removed in the Canton version 3.5.0, use v2/updates/update-by-offset\n instead.\n operationId: postV2UpdatesTransaction-by-offset\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GetTransactionByOffsetRequest'\n required: true\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsGetTransactionResponse'\n '400':\n description: 'Invalid value for: body, Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n deprecated: true\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/updates/update-by-offset:\n post:\n description: Get update by offset\n operationId: postV2UpdatesUpdate-by-offset\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GetUpdateByOffsetRequest'\n required: true\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsGetUpdateResponse'\n '400':\n description: 'Invalid value for: body, Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/updates/transaction-by-id:\n post:\n description: Get transaction by id. Provided for backwards compatibility, it\n will be removed in the Canton version 3.5.0, use v2/updates/update-by-id instead.\n operationId: postV2UpdatesTransaction-by-id\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GetTransactionByIdRequest'\n required: true\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsGetTransactionResponse'\n '400':\n description: 'Invalid value for: body, Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n deprecated: true\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/updates/update-by-id:\n post:\n description: Get update by id\n operationId: postV2UpdatesUpdate-by-id\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GetUpdateByIdRequest'\n required: true\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsGetUpdateResponse'\n '400':\n description: 'Invalid value for: body, Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/updates/transaction-tree-by-id/{update-id}:\n get:\n description: Get transaction tree by id. Provided for backwards compatibility,\n it will be removed in the Canton version 3.5.0, use v2/updates/update-by-id\n instead.\n operationId: getV2UpdatesTransaction-tree-by-idUpdate-id\n parameters:\n - name: update-id\n in: path\n required: true\n schema:\n type: string\n - name: parties\n in: query\n required: false\n schema:\n type: array\n items:\n type: string\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsGetTransactionTreeResponse'\n '400':\n description: 'Invalid value for: query parameter parties, Invalid value\n for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n deprecated: true\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/users:\n get:\n description: List all users.\n operationId: getV2Users\n parameters:\n - name: pageSize\n in: query\n description: maximum number of elements in a returned page\n required: false\n schema:\n type: integer\n format: int32\n - name: pageToken\n in: query\n description: token - to continue results from a given page, leave empty to\n start from the beginning of the list, obtain token from the result of previous\n page\n required: false\n schema:\n type: string\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ListUsersResponse'\n '400':\n description: 'Invalid value for: query parameter pageSize, Invalid value\n for: query parameter pageToken, Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n post:\n description: Create user.\n operationId: postV2Users\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/CreateUserRequest'\n required: true\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/CreateUserResponse'\n '400':\n description: 'Invalid value for: body, Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/users/{user-id}:\n get:\n description: Get user details.\n operationId: getV2UsersUser-id\n parameters:\n - name: user-id\n in: path\n required: true\n schema:\n type: string\n - name: identity-provider-id\n in: query\n required: false\n schema:\n type: string\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GetUserResponse'\n '400':\n description: 'Invalid value for: query parameter identity-provider-id, Invalid\n value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n delete:\n description: Delete user.\n operationId: deleteV2UsersUser-id\n parameters:\n - name: user-id\n in: path\n required: true\n schema:\n type: string\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n type: object\n '400':\n description: 'Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n patch:\n description: Update user.\n operationId: patchV2UsersUser-id\n parameters:\n - name: user-id\n in: path\n required: true\n schema:\n type: string\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/UpdateUserRequest'\n required: true\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/UpdateUserResponse'\n '400':\n description: 'Invalid value for: body, Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/authenticated-user:\n get:\n description: Get current user details (uses user for JWT).\n operationId: getV2Authenticated-user\n parameters:\n - name: identity-provider-id\n in: query\n required: false\n schema:\n type: string\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GetUserResponse'\n '400':\n description: 'Invalid value for: query parameter identity-provider-id, Invalid\n value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/users/{user-id}/rights:\n get:\n description: List user rights.\n operationId: getV2UsersUser-idRights\n parameters:\n - name: user-id\n in: path\n required: true\n schema:\n type: string\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ListUserRightsResponse'\n '400':\n description: 'Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n post:\n description: Grant user rights.\n operationId: postV2UsersUser-idRights\n parameters:\n - name: user-id\n in: path\n required: true\n schema:\n type: string\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GrantUserRightsRequest'\n required: true\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GrantUserRightsResponse'\n '400':\n description: 'Invalid value for: body, Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n patch:\n description: Revoke user rights.\n operationId: patchV2UsersUser-idRights\n parameters:\n - name: user-id\n in: path\n required: true\n schema:\n type: string\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/RevokeUserRightsRequest'\n required: true\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/RevokeUserRightsResponse'\n '400':\n description: 'Invalid value for: body, Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/users/{user-id}/identity-provider-id:\n patch:\n description: Update user identity provider.\n operationId: patchV2UsersUser-idIdentity-provider-id\n parameters:\n - name: user-id\n in: path\n required: true\n schema:\n type: string\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/UpdateUserIdentityProviderIdRequest'\n required: true\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/UpdateUserIdentityProviderIdResponse'\n '400':\n description: 'Invalid value for: body, Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/idps:\n get:\n description: List all identity provider configs\n operationId: getV2Idps\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ListIdentityProviderConfigsResponse'\n '400':\n description: 'Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n post:\n description: Create identity provider configs\n operationId: postV2Idps\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/CreateIdentityProviderConfigRequest'\n required: true\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/CreateIdentityProviderConfigResponse'\n '400':\n description: 'Invalid value for: body, Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/idps/{idp-id}:\n get:\n description: Get identity provider config\n operationId: getV2IdpsIdp-id\n parameters:\n - name: idp-id\n in: path\n required: true\n schema:\n type: string\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GetIdentityProviderConfigResponse'\n '400':\n description: 'Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n delete:\n description: Delete identity provider config\n operationId: deleteV2IdpsIdp-id\n parameters:\n - name: idp-id\n in: path\n required: true\n schema:\n type: string\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/DeleteIdentityProviderConfigResponse'\n '400':\n description: 'Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n patch:\n description: Update identity provider config\n operationId: patchV2IdpsIdp-id\n parameters:\n - name: idp-id\n in: path\n required: true\n schema:\n type: string\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/UpdateIdentityProviderConfigRequest'\n required: true\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/UpdateIdentityProviderConfigResponse'\n '400':\n description: 'Invalid value for: body, Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/interactive-submission/prepare:\n post:\n description: Prepare commands for signing\n operationId: postV2Interactive-submissionPrepare\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsPrepareSubmissionRequest'\n required: true\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsPrepareSubmissionResponse'\n '400':\n description: 'Invalid value for: body, Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/interactive-submission/execute:\n post:\n description: Execute a signed transaction\n operationId: postV2Interactive-submissionExecute\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsExecuteSubmissionRequest'\n required: true\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ExecuteSubmissionResponse'\n '400':\n description: 'Invalid value for: body, Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/interactive-submission/executeAndWait:\n post:\n description: Execute a signed transaction and wait for its completion\n operationId: postV2Interactive-submissionExecuteandwait\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsExecuteSubmissionAndWaitRequest'\n required: true\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ExecuteSubmissionAndWaitResponse'\n '400':\n description: 'Invalid value for: body, Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/interactive-submission/executeAndWaitForTransaction:\n post:\n description: Execute a signed transaction and wait for the transaction response\n operationId: postV2Interactive-submissionExecuteandwaitfortransaction\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsExecuteSubmissionAndWaitForTransactionRequest'\n required: true\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsExecuteSubmissionAndWaitForTransactionResponse'\n '400':\n description: 'Invalid value for: body, Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/interactive-submission/preferred-package-version:\n get:\n description: Get the preferred package version for constructing a command submission\n operationId: getV2Interactive-submissionPreferred-package-version\n parameters:\n - name: parties\n in: query\n required: false\n schema:\n type: array\n items:\n type: string\n - name: package-name\n in: query\n required: true\n schema:\n type: string\n - name: vetting_valid_at\n in: query\n required: false\n schema:\n type: string\n format: date-time\n - name: synchronizer-id\n in: query\n required: false\n schema:\n type: string\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GetPreferredPackageVersionResponse'\n '400':\n description: 'Invalid value for: query parameter parties, Invalid value\n for: query parameter package-name, Invalid value for: query parameter\n vetting_valid_at, Invalid value for: query parameter synchronizer-id,\n Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\n /v2/interactive-submission/preferred-packages:\n post:\n description: Get the version of preferred packages for constructing a command\n submission\n operationId: postV2Interactive-submissionPreferred-packages\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GetPreferredPackagesRequest'\n required: true\n responses:\n '200':\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GetPreferredPackagesResponse'\n '400':\n description: 'Invalid value for: body, Invalid value for: headers'\n content:\n text/plain:\n schema:\n type: string\n default:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/JsCantonError'\n security:\n - httpAuth: []\n - apiKeyAuth: []\ncomponents:\n schemas:\n AllocateExternalPartyRequest:\n title: AllocateExternalPartyRequest\n description: 'Required authorization: ``HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(identity_provider_id)``'\n type: object\n required:\n - synchronizer\n - identityProviderId\n properties:\n synchronizer:\n description: |-\n TODO(#27670) support synchronizer aliases\n Synchronizer ID on which to onboard the party\n Required\n type: string\n onboardingTransactions:\n description: |-\n TopologyTransactions to onboard the external party\n Can contain:\n - A namespace for the party.\n This can be either a single NamespaceDelegation,\n or DecentralizedNamespaceDefinition along with its authorized namespace owners in the form of NamespaceDelegations.\n May be provided, if so it must be fully authorized by the signatures in this request combined with the existing topology state.\n - A PartyToKeyMapping to register the party's signing keys.\n May be provided, if so it must be fully authorized by the signatures in this request combined with the existing topology state.\n - A PartyToParticipant to register the hosting relationship of the party.\n Must be provided.\n Required\n type: array\n items:\n $ref: '#/components/schemas/SignedTransaction'\n multiHashSignatures:\n description: |-\n Optional signatures of the combined hash of all onboarding_transactions\n This may be used instead of providing signatures on each individual transaction\n type: array\n items:\n $ref: '#/components/schemas/Signature'\n identityProviderId:\n description: |-\n The id of the ``Identity Provider``\n If not set, assume the party is managed by the default identity provider.\n Optional\n type: string\n AllocateExternalPartyResponse:\n title: AllocateExternalPartyResponse\n type: object\n required:\n - partyId\n properties:\n partyId:\n description: ''\n type: string\n AllocatePartyRequest:\n title: AllocatePartyRequest\n description: 'Required authorization: ``HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(identity_provider_id)``'\n type: object\n required:\n - partyIdHint\n - identityProviderId\n - synchronizerId\n - userId\n properties:\n partyIdHint:\n description: |-\n A hint to the participant which party ID to allocate. It can be\n ignored.\n Must be a valid PartyIdString (as described in ``value.proto``).\n Optional\n type: string\n localMetadata:\n $ref: '#/components/schemas/ObjectMeta'\n description: |-\n Formerly \"display_name\"\n Participant-local metadata to be stored in the ``PartyDetails`` of this newly allocated party.\n Optional\n identityProviderId:\n description: |-\n The id of the ``Identity Provider``\n Optional, if not set, assume the party is managed by the default identity provider or party is not hosted by the participant.\n type: string\n synchronizerId:\n description: |-\n The synchronizer, on which the party should be allocated.\n For backwards compatibility, this field may be omitted, if the participant is connected to only one synchronizer.\n Otherwise a synchronizer must be specified.\n Optional\n type: string\n userId:\n description: |-\n The user who will get the act_as rights to the newly allocated party.\n If set to an empty string (the default), no user will get rights to the party.\n Optional\n type: string\n AllocatePartyResponse:\n title: AllocatePartyResponse\n type: object\n properties:\n partyDetails:\n $ref: '#/components/schemas/PartyDetails'\n description: ''\n ArchivedEvent:\n title: ArchivedEvent\n description: Records that a contract has been archived, and choices may no longer\n be exercised on it.\n type: object\n required:\n - offset\n - nodeId\n - contractId\n - templateId\n - packageName\n properties:\n offset:\n description: |-\n The offset of origin.\n Offsets are managed by the participant nodes.\n Transactions can thus NOT be assumed to have the same offsets on different participant nodes.\n Required, it is a valid absolute offset (positive integer)\n type: integer\n format: int64\n nodeId:\n description: |-\n The position of this event in the originating transaction or reassignment.\n Node IDs are not necessarily equal across participants,\n as these may see different projections/parts of transactions.\n Required, must be valid node ID (non-negative integer)\n type: integer\n format: int32\n contractId:\n description: |-\n The ID of the archived contract.\n Must be a valid LedgerString (as described in ``value.proto``).\n Required\n type: string\n templateId:\n description: |-\n Identifies the template that defines the choice that archived the contract.\n This template's package-id may differ from the target contract's package-id\n if the target contract has been upgraded or downgraded.\n\n The identifier uses the package-id reference format.\n\n Required\n type: string\n witnessParties:\n description: |-\n The parties that are notified of this event. For an ``ArchivedEvent``,\n these are the intersection of the stakeholders of the contract in\n question and the parties specified in the ``TransactionFilter``. The\n stakeholders are the union of the signatories and the observers of\n the contract.\n Each one of its elements must be a valid PartyIdString (as described\n in ``value.proto``).\n Required\n type: array\n items:\n type: string\n packageName:\n description: |-\n The package name of the contract.\n Required\n type: string\n implementedInterfaces:\n description: |-\n The interfaces implemented by the target template that have been\n matched from the interface filter query.\n Populated only in case interface filters with include_interface_view set.\n\n If defined, the identifier uses the package-id reference format.\n\n Optional\n type: array\n items:\n type: string\n AssignCommand:\n title: AssignCommand\n description: Assign a contract\n type: object\n required:\n - value\n properties:\n value:\n $ref: '#/components/schemas/AssignCommand1'\n AssignCommand1:\n title: AssignCommand\n description: Assign a contract\n type: object\n required:\n - reassignmentId\n - source\n - target\n properties:\n reassignmentId:\n description: |-\n The ID from the unassigned event to be completed by this assignment.\n Must be a valid LedgerString (as described in ``value.proto``).\n Required\n type: string\n source:\n description: |-\n The ID of the source synchronizer\n Must be a valid synchronizer id\n Required\n type: string\n target:\n description: |-\n The ID of the target synchronizer\n Must be a valid synchronizer id\n Required\n type: string\n CanActAs:\n title: CanActAs\n type: object\n required:\n - value\n properties:\n value:\n $ref: '#/components/schemas/CanActAs1'\n CanActAs1:\n title: CanActAs\n type: object\n required:\n - party\n properties:\n party:\n type: string\n CanExecuteAs:\n title: CanExecuteAs\n type: object\n required:\n - value\n properties:\n value:\n $ref: '#/components/schemas/CanExecuteAs1'\n CanExecuteAs1:\n title: CanExecuteAs\n type: object\n required:\n - party\n properties:\n party:\n type: string\n CanExecuteAsAnyParty:\n title: CanExecuteAsAnyParty\n type: object\n required:\n - value\n properties:\n value:\n $ref: '#/components/schemas/CanExecuteAsAnyParty1'\n CanExecuteAsAnyParty1:\n title: CanExecuteAsAnyParty\n type: object\n CanReadAs:\n title: CanReadAs\n type: object\n required:\n - value\n properties:\n value:\n $ref: '#/components/schemas/CanReadAs1'\n CanReadAs1:\n title: CanReadAs\n type: object\n required:\n - party\n properties:\n party:\n type: string\n CanReadAsAnyParty:\n title: CanReadAsAnyParty\n type: object\n required:\n - value\n properties:\n value:\n $ref: '#/components/schemas/CanReadAsAnyParty1'\n CanReadAsAnyParty1:\n title: CanReadAsAnyParty\n type: object\n Command:\n title: Command\n description: A command can either create a new contract or exercise a choice\n on an existing contract.\n oneOf:\n - type: object\n required:\n - CreateAndExerciseCommand\n properties:\n CreateAndExerciseCommand:\n $ref: '#/components/schemas/CreateAndExerciseCommand'\n - type: object\n required:\n - CreateCommand\n properties:\n CreateCommand:\n $ref: '#/components/schemas/CreateCommand'\n - type: object\n required:\n - ExerciseByKeyCommand\n properties:\n ExerciseByKeyCommand:\n $ref: '#/components/schemas/ExerciseByKeyCommand'\n - type: object\n required:\n - ExerciseCommand\n properties:\n ExerciseCommand:\n $ref: '#/components/schemas/ExerciseCommand'\n Command1:\n title: Command\n description: A command can either create a new contract or exercise a choice\n on an existing contract.\n oneOf:\n - type: object\n required:\n - AssignCommand\n properties:\n AssignCommand:\n $ref: '#/components/schemas/AssignCommand'\n - type: object\n required:\n - Empty\n properties:\n Empty:\n $ref: '#/components/schemas/Empty2'\n - type: object\n required:\n - UnassignCommand\n properties:\n UnassignCommand:\n $ref: '#/components/schemas/UnassignCommand'\n Completion:\n title: Completion\n description: 'A completion represents the status of a submitted command on the\n ledger: it can be successful or failed.'\n type: object\n required:\n - value\n properties:\n value:\n $ref: '#/components/schemas/Completion1'\n Completion1:\n title: Completion\n description: 'A completion represents the status of a submitted command on the\n ledger: it can be successful or failed.'\n type: object\n required:\n - commandId\n - updateId\n - userId\n - submissionId\n - deduplicationPeriod\n - offset\n properties:\n commandId:\n description: |-\n The ID of the succeeded or failed command.\n Must be a valid LedgerString (as described in ``value.proto``).\n Required\n type: string\n status:\n $ref: '#/components/schemas/JsStatus'\n description: |-\n Identifies the exact type of the error.\n It uses the same format of conveying error details as it is used for the RPC responses of the APIs.\n Optional\n updateId:\n description: |-\n The update_id of the transaction or reassignment that resulted from the command with command_id.\n Only set for successfully executed commands.\n Must be a valid LedgerString (as described in ``value.proto``).\n type: string\n userId:\n description: |-\n The user-id that was used for the submission, as described in ``commands.proto``.\n Must be a valid UserIdString (as described in ``value.proto``).\n Optional for historic completions where this data is not available.\n type: string\n actAs:\n description: |-\n The set of parties on whose behalf the commands were executed.\n Contains the ``act_as`` parties from ``commands.proto``\n filtered to the requesting parties in CompletionStreamRequest.\n The order of the parties need not be the same as in the submission.\n Each element must be a valid PartyIdString (as described in ``value.proto``).\n Optional for historic completions where this data is not available.\n type: array\n items:\n type: string\n submissionId:\n description: |-\n The submission ID this completion refers to, as described in ``commands.proto``.\n Must be a valid LedgerString (as described in ``value.proto``).\n Optional\n type: string\n deduplicationPeriod:\n $ref: '#/components/schemas/DeduplicationPeriod1'\n traceContext:\n $ref: '#/components/schemas/TraceContext'\n description: |-\n Optional; ledger API trace context\n\n The trace context transported in this message corresponds to the trace context supplied\n by the client application in a HTTP2 header of the original command submission.\n We typically use a header to transfer this type of information. Here we use message\n body, because it is used in gRPC streams which do not support per message headers.\n This field will be populated with the trace context contained in the original submission.\n If that was not provided, a unique ledger-api-server generated trace context will be used\n instead.\n offset:\n description: |-\n May be used in a subsequent CompletionStreamRequest to resume the consumption of this stream at a later time.\n Required, must be a valid absolute offset (positive integer).\n type: integer\n format: int64\n synchronizerTime:\n $ref: '#/components/schemas/SynchronizerTime'\n description: |-\n The synchronizer along with its record time.\n The synchronizer id provided, in case of\n\n - successful/failed transactions: identifies the synchronizer of the transaction\n - for successful/failed unassign commands: identifies the source synchronizer\n - for successful/failed assign commands: identifies the target synchronizer\n\n Required\n CompletionResponse:\n title: CompletionResponse\n oneOf:\n - type: object\n required:\n - Completion\n properties:\n Completion:\n $ref: '#/components/schemas/Completion'\n - type: object\n required:\n - Empty\n properties:\n Empty:\n $ref: '#/components/schemas/Empty4'\n - type: object\n required:\n - OffsetCheckpoint\n properties:\n OffsetCheckpoint:\n $ref: '#/components/schemas/OffsetCheckpoint'\n CompletionStreamRequest:\n title: CompletionStreamRequest\n type: object\n required:\n - userId\n - beginExclusive\n properties:\n userId:\n description: |-\n Only completions of commands submitted with the same user_id will be visible in the stream.\n Must be a valid UserIdString (as described in ``value.proto``).\n Required unless authentication is used with a user token.\n In that case, the token's user-id will be used for the request's user_id.\n type: string\n parties:\n description: |-\n Non-empty list of parties whose data should be included.\n The stream shows only completions of commands for which at least one of the ``act_as`` parties is in the given set of parties.\n Must be a valid PartyIdString (as described in ``value.proto``).\n Required\n type: array\n items:\n type: string\n beginExclusive:\n description: |-\n This optional field indicates the minimum offset for completions. This can be used to resume an earlier completion stream.\n If not set the ledger uses the ledger begin offset instead.\n If specified, it must be a valid absolute offset (positive integer) or zero (ledger begin offset).\n If the ledger has been pruned, this parameter must be specified and greater than the pruning offset.\n type: integer\n format: int64\n CompletionStreamResponse:\n title: CompletionStreamResponse\n type: object\n required:\n - completionResponse\n properties:\n completionResponse:\n $ref: '#/components/schemas/CompletionResponse'\n ConnectedSynchronizer:\n title: ConnectedSynchronizer\n type: object\n required:\n - synchronizerAlias\n - synchronizerId\n - permission\n properties:\n synchronizerAlias:\n type: string\n synchronizerId:\n type: string\n permission:\n type: string\n enum:\n - PARTICIPANT_PERMISSION_UNSPECIFIED\n - PARTICIPANT_PERMISSION_SUBMISSION\n - PARTICIPANT_PERMISSION_CONFIRMATION\n - PARTICIPANT_PERMISSION_OBSERVATION\n CostEstimation:\n title: CostEstimation\n description: |-\n Estimation of the cost of submitting the prepared transaction\n The estimation is done against the synchronizer chosen during preparation of the transaction\n (or the one explicitly requested).\n The cost of re-assigning contracts to another synchronizer when necessary is not included in the estimation.\n type: object\n required:\n - confirmationRequestTrafficCostEstimation\n - confirmationResponseTrafficCostEstimation\n - totalTrafficCostEstimation\n properties:\n estimationTimestamp:\n description: Timestamp at which the estimation was made\n type: string\n confirmationRequestTrafficCostEstimation:\n description: Estimated traffic cost of the confirmation request associated\n with the transaction\n type: integer\n format: int64\n confirmationResponseTrafficCostEstimation:\n description: |-\n Estimated traffic cost of the confirmation response associated with the transaction\n This field can also be used as an indication of the cost that other potential confirming nodes\n of the party will incur to approve or reject the transaction\n type: integer\n format: int64\n totalTrafficCostEstimation:\n description: Sum of the fields above\n type: integer\n format: int64\n CostEstimationHints:\n title: CostEstimationHints\n description: Hints to improve cost estimation precision of a prepared transaction\n type: object\n required:\n - disabled\n properties:\n disabled:\n description: |-\n Disable cost estimation\n Default (not set) is false\n type: boolean\n expectedSignatures:\n description: |-\n Details on the keys that will be used to sign the transaction (how many and of which type).\n Signature size impacts the cost of the transaction.\n If empty, the signature sizes will be approximated with threshold-many signatures (where threshold is defined\n in the PartyToKeyMapping of the external party), using keys in the order they are registered.\n Optional (empty list is equivalent to not providing this field)\n type: array\n items:\n type: string\n enum:\n - SIGNING_ALGORITHM_SPEC_UNSPECIFIED\n - SIGNING_ALGORITHM_SPEC_ED25519\n - SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_256\n - SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_384\n CreateAndExerciseCommand:\n title: CreateAndExerciseCommand\n description: Create a contract and exercise a choice on it in the same transaction.\n type: object\n required:\n - templateId\n - createArguments\n - choice\n - choiceArgument\n properties:\n templateId:\n description: |-\n The template of the contract the client wants to create.\n Both package-name and package-id reference identifier formats for the template-id are supported.\n Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4.\n\n Required\n type: string\n createArguments:\n description: |-\n The arguments required for creating a contract from this template.\n Required\n choice:\n description: |-\n The name of the choice the client wants to exercise.\n Must be a valid NameString (as described in ``value.proto``).\n Required\n type: string\n choiceArgument:\n description: |-\n The argument for this choice.\n Required\n CreateCommand:\n title: CreateCommand\n description: Create a new contract instance based on a template.\n type: object\n required:\n - templateId\n - createArguments\n properties:\n templateId:\n description: |-\n The template of contract the client wants to create.\n Both package-name and package-id reference identifier formats for the template-id are supported.\n Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4.\n\n Required\n type: string\n createArguments:\n description: |-\n The arguments required for creating a contract from this template.\n Required\n CreateIdentityProviderConfigRequest:\n title: CreateIdentityProviderConfigRequest\n type: object\n properties:\n identityProviderConfig:\n $ref: '#/components/schemas/IdentityProviderConfig'\n description: Required\n CreateIdentityProviderConfigResponse:\n title: CreateIdentityProviderConfigResponse\n type: object\n properties:\n identityProviderConfig:\n $ref: '#/components/schemas/IdentityProviderConfig'\n description: ''\n CreateUserRequest:\n title: CreateUserRequest\n description: |2-\n RPC requests and responses\n ///////////////////////////\n Required authorization: ``HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(user.identity_provider_id)``\n type: object\n properties:\n user:\n $ref: '#/components/schemas/User'\n description: |-\n The user to create.\n Required\n rights:\n description: |-\n The rights to be assigned to the user upon creation,\n which SHOULD include appropriate rights for the ``user.primary_party``.\n Optional\n type: array\n items:\n $ref: '#/components/schemas/Right'\n CreateUserResponse:\n title: CreateUserResponse\n type: object\n properties:\n user:\n $ref: '#/components/schemas/User'\n description: Created user.\n CreatedEvent:\n title: CreatedEvent\n description: Records that a contract has been created, and choices may now be\n exercised on it.\n type: object\n required:\n - offset\n - nodeId\n - contractId\n - templateId\n - createdEventBlob\n - createdAt\n - packageName\n - representativePackageId\n - acsDelta\n properties:\n offset:\n description: |-\n The offset of origin, which has contextual meaning, please see description at messages that include a CreatedEvent.\n Offsets are managed by the participant nodes.\n Transactions can thus NOT be assumed to have the same offsets on different participant nodes.\n Required, it is a valid absolute offset (positive integer)\n type: integer\n format: int64\n nodeId:\n description: |-\n The position of this event in the originating transaction or reassignment.\n The origin has contextual meaning, please see description at messages that include a CreatedEvent.\n Node IDs are not necessarily equal across participants,\n as these may see different projections/parts of transactions.\n Required, must be valid node ID (non-negative integer)\n type: integer\n format: int32\n contractId:\n description: |-\n The ID of the created contract.\n Must be a valid LedgerString (as described in ``value.proto``).\n Required\n type: string\n templateId:\n description: |-\n The template of the created contract.\n The identifier uses the package-id reference format.\n\n Required\n type: string\n contractKey:\n description: |-\n The key of the created contract.\n This will be set if and only if ``template_id`` defines a contract key.\n Optional\n createArgument: {}\n createdEventBlob:\n description: |-\n Opaque representation of contract create event payload intended for forwarding\n to an API server as a contract disclosed as part of a command\n submission.\n Optional\n type: string\n interfaceViews:\n description: |-\n Interface views specified in the transaction filter.\n Includes an ``InterfaceView`` for each interface for which there is a ``InterfaceFilter`` with\n\n - its party in the ``witness_parties`` of this event,\n - and which is implemented by the template of this event,\n - and which has ``include_interface_view`` set.\n\n Optional\n type: array\n items:\n $ref: '#/components/schemas/JsInterfaceView'\n witnessParties:\n description: |-\n The parties that are notified of this event. When a ``CreatedEvent``\n is returned as part of a transaction tree or ledger-effects transaction, this will include all\n the parties specified in the ``TransactionFilter`` that are witnesses of the event\n (the stakeholders of the contract and all informees of all the ancestors\n of this create action that this participant knows about).\n If served as part of a ACS delta transaction those will\n be limited to all parties specified in the ``TransactionFilter`` that\n are stakeholders of the contract (i.e. either signatories or observers).\n If the ``CreatedEvent`` is returned as part of an AssignedEvent,\n ActiveContract or IncompleteUnassigned (so the event is related to\n an assignment or unassignment): this will include all parties of the\n ``TransactionFilter`` that are stakeholders of the contract.\n\n The behavior of reading create events visible to parties not hosted\n on the participant node serving the Ledger API is undefined. Concretely,\n there is neither a guarantee that the participant node will serve all their\n create events on the ACS stream, nor is there a guarantee that matching archive\n events are delivered for such create events.\n\n For most clients this is not a problem, as they only read events for parties\n that are hosted on the participant node. If you need to read events\n for parties that may not be hosted at all times on the participant node,\n subscribe to the ``TopologyEvent``s for that party by setting a corresponding\n ``UpdateFormat``. Using these events, query the ACS as-of an offset where the\n party is hosted on the participant node, and ignore create events at offsets\n where the party is not hosted on the participant node.\n Required\n type: array\n items:\n type: string\n signatories:\n description: |-\n The signatories for this contract as specified by the template.\n Required\n type: array\n items:\n type: string\n observers:\n description: |-\n The observers for this contract as specified explicitly by the template or implicitly as choice controllers.\n This field never contains parties that are signatories.\n Required\n type: array\n items:\n type: string\n createdAt:\n description: |-\n Ledger effective time of the transaction that created the contract.\n Required\n type: string\n packageName:\n description: |-\n The package name of the created contract.\n Required\n type: string\n representativePackageId:\n description: |-\n A package-id present in the participant package store that typechecks the contract's argument.\n This may differ from the package-id of the template used to create the contract.\n For contracts created before Canton 3.4, this field matches the contract's creation package-id.\n\n NOTE: Experimental, server internal concept, not for client consumption. Subject to change without notice.\n\n Required\n type: string\n acsDelta:\n description: |-\n Whether this event would be part of respective ACS_DELTA shaped stream,\n and should therefore considered when tracking contract activeness on the client-side.\n Required\n type: boolean\n CreatedTreeEvent:\n title: CreatedTreeEvent\n type: object\n required:\n - value\n properties:\n value:\n $ref: '#/components/schemas/CreatedEvent'\n CumulativeFilter:\n title: CumulativeFilter\n description: |-\n A filter that matches all contracts that are either an instance of one of\n the ``template_filters`` or that match one of the ``interface_filters``.\n type: object\n required:\n - identifierFilter\n properties:\n identifierFilter:\n $ref: '#/components/schemas/IdentifierFilter'\n DeduplicationDuration:\n title: DeduplicationDuration\n type: object\n required:\n - value\n properties:\n value:\n $ref: '#/components/schemas/Duration'\n DeduplicationDuration1:\n title: DeduplicationDuration\n type: object\n required:\n - value\n properties:\n value:\n $ref: '#/components/schemas/Duration'\n DeduplicationDuration2:\n title: DeduplicationDuration\n type: object\n required:\n - value\n properties:\n value:\n $ref: '#/components/schemas/Duration'\n DeduplicationOffset:\n title: DeduplicationOffset\n type: object\n required:\n - value\n properties:\n value:\n type: integer\n format: int64\n DeduplicationOffset1:\n title: DeduplicationOffset\n type: object\n required:\n - value\n properties:\n value:\n type: integer\n format: int64\n DeduplicationOffset2:\n title: DeduplicationOffset\n type: object\n required:\n - value\n properties:\n value:\n type: integer\n format: int64\n DeduplicationPeriod:\n title: DeduplicationPeriod\n description: |-\n Specifies the deduplication period for the change ID.\n If omitted, the participant will assume the configured maximum deduplication time.\n oneOf:\n - type: object\n required:\n - DeduplicationDuration\n properties:\n DeduplicationDuration:\n $ref: '#/components/schemas/DeduplicationDuration'\n - type: object\n required:\n - DeduplicationOffset\n properties:\n DeduplicationOffset:\n $ref: '#/components/schemas/DeduplicationOffset'\n - type: object\n required:\n - Empty\n properties:\n Empty:\n $ref: '#/components/schemas/Empty'\n DeduplicationPeriod1:\n title: DeduplicationPeriod\n description: |-\n The actual deduplication window used for the submission, which is derived from\n ``Commands.deduplication_period``. The ledger may convert the deduplication period into other\n descriptions and extend the period in implementation-specified ways.\n\n Used to audit the deduplication guarantee described in ``commands.proto``.\n\n Optional; the deduplication guarantee applies even if the completion omits this field.\n oneOf:\n - type: object\n required:\n - DeduplicationDuration\n properties:\n DeduplicationDuration:\n $ref: '#/components/schemas/DeduplicationDuration1'\n - type: object\n required:\n - DeduplicationOffset\n properties:\n DeduplicationOffset:\n $ref: '#/components/schemas/DeduplicationOffset1'\n - type: object\n required:\n - Empty\n properties:\n Empty:\n $ref: '#/components/schemas/Empty3'\n DeduplicationPeriod2:\n title: DeduplicationPeriod\n oneOf:\n - type: object\n required:\n - DeduplicationDuration\n properties:\n DeduplicationDuration:\n $ref: '#/components/schemas/DeduplicationDuration2'\n - type: object\n required:\n - DeduplicationOffset\n properties:\n DeduplicationOffset:\n $ref: '#/components/schemas/DeduplicationOffset2'\n - type: object\n required:\n - Empty\n properties:\n Empty:\n $ref: '#/components/schemas/Empty10'\n DeleteIdentityProviderConfigResponse:\n title: DeleteIdentityProviderConfigResponse\n description: Does not (yet) contain any data.\n type: object\n DisclosedContract:\n title: DisclosedContract\n description: |-\n An additional contract that is used to resolve\n contract & contract key lookups.\n type: object\n required:\n - contractId\n - createdEventBlob\n - synchronizerId\n properties:\n templateId:\n description: |-\n The template id of the contract.\n The identifier uses the package-id reference format.\n\n If provided, used to validate the template id of the contract serialized in the created_event_blob.\n Optional\n type: string\n contractId:\n description: |-\n The contract id\n\n If provided, used to validate the contract id of the contract serialized in the created_event_blob.\n Optional\n type: string\n createdEventBlob:\n description: |-\n Opaque byte string containing the complete payload required by the Daml engine\n to reconstruct a contract not known to the receiving participant.\n Required\n type: string\n synchronizerId:\n description: |-\n The ID of the synchronizer where the contract is currently assigned\n Optional\n type: string\n Duration:\n title: Duration\n type: object\n required:\n - seconds\n - nanos\n properties:\n seconds:\n type: integer\n format: int64\n nanos:\n type: integer\n format: int32\n unknownFields:\n $ref: '#/components/schemas/UnknownFieldSet'\n description: This field is automatically added as part of protobuf to json\n mapping\n Empty:\n title: Empty\n type: object\n Empty1:\n title: Empty\n type: object\n Empty10:\n title: Empty\n type: object\n Empty2:\n title: Empty\n type: object\n Empty3:\n title: Empty\n type: object\n Empty4:\n title: Empty\n type: object\n Empty5:\n title: Empty\n type: object\n Empty6:\n title: Empty\n type: object\n Empty7:\n title: Empty\n type: object\n Empty8:\n title: Empty\n type: object\n Empty9:\n title: Empty\n type: object\n Event:\n title: Event\n description: |-\n Events in transactions can have two primary shapes:\n\n - ACS delta: events can be CreatedEvent or ArchivedEvent\n - ledger effects: events can be CreatedEvent or ExercisedEvent\n\n In the update service the events are restricted to the events\n visible for the parties specified in the transaction filter. Each\n event message type below contains a ``witness_parties`` field which\n indicates the subset of the requested parties that can see the event\n in question.\n oneOf:\n - type: object\n required:\n - ArchivedEvent\n properties:\n ArchivedEvent:\n $ref: '#/components/schemas/ArchivedEvent'\n - type: object\n required:\n - CreatedEvent\n properties:\n CreatedEvent:\n $ref: '#/components/schemas/CreatedEvent'\n - type: object\n required:\n - ExercisedEvent\n properties:\n ExercisedEvent:\n $ref: '#/components/schemas/ExercisedEvent'\n EventFormat:\n title: EventFormat\n description: |-\n A format for events which defines both which events should be included\n and what data should be computed and included for them.\n\n Note that some of the filtering behavior depends on the `TransactionShape`,\n which is expected to be specified alongside usages of `EventFormat`.\n type: object\n required:\n - filtersByParty\n - verbose\n properties:\n filtersByParty:\n $ref: '#/components/schemas/Map_Filters'\n description: |-\n Each key must be a valid PartyIdString (as described in ``value.proto``).\n The interpretation of the filter depends on the transaction-shape being filtered:\n\n 1. For **ledger-effects** create and exercise events are returned, for which the witnesses include at least one of\n the listed parties and match the per-party filter.\n 2. For **transaction and active-contract-set streams** create and archive events are returned for all contracts whose\n stakeholders include at least one of the listed parties and match the per-party filter.\n\n Optional\n filtersForAnyParty:\n $ref: '#/components/schemas/Filters'\n description: |-\n Wildcard filters that apply to all the parties existing on the participant. The interpretation of the filters is the same\n with the per-party filter as described above.\n Optional\n verbose:\n description: |-\n If enabled, values served over the API will contain more information than strictly necessary to interpret the data.\n In particular, setting the verbose flag to true triggers the ledger to include labels for record fields.\n Optional\n type: boolean\n ExecuteSubmissionAndWaitResponse:\n title: ExecuteSubmissionAndWaitResponse\n type: object\n required:\n - updateId\n - completionOffset\n properties:\n updateId:\n description: |-\n The id of the transaction that resulted from the submitted command.\n Must be a valid LedgerString (as described in ``value.proto``).\n Required\n type: string\n completionOffset:\n description: |-\n The details of the offset field are described in ``community/ledger-api/README.md``.\n Required\n type: integer\n format: int64\n ExecuteSubmissionResponse:\n title: ExecuteSubmissionResponse\n type: object\n ExerciseByKeyCommand:\n title: ExerciseByKeyCommand\n description: Exercise a choice on an existing contract specified by its key.\n type: object\n required:\n - templateId\n - contractKey\n - choice\n - choiceArgument\n properties:\n templateId:\n description: |-\n The template of contract the client wants to exercise.\n Both package-name and package-id reference identifier formats for the template-id are supported.\n Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4.\n\n Required\n type: string\n contractKey:\n description: |-\n The key of the contract the client wants to exercise upon.\n Required\n choice:\n description: |-\n The name of the choice the client wants to exercise.\n Must be a valid NameString (as described in ``value.proto``)\n Required\n type: string\n choiceArgument:\n description: |-\n The argument for this choice.\n Required\n ExerciseCommand:\n title: ExerciseCommand\n description: Exercise a choice on an existing contract.\n type: object\n required:\n - templateId\n - contractId\n - choice\n - choiceArgument\n properties:\n templateId:\n description: |-\n The template or interface of the contract the client wants to exercise.\n Both package-name and package-id reference identifier formats for the template-id are supported.\n Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4.\n To exercise a choice on an interface, specify the interface identifier in the template_id field.\n\n Required\n type: string\n contractId:\n description: |-\n The ID of the contract the client wants to exercise upon.\n Must be a valid LedgerString (as described in ``value.proto``).\n Required\n type: string\n choice:\n description: |-\n The name of the choice the client wants to exercise.\n Must be a valid NameString (as described in ``value.proto``)\n Required\n type: string\n choiceArgument:\n description: |-\n The argument for this choice.\n Required\n ExercisedEvent:\n title: ExercisedEvent\n description: Records that a choice has been exercised on a target contract.\n type: object\n required:\n - offset\n - nodeId\n - contractId\n - templateId\n - choice\n - choiceArgument\n - consuming\n - lastDescendantNodeId\n - exerciseResult\n - packageName\n - acsDelta\n properties:\n offset:\n description: |-\n The offset of origin.\n Offsets are managed by the participant nodes.\n Transactions can thus NOT be assumed to have the same offsets on different participant nodes.\n Required, it is a valid absolute offset (positive integer)\n type: integer\n format: int64\n nodeId:\n description: |-\n The position of this event in the originating transaction or reassignment.\n Node IDs are not necessarily equal across participants,\n as these may see different projections/parts of transactions.\n Required, must be valid node ID (non-negative integer)\n type: integer\n format: int32\n contractId:\n description: |-\n The ID of the target contract.\n Must be a valid LedgerString (as described in ``value.proto``).\n Required\n type: string\n templateId:\n description: |-\n Identifies the template that defines the executed choice.\n This template's package-id may differ from the target contract's package-id\n if the target contract has been upgraded or downgraded.\n\n The identifier uses the package-id reference format.\n\n Required\n type: string\n interfaceId:\n description: |-\n The interface where the choice is defined, if inherited.\n If defined, the identifier uses the package-id reference format.\n\n Optional\n type: string\n choice:\n description: |-\n The choice that was exercised on the target contract.\n Must be a valid NameString (as described in ``value.proto``).\n Required\n type: string\n choiceArgument:\n description: |-\n The argument of the exercised choice.\n Required\n actingParties:\n description: |-\n The parties that exercised the choice.\n Each element must be a valid PartyIdString (as described in ``value.proto``).\n Required\n type: array\n items:\n type: string\n consuming:\n description: |-\n If true, the target contract may no longer be exercised.\n Required\n type: boolean\n witnessParties:\n description: |-\n The parties that are notified of this event. The witnesses of an exercise\n node will depend on whether the exercise was consuming or not.\n If consuming, the witnesses are the union of the stakeholders,\n the actors and all informees of all the ancestors of this event this\n participant knows about.\n If not consuming, the witnesses are the union of the signatories,\n the actors and all informees of all the ancestors of this event this\n participant knows about.\n In both cases the witnesses are limited to the querying parties, or not\n limited in case anyParty filters are used.\n Note that the actors might not necessarily be observers\n and thus stakeholders. This is the case when the controllers of a\n choice are specified using \"flexible controllers\", using the\n ``choice ... controller`` syntax, and said controllers are not\n explicitly marked as observers.\n Each element must be a valid PartyIdString (as described in ``value.proto``).\n Required\n type: array\n items:\n type: string\n lastDescendantNodeId:\n description: |-\n Specifies the upper boundary of the node ids of the events in the same transaction that appeared as a result of\n this ``ExercisedEvent``. This allows unambiguous identification of all the members of the subtree rooted at this\n node. A full subtree can be constructed when all descendant nodes are present in the stream. If nodes are heavily\n filtered, it is only possible to determine if a node is in a consequent subtree or not.\n Required\n type: integer\n format: int32\n exerciseResult:\n description: |-\n The result of exercising the choice.\n Required\n packageName:\n description: |-\n The package name of the contract.\n Required\n type: string\n implementedInterfaces:\n description: |-\n If the event is consuming, the interfaces implemented by the target template that have been\n matched from the interface filter query.\n Populated only in case interface filters with include_interface_view set.\n\n The identifier uses the package-id reference format.\n\n Optional\n type: array\n items:\n type: string\n acsDelta:\n description: |-\n Whether this event would be part of respective ACS_DELTA shaped stream,\n and should therefore considered when tracking contract activeness on the client-side.\n Required\n type: boolean\n ExercisedTreeEvent:\n title: ExercisedTreeEvent\n type: object\n required:\n - value\n properties:\n value:\n $ref: '#/components/schemas/ExercisedEvent'\n ExperimentalCommandInspectionService:\n title: ExperimentalCommandInspectionService\n description: Whether the Ledger API supports command inspection service\n type: object\n required:\n - supported\n properties:\n supported:\n description: ''\n type: boolean\n ExperimentalFeatures:\n title: ExperimentalFeatures\n description: See the feature message definitions for descriptions.\n type: object\n properties:\n staticTime:\n $ref: '#/components/schemas/ExperimentalStaticTime'\n description: ''\n commandInspectionService:\n $ref: '#/components/schemas/ExperimentalCommandInspectionService'\n description: ''\n ExperimentalStaticTime:\n title: ExperimentalStaticTime\n description: Ledger is in the static time mode and exposes a time service.\n type: object\n required:\n - supported\n properties:\n supported:\n description: ''\n type: boolean\n FeaturesDescriptor:\n title: FeaturesDescriptor\n type: object\n properties:\n experimental:\n $ref: '#/components/schemas/ExperimentalFeatures'\n description: |-\n Features under development or features that are used\n for ledger implementation testing purposes only.\n\n Daml applications SHOULD not depend on these in production.\n userManagement:\n $ref: '#/components/schemas/UserManagementFeature'\n description: |-\n If set, then the Ledger API server supports user management.\n It is recommended that clients query this field to gracefully adjust their behavior for\n ledgers that do not support user management.\n partyManagement:\n $ref: '#/components/schemas/PartyManagementFeature'\n description: |-\n If set, then the Ledger API server supports party management configurability.\n It is recommended that clients query this field to gracefully adjust their behavior to\n maximum party page size.\n offsetCheckpoint:\n $ref: '#/components/schemas/OffsetCheckpointFeature'\n description: It contains the timeouts related to the periodic offset checkpoint\n emission\n packageFeature:\n $ref: '#/components/schemas/PackageFeature'\n description: |-\n If set, then the Ledger API server supports package listing\n configurability. It is recommended that clients query this field to\n gracefully adjust their behavior to maximum package listing page size.\n Field:\n title: Field\n type: object\n properties:\n varint:\n type: array\n items:\n type: integer\n format: int64\n fixed64:\n type: array\n items:\n type: integer\n format: int64\n fixed32:\n type: array\n items:\n type: integer\n format: int32\n lengthDelimited:\n type: array\n items:\n type: string\n FieldMask:\n title: FieldMask\n type: object\n required:\n - unknownFields\n properties:\n paths:\n type: array\n items:\n type: string\n unknownFields:\n $ref: '#/components/schemas/UnknownFieldSet'\n Filters:\n title: Filters\n description: The union of a set of template filters, interface filters, or a\n wildcard.\n type: object\n properties:\n cumulative:\n description: |-\n Every filter in the cumulative list expands the scope of the resulting stream. Each interface,\n template or wildcard filter means additional events that will match the query.\n The impact of include_interface_view and include_created_event_blob fields in the filters will\n also be accumulated.\n A template or an interface SHOULD NOT appear twice in the accumulative field.\n A wildcard filter SHOULD NOT be defined more than once in the accumulative field.\n Optional, if no ``CumulativeFilter`` defined, the default of a single ``WildcardFilter`` with\n include_created_event_blob unset is used.\n type: array\n items:\n $ref: '#/components/schemas/CumulativeFilter'\n GenerateExternalPartyTopologyRequest:\n title: GenerateExternalPartyTopologyRequest\n type: object\n required:\n - synchronizer\n - partyHint\n - localParticipantObservationOnly\n - confirmationThreshold\n properties:\n synchronizer:\n description: |-\n TODO(#27670) support synchronizer aliases\n Required: synchronizer-id for which we are building this request.\n type: string\n partyHint:\n description: 'Required: the actual party id will be constructed from this\n hint and a fingerprint of the public key'\n type: string\n publicKey:\n $ref: '#/components/schemas/SigningPublicKey'\n description: 'Required: public key'\n localParticipantObservationOnly:\n description: 'Optional: if true, then the local participant will only be\n observing, not confirming. Default false.'\n type: boolean\n otherConfirmingParticipantUids:\n description: 'Optional: other participant ids which should be confirming\n for this party'\n type: array\n items:\n type: string\n confirmationThreshold:\n description: 'Optional: Confirmation threshold >= 1 for the party. Defaults\n to all available confirmers (or if set to 0).'\n type: integer\n format: int32\n observingParticipantUids:\n description: 'Optional: other observing participant ids for this party'\n type: array\n items:\n type: string\n GenerateExternalPartyTopologyResponse:\n title: GenerateExternalPartyTopologyResponse\n description: Response message with topology transactions and the multi-hash\n to be signed.\n type: object\n required:\n - partyId\n - publicKeyFingerprint\n - multiHash\n properties:\n partyId:\n description: the generated party id\n type: string\n publicKeyFingerprint:\n description: the fingerprint of the supplied public key\n type: string\n topologyTransactions:\n description: |-\n The serialized topology transactions which need to be signed and submitted as part of the allocate party process\n Note that the serialization includes the versioning information. Therefore, the transaction here is serialized\n as an `UntypedVersionedMessage` which in turn contains the serialized `TopologyTransaction` in the version\n supported by the synchronizer.\n type: array\n items:\n type: string\n multiHash:\n description: the multi-hash which may be signed instead of each individual\n transaction\n type: string\n GetActiveContractsRequest:\n title: GetActiveContractsRequest\n description: |-\n If the given offset is different than the ledger end, and there are (un)assignments in-flight at the given offset,\n the snapshot may fail with \"FAILED_PRECONDITION/PARTICIPANT_PRUNED_DATA_ACCESSED\".\n Note that it is ok to request acs snapshots for party migration with offsets other than ledger end, because party\n migration is not concerned with incomplete (un)assignments.\n type: object\n required:\n - verbose\n - activeAtOffset\n properties:\n filter:\n $ref: '#/components/schemas/TransactionFilter'\n description: |-\n Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.\n Templates to include in the served snapshot, per party.\n Optional, if specified event_format must be unset, if not specified event_format must be set.\n verbose:\n description: |-\n Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.\n If enabled, values served over the API will contain more information than strictly necessary to interpret the data.\n In particular, setting the verbose flag to true triggers the ledger to include labels for record fields.\n Optional, if specified event_format must be unset.\n type: boolean\n activeAtOffset:\n description: |-\n The offset at which the snapshot of the active contracts will be computed.\n Must be no greater than the current ledger end offset.\n Must be greater than or equal to the last pruning offset.\n Required, must be a valid absolute offset (positive integer) or ledger begin offset (zero).\n If zero, the empty set will be returned.\n type: integer\n format: int64\n eventFormat:\n $ref: '#/components/schemas/EventFormat'\n description: |-\n Format of the contract_entries in the result. In case of CreatedEvent the presentation will be of\n TRANSACTION_SHAPE_ACS_DELTA.\n Optional for backwards compatibility, defaults to an EventFormat where:\n\n - filters_by_party is the filter.filters_by_party from this request\n - filters_for_any_party is the filter.filters_for_any_party from this request\n - verbose is the verbose field from this request\n GetConnectedSynchronizersResponse:\n title: GetConnectedSynchronizersResponse\n type: object\n properties:\n connectedSynchronizers:\n description: ''\n type: array\n items:\n $ref: '#/components/schemas/ConnectedSynchronizer'\n GetEventsByContractIdRequest:\n title: GetEventsByContractIdRequest\n type: object\n required:\n - contractId\n properties:\n contractId:\n description: |-\n The contract id being queried.\n Required\n type: string\n eventFormat:\n $ref: '#/components/schemas/EventFormat'\n description: |-\n Format of the events in the result, the presentation will be of TRANSACTION_SHAPE_ACS_DELTA.\n Required\n GetIdentityProviderConfigResponse:\n title: GetIdentityProviderConfigResponse\n type: object\n properties:\n identityProviderConfig:\n $ref: '#/components/schemas/IdentityProviderConfig'\n description: ''\n GetLatestPrunedOffsetsResponse:\n title: GetLatestPrunedOffsetsResponse\n type: object\n required:\n - participantPrunedUpToInclusive\n - allDivulgedContractsPrunedUpToInclusive\n properties:\n participantPrunedUpToInclusive:\n description: |-\n It will always be a non-negative integer.\n If positive, the absolute offset up to which the ledger has been pruned,\n disregarding the state of all divulged contracts pruning.\n If zero, the ledger has not been pruned yet.\n type: integer\n format: int64\n allDivulgedContractsPrunedUpToInclusive:\n description: |-\n It will always be a non-negative integer.\n If positive, the absolute offset up to which all divulged events have been pruned on the ledger.\n It can be at or before the ``participant_pruned_up_to_inclusive`` offset.\n For more details about all divulged events pruning,\n see ``PruneRequest.prune_all_divulged_contracts`` in ``participant_pruning_service.proto``.\n If zero, the divulged events have not been pruned yet.\n type: integer\n format: int64\n GetLedgerApiVersionResponse:\n title: GetLedgerApiVersionResponse\n type: object\n required:\n - version\n properties:\n version:\n description: The version of the ledger API.\n type: string\n features:\n $ref: '#/components/schemas/FeaturesDescriptor'\n description: |-\n The features supported by this Ledger API endpoint.\n\n Daml applications CAN use the feature descriptor on top of\n version constraints on the Ledger API version to determine\n whether a given Ledger API endpoint supports the features\n required to run the application.\n\n See the feature descriptions themselves for the relation between\n Ledger API versions and feature presence.\n GetLedgerEndResponse:\n title: GetLedgerEndResponse\n type: object\n required:\n - offset\n properties:\n offset:\n description: |-\n It will always be a non-negative integer.\n If zero, the participant view of the ledger is empty.\n If positive, the absolute offset of the ledger as viewed by the participant.\n type: integer\n format: int64\n GetPackageStatusResponse:\n title: GetPackageStatusResponse\n type: object\n required:\n - packageStatus\n properties:\n packageStatus:\n description: The status of the package.\n type: string\n enum:\n - PACKAGE_STATUS_UNSPECIFIED\n - PACKAGE_STATUS_REGISTERED\n GetParticipantIdResponse:\n title: GetParticipantIdResponse\n type: object\n required:\n - participantId\n properties:\n participantId:\n description: |-\n Identifier of the participant, which SHOULD be globally unique.\n Must be a valid LedgerString (as describe in ``value.proto``).\n type: string\n GetPartiesResponse:\n title: GetPartiesResponse\n type: object\n properties:\n partyDetails:\n description: |-\n The details of the requested Daml parties by the participant, if known.\n The party details may not be in the same order as requested.\n Required\n type: array\n items:\n $ref: '#/components/schemas/PartyDetails'\n GetPreferredPackageVersionResponse:\n title: GetPreferredPackageVersionResponse\n type: object\n properties:\n packagePreference:\n $ref: '#/components/schemas/PackagePreference'\n description: |-\n Not populated when no preferred package is found\n Optional\n GetPreferredPackagesRequest:\n title: GetPreferredPackagesRequest\n type: object\n required:\n - synchronizerId\n properties:\n packageVettingRequirements:\n description: |-\n The package-name vetting requirements for which the preferred packages should be resolved.\n\n Generally it is enough to provide the requirements for the intended command's root package-names.\n Additional package-name requirements can be provided when additional Daml transaction informees need to use\n package dependencies of the command's root packages.\n\n Required\n type: array\n items:\n $ref: '#/components/schemas/PackageVettingRequirement'\n synchronizerId:\n description: |-\n The synchronizer whose vetting state should be used for resolving this query.\n If not specified, the vetting states of all synchronizers to which the participant is connected are used.\n Optional\n type: string\n vettingValidAt:\n description: |-\n The timestamp at which the package vetting validity should be computed\n on the latest topology snapshot as seen by the participant.\n If not provided, the participant's current clock time is used.\n Optional\n type: string\n GetPreferredPackagesResponse:\n title: GetPreferredPackagesResponse\n type: object\n required:\n - synchronizerId\n properties:\n packageReferences:\n description: |-\n The package references of the preferred packages.\n Must contain one package reference for each requested package-name.\n\n If you build command submissions whose content depends on the returned\n preferred packages, then we recommend submitting the preferred package-ids\n in the ``package_id_selection_preference`` of the command submission to\n avoid race conditions with concurrent changes of the on-ledger package vetting state.\n\n Required\n type: array\n items:\n $ref: '#/components/schemas/PackageReference'\n synchronizerId:\n description: |-\n The synchronizer for which the package preferences are computed.\n If the synchronizer_id was specified in the request, then it matches the request synchronizer_id.\n Required\n type: string\n GetTransactionByIdRequest:\n title: GetTransactionByIdRequest\n description: Provided for backwards compatibility, it will be removed in the\n Canton version 3.5.0.\n type: object\n required:\n - updateId\n properties:\n updateId:\n description: |-\n The ID of a particular transaction.\n Must be a valid LedgerString (as described in ``value.proto``).\n Required\n type: string\n requestingParties:\n description: |-\n Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.\n The parties whose events the client expects to see.\n Events that are not visible for the parties in this collection will not be present in the response.\n Each element must be a valid PartyIdString (as described in ``value.proto``).\n Optional for backwards compatibility for GetTransactionById request: if defined transaction_format must be\n unset (falling back to defaults).\n type: array\n items:\n type: string\n transactionFormat:\n $ref: '#/components/schemas/TransactionFormat'\n description: |-\n Optional for GetTransactionById request for backwards compatibility: defaults to a transaction_format, where:\n\n - event_format.filters_by_party will have template-wildcard filters for all the requesting_parties\n - event_format.filters_for_any_party is unset\n - event_format.verbose = true\n - transaction_shape = TRANSACTION_SHAPE_ACS_DELTA\n GetTransactionByOffsetRequest:\n title: GetTransactionByOffsetRequest\n description: Provided for backwards compatibility, it will be removed in the\n Canton version 3.5.0.\n type: object\n required:\n - offset\n properties:\n offset:\n description: |-\n The offset of the transaction being looked up.\n Must be a valid absolute offset (positive integer).\n Required\n type: integer\n format: int64\n requestingParties:\n description: |-\n Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.\n The parties whose events the client expects to see.\n Events that are not visible for the parties in this collection will not be present in the response.\n Each element must be a valid PartyIdString (as described in ``value.proto``).\n Optional for backwards compatibility for GetTransactionByOffset request: if defined transaction_format must be\n unset (falling back to defaults).\n type: array\n items:\n type: string\n transactionFormat:\n $ref: '#/components/schemas/TransactionFormat'\n description: |-\n Optional for GetTransactionByOffset request for backwards compatibility: defaults to a TransactionFormat, where:\n\n - event_format.filters_by_party will have template-wildcard filters for all the requesting_parties\n - event_format.filters_for_any_party is unset\n - event_format.verbose = true\n - transaction_shape = TRANSACTION_SHAPE_ACS_DELTA\n GetUpdateByIdRequest:\n title: GetUpdateByIdRequest\n type: object\n required:\n - updateId\n properties:\n updateId:\n description: |-\n The ID of a particular update.\n Must be a valid LedgerString (as described in ``value.proto``).\n Required\n type: string\n updateFormat:\n $ref: '#/components/schemas/UpdateFormat'\n description: |-\n The format for the update.\n Required\n GetUpdateByOffsetRequest:\n title: GetUpdateByOffsetRequest\n type: object\n required:\n - offset\n properties:\n offset:\n description: |-\n The offset of the update being looked up.\n Must be a valid absolute offset (positive integer).\n Required\n type: integer\n format: int64\n updateFormat:\n $ref: '#/components/schemas/UpdateFormat'\n description: |-\n The format for the update.\n Required\n GetUpdatesRequest:\n title: GetUpdatesRequest\n type: object\n required:\n - beginExclusive\n - verbose\n properties:\n beginExclusive:\n description: |-\n Beginning of the requested ledger section (non-negative integer).\n The response will only contain transactions whose offset is strictly greater than this.\n If zero, the stream will start from the beginning of the ledger.\n If positive, the streaming will start after this absolute offset.\n If the ledger has been pruned, this parameter must be specified and be greater than the pruning offset.\n type: integer\n format: int64\n endInclusive:\n description: |-\n End of the requested ledger section.\n The response will only contain transactions whose offset is less than or equal to this.\n Optional, if empty, the stream will not terminate.\n If specified, the stream will terminate after this absolute offset (positive integer) is reached.\n type: integer\n format: int64\n filter:\n $ref: '#/components/schemas/TransactionFilter'\n description: |-\n Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.\n Requesting parties with template filters.\n Template filters must be empty for GetUpdateTrees requests.\n Optional for backwards compatibility, if defined update_format must be unset\n verbose:\n description: |-\n Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.\n If enabled, values served over the API will contain more information than strictly necessary to interpret the data.\n In particular, setting the verbose flag to true triggers the ledger to include labels, record and variant type ids\n for record fields.\n Optional for backwards compatibility, if defined update_format must be unset\n type: boolean\n updateFormat:\n $ref: '#/components/schemas/UpdateFormat'\n description: |-\n Must be unset for GetUpdateTrees request.\n Optional for backwards compatibility for GetUpdates request: defaults to an UpdateFormat where:\n\n - include_transactions.event_format.filters_by_party = the filter.filters_by_party on this request\n - include_transactions.event_format.filters_for_any_party = the filter.filters_for_any_party on this request\n - include_transactions.event_format.verbose = the same flag specified on this request\n - include_transactions.transaction_shape = TRANSACTION_SHAPE_ACS_DELTA\n - include_reassignments.filter = the same filter specified on this request\n - include_reassignments.verbose = the same flag specified on this request\n - include_topology_events.include_participant_authorization_events.parties = all the parties specified in filter\n GetUserResponse:\n title: GetUserResponse\n type: object\n properties:\n user:\n $ref: '#/components/schemas/User'\n description: Retrieved user.\n GrantUserRightsRequest:\n title: GrantUserRightsRequest\n description: |-\n Add the rights to the set of rights granted to the user.\n\n Required authorization: ``HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(identity_provider_id)``\n type: object\n required:\n - userId\n - identityProviderId\n properties:\n userId:\n description: |-\n The user to whom to grant rights.\n Required\n type: string\n rights:\n description: |-\n The rights to grant.\n Optional\n type: array\n items:\n $ref: '#/components/schemas/Right'\n identityProviderId:\n description: |-\n The id of the ``Identity Provider``\n Optional, if not set, assume the user is managed by the default identity provider.\n type: string\n GrantUserRightsResponse:\n title: GrantUserRightsResponse\n type: object\n properties:\n newlyGrantedRights:\n description: The rights that were newly granted by the request.\n type: array\n items:\n $ref: '#/components/schemas/Right'\n Identifier:\n title: Identifier\n type: object\n required:\n - packageId\n - moduleName\n - entityName\n properties:\n packageId:\n type: string\n moduleName:\n type: string\n entityName:\n type: string\n IdentifierFilter:\n title: IdentifierFilter\n oneOf:\n - type: object\n required:\n - Empty\n properties:\n Empty:\n $ref: '#/components/schemas/Empty1'\n - type: object\n required:\n - InterfaceFilter\n properties:\n InterfaceFilter:\n $ref: '#/components/schemas/InterfaceFilter'\n - type: object\n required:\n - TemplateFilter\n properties:\n TemplateFilter:\n $ref: '#/components/schemas/TemplateFilter'\n - type: object\n required:\n - WildcardFilter\n properties:\n WildcardFilter:\n $ref: '#/components/schemas/WildcardFilter'\n IdentityProviderAdmin:\n title: IdentityProviderAdmin\n type: object\n required:\n - value\n properties:\n value:\n $ref: '#/components/schemas/IdentityProviderAdmin1'\n IdentityProviderAdmin1:\n title: IdentityProviderAdmin\n type: object\n IdentityProviderConfig:\n title: IdentityProviderConfig\n type: object\n required:\n - identityProviderId\n - isDeactivated\n - issuer\n - jwksUrl\n - audience\n properties:\n identityProviderId:\n description: |-\n The identity provider identifier\n Must be a valid LedgerString (as describe in ``value.proto``).\n Required\n type: string\n isDeactivated:\n description: |-\n When set, the callers using JWT tokens issued by this identity provider are denied all access\n to the Ledger API.\n Optional,\n Modifiable\n type: boolean\n issuer:\n description: |-\n Specifies the issuer of the JWT token.\n The issuer value is a case sensitive URL using the https scheme that contains scheme, host,\n and optionally, port number and path components and no query or fragment components.\n Required\n Modifiable\n type: string\n jwksUrl:\n description: |-\n The JWKS (JSON Web Key Set) URL.\n The Ledger API uses JWKs (JSON Web Keys) from the provided URL to verify that the JWT has been\n signed with the loaded JWK. Only RS256 (RSA Signature with SHA-256) signing algorithm is supported.\n Required\n Modifiable\n type: string\n audience:\n description: |-\n Specifies the audience of the JWT token.\n When set, the callers using JWT tokens issued by this identity provider are allowed to get an access\n only if the \"aud\" claim includes the string specified here\n Optional,\n Modifiable\n type: string\n InterfaceFilter:\n title: InterfaceFilter\n description: This filter matches contracts that implement a specific interface.\n type: object\n required:\n - value\n properties:\n value:\n $ref: '#/components/schemas/InterfaceFilter1'\n InterfaceFilter1:\n title: InterfaceFilter\n description: This filter matches contracts that implement a specific interface.\n type: object\n required:\n - includeInterfaceView\n - includeCreatedEventBlob\n properties:\n interfaceId:\n description: |-\n The interface that a matching contract must implement.\n The ``interface_id`` needs to be valid: corresponding interface should be defined in\n one of the available packages at the time of the query.\n Both package-name and package-id reference formats for the identifier are supported.\n Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4.\n\n Required\n type: string\n includeInterfaceView:\n description: |-\n Whether to include the interface view on the contract in the returned ``CreatedEvent``.\n Use this to access contract data in a uniform manner in your API client.\n Optional\n type: boolean\n includeCreatedEventBlob:\n description: |-\n Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``.\n Use this to access the contract create event payload in your API client\n for submitting it as a disclosed contract with future commands.\n Optional\n type: boolean\n JsActiveContract:\n title: JsActiveContract\n type: object\n required:\n - createdEvent\n - synchronizerId\n - reassignmentCounter\n properties:\n createdEvent:\n $ref: '#/components/schemas/CreatedEvent'\n description: |-\n Required\n The event as it appeared in the context of its last update (i.e. daml transaction or\n reassignment). In particular, the last offset, node_id pair is preserved.\n The last update is the most recent update created or assigned this contract on synchronizer_id synchronizer.\n The offset of the CreatedEvent might point to an already pruned update, therefore it cannot necessarily be used\n for lookups.\n synchronizerId:\n description: |-\n A valid synchronizer id\n Required\n type: string\n reassignmentCounter:\n description: |-\n Each corresponding assigned and unassigned event has the same reassignment_counter. This strictly increases\n with each unassign command for the same contract. Creation of the contract corresponds to reassignment_counter\n equals zero.\n This field will be the reassignment_counter of the latest observable activation event on this synchronizer, which is\n before the active_at_offset.\n Required\n type: integer\n format: int64\n JsArchived:\n title: JsArchived\n type: object\n required:\n - archivedEvent\n - synchronizerId\n properties:\n archivedEvent:\n $ref: '#/components/schemas/ArchivedEvent'\n description: Required\n synchronizerId:\n description: |-\n Required\n The synchronizer which sequenced the archival of the contract\n type: string\n JsAssignedEvent:\n title: JsAssignedEvent\n description: Records that a contract has been assigned, and it can be used on\n the target synchronizer.\n type: object\n required:\n - source\n - target\n - reassignmentId\n - submitter\n - reassignmentCounter\n - createdEvent\n properties:\n source:\n description: |-\n The ID of the source synchronizer.\n Must be a valid synchronizer id.\n Required\n type: string\n target:\n description: |-\n The ID of the target synchronizer.\n Must be a valid synchronizer id.\n Required\n type: string\n reassignmentId:\n description: |-\n The ID from the unassigned event.\n For correlation capabilities.\n Must be a valid LedgerString (as described in ``value.proto``).\n Required\n type: string\n submitter:\n description: |-\n Party on whose behalf the assign command was executed.\n Empty if the assignment happened offline via the repair service.\n Must be a valid PartyIdString (as described in ``value.proto``).\n Optional\n type: string\n reassignmentCounter:\n description: |-\n Each corresponding assigned and unassigned event has the same reassignment_counter. This strictly increases\n with each unassign command for the same contract. Creation of the contract corresponds to reassignment_counter\n equals zero.\n Required\n type: integer\n format: int64\n createdEvent:\n $ref: '#/components/schemas/CreatedEvent'\n description: |-\n Required\n The offset of this event refers to the offset of the assignment,\n while the node_id is the index of within the batch.\n JsAssignmentEvent:\n title: JsAssignmentEvent\n type: object\n required:\n - source\n - target\n - reassignmentId\n - submitter\n - reassignmentCounter\n - createdEvent\n properties:\n source:\n type: string\n target:\n type: string\n reassignmentId:\n type: string\n submitter:\n type: string\n reassignmentCounter:\n type: integer\n format: int64\n createdEvent:\n $ref: '#/components/schemas/CreatedEvent'\n JsCantonError:\n title: JsCantonError\n type: object\n required:\n - code\n - cause\n - context\n - errorCategory\n properties:\n code:\n type: string\n cause:\n type: string\n correlationId:\n type: string\n traceId:\n type: string\n context:\n $ref: '#/components/schemas/Map_String'\n resources:\n type: array\n items:\n $ref: '#/components/schemas/Tuple2_String_String'\n errorCategory:\n type: integer\n format: int32\n grpcCodeValue:\n type: integer\n format: int32\n retryInfo:\n type: string\n definiteAnswer:\n type: boolean\n JsCommands:\n title: JsCommands\n description: A composite command that groups multiple commands together.\n type: object\n required:\n - commandId\n properties:\n commands:\n description: |-\n Individual elements of this atomic command. Must be non-empty.\n Required\n type: array\n items:\n $ref: '#/components/schemas/Command'\n commandId:\n description: |-\n Uniquely identifies the command.\n The triple (user_id, act_as, command_id) constitutes the change ID for the intended ledger change,\n where act_as is interpreted as a set of party names.\n The change ID can be used for matching the intended ledger changes with all their completions.\n Must be a valid LedgerString (as described in ``value.proto``).\n Required\n type: string\n actAs:\n description: |-\n Set of parties on whose behalf the command should be executed.\n If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request\n to act on behalf of each of the given parties.\n Each element must be a valid PartyIdString (as described in ``value.proto``).\n Required, must be non-empty.\n type: array\n items:\n type: string\n userId:\n description: |-\n Uniquely identifies the participant user that issued the command.\n Must be a valid UserIdString (as described in ``value.proto``).\n Required unless authentication is used with a user token.\n In that case, the token's user-id will be used for the request's user_id.\n type: string\n readAs:\n description: |-\n Set of parties on whose behalf (in addition to all parties listed in ``act_as``) contracts can be retrieved.\n This affects Daml operations such as ``fetch``, ``fetchByKey``, ``lookupByKey``, ``exercise``, and ``exerciseByKey``.\n Note: A participant node of a Daml network can host multiple parties. Each contract present on the participant\n node is only visible to a subset of these parties. A command can only use contracts that are visible to at least\n one of the parties in ``act_as`` or ``read_as``. This visibility check is independent from the Daml authorization\n rules for fetch operations.\n If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request\n to read contract data on behalf of each of the given parties.\n Optional\n type: array\n items:\n type: string\n workflowId:\n description: |-\n Identifier of the on-ledger workflow that this command is a part of.\n Must be a valid LedgerString (as described in ``value.proto``).\n Optional\n type: string\n deduplicationPeriod:\n $ref: '#/components/schemas/DeduplicationPeriod'\n minLedgerTimeAbs:\n description: |-\n Lower bound for the ledger time assigned to the resulting transaction.\n Note: The ledger time of a transaction is assigned as part of command interpretation.\n Use this property if you expect that command interpretation will take a considerate amount of time, such that by\n the time the resulting transaction is sequenced, its assigned ledger time is not valid anymore.\n Must not be set at the same time as min_ledger_time_rel.\n Optional\n type: string\n minLedgerTimeRel:\n $ref: '#/components/schemas/Duration'\n description: |-\n Same as min_ledger_time_abs, but specified as a duration, starting from the time the command is received by the server.\n Must not be set at the same time as min_ledger_time_abs.\n Optional\n submissionId:\n description: |-\n A unique identifier to distinguish completions for different submissions with the same change ID.\n Typically a random UUID. Applications are expected to use a different UUID for each retry of a submission\n with the same change ID.\n Must be a valid LedgerString (as described in ``value.proto``).\n\n If omitted, the participant or the committer may set a value of their choice.\n Optional\n type: string\n disclosedContracts:\n description: |-\n Additional contracts used to resolve contract & contract key lookups.\n Optional\n type: array\n items:\n $ref: '#/components/schemas/DisclosedContract'\n synchronizerId:\n description: |-\n Must be a valid synchronizer id\n Optional\n type: string\n packageIdSelectionPreference:\n description: |-\n The package-id selection preference of the client for resolving\n package names and interface instances in command submission and interpretation\n type: array\n items:\n type: string\n prefetchContractKeys:\n description: |-\n Fetches the contract keys into the caches to speed up the command processing.\n Should only contain contract keys that are expected to be resolved during interpretation of the commands.\n Keys of disclosed contracts do not need prefetching.\n\n Optional\n type: array\n items:\n $ref: '#/components/schemas/PrefetchContractKey'\n JsContractEntry:\n title: JsContractEntry\n description: |-\n For a contract there could be multiple contract_entry-s in the entire snapshot. These together define\n the state of one contract in the snapshot.\n A contract_entry is included in the result, if and only if there is at least one stakeholder party of the contract\n that is hosted on the synchronizer at the time of the event and the party satisfies the\n ``TransactionFilter`` in the query.\n oneOf:\n - type: object\n required:\n - JsActiveContract\n properties:\n JsActiveContract:\n $ref: '#/components/schemas/JsActiveContract'\n - type: object\n required:\n - JsEmpty\n properties:\n JsEmpty:\n $ref: '#/components/schemas/JsEmpty'\n - type: object\n required:\n - JsIncompleteAssigned\n properties:\n JsIncompleteAssigned:\n $ref: '#/components/schemas/JsIncompleteAssigned'\n - type: object\n required:\n - JsIncompleteUnassigned\n properties:\n JsIncompleteUnassigned:\n $ref: '#/components/schemas/JsIncompleteUnassigned'\n JsCreated:\n title: JsCreated\n type: object\n required:\n - createdEvent\n - synchronizerId\n properties:\n createdEvent:\n $ref: '#/components/schemas/CreatedEvent'\n description: |-\n Required\n The event as it appeared in the context of its original update (i.e. daml transaction or\n reassignment) on this participant node. You can use its offset and node_id to find the\n corresponding update and the node within it.\n synchronizerId:\n description: |-\n The synchronizer which sequenced the creation of the contract\n Required\n type: string\n JsEmpty:\n title: JsEmpty\n type: object\n JsExecuteSubmissionAndWaitForTransactionRequest:\n title: JsExecuteSubmissionAndWaitForTransactionRequest\n type: object\n required:\n - deduplicationPeriod\n - submissionId\n - userId\n - hashingSchemeVersion\n properties:\n preparedTransaction:\n description: |-\n the prepared transaction\n Typically this is the value of the `prepared_transaction` field in `PrepareSubmissionResponse`\n obtained from calling `prepareSubmission`.\n Required\n type: string\n partySignatures:\n $ref: '#/components/schemas/PartySignatures'\n description: |-\n The party(ies) signatures that authorize the prepared submission to be executed by this node.\n Each party can provide one or more signatures..\n and one or more parties can sign.\n Note that currently, only single party submissions are supported.\n Required\n deduplicationPeriod:\n $ref: '#/components/schemas/DeduplicationPeriod2'\n submissionId:\n description: |-\n A unique identifier to distinguish completions for different submissions with the same change ID.\n Typically a random UUID. Applications are expected to use a different UUID for each retry of a submission\n with the same change ID.\n Must be a valid LedgerString (as described in ``value.proto``).\n\n Required\n type: string\n userId:\n description: |-\n See [PrepareSubmissionRequest.user_id]\n Optional\n type: string\n hashingSchemeVersion:\n description: |-\n The hashing scheme version used when building the hash\n Required\n type: string\n enum:\n - HASHING_SCHEME_VERSION_UNSPECIFIED\n - HASHING_SCHEME_VERSION_V2\n minLedgerTime:\n $ref: '#/components/schemas/MinLedgerTime'\n description: |-\n If set will influence the chosen ledger effective time but will not result in a submission delay so any override\n should be scheduled to executed within the window allowed by synchronizer.\n Optional\n transactionFormat:\n $ref: '#/components/schemas/TransactionFormat'\n description: |-\n If no ``transaction_format`` is provided, a default will be used where ``transaction_shape`` is set to\n TRANSACTION_SHAPE_ACS_DELTA, ``event_format`` is defined with ``filters_by_party`` containing wildcard-template\n filter for all original ``act_as`` and ``read_as`` parties and the ``verbose`` flag is set.\n When the ``transaction_shape`` TRANSACTION_SHAPE_ACS_DELTA shape is used (explicitly or is defaulted to as explained above),\n events will only be returned if the submitting party is hosted on this node.\n Optional\n JsExecuteSubmissionAndWaitForTransactionResponse:\n title: JsExecuteSubmissionAndWaitForTransactionResponse\n type: object\n required:\n - transaction\n properties:\n transaction:\n $ref: '#/components/schemas/JsTransaction'\n description: |-\n The transaction that resulted from the submitted command.\n The transaction might contain no events (request conditions result in filtering out all of them).\n Required\n JsExecuteSubmissionAndWaitRequest:\n title: JsExecuteSubmissionAndWaitRequest\n type: object\n required:\n - deduplicationPeriod\n - submissionId\n - userId\n - hashingSchemeVersion\n properties:\n preparedTransaction:\n description: |-\n the prepared transaction\n Typically this is the value of the `prepared_transaction` field in `PrepareSubmissionResponse`\n obtained from calling `prepareSubmission`.\n Required\n type: string\n partySignatures:\n $ref: '#/components/schemas/PartySignatures'\n description: |-\n The party(ies) signatures that authorize the prepared submission to be executed by this node.\n Each party can provide one or more signatures..\n and one or more parties can sign.\n Note that currently, only single party submissions are supported.\n Required\n deduplicationPeriod:\n $ref: '#/components/schemas/DeduplicationPeriod2'\n submissionId:\n description: |-\n A unique identifier to distinguish completions for different submissions with the same change ID.\n Typically a random UUID. Applications are expected to use a different UUID for each retry of a submission\n with the same change ID.\n Must be a valid LedgerString (as described in ``value.proto``).\n\n Required\n type: string\n userId:\n description: |-\n See [PrepareSubmissionRequest.user_id]\n Optional\n type: string\n hashingSchemeVersion:\n description: |-\n The hashing scheme version used when building the hash\n Required\n type: string\n enum:\n - HASHING_SCHEME_VERSION_UNSPECIFIED\n - HASHING_SCHEME_VERSION_V2\n minLedgerTime:\n $ref: '#/components/schemas/MinLedgerTime'\n description: |-\n If set will influence the chosen ledger effective time but will not result in a submission delay so any override\n should be scheduled to executed within the window allowed by synchronizer.\n Optional\n JsExecuteSubmissionRequest:\n title: JsExecuteSubmissionRequest\n type: object\n required:\n - deduplicationPeriod\n - submissionId\n - userId\n - hashingSchemeVersion\n properties:\n preparedTransaction:\n description: |-\n the prepared transaction\n Typically this is the value of the `prepared_transaction` field in `PrepareSubmissionResponse`\n obtained from calling `prepareSubmission`.\n Required\n type: string\n partySignatures:\n $ref: '#/components/schemas/PartySignatures'\n description: |-\n The party(ies) signatures that authorize the prepared submission to be executed by this node.\n Each party can provide one or more signatures..\n and one or more parties can sign.\n Note that currently, only single party submissions are supported.\n Required\n deduplicationPeriod:\n $ref: '#/components/schemas/DeduplicationPeriod2'\n submissionId:\n description: |-\n A unique identifier to distinguish completions for different submissions with the same change ID.\n Typically a random UUID. Applications are expected to use a different UUID for each retry of a submission\n with the same change ID.\n Must be a valid LedgerString (as described in ``value.proto``).\n\n Required\n type: string\n userId:\n description: |-\n See [PrepareSubmissionRequest.user_id]\n Optional\n type: string\n hashingSchemeVersion:\n description: |-\n The hashing scheme version used when building the hash\n Required\n type: string\n enum:\n - HASHING_SCHEME_VERSION_UNSPECIFIED\n - HASHING_SCHEME_VERSION_V2\n minLedgerTime:\n $ref: '#/components/schemas/MinLedgerTime'\n description: |-\n If set will influence the chosen ledger effective time but will not result in a submission delay so any override\n should be scheduled to executed within the window allowed by synchronizer.\n Optional\n JsGetActiveContractsResponse:\n title: JsGetActiveContractsResponse\n type: object\n required:\n - workflowId\n - contractEntry\n properties:\n workflowId:\n description: |-\n The workflow ID used in command submission which corresponds to the contract_entry. Only set if\n the ``workflow_id`` for the command was set.\n Must be a valid LedgerString (as described in ``value.proto``).\n Optional\n type: string\n contractEntry:\n $ref: '#/components/schemas/JsContractEntry'\n JsGetEventsByContractIdResponse:\n title: JsGetEventsByContractIdResponse\n type: object\n properties:\n created:\n $ref: '#/components/schemas/JsCreated'\n description: |-\n The create event for the contract with the ``contract_id`` given in the request\n provided it exists and has not yet been pruned.\n Optional\n archived:\n $ref: '#/components/schemas/JsArchived'\n description: |-\n The archive event for the contract with the ``contract_id`` given in the request\n provided such an archive event exists and it has not yet been pruned.\n Optional\n JsGetTransactionResponse:\n title: JsGetTransactionResponse\n description: Provided for backwards compatibility, it will be removed in the\n Canton version 3.5.0.\n type: object\n required:\n - transaction\n properties:\n transaction:\n $ref: '#/components/schemas/JsTransaction'\n description: Required\n JsGetTransactionTreeResponse:\n title: JsGetTransactionTreeResponse\n description: Provided for backwards compatibility, it will be removed in the\n Canton version 3.5.0.\n type: object\n required:\n - transaction\n properties:\n transaction:\n $ref: '#/components/schemas/JsTransactionTree'\n description: Required\n JsGetUpdateResponse:\n title: JsGetUpdateResponse\n type: object\n required:\n - update\n properties:\n update:\n $ref: '#/components/schemas/Update'\n JsGetUpdateTreesResponse:\n title: JsGetUpdateTreesResponse\n description: Provided for backwards compatibility, it will be removed in the\n Canton version 3.5.0.\n type: object\n required:\n - update\n properties:\n update:\n $ref: '#/components/schemas/Update1'\n JsGetUpdatesResponse:\n title: JsGetUpdatesResponse\n type: object\n required:\n - update\n properties:\n update:\n $ref: '#/components/schemas/Update'\n JsIncompleteAssigned:\n title: JsIncompleteAssigned\n type: object\n required:\n - assignedEvent\n properties:\n assignedEvent:\n $ref: '#/components/schemas/JsAssignedEvent'\n description: Required\n JsIncompleteUnassigned:\n title: JsIncompleteUnassigned\n type: object\n required:\n - createdEvent\n - unassignedEvent\n properties:\n createdEvent:\n $ref: '#/components/schemas/CreatedEvent'\n description: |-\n Required\n The event as it appeared in the context of its last activation update (i.e. daml transaction or\n reassignment). In particular, the last activation offset, node_id pair is preserved.\n The last activation update is the most recent update created or assigned this contract on synchronizer_id synchronizer before\n the unassigned_event.\n The offset of the CreatedEvent might point to an already pruned update, therefore it cannot necessarily be used\n for lookups.\n unassignedEvent:\n $ref: '#/components/schemas/UnassignedEvent'\n description: Required\n JsInterfaceView:\n title: JsInterfaceView\n description: View of a create event matched by an interface filter.\n type: object\n required:\n - interfaceId\n - viewStatus\n properties:\n interfaceId:\n description: |-\n The interface implemented by the matched event.\n The identifier uses the package-id reference format.\n\n Required\n type: string\n viewStatus:\n $ref: '#/components/schemas/JsStatus'\n description: |-\n Whether the view was successfully computed, and if not,\n the reason for the error. The error is reported using the same rules\n for error codes and messages as the errors returned for API requests.\n Required\n viewValue:\n description: |-\n The value of the interface's view method on this event.\n Set if it was requested in the ``InterfaceFilter`` and it could be\n successfully computed.\n Optional\n JsPrepareSubmissionRequest:\n title: JsPrepareSubmissionRequest\n type: object\n required:\n - userId\n - commandId\n - synchronizerId\n - verboseHashing\n properties:\n userId:\n description: |-\n Uniquely identifies the participant user that prepares the transaction.\n Must be a valid UserIdString (as described in ``value.proto``).\n Required unless authentication is used with a user token.\n In that case, the token's user-id will be used for the request's user_id.\n Optional\n type: string\n commandId:\n description: |-\n Uniquely identifies the command.\n The triple (user_id, act_as, command_id) constitutes the change ID for the intended ledger change,\n where act_as is interpreted as a set of party names.\n The change ID can be used for matching the intended ledger changes with all their completions.\n Must be a valid LedgerString (as described in ``value.proto``).\n Required\n type: string\n commands:\n description: |-\n Individual elements of this atomic command. Must be non-empty.\n Limitation: Only single command transaction are currently supported by the API.\n The field is marked as repeated in preparation for future support of multiple commands.\n Required\n type: array\n items:\n $ref: '#/components/schemas/Command'\n minLedgerTime:\n $ref: '#/components/schemas/MinLedgerTime'\n description: Optional\n actAs:\n description: |-\n Set of parties on whose behalf the command should be executed, if submitted.\n If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request\n to **read** (not act) on behalf of each of the given parties. This is because this RPC merely prepares a transaction\n and does not execute it. Therefore read authorization is sufficient even for actAs parties.\n Note: This may change, and more specific authorization scope may be introduced in the future.\n Each element must be a valid PartyIdString (as described in ``value.proto``).\n Required, must be non-empty.\n type: array\n items:\n type: string\n readAs:\n description: |-\n Set of parties on whose behalf (in addition to all parties listed in ``act_as``) contracts can be retrieved.\n This affects Daml operations such as ``fetch``, ``fetchByKey``, ``lookupByKey``, ``exercise``, and ``exerciseByKey``.\n Note: A command can only use contracts that are visible to at least\n one of the parties in ``act_as`` or ``read_as``. This visibility check is independent from the Daml authorization\n rules for fetch operations.\n If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request\n to read contract data on behalf of each of the given parties.\n Optional\n type: array\n items:\n type: string\n disclosedContracts:\n description: |-\n Additional contracts used to resolve contract & contract key lookups.\n Optional\n type: array\n items:\n $ref: '#/components/schemas/DisclosedContract'\n synchronizerId:\n description: |-\n Must be a valid synchronizer id\n If not set, a suitable synchronizer that this node is connected to will be chosen\n Optional\n type: string\n packageIdSelectionPreference:\n description: |-\n The package-id selection preference of the client for resolving\n package names and interface instances in command submission and interpretation\n Optional\n type: array\n items:\n type: string\n verboseHashing:\n description: |-\n When true, the response will contain additional details on how the transaction was encoded and hashed\n This can be useful for troubleshooting of hash mismatches. Should only be used for debugging.\n Optional, default to false\n type: boolean\n prefetchContractKeys:\n description: |-\n Fetches the contract keys into the caches to speed up the command processing.\n Should only contain contract keys that are expected to be resolved during interpretation of the commands.\n Keys of disclosed contracts do not need prefetching.\n\n Optional\n type: array\n items:\n $ref: '#/components/schemas/PrefetchContractKey'\n maxRecordTime:\n description: |-\n Maximum timestamp at which the transaction can be recorded onto the ledger via the synchronizer specified in the `PrepareSubmissionResponse`.\n If submitted after it will be rejected even if otherwise valid, in which case it needs to be prepared and signed again\n with a new valid max_record_time.\n Use this to limit the time-to-life of a prepared transaction,\n which is useful to know when it can definitely not be accepted\n anymore and resorting to preparing another transaction for the same\n intent is safe again.\n Optional\n type: string\n estimateTrafficCost:\n $ref: '#/components/schemas/CostEstimationHints'\n description: |-\n Hints to improve the accuracy of traffic cost estimation.\n The estimation logic assumes that this node will be used for the execution of the transaction\n If another node is used instead, the estimation may be less precise.\n Request amplification is not accounted for in the estimation: each amplified request will\n result in the cost of the confirmation request to be charged additionally.\n\n Optional - Traffic cost estimation is enabled by default if this field is not set\n To turn off cost estimation, set the CostEstimationHints#disabled field to true\n JsPrepareSubmissionResponse:\n title: JsPrepareSubmissionResponse\n description: '[docs-entry-end: HashingSchemeVersion]'\n type: object\n required:\n - preparedTransactionHash\n - hashingSchemeVersion\n properties:\n preparedTransaction:\n description: |-\n The interpreted transaction, it represents the ledger changes necessary to execute the commands specified in the request.\n Clients MUST display the content of the transaction to the user for them to validate before signing the hash if the preparing participant is not trusted.\n type: string\n preparedTransactionHash:\n description: |-\n Hash of the transaction, this is what needs to be signed by the party to authorize the transaction.\n Only provided for convenience, clients MUST recompute the hash from the raw transaction if the preparing participant is not trusted.\n May be removed in future versions\n type: string\n hashingSchemeVersion:\n description: The hashing scheme version used when building the hash\n type: string\n enum:\n - HASHING_SCHEME_VERSION_UNSPECIFIED\n - HASHING_SCHEME_VERSION_V2\n hashingDetails:\n description: |-\n Optional additional details on how the transaction was encoded and hashed. Only set if verbose_hashing = true in the request\n Note that there are no guarantees on the stability of the format or content of this field.\n Its content should NOT be parsed and should only be used for troubleshooting purposes.\n type: string\n costEstimation:\n $ref: '#/components/schemas/CostEstimation'\n description: |-\n Traffic cost estimation of the prepared transaction\n Optional\n JsReassignment:\n title: JsReassignment\n description: Complete view of an on-ledger reassignment.\n type: object\n required:\n - updateId\n - commandId\n - workflowId\n - offset\n - recordTime\n - synchronizerId\n properties:\n updateId:\n description: |-\n Assigned by the server. Useful for correlating logs.\n Must be a valid LedgerString (as described in ``value.proto``).\n Required\n type: string\n commandId:\n description: |-\n The ID of the command which resulted in this reassignment. Missing for everyone except the submitting party on the submitting participant.\n Must be a valid LedgerString (as described in ``value.proto``).\n Optional\n type: string\n workflowId:\n description: |-\n The workflow ID used in reassignment command submission. Only set if the ``workflow_id`` for the command was set.\n Must be a valid LedgerString (as described in ``value.proto``).\n Optional\n type: string\n offset:\n description: |-\n The participant's offset. The details of this field are described in ``community/ledger-api/README.md``.\n Required, must be a valid absolute offset (positive integer).\n type: integer\n format: int64\n events:\n description: The collection of reassignment events. Required.\n type: array\n items:\n $ref: '#/components/schemas/JsReassignmentEvent'\n traceContext:\n $ref: '#/components/schemas/TraceContext'\n description: |-\n Optional; ledger API trace context\n\n The trace context transported in this message corresponds to the trace context supplied\n by the client application in a HTTP2 header of the original command submission.\n We typically use a header to transfer this type of information. Here we use message\n body, because it is used in gRPC streams which do not support per message headers.\n This field will be populated with the trace context contained in the original submission.\n If that was not provided, a unique ledger-api-server generated trace context will be used\n instead.\n recordTime:\n description: |-\n The time at which the reassignment was recorded. The record time refers to the source/target\n synchronizer for an unassign/assign event respectively.\n Required\n type: string\n synchronizerId:\n description: |-\n A valid synchronizer id.\n Identifies the synchronizer that synchronized this Reassignment.\n Required\n type: string\n JsReassignmentEvent:\n title: JsReassignmentEvent\n oneOf:\n - type: object\n required:\n - JsAssignmentEvent\n properties:\n JsAssignmentEvent:\n $ref: '#/components/schemas/JsAssignmentEvent'\n - type: object\n required:\n - JsUnassignedEvent\n properties:\n JsUnassignedEvent:\n $ref: '#/components/schemas/JsUnassignedEvent'\n JsStatus:\n title: JsStatus\n type: object\n required:\n - code\n - message\n properties:\n code:\n type: integer\n format: int32\n message:\n type: string\n details:\n type: array\n items:\n $ref: '#/components/schemas/ProtoAny'\n JsSubmitAndWaitForReassignmentResponse:\n title: JsSubmitAndWaitForReassignmentResponse\n type: object\n required:\n - reassignment\n properties:\n reassignment:\n $ref: '#/components/schemas/JsReassignment'\n description: |-\n The reassignment that resulted from the submitted reassignment command.\n The reassignment might contain no events (request conditions result in filtering out all of them).\n Required\n JsSubmitAndWaitForTransactionRequest:\n title: JsSubmitAndWaitForTransactionRequest\n description: These commands are executed as a single atomic transaction.\n type: object\n required:\n - commands\n properties:\n commands:\n $ref: '#/components/schemas/JsCommands'\n description: |-\n The commands to be submitted.\n Required\n transactionFormat:\n $ref: '#/components/schemas/TransactionFormat'\n description: |-\n If no ``transaction_format`` is provided, a default will be used where ``transaction_shape`` is set to\n TRANSACTION_SHAPE_ACS_DELTA, ``event_format`` is defined with ``filters_by_party`` containing wildcard-template\n filter for all original ``act_as`` and ``read_as`` parties and the ``verbose`` flag is set.\n Optional\n JsSubmitAndWaitForTransactionResponse:\n title: JsSubmitAndWaitForTransactionResponse\n type: object\n required:\n - transaction\n properties:\n transaction:\n $ref: '#/components/schemas/JsTransaction'\n description: |-\n The transaction that resulted from the submitted command.\n The transaction might contain no events (request conditions result in filtering out all of them).\n Required\n JsSubmitAndWaitForTransactionTreeResponse:\n title: JsSubmitAndWaitForTransactionTreeResponse\n description: Provided for backwards compatibility, it will be removed in the\n Canton version 3.5.0.\n type: object\n required:\n - transactionTree\n properties:\n transactionTree:\n $ref: '#/components/schemas/JsTransactionTree'\n JsTopologyTransaction:\n title: JsTopologyTransaction\n type: object\n required:\n - updateId\n - offset\n - synchronizerId\n properties:\n updateId:\n description: |-\n Assigned by the server. Useful for correlating logs.\n Must be a valid LedgerString (as described in ``value.proto``).\n Required\n type: string\n offset:\n description: |-\n The absolute offset. The details of this field are described in ``community/ledger-api/README.md``.\n Required, it is a valid absolute offset (positive integer).\n type: integer\n format: int64\n synchronizerId:\n description: |-\n A valid synchronizer id.\n Identifies the synchronizer that synchronized the topology transaction.\n Required\n type: string\n recordTime:\n description: |-\n The time at which the changes in the topology transaction become effective. There is a small delay between a\n topology transaction being sequenced and the changes it contains becoming effective. Topology transactions appear\n in order relative to a synchronizer based on their effective time rather than their sequencing time.\n Required\n type: string\n events:\n description: |-\n A non-empty list of topology events.\n Required\n type: array\n items:\n $ref: '#/components/schemas/TopologyEvent'\n traceContext:\n $ref: '#/components/schemas/TraceContext'\n description: |-\n Optional; ledger API trace context\n\n The trace context transported in this message corresponds to the trace context supplied\n by the client application in a HTTP2 header of the original command submission.\n We typically use a header to transfer this type of information. Here we use message\n body, because it is used in gRPC streams which do not support per message headers.\n This field will be populated with the trace context contained in the original submission.\n If that was not provided, a unique ledger-api-server generated trace context will be used\n instead.\n JsTransaction:\n title: JsTransaction\n description: Filtered view of an on-ledger transaction's create and archive\n events.\n type: object\n required:\n - updateId\n - commandId\n - workflowId\n - effectiveAt\n - offset\n - synchronizerId\n - recordTime\n properties:\n updateId:\n description: |-\n Assigned by the server. Useful for correlating logs.\n Must be a valid LedgerString (as described in ``value.proto``).\n Required\n type: string\n commandId:\n description: |-\n The ID of the command which resulted in this transaction. Missing for everyone except the submitting party.\n Must be a valid LedgerString (as described in ``value.proto``).\n Optional\n type: string\n workflowId:\n description: |-\n The workflow ID used in command submission.\n Must be a valid LedgerString (as described in ``value.proto``).\n Optional\n type: string\n effectiveAt:\n description: |-\n Ledger effective time.\n Required\n type: string\n events:\n description: |-\n The collection of events.\n Contains:\n\n - ``CreatedEvent`` or ``ArchivedEvent`` in case of ACS_DELTA transaction shape\n - ``CreatedEvent`` or ``ExercisedEvent`` in case of LEDGER_EFFECTS transaction shape\n\n Required\n type: array\n items:\n $ref: '#/components/schemas/Event'\n offset:\n description: |-\n The absolute offset. The details of this field are described in ``community/ledger-api/README.md``.\n Required, it is a valid absolute offset (positive integer).\n type: integer\n format: int64\n synchronizerId:\n description: |-\n A valid synchronizer id.\n Identifies the synchronizer that synchronized the transaction.\n Required\n type: string\n traceContext:\n $ref: '#/components/schemas/TraceContext'\n description: |-\n Optional; ledger API trace context\n\n The trace context transported in this message corresponds to the trace context supplied\n by the client application in a HTTP2 header of the original command submission.\n We typically use a header to transfer this type of information. Here we use message\n body, because it is used in gRPC streams which do not support per message headers.\n This field will be populated with the trace context contained in the original submission.\n If that was not provided, a unique ledger-api-server generated trace context will be used\n instead.\n recordTime:\n description: |-\n The time at which the transaction was recorded. The record time refers to the synchronizer\n which synchronized the transaction.\n Required\n type: string\n externalTransactionHash:\n description: |-\n For transaction externally signed, contains the external transaction hash\n signed by the external party. Can be used to correlate an external submission with a committed transaction.\n Optional\n type: string\n JsTransactionTree:\n title: JsTransactionTree\n description: |-\n Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.\n Complete view of an on-ledger transaction.\n type: object\n required:\n - updateId\n - commandId\n - workflowId\n - offset\n - eventsById\n - synchronizerId\n - recordTime\n properties:\n updateId:\n description: |-\n Assigned by the server. Useful for correlating logs.\n Must be a valid LedgerString (as described in ``value.proto``).\n Required\n type: string\n commandId:\n description: |-\n The ID of the command which resulted in this transaction. Missing for everyone except the submitting party.\n Must be a valid LedgerString (as described in ``value.proto``).\n Optional\n type: string\n workflowId:\n description: |-\n The workflow ID used in command submission. Only set if the ``workflow_id`` for the command was set.\n Must be a valid LedgerString (as described in ``value.proto``).\n Optional\n type: string\n effectiveAt:\n description: |-\n Ledger effective time.\n Required\n type: string\n offset:\n description: |-\n The absolute offset. The details of this field are described in ``community/ledger-api/README.md``.\n Required, it is a valid absolute offset (positive integer).\n type: integer\n format: int64\n eventsById:\n $ref: '#/components/schemas/Map_Int_TreeEvent'\n description: |-\n Changes to the ledger that were caused by this transaction. Nodes of the transaction tree.\n Each key must be a valid node ID (non-negative integer).\n Required\n synchronizerId:\n description: |-\n A valid synchronizer id.\n Identifies the synchronizer that synchronized the transaction.\n Required\n type: string\n traceContext:\n $ref: '#/components/schemas/TraceContext'\n description: |-\n Optional; ledger API trace context\n\n The trace context transported in this message corresponds to the trace context supplied\n by the client application in a HTTP2 header of the original command submission.\n We typically use a header to transfer this type of information. Here we use message\n body, because it is used in gRPC streams which do not support per message headers.\n This field will be populated with the trace context contained in the original submission.\n If that was not provided, a unique ledger-api-server generated trace context will be used\n instead.\n recordTime:\n description: |-\n The time at which the transaction was recorded. The record time refers to the synchronizer\n which synchronized the transaction.\n Required\n type: string\n JsUnassignedEvent:\n title: JsUnassignedEvent\n description: Records that a contract has been unassigned, and it becomes unusable\n on the source synchronizer\n type: object\n required:\n - value\n properties:\n value:\n $ref: '#/components/schemas/UnassignedEvent'\n Kind:\n title: Kind\n description: Required\n oneOf:\n - type: object\n required:\n - CanActAs\n properties:\n CanActAs:\n $ref: '#/components/schemas/CanActAs'\n - type: object\n required:\n - CanExecuteAs\n properties:\n CanExecuteAs:\n $ref: '#/components/schemas/CanExecuteAs'\n - type: object\n required:\n - CanExecuteAsAnyParty\n properties:\n CanExecuteAsAnyParty:\n $ref: '#/components/schemas/CanExecuteAsAnyParty'\n - type: object\n required:\n - CanReadAs\n properties:\n CanReadAs:\n $ref: '#/components/schemas/CanReadAs'\n - type: object\n required:\n - CanReadAsAnyParty\n properties:\n CanReadAsAnyParty:\n $ref: '#/components/schemas/CanReadAsAnyParty'\n - type: object\n required:\n - Empty\n properties:\n Empty:\n $ref: '#/components/schemas/Empty8'\n - type: object\n required:\n - IdentityProviderAdmin\n properties:\n IdentityProviderAdmin:\n $ref: '#/components/schemas/IdentityProviderAdmin'\n - type: object\n required:\n - ParticipantAdmin\n properties:\n ParticipantAdmin:\n $ref: '#/components/schemas/ParticipantAdmin'\n ListIdentityProviderConfigsResponse:\n title: ListIdentityProviderConfigsResponse\n type: object\n properties:\n identityProviderConfigs:\n description: ''\n type: array\n items:\n $ref: '#/components/schemas/IdentityProviderConfig'\n ListKnownPartiesResponse:\n title: ListKnownPartiesResponse\n type: object\n required:\n - nextPageToken\n properties:\n partyDetails:\n description: |-\n The details of all Daml parties known by the participant.\n Required\n type: array\n items:\n $ref: '#/components/schemas/PartyDetails'\n nextPageToken:\n description: |-\n Pagination token to retrieve the next page.\n Empty, if there are no further results.\n type: string\n ListPackagesResponse:\n title: ListPackagesResponse\n type: object\n properties:\n packageIds:\n description: |-\n The IDs of all Daml-LF packages supported by the server.\n Each element must be a valid PackageIdString (as described in ``value.proto``).\n Required\n type: array\n items:\n type: string\n ListUserRightsResponse:\n title: ListUserRightsResponse\n type: object\n properties:\n rights:\n description: All rights of the user.\n type: array\n items:\n $ref: '#/components/schemas/Right'\n ListUsersResponse:\n title: ListUsersResponse\n type: object\n required:\n - nextPageToken\n properties:\n users:\n description: A subset of users of the participant node that fit into this\n page.\n type: array\n items:\n $ref: '#/components/schemas/User'\n nextPageToken:\n description: |-\n Pagination token to retrieve the next page.\n Empty, if there are no further results.\n type: string\n ListVettedPackagesRequest:\n title: ListVettedPackagesRequest\n type: object\n required:\n - pageToken\n - pageSize\n properties:\n packageMetadataFilter:\n $ref: '#/components/schemas/PackageMetadataFilter'\n description: |-\n The package metadata filter the returned vetted packages set must satisfy.\n Optional\n topologyStateFilter:\n $ref: '#/components/schemas/TopologyStateFilter'\n description: |-\n The topology filter the returned vetted packages set must satisfy.\n Optional\n pageToken:\n description: |-\n Pagination token to determine the specific page to fetch. Using the token\n guarantees that ``VettedPackages`` on a subsequent page are all greater\n (``VettedPackages`` are sorted by synchronizer ID then participant ID) than\n the last ``VettedPackages`` on a previous page.\n\n The server does not store intermediate results between calls chained by a\n series of page tokens. As a consequence, if new vetted packages are being\n added and a page is requested twice using the same token, more packages can\n be returned on the second call.\n\n Leave unspecified (i.e. as empty string) to fetch the first page.\n\n Optional\n type: string\n pageSize:\n description: |-\n Maximum number of ``VettedPackages`` results to return in a single page.\n\n If the page_size is unspecified (i.e. left as 0), the server will decide\n the number of results to be returned.\n\n If the page_size exceeds the maximum supported by the server, an\n error will be returned.\n\n To obtain the server's maximum consult the PackageService descriptor\n available in the VersionService.\n\n Optional\n type: integer\n format: int32\n ListVettedPackagesResponse:\n title: ListVettedPackagesResponse\n type: object\n required:\n - nextPageToken\n properties:\n vettedPackages:\n description: |-\n All ``VettedPackages`` that contain at least one ``VettedPackage`` matching\n both a ``PackageMetadataFilter`` and a ``TopologyStateFilter``.\n Sorted by synchronizer_id then participant_id.\n type: array\n items:\n $ref: '#/components/schemas/VettedPackages'\n nextPageToken:\n description: |-\n Pagination token to retrieve the next page.\n Empty string if there are no further results.\n type: string\n Map_Filters:\n title: Map_Filters\n type: object\n additionalProperties:\n $ref: '#/components/schemas/Filters'\n Map_Int_Field:\n title: Map_Int_Field\n type: object\n additionalProperties:\n $ref: '#/components/schemas/Field'\n Map_Int_TreeEvent:\n title: Map_Int_TreeEvent\n type: object\n additionalProperties:\n $ref: '#/components/schemas/TreeEvent'\n Map_String:\n title: Map_String\n type: object\n additionalProperties:\n type: string\n MinLedgerTime:\n title: MinLedgerTime\n type: object\n required:\n - time\n properties:\n time:\n $ref: '#/components/schemas/Time'\n MinLedgerTimeAbs:\n title: MinLedgerTimeAbs\n type: object\n required:\n - value\n properties:\n value:\n type: string\n MinLedgerTimeRel:\n title: MinLedgerTimeRel\n type: object\n required:\n - value\n properties:\n value:\n $ref: '#/components/schemas/Duration'\n NoPrior:\n title: NoPrior\n type: object\n ObjectMeta:\n title: ObjectMeta\n description: |-\n Represents metadata corresponding to a participant resource (e.g. a participant user or participant local information about a party).\n\n Based on ``ObjectMeta`` meta used in Kubernetes API.\n See https://github.com/kubernetes/apimachinery/blob/master/pkg/apis/meta/v1/generated.proto#L640\n type: object\n required:\n - resourceVersion\n - annotations\n properties:\n resourceVersion:\n description: |-\n An opaque, non-empty value, populated by a participant server which represents the internal version of the resource\n this ``ObjectMeta`` message is attached to. The participant server will change it to a unique value each time the corresponding resource is updated.\n You must not rely on the format of resource version. The participant server might change it without notice.\n You can obtain the newest resource version value by issuing a read request.\n You may use it for concurrent change detection by passing it back unmodified in an update request.\n The participant server will then compare the passed value with the value maintained by the system to determine\n if any other updates took place since you had read the resource version.\n Upon a successful update you are guaranteed that no other update took place during your read-modify-write sequence.\n However, if another update took place during your read-modify-write sequence then your update will fail with an appropriate error.\n Concurrent change control is optional. It will be applied only if you include a resource version in an update request.\n When creating a new instance of a resource you must leave the resource version empty.\n Its value will be populated by the participant server upon successful resource creation.\n Optional\n type: string\n annotations:\n $ref: '#/components/schemas/Map_String'\n description: |-\n A set of modifiable key-value pairs that can be used to represent arbitrary, client-specific metadata.\n Constraints:\n\n 1. The total size over all keys and values cannot exceed 256kb in UTF-8 encoding.\n 2. Keys are composed of an optional prefix segment and a required name segment such that:\n\n - key prefix, when present, must be a valid DNS subdomain with at most 253 characters, followed by a '/' (forward slash) character,\n - name segment must have at most 63 characters that are either alphanumeric ([a-z0-9A-Z]), or a '.' (dot), '-' (dash) or '_' (underscore);\n and it must start and end with an alphanumeric character.\n\n 3. Values can be any non-empty strings.\n\n Keys with empty prefix are reserved for end-users.\n Properties set by external tools or internally by the participant server must use non-empty key prefixes.\n Duplicate keys are disallowed by the semantics of the protobuf3 maps.\n See: https://developers.google.com/protocol-buffers/docs/proto3#maps\n Annotations may be a part of a modifiable resource.\n Use the resource's update RPC to update its annotations.\n In order to add a new annotation or update an existing one using an update RPC, provide the desired annotation in the update request.\n In order to remove an annotation using an update RPC, provide the target annotation's key but set its value to the empty string in the update request.\n Optional\n Modifiable\n OffsetCheckpoint:\n title: OffsetCheckpoint\n description: |-\n OffsetCheckpoints may be used to:\n\n - detect time out of commands.\n - provide an offset which can be used to restart consumption.\n type: object\n required:\n - value\n properties:\n value:\n $ref: '#/components/schemas/OffsetCheckpoint1'\n OffsetCheckpoint1:\n title: OffsetCheckpoint\n description: |-\n OffsetCheckpoints may be used to:\n\n - detect time out of commands.\n - provide an offset which can be used to restart consumption.\n type: object\n required:\n - offset\n properties:\n offset:\n description: |-\n The participant's offset, the details of the offset field are described in ``community/ledger-api/README.md``.\n Required, must be a valid absolute offset (positive integer).\n type: integer\n format: int64\n synchronizerTimes:\n description: ''\n type: array\n items:\n $ref: '#/components/schemas/SynchronizerTime'\n OffsetCheckpoint2:\n title: OffsetCheckpoint\n description: |-\n OffsetCheckpoints may be used to:\n\n - detect time out of commands.\n - provide an offset which can be used to restart consumption.\n type: object\n required:\n - value\n properties:\n value:\n $ref: '#/components/schemas/OffsetCheckpoint1'\n OffsetCheckpoint3:\n title: OffsetCheckpoint\n description: |-\n OffsetCheckpoints may be used to:\n\n - detect time out of commands.\n - provide an offset which can be used to restart consumption.\n type: object\n required:\n - value\n properties:\n value:\n $ref: '#/components/schemas/OffsetCheckpoint1'\n OffsetCheckpointFeature:\n title: OffsetCheckpointFeature\n type: object\n properties:\n maxOffsetCheckpointEmissionDelay:\n $ref: '#/components/schemas/Duration'\n description: The maximum delay to emmit a new OffsetCheckpoint if it exists\n Operation:\n title: Operation\n oneOf:\n - type: object\n required:\n - Empty\n properties:\n Empty:\n $ref: '#/components/schemas/Empty5'\n - type: object\n required:\n - Unvet\n properties:\n Unvet:\n $ref: '#/components/schemas/Unvet'\n - type: object\n required:\n - Vet\n properties:\n Vet:\n $ref: '#/components/schemas/Vet'\n PackageFeature:\n title: PackageFeature\n type: object\n required:\n - maxVettedPackagesPageSize\n properties:\n maxVettedPackagesPageSize:\n description: |-\n The maximum number of vetted packages the server can return in a single\n response (page) when listing them.\n type: integer\n format: int32\n PackageMetadataFilter:\n title: PackageMetadataFilter\n description: |-\n Filter the VettedPackages by package metadata.\n\n A PackageMetadataFilter without package_ids and without package_name_prefixes\n matches any vetted package.\n\n Non-empty fields specify candidate values of which at least one must match.\n If both fields are set, then a candidate is returned if it matches one of the fields.\n type: object\n properties:\n packageIds:\n description: |-\n If this list is non-empty, any vetted package with a package ID in this\n list will match the filter.\n type: array\n items:\n type: string\n packageNamePrefixes:\n description: |-\n If this list is non-empty, any vetted package with a name matching at least\n one prefix in this list will match the filter.\n type: array\n items:\n type: string\n PackagePreference:\n title: PackagePreference\n type: object\n required:\n - synchronizerId\n properties:\n packageReference:\n $ref: '#/components/schemas/PackageReference'\n description: |-\n The package reference of the preferred package.\n Required\n synchronizerId:\n description: |-\n The synchronizer for which the preferred package was computed.\n If the synchronizer_id was specified in the request, then it matches the request synchronizer_id.\n Required\n type: string\n PackageReference:\n title: PackageReference\n type: object\n required:\n - packageId\n - packageName\n - packageVersion\n properties:\n packageId:\n description: Required\n type: string\n packageName:\n description: Required\n type: string\n packageVersion:\n description: Required\n type: string\n PackageVettingRequirement:\n title: PackageVettingRequirement\n description: Defines a package-name for which the commonly vetted package with\n the highest version must be found.\n type: object\n required:\n - packageName\n properties:\n parties:\n description: |-\n The parties whose participants' vetting state should be considered when resolving the preferred package.\n Required\n type: array\n items:\n type: string\n packageName:\n description: |-\n The package-name for which the preferred package should be resolved.\n Required\n type: string\n ParticipantAdmin:\n title: ParticipantAdmin\n type: object\n required:\n - value\n properties:\n value:\n $ref: '#/components/schemas/ParticipantAdmin1'\n ParticipantAdmin1:\n title: ParticipantAdmin\n type: object\n ParticipantAuthorizationAdded:\n title: ParticipantAuthorizationAdded\n type: object\n required:\n - value\n properties:\n value:\n $ref: '#/components/schemas/ParticipantAuthorizationAdded1'\n ParticipantAuthorizationAdded1:\n title: ParticipantAuthorizationAdded\n type: object\n required:\n - partyId\n - participantId\n - participantPermission\n properties:\n partyId:\n description: Required\n type: string\n participantId:\n description: Required\n type: string\n participantPermission:\n description: Required\n type: string\n enum:\n - PARTICIPANT_PERMISSION_UNSPECIFIED\n - PARTICIPANT_PERMISSION_SUBMISSION\n - PARTICIPANT_PERMISSION_CONFIRMATION\n - PARTICIPANT_PERMISSION_OBSERVATION\n ParticipantAuthorizationChanged:\n title: ParticipantAuthorizationChanged\n type: object\n required:\n - value\n properties:\n value:\n $ref: '#/components/schemas/ParticipantAuthorizationChanged1'\n ParticipantAuthorizationChanged1:\n title: ParticipantAuthorizationChanged\n type: object\n required:\n - partyId\n - participantId\n - participantPermission\n properties:\n partyId:\n description: Required\n type: string\n participantId:\n description: Required\n type: string\n participantPermission:\n description: Required\n type: string\n enum:\n - PARTICIPANT_PERMISSION_UNSPECIFIED\n - PARTICIPANT_PERMISSION_SUBMISSION\n - PARTICIPANT_PERMISSION_CONFIRMATION\n - PARTICIPANT_PERMISSION_OBSERVATION\n ParticipantAuthorizationRevoked:\n title: ParticipantAuthorizationRevoked\n type: object\n required:\n - value\n properties:\n value:\n $ref: '#/components/schemas/ParticipantAuthorizationRevoked1'\n ParticipantAuthorizationRevoked1:\n title: ParticipantAuthorizationRevoked\n type: object\n required:\n - partyId\n - participantId\n properties:\n partyId:\n description: Required\n type: string\n participantId:\n description: Required\n type: string\n ParticipantAuthorizationTopologyFormat:\n title: ParticipantAuthorizationTopologyFormat\n description: A format specifying which participant authorization topology transactions\n to include and how to render them.\n type: object\n properties:\n parties:\n description: |-\n List of parties for which the topology transactions should be sent.\n Empty means: for all parties.\n type: array\n items:\n type: string\n PartyDetails:\n title: PartyDetails\n type: object\n required:\n - party\n - isLocal\n - identityProviderId\n properties:\n party:\n description: |-\n The stable unique identifier of a Daml party.\n Must be a valid PartyIdString (as described in ``value.proto``).\n Required\n type: string\n isLocal:\n description: |-\n true if party is hosted by the participant and the party shares the same identity provider as the user issuing the request.\n Optional\n type: boolean\n localMetadata:\n $ref: '#/components/schemas/ObjectMeta'\n description: |-\n Participant-local metadata of this party.\n Optional,\n Modifiable\n identityProviderId:\n description: |-\n The id of the ``Identity Provider``\n Optional, if not set, there could be 3 options:\n\n 1. the party is managed by the default identity provider.\n 2. party is not hosted by the participant.\n 3. party is hosted by the participant, but is outside of the user's identity provider.\n type: string\n PartyManagementFeature:\n title: PartyManagementFeature\n type: object\n required:\n - maxPartiesPageSize\n properties:\n maxPartiesPageSize:\n description: The maximum number of parties the server can return in a single\n response (page).\n type: integer\n format: int32\n PartySignatures:\n title: PartySignatures\n description: Additional signatures provided by the submitting parties\n type: object\n properties:\n signatures:\n description: |-\n Additional signatures provided by all individual parties\n Required\n type: array\n items:\n $ref: '#/components/schemas/SinglePartySignatures'\n PrefetchContractKey:\n title: PrefetchContractKey\n description: Preload contracts\n type: object\n required:\n - contractKey\n properties:\n templateId:\n description: |-\n The template of contract the client wants to prefetch.\n Both package-name and package-id reference identifier formats for the template-id are supported.\n Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4.\n\n Required\n type: string\n contractKey:\n description: |-\n The key of the contract the client wants to prefetch.\n Required\n Prior:\n title: Prior\n type: object\n required:\n - value\n properties:\n value:\n type: integer\n format: int32\n PriorTopologySerial:\n title: PriorTopologySerial\n description: |-\n The serial of last ``VettedPackages`` topology transaction on a given\n participant and synchronizer.\n type: object\n required:\n - serial\n properties:\n serial:\n $ref: '#/components/schemas/Serial'\n ProtoAny:\n title: ProtoAny\n type: object\n required:\n - typeUrl\n - value\n - unknownFields\n properties:\n typeUrl:\n type: string\n value:\n type: string\n unknownFields:\n $ref: '#/components/schemas/UnknownFieldSet'\n valueDecoded:\n type: string\n Reassignment:\n title: Reassignment\n description: Complete view of an on-ledger reassignment.\n type: object\n required:\n - value\n properties:\n value:\n $ref: '#/components/schemas/JsReassignment'\n Reassignment1:\n title: Reassignment\n description: Complete view of an on-ledger reassignment.\n type: object\n required:\n - value\n properties:\n value:\n $ref: '#/components/schemas/JsReassignment'\n ReassignmentCommand:\n title: ReassignmentCommand\n type: object\n required:\n - command\n properties:\n command:\n $ref: '#/components/schemas/Command1'\n ReassignmentCommands:\n title: ReassignmentCommands\n type: object\n required:\n - workflowId\n - userId\n - commandId\n - submitter\n - submissionId\n properties:\n workflowId:\n description: |-\n Identifier of the on-ledger workflow that this command is a part of.\n Must be a valid LedgerString (as described in ``value.proto``).\n Optional\n type: string\n userId:\n description: |-\n Uniquely identifies the participant user that issued the command.\n Must be a valid UserIdString (as described in ``value.proto``).\n Required unless authentication is used with a user token.\n In that case, the token's user-id will be used for the request's user_id.\n type: string\n commandId:\n description: |-\n Uniquely identifies the command.\n The triple (user_id, submitter, command_id) constitutes the change ID for the intended ledger change.\n The change ID can be used for matching the intended ledger changes with all their completions.\n Must be a valid LedgerString (as described in ``value.proto``).\n Required\n type: string\n submitter:\n description: |-\n Party on whose behalf the command should be executed.\n If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request\n to act on behalf of the given party.\n Must be a valid PartyIdString (as described in ``value.proto``).\n Required\n type: string\n submissionId:\n description: |-\n A unique identifier to distinguish completions for different submissions with the same change ID.\n Typically a random UUID. Applications are expected to use a different UUID for each retry of a submission\n with the same change ID.\n Must be a valid LedgerString (as described in ``value.proto``).\n\n If omitted, the participant or the committer may set a value of their choice.\n Optional\n type: string\n commands:\n description: Individual elements of this reassignment. Must be non-empty.\n type: array\n items:\n $ref: '#/components/schemas/ReassignmentCommand'\n RevokeUserRightsRequest:\n title: RevokeUserRightsRequest\n description: |-\n Remove the rights from the set of rights granted to the user.\n\n Required authorization: ``HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(identity_provider_id)``\n type: object\n required:\n - userId\n - identityProviderId\n properties:\n userId:\n description: |-\n The user from whom to revoke rights.\n Required\n type: string\n rights:\n description: |-\n The rights to revoke.\n Optional\n type: array\n items:\n $ref: '#/components/schemas/Right'\n identityProviderId:\n description: |-\n The id of the ``Identity Provider``\n Optional, if not set, assume the user is managed by the default identity provider.\n type: string\n RevokeUserRightsResponse:\n title: RevokeUserRightsResponse\n type: object\n properties:\n newlyRevokedRights:\n description: The rights that were actually revoked by the request.\n type: array\n items:\n $ref: '#/components/schemas/Right'\n Right:\n title: Right\n description: A right granted to a user.\n type: object\n required:\n - kind\n properties:\n kind:\n $ref: '#/components/schemas/Kind'\n Serial:\n title: Serial\n oneOf:\n - type: object\n required:\n - Empty\n properties:\n Empty:\n $ref: '#/components/schemas/Empty6'\n - type: object\n required:\n - NoPrior\n properties:\n NoPrior:\n $ref: '#/components/schemas/NoPrior'\n - type: object\n required:\n - Prior\n properties:\n Prior:\n $ref: '#/components/schemas/Prior'\n Signature:\n title: Signature\n type: object\n required:\n - format\n - signature\n - signedBy\n - signingAlgorithmSpec\n properties:\n format:\n description: ''\n type: string\n signature:\n description: ''\n type: string\n signedBy:\n description: The fingerprint/id of the keypair used to create this signature\n and needed to verify.\n type: string\n signingAlgorithmSpec:\n description: The signing algorithm specification used to produce this signature\n type: string\n SignedTransaction:\n title: SignedTransaction\n type: object\n required:\n - transaction\n properties:\n transaction:\n type: string\n signatures:\n type: array\n items:\n $ref: '#/components/schemas/Signature'\n SigningPublicKey:\n title: SigningPublicKey\n type: object\n required:\n - format\n - keyData\n - keySpec\n properties:\n format:\n description: The serialization format of the public key\n example: CRYPTO_KEY_FORMAT_DER_X509_SUBJECT_PUBLIC_KEY_INFO\n type: string\n keyData:\n description: Serialized public key in the format specified above\n type: string\n keySpec:\n description: The key specification\n example: SIGNING_KEY_SPEC_EC_CURVE25519\n type: string\n SinglePartySignatures:\n title: SinglePartySignatures\n description: Signatures provided by a single party\n type: object\n required:\n - party\n properties:\n party:\n description: |-\n Submitting party\n Required\n type: string\n signatures:\n description: |-\n Signatures\n Required\n type: array\n items:\n $ref: '#/components/schemas/Signature'\n SubmitAndWaitForReassignmentRequest:\n title: SubmitAndWaitForReassignmentRequest\n description: This reassignment is executed as a single atomic update.\n type: object\n properties:\n reassignmentCommands:\n $ref: '#/components/schemas/ReassignmentCommands'\n description: |-\n The reassignment commands to be submitted.\n Required\n eventFormat:\n $ref: '#/components/schemas/EventFormat'\n description: |-\n Optional\n If no event_format provided, the result will contain no events.\n The events in the result, will take shape TRANSACTION_SHAPE_ACS_DELTA.\n SubmitAndWaitResponse:\n title: SubmitAndWaitResponse\n type: object\n required:\n - updateId\n - completionOffset\n properties:\n updateId:\n description: |-\n The id of the transaction that resulted from the submitted command.\n Must be a valid LedgerString (as described in ``value.proto``).\n Required\n type: string\n completionOffset:\n description: |-\n The details of the offset field are described in ``community/ledger-api/README.md``.\n Required\n type: integer\n format: int64\n SubmitReassignmentRequest:\n title: SubmitReassignmentRequest\n type: object\n properties:\n reassignmentCommands:\n $ref: '#/components/schemas/ReassignmentCommands'\n description: |-\n The reassignment command to be submitted.\n Required\n SubmitReassignmentResponse:\n title: SubmitReassignmentResponse\n type: object\n SubmitResponse:\n title: SubmitResponse\n type: object\n SynchronizerTime:\n title: SynchronizerTime\n type: object\n required:\n - synchronizerId\n properties:\n synchronizerId:\n description: |-\n The id of the synchronizer.\n Required\n type: string\n recordTime:\n description: |-\n All commands with a maximum record time below this value MUST be considered lost if their completion has not arrived before this checkpoint.\n Required\n type: string\n TemplateFilter:\n title: TemplateFilter\n description: This filter matches contracts of a specific template.\n type: object\n required:\n - value\n properties:\n value:\n $ref: '#/components/schemas/TemplateFilter1'\n TemplateFilter1:\n title: TemplateFilter\n description: This filter matches contracts of a specific template.\n type: object\n required:\n - includeCreatedEventBlob\n properties:\n templateId:\n description: |-\n A template for which the payload should be included in the response.\n The ``template_id`` needs to be valid: corresponding template should be defined in\n one of the available packages at the time of the query.\n Both package-name and package-id reference formats for the identifier are supported.\n Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4.\n\n Required\n type: string\n includeCreatedEventBlob:\n description: |-\n Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``.\n Use this to access the contract event payload in your API client\n for submitting it as a disclosed contract with future commands.\n Optional\n type: boolean\n Time:\n title: Time\n oneOf:\n - type: object\n required:\n - Empty\n properties:\n Empty:\n $ref: '#/components/schemas/Empty9'\n - type: object\n required:\n - MinLedgerTimeAbs\n properties:\n MinLedgerTimeAbs:\n $ref: '#/components/schemas/MinLedgerTimeAbs'\n - type: object\n required:\n - MinLedgerTimeRel\n properties:\n MinLedgerTimeRel:\n $ref: '#/components/schemas/MinLedgerTimeRel'\n TopologyEvent:\n title: TopologyEvent\n type: object\n required:\n - event\n properties:\n event:\n $ref: '#/components/schemas/TopologyEventEvent'\n TopologyEventEvent:\n title: TopologyEventEvent\n oneOf:\n - type: object\n required:\n - Empty\n properties:\n Empty:\n $ref: '#/components/schemas/Empty7'\n - type: object\n required:\n - ParticipantAuthorizationAdded\n properties:\n ParticipantAuthorizationAdded:\n $ref: '#/components/schemas/ParticipantAuthorizationAdded'\n - type: object\n required:\n - ParticipantAuthorizationChanged\n properties:\n ParticipantAuthorizationChanged:\n $ref: '#/components/schemas/ParticipantAuthorizationChanged'\n - type: object\n required:\n - ParticipantAuthorizationRevoked\n properties:\n ParticipantAuthorizationRevoked:\n $ref: '#/components/schemas/ParticipantAuthorizationRevoked'\n TopologyFormat:\n title: TopologyFormat\n description: A format specifying which topology transactions to include and\n how to render them.\n type: object\n properties:\n includeParticipantAuthorizationEvents:\n $ref: '#/components/schemas/ParticipantAuthorizationTopologyFormat'\n description: |-\n Include participant authorization topology events in streams.\n Optional, if unset no participant authorization topology events are emitted in the stream.\n TopologyStateFilter:\n title: TopologyStateFilter\n description: |-\n Filter the vetted packages by the participant and synchronizer that they are\n hosted on.\n\n Empty fields are ignored, such that a ``TopologyStateFilter`` without\n participant_ids and without synchronizer_ids matches a vetted package hosted\n on any participant and synchronizer.\n\n Non-empty fields specify candidate values of which at least one must match.\n If both fields are set then at least one candidate value must match from each\n field.\n type: object\n properties:\n participantIds:\n description: |-\n If this list is non-empty, only vetted packages hosted on participants\n listed in this field match the filter.\n Query the current Ledger API's participant's ID via the public\n ``GetParticipantId`` command in ``PartyManagementService``.\n type: array\n items:\n type: string\n synchronizerIds:\n description: |-\n If this list is non-empty, only vetted packages from the topology state of\n the synchronizers in this list match the filter.\n type: array\n items:\n type: string\n TopologyTransaction:\n title: TopologyTransaction\n type: object\n required:\n - value\n properties:\n value:\n $ref: '#/components/schemas/JsTopologyTransaction'\n TraceContext:\n title: TraceContext\n type: object\n properties:\n traceparent:\n description: https://www.w3.org/TR/trace-context/\n type: string\n tracestate:\n description: ''\n type: string\n Transaction:\n title: Transaction\n description: Filtered view of an on-ledger transaction's create and archive\n events.\n type: object\n required:\n - value\n properties:\n value:\n $ref: '#/components/schemas/JsTransaction'\n TransactionFilter:\n title: TransactionFilter\n description: |-\n Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.\n Used both for filtering create and archive events as well as for filtering transaction trees.\n type: object\n required:\n - filtersByParty\n properties:\n filtersByParty:\n $ref: '#/components/schemas/Map_Filters'\n description: |-\n Each key must be a valid PartyIdString (as described in ``value.proto``).\n The interpretation of the filter depends on the transaction-shape being filtered:\n\n 1. For **transaction trees** (used in GetUpdateTreesResponse for backwards compatibility) all party keys used as\n wildcard filters, and all subtrees whose root has one of the listed parties as an informee are returned.\n If there are ``CumulativeFilter``s, those will control returned ``CreatedEvent`` fields where applicable, but will\n not be used for template/interface filtering.\n 2. For **ledger-effects** create and exercise events are returned, for which the witnesses include at least one of\n the listed parties and match the per-party filter.\n 3. For **transaction and active-contract-set streams** create and archive events are returned for all contracts whose\n stakeholders include at least one of the listed parties and match the per-party filter.\n filtersForAnyParty:\n $ref: '#/components/schemas/Filters'\n description: |-\n Wildcard filters that apply to all the parties existing on the participant. The interpretation of the filters is the same\n with the per-party filter as described above.\n TransactionFormat:\n title: TransactionFormat\n description: |-\n A format that specifies what events to include in Daml transactions\n and what data to compute and include for them.\n type: object\n required:\n - transactionShape\n properties:\n eventFormat:\n $ref: '#/components/schemas/EventFormat'\n description: Required\n transactionShape:\n description: |-\n What transaction shape to use for interpreting the filters of the event format.\n Required\n type: string\n enum:\n - TRANSACTION_SHAPE_UNSPECIFIED\n - TRANSACTION_SHAPE_ACS_DELTA\n - TRANSACTION_SHAPE_LEDGER_EFFECTS\n TransactionTree:\n title: TransactionTree\n description: |-\n Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.\n Complete view of an on-ledger transaction.\n type: object\n required:\n - value\n properties:\n value:\n $ref: '#/components/schemas/JsTransactionTree'\n TreeEvent:\n title: TreeEvent\n description: |-\n Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.\n Each tree event message type below contains a ``witness_parties`` field which\n indicates the subset of the requested parties that can see the event\n in question.\n\n Note that transaction trees might contain events with\n _no_ witness parties, which were included simply because they were\n children of events which have witnesses.\n oneOf:\n - type: object\n required:\n - CreatedTreeEvent\n properties:\n CreatedTreeEvent:\n $ref: '#/components/schemas/CreatedTreeEvent'\n - type: object\n required:\n - ExercisedTreeEvent\n properties:\n ExercisedTreeEvent:\n $ref: '#/components/schemas/ExercisedTreeEvent'\n Tuple2_String_String:\n title: Tuple2_String_String\n type: array\n maxItems: 2\n minItems: 2\n items:\n type: string\n UnassignCommand:\n title: UnassignCommand\n description: Unassign a contract\n type: object\n required:\n - value\n properties:\n value:\n $ref: '#/components/schemas/UnassignCommand1'\n UnassignCommand1:\n title: UnassignCommand\n description: Unassign a contract\n type: object\n required:\n - contractId\n - source\n - target\n properties:\n contractId:\n description: |-\n The ID of the contract the client wants to unassign.\n Must be a valid LedgerString (as described in ``value.proto``).\n Required\n type: string\n source:\n description: |-\n The ID of the source synchronizer\n Must be a valid synchronizer id\n Required\n type: string\n target:\n description: |-\n The ID of the target synchronizer\n Must be a valid synchronizer id\n Required\n type: string\n UnassignedEvent:\n title: UnassignedEvent\n description: Records that a contract has been unassigned, and it becomes unusable\n on the source synchronizer\n type: object\n required:\n - reassignmentId\n - contractId\n - source\n - target\n - submitter\n - reassignmentCounter\n - packageName\n - offset\n - nodeId\n properties:\n reassignmentId:\n description: |-\n The ID of the unassignment. This needs to be used as an input for a assign ReassignmentCommand.\n Must be a valid LedgerString (as described in ``value.proto``).\n Required\n type: string\n contractId:\n description: |-\n The ID of the reassigned contract.\n Must be a valid LedgerString (as described in ``value.proto``).\n Required\n type: string\n templateId:\n description: |-\n The template of the reassigned contract.\n The identifier uses the package-id reference format.\n\n Required\n type: string\n source:\n description: |-\n The ID of the source synchronizer\n Must be a valid synchronizer id\n Required\n type: string\n target:\n description: |-\n The ID of the target synchronizer\n Must be a valid synchronizer id\n Required\n type: string\n submitter:\n description: |-\n Party on whose behalf the unassign command was executed.\n Empty if the unassignment happened offline via the repair service.\n Must be a valid PartyIdString (as described in ``value.proto``).\n Optional\n type: string\n reassignmentCounter:\n description: |-\n Each corresponding assigned and unassigned event has the same reassignment_counter. This strictly increases\n with each unassign command for the same contract. Creation of the contract corresponds to reassignment_counter\n equals zero.\n Required\n type: integer\n format: int64\n assignmentExclusivity:\n description: |-\n Assignment exclusivity\n Before this time (measured on the target synchronizer), only the submitter of the unassignment can initiate the assignment\n Defined for reassigning participants.\n Optional\n type: string\n witnessParties:\n description: |-\n The parties that are notified of this event.\n Required\n type: array\n items:\n type: string\n packageName:\n description: |-\n The package name of the contract.\n Required\n type: string\n offset:\n description: |-\n The offset of origin.\n Offsets are managed by the participant nodes.\n Reassignments can thus NOT be assumed to have the same offsets on different participant nodes.\n Required, it is a valid absolute offset (positive integer)\n type: integer\n format: int64\n nodeId:\n description: |-\n The position of this event in the originating reassignment.\n Node IDs are not necessarily equal across participants,\n as these may see different projections/parts of reassignments.\n Required, must be valid node ID (non-negative integer)\n type: integer\n format: int32\n UnknownFieldSet:\n title: UnknownFieldSet\n type: object\n required:\n - fields\n properties:\n fields:\n $ref: '#/components/schemas/Map_Int_Field'\n Unvet:\n title: Unvet\n type: object\n required:\n - value\n properties:\n value:\n $ref: '#/components/schemas/Unvet1'\n Unvet1:\n title: Unvet\n type: object\n properties:\n packages:\n type: array\n items:\n $ref: '#/components/schemas/VettedPackagesRef'\n Update:\n title: Update\n oneOf:\n - type: object\n required:\n - OffsetCheckpoint\n properties:\n OffsetCheckpoint:\n $ref: '#/components/schemas/OffsetCheckpoint2'\n - type: object\n required:\n - Reassignment\n properties:\n Reassignment:\n $ref: '#/components/schemas/Reassignment'\n - type: object\n required:\n - TopologyTransaction\n properties:\n TopologyTransaction:\n $ref: '#/components/schemas/TopologyTransaction'\n - type: object\n required:\n - Transaction\n properties:\n Transaction:\n $ref: '#/components/schemas/Transaction'\n Update1:\n title: Update\n oneOf:\n - type: object\n required:\n - OffsetCheckpoint\n properties:\n OffsetCheckpoint:\n $ref: '#/components/schemas/OffsetCheckpoint3'\n - type: object\n required:\n - Reassignment\n properties:\n Reassignment:\n $ref: '#/components/schemas/Reassignment1'\n - type: object\n required:\n - TransactionTree\n properties:\n TransactionTree:\n $ref: '#/components/schemas/TransactionTree'\n UpdateFormat:\n title: UpdateFormat\n description: A format specifying what updates to include and how to render them.\n type: object\n properties:\n includeTransactions:\n $ref: '#/components/schemas/TransactionFormat'\n description: |-\n Include Daml transactions in streams.\n Optional, if unset, no transactions are emitted in the stream.\n includeReassignments:\n $ref: '#/components/schemas/EventFormat'\n description: |-\n Include (un)assignments in the stream.\n The events in the result take the shape TRANSACTION_SHAPE_ACS_DELTA.\n Optional, if unset, no (un)assignments are emitted in the stream.\n includeTopologyEvents:\n $ref: '#/components/schemas/TopologyFormat'\n description: |-\n Include topology events in streams.\n Optional, if unset no topology events are emitted in the stream.\n UpdateIdentityProviderConfigRequest:\n title: UpdateIdentityProviderConfigRequest\n type: object\n properties:\n identityProviderConfig:\n $ref: '#/components/schemas/IdentityProviderConfig'\n description: |-\n The identity provider config to update.\n Required,\n Modifiable\n updateMask:\n $ref: '#/components/schemas/FieldMask'\n description: |-\n An update mask specifies how and which properties of the ``IdentityProviderConfig`` message are to be updated.\n An update mask consists of a set of update paths.\n A valid update path points to a field or a subfield relative to the ``IdentityProviderConfig`` message.\n A valid update mask must:\n\n 1. contain at least one update path,\n 2. contain only valid update paths.\n\n Fields that can be updated are marked as ``Modifiable``.\n For additional information see the documentation for standard protobuf3's ``google.protobuf.FieldMask``.\n Required\n UpdateIdentityProviderConfigResponse:\n title: UpdateIdentityProviderConfigResponse\n type: object\n properties:\n identityProviderConfig:\n $ref: '#/components/schemas/IdentityProviderConfig'\n description: Updated identity provider config\n UpdatePartyDetailsRequest:\n title: UpdatePartyDetailsRequest\n description: 'Required authorization: ``HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(party_details.identity_provider_id)``'\n type: object\n properties:\n partyDetails:\n $ref: '#/components/schemas/PartyDetails'\n description: |-\n Party to be updated\n Required,\n Modifiable\n updateMask:\n $ref: '#/components/schemas/FieldMask'\n description: |-\n An update mask specifies how and which properties of the ``PartyDetails`` message are to be updated.\n An update mask consists of a set of update paths.\n A valid update path points to a field or a subfield relative to the ``PartyDetails`` message.\n A valid update mask must:\n\n 1. contain at least one update path,\n 2. contain only valid update paths.\n\n Fields that can be updated are marked as ``Modifiable``.\n An update path can also point to non-``Modifiable`` fields such as 'party' and 'local_metadata.resource_version'\n because they are used:\n\n 1. to identify the party details resource subject to the update,\n 2. for concurrent change control.\n\n An update path can also point to non-``Modifiable`` fields such as 'is_local'\n as long as the values provided in the update request match the server values.\n Examples of update paths: 'local_metadata.annotations', 'local_metadata'.\n For additional information see the documentation for standard protobuf3's ``google.protobuf.FieldMask``.\n For similar Ledger API see ``com.daml.ledger.api.v2.admin.UpdateUserRequest``.\n Required\n UpdatePartyDetailsResponse:\n title: UpdatePartyDetailsResponse\n type: object\n properties:\n partyDetails:\n $ref: '#/components/schemas/PartyDetails'\n description: Updated party details\n UpdateUserIdentityProviderIdRequest:\n title: UpdateUserIdentityProviderIdRequest\n description: 'Required authorization: ``HasRight(ParticipantAdmin)``'\n type: object\n required:\n - userId\n - sourceIdentityProviderId\n - targetIdentityProviderId\n properties:\n userId:\n description: User to update\n type: string\n sourceIdentityProviderId:\n description: Current identity provider ID of the user\n type: string\n targetIdentityProviderId:\n description: Target identity provider ID of the user\n type: string\n UpdateUserIdentityProviderIdResponse:\n title: UpdateUserIdentityProviderIdResponse\n type: object\n UpdateUserRequest:\n title: UpdateUserRequest\n description: 'Required authorization: ``HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(user.identity_provider_id)``'\n type: object\n properties:\n user:\n $ref: '#/components/schemas/User'\n description: |-\n The user to update.\n Required,\n Modifiable\n updateMask:\n $ref: '#/components/schemas/FieldMask'\n description: |-\n An update mask specifies how and which properties of the ``User`` message are to be updated.\n An update mask consists of a set of update paths.\n A valid update path points to a field or a subfield relative to the ``User`` message.\n A valid update mask must:\n\n 1. contain at least one update path,\n 2. contain only valid update paths.\n\n Fields that can be updated are marked as ``Modifiable``.\n An update path can also point to a non-``Modifiable`` fields such as 'id' and 'metadata.resource_version'\n because they are used:\n\n 1. to identify the user resource subject to the update,\n 2. for concurrent change control.\n\n Examples of valid update paths: 'primary_party', 'metadata', 'metadata.annotations'.\n For additional information see the documentation for standard protobuf3's ``google.protobuf.FieldMask``.\n For similar Ledger API see ``com.daml.ledger.api.v2.admin.UpdatePartyDetailsRequest``.\n Required\n UpdateUserResponse:\n title: UpdateUserResponse\n type: object\n properties:\n user:\n $ref: '#/components/schemas/User'\n description: Updated user\n UpdateVettedPackagesRequest:\n title: UpdateVettedPackagesRequest\n type: object\n required:\n - dryRun\n - synchronizerId\n properties:\n changes:\n description: |-\n Changes to apply to the current vetting state of the participant on the\n specified synchronizer. The changes are applied in order.\n Any package not changed will keep their previous vetting state.\n type: array\n items:\n $ref: '#/components/schemas/VettedPackagesChange'\n dryRun:\n description: |-\n If dry_run is true, then the changes are only prepared, but not applied. If\n a request would trigger an error when run (e.g. TOPOLOGY_DEPENDENCIES_NOT_VETTED),\n it will also trigger an error when dry_run.\n\n Use this flag to preview a change before applying it.\n type: boolean\n synchronizerId:\n description: |-\n If set, the requested changes will take place on the specified\n synchronizer. If synchronizer_id is unset and the participant is only\n connected to a single synchronizer, that synchronizer will be used by\n default. If synchronizer_id is unset and the participant is connected to\n multiple synchronizers, the request will error out with\n PACKAGE_SERVICE_CANNOT_AUTODETECT_SYNCHRONIZER.\n\n Optional\n type: string\n expectedTopologySerial:\n $ref: '#/components/schemas/PriorTopologySerial'\n description: |-\n The serial of the last ``VettedPackages`` topology transaction of this\n participant and on this synchronizer.\n\n Execution of the request fails if this is not correct. Use this to guard\n against concurrent changes.\n\n If left unspecified, no validation is done against the last transaction's\n serial.\n\n Optional\n updateVettedPackagesForceFlags:\n description: |-\n Controls whether potentially unsafe vetting updates are allowed.\n\n Optional, defaults to FORCE_FLAG_UNSPECIFIED.\n type: array\n items:\n type: string\n enum:\n - UPDATE_VETTED_PACKAGES_FORCE_FLAG_UNSPECIFIED\n - UPDATE_VETTED_PACKAGES_FORCE_FLAG_ALLOW_VET_INCOMPATIBLE_UPGRADES\n - UPDATE_VETTED_PACKAGES_FORCE_FLAG_ALLOW_UNVETTED_DEPENDENCIES\n UpdateVettedPackagesResponse:\n title: UpdateVettedPackagesResponse\n type: object\n properties:\n pastVettedPackages:\n $ref: '#/components/schemas/VettedPackages'\n description: |-\n All vetted packages on this participant and synchronizer, before the\n specified changes. Empty if no vetting state existed beforehand.\n newVettedPackages:\n $ref: '#/components/schemas/VettedPackages'\n description: All vetted packages on this participant and synchronizer, after\n the specified changes.\n UploadDarFileResponse:\n title: UploadDarFileResponse\n description: A message that is received when the upload operation succeeded.\n type: object\n User:\n title: User\n description: |2-\n Users and rights\n /////////////////\n Users are used to dynamically manage the rights given to Daml applications.\n They are stored and managed per participant node.\n type: object\n required:\n - id\n - primaryParty\n - isDeactivated\n - identityProviderId\n properties:\n id:\n description: |-\n The user identifier, which must be a non-empty string of at most 128\n characters that are either alphanumeric ASCII characters or one of the symbols \"@^$.!`-#+'~_|:\".\n Required\n type: string\n primaryParty:\n description: |-\n The primary party as which this user reads and acts by default on the ledger\n *provided* it has the corresponding ``CanReadAs(primary_party)`` or\n ``CanActAs(primary_party)`` rights.\n Ledger API clients SHOULD set this field to a non-empty value for all users to\n enable the users to act on the ledger using their own Daml party.\n Users for participant administrators MAY have an associated primary party.\n Optional,\n Modifiable\n type: string\n isDeactivated:\n description: |-\n When set, then the user is denied all access to the Ledger API.\n Otherwise, the user has access to the Ledger API as per the user's rights.\n Optional,\n Modifiable\n type: boolean\n metadata:\n $ref: '#/components/schemas/ObjectMeta'\n description: |-\n The metadata of this user.\n Note that the ``metadata.resource_version`` tracks changes to the properties described by the ``User`` message and not the user's rights.\n Optional,\n Modifiable\n identityProviderId:\n description: |-\n The ID of the identity provider configured by ``Identity Provider Config``\n Optional, if not set, assume the user is managed by the default identity provider.\n type: string\n UserManagementFeature:\n title: UserManagementFeature\n type: object\n required:\n - supported\n - maxRightsPerUser\n - maxUsersPageSize\n properties:\n supported:\n description: Whether the Ledger API server provides the user management\n service.\n type: boolean\n maxRightsPerUser:\n description: |-\n The maximum number of rights that can be assigned to a single user.\n Servers MUST support at least 100 rights per user.\n A value of 0 means that the server enforces no rights per user limit.\n type: integer\n format: int32\n maxUsersPageSize:\n description: |-\n The maximum number of users the server can return in a single response (page).\n Servers MUST support at least a 100 users per page.\n A value of 0 means that the server enforces no page size limit.\n type: integer\n format: int32\n Vet:\n title: Vet\n type: object\n required:\n - value\n properties:\n value:\n $ref: '#/components/schemas/Vet1'\n Vet1:\n title: Vet\n type: object\n properties:\n packages:\n type: array\n items:\n $ref: '#/components/schemas/VettedPackagesRef'\n newValidFromInclusive:\n type: string\n newValidUntilExclusive:\n type: string\n VettedPackage:\n title: VettedPackage\n description: |-\n A package that is vetting on a given participant and synchronizer,\n modelled after ``VettedPackage`` in `topology.proto <https://github.com/digital-asset/canton/blob/main/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto#L206>`_,\n enriched with the package name and version.\n type: object\n required:\n - packageId\n - packageName\n - packageVersion\n properties:\n packageId:\n description: Package ID of this package. Always present.\n type: string\n validFromInclusive:\n description: |-\n The time from which this package is vetted. Empty if vetting time has no\n lower bound.\n type: string\n validUntilExclusive:\n description: |-\n The time until which this package is vetted. Empty if vetting time has no\n upper bound.\n type: string\n packageName:\n description: |-\n Name of this package.\n Only available if the package has been uploaded to the current participant.\n If unavailable, is empty string.\n type: string\n packageVersion:\n description: |-\n Version of this package.\n Only available if the package has been uploaded to the current participant.\n If unavailable, is empty string.\n type: string\n VettedPackages:\n title: VettedPackages\n description: |-\n The list of packages vetted on a given participant and synchronizer, modelled\n after ``VettedPackages`` in `topology.proto <https://github.com/digital-asset/canton/blob/main/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto#L206>`_.\n The list only contains packages that matched a filter in the query that\n originated it.\n type: object\n required:\n - participantId\n - synchronizerId\n - topologySerial\n properties:\n packages:\n description: |-\n Sorted by package_name and package_version where known, and package_id as a\n last resort.\n type: array\n items:\n $ref: '#/components/schemas/VettedPackage'\n participantId:\n description: Participant on which these packages are vetted. Always present.\n type: string\n synchronizerId:\n description: Synchronizer on which these packages are vetted. Always present.\n type: string\n topologySerial:\n description: |-\n Serial of last ``VettedPackages`` topology transaction of this participant\n and on this synchronizer. Always present.\n type: integer\n format: int32\n VettedPackagesChange:\n title: VettedPackagesChange\n description: A change to the set of vetted packages.\n type: object\n required:\n - operation\n properties:\n operation:\n $ref: '#/components/schemas/Operation'\n VettedPackagesRef:\n title: VettedPackagesRef\n description: |-\n A reference to identify one or more packages.\n\n A reference matches a package if its ``package_id`` matches the package's ID,\n its ``package_name`` matches the package's name, and its ``package_version``\n matches the package's version. If an attribute in the reference is left\n unspecified (i.e. as an empty string), that attribute is treated as a\n wildcard. At a minimum, ``package_id`` or the ``package_name`` must be\n specified.\n\n If a reference does not match any package, the reference is considered\n unresolved and the entire update request is rejected.\n type: object\n required:\n - packageId\n - packageName\n - packageVersion\n properties:\n packageId:\n description: |-\n Package's package id must be the same as this field.\n Optional\n type: string\n packageName:\n description: |-\n Package's name must be the same as this field.\n Optional\n type: string\n packageVersion:\n description: |-\n Package's version must be the same as this field.\n Optional\n type: string\n WildcardFilter:\n title: WildcardFilter\n description: This filter matches all templates.\n type: object\n required:\n - value\n properties:\n value:\n $ref: '#/components/schemas/WildcardFilter1'\n WildcardFilter1:\n title: WildcardFilter\n description: This filter matches all templates.\n type: object\n required:\n - includeCreatedEventBlob\n properties:\n includeCreatedEventBlob:\n description: |-\n Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``.\n Use this to access the contract create event payload in your API client\n for submitting it as a disclosed contract with future commands.\n Optional\n type: boolean\n securitySchemes:\n apiKeyAuth:\n type: apiKey\n description: Ledger API standard JWT token (websocket)\n name: Sec-WebSocket-Protocol\n in: header\n httpAuth:\n type: http\n description: Ledger API standard JWT token\n scheme: bearer\n";