From 4bf90d94468712eaf16fa2388b8ff110aa1cd6cd Mon Sep 17 00:00:00 2001 From: danielporterda Date: Mon, 27 Apr 2026 12:59:14 -0400 Subject: [PATCH 1/3] Add Mintlify-parity reference renderer --- .envrc | 7 +- .github/workflows/ci.yml | 24 + README.md | 21 +- flake.lock | 61 + flake.nix | 60 + shell.nix | 15 +- src/x2mdx/asyncapi/render.py | 438 +- src/x2mdx/cli.py | 48 +- src/x2mdx/openrpc/render.py | 479 +- src/x2mdx/protobuf/render.py | 1046 +- src/x2mdx/reference_pages.py | 261 + .../templates/asyncapi/single_page.md.j2 | 21 + .../templates/reference/collection.md.j2 | 18 + src/x2mdx/templates/reference/operation.md.j2 | 7 + .../templates/shared/reference_macros.md.j2 | 257 + src/x2mdx/templating.py | 22 + .../ledger-api-websocket-reference.mdx | 2731 ++- .../openrpc/expected/index.mdx | 236 +- .../operations/dapp-api/accountschanged.mdx | 234 + .../expected/operations/dapp-api/connect.mdx | 253 + .../operations/dapp-api/disconnect.mdx | 193 + .../operations/dapp-api/getactivenetwork.mdx | 230 + .../operations/dapp-api/getprimaryaccount.mdx | 391 + .../operations/dapp-api/ledgerapi.mdx | 333 + .../operations/dapp-api/listaccounts.mdx | 234 + .../operations/dapp-api/prepareexecute.mdx | 273 + .../dapp-api/prepareexecuteandwait.mdx | 312 + .../operations/dapp-api/signmessage.mdx | 310 + .../expected/operations/dapp-api/status.mdx | 258 + .../operations/dapp-api/txchanged.mdx | 240 + .../dapp-remote-api/accountschanged.mdx | 234 + .../operations/dapp-remote-api/connect.mdx | 253 + .../operations/dapp-remote-api/connected.mdx | 258 + .../operations/dapp-remote-api/disconnect.mdx | 193 + .../dapp-remote-api/getactivenetwork.mdx | 230 + .../dapp-remote-api/getprimaryaccount.mdx | 391 + .../operations/dapp-remote-api/ledgerapi.mdx | 333 + .../dapp-remote-api/listaccounts.mdx | 234 + .../dapp-remote-api/onstatuschanged.mdx | 258 + .../dapp-remote-api/prepareexecute.mdx | 305 + .../dapp-remote-api/signmessage.mdx | 310 + .../operations/dapp-remote-api/status.mdx | 258 + .../operations/dapp-remote-api/txchanged.mdx | 240 + .../operations/signing-api/createkey.mdx | 310 + .../signing-api/getconfiguration.mdx | 188 + .../operations/signing-api/getkeys.mdx | 235 + .../operations/signing-api/gettransaction.mdx | 310 + .../signing-api/gettransactions.mdx | 324 + .../signing-api/setconfiguration.mdx | 226 + .../signing-api/signtransaction.mdx | 358 + .../signing-api/subscribetransactions.mdx | 330 + .../expected/operations/user-api/addidp.mdx | 272 + .../operations/user-api/addnetwork.mdx | 280 + .../operations/user-api/addsession.mdx | 413 + .../user-api/allocatepartyforwallet.mdx | 309 + .../operations/user-api/createwallet.mdx | 345 + .../operations/user-api/deletetransaction.mdx | 268 + .../expected/operations/user-api/execute.mdx | 332 + .../operations/user-api/gettransaction.mdx | 374 + .../expected/operations/user-api/getuser.mdx | 248 + .../user-api/iswalletsyncneeded.mdx | 225 + .../expected/operations/user-api/listidps.mdx | 231 + .../operations/user-api/listnetworks.mdx | 239 + .../operations/user-api/listsessions.mdx | 244 + .../operations/user-api/listtransactions.mdx | 232 + .../operations/user-api/listwallets.mdx | 302 + .../operations/user-api/removeidp.mdx | 268 + .../operations/user-api/removenetwork.mdx | 268 + .../operations/user-api/removesession.mdx | 193 + .../operations/user-api/removewallet.mdx | 263 + .../operations/user-api/setprimarywallet.mdx | 268 + .../expected/operations/user-api/sign.mdx | 415 + .../operations/user-api/syncwallets.mdx | 317 + .../openrpc/expected/specs/dapp-api.mdx | 910 +- .../expected/specs/dapp-remote-api.mdx | 960 +- .../openrpc/expected/specs/signing-api.mdx | 660 +- .../openrpc/expected/specs/user-api.mdx | 1779 +- .../operations/dapp-api/accountschanged.mdx | 234 + .../operations/dapp-api/connect.mdx | 253 + .../operations/dapp-api/disconnect.mdx | 193 + .../operations/dapp-api/getactivenetwork.mdx | 230 + .../operations/dapp-api/getprimaryaccount.mdx | 391 + .../operations/dapp-api/ledgerapi.mdx | 333 + .../operations/dapp-api/listaccounts.mdx | 234 + .../operations/dapp-api/prepareexecute.mdx | 273 + .../dapp-api/prepareexecuteandwait.mdx | 312 + .../operations/dapp-api/signmessage.mdx | 310 + .../operations/dapp-api/status.mdx | 258 + .../operations/dapp-api/txchanged.mdx | 240 + .../dapp-remote-api/accountschanged.mdx | 234 + .../operations/dapp-remote-api/connect.mdx | 253 + .../operations/dapp-remote-api/connected.mdx | 258 + .../operations/dapp-remote-api/disconnect.mdx | 193 + .../dapp-remote-api/getactivenetwork.mdx | 230 + .../dapp-remote-api/getprimaryaccount.mdx | 391 + .../operations/dapp-remote-api/ledgerapi.mdx | 333 + .../dapp-remote-api/listaccounts.mdx | 234 + .../dapp-remote-api/onstatuschanged.mdx | 258 + .../dapp-remote-api/prepareexecute.mdx | 305 + .../dapp-remote-api/signmessage.mdx | 310 + .../operations/dapp-remote-api/status.mdx | 258 + .../operations/dapp-remote-api/txchanged.mdx | 240 + .../operations/signing-api/createkey.mdx | 310 + .../signing-api/getconfiguration.mdx | 188 + .../operations/signing-api/getkeys.mdx | 235 + .../operations/signing-api/gettransaction.mdx | 310 + .../signing-api/gettransactions.mdx | 324 + .../signing-api/setconfiguration.mdx | 226 + .../signing-api/signtransaction.mdx | 358 + .../signing-api/subscribetransactions.mdx | 330 + .../operations/user-api/addidp.mdx | 272 + .../operations/user-api/addnetwork.mdx | 280 + .../operations/user-api/addsession.mdx | 413 + .../user-api/allocatepartyforwallet.mdx | 309 + .../operations/user-api/createwallet.mdx | 345 + .../operations/user-api/deletetransaction.mdx | 268 + .../operations/user-api/execute.mdx | 332 + .../operations/user-api/gettransaction.mdx | 374 + .../operations/user-api/getuser.mdx | 248 + .../user-api/iswalletsyncneeded.mdx | 225 + .../operations/user-api/listidps.mdx | 231 + .../operations/user-api/listnetworks.mdx | 239 + .../operations/user-api/listsessions.mdx | 244 + .../operations/user-api/listtransactions.mdx | 232 + .../operations/user-api/listwallets.mdx | 302 + .../operations/user-api/removeidp.mdx | 268 + .../operations/user-api/removenetwork.mdx | 268 + .../operations/user-api/removesession.mdx | 193 + .../operations/user-api/removewallet.mdx | 263 + .../operations/user-api/setprimarywallet.mdx | 268 + .../operations/user-api/sign.mdx | 415 + .../operations/user-api/syncwallets.mdx | 317 + .../rpc-specs/dapp-api.mdx | 910 +- .../rpc-specs/dapp-remote-api.mdx | 960 +- .../rpc-specs/signing-api.mdx | 660 +- .../rpc-specs/user-api.mdx | 1779 +- .../wallet-gateway-overview.mdx | 236 +- .../protobuf/expected/index.mdx | 1650 +- .../getcommandstatus.mdx | 1101 ++ .../createidentityproviderconfig.mdx | 388 + .../deleteidentityproviderconfig.mdx | 280 + .../getidentityproviderconfig.mdx | 382 + .../listidentityproviderconfigs.mdx | 352 + .../updateidentityproviderconfig.mdx | 415 + .../listknownpackages.mdx | 356 + .../updatevettedpackages.mdx | 801 + .../uploaddarfile.mdx | 368 + .../validatedarfile.mdx | 326 + .../participantpruningservice/prune.mdx | 326 + .../allocateexternalparty.mdx | 528 + .../partymanagementservice/allocateparty.mdx | 511 + .../generateexternalpartytopology.mdx | 619 + .../getparticipantid.mdx | 280 + .../partymanagementservice/getparties.mdx | 443 + .../listknownparties.mdx | 510 + .../updatepartydetails.mdx | 451 + .../updatepartyidentityproviderid.mdx | 326 + .../usermanagementservice/createuser.mdx | 666 + .../usermanagementservice/deleteuser.mdx | 303 + .../usermanagementservice/getuser.mdx | 451 + .../usermanagementservice/grantuserrights.mdx | 564 + .../usermanagementservice/listuserrights.mdx | 537 + .../usermanagementservice/listusers.mdx | 499 + .../revokeuserrights.mdx | 564 + .../usermanagementservice/updateuser.mdx | 464 + .../updateuseridentityproviderid.mdx | 326 + .../executesubmission.mdx | 1511 ++ .../executesubmissionandwait.mdx | 1566 ++ ...executesubmissionandwaitfortransaction.mdx | 2557 +++ .../getpreferredpackages.mdx | 475 + .../getpreferredpackageversion.mdx | 471 + .../preparesubmission.mdx | 2059 ++ .../completionstream.mdx | 620 + .../commandservice/submitandwait.mdx | 875 + .../submitandwaitforreassignment.mdx | 1431 ++ .../submitandwaitfortransaction.mdx | 1886 ++ .../commandsubmissionservice/submit.mdx | 820 + .../submitreassignment.mdx | 497 + .../contractservice/getcontract.mdx | 576 + .../geteventsbycontractid.mdx | 1016 + .../packageservice/getpackage.mdx | 373 + .../packageservice/getpackagestatus.mdx | 329 + .../packageservice/listpackages.mdx | 282 + .../packageservice/listvettedpackages.mdx | 628 + .../stateservice/getactivecontracts.mdx | 1216 ++ .../getconnectedsynchronizers.mdx | 427 + .../stateservice/getlatestprunedoffsets.mdx | 303 + .../stateservice/getledgerend.mdx | 280 + .../updateservice/getupdatebyid.mdx | 2113 ++ .../updateservice/getupdatebyoffset.mdx | 2113 ++ .../updateservice/getupdates.mdx | 2223 +++ .../versionservice/getledgerapiversion.mdx | 587 + .../statusservice/getlasterrors.mdx | 312 + .../statusservice/getlasterrortrace.mdx | 310 + .../statusservice/healthdump.mdx | 313 + .../statusservice/setloglevel.mdx | 280 + .../mediatorstatusservice/mediatorstatus.mdx | 625 + .../setpassive.mdx | 248 + .../packageservice/getdar.mdx | 377 + .../packageservice/getdarcontents.mdx | 443 + .../packageservice/getpackagecontents.mdx | 451 + .../packageservice/getpackagereferences.mdx | 360 + .../packageservice/listdars.mdx | 379 + .../packageservice/listpackages.mdx | 389 + .../packageservice/removedar.mdx | 276 + .../packageservice/removepackage.mdx | 323 + .../packageservice/unvetdar.mdx | 299 + .../packageservice/uploaddar.mdx | 423 + .../packageservice/validatedar.mdx | 346 + .../packageservice/vetdar.mdx | 322 + .../countinflight.mdx | 327 + .../getconfigforslowcounterparticipants.mdx | 392 + ...tintervalsbehindforcounterparticipants.mdx | 430 + .../inspectcommitmentcontracts.mdx | 384 + .../lookupoffsetbytime.mdx | 312 + .../lookupreceivedacscommitments.mdx | 618 + .../lookupsentacscommitments.mdx | 616 + .../opencommitment.mdx | 378 + .../setconfigforslowcounterparticipants.mdx | 362 + .../changeassignation.mdx | 383 + .../participantrepairservice/exportacs.mdx | 415 + .../participantrepairservice/exportacsold.mdx | 407 + .../participantrepairservice/ignoreevents.mdx | 345 + .../participantrepairservice/importacs.mdx | 494 + .../participantrepairservice/importacsold.mdx | 363 + .../migratesynchronizer.mdx | 807 + .../purgecontracts.mdx | 328 + .../purgedeactivatedsynchronizer.mdx | 280 + .../repaircommitmentsusingacs.mdx | 428 + .../rollbackunassignment.mdx | 326 + .../unignoreevents.mdx | 345 + .../participantstatus.mdx | 696 + .../partymanagementservice/addpartyasync.mdx | 425 + .../clearpartyonboardingflag.mdx | 404 + .../partymanagementservice/exportpartyacs.mdx | 405 + .../getaddpartystatus.mdx | 830 + .../gethighestoffsetbytimestamp.mdx | 358 + .../partymanagementservice/importpartyacs.mdx | 433 + .../pingservice/ping.mdx | 508 + .../pruningservice/clearschedule.mdx | 248 + .../getnowaitcommitmentsfrom.mdx | 425 + .../pruningservice/getparticipantschedule.mdx | 354 + .../pruningservice/getsafepruningoffset.mdx | 390 + .../pruningservice/getschedule.mdx | 320 + .../pruningservice/prune.mdx | 320 + .../resetnowaitcommitmentsfrom.mdx | 307 + .../pruningservice/setcron.mdx | 276 + .../pruningservice/setmaxduration.mdx | 276 + .../setnowaitcommitmentsfrom.mdx | 307 + .../pruningservice/setparticipantschedule.mdx | 354 + .../pruningservice/setretention.mdx | 276 + .../pruningservice/setschedule.mdx | 320 + .../getresourcelimits.mdx | 326 + .../setresourcelimits.mdx | 326 + .../connectsynchronizer.mdx | 835 + .../disconnectallsynchronizers.mdx | 248 + .../disconnectsynchronizer.mdx | 276 + .../getsynchronizerid.mdx | 323 + .../listconnectedsynchronizers.mdx | 332 + .../listregisteredsynchronizers.mdx | 787 + .../logout.mdx | 276 + .../modifysynchronizer.mdx | 822 + .../reconnectsynchronizer.mdx | 331 + .../reconnectsynchronizers.mdx | 280 + .../registersynchronizer.mdx | 845 + .../trafficcontrolstate.mdx | 394 + .../sequencerstatus.mdx | 783 + .../apiinfoservice/getapiinfo.mdx | 276 + .../vaultservice/deletekeypair.mdx | 276 + .../vaultservice/exportkeypair.mdx | 354 + .../vaultservice/generateencryptionkey.mdx | 452 + .../vaultservice/generatesigningkey.mdx | 520 + .../vaultservice/getwrapperkeyid.mdx | 276 + .../vaultservice/importkeypair.mdx | 318 + .../vaultservice/importpublickey.mdx | 335 + .../vaultservice/listmykeys.mdx | 763 + .../vaultservice/listpublickeys.mdx | 723 + .../vaultservice/registerkmsencryptionkey.mdx | 452 + .../vaultservice/registerkmssigningkey.mdx | 520 + .../vaultservice/rotatewrapperkey.mdx | 276 + .../clearschedule.mdx | 248 + .../findpruningtimestamp.mdx | 312 + .../getschedule.mdx | 320 + .../mediatoradministrationservice/prune.mdx | 280 + .../mediatoradministrationservice/setcron.mdx | 276 + .../setmaxduration.mdx | 276 + .../setretention.mdx | 276 + .../setschedule.mdx | 320 + .../initializemediator.mdx | 617 + .../mediatorinspectionservice/verdicts.mdx | 480 + .../getconnection.mdx | 548 + .../sequencerconnectionservice/logout.mdx | 248 + .../setconnection.mdx | 594 + .../disablemember.mdx | 276 + .../generateauthenticationtoken.mdx | 358 + .../onboardingstate.mdx | 335 + .../onboardingstatev2.mdx | 335 + .../pruningstatus.mdx | 386 + .../settrafficpurchased.mdx | 326 + .../snapshot.mdx | 1209 ++ .../trafficcontrolstate.mdx | 389 + .../addpeerendpoint.mdx | 432 + .../getorderingtopology.mdx | 305 + .../getpeernetworkstatus.mdx | 569 + .../removepeerendpoint.mdx | 352 + .../setperformancemetricsenabled.mdx | 276 + .../bftprune.mdx | 323 + .../bftpruningstatus.mdx | 352 + .../clearschedule.mdx | 248 + .../getbftschedule.mdx | 354 + .../getschedule.mdx | 320 + .../setbftschedule.mdx | 354 + .../setcron.mdx | 276 + .../setmaxduration.mdx | 276 + .../setminblockstokeep.mdx | 276 + .../setretention.mdx | 276 + .../setschedule.mdx | 320 + .../initializesequencerfromgenesisstate.mdx | 696 + .../initializesequencerfromgenesisstatev2.mdx | 696 + ...initializesequencerfromonboardingstate.mdx | 309 + ...itializesequencerfromonboardingstatev2.mdx | 309 + .../initializesequencerfrompredecessor.mdx | 660 + .../clearschedule.mdx | 248 + .../findpruningtimestamp.mdx | 312 + .../getschedule.mdx | 320 + .../prune.mdx | 308 + .../setcron.mdx | 276 + .../setmaxduration.mdx | 276 + .../setretention.mdx | 276 + .../setschedule.mdx | 320 + .../authenticate.mdx | 608 + .../challenge.mdx | 354 + .../sequencerauthenticationservice/logout.mdx | 280 + .../connecttosequencerchannel.mdx | 679 + .../sequencerchannelservice/ping.mdx | 248 + .../getsynchronizerid.mdx | 295 + .../getsynchronizerparameters.mdx | 640 + .../sequencerconnectservice/handshake.mdx | 393 + ...registeronboardingtopologytransactions.mdx | 627 + .../sequencerconnectservice/verifyactive.mdx | 340 + .../sequencerservice/acknowledgesigned.mdx | 280 + .../downloadtopologystateforinit.mdx | 401 + .../downloadtopologystateforinithash.mdx | 312 + .../sequencerservice/gettime.mdx | 280 + .../gettrafficstateformember.mdx | 417 + .../sequencerservice/sendasync.mdx | 280 + .../sequencerservice/subscribe.mdx | 391 + .../readordered.mdx | 360 + .../standalonebftorderingservice/send.mdx | 323 + .../bftorderingservice/receive.mdx | 806 + .../synchronizertimeservice/awaittime.mdx | 336 + .../synchronizertimeservice/fetchtime.mdx | 360 + .../currenttime.mdx | 276 + .../identityinitializationservice/getid.mdx | 295 + .../identityinitializationservice/initid.mdx | 677 + .../listkeyowners.mdx | 720 + .../listparties.mdx | 523 + .../exporttopologysnapshot.mdx | 593 + .../exporttopologysnapshotv2.mdx | 593 + .../genesisstate.mdx | 440 + .../genesisstatev2.mdx | 440 + .../topologymanagerreadservice/listall.mdx | 688 + .../listavailablestores.mdx | 382 + .../listdecentralizednamespacedefinition.mdx | 757 + .../listmediatorsynchronizerstate.mdx | 783 + .../listnamespacedelegation.mdx | 1055 + .../listownertokeymapping.mdx | 1052 + .../listparticipantsynchronizerpermission.mdx | 820 + .../listpartyhostinglimits.mdx | 739 + .../listpartytokeymapping.mdx | 925 + .../listpartytoparticipant.mdx | 1068 ++ .../listsequencerconnectionsuccessor.mdx | 812 + .../listsequencersynchronizerstate.mdx | 771 + .../listsynchronizerparametersstate.mdx | 1012 + .../listsynchronizertrustcertificate.mdx | 774 + .../listsynchronizerupgradeannouncement.mdx | 743 + .../listvettedpackages.mdx | 809 + .../logicalupgradestate.mdx | 281 + .../addtransactions.mdx | 845 + .../topologymanagerwriteservice/authorize.mdx | 2784 +++ .../createtemporarytopologystore.mdx | 359 + .../droptemporarytopologystore.mdx | 304 + .../generatetransactions.mdx | 2332 +++ .../importtopologysnapshot.mdx | 423 + .../importtopologysnapshotv2.mdx | 423 + .../signtransactions.mdx | 917 + .../packages/com-daml-ledger-api-v2-admin.mdx | 7891 ++++++-- ...dger-api-v2-interactive-transaction-v1.mdx | 627 +- .../com-daml-ledger-api-v2-interactive.mdx | 4741 ++++- .../packages/com-daml-ledger-api-v2.mdx | 9764 +++++++--- ...m-digitalasset-canton-admin-crypto-v30.mdx | 184 +- ...m-digitalasset-canton-admin-health-v30.mdx | 1183 +- ...digitalasset-canton-admin-mediator-v30.mdx | 659 +- ...italasset-canton-admin-participant-v30.mdx | 15954 +++++++++++----- ...-digitalasset-canton-admin-pruning-v30.mdx | 1107 +- ...igitalasset-canton-admin-sequencer-v30.mdx | 1285 +- ...com-digitalasset-canton-admin-time-v30.mdx | 234 +- ...com-digitalasset-canton-connection-v30.mdx | 293 +- ...m-digitalasset-canton-crypto-admin-v30.mdx | 2946 ++- .../com-digitalasset-canton-crypto-v30.mdx | 1910 +- ...digitalasset-canton-mediator-admin-v30.mdx | 2447 ++- ...lasset-canton-participant-protocol-v30.mdx | 950 +- .../com-digitalasset-canton-protocol-v30.mdx | 9837 ++++++++-- .../com-digitalasset-canton-protocol-v31.mdx | 173 +- ...igitalasset-canton-sequencer-admin-v30.mdx | 8008 +++++--- ...-digitalasset-canton-sequencer-api-v30.mdx | 4611 +++-- ...asset-canton-synchronizer-protocol-v30.mdx | 422 +- ...ng-sequencer-bftordering-standalone-v1.mdx | 541 +- ...r-sequencing-sequencer-bftordering-v30.mdx | 2435 ++- ...m-digitalasset-canton-synchronizer-v30.mdx | 163 +- ...com-digitalasset-canton-time-admin-v30.mdx | 517 +- ...digitalasset-canton-topology-admin-v30.mdx | 10310 +++++++--- .../packages/com-digitalasset-canton-v30.mdx | 161 +- .../com-digitalasset-canton-version-v1.mdx | 167 +- .../expected/packages/daml-platform-v1.mdx | 307 +- tests/test_asyncapi.py | 123 +- tests/test_characterization_preview.py | 2 +- tests/test_openrpc.py | 76 +- tests/test_protobuf.py | 99 +- 419 files changed, 240246 insertions(+), 27520 deletions(-) create mode 100644 .github/workflows/ci.yml create mode 100644 flake.lock create mode 100644 flake.nix create mode 100644 src/x2mdx/reference_pages.py create mode 100644 src/x2mdx/templates/asyncapi/single_page.md.j2 create mode 100644 src/x2mdx/templates/reference/collection.md.j2 create mode 100644 src/x2mdx/templates/reference/operation.md.j2 create mode 100644 src/x2mdx/templates/shared/reference_macros.md.j2 create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/dapp-api/accountschanged.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/dapp-api/connect.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/dapp-api/disconnect.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/dapp-api/getactivenetwork.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/dapp-api/getprimaryaccount.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/dapp-api/ledgerapi.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/dapp-api/listaccounts.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/dapp-api/prepareexecute.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/dapp-api/prepareexecuteandwait.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/dapp-api/signmessage.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/dapp-api/status.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/dapp-api/txchanged.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/accountschanged.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/connect.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/connected.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/disconnect.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/getactivenetwork.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/getprimaryaccount.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/ledgerapi.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/listaccounts.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/onstatuschanged.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/prepareexecute.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/signmessage.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/status.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/txchanged.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/signing-api/createkey.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/signing-api/getconfiguration.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/signing-api/getkeys.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/signing-api/gettransaction.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/signing-api/gettransactions.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/signing-api/setconfiguration.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/signing-api/signtransaction.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/signing-api/subscribetransactions.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/user-api/addidp.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/user-api/addnetwork.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/user-api/addsession.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/user-api/allocatepartyforwallet.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/user-api/createwallet.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/user-api/deletetransaction.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/user-api/execute.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/user-api/gettransaction.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/user-api/getuser.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/user-api/iswalletsyncneeded.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/user-api/listidps.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/user-api/listnetworks.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/user-api/listsessions.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/user-api/listtransactions.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/user-api/listwallets.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/user-api/removeidp.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/user-api/removenetwork.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/user-api/removesession.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/user-api/removewallet.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/user-api/setprimarywallet.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/user-api/sign.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected/operations/user-api/syncwallets.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/accountschanged.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/connect.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/disconnect.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/getactivenetwork.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/getprimaryaccount.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/ledgerapi.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/listaccounts.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/prepareexecute.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/prepareexecuteandwait.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/signmessage.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/status.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/txchanged.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/accountschanged.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/connect.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/connected.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/disconnect.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/getactivenetwork.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/getprimaryaccount.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/ledgerapi.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/listaccounts.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/onstatuschanged.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/prepareexecute.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/signmessage.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/status.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/txchanged.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/createkey.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/getconfiguration.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/getkeys.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/gettransaction.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/gettransactions.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/setconfiguration.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/signtransaction.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/subscribetransactions.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/addidp.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/addnetwork.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/addsession.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/allocatepartyforwallet.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/createwallet.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/deletetransaction.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/execute.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/gettransaction.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/getuser.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/iswalletsyncneeded.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listidps.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listnetworks.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listsessions.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listtransactions.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listwallets.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removeidp.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removenetwork.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removesession.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removewallet.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/setprimarywallet.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/sign.mdx create mode 100644 tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/syncwallets.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/commandinspectionservice/getcommandstatus.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/createidentityproviderconfig.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/deleteidentityproviderconfig.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/getidentityproviderconfig.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/listidentityproviderconfigs.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/updateidentityproviderconfig.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/listknownpackages.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/updatevettedpackages.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/uploaddarfile.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/validatedarfile.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/participantpruningservice/prune.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/allocateexternalparty.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/allocateparty.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/generateexternalpartytopology.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/getparticipantid.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/getparties.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/listknownparties.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/updatepartydetails.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/updatepartyidentityproviderid.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/createuser.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/deleteuser.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/getuser.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/grantuserrights.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/listuserrights.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/listusers.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/revokeuserrights.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/updateuser.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/updateuseridentityproviderid.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/executesubmission.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/executesubmissionandwait.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/executesubmissionandwaitfortransaction.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/getpreferredpackages.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/getpreferredpackageversion.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/preparesubmission.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandcompletionservice/completionstream.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandservice/submitandwait.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandservice/submitandwaitforreassignment.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandservice/submitandwaitfortransaction.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandsubmissionservice/submit.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandsubmissionservice/submitreassignment.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/contractservice/getcontract.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/eventqueryservice/geteventsbycontractid.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/getpackage.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/getpackagestatus.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/listpackages.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/listvettedpackages.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getactivecontracts.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getconnectedsynchronizers.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getlatestprunedoffsets.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getledgerend.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/updateservice/getupdatebyid.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/updateservice/getupdatebyoffset.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/updateservice/getupdates.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/versionservice/getledgerapiversion.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/getlasterrors.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/getlasterrortrace.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/healthdump.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/setloglevel.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-mediator-v30/mediatorstatusservice/mediatorstatus.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/enterpriseparticipantreplicationservice/setpassive.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getdar.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getdarcontents.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getpackagecontents.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getpackagereferences.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/listdars.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/listpackages.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/removedar.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/removepackage.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/unvetdar.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/uploaddar.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/validatedar.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/vetdar.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/countinflight.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/getconfigforslowcounterparticipants.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/getintervalsbehindforcounterparticipants.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/inspectcommitmentcontracts.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/lookupoffsetbytime.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/lookupreceivedacscommitments.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/lookupsentacscommitments.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/opencommitment.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/setconfigforslowcounterparticipants.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/changeassignation.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/exportacs.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/exportacsold.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/ignoreevents.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/importacs.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/importacsold.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/migratesynchronizer.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/purgecontracts.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/purgedeactivatedsynchronizer.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/repaircommitmentsusingacs.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/rollbackunassignment.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/unignoreevents.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantstatusservice/participantstatus.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/addpartyasync.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/clearpartyonboardingflag.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/exportpartyacs.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/getaddpartystatus.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/gethighestoffsetbytimestamp.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/importpartyacs.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pingservice/ping.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/clearschedule.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getnowaitcommitmentsfrom.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getparticipantschedule.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getsafepruningoffset.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getschedule.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/prune.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/resetnowaitcommitmentsfrom.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setcron.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setmaxduration.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setnowaitcommitmentsfrom.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setparticipantschedule.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setretention.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setschedule.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/resourcemanagementservice/getresourcelimits.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/resourcemanagementservice/setresourcelimits.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/connectsynchronizer.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/disconnectallsynchronizers.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/disconnectsynchronizer.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/getsynchronizerid.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/listconnectedsynchronizers.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/listregisteredsynchronizers.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/logout.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/modifysynchronizer.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/reconnectsynchronizer.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/reconnectsynchronizers.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/registersynchronizer.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/trafficcontrolservice/trafficcontrolstate.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-sequencer-v30/sequencerstatusservice/sequencerstatus.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-connection-v30/apiinfoservice/getapiinfo.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/deletekeypair.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/exportkeypair.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/generateencryptionkey.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/generatesigningkey.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/getwrapperkeyid.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/importkeypair.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/importpublickey.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/listmykeys.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/listpublickeys.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/registerkmsencryptionkey.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/registerkmssigningkey.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/rotatewrapperkey.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/clearschedule.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/findpruningtimestamp.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/getschedule.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/prune.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setcron.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setmaxduration.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setretention.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setschedule.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatorinitializationservice/initializemediator.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatorinspectionservice/verdicts.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/sequencerconnectionservice/getconnection.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/sequencerconnectionservice/logout.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/sequencerconnectionservice/setconnection.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/disablemember.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/generateauthenticationtoken.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/onboardingstate.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/onboardingstatev2.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/pruningstatus.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/settrafficpurchased.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/snapshot.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/trafficcontrolstate.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/addpeerendpoint.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/getorderingtopology.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/getpeernetworkstatus.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/removepeerendpoint.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/setperformancemetricsenabled.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/bftprune.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/bftpruningstatus.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/clearschedule.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/getbftschedule.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/getschedule.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setbftschedule.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setcron.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setmaxduration.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setminblockstokeep.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setretention.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setschedule.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromgenesisstate.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromgenesisstatev2.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromonboardingstate.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromonboardingstatev2.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfrompredecessor.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/clearschedule.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/findpruningtimestamp.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/getschedule.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/prune.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setcron.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setmaxduration.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setretention.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setschedule.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerauthenticationservice/authenticate.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerauthenticationservice/challenge.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerauthenticationservice/logout.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerchannelservice/connecttosequencerchannel.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerchannelservice/ping.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/getsynchronizerid.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/getsynchronizerparameters.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/handshake.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/registeronboardingtopologytransactions.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/verifyactive.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/acknowledgesigned.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/downloadtopologystateforinit.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/downloadtopologystateforinithash.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/gettime.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/gettrafficstateformember.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/sendasync.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/subscribe.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-standalone-v1/standalonebftorderingservice/readordered.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-standalone-v1/standalonebftorderingservice/send.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30/bftorderingservice/receive.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-time-admin-v30/synchronizertimeservice/awaittime.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-time-admin-v30/synchronizertimeservice/fetchtime.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/identityinitializationservice/currenttime.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/identityinitializationservice/getid.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/identityinitializationservice/initid.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologyaggregationservice/listkeyowners.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologyaggregationservice/listparties.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/exporttopologysnapshot.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/exporttopologysnapshotv2.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/genesisstate.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/genesisstatev2.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listall.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listavailablestores.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listdecentralizednamespacedefinition.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listmediatorsynchronizerstate.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listnamespacedelegation.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listownertokeymapping.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listparticipantsynchronizerpermission.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listpartyhostinglimits.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listpartytokeymapping.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listpartytoparticipant.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsequencerconnectionsuccessor.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsequencersynchronizerstate.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsynchronizerparametersstate.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsynchronizertrustcertificate.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsynchronizerupgradeannouncement.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listvettedpackages.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/logicalupgradestate.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/addtransactions.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/authorize.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/createtemporarytopologystore.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/droptemporarytopologystore.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/generatetransactions.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/importtopologysnapshot.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/importtopologysnapshotv2.mdx create mode 100644 tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/signtransactions.mdx diff --git a/.envrc b/.envrc index 4149611..38ad260 100644 --- a/.envrc +++ b/.envrc @@ -1,6 +1,7 @@ -watch_file shell.nix +watch_file flake.nix +watch_file flake.lock watch_file pyproject.toml -PATH_add "$PWD/.venv/bin" +export NIX_CONFIG="experimental-features = nix-command flakes" -use nix +use flake diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..b4c73e7 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,24 @@ +name: CI + +on: + pull_request: + push: + branches: + - main + +permissions: + contents: read + +jobs: + test: + runs-on: ubuntu-latest + + steps: + - name: Check out repository + uses: actions/checkout@v4 + + - name: Install Nix + uses: cachix/install-nix-action@v27 + + - name: Run unit tests in the pinned dev shell + run: nix develop . --command pytest diff --git a/README.md b/README.md index b46d481..d44f6f6 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,14 @@ x2mdx asyncapi build-api-pages-from-manifest --manifest fixtures/asyncapi.json - x2mdx openrpc build-api-pages-from-manifest --manifest fixtures/openrpc.json --output-dir ./out/openrpc ``` +Run the tool through the pinned shell so `python`, `pytest`, and `x2mdx` all come from the same environment: + +```bash +direnv allow +direnv exec . x2mdx list-formats +direnv exec . pytest +``` + ## JVM Docs `jvm-docs build-api-pages-from-manifest` consumes a local manifest of Javadoc/Scaladoc jars and renders: @@ -115,13 +123,20 @@ The intended split is: ## direnv / Nix -This repo now includes [.envrc](/Users/danielporter/control/.envrc) and [shell.nix](/Users/danielporter/control/shell.nix) so `direnv` can give you a Mintlify-compatible Node runtime. +This repo includes [`flake.nix`](./flake.nix), [`flake.lock`](./flake.lock), [`.envrc`](./.envrc), and [`shell.nix`](./shell.nix) so the development shell is pinned and reproducible. Activate it with: ```bash direnv allow -node -v +direnv exec . x2mdx list-formats +direnv exec . pytest ``` -The shell pins Node 22, which works with Mintlify and avoids the local Node 25 incompatibility. +The shell pins: + +- Node 22 for Mintlify compatibility +- Python 3.12 plus the runtime and test dependencies used by `x2mdx` +- the `x2mdx` CLI itself, built from the checked-out source tree + +GitHub Actions uses the same flake via `.github/workflows/ci.yml`, so local `direnv` and CI exercise the same bootstrap path. diff --git a/flake.lock b/flake.lock new file mode 100644 index 0000000..032fb8b --- /dev/null +++ b/flake.lock @@ -0,0 +1,61 @@ +{ + "nodes": { + "flake-utils": { + "inputs": { + "systems": "systems" + }, + "locked": { + "lastModified": 1731533236, + "narHash": "sha256-l0KFg5HjrsfsO/JpG+r7fRrqm12kzFHyUHqHCVpMMbI=", + "owner": "numtide", + "repo": "flake-utils", + "rev": "11707dc2f618dd54ca8739b309ec4fc024de578b", + "type": "github" + }, + "original": { + "owner": "numtide", + "repo": "flake-utils", + "type": "github" + } + }, + "nixpkgs": { + "locked": { + "lastModified": 1751274312, + "narHash": "sha256-/bVBlRpECLVzjV19t5KMdMFWSwKLtb5RyXdjz3LJT+g=", + "owner": "NixOS", + "repo": "nixpkgs", + "rev": "50ab793786d9de88ee30ec4e4c24fb4236fc2674", + "type": "github" + }, + "original": { + "owner": "NixOS", + "ref": "nixos-24.11", + "repo": "nixpkgs", + "type": "github" + } + }, + "root": { + "inputs": { + "flake-utils": "flake-utils", + "nixpkgs": "nixpkgs" + } + }, + "systems": { + "locked": { + "lastModified": 1681028828, + "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=", + "owner": "nix-systems", + "repo": "default", + "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e", + "type": "github" + }, + "original": { + "owner": "nix-systems", + "repo": "default", + "type": "github" + } + } + }, + "root": "root", + "version": 7 +} diff --git a/flake.nix b/flake.nix new file mode 100644 index 0000000..912c62c --- /dev/null +++ b/flake.nix @@ -0,0 +1,60 @@ +{ + description = "Reproducible development shell for x2mdx"; + + inputs = { + nixpkgs.url = "github:NixOS/nixpkgs/nixos-24.11"; + flake-utils.url = "github:numtide/flake-utils"; + }; + + outputs = { self, nixpkgs, flake-utils }: + flake-utils.lib.eachDefaultSystem ( + system: + let + pkgs = import nixpkgs { inherit system; }; + python = pkgs.python312; + pythonPackages = pkgs.python312Packages; + pythonEnv = python.withPackages ( + ps: with ps; [ + jinja2 + protobuf + pyyaml + pytest + ] + ); + x2mdx = pythonPackages.buildPythonApplication { + pname = "x2mdx"; + version = "0.1.0"; + pyproject = true; + src = ./.; + nativeBuildInputs = with pythonPackages; [ + setuptools + wheel + ]; + propagatedBuildInputs = with pythonPackages; [ + jinja2 + protobuf + pyyaml + ]; + doCheck = false; + }; + in + { + packages.default = x2mdx; + apps.default = flake-utils.lib.mkApp { drv = x2mdx; }; + + devShells.default = pkgs.mkShell { + packages = [ + pkgs.git + pkgs.nodejs_22 + pythonEnv + x2mdx + ]; + + shellHook = '' + export PYTHONPATH="$PWD/src''${PYTHONPATH:+:$PYTHONPATH}" + echo "x2mdx dev shell ready: node $(node -v), python $(python --version 2>&1)" + ''; + }; + } + ); +} diff --git a/shell.nix b/shell.nix index 53daac0..709f7a0 100644 --- a/shell.nix +++ b/shell.nix @@ -1,14 +1 @@ -{ pkgs ? import {} }: - -pkgs.mkShell { - packages = [ - pkgs.git - pkgs.nodejs_22 - pkgs.python3 - ]; - - shellHook = '' - export PATH="$PWD/.venv/bin:$PWD/node_modules/.bin:$PATH" - echo "control dev shell ready: node $(node -v)" - ''; -} +(builtins.getFlake (toString ./. )).devShells.${builtins.currentSystem}.default diff --git a/src/x2mdx/asyncapi/render.py b/src/x2mdx/asyncapi/render.py index 5f57aa2..0f67670 100644 --- a/src/x2mdx/asyncapi/render.py +++ b/src/x2mdx/asyncapi/render.py @@ -1,19 +1,32 @@ -"""Render AsyncAPI lifecycle reports into MDX pages.""" +"""Render AsyncAPI lifecycle reports into Mintlify-like collection and operation pages.""" from __future__ import annotations -import html +import json import re from pathlib import Path from typing import Any from x2mdx.asyncapi.models import AsyncApiChannelLifecycle, AsyncApiReport -from x2mdx.output import Page -from x2mdx.templating import markdown_page - - -def escape_md_cell(text: str) -> str: - return text.replace("|", r"\|").replace("\n", "
") +from x2mdx.reference_pages import ( + ReferenceBadge, + ReferenceBreadcrumb, + ReferenceCard, + ReferenceChange, + ReferenceCollectionPage, + ReferenceExample, + ReferenceMetaItem, + ReferenceOperationPage, + ReferencePanel, + ReferenceSection, + compact_text, + markdown_page_from_template, + relative_page_ref, + render_collection_page, + render_operation_page, + safe_markdown_text, + schema_from_sample, +) def slugify(value: str) -> str: @@ -23,104 +36,284 @@ def slugify(value: str) -> str: return output -def md_code(text: Any) -> str: - output = str(text).replace("`", "\\`").replace("|", "\\|").replace("\n", " ").strip() - return f"`{output}`" +def channel_page_path(output_dir: Path, channel: AsyncApiChannelLifecycle) -> Path: + return output_dir / "channels" / f"{slugify(channel.channel)}.mdx" -def channel_anchor(channel: str) -> str: - return f"channel-{slugify(channel)}" +def operation_page_path(output_dir: Path, channel: AsyncApiChannelLifecycle, action_name: str) -> Path: + return output_dir / "operations" / slugify(channel.channel) / f"{slugify(action_name)}.mdx" -def channel_link(channel: str) -> str: - escaped = html.escape(channel, quote=False) - return f"[`{escaped}`](#{channel_anchor(channel)})" +def page_ref(from_path: Path, to_path: Path) -> str: + return relative_page_ref(from_path, to_path) -def render_change_summary(change_details: list[dict[str, object]]) -> str: - parts: list[str] = [] - for entry in change_details: - version = str(entry["version"]) - changes = entry["changes"] if isinstance(entry.get("changes"), list) else [] - rendered_changes = "; ".join(str(change) for change in changes) if changes else "details updated" - parts.append(f"`{version}`: {rendered_changes}") - return "
".join(parts) if parts else "-" +def lifecycle_badges(channel: AsyncApiChannelLifecycle) -> list[ReferenceBadge]: + badges = [ReferenceBadge("WebSocket", tone="protocol"), ReferenceBadge(f"Since {channel.introduced_version}", tone="added")] + if channel.changed_in_versions: + badges.append(ReferenceBadge(f"Changed {channel.changed_in_versions[-1]}", tone="changed")) + if channel.removed_version: + badges.append(ReferenceBadge(f"Removed {channel.removed_version}", tone="removed")) + return badges -def action_list(channel: AsyncApiChannelLifecycle) -> str: - actions = channel.latest.get("action_names", []) - if not actions: - return "-" - return ", ".join(md_code(action) for action in actions) +def channel_summary(channel: AsyncApiChannelLifecycle) -> str: + description = str(channel.latest.get("description") or "").strip() + if description: + return compact_text(description, limit=180) + action_names = list(channel.latest.get("action_names") or []) + if action_names: + return ", ".join(action_names) + return "AsyncAPI channel" -def compact_text(text: str, *, limit: int = 120) -> str: - normalized = " ".join(text.split()) - if not normalized: - return "-" - if len(normalized) <= limit: - return normalized - return normalized[: limit - 3].rstrip() + "..." +def channel_short_label(channel_name: str) -> str: + parts = [part for part in channel_name.strip("/").split("/") if part] + label = parts[-1] if parts else channel_name.strip("/") or channel_name + return label.replace("-", " ").replace("_", " ") -def _channel_context(channel: AsyncApiChannelLifecycle) -> dict[str, Any]: - lifecycle_bits = [ - f"Actions: {action_list(channel)}", - f"Introduced: `{channel.introduced_version}`", - ] - if channel.change_details: - lifecycle_bits.append("Changed in: " + ", ".join(f"`{entry['version']}`" for entry in channel.change_details)) - if channel.removed_version: - lifecycle_bits.append(f"Removed in: `{channel.removed_version}`") - lifecycle_bits.append("Shown for historical reference.") - - return { - "anchor": channel.anchor, - "name": channel.channel, - "lifecycle_bits": lifecycle_bits, - "description": str(channel.latest.get("description") or ""), - "change_rows": [ +def action_display_title(channel: AsyncApiChannelLifecycle, action_name: str) -> str: + return f"{action_name.title()} {channel_short_label(channel.channel)}" + + +def action_schema(action: dict[str, Any], *, anchor: str): + message = dict(action.get("message") or {}) + sample = message.get("sample") + required_fields = list(message.get("required_fields") or []) + if sample is None and not required_fields: + return None + return schema_from_sample( + name=str(message.get("name") or action["action"]), + sample=sample, + required_fields=required_fields, + summary=str(message.get("payload_schema") or "-"), + description=str(action.get("description") or ""), + anchor=anchor, + ) + + +def wscat_example(action: dict[str, Any]) -> str: + sample = action["message"].get("sample") + if action["action"] == "publish" and sample is not None: + return "\n".join( [ - md_code(str(entry["version"])), - escape_md_cell("; ".join(str(change) for change in entry["changes"])), + "npx wscat \\", + " -c \\", + f" -x '{json.dumps(sample, ensure_ascii=False)}' \\", + " -w -1", ] - for entry in channel.change_details - ], - "actions": [ - { - "heading": str(action["action"]).capitalize(), - "detail_items": [ - item - for item in [ - f"Operation ID: `{action['operation_id']}`" if action["operation_id"] else "", - f"WebSocket method: `{action['ws_method']}`" if action["ws_method"] else "", - ( - f"Message: `{action['message']['name']}`" - if action["message"]["name"] and action["message"]["name"] != "-" - else "" - ), - ( - f"Content type: `{action['message']['content_type']}`" - if action["message"]["content_type"] and action["message"]["content_type"] != "-" - else "" - ), - ] - if item + ) + return "npx wscat -c " + + +def build_action_operation( + channel: AsyncApiChannelLifecycle, + action: dict[str, Any], + *, + output_dir: Path | None, +) -> ReferenceOperationPage: + is_publish = action["action"] == "publish" + schema = action_schema(action, anchor=f"schema-{slugify(channel.channel)}-{slugify(action['action'])}") + examples = [ReferenceExample(title="wscat", body=wscat_example(action), language="bash")] + if action["message"].get("sample") is not None: + examples.append( + ReferenceExample( + title="message", + body=json.dumps(action["message"]["sample"], indent=2, ensure_ascii=False), + kind="response", + media_type=str(action["message"].get("content_type") or "application/json"), + ) + ) + + path = operation_page_path(output_dir, channel, action["action"]) if output_dir is not None else Path("unused.mdx") + channel_path = channel_page_path(output_dir, channel) if output_dir is not None else Path("unused.mdx") + inputs = [] + outputs = [] + if is_publish: + inputs.append( + ReferencePanel( + title=str(action["message"].get("name") or "Message payload"), + meta_items=[ + ReferenceMetaItem("Direction", "Client -> Server"), + ReferenceMetaItem("Message", str(action["message"].get("name") or "-")), ], - "description": action["description"], - "payload_row": [ - md_code(action["message"]["payload_schema"]), - ( - ", ".join(md_code(field) for field in action["message"]["required_fields"]) - if action["message"]["required_fields"] - else "-" - ), + schema=schema, + ) + ) + else: + outputs.append( + ReferencePanel( + title=str(action["message"].get("name") or "Message payload"), + meta_items=[ + ReferenceMetaItem("Direction", "Server -> Client"), + ReferenceMetaItem("Message", str(action["message"].get("name") or "-")), ], - "sample": action["message"]["sample"], - } - for action in channel.latest.get("actions", []) + schema=schema, + ) + ) + + return ReferenceOperationPage( + path=path.relative_to(output_dir).as_posix() if output_dir is not None else "single-page", + anchor=f"operation-{slugify(channel.channel)}-{slugify(action['action'])}", + title=action_display_title(channel, str(action["action"])), + description=None, + eyebrow=str(channel.channel), + summary=None, + back_link=page_ref(path, channel_path) if output_dir is not None else None, + back_label="Back to channel", + breadcrumbs=[ + ReferenceBreadcrumb("JSON API AsyncAPI", page_ref(path, output_dir / "index.mdx") if output_dir is not None else None), + ReferenceBreadcrumb(channel.channel, page_ref(path, channel_path) if output_dir is not None else None), + ReferenceBreadcrumb(str(action["action"])), + ] + if output_dir is not None + else [], + badges=lifecycle_badges(channel), + meta_items=[ + ReferenceMetaItem("Channel", channel.channel), + ReferenceMetaItem("Action", str(action["action"])), + ReferenceMetaItem("Introduced", channel.introduced_version), + ReferenceMetaItem("Removed", channel.removed_version or "-"), ], - } + operation_method=str(action["action"]).upper(), + operation_target=channel.channel, + overview_markdown=None, + protocol_items=[ + ReferenceMetaItem("Protocol", "WebSocket"), + ReferenceMetaItem("Channel", channel.channel), + ReferenceMetaItem("Action", str(action["action"])), + ReferenceMetaItem("Operation ID", str(action.get("operation_id") or "-")), + ReferenceMetaItem("Content type", str(action["message"].get("content_type") or "-")), + ReferenceMetaItem("Payload", str(action["message"].get("payload_schema") or "-")), + ], + inputs=inputs, + outputs=outputs, + examples=examples, + lifecycle_changes=[ + ReferenceChange(version=str(entry["version"]), details="; ".join(str(change) for change in entry["changes"])) + for entry in channel.change_details + ], + related_schemas=[schema] if schema is not None else [], + ) + + +def build_overview_page( + report: AsyncApiReport, + *, + output_dir: Path, + overview_name: str, + page_title: str, + page_description: str, +) -> ReferenceCollectionPage: + overview_path = output_dir / overview_name + cards = [ + ReferenceCard( + title=channel.channel, + href=page_ref(overview_path, channel_page_path(output_dir, channel)), + summary=channel_summary(channel), + badges=lifecycle_badges(channel), + meta_items=[ + ReferenceMetaItem("Actions", ", ".join(channel.latest.get("action_names") or []) or "-"), + ReferenceMetaItem("Last seen", channel.last_seen_in), + ], + ) + for channel in report.channels + ] + return ReferenceCollectionPage( + path=overview_name, + title=page_title, + description=page_description, + eyebrow="AsyncAPI Reference", + summary="Operation-first WebSocket reference pages built from AsyncAPI channel snapshots and lifecycle deltas.", + badges=[ReferenceBadge("AsyncAPI", tone="protocol"), ReferenceBadge(report.publish_version, tone="neutral")], + meta_items=[ + ReferenceMetaItem("Publish version", report.publish_version), + ReferenceMetaItem("AsyncAPI version", report.asyncapi_version or "-"), + ReferenceMetaItem("Source", report.source_name), + ReferenceMetaItem("Version filter", report.version_filter), + ], + sections=[ + ReferenceSection( + heading="Channels", + body_markdown=safe_markdown_text("Use the channel page to choose a specific `publish` or `subscribe` action. Action pages are the primary reference surface."), + cards=cards, + ) + ], + ) + + +def build_channel_page( + channel: AsyncApiChannelLifecycle, + *, + output_dir: Path, + overview_name: str, +) -> ReferenceCollectionPage: + page_path = channel_page_path(output_dir, channel) + overview_path = output_dir / overview_name + cards = [ + ReferenceCard( + title=f"{action['action']} {channel.channel}", + href=page_ref(page_path, operation_page_path(output_dir, channel, action["action"])), + summary=compact_text(action.get("description") or channel.latest.get("description") or "", limit=170), + badges=lifecycle_badges(channel), + meta_items=[ + ReferenceMetaItem("Operation ID", str(action.get("operation_id") or "-")), + ReferenceMetaItem("Method", str(action.get("ws_method") or "-")), + ReferenceMetaItem("Payload", str(action["message"].get("payload_schema") or "-")), + ], + ) + for action in channel.latest.get("actions", []) + ] + return ReferenceCollectionPage( + path=page_path.relative_to(output_dir).as_posix(), + title=channel.channel, + description=str(channel.latest.get("description") or "AsyncAPI channel overview."), + eyebrow="AsyncAPI Channel", + summary=channel_summary(channel), + back_link=page_ref(page_path, overview_path), + back_label="Back to overview", + badges=lifecycle_badges(channel), + meta_items=[ + ReferenceMetaItem("Channel", channel.channel), + ReferenceMetaItem("Actions", ", ".join(channel.latest.get("action_names") or []) or "-"), + ReferenceMetaItem("Introduced", channel.introduced_version), + ReferenceMetaItem("Removed", channel.removed_version or "-"), + ], + sections=[ + ReferenceSection( + heading="Actions", + body_markdown=safe_markdown_text(channel.latest.get("description") or "") or None, + cards=cards, + ) + ], + ) + + +def build_pages( + report: AsyncApiReport, + *, + output_dir: Path, + overview_name: str = "index.mdx", + page_title: str = "AsyncAPI WebSocket Reference", + page_description: str = "WebSocket AsyncAPI reference and version history.", +) -> tuple[Path, list[Any]]: + pages = [ + render_collection_page( + build_overview_page( + report, + output_dir=output_dir, + overview_name=overview_name, + page_title=page_title, + page_description=page_description, + ) + ) + ] + for channel in report.channels: + pages.append(render_collection_page(build_channel_page(channel, output_dir=output_dir, overview_name=overview_name))) + for action in channel.latest.get("actions", []): + pages.append(render_operation_page(build_action_operation(channel, action, output_dir=output_dir))) + return output_dir, pages def build_page( @@ -129,33 +322,50 @@ def build_page( output_path: str, page_title: str, page_description: str, -) -> Page: - return markdown_page( +): + header = ReferenceCollectionPage( path=Path(output_path).as_posix(), title=page_title, description=page_description, - template_name="asyncapi/page.md.j2", - report=report, - version_timeline_rows=[ - [ - md_code(version), - str(report.per_version_deltas[version]["added_count"]), - str(report.per_version_deltas[version]["changed_count"]), - str(report.per_version_deltas[version]["removed_count"]), - ] - for version in report.versions - ], - channel_summary_rows=[ - [ - channel_link(channel.channel), - action_list(channel), - escape_md_cell(compact_text(str(channel.latest.get("description") or ""))), - md_code(channel.introduced_version), - escape_md_cell(render_change_summary(channel.change_details)), - "-", - md_code(channel.removed_version) if channel.removed_version else "-", - ] - for channel in report.channels + eyebrow="AsyncAPI Reference", + summary="Single-page compatibility view for the new operation-first AsyncAPI renderer.", + badges=[ReferenceBadge("AsyncAPI", tone="protocol"), ReferenceBadge(report.publish_version, tone="neutral")], + meta_items=[ + ReferenceMetaItem("Publish version", report.publish_version), + ReferenceMetaItem("AsyncAPI version", report.asyncapi_version or "-"), + ReferenceMetaItem("Source", report.source_name), + ReferenceMetaItem("Version filter", report.version_filter), ], - channels=[_channel_context(channel) for channel in report.channels], + ) + channels = [] + for channel in report.channels: + operations = [build_action_operation(channel, action, output_dir=None) for action in channel.latest.get("actions", [])] + cards = [ + ReferenceCard( + title=operation.title, + href=f"#{operation.anchor}", + summary=operation.summary or "", + badges=operation.badges, + meta_items=[ + ReferenceMetaItem("Action", next((item.value for item in operation.protocol_items if item.label == "Action"), "-")), + ReferenceMetaItem("Payload", next((item.value for item in operation.protocol_items if item.label == "Payload"), "-")), + ], + ) + for operation in operations + ] + channels.append( + { + "heading": channel.channel, + "body_markdown": str(channel.latest.get("description") or "") or None, + "cards": cards, + "operations": operations, + } + ) + return markdown_page_from_template( + path=Path(output_path).as_posix(), + title=page_title, + description=page_description, + template_name="asyncapi/single_page.md.j2", + page=header, + channels=channels, ) diff --git a/src/x2mdx/cli.py b/src/x2mdx/cli.py index 0a883c0..81faa43 100644 --- a/src/x2mdx/cli.py +++ b/src/x2mdx/cli.py @@ -345,11 +345,19 @@ def build_parser() -> argparse.ArgumentParser: required=True, help="Path to a JSON/YAML manifest that lists local AsyncAPI snapshots", ) + build_asyncapi.add_argument( + "--output-dir", + help="Directory where generated MDX pages should be written", + ) build_asyncapi.add_argument( "--output-file", - required=True, help="Exact MDX file path to write for the generated AsyncAPI page", ) + build_asyncapi.add_argument( + "--overview-name", + default="index.mdx", + help="Filename for the overview page inside the output directory.", + ) build_asyncapi.add_argument( "--fixture-root", help="Directory to resolve manifest files from; defaults to the manifest directory", @@ -561,24 +569,42 @@ def main(argv: Sequence[str] | None = None) -> int: if args.command == "asyncapi": if args.asyncapi_command == "build-api-pages-from-manifest": - from x2mdx.asyncapi.render import build_page + from x2mdx.asyncapi.render import build_page, build_pages from x2mdx.mintlify import MintlifyNavTarget, update_docs_json_navigation - from x2mdx.render import write_page + from x2mdx.render import write_page, write_pages if (args.nav_dropdown or args.nav_version or args.nav_group) and not args.docs_json: parser.error("--nav-dropdown/--nav-version/--nav-group require --docs-json") if args.docs_json and not args.nav_dropdown: parser.error("--docs-json requires --nav-dropdown") + if not args.output_dir and not args.output_file: + parser.error("build-api-pages-from-manifest requires --output-dir or --output-file") + if args.output_dir and args.output_file: + parser.error("build-api-pages-from-manifest accepts only one of --output-dir or --output-file") report = build_asyncapi_report_from_manifest_args(args) - output_file = Path(args.output_file) - page = build_page( - report, - output_path=output_file.name, - page_title=args.page_title, - page_description=args.page_description, - ) - write_page(page, output_file) + if args.output_file: + output_file = Path(args.output_file) + page = build_page( + report, + output_path=output_file.name, + page_title=args.page_title, + page_description=args.page_description, + ) + write_page(page, output_file) + else: + output_dir = Path(args.output_dir) + if output_dir.exists(): + shutil.rmtree(output_dir) + output_root, pages = build_pages( + report, + output_dir=output_dir, + overview_name=args.overview_name, + page_title=args.page_title, + page_description=args.page_description, + ) + write_pages(pages, output_root) + output_file = output_dir / args.overview_name if args.docs_json: update_docs_json_navigation( Path(args.docs_json), diff --git a/src/x2mdx/openrpc/render.py b/src/x2mdx/openrpc/render.py index 4e3a86a..01fba48 100644 --- a/src/x2mdx/openrpc/render.py +++ b/src/x2mdx/openrpc/render.py @@ -1,14 +1,33 @@ -"""Render OpenRPC reports into overview and per-spec MDX pages.""" +"""Render OpenRPC reports into Mintlify-like overview, supporting, and operation pages.""" from __future__ import annotations +import json import re from pathlib import Path from typing import Any from x2mdx.openrpc.models import OpenRpcMethodLifecycle, OpenRpcReport, OpenRpcSpecLifecycle -from x2mdx.output import Page -from x2mdx.templating import markdown_page, render_status_cell, render_status_legend +from x2mdx.reference_pages import ( + ReferenceBadge, + ReferenceBreadcrumb, + ReferenceCard, + ReferenceChange, + ReferenceCollectionPage, + ReferenceExample, + ReferenceMetaItem, + ReferenceOperationPage, + ReferencePanel, + ReferenceSchema, + ReferenceSection, + compact_text, + relative_page_ref, + render_collection_page, + render_operation_page, + rooted_page_ref, + safe_markdown_text, + schema_from_sample, +) def slugify(value: str) -> str: @@ -18,21 +37,12 @@ def slugify(value: str) -> str: return output -def escape_md_cell(text: str) -> str: - return str(text).replace("|", r"\|").replace("\n", "
") +def spec_page_path(output_dir: Path, spec: OpenRpcSpecLifecycle, *, spec_dir_name: str) -> Path: + return output_dir / spec_dir_name / f"{slugify(spec.spec_id)}.mdx" -def md_code(text: Any) -> str: - output = str(text).replace("`", "\\`").replace("|", "\\|").replace("\n", " ").strip() - return f"`{output}`" - - -def spec_page_name(spec: OpenRpcSpecLifecycle) -> str: - return f"{slugify(spec.spec_id)}.mdx" - - -def spec_page_link(spec: OpenRpcSpecLifecycle, *, spec_dir_name: str) -> str: - return f"{spec_dir_name}/{Path(spec_page_name(spec)).with_suffix('').as_posix()}" +def operation_page_path(output_dir: Path, spec: OpenRpcSpecLifecycle, method: OpenRpcMethodLifecycle) -> Path: + return output_dir / "operations" / slugify(spec.spec_id) / f"{slugify(method.method)}.mdx" def normalize_link_prefix(link_prefix: str) -> str: @@ -41,162 +51,304 @@ def normalize_link_prefix(link_prefix: str) -> str: raise ValueError("link_prefix must not be empty") if trimmed == "/": return "" - return "/" + trimmed.strip("/") + return trimmed.strip("/") + + +def page_ref(from_path: Path, to_path: Path, *, output_dir: Path, link_prefix: str | None) -> str: + if link_prefix is not None: + return rooted_page_ref(link_prefix, to_path, output_dir) + return relative_page_ref(from_path, to_path) + + +def lifecycle_badges( + *, + protocol_label: str, + introduced: str, + changed: list[str] | None = None, + removed: str | None = None, +) -> list[ReferenceBadge]: + badges = [ReferenceBadge(protocol_label, tone="protocol"), ReferenceBadge(f"Since {introduced}", tone="added")] + if changed: + badges.append(ReferenceBadge(f"Changed {changed[-1]}", tone="changed")) + if removed: + badges.append(ReferenceBadge(f"Removed {removed}", tone="removed")) + return badges -def spec_summary_text(spec: OpenRpcSpecLifecycle) -> str: - parts: list[str] = [] +def info_summary(spec: OpenRpcSpecLifecycle) -> str: + if spec.info_description: + return compact_text(spec.info_description, limit=200) if spec.info_title and spec.info_title != spec.display_name: - parts.append(str(spec.info_title)) - parts.append(f"{len(spec.methods)} methods") - return escape_md_cell(". ".join(parts)) + return spec.info_title + return f"{len(spec.methods)} methods" -def method_summary_text(method: OpenRpcMethodLifecycle) -> str: - summary = str(method.latest.get("summary") or "").strip() - if summary: - return escape_md_cell(summary) - description = str(method.latest.get("description") or "").strip() - if description: - return escape_md_cell(description) - return "-" +def schema_meta_items(schema_name: str | None, schema_brief: str, required_fields: list[str]) -> list[ReferenceMetaItem]: + items = [ReferenceMetaItem("Shape", schema_brief)] + if schema_name: + items.append(ReferenceMetaItem("Schema", schema_name)) + if required_fields: + items.append(ReferenceMetaItem("Required", ", ".join(required_fields))) + return items + + +def schema_for_detail(name: str, detail: dict[str, Any], *, anchor: str) -> ReferenceSchema | None: + sample = detail.get("sample") + if sample is None and not detail.get("required_fields"): + return None + return schema_from_sample( + name=name, + sample=sample, + required_fields=list(detail.get("required_fields") or []), + summary=str(detail.get("schema") or "-"), + description=str(detail.get("description") or ""), + anchor=anchor, + ) + + +def json_rpc_request_body(method_name: str, request_payload: dict[str, Any]) -> dict[str, Any]: + body: dict[str, Any] = { + "jsonrpc": "2.0", + "id": 1, + "method": method_name, + } + if request_payload: + body["params"] = request_payload + return body + + +def curl_example(request_body: dict[str, Any]) -> str: + return "\n".join( + [ + "curl \\", + " \\", + " -H 'content-type: application/json' \\", + " --data @- <<'EOF'", + json.dumps(request_body, indent=2, ensure_ascii=False), + "EOF", + ] + ) def build_overview_page( report: OpenRpcReport, *, + output_dir: Path, overview_name: str, - spec_dir_name: str, overview_title: str, + spec_dir_name: str, link_prefix: str | None = None, -) -> Page: - normalized_link_prefix = normalize_link_prefix(link_prefix) if link_prefix else None - return markdown_page( - path=overview_name, - title=overview_title, - description="Versioned OpenRPC reference docs.", - template_name="openrpc/overview.md.j2", - overview_title=overview_title, - overview_items=[ - f"Publish version: `{report.publish_version}`", - f"Versions compared: {', '.join(f'`{version}`' for version in report.versions)}", - f"Source: `{report.source_name}`", - f"Version filter: `{report.version_filter}`", - ], - spec_summary_legend=render_status_legend(include_deprecated=False), - spec_rows=[ - [ - f"[`{escape_md_cell(spec.display_name)}`](" - + ( - f"{normalized_link_prefix}/{spec_page_link(spec, spec_dir_name=spec_dir_name)}" - if normalized_link_prefix - else spec_page_link(spec, spec_dir_name=spec_dir_name) - ) - + ")", - render_status_cell( +) -> ReferenceCollectionPage: + overview_path = output_dir / overview_name + cards = [] + for spec in report.specs: + spec_path = spec_page_path(output_dir, spec, spec_dir_name=spec_dir_name) + cards.append( + ReferenceCard( + title=spec.display_name, + href=page_ref(overview_path, spec_path, output_dir=output_dir, link_prefix=link_prefix), + summary=info_summary(spec), + badges=lifecycle_badges( + protocol_label="JSON-RPC", introduced=spec.introduced_version, changed=spec.changed_in_versions, removed=spec.removed_version, ), - spec_summary_text(spec), - ] - for spec in report.specs + meta_items=[ + ReferenceMetaItem("Methods", str(len(spec.methods))), + ReferenceMetaItem("Latest version", spec.latest_version), + ReferenceMetaItem("OpenRPC", spec.openrpc_version or "-"), + ], + ) + ) + return ReferenceCollectionPage( + path=overview_name, + title=overview_title, + description="Versioned OpenRPC reference docs.", + eyebrow="OpenRPC Reference", + summary="Operation-first JSON-RPC reference pages with version history carried from the snapshot lifecycle report.", + badges=[ReferenceBadge("OpenRPC", tone="protocol"), ReferenceBadge(report.publish_version, tone="neutral")], + meta_items=[ + ReferenceMetaItem("Publish version", report.publish_version), + ReferenceMetaItem("Versions compared", ", ".join(report.versions)), + ReferenceMetaItem("Source", report.source_name), + ReferenceMetaItem("Version filter", report.version_filter), + ], + sections=[ + ReferenceSection( + heading="Specs", + body_markdown=safe_markdown_text("Choose a spec page to browse its methods, then drill into operation pages for request/response details."), + cards=cards, + ) ], ) -def _method_context(method: OpenRpcMethodLifecycle) -> dict[str, Any]: - latest = method.latest - lifecycle_lines = [f"- Introduced: `{method.introduced_version}`"] - if method.change_details: - lifecycle_lines.append("Changed in: " + ", ".join(md_code(entry["version"]) for entry in method.change_details)) - if method.removed_version: - lifecycle_lines.append(f"Removed in: `{method.removed_version}`") - lifecycle_lines.append("Shown for historical reference.") - - param_samples = {param["name"]: param["sample"] for param in latest["params"] if param["sample"] is not None} - return { - "anchor": method.anchor, - "heading_text": md_code(method.method), - "lifecycle_text": "\n".join(lifecycle_lines), - "summary": latest["summary"], - "description": latest["description"], - "change_rows": [ - [ - md_code(entry["version"]), - escape_md_cell("; ".join(str(change) for change in entry["changes"])), - ] - for entry in method.change_details - ], - "parameter_rows": [ - [ - md_code(param["name"]), - md_code(param["schema"]), - ", ".join(md_code(field) for field in param["required_fields"]) if param["required_fields"] else "-", - escape_md_cell(param["description"]) if param["description"] else "-", - ] - for param in latest["params"] +def build_spec_page( + spec: OpenRpcSpecLifecycle, + *, + output_dir: Path, + overview_name: str, + spec_dir_name: str, + link_prefix: str | None = None, +) -> ReferenceCollectionPage: + spec_path = spec_page_path(output_dir, spec, spec_dir_name=spec_dir_name) + overview_path = output_dir / overview_name + method_cards = [ + ReferenceCard( + title=method.method, + href=page_ref(spec_path, operation_page_path(output_dir, spec, method), output_dir=output_dir, link_prefix=link_prefix), + summary=compact_text(method.latest.get("summary") or method.latest.get("description") or "", limit=170), + badges=lifecycle_badges( + protocol_label="JSON-RPC", + introduced=method.introduced_version, + changed=method.changed_in_versions, + removed=method.removed_version, + ), + meta_items=[ + ReferenceMetaItem("Parameters", str(len(method.latest.get("params", [])))), + ReferenceMetaItem("Result", str(method.latest.get("result", {}).get("schema") or "-")), + ], + ) + for method in spec.methods + ] + + return ReferenceCollectionPage( + path=spec_path.relative_to(output_dir).as_posix(), + title=spec.display_name, + description=spec.info_description or "OpenRPC supporting overview.", + eyebrow="OpenRPC Spec", + summary=spec.info_description or info_summary(spec), + back_link=page_ref(spec_path, overview_path, output_dir=output_dir, link_prefix=link_prefix), + back_label="Back to overview", + badges=lifecycle_badges( + protocol_label="JSON-RPC", + introduced=spec.introduced_version, + changed=spec.changed_in_versions, + removed=spec.removed_version, + ), + meta_items=[ + ReferenceMetaItem("Latest source path", spec.latest_source_path), + ReferenceMetaItem("Publish version", spec.latest_version), + ReferenceMetaItem("OpenRPC version", spec.openrpc_version or "-"), + ReferenceMetaItem("Spec info.version", spec.info_version or "-"), ], - "result_row": [ - md_code(latest["result"]["schema"]), - ", ".join(md_code(field) for field in latest["result"]["required_fields"]) - if latest["result"]["required_fields"] - else "-", - escape_md_cell(latest["result"]["description"]) if latest["result"]["description"] else "-", + sections=[ + ReferenceSection( + heading="Methods", + body_markdown=safe_markdown_text("Method pages are the primary reference surface. This spec page stays focused on grouping and discovery."), + cards=method_cards, + ) ], - "param_sample": param_samples or None, - "result_sample": latest["result"]["sample"], - } + ) -def build_spec_page( +def build_method_page( spec: OpenRpcSpecLifecycle, + method: OpenRpcMethodLifecycle, *, - overview_name: str, + output_dir: Path, spec_dir_name: str, link_prefix: str | None = None, -) -> Page: - normalized_link_prefix = normalize_link_prefix(link_prefix) if link_prefix else None - overview_link = f"../{Path(overview_name).with_suffix('').as_posix()}" - if normalized_link_prefix is not None: - overview_link = normalized_link_prefix or "/" - return markdown_page( - path=f"{spec_dir_name}/{Path(spec_page_name(spec)).as_posix()}", - title=spec.display_name, - description=spec.info_title or "OpenRPC reference page.", - template_name="openrpc/spec.md.j2", - spec=spec, - overview_link=overview_link, - metadata_items=[ - f"Latest source path: `{spec.latest_source_path}`", - f"Publish version: `{spec.latest_version}`", - f"OpenRPC version: `{spec.openrpc_version or '-'}`", - f"Spec info.version: `{spec.info_version or '-'}`", +) -> ReferenceOperationPage: + page_path = operation_page_path(output_dir, spec, method) + spec_path = spec_page_path(output_dir, spec, spec_dir_name=spec_dir_name) + params = list(method.latest.get("params") or []) + result = dict(method.latest.get("result") or {}) + + param_panels = [] + related_schemas = [] + request_payload: dict[str, Any] = {} + for index, param in enumerate(params): + schema_anchor = f"schema-param-{slugify(method.method)}-{index}" + schema = schema_for_detail(param.get("schema_name") or param.get("name") or f"param-{index + 1}", param, anchor=schema_anchor) + if schema is not None: + related_schemas.append(schema) + if param.get("sample") is not None: + request_payload[str(param.get("name") or f"param{index + 1}")] = param["sample"] + param_panels.append( + ReferencePanel( + title=str(param.get("name") or f"param-{index + 1}"), + meta_items=schema_meta_items( + str(param.get("schema_name") or "") or None, + str(param.get("schema") or "-"), + list(param.get("required_fields") or []), + ), + schema=schema, + ) + ) + + result_schema = schema_for_detail(result.get("schema_name") or result.get("name") or "result", result, anchor=f"schema-result-{slugify(method.method)}") + if result_schema is not None: + related_schemas.append(result_schema) + + request_body = json_rpc_request_body(method.method, request_payload) + examples = [] + examples.append(ReferenceExample(title="cURL", body=curl_example(request_body), language="bash")) + if result.get("sample") is not None: + examples.append( + ReferenceExample( + title="Result", + body=json.dumps(result["sample"], indent=2, ensure_ascii=False), + kind="response", + media_type="application/json", + ) + ) + + overview_parts = [part for part in [method.latest.get("summary"), method.latest.get("description")] if part] + return ReferenceOperationPage( + path=page_path.relative_to(output_dir).as_posix(), + title=method.method, + description=None, + eyebrow=spec.display_name, + summary=None, + back_link=page_ref(page_path, spec_path, output_dir=output_dir, link_prefix=link_prefix), + back_label="Back to spec", + breadcrumbs=[ + ReferenceBreadcrumb("Wallet Gateway JSON-RPC"), + ReferenceBreadcrumb(spec.display_name, page_ref(page_path, spec_path, output_dir=output_dir, link_prefix=link_prefix)), + ReferenceBreadcrumb(method.method), + ], + badges=lifecycle_badges( + protocol_label="JSON-RPC", + introduced=method.introduced_version, + changed=method.changed_in_versions, + removed=method.removed_version, + ), + meta_items=[ + ReferenceMetaItem("Spec", spec.display_name), + ReferenceMetaItem("Introduced", method.introduced_version), + ReferenceMetaItem("Last seen", method.last_seen_in), + ReferenceMetaItem("Removed", method.removed_version or "-"), ], - version_timeline_rows=[ - [ - md_code(version), - str(spec.per_version_method_deltas[version]["active_count"]), - str(spec.per_version_method_deltas[version]["added_count"]), - str(spec.per_version_method_deltas[version]["changed_count"]), - str(spec.per_version_method_deltas[version]["removed_count"]), - ] - for version in spec.versions_present + operation_method="POST", + operation_target=f"JSON-RPC {method.method}", + overview_markdown=None, + protocol_items=[ + ReferenceMetaItem("Protocol", "JSON-RPC"), + ReferenceMetaItem("Transport", "HTTP POST"), + ReferenceMetaItem("Method", method.method), + ReferenceMetaItem("Parameters", str(len(params))), + ReferenceMetaItem("Result", str(result.get("schema") or "-")), ], - method_summary_legend=render_status_legend(include_deprecated=False), - method_summary_rows=[ - [ - f"[{md_code(method.method)}](#{method.anchor})", - render_status_cell( - introduced=method.introduced_version, - changed=[entry["version"] for entry in method.change_details], - removed=method.removed_version, + inputs=param_panels, + outputs=[ + ReferencePanel( + title=result.get("name") or "result", + meta_items=schema_meta_items( + str(result.get("schema_name") or "") or None, + str(result.get("schema") or "-"), + list(result.get("required_fields") or []), ), - method_summary_text(method), - ] - for method in spec.methods + schema=result_schema, + ) + ], + examples=examples, + lifecycle_changes=[ + ReferenceChange(version=str(entry["version"]), details="; ".join(str(change) for change in entry["changes"])) + for entry in method.change_details ], - methods=[_method_context(method) for method in spec.methods], + related_schemas=related_schemas, ) @@ -208,23 +360,42 @@ def build_pages( spec_dir_name: str = "specs", overview_title: str = "Wallet Gateway OpenRPC", link_prefix: str | None = None, -) -> tuple[Path, list[Page]]: +) -> tuple[Path, list[Any]]: + normalized_link_prefix = normalize_link_prefix(link_prefix) if link_prefix else None pages = [ - build_overview_page( - report, - overview_name=overview_name, - spec_dir_name=spec_dir_name, - overview_title=overview_title, - link_prefix=link_prefix, + render_collection_page( + build_overview_page( + report, + output_dir=output_dir, + overview_name=overview_name, + overview_title=overview_title, + spec_dir_name=spec_dir_name, + link_prefix=normalized_link_prefix, + ) ) ] - pages.extend( - build_spec_page( - spec, - overview_name=overview_name, - spec_dir_name=spec_dir_name, - link_prefix=link_prefix, + for spec in report.specs: + pages.append( + render_collection_page( + build_spec_page( + spec, + output_dir=output_dir, + overview_name=overview_name, + spec_dir_name=spec_dir_name, + link_prefix=normalized_link_prefix, + ) + ) ) - for spec in report.specs - ) + for method in spec.methods: + pages.append( + render_operation_page( + build_method_page( + spec, + method, + output_dir=output_dir, + spec_dir_name=spec_dir_name, + link_prefix=normalized_link_prefix, + ) + ) + ) return output_dir, pages diff --git a/src/x2mdx/protobuf/render.py b/src/x2mdx/protobuf/render.py index ed3e748..77984c4 100644 --- a/src/x2mdx/protobuf/render.py +++ b/src/x2mdx/protobuf/render.py @@ -1,15 +1,33 @@ -"""Render descriptor-backed protobuf history reports into grouped MDX pages.""" +"""Render descriptor-backed protobuf reports into Mintlify-like collection and operation pages.""" from __future__ import annotations -import os +import json import re from collections import defaultdict from pathlib import Path from typing import Any -from x2mdx.output import Page -from x2mdx.templating import markdown_page, render_status_cell, render_status_legend +from x2mdx.reference_pages import ( + ReferenceBadge, + ReferenceBreadcrumb, + ReferenceCard, + ReferenceChange, + ReferenceCollectionPage, + ReferenceExample, + ReferenceField, + ReferenceMetaItem, + ReferenceOperationPage, + ReferencePanel, + ReferenceSchema, + ReferenceSection, + compact_text, + relative_page_ref, + render_collection_page, + render_operation_page, + safe_markdown_text, +) + PACKAGE_GROUP_ORDER = [ "Ledger API", @@ -21,71 +39,9 @@ "Schema Packages", ] - -def escape_text(text: str) -> str: - return text.replace("&", "&").replace("<", "<").replace(">", ">") - - -def escape_md(text: str) -> str: - return text.replace("|", r"\|") - - -def escape_md_cell(text: str) -> str: - return escape_text(escape_md(text)).replace("\n", "
") - - -def md_link(label: str, url: str | None) -> str: - return f"[{label}]({url})" if url else label - - -def render_description(text: str) -> str: - return escape_text(text.strip()) if text.strip() else "_No description._" - - -def compact_text(text: str, *, limit: int = 120) -> str: - normalized = " ".join(text.split()) - if len(normalized) <= limit: - return normalized - return normalized[: limit - 3].rstrip() + "..." - - -def compact_package_summary(package: dict[str, Any]) -> str: - parts = [ - f"{package['serviceCount']} services", - f"{package['endpointCount']} endpoints", - f"{package['messageCount']} messages", - ] - if package["enumCount"]: - parts.append(f"{package['enumCount']} enums") - return escape_md_cell(", ".join(parts)) - - -def change_versions_for_package( - package_name: str, - endpoint_lifecycle: list[dict[str, Any]], - *, - version_order: dict[str, int], -) -> list[str]: - versions = { - str(event["version"]) - for entry in endpoint_lifecycle - if entry["package"] == package_name - for event in entry.get("history", []) - if event.get("kind") == "modified" - } - return sorted(versions, key=lambda version: version_order.get(version, len(version_order))) - - -def introduced_version_for_package( - package_name: str, - endpoint_lifecycle: list[dict[str, Any]], - *, - version_order: dict[str, int], -) -> str | None: - versions = [str(entry["introducedIn"]) for entry in endpoint_lifecycle if entry["package"] == package_name and entry.get("introducedIn")] - if not versions: - return None - return sorted(versions, key=lambda version: version_order.get(version, len(version_order)))[0] +GRPC_TARGET_PLACEHOLDER = "" +REQUEST_SAMPLE_MAX_DEPTH = 4 +REQUEST_SAMPLE_MAX_FIELDS = 8 def slugify_segment(value: str) -> str: @@ -93,54 +49,6 @@ def slugify_segment(value: str) -> str: return slug or "item" -def relative_page_link(from_path: Path, to_path: Path) -> str: - relative = os.path.relpath(to_path.with_suffix(""), start=from_path.parent) - return Path(relative).as_posix() - - -def relative_anchor_link(from_path: Path, to_path: Path, anchor: str) -> str: - if from_path == to_path: - return f"#{anchor}" - return f"{relative_page_link(from_path, to_path)}#{anchor}" - - -def service_anchor(service_id: str) -> str: - return f"service-{slugify_segment(service_id)}" - - -def endpoint_anchor(endpoint_id: str) -> str: - return f"endpoint-{slugify_segment(endpoint_id)}" - - -def type_anchor(type_name: str) -> str: - return f"type-{slugify_segment(type_name)}" - - -def build_package_page_path(output_dir: Path, package_name: str) -> Path: - return output_dir / "packages" / f"{slugify_segment(package_name)}.mdx" - - -def build_package_page_map(report: dict[str, Any], *, output_dir: Path) -> dict[str, Path]: - package_names = {package["package"] for package in report["latestSnapshot"]["packages"]} - package_names.update(entry["package"] for entry in report["endpointLifecycle"]) - return { - package_name: build_package_page_path(output_dir, package_name) - for package_name in sorted(package_names) - } - - -def build_type_page_map(report: dict[str, Any], *, package_page_map: dict[str, Path]) -> dict[str, Path]: - latest = report["latestSnapshot"] - version_order = {str(release["version"]): index for index, release in enumerate(report["releases"])} - type_page_map: dict[str, Path] = {} - for collection_name in ("messages", "enums"): - for entity in latest[collection_name].values(): - page_path = package_page_map.get(entity["package"]) - if page_path is not None: - type_page_map[entity["id"]] = page_path - return type_page_map - - def package_group(package_name: str, *, has_services: bool) -> str: if not has_services: return "Schema Packages" @@ -170,140 +78,42 @@ def package_group_sort_key(package_name: str, *, has_services: bool) -> tuple[in return (PACKAGE_GROUP_ORDER.index(label), package_name) -def render_type_link(type_name: str, *, from_path: Path, type_page_map: dict[str, Path]) -> str: - label = f"`{escape_md(type_name)}`" - page_path = type_page_map.get(type_name) - if page_path is None: - return label - return f"[{label}]({relative_anchor_link(from_path, page_path, type_anchor(type_name))})" +def lifecycle_badges(*, introduced: str, changed: str | None = None, removed: str | None = None) -> list[ReferenceBadge]: + badges = [ReferenceBadge("gRPC", tone="protocol"), ReferenceBadge(f"Since {introduced}", tone="added")] + if changed and changed != introduced: + badges.append(ReferenceBadge(f"Changed {changed}", tone="changed")) + if removed: + badges.append(ReferenceBadge(f"Removed {removed}", tone="removed")) + return badges -def render_field_type(field: dict[str, Any], *, current_page: Path, type_page_map: dict[str, Path]) -> str: - type_name = field.get("typeName") - if type_name and not field.get("map"): - return render_type_link(type_name, from_path=current_page, type_page_map=type_page_map) - return f"`{escape_md(field['type'])}`" +def page_ref(from_path: Path, to_path: Path) -> str: + return relative_page_ref(from_path, to_path) -def render_message_block( - message: dict[str, Any], - ctx: dict[str, dict[str, Any]], - *, - current_page: Path, - type_page_map: dict[str, Path], - seen: set[str], -) -> list[str]: - if message["id"] in seen: - return [] - seen.add(message["id"]) - - lines = [ - f'', - f"**Message `{message['id']}`**", - "", - f"- Source: {md_link(message['file'], message['sourceUrl'])}", - f"- Fields: {len(message['fieldIds'])}", - "", - render_description(message["description"]), - ] - - if message["fieldIds"]: - lines.extend( - [ - "", - "| Field | Type | Label | Description |", - "| --- | --- | --- | --- |", - ] - ) - for field_id in message["fieldIds"]: - field = ctx["fields"][field_id] - lines.append( - "| " - + " | ".join( - [ - escape_md_cell(field["name"]), - render_field_type(field, current_page=current_page, type_page_map=type_page_map), - escape_md_cell(field["label"]), - escape_md_cell(field["description"] or ""), - ] - ) - + " |" - ) - - for enum_id in message.get("enumIds", []): - nested_lines = render_enum_block( - ctx["enums"][enum_id], - ctx, - current_page=current_page, - type_page_map=type_page_map, - seen=seen, - ) - if nested_lines: - lines.extend(["", *nested_lines]) - for nested_id in message.get("nestedMessageIds", []): - nested_lines = render_message_block( - ctx["messages"][nested_id], - ctx, - current_page=current_page, - type_page_map=type_page_map, - seen=seen, - ) - if nested_lines: - lines.extend(["", *nested_lines]) - return lines - - -def render_enum_block( - enum_doc: dict[str, Any], - ctx: dict[str, dict[str, Any]], - *, - current_page: Path, - type_page_map: dict[str, Path], - seen: set[str], -) -> list[str]: - del current_page, type_page_map - if enum_doc["id"] in seen: - return [] - seen.add(enum_doc["id"]) - - lines = [ - f'', - f"**Enum `{enum_doc['id']}`**", - "", - f"- Source: {md_link(enum_doc['file'], enum_doc['sourceUrl'])}", - "", - render_description(enum_doc["description"]), - "", - "| Name | Number |", - "| --- | --- |", - ] - for value_id in enum_doc["valueIds"]: - value = ctx["enumValues"][value_id] - lines.append(f"| {escape_md_cell(value['name'])} | `{value['number']}` |") - return lines +def package_page_path(output_dir: Path, package_name: str) -> Path: + return output_dir / "packages" / f"{slugify_segment(package_name)}.mdx" -def render_endpoint_signature(endpoint: dict[str, Any]) -> str: - request_prefix = "stream " if endpoint["clientStreaming"] else "" - response_prefix = "stream " if endpoint["serverStreaming"] else "" +def operation_page_path(output_dir: Path, package_name: str, service_name: str, endpoint_name: str) -> Path: return ( - f"{endpoint['service']}.{endpoint['name']}(" - f"{request_prefix}{endpoint['requestType']}) returns " - f"({response_prefix}{endpoint['responseType']})" + output_dir + / "operations" + / slugify_segment(package_name) + / slugify_segment(service_name) + / f"{slugify_segment(endpoint_name)}.mdx" ) -def render_history_table(lifecycle_entry: dict[str, Any]) -> str: - lines = [ - "| Version | Kind | Details |", - "| --- | --- | --- |", +def compact_package_summary(package: dict[str, Any]) -> str: + parts = [ + f"{package['serviceCount']} services", + f"{package['endpointCount']} endpoints", + f"{package['messageCount']} messages", ] - for event in lifecycle_entry.get("history", []): - details = ", ".join(event.get("changeTypes", [])) - lines.append( - f"| `{escape_md_cell(event['version'])}` | `{escape_md_cell(event['kind'])}` | {escape_md_cell(details)} |" - ) - return "\n".join(lines) + if package["enumCount"]: + parts.append(f"{package['enumCount']} enums") + return ", ".join(parts) def endpoint_snapshot_map(report: dict[str, Any]) -> dict[str, dict[str, Any]]: @@ -376,283 +186,517 @@ def build_package_docs(report: dict[str, Any]) -> list[dict[str, Any]]: ) -def package_status( - package_name: str, - lifecycle_entries: list[dict[str, Any]], -) -> str: - package_entries = [entry for entry in lifecycle_entries if entry["package"] == package_name] - if not package_entries: - return "-" - - introduced_versions = sorted({str(entry["introducedIn"]) for entry in package_entries if entry.get("introducedIn")}) - changed_versions = sorted( - { - str(version) - for entry in package_entries - for version in [entry.get("lastChangedIn"), entry.get("removedIn")] - if version and str(version) not in introduced_versions - } - ) - removed_versions = sorted({str(entry["removedIn"]) for entry in package_entries if entry.get("removedIn")}) - all_removed = bool(package_entries) and all(not entry.get("current", True) for entry in package_entries) - removed_version = removed_versions[-1] if all_removed and removed_versions else None - return render_status_cell( - introduced=introduced_versions[0] if introduced_versions else None, - changed=changed_versions, - removed=removed_version, +def field_type_label(field: dict[str, Any]) -> str: + if field.get("map"): + base = "map" + elif field.get("typeName"): + base = str(field["typeName"]) + else: + base = str(field.get("type") or "-") + if field.get("label") == "repeated": + return f"repeated {base}" + return base + + +def short_type_name(type_name: str) -> str: + return type_name.rsplit(".", 1)[-1] if "." in type_name else type_name + + +def display_field_type(field: dict[str, Any]) -> str: + type_label = field_type_label(field) + if type_label.startswith("repeated "): + return f"repeated {short_type_name(type_label.removeprefix('repeated '))}" + return short_type_name(type_label) + + +def message_schema( + message: dict[str, Any], + ctx: dict[str, dict[str, Any]], + *, + seen: set[str], +) -> list[ReferenceSchema]: + if message["id"] in seen: + return [] + seen.add(message["id"]) + + schemas = [ + ReferenceSchema( + name=message["id"], + summary=f"{len(message['fieldIds'])} fields", + description=str(message.get("description") or ""), + anchor=f"schema-{slugify_segment(message['id'])}", + fields=[ + ReferenceField( + name=field["name"], + type_label=display_field_type(field), + required=field.get("label") == "required", + description=str(field.get("description") or ""), + ) + for field_id in message["fieldIds"] + for field in [ctx["fields"][field_id]] + ], + ) + ] + + for enum_id in message.get("enumIds", []): + schemas.extend(enum_schema(ctx["enums"][enum_id], ctx, seen=seen)) + for nested_id in message.get("nestedMessageIds", []): + schemas.extend(message_schema(ctx["messages"][nested_id], ctx, seen=seen)) + for field_id in message["fieldIds"]: + field = ctx["fields"][field_id] + type_name = field.get("typeName") + if type_name and type_name in ctx["messages"]: + schemas.extend(message_schema(ctx["messages"][type_name], ctx, seen=seen)) + elif type_name and type_name in ctx["enums"]: + schemas.extend(enum_schema(ctx["enums"][type_name], ctx, seen=seen)) + return schemas + + +def enum_schema(enum_doc: dict[str, Any], ctx: dict[str, dict[str, Any]], *, seen: set[str]) -> list[ReferenceSchema]: + if enum_doc["id"] in seen: + return [] + seen.add(enum_doc["id"]) + return [ + ReferenceSchema( + name=enum_doc["id"], + summary=f"{len(enum_doc['valueIds'])} values", + description=str(enum_doc.get("description") or ""), + anchor=f"schema-{slugify_segment(enum_doc['id'])}", + enum_values=[ + str(ctx_value["name"]) + for value_id in enum_doc["valueIds"] + for ctx_value in [ctx["enumValues"][value_id]] + ], + ) + ] + + +def related_schemas_for_types( + type_names: list[str], + ctx: dict[str, dict[str, Any]], +) -> list[ReferenceSchema]: + seen: set[str] = set() + schemas: list[ReferenceSchema] = [] + for type_name in type_names: + if type_name in ctx["messages"]: + schemas.extend(message_schema(ctx["messages"][type_name], ctx, seen=seen)) + elif type_name in ctx["enums"]: + schemas.extend(enum_schema(ctx["enums"][type_name], ctx, seen=seen)) + return schemas + + +def endpoint_signature(endpoint: dict[str, Any]) -> str: + request_prefix = "stream " if endpoint["clientStreaming"] else "" + response_prefix = "stream " if endpoint["serverStreaming"] else "" + return ( + f"rpc {endpoint['service']}.{endpoint['name']}(" + f"{request_prefix}{endpoint['requestType']}) returns " + f"({response_prefix}{endpoint['responseType']});" ) -def render_overview_page( +def scalar_json_sample(type_name: str | None) -> Any: + normalized = str(type_name or "").lower() + if normalized in {"double", "float"}: + return 0.0 + if normalized in {"int64", "sint64", "sfixed64", "uint64", "fixed64"}: + return "0" + if normalized in {"int32", "sint32", "sfixed32", "uint32", "fixed32"}: + return 0 + if normalized == "bool": + return True + if normalized == "bytes": + return "BASE64_ENCODED_BYTES" + if normalized: + return "string" + return {} + + +def enum_json_sample(enum_name: str, ctx: dict[str, dict[str, Any]]) -> str: + enum_doc = ctx["enums"].get(enum_name) + if not enum_doc: + return "ENUM_VALUE" + for value_id in enum_doc.get("valueIds", []): + enum_value = ctx["enumValues"].get(value_id) + if enum_value: + return str(enum_value["name"]) + return "ENUM_VALUE" + + +def type_json_sample( + type_name: str | None, + ctx: dict[str, dict[str, Any]], + *, + depth: int, + seen_messages: set[str], +) -> Any: + if type_name and type_name in ctx["messages"]: + return message_json_sample(type_name, ctx, depth=depth, seen_messages=seen_messages) + if type_name and type_name in ctx["enums"]: + return enum_json_sample(type_name, ctx) + return scalar_json_sample(type_name) + + +def field_json_sample( + field: dict[str, Any], + ctx: dict[str, dict[str, Any]], + *, + depth: int, + seen_messages: set[str], +) -> Any: + if field.get("map"): + value_sample = type_json_sample(field.get("valueType"), ctx, depth=depth - 1, seen_messages=seen_messages) + sample: Any = {"key": value_sample} + elif field.get("typeName"): + sample = type_json_sample(field.get("typeName"), ctx, depth=depth - 1, seen_messages=seen_messages) + else: + sample = scalar_json_sample(field.get("type")) + if field.get("label") == "repeated": + return [sample] + return sample + + +def message_json_sample( + message_name: str, + ctx: dict[str, dict[str, Any]], + *, + depth: int = REQUEST_SAMPLE_MAX_DEPTH, + seen_messages: set[str] | None = None, +) -> Any: + if depth <= 0: + return {} + message = ctx["messages"].get(message_name) + if not message: + return {} + if seen_messages is None: + seen_messages = set() + if message_name in seen_messages: + return {} + + next_seen = seen_messages | {message_name} + sample: dict[str, Any] = {} + rendered_oneofs: set[str] = set() + + for field_id in message.get("fieldIds", [])[:REQUEST_SAMPLE_MAX_FIELDS]: + field = ctx["fields"][field_id] + oneof_name = field.get("oneof") + if oneof_name: + if oneof_name in rendered_oneofs: + continue + rendered_oneofs.add(oneof_name) + sample[str(field.get("jsonName") or field["name"])] = field_json_sample( + field, + ctx, + depth=depth, + seen_messages=next_seen, + ) + return sample + + +def grpc_method_name(package_name: str, endpoint: dict[str, Any]) -> str: + endpoint_id = endpoint.get("id") + if endpoint_id: + return str(endpoint_id) + return f"{package_name}.{endpoint['service']}/{endpoint['name']}" + + +def grpcurl_example(package_name: str, endpoint: dict[str, Any], request_body: Any) -> str: + body = json.dumps(request_body, indent=2, ensure_ascii=False) + lines = [ + "# Add -plaintext if the server is not using TLS.", + "grpcurl \\", + " -d @ \\", + f" {GRPC_TARGET_PLACEHOLDER} \\", + f" {grpc_method_name(package_name, endpoint)} <<'EOF'", + body, + "EOF", + ] + if endpoint.get("clientStreaming") or endpoint.get("serverStreaming"): + lines.insert(1, "# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed.") + return "\n".join(lines) + + +def build_overview_page( report: dict[str, Any], *, output_dir: Path, - overview_path: Path, - package_page_map: dict[str, Path], package_docs: list[dict[str, Any]], -) -> Page: - latest = report["latestSnapshot"] +) -> ReferenceCollectionPage: + package_page_map = {package["package"]: package_page_path(output_dir, package["package"]) for package in package_docs} + package_groups: dict[str, list[ReferenceCard]] = defaultdict(list) + for package in package_docs: + group_label = package_group(package["package"], has_services=bool(package["serviceCount"] or package["endpointCount"])) + package_groups[group_label].append( + ReferenceCard( + title=package["package"], + href=page_ref(output_dir / "index.mdx", package_page_map[package["package"]]), + summary=compact_package_summary(package), + badges=[ReferenceBadge("gRPC", tone="protocol")], + meta_items=[ + ReferenceMetaItem("Services", str(package["serviceCount"])), + ReferenceMetaItem("Endpoints", str(package["endpointCount"])), + ReferenceMetaItem("Messages", str(package["messageCount"])), + ReferenceMetaItem("Enums", str(package["enumCount"])), + ], + ) + ) - release_rows: list[list[str]] = [] + release_cards = [] for release in report["releases"]: counts = release["changes"]["counts"] - release_rows.append( - [ - f"`{release['version']}`", - f"`{counts['endpoints']['added']}/{counts['endpoints']['modified']}/{counts['endpoints']['removed']}`", - f"`{counts['messages']['added']}/{counts['messages']['modified']}/{counts['messages']['removed']}`", - f"`{counts['enums']['added']}/{counts['enums']['modified']}/{counts['enums']['removed']}`", - f"`{counts['files']['added']}/{counts['files']['modified']}/{counts['files']['removed']}`", - ] + release_cards.append( + ReferenceCard( + title=str(release["version"]), + summary="Endpoint / message / enum deltas for this release.", + badges=[ReferenceBadge("Release", tone="neutral")], + meta_items=[ + ReferenceMetaItem("Endpoints", f"{counts['endpoints']['added']} / {counts['endpoints']['modified']} / {counts['endpoints']['removed']}"), + ReferenceMetaItem("Messages", f"{counts['messages']['added']} / {counts['messages']['modified']} / {counts['messages']['removed']}"), + ReferenceMetaItem("Enums", f"{counts['enums']['added']} / {counts['enums']['modified']} / {counts['enums']['removed']}"), + ], + ) ) - package_groups: dict[str, list[dict[str, Any]]] = defaultdict(list) - for package in package_docs: - label = package_group( - package["package"], - has_services=bool(package["serviceCount"] or package["endpointCount"]), + sections = [ + ReferenceSection( + heading="Release Summary", + body_markdown="Counts are shown as added / changed / removed within each release slice.", + cards=release_cards, ) - package_groups[label].append(package) - - grouped_packages: list[dict[str, Any]] = [] - toc_rows: list[list[str]] = [] + ] for label in PACKAGE_GROUP_ORDER: - packages = package_groups.get(label, []) - if not packages: - continue - rows: list[list[str]] = [] - for package in packages: - package_path = package_page_map[package["package"]] - link = package_path.relative_to(output_dir.parent).with_suffix("").as_posix() - rows.append( - [ - f"[`{escape_md(package['package'])}`]({link})", - f"`{package['serviceCount']}`", - f"`{package['endpointCount']}`", - f"`{package['messageCount']}`", - f"`{package['enumCount']}`", - ] - ) - toc_rows.append( - [ - f"[`{escape_md(package['package'])}`]({link})", - package_status( - package["package"], - report["endpointLifecycle"], - ), - compact_package_summary(package), - ] + if label in package_groups: + sections.append( + ReferenceSection( + heading=label, + cards=package_groups[label], + ) ) - grouped_packages.append({"label": label, "rows": rows}) - - return markdown_page( - path=overview_path.relative_to(output_dir.parent).as_posix(), - title="Canton Protobuf History", + latest = report["latestSnapshot"] + return ReferenceCollectionPage( + path="index.mdx", + title="Canton Protobuf Reference", description="Descriptor-backed protobuf API history grouped by package.", - template_name="protobuf/overview.md.j2", - source_items=[ - f"Source name: `{report['sourceName']}`", - f"Version filter: `{report['versionFilter']}`", - f"Latest release: `{report['latestRelease']}`", - f"Source repo: `{report['repo'].get('remote') or '-'}`", - ], - snapshot_items=[ - f"Packages: `{latest['stats']['packages']}`", - f"Services: `{latest['stats']['services']}`", - f"Endpoints: `{latest['stats']['endpoints']}`", - f"Messages: `{latest['stats']['messages']}`", - f"Enums: `{latest['stats']['enums']}`", + eyebrow="Protobuf Reference", + summary="Operation-first gRPC pages with package-level browsing and recursive related schema sections.", + badges=[ReferenceBadge("Protobuf", tone="protocol"), ReferenceBadge(str(report["latestRelease"]), tone="neutral")], + meta_items=[ + ReferenceMetaItem("Source", str(report["sourceName"])), + ReferenceMetaItem("Version filter", str(report["versionFilter"])), + ReferenceMetaItem("Latest release", str(report["latestRelease"])), + ReferenceMetaItem("Packages", str(latest["stats"]["packages"])), + ReferenceMetaItem("Endpoints", str(latest["stats"]["endpoints"])), + ReferenceMetaItem("Messages", str(latest["stats"]["messages"])), ], - package_toc_legend=render_status_legend(include_deprecated=False), - package_toc_rows=toc_rows, - package_groups=grouped_packages, - release_rows=release_rows, + sections=sections, ) -def render_package_page( +def build_package_page( package_doc: dict[str, Any], report: dict[str, Any], *, - package_path: Path, - overview_path: Path, + output_dir: Path, ctx: dict[str, dict[str, Any]], endpoint_docs: dict[str, dict[str, Any]], - type_page_map: dict[str, Path], -) -> Page: +) -> ReferenceCollectionPage: lifecycle_map = {entry["id"]: entry for entry in report["endpointLifecycle"]} - package_entries = sorted( - [entry for entry in report["endpointLifecycle"] if entry["package"] == package_doc["package"]], - key=lambda entry: (entry["service"], entry["name"]), - ) - service_buckets: dict[str, dict[str, Any]] = {} + page_path = package_page_path(output_dir, package_doc["package"]) + overview_path = output_dir / "index.mdx" + + service_sections: list[ReferenceSection] = [] for service_id in package_doc["serviceIds"]: - service_doc = ctx["services"][service_id] - service_buckets[service_id] = { - "id": service_id, - "name": service_doc["name"], - "file": service_doc["file"], - "sourceUrl": service_doc.get("sourceUrl"), - "description": service_doc.get("description", ""), - "endpointIds": [], - } - for entry in package_entries: - bucket = service_buckets.setdefault( - entry["serviceFullName"], - { - "id": entry["serviceFullName"], - "name": entry["service"], - "file": endpoint_docs.get(entry["id"], {}).get("file", "-"), - "sourceUrl": endpoint_docs.get(entry["id"], {}).get("sourceUrl"), - "description": "", - "endpointIds": [], - }, - ) - bucket["endpointIds"].append(entry["id"]) - - package_files = [ctx["files"][file_id] for file_id in package_doc["fileIds"] if file_id in ctx["files"]] - package_messages = [ctx["messages"][message_id] for message_id in package_doc["messageIds"] if message_id in ctx["messages"]] - package_enums = [ctx["enums"][enum_id] for enum_id in package_doc["enumIds"] if enum_id in ctx["enums"]] - - service_contexts: list[dict[str, Any]] = [] - service_rows: list[list[str]] = [] - for service in sorted(service_buckets.values(), key=lambda item: item["name"]): - service_rows.append( - [ - f"[`{escape_md(service['name'])}`](#{service_anchor(service['id'])})", - f"`{len(service['endpointIds'])}`", - md_link("file", service.get("sourceUrl")), - escape_md_cell(compact_text(service.get("description", ""))), - ] - ) - service_contexts.append( - { - "anchor": service_anchor(service["id"]), - "heading": f"Service `{service['name']}`", - "summary_items": [ - f"Source: {md_link(service['file'], service.get('sourceUrl'))}", - f"Endpoints tracked: `{len(service['endpointIds'])}`", - ], - "description": render_description(service.get("description", "")), - "endpoint_rows": [ - [ - f"[`{escape_md(endpoint_docs[endpoint_id]['name'])}`](#{endpoint_anchor(endpoint_id)})", - f"`{lifecycle_map[endpoint_id]['introducedIn']}`", - f"`{lifecycle_map[endpoint_id]['lastChangedIn']}`", - f"`{lifecycle_map[endpoint_id]['removedIn'] or ''}`", - render_type_link(endpoint_docs[endpoint_id]["requestType"], from_path=package_path, type_page_map=type_page_map), - render_type_link(endpoint_docs[endpoint_id]["responseType"], from_path=package_path, type_page_map=type_page_map), - md_link("file", endpoint_docs[endpoint_id].get("sourceUrl")), - ] - for endpoint_id in sorted(service["endpointIds"]) - ], - "endpoint_details": [ - { - "anchor": endpoint_anchor(endpoint_id), - "title": f"{endpoint_docs[endpoint_id]['service']}.{endpoint_docs[endpoint_id]['name']}", - "summary_items": [ - f"Introduced in: `{lifecycle_map[endpoint_id]['introducedIn']}`", - f"Last changed in: `{lifecycle_map[endpoint_id]['lastChangedIn']}`", - f"Removed in: `{lifecycle_map[endpoint_id]['removedIn'] or '-'}`", - f"Status: `{'current' if lifecycle_map[endpoint_id]['current'] else 'removed'}`", - f"Source: {md_link(endpoint_docs[endpoint_id]['file'], endpoint_docs[endpoint_id].get('sourceUrl'))}", - ], - "signature": f"rpc {render_endpoint_signature(endpoint_docs[endpoint_id])};", - "description": render_description(endpoint_docs[endpoint_id]["description"]), - "history_table": render_history_table(lifecycle_map[endpoint_id]), - "request_type": render_type_link( - endpoint_docs[endpoint_id]["requestType"], - from_path=package_path, - type_page_map=type_page_map, - ), - "response_type": render_type_link( - endpoint_docs[endpoint_id]["responseType"], - from_path=package_path, - type_page_map=type_page_map, - ), - } - for endpoint_id in sorted(service["endpointIds"]) + service = ctx["services"][service_id] + service_cards: list[ReferenceCard] = [] + for endpoint_id in sorted(service["endpointIds"]): + endpoint = endpoint_docs[endpoint_id] + lifecycle = lifecycle_map[endpoint_id] + operation_path = operation_page_path(output_dir, package_doc["package"], endpoint["service"], endpoint["name"]) + service_cards.append( + ReferenceCard( + title=f"{endpoint['service']}.{endpoint['name']}", + href=page_ref(page_path, operation_path), + summary=compact_text(endpoint.get("description") or endpoint_signature(endpoint), limit=180), + badges=lifecycle_badges( + introduced=str(lifecycle["introducedIn"]), + changed=str(lifecycle.get("lastChangedIn") or ""), + removed=str(lifecycle.get("removedIn") or "") or None, + ), + meta_items=[ + ReferenceMetaItem("Request", endpoint["requestType"]), + ReferenceMetaItem("Response", endpoint["responseType"]), + ReferenceMetaItem("Client stream", "Yes" if endpoint["clientStreaming"] else "No"), + ReferenceMetaItem("Server stream", "Yes" if endpoint["serverStreaming"] else "No"), + ], + ) + ) + service_sections.append( + ReferenceSection( + heading=service["name"], + body_markdown=safe_markdown_text(service.get("description") or "") or None, + meta_items=[ + ReferenceMetaItem("Source file", service["file"], href=service.get("sourceUrl")), + ReferenceMetaItem("Operations", str(len(service_cards))), ], - } + cards=service_cards, + ) ) - type_reference_blocks: list[str] = [] - if package_messages or package_enums: - seen: set[str] = set() - for message in package_messages: - block_lines = render_message_block( - message, - ctx, - current_page=package_path, - type_page_map=type_page_map, - seen=seen, + file_cards = [ + ReferenceCard( + title=file_doc["repoPath"], + summary="Current source file in the latest published descriptor snapshot.", + meta_items=[ + ReferenceMetaItem("Services", str(len(file_doc["serviceIds"]))), + ReferenceMetaItem("Messages", str(len(file_doc["messageIds"]))), + ReferenceMetaItem("Enums", str(len(file_doc["enumIds"]))), + ReferenceMetaItem("Source", file_doc["repoPath"], href=file_doc.get("sourceUrl")), + ], ) - if block_lines: - type_reference_blocks.append("\n".join(block_lines)) - for enum_doc in package_enums: - block_lines = render_enum_block( - enum_doc, - ctx, - current_page=package_path, - type_page_map=type_page_map, - seen=seen, + for file_id in package_doc["fileIds"] + for file_doc in [ctx["files"][file_id]] + if file_id in ctx["files"] + ] + + related_types = related_schemas_for_types( + [*package_doc["messageIds"], *package_doc["enumIds"]], + ctx, + ) + + sections = [] + if file_cards: + sections.append(ReferenceSection(heading="Source Files", cards=file_cards)) + sections.extend(service_sections) + if related_types: + sections.append( + ReferenceSection( + heading="Type Inventory", + body_markdown="These are the package-level message and enum shapes in the publish-version snapshot.", + schemas=related_types, ) - if block_lines: - type_reference_blocks.append("\n".join(block_lines)) + ) - return markdown_page( - path=package_path.relative_to(overview_path.parent.parent).as_posix(), + return ReferenceCollectionPage( + path=page_path.relative_to(output_dir).as_posix(), title=package_doc["package"], - description=f"Descriptor-backed protobuf API history for package {package_doc['package']}.", - template_name="protobuf/package.md.j2", - package_title=f"Package `{package_doc['package']}`", - overview_link=relative_page_link(package_path, overview_path), - snapshot_items=[ - f"Current files: `{package_doc['fileCount']}`", - f"Current services: `{package_doc['serviceCount']}`", - f"Current endpoints: `{package_doc['endpointCount']}`", - f"Current messages: `{package_doc['messageCount']}`", - f"Current enums: `{package_doc['enumCount']}`", - f"Lifecycle endpoints tracked: `{len(package_entries)}`", + description=f"Package-level overview for {package_doc['package']}.", + eyebrow="Protobuf Package", + summary=compact_package_summary(package_doc), + back_link=page_ref(page_path, overview_path), + back_label="Back to overview", + badges=[ReferenceBadge("gRPC", tone="protocol")], + meta_items=[ + ReferenceMetaItem("Files", str(package_doc["fileCount"])), + ReferenceMetaItem("Services", str(package_doc["serviceCount"])), + ReferenceMetaItem("Endpoints", str(package_doc["endpointCount"])), + ReferenceMetaItem("Messages", str(package_doc["messageCount"])), + ReferenceMetaItem("Enums", str(package_doc["enumCount"])), ], - source_file_rows=[ - [ - escape_md_cell(file_doc["repoPath"]), - f"`{len(file_doc['serviceIds'])}`", - f"`{len(file_doc['messageIds'])}`", - f"`{len(file_doc['enumIds'])}`", - md_link("file", file_doc.get("sourceUrl")), - ] - for file_doc in package_files + sections=sections, + ) + + +def build_operation_page( + package_name: str, + endpoint: dict[str, Any], + lifecycle: dict[str, Any], + *, + output_dir: Path, + ctx: dict[str, dict[str, Any]], +) -> ReferenceOperationPage: + page_path = operation_page_path(output_dir, package_name, endpoint["service"], endpoint["name"]) + package_path = package_page_path(output_dir, package_name) + related_schemas = related_schemas_for_types([endpoint["requestType"], endpoint["responseType"]], ctx) + schema_map = {schema.name: schema for schema in related_schemas} + + request_schema = schema_map.get(endpoint["requestType"]) + response_schema = schema_map.get(endpoint["responseType"]) + request_body = message_json_sample(endpoint["requestType"], ctx) + response_body = message_json_sample(endpoint["responseType"], ctx) + + description = str(endpoint.get("description") or "") + + return ReferenceOperationPage( + path=page_path.relative_to(output_dir).as_posix(), + title=endpoint["name"], + description=None, + eyebrow=package_name, + summary=None, + back_link=page_ref(page_path, package_path), + back_label="Back to package", + breadcrumbs=[ + ReferenceBreadcrumb(package_group(package_name, has_services=True)), + ReferenceBreadcrumb("Protobuf", page_ref(page_path, output_dir / "index.mdx")), + ReferenceBreadcrumb(package_name, page_ref(page_path, package_path)), + ReferenceBreadcrumb(endpoint["name"]), + ], + badges=lifecycle_badges( + introduced=str(lifecycle["introducedIn"]), + changed=str(lifecycle.get("lastChangedIn") or ""), + removed=str(lifecycle.get("removedIn") or "") or None, + ), + meta_items=[ + ReferenceMetaItem("Package", package_name), + ReferenceMetaItem("Service", endpoint["service"]), + ReferenceMetaItem("Introduced", str(lifecycle["introducedIn"])), + ReferenceMetaItem("Removed", str(lifecycle.get("removedIn") or "-")), + ReferenceMetaItem("Source", endpoint["file"], href=endpoint.get("sourceUrl")), + ], + operation_method="RPC", + operation_target=f"/{package_name}.{endpoint['service']}/{endpoint['name']}", + overview_markdown=None, + protocol_items=[ + ReferenceMetaItem("Protocol", "gRPC"), + ReferenceMetaItem("Service", endpoint["service"]), + ReferenceMetaItem("RPC", endpoint["name"]), + ReferenceMetaItem("Client stream", "Yes" if endpoint["clientStreaming"] else "No"), + ReferenceMetaItem("Server stream", "Yes" if endpoint["serverStreaming"] else "No"), + ], + inputs=[ + ReferencePanel( + title=short_type_name(endpoint["requestType"]), + meta_items=[ + ReferenceMetaItem("Message", endpoint["requestType"]), + ReferenceMetaItem("Client stream", "Yes" if endpoint["clientStreaming"] else "No"), + ], + schema=request_schema, + ) + ], + outputs=[ + ReferencePanel( + title=short_type_name(endpoint["responseType"]), + meta_items=[ + ReferenceMetaItem("Message", endpoint["responseType"]), + ReferenceMetaItem("Server stream", "Yes" if endpoint["serverStreaming"] else "No"), + ], + schema=response_schema, + ) ], - service_rows=service_rows, - services=service_contexts, - type_reference_blocks=type_reference_blocks, + examples=[ + ReferenceExample( + title="grpcurl", + body=grpcurl_example(package_name, endpoint, request_body), + language="bash", + ), + ReferenceExample( + title="OK", + body=json.dumps(response_body, indent=2, ensure_ascii=False), + kind="response", + media_type="application/json", + ), + ], + lifecycle_changes=[ + ReferenceChange( + version=str(event["version"]), + details=", ".join(str(change) for change in event.get("changeTypes", [])) or str(event["kind"]), + ) + for event in lifecycle.get("history", []) + ], + related_schemas=related_schemas, ) -def build_pages(report: dict[str, Any], *, output_dir: Path) -> tuple[Path, list[Page]]: - root = output_dir.parent +def build_pages(report: dict[str, Any], *, output_dir: Path) -> tuple[Path, list[Any]]: latest = report["latestSnapshot"] ctx = { "files": latest["files"], @@ -663,33 +707,33 @@ def build_pages(report: dict[str, Any], *, output_dir: Path) -> tuple[Path, list "enums": latest["enums"], "enumValues": latest["enumValues"], } - overview_path = output_dir / "index.mdx" package_docs = build_package_docs(report) - package_page_map = build_package_page_map(report, output_dir=output_dir) - type_page_map = build_type_page_map(report, package_page_map=package_page_map) endpoint_docs = endpoint_snapshot_map(report) + lifecycle_map = {entry["id"]: entry for entry in report["endpointLifecycle"]} - pages = [ - render_overview_page( - report, - output_dir=output_dir, - overview_path=overview_path, - package_page_map=package_page_map, - package_docs=package_docs, - ) - ] + pages = [render_collection_page(build_overview_page(report, output_dir=output_dir, package_docs=package_docs))] for package_doc in package_docs: - package_path = package_page_map[package_doc["package"]] pages.append( - render_package_page( - package_doc, - report, - package_path=package_path, - overview_path=overview_path, - ctx=ctx, - endpoint_docs=endpoint_docs, - type_page_map=type_page_map, + render_collection_page( + build_package_page( + package_doc, + report, + output_dir=output_dir, + ctx=ctx, + endpoint_docs=endpoint_docs, + ) ) ) - - return root, pages + for endpoint_id in package_doc["endpointIds"]: + pages.append( + render_operation_page( + build_operation_page( + package_doc["package"], + endpoint_docs[endpoint_id], + lifecycle_map[endpoint_id], + output_dir=output_dir, + ctx=ctx, + ) + ) + ) + return output_dir, pages diff --git a/src/x2mdx/reference_pages.py b/src/x2mdx/reference_pages.py new file mode 100644 index 0000000..3dc3f7e --- /dev/null +++ b/src/x2mdx/reference_pages.py @@ -0,0 +1,261 @@ +"""Shared Mintlify-like reference page structures and rendering helpers.""" + +from __future__ import annotations + +import json +import os +from dataclasses import dataclass, field +from pathlib import Path +from typing import Any + +from x2mdx.output import Page, RawMarkdown +from x2mdx.templating import render_template + + +@dataclass(frozen=True) +class ReferenceBadge: + label: str + tone: str = "neutral" + + +@dataclass(frozen=True) +class ReferenceMetaItem: + label: str + value: str + href: str | None = None + + +@dataclass(frozen=True) +class ReferenceBreadcrumb: + label: str + href: str | None = None + + +@dataclass(frozen=True) +class ReferenceField: + name: str + type_label: str + required: bool = False + description: str = "" + + +@dataclass(frozen=True) +class ReferenceExample: + title: str + body: str + language: str = "json" + kind: str = "request" + media_type: str | None = None + + +@dataclass(frozen=True) +class ReferenceSchema: + name: str + summary: str = "" + description: str = "" + anchor: str | None = None + fields: list[ReferenceField] = field(default_factory=list) + enum_values: list[str] = field(default_factory=list) + example: ReferenceExample | None = None + + +@dataclass(frozen=True) +class ReferencePanel: + title: str + summary: str = "" + description: str = "" + badges: list[ReferenceBadge] = field(default_factory=list) + meta_items: list[ReferenceMetaItem] = field(default_factory=list) + schema: ReferenceSchema | None = None + example: ReferenceExample | None = None + + +@dataclass(frozen=True) +class ReferenceCard: + title: str + href: str | None = None + summary: str = "" + badges: list[ReferenceBadge] = field(default_factory=list) + meta_items: list[ReferenceMetaItem] = field(default_factory=list) + + +@dataclass(frozen=True) +class ReferenceSection: + heading: str + body_markdown: str | None = None + cards: list[ReferenceCard] = field(default_factory=list) + meta_items: list[ReferenceMetaItem] = field(default_factory=list) + schemas: list[ReferenceSchema] = field(default_factory=list) + examples: list[ReferenceExample] = field(default_factory=list) + + +@dataclass(frozen=True) +class ReferenceCollectionPage: + path: str + title: str + description: str | None = None + eyebrow: str | None = None + summary: str | None = None + back_link: str | None = None + back_label: str | None = None + badges: list[ReferenceBadge] = field(default_factory=list) + meta_items: list[ReferenceMetaItem] = field(default_factory=list) + sections: list[ReferenceSection] = field(default_factory=list) + + +@dataclass(frozen=True) +class ReferenceChange: + version: str + details: str + + +@dataclass(frozen=True) +class ReferenceOperationPage: + path: str + title: str + anchor: str | None = None + description: str | None = None + eyebrow: str | None = None + summary: str | None = None + back_link: str | None = None + back_label: str | None = None + breadcrumbs: list[ReferenceBreadcrumb] = field(default_factory=list) + badges: list[ReferenceBadge] = field(default_factory=list) + meta_items: list[ReferenceMetaItem] = field(default_factory=list) + operation_method: str | None = None + operation_target: str | None = None + overview_markdown: str | None = None + protocol_items: list[ReferenceMetaItem] = field(default_factory=list) + inputs: list[ReferencePanel] = field(default_factory=list) + outputs: list[ReferencePanel] = field(default_factory=list) + examples: list[ReferenceExample] = field(default_factory=list) + lifecycle_changes: list[ReferenceChange] = field(default_factory=list) + related_schemas: list[ReferenceSchema] = field(default_factory=list) + + +def markdown_page_from_template( + *, + path: str, + title: str, + description: str | None, + template_name: str, + **context: Any, +) -> Page: + return Page( + path=path, + title=title, + description=safe_markdown_text(description) if description is not None else None, + blocks=[RawMarkdown(render_template(template_name, collapse_blank_lines=False, **context))], + ) + + +def render_collection_page(page: ReferenceCollectionPage) -> Page: + return markdown_page_from_template( + path=page.path, + title=page.title, + description=page.description, + template_name="reference/collection.md.j2", + page=page, + ) + + +def render_operation_page(page: ReferenceOperationPage) -> Page: + return markdown_page_from_template( + path=page.path, + title=page.title, + description=None, + template_name="reference/operation.md.j2", + page=page, + ) + + +def compact_text(text: str, *, limit: int = 160) -> str: + normalized = " ".join(str(text or "").split()) + if not normalized: + return "" + if len(normalized) <= limit: + return normalized + return normalized[: limit - 3].rstrip() + "..." + + +def safe_markdown_text(text: str) -> str: + return str(text or "").replace("<", "<") + + +def relative_page_ref(from_path: Path, to_path: Path) -> str: + relative = os.path.relpath(to_path.with_suffix(""), start=from_path.parent) + return Path(relative).as_posix() + + +def rooted_page_ref(root_prefix: str, target_path: Path, output_dir: Path) -> str: + relative = target_path.relative_to(output_dir).with_suffix("").as_posix() + trimmed = root_prefix.strip() + if not trimmed or trimmed == "/": + return f"/{relative}" + return f"/{trimmed.strip('/')}/{relative}" + + +def code_literal(value: str) -> str: + return f"`{str(value).replace('`', '\\`')}`" + + +def json_body(value: Any) -> str: + return json.dumps(value, indent=2, ensure_ascii=False) + + +def infer_type_label(value: Any) -> str: + if isinstance(value, bool): + return "boolean" + if isinstance(value, int) and not isinstance(value, bool): + return "integer" + if isinstance(value, float): + return "number" + if isinstance(value, list): + if not value: + return "array" + return f"array[{infer_type_label(value[0])}]" + if isinstance(value, dict): + return "object" + if value is None: + return "null" + return "string" + + +def schema_from_sample( + *, + name: str, + sample: Any, + required_fields: list[str] | None = None, + description: str = "", + summary: str = "", + anchor: str | None = None, +) -> ReferenceSchema: + required = set(required_fields or []) + fields: list[ReferenceField] = [] + if isinstance(sample, dict): + for key, value in sample.items(): + fields.append( + ReferenceField( + name=str(key), + type_label=infer_type_label(value), + required=key in required, + ) + ) + elif isinstance(sample, list): + fields.append( + ReferenceField( + name="items", + type_label=infer_type_label(sample[0]) if sample else "unknown", + required=True, + ) + ) + + example = ReferenceExample(title=name, body=json_body(sample)) if sample is not None else None + return ReferenceSchema( + name=name, + summary=summary or infer_type_label(sample), + description=description, + anchor=anchor, + fields=fields, + example=example, + ) diff --git a/src/x2mdx/templates/asyncapi/single_page.md.j2 b/src/x2mdx/templates/asyncapi/single_page.md.j2 new file mode 100644 index 0000000..68d27f5 --- /dev/null +++ b/src/x2mdx/templates/asyncapi/single_page.md.j2 @@ -0,0 +1,21 @@ +{% import "shared/reference_macros.md.j2" as ref %} +{{ ref.header(page.eyebrow, page.title, page.summary, page.back_link, page.back_label, page.badges, page.meta_items) }} +{% for channel in channels %} + +## {{ channel.heading }} + +{% if channel.body_markdown %} +{{ channel.body_markdown }} +{% endif %} +{{ ref.card_grid(channel.cards) }} + +{% for operation in channel.operations %} + + +### {{ operation.title }} + +{{ ref.badge_row(operation.badges) }} +{{ ref.meta_grid(operation.meta_items) }} +{{ ref.operation_sections(operation, "####") }} +{% endfor %} +{% endfor %} diff --git a/src/x2mdx/templates/reference/collection.md.j2 b/src/x2mdx/templates/reference/collection.md.j2 new file mode 100644 index 0000000..c76ba7a --- /dev/null +++ b/src/x2mdx/templates/reference/collection.md.j2 @@ -0,0 +1,18 @@ +{% import "shared/reference_macros.md.j2" as ref %} +{{ ref.header(page.eyebrow, page.title, page.summary, page.back_link, page.back_label, page.badges, page.meta_items) }} +{% for section in page.sections %} + +## {{ section.heading }} + +{% if section.body_markdown %} +{{ section.body_markdown }} +{% endif %} +{{ ref.meta_grid(section.meta_items) }} +{{ ref.card_grid(section.cards) }} +{% for schema in section.schemas %} +{{ ref.schema_block(schema) }} +{% endfor %} +{% for example in section.examples %} +{{ ref.example_block(example) }} +{% endfor %} +{% endfor %} diff --git a/src/x2mdx/templates/reference/operation.md.j2 b/src/x2mdx/templates/reference/operation.md.j2 new file mode 100644 index 0000000..cba3716 --- /dev/null +++ b/src/x2mdx/templates/reference/operation.md.j2 @@ -0,0 +1,7 @@ +{% import "shared/reference_macros.md.j2" as ref %} +
+{{ ref.breadcrumbs(page.breadcrumbs) }} +{{ ref.header(page.eyebrow, page.title, page.summary, None, None, page.badges, [], render_title=True, render_summary=False) }} +{{ ref.operation_bar(page) }} +{{ ref.operation_right_rail(page) }} +{{ ref.operation_sections(page, include_examples=False) }} diff --git a/src/x2mdx/templates/shared/reference_macros.md.j2 b/src/x2mdx/templates/shared/reference_macros.md.j2 new file mode 100644 index 0000000..cf5f707 --- /dev/null +++ b/src/x2mdx/templates/shared/reference_macros.md.j2 @@ -0,0 +1,257 @@ +{% macro header(eyebrow, title, summary, back_link, back_label, badges, meta_items, render_title=True, render_summary=True) -%} +{% if back_link %} +

{{ escape_html(inline_text(back_label or "Back")) }}

+{% endif %} +
+ {% if eyebrow %} +

{{ escape_html(inline_text(eyebrow)) }}

+ {% endif %} + {% if render_title %} +

{{ escape_html(inline_text(title)) }}

+ {% endif %} + {% if render_summary and summary %} +

{{ escape_html(inline_text(summary)) }}

+ {% endif %} + {{ badge_row(badges) }} + {{ meta_grid(meta_items) }} +
+{%- endmacro %} + +{% macro breadcrumbs(items) -%} +{% if items %} + +{% endif %} +{%- endmacro %} + +{% macro badge_row(badges) -%} +{% if badges %} +
+ {% for badge in badges %} + {{ escape_html(inline_text(badge.label)) }} + {% endfor %} +
+{% endif %} +{%- endmacro %} + +{% macro meta_grid(meta_items) -%} +{% if meta_items %} +
+ {% for item in meta_items %} +
+
{{ escape_html(inline_text(item.label)) }}
+
{% if item.href %}{{ escape_html(inline_text(item.value)) }}{% else %}{{ escape_html(inline_text(item.value)) }}{% endif %}
+
+ {% endfor %} +
+{% endif %} +{%- endmacro %} + +{% macro card_grid(cards) -%} +{% if cards %} +
+ {% for card in cards %} + {% if card.href %} + + {% else %} +
+ {% endif %} +
+

{{ escape_html(inline_text(card.title)) }}

+ {{ badge_row(card.badges) }} +
+ {% if card.summary %} +

{{ escape_html(inline_text(card.summary)) }}

+ {% endif %} + {{ meta_grid(card.meta_items) }} + {% if card.href %} + + {% else %} +
+ {% endif %} + {% endfor %} +
+{% endif %} +{%- endmacro %} + +{% macro fields_table(fields) -%} +{% if fields %} +
+ {% for field in fields %} +
+
+ {{ escape_html(inline_text(field.name)) }} + {{ escape_html(inline_text(field.type_label)) }} + {% if field.required %} + required + {% endif %} +
+ {% if field.description and field.description != "-" %} +
{{ escape_html(inline_text(field.description or "-")) }}
+ {% endif %} +
+ {% endfor %} +
+{% endif %} +{%- endmacro %} + +{% macro example_block(example) -%} +{% if example %} +
{{ escape_html(inline_text(example.title)) }}
+{{ code_block(example.language, example.body) }} +{% endif %} +{%- endmacro %} + +{% macro rail_example_card(example) -%} +
+
+ {{ escape_html(inline_text(example.title)) }} + {% if example.kind == "response" and example.media_type %} + {{ escape_html(inline_text(example.media_type)) }} + {% endif %} +
+ +```{{ escape_html(inline_text(example.language or "text")) }} {{ escape_html(inline_text(example.title)) }} +{{ example.body }} +``` + +
+{%- endmacro %} + +{% macro schema_block(schema) -%} +
+
+

{{ escape_html(inline_text(schema.name)) }}

+ {% if schema.summary %} +

{{ escape_html(inline_text(schema.summary)) }}

+ {% endif %} +
+ {{ schema_body(schema) }} +
+{%- endmacro %} + +{% macro schema_body(schema, render_example=True, render_description=True) -%} + {% if render_description and schema.description %} +

{{ escape_html(inline_text(schema.description)) }}

+ {% endif %} + {{ fields_table(schema.fields) }} + {% if schema.enum_values %} +
    + {% for value in schema.enum_values %} +
  • {{ escape_html(inline_text(value)) }}
    • + {% endfor %} +
+ {% endif %} + {% if render_example and schema.example %} + {{ example_block(schema.example) }} + {% endif %} +{%- endmacro %} + +{% macro panel_block(panel, render_text=True, render_schema_description=True) -%} +
+
+

{{ escape_html(inline_text(panel.title)) }}

+ {% if render_text and panel.summary %} +

{{ escape_html(inline_text(panel.summary)) }}

+ {% endif %} +
+ {{ badge_row(panel.badges) }} + {% if render_text and panel.description %} +

{{ escape_html(inline_text(panel.description)) }}

+ {% endif %} + {{ meta_grid(panel.meta_items) }} + {% if panel.schema %} + {{ schema_body(panel.schema, render_example=False, render_description=render_schema_description) }} + {% endif %} + {% if panel.example %} + {{ example_block(panel.example) }} + {% endif %} +
+{%- endmacro %} + +{% macro operation_right_rail(operation) -%} +{% if operation.examples %} +
+ {% for example in operation.examples %} +
+ {{ rail_example_card(example) }} +
+ {% endfor %} +
+{% endif %} +{%- endmacro %} + +{% macro operation_bar(operation) -%} +{% if operation.operation_target %} +
+ {% if operation.operation_method %} + {{ escape_html(inline_text(operation.operation_method)) }} + {% endif %} + {{ escape_html(inline_text(operation.operation_target)) }} + Try it +
+{% endif %} +{%- endmacro %} + +{% macro operation_sections(operation, heading_prefix="##", include_examples=True) -%} +{{ heading_prefix }} Protocol Details + +{{ meta_grid(operation.protocol_items) }} + +{{ heading_prefix }} Inputs + +{% for panel in operation.inputs %} +{{ panel_block(panel, render_text=False, render_schema_description=False) }} +{% endfor %} + +{{ heading_prefix }} Outputs + +{% for panel in operation.outputs %} +{{ panel_block(panel, render_text=False, render_schema_description=False) }} +{% endfor %} + +{% if include_examples and operation.examples %} +{{ heading_prefix }} Examples + +{% for example in operation.examples %} +{{ example_block(example) }} +{% endfor %} +{% endif %} + +{% if operation.lifecycle_changes %} +{{ heading_prefix }} Lifecycle Changes + +
+ {% for change in operation.lifecycle_changes %} +
+ {{ escape_html(inline_text(change.version)) }} + {{ escape_html(inline_text(change.details)) }} +
+ {% endfor %} +
+{% endif %} + +{% if operation.related_schemas %} +{{ heading_prefix }} Related Schemas + + +{% for schema in operation.related_schemas %} + +
+ {{ schema_body(schema, render_example=False, render_description=False) }} +
+ +{% endfor %} + +{% endif %} +{%- endmacro %} diff --git a/src/x2mdx/templating.py b/src/x2mdx/templating.py index 7c7166e..696e74f 100644 --- a/src/x2mdx/templating.py +++ b/src/x2mdx/templating.py @@ -2,6 +2,7 @@ from __future__ import annotations +import html import re from functools import lru_cache from typing import Any @@ -44,6 +45,23 @@ def admonition(kind: str, body: str) -> str: return f"<{kind}>\n{body}\n" +def escape_html(value: Any) -> str: + return html.escape("" if value is None else str(value), quote=True) + + +def escape_mdx_html_text(value: Any) -> str: + escaped = escape_html(value) + return escaped.replace("{", "{").replace("}", "}") + + +def escape_js_template_literal(value: Any) -> str: + return ("" if value is None else str(value)).replace("`", "\\`").replace("${", "\\${") + + +def inline_text(value: Any) -> str: + return re.sub(r"\s+", " ", "" if value is None else str(value)).strip() + + def accordion_list(title: str, items: list[str]) -> str: lines = ["", f''] lines.extend(f"- {item}" for item in items) @@ -160,6 +178,10 @@ def template_environment() -> Environment: code_block=code_block, anchor=anchor, admonition=admonition, + escape_html=escape_html, + escape_mdx_html_text=escape_mdx_html_text, + escape_js_template_literal=escape_js_template_literal, + inline_text=inline_text, accordion_list=accordion_list, render_card_group=render_card_group, pretty_json=pretty_json, diff --git a/tests/fixtures/characterization/asyncapi/expected/ledger-api-websocket-reference.mdx b/tests/fixtures/characterization/asyncapi/expected/ledger-api-websocket-reference.mdx index 83cc4a0..c626ca7 100644 --- a/tests/fixtures/characterization/asyncapi/expected/ledger-api-websocket-reference.mdx +++ b/tests/fixtures/characterization/asyncapi/expected/ledger-api-websocket-reference.mdx @@ -3,62 +3,287 @@ title: "JSON API AsyncAPI Reference" description: "JSON Ledger API WebSocket AsyncAPI reference and version history." --- -Generated from AsyncAPI snapshots for `JSON Ledger API WebSocket endpoints`. +
+ +

AsyncAPI Reference

+ + +

JSON API AsyncAPI Reference

+ + +

Single-page compatibility view for the new operation-first AsyncAPI renderer.

+ + +
+ + AsyncAPI + + 3.4.12 + +
+ + +
+ +
+
Publish version
+
3.4.12
+
+ +
+
AsyncAPI version
+
2.6.0
+
+ +
+
Source
+
splice-wallet-kernel Ledger API AsyncAPI snapshots
+
+ +
+
Version filter
+
characterization fixture versions
+
+ +
+ +
+ + +## /v2/commands/completions -This specification version fixes the API inconsistencies where certain fields marked as required in the spec are in fact optional. -If you use code generation tool based on this file, you might need to adjust the existing application code to handle those fields as optional. -If you do not want to change your client code, continue using the OpenAPI specification from the previous Canton 3.4 patch release. -MINIMUM_CANTON_VERSION=3.4.12 - -## Table of Contents - -| Name | Kind | Summary | Introduced | Changed | Deprecated | Removed | -| --- | --- | --- | --- | --- | --- | --- | -| [`/v2/commands/completions`](#channel-v2-commands-completions) | `publish`, `subscribe` | Get completions stream | `3.4.11` | `3.4.12`: publish required fields added: `parties`; publish required fields removed: `beginExclusive`, `userId` | - | - | -| [`/v2/state/active-contracts`](#channel-v2-state-active-contracts) | `publish`, `subscribe` | Get active contracts stream | `3.4.11` | `3.4.12`: publish required fields added: `eventFormat`; publish required fields removed: `verbose` | - | - | -| [`/v2/updates`](#channel-v2-updates) | `publish`, `subscribe` | Get updates stream | `3.4.11` | `3.4.12`: publish required fields added: `updateFormat`; publish required fields removed: `beginExclusive`, `verbose` | - | - | -| [`/v2/updates/flats`](#channel-v2-updates-flats) | `publish`, `subscribe` | Get flat transactions update stream. Provided for backwards compatibility, it will be removed in the Canton version 3... | `3.4.11` | `3.4.12`: publish required fields added: `updateFormat`; publish required fields removed: `beginExclusive`, `verbose` | - | - | -| [`/v2/updates/trees`](#channel-v2-updates-trees) | `publish`, `subscribe` | Get update transactions tree stream. Provided for backwards compatibility, it will be removed in the Canton version 3... | `3.4.11` | `3.4.12`: publish required fields added: `updateFormat`; publish required fields removed: `beginExclusive`, `verbose` | - | - | - -## Version Change Summary - -| Version | Added | Changed | Removed | -| --- | --- | --- | --- | -| `3.4.11` | 0 | 0 | 0 | -| `3.4.12` | 0 | 5 | 0 | - -## Reference - - - -### /v2/commands/completions - -- Actions: `publish`, `subscribe` -- Introduced: `3.4.11` -- Changed in: `3.4.12` Get completions stream -**Version Changes** - -| Version | Changes | -| --- | --- | -| `3.4.12` | publish required fields added: `parties`; publish required fields removed: `beginExclusive`, `userId` | -**Publish** - -- Operation ID: `sendV2CommandsCompletions` -- Message: `CompletionStreamRequest` -- Content type: `application/json` - -Get completions stream +
+ + + + +
+

Publish completions

+ +
+ + WebSocket + + Since 3.4.11 + + Changed 3.4.12 + +
+ +
+ + +
+ +
+
Action
+
publish
+
+ +
+
Payload
+
object
+
+ +
+ + + + + + + + +
+

Subscribe completions

+ +
+ + WebSocket + + Since 3.4.11 + + Changed 3.4.12 + +
+ +
+ + +
+ +
+
Action
+
subscribe
+
+ +
+
Payload
+
oneOf
+
+ +
+ + + + + +
+ + + + + +### Publish completions + + +
+ + WebSocket + + Since 3.4.11 + + Changed 3.4.12 + +
+ + +
+ +
+
Channel
+
/v2/commands/completions
+
+ +
+
Action
+
publish
+
+ +
+
Introduced
+
3.4.11
+
+ +
+
Removed
+
-
+
+ +
+ +#### Protocol Details + + +
+ +
+
Protocol
+
WebSocket
+
+ +
+
Channel
+
/v2/commands/completions
+
+ +
+
Action
+
publish
+
+ +
+
Operation ID
+
sendV2CommandsCompletions
+
+ +
+
Content type
+
application/json
+
+ +
+
Payload
+
object
+
+ +
+ + +#### Inputs + + +
+
+

CompletionStreamRequest

+ +
+ + + +
+ +
+
Direction
+
Client -> Server
+
+ +
+
Message
+
CompletionStreamRequest
+
+ +
+ + + + +
+ +
+
+ parties + array[string] + + required + +
+ +
+ +
+ + + + + +
+ + +#### Outputs + + + + +#### Examples + + + +
wscat
+```bash +npx wscat \ + -c \ + -x '{"parties": [""]}' \ + -w -1 +``` -| Payload Schema | Required Fields | -| --- | --- | -| `object` | `parties` | -**Message Example** +
message
```json { "parties": [ @@ -67,20 +292,197 @@ Get completions stream } ``` -**Subscribe** -- Operation ID: `onV2CommandsCompletions` -- Message: `Either_JsCantonError_CompletionStreamResponse` -- Content type: `application/json` -Get completions stream -| Payload Schema | Required Fields | -| --- | --- | -| `oneOf` | - | -**Message Example** +#### Lifecycle Changes + +
+ +
+ 3.4.12 + publish required fields added: `parties`; publish required fields removed: `beginExclusive`, `userId` +
+ +
+ + + +#### Related Schemas + + + + +
+ + +
+ +
+
+ parties + array[string] + + required + +
+ +
+ +
+ + + +
+ + + + + + + +### Subscribe completions + + +
+ + WebSocket + + Since 3.4.11 + + Changed 3.4.12 + +
+ + +
+ +
+
Channel
+
/v2/commands/completions
+
+ +
+
Action
+
subscribe
+
+ +
+
Introduced
+
3.4.11
+
+ +
+
Removed
+
-
+
+ +
+ +#### Protocol Details + + +
+ +
+
Protocol
+
WebSocket
+
+ +
+
Channel
+
/v2/commands/completions
+
+ +
+
Action
+
subscribe
+
+ +
+
Operation ID
+
onV2CommandsCompletions
+
+ +
+
Content type
+
application/json
+
+ +
+
Payload
+
oneOf
+
+ +
+ + +#### Inputs + + + +#### Outputs + + +
+
+

Either_JsCantonError_CompletionStreamResponse

+ +
+ + + +
+ +
+
Direction
+
Server -> Client
+
+ +
+
Message
+
Either_JsCantonError_CompletionStreamResponse
+
+ +
+ + + + +
+ +
+
+ completionResponse + object + +
+ +
+ +
+ + + + + +
+ + + +#### Examples + + + +
wscat
+```bash +npx wscat -c +``` + + +
message
```json { "completionResponse": { @@ -99,36 +501,299 @@ Get completions stream } ``` - -### /v2/state/active-contracts -- Actions: `publish`, `subscribe` -- Introduced: `3.4.11` -- Changed in: `3.4.12` -Get active contracts stream -**Version Changes** +#### Lifecycle Changes + +
+ +
+ 3.4.12 + publish required fields added: `parties`; publish required fields removed: `beginExclusive`, `userId` +
+ +
+ + + +#### Related Schemas + + + + +
+ + +
+ +
+
+ completionResponse + object + +
+ +
+ +
-| Version | Changes | -| --- | --- | -| `3.4.12` | publish required fields added: `eventFormat`; publish required fields removed: `verbose` | + + +
+ -**Publish** + + + + + +## /v2/state/active-contracts -- Operation ID: `sendV2StateActive-contracts` -- Message: `GetActiveContractsRequest` -- Content type: `application/json` Get active contracts stream -| Payload Schema | Required Fields | -| --- | --- | -| `object` | `activeAtOffset`, `eventFormat` | -**Message Example** +
+ + + + +
+

Publish active contracts

+ +
+ + WebSocket + + Since 3.4.11 + + Changed 3.4.12 + +
+ +
+ + +
+ +
+
Action
+
publish
+
+ +
+
Payload
+
object
+
+ +
+ + + + + + + + +
+

Subscribe active contracts

+ +
+ + WebSocket + + Since 3.4.11 + + Changed 3.4.12 + +
+ +
+ + +
+ +
+
Action
+
subscribe
+
+ +
+
Payload
+
oneOf
+
+ +
+ + + + + +
+ + + + + +### Publish active contracts + + +
+ + WebSocket + + Since 3.4.11 + + Changed 3.4.12 + +
+ + +
+ +
+
Channel
+
/v2/state/active-contracts
+
+ +
+
Action
+
publish
+
+ +
+
Introduced
+
3.4.11
+
+ +
+
Removed
+
-
+
+ +
+ +#### Protocol Details + + +
+ +
+
Protocol
+
WebSocket
+
+ +
+
Channel
+
/v2/state/active-contracts
+
+ +
+
Action
+
publish
+
+ +
+
Operation ID
+
sendV2StateActive-contracts
+
+ +
+
Content type
+
application/json
+
+ +
+
Payload
+
object
+
+ +
+ + +#### Inputs + + +
+
+

GetActiveContractsRequest

+ +
+ + + +
+ +
+
Direction
+
Client -> Server
+
+ +
+
Message
+
GetActiveContractsRequest
+
+ +
+ + + + +
+ +
+
+ activeAtOffset + string + + required + +
+ +
+ +
+
+ eventFormat + object + + required + +
+ +
+ +
+ + + + + +
+ + +#### Outputs + + + + +#### Examples + + + +
wscat
+```bash +npx wscat \ + -c \ + -x '{"activeAtOffset": "", "eventFormat": {"filtersByParty": {}, "filtersForAnyParty": {"cumulative": [""]}, "verbose": ""}}' \ + -w -1 +``` + + +
message
```json { "activeAtOffset": "", @@ -144,20 +809,235 @@ Get active contracts stream } ``` -**Subscribe** -- Operation ID: `onV2StateActive-contracts` -- Message: `Either_JsCantonError_JsGetActiveContractsResponse` -- Content type: `application/json` -Get active contracts stream -| Payload Schema | Required Fields | -| --- | --- | -| `oneOf` | - | -**Message Example** +#### Lifecycle Changes + +
+ +
+ 3.4.12 + publish required fields added: `eventFormat`; publish required fields removed: `verbose` +
+ +
+ + + +#### Related Schemas + + + + +
+ + +
+ +
+
+ activeAtOffset + string + + required + +
+ +
+ +
+
+ eventFormat + object + + required + +
+ +
+ +
+ + + +
+ + + + + + + +### Subscribe active contracts + + +
+ + WebSocket + + Since 3.4.11 + + Changed 3.4.12 + +
+ + +
+ +
+
Channel
+
/v2/state/active-contracts
+
+ +
+
Action
+
subscribe
+
+ +
+
Introduced
+
3.4.11
+
+ +
+
Removed
+
-
+
+ +
+ +#### Protocol Details + + +
+ +
+
Protocol
+
WebSocket
+
+ +
+
Channel
+
/v2/state/active-contracts
+
+ +
+
Action
+
subscribe
+
+ +
+
Operation ID
+
onV2StateActive-contracts
+
+ +
+
Content type
+
application/json
+
+ +
+
Payload
+
oneOf
+
+ +
+ + +#### Inputs + + + +#### Outputs + + +
+
+

Either_JsCantonError_JsGetActiveContractsResponse

+ +
+ + + +
+ +
+
Direction
+
Server -> Client
+
+ +
+
Message
+
Either_JsCantonError_JsGetActiveContractsResponse
+
+ +
+ + + + +
+ +
+
+ code + string + +
+ +
+ +
+
+ cause + string + +
+ +
+ +
+
+ context + object + +
+ +
+ +
+
+ errorCategory + string + +
+ +
+ +
+ + + + + +
+ + + +#### Examples + + + +
wscat
+```bash +npx wscat -c +``` + + +
message
```json { "code": "", @@ -167,36 +1047,315 @@ Get active contracts stream } ``` - -### /v2/updates -- Actions: `publish`, `subscribe` -- Introduced: `3.4.11` -- Changed in: `3.4.12` -Get updates stream -**Version Changes** +#### Lifecycle Changes -| Version | Changes | -| --- | --- | -| `3.4.12` | publish required fields added: `updateFormat`; publish required fields removed: `beginExclusive`, `verbose` | +
+ +
+ 3.4.12 + publish required fields added: `eventFormat`; publish required fields removed: `verbose` +
+ +
-**Publish** -- Operation ID: `sendV2Updates` -- Message: `GetUpdatesRequest` -- Content type: `application/json` + +#### Related Schemas + + + + +
+ + +
+ +
+
+ code + string + +
+ +
+ +
+
+ cause + string + +
+ +
+ +
+
+ context + object + +
+ +
+ +
+
+ errorCategory + string + +
+ +
+ +
+ + + +
+ + + + + + + +## /v2/updates + Get updates stream -| Payload Schema | Required Fields | -| --- | --- | -| `object` | `updateFormat` | -**Message Example** +
+ + + + +
+

Publish updates

+ +
+ + WebSocket + + Since 3.4.11 + + Changed 3.4.12 + +
+ +
+ + +
+ +
+
Action
+
publish
+
+ +
+
Payload
+
object
+
+ +
+ + + + + + + + +
+

Subscribe updates

+ +
+ + WebSocket + + Since 3.4.11 + + Changed 3.4.12 + +
+ +
+ + +
+ +
+
Action
+
subscribe
+
+ +
+
Payload
+
oneOf
+
+ +
+ + + + + +
+ + + + + +### Publish updates + + +
+ + WebSocket + + Since 3.4.11 + + Changed 3.4.12 + +
+ + +
+ +
+
Channel
+
/v2/updates
+
+ +
+
Action
+
publish
+
+ +
+
Introduced
+
3.4.11
+
+ +
+
Removed
+
-
+
+ +
+ +#### Protocol Details + + +
+ +
+
Protocol
+
WebSocket
+
+ +
+
Channel
+
/v2/updates
+
+ +
+
Action
+
publish
+
+ +
+
Operation ID
+
sendV2Updates
+
+ +
+
Content type
+
application/json
+
+ +
+
Payload
+
object
+
+ +
+ + +#### Inputs + + +
+
+

GetUpdatesRequest

+ +
+ + + +
+ +
+
Direction
+
Client -> Server
+
+ +
+
Message
+
GetUpdatesRequest
+
+ +
+ + + + +
+ +
+
+ updateFormat + object + + required + +
+ +
+ +
+ + + + + +
+ + +#### Outputs + + + + +#### Examples + + + +
wscat
+```bash +npx wscat \ + -c \ + -x '{"updateFormat": {"includeTransactions": {"eventFormat": {"filtersByParty": "", "filtersForAnyParty": "", "verbose": ""}, "transactionShape": ""}, "includeReassignments": {"filtersByParty": {}, "filtersForAnyParty": {"cumulative": [""]}, "verbose": ""}, "includeTopologyEvents": {"includeParticipantAuthorizationEvents": {"parties": [""]}}}}' \ + -w -1 +``` + + +
message
```json { "updateFormat": { @@ -228,20 +1387,224 @@ Get updates stream } ``` -**Subscribe** -- Operation ID: `onV2Updates` -- Message: `Either_JsCantonError_JsGetUpdatesResponse` -- Content type: `application/json` -Get updates stream -| Payload Schema | Required Fields | -| --- | --- | -| `oneOf` | - | -**Message Example** +#### Lifecycle Changes + +
+ +
+ 3.4.12 + publish required fields added: `updateFormat`; publish required fields removed: `beginExclusive`, `verbose` +
+ +
+ + + +#### Related Schemas + + + + +
+ + +
+ +
+
+ updateFormat + object + + required + +
+ +
+ +
+ + + +
+ + + + + + + +### Subscribe updates + + +
+ + WebSocket + + Since 3.4.11 + + Changed 3.4.12 + +
+ + +
+ +
+
Channel
+
/v2/updates
+
+ +
+
Action
+
subscribe
+
+ +
+
Introduced
+
3.4.11
+
+ +
+
Removed
+
-
+
+ +
+ +#### Protocol Details + + +
+ +
+
Protocol
+
WebSocket
+
+ +
+
Channel
+
/v2/updates
+
+ +
+
Action
+
subscribe
+
+ +
+
Operation ID
+
onV2Updates
+
+ +
+
Content type
+
application/json
+
+ +
+
Payload
+
oneOf
+
+ +
+ + +#### Inputs + + + +#### Outputs + + +
+
+

Either_JsCantonError_JsGetUpdatesResponse

+ +
+ + + +
+ +
+
Direction
+
Server -> Client
+
+ +
+
Message
+
Either_JsCantonError_JsGetUpdatesResponse
+
+ +
+ + + + +
+ +
+
+ code + string + +
+ +
+ +
+
+ cause + string + +
+ +
+ +
+
+ context + object + +
+ +
+ +
+
+ errorCategory + string + +
+ +
+ +
+ + + + + +
+ + + +#### Examples + + + +
wscat
+```bash +npx wscat -c +``` + + +
message
```json { "code": "", @@ -251,36 +1614,315 @@ Get updates stream } ``` - -### /v2/updates/flats -- Actions: `publish`, `subscribe` -- Introduced: `3.4.11` -- Changed in: `3.4.12` -Get flat transactions update stream. Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates instead. -**Version Changes** +#### Lifecycle Changes + +
+ +
+ 3.4.12 + publish required fields added: `updateFormat`; publish required fields removed: `beginExclusive`, `verbose` +
+ +
+ + + +#### Related Schemas + + -| Version | Changes | -| --- | --- | -| `3.4.12` | publish required fields added: `updateFormat`; publish required fields removed: `beginExclusive`, `verbose` | + +
+ + +
+ +
+
+ code + string + +
+ +
+ +
+
+ cause + string + +
+ +
+ +
+
+ context + object + +
+ +
+ +
+
+ errorCategory + string + +
+ +
+ +
-**Publish** + + +
+ + + + + + + +## /v2/updates/flats -- Operation ID: `sendV2UpdatesFlats` -- Message: `GetUpdatesRequest` -- Content type: `application/json` Get flat transactions update stream. Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates instead. -| Payload Schema | Required Fields | -| --- | --- | -| `object` | `updateFormat` | -**Message Example** +
+ + + + +
+

Publish flats

+ +
+ + WebSocket + + Since 3.4.11 + + Changed 3.4.12 + +
+ +
+ + +
+ +
+
Action
+
publish
+
+ +
+
Payload
+
object
+
+ +
+ + + + + + + + +
+

Subscribe flats

+ +
+ + WebSocket + + Since 3.4.11 + + Changed 3.4.12 + +
+ +
+ + +
+ +
+
Action
+
subscribe
+
+ +
+
Payload
+
oneOf
+
+ +
+ + + + + +
+ + + + + +### Publish flats + + +
+ + WebSocket + + Since 3.4.11 + + Changed 3.4.12 + +
+ + +
+ +
+
Channel
+
/v2/updates/flats
+
+ +
+
Action
+
publish
+
+ +
+
Introduced
+
3.4.11
+
+ +
+
Removed
+
-
+
+ +
+ +#### Protocol Details + + +
+ +
+
Protocol
+
WebSocket
+
+ +
+
Channel
+
/v2/updates/flats
+
+ +
+
Action
+
publish
+
+ +
+
Operation ID
+
sendV2UpdatesFlats
+
+ +
+
Content type
+
application/json
+
+ +
+
Payload
+
object
+
+ +
+ + +#### Inputs + + +
+
+

GetUpdatesRequest

+ +
+ + + +
+ +
+
Direction
+
Client -> Server
+
+ +
+
Message
+
GetUpdatesRequest
+
+ +
+ + + + +
+ +
+
+ updateFormat + object + + required + +
+ +
+ +
+ + + + + +
+ + +#### Outputs + + + + +#### Examples + + + +
wscat
+```bash +npx wscat \ + -c \ + -x '{"updateFormat": {"includeTransactions": {"eventFormat": {"filtersByParty": "", "filtersForAnyParty": "", "verbose": ""}, "transactionShape": ""}, "includeReassignments": {"filtersByParty": {}, "filtersForAnyParty": {"cumulative": [""]}, "verbose": ""}, "includeTopologyEvents": {"includeParticipantAuthorizationEvents": {"parties": [""]}}}}' \ + -w -1 +``` + + +
message
```json { "updateFormat": { @@ -312,20 +1954,224 @@ Get flat transactions update stream. Provided for backwards compatibility, it wi } ``` -**Subscribe** -- Operation ID: `onV2UpdatesFlats` -- Message: `Either_JsCantonError_JsGetUpdatesResponse` -- Content type: `application/json` -Get flat transactions update stream. Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates instead. -| Payload Schema | Required Fields | -| --- | --- | -| `oneOf` | - | -**Message Example** +#### Lifecycle Changes + +
+ +
+ 3.4.12 + publish required fields added: `updateFormat`; publish required fields removed: `beginExclusive`, `verbose` +
+ +
+ + + +#### Related Schemas + + + + +
+ + +
+ +
+
+ updateFormat + object + + required + +
+ +
+ +
+ + + +
+ + + + + + + +### Subscribe flats + + +
+ + WebSocket + + Since 3.4.11 + + Changed 3.4.12 + +
+ + +
+ +
+
Channel
+
/v2/updates/flats
+
+ +
+
Action
+
subscribe
+
+ +
+
Introduced
+
3.4.11
+
+ +
+
Removed
+
-
+
+ +
+ +#### Protocol Details + + +
+ +
+
Protocol
+
WebSocket
+
+ +
+
Channel
+
/v2/updates/flats
+
+ +
+
Action
+
subscribe
+
+ +
+
Operation ID
+
onV2UpdatesFlats
+
+ +
+
Content type
+
application/json
+
+ +
+
Payload
+
oneOf
+
+ +
+ + +#### Inputs + + + +#### Outputs + + +
+
+

Either_JsCantonError_JsGetUpdatesResponse

+ +
+ + + +
+ +
+
Direction
+
Server -> Client
+
+ +
+
Message
+
Either_JsCantonError_JsGetUpdatesResponse
+
+ +
+ + + + +
+ +
+
+ code + string + +
+ +
+ +
+
+ cause + string + +
+ +
+ +
+
+ context + object + +
+ +
+ +
+
+ errorCategory + string + +
+ +
+ +
+ + + + + +
+ + + +#### Examples + + + +
wscat
+```bash +npx wscat -c +``` + + +
message
```json { "code": "", @@ -335,36 +2181,315 @@ Get flat transactions update stream. Provided for backwards compatibility, it wi } ``` - -### /v2/updates/trees -- Actions: `publish`, `subscribe` -- Introduced: `3.4.11` -- Changed in: `3.4.12` -Get update transactions tree stream. Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates instead. -**Version Changes** +#### Lifecycle Changes + +
+ +
+ 3.4.12 + publish required fields added: `updateFormat`; publish required fields removed: `beginExclusive`, `verbose` +
+ +
+ + + +#### Related Schemas + + -| Version | Changes | -| --- | --- | -| `3.4.12` | publish required fields added: `updateFormat`; publish required fields removed: `beginExclusive`, `verbose` | + +
+ + +
+ +
+
+ code + string + +
+ +
+ +
+
+ cause + string + +
+ +
+ +
+
+ context + object + +
+ +
+ +
+
+ errorCategory + string + +
+ +
+ +
-**Publish** + + +
+ + + + + + + +## /v2/updates/trees -- Operation ID: `sendV2UpdatesTrees` -- Message: `GetUpdatesRequest` -- Content type: `application/json` Get update transactions tree stream. Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates instead. -| Payload Schema | Required Fields | -| --- | --- | -| `object` | `updateFormat` | -**Message Example** +
+ + + + +
+

Publish trees

+ +
+ + WebSocket + + Since 3.4.11 + + Changed 3.4.12 + +
+ +
+ + +
+ +
+
Action
+
publish
+
+ +
+
Payload
+
object
+
+ +
+ + + + + + + + +
+

Subscribe trees

+ +
+ + WebSocket + + Since 3.4.11 + + Changed 3.4.12 + +
+ +
+ + +
+ +
+
Action
+
subscribe
+
+ +
+
Payload
+
oneOf
+
+ +
+ + + + + +
+ + + + + +### Publish trees + + +
+ + WebSocket + + Since 3.4.11 + + Changed 3.4.12 + +
+ + +
+ +
+
Channel
+
/v2/updates/trees
+
+ +
+
Action
+
publish
+
+ +
+
Introduced
+
3.4.11
+
+ +
+
Removed
+
-
+
+ +
+ +#### Protocol Details + + +
+ +
+
Protocol
+
WebSocket
+
+ +
+
Channel
+
/v2/updates/trees
+
+ +
+
Action
+
publish
+
+ +
+
Operation ID
+
sendV2UpdatesTrees
+
+ +
+
Content type
+
application/json
+
+ +
+
Payload
+
object
+
+ +
+ + +#### Inputs + + +
+
+

GetUpdatesRequest

+ +
+ + + +
+ +
+
Direction
+
Client -> Server
+
+ +
+
Message
+
GetUpdatesRequest
+
+ +
+ + + + +
+ +
+
+ updateFormat + object + + required + +
+ +
+ +
+ + + + + +
+ + +#### Outputs + + + + +#### Examples + + + +
wscat
+```bash +npx wscat \ + -c \ + -x '{"updateFormat": {"includeTransactions": {"eventFormat": {"filtersByParty": "", "filtersForAnyParty": "", "verbose": ""}, "transactionShape": ""}, "includeReassignments": {"filtersByParty": {}, "filtersForAnyParty": {"cumulative": [""]}, "verbose": ""}, "includeTopologyEvents": {"includeParticipantAuthorizationEvents": {"parties": [""]}}}}' \ + -w -1 +``` + + +
message
```json { "updateFormat": { @@ -396,20 +2521,224 @@ Get update transactions tree stream. Provided for backwards compatibility, it wi } ``` -**Subscribe** -- Operation ID: `onV2UpdatesTrees` -- Message: `Either_JsCantonError_JsGetUpdateTreesResponse` -- Content type: `application/json` -Get update transactions tree stream. Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates instead. -| Payload Schema | Required Fields | -| --- | --- | -| `oneOf` | - | -**Message Example** +#### Lifecycle Changes + +
+ +
+ 3.4.12 + publish required fields added: `updateFormat`; publish required fields removed: `beginExclusive`, `verbose` +
+ +
+ + + +#### Related Schemas + + + + +
+ + +
+ +
+
+ updateFormat + object + + required + +
+ +
+ +
+ + + +
+ + + + + + + +### Subscribe trees + + +
+ + WebSocket + + Since 3.4.11 + + Changed 3.4.12 + +
+ + +
+ +
+
Channel
+
/v2/updates/trees
+
+ +
+
Action
+
subscribe
+
+ +
+
Introduced
+
3.4.11
+
+ +
+
Removed
+
-
+
+ +
+ +#### Protocol Details + + +
+ +
+
Protocol
+
WebSocket
+
+ +
+
Channel
+
/v2/updates/trees
+
+ +
+
Action
+
subscribe
+
+ +
+
Operation ID
+
onV2UpdatesTrees
+
+ +
+
Content type
+
application/json
+
+ +
+
Payload
+
oneOf
+
+ +
+ + +#### Inputs + + + +#### Outputs + + +
+
+

Either_JsCantonError_JsGetUpdateTreesResponse

+ +
+ + + +
+ +
+
Direction
+
Server -> Client
+
+ +
+
Message
+
Either_JsCantonError_JsGetUpdateTreesResponse
+
+ +
+ + + + +
+ +
+
+ code + string + +
+ +
+ +
+
+ cause + string + +
+ +
+ +
+
+ context + object + +
+ +
+ +
+
+ errorCategory + string + +
+ +
+ +
+ + + + + +
+ + + +#### Examples + + + +
wscat
+```bash +npx wscat -c +``` + + +
message
```json { "code": "", @@ -418,3 +2747,75 @@ Get update transactions tree stream. Provided for backwards compatibility, it wi "errorCategory": "" } ``` + + + + + +#### Lifecycle Changes + +
+ +
+ 3.4.12 + publish required fields added: `updateFormat`; publish required fields removed: `beginExclusive`, `verbose` +
+ +
+ + + +#### Related Schemas + + + + +
+ + +
+ +
+
+ code + string + +
+ +
+ +
+
+ cause + string + +
+ +
+ +
+
+ context + object + +
+ +
+ +
+
+ errorCategory + string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/index.mdx b/tests/fixtures/characterization/openrpc/expected/index.mdx index 5881738..903c871 100644 --- a/tests/fixtures/characterization/openrpc/expected/index.mdx +++ b/tests/fixtures/characterization/openrpc/expected/index.mdx @@ -3,22 +3,230 @@ title: "Wallet Gateway OpenRPC" description: "Versioned OpenRPC reference docs." --- -# Wallet Gateway OpenRPC +
+ +

OpenRPC Reference

+ + +

Wallet Gateway OpenRPC

+ + +

Operation-first JSON-RPC reference pages with version history carried from the snapshot lifecycle report.

+ + +
+ + OpenRPC + + 0.21.0 + +
-Generated from versioned OpenRPC snapshots. + +
+ +
+
Publish version
+
0.21.0
+
+ +
+
Versions compared
+
0.20.0, 0.21.0
+
+ +
+
Source
+
splice-wallet-kernel Wallet Gateway OpenRPC release-tag snapshots
+
+ +
+
Version filter
+
characterization fixture versions
+
+ +
-- Publish version: `0.21.0` -- Versions compared: `0.20.0`, `0.21.0` -- Source: `splice-wallet-kernel Wallet Gateway OpenRPC release-tag snapshots` -- Version filter: `characterization fixture versions` +
-## Table of Contents -🟢 Active Since 🔵 Changed 🔴 Removed +## Specs -| NAME | STATUS | SUMMARY | -| --- | --- | --- | -| [`dApp API`](/reference/wallet-gateway-json-rpc/specs/dapp-api) | 🟢 `v0.20` | Splice Wallet JSON-RPC dApp API. 12 methods | -| [`Remote dApp API`](/reference/wallet-gateway-json-rpc/specs/dapp-remote-api) | 🟢 `v0.20` | Splice Wallet JSON-RPC Remote dApp API. 13 methods | -| [`Signing API`](/reference/wallet-gateway-json-rpc/specs/signing-api) | 🟢 `v0.20` | Wallet JSON-RPC Signing API. 8 methods | -| [`User API`](/reference/wallet-gateway-json-rpc/specs/user-api) | 🟢 `v0.20` 🔵 `v0.21` | Splice Wallet JSON-RPC User API. 22 methods | + +Choose a spec page to browse its methods, then drill into operation pages for request/response details. + + + +
+ + + + +
+

dApp API

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

An OpenRPC specification for the dapp to interact with a Wallet Provider.

+ + +
+ +
+
Methods
+
12
+
+ +
+
Latest version
+
0.21.0
+
+ +
+
OpenRPC
+
1.2.6
+
+ +
+ + + + + + + + +
+

Remote dApp API

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

An OpenRPC specification for remotely hosted Wallet Providers. Due to the remote nature, an implementing provider must bridge certain functionality on the client-side to satisfy the general dApp AP...

+ + +
+ +
+
Methods
+
13
+
+ +
+
Latest version
+
0.21.0
+
+ +
+
OpenRPC
+
1.2.6
+
+ +
+ + + + + + + + +
+

Signing API

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

An OpenRPC specification for the Signing API which allows the Wallet Gateway to interact with a Wallet Providers.

+ + +
+ +
+
Methods
+
8
+
+ +
+
Latest version
+
0.21.0
+
+ +
+
OpenRPC
+
1.2.6
+
+ +
+ + + + + + + + +
+

User API

+ +
+ + JSON-RPC + + Since 0.20.0 + + Changed 0.21.0 + +
+ +
+ +

An OpenRPC specification for the user to interact with the Wallet Gateway.

+ + +
+ +
+
Methods
+
22
+
+ +
+
Latest version
+
0.21.0
+
+ +
+
OpenRPC
+
1.2.6
+
+ +
+ + + + + +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/accountschanged.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/accountschanged.mdx new file mode 100644 index 0000000..d417d11 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/accountschanged.mdx @@ -0,0 +1,234 @@ +--- +title: "accountsChanged" +--- + +
+ + + + +
+ +

dApp API

+ + +

accountsChanged

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC accountsChanged + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "accountsChanged" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +[ + { + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" + } +] +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
accountsChanged
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
array[object]
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
array[object]
+
+ +
+
Schema
+
AccountsChangedEvent
+
+ +
+ + + + +
+ +
+
+ items + object + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ items + object + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/connect.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/connect.mdx new file mode 100644 index 0000000..e7d94f0 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/connect.mdx @@ -0,0 +1,253 @@ +--- +title: "connect" +--- + +
+ + + + +
+ +

dApp API

+ + +

connect

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC connect + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "connect" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "isConnected": "", + "isNetworkConnected": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
connect
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
ConnectResult
+
+ +
+
Required
+
isConnected, isNetworkConnected
+
+ +
+ + + + +
+ +
+
+ isConnected + string + + required + +
+ +
+ +
+
+ isNetworkConnected + string + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ isConnected + string + + required + +
+ +
+ +
+
+ isNetworkConnected + string + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/disconnect.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/disconnect.mdx new file mode 100644 index 0000000..1caf74e --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/disconnect.mdx @@ -0,0 +1,193 @@ +--- +title: "disconnect" +--- + +
+ + + + +
+ +

dApp API

+ + +

disconnect

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC disconnect + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "disconnect" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +"" +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
disconnect
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
null
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
null
+
+ +
+
Schema
+
Null
+
+ +
+ + + + + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/getactivenetwork.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/getactivenetwork.mdx new file mode 100644 index 0000000..a54e024 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/getactivenetwork.mdx @@ -0,0 +1,230 @@ +--- +title: "getActiveNetwork" +--- + +
+ + + + +
+ +

dApp API

+ + +

getActiveNetwork

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC getActiveNetwork + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "getActiveNetwork" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "networkId": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
getActiveNetwork
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
Network
+
+ +
+
Required
+
networkId
+
+ +
+ + + + +
+ +
+
+ networkId + string + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ networkId + string + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/getprimaryaccount.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/getprimaryaccount.mdx new file mode 100644 index 0000000..da12ec3 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/getprimaryaccount.mdx @@ -0,0 +1,391 @@ +--- +title: "getPrimaryAccount" +--- + +
+ + + + +
+ +

dApp API

+ + +

getPrimaryAccount

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC getPrimaryAccount + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "getPrimaryAccount" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
getPrimaryAccount
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
Wallet
+
+ +
+
Required
+
hint, namespace, networkId, partyId, primary, publicKey, signingProviderId, status
+
+ +
+ + + + +
+ +
+
+ primary + string + + required + +
+ +
+ +
+
+ partyId + string + + required + +
+ +
+ +
+
+ status + string + + required + +
+ +
+ +
+
+ hint + string + + required + +
+ +
+ +
+
+ publicKey + string + + required + +
+ +
+ +
+
+ namespace + string + + required + +
+ +
+ +
+
+ networkId + string + + required + +
+ +
+ +
+
+ signingProviderId + string + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ primary + string + + required + +
+ +
+ +
+
+ partyId + string + + required + +
+ +
+ +
+
+ status + string + + required + +
+ +
+ +
+
+ hint + string + + required + +
+ +
+ +
+
+ publicKey + string + + required + +
+ +
+ +
+
+ namespace + string + + required + +
+ +
+ +
+
+ networkId + string + + required + +
+ +
+ +
+
+ signingProviderId + string + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/ledgerapi.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/ledgerapi.mdx new file mode 100644 index 0000000..8770e51 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/ledgerapi.mdx @@ -0,0 +1,333 @@ +--- +title: "ledgerApi" +--- + +
+ + + + +
+ +

dApp API

+ + +

ledgerApi

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC ledgerApi + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "ledgerApi", + "params": { + "params": { + "requestMethod": "", + "resource": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "response": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
ledgerApi
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
LedgerApiRequest
+
+ +
+
Required
+
requestMethod, resource
+
+ +
+ + + + +
+ +
+
+ requestMethod + string + + required + +
+ +
+ +
+
+ resource + string + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
LedgerApiResult
+
+ +
+
Required
+
response
+
+ +
+ + + + +
+ +
+
+ response + string + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ requestMethod + string + + required + +
+ +
+ +
+
+ resource + string + + required + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ response + string + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/listaccounts.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/listaccounts.mdx new file mode 100644 index 0000000..7487e9a --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/listaccounts.mdx @@ -0,0 +1,234 @@ +--- +title: "listAccounts" +--- + +
+ + + + +
+ +

dApp API

+ + +

listAccounts

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC listAccounts + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "listAccounts" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +[ + { + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" + } +] +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
listAccounts
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
array[object]
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
array[object]
+
+ +
+
Schema
+
ListAccountsResult
+
+ +
+ + + + +
+ +
+
+ items + object + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ items + object + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/prepareexecute.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/prepareexecute.mdx new file mode 100644 index 0000000..8cd8d00 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/prepareexecute.mdx @@ -0,0 +1,273 @@ +--- +title: "prepareExecute" +--- + +
+ + + + +
+ +

dApp API

+ + +

prepareExecute

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC prepareExecute + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "prepareExecute", + "params": { + "params": { + "commands": {} + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +"" +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
prepareExecute
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
null
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
JsPrepareSubmissionRequest
+
+ +
+
Required
+
commands
+
+ +
+ + + + +
+ +
+
+ commands + object + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
null
+
+ +
+
Schema
+
Null
+
+ +
+ + + + + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ commands + object + + required + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/prepareexecuteandwait.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/prepareexecuteandwait.mdx new file mode 100644 index 0000000..910f75a --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/prepareexecuteandwait.mdx @@ -0,0 +1,312 @@ +--- +title: "prepareExecuteAndWait" +--- + +
+ + + + +
+ +

dApp API

+ + +

prepareExecuteAndWait

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC prepareExecuteAndWait + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "prepareExecuteAndWait", + "params": { + "params": { + "commands": {} + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "tx": { + "status": "", + "commandId": "", + "payload": { + "updateId": "", + "completionOffset": "" + } + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
prepareExecuteAndWait
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
JsPrepareSubmissionRequest
+
+ +
+
Required
+
commands
+
+ +
+ + + + +
+ +
+
+ commands + object + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
tx
+
+ +
+ + + + +
+ +
+
+ tx + object + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ commands + object + + required + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ tx + object + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/signmessage.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/signmessage.mdx new file mode 100644 index 0000000..3fcd7c5 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/signmessage.mdx @@ -0,0 +1,310 @@ +--- +title: "signMessage" +--- + +
+ + + + +
+ +

dApp API

+ + +

signMessage

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC signMessage + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "signMessage", + "params": { + "params": { + "message": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "signature": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
signMessage
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
SignMessageRequest
+
+ +
+
Required
+
message
+
+ +
+ + + + +
+ +
+
+ message + string + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
SignMessageResult
+
+ +
+
Required
+
signature
+
+ +
+ + + + +
+ +
+
+ signature + string + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ message + string + + required + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ signature + string + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/status.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/status.mdx new file mode 100644 index 0000000..c19b3e8 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/status.mdx @@ -0,0 +1,258 @@ +--- +title: "status" +--- + +
+ + + + +
+ +

dApp API

+ + +

status

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC status + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "status" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "provider": { + "id": "" + }, + "connection": { + "isConnected": "", + "isNetworkConnected": "" + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
status
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
StatusEvent
+
+ +
+
Required
+
connection, provider
+
+ +
+ + + + +
+ +
+
+ provider + object + + required + +
+ +
+ +
+
+ connection + object + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ provider + object + + required + +
+ +
+ +
+
+ connection + object + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/txchanged.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/txchanged.mdx new file mode 100644 index 0000000..5c83799 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/txchanged.mdx @@ -0,0 +1,240 @@ +--- +title: "txChanged" +--- + +
+ + + + +
+ +

dApp API

+ + +

txChanged

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC txChanged + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "txChanged" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "status": "", + "commandId": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
txChanged
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
oneOf
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
oneOf
+
+ +
+
Schema
+
TxChangedEvent
+
+ +
+ + + + +
+ +
+
+ status + string + +
+ +
+ +
+
+ commandId + string + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ status + string + +
+ +
+ +
+
+ commandId + string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/accountschanged.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/accountschanged.mdx new file mode 100644 index 0000000..1c45473 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/accountschanged.mdx @@ -0,0 +1,234 @@ +--- +title: "accountsChanged" +--- + +
+ + + + +
+ +

Remote dApp API

+ + +

accountsChanged

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC accountsChanged + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "accountsChanged" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +[ + { + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" + } +] +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
accountsChanged
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
array[object]
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
array[object]
+
+ +
+
Schema
+
AccountsChangedEvent
+
+ +
+ + + + +
+ +
+
+ items + object + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ items + object + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/connect.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/connect.mdx new file mode 100644 index 0000000..2041195 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/connect.mdx @@ -0,0 +1,253 @@ +--- +title: "connect" +--- + +
+ + + + +
+ +

Remote dApp API

+ + +

connect

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC connect + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "connect" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "isConnected": "", + "isNetworkConnected": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
connect
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
ConnectResult
+
+ +
+
Required
+
isConnected, isNetworkConnected
+
+ +
+ + + + +
+ +
+
+ isConnected + string + + required + +
+ +
+ +
+
+ isNetworkConnected + string + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ isConnected + string + + required + +
+ +
+ +
+
+ isNetworkConnected + string + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/connected.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/connected.mdx new file mode 100644 index 0000000..fcfe507 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/connected.mdx @@ -0,0 +1,258 @@ +--- +title: "connected" +--- + +
+ + + + +
+ +

Remote dApp API

+ + +

connected

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC connected + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "connected" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "provider": { + "id": "" + }, + "connection": { + "isConnected": "", + "isNetworkConnected": "" + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
connected
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
StatusEvent
+
+ +
+
Required
+
connection, provider
+
+ +
+ + + + +
+ +
+
+ provider + object + + required + +
+ +
+ +
+
+ connection + object + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ provider + object + + required + +
+ +
+ +
+
+ connection + object + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/disconnect.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/disconnect.mdx new file mode 100644 index 0000000..2003cce --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/disconnect.mdx @@ -0,0 +1,193 @@ +--- +title: "disconnect" +--- + +
+ + + + +
+ +

Remote dApp API

+ + +

disconnect

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC disconnect + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "disconnect" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +"" +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
disconnect
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
null
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
null
+
+ +
+
Schema
+
Null
+
+ +
+ + + + + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/getactivenetwork.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/getactivenetwork.mdx new file mode 100644 index 0000000..3f8f40f --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/getactivenetwork.mdx @@ -0,0 +1,230 @@ +--- +title: "getActiveNetwork" +--- + +
+ + + + +
+ +

Remote dApp API

+ + +

getActiveNetwork

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC getActiveNetwork + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "getActiveNetwork" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "networkId": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
getActiveNetwork
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
Network
+
+ +
+
Required
+
networkId
+
+ +
+ + + + +
+ +
+
+ networkId + string + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ networkId + string + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/getprimaryaccount.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/getprimaryaccount.mdx new file mode 100644 index 0000000..29ba582 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/getprimaryaccount.mdx @@ -0,0 +1,391 @@ +--- +title: "getPrimaryAccount" +--- + +
+ + + + +
+ +

Remote dApp API

+ + +

getPrimaryAccount

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC getPrimaryAccount + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "getPrimaryAccount" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
getPrimaryAccount
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
Wallet
+
+ +
+
Required
+
hint, namespace, networkId, partyId, primary, publicKey, signingProviderId, status
+
+ +
+ + + + +
+ +
+
+ primary + string + + required + +
+ +
+ +
+
+ partyId + string + + required + +
+ +
+ +
+
+ status + string + + required + +
+ +
+ +
+
+ hint + string + + required + +
+ +
+ +
+
+ publicKey + string + + required + +
+ +
+ +
+
+ namespace + string + + required + +
+ +
+ +
+
+ networkId + string + + required + +
+ +
+ +
+
+ signingProviderId + string + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ primary + string + + required + +
+ +
+ +
+
+ partyId + string + + required + +
+ +
+ +
+
+ status + string + + required + +
+ +
+ +
+
+ hint + string + + required + +
+ +
+ +
+
+ publicKey + string + + required + +
+ +
+ +
+
+ namespace + string + + required + +
+ +
+ +
+
+ networkId + string + + required + +
+ +
+ +
+
+ signingProviderId + string + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/ledgerapi.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/ledgerapi.mdx new file mode 100644 index 0000000..e048427 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/ledgerapi.mdx @@ -0,0 +1,333 @@ +--- +title: "ledgerApi" +--- + +
+ + + + +
+ +

Remote dApp API

+ + +

ledgerApi

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC ledgerApi + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "ledgerApi", + "params": { + "params": { + "requestMethod": "", + "resource": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "response": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
ledgerApi
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
LedgerApiRequest
+
+ +
+
Required
+
requestMethod, resource
+
+ +
+ + + + +
+ +
+
+ requestMethod + string + + required + +
+ +
+ +
+
+ resource + string + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
LedgerApiResult
+
+ +
+
Required
+
response
+
+ +
+ + + + +
+ +
+
+ response + string + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ requestMethod + string + + required + +
+ +
+ +
+
+ resource + string + + required + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ response + string + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/listaccounts.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/listaccounts.mdx new file mode 100644 index 0000000..7a67395 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/listaccounts.mdx @@ -0,0 +1,234 @@ +--- +title: "listAccounts" +--- + +
+ + + + +
+ +

Remote dApp API

+ + +

listAccounts

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC listAccounts + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "listAccounts" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +[ + { + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" + } +] +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
listAccounts
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
array[object]
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
array[object]
+
+ +
+
Schema
+
ListAccountsResult
+
+ +
+ + + + +
+ +
+
+ items + object + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ items + object + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/onstatuschanged.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/onstatuschanged.mdx new file mode 100644 index 0000000..3081318 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/onstatuschanged.mdx @@ -0,0 +1,258 @@ +--- +title: "onStatusChanged" +--- + +
+ + + + +
+ +

Remote dApp API

+ + +

onStatusChanged

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC onStatusChanged + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "onStatusChanged" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "provider": { + "id": "" + }, + "connection": { + "isConnected": "", + "isNetworkConnected": "" + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
onStatusChanged
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
StatusEvent
+
+ +
+
Required
+
connection, provider
+
+ +
+ + + + +
+ +
+
+ provider + object + + required + +
+ +
+ +
+
+ connection + object + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ provider + object + + required + +
+ +
+ +
+
+ connection + object + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/prepareexecute.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/prepareexecute.mdx new file mode 100644 index 0000000..f0d8b12 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/prepareexecute.mdx @@ -0,0 +1,305 @@ +--- +title: "prepareExecute" +--- + +
+ + + + +
+ +

Remote dApp API

+ + +

prepareExecute

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC prepareExecute + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "prepareExecute", + "params": { + "params": { + "commands": {} + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "userUrl": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
prepareExecute
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
JsPrepareSubmissionRequest
+
+ +
+
Required
+
commands
+
+ +
+ + + + +
+ +
+
+ commands + object + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
userUrl
+
+ +
+ + + + +
+ +
+
+ userUrl + string + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ commands + object + + required + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ userUrl + string + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/signmessage.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/signmessage.mdx new file mode 100644 index 0000000..3e05958 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/signmessage.mdx @@ -0,0 +1,310 @@ +--- +title: "signMessage" +--- + +
+ + + + +
+ +

Remote dApp API

+ + +

signMessage

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC signMessage + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "signMessage", + "params": { + "params": { + "message": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "signature": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
signMessage
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
SignMessageRequest
+
+ +
+
Required
+
message
+
+ +
+ + + + +
+ +
+
+ message + string + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
SignMessageResult
+
+ +
+
Required
+
signature
+
+ +
+ + + + +
+ +
+
+ signature + string + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ message + string + + required + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ signature + string + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/status.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/status.mdx new file mode 100644 index 0000000..e080c48 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/status.mdx @@ -0,0 +1,258 @@ +--- +title: "status" +--- + +
+ + + + +
+ +

Remote dApp API

+ + +

status

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC status + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "status" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "provider": { + "id": "" + }, + "connection": { + "isConnected": "", + "isNetworkConnected": "" + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
status
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
StatusEvent
+
+ +
+
Required
+
connection, provider
+
+ +
+ + + + +
+ +
+
+ provider + object + + required + +
+ +
+ +
+
+ connection + object + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ provider + object + + required + +
+ +
+ +
+
+ connection + object + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/txchanged.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/txchanged.mdx new file mode 100644 index 0000000..920fd0f --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/txchanged.mdx @@ -0,0 +1,240 @@ +--- +title: "txChanged" +--- + +
+ + + + +
+ +

Remote dApp API

+ + +

txChanged

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC txChanged + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "txChanged" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "status": "", + "commandId": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
txChanged
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
oneOf
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
oneOf
+
+ +
+
Schema
+
TxChangedEvent
+
+ +
+ + + + +
+ +
+
+ status + string + +
+ +
+ +
+
+ commandId + string + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ status + string + +
+ +
+ +
+
+ commandId + string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/signing-api/createkey.mdx b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/createkey.mdx new file mode 100644 index 0000000..e50e4b2 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/createkey.mdx @@ -0,0 +1,310 @@ +--- +title: "createKey" +--- + +
+ + + + +
+ +

Signing API

+ + +

createKey

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC createKey + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "createKey", + "params": { + "params": { + "name": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "error": "", + "error_description": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
createKey
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
oneOf
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
name
+
+ +
+ + + + +
+ +
+
+ name + string + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
oneOf
+
+ +
+ + + + +
+ +
+
+ error + string + +
+ +
+ +
+
+ error_description + string + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ name + string + + required + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ error + string + +
+ +
+ +
+
+ error_description + string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/signing-api/getconfiguration.mdx b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/getconfiguration.mdx new file mode 100644 index 0000000..a509b2c --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/getconfiguration.mdx @@ -0,0 +1,188 @@ +--- +title: "getConfiguration" +--- + +
+ + + + +
+ +

Signing API

+ + +

getConfiguration

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC getConfiguration + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "getConfiguration" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
getConfiguration
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+ + + + + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/signing-api/getkeys.mdx b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/getkeys.mdx new file mode 100644 index 0000000..ab1c7a0 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/getkeys.mdx @@ -0,0 +1,235 @@ +--- +title: "getKeys" +--- + +
+ + + + +
+ +

Signing API

+ + +

getKeys

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC getKeys + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "getKeys" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "error": "", + "error_description": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
getKeys
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
oneOf
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
oneOf
+
+ +
+ + + + +
+ +
+
+ error + string + +
+ +
+ +
+
+ error_description + string + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ error + string + +
+ +
+ +
+
+ error_description + string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/signing-api/gettransaction.mdx b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/gettransaction.mdx new file mode 100644 index 0000000..267a709 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/gettransaction.mdx @@ -0,0 +1,310 @@ +--- +title: "getTransaction" +--- + +
+ + + + +
+ +

Signing API

+ + +

getTransaction

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC getTransaction + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "getTransaction", + "params": { + "params": { + "txId": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "error": "", + "error_description": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
getTransaction
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
oneOf
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
txId
+
+ +
+ + + + +
+ +
+
+ txId + string + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
oneOf
+
+ +
+ + + + +
+ +
+
+ error + string + +
+ +
+ +
+
+ error_description + string + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ txId + string + + required + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ error + string + +
+ +
+ +
+
+ error_description + string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/signing-api/gettransactions.mdx b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/gettransactions.mdx new file mode 100644 index 0000000..46981fe --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/gettransactions.mdx @@ -0,0 +1,324 @@ +--- +title: "getTransactions" +--- + +
+ + + + +
+ +

Signing API

+ + +

getTransactions

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC getTransactions + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "getTransactions", + "params": { + "params": { + "txIds": [ + "" + ], + "publicKeys": [ + "" + ] + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "error": "", + "error_description": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
getTransactions
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
oneOf
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+ + + + +
+ +
+
+ txIds + array[string] + +
+ +
+ +
+
+ publicKeys + array[string] + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
oneOf
+
+ +
+ + + + +
+ +
+
+ error + string + +
+ +
+ +
+
+ error_description + string + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ txIds + array[string] + +
+ +
+ +
+
+ publicKeys + array[string] + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ error + string + +
+ +
+ +
+
+ error_description + string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/signing-api/setconfiguration.mdx b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/setconfiguration.mdx new file mode 100644 index 0000000..5d6aad8 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/setconfiguration.mdx @@ -0,0 +1,226 @@ +--- +title: "setConfiguration" +--- + +
+ + + + +
+ +

Signing API

+ + +

setConfiguration

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC setConfiguration + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "setConfiguration", + "params": { + "params": {} + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
setConfiguration
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+ + + + + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/signing-api/signtransaction.mdx b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/signtransaction.mdx new file mode 100644 index 0000000..b3a6636 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/signtransaction.mdx @@ -0,0 +1,358 @@ +--- +title: "signTransaction" +--- + +
+ + + + +
+ +

Signing API

+ + +

signTransaction

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC signTransaction + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "signTransaction", + "params": { + "params": { + "tx": "", + "txHash": "", + "keyIdentifier": { + "publicKey": "" + } + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "error": "", + "error_description": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
signTransaction
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
oneOf
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
keyIdentifier, tx, txHash
+
+ +
+ + + + +
+ +
+
+ tx + string + + required + +
+ +
+ +
+
+ txHash + string + + required + +
+ +
+ +
+
+ keyIdentifier + object + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
oneOf
+
+ +
+ + + + +
+ +
+
+ error + string + +
+ +
+ +
+
+ error_description + string + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ tx + string + + required + +
+ +
+ +
+
+ txHash + string + + required + +
+ +
+ +
+
+ keyIdentifier + object + + required + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ error + string + +
+ +
+ +
+
+ error_description + string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/signing-api/subscribetransactions.mdx b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/subscribetransactions.mdx new file mode 100644 index 0000000..9a3b807 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/subscribetransactions.mdx @@ -0,0 +1,330 @@ +--- +title: "subscribeTransactions" +--- + +
+ + + + +
+ +

Signing API

+ + +

subscribeTransactions

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC subscribeTransactions + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "subscribeTransactions", + "params": { + "params": { + "txIds": [ + "" + ] + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "txId": "", + "status": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
subscribeTransactions
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
txIds
+
+ +
+ + + + +
+ +
+
+ txIds + array[string] + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
Transaction
+
+ +
+
Required
+
status, txId
+
+ +
+ + + + +
+ +
+
+ txId + string + + required + +
+ +
+ +
+
+ status + string + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ txIds + array[string] + + required + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ txId + string + + required + +
+ +
+ +
+
+ status + string + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/addidp.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/addidp.mdx new file mode 100644 index 0000000..051df48 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/addidp.mdx @@ -0,0 +1,272 @@ +--- +title: "addIdp" +--- + +
+ + + + +
+ +

User API

+ + +

addIdp

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC addIdp + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "addIdp", + "params": { + "params": { + "idp": { + "id": "", + "type": "", + "issuer": "" + } + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +"" +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
addIdp
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
null
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
idp
+
+ +
+ + + + +
+ +
+
+ idp + object + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
null
+
+ +
+
Schema
+
Null
+
+ +
+ + + + + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ idp + object + + required + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/addnetwork.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/addnetwork.mdx new file mode 100644 index 0000000..c462244 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/addnetwork.mdx @@ -0,0 +1,280 @@ +--- +title: "addNetwork" +--- + +
+ + + + +
+ +

User API

+ + +

addNetwork

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC addNetwork + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "addNetwork", + "params": { + "params": { + "network": { + "id": "", + "name": "", + "description": "", + "identityProviderId": "", + "auth": { + "method": "", + "scope": "", + "clientId": "", + "audience": "" + }, + "ledgerApi": "" + } + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +"" +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
addNetwork
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
null
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
network
+
+ +
+ + + + +
+ +
+
+ network + object + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
null
+
+ +
+
Schema
+
Null
+
+ +
+ + + + + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ network + object + + required + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/addsession.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/addsession.mdx new file mode 100644 index 0000000..d29c364 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/addsession.mdx @@ -0,0 +1,413 @@ +--- +title: "addSession" +--- + +
+ + + + +
+ +

User API

+ + +

addSession

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC addSession + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "addSession", + "params": { + "params": { + "networkId": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "id": "", + "network": { + "id": "", + "name": "", + "description": "", + "identityProviderId": "", + "auth": { + "method": "", + "scope": "", + "clientId": "", + "audience": "" + }, + "ledgerApi": "" + }, + "idp": { + "id": "", + "type": "", + "issuer": "" + }, + "accessToken": "", + "status": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
addSession
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
networkId
+
+ +
+ + + + +
+ +
+
+ networkId + string + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
Session
+
+ +
+
Required
+
accessToken, id, idp, network, status
+
+ +
+ + + + +
+ +
+
+ id + string + + required + +
+ +
+ +
+
+ network + object + + required + +
+ +
+ +
+
+ idp + object + + required + +
+ +
+ +
+
+ accessToken + string + + required + +
+ +
+ +
+
+ status + string + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ networkId + string + + required + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ id + string + + required + +
+ +
+ +
+
+ network + object + + required + +
+ +
+ +
+
+ idp + object + + required + +
+ +
+ +
+
+ accessToken + string + + required + +
+ +
+ +
+
+ status + string + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/allocatepartyforwallet.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/allocatepartyforwallet.mdx new file mode 100644 index 0000000..05ff786 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/allocatepartyforwallet.mdx @@ -0,0 +1,309 @@ +--- +title: "allocatePartyForWallet" +--- + +
+ + + + +
+ +

User API

+ + +

allocatePartyForWallet

+ + + +
+ + JSON-RPC + + Since 0.21.0 + +
+ + +
+ +
+ + POST + + JSON-RPC allocatePartyForWallet + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "allocatePartyForWallet", + "params": { + "params": { + "partyId": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "wallet": { + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
allocatePartyForWallet
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
partyId
+
+ +
+ + + + +
+ +
+
+ partyId + string + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
wallet
+
+ +
+ + + + +
+ +
+
+ wallet + object + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ partyId + string + + required + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ wallet + object + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/createwallet.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/createwallet.mdx new file mode 100644 index 0000000..9500d4d --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/createwallet.mdx @@ -0,0 +1,345 @@ +--- +title: "createWallet" +--- + +
+ + + + +
+ +

User API

+ + +

createWallet

+ + + +
+ + JSON-RPC + + Since 0.20.0 + + Changed 0.21.0 + +
+ + +
+ +
+ + POST + + JSON-RPC createWallet + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "createWallet", + "params": { + "params": { + "partyHint": "", + "signingProviderId": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "wallet": { + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
createWallet
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
partyHint, signingProviderId, networkId
+
+ +
+ + + + +
+ +
+
+ partyHint + string + + required + +
+ +
+ +
+
+ signingProviderId + string + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
wallet
+
+ +
+ + + + +
+ +
+
+ wallet + object + + required + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 0.21.0 + description updated +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ partyHint + string + + required + +
+ +
+ +
+
+ signingProviderId + string + + required + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ wallet + object + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/deletetransaction.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/deletetransaction.mdx new file mode 100644 index 0000000..55b8bab --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/deletetransaction.mdx @@ -0,0 +1,268 @@ +--- +title: "deleteTransaction" +--- + +
+ + + + +
+ +

User API

+ + +

deleteTransaction

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC deleteTransaction + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "deleteTransaction", + "params": { + "params": { + "commandId": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +"" +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
deleteTransaction
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
null
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
commandId
+
+ +
+ + + + +
+ +
+
+ commandId + string + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
null
+
+ +
+
Schema
+
Null
+
+ +
+ + + + + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ commandId + string + + required + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/execute.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/execute.mdx new file mode 100644 index 0000000..54150fe --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/execute.mdx @@ -0,0 +1,332 @@ +--- +title: "execute" +--- + +
+ + + + +
+ +

User API

+ + +

execute

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC execute + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "execute", + "params": { + "params": { + "signature": "", + "partyId": "", + "commandId": "", + "signedBy": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
execute
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
commandId, partyId, signature, signedBy
+
+ +
+ + + + +
+ +
+
+ signature + string + + required + +
+ +
+ +
+
+ partyId + string + + required + +
+ +
+ +
+
+ commandId + string + + required + +
+ +
+ +
+
+ signedBy + string + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+ + + + + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ signature + string + + required + +
+ +
+ +
+
+ partyId + string + + required + +
+ +
+ +
+
+ commandId + string + + required + +
+ +
+ +
+
+ signedBy + string + + required + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/gettransaction.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/gettransaction.mdx new file mode 100644 index 0000000..a837d89 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/gettransaction.mdx @@ -0,0 +1,374 @@ +--- +title: "getTransaction" +--- + +
+ + + + +
+ +

User API

+ + +

getTransaction

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC getTransaction + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "getTransaction", + "params": { + "params": { + "commandId": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "commandId": "", + "status": "", + "preparedTransaction": "", + "preparedTransactionHash": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
getTransaction
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
commandId
+
+ +
+ + + + +
+ +
+
+ commandId + string + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
Transaction
+
+ +
+
Required
+
commandId, preparedTransaction, preparedTransactionHash, status
+
+ +
+ + + + +
+ +
+
+ commandId + string + + required + +
+ +
+ +
+
+ status + string + + required + +
+ +
+ +
+
+ preparedTransaction + string + + required + +
+ +
+ +
+
+ preparedTransactionHash + string + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ commandId + string + + required + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ commandId + string + + required + +
+ +
+ +
+
+ status + string + + required + +
+ +
+ +
+
+ preparedTransaction + string + + required + +
+ +
+ +
+
+ preparedTransactionHash + string + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/getuser.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/getuser.mdx new file mode 100644 index 0000000..631b319 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/getuser.mdx @@ -0,0 +1,248 @@ +--- +title: "getUser" +--- + +
+ + + + +
+ +

User API

+ + +

getUser

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC getUser + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "getUser" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "userId": "", + "isAdmin": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
getUser
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
isAdmin, userId
+
+ +
+ + + + +
+ +
+
+ userId + string + + required + +
+ +
+ +
+
+ isAdmin + string + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ userId + string + + required + +
+ +
+ +
+
+ isAdmin + string + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/iswalletsyncneeded.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/iswalletsyncneeded.mdx new file mode 100644 index 0000000..3303f12 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/iswalletsyncneeded.mdx @@ -0,0 +1,225 @@ +--- +title: "isWalletSyncNeeded" +--- + +
+ + + + +
+ +

User API

+ + +

isWalletSyncNeeded

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC isWalletSyncNeeded + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "isWalletSyncNeeded" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "walletSyncNeeded": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
isWalletSyncNeeded
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
walletSyncNeeded
+
+ +
+ + + + +
+ +
+
+ walletSyncNeeded + string + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ walletSyncNeeded + string + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/listidps.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/listidps.mdx new file mode 100644 index 0000000..013e399 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/listidps.mdx @@ -0,0 +1,231 @@ +--- +title: "listIdps" +--- + +
+ + + + +
+ +

User API

+ + +

listIdps

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC listIdps + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "listIdps" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "idps": [ + { + "id": "", + "type": "", + "issuer": "" + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
listIdps
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
idps
+
+ +
+ + + + +
+ +
+
+ idps + array[object] + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ idps + array[object] + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/listnetworks.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/listnetworks.mdx new file mode 100644 index 0000000..4de1454 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/listnetworks.mdx @@ -0,0 +1,239 @@ +--- +title: "listNetworks" +--- + +
+ + + + +
+ +

User API

+ + +

listNetworks

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC listNetworks + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "listNetworks" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "networks": [ + { + "id": "", + "name": "", + "description": "", + "identityProviderId": "", + "auth": { + "method": "", + "scope": "", + "clientId": "", + "audience": "" + }, + "ledgerApi": "" + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
listNetworks
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
networks
+
+ +
+ + + + +
+ +
+
+ networks + array[object] + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ networks + array[object] + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/listsessions.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/listsessions.mdx new file mode 100644 index 0000000..0d523b9 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/listsessions.mdx @@ -0,0 +1,244 @@ +--- +title: "listSessions" +--- + +
+ + + + +
+ +

User API

+ + +

listSessions

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC listSessions + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "listSessions" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "sessions": [ + { + "id": "", + "network": { + "id": "", + "name": "", + "description": "", + "identityProviderId": "", + "auth": "", + "ledgerApi": "" + }, + "idp": { + "id": "", + "type": "", + "issuer": "" + }, + "accessToken": "", + "status": "" + } + ] +} +``` + + + + + + +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
listSessions
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
sessions
+
+ +
+ + + + +
+ +
+
+ sessions + array[object] + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ sessions + array[object] + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/listtransactions.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/listtransactions.mdx new file mode 100644 index 0000000..52b4f59 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/listtransactions.mdx @@ -0,0 +1,232 @@ +--- +title: "listTransactions" +--- + +
+ + + + +
+ +

User API

+ + +

listTransactions

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC listTransactions + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "listTransactions" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "transactions": [ + { + "commandId": "", + "status": "", + "preparedTransaction": "", + "preparedTransactionHash": "" + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
listTransactions
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
transactions
+
+ +
+ + + + +
+ +
+
+ transactions + array[object] + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ transactions + array[object] + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/listwallets.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/listwallets.mdx new file mode 100644 index 0000000..8a168ef --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/listwallets.mdx @@ -0,0 +1,302 @@ +--- +title: "listWallets" +--- + +
+ + + + +
+ +

User API

+ + +

listWallets

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC listWallets + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "listWallets", + "params": { + "params": { + "filter": { + "networkIds": [ + "" + ], + "signingProviderIds": [ + "" + ] + } + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +[ + { + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" + } +] +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
listWallets
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
array[object]
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+ + + + +
+ +
+
+ filter + object + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
array[object]
+
+ +
+ + + + +
+ +
+
+ items + object + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ filter + object + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ items + object + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/removeidp.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/removeidp.mdx new file mode 100644 index 0000000..dbd8be8 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/removeidp.mdx @@ -0,0 +1,268 @@ +--- +title: "removeIdp" +--- + +
+ + + + +
+ +

User API

+ + +

removeIdp

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC removeIdp + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "removeIdp", + "params": { + "params": { + "identityProviderId": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +"" +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
removeIdp
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
null
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
identityProviderId
+
+ +
+ + + + +
+ +
+
+ identityProviderId + string + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
null
+
+ +
+
Schema
+
Null
+
+ +
+ + + + + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ identityProviderId + string + + required + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/removenetwork.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/removenetwork.mdx new file mode 100644 index 0000000..f41e2aa --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/removenetwork.mdx @@ -0,0 +1,268 @@ +--- +title: "removeNetwork" +--- + +
+ + + + +
+ +

User API

+ + +

removeNetwork

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC removeNetwork + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "removeNetwork", + "params": { + "params": { + "networkName": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +"" +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
removeNetwork
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
null
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
networkName
+
+ +
+ + + + +
+ +
+
+ networkName + string + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
null
+
+ +
+
Schema
+
Null
+
+ +
+ + + + + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ networkName + string + + required + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/removesession.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/removesession.mdx new file mode 100644 index 0000000..4d00f3e --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/removesession.mdx @@ -0,0 +1,193 @@ +--- +title: "removeSession" +--- + +
+ + + + +
+ +

User API

+ + +

removeSession

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC removeSession + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "removeSession" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +"" +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
removeSession
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
null
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
null
+
+ +
+
Schema
+
Null
+
+ +
+ + + + + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/removewallet.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/removewallet.mdx new file mode 100644 index 0000000..f06b0c4 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/removewallet.mdx @@ -0,0 +1,263 @@ +--- +title: "removeWallet" +--- + +
+ + + + +
+ +

User API

+ + +

removeWallet

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC removeWallet + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "removeWallet", + "params": { + "params": { + "partyId": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
removeWallet
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
partyId
+
+ +
+ + + + +
+ +
+
+ partyId + string + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+ + + + + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ partyId + string + + required + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/setprimarywallet.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/setprimarywallet.mdx new file mode 100644 index 0000000..e7fddd5 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/setprimarywallet.mdx @@ -0,0 +1,268 @@ +--- +title: "setPrimaryWallet" +--- + +
+ + + + +
+ +

User API

+ + +

setPrimaryWallet

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC setPrimaryWallet + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "setPrimaryWallet", + "params": { + "params": { + "partyId": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +"" +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
setPrimaryWallet
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
null
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
partyId
+
+ +
+ + + + +
+ +
+
+ partyId + string + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
null
+
+ +
+
Schema
+
Null
+
+ +
+ + + + + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ partyId + string + + required + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/sign.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/sign.mdx new file mode 100644 index 0000000..c5232a7 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/sign.mdx @@ -0,0 +1,415 @@ +--- +title: "sign" +--- + +
+ + + + +
+ +

User API

+ + +

sign

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC sign + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "sign", + "params": { + "params": { + "preparedTransaction": "", + "preparedTransactionHash": "", + "commandId": "", + "partyId": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "signature": "", + "partyId": "", + "signedBy": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
sign
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
commandId, partyId, preparedTransaction, preparedTransactionHash
+
+ +
+ + + + +
+ +
+
+ preparedTransaction + string + + required + +
+ +
+ +
+
+ preparedTransactionHash + string + + required + +
+ +
+ +
+
+ commandId + string + + required + +
+ +
+ +
+
+ partyId + string + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
partyId, signature, signedBy
+
+ +
+ + + + +
+ +
+
+ signature + string + + required + +
+ +
+ +
+
+ partyId + string + + required + +
+ +
+ +
+
+ signedBy + string + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ preparedTransaction + string + + required + +
+ +
+ +
+
+ preparedTransactionHash + string + + required + +
+ +
+ +
+
+ commandId + string + + required + +
+ +
+ +
+
+ partyId + string + + required + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ signature + string + + required + +
+ +
+ +
+
+ partyId + string + + required + +
+ +
+ +
+
+ signedBy + string + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/syncwallets.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/syncwallets.mdx new file mode 100644 index 0000000..68fc24e --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/syncwallets.mdx @@ -0,0 +1,317 @@ +--- +title: "syncWallets" +--- + +
+ + + + +
+ +

User API

+ + +

syncWallets

+ + + +
+ + JSON-RPC + + Since 0.20.0 + + Changed 0.21.0 + +
+ + +
+ +
+ + POST + + JSON-RPC syncWallets + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "syncWallets" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "added": [ + { + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" + } + ], + "updated": [ + { + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" + } + ], + "disabled": [ + { + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
syncWallets
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
added, disabled, updated
+
+ +
+ + + + +
+ +
+
+ added + array[object] + + required + +
+ +
+ +
+
+ updated + array[object] + + required + +
+ +
+ +
+
+ disabled + array[object] + + required + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 0.21.0 + result updated (required fields) +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ added + array[object] + + required + +
+ +
+ +
+
+ updated + array[object] + + required + +
+ +
+ +
+
+ disabled + array[object] + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected/specs/dapp-api.mdx b/tests/fixtures/characterization/openrpc/expected/specs/dapp-api.mdx index 97b865e..eea26a6 100644 --- a/tests/fixtures/characterization/openrpc/expected/specs/dapp-api.mdx +++ b/tests/fixtures/characterization/openrpc/expected/specs/dapp-api.mdx @@ -1,424 +1,504 @@ --- title: "dApp API" -description: "Splice Wallet JSON-RPC dApp API" +description: "An OpenRPC specification for the dapp to interact with a Wallet Provider." --- -# dApp API +

Back to overview

+ +
+ +

OpenRPC Spec

+ + +

dApp API

+ + +

An OpenRPC specification for the dapp to interact with a Wallet Provider.

+ + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+
Latest source path
+
api-specs/openrpc-dapp-api.json
+
+ +
+
Publish version
+
0.21.0
+
+ +
+
OpenRPC version
+
1.2.6
+
+ +
+
Spec info.version
+
0.5.0
+
+ +
+ +
-[Back to overview](/reference/wallet-gateway-json-rpc) - -An OpenRPC specification for the dapp to interact with a Wallet Provider. - -- Latest source path: `api-specs/openrpc-dapp-api.json` -- Publish version: `0.21.0` -- OpenRPC version: `1.2.6` -- Spec info.version: `0.5.0` - -## Version Change Timeline - -| Version | Active Methods | Added | Changed | Removed | -| --- | --- | --- | --- | --- | -| `0.20.0` | 12 | 0 | 0 | 0 | -| `0.21.0` | 12 | 0 | 0 | 0 | - -## Table of Contents - -🟢 Active Since 🔵 Changed 🔴 Removed - -| NAME | STATUS | SUMMARY | -| --- | --- | --- | -| [`accountsChanged`](#method-accountschanged) | 🟢 `v0.20` | - | -| [`connect`](#method-connect) | 🟢 `v0.20` | Ensures ledger connectivity and returns the connected network information along with the session information. | -| [`disconnect`](#method-disconnect) | 🟢 `v0.20` | Invoke a disconnect of the wallet provider session. | -| [`getActiveNetwork`](#method-getactivenetwork) | 🟢 `v0.20` | Returns the active network. | -| [`getPrimaryAccount`](#method-getprimaryaccount) | 🟢 `v0.20` | Returns the primary account. | -| [`ledgerApi`](#method-ledgerapi) | 🟢 `v0.20` | Proxy for the JSON-API endpoints. Injects authorization headers automatically. | -| [`listAccounts`](#method-listaccounts) | 🟢 `v0.20` | Lists the addresses (wallets) with their properties; including which network they are associated to and with signing provider is used. | -| [`prepareExecute`](#method-prepareexecute) | 🟢 `v0.20` | Prepares a transaction for subsequent signing & execution. | -| [`prepareExecuteAndWait`](#method-prepareexecuteandwait) | 🟢 `v0.20` | Like prepareExecute, but waits for the transaction to be executed on the ledger. | -| [`signMessage`](#method-signmessage) | 🟢 `v0.20` | Signs a message. | -| [`status`](#method-status) | 🟢 `v0.20` | Returns the current status of the wallet provider session. | -| [`txChanged`](#method-txchanged) | 🟢 `v0.20` | - | ## Methods - -### `accountsChanged` - -- Introduced: `0.20.0` - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `array[object]` | - | - | - -**Result Example** - -```json -[ - { - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" - } -] -``` - - -### `connect` - -- Introduced: `0.20.0` - -Ensures ledger connectivity and returns the connected network information along with the session information. - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `isConnected`, `isNetworkConnected` | - | - -**Result Example** - -```json -{ - "isConnected": "", - "isNetworkConnected": "" -} -``` - - -### `disconnect` - -- Introduced: `0.20.0` - -Invoke a disconnect of the wallet provider session. - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `null` | - | - | - -**Result Example** - -```json -"" -``` - - -### `getActiveNetwork` - -- Introduced: `0.20.0` - -Returns the active network. - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `networkId` | - | - -**Result Example** - -```json -{ - "networkId": "" -} -``` - - -### `getPrimaryAccount` - -- Introduced: `0.20.0` - -Returns the primary account. - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `hint`, `namespace`, `networkId`, `partyId`, `primary`, `publicKey`, `signingProviderId`, `status` | - | - -**Result Example** - -```json -{ - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" -} -``` - - -### `ledgerApi` - -- Introduced: `0.20.0` - -Proxy for the JSON-API endpoints. Injects authorization headers automatically. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `requestMethod`, `resource` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `response` | - | - -**Params Example** - -```json -{ - "params": { - "requestMethod": "", - "resource": "" - } -} -``` - -**Result Example** - -```json -{ - "response": "" -} -``` - - -### `listAccounts` - -- Introduced: `0.20.0` - -Lists the addresses (wallets) with their properties; including which network they are associated to and with signing provider is used. - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `array[object]` | - | - | - -**Result Example** - -```json -[ - { - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" - } -] -``` - - -### `prepareExecute` - -- Introduced: `0.20.0` - -Prepares a transaction for subsequent signing & execution. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `commands` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `null` | - | - | - -**Params Example** - -```json -{ - "params": { - "commands": {} - } -} -``` - -**Result Example** - -```json -"" -``` - - -### `prepareExecuteAndWait` - -- Introduced: `0.20.0` - -Like prepareExecute, but waits for the transaction to be executed on the ledger. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `commands` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `tx` | - | - -**Params Example** - -```json -{ - "params": { - "commands": {} - } -} -``` - -**Result Example** - -```json -{ - "tx": { - "status": "", - "commandId": "", - "payload": { - "updateId": "", - "completionOffset": "" - } - } -} -``` - - -### `signMessage` - -- Introduced: `0.20.0` - -Signs a message. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `message` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `signature` | - | - -**Params Example** - -```json -{ - "params": { - "message": "" - } -} -``` - -**Result Example** - -```json -{ - "signature": "" -} -``` - - -### `status` - -- Introduced: `0.20.0` - -Returns the current status of the wallet provider session. - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `connection`, `provider` | - | - -**Result Example** - -```json -{ - "provider": { - "id": "" - }, - "connection": { - "isConnected": "", - "isNetworkConnected": "" - } -} -``` - - -### `txChanged` - -- Introduced: `0.20.0` - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `oneOf` | - | - | - -**Result Example** -```json -{ - "status": "", - "commandId": "" -} -``` +Method pages are the primary reference surface. This spec page stays focused on grouping and discovery. + + + +
+ + + + +
+

accountsChanged

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
array[object]
+
+ +
+ + + + + + + + +
+

connect

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Ensures ledger connectivity and returns the connected network information along with the session information.

+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

disconnect

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Invoke a disconnect of the wallet provider session.

+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
null
+
+ +
+ + + + + + + + +
+

getActiveNetwork

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Returns the active network.

+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

getPrimaryAccount

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Returns the primary account.

+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

ledgerApi

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Proxy for the JSON-API endpoints. Injects authorization headers automatically.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

listAccounts

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Lists the addresses (wallets) with their properties; including which network they are associated to and with signing provider is used.

+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
array[object]
+
+ +
+ + + + + + + + +
+

prepareExecute

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Prepares a transaction for subsequent signing & execution.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
null
+
+ +
+ + + + + + + + +
+

prepareExecuteAndWait

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Like prepareExecute, but waits for the transaction to be executed on the ledger.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

signMessage

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Signs a message.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

status

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Returns the current status of the wallet provider session.

+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

txChanged

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
oneOf
+
+ +
+ + + + + +
diff --git a/tests/fixtures/characterization/openrpc/expected/specs/dapp-remote-api.mdx b/tests/fixtures/characterization/openrpc/expected/specs/dapp-remote-api.mdx index 347a3c3..f6bc321 100644 --- a/tests/fixtures/characterization/openrpc/expected/specs/dapp-remote-api.mdx +++ b/tests/fixtures/characterization/openrpc/expected/specs/dapp-remote-api.mdx @@ -1,441 +1,537 @@ --- title: "Remote dApp API" -description: "Splice Wallet JSON-RPC Remote dApp API" +description: "An OpenRPC specification for remotely hosted Wallet Providers. Due to the remote nature, an implementing provider must bridge certain functionality on the client-side to satisfy the general dApp API spec." --- -# Remote dApp API +

Back to overview

+ +
+ +

OpenRPC Spec

+ + +

Remote dApp API

+ + +

An OpenRPC specification for remotely hosted Wallet Providers. Due to the remote nature, an implementing provider must bridge certain functionality on the client-side to satisfy the general dApp API spec.

+ + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+
Latest source path
+
api-specs/openrpc-dapp-remote-api.json
+
+ +
+
Publish version
+
0.21.0
+
+ +
+
OpenRPC version
+
1.2.6
+
+ +
+
Spec info.version
+
0.1.0
+
+ +
+ +
-[Back to overview](/reference/wallet-gateway-json-rpc) - -An OpenRPC specification for remotely hosted Wallet Providers. Due to the remote nature, an implementing provider must bridge certain functionality on the client-side to satisfy the general dApp API spec. - -- Latest source path: `api-specs/openrpc-dapp-remote-api.json` -- Publish version: `0.21.0` -- OpenRPC version: `1.2.6` -- Spec info.version: `0.1.0` - -## Version Change Timeline - -| Version | Active Methods | Added | Changed | Removed | -| --- | --- | --- | --- | --- | -| `0.20.0` | 13 | 0 | 0 | 0 | -| `0.21.0` | 13 | 0 | 0 | 0 | - -## Table of Contents - -🟢 Active Since 🔵 Changed 🔴 Removed - -| NAME | STATUS | SUMMARY | -| --- | --- | --- | -| [`accountsChanged`](#method-accountschanged) | 🟢 `v0.20` | - | -| [`connect`](#method-connect) | 🟢 `v0.20` | Ensures ledger connectivity and returns the connected network information. | -| [`connected`](#method-connected) | 🟢 `v0.20` | Informs when the user connects to a network. | -| [`disconnect`](#method-disconnect) | 🟢 `v0.20` | Invoke a disconnect of the wallet gateway session. | -| [`getActiveNetwork`](#method-getactivenetwork) | 🟢 `v0.20` | Returns the active network. | -| [`getPrimaryAccount`](#method-getprimaryaccount) | 🟢 `v0.20` | Returns the primary account. | -| [`ledgerApi`](#method-ledgerapi) | 🟢 `v0.20` | Proxy for the JSON-API endpoints. Injects authorization headers automatically. | -| [`listAccounts`](#method-listaccounts) | 🟢 `v0.20` | - | -| [`onStatusChanged`](#method-onstatuschanged) | 🟢 `v0.20` | - | -| [`prepareExecute`](#method-prepareexecute) | 🟢 `v0.20` | Prepares, signs, and executes a transaction. | -| [`signMessage`](#method-signmessage) | 🟢 `v0.20` | Signs a message. | -| [`status`](#method-status) | 🟢 `v0.20` | Returns the current status of the wallet provider session. | -| [`txChanged`](#method-txchanged) | 🟢 `v0.20` | - | ## Methods - -### `accountsChanged` - -- Introduced: `0.20.0` - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `array[object]` | - | - | - -**Result Example** - -```json -[ - { - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" - } -] -``` - - -### `connect` - -- Introduced: `0.20.0` - -Ensures ledger connectivity and returns the connected network information. - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `isConnected`, `isNetworkConnected` | - | - -**Result Example** - -```json -{ - "isConnected": "", - "isNetworkConnected": "" -} -``` - - -### `connected` - -- Introduced: `0.20.0` - -Informs when the user connects to a network. - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `connection`, `provider` | - | - -**Result Example** - -```json -{ - "provider": { - "id": "" - }, - "connection": { - "isConnected": "", - "isNetworkConnected": "" - } -} -``` - - -### `disconnect` - -- Introduced: `0.20.0` - -Invoke a disconnect of the wallet gateway session. - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `null` | - | - | - -**Result Example** - -```json -"" -``` - - -### `getActiveNetwork` - -- Introduced: `0.20.0` - -Returns the active network. - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `networkId` | - | - -**Result Example** - -```json -{ - "networkId": "" -} -``` - - -### `getPrimaryAccount` - -- Introduced: `0.20.0` - -Returns the primary account. - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `hint`, `namespace`, `networkId`, `partyId`, `primary`, `publicKey`, `signingProviderId`, `status` | - | - -**Result Example** - -```json -{ - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" -} -``` - - -### `ledgerApi` - -- Introduced: `0.20.0` - -Proxy for the JSON-API endpoints. Injects authorization headers automatically. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `requestMethod`, `resource` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `response` | - | - -**Params Example** - -```json -{ - "params": { - "requestMethod": "", - "resource": "" - } -} -``` - -**Result Example** - -```json -{ - "response": "" -} -``` - - -### `listAccounts` - -- Introduced: `0.20.0` - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `array[object]` | - | - | - -**Result Example** - -```json -[ - { - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" - } -] -``` - - -### `onStatusChanged` - -- Introduced: `0.20.0` - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `connection`, `provider` | - | - -**Result Example** - -```json -{ - "provider": { - "id": "" - }, - "connection": { - "isConnected": "", - "isNetworkConnected": "" - } -} -``` - - -### `prepareExecute` - -- Introduced: `0.20.0` - -Prepares, signs, and executes a transaction. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `commands` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `userUrl` | - | - -**Params Example** - -```json -{ - "params": { - "commands": {} - } -} -``` - -**Result Example** - -```json -{ - "userUrl": "" -} -``` - - -### `signMessage` - -- Introduced: `0.20.0` - -Signs a message. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `message` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `signature` | - | - -**Params Example** - -```json -{ - "params": { - "message": "" - } -} -``` - -**Result Example** - -```json -{ - "signature": "" -} -``` - - -### `status` - -- Introduced: `0.20.0` - -Returns the current status of the wallet provider session. - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `connection`, `provider` | - | - -**Result Example** - -```json -{ - "provider": { - "id": "" - }, - "connection": { - "isConnected": "", - "isNetworkConnected": "" - } -} -``` - - -### `txChanged` - -- Introduced: `0.20.0` - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `oneOf` | - | - | - -**Result Example** -```json -{ - "status": "", - "commandId": "" -} -``` +Method pages are the primary reference surface. This spec page stays focused on grouping and discovery. + + + +
+ + + + +
+

accountsChanged

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
array[object]
+
+ +
+ + + + + + + + +
+

connect

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Ensures ledger connectivity and returns the connected network information.

+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

connected

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Informs when the user connects to a network.

+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

disconnect

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Invoke a disconnect of the wallet gateway session.

+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
null
+
+ +
+ + + + + + + + +
+

getActiveNetwork

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Returns the active network.

+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

getPrimaryAccount

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Returns the primary account.

+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

ledgerApi

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Proxy for the JSON-API endpoints. Injects authorization headers automatically.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

listAccounts

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
array[object]
+
+ +
+ + + + + + + + +
+

onStatusChanged

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

prepareExecute

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Prepares, signs, and executes a transaction.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

signMessage

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Signs a message.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

status

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Returns the current status of the wallet provider session.

+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

txChanged

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
oneOf
+
+ +
+ + + + + +
diff --git a/tests/fixtures/characterization/openrpc/expected/specs/signing-api.mdx b/tests/fixtures/characterization/openrpc/expected/specs/signing-api.mdx index 81d568d..8b35b7c 100644 --- a/tests/fixtures/characterization/openrpc/expected/specs/signing-api.mdx +++ b/tests/fixtures/characterization/openrpc/expected/specs/signing-api.mdx @@ -1,320 +1,358 @@ --- title: "Signing API" -description: "Wallet JSON-RPC Signing API" +description: "An OpenRPC specification for the Signing API which allows the Wallet Gateway to interact with a Wallet Providers." --- -# Signing API +

Back to overview

+ +
+ +

OpenRPC Spec

+ + +

Signing API

+ + +

An OpenRPC specification for the Signing API which allows the Wallet Gateway to interact with a Wallet Providers.

+ + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+
Latest source path
+
api-specs/openrpc-signing-api.json
+
+ +
+
Publish version
+
0.21.0
+
+ +
+
OpenRPC version
+
1.2.6
+
+ +
+
Spec info.version
+
0.1.0
+
+ +
+ +
-[Back to overview](/reference/wallet-gateway-json-rpc) - -An OpenRPC specification for the Signing API which allows the Wallet Gateway to interact with a Wallet Providers. - -- Latest source path: `api-specs/openrpc-signing-api.json` -- Publish version: `0.21.0` -- OpenRPC version: `1.2.6` -- Spec info.version: `0.1.0` - -## Version Change Timeline - -| Version | Active Methods | Added | Changed | Removed | -| --- | --- | --- | --- | --- | -| `0.20.0` | 8 | 0 | 0 | 0 | -| `0.21.0` | 8 | 0 | 0 | 0 | - -## Table of Contents - -🟢 Active Since 🔵 Changed 🔴 Removed - -| NAME | STATUS | SUMMARY | -| --- | --- | --- | -| [`createKey`](#method-createkey) | 🟢 `v0.20` | Create a new key at the Wallet Provider. | -| [`getConfiguration`](#method-getconfiguration) | 🟢 `v0.20` | - | -| [`getKeys`](#method-getkeys) | 🟢 `v0.20` | Get a list of public keys availabile for signing. | -| [`getTransaction`](#method-gettransaction) | 🟢 `v0.20` | Get the status of a single transaction by its ID. | -| [`getTransactions`](#method-gettransactions) | 🟢 `v0.20` | Get the status of multiple transactions, filtering by txIds or publicKeys. Either publicKeys or txIds must be provided. | -| [`setConfiguration`](#method-setconfiguration) | 🟢 `v0.20` | Set configuration parameters for the Wallet Provider. The paramaters will change depending on the Wallet Provider implementation | -| [`signTransaction`](#method-signtransaction) | 🟢 `v0.20` | Uses the Wallet Provider to sign a transaction. This will likely be an asynchronous operation. | -| [`subscribeTransactions`](#method-subscribetransactions) | 🟢 `v0.20` | Subscribe to updates for specific transactions. The server will emit updates when the status of the specified transactions have changed. On initial subscription, the server will emit the current status of all subscribed transactions. | ## Methods - -### `createKey` - -- Introduced: `0.20.0` - -Create a new key at the Wallet Provider. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `name` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `oneOf` | - | - | - -**Params Example** - -```json -{ - "params": { - "name": "" - } -} -``` - -**Result Example** - -```json -{ - "error": "", - "error_description": "" -} -``` - - -### `getConfiguration` - -- Introduced: `0.20.0` - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | - | - | - -**Result Example** - -```json -{} -``` - - -### `getKeys` - -- Introduced: `0.20.0` - -Get a list of public keys availabile for signing. - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `oneOf` | - | - | - -**Result Example** - -```json -{ - "error": "", - "error_description": "" -} -``` - - -### `getTransaction` - -- Introduced: `0.20.0` - -Get the status of a single transaction by its ID. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `txId` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `oneOf` | - | - | - -**Params Example** - -```json -{ - "params": { - "txId": "" - } -} -``` - -**Result Example** - -```json -{ - "error": "", - "error_description": "" -} -``` - - -### `getTransactions` - -- Introduced: `0.20.0` - -Get the status of multiple transactions, filtering by txIds or publicKeys. Either publicKeys or txIds must be provided. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | - | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `oneOf` | - | - | - -**Params Example** - -```json -{ - "params": { - "txIds": [ - "" - ], - "publicKeys": [ - "" - ] - } -} -``` - -**Result Example** - -```json -{ - "error": "", - "error_description": "" -} -``` - - -### `setConfiguration` - -- Introduced: `0.20.0` - -Set configuration parameters for the Wallet Provider. The paramaters will change depending on the Wallet Provider implementation - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | - | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | - | - | - -**Params Example** - -```json -{ - "params": {} -} -``` - -**Result Example** - -```json -{} -``` - - -### `signTransaction` - -- Introduced: `0.20.0` - -Uses the Wallet Provider to sign a transaction. This will likely be an asynchronous operation. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `keyIdentifier`, `tx`, `txHash` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `oneOf` | - | The resulting transaction entry at the Wallet Provider. This will include the signature if the transaction was immediately signed. | - -**Params Example** - -```json -{ - "params": { - "tx": "", - "txHash": "", - "keyIdentifier": { - "publicKey": "" - } - } -} -``` - -**Result Example** - -```json -{ - "error": "", - "error_description": "" -} -``` - - -### `subscribeTransactions` - -- Introduced: `0.20.0` - -Subscribe to updates for specific transactions. The server will emit updates when the status of the specified transactions have changed. On initial subscription, the server will emit the current status of all subscribed transactions. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `txIds` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `status`, `txId` | - | - -**Params Example** - -```json -{ - "params": { - "txIds": [ - "" - ] - } -} -``` - -**Result Example** -```json -{ - "txId": "", - "status": "" -} -``` +Method pages are the primary reference surface. This spec page stays focused on grouping and discovery. + + + +
+ + + + +
+

createKey

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Create a new key at the Wallet Provider.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
oneOf
+
+ +
+ + + + + + + + +
+

getConfiguration

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

getKeys

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Get a list of public keys availabile for signing.

+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
oneOf
+
+ +
+ + + + + + + + +
+

getTransaction

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Get the status of a single transaction by its ID.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
oneOf
+
+ +
+ + + + + + + + +
+

getTransactions

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Get the status of multiple transactions, filtering by txIds or publicKeys. Either publicKeys or txIds must be provided.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
oneOf
+
+ +
+ + + + + + + + +
+

setConfiguration

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Set configuration parameters for the Wallet Provider. The paramaters will change depending on the Wallet Provider implementation

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

signTransaction

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Uses the Wallet Provider to sign a transaction. This will likely be an asynchronous operation.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
oneOf
+
+ +
+ + + + + + + + +
+

subscribeTransactions

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Subscribe to updates for specific transactions. The server will emit updates when the status of the specified transactions have changed. On initial subscription, the s...

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + + + + +
diff --git a/tests/fixtures/characterization/openrpc/expected/specs/user-api.mdx b/tests/fixtures/characterization/openrpc/expected/specs/user-api.mdx index c65536a..7026210 100644 --- a/tests/fixtures/characterization/openrpc/expected/specs/user-api.mdx +++ b/tests/fixtures/characterization/openrpc/expected/specs/user-api.mdx @@ -1,921 +1,874 @@ --- title: "User API" -description: "Splice Wallet JSON-RPC User API" +description: "An OpenRPC specification for the user to interact with the Wallet Gateway." --- -# User API - -[Back to overview](/reference/wallet-gateway-json-rpc) - -An OpenRPC specification for the user to interact with the Wallet Gateway. - -- Latest source path: `api-specs/openrpc-user-api.json` -- Publish version: `0.21.0` -- OpenRPC version: `1.2.6` -- Spec info.version: `0.1.0` - -## Version Change Timeline - -| Version | Active Methods | Added | Changed | Removed | -| --- | --- | --- | --- | --- | -| `0.20.0` | 21 | 0 | 0 | 0 | -| `0.21.0` | 22 | 1 | 2 | 0 | - -## Table of Contents - -🟢 Active Since 🔵 Changed 🔴 Removed - -| NAME | STATUS | SUMMARY | -| --- | --- | --- | -| [`addIdp`](#method-addidp) | 🟢 `v0.20` | Adds a new identity provider. | -| [`addNetwork`](#method-addnetwork) | 🟢 `v0.20` | Adds a new network configuration (similar to EIP-3085). | -| [`addSession`](#method-addsession) | 🟢 `v0.20` | Adds a network session. | -| [`allocatePartyForWallet`](#method-allocatepartyforwallet) | 🟢 `v0.21` | Allocates a party for an already initialized wallet if external signing is complete. | -| [`createWallet`](#method-createwallet) | 🟢 `v0.20` 🔵 `v0.21` | Creates a new wallet and party with the given hint. | -| [`deleteTransaction`](#method-deletetransaction) | 🟢 `v0.20` | Deletes a pending transaction. Only transactions with status 'pending' can be deleted. | -| [`execute`](#method-execute) | 🟢 `v0.20` | Executes a signed transaction. | -| [`getTransaction`](#method-gettransaction) | 🟢 `v0.20` | - | -| [`getUser`](#method-getuser) | 🟢 `v0.20` | Returns information about the current user, including whether they are an admin. | -| [`isWalletSyncNeeded`](#method-iswalletsyncneeded) | 🟢 `v0.20` | Checks if wallet sync is needed (disabled wallets or new parties on ledger). | -| [`listIdps`](#method-listidps) | 🟢 `v0.20` | - | -| [`listNetworks`](#method-listnetworks) | 🟢 `v0.20` | - | -| [`listSessions`](#method-listsessions) | 🟢 `v0.20` | - | -| [`listTransactions`](#method-listtransactions) | 🟢 `v0.20` | - | -| [`listWallets`](#method-listwallets) | 🟢 `v0.20` | Lists wallets. | -| [`removeIdp`](#method-removeidp) | 🟢 `v0.20` | Removes an identity provider. Fails if an existing network is using the identity provider. | -| [`removeNetwork`](#method-removenetwork) | 🟢 `v0.20` | Removes a new network configuration (similar to EIP-3085). | -| [`removeSession`](#method-removesession) | 🟢 `v0.20` | Removes the current network session. | -| [`removeWallet`](#method-removewallet) | 🟢 `v0.20` | Removes a party with the given hint. | -| [`setPrimaryWallet`](#method-setprimarywallet) | 🟢 `v0.20` | Sets the specified wallet as the primary wallet for dApp usage. | -| [`sign`](#method-sign) | 🟢 `v0.20` | Signs the provided data with the private key of the specified or active party. | -| [`syncWallets`](#method-syncwallets) | 🟢 `v0.20` 🔵 `v0.21` | Synchronizes wallets with the connected network. | +

Back to overview

+ +
+ +

OpenRPC Spec

+ + +

User API

+ + +

An OpenRPC specification for the user to interact with the Wallet Gateway.

+ + +
+ + JSON-RPC + + Since 0.20.0 + + Changed 0.21.0 + +
+ + +
+ +
+
Latest source path
+
api-specs/openrpc-user-api.json
+
+ +
+
Publish version
+
0.21.0
+
+ +
+
OpenRPC version
+
1.2.6
+
+ +
+
Spec info.version
+
0.1.0
+
+ +
+ +
-## Methods - - -### `addIdp` - -- Introduced: `0.20.0` - -Adds a new identity provider. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `idp` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `null` | - | - | - -**Params Example** - -```json -{ - "params": { - "idp": { - "id": "", - "type": "", - "issuer": "" - } - } -} -``` - -**Result Example** - -```json -"" -``` - - -### `addNetwork` - -- Introduced: `0.20.0` - -Adds a new network configuration (similar to EIP-3085). - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `network` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `null` | - | - | - -**Params Example** - -```json -{ - "params": { - "network": { - "id": "", - "name": "", - "description": "", - "identityProviderId": "", - "auth": { - "method": "", - "scope": "", - "clientId": "", - "audience": "" - }, - "ledgerApi": "" - } - } -} -``` - -**Result Example** - -```json -"" -``` - - -### `addSession` - -- Introduced: `0.20.0` - -Adds a network session. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `networkId` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `accessToken`, `id`, `idp`, `network`, `status` | - | - -**Params Example** - -```json -{ - "params": { - "networkId": "" - } -} -``` - -**Result Example** - -```json -{ - "id": "", - "network": { - "id": "", - "name": "", - "description": "", - "identityProviderId": "", - "auth": { - "method": "", - "scope": "", - "clientId": "", - "audience": "" - }, - "ledgerApi": "" - }, - "idp": { - "id": "", - "type": "", - "issuer": "" - }, - "accessToken": "", - "status": "" -} -``` - - -### `allocatePartyForWallet` - -- Introduced: `0.21.0` - -Allocates a party for an already initialized wallet if external signing is complete. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `partyId` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `wallet` | - | - -**Params Example** - -```json -{ - "params": { - "partyId": "" - } -} -``` - -**Result Example** - -```json -{ - "wallet": { - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" - } -} -``` - - -### `createWallet` - -- Introduced: `0.20.0` -Changed in: `0.21.0` - -Creates a new wallet and party with the given hint. - -**Version Changes** - -| Version | Changes | -| --- | --- | -| `0.21.0` | description updated | - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `partyHint`, `signingProviderId`, `networkId` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `wallet` | - | - -**Params Example** - -```json -{ - "params": { - "partyHint": "", - "signingProviderId": "" - } -} -``` - -**Result Example** - -```json -{ - "wallet": { - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" - } -} -``` - - -### `deleteTransaction` - -- Introduced: `0.20.0` - -Deletes a pending transaction. Only transactions with status 'pending' can be deleted. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `commandId` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `null` | - | - | - -**Params Example** - -```json -{ - "params": { - "commandId": "" - } -} -``` - -**Result Example** - -```json -"" -``` - - -### `execute` - -- Introduced: `0.20.0` - -Executes a signed transaction. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `commandId`, `partyId`, `signature`, `signedBy` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | - | - | - -**Params Example** - -```json -{ - "params": { - "signature": "", - "partyId": "", - "commandId": "", - "signedBy": "" - } -} -``` - -**Result Example** - -```json -{} -``` - - -### `getTransaction` - -- Introduced: `0.20.0` - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `commandId` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `commandId`, `preparedTransaction`, `preparedTransactionHash`, `status` | - | - -**Params Example** - -```json -{ - "params": { - "commandId": "" - } -} -``` - -**Result Example** - -```json -{ - "commandId": "", - "status": "", - "preparedTransaction": "", - "preparedTransactionHash": "" -} -``` - - -### `getUser` - -- Introduced: `0.20.0` - -Returns information about the current user, including whether they are an admin. - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `isAdmin`, `userId` | - | - -**Result Example** - -```json -{ - "userId": "", - "isAdmin": "" -} -``` - - -### `isWalletSyncNeeded` - -- Introduced: `0.20.0` - -Checks if wallet sync is needed (disabled wallets or new parties on ledger). - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `walletSyncNeeded` | - | - -**Result Example** - -```json -{ - "walletSyncNeeded": "" -} -``` - - -### `listIdps` - -- Introduced: `0.20.0` - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `idps` | - | - -**Result Example** -```json -{ - "idps": [ - { - "id": "", - "type": "", - "issuer": "" - } - ] -} -``` - - -### `listNetworks` - -- Introduced: `0.20.0` - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `networks` | - | - -**Result Example** - -```json -{ - "networks": [ - { - "id": "", - "name": "", - "description": "", - "identityProviderId": "", - "auth": { - "method": "", - "scope": "", - "clientId": "", - "audience": "" - }, - "ledgerApi": "" - } - ] -} -``` - - -### `listSessions` - -- Introduced: `0.20.0` - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `sessions` | - | - -**Result Example** - -```json -{ - "sessions": [ - { - "id": "", - "network": { - "id": "", - "name": "", - "description": "", - "identityProviderId": "", - "auth": "", - "ledgerApi": "" - }, - "idp": { - "id": "", - "type": "", - "issuer": "" - }, - "accessToken": "", - "status": "" - } - ] -} -``` - - -### `listTransactions` - -- Introduced: `0.20.0` - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `transactions` | - | - -**Result Example** - -```json -{ - "transactions": [ - { - "commandId": "", - "status": "", - "preparedTransaction": "", - "preparedTransactionHash": "" - } - ] -} -``` - - -### `listWallets` - -- Introduced: `0.20.0` - -Lists wallets. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | - | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `array[object]` | - | - | - -**Params Example** - -```json -{ - "params": { - "filter": { - "networkIds": [ - "" - ], - "signingProviderIds": [ - "" - ] - } - } -} -``` - -**Result Example** - -```json -[ - { - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" - } -] -``` - - -### `removeIdp` - -- Introduced: `0.20.0` - -Removes an identity provider. Fails if an existing network is using the identity provider. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `identityProviderId` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `null` | - | - | - -**Params Example** - -```json -{ - "params": { - "identityProviderId": "" - } -} -``` - -**Result Example** - -```json -"" -``` - - -### `removeNetwork` - -- Introduced: `0.20.0` - -Removes a new network configuration (similar to EIP-3085). - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `networkName` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `null` | - | - | - -**Params Example** - -```json -{ - "params": { - "networkName": "" - } -} -``` - -**Result Example** - -```json -"" -``` - - -### `removeSession` - -- Introduced: `0.20.0` - -Removes the current network session. - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `null` | - | - | - -**Result Example** - -```json -"" -``` - - -### `removeWallet` - -- Introduced: `0.20.0` - -Removes a party with the given hint. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `partyId` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | - | - | - -**Params Example** - -```json -{ - "params": { - "partyId": "" - } -} -``` - -**Result Example** - -```json -{} -``` - - -### `setPrimaryWallet` - -- Introduced: `0.20.0` - -Sets the specified wallet as the primary wallet for dApp usage. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `partyId` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `null` | - | - | - -**Params Example** - -```json -{ - "params": { - "partyId": "" - } -} -``` - -**Result Example** - -```json -"" -``` - - -### `sign` - -- Introduced: `0.20.0` - -Signs the provided data with the private key of the specified or active party. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `commandId`, `partyId`, `preparedTransaction`, `preparedTransactionHash` | - | - -**Result** +## Methods -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `partyId`, `signature`, `signedBy` | - | -**Params Example** - -```json -{ - "params": { - "preparedTransaction": "", - "preparedTransactionHash": "", - "commandId": "", - "partyId": "" - } -} -``` - -**Result Example** - -```json -{ - "signature": "", - "partyId": "", - "signedBy": "" -} -``` - - -### `syncWallets` - -- Introduced: `0.20.0` -Changed in: `0.21.0` - -Synchronizes wallets with the connected network. - -**Version Changes** - -| Version | Changes | -| --- | --- | -| `0.21.0` | result updated (required fields) | - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `added`, `disabled`, `updated` | - | - -**Result Example** - -```json -{ - "added": [ - { - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" - } - ], - "updated": [ - { - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" - } - ], - "disabled": [ - { - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" - } - ] -} -``` +Method pages are the primary reference surface. This spec page stays focused on grouping and discovery. + + + +
+ + + + +
+

addIdp

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Adds a new identity provider.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
null
+
+ +
+ + + + + + + + +
+

addNetwork

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Adds a new network configuration (similar to EIP-3085).

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
null
+
+ +
+ + + + + + + + +
+

addSession

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Adds a network session.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

allocatePartyForWallet

+ +
+ + JSON-RPC + + Since 0.21.0 + +
+ +
+ +

Allocates a party for an already initialized wallet if external signing is complete.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

createWallet

+ +
+ + JSON-RPC + + Since 0.20.0 + + Changed 0.21.0 + +
+ +
+ +

Creates a new wallet and party with the given hint.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

deleteTransaction

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Deletes a pending transaction. Only transactions with status 'pending' can be deleted.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
null
+
+ +
+ + + + + + + + +
+

execute

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Executes a signed transaction.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

getTransaction

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

getUser

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Returns information about the current user, including whether they are an admin.

+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

isWalletSyncNeeded

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Checks if wallet sync is needed (disabled wallets or new parties on ledger).

+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

listIdps

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

listNetworks

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

listSessions

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

listTransactions

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

listWallets

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Lists wallets.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
array[object]
+
+ +
+ + + + + + + + +
+

removeIdp

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Removes an identity provider. Fails if an existing network is using the identity provider.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
null
+
+ +
+ + + + + + + + +
+

removeNetwork

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Removes a new network configuration (similar to EIP-3085).

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
null
+
+ +
+ + + + + + + + +
+

removeSession

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Removes the current network session.

+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
null
+
+ +
+ + + + + + + + +
+

removeWallet

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Removes a party with the given hint.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

setPrimaryWallet

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Sets the specified wallet as the primary wallet for dApp usage.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
null
+
+ +
+ + + + + + + + +
+

sign

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Signs the provided data with the private key of the specified or active party.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

syncWallets

+ +
+ + JSON-RPC + + Since 0.20.0 + + Changed 0.21.0 + +
+ +
+ +

Synchronizes wallets with the connected network.

+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + + + + +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/accountschanged.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/accountschanged.mdx new file mode 100644 index 0000000..3d25425 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/accountschanged.mdx @@ -0,0 +1,234 @@ +--- +title: "accountsChanged" +--- + +
+ + + + +
+ +

dApp API

+ + +

accountsChanged

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC accountsChanged + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "accountsChanged" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +[ + { + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" + } +] +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
accountsChanged
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
array[object]
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
array[object]
+
+ +
+
Schema
+
AccountsChangedEvent
+
+ +
+ + + + +
+ +
+
+ items + object + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ items + object + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/connect.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/connect.mdx new file mode 100644 index 0000000..b733bf2 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/connect.mdx @@ -0,0 +1,253 @@ +--- +title: "connect" +--- + +
+ + + + +
+ +

dApp API

+ + +

connect

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC connect + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "connect" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "isConnected": "", + "isNetworkConnected": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
connect
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
ConnectResult
+
+ +
+
Required
+
isConnected, isNetworkConnected
+
+ +
+ + + + +
+ +
+
+ isConnected + string + + required + +
+ +
+ +
+
+ isNetworkConnected + string + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ isConnected + string + + required + +
+ +
+ +
+
+ isNetworkConnected + string + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/disconnect.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/disconnect.mdx new file mode 100644 index 0000000..edfcf5e --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/disconnect.mdx @@ -0,0 +1,193 @@ +--- +title: "disconnect" +--- + +
+ + + + +
+ +

dApp API

+ + +

disconnect

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC disconnect + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "disconnect" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +"" +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
disconnect
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
null
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
null
+
+ +
+
Schema
+
Null
+
+ +
+ + + + + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/getactivenetwork.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/getactivenetwork.mdx new file mode 100644 index 0000000..22bdfcd --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/getactivenetwork.mdx @@ -0,0 +1,230 @@ +--- +title: "getActiveNetwork" +--- + +
+ + + + +
+ +

dApp API

+ + +

getActiveNetwork

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC getActiveNetwork + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "getActiveNetwork" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "networkId": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
getActiveNetwork
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
Network
+
+ +
+
Required
+
networkId
+
+ +
+ + + + +
+ +
+
+ networkId + string + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ networkId + string + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/getprimaryaccount.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/getprimaryaccount.mdx new file mode 100644 index 0000000..2a980bd --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/getprimaryaccount.mdx @@ -0,0 +1,391 @@ +--- +title: "getPrimaryAccount" +--- + +
+ + + + +
+ +

dApp API

+ + +

getPrimaryAccount

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC getPrimaryAccount + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "getPrimaryAccount" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
getPrimaryAccount
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
Wallet
+
+ +
+
Required
+
hint, namespace, networkId, partyId, primary, publicKey, signingProviderId, status
+
+ +
+ + + + +
+ +
+
+ primary + string + + required + +
+ +
+ +
+
+ partyId + string + + required + +
+ +
+ +
+
+ status + string + + required + +
+ +
+ +
+
+ hint + string + + required + +
+ +
+ +
+
+ publicKey + string + + required + +
+ +
+ +
+
+ namespace + string + + required + +
+ +
+ +
+
+ networkId + string + + required + +
+ +
+ +
+
+ signingProviderId + string + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ primary + string + + required + +
+ +
+ +
+
+ partyId + string + + required + +
+ +
+ +
+
+ status + string + + required + +
+ +
+ +
+
+ hint + string + + required + +
+ +
+ +
+
+ publicKey + string + + required + +
+ +
+ +
+
+ namespace + string + + required + +
+ +
+ +
+
+ networkId + string + + required + +
+ +
+ +
+
+ signingProviderId + string + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/ledgerapi.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/ledgerapi.mdx new file mode 100644 index 0000000..39b9004 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/ledgerapi.mdx @@ -0,0 +1,333 @@ +--- +title: "ledgerApi" +--- + +
+ + + + +
+ +

dApp API

+ + +

ledgerApi

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC ledgerApi + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "ledgerApi", + "params": { + "params": { + "requestMethod": "", + "resource": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "response": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
ledgerApi
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
LedgerApiRequest
+
+ +
+
Required
+
requestMethod, resource
+
+ +
+ + + + +
+ +
+
+ requestMethod + string + + required + +
+ +
+ +
+
+ resource + string + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
LedgerApiResult
+
+ +
+
Required
+
response
+
+ +
+ + + + +
+ +
+
+ response + string + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ requestMethod + string + + required + +
+ +
+ +
+
+ resource + string + + required + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ response + string + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/listaccounts.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/listaccounts.mdx new file mode 100644 index 0000000..5312f2f --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/listaccounts.mdx @@ -0,0 +1,234 @@ +--- +title: "listAccounts" +--- + +
+ + + + +
+ +

dApp API

+ + +

listAccounts

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC listAccounts + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "listAccounts" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +[ + { + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" + } +] +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
listAccounts
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
array[object]
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
array[object]
+
+ +
+
Schema
+
ListAccountsResult
+
+ +
+ + + + +
+ +
+
+ items + object + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ items + object + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/prepareexecute.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/prepareexecute.mdx new file mode 100644 index 0000000..7fab0f0 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/prepareexecute.mdx @@ -0,0 +1,273 @@ +--- +title: "prepareExecute" +--- + +
+ + + + +
+ +

dApp API

+ + +

prepareExecute

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC prepareExecute + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "prepareExecute", + "params": { + "params": { + "commands": {} + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +"" +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
prepareExecute
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
null
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
JsPrepareSubmissionRequest
+
+ +
+
Required
+
commands
+
+ +
+ + + + +
+ +
+
+ commands + object + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
null
+
+ +
+
Schema
+
Null
+
+ +
+ + + + + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ commands + object + + required + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/prepareexecuteandwait.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/prepareexecuteandwait.mdx new file mode 100644 index 0000000..6466630 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/prepareexecuteandwait.mdx @@ -0,0 +1,312 @@ +--- +title: "prepareExecuteAndWait" +--- + +
+ + + + +
+ +

dApp API

+ + +

prepareExecuteAndWait

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC prepareExecuteAndWait + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "prepareExecuteAndWait", + "params": { + "params": { + "commands": {} + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "tx": { + "status": "", + "commandId": "", + "payload": { + "updateId": "", + "completionOffset": "" + } + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
prepareExecuteAndWait
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
JsPrepareSubmissionRequest
+
+ +
+
Required
+
commands
+
+ +
+ + + + +
+ +
+
+ commands + object + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
tx
+
+ +
+ + + + +
+ +
+
+ tx + object + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ commands + object + + required + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ tx + object + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/signmessage.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/signmessage.mdx new file mode 100644 index 0000000..78bbbc2 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/signmessage.mdx @@ -0,0 +1,310 @@ +--- +title: "signMessage" +--- + +
+ + + + +
+ +

dApp API

+ + +

signMessage

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC signMessage + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "signMessage", + "params": { + "params": { + "message": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "signature": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
signMessage
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
SignMessageRequest
+
+ +
+
Required
+
message
+
+ +
+ + + + +
+ +
+
+ message + string + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
SignMessageResult
+
+ +
+
Required
+
signature
+
+ +
+ + + + +
+ +
+
+ signature + string + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ message + string + + required + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ signature + string + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/status.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/status.mdx new file mode 100644 index 0000000..91481c9 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/status.mdx @@ -0,0 +1,258 @@ +--- +title: "status" +--- + +
+ + + + +
+ +

dApp API

+ + +

status

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC status + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "status" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "provider": { + "id": "" + }, + "connection": { + "isConnected": "", + "isNetworkConnected": "" + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
status
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
StatusEvent
+
+ +
+
Required
+
connection, provider
+
+ +
+ + + + +
+ +
+
+ provider + object + + required + +
+ +
+ +
+
+ connection + object + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ provider + object + + required + +
+ +
+ +
+
+ connection + object + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/txchanged.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/txchanged.mdx new file mode 100644 index 0000000..a4a7992 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/txchanged.mdx @@ -0,0 +1,240 @@ +--- +title: "txChanged" +--- + +
+ + + + +
+ +

dApp API

+ + +

txChanged

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC txChanged + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "txChanged" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "status": "", + "commandId": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
txChanged
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
oneOf
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
oneOf
+
+ +
+
Schema
+
TxChangedEvent
+
+ +
+ + + + +
+ +
+
+ status + string + +
+ +
+ +
+
+ commandId + string + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ status + string + +
+ +
+ +
+
+ commandId + string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/accountschanged.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/accountschanged.mdx new file mode 100644 index 0000000..6d07b30 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/accountschanged.mdx @@ -0,0 +1,234 @@ +--- +title: "accountsChanged" +--- + +
+ + + + +
+ +

Remote dApp API

+ + +

accountsChanged

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC accountsChanged + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "accountsChanged" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +[ + { + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" + } +] +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
accountsChanged
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
array[object]
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
array[object]
+
+ +
+
Schema
+
AccountsChangedEvent
+
+ +
+ + + + +
+ +
+
+ items + object + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ items + object + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/connect.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/connect.mdx new file mode 100644 index 0000000..25260a4 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/connect.mdx @@ -0,0 +1,253 @@ +--- +title: "connect" +--- + +
+ + + + +
+ +

Remote dApp API

+ + +

connect

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC connect + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "connect" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "isConnected": "", + "isNetworkConnected": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
connect
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
ConnectResult
+
+ +
+
Required
+
isConnected, isNetworkConnected
+
+ +
+ + + + +
+ +
+
+ isConnected + string + + required + +
+ +
+ +
+
+ isNetworkConnected + string + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ isConnected + string + + required + +
+ +
+ +
+
+ isNetworkConnected + string + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/connected.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/connected.mdx new file mode 100644 index 0000000..656e583 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/connected.mdx @@ -0,0 +1,258 @@ +--- +title: "connected" +--- + +
+ + + + +
+ +

Remote dApp API

+ + +

connected

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC connected + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "connected" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "provider": { + "id": "" + }, + "connection": { + "isConnected": "", + "isNetworkConnected": "" + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
connected
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
StatusEvent
+
+ +
+
Required
+
connection, provider
+
+ +
+ + + + +
+ +
+
+ provider + object + + required + +
+ +
+ +
+
+ connection + object + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ provider + object + + required + +
+ +
+ +
+
+ connection + object + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/disconnect.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/disconnect.mdx new file mode 100644 index 0000000..b639050 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/disconnect.mdx @@ -0,0 +1,193 @@ +--- +title: "disconnect" +--- + +
+ + + + +
+ +

Remote dApp API

+ + +

disconnect

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC disconnect + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "disconnect" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +"" +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
disconnect
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
null
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
null
+
+ +
+
Schema
+
Null
+
+ +
+ + + + + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/getactivenetwork.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/getactivenetwork.mdx new file mode 100644 index 0000000..9957117 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/getactivenetwork.mdx @@ -0,0 +1,230 @@ +--- +title: "getActiveNetwork" +--- + +
+ + + + +
+ +

Remote dApp API

+ + +

getActiveNetwork

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC getActiveNetwork + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "getActiveNetwork" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "networkId": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
getActiveNetwork
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
Network
+
+ +
+
Required
+
networkId
+
+ +
+ + + + +
+ +
+
+ networkId + string + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ networkId + string + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/getprimaryaccount.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/getprimaryaccount.mdx new file mode 100644 index 0000000..6ee7dd0 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/getprimaryaccount.mdx @@ -0,0 +1,391 @@ +--- +title: "getPrimaryAccount" +--- + +
+ + + + +
+ +

Remote dApp API

+ + +

getPrimaryAccount

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC getPrimaryAccount + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "getPrimaryAccount" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
getPrimaryAccount
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
Wallet
+
+ +
+
Required
+
hint, namespace, networkId, partyId, primary, publicKey, signingProviderId, status
+
+ +
+ + + + +
+ +
+
+ primary + string + + required + +
+ +
+ +
+
+ partyId + string + + required + +
+ +
+ +
+
+ status + string + + required + +
+ +
+ +
+
+ hint + string + + required + +
+ +
+ +
+
+ publicKey + string + + required + +
+ +
+ +
+
+ namespace + string + + required + +
+ +
+ +
+
+ networkId + string + + required + +
+ +
+ +
+
+ signingProviderId + string + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ primary + string + + required + +
+ +
+ +
+
+ partyId + string + + required + +
+ +
+ +
+
+ status + string + + required + +
+ +
+ +
+
+ hint + string + + required + +
+ +
+ +
+
+ publicKey + string + + required + +
+ +
+ +
+
+ namespace + string + + required + +
+ +
+ +
+
+ networkId + string + + required + +
+ +
+ +
+
+ signingProviderId + string + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/ledgerapi.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/ledgerapi.mdx new file mode 100644 index 0000000..fbc725f --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/ledgerapi.mdx @@ -0,0 +1,333 @@ +--- +title: "ledgerApi" +--- + +
+ + + + +
+ +

Remote dApp API

+ + +

ledgerApi

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC ledgerApi + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "ledgerApi", + "params": { + "params": { + "requestMethod": "", + "resource": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "response": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
ledgerApi
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
LedgerApiRequest
+
+ +
+
Required
+
requestMethod, resource
+
+ +
+ + + + +
+ +
+
+ requestMethod + string + + required + +
+ +
+ +
+
+ resource + string + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
LedgerApiResult
+
+ +
+
Required
+
response
+
+ +
+ + + + +
+ +
+
+ response + string + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ requestMethod + string + + required + +
+ +
+ +
+
+ resource + string + + required + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ response + string + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/listaccounts.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/listaccounts.mdx new file mode 100644 index 0000000..68787eb --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/listaccounts.mdx @@ -0,0 +1,234 @@ +--- +title: "listAccounts" +--- + +
+ + + + +
+ +

Remote dApp API

+ + +

listAccounts

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC listAccounts + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "listAccounts" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +[ + { + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" + } +] +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
listAccounts
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
array[object]
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
array[object]
+
+ +
+
Schema
+
ListAccountsResult
+
+ +
+ + + + +
+ +
+
+ items + object + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ items + object + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/onstatuschanged.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/onstatuschanged.mdx new file mode 100644 index 0000000..e30e778 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/onstatuschanged.mdx @@ -0,0 +1,258 @@ +--- +title: "onStatusChanged" +--- + +
+ + + + +
+ +

Remote dApp API

+ + +

onStatusChanged

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC onStatusChanged + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "onStatusChanged" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "provider": { + "id": "" + }, + "connection": { + "isConnected": "", + "isNetworkConnected": "" + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
onStatusChanged
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
StatusEvent
+
+ +
+
Required
+
connection, provider
+
+ +
+ + + + +
+ +
+
+ provider + object + + required + +
+ +
+ +
+
+ connection + object + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ provider + object + + required + +
+ +
+ +
+
+ connection + object + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/prepareexecute.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/prepareexecute.mdx new file mode 100644 index 0000000..b5673dd --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/prepareexecute.mdx @@ -0,0 +1,305 @@ +--- +title: "prepareExecute" +--- + +
+ + + + +
+ +

Remote dApp API

+ + +

prepareExecute

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC prepareExecute + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "prepareExecute", + "params": { + "params": { + "commands": {} + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "userUrl": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
prepareExecute
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
JsPrepareSubmissionRequest
+
+ +
+
Required
+
commands
+
+ +
+ + + + +
+ +
+
+ commands + object + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
userUrl
+
+ +
+ + + + +
+ +
+
+ userUrl + string + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ commands + object + + required + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ userUrl + string + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/signmessage.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/signmessage.mdx new file mode 100644 index 0000000..392a6d9 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/signmessage.mdx @@ -0,0 +1,310 @@ +--- +title: "signMessage" +--- + +
+ + + + +
+ +

Remote dApp API

+ + +

signMessage

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC signMessage + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "signMessage", + "params": { + "params": { + "message": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "signature": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
signMessage
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
SignMessageRequest
+
+ +
+
Required
+
message
+
+ +
+ + + + +
+ +
+
+ message + string + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
SignMessageResult
+
+ +
+
Required
+
signature
+
+ +
+ + + + +
+ +
+
+ signature + string + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ message + string + + required + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ signature + string + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/status.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/status.mdx new file mode 100644 index 0000000..fceff47 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/status.mdx @@ -0,0 +1,258 @@ +--- +title: "status" +--- + +
+ + + + +
+ +

Remote dApp API

+ + +

status

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC status + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "status" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "provider": { + "id": "" + }, + "connection": { + "isConnected": "", + "isNetworkConnected": "" + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
status
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
StatusEvent
+
+ +
+
Required
+
connection, provider
+
+ +
+ + + + +
+ +
+
+ provider + object + + required + +
+ +
+ +
+
+ connection + object + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ provider + object + + required + +
+ +
+ +
+
+ connection + object + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/txchanged.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/txchanged.mdx new file mode 100644 index 0000000..b22e286 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/txchanged.mdx @@ -0,0 +1,240 @@ +--- +title: "txChanged" +--- + +
+ + + + +
+ +

Remote dApp API

+ + +

txChanged

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC txChanged + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "txChanged" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "status": "", + "commandId": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
txChanged
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
oneOf
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
oneOf
+
+ +
+
Schema
+
TxChangedEvent
+
+ +
+ + + + +
+ +
+
+ status + string + +
+ +
+ +
+
+ commandId + string + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ status + string + +
+ +
+ +
+
+ commandId + string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/createkey.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/createkey.mdx new file mode 100644 index 0000000..b616e87 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/createkey.mdx @@ -0,0 +1,310 @@ +--- +title: "createKey" +--- + +
+ + + + +
+ +

Signing API

+ + +

createKey

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC createKey + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "createKey", + "params": { + "params": { + "name": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "error": "", + "error_description": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
createKey
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
oneOf
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
name
+
+ +
+ + + + +
+ +
+
+ name + string + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
oneOf
+
+ +
+ + + + +
+ +
+
+ error + string + +
+ +
+ +
+
+ error_description + string + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ name + string + + required + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ error + string + +
+ +
+ +
+
+ error_description + string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/getconfiguration.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/getconfiguration.mdx new file mode 100644 index 0000000..23fc689 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/getconfiguration.mdx @@ -0,0 +1,188 @@ +--- +title: "getConfiguration" +--- + +
+ + + + +
+ +

Signing API

+ + +

getConfiguration

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC getConfiguration + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "getConfiguration" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
getConfiguration
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+ + + + + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/getkeys.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/getkeys.mdx new file mode 100644 index 0000000..940f4de --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/getkeys.mdx @@ -0,0 +1,235 @@ +--- +title: "getKeys" +--- + +
+ + + + +
+ +

Signing API

+ + +

getKeys

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC getKeys + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "getKeys" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "error": "", + "error_description": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
getKeys
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
oneOf
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
oneOf
+
+ +
+ + + + +
+ +
+
+ error + string + +
+ +
+ +
+
+ error_description + string + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ error + string + +
+ +
+ +
+
+ error_description + string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/gettransaction.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/gettransaction.mdx new file mode 100644 index 0000000..a42e899 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/gettransaction.mdx @@ -0,0 +1,310 @@ +--- +title: "getTransaction" +--- + +
+ + + + +
+ +

Signing API

+ + +

getTransaction

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC getTransaction + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "getTransaction", + "params": { + "params": { + "txId": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "error": "", + "error_description": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
getTransaction
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
oneOf
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
txId
+
+ +
+ + + + +
+ +
+
+ txId + string + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
oneOf
+
+ +
+ + + + +
+ +
+
+ error + string + +
+ +
+ +
+
+ error_description + string + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ txId + string + + required + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ error + string + +
+ +
+ +
+
+ error_description + string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/gettransactions.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/gettransactions.mdx new file mode 100644 index 0000000..92c78bc --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/gettransactions.mdx @@ -0,0 +1,324 @@ +--- +title: "getTransactions" +--- + +
+ + + + +
+ +

Signing API

+ + +

getTransactions

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC getTransactions + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "getTransactions", + "params": { + "params": { + "txIds": [ + "" + ], + "publicKeys": [ + "" + ] + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "error": "", + "error_description": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
getTransactions
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
oneOf
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+ + + + +
+ +
+
+ txIds + array[string] + +
+ +
+ +
+
+ publicKeys + array[string] + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
oneOf
+
+ +
+ + + + +
+ +
+
+ error + string + +
+ +
+ +
+
+ error_description + string + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ txIds + array[string] + +
+ +
+ +
+
+ publicKeys + array[string] + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ error + string + +
+ +
+ +
+
+ error_description + string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/setconfiguration.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/setconfiguration.mdx new file mode 100644 index 0000000..c1ede74 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/setconfiguration.mdx @@ -0,0 +1,226 @@ +--- +title: "setConfiguration" +--- + +
+ + + + +
+ +

Signing API

+ + +

setConfiguration

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC setConfiguration + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "setConfiguration", + "params": { + "params": {} + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
setConfiguration
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+ + + + + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/signtransaction.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/signtransaction.mdx new file mode 100644 index 0000000..ebef6bc --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/signtransaction.mdx @@ -0,0 +1,358 @@ +--- +title: "signTransaction" +--- + +
+ + + + +
+ +

Signing API

+ + +

signTransaction

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC signTransaction + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "signTransaction", + "params": { + "params": { + "tx": "", + "txHash": "", + "keyIdentifier": { + "publicKey": "" + } + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "error": "", + "error_description": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
signTransaction
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
oneOf
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
keyIdentifier, tx, txHash
+
+ +
+ + + + +
+ +
+
+ tx + string + + required + +
+ +
+ +
+
+ txHash + string + + required + +
+ +
+ +
+
+ keyIdentifier + object + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
oneOf
+
+ +
+ + + + +
+ +
+
+ error + string + +
+ +
+ +
+
+ error_description + string + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ tx + string + + required + +
+ +
+ +
+
+ txHash + string + + required + +
+ +
+ +
+
+ keyIdentifier + object + + required + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ error + string + +
+ +
+ +
+
+ error_description + string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/subscribetransactions.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/subscribetransactions.mdx new file mode 100644 index 0000000..d563f7f --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/subscribetransactions.mdx @@ -0,0 +1,330 @@ +--- +title: "subscribeTransactions" +--- + +
+ + + + +
+ +

Signing API

+ + +

subscribeTransactions

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC subscribeTransactions + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "subscribeTransactions", + "params": { + "params": { + "txIds": [ + "" + ] + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "txId": "", + "status": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
subscribeTransactions
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
txIds
+
+ +
+ + + + +
+ +
+
+ txIds + array[string] + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
Transaction
+
+ +
+
Required
+
status, txId
+
+ +
+ + + + +
+ +
+
+ txId + string + + required + +
+ +
+ +
+
+ status + string + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ txIds + array[string] + + required + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ txId + string + + required + +
+ +
+ +
+
+ status + string + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/addidp.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/addidp.mdx new file mode 100644 index 0000000..9f0cc33 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/addidp.mdx @@ -0,0 +1,272 @@ +--- +title: "addIdp" +--- + +
+ + + + +
+ +

User API

+ + +

addIdp

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC addIdp + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "addIdp", + "params": { + "params": { + "idp": { + "id": "", + "type": "", + "issuer": "" + } + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +"" +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
addIdp
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
null
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
idp
+
+ +
+ + + + +
+ +
+
+ idp + object + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
null
+
+ +
+
Schema
+
Null
+
+ +
+ + + + + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ idp + object + + required + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/addnetwork.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/addnetwork.mdx new file mode 100644 index 0000000..d54aa5c --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/addnetwork.mdx @@ -0,0 +1,280 @@ +--- +title: "addNetwork" +--- + +
+ + + + +
+ +

User API

+ + +

addNetwork

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC addNetwork + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "addNetwork", + "params": { + "params": { + "network": { + "id": "", + "name": "", + "description": "", + "identityProviderId": "", + "auth": { + "method": "", + "scope": "", + "clientId": "", + "audience": "" + }, + "ledgerApi": "" + } + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +"" +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
addNetwork
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
null
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
network
+
+ +
+ + + + +
+ +
+
+ network + object + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
null
+
+ +
+
Schema
+
Null
+
+ +
+ + + + + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ network + object + + required + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/addsession.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/addsession.mdx new file mode 100644 index 0000000..f3a09d6 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/addsession.mdx @@ -0,0 +1,413 @@ +--- +title: "addSession" +--- + +
+ + + + +
+ +

User API

+ + +

addSession

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC addSession + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "addSession", + "params": { + "params": { + "networkId": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "id": "", + "network": { + "id": "", + "name": "", + "description": "", + "identityProviderId": "", + "auth": { + "method": "", + "scope": "", + "clientId": "", + "audience": "" + }, + "ledgerApi": "" + }, + "idp": { + "id": "", + "type": "", + "issuer": "" + }, + "accessToken": "", + "status": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
addSession
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
networkId
+
+ +
+ + + + +
+ +
+
+ networkId + string + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
Session
+
+ +
+
Required
+
accessToken, id, idp, network, status
+
+ +
+ + + + +
+ +
+
+ id + string + + required + +
+ +
+ +
+
+ network + object + + required + +
+ +
+ +
+
+ idp + object + + required + +
+ +
+ +
+
+ accessToken + string + + required + +
+ +
+ +
+
+ status + string + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ networkId + string + + required + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ id + string + + required + +
+ +
+ +
+
+ network + object + + required + +
+ +
+ +
+
+ idp + object + + required + +
+ +
+ +
+
+ accessToken + string + + required + +
+ +
+ +
+
+ status + string + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/allocatepartyforwallet.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/allocatepartyforwallet.mdx new file mode 100644 index 0000000..669a2b0 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/allocatepartyforwallet.mdx @@ -0,0 +1,309 @@ +--- +title: "allocatePartyForWallet" +--- + +
+ + + + +
+ +

User API

+ + +

allocatePartyForWallet

+ + + +
+ + JSON-RPC + + Since 0.21.0 + +
+ + +
+ +
+ + POST + + JSON-RPC allocatePartyForWallet + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "allocatePartyForWallet", + "params": { + "params": { + "partyId": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "wallet": { + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
allocatePartyForWallet
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
partyId
+
+ +
+ + + + +
+ +
+
+ partyId + string + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
wallet
+
+ +
+ + + + +
+ +
+
+ wallet + object + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ partyId + string + + required + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ wallet + object + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/createwallet.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/createwallet.mdx new file mode 100644 index 0000000..2cdfdfc --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/createwallet.mdx @@ -0,0 +1,345 @@ +--- +title: "createWallet" +--- + +
+ + + + +
+ +

User API

+ + +

createWallet

+ + + +
+ + JSON-RPC + + Since 0.20.0 + + Changed 0.21.0 + +
+ + +
+ +
+ + POST + + JSON-RPC createWallet + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "createWallet", + "params": { + "params": { + "partyHint": "", + "signingProviderId": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "wallet": { + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
createWallet
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
partyHint, signingProviderId, networkId
+
+ +
+ + + + +
+ +
+
+ partyHint + string + + required + +
+ +
+ +
+
+ signingProviderId + string + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
wallet
+
+ +
+ + + + +
+ +
+
+ wallet + object + + required + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 0.21.0 + description updated +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ partyHint + string + + required + +
+ +
+ +
+
+ signingProviderId + string + + required + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ wallet + object + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/deletetransaction.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/deletetransaction.mdx new file mode 100644 index 0000000..ac33203 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/deletetransaction.mdx @@ -0,0 +1,268 @@ +--- +title: "deleteTransaction" +--- + +
+ + + + +
+ +

User API

+ + +

deleteTransaction

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC deleteTransaction + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "deleteTransaction", + "params": { + "params": { + "commandId": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +"" +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
deleteTransaction
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
null
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
commandId
+
+ +
+ + + + +
+ +
+
+ commandId + string + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
null
+
+ +
+
Schema
+
Null
+
+ +
+ + + + + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ commandId + string + + required + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/execute.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/execute.mdx new file mode 100644 index 0000000..5a42aed --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/execute.mdx @@ -0,0 +1,332 @@ +--- +title: "execute" +--- + +
+ + + + +
+ +

User API

+ + +

execute

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC execute + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "execute", + "params": { + "params": { + "signature": "", + "partyId": "", + "commandId": "", + "signedBy": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
execute
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
commandId, partyId, signature, signedBy
+
+ +
+ + + + +
+ +
+
+ signature + string + + required + +
+ +
+ +
+
+ partyId + string + + required + +
+ +
+ +
+
+ commandId + string + + required + +
+ +
+ +
+
+ signedBy + string + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+ + + + + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ signature + string + + required + +
+ +
+ +
+
+ partyId + string + + required + +
+ +
+ +
+
+ commandId + string + + required + +
+ +
+ +
+
+ signedBy + string + + required + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/gettransaction.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/gettransaction.mdx new file mode 100644 index 0000000..a85fd64 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/gettransaction.mdx @@ -0,0 +1,374 @@ +--- +title: "getTransaction" +--- + +
+ + + + +
+ +

User API

+ + +

getTransaction

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC getTransaction + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "getTransaction", + "params": { + "params": { + "commandId": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "commandId": "", + "status": "", + "preparedTransaction": "", + "preparedTransactionHash": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
getTransaction
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
commandId
+
+ +
+ + + + +
+ +
+
+ commandId + string + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
Transaction
+
+ +
+
Required
+
commandId, preparedTransaction, preparedTransactionHash, status
+
+ +
+ + + + +
+ +
+
+ commandId + string + + required + +
+ +
+ +
+
+ status + string + + required + +
+ +
+ +
+
+ preparedTransaction + string + + required + +
+ +
+ +
+
+ preparedTransactionHash + string + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ commandId + string + + required + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ commandId + string + + required + +
+ +
+ +
+
+ status + string + + required + +
+ +
+ +
+
+ preparedTransaction + string + + required + +
+ +
+ +
+
+ preparedTransactionHash + string + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/getuser.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/getuser.mdx new file mode 100644 index 0000000..dd9723f --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/getuser.mdx @@ -0,0 +1,248 @@ +--- +title: "getUser" +--- + +
+ + + + +
+ +

User API

+ + +

getUser

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC getUser + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "getUser" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "userId": "", + "isAdmin": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
getUser
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
isAdmin, userId
+
+ +
+ + + + +
+ +
+
+ userId + string + + required + +
+ +
+ +
+
+ isAdmin + string + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ userId + string + + required + +
+ +
+ +
+
+ isAdmin + string + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/iswalletsyncneeded.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/iswalletsyncneeded.mdx new file mode 100644 index 0000000..8880e41 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/iswalletsyncneeded.mdx @@ -0,0 +1,225 @@ +--- +title: "isWalletSyncNeeded" +--- + +
+ + + + +
+ +

User API

+ + +

isWalletSyncNeeded

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC isWalletSyncNeeded + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "isWalletSyncNeeded" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "walletSyncNeeded": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
isWalletSyncNeeded
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
walletSyncNeeded
+
+ +
+ + + + +
+ +
+
+ walletSyncNeeded + string + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ walletSyncNeeded + string + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listidps.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listidps.mdx new file mode 100644 index 0000000..33bb917 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listidps.mdx @@ -0,0 +1,231 @@ +--- +title: "listIdps" +--- + +
+ + + + +
+ +

User API

+ + +

listIdps

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC listIdps + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "listIdps" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "idps": [ + { + "id": "", + "type": "", + "issuer": "" + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
listIdps
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
idps
+
+ +
+ + + + +
+ +
+
+ idps + array[object] + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ idps + array[object] + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listnetworks.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listnetworks.mdx new file mode 100644 index 0000000..df1ec8e --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listnetworks.mdx @@ -0,0 +1,239 @@ +--- +title: "listNetworks" +--- + +
+ + + + +
+ +

User API

+ + +

listNetworks

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC listNetworks + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "listNetworks" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "networks": [ + { + "id": "", + "name": "", + "description": "", + "identityProviderId": "", + "auth": { + "method": "", + "scope": "", + "clientId": "", + "audience": "" + }, + "ledgerApi": "" + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
listNetworks
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
networks
+
+ +
+ + + + +
+ +
+
+ networks + array[object] + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ networks + array[object] + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listsessions.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listsessions.mdx new file mode 100644 index 0000000..238f737 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listsessions.mdx @@ -0,0 +1,244 @@ +--- +title: "listSessions" +--- + +
+ + + + +
+ +

User API

+ + +

listSessions

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC listSessions + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "listSessions" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "sessions": [ + { + "id": "", + "network": { + "id": "", + "name": "", + "description": "", + "identityProviderId": "", + "auth": "", + "ledgerApi": "" + }, + "idp": { + "id": "", + "type": "", + "issuer": "" + }, + "accessToken": "", + "status": "" + } + ] +} +``` + + + + + + +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
listSessions
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
sessions
+
+ +
+ + + + +
+ +
+
+ sessions + array[object] + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ sessions + array[object] + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listtransactions.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listtransactions.mdx new file mode 100644 index 0000000..e88332c --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listtransactions.mdx @@ -0,0 +1,232 @@ +--- +title: "listTransactions" +--- + +
+ + + + +
+ +

User API

+ + +

listTransactions

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC listTransactions + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "listTransactions" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "transactions": [ + { + "commandId": "", + "status": "", + "preparedTransaction": "", + "preparedTransactionHash": "" + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
listTransactions
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
transactions
+
+ +
+ + + + +
+ +
+
+ transactions + array[object] + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ transactions + array[object] + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listwallets.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listwallets.mdx new file mode 100644 index 0000000..4fb543b --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listwallets.mdx @@ -0,0 +1,302 @@ +--- +title: "listWallets" +--- + +
+ + + + +
+ +

User API

+ + +

listWallets

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC listWallets + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "listWallets", + "params": { + "params": { + "filter": { + "networkIds": [ + "" + ], + "signingProviderIds": [ + "" + ] + } + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +[ + { + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" + } +] +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
listWallets
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
array[object]
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+ + + + +
+ +
+
+ filter + object + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
array[object]
+
+ +
+ + + + +
+ +
+
+ items + object + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ filter + object + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ items + object + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removeidp.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removeidp.mdx new file mode 100644 index 0000000..36fb4a7 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removeidp.mdx @@ -0,0 +1,268 @@ +--- +title: "removeIdp" +--- + +
+ + + + +
+ +

User API

+ + +

removeIdp

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC removeIdp + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "removeIdp", + "params": { + "params": { + "identityProviderId": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +"" +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
removeIdp
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
null
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
identityProviderId
+
+ +
+ + + + +
+ +
+
+ identityProviderId + string + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
null
+
+ +
+
Schema
+
Null
+
+ +
+ + + + + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ identityProviderId + string + + required + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removenetwork.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removenetwork.mdx new file mode 100644 index 0000000..a98fb07 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removenetwork.mdx @@ -0,0 +1,268 @@ +--- +title: "removeNetwork" +--- + +
+ + + + +
+ +

User API

+ + +

removeNetwork

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC removeNetwork + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "removeNetwork", + "params": { + "params": { + "networkName": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +"" +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
removeNetwork
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
null
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
networkName
+
+ +
+ + + + +
+ +
+
+ networkName + string + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
null
+
+ +
+
Schema
+
Null
+
+ +
+ + + + + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ networkName + string + + required + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removesession.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removesession.mdx new file mode 100644 index 0000000..670fc77 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removesession.mdx @@ -0,0 +1,193 @@ +--- +title: "removeSession" +--- + +
+ + + + +
+ +

User API

+ + +

removeSession

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC removeSession + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "removeSession" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +"" +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
removeSession
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
null
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
null
+
+ +
+
Schema
+
Null
+
+ +
+ + + + + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removewallet.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removewallet.mdx new file mode 100644 index 0000000..e94e83f --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removewallet.mdx @@ -0,0 +1,263 @@ +--- +title: "removeWallet" +--- + +
+ + + + +
+ +

User API

+ + +

removeWallet

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC removeWallet + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "removeWallet", + "params": { + "params": { + "partyId": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
removeWallet
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
partyId
+
+ +
+ + + + +
+ +
+
+ partyId + string + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+ + + + + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ partyId + string + + required + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/setprimarywallet.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/setprimarywallet.mdx new file mode 100644 index 0000000..1ff37c4 --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/setprimarywallet.mdx @@ -0,0 +1,268 @@ +--- +title: "setPrimaryWallet" +--- + +
+ + + + +
+ +

User API

+ + +

setPrimaryWallet

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC setPrimaryWallet + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "setPrimaryWallet", + "params": { + "params": { + "partyId": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +"" +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
setPrimaryWallet
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
null
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
partyId
+
+ +
+ + + + +
+ +
+
+ partyId + string + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
null
+
+ +
+
Schema
+
Null
+
+ +
+ + + + + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ partyId + string + + required + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/sign.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/sign.mdx new file mode 100644 index 0000000..f031eaa --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/sign.mdx @@ -0,0 +1,415 @@ +--- +title: "sign" +--- + +
+ + + + +
+ +

User API

+ + +

sign

+ + + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+ + POST + + JSON-RPC sign + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "sign", + "params": { + "params": { + "preparedTransaction": "", + "preparedTransactionHash": "", + "commandId": "", + "partyId": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "signature": "", + "partyId": "", + "signedBy": "" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
sign
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
commandId, partyId, preparedTransaction, preparedTransactionHash
+
+ +
+ + + + +
+ +
+
+ preparedTransaction + string + + required + +
+ +
+ +
+
+ preparedTransactionHash + string + + required + +
+ +
+ +
+
+ commandId + string + + required + +
+ +
+ +
+
+ partyId + string + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
partyId, signature, signedBy
+
+ +
+ + + + +
+ +
+
+ signature + string + + required + +
+ +
+ +
+
+ partyId + string + + required + +
+ +
+ +
+
+ signedBy + string + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ preparedTransaction + string + + required + +
+ +
+ +
+
+ preparedTransactionHash + string + + required + +
+ +
+ +
+
+ commandId + string + + required + +
+ +
+ +
+
+ partyId + string + + required + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ signature + string + + required + +
+ +
+ +
+
+ partyId + string + + required + +
+ +
+ +
+
+ signedBy + string + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/syncwallets.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/syncwallets.mdx new file mode 100644 index 0000000..ccf835f --- /dev/null +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/syncwallets.mdx @@ -0,0 +1,317 @@ +--- +title: "syncWallets" +--- + +
+ + + + +
+ +

User API

+ + +

syncWallets

+ + + +
+ + JSON-RPC + + Since 0.20.0 + + Changed 0.21.0 + +
+ + +
+ +
+ + POST + + JSON-RPC syncWallets + Try it +
+ + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "syncWallets" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "added": [ + { + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" + } + ], + "updated": [ + { + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" + } + ], + "disabled": [ + { + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
syncWallets
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
added, disabled, updated
+
+ +
+ + + + +
+ +
+
+ added + array[object] + + required + +
+ +
+ +
+
+ updated + array[object] + + required + +
+ +
+ +
+
+ disabled + array[object] + + required + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 0.21.0 + result updated (required fields) +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ added + array[object] + + required + +
+ +
+ +
+
+ updated + array[object] + + required + +
+ +
+ +
+
+ disabled + array[object] + + required + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/rpc-specs/dapp-api.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/rpc-specs/dapp-api.mdx index 97b865e..82c91b2 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/rpc-specs/dapp-api.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/rpc-specs/dapp-api.mdx @@ -1,424 +1,504 @@ --- title: "dApp API" -description: "Splice Wallet JSON-RPC dApp API" +description: "An OpenRPC specification for the dapp to interact with a Wallet Provider." --- -# dApp API +

Back to overview

+ +
+ +

OpenRPC Spec

+ + +

dApp API

+ + +

An OpenRPC specification for the dapp to interact with a Wallet Provider.

+ + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+
Latest source path
+
api-specs/openrpc-dapp-api.json
+
+ +
+
Publish version
+
0.21.0
+
+ +
+
OpenRPC version
+
1.2.6
+
+ +
+
Spec info.version
+
0.5.0
+
+ +
+ +
-[Back to overview](/reference/wallet-gateway-json-rpc) - -An OpenRPC specification for the dapp to interact with a Wallet Provider. - -- Latest source path: `api-specs/openrpc-dapp-api.json` -- Publish version: `0.21.0` -- OpenRPC version: `1.2.6` -- Spec info.version: `0.5.0` - -## Version Change Timeline - -| Version | Active Methods | Added | Changed | Removed | -| --- | --- | --- | --- | --- | -| `0.20.0` | 12 | 0 | 0 | 0 | -| `0.21.0` | 12 | 0 | 0 | 0 | - -## Table of Contents - -🟢 Active Since 🔵 Changed 🔴 Removed - -| NAME | STATUS | SUMMARY | -| --- | --- | --- | -| [`accountsChanged`](#method-accountschanged) | 🟢 `v0.20` | - | -| [`connect`](#method-connect) | 🟢 `v0.20` | Ensures ledger connectivity and returns the connected network information along with the session information. | -| [`disconnect`](#method-disconnect) | 🟢 `v0.20` | Invoke a disconnect of the wallet provider session. | -| [`getActiveNetwork`](#method-getactivenetwork) | 🟢 `v0.20` | Returns the active network. | -| [`getPrimaryAccount`](#method-getprimaryaccount) | 🟢 `v0.20` | Returns the primary account. | -| [`ledgerApi`](#method-ledgerapi) | 🟢 `v0.20` | Proxy for the JSON-API endpoints. Injects authorization headers automatically. | -| [`listAccounts`](#method-listaccounts) | 🟢 `v0.20` | Lists the addresses (wallets) with their properties; including which network they are associated to and with signing provider is used. | -| [`prepareExecute`](#method-prepareexecute) | 🟢 `v0.20` | Prepares a transaction for subsequent signing & execution. | -| [`prepareExecuteAndWait`](#method-prepareexecuteandwait) | 🟢 `v0.20` | Like prepareExecute, but waits for the transaction to be executed on the ledger. | -| [`signMessage`](#method-signmessage) | 🟢 `v0.20` | Signs a message. | -| [`status`](#method-status) | 🟢 `v0.20` | Returns the current status of the wallet provider session. | -| [`txChanged`](#method-txchanged) | 🟢 `v0.20` | - | ## Methods - -### `accountsChanged` - -- Introduced: `0.20.0` - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `array[object]` | - | - | - -**Result Example** - -```json -[ - { - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" - } -] -``` - - -### `connect` - -- Introduced: `0.20.0` - -Ensures ledger connectivity and returns the connected network information along with the session information. - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `isConnected`, `isNetworkConnected` | - | - -**Result Example** - -```json -{ - "isConnected": "", - "isNetworkConnected": "" -} -``` - - -### `disconnect` - -- Introduced: `0.20.0` - -Invoke a disconnect of the wallet provider session. - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `null` | - | - | - -**Result Example** - -```json -"" -``` - - -### `getActiveNetwork` - -- Introduced: `0.20.0` - -Returns the active network. - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `networkId` | - | - -**Result Example** - -```json -{ - "networkId": "" -} -``` - - -### `getPrimaryAccount` - -- Introduced: `0.20.0` - -Returns the primary account. - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `hint`, `namespace`, `networkId`, `partyId`, `primary`, `publicKey`, `signingProviderId`, `status` | - | - -**Result Example** - -```json -{ - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" -} -``` - - -### `ledgerApi` - -- Introduced: `0.20.0` - -Proxy for the JSON-API endpoints. Injects authorization headers automatically. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `requestMethod`, `resource` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `response` | - | - -**Params Example** - -```json -{ - "params": { - "requestMethod": "", - "resource": "" - } -} -``` - -**Result Example** - -```json -{ - "response": "" -} -``` - - -### `listAccounts` - -- Introduced: `0.20.0` - -Lists the addresses (wallets) with their properties; including which network they are associated to and with signing provider is used. - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `array[object]` | - | - | - -**Result Example** - -```json -[ - { - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" - } -] -``` - - -### `prepareExecute` - -- Introduced: `0.20.0` - -Prepares a transaction for subsequent signing & execution. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `commands` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `null` | - | - | - -**Params Example** - -```json -{ - "params": { - "commands": {} - } -} -``` - -**Result Example** - -```json -"" -``` - - -### `prepareExecuteAndWait` - -- Introduced: `0.20.0` - -Like prepareExecute, but waits for the transaction to be executed on the ledger. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `commands` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `tx` | - | - -**Params Example** - -```json -{ - "params": { - "commands": {} - } -} -``` - -**Result Example** - -```json -{ - "tx": { - "status": "", - "commandId": "", - "payload": { - "updateId": "", - "completionOffset": "" - } - } -} -``` - - -### `signMessage` - -- Introduced: `0.20.0` - -Signs a message. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `message` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `signature` | - | - -**Params Example** - -```json -{ - "params": { - "message": "" - } -} -``` - -**Result Example** - -```json -{ - "signature": "" -} -``` - - -### `status` - -- Introduced: `0.20.0` - -Returns the current status of the wallet provider session. - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `connection`, `provider` | - | - -**Result Example** - -```json -{ - "provider": { - "id": "" - }, - "connection": { - "isConnected": "", - "isNetworkConnected": "" - } -} -``` - - -### `txChanged` - -- Introduced: `0.20.0` - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `oneOf` | - | - | - -**Result Example** -```json -{ - "status": "", - "commandId": "" -} -``` +Method pages are the primary reference surface. This spec page stays focused on grouping and discovery. + + + +
+ + + + +
+

accountsChanged

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
array[object]
+
+ +
+ + + + + + + + +
+

connect

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Ensures ledger connectivity and returns the connected network information along with the session information.

+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

disconnect

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Invoke a disconnect of the wallet provider session.

+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
null
+
+ +
+ + + + + + + + +
+

getActiveNetwork

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Returns the active network.

+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

getPrimaryAccount

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Returns the primary account.

+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

ledgerApi

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Proxy for the JSON-API endpoints. Injects authorization headers automatically.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

listAccounts

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Lists the addresses (wallets) with their properties; including which network they are associated to and with signing provider is used.

+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
array[object]
+
+ +
+ + + + + + + + +
+

prepareExecute

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Prepares a transaction for subsequent signing & execution.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
null
+
+ +
+ + + + + + + + +
+

prepareExecuteAndWait

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Like prepareExecute, but waits for the transaction to be executed on the ledger.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

signMessage

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Signs a message.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

status

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Returns the current status of the wallet provider session.

+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

txChanged

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
oneOf
+
+ +
+ + + + + +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/rpc-specs/dapp-remote-api.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/rpc-specs/dapp-remote-api.mdx index 347a3c3..32d213d 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/rpc-specs/dapp-remote-api.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/rpc-specs/dapp-remote-api.mdx @@ -1,441 +1,537 @@ --- title: "Remote dApp API" -description: "Splice Wallet JSON-RPC Remote dApp API" +description: "An OpenRPC specification for remotely hosted Wallet Providers. Due to the remote nature, an implementing provider must bridge certain functionality on the client-side to satisfy the general dApp API spec." --- -# Remote dApp API +

Back to overview

+ +
+ +

OpenRPC Spec

+ + +

Remote dApp API

+ + +

An OpenRPC specification for remotely hosted Wallet Providers. Due to the remote nature, an implementing provider must bridge certain functionality on the client-side to satisfy the general dApp API spec.

+ + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+
Latest source path
+
api-specs/openrpc-dapp-remote-api.json
+
+ +
+
Publish version
+
0.21.0
+
+ +
+
OpenRPC version
+
1.2.6
+
+ +
+
Spec info.version
+
0.1.0
+
+ +
+ +
-[Back to overview](/reference/wallet-gateway-json-rpc) - -An OpenRPC specification for remotely hosted Wallet Providers. Due to the remote nature, an implementing provider must bridge certain functionality on the client-side to satisfy the general dApp API spec. - -- Latest source path: `api-specs/openrpc-dapp-remote-api.json` -- Publish version: `0.21.0` -- OpenRPC version: `1.2.6` -- Spec info.version: `0.1.0` - -## Version Change Timeline - -| Version | Active Methods | Added | Changed | Removed | -| --- | --- | --- | --- | --- | -| `0.20.0` | 13 | 0 | 0 | 0 | -| `0.21.0` | 13 | 0 | 0 | 0 | - -## Table of Contents - -🟢 Active Since 🔵 Changed 🔴 Removed - -| NAME | STATUS | SUMMARY | -| --- | --- | --- | -| [`accountsChanged`](#method-accountschanged) | 🟢 `v0.20` | - | -| [`connect`](#method-connect) | 🟢 `v0.20` | Ensures ledger connectivity and returns the connected network information. | -| [`connected`](#method-connected) | 🟢 `v0.20` | Informs when the user connects to a network. | -| [`disconnect`](#method-disconnect) | 🟢 `v0.20` | Invoke a disconnect of the wallet gateway session. | -| [`getActiveNetwork`](#method-getactivenetwork) | 🟢 `v0.20` | Returns the active network. | -| [`getPrimaryAccount`](#method-getprimaryaccount) | 🟢 `v0.20` | Returns the primary account. | -| [`ledgerApi`](#method-ledgerapi) | 🟢 `v0.20` | Proxy for the JSON-API endpoints. Injects authorization headers automatically. | -| [`listAccounts`](#method-listaccounts) | 🟢 `v0.20` | - | -| [`onStatusChanged`](#method-onstatuschanged) | 🟢 `v0.20` | - | -| [`prepareExecute`](#method-prepareexecute) | 🟢 `v0.20` | Prepares, signs, and executes a transaction. | -| [`signMessage`](#method-signmessage) | 🟢 `v0.20` | Signs a message. | -| [`status`](#method-status) | 🟢 `v0.20` | Returns the current status of the wallet provider session. | -| [`txChanged`](#method-txchanged) | 🟢 `v0.20` | - | ## Methods - -### `accountsChanged` - -- Introduced: `0.20.0` - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `array[object]` | - | - | - -**Result Example** - -```json -[ - { - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" - } -] -``` - - -### `connect` - -- Introduced: `0.20.0` - -Ensures ledger connectivity and returns the connected network information. - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `isConnected`, `isNetworkConnected` | - | - -**Result Example** - -```json -{ - "isConnected": "", - "isNetworkConnected": "" -} -``` - - -### `connected` - -- Introduced: `0.20.0` - -Informs when the user connects to a network. - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `connection`, `provider` | - | - -**Result Example** - -```json -{ - "provider": { - "id": "" - }, - "connection": { - "isConnected": "", - "isNetworkConnected": "" - } -} -``` - - -### `disconnect` - -- Introduced: `0.20.0` - -Invoke a disconnect of the wallet gateway session. - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `null` | - | - | - -**Result Example** - -```json -"" -``` - - -### `getActiveNetwork` - -- Introduced: `0.20.0` - -Returns the active network. - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `networkId` | - | - -**Result Example** - -```json -{ - "networkId": "" -} -``` - - -### `getPrimaryAccount` - -- Introduced: `0.20.0` - -Returns the primary account. - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `hint`, `namespace`, `networkId`, `partyId`, `primary`, `publicKey`, `signingProviderId`, `status` | - | - -**Result Example** - -```json -{ - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" -} -``` - - -### `ledgerApi` - -- Introduced: `0.20.0` - -Proxy for the JSON-API endpoints. Injects authorization headers automatically. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `requestMethod`, `resource` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `response` | - | - -**Params Example** - -```json -{ - "params": { - "requestMethod": "", - "resource": "" - } -} -``` - -**Result Example** - -```json -{ - "response": "" -} -``` - - -### `listAccounts` - -- Introduced: `0.20.0` - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `array[object]` | - | - | - -**Result Example** - -```json -[ - { - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" - } -] -``` - - -### `onStatusChanged` - -- Introduced: `0.20.0` - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `connection`, `provider` | - | - -**Result Example** - -```json -{ - "provider": { - "id": "" - }, - "connection": { - "isConnected": "", - "isNetworkConnected": "" - } -} -``` - - -### `prepareExecute` - -- Introduced: `0.20.0` - -Prepares, signs, and executes a transaction. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `commands` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `userUrl` | - | - -**Params Example** - -```json -{ - "params": { - "commands": {} - } -} -``` - -**Result Example** - -```json -{ - "userUrl": "" -} -``` - - -### `signMessage` - -- Introduced: `0.20.0` - -Signs a message. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `message` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `signature` | - | - -**Params Example** - -```json -{ - "params": { - "message": "" - } -} -``` - -**Result Example** - -```json -{ - "signature": "" -} -``` - - -### `status` - -- Introduced: `0.20.0` - -Returns the current status of the wallet provider session. - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `connection`, `provider` | - | - -**Result Example** - -```json -{ - "provider": { - "id": "" - }, - "connection": { - "isConnected": "", - "isNetworkConnected": "" - } -} -``` - - -### `txChanged` - -- Introduced: `0.20.0` - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `oneOf` | - | - | - -**Result Example** -```json -{ - "status": "", - "commandId": "" -} -``` +Method pages are the primary reference surface. This spec page stays focused on grouping and discovery. + + + +
+ + + + +
+

accountsChanged

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
array[object]
+
+ +
+ + + + + + + + +
+

connect

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Ensures ledger connectivity and returns the connected network information.

+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

connected

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Informs when the user connects to a network.

+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

disconnect

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Invoke a disconnect of the wallet gateway session.

+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
null
+
+ +
+ + + + + + + + +
+

getActiveNetwork

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Returns the active network.

+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

getPrimaryAccount

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Returns the primary account.

+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

ledgerApi

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Proxy for the JSON-API endpoints. Injects authorization headers automatically.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

listAccounts

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
array[object]
+
+ +
+ + + + + + + + +
+

onStatusChanged

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

prepareExecute

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Prepares, signs, and executes a transaction.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

signMessage

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Signs a message.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

status

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Returns the current status of the wallet provider session.

+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

txChanged

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
oneOf
+
+ +
+ + + + + +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/rpc-specs/signing-api.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/rpc-specs/signing-api.mdx index 81d568d..32da50c 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/rpc-specs/signing-api.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/rpc-specs/signing-api.mdx @@ -1,320 +1,358 @@ --- title: "Signing API" -description: "Wallet JSON-RPC Signing API" +description: "An OpenRPC specification for the Signing API which allows the Wallet Gateway to interact with a Wallet Providers." --- -# Signing API +

Back to overview

+ +
+ +

OpenRPC Spec

+ + +

Signing API

+ + +

An OpenRPC specification for the Signing API which allows the Wallet Gateway to interact with a Wallet Providers.

+ + +
+ + JSON-RPC + + Since 0.20.0 + +
+ + +
+ +
+
Latest source path
+
api-specs/openrpc-signing-api.json
+
+ +
+
Publish version
+
0.21.0
+
+ +
+
OpenRPC version
+
1.2.6
+
+ +
+
Spec info.version
+
0.1.0
+
+ +
+ +
-[Back to overview](/reference/wallet-gateway-json-rpc) - -An OpenRPC specification for the Signing API which allows the Wallet Gateway to interact with a Wallet Providers. - -- Latest source path: `api-specs/openrpc-signing-api.json` -- Publish version: `0.21.0` -- OpenRPC version: `1.2.6` -- Spec info.version: `0.1.0` - -## Version Change Timeline - -| Version | Active Methods | Added | Changed | Removed | -| --- | --- | --- | --- | --- | -| `0.20.0` | 8 | 0 | 0 | 0 | -| `0.21.0` | 8 | 0 | 0 | 0 | - -## Table of Contents - -🟢 Active Since 🔵 Changed 🔴 Removed - -| NAME | STATUS | SUMMARY | -| --- | --- | --- | -| [`createKey`](#method-createkey) | 🟢 `v0.20` | Create a new key at the Wallet Provider. | -| [`getConfiguration`](#method-getconfiguration) | 🟢 `v0.20` | - | -| [`getKeys`](#method-getkeys) | 🟢 `v0.20` | Get a list of public keys availabile for signing. | -| [`getTransaction`](#method-gettransaction) | 🟢 `v0.20` | Get the status of a single transaction by its ID. | -| [`getTransactions`](#method-gettransactions) | 🟢 `v0.20` | Get the status of multiple transactions, filtering by txIds or publicKeys. Either publicKeys or txIds must be provided. | -| [`setConfiguration`](#method-setconfiguration) | 🟢 `v0.20` | Set configuration parameters for the Wallet Provider. The paramaters will change depending on the Wallet Provider implementation | -| [`signTransaction`](#method-signtransaction) | 🟢 `v0.20` | Uses the Wallet Provider to sign a transaction. This will likely be an asynchronous operation. | -| [`subscribeTransactions`](#method-subscribetransactions) | 🟢 `v0.20` | Subscribe to updates for specific transactions. The server will emit updates when the status of the specified transactions have changed. On initial subscription, the server will emit the current status of all subscribed transactions. | ## Methods - -### `createKey` - -- Introduced: `0.20.0` - -Create a new key at the Wallet Provider. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `name` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `oneOf` | - | - | - -**Params Example** - -```json -{ - "params": { - "name": "" - } -} -``` - -**Result Example** - -```json -{ - "error": "", - "error_description": "" -} -``` - - -### `getConfiguration` - -- Introduced: `0.20.0` - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | - | - | - -**Result Example** - -```json -{} -``` - - -### `getKeys` - -- Introduced: `0.20.0` - -Get a list of public keys availabile for signing. - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `oneOf` | - | - | - -**Result Example** - -```json -{ - "error": "", - "error_description": "" -} -``` - - -### `getTransaction` - -- Introduced: `0.20.0` - -Get the status of a single transaction by its ID. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `txId` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `oneOf` | - | - | - -**Params Example** - -```json -{ - "params": { - "txId": "" - } -} -``` - -**Result Example** - -```json -{ - "error": "", - "error_description": "" -} -``` - - -### `getTransactions` - -- Introduced: `0.20.0` - -Get the status of multiple transactions, filtering by txIds or publicKeys. Either publicKeys or txIds must be provided. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | - | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `oneOf` | - | - | - -**Params Example** - -```json -{ - "params": { - "txIds": [ - "" - ], - "publicKeys": [ - "" - ] - } -} -``` - -**Result Example** - -```json -{ - "error": "", - "error_description": "" -} -``` - - -### `setConfiguration` - -- Introduced: `0.20.0` - -Set configuration parameters for the Wallet Provider. The paramaters will change depending on the Wallet Provider implementation - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | - | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | - | - | - -**Params Example** - -```json -{ - "params": {} -} -``` - -**Result Example** - -```json -{} -``` - - -### `signTransaction` - -- Introduced: `0.20.0` - -Uses the Wallet Provider to sign a transaction. This will likely be an asynchronous operation. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `keyIdentifier`, `tx`, `txHash` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `oneOf` | - | The resulting transaction entry at the Wallet Provider. This will include the signature if the transaction was immediately signed. | - -**Params Example** - -```json -{ - "params": { - "tx": "", - "txHash": "", - "keyIdentifier": { - "publicKey": "" - } - } -} -``` - -**Result Example** - -```json -{ - "error": "", - "error_description": "" -} -``` - - -### `subscribeTransactions` - -- Introduced: `0.20.0` - -Subscribe to updates for specific transactions. The server will emit updates when the status of the specified transactions have changed. On initial subscription, the server will emit the current status of all subscribed transactions. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `txIds` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `status`, `txId` | - | - -**Params Example** - -```json -{ - "params": { - "txIds": [ - "" - ] - } -} -``` - -**Result Example** -```json -{ - "txId": "", - "status": "" -} -``` +Method pages are the primary reference surface. This spec page stays focused on grouping and discovery. + + + +
+ + + + +
+

createKey

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Create a new key at the Wallet Provider.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
oneOf
+
+ +
+ + + + + + + + +
+

getConfiguration

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

getKeys

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Get a list of public keys availabile for signing.

+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
oneOf
+
+ +
+ + + + + + + + +
+

getTransaction

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Get the status of a single transaction by its ID.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
oneOf
+
+ +
+ + + + + + + + +
+

getTransactions

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Get the status of multiple transactions, filtering by txIds or publicKeys. Either publicKeys or txIds must be provided.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
oneOf
+
+ +
+ + + + + + + + +
+

setConfiguration

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Set configuration parameters for the Wallet Provider. The paramaters will change depending on the Wallet Provider implementation

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

signTransaction

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Uses the Wallet Provider to sign a transaction. This will likely be an asynchronous operation.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
oneOf
+
+ +
+ + + + + + + + +
+

subscribeTransactions

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Subscribe to updates for specific transactions. The server will emit updates when the status of the specified transactions have changed. On initial subscription, the s...

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + + + + +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/rpc-specs/user-api.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/rpc-specs/user-api.mdx index c65536a..b91f76d 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/rpc-specs/user-api.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/rpc-specs/user-api.mdx @@ -1,921 +1,874 @@ --- title: "User API" -description: "Splice Wallet JSON-RPC User API" +description: "An OpenRPC specification for the user to interact with the Wallet Gateway." --- -# User API - -[Back to overview](/reference/wallet-gateway-json-rpc) - -An OpenRPC specification for the user to interact with the Wallet Gateway. - -- Latest source path: `api-specs/openrpc-user-api.json` -- Publish version: `0.21.0` -- OpenRPC version: `1.2.6` -- Spec info.version: `0.1.0` - -## Version Change Timeline - -| Version | Active Methods | Added | Changed | Removed | -| --- | --- | --- | --- | --- | -| `0.20.0` | 21 | 0 | 0 | 0 | -| `0.21.0` | 22 | 1 | 2 | 0 | - -## Table of Contents - -🟢 Active Since 🔵 Changed 🔴 Removed - -| NAME | STATUS | SUMMARY | -| --- | --- | --- | -| [`addIdp`](#method-addidp) | 🟢 `v0.20` | Adds a new identity provider. | -| [`addNetwork`](#method-addnetwork) | 🟢 `v0.20` | Adds a new network configuration (similar to EIP-3085). | -| [`addSession`](#method-addsession) | 🟢 `v0.20` | Adds a network session. | -| [`allocatePartyForWallet`](#method-allocatepartyforwallet) | 🟢 `v0.21` | Allocates a party for an already initialized wallet if external signing is complete. | -| [`createWallet`](#method-createwallet) | 🟢 `v0.20` 🔵 `v0.21` | Creates a new wallet and party with the given hint. | -| [`deleteTransaction`](#method-deletetransaction) | 🟢 `v0.20` | Deletes a pending transaction. Only transactions with status 'pending' can be deleted. | -| [`execute`](#method-execute) | 🟢 `v0.20` | Executes a signed transaction. | -| [`getTransaction`](#method-gettransaction) | 🟢 `v0.20` | - | -| [`getUser`](#method-getuser) | 🟢 `v0.20` | Returns information about the current user, including whether they are an admin. | -| [`isWalletSyncNeeded`](#method-iswalletsyncneeded) | 🟢 `v0.20` | Checks if wallet sync is needed (disabled wallets or new parties on ledger). | -| [`listIdps`](#method-listidps) | 🟢 `v0.20` | - | -| [`listNetworks`](#method-listnetworks) | 🟢 `v0.20` | - | -| [`listSessions`](#method-listsessions) | 🟢 `v0.20` | - | -| [`listTransactions`](#method-listtransactions) | 🟢 `v0.20` | - | -| [`listWallets`](#method-listwallets) | 🟢 `v0.20` | Lists wallets. | -| [`removeIdp`](#method-removeidp) | 🟢 `v0.20` | Removes an identity provider. Fails if an existing network is using the identity provider. | -| [`removeNetwork`](#method-removenetwork) | 🟢 `v0.20` | Removes a new network configuration (similar to EIP-3085). | -| [`removeSession`](#method-removesession) | 🟢 `v0.20` | Removes the current network session. | -| [`removeWallet`](#method-removewallet) | 🟢 `v0.20` | Removes a party with the given hint. | -| [`setPrimaryWallet`](#method-setprimarywallet) | 🟢 `v0.20` | Sets the specified wallet as the primary wallet for dApp usage. | -| [`sign`](#method-sign) | 🟢 `v0.20` | Signs the provided data with the private key of the specified or active party. | -| [`syncWallets`](#method-syncwallets) | 🟢 `v0.20` 🔵 `v0.21` | Synchronizes wallets with the connected network. | +

Back to overview

+ +
+ +

OpenRPC Spec

+ + +

User API

+ + +

An OpenRPC specification for the user to interact with the Wallet Gateway.

+ + +
+ + JSON-RPC + + Since 0.20.0 + + Changed 0.21.0 + +
+ + +
+ +
+
Latest source path
+
api-specs/openrpc-user-api.json
+
+ +
+
Publish version
+
0.21.0
+
+ +
+
OpenRPC version
+
1.2.6
+
+ +
+
Spec info.version
+
0.1.0
+
+ +
+ +
-## Methods - - -### `addIdp` - -- Introduced: `0.20.0` - -Adds a new identity provider. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `idp` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `null` | - | - | - -**Params Example** - -```json -{ - "params": { - "idp": { - "id": "", - "type": "", - "issuer": "" - } - } -} -``` - -**Result Example** - -```json -"" -``` - - -### `addNetwork` - -- Introduced: `0.20.0` - -Adds a new network configuration (similar to EIP-3085). - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `network` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `null` | - | - | - -**Params Example** - -```json -{ - "params": { - "network": { - "id": "", - "name": "", - "description": "", - "identityProviderId": "", - "auth": { - "method": "", - "scope": "", - "clientId": "", - "audience": "" - }, - "ledgerApi": "" - } - } -} -``` - -**Result Example** - -```json -"" -``` - - -### `addSession` - -- Introduced: `0.20.0` - -Adds a network session. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `networkId` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `accessToken`, `id`, `idp`, `network`, `status` | - | - -**Params Example** - -```json -{ - "params": { - "networkId": "" - } -} -``` - -**Result Example** - -```json -{ - "id": "", - "network": { - "id": "", - "name": "", - "description": "", - "identityProviderId": "", - "auth": { - "method": "", - "scope": "", - "clientId": "", - "audience": "" - }, - "ledgerApi": "" - }, - "idp": { - "id": "", - "type": "", - "issuer": "" - }, - "accessToken": "", - "status": "" -} -``` - - -### `allocatePartyForWallet` - -- Introduced: `0.21.0` - -Allocates a party for an already initialized wallet if external signing is complete. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `partyId` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `wallet` | - | - -**Params Example** - -```json -{ - "params": { - "partyId": "" - } -} -``` - -**Result Example** - -```json -{ - "wallet": { - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" - } -} -``` - - -### `createWallet` - -- Introduced: `0.20.0` -Changed in: `0.21.0` - -Creates a new wallet and party with the given hint. - -**Version Changes** - -| Version | Changes | -| --- | --- | -| `0.21.0` | description updated | - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `partyHint`, `signingProviderId`, `networkId` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `wallet` | - | - -**Params Example** - -```json -{ - "params": { - "partyHint": "", - "signingProviderId": "" - } -} -``` - -**Result Example** - -```json -{ - "wallet": { - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" - } -} -``` - - -### `deleteTransaction` - -- Introduced: `0.20.0` - -Deletes a pending transaction. Only transactions with status 'pending' can be deleted. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `commandId` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `null` | - | - | - -**Params Example** - -```json -{ - "params": { - "commandId": "" - } -} -``` - -**Result Example** - -```json -"" -``` - - -### `execute` - -- Introduced: `0.20.0` - -Executes a signed transaction. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `commandId`, `partyId`, `signature`, `signedBy` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | - | - | - -**Params Example** - -```json -{ - "params": { - "signature": "", - "partyId": "", - "commandId": "", - "signedBy": "" - } -} -``` - -**Result Example** - -```json -{} -``` - - -### `getTransaction` - -- Introduced: `0.20.0` - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `commandId` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `commandId`, `preparedTransaction`, `preparedTransactionHash`, `status` | - | - -**Params Example** - -```json -{ - "params": { - "commandId": "" - } -} -``` - -**Result Example** - -```json -{ - "commandId": "", - "status": "", - "preparedTransaction": "", - "preparedTransactionHash": "" -} -``` - - -### `getUser` - -- Introduced: `0.20.0` - -Returns information about the current user, including whether they are an admin. - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `isAdmin`, `userId` | - | - -**Result Example** - -```json -{ - "userId": "", - "isAdmin": "" -} -``` - - -### `isWalletSyncNeeded` - -- Introduced: `0.20.0` - -Checks if wallet sync is needed (disabled wallets or new parties on ledger). - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `walletSyncNeeded` | - | - -**Result Example** - -```json -{ - "walletSyncNeeded": "" -} -``` - - -### `listIdps` - -- Introduced: `0.20.0` - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `idps` | - | - -**Result Example** -```json -{ - "idps": [ - { - "id": "", - "type": "", - "issuer": "" - } - ] -} -``` - - -### `listNetworks` - -- Introduced: `0.20.0` - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `networks` | - | - -**Result Example** - -```json -{ - "networks": [ - { - "id": "", - "name": "", - "description": "", - "identityProviderId": "", - "auth": { - "method": "", - "scope": "", - "clientId": "", - "audience": "" - }, - "ledgerApi": "" - } - ] -} -``` - - -### `listSessions` - -- Introduced: `0.20.0` - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `sessions` | - | - -**Result Example** - -```json -{ - "sessions": [ - { - "id": "", - "network": { - "id": "", - "name": "", - "description": "", - "identityProviderId": "", - "auth": "", - "ledgerApi": "" - }, - "idp": { - "id": "", - "type": "", - "issuer": "" - }, - "accessToken": "", - "status": "" - } - ] -} -``` - - -### `listTransactions` - -- Introduced: `0.20.0` - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `transactions` | - | - -**Result Example** - -```json -{ - "transactions": [ - { - "commandId": "", - "status": "", - "preparedTransaction": "", - "preparedTransactionHash": "" - } - ] -} -``` - - -### `listWallets` - -- Introduced: `0.20.0` - -Lists wallets. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | - | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `array[object]` | - | - | - -**Params Example** - -```json -{ - "params": { - "filter": { - "networkIds": [ - "" - ], - "signingProviderIds": [ - "" - ] - } - } -} -``` - -**Result Example** - -```json -[ - { - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" - } -] -``` - - -### `removeIdp` - -- Introduced: `0.20.0` - -Removes an identity provider. Fails if an existing network is using the identity provider. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `identityProviderId` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `null` | - | - | - -**Params Example** - -```json -{ - "params": { - "identityProviderId": "" - } -} -``` - -**Result Example** - -```json -"" -``` - - -### `removeNetwork` - -- Introduced: `0.20.0` - -Removes a new network configuration (similar to EIP-3085). - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `networkName` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `null` | - | - | - -**Params Example** - -```json -{ - "params": { - "networkName": "" - } -} -``` - -**Result Example** - -```json -"" -``` - - -### `removeSession` - -- Introduced: `0.20.0` - -Removes the current network session. - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `null` | - | - | - -**Result Example** - -```json -"" -``` - - -### `removeWallet` - -- Introduced: `0.20.0` - -Removes a party with the given hint. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `partyId` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | - | - | - -**Params Example** - -```json -{ - "params": { - "partyId": "" - } -} -``` - -**Result Example** - -```json -{} -``` - - -### `setPrimaryWallet` - -- Introduced: `0.20.0` - -Sets the specified wallet as the primary wallet for dApp usage. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `partyId` | - | - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `null` | - | - | - -**Params Example** - -```json -{ - "params": { - "partyId": "" - } -} -``` - -**Result Example** - -```json -"" -``` - - -### `sign` - -- Introduced: `0.20.0` - -Signs the provided data with the private key of the specified or active party. - -**Parameters** - -| Parameter | Schema | Required Fields | Description | -| --- | --- | --- | --- | -| `params` | `object` | `commandId`, `partyId`, `preparedTransaction`, `preparedTransactionHash` | - | - -**Result** +## Methods -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `partyId`, `signature`, `signedBy` | - | -**Params Example** - -```json -{ - "params": { - "preparedTransaction": "", - "preparedTransactionHash": "", - "commandId": "", - "partyId": "" - } -} -``` - -**Result Example** - -```json -{ - "signature": "", - "partyId": "", - "signedBy": "" -} -``` - - -### `syncWallets` - -- Introduced: `0.20.0` -Changed in: `0.21.0` - -Synchronizes wallets with the connected network. - -**Version Changes** - -| Version | Changes | -| --- | --- | -| `0.21.0` | result updated (required fields) | - -**Parameters** - -_No parameters._ - -**Result** - -| Schema | Required Fields | Description | -| --- | --- | --- | -| `object` | `added`, `disabled`, `updated` | - | - -**Result Example** - -```json -{ - "added": [ - { - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" - } - ], - "updated": [ - { - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" - } - ], - "disabled": [ - { - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" - } - ] -} -``` +Method pages are the primary reference surface. This spec page stays focused on grouping and discovery. + + + +
+ + + + +
+

addIdp

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Adds a new identity provider.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
null
+
+ +
+ + + + + + + + +
+

addNetwork

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Adds a new network configuration (similar to EIP-3085).

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
null
+
+ +
+ + + + + + + + +
+

addSession

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Adds a network session.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

allocatePartyForWallet

+ +
+ + JSON-RPC + + Since 0.21.0 + +
+ +
+ +

Allocates a party for an already initialized wallet if external signing is complete.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

createWallet

+ +
+ + JSON-RPC + + Since 0.20.0 + + Changed 0.21.0 + +
+ +
+ +

Creates a new wallet and party with the given hint.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

deleteTransaction

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Deletes a pending transaction. Only transactions with status 'pending' can be deleted.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
null
+
+ +
+ + + + + + + + +
+

execute

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Executes a signed transaction.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

getTransaction

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

getUser

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Returns information about the current user, including whether they are an admin.

+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

isWalletSyncNeeded

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Checks if wallet sync is needed (disabled wallets or new parties on ledger).

+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

listIdps

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

listNetworks

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

listSessions

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

listTransactions

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

listWallets

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Lists wallets.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
array[object]
+
+ +
+ + + + + + + + +
+

removeIdp

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Removes an identity provider. Fails if an existing network is using the identity provider.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
null
+
+ +
+ + + + + + + + +
+

removeNetwork

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Removes a new network configuration (similar to EIP-3085).

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
null
+
+ +
+ + + + + + + + +
+

removeSession

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Removes the current network session.

+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
null
+
+ +
+ + + + + + + + +
+

removeWallet

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Removes a party with the given hint.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

setPrimaryWallet

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Sets the specified wallet as the primary wallet for dApp usage.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
null
+
+ +
+ + + + + + + + +
+

sign

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

Signs the provided data with the private key of the specified or active party.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + + + + + + + +
+

syncWallets

+ +
+ + JSON-RPC + + Since 0.20.0 + + Changed 0.21.0 + +
+ +
+ +

Synchronizes wallets with the connected network.

+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + + + + +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/wallet-gateway-overview.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/wallet-gateway-overview.mdx index 3861e15..14073aa 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/wallet-gateway-overview.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/wallet-gateway-overview.mdx @@ -3,22 +3,230 @@ title: "Wallet Gateway OpenRPC" description: "Versioned OpenRPC reference docs." --- -# Wallet Gateway OpenRPC +
+ +

OpenRPC Reference

+ + +

Wallet Gateway OpenRPC

+ + +

Operation-first JSON-RPC reference pages with version history carried from the snapshot lifecycle report.

+ + +
+ + OpenRPC + + 0.21.0 + +
-Generated from versioned OpenRPC snapshots. + +
+ +
+
Publish version
+
0.21.0
+
+ +
+
Versions compared
+
0.20.0, 0.21.0
+
+ +
+
Source
+
splice-wallet-kernel Wallet Gateway OpenRPC release-tag snapshots
+
+ +
+
Version filter
+
characterization fixture versions
+
+ +
-- Publish version: `0.21.0` -- Versions compared: `0.20.0`, `0.21.0` -- Source: `splice-wallet-kernel Wallet Gateway OpenRPC release-tag snapshots` -- Version filter: `characterization fixture versions` +
-## Table of Contents -🟢 Active Since 🔵 Changed 🔴 Removed +## Specs -| NAME | STATUS | SUMMARY | -| --- | --- | --- | -| [`dApp API`](/reference/wallet-gateway-json-rpc/rpc-specs/dapp-api) | 🟢 `v0.20` | Splice Wallet JSON-RPC dApp API. 12 methods | -| [`Remote dApp API`](/reference/wallet-gateway-json-rpc/rpc-specs/dapp-remote-api) | 🟢 `v0.20` | Splice Wallet JSON-RPC Remote dApp API. 13 methods | -| [`Signing API`](/reference/wallet-gateway-json-rpc/rpc-specs/signing-api) | 🟢 `v0.20` | Wallet JSON-RPC Signing API. 8 methods | -| [`User API`](/reference/wallet-gateway-json-rpc/rpc-specs/user-api) | 🟢 `v0.20` 🔵 `v0.21` | Splice Wallet JSON-RPC User API. 22 methods | + +Choose a spec page to browse its methods, then drill into operation pages for request/response details. + + + +
+ + + + +
+

dApp API

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

An OpenRPC specification for the dapp to interact with a Wallet Provider.

+ + +
+ +
+
Methods
+
12
+
+ +
+
Latest version
+
0.21.0
+
+ +
+
OpenRPC
+
1.2.6
+
+ +
+ + + + + + + + +
+

Remote dApp API

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

An OpenRPC specification for remotely hosted Wallet Providers. Due to the remote nature, an implementing provider must bridge certain functionality on the client-side to satisfy the general dApp AP...

+ + +
+ +
+
Methods
+
13
+
+ +
+
Latest version
+
0.21.0
+
+ +
+
OpenRPC
+
1.2.6
+
+ +
+ + + + + + + + +
+

Signing API

+ +
+ + JSON-RPC + + Since 0.20.0 + +
+ +
+ +

An OpenRPC specification for the Signing API which allows the Wallet Gateway to interact with a Wallet Providers.

+ + +
+ +
+
Methods
+
8
+
+ +
+
Latest version
+
0.21.0
+
+ +
+
OpenRPC
+
1.2.6
+
+ +
+ + + + + + + + +
+

User API

+ +
+ + JSON-RPC + + Since 0.20.0 + + Changed 0.21.0 + +
+ +
+ +

An OpenRPC specification for the user to interact with the Wallet Gateway.

+ + +
+ +
+
Methods
+
22
+
+ +
+
Latest version
+
0.21.0
+
+ +
+
OpenRPC
+
1.2.6
+
+ +
+ + + + + +
diff --git a/tests/fixtures/characterization/protobuf/expected/index.mdx b/tests/fixtures/characterization/protobuf/expected/index.mdx index 46230ea..ffde405 100644 --- a/tests/fixtures/characterization/protobuf/expected/index.mdx +++ b/tests/fixtures/characterization/protobuf/expected/index.mdx @@ -1,129 +1,1535 @@ --- -title: "Canton Protobuf History" +title: "Canton Protobuf Reference" description: "Descriptor-backed protobuf API history grouped by package." --- -# Canton Protobuf History - -This page is generated from local descriptor-image snapshots with source info. - -## Source - -- Source name: `Canton protobuf descriptor snapshots from release tags` -- Version filter: `characterization fixture versions` -- Latest release: `v3.4.11` -- Source repo: `git@github.com:DACH-NY/canton.git` - -## Latest Snapshot - -- Packages: `29` -- Services: `52` -- Endpoints: `248` -- Messages: `932` -- Enums: `48` - -## Table of Contents - -🟢 Active Since 🔵 Changed 🔴 Removed - -| NAME | STATUS | SUMMARY | -| --- | --- | --- | -| [`com.daml.ledger.api.v2`](expected/packages/com-daml-ledger-api-v2) | 🟢 `v3.4` | 9 services, 20 endpoints, 103 messages, 8 enums | -| [`com.daml.ledger.api.v2.admin`](expected/packages/com-daml-ledger-api-v2-admin) | 🟢 `v3.4` | 6 services, 28 endpoints, 78 messages, 3 enums | -| [`com.daml.ledger.api.v2.interactive`](expected/packages/com-daml-ledger-api-v2-interactive) | 🟢 `v3.4` | 1 services, 6 endpoints, 28 messages, 1 enums | -| [`com.digitalasset.canton.admin.participant.v30`](expected/packages/com-digitalasset-canton-admin-participant-v30) | 🟢 `v3.4` | 11 services, 69 endpoints, 169 messages, 7 enums | -| [`com.digitalasset.canton.admin.sequencer.v30`](expected/packages/com-digitalasset-canton-admin-sequencer-v30) | 🟢 `v3.4` | 1 services, 1 endpoints, 12 messages, 1 enums | -| [`com.digitalasset.canton.sequencer.admin.v30`](expected/packages/com-digitalasset-canton-sequencer-admin-v30) | 🟢 `v3.4` | 5 services, 37 endpoints, 81 messages, 1 enums | -| [`com.digitalasset.canton.sequencer.api.v30`](expected/packages/com-digitalasset-canton-sequencer-api-v30) | 🟢 `v3.4` | 4 services, 17 endpoints, 48 messages | -| [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1`](expected/packages/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-standalone-v1) | 🟢 `v3.4` | 1 services, 2 endpoints, 5 messages | -| [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30`](expected/packages/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30) | 🟢 `v3.4` | 1 services, 1 endpoints, 37 messages | -| [`com.digitalasset.canton.admin.mediator.v30`](expected/packages/com-digitalasset-canton-admin-mediator-v30) | 🟢 `v3.4` | 1 services, 1 endpoints, 3 messages | -| [`com.digitalasset.canton.mediator.admin.v30`](expected/packages/com-digitalasset-canton-mediator-admin-v30) | 🟢 `v3.4` | 4 services, 13 endpoints, 17 messages, 1 enums | -| [`com.digitalasset.canton.admin.health.v30`](expected/packages/com-digitalasset-canton-admin-health-v30) | 🟢 `v3.4` | 1 services, 4 endpoints, 14 messages, 1 enums | -| [`com.digitalasset.canton.connection.v30`](expected/packages/com-digitalasset-canton-connection-v30) | 🟢 `v3.4` | 1 services, 1 endpoints, 2 messages | -| [`com.digitalasset.canton.crypto.admin.v30`](expected/packages/com-digitalasset-canton-crypto-admin-v30) | 🟢 `v3.4` | 1 services, 12 endpoints, 33 messages | -| [`com.digitalasset.canton.time.admin.v30`](expected/packages/com-digitalasset-canton-time-admin-v30) | 🟢 `v3.4` | 1 services, 2 endpoints, 4 messages | -| [`com.digitalasset.canton.topology.admin.v30`](expected/packages/com-digitalasset-canton-topology-admin-v30) | 🟢 `v3.4` | 4 services, 34 endpoints, 100 messages, 1 enums | -| [`com.daml.ledger.api.v2.interactive.transaction.v1`](expected/packages/com-daml-ledger-api-v2-interactive-transaction-v1) | - | 0 services, 0 endpoints, 5 messages | -| [`com.digitalasset.canton.admin.crypto.v30`](expected/packages/com-digitalasset-canton-admin-crypto-v30) | - | 0 services, 0 endpoints, 1 messages, 1 enums | -| [`com.digitalasset.canton.admin.pruning.v30`](expected/packages/com-digitalasset-canton-admin-pruning-v30) | - | 0 services, 0 endpoints, 28 messages | -| [`com.digitalasset.canton.admin.time.v30`](expected/packages/com-digitalasset-canton-admin-time-v30) | - | 0 services, 0 endpoints, 2 messages | -| [`com.digitalasset.canton.crypto.v30`](expected/packages/com-digitalasset-canton-crypto-v30) | - | 0 services, 0 endpoints, 20 messages, 14 enums | -| [`com.digitalasset.canton.participant.protocol.v30`](expected/packages/com-digitalasset-canton-participant-protocol-v30) | - | 0 services, 0 endpoints, 12 messages | -| [`com.digitalasset.canton.protocol.v30`](expected/packages/com-digitalasset-canton-protocol-v30) | - | 0 services, 0 endpoints, 120 messages, 9 enums | -| [`com.digitalasset.canton.protocol.v31`](expected/packages/com-digitalasset-canton-protocol-v31) | - | 0 services, 0 endpoints, 1 messages | -| [`com.digitalasset.canton.synchronizer.protocol.v30`](expected/packages/com-digitalasset-canton-synchronizer-protocol-v30) | - | 0 services, 0 endpoints, 2 messages | -| [`com.digitalasset.canton.synchronizer.v30`](expected/packages/com-digitalasset-canton-synchronizer-v30) | - | 0 services, 0 endpoints, 1 messages | -| [`com.digitalasset.canton.v30`](expected/packages/com-digitalasset-canton-v30) | - | 0 services, 0 endpoints, 1 messages | -| [`com.digitalasset.canton.version.v1`](expected/packages/com-digitalasset-canton-version-v1) | - | 0 services, 0 endpoints, 1 messages | -| [`daml.platform.v1`](expected/packages/daml-platform-v1) | - | 0 services, 0 endpoints, 4 messages | +
+ +

Protobuf Reference

+ + +

Canton Protobuf Reference

+ + +

Operation-first gRPC pages with package-level browsing and recursive related schema sections.

+ + +
+ + Protobuf + + v3.4.11 + +
+ + +
+ +
+
Source
+
Canton protobuf descriptor snapshots from release tags
+
+ +
+
Version filter
+
characterization fixture versions
+
+ +
+
Latest release
+
v3.4.11
+
+ +
+
Packages
+
29
+
+ +
+
Endpoints
+
248
+
+ +
+
Messages
+
932
+
+ +
+ +
+ ## Release Summary -| Version | Endpoints +/~/- | Messages +/~/- | Enums +/~/- | Files +/~/- | -| --- | --- | --- | --- | --- | -| `3.4.0` | `246/0/0` | `928/0/0` | `47/0/0` | `107/0/0` | -| `3.4.11` | `2/0/0` | `4/14/0` | `1/1/0` | `1/10/0` | - -## Reference - -Packages are grouped by API area. Each package page contains its services, endpoint history, and shared type reference. - -### Ledger API - -| Package | Services | Endpoints | Messages | Enums | -| --- | --- | --- | --- | --- | -| [`com.daml.ledger.api.v2`](expected/packages/com-daml-ledger-api-v2) | `9` | `20` | `103` | `8` | -| [`com.daml.ledger.api.v2.admin`](expected/packages/com-daml-ledger-api-v2-admin) | `6` | `28` | `78` | `3` | -| [`com.daml.ledger.api.v2.interactive`](expected/packages/com-daml-ledger-api-v2-interactive) | `1` | `6` | `28` | `1` | - -### Participant Administration - -| Package | Services | Endpoints | Messages | Enums | -| --- | --- | --- | --- | --- | -| [`com.digitalasset.canton.admin.participant.v30`](expected/packages/com-digitalasset-canton-admin-participant-v30) | `11` | `69` | `169` | `7` | - -### Sequencer - -| Package | Services | Endpoints | Messages | Enums | -| --- | --- | --- | --- | --- | -| [`com.digitalasset.canton.admin.sequencer.v30`](expected/packages/com-digitalasset-canton-admin-sequencer-v30) | `1` | `1` | `12` | `1` | -| [`com.digitalasset.canton.sequencer.admin.v30`](expected/packages/com-digitalasset-canton-sequencer-admin-v30) | `5` | `37` | `81` | `1` | -| [`com.digitalasset.canton.sequencer.api.v30`](expected/packages/com-digitalasset-canton-sequencer-api-v30) | `4` | `17` | `48` | `0` | -| [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1`](expected/packages/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-standalone-v1) | `1` | `2` | `5` | `0` | -| [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30`](expected/packages/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30) | `1` | `1` | `37` | `0` | - -### Mediator - -| Package | Services | Endpoints | Messages | Enums | -| --- | --- | --- | --- | --- | -| [`com.digitalasset.canton.admin.mediator.v30`](expected/packages/com-digitalasset-canton-admin-mediator-v30) | `1` | `1` | `3` | `0` | -| [`com.digitalasset.canton.mediator.admin.v30`](expected/packages/com-digitalasset-canton-mediator-admin-v30) | `4` | `13` | `17` | `1` | - -### Shared Administration - -| Package | Services | Endpoints | Messages | Enums | -| --- | --- | --- | --- | --- | -| [`com.digitalasset.canton.admin.health.v30`](expected/packages/com-digitalasset-canton-admin-health-v30) | `1` | `4` | `14` | `1` | -| [`com.digitalasset.canton.connection.v30`](expected/packages/com-digitalasset-canton-connection-v30) | `1` | `1` | `2` | `0` | -| [`com.digitalasset.canton.crypto.admin.v30`](expected/packages/com-digitalasset-canton-crypto-admin-v30) | `1` | `12` | `33` | `0` | -| [`com.digitalasset.canton.time.admin.v30`](expected/packages/com-digitalasset-canton-time-admin-v30) | `1` | `2` | `4` | `0` | -| [`com.digitalasset.canton.topology.admin.v30`](expected/packages/com-digitalasset-canton-topology-admin-v30) | `4` | `34` | `100` | `1` | - -### Schema Packages - -| Package | Services | Endpoints | Messages | Enums | -| --- | --- | --- | --- | --- | -| [`com.daml.ledger.api.v2.interactive.transaction.v1`](expected/packages/com-daml-ledger-api-v2-interactive-transaction-v1) | `0` | `0` | `5` | `0` | -| [`com.digitalasset.canton.admin.crypto.v30`](expected/packages/com-digitalasset-canton-admin-crypto-v30) | `0` | `0` | `1` | `1` | -| [`com.digitalasset.canton.admin.pruning.v30`](expected/packages/com-digitalasset-canton-admin-pruning-v30) | `0` | `0` | `28` | `0` | -| [`com.digitalasset.canton.admin.time.v30`](expected/packages/com-digitalasset-canton-admin-time-v30) | `0` | `0` | `2` | `0` | -| [`com.digitalasset.canton.crypto.v30`](expected/packages/com-digitalasset-canton-crypto-v30) | `0` | `0` | `20` | `14` | -| [`com.digitalasset.canton.participant.protocol.v30`](expected/packages/com-digitalasset-canton-participant-protocol-v30) | `0` | `0` | `12` | `0` | -| [`com.digitalasset.canton.protocol.v30`](expected/packages/com-digitalasset-canton-protocol-v30) | `0` | `0` | `120` | `9` | -| [`com.digitalasset.canton.protocol.v31`](expected/packages/com-digitalasset-canton-protocol-v31) | `0` | `0` | `1` | `0` | -| [`com.digitalasset.canton.synchronizer.protocol.v30`](expected/packages/com-digitalasset-canton-synchronizer-protocol-v30) | `0` | `0` | `2` | `0` | -| [`com.digitalasset.canton.synchronizer.v30`](expected/packages/com-digitalasset-canton-synchronizer-v30) | `0` | `0` | `1` | `0` | -| [`com.digitalasset.canton.v30`](expected/packages/com-digitalasset-canton-v30) | `0` | `0` | `1` | `0` | -| [`com.digitalasset.canton.version.v1`](expected/packages/com-digitalasset-canton-version-v1) | `0` | `0` | `1` | `0` | -| [`daml.platform.v1`](expected/packages/daml-platform-v1) | `0` | `0` | `4` | `0` | + +Counts are shown as added / changed / removed within each release slice. + + + +
+ + +
+ +
+

3.4.0

+ +
+ + Release + +
+ +
+ +

Endpoint / message / enum deltas for this release.

+ + +
+ +
+
Endpoints
+
246 / 0 / 0
+
+ +
+
Messages
+
928 / 0 / 0
+
+ +
+
Enums
+
47 / 0 / 0
+
+ +
+ + +
+ + + +
+ +
+

3.4.11

+ +
+ + Release + +
+ +
+ +

Endpoint / message / enum deltas for this release.

+ + +
+ +
+
Endpoints
+
2 / 0 / 0
+
+ +
+
Messages
+
4 / 14 / 0
+
+ +
+
Enums
+
1 / 1 / 0
+
+ +
+ + +
+ + +
+ + + + + +## Ledger API + + + + +
+ + + + +
+

com.daml.ledger.api.v2

+ +
+ + gRPC + +
+ +
+ +

9 services, 20 endpoints, 103 messages, 8 enums

+ + +
+ +
+
Services
+
9
+
+ +
+
Endpoints
+
20
+
+ +
+
Messages
+
103
+
+ +
+
Enums
+
8
+
+ +
+ + + + + + + + +
+

com.daml.ledger.api.v2.admin

+ +
+ + gRPC + +
+ +
+ +

6 services, 28 endpoints, 78 messages, 3 enums

+ + +
+ +
+
Services
+
6
+
+ +
+
Endpoints
+
28
+
+ +
+
Messages
+
78
+
+ +
+
Enums
+
3
+
+ +
+ + + + + + + + +
+

com.daml.ledger.api.v2.interactive

+ +
+ + gRPC + +
+ +
+ +

1 services, 6 endpoints, 28 messages, 1 enums

+ + +
+ +
+
Services
+
1
+
+ +
+
Endpoints
+
6
+
+ +
+
Messages
+
28
+
+ +
+
Enums
+
1
+
+ +
+ + + + + +
+ + + + + +## Participant Administration + + + + +
+ + + + +
+

com.digitalasset.canton.admin.participant.v30

+ +
+ + gRPC + +
+ +
+ +

11 services, 69 endpoints, 169 messages, 7 enums

+ + +
+ +
+
Services
+
11
+
+ +
+
Endpoints
+
69
+
+ +
+
Messages
+
169
+
+ +
+
Enums
+
7
+
+ +
+ + + + + +
+ + + + + +## Sequencer + + + + +
+ + + + +
+

com.digitalasset.canton.admin.sequencer.v30

+ +
+ + gRPC + +
+ +
+ +

1 services, 1 endpoints, 12 messages, 1 enums

+ + +
+ +
+
Services
+
1
+
+ +
+
Endpoints
+
1
+
+ +
+
Messages
+
12
+
+ +
+
Enums
+
1
+
+ +
+ + + + + + + + +
+

com.digitalasset.canton.sequencer.admin.v30

+ +
+ + gRPC + +
+ +
+ +

5 services, 37 endpoints, 81 messages, 1 enums

+ + +
+ +
+
Services
+
5
+
+ +
+
Endpoints
+
37
+
+ +
+
Messages
+
81
+
+ +
+
Enums
+
1
+
+ +
+ + + + + + + + +
+

com.digitalasset.canton.sequencer.api.v30

+ +
+ + gRPC + +
+ +
+ +

4 services, 17 endpoints, 48 messages

+ + +
+ +
+
Services
+
4
+
+ +
+
Endpoints
+
17
+
+ +
+
Messages
+
48
+
+ +
+
Enums
+
0
+
+ +
+ + + + + + + + +
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1

+ +
+ + gRPC + +
+ +
+ +

1 services, 2 endpoints, 5 messages

+ + +
+ +
+
Services
+
1
+
+ +
+
Endpoints
+
2
+
+ +
+
Messages
+
5
+
+ +
+
Enums
+
0
+
+ +
+ + + + + + + + +
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30

+ +
+ + gRPC + +
+ +
+ +

1 services, 1 endpoints, 37 messages

+ + +
+ +
+
Services
+
1
+
+ +
+
Endpoints
+
1
+
+ +
+
Messages
+
37
+
+ +
+
Enums
+
0
+
+ +
+ + + + + +
+ + + + + +## Mediator + + + + +
+ + + + +
+

com.digitalasset.canton.admin.mediator.v30

+ +
+ + gRPC + +
+ +
+ +

1 services, 1 endpoints, 3 messages

+ + +
+ +
+
Services
+
1
+
+ +
+
Endpoints
+
1
+
+ +
+
Messages
+
3
+
+ +
+
Enums
+
0
+
+ +
+ + + + + + + + +
+

com.digitalasset.canton.mediator.admin.v30

+ +
+ + gRPC + +
+ +
+ +

4 services, 13 endpoints, 17 messages, 1 enums

+ + +
+ +
+
Services
+
4
+
+ +
+
Endpoints
+
13
+
+ +
+
Messages
+
17
+
+ +
+
Enums
+
1
+
+ +
+ + + + + +
+ + + + + +## Shared Administration + + + + +
+ + + + +
+

com.digitalasset.canton.admin.health.v30

+ +
+ + gRPC + +
+ +
+ +

1 services, 4 endpoints, 14 messages, 1 enums

+ + +
+ +
+
Services
+
1
+
+ +
+
Endpoints
+
4
+
+ +
+
Messages
+
14
+
+ +
+
Enums
+
1
+
+ +
+ + + + + + + + +
+

com.digitalasset.canton.connection.v30

+ +
+ + gRPC + +
+ +
+ +

1 services, 1 endpoints, 2 messages

+ + +
+ +
+
Services
+
1
+
+ +
+
Endpoints
+
1
+
+ +
+
Messages
+
2
+
+ +
+
Enums
+
0
+
+ +
+ + + + + + + + +
+

com.digitalasset.canton.crypto.admin.v30

+ +
+ + gRPC + +
+ +
+ +

1 services, 12 endpoints, 33 messages

+ + +
+ +
+
Services
+
1
+
+ +
+
Endpoints
+
12
+
+ +
+
Messages
+
33
+
+ +
+
Enums
+
0
+
+ +
+ + + + + + + + +
+

com.digitalasset.canton.time.admin.v30

+ +
+ + gRPC + +
+ +
+ +

1 services, 2 endpoints, 4 messages

+ + +
+ +
+
Services
+
1
+
+ +
+
Endpoints
+
2
+
+ +
+
Messages
+
4
+
+ +
+
Enums
+
0
+
+ +
+ + + + + + + + +
+

com.digitalasset.canton.topology.admin.v30

+ +
+ + gRPC + +
+ +
+ +

4 services, 34 endpoints, 100 messages, 1 enums

+ + +
+ +
+
Services
+
4
+
+ +
+
Endpoints
+
34
+
+ +
+
Messages
+
100
+
+ +
+
Enums
+
1
+
+ +
+ + + + + +
+ + + + + +## Schema Packages + + + + +
+ + + + +
+

com.daml.ledger.api.v2.interactive.transaction.v1

+ +
+ + gRPC + +
+ +
+ +

0 services, 0 endpoints, 5 messages

+ + +
+ +
+
Services
+
0
+
+ +
+
Endpoints
+
0
+
+ +
+
Messages
+
5
+
+ +
+
Enums
+
0
+
+ +
+ + + + + + + + +
+

com.digitalasset.canton.admin.crypto.v30

+ +
+ + gRPC + +
+ +
+ +

0 services, 0 endpoints, 1 messages, 1 enums

+ + +
+ +
+
Services
+
0
+
+ +
+
Endpoints
+
0
+
+ +
+
Messages
+
1
+
+ +
+
Enums
+
1
+
+ +
+ + + + + + + + +
+

com.digitalasset.canton.admin.pruning.v30

+ +
+ + gRPC + +
+ +
+ +

0 services, 0 endpoints, 28 messages

+ + +
+ +
+
Services
+
0
+
+ +
+
Endpoints
+
0
+
+ +
+
Messages
+
28
+
+ +
+
Enums
+
0
+
+ +
+ + + + + + + + +
+

com.digitalasset.canton.admin.time.v30

+ +
+ + gRPC + +
+ +
+ +

0 services, 0 endpoints, 2 messages

+ + +
+ +
+
Services
+
0
+
+ +
+
Endpoints
+
0
+
+ +
+
Messages
+
2
+
+ +
+
Enums
+
0
+
+ +
+ + + + + + + + +
+

com.digitalasset.canton.crypto.v30

+ +
+ + gRPC + +
+ +
+ +

0 services, 0 endpoints, 20 messages, 14 enums

+ + +
+ +
+
Services
+
0
+
+ +
+
Endpoints
+
0
+
+ +
+
Messages
+
20
+
+ +
+
Enums
+
14
+
+ +
+ + + + + + + + +
+

com.digitalasset.canton.participant.protocol.v30

+ +
+ + gRPC + +
+ +
+ +

0 services, 0 endpoints, 12 messages

+ + +
+ +
+
Services
+
0
+
+ +
+
Endpoints
+
0
+
+ +
+
Messages
+
12
+
+ +
+
Enums
+
0
+
+ +
+ + + + + + + + +
+

com.digitalasset.canton.protocol.v30

+ +
+ + gRPC + +
+ +
+ +

0 services, 0 endpoints, 120 messages, 9 enums

+ + +
+ +
+
Services
+
0
+
+ +
+
Endpoints
+
0
+
+ +
+
Messages
+
120
+
+ +
+
Enums
+
9
+
+ +
+ + + + + + + + +
+

com.digitalasset.canton.protocol.v31

+ +
+ + gRPC + +
+ +
+ +

0 services, 0 endpoints, 1 messages

+ + +
+ +
+
Services
+
0
+
+ +
+
Endpoints
+
0
+
+ +
+
Messages
+
1
+
+ +
+
Enums
+
0
+
+ +
+ + + + + + + + +
+

com.digitalasset.canton.synchronizer.protocol.v30

+ +
+ + gRPC + +
+ +
+ +

0 services, 0 endpoints, 2 messages

+ + +
+ +
+
Services
+
0
+
+ +
+
Endpoints
+
0
+
+ +
+
Messages
+
2
+
+ +
+
Enums
+
0
+
+ +
+ + + + + + + + +
+

com.digitalasset.canton.synchronizer.v30

+ +
+ + gRPC + +
+ +
+ +

0 services, 0 endpoints, 1 messages

+ + +
+ +
+
Services
+
0
+
+ +
+
Endpoints
+
0
+
+ +
+
Messages
+
1
+
+ +
+
Enums
+
0
+
+ +
+ + + + + + + + +
+

com.digitalasset.canton.v30

+ +
+ + gRPC + +
+ +
+ +

0 services, 0 endpoints, 1 messages

+ + +
+ +
+
Services
+
0
+
+ +
+
Endpoints
+
0
+
+ +
+
Messages
+
1
+
+ +
+
Enums
+
0
+
+ +
+ + + + + + + + +
+

com.digitalasset.canton.version.v1

+ +
+ + gRPC + +
+ +
+ +

0 services, 0 endpoints, 1 messages

+ + +
+ +
+
Services
+
0
+
+ +
+
Endpoints
+
0
+
+ +
+
Messages
+
1
+
+ +
+
Enums
+
0
+
+ +
+ + + + + + + + +
+

daml.platform.v1

+ +
+ + gRPC + +
+ +
+ +

0 services, 0 endpoints, 4 messages

+ + +
+ +
+
Services
+
0
+
+ +
+
Endpoints
+
0
+
+ +
+
Messages
+
4
+
+ +
+
Enums
+
0
+
+ +
+ + + + + +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/commandinspectionservice/getcommandstatus.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/commandinspectionservice/getcommandstatus.mdx new file mode 100644 index 0000000..edf34a0 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/commandinspectionservice/getcommandstatus.mdx @@ -0,0 +1,1101 @@ +--- +title: "GetCommandStatus" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2.admin

+ + +

GetCommandStatus

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.admin.CommandInspectionService/GetCommandStatus + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.CommandInspectionService/GetCommandStatus <<'EOF' +{ + "commandIdPrefix": "string", + "state": "COMMAND_STATE_UNSPECIFIED", + "limit": 0 +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "commandStatus": [ + { + "started": "string", + "completed": "string", + "completion": { + "commandId": "string", + "status": "string", + "updateId": "string", + "userId": "string", + "actAs": [ + "string" + ], + "submissionId": "string", + "deduplicationOffset": "0" + }, + "state": "COMMAND_STATE_UNSPECIFIED", + "commands": [ + { + "create": { + "templateId": "string", + "createArguments": "string" + } + } + ], + "requestStatistics": { + "envelopes": 0, + "requestSize": 0, + "recipients": 0 + }, + "updates": { + "created": [ + { + "templateId": "string", + "contractId": "string", + "contractKey": "string" + } + ], + "archived": [ + { + "templateId": "string", + "contractId": "string", + "contractKey": "string" + } + ], + "exercised": 0, + "fetched": 0, + "lookedUpByKey": 0 + } + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
CommandInspectionService
+
+ +
+
RPC
+
GetCommandStatus
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetCommandStatusRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.GetCommandStatusRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ command_id_prefix + string + +
+ +
optional filter by command id
+ +
+ +
+
+ state + CommandState + +
+ +
optional filter by state
+ +
+ +
+
+ limit + uint32 + +
+ +
optional limit of returned statuses, defaults to 100
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

GetCommandStatusResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.GetCommandStatusResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ command_status + repeated CommandStatus + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ command_id_prefix + string + +
+ +
optional filter by command id
+ +
+ +
+
+ state + CommandState + +
+ +
optional filter by state
+ +
+ +
+
+ limit + uint32 + +
+ +
optional limit of returned statuses, defaults to 100
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • COMMAND_STATE_UNSPECIFIED
    • + +
  • COMMAND_STATE_PENDING
    • + +
  • COMMAND_STATE_SUCCEEDED
    • + +
  • COMMAND_STATE_FAILED
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ command_status + repeated CommandStatus + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ started + Timestamp + +
+ +
+ +
+
+ completed + Timestamp + +
+ +
+ +
+
+ completion + Completion + +
+ +
+ +
+
+ state + CommandState + +
+ +
+ +
+
+ commands + repeated Command + +
+ +
+ +
+
+ request_statistics + RequestStatistics + +
+ +
+ +
+
+ updates + CommandUpdates + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ command_id + string + +
+ +
The ID of the succeeded or failed command. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ status + Status + +
+ +
Identifies the exact type of the error. It uses the same format of conveying error details as it is used for the RPC responses of the APIs. Optional
+ +
+ +
+
+ update_id + string + +
+ +
The update_id of the transaction or reassignment that resulted from the command with command_id. Only set for successfully executed commands. Must be a valid LedgerString (as described in ``value.proto``).
+ +
+ +
+
+ user_id + string + +
+ +
The user-id that was used for the submission, as described in ``commands.proto``. Must be a valid UserIdString (as described in ``value.proto``). Optional for historic completions where this data is not available.
+ +
+ +
+
+ act_as + repeated string + +
+ +
The set of parties on whose behalf the commands were executed. Contains the ``act_as`` parties from ``commands.proto`` filtered to the requesting parties in CompletionStreamRequest. The order of the parties need not be the same as in the submission. Each element must be a valid PartyIdString (as described in ``value.proto``). Optional for historic completions where this data is not available.
+ +
+ +
+
+ submission_id + string + +
+ +
The submission ID this completion refers to, as described in ``commands.proto``. Must be a valid LedgerString (as described in ``value.proto``). Optional
+ +
+ +
+
+ deduplication_offset + int64 + +
+ +
Specifies the start of the deduplication period by a completion stream offset (exclusive). Must be a valid absolute offset (positive integer) or participant begin (zero).
+ +
+ +
+
+ deduplication_duration + Duration + +
+ +
Specifies the length of the deduplication period. It is measured in record time of completions. Must be non-negative.
+ +
+ +
+
+ trace_context + TraceContext + +
+ +
Optional; ledger API trace context The trace context transported in this message corresponds to the trace context supplied by the client application in a HTTP2 header of the original command submission. We typically use a header to transfer this type of information. Here we use message body, because it is used in gRPC streams which do not support per message headers. This field will be populated with the trace context contained in the original submission. If that was not provided, a unique ledger-api-server generated trace context will be used instead.
+ +
+ +
+
+ offset + int64 + +
+ +
May be used in a subsequent CompletionStreamRequest to resume the consumption of this stream at a later time. Required, must be a valid absolute offset (positive integer).
+ +
+ +
+
+ synchronizer_time + SynchronizerTime + +
+ +
The synchronizer along with its record time. The synchronizer id provided, in case of - successful/failed transactions: identifies the synchronizer of the transaction - for successful/failed unassign commands: identifies the source synchronizer - for successful/failed assign commands: identifies the target synchronizer Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ traceparent + string + +
+ +
https://www.w3.org/TR/trace-context/
+ +
+ +
+
+ tracestate + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ synchronizer_id + string + +
+ +
The id of the synchronizer. Required
+ +
+ +
+
+ record_time + Timestamp + +
+ +
All commands with a maximum record time below this value MUST be considered lost if their completion has not arrived before this checkpoint. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ create + CreateCommand + +
+ +
+ +
+
+ exercise + ExerciseCommand + +
+ +
+ +
+
+ exercise_by_key + ExerciseByKeyCommand + +
+ +
+ +
+
+ create_and_exercise + CreateAndExerciseCommand + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template of contract the client wants to create. Both package-name and package-id reference identifier formats for the template-id are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ create_arguments + Record + +
+ +
The arguments required for creating a contract from this template. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template or interface of the contract the client wants to exercise. Both package-name and package-id reference identifier formats for the template-id are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. To exercise a choice on an interface, specify the interface identifier in the template_id field. Required
+ +
+ +
+
+ contract_id + string + +
+ +
The ID of the contract the client wants to exercise upon. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ choice + string + +
+ +
The name of the choice the client wants to exercise. Must be a valid NameString (as described in ``value.proto``) Required
+ +
+ +
+
+ choice_argument + Value + +
+ +
The argument for this choice. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template of contract the client wants to exercise. Both package-name and package-id reference identifier formats for the template-id are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ contract_key + Value + +
+ +
The key of the contract the client wants to exercise upon. Required
+ +
+ +
+
+ choice + string + +
+ +
The name of the choice the client wants to exercise. Must be a valid NameString (as described in ``value.proto``) Required
+ +
+ +
+
+ choice_argument + Value + +
+ +
The argument for this choice. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template of the contract the client wants to create. Both package-name and package-id reference identifier formats for the template-id are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ create_arguments + Record + +
+ +
The arguments required for creating a contract from this template. Required
+ +
+ +
+
+ choice + string + +
+ +
The name of the choice the client wants to exercise. Must be a valid NameString (as described in ``value.proto``). Required
+ +
+ +
+
+ choice_argument + Value + +
+ +
The argument for this choice. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ envelopes + uint32 + +
+ +
+ +
+
+ request_size + uint32 + +
+ +
+ +
+
+ recipients + uint32 + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ created + repeated Contract + +
+ +
+ +
+
+ archived + repeated Contract + +
+ +
+ +
+
+ exercised + uint32 + +
+ +
+ +
+
+ fetched + uint32 + +
+ +
+ +
+
+ looked_up_by_key + uint32 + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ template_id + Identifier + +
+ +
The identifier of the template used to create the contract. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ contract_id + string + +
+ +
The contract's ID Required
+ +
+ +
+
+ contract_key + Value + +
+ +
The contract key, if defined Optional
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/createidentityproviderconfig.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/createidentityproviderconfig.mdx new file mode 100644 index 0000000..998f4a7 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/createidentityproviderconfig.mdx @@ -0,0 +1,388 @@ +--- +title: "CreateIdentityProviderConfig" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2.admin

+ + +

CreateIdentityProviderConfig

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.admin.IdentityProviderConfigService/CreateIdentityProviderConfig + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.IdentityProviderConfigService/CreateIdentityProviderConfig <<'EOF' +{ + "identityProviderConfig": { + "identityProviderId": "string", + "isDeactivated": true, + "issuer": "string", + "jwksUrl": "string", + "audience": "string" + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "identityProviderConfig": { + "identityProviderId": "string", + "isDeactivated": true, + "issuer": "string", + "jwksUrl": "string", + "audience": "string" + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
IdentityProviderConfigService
+
+ +
+
RPC
+
CreateIdentityProviderConfig
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

CreateIdentityProviderConfigRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.CreateIdentityProviderConfigRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ identity_provider_config + IdentityProviderConfig + +
+ +
Required
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

CreateIdentityProviderConfigResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.CreateIdentityProviderConfigResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ identity_provider_config + IdentityProviderConfig + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ identity_provider_config + IdentityProviderConfig + +
+ +
Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ identity_provider_id + string + +
+ +
The identity provider identifier Must be a valid LedgerString (as describe in ``value.proto``). Required
+ +
+ +
+
+ is_deactivated + bool + +
+ +
When set, the callers using JWT tokens issued by this identity provider are denied all access to the Ledger API. Optional, Modifiable
+ +
+ +
+
+ issuer + string + +
+ +
Specifies the issuer of the JWT token. The issuer value is a case sensitive URL using the https scheme that contains scheme, host, and optionally, port number and path components and no query or fragment components. Required Modifiable
+ +
+ +
+
+ jwks_url + string + +
+ +
The JWKS (JSON Web Key Set) URL. The Ledger API uses JWKs (JSON Web Keys) from the provided URL to verify that the JWT has been signed with the loaded JWK. Only RS256 (RSA Signature with SHA-256) signing algorithm is supported. Required Modifiable
+ +
+ +
+
+ audience + string + +
+ +
Specifies the audience of the JWT token. When set, the callers using JWT tokens issued by this identity provider are allowed to get an access only if the "aud" claim includes the string specified here Optional, Modifiable
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ identity_provider_config + IdentityProviderConfig + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/deleteidentityproviderconfig.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/deleteidentityproviderconfig.mdx new file mode 100644 index 0000000..aa97c25 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/deleteidentityproviderconfig.mdx @@ -0,0 +1,280 @@ +--- +title: "DeleteIdentityProviderConfig" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2.admin

+ + +

DeleteIdentityProviderConfig

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.admin.IdentityProviderConfigService/DeleteIdentityProviderConfig + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.IdentityProviderConfigService/DeleteIdentityProviderConfig <<'EOF' +{ + "identityProviderId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
IdentityProviderConfigService
+
+ +
+
RPC
+
DeleteIdentityProviderConfig
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

DeleteIdentityProviderConfigRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.DeleteIdentityProviderConfigRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ identity_provider_id + string + +
+ +
The identity provider config to delete. Required
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

DeleteIdentityProviderConfigResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.DeleteIdentityProviderConfigResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ identity_provider_id + string + +
+ +
The identity provider config to delete. Required
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/getidentityproviderconfig.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/getidentityproviderconfig.mdx new file mode 100644 index 0000000..d6f239a --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/getidentityproviderconfig.mdx @@ -0,0 +1,382 @@ +--- +title: "GetIdentityProviderConfig" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2.admin

+ + +

GetIdentityProviderConfig

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.admin.IdentityProviderConfigService/GetIdentityProviderConfig + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.IdentityProviderConfigService/GetIdentityProviderConfig <<'EOF' +{ + "identityProviderId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "identityProviderConfig": { + "identityProviderId": "string", + "isDeactivated": true, + "issuer": "string", + "jwksUrl": "string", + "audience": "string" + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
IdentityProviderConfigService
+
+ +
+
RPC
+
GetIdentityProviderConfig
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetIdentityProviderConfigRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.GetIdentityProviderConfigRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ identity_provider_id + string + +
+ +
Required
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

GetIdentityProviderConfigResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.GetIdentityProviderConfigResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ identity_provider_config + IdentityProviderConfig + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ identity_provider_id + string + +
+ +
Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ identity_provider_config + IdentityProviderConfig + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ identity_provider_id + string + +
+ +
The identity provider identifier Must be a valid LedgerString (as describe in ``value.proto``). Required
+ +
+ +
+
+ is_deactivated + bool + +
+ +
When set, the callers using JWT tokens issued by this identity provider are denied all access to the Ledger API. Optional, Modifiable
+ +
+ +
+
+ issuer + string + +
+ +
Specifies the issuer of the JWT token. The issuer value is a case sensitive URL using the https scheme that contains scheme, host, and optionally, port number and path components and no query or fragment components. Required Modifiable
+ +
+ +
+
+ jwks_url + string + +
+ +
The JWKS (JSON Web Key Set) URL. The Ledger API uses JWKs (JSON Web Keys) from the provided URL to verify that the JWT has been signed with the loaded JWK. Only RS256 (RSA Signature with SHA-256) signing algorithm is supported. Required Modifiable
+ +
+ +
+
+ audience + string + +
+ +
Specifies the audience of the JWT token. When set, the callers using JWT tokens issued by this identity provider are allowed to get an access only if the "aud" claim includes the string specified here Optional, Modifiable
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/listidentityproviderconfigs.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/listidentityproviderconfigs.mdx new file mode 100644 index 0000000..fc22b51 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/listidentityproviderconfigs.mdx @@ -0,0 +1,352 @@ +--- +title: "ListIdentityProviderConfigs" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2.admin

+ + +

ListIdentityProviderConfigs

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.admin.IdentityProviderConfigService/ListIdentityProviderConfigs + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.IdentityProviderConfigService/ListIdentityProviderConfigs <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "identityProviderConfigs": [ + { + "identityProviderId": "string", + "isDeactivated": true, + "issuer": "string", + "jwksUrl": "string", + "audience": "string" + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
IdentityProviderConfigService
+
+ +
+
RPC
+
ListIdentityProviderConfigs
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ListIdentityProviderConfigsRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.ListIdentityProviderConfigsRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

ListIdentityProviderConfigsResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.ListIdentityProviderConfigsResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ identity_provider_configs + repeated IdentityProviderConfig + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ identity_provider_configs + repeated IdentityProviderConfig + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ identity_provider_id + string + +
+ +
The identity provider identifier Must be a valid LedgerString (as describe in ``value.proto``). Required
+ +
+ +
+
+ is_deactivated + bool + +
+ +
When set, the callers using JWT tokens issued by this identity provider are denied all access to the Ledger API. Optional, Modifiable
+ +
+ +
+
+ issuer + string + +
+ +
Specifies the issuer of the JWT token. The issuer value is a case sensitive URL using the https scheme that contains scheme, host, and optionally, port number and path components and no query or fragment components. Required Modifiable
+ +
+ +
+
+ jwks_url + string + +
+ +
The JWKS (JSON Web Key Set) URL. The Ledger API uses JWKs (JSON Web Keys) from the provided URL to verify that the JWT has been signed with the loaded JWK. Only RS256 (RSA Signature with SHA-256) signing algorithm is supported. Required Modifiable
+ +
+ +
+
+ audience + string + +
+ +
Specifies the audience of the JWT token. When set, the callers using JWT tokens issued by this identity provider are allowed to get an access only if the "aud" claim includes the string specified here Optional, Modifiable
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/updateidentityproviderconfig.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/updateidentityproviderconfig.mdx new file mode 100644 index 0000000..1be2d17 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/updateidentityproviderconfig.mdx @@ -0,0 +1,415 @@ +--- +title: "UpdateIdentityProviderConfig" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2.admin

+ + +

UpdateIdentityProviderConfig

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.admin.IdentityProviderConfigService/UpdateIdentityProviderConfig + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.IdentityProviderConfigService/UpdateIdentityProviderConfig <<'EOF' +{ + "identityProviderConfig": { + "identityProviderId": "string", + "isDeactivated": true, + "issuer": "string", + "jwksUrl": "string", + "audience": "string" + }, + "updateMask": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "identityProviderConfig": { + "identityProviderId": "string", + "isDeactivated": true, + "issuer": "string", + "jwksUrl": "string", + "audience": "string" + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
IdentityProviderConfigService
+
+ +
+
RPC
+
UpdateIdentityProviderConfig
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

UpdateIdentityProviderConfigRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.UpdateIdentityProviderConfigRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ identity_provider_config + IdentityProviderConfig + +
+ +
The identity provider config to update. Required, Modifiable
+ +
+ +
+
+ update_mask + FieldMask + +
+ +
An update mask specifies how and which properties of the ``IdentityProviderConfig`` message are to be updated. An update mask consists of a set of update paths. A valid update path points to a field or a subfield relative to the ``IdentityProviderConfig`` message. A valid update mask must: 1. contain at least one update path, 2. contain only valid update paths. Fields that can be updated are marked as ``Modifiable``. For additional information see the documentation for standard protobuf3's ``google.protobuf.FieldMask``. Required
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

UpdateIdentityProviderConfigResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.UpdateIdentityProviderConfigResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ identity_provider_config + IdentityProviderConfig + +
+ +
Updated identity provider config
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ identity_provider_config + IdentityProviderConfig + +
+ +
The identity provider config to update. Required, Modifiable
+ +
+ +
+
+ update_mask + FieldMask + +
+ +
An update mask specifies how and which properties of the ``IdentityProviderConfig`` message are to be updated. An update mask consists of a set of update paths. A valid update path points to a field or a subfield relative to the ``IdentityProviderConfig`` message. A valid update mask must: 1. contain at least one update path, 2. contain only valid update paths. Fields that can be updated are marked as ``Modifiable``. For additional information see the documentation for standard protobuf3's ``google.protobuf.FieldMask``. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ identity_provider_id + string + +
+ +
The identity provider identifier Must be a valid LedgerString (as describe in ``value.proto``). Required
+ +
+ +
+
+ is_deactivated + bool + +
+ +
When set, the callers using JWT tokens issued by this identity provider are denied all access to the Ledger API. Optional, Modifiable
+ +
+ +
+
+ issuer + string + +
+ +
Specifies the issuer of the JWT token. The issuer value is a case sensitive URL using the https scheme that contains scheme, host, and optionally, port number and path components and no query or fragment components. Required Modifiable
+ +
+ +
+
+ jwks_url + string + +
+ +
The JWKS (JSON Web Key Set) URL. The Ledger API uses JWKs (JSON Web Keys) from the provided URL to verify that the JWT has been signed with the loaded JWK. Only RS256 (RSA Signature with SHA-256) signing algorithm is supported. Required Modifiable
+ +
+ +
+
+ audience + string + +
+ +
Specifies the audience of the JWT token. When set, the callers using JWT tokens issued by this identity provider are allowed to get an access only if the "aud" claim includes the string specified here Optional, Modifiable
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ identity_provider_config + IdentityProviderConfig + +
+ +
Updated identity provider config
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/listknownpackages.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/listknownpackages.mdx new file mode 100644 index 0000000..910c422 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/listknownpackages.mdx @@ -0,0 +1,356 @@ +--- +title: "ListKnownPackages" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2.admin

+ + +

ListKnownPackages

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.admin.PackageManagementService/ListKnownPackages + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.PackageManagementService/ListKnownPackages <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "packageDetails": [ + { + "packageId": "string", + "packageSize": "0", + "knownSince": "string", + "name": "string", + "version": "string" + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PackageManagementService
+
+ +
+
RPC
+
ListKnownPackages
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ListKnownPackagesRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.ListKnownPackagesRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

ListKnownPackagesResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.ListKnownPackagesResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ package_details + repeated PackageDetails + +
+ +
The details of all Daml-LF packages known to backing participant. Required
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ package_details + repeated PackageDetails + +
+ +
The details of all Daml-LF packages known to backing participant. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ package_id + string + +
+ +
The identity of the Daml-LF package. Must be a valid PackageIdString (as describe in ``value.proto``). Required
+ +
+ +
+
+ package_size + uint64 + +
+ +
Size of the package in bytes. The size of the package is given by the size of the ``daml_lf`` ArchivePayload. See further details in ``daml_lf.proto``. Required
+ +
+ +
+
+ known_since + Timestamp + +
+ +
Indicates since when the package is known to the backing participant. Required
+ +
+ +
+
+ name + string + +
+ +
Name of the package as defined by the package metadata
+ +
+ +
+
+ version + string + +
+ +
Version of the package as defined by the package metadata
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/updatevettedpackages.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/updatevettedpackages.mdx new file mode 100644 index 0000000..1588388 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/updatevettedpackages.mdx @@ -0,0 +1,801 @@ +--- +title: "UpdateVettedPackages" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2.admin

+ + +

UpdateVettedPackages

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.admin.PackageManagementService/UpdateVettedPackages + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.PackageManagementService/UpdateVettedPackages <<'EOF' +{ + "changes": [ + { + "vet": { + "packages": [ + { + "packageId": "string", + "packageName": "string", + "packageVersion": "string" + } + ], + "newValidFromInclusive": "string", + "newValidUntilExclusive": "string" + } + } + ], + "dryRun": true, + "synchronizerId": "string", + "expectedTopologySerial": { + "prior": 0 + }, + "updateVettedPackagesForceFlags": [ + "UPDATE_VETTED_PACKAGES_FORCE_FLAG_UNSPECIFIED" + ] +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "pastVettedPackages": { + "packages": [ + { + "packageId": "string", + "validFromInclusive": "string", + "validUntilExclusive": "string", + "packageName": "string", + "packageVersion": "string" + } + ], + "participantId": "string", + "synchronizerId": "string", + "topologySerial": 0 + }, + "newVettedPackages": { + "packages": [ + { + "packageId": "string", + "validFromInclusive": "string", + "validUntilExclusive": "string", + "packageName": "string", + "packageVersion": "string" + } + ], + "participantId": "string", + "synchronizerId": "string", + "topologySerial": 0 + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PackageManagementService
+
+ +
+
RPC
+
UpdateVettedPackages
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

UpdateVettedPackagesRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.UpdateVettedPackagesRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ changes + repeated VettedPackagesChange + +
+ +
Changes to apply to the current vetting state of the participant on the specified synchronizer. The changes are applied in order. Any package not changed will keep their previous vetting state.
+ +
+ +
+
+ dry_run + bool + +
+ +
If dry_run is true, then the changes are only prepared, but not applied. If a request would trigger an error when run (e.g. TOPOLOGY_DEPENDENCIES_NOT_VETTED), it will also trigger an error when dry_run. Use this flag to preview a change before applying it.
+ +
+ +
+
+ synchronizer_id + string + +
+ +
If set, the requested changes will take place on the specified synchronizer. If synchronizer_id is unset and the participant is only connected to a single synchronizer, that synchronizer will be used by default. If synchronizer_id is unset and the participant is connected to multiple synchronizers, the request will error out with PACKAGE_SERVICE_CANNOT_AUTODETECT_SYNCHRONIZER. Optional
+ +
+ +
+
+ expected_topology_serial + PriorTopologySerial + +
+ +
The serial of the last ``VettedPackages`` topology transaction of this participant and on this synchronizer. Execution of the request fails if this is not correct. Use this to guard against concurrent changes. If left unspecified, no validation is done against the last transaction's serial. Optional
+ +
+ +
+
+ update_vetted_packages_force_flags + repeated UpdateVettedPackagesForceFlag + +
+ +
Controls whether potentially unsafe vetting updates are allowed. Optional, defaults to FORCE_FLAG_UNSPECIFIED.
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

UpdateVettedPackagesResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.UpdateVettedPackagesResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ past_vetted_packages + VettedPackages + +
+ +
All vetted packages on this participant and synchronizer, before the specified changes. Empty if no vetting state existed beforehand.
+ +
+ +
+
+ new_vetted_packages + VettedPackages + +
+ +
All vetted packages on this participant and synchronizer, after the specified changes.
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ changes + repeated VettedPackagesChange + +
+ +
Changes to apply to the current vetting state of the participant on the specified synchronizer. The changes are applied in order. Any package not changed will keep their previous vetting state.
+ +
+ +
+
+ dry_run + bool + +
+ +
If dry_run is true, then the changes are only prepared, but not applied. If a request would trigger an error when run (e.g. TOPOLOGY_DEPENDENCIES_NOT_VETTED), it will also trigger an error when dry_run. Use this flag to preview a change before applying it.
+ +
+ +
+
+ synchronizer_id + string + +
+ +
If set, the requested changes will take place on the specified synchronizer. If synchronizer_id is unset and the participant is only connected to a single synchronizer, that synchronizer will be used by default. If synchronizer_id is unset and the participant is connected to multiple synchronizers, the request will error out with PACKAGE_SERVICE_CANNOT_AUTODETECT_SYNCHRONIZER. Optional
+ +
+ +
+
+ expected_topology_serial + PriorTopologySerial + +
+ +
The serial of the last ``VettedPackages`` topology transaction of this participant and on this synchronizer. Execution of the request fails if this is not correct. Use this to guard against concurrent changes. If left unspecified, no validation is done against the last transaction's serial. Optional
+ +
+ +
+
+ update_vetted_packages_force_flags + repeated UpdateVettedPackagesForceFlag + +
+ +
Controls whether potentially unsafe vetting updates are allowed. Optional, defaults to FORCE_FLAG_UNSPECIFIED.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ vet + Vet + +
+ +
Add packages to or update packages in the set of vetted packages.
+ +
+ +
+
+ unvet + Unvet + +
+ +
Remove packages from the set of vetted packages.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ packages + repeated VettedPackagesRef + +
+ +
Packages to be unvetted. If a reference in this list matches multiple packages, they are all unvetted.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ package_id + string + +
+ +
Package's package id must be the same as this field. Optional
+ +
+ +
+
+ package_name + string + +
+ +
Package's name must be the same as this field. Optional
+ +
+ +
+
+ package_version + string + +
+ +
Package's version must be the same as this field. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ packages + repeated VettedPackagesRef + +
+ +
Packages to be vetted. If a reference in this list matches more than one package, the change is considered ambiguous and the entire update request is rejected. In other words, every reference must match exactly one package.
+ +
+ +
+
+ new_valid_from_inclusive + Timestamp + +
+ +
The time from which these packages should be vetted, prior lower bounds are overwritten. Optional
+ +
+ +
+
+ new_valid_until_exclusive + Timestamp + +
+ +
The time until which these packages should be vetted, prior upper bounds are overwritten. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ prior + uint32 + +
+ +
Previous transaction's serial.
+ +
+ +
+
+ no_prior + Empty + +
+ +
No previous transaction exists.
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • UPDATE_VETTED_PACKAGES_FORCE_FLAG_UNSPECIFIED
    • + +
  • UPDATE_VETTED_PACKAGES_FORCE_FLAG_ALLOW_VET_INCOMPATIBLE_UPGRADES
    • + +
  • UPDATE_VETTED_PACKAGES_FORCE_FLAG_ALLOW_UNVETTED_DEPENDENCIES
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ past_vetted_packages + VettedPackages + +
+ +
All vetted packages on this participant and synchronizer, before the specified changes. Empty if no vetting state existed beforehand.
+ +
+ +
+
+ new_vetted_packages + VettedPackages + +
+ +
All vetted packages on this participant and synchronizer, after the specified changes.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ packages + repeated VettedPackage + +
+ +
Sorted by package_name and package_version where known, and package_id as a last resort.
+ +
+ +
+
+ participant_id + string + +
+ +
Participant on which these packages are vetted. Always present.
+ +
+ +
+
+ synchronizer_id + string + +
+ +
Synchronizer on which these packages are vetted. Always present.
+ +
+ +
+
+ topology_serial + uint32 + +
+ +
Serial of last ``VettedPackages`` topology transaction of this participant and on this synchronizer. Always present.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ package_id + string + +
+ +
Package ID of this package. Always present.
+ +
+ +
+
+ valid_from_inclusive + Timestamp + +
+ +
The time from which this package is vetted. Empty if vetting time has no lower bound.
+ +
+ +
+
+ valid_until_exclusive + Timestamp + +
+ +
The time until which this package is vetted. Empty if vetting time has no upper bound.
+ +
+ +
+
+ package_name + string + +
+ +
Name of this package. Only available if the package has been uploaded to the current participant. If unavailable, is empty string.
+ +
+ +
+
+ package_version + string + +
+ +
Version of this package. Only available if the package has been uploaded to the current participant. If unavailable, is empty string.
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/uploaddarfile.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/uploaddarfile.mdx new file mode 100644 index 0000000..5c33e1a --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/uploaddarfile.mdx @@ -0,0 +1,368 @@ +--- +title: "UploadDarFile" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2.admin

+ + +

UploadDarFile

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.admin.PackageManagementService/UploadDarFile + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.PackageManagementService/UploadDarFile <<'EOF' +{ + "darFile": "BASE64_ENCODED_BYTES", + "submissionId": "string", + "vettingChange": "VETTING_CHANGE_UNSPECIFIED", + "synchronizerId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PackageManagementService
+
+ +
+
RPC
+
UploadDarFile
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

UploadDarFileRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.UploadDarFileRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ dar_file + bytes + +
+ +
Contains a Daml archive DAR file, which in turn is a jar like zipped container for ``daml_lf`` archives. See further details in ``daml_lf.proto``. Required
+ +
+ +
+
+ submission_id + string + +
+ +
Unique submission identifier. Optional, defaults to a random identifier.
+ +
+ +
+
+ vetting_change + VettingChange + +
+ +
How to vet packages in the DAR being uploaded
+ +
+ +
+
+ synchronizer_id + string + +
+ +
Only used if VettingChange is set to VETTING_CHANGE_VET_ALL_PACKAGES, in order to specify which synchronizer to vet on. If synchronizer_id is set, the synchronizer with this ID will be used. If synchronizer_id is unset and the participant is only connected to a single synchronizer, that synchronizer will be used by default. If synchronizer_id is unset and the participant is connected to multiple synchronizers, the request will error out with PACKAGE_SERVICE_CANNOT_AUTODETECT_SYNCHRONIZER. Optional
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

UploadDarFileResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.UploadDarFileResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ dar_file + bytes + +
+ +
Contains a Daml archive DAR file, which in turn is a jar like zipped container for ``daml_lf`` archives. See further details in ``daml_lf.proto``. Required
+ +
+ +
+
+ submission_id + string + +
+ +
Unique submission identifier. Optional, defaults to a random identifier.
+ +
+ +
+
+ vetting_change + VettingChange + +
+ +
How to vet packages in the DAR being uploaded
+ +
+ +
+
+ synchronizer_id + string + +
+ +
Only used if VettingChange is set to VETTING_CHANGE_VET_ALL_PACKAGES, in order to specify which synchronizer to vet on. If synchronizer_id is set, the synchronizer with this ID will be used. If synchronizer_id is unset and the participant is only connected to a single synchronizer, that synchronizer will be used by default. If synchronizer_id is unset and the participant is connected to multiple synchronizers, the request will error out with PACKAGE_SERVICE_CANNOT_AUTODETECT_SYNCHRONIZER. Optional
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • VETTING_CHANGE_UNSPECIFIED
    • + +
  • VETTING_CHANGE_VET_ALL_PACKAGES
    • + +
  • VETTING_CHANGE_DONT_VET_ANY_PACKAGES
    • + +
+ + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/validatedarfile.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/validatedarfile.mdx new file mode 100644 index 0000000..4f421d4 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/validatedarfile.mdx @@ -0,0 +1,326 @@ +--- +title: "ValidateDarFile" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2.admin

+ + +

ValidateDarFile

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.admin.PackageManagementService/ValidateDarFile + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.PackageManagementService/ValidateDarFile <<'EOF' +{ + "darFile": "BASE64_ENCODED_BYTES", + "submissionId": "string", + "synchronizerId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PackageManagementService
+
+ +
+
RPC
+
ValidateDarFile
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ValidateDarFileRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.ValidateDarFileRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ dar_file + bytes + +
+ +
Contains a Daml archive DAR file, which in turn is a jar like zipped container for ``daml_lf`` archives. See further details in ``daml_lf.proto``. Required
+ +
+ +
+
+ submission_id + string + +
+ +
Unique submission identifier. Optional, defaults to a random identifier.
+ +
+ +
+
+ synchronizer_id + string + +
+ +
If synchronizer_id is set, the synchronizer with this ID will be used. If synchronizer_id is unset and the participant is only connected to a single synchronizer, that synchronizer will be used by default. If synchronizer_id is unset and the participant is connected to multiple synchronizers, the request will error out with PACKAGE_SERVICE_CANNOT_AUTODETECT_SYNCHRONIZER. Optional
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ValidateDarFileResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.ValidateDarFileResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ dar_file + bytes + +
+ +
Contains a Daml archive DAR file, which in turn is a jar like zipped container for ``daml_lf`` archives. See further details in ``daml_lf.proto``. Required
+ +
+ +
+
+ submission_id + string + +
+ +
Unique submission identifier. Optional, defaults to a random identifier.
+ +
+ +
+
+ synchronizer_id + string + +
+ +
If synchronizer_id is set, the synchronizer with this ID will be used. If synchronizer_id is unset and the participant is only connected to a single synchronizer, that synchronizer will be used by default. If synchronizer_id is unset and the participant is connected to multiple synchronizers, the request will error out with PACKAGE_SERVICE_CANNOT_AUTODETECT_SYNCHRONIZER. Optional
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/participantpruningservice/prune.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/participantpruningservice/prune.mdx new file mode 100644 index 0000000..fb1c7cc --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/participantpruningservice/prune.mdx @@ -0,0 +1,326 @@ +--- +title: "Prune" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2.admin

+ + +

Prune

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.admin.ParticipantPruningService/Prune + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.ParticipantPruningService/Prune <<'EOF' +{ + "pruneUpTo": "0", + "submissionId": "string", + "pruneAllDivulgedContracts": true +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
ParticipantPruningService
+
+ +
+
RPC
+
Prune
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

PruneRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.PruneRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ prune_up_to + int64 + +
+ +
Inclusive valid absolute offset (positive integer) up to which the ledger is to be pruned. By default the following data is pruned: 1. All normal and divulged contracts that have been archived before `prune_up_to`. 2. All transaction events and completions before `prune_up_to` 3. All immediately divulged contracts created before `prune_up_to` independent of whether they were archived before `prune_up_to`.
+ +
+ +
+
+ submission_id + string + +
+ +
Unique submission identifier. Optional, defaults to a random identifier, used for logging.
+ +
+ +
+
+ prune_all_divulged_contracts + bool + +
+ +
Deprecated flag used to prune all immediately and retroactively divulged contracts. It is a no-op since the divulged contracts are pruned along with the deactivated contracts.
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

PruneResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.PruneResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ prune_up_to + int64 + +
+ +
Inclusive valid absolute offset (positive integer) up to which the ledger is to be pruned. By default the following data is pruned: 1. All normal and divulged contracts that have been archived before `prune_up_to`. 2. All transaction events and completions before `prune_up_to` 3. All immediately divulged contracts created before `prune_up_to` independent of whether they were archived before `prune_up_to`.
+ +
+ +
+
+ submission_id + string + +
+ +
Unique submission identifier. Optional, defaults to a random identifier, used for logging.
+ +
+ +
+
+ prune_all_divulged_contracts + bool + +
+ +
Deprecated flag used to prune all immediately and retroactively divulged contracts. It is a no-op since the divulged contracts are pruned along with the deactivated contracts.
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/allocateexternalparty.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/allocateexternalparty.mdx new file mode 100644 index 0000000..e3eb312 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/allocateexternalparty.mdx @@ -0,0 +1,528 @@ +--- +title: "AllocateExternalParty" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2.admin

+ + +

AllocateExternalParty

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.admin.PartyManagementService/AllocateExternalParty + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.PartyManagementService/AllocateExternalParty <<'EOF' +{ + "synchronizer": "string", + "onboardingTransactions": [ + { + "transaction": "BASE64_ENCODED_BYTES", + "signatures": [ + { + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signedBy": "string", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" + } + ] + } + ], + "multiHashSignatures": [ + { + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signedBy": "string", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" + } + ], + "identityProviderId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "partyId": "string" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PartyManagementService
+
+ +
+
RPC
+
AllocateExternalParty
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

AllocateExternalPartyRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.AllocateExternalPartyRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ synchronizer + string + +
+ +
TODO(#27670) support synchronizer aliases Synchronizer ID on which to onboard the party Required
+ +
+ +
+
+ onboarding_transactions + repeated SignedTransaction + +
+ +
TopologyTransactions to onboard the external party Can contain: - A namespace for the party. This can be either a single NamespaceDelegation, or DecentralizedNamespaceDefinition along with its authorized namespace owners in the form of NamespaceDelegations. May be provided, if so it must be fully authorized by the signatures in this request combined with the existing topology state. - A PartyToKeyMapping to register the party's signing keys. May be provided, if so it must be fully authorized by the signatures in this request combined with the existing topology state. - A PartyToParticipant to register the hosting relationship of the party. Must be provided. Required
+ +
+ +
+
+ multi_hash_signatures + repeated Signature + +
+ +
Optional signatures of the combined hash of all onboarding_transactions This may be used instead of providing signatures on each individual transaction
+ +
+ +
+
+ identity_provider_id + string + +
+ +
The id of the ``Identity Provider`` If not set, assume the party is managed by the default identity provider. Optional
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

AllocateExternalPartyResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.AllocateExternalPartyResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ party_id + string + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ synchronizer + string + +
+ +
TODO(#27670) support synchronizer aliases Synchronizer ID on which to onboard the party Required
+ +
+ +
+
+ onboarding_transactions + repeated SignedTransaction + +
+ +
TopologyTransactions to onboard the external party Can contain: - A namespace for the party. This can be either a single NamespaceDelegation, or DecentralizedNamespaceDefinition along with its authorized namespace owners in the form of NamespaceDelegations. May be provided, if so it must be fully authorized by the signatures in this request combined with the existing topology state. - A PartyToKeyMapping to register the party's signing keys. May be provided, if so it must be fully authorized by the signatures in this request combined with the existing topology state. - A PartyToParticipant to register the hosting relationship of the party. Must be provided. Required
+ +
+ +
+
+ multi_hash_signatures + repeated Signature + +
+ +
Optional signatures of the combined hash of all onboarding_transactions This may be used instead of providing signatures on each individual transaction
+ +
+ +
+
+ identity_provider_id + string + +
+ +
The id of the ``Identity Provider`` If not set, assume the party is managed by the default identity provider. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ transaction + bytes + +
+ +
The serialized TopologyTransaction
+ +
+ +
+
+ signatures + repeated Signature + +
+ +
Additional signatures for this transaction specifically Use for transactions that require additional signatures beyond the namespace key signatures e.g: PartyToKeyMapping must be signed by all registered keys
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ format + SignatureFormat + +
+ +
+ +
+
+ signature + bytes + +
+ +
+ +
+
+ signed_by + string + +
+ +
The fingerprint/id of the keypair used to create this signature and needed to verify.
+ +
+ +
+
+ signing_algorithm_spec + SigningAlgorithmSpec + +
+ +
The signing algorithm specification used to produce this signature
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • SIGNATURE_FORMAT_UNSPECIFIED
    • + +
  • SIGNATURE_FORMAT_RAW
    • + +
  • SIGNATURE_FORMAT_DER
    • + +
  • SIGNATURE_FORMAT_CONCAT
    • + +
  • SIGNATURE_FORMAT_SYMBOLIC
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_ALGORITHM_SPEC_UNSPECIFIED
    • + +
  • SIGNING_ALGORITHM_SPEC_ED25519
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_256
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_384
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ party_id + string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/allocateparty.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/allocateparty.mdx new file mode 100644 index 0000000..c688208 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/allocateparty.mdx @@ -0,0 +1,511 @@ +--- +title: "AllocateParty" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2.admin

+ + +

AllocateParty

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.admin.PartyManagementService/AllocateParty + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.PartyManagementService/AllocateParty <<'EOF' +{ + "partyIdHint": "string", + "localMetadata": { + "resourceVersion": "string", + "annotations": [ + { + "key": "string" + } + ] + }, + "identityProviderId": "string", + "synchronizerId": "string", + "userId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "partyDetails": { + "party": "string", + "isLocal": true, + "localMetadata": { + "resourceVersion": "string", + "annotations": [ + { + "key": "string" + } + ] + }, + "identityProviderId": "string" + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PartyManagementService
+
+ +
+
RPC
+
AllocateParty
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

AllocatePartyRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.AllocatePartyRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ party_id_hint + string + +
+ +
A hint to the participant which party ID to allocate. It can be ignored. Must be a valid PartyIdString (as described in ``value.proto``). Optional
+ +
+ +
+
+ local_metadata + ObjectMeta + +
+ +
Participant-local metadata to be stored in the ``PartyDetails`` of this newly allocated party. Optional
+ +
+ +
+
+ identity_provider_id + string + +
+ +
The id of the ``Identity Provider`` Optional, if not set, assume the party is managed by the default identity provider or party is not hosted by the participant.
+ +
+ +
+
+ synchronizer_id + string + +
+ +
The synchronizer, on which the party should be allocated. For backwards compatibility, this field may be omitted, if the participant is connected to only one synchronizer. Otherwise a synchronizer must be specified. Optional
+ +
+ +
+
+ user_id + string + +
+ +
The user who will get the act_as rights to the newly allocated party. If set to an empty string (the default), no user will get rights to the party. Optional
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

AllocatePartyResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.AllocatePartyResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ party_details + PartyDetails + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ party_id_hint + string + +
+ +
A hint to the participant which party ID to allocate. It can be ignored. Must be a valid PartyIdString (as described in ``value.proto``). Optional
+ +
+ +
+
+ local_metadata + ObjectMeta + +
+ +
Participant-local metadata to be stored in the ``PartyDetails`` of this newly allocated party. Optional
+ +
+ +
+
+ identity_provider_id + string + +
+ +
The id of the ``Identity Provider`` Optional, if not set, assume the party is managed by the default identity provider or party is not hosted by the participant.
+ +
+ +
+
+ synchronizer_id + string + +
+ +
The synchronizer, on which the party should be allocated. For backwards compatibility, this field may be omitted, if the participant is connected to only one synchronizer. Otherwise a synchronizer must be specified. Optional
+ +
+ +
+
+ user_id + string + +
+ +
The user who will get the act_as rights to the newly allocated party. If set to an empty string (the default), no user will get rights to the party. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ resource_version + string + +
+ +
An opaque, non-empty value, populated by a participant server which represents the internal version of the resource this ``ObjectMeta`` message is attached to. The participant server will change it to a unique value each time the corresponding resource is updated. You must not rely on the format of resource version. The participant server might change it without notice. You can obtain the newest resource version value by issuing a read request. You may use it for concurrent change detection by passing it back unmodified in an update request. The participant server will then compare the passed value with the value maintained by the system to determine if any other updates took place since you had read the resource version. Upon a successful update you are guaranteed that no other update took place during your read-modify-write sequence. However, if another update took place during your read-modify-write sequence then your update will fail with an appropriate error. Concurrent change control is optional. It will be applied only if you include a resource version in an update request. When creating a new instance of a resource you must leave the resource version empty. Its value will be populated by the participant server upon successful resource creation. Optional
+ +
+ +
+
+ annotations + repeated map + +
+ +
A set of modifiable key-value pairs that can be used to represent arbitrary, client-specific metadata. Constraints: 1. The total size over all keys and values cannot exceed 256kb in UTF-8 encoding. 2. Keys are composed of an optional prefix segment and a required name segment such that: - key prefix, when present, must be a valid DNS subdomain with at most 253 characters, followed by a '/' (forward slash) character, - name segment must have at most 63 characters that are either alphanumeric ([a-z0-9A-Z]), or a '.' (dot), '-' (dash) or '_' (underscore); and it must start and end with an alphanumeric character. 3. Values can be any non-empty strings. Keys with empty prefix are reserved for end-users. Properties set by external tools or internally by the participant server must use non-empty key prefixes. Duplicate keys are disallowed by the semantics of the protobuf3 maps. See: https://developers.google.com/protocol-buffers/docs/proto3#maps Annotations may be a part of a modifiable resource. Use the resource's update RPC to update its annotations. In order to add a new annotation or update an existing one using an update RPC, provide the desired annotation in the update request. 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. Optional Modifiable
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ party_details + PartyDetails + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ party + string + +
+ +
The stable unique identifier of a Daml party. Must be a valid PartyIdString (as described in ``value.proto``). Required
+ +
+ +
+
+ is_local + bool + +
+ +
true if party is hosted by the participant and the party shares the same identity provider as the user issuing the request. Optional
+ +
+ +
+
+ local_metadata + ObjectMeta + +
+ +
Participant-local metadata of this party. Optional, Modifiable
+ +
+ +
+
+ identity_provider_id + string + +
+ +
The id of the ``Identity Provider`` Optional, if not set, there could be 3 options: 1. the party is managed by the default identity provider. 2. party is not hosted by the participant. 3. party is hosted by the participant, but is outside of the user's identity provider.
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/generateexternalpartytopology.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/generateexternalpartytopology.mdx new file mode 100644 index 0000000..63f65d4 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/generateexternalpartytopology.mdx @@ -0,0 +1,619 @@ +--- +title: "GenerateExternalPartyTopology" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2.admin

+ + +

GenerateExternalPartyTopology

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.admin.PartyManagementService/GenerateExternalPartyTopology + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.PartyManagementService/GenerateExternalPartyTopology <<'EOF' +{ + "synchronizer": "string", + "partyHint": "string", + "publicKey": { + "format": "CRYPTO_KEY_FORMAT_UNSPECIFIED", + "keyData": "BASE64_ENCODED_BYTES", + "keySpec": "SIGNING_KEY_SPEC_UNSPECIFIED" + }, + "localParticipantObservationOnly": true, + "otherConfirmingParticipantUids": [ + "string" + ], + "confirmationThreshold": 0, + "observingParticipantUids": [ + "string" + ] +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "partyId": "string", + "publicKeyFingerprint": "string", + "topologyTransactions": [ + "BASE64_ENCODED_BYTES" + ], + "multiHash": "BASE64_ENCODED_BYTES" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PartyManagementService
+
+ +
+
RPC
+
GenerateExternalPartyTopology
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GenerateExternalPartyTopologyRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.GenerateExternalPartyTopologyRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ synchronizer + string + +
+ +
TODO(#27670) support synchronizer aliases Required: synchronizer-id for which we are building this request.
+ +
+ +
+
+ party_hint + string + +
+ +
Required: the actual party id will be constructed from this hint and a fingerprint of the public key
+ +
+ +
+
+ public_key + SigningPublicKey + +
+ +
Required: public key
+ +
+ +
+
+ local_participant_observation_only + bool + +
+ +
Optional: if true, then the local participant will only be observing, not confirming. Default false.
+ +
+ +
+
+ other_confirming_participant_uids + repeated string + +
+ +
Optional: other participant ids which should be confirming for this party
+ +
+ +
+
+ confirmation_threshold + uint32 + +
+ +
Optional: Confirmation threshold >= 1 for the party. Defaults to all available confirmers (or if set to 0).
+ +
+ +
+
+ observing_participant_uids + repeated string + +
+ +
Optional: other observing participant ids for this party
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

GenerateExternalPartyTopologyResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.GenerateExternalPartyTopologyResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ party_id + string + +
+ +
the generated party id
+ +
+ +
+
+ public_key_fingerprint + string + +
+ +
the fingerprint of the supplied public key
+ +
+ +
+
+ topology_transactions + repeated bytes + +
+ +
The serialized topology transactions which need to be signed and submitted as part of the allocate party process Note that the serialization includes the versioning information. Therefore, the transaction here is serialized as an `UntypedVersionedMessage` which in turn contains the serialized `TopologyTransaction` in the version supported by the synchronizer.
+ +
+ +
+
+ multi_hash + bytes + +
+ +
the multi-hash which may be signed instead of each individual transaction
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ synchronizer + string + +
+ +
TODO(#27670) support synchronizer aliases Required: synchronizer-id for which we are building this request.
+ +
+ +
+
+ party_hint + string + +
+ +
Required: the actual party id will be constructed from this hint and a fingerprint of the public key
+ +
+ +
+
+ public_key + SigningPublicKey + +
+ +
Required: public key
+ +
+ +
+
+ local_participant_observation_only + bool + +
+ +
Optional: if true, then the local participant will only be observing, not confirming. Default false.
+ +
+ +
+
+ other_confirming_participant_uids + repeated string + +
+ +
Optional: other participant ids which should be confirming for this party
+ +
+ +
+
+ confirmation_threshold + uint32 + +
+ +
Optional: Confirmation threshold >= 1 for the party. Defaults to all available confirmers (or if set to 0).
+ +
+ +
+
+ observing_participant_uids + repeated string + +
+ +
Optional: other observing participant ids for this party
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ format + CryptoKeyFormat + +
+ +
The serialization format of the public key
+ +
+ +
+
+ key_data + bytes + +
+ +
Serialized public key in the format specified above
+ +
+ +
+
+ key_spec + SigningKeySpec + +
+ +
The key specification
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • CRYPTO_KEY_FORMAT_UNSPECIFIED
    • + +
  • CRYPTO_KEY_FORMAT_DER
    • + +
  • CRYPTO_KEY_FORMAT_RAW
    • + +
  • CRYPTO_KEY_FORMAT_DER_X509_SUBJECT_PUBLIC_KEY_INFO
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_SPEC_UNSPECIFIED
    • + +
  • SIGNING_KEY_SPEC_EC_CURVE25519
    • + +
  • SIGNING_KEY_SPEC_EC_P256
    • + +
  • SIGNING_KEY_SPEC_EC_P384
    • + +
  • SIGNING_KEY_SPEC_EC_SECP256K1
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ party_id + string + +
+ +
the generated party id
+ +
+ +
+
+ public_key_fingerprint + string + +
+ +
the fingerprint of the supplied public key
+ +
+ +
+
+ topology_transactions + repeated bytes + +
+ +
The serialized topology transactions which need to be signed and submitted as part of the allocate party process Note that the serialization includes the versioning information. Therefore, the transaction here is serialized as an `UntypedVersionedMessage` which in turn contains the serialized `TopologyTransaction` in the version supported by the synchronizer.
+ +
+ +
+
+ multi_hash + bytes + +
+ +
the multi-hash which may be signed instead of each individual transaction
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/getparticipantid.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/getparticipantid.mdx new file mode 100644 index 0000000..5cf16b8 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/getparticipantid.mdx @@ -0,0 +1,280 @@ +--- +title: "GetParticipantId" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2.admin

+ + +

GetParticipantId

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.admin.PartyManagementService/GetParticipantId + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.PartyManagementService/GetParticipantId <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "participantId": "string" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PartyManagementService
+
+ +
+
RPC
+
GetParticipantId
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetParticipantIdRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.GetParticipantIdRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

GetParticipantIdResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.GetParticipantIdResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ participant_id + string + +
+ +
Identifier of the participant, which SHOULD be globally unique. Must be a valid LedgerString (as describe in ``value.proto``).
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ participant_id + string + +
+ +
Identifier of the participant, which SHOULD be globally unique. Must be a valid LedgerString (as describe in ``value.proto``).
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/getparties.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/getparties.mdx new file mode 100644 index 0000000..c4405e4 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/getparties.mdx @@ -0,0 +1,443 @@ +--- +title: "GetParties" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2.admin

+ + +

GetParties

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.admin.PartyManagementService/GetParties + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.PartyManagementService/GetParties <<'EOF' +{ + "parties": [ + "string" + ], + "identityProviderId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "partyDetails": [ + { + "party": "string", + "isLocal": true, + "localMetadata": { + "resourceVersion": "string", + "annotations": [ + { + "key": "string" + } + ] + }, + "identityProviderId": "string" + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PartyManagementService
+
+ +
+
RPC
+
GetParties
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetPartiesRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.GetPartiesRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ parties + repeated string + +
+ +
The stable, unique identifier of the Daml parties. Must be valid PartyIdStrings (as described in ``value.proto``). Required
+ +
+ +
+
+ identity_provider_id + string + +
+ +
The id of the ``Identity Provider`` whose parties should be retrieved. Optional, if not set, assume the party is managed by the default identity provider or party is not hosted by the participant.
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

GetPartiesResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.GetPartiesResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ party_details + repeated PartyDetails + +
+ +
The details of the requested Daml parties by the participant, if known. The party details may not be in the same order as requested. Required
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ parties + repeated string + +
+ +
The stable, unique identifier of the Daml parties. Must be valid PartyIdStrings (as described in ``value.proto``). Required
+ +
+ +
+
+ identity_provider_id + string + +
+ +
The id of the ``Identity Provider`` whose parties should be retrieved. Optional, if not set, assume the party is managed by the default identity provider or party is not hosted by the participant.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ party_details + repeated PartyDetails + +
+ +
The details of the requested Daml parties by the participant, if known. The party details may not be in the same order as requested. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ party + string + +
+ +
The stable unique identifier of a Daml party. Must be a valid PartyIdString (as described in ``value.proto``). Required
+ +
+ +
+
+ is_local + bool + +
+ +
true if party is hosted by the participant and the party shares the same identity provider as the user issuing the request. Optional
+ +
+ +
+
+ local_metadata + ObjectMeta + +
+ +
Participant-local metadata of this party. Optional, Modifiable
+ +
+ +
+
+ identity_provider_id + string + +
+ +
The id of the ``Identity Provider`` Optional, if not set, there could be 3 options: 1. the party is managed by the default identity provider. 2. party is not hosted by the participant. 3. party is hosted by the participant, but is outside of the user's identity provider.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ resource_version + string + +
+ +
An opaque, non-empty value, populated by a participant server which represents the internal version of the resource this ``ObjectMeta`` message is attached to. The participant server will change it to a unique value each time the corresponding resource is updated. You must not rely on the format of resource version. The participant server might change it without notice. You can obtain the newest resource version value by issuing a read request. You may use it for concurrent change detection by passing it back unmodified in an update request. The participant server will then compare the passed value with the value maintained by the system to determine if any other updates took place since you had read the resource version. Upon a successful update you are guaranteed that no other update took place during your read-modify-write sequence. However, if another update took place during your read-modify-write sequence then your update will fail with an appropriate error. Concurrent change control is optional. It will be applied only if you include a resource version in an update request. When creating a new instance of a resource you must leave the resource version empty. Its value will be populated by the participant server upon successful resource creation. Optional
+ +
+ +
+
+ annotations + repeated map + +
+ +
A set of modifiable key-value pairs that can be used to represent arbitrary, client-specific metadata. Constraints: 1. The total size over all keys and values cannot exceed 256kb in UTF-8 encoding. 2. Keys are composed of an optional prefix segment and a required name segment such that: - key prefix, when present, must be a valid DNS subdomain with at most 253 characters, followed by a '/' (forward slash) character, - name segment must have at most 63 characters that are either alphanumeric ([a-z0-9A-Z]), or a '.' (dot), '-' (dash) or '_' (underscore); and it must start and end with an alphanumeric character. 3. Values can be any non-empty strings. Keys with empty prefix are reserved for end-users. Properties set by external tools or internally by the participant server must use non-empty key prefixes. Duplicate keys are disallowed by the semantics of the protobuf3 maps. See: https://developers.google.com/protocol-buffers/docs/proto3#maps Annotations may be a part of a modifiable resource. Use the resource's update RPC to update its annotations. In order to add a new annotation or update an existing one using an update RPC, provide the desired annotation in the update request. 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. Optional Modifiable
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/listknownparties.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/listknownparties.mdx new file mode 100644 index 0000000..b9b4594 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/listknownparties.mdx @@ -0,0 +1,510 @@ +--- +title: "ListKnownParties" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2.admin

+ + +

ListKnownParties

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.admin.PartyManagementService/ListKnownParties + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.PartyManagementService/ListKnownParties <<'EOF' +{ + "pageToken": "string", + "pageSize": 0, + "identityProviderId": "string", + "filterParty": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "partyDetails": [ + { + "party": "string", + "isLocal": true, + "localMetadata": { + "resourceVersion": "string", + "annotations": [ + { + "key": "string" + } + ] + }, + "identityProviderId": "string" + } + ], + "nextPageToken": "string" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PartyManagementService
+
+ +
+
RPC
+
ListKnownParties
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ListKnownPartiesRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.ListKnownPartiesRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ page_token + string + +
+ +
Pagination token to determine the specific page to fetch. Using the token guarantees that parties on a subsequent page are all lexically greater than the last party on a previous page. Server does not store intermediate results between calls chained by a series of page tokens. As a consequence, if new parties are being added and a page is requested twice using the same token, more parties can be returned on the second call. Leave empty to fetch the first page. Optional
+ +
+ +
+
+ page_size + int32 + +
+ +
Maximum number of results to be returned by the server. The server will return no more than that many results, but it might return fewer. If the page_size is 0, the server will decide the number of results to be returned. If the page_size exceeds the maximum supported by the server, an error will be returned. To obtain the server's maximum consult the PartyManagementFeature descriptor available in the VersionService. Optional
+ +
+ +
+
+ identity_provider_id + string + +
+ +
The id of the ``Identity Provider`` whose parties should be retrieved. Optional, if not set, assume the party is managed by the default identity provider or party is not hosted by the participant.
+ +
+ +
+
+ filter_party + string + +
+ +
An optional filter for the party name, searching for all party names known to this node starting with the given prefix. This can either be just a string or extend up to the full identifier. Optional
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ListKnownPartiesResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.ListKnownPartiesResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ party_details + repeated PartyDetails + +
+ +
The details of all Daml parties known by the participant. Required
+ +
+ +
+
+ next_page_token + string + +
+ +
Pagination token to retrieve the next page. Empty, if there are no further results.
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ page_token + string + +
+ +
Pagination token to determine the specific page to fetch. Using the token guarantees that parties on a subsequent page are all lexically greater than the last party on a previous page. Server does not store intermediate results between calls chained by a series of page tokens. As a consequence, if new parties are being added and a page is requested twice using the same token, more parties can be returned on the second call. Leave empty to fetch the first page. Optional
+ +
+ +
+
+ page_size + int32 + +
+ +
Maximum number of results to be returned by the server. The server will return no more than that many results, but it might return fewer. If the page_size is 0, the server will decide the number of results to be returned. If the page_size exceeds the maximum supported by the server, an error will be returned. To obtain the server's maximum consult the PartyManagementFeature descriptor available in the VersionService. Optional
+ +
+ +
+
+ identity_provider_id + string + +
+ +
The id of the ``Identity Provider`` whose parties should be retrieved. Optional, if not set, assume the party is managed by the default identity provider or party is not hosted by the participant.
+ +
+ +
+
+ filter_party + string + +
+ +
An optional filter for the party name, searching for all party names known to this node starting with the given prefix. This can either be just a string or extend up to the full identifier. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ party_details + repeated PartyDetails + +
+ +
The details of all Daml parties known by the participant. Required
+ +
+ +
+
+ next_page_token + string + +
+ +
Pagination token to retrieve the next page. Empty, if there are no further results.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ party + string + +
+ +
The stable unique identifier of a Daml party. Must be a valid PartyIdString (as described in ``value.proto``). Required
+ +
+ +
+
+ is_local + bool + +
+ +
true if party is hosted by the participant and the party shares the same identity provider as the user issuing the request. Optional
+ +
+ +
+
+ local_metadata + ObjectMeta + +
+ +
Participant-local metadata of this party. Optional, Modifiable
+ +
+ +
+
+ identity_provider_id + string + +
+ +
The id of the ``Identity Provider`` Optional, if not set, there could be 3 options: 1. the party is managed by the default identity provider. 2. party is not hosted by the participant. 3. party is hosted by the participant, but is outside of the user's identity provider.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ resource_version + string + +
+ +
An opaque, non-empty value, populated by a participant server which represents the internal version of the resource this ``ObjectMeta`` message is attached to. The participant server will change it to a unique value each time the corresponding resource is updated. You must not rely on the format of resource version. The participant server might change it without notice. You can obtain the newest resource version value by issuing a read request. You may use it for concurrent change detection by passing it back unmodified in an update request. The participant server will then compare the passed value with the value maintained by the system to determine if any other updates took place since you had read the resource version. Upon a successful update you are guaranteed that no other update took place during your read-modify-write sequence. However, if another update took place during your read-modify-write sequence then your update will fail with an appropriate error. Concurrent change control is optional. It will be applied only if you include a resource version in an update request. When creating a new instance of a resource you must leave the resource version empty. Its value will be populated by the participant server upon successful resource creation. Optional
+ +
+ +
+
+ annotations + repeated map + +
+ +
A set of modifiable key-value pairs that can be used to represent arbitrary, client-specific metadata. Constraints: 1. The total size over all keys and values cannot exceed 256kb in UTF-8 encoding. 2. Keys are composed of an optional prefix segment and a required name segment such that: - key prefix, when present, must be a valid DNS subdomain with at most 253 characters, followed by a '/' (forward slash) character, - name segment must have at most 63 characters that are either alphanumeric ([a-z0-9A-Z]), or a '.' (dot), '-' (dash) or '_' (underscore); and it must start and end with an alphanumeric character. 3. Values can be any non-empty strings. Keys with empty prefix are reserved for end-users. Properties set by external tools or internally by the participant server must use non-empty key prefixes. Duplicate keys are disallowed by the semantics of the protobuf3 maps. See: https://developers.google.com/protocol-buffers/docs/proto3#maps Annotations may be a part of a modifiable resource. Use the resource's update RPC to update its annotations. In order to add a new annotation or update an existing one using an update RPC, provide the desired annotation in the update request. 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. Optional Modifiable
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/updatepartydetails.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/updatepartydetails.mdx new file mode 100644 index 0000000..92f00dd --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/updatepartydetails.mdx @@ -0,0 +1,451 @@ +--- +title: "UpdatePartyDetails" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2.admin

+ + +

UpdatePartyDetails

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.admin.PartyManagementService/UpdatePartyDetails + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.PartyManagementService/UpdatePartyDetails <<'EOF' +{ + "partyDetails": { + "party": "string", + "isLocal": true, + "localMetadata": { + "resourceVersion": "string", + "annotations": [ + { + "key": "string" + } + ] + }, + "identityProviderId": "string" + }, + "updateMask": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "partyDetails": { + "party": "string", + "isLocal": true, + "localMetadata": { + "resourceVersion": "string", + "annotations": [ + { + "key": "string" + } + ] + }, + "identityProviderId": "string" + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PartyManagementService
+
+ +
+
RPC
+
UpdatePartyDetails
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

UpdatePartyDetailsRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.UpdatePartyDetailsRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ party_details + PartyDetails + +
+ +
Party to be updated Required, Modifiable
+ +
+ +
+
+ update_mask + FieldMask + +
+ +
An update mask specifies how and which properties of the ``PartyDetails`` message are to be updated. An update mask consists of a set of update paths. A valid update path points to a field or a subfield relative to the ``PartyDetails`` message. A valid update mask must: 1. contain at least one update path, 2. contain only valid update paths. Fields that can be updated are marked as ``Modifiable``. An update path can also point to non-``Modifiable`` fields such as 'party' and 'local_metadata.resource_version' because they are used: 1. to identify the party details resource subject to the update, 2. for concurrent change control. An update path can also point to non-``Modifiable`` fields such as 'is_local' as long as the values provided in the update request match the server values. Examples of update paths: 'local_metadata.annotations', 'local_metadata'. For additional information see the documentation for standard protobuf3's ``google.protobuf.FieldMask``. For similar Ledger API see ``com.daml.ledger.api.v2.admin.UpdateUserRequest``. Required
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

UpdatePartyDetailsResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.UpdatePartyDetailsResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ party_details + PartyDetails + +
+ +
Updated party details
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ party_details + PartyDetails + +
+ +
Party to be updated Required, Modifiable
+ +
+ +
+
+ update_mask + FieldMask + +
+ +
An update mask specifies how and which properties of the ``PartyDetails`` message are to be updated. An update mask consists of a set of update paths. A valid update path points to a field or a subfield relative to the ``PartyDetails`` message. A valid update mask must: 1. contain at least one update path, 2. contain only valid update paths. Fields that can be updated are marked as ``Modifiable``. An update path can also point to non-``Modifiable`` fields such as 'party' and 'local_metadata.resource_version' because they are used: 1. to identify the party details resource subject to the update, 2. for concurrent change control. An update path can also point to non-``Modifiable`` fields such as 'is_local' as long as the values provided in the update request match the server values. Examples of update paths: 'local_metadata.annotations', 'local_metadata'. For additional information see the documentation for standard protobuf3's ``google.protobuf.FieldMask``. For similar Ledger API see ``com.daml.ledger.api.v2.admin.UpdateUserRequest``. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ party + string + +
+ +
The stable unique identifier of a Daml party. Must be a valid PartyIdString (as described in ``value.proto``). Required
+ +
+ +
+
+ is_local + bool + +
+ +
true if party is hosted by the participant and the party shares the same identity provider as the user issuing the request. Optional
+ +
+ +
+
+ local_metadata + ObjectMeta + +
+ +
Participant-local metadata of this party. Optional, Modifiable
+ +
+ +
+
+ identity_provider_id + string + +
+ +
The id of the ``Identity Provider`` Optional, if not set, there could be 3 options: 1. the party is managed by the default identity provider. 2. party is not hosted by the participant. 3. party is hosted by the participant, but is outside of the user's identity provider.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ resource_version + string + +
+ +
An opaque, non-empty value, populated by a participant server which represents the internal version of the resource this ``ObjectMeta`` message is attached to. The participant server will change it to a unique value each time the corresponding resource is updated. You must not rely on the format of resource version. The participant server might change it without notice. You can obtain the newest resource version value by issuing a read request. You may use it for concurrent change detection by passing it back unmodified in an update request. The participant server will then compare the passed value with the value maintained by the system to determine if any other updates took place since you had read the resource version. Upon a successful update you are guaranteed that no other update took place during your read-modify-write sequence. However, if another update took place during your read-modify-write sequence then your update will fail with an appropriate error. Concurrent change control is optional. It will be applied only if you include a resource version in an update request. When creating a new instance of a resource you must leave the resource version empty. Its value will be populated by the participant server upon successful resource creation. Optional
+ +
+ +
+
+ annotations + repeated map + +
+ +
A set of modifiable key-value pairs that can be used to represent arbitrary, client-specific metadata. Constraints: 1. The total size over all keys and values cannot exceed 256kb in UTF-8 encoding. 2. Keys are composed of an optional prefix segment and a required name segment such that: - key prefix, when present, must be a valid DNS subdomain with at most 253 characters, followed by a '/' (forward slash) character, - name segment must have at most 63 characters that are either alphanumeric ([a-z0-9A-Z]), or a '.' (dot), '-' (dash) or '_' (underscore); and it must start and end with an alphanumeric character. 3. Values can be any non-empty strings. Keys with empty prefix are reserved for end-users. Properties set by external tools or internally by the participant server must use non-empty key prefixes. Duplicate keys are disallowed by the semantics of the protobuf3 maps. See: https://developers.google.com/protocol-buffers/docs/proto3#maps Annotations may be a part of a modifiable resource. Use the resource's update RPC to update its annotations. In order to add a new annotation or update an existing one using an update RPC, provide the desired annotation in the update request. 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. Optional Modifiable
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ party_details + PartyDetails + +
+ +
Updated party details
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/updatepartyidentityproviderid.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/updatepartyidentityproviderid.mdx new file mode 100644 index 0000000..13596df --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/updatepartyidentityproviderid.mdx @@ -0,0 +1,326 @@ +--- +title: "UpdatePartyIdentityProviderId" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2.admin

+ + +

UpdatePartyIdentityProviderId

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.admin.PartyManagementService/UpdatePartyIdentityProviderId + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.PartyManagementService/UpdatePartyIdentityProviderId <<'EOF' +{ + "party": "string", + "sourceIdentityProviderId": "string", + "targetIdentityProviderId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PartyManagementService
+
+ +
+
RPC
+
UpdatePartyIdentityProviderId
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

UpdatePartyIdentityProviderIdRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.UpdatePartyIdentityProviderIdRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ party + string + +
+ +
Party to update
+ +
+ +
+
+ source_identity_provider_id + string + +
+ +
Current identity provider id of the party
+ +
+ +
+
+ target_identity_provider_id + string + +
+ +
Target identity provider id of the party
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

UpdatePartyIdentityProviderIdResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.UpdatePartyIdentityProviderIdResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ party + string + +
+ +
Party to update
+ +
+ +
+
+ source_identity_provider_id + string + +
+ +
Current identity provider id of the party
+ +
+ +
+
+ target_identity_provider_id + string + +
+ +
Target identity provider id of the party
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/createuser.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/createuser.mdx new file mode 100644 index 0000000..5a1436e --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/createuser.mdx @@ -0,0 +1,666 @@ +--- +title: "CreateUser" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2.admin

+ + +

CreateUser

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.admin.UserManagementService/CreateUser + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.UserManagementService/CreateUser <<'EOF' +{ + "user": { + "id": "string", + "primaryParty": "string", + "isDeactivated": true, + "metadata": { + "resourceVersion": "string", + "annotations": [ + { + "key": "string" + } + ] + }, + "identityProviderId": "string" + }, + "rights": [ + { + "participantAdmin": {} + } + ] +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "user": { + "id": "string", + "primaryParty": "string", + "isDeactivated": true, + "metadata": { + "resourceVersion": "string", + "annotations": [ + { + "key": "string" + } + ] + }, + "identityProviderId": "string" + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
UserManagementService
+
+ +
+
RPC
+
CreateUser
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

CreateUserRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.CreateUserRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ user + User + +
+ +
The user to create. Required
+ +
+ +
+
+ rights + repeated Right + +
+ +
The rights to be assigned to the user upon creation, which SHOULD include appropriate rights for the ``user.primary_party``. Optional
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

CreateUserResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.CreateUserResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ user + User + +
+ +
Created user.
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ user + User + +
+ +
The user to create. Required
+ +
+ +
+
+ rights + repeated Right + +
+ +
The rights to be assigned to the user upon creation, which SHOULD include appropriate rights for the ``user.primary_party``. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ id + string + +
+ +
The user identifier, which must be a non-empty string of at most 128 characters that are either alphanumeric ASCII characters or one of the symbols "@^$.!`-#+'~_|:()". Required
+ +
+ +
+
+ primary_party + string + +
+ +
The primary party as which this user reads and acts by default on the ledger *provided* it has the corresponding ``CanReadAs(primary_party)`` or ``CanActAs(primary_party)`` rights. Ledger API clients SHOULD set this field to a non-empty value for all users to enable the users to act on the ledger using their own Daml party. Users for participant administrators MAY have an associated primary party. Optional, Modifiable
+ +
+ +
+
+ is_deactivated + bool + +
+ +
When set, then the user is denied all access to the Ledger API. Otherwise, the user has access to the Ledger API as per the user's rights. Optional, Modifiable
+ +
+ +
+
+ metadata + ObjectMeta + +
+ +
The metadata of this user. Note that the ``metadata.resource_version`` tracks changes to the properties described by the ``User`` message and not the user's rights. Optional, Modifiable
+ +
+ +
+
+ identity_provider_id + string + +
+ +
The ID of the identity provider configured by ``Identity Provider Config`` Optional, if not set, assume the user is managed by the default identity provider.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ resource_version + string + +
+ +
An opaque, non-empty value, populated by a participant server which represents the internal version of the resource this ``ObjectMeta`` message is attached to. The participant server will change it to a unique value each time the corresponding resource is updated. You must not rely on the format of resource version. The participant server might change it without notice. You can obtain the newest resource version value by issuing a read request. You may use it for concurrent change detection by passing it back unmodified in an update request. The participant server will then compare the passed value with the value maintained by the system to determine if any other updates took place since you had read the resource version. Upon a successful update you are guaranteed that no other update took place during your read-modify-write sequence. However, if another update took place during your read-modify-write sequence then your update will fail with an appropriate error. Concurrent change control is optional. It will be applied only if you include a resource version in an update request. When creating a new instance of a resource you must leave the resource version empty. Its value will be populated by the participant server upon successful resource creation. Optional
+ +
+ +
+
+ annotations + repeated map + +
+ +
A set of modifiable key-value pairs that can be used to represent arbitrary, client-specific metadata. Constraints: 1. The total size over all keys and values cannot exceed 256kb in UTF-8 encoding. 2. Keys are composed of an optional prefix segment and a required name segment such that: - key prefix, when present, must be a valid DNS subdomain with at most 253 characters, followed by a '/' (forward slash) character, - name segment must have at most 63 characters that are either alphanumeric ([a-z0-9A-Z]), or a '.' (dot), '-' (dash) or '_' (underscore); and it must start and end with an alphanumeric character. 3. Values can be any non-empty strings. Keys with empty prefix are reserved for end-users. Properties set by external tools or internally by the participant server must use non-empty key prefixes. Duplicate keys are disallowed by the semantics of the protobuf3 maps. See: https://developers.google.com/protocol-buffers/docs/proto3#maps Annotations may be a part of a modifiable resource. Use the resource's update RPC to update its annotations. In order to add a new annotation or update an existing one using an update RPC, provide the desired annotation in the update request. 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. Optional Modifiable
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ participant_admin + ParticipantAdmin + +
+ +
The user can administer the participant node.
+ +
+ +
+
+ can_act_as + CanActAs + +
+ +
The user can act as a specific party.
+ +
+ +
+
+ can_read_as + CanReadAs + +
+ +
The user can read ledger data visible to a specific party.
+ +
+ +
+
+ identity_provider_admin + IdentityProviderAdmin + +
+ +
The user can administer users and parties assigned to the same identity provider as the one of the user.
+ +
+ +
+
+ can_read_as_any_party + CanReadAsAnyParty + +
+ +
The user can read as any party on a participant
+ +
+ +
+
+ can_execute_as + CanExecuteAs + +
+ +
The user can prepare and execute submissions as a specific party.
+ +
+ +
+
+ can_execute_as_any_party + CanExecuteAsAnyParty + +
+ +
The user can prepare and execute submissions as any party on a participant.
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ party + string + +
+ +
The right to authorize commands for this party.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ party + string + +
+ +
The right to read ledger data visible to this party.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ party + string + +
+ +
The right to prepare and execute submissions as this party. This right does not entitle the user to perform any reads. If reading is required, a separate ReadAs right must be added. Right to execute as a party is also implicitly contained in the CanActAs right.
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + + + +
+ + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ user + User + +
+ +
Created user.
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/deleteuser.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/deleteuser.mdx new file mode 100644 index 0000000..7caaa1a --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/deleteuser.mdx @@ -0,0 +1,303 @@ +--- +title: "DeleteUser" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2.admin

+ + +

DeleteUser

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.admin.UserManagementService/DeleteUser + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.UserManagementService/DeleteUser <<'EOF' +{ + "userId": "string", + "identityProviderId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
UserManagementService
+
+ +
+
RPC
+
DeleteUser
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

DeleteUserRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.DeleteUserRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ user_id + string + +
+ +
The user to delete. Required
+ +
+ +
+
+ identity_provider_id + string + +
+ +
The id of the ``Identity Provider`` Optional, if not set, assume the user is managed by the default identity provider.
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

DeleteUserResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.DeleteUserResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ user_id + string + +
+ +
The user to delete. Required
+ +
+ +
+
+ identity_provider_id + string + +
+ +
The id of the ``Identity Provider`` Optional, if not set, assume the user is managed by the default identity provider.
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/getuser.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/getuser.mdx new file mode 100644 index 0000000..31f34f8 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/getuser.mdx @@ -0,0 +1,451 @@ +--- +title: "GetUser" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2.admin

+ + +

GetUser

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.admin.UserManagementService/GetUser + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.UserManagementService/GetUser <<'EOF' +{ + "userId": "string", + "identityProviderId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "user": { + "id": "string", + "primaryParty": "string", + "isDeactivated": true, + "metadata": { + "resourceVersion": "string", + "annotations": [ + { + "key": "string" + } + ] + }, + "identityProviderId": "string" + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
UserManagementService
+
+ +
+
RPC
+
GetUser
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetUserRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.GetUserRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ user_id + string + +
+ +
The user whose data to retrieve. If set to empty string (the default), then the data for the authenticated user will be retrieved. Optional
+ +
+ +
+
+ identity_provider_id + string + +
+ +
The id of the ``Identity Provider`` Optional, if not set, assume the user is managed by the default identity provider.
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

GetUserResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.GetUserResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ user + User + +
+ +
Retrieved user.
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ user_id + string + +
+ +
The user whose data to retrieve. If set to empty string (the default), then the data for the authenticated user will be retrieved. Optional
+ +
+ +
+
+ identity_provider_id + string + +
+ +
The id of the ``Identity Provider`` Optional, if not set, assume the user is managed by the default identity provider.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ user + User + +
+ +
Retrieved user.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ id + string + +
+ +
The user identifier, which must be a non-empty string of at most 128 characters that are either alphanumeric ASCII characters or one of the symbols "@^$.!`-#+'~_|:()". Required
+ +
+ +
+
+ primary_party + string + +
+ +
The primary party as which this user reads and acts by default on the ledger *provided* it has the corresponding ``CanReadAs(primary_party)`` or ``CanActAs(primary_party)`` rights. Ledger API clients SHOULD set this field to a non-empty value for all users to enable the users to act on the ledger using their own Daml party. Users for participant administrators MAY have an associated primary party. Optional, Modifiable
+ +
+ +
+
+ is_deactivated + bool + +
+ +
When set, then the user is denied all access to the Ledger API. Otherwise, the user has access to the Ledger API as per the user's rights. Optional, Modifiable
+ +
+ +
+
+ metadata + ObjectMeta + +
+ +
The metadata of this user. Note that the ``metadata.resource_version`` tracks changes to the properties described by the ``User`` message and not the user's rights. Optional, Modifiable
+ +
+ +
+
+ identity_provider_id + string + +
+ +
The ID of the identity provider configured by ``Identity Provider Config`` Optional, if not set, assume the user is managed by the default identity provider.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ resource_version + string + +
+ +
An opaque, non-empty value, populated by a participant server which represents the internal version of the resource this ``ObjectMeta`` message is attached to. The participant server will change it to a unique value each time the corresponding resource is updated. You must not rely on the format of resource version. The participant server might change it without notice. You can obtain the newest resource version value by issuing a read request. You may use it for concurrent change detection by passing it back unmodified in an update request. The participant server will then compare the passed value with the value maintained by the system to determine if any other updates took place since you had read the resource version. Upon a successful update you are guaranteed that no other update took place during your read-modify-write sequence. However, if another update took place during your read-modify-write sequence then your update will fail with an appropriate error. Concurrent change control is optional. It will be applied only if you include a resource version in an update request. When creating a new instance of a resource you must leave the resource version empty. Its value will be populated by the participant server upon successful resource creation. Optional
+ +
+ +
+
+ annotations + repeated map + +
+ +
A set of modifiable key-value pairs that can be used to represent arbitrary, client-specific metadata. Constraints: 1. The total size over all keys and values cannot exceed 256kb in UTF-8 encoding. 2. Keys are composed of an optional prefix segment and a required name segment such that: - key prefix, when present, must be a valid DNS subdomain with at most 253 characters, followed by a '/' (forward slash) character, - name segment must have at most 63 characters that are either alphanumeric ([a-z0-9A-Z]), or a '.' (dot), '-' (dash) or '_' (underscore); and it must start and end with an alphanumeric character. 3. Values can be any non-empty strings. Keys with empty prefix are reserved for end-users. Properties set by external tools or internally by the participant server must use non-empty key prefixes. Duplicate keys are disallowed by the semantics of the protobuf3 maps. See: https://developers.google.com/protocol-buffers/docs/proto3#maps Annotations may be a part of a modifiable resource. Use the resource's update RPC to update its annotations. In order to add a new annotation or update an existing one using an update RPC, provide the desired annotation in the update request. 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. Optional Modifiable
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/grantuserrights.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/grantuserrights.mdx new file mode 100644 index 0000000..5c92a83 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/grantuserrights.mdx @@ -0,0 +1,564 @@ +--- +title: "GrantUserRights" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2.admin

+ + +

GrantUserRights

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.admin.UserManagementService/GrantUserRights + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.UserManagementService/GrantUserRights <<'EOF' +{ + "userId": "string", + "rights": [ + { + "participantAdmin": {} + } + ], + "identityProviderId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "newlyGrantedRights": [ + { + "participantAdmin": {} + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
UserManagementService
+
+ +
+
RPC
+
GrantUserRights
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GrantUserRightsRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.GrantUserRightsRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ user_id + string + +
+ +
The user to whom to grant rights. Required
+ +
+ +
+
+ rights + repeated Right + +
+ +
The rights to grant. Optional
+ +
+ +
+
+ identity_provider_id + string + +
+ +
The id of the ``Identity Provider`` Optional, if not set, assume the user is managed by the default identity provider.
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

GrantUserRightsResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.GrantUserRightsResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ newly_granted_rights + repeated Right + +
+ +
The rights that were newly granted by the request.
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ user_id + string + +
+ +
The user to whom to grant rights. Required
+ +
+ +
+
+ rights + repeated Right + +
+ +
The rights to grant. Optional
+ +
+ +
+
+ identity_provider_id + string + +
+ +
The id of the ``Identity Provider`` Optional, if not set, assume the user is managed by the default identity provider.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ participant_admin + ParticipantAdmin + +
+ +
The user can administer the participant node.
+ +
+ +
+
+ can_act_as + CanActAs + +
+ +
The user can act as a specific party.
+ +
+ +
+
+ can_read_as + CanReadAs + +
+ +
The user can read ledger data visible to a specific party.
+ +
+ +
+
+ identity_provider_admin + IdentityProviderAdmin + +
+ +
The user can administer users and parties assigned to the same identity provider as the one of the user.
+ +
+ +
+
+ can_read_as_any_party + CanReadAsAnyParty + +
+ +
The user can read as any party on a participant
+ +
+ +
+
+ can_execute_as + CanExecuteAs + +
+ +
The user can prepare and execute submissions as a specific party.
+ +
+ +
+
+ can_execute_as_any_party + CanExecuteAsAnyParty + +
+ +
The user can prepare and execute submissions as any party on a participant.
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ party + string + +
+ +
The right to authorize commands for this party.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ party + string + +
+ +
The right to read ledger data visible to this party.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ party + string + +
+ +
The right to prepare and execute submissions as this party. This right does not entitle the user to perform any reads. If reading is required, a separate ReadAs right must be added. Right to execute as a party is also implicitly contained in the CanActAs right.
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + + + +
+ + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ newly_granted_rights + repeated Right + +
+ +
The rights that were newly granted by the request.
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/listuserrights.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/listuserrights.mdx new file mode 100644 index 0000000..2a30351 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/listuserrights.mdx @@ -0,0 +1,537 @@ +--- +title: "ListUserRights" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2.admin

+ + +

ListUserRights

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.admin.UserManagementService/ListUserRights + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.UserManagementService/ListUserRights <<'EOF' +{ + "userId": "string", + "identityProviderId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "rights": [ + { + "participantAdmin": {} + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
UserManagementService
+
+ +
+
RPC
+
ListUserRights
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ListUserRightsRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.ListUserRightsRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ user_id + string + +
+ +
The user for which to list the rights. If set to empty string (the default), then the rights for the authenticated user will be listed. Required
+ +
+ +
+
+ identity_provider_id + string + +
+ +
The id of the ``Identity Provider`` Optional, if not set, assume the user is managed by the default identity provider.
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ListUserRightsResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.ListUserRightsResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ rights + repeated Right + +
+ +
All rights of the user.
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ user_id + string + +
+ +
The user for which to list the rights. If set to empty string (the default), then the rights for the authenticated user will be listed. Required
+ +
+ +
+
+ identity_provider_id + string + +
+ +
The id of the ``Identity Provider`` Optional, if not set, assume the user is managed by the default identity provider.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ rights + repeated Right + +
+ +
All rights of the user.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ participant_admin + ParticipantAdmin + +
+ +
The user can administer the participant node.
+ +
+ +
+
+ can_act_as + CanActAs + +
+ +
The user can act as a specific party.
+ +
+ +
+
+ can_read_as + CanReadAs + +
+ +
The user can read ledger data visible to a specific party.
+ +
+ +
+
+ identity_provider_admin + IdentityProviderAdmin + +
+ +
The user can administer users and parties assigned to the same identity provider as the one of the user.
+ +
+ +
+
+ can_read_as_any_party + CanReadAsAnyParty + +
+ +
The user can read as any party on a participant
+ +
+ +
+
+ can_execute_as + CanExecuteAs + +
+ +
The user can prepare and execute submissions as a specific party.
+ +
+ +
+
+ can_execute_as_any_party + CanExecuteAsAnyParty + +
+ +
The user can prepare and execute submissions as any party on a participant.
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ party + string + +
+ +
The right to authorize commands for this party.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ party + string + +
+ +
The right to read ledger data visible to this party.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ party + string + +
+ +
The right to prepare and execute submissions as this party. This right does not entitle the user to perform any reads. If reading is required, a separate ReadAs right must be added. Right to execute as a party is also implicitly contained in the CanActAs right.
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/listusers.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/listusers.mdx new file mode 100644 index 0000000..88f0d96 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/listusers.mdx @@ -0,0 +1,499 @@ +--- +title: "ListUsers" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2.admin

+ + +

ListUsers

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.admin.UserManagementService/ListUsers + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.UserManagementService/ListUsers <<'EOF' +{ + "pageToken": "string", + "pageSize": 0, + "identityProviderId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "users": [ + { + "id": "string", + "primaryParty": "string", + "isDeactivated": true, + "metadata": { + "resourceVersion": "string", + "annotations": [ + { + "key": "string" + } + ] + }, + "identityProviderId": "string" + } + ], + "nextPageToken": "string" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
UserManagementService
+
+ +
+
RPC
+
ListUsers
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ListUsersRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.ListUsersRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ page_token + string + +
+ +
Pagination token to determine the specific page to fetch. Leave empty to fetch the first page. Optional
+ +
+ +
+
+ page_size + int32 + +
+ +
Maximum number of results to be returned by the server. The server will return no more than that many results, but it might return fewer. If 0, the server will decide the number of results to be returned. Optional
+ +
+ +
+
+ identity_provider_id + string + +
+ +
The id of the ``Identity Provider`` Optional, if not set, assume the user is managed by the default identity provider.
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ListUsersResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.ListUsersResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ users + repeated User + +
+ +
A subset of users of the participant node that fit into this page.
+ +
+ +
+
+ next_page_token + string + +
+ +
Pagination token to retrieve the next page. Empty, if there are no further results.
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ page_token + string + +
+ +
Pagination token to determine the specific page to fetch. Leave empty to fetch the first page. Optional
+ +
+ +
+
+ page_size + int32 + +
+ +
Maximum number of results to be returned by the server. The server will return no more than that many results, but it might return fewer. If 0, the server will decide the number of results to be returned. Optional
+ +
+ +
+
+ identity_provider_id + string + +
+ +
The id of the ``Identity Provider`` Optional, if not set, assume the user is managed by the default identity provider.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ users + repeated User + +
+ +
A subset of users of the participant node that fit into this page.
+ +
+ +
+
+ next_page_token + string + +
+ +
Pagination token to retrieve the next page. Empty, if there are no further results.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ id + string + +
+ +
The user identifier, which must be a non-empty string of at most 128 characters that are either alphanumeric ASCII characters or one of the symbols "@^$.!`-#+'~_|:()". Required
+ +
+ +
+
+ primary_party + string + +
+ +
The primary party as which this user reads and acts by default on the ledger *provided* it has the corresponding ``CanReadAs(primary_party)`` or ``CanActAs(primary_party)`` rights. Ledger API clients SHOULD set this field to a non-empty value for all users to enable the users to act on the ledger using their own Daml party. Users for participant administrators MAY have an associated primary party. Optional, Modifiable
+ +
+ +
+
+ is_deactivated + bool + +
+ +
When set, then the user is denied all access to the Ledger API. Otherwise, the user has access to the Ledger API as per the user's rights. Optional, Modifiable
+ +
+ +
+
+ metadata + ObjectMeta + +
+ +
The metadata of this user. Note that the ``metadata.resource_version`` tracks changes to the properties described by the ``User`` message and not the user's rights. Optional, Modifiable
+ +
+ +
+
+ identity_provider_id + string + +
+ +
The ID of the identity provider configured by ``Identity Provider Config`` Optional, if not set, assume the user is managed by the default identity provider.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ resource_version + string + +
+ +
An opaque, non-empty value, populated by a participant server which represents the internal version of the resource this ``ObjectMeta`` message is attached to. The participant server will change it to a unique value each time the corresponding resource is updated. You must not rely on the format of resource version. The participant server might change it without notice. You can obtain the newest resource version value by issuing a read request. You may use it for concurrent change detection by passing it back unmodified in an update request. The participant server will then compare the passed value with the value maintained by the system to determine if any other updates took place since you had read the resource version. Upon a successful update you are guaranteed that no other update took place during your read-modify-write sequence. However, if another update took place during your read-modify-write sequence then your update will fail with an appropriate error. Concurrent change control is optional. It will be applied only if you include a resource version in an update request. When creating a new instance of a resource you must leave the resource version empty. Its value will be populated by the participant server upon successful resource creation. Optional
+ +
+ +
+
+ annotations + repeated map + +
+ +
A set of modifiable key-value pairs that can be used to represent arbitrary, client-specific metadata. Constraints: 1. The total size over all keys and values cannot exceed 256kb in UTF-8 encoding. 2. Keys are composed of an optional prefix segment and a required name segment such that: - key prefix, when present, must be a valid DNS subdomain with at most 253 characters, followed by a '/' (forward slash) character, - name segment must have at most 63 characters that are either alphanumeric ([a-z0-9A-Z]), or a '.' (dot), '-' (dash) or '_' (underscore); and it must start and end with an alphanumeric character. 3. Values can be any non-empty strings. Keys with empty prefix are reserved for end-users. Properties set by external tools or internally by the participant server must use non-empty key prefixes. Duplicate keys are disallowed by the semantics of the protobuf3 maps. See: https://developers.google.com/protocol-buffers/docs/proto3#maps Annotations may be a part of a modifiable resource. Use the resource's update RPC to update its annotations. In order to add a new annotation or update an existing one using an update RPC, provide the desired annotation in the update request. 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. Optional Modifiable
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/revokeuserrights.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/revokeuserrights.mdx new file mode 100644 index 0000000..6670ba5 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/revokeuserrights.mdx @@ -0,0 +1,564 @@ +--- +title: "RevokeUserRights" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2.admin

+ + +

RevokeUserRights

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.admin.UserManagementService/RevokeUserRights + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.UserManagementService/RevokeUserRights <<'EOF' +{ + "userId": "string", + "rights": [ + { + "participantAdmin": {} + } + ], + "identityProviderId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "newlyRevokedRights": [ + { + "participantAdmin": {} + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
UserManagementService
+
+ +
+
RPC
+
RevokeUserRights
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

RevokeUserRightsRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.RevokeUserRightsRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ user_id + string + +
+ +
The user from whom to revoke rights. Required
+ +
+ +
+
+ rights + repeated Right + +
+ +
The rights to revoke. Optional
+ +
+ +
+
+ identity_provider_id + string + +
+ +
The id of the ``Identity Provider`` Optional, if not set, assume the user is managed by the default identity provider.
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

RevokeUserRightsResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.RevokeUserRightsResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ newly_revoked_rights + repeated Right + +
+ +
The rights that were actually revoked by the request.
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ user_id + string + +
+ +
The user from whom to revoke rights. Required
+ +
+ +
+
+ rights + repeated Right + +
+ +
The rights to revoke. Optional
+ +
+ +
+
+ identity_provider_id + string + +
+ +
The id of the ``Identity Provider`` Optional, if not set, assume the user is managed by the default identity provider.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ participant_admin + ParticipantAdmin + +
+ +
The user can administer the participant node.
+ +
+ +
+
+ can_act_as + CanActAs + +
+ +
The user can act as a specific party.
+ +
+ +
+
+ can_read_as + CanReadAs + +
+ +
The user can read ledger data visible to a specific party.
+ +
+ +
+
+ identity_provider_admin + IdentityProviderAdmin + +
+ +
The user can administer users and parties assigned to the same identity provider as the one of the user.
+ +
+ +
+
+ can_read_as_any_party + CanReadAsAnyParty + +
+ +
The user can read as any party on a participant
+ +
+ +
+
+ can_execute_as + CanExecuteAs + +
+ +
The user can prepare and execute submissions as a specific party.
+ +
+ +
+
+ can_execute_as_any_party + CanExecuteAsAnyParty + +
+ +
The user can prepare and execute submissions as any party on a participant.
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ party + string + +
+ +
The right to authorize commands for this party.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ party + string + +
+ +
The right to read ledger data visible to this party.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ party + string + +
+ +
The right to prepare and execute submissions as this party. This right does not entitle the user to perform any reads. If reading is required, a separate ReadAs right must be added. Right to execute as a party is also implicitly contained in the CanActAs right.
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + + + +
+ + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ newly_revoked_rights + repeated Right + +
+ +
The rights that were actually revoked by the request.
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/updateuser.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/updateuser.mdx new file mode 100644 index 0000000..5338e2f --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/updateuser.mdx @@ -0,0 +1,464 @@ +--- +title: "UpdateUser" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2.admin

+ + +

UpdateUser

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.admin.UserManagementService/UpdateUser + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.UserManagementService/UpdateUser <<'EOF' +{ + "user": { + "id": "string", + "primaryParty": "string", + "isDeactivated": true, + "metadata": { + "resourceVersion": "string", + "annotations": [ + { + "key": "string" + } + ] + }, + "identityProviderId": "string" + }, + "updateMask": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "user": { + "id": "string", + "primaryParty": "string", + "isDeactivated": true, + "metadata": { + "resourceVersion": "string", + "annotations": [ + { + "key": "string" + } + ] + }, + "identityProviderId": "string" + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
UserManagementService
+
+ +
+
RPC
+
UpdateUser
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

UpdateUserRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.UpdateUserRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ user + User + +
+ +
The user to update. Required, Modifiable
+ +
+ +
+
+ update_mask + FieldMask + +
+ +
An update mask specifies how and which properties of the ``User`` message are to be updated. An update mask consists of a set of update paths. A valid update path points to a field or a subfield relative to the ``User`` message. A valid update mask must: 1. contain at least one update path, 2. contain only valid update paths. Fields that can be updated are marked as ``Modifiable``. An update path can also point to a non-``Modifiable`` fields such as 'id' and 'metadata.resource_version' because they are used: 1. to identify the user resource subject to the update, 2. for concurrent change control. Examples of valid update paths: 'primary_party', 'metadata', 'metadata.annotations'. For additional information see the documentation for standard protobuf3's ``google.protobuf.FieldMask``. For similar Ledger API see ``com.daml.ledger.api.v2.admin.UpdatePartyDetailsRequest``. Required
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

UpdateUserResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.UpdateUserResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ user + User + +
+ +
Updated user
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ user + User + +
+ +
The user to update. Required, Modifiable
+ +
+ +
+
+ update_mask + FieldMask + +
+ +
An update mask specifies how and which properties of the ``User`` message are to be updated. An update mask consists of a set of update paths. A valid update path points to a field or a subfield relative to the ``User`` message. A valid update mask must: 1. contain at least one update path, 2. contain only valid update paths. Fields that can be updated are marked as ``Modifiable``. An update path can also point to a non-``Modifiable`` fields such as 'id' and 'metadata.resource_version' because they are used: 1. to identify the user resource subject to the update, 2. for concurrent change control. Examples of valid update paths: 'primary_party', 'metadata', 'metadata.annotations'. For additional information see the documentation for standard protobuf3's ``google.protobuf.FieldMask``. For similar Ledger API see ``com.daml.ledger.api.v2.admin.UpdatePartyDetailsRequest``. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ id + string + +
+ +
The user identifier, which must be a non-empty string of at most 128 characters that are either alphanumeric ASCII characters or one of the symbols "@^$.!`-#+'~_|:()". Required
+ +
+ +
+
+ primary_party + string + +
+ +
The primary party as which this user reads and acts by default on the ledger *provided* it has the corresponding ``CanReadAs(primary_party)`` or ``CanActAs(primary_party)`` rights. Ledger API clients SHOULD set this field to a non-empty value for all users to enable the users to act on the ledger using their own Daml party. Users for participant administrators MAY have an associated primary party. Optional, Modifiable
+ +
+ +
+
+ is_deactivated + bool + +
+ +
When set, then the user is denied all access to the Ledger API. Otherwise, the user has access to the Ledger API as per the user's rights. Optional, Modifiable
+ +
+ +
+
+ metadata + ObjectMeta + +
+ +
The metadata of this user. Note that the ``metadata.resource_version`` tracks changes to the properties described by the ``User`` message and not the user's rights. Optional, Modifiable
+ +
+ +
+
+ identity_provider_id + string + +
+ +
The ID of the identity provider configured by ``Identity Provider Config`` Optional, if not set, assume the user is managed by the default identity provider.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ resource_version + string + +
+ +
An opaque, non-empty value, populated by a participant server which represents the internal version of the resource this ``ObjectMeta`` message is attached to. The participant server will change it to a unique value each time the corresponding resource is updated. You must not rely on the format of resource version. The participant server might change it without notice. You can obtain the newest resource version value by issuing a read request. You may use it for concurrent change detection by passing it back unmodified in an update request. The participant server will then compare the passed value with the value maintained by the system to determine if any other updates took place since you had read the resource version. Upon a successful update you are guaranteed that no other update took place during your read-modify-write sequence. However, if another update took place during your read-modify-write sequence then your update will fail with an appropriate error. Concurrent change control is optional. It will be applied only if you include a resource version in an update request. When creating a new instance of a resource you must leave the resource version empty. Its value will be populated by the participant server upon successful resource creation. Optional
+ +
+ +
+
+ annotations + repeated map + +
+ +
A set of modifiable key-value pairs that can be used to represent arbitrary, client-specific metadata. Constraints: 1. The total size over all keys and values cannot exceed 256kb in UTF-8 encoding. 2. Keys are composed of an optional prefix segment and a required name segment such that: - key prefix, when present, must be a valid DNS subdomain with at most 253 characters, followed by a '/' (forward slash) character, - name segment must have at most 63 characters that are either alphanumeric ([a-z0-9A-Z]), or a '.' (dot), '-' (dash) or '_' (underscore); and it must start and end with an alphanumeric character. 3. Values can be any non-empty strings. Keys with empty prefix are reserved for end-users. Properties set by external tools or internally by the participant server must use non-empty key prefixes. Duplicate keys are disallowed by the semantics of the protobuf3 maps. See: https://developers.google.com/protocol-buffers/docs/proto3#maps Annotations may be a part of a modifiable resource. Use the resource's update RPC to update its annotations. In order to add a new annotation or update an existing one using an update RPC, provide the desired annotation in the update request. 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. Optional Modifiable
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ user + User + +
+ +
Updated user
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/updateuseridentityproviderid.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/updateuseridentityproviderid.mdx new file mode 100644 index 0000000..63bec43 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/updateuseridentityproviderid.mdx @@ -0,0 +1,326 @@ +--- +title: "UpdateUserIdentityProviderId" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2.admin

+ + +

UpdateUserIdentityProviderId

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.admin.UserManagementService/UpdateUserIdentityProviderId + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.UserManagementService/UpdateUserIdentityProviderId <<'EOF' +{ + "userId": "string", + "sourceIdentityProviderId": "string", + "targetIdentityProviderId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
UserManagementService
+
+ +
+
RPC
+
UpdateUserIdentityProviderId
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

UpdateUserIdentityProviderIdRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.UpdateUserIdentityProviderIdRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ user_id + string + +
+ +
User to update
+ +
+ +
+
+ source_identity_provider_id + string + +
+ +
Current identity provider ID of the user
+ +
+ +
+
+ target_identity_provider_id + string + +
+ +
Target identity provider ID of the user
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

UpdateUserIdentityProviderIdResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.admin.UpdateUserIdentityProviderIdResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ user_id + string + +
+ +
User to update
+ +
+ +
+
+ source_identity_provider_id + string + +
+ +
Current identity provider ID of the user
+ +
+ +
+
+ target_identity_provider_id + string + +
+ +
Target identity provider ID of the user
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/executesubmission.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/executesubmission.mdx new file mode 100644 index 0000000..55f4aa7 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/executesubmission.mdx @@ -0,0 +1,1511 @@ +--- +title: "ExecuteSubmission" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2.interactive

+ + +

ExecuteSubmission

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.interactive.InteractiveSubmissionService/ExecuteSubmission + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.interactive.InteractiveSubmissionService/ExecuteSubmission <<'EOF' +{ + "preparedTransaction": { + "transaction": { + "version": "string", + "roots": [ + "string" + ], + "nodes": [ + { + "nodeId": "string", + "v1": {} + } + ], + "nodeSeeds": [ + { + "nodeId": 0, + "seed": "BASE64_ENCODED_BYTES" + } + ] + }, + "metadata": { + "submitterInfo": { + "actAs": [ + "string" + ], + "commandId": "string" + }, + "synchronizerId": "string", + "mediatorGroup": 0, + "transactionUuid": "string", + "preparationTime": "0", + "inputContracts": [ + { + "v1": {}, + "createdAt": "0", + "eventBlob": "BASE64_ENCODED_BYTES" + } + ], + "minLedgerEffectiveTime": "0", + "maxLedgerEffectiveTime": "0" + } + }, + "partySignatures": { + "signatures": [ + { + "party": "string", + "signatures": [ + { + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signedBy": "string", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" + } + ] + } + ] + }, + "deduplicationDuration": "string", + "submissionId": "string", + "userId": "string", + "hashingSchemeVersion": "HASHING_SCHEME_VERSION_UNSPECIFIED", + "minLedgerTime": { + "minLedgerTimeAbs": "string" + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
InteractiveSubmissionService
+
+ +
+
RPC
+
ExecuteSubmission
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ExecuteSubmissionRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.interactive.ExecuteSubmissionRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ prepared_transaction + PreparedTransaction + +
+ +
the prepared transaction Typically this is the value of the `prepared_transaction` field in `PrepareSubmissionResponse` obtained from calling `prepareSubmission`. Required
+ +
+ +
+
+ party_signatures + PartySignatures + +
+ +
The party(ies) signatures that authorize the prepared submission to be executed by this node. Each party can provide one or more signatures.. and one or more parties can sign. Note that currently, only single party submissions are supported. Required
+ +
+ +
+
+ deduplication_duration + Duration + +
+ +
Specifies the length of the deduplication period. It is interpreted relative to the local clock at some point during the submission's processing. Must be non-negative. Must not exceed the maximum deduplication time.
+ +
+ +
+
+ deduplication_offset + int64 + +
+ +
Specifies the start of the deduplication period by a completion stream offset (exclusive). Must be a valid absolute offset (positive integer).
+ +
+ +
+
+ submission_id + string + +
+ +
A unique identifier to distinguish completions for different submissions with the same change ID. Typically a random UUID. Applications are expected to use a different UUID for each retry of a submission with the same change ID. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ user_id + string + +
+ +
See [PrepareSubmissionRequest.user_id] Optional
+ +
+ +
+
+ hashing_scheme_version + HashingSchemeVersion + +
+ +
The hashing scheme version used when building the hash Required
+ +
+ +
+
+ min_ledger_time + MinLedgerTime + +
+ +
If set will influence the chosen ledger effective time but will not result in a submission delay so any override should be scheduled to executed within the window allowed by synchronizer. Optional
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ExecuteSubmissionResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.interactive.ExecuteSubmissionResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ prepared_transaction + PreparedTransaction + +
+ +
the prepared transaction Typically this is the value of the `prepared_transaction` field in `PrepareSubmissionResponse` obtained from calling `prepareSubmission`. Required
+ +
+ +
+
+ party_signatures + PartySignatures + +
+ +
The party(ies) signatures that authorize the prepared submission to be executed by this node. Each party can provide one or more signatures.. and one or more parties can sign. Note that currently, only single party submissions are supported. Required
+ +
+ +
+
+ deduplication_duration + Duration + +
+ +
Specifies the length of the deduplication period. It is interpreted relative to the local clock at some point during the submission's processing. Must be non-negative. Must not exceed the maximum deduplication time.
+ +
+ +
+
+ deduplication_offset + int64 + +
+ +
Specifies the start of the deduplication period by a completion stream offset (exclusive). Must be a valid absolute offset (positive integer).
+ +
+ +
+
+ submission_id + string + +
+ +
A unique identifier to distinguish completions for different submissions with the same change ID. Typically a random UUID. Applications are expected to use a different UUID for each retry of a submission with the same change ID. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ user_id + string + +
+ +
See [PrepareSubmissionRequest.user_id] Optional
+ +
+ +
+
+ hashing_scheme_version + HashingSchemeVersion + +
+ +
The hashing scheme version used when building the hash Required
+ +
+ +
+
+ min_ledger_time + MinLedgerTime + +
+ +
If set will influence the chosen ledger effective time but will not result in a submission delay so any override should be scheduled to executed within the window allowed by synchronizer. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ transaction + DamlTransaction + +
+ +
Daml Transaction representing the ledger effect if executed. See below
+ +
+ +
+
+ metadata + Metadata + +
+ +
Metadata context necessary to execute the transaction
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ version + string + +
+ +
serialization version, will be >= max(nodes version)
+ +
+ +
+
+ roots + repeated string + +
+ +
Root nodes of the transaction
+ +
+ +
+
+ nodes + repeated Node + +
+ +
List of nodes in the transaction
+ +
+ +
+
+ node_seeds + repeated NodeSeed + +
+ +
Node seeds are values associated with certain nodes used for generating cryptographic salts
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ node_id + int32 + +
+ +
+ +
+
+ seed + bytes + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ node_id + string + +
+ +
+ +
+
+ v1 + Node + +
+ +
Start at 1000 so we can add more fields before if necessary When new versions will be added, they will show here
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ create + Create + +
+ +
+ +
+
+ fetch + Fetch + +
+ +
+ +
+
+ exercise + Exercise + +
+ +
+ +
+
+ rollback + Rollback + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ lf_version + string + +
+ +
Specific LF version of the node
+ +
+ +
+
+ contract_id + string + +
+ +
+ +
+
+ package_name + string + +
+ +
+ +
+
+ template_id + Identifier + +
+ +
The identifier uses the package-id reference format.
+ +
+ +
+
+ argument + Value + +
+ +
+ +
+
+ signatories + repeated string + +
+ +
+ +
+
+ stakeholders + repeated string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ lf_version + string + +
+ +
Specific LF version of the node
+ +
+ +
+
+ contract_id + string + +
+ +
+ +
+
+ package_name + string + +
+ +
+ +
+
+ template_id + Identifier + +
+ +
The identifier uses the package-id reference format.
+ +
+ +
+
+ signatories + repeated string + +
+ +
+ +
+
+ stakeholders + repeated string + +
+ +
+ +
+
+ acting_parties + repeated string + +
+ +
+ +
+
+ interface_id + Identifier + +
+ +
Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ lf_version + string + +
+ +
Specific LF version of the node
+ +
+ +
+
+ contract_id + string + +
+ +
+ +
+
+ package_name + string + +
+ +
+ +
+
+ template_id + Identifier + +
+ +
The identifier uses the package-id reference format.
+ +
+ +
+
+ signatories + repeated string + +
+ +
+ +
+
+ stakeholders + repeated string + +
+ +
+ +
+
+ acting_parties + repeated string + +
+ +
+ +
+
+ interface_id + Identifier + +
+ +
The identifier uses the package-id reference format.
+ +
+ +
+
+ choice_id + string + +
+ +
+ +
+
+ chosen_value + Value + +
+ +
+ +
+
+ consuming + bool + +
+ +
+ +
+
+ children + repeated string + +
+ +
+ +
+
+ exercise_result + Value + +
+ +
+ +
+
+ choice_observers + repeated string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ children + repeated string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ submitter_info + SubmitterInfo + +
+ +
+ +
+
+ synchronizer_id + string + +
+ +
+ +
+
+ mediator_group + uint32 + +
+ +
+ +
+
+ transaction_uuid + string + +
+ +
+ +
+
+ preparation_time + uint64 + +
+ +
+ +
+
+ input_contracts + repeated InputContract + +
+ +
+ +
+
+ min_ledger_effective_time + uint64 + +
+ +
Where ledger time constraints are imposed during the execution of the contract they will be populated in the fields below. These are optional because if the transaction does NOT depend on time, these values do not need to be set. The final ledger effective time used will be chosen when the command is submitted through the [execute] RPC. If the ledger effective time is outside of any populated min/max bounds then a different transaction can result, that will cause a confirmation message rejection.
+ +
+ +
+
+ max_ledger_effective_time + uint64 + +
+ +
+ +
+
+ global_key_mapping + repeated GlobalKeyMappingEntry + +
+ +
********************************************************** ** Metadata information that does NOT need to be signed ** ********************************************************** Contextual information needed to process the transaction but not signed, either because it's already indirectly signed by signing the transaction, or because it doesn't impact the ledger state
+ +
+ +
+
+ max_record_time + uint64 + +
+ +
Maximum timestamp at which the transaction can be recorded onto the ledger via the synchronizer `synchronizer_id`. If submitted after it will be rejected even if otherwise valid, in which case it needs to be prepared and signed again with a new valid max_record_time. Unsigned in 3.3 to avoid a breaking protocol change Will be signed in 3.4+ Set max_record_time in the PreparedTransactionRequest to get this field set accordingly
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ act_as + repeated string + +
+ +
+ +
+
+ command_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ key + GlobalKey + +
+ +
+ +
+
+ value + Value + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ template_id + Identifier + +
+ +
The identifier uses the package-id reference format.
+ +
+ +
+
+ package_name + string + +
+ +
+ +
+
+ key + Value + +
+ +
+ +
+
+ hash + bytes + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ v1 + Create + +
+ +
When new versions will be added, they will show here
+ +
+ +
+
+ created_at + uint64 + +
+ +
+ +
+
+ event_blob + bytes + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ signatures + repeated SinglePartySignatures + +
+ +
Additional signatures provided by all individual parties Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ party + string + +
+ +
Submitting party Required
+ +
+ +
+
+ signatures + repeated Signature + +
+ +
Signatures Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ format + SignatureFormat + +
+ +
+ +
+
+ signature + bytes + +
+ +
+ +
+
+ signed_by + string + +
+ +
The fingerprint/id of the keypair used to create this signature and needed to verify.
+ +
+ +
+
+ signing_algorithm_spec + SigningAlgorithmSpec + +
+ +
The signing algorithm specification used to produce this signature
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • SIGNATURE_FORMAT_UNSPECIFIED
    • + +
  • SIGNATURE_FORMAT_RAW
    • + +
  • SIGNATURE_FORMAT_DER
    • + +
  • SIGNATURE_FORMAT_CONCAT
    • + +
  • SIGNATURE_FORMAT_SYMBOLIC
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_ALGORITHM_SPEC_UNSPECIFIED
    • + +
  • SIGNING_ALGORITHM_SPEC_ED25519
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_256
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_384
    • + +
+ + +
+ + + +
+ + + +
    + +
  • HASHING_SCHEME_VERSION_UNSPECIFIED
    • + +
  • HASHING_SCHEME_VERSION_V2
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ min_ledger_time_abs + Timestamp + +
+ +
Lower bound for the ledger time assigned to the resulting transaction. The ledger time of a transaction is assigned as part of command interpretation. Important note: for interactive submissions, if the transaction depends on time, it **must** be signed and submitted within a time window around the ledger time assigned to the transaction during the prepare method. The time delta around that ledger time is a configuration of the ledger, usually short, around 1 minute. If however the transaction does not depend on time, the available time window to sign and submit the transaction is bound by the preparation time, which is also assigned in the "prepare" step (this request), but can be configured with a much larger skew, allowing for more time to sign the request (in the order of hours). Must not be set at the same time as min_ledger_time_rel. Optional
+ +
+ +
+
+ min_ledger_time_rel + Duration + +
+ +
Same as min_ledger_time_abs, but specified as a duration, starting from the time this request is received by the server. Must not be set at the same time as min_ledger_time_abs. Optional
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/executesubmissionandwait.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/executesubmissionandwait.mdx new file mode 100644 index 0000000..8a56e9f --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/executesubmissionandwait.mdx @@ -0,0 +1,1566 @@ +--- +title: "ExecuteSubmissionAndWait" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2.interactive

+ + +

ExecuteSubmissionAndWait

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.interactive.InteractiveSubmissionService/ExecuteSubmissionAndWait + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.interactive.InteractiveSubmissionService/ExecuteSubmissionAndWait <<'EOF' +{ + "preparedTransaction": { + "transaction": { + "version": "string", + "roots": [ + "string" + ], + "nodes": [ + { + "nodeId": "string", + "v1": {} + } + ], + "nodeSeeds": [ + { + "nodeId": 0, + "seed": "BASE64_ENCODED_BYTES" + } + ] + }, + "metadata": { + "submitterInfo": { + "actAs": [ + "string" + ], + "commandId": "string" + }, + "synchronizerId": "string", + "mediatorGroup": 0, + "transactionUuid": "string", + "preparationTime": "0", + "inputContracts": [ + { + "v1": {}, + "createdAt": "0", + "eventBlob": "BASE64_ENCODED_BYTES" + } + ], + "minLedgerEffectiveTime": "0", + "maxLedgerEffectiveTime": "0" + } + }, + "partySignatures": { + "signatures": [ + { + "party": "string", + "signatures": [ + { + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signedBy": "string", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" + } + ] + } + ] + }, + "deduplicationDuration": "string", + "submissionId": "string", + "userId": "string", + "hashingSchemeVersion": "HASHING_SCHEME_VERSION_UNSPECIFIED", + "minLedgerTime": { + "minLedgerTimeAbs": "string" + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "updateId": "string", + "completionOffset": "0" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
InteractiveSubmissionService
+
+ +
+
RPC
+
ExecuteSubmissionAndWait
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ExecuteSubmissionAndWaitRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.interactive.ExecuteSubmissionAndWaitRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ prepared_transaction + PreparedTransaction + +
+ +
the prepared transaction Typically this is the value of the `prepared_transaction` field in `PrepareSubmissionResponse` obtained from calling `prepareSubmission`. Required
+ +
+ +
+
+ party_signatures + PartySignatures + +
+ +
The party(ies) signatures that authorize the prepared submission to be executed by this node. Each party can provide one or more signatures.. and one or more parties can sign. Note that currently, only single party submissions are supported. Required
+ +
+ +
+
+ deduplication_duration + Duration + +
+ +
Specifies the length of the deduplication period. It is interpreted relative to the local clock at some point during the submission's processing. Must be non-negative. Must not exceed the maximum deduplication time.
+ +
+ +
+
+ deduplication_offset + int64 + +
+ +
Specifies the start of the deduplication period by a completion stream offset (exclusive). Must be a valid absolute offset (positive integer).
+ +
+ +
+
+ submission_id + string + +
+ +
A unique identifier to distinguish completions for different submissions with the same change ID. Typically a random UUID. Applications are expected to use a different UUID for each retry of a submission with the same change ID. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ user_id + string + +
+ +
See [PrepareSubmissionRequest.user_id] Optional
+ +
+ +
+
+ hashing_scheme_version + HashingSchemeVersion + +
+ +
The hashing scheme version used when building the hash Required
+ +
+ +
+
+ min_ledger_time + MinLedgerTime + +
+ +
If set will influence the chosen ledger effective time but will not result in a submission delay so any override should be scheduled to executed within the window allowed by synchronizer. Optional
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ExecuteSubmissionAndWaitResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.interactive.ExecuteSubmissionAndWaitResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ update_id + string + +
+ +
The id of the transaction that resulted from the submitted command. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ completion_offset + int64 + +
+ +
The details of the offset field are described in ``community/ledger-api/README.md``. Required
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ prepared_transaction + PreparedTransaction + +
+ +
the prepared transaction Typically this is the value of the `prepared_transaction` field in `PrepareSubmissionResponse` obtained from calling `prepareSubmission`. Required
+ +
+ +
+
+ party_signatures + PartySignatures + +
+ +
The party(ies) signatures that authorize the prepared submission to be executed by this node. Each party can provide one or more signatures.. and one or more parties can sign. Note that currently, only single party submissions are supported. Required
+ +
+ +
+
+ deduplication_duration + Duration + +
+ +
Specifies the length of the deduplication period. It is interpreted relative to the local clock at some point during the submission's processing. Must be non-negative. Must not exceed the maximum deduplication time.
+ +
+ +
+
+ deduplication_offset + int64 + +
+ +
Specifies the start of the deduplication period by a completion stream offset (exclusive). Must be a valid absolute offset (positive integer).
+ +
+ +
+
+ submission_id + string + +
+ +
A unique identifier to distinguish completions for different submissions with the same change ID. Typically a random UUID. Applications are expected to use a different UUID for each retry of a submission with the same change ID. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ user_id + string + +
+ +
See [PrepareSubmissionRequest.user_id] Optional
+ +
+ +
+
+ hashing_scheme_version + HashingSchemeVersion + +
+ +
The hashing scheme version used when building the hash Required
+ +
+ +
+
+ min_ledger_time + MinLedgerTime + +
+ +
If set will influence the chosen ledger effective time but will not result in a submission delay so any override should be scheduled to executed within the window allowed by synchronizer. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ transaction + DamlTransaction + +
+ +
Daml Transaction representing the ledger effect if executed. See below
+ +
+ +
+
+ metadata + Metadata + +
+ +
Metadata context necessary to execute the transaction
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ version + string + +
+ +
serialization version, will be >= max(nodes version)
+ +
+ +
+
+ roots + repeated string + +
+ +
Root nodes of the transaction
+ +
+ +
+
+ nodes + repeated Node + +
+ +
List of nodes in the transaction
+ +
+ +
+
+ node_seeds + repeated NodeSeed + +
+ +
Node seeds are values associated with certain nodes used for generating cryptographic salts
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ node_id + int32 + +
+ +
+ +
+
+ seed + bytes + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ node_id + string + +
+ +
+ +
+
+ v1 + Node + +
+ +
Start at 1000 so we can add more fields before if necessary When new versions will be added, they will show here
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ create + Create + +
+ +
+ +
+
+ fetch + Fetch + +
+ +
+ +
+
+ exercise + Exercise + +
+ +
+ +
+
+ rollback + Rollback + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ lf_version + string + +
+ +
Specific LF version of the node
+ +
+ +
+
+ contract_id + string + +
+ +
+ +
+
+ package_name + string + +
+ +
+ +
+
+ template_id + Identifier + +
+ +
The identifier uses the package-id reference format.
+ +
+ +
+
+ argument + Value + +
+ +
+ +
+
+ signatories + repeated string + +
+ +
+ +
+
+ stakeholders + repeated string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ lf_version + string + +
+ +
Specific LF version of the node
+ +
+ +
+
+ contract_id + string + +
+ +
+ +
+
+ package_name + string + +
+ +
+ +
+
+ template_id + Identifier + +
+ +
The identifier uses the package-id reference format.
+ +
+ +
+
+ signatories + repeated string + +
+ +
+ +
+
+ stakeholders + repeated string + +
+ +
+ +
+
+ acting_parties + repeated string + +
+ +
+ +
+
+ interface_id + Identifier + +
+ +
Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ lf_version + string + +
+ +
Specific LF version of the node
+ +
+ +
+
+ contract_id + string + +
+ +
+ +
+
+ package_name + string + +
+ +
+ +
+
+ template_id + Identifier + +
+ +
The identifier uses the package-id reference format.
+ +
+ +
+
+ signatories + repeated string + +
+ +
+ +
+
+ stakeholders + repeated string + +
+ +
+ +
+
+ acting_parties + repeated string + +
+ +
+ +
+
+ interface_id + Identifier + +
+ +
The identifier uses the package-id reference format.
+ +
+ +
+
+ choice_id + string + +
+ +
+ +
+
+ chosen_value + Value + +
+ +
+ +
+
+ consuming + bool + +
+ +
+ +
+
+ children + repeated string + +
+ +
+ +
+
+ exercise_result + Value + +
+ +
+ +
+
+ choice_observers + repeated string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ children + repeated string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ submitter_info + SubmitterInfo + +
+ +
+ +
+
+ synchronizer_id + string + +
+ +
+ +
+
+ mediator_group + uint32 + +
+ +
+ +
+
+ transaction_uuid + string + +
+ +
+ +
+
+ preparation_time + uint64 + +
+ +
+ +
+
+ input_contracts + repeated InputContract + +
+ +
+ +
+
+ min_ledger_effective_time + uint64 + +
+ +
Where ledger time constraints are imposed during the execution of the contract they will be populated in the fields below. These are optional because if the transaction does NOT depend on time, these values do not need to be set. The final ledger effective time used will be chosen when the command is submitted through the [execute] RPC. If the ledger effective time is outside of any populated min/max bounds then a different transaction can result, that will cause a confirmation message rejection.
+ +
+ +
+
+ max_ledger_effective_time + uint64 + +
+ +
+ +
+
+ global_key_mapping + repeated GlobalKeyMappingEntry + +
+ +
********************************************************** ** Metadata information that does NOT need to be signed ** ********************************************************** Contextual information needed to process the transaction but not signed, either because it's already indirectly signed by signing the transaction, or because it doesn't impact the ledger state
+ +
+ +
+
+ max_record_time + uint64 + +
+ +
Maximum timestamp at which the transaction can be recorded onto the ledger via the synchronizer `synchronizer_id`. If submitted after it will be rejected even if otherwise valid, in which case it needs to be prepared and signed again with a new valid max_record_time. Unsigned in 3.3 to avoid a breaking protocol change Will be signed in 3.4+ Set max_record_time in the PreparedTransactionRequest to get this field set accordingly
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ act_as + repeated string + +
+ +
+ +
+
+ command_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ key + GlobalKey + +
+ +
+ +
+
+ value + Value + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ template_id + Identifier + +
+ +
The identifier uses the package-id reference format.
+ +
+ +
+
+ package_name + string + +
+ +
+ +
+
+ key + Value + +
+ +
+ +
+
+ hash + bytes + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ v1 + Create + +
+ +
When new versions will be added, they will show here
+ +
+ +
+
+ created_at + uint64 + +
+ +
+ +
+
+ event_blob + bytes + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ signatures + repeated SinglePartySignatures + +
+ +
Additional signatures provided by all individual parties Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ party + string + +
+ +
Submitting party Required
+ +
+ +
+
+ signatures + repeated Signature + +
+ +
Signatures Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ format + SignatureFormat + +
+ +
+ +
+
+ signature + bytes + +
+ +
+ +
+
+ signed_by + string + +
+ +
The fingerprint/id of the keypair used to create this signature and needed to verify.
+ +
+ +
+
+ signing_algorithm_spec + SigningAlgorithmSpec + +
+ +
The signing algorithm specification used to produce this signature
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • SIGNATURE_FORMAT_UNSPECIFIED
    • + +
  • SIGNATURE_FORMAT_RAW
    • + +
  • SIGNATURE_FORMAT_DER
    • + +
  • SIGNATURE_FORMAT_CONCAT
    • + +
  • SIGNATURE_FORMAT_SYMBOLIC
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_ALGORITHM_SPEC_UNSPECIFIED
    • + +
  • SIGNING_ALGORITHM_SPEC_ED25519
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_256
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_384
    • + +
+ + +
+ + + +
+ + + +
    + +
  • HASHING_SCHEME_VERSION_UNSPECIFIED
    • + +
  • HASHING_SCHEME_VERSION_V2
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ min_ledger_time_abs + Timestamp + +
+ +
Lower bound for the ledger time assigned to the resulting transaction. The ledger time of a transaction is assigned as part of command interpretation. Important note: for interactive submissions, if the transaction depends on time, it **must** be signed and submitted within a time window around the ledger time assigned to the transaction during the prepare method. The time delta around that ledger time is a configuration of the ledger, usually short, around 1 minute. If however the transaction does not depend on time, the available time window to sign and submit the transaction is bound by the preparation time, which is also assigned in the "prepare" step (this request), but can be configured with a much larger skew, allowing for more time to sign the request (in the order of hours). Must not be set at the same time as min_ledger_time_rel. Optional
+ +
+ +
+
+ min_ledger_time_rel + Duration + +
+ +
Same as min_ledger_time_abs, but specified as a duration, starting from the time this request is received by the server. Must not be set at the same time as min_ledger_time_abs. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ update_id + string + +
+ +
The id of the transaction that resulted from the submitted command. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ completion_offset + int64 + +
+ +
The details of the offset field are described in ``community/ledger-api/README.md``. Required
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/executesubmissionandwaitfortransaction.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/executesubmissionandwaitfortransaction.mdx new file mode 100644 index 0000000..3da97b5 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/executesubmissionandwaitfortransaction.mdx @@ -0,0 +1,2557 @@ +--- +title: "ExecuteSubmissionAndWaitForTransaction" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2.interactive

+ + +

ExecuteSubmissionAndWaitForTransaction

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.interactive.InteractiveSubmissionService/ExecuteSubmissionAndWaitForTransaction + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.interactive.InteractiveSubmissionService/ExecuteSubmissionAndWaitForTransaction <<'EOF' +{ + "preparedTransaction": { + "transaction": { + "version": "string", + "roots": [ + "string" + ], + "nodes": [ + { + "nodeId": "string", + "v1": {} + } + ], + "nodeSeeds": [ + { + "nodeId": 0, + "seed": "BASE64_ENCODED_BYTES" + } + ] + }, + "metadata": { + "submitterInfo": { + "actAs": [ + "string" + ], + "commandId": "string" + }, + "synchronizerId": "string", + "mediatorGroup": 0, + "transactionUuid": "string", + "preparationTime": "0", + "inputContracts": [ + { + "v1": {}, + "createdAt": "0", + "eventBlob": "BASE64_ENCODED_BYTES" + } + ], + "minLedgerEffectiveTime": "0", + "maxLedgerEffectiveTime": "0" + } + }, + "partySignatures": { + "signatures": [ + { + "party": "string", + "signatures": [ + { + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signedBy": "string", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" + } + ] + } + ] + }, + "deduplicationDuration": "string", + "submissionId": "string", + "userId": "string", + "hashingSchemeVersion": "HASHING_SCHEME_VERSION_UNSPECIFIED", + "minLedgerTime": { + "minLedgerTimeAbs": "string" + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "transaction": { + "updateId": "string", + "commandId": "string", + "workflowId": "string", + "effectiveAt": "string", + "events": [ + { + "created": { + "offset": "0", + "nodeId": 0, + "contractId": "string", + "templateId": "string", + "contractKey": "string", + "createArguments": "string", + "createdEventBlob": "BASE64_ENCODED_BYTES", + "interfaceViews": [ + {} + ] + } + } + ], + "offset": "0", + "synchronizerId": "string", + "traceContext": { + "traceparent": "string", + "tracestate": "string" + } + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
InteractiveSubmissionService
+
+ +
+
RPC
+
ExecuteSubmissionAndWaitForTransaction
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ExecuteSubmissionAndWaitForTransactionRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.interactive.ExecuteSubmissionAndWaitForTransactionRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ prepared_transaction + PreparedTransaction + +
+ +
the prepared transaction Typically this is the value of the `prepared_transaction` field in `PrepareSubmissionResponse` obtained from calling `prepareSubmission`. Required
+ +
+ +
+
+ party_signatures + PartySignatures + +
+ +
The party(ies) signatures that authorize the prepared submission to be executed by this node. Each party can provide one or more signatures.. and one or more parties can sign. Note that currently, only single party submissions are supported. Required
+ +
+ +
+
+ deduplication_duration + Duration + +
+ +
Specifies the length of the deduplication period. It is interpreted relative to the local clock at some point during the submission's processing. Must be non-negative. Must not exceed the maximum deduplication time.
+ +
+ +
+
+ deduplication_offset + int64 + +
+ +
Specifies the start of the deduplication period by a completion stream offset (exclusive). Must be a valid absolute offset (positive integer).
+ +
+ +
+
+ submission_id + string + +
+ +
A unique identifier to distinguish completions for different submissions with the same change ID. Typically a random UUID. Applications are expected to use a different UUID for each retry of a submission with the same change ID. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ user_id + string + +
+ +
See [PrepareSubmissionRequest.user_id] Optional
+ +
+ +
+
+ hashing_scheme_version + HashingSchemeVersion + +
+ +
The hashing scheme version used when building the hash Required
+ +
+ +
+
+ min_ledger_time + MinLedgerTime + +
+ +
If set will influence the chosen ledger effective time but will not result in a submission delay so any override should be scheduled to executed within the window allowed by synchronizer. Optional
+ +
+ +
+
+ transaction_format + TransactionFormat + +
+ +
If no ``transaction_format`` is provided, a default will be used where ``transaction_shape`` is set to TRANSACTION_SHAPE_ACS_DELTA, ``event_format`` is defined with ``filters_by_party`` containing wildcard-template filter for all original ``act_as`` and ``read_as`` parties and the ``verbose`` flag is set. When the ``transaction_shape`` TRANSACTION_SHAPE_ACS_DELTA shape is used (explicitly or is defaulted to as explained above), events will only be returned if the submitting party is hosted on this node. Optional
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ExecuteSubmissionAndWaitForTransactionResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.interactive.ExecuteSubmissionAndWaitForTransactionResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ transaction + Transaction + +
+ +
The transaction that resulted from the submitted command. The transaction might contain no events (request conditions result in filtering out all of them). Required
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ prepared_transaction + PreparedTransaction + +
+ +
the prepared transaction Typically this is the value of the `prepared_transaction` field in `PrepareSubmissionResponse` obtained from calling `prepareSubmission`. Required
+ +
+ +
+
+ party_signatures + PartySignatures + +
+ +
The party(ies) signatures that authorize the prepared submission to be executed by this node. Each party can provide one or more signatures.. and one or more parties can sign. Note that currently, only single party submissions are supported. Required
+ +
+ +
+
+ deduplication_duration + Duration + +
+ +
Specifies the length of the deduplication period. It is interpreted relative to the local clock at some point during the submission's processing. Must be non-negative. Must not exceed the maximum deduplication time.
+ +
+ +
+
+ deduplication_offset + int64 + +
+ +
Specifies the start of the deduplication period by a completion stream offset (exclusive). Must be a valid absolute offset (positive integer).
+ +
+ +
+
+ submission_id + string + +
+ +
A unique identifier to distinguish completions for different submissions with the same change ID. Typically a random UUID. Applications are expected to use a different UUID for each retry of a submission with the same change ID. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ user_id + string + +
+ +
See [PrepareSubmissionRequest.user_id] Optional
+ +
+ +
+
+ hashing_scheme_version + HashingSchemeVersion + +
+ +
The hashing scheme version used when building the hash Required
+ +
+ +
+
+ min_ledger_time + MinLedgerTime + +
+ +
If set will influence the chosen ledger effective time but will not result in a submission delay so any override should be scheduled to executed within the window allowed by synchronizer. Optional
+ +
+ +
+
+ transaction_format + TransactionFormat + +
+ +
If no ``transaction_format`` is provided, a default will be used where ``transaction_shape`` is set to TRANSACTION_SHAPE_ACS_DELTA, ``event_format`` is defined with ``filters_by_party`` containing wildcard-template filter for all original ``act_as`` and ``read_as`` parties and the ``verbose`` flag is set. When the ``transaction_shape`` TRANSACTION_SHAPE_ACS_DELTA shape is used (explicitly or is defaulted to as explained above), events will only be returned if the submitting party is hosted on this node. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ transaction + DamlTransaction + +
+ +
Daml Transaction representing the ledger effect if executed. See below
+ +
+ +
+
+ metadata + Metadata + +
+ +
Metadata context necessary to execute the transaction
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ version + string + +
+ +
serialization version, will be >= max(nodes version)
+ +
+ +
+
+ roots + repeated string + +
+ +
Root nodes of the transaction
+ +
+ +
+
+ nodes + repeated Node + +
+ +
List of nodes in the transaction
+ +
+ +
+
+ node_seeds + repeated NodeSeed + +
+ +
Node seeds are values associated with certain nodes used for generating cryptographic salts
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ node_id + int32 + +
+ +
+ +
+
+ seed + bytes + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ node_id + string + +
+ +
+ +
+
+ v1 + Node + +
+ +
Start at 1000 so we can add more fields before if necessary When new versions will be added, they will show here
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ create + Create + +
+ +
+ +
+
+ fetch + Fetch + +
+ +
+ +
+
+ exercise + Exercise + +
+ +
+ +
+
+ rollback + Rollback + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ lf_version + string + +
+ +
Specific LF version of the node
+ +
+ +
+
+ contract_id + string + +
+ +
+ +
+
+ package_name + string + +
+ +
+ +
+
+ template_id + Identifier + +
+ +
The identifier uses the package-id reference format.
+ +
+ +
+
+ argument + Value + +
+ +
+ +
+
+ signatories + repeated string + +
+ +
+ +
+
+ stakeholders + repeated string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ lf_version + string + +
+ +
Specific LF version of the node
+ +
+ +
+
+ contract_id + string + +
+ +
+ +
+
+ package_name + string + +
+ +
+ +
+
+ template_id + Identifier + +
+ +
The identifier uses the package-id reference format.
+ +
+ +
+
+ signatories + repeated string + +
+ +
+ +
+
+ stakeholders + repeated string + +
+ +
+ +
+
+ acting_parties + repeated string + +
+ +
+ +
+
+ interface_id + Identifier + +
+ +
Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ lf_version + string + +
+ +
Specific LF version of the node
+ +
+ +
+
+ contract_id + string + +
+ +
+ +
+
+ package_name + string + +
+ +
+ +
+
+ template_id + Identifier + +
+ +
The identifier uses the package-id reference format.
+ +
+ +
+
+ signatories + repeated string + +
+ +
+ +
+
+ stakeholders + repeated string + +
+ +
+ +
+
+ acting_parties + repeated string + +
+ +
+ +
+
+ interface_id + Identifier + +
+ +
The identifier uses the package-id reference format.
+ +
+ +
+
+ choice_id + string + +
+ +
+ +
+
+ chosen_value + Value + +
+ +
+ +
+
+ consuming + bool + +
+ +
+ +
+
+ children + repeated string + +
+ +
+ +
+
+ exercise_result + Value + +
+ +
+ +
+
+ choice_observers + repeated string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ children + repeated string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ submitter_info + SubmitterInfo + +
+ +
+ +
+
+ synchronizer_id + string + +
+ +
+ +
+
+ mediator_group + uint32 + +
+ +
+ +
+
+ transaction_uuid + string + +
+ +
+ +
+
+ preparation_time + uint64 + +
+ +
+ +
+
+ input_contracts + repeated InputContract + +
+ +
+ +
+
+ min_ledger_effective_time + uint64 + +
+ +
Where ledger time constraints are imposed during the execution of the contract they will be populated in the fields below. These are optional because if the transaction does NOT depend on time, these values do not need to be set. The final ledger effective time used will be chosen when the command is submitted through the [execute] RPC. If the ledger effective time is outside of any populated min/max bounds then a different transaction can result, that will cause a confirmation message rejection.
+ +
+ +
+
+ max_ledger_effective_time + uint64 + +
+ +
+ +
+
+ global_key_mapping + repeated GlobalKeyMappingEntry + +
+ +
********************************************************** ** Metadata information that does NOT need to be signed ** ********************************************************** Contextual information needed to process the transaction but not signed, either because it's already indirectly signed by signing the transaction, or because it doesn't impact the ledger state
+ +
+ +
+
+ max_record_time + uint64 + +
+ +
Maximum timestamp at which the transaction can be recorded onto the ledger via the synchronizer `synchronizer_id`. If submitted after it will be rejected even if otherwise valid, in which case it needs to be prepared and signed again with a new valid max_record_time. Unsigned in 3.3 to avoid a breaking protocol change Will be signed in 3.4+ Set max_record_time in the PreparedTransactionRequest to get this field set accordingly
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ act_as + repeated string + +
+ +
+ +
+
+ command_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ key + GlobalKey + +
+ +
+ +
+
+ value + Value + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ template_id + Identifier + +
+ +
The identifier uses the package-id reference format.
+ +
+ +
+
+ package_name + string + +
+ +
+ +
+
+ key + Value + +
+ +
+ +
+
+ hash + bytes + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ v1 + Create + +
+ +
When new versions will be added, they will show here
+ +
+ +
+
+ created_at + uint64 + +
+ +
+ +
+
+ event_blob + bytes + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ signatures + repeated SinglePartySignatures + +
+ +
Additional signatures provided by all individual parties Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ party + string + +
+ +
Submitting party Required
+ +
+ +
+
+ signatures + repeated Signature + +
+ +
Signatures Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ format + SignatureFormat + +
+ +
+ +
+
+ signature + bytes + +
+ +
+ +
+
+ signed_by + string + +
+ +
The fingerprint/id of the keypair used to create this signature and needed to verify.
+ +
+ +
+
+ signing_algorithm_spec + SigningAlgorithmSpec + +
+ +
The signing algorithm specification used to produce this signature
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • SIGNATURE_FORMAT_UNSPECIFIED
    • + +
  • SIGNATURE_FORMAT_RAW
    • + +
  • SIGNATURE_FORMAT_DER
    • + +
  • SIGNATURE_FORMAT_CONCAT
    • + +
  • SIGNATURE_FORMAT_SYMBOLIC
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_ALGORITHM_SPEC_UNSPECIFIED
    • + +
  • SIGNING_ALGORITHM_SPEC_ED25519
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_256
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_384
    • + +
+ + +
+ + + +
+ + + +
    + +
  • HASHING_SCHEME_VERSION_UNSPECIFIED
    • + +
  • HASHING_SCHEME_VERSION_V2
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ min_ledger_time_abs + Timestamp + +
+ +
Lower bound for the ledger time assigned to the resulting transaction. The ledger time of a transaction is assigned as part of command interpretation. Important note: for interactive submissions, if the transaction depends on time, it **must** be signed and submitted within a time window around the ledger time assigned to the transaction during the prepare method. The time delta around that ledger time is a configuration of the ledger, usually short, around 1 minute. If however the transaction does not depend on time, the available time window to sign and submit the transaction is bound by the preparation time, which is also assigned in the "prepare" step (this request), but can be configured with a much larger skew, allowing for more time to sign the request (in the order of hours). Must not be set at the same time as min_ledger_time_rel. Optional
+ +
+ +
+
+ min_ledger_time_rel + Duration + +
+ +
Same as min_ledger_time_abs, but specified as a duration, starting from the time this request is received by the server. Must not be set at the same time as min_ledger_time_abs. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ event_format + EventFormat + +
+ +
Required
+ +
+ +
+
+ transaction_shape + TransactionShape + +
+ +
What transaction shape to use for interpreting the filters of the event format. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ filters_by_party + repeated map + +
+ +
Each key must be a valid PartyIdString (as described in ``value.proto``). The interpretation of the filter depends on the transaction-shape being filtered: 1. For **ledger-effects** create and exercise events are returned, for which the witnesses include at least one of the listed parties and match the per-party filter. 2. For **transaction and active-contract-set streams** create and archive events are returned for all contracts whose stakeholders include at least one of the listed parties and match the per-party filter. Optional
+ +
+ +
+
+ filters_for_any_party + Filters + +
+ +
Wildcard filters that apply to all the parties existing on the participant. The interpretation of the filters is the same with the per-party filter as described above. Optional
+ +
+ +
+
+ verbose + bool + +
+ +
If enabled, values served over the API will contain more information than strictly necessary to interpret the data. In particular, setting the verbose flag to true triggers the ledger to include labels for record fields. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ cumulative + repeated CumulativeFilter + +
+ +
Every filter in the cumulative list expands the scope of the resulting stream. Each interface, template or wildcard filter means additional events that will match the query. The impact of include_interface_view and include_created_event_blob fields in the filters will also be accumulated. A template or an interface SHOULD NOT appear twice in the accumulative field. A wildcard filter SHOULD NOT be defined more than once in the accumulative field. Optional, if no ``CumulativeFilter`` defined, the default of a single ``WildcardFilter`` with include_created_event_blob unset is used.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ wildcard_filter + WildcardFilter + +
+ +
A wildcard filter that matches all templates Optional
+ +
+ +
+
+ interface_filter + InterfaceFilter + +
+ +
Include an ``InterfaceView`` for every ``InterfaceFilter`` matching a contract. The ``InterfaceFilter`` instances MUST each use a unique ``interface_id``. Optional
+ +
+ +
+
+ template_filter + TemplateFilter + +
+ +
A template for which the data will be included in the ``create_arguments`` of a matching ``CreatedEvent``. If a contract is simultaneously selected by a template filter and one or more interface filters, the corresponding ``include_created_event_blob`` are consolidated using an OR operation. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ include_created_event_blob + bool + +
+ +
Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``. Use this to access the contract create event payload in your API client for submitting it as a disclosed contract with future commands. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ interface_id + Identifier + +
+ +
The interface that a matching contract must implement. The ``interface_id`` needs to be valid: corresponding interface should be defined in one of the available packages at the time of the query. Both package-name and package-id reference formats for the identifier are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ include_interface_view + bool + +
+ +
Whether to include the interface view on the contract in the returned ``CreatedEvent``. Use this to access contract data in a uniform manner in your API client. Optional
+ +
+ +
+
+ include_created_event_blob + bool + +
+ +
Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``. Use this to access the contract create event payload in your API client for submitting it as a disclosed contract with future commands. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ template_id + Identifier + +
+ +
A template for which the payload should be included in the response. The ``template_id`` needs to be valid: corresponding template should be defined in one of the available packages at the time of the query. Both package-name and package-id reference formats for the identifier are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ include_created_event_blob + bool + +
+ +
Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``. Use this to access the contract event payload in your API client for submitting it as a disclosed contract with future commands. Optional
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • TRANSACTION_SHAPE_UNSPECIFIED
    • + +
  • TRANSACTION_SHAPE_ACS_DELTA
    • + +
  • TRANSACTION_SHAPE_LEDGER_EFFECTS
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ transaction + Transaction + +
+ +
The transaction that resulted from the submitted command. The transaction might contain no events (request conditions result in filtering out all of them). Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ update_id + string + +
+ +
Assigned by the server. Useful for correlating logs. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ command_id + string + +
+ +
The ID of the command which resulted in this transaction. Missing for everyone except the submitting party. Must be a valid LedgerString (as described in ``value.proto``). Optional
+ +
+ +
+
+ workflow_id + string + +
+ +
The workflow ID used in command submission. Must be a valid LedgerString (as described in ``value.proto``). Optional
+ +
+ +
+
+ effective_at + Timestamp + +
+ +
Ledger effective time. Required
+ +
+ +
+
+ events + repeated Event + +
+ +
The collection of events. Contains: - ``CreatedEvent`` or ``ArchivedEvent`` in case of ACS_DELTA transaction shape - ``CreatedEvent`` or ``ExercisedEvent`` in case of LEDGER_EFFECTS transaction shape Required
+ +
+ +
+
+ offset + int64 + +
+ +
The absolute offset. The details of this field are described in ``community/ledger-api/README.md``. Required, it is a valid absolute offset (positive integer).
+ +
+ +
+
+ synchronizer_id + string + +
+ +
A valid synchronizer id. Identifies the synchronizer that synchronized the transaction. Required
+ +
+ +
+
+ trace_context + TraceContext + +
+ +
Optional; ledger API trace context The trace context transported in this message corresponds to the trace context supplied by the client application in a HTTP2 header of the original command submission. We typically use a header to transfer this type of information. Here we use message body, because it is used in gRPC streams which do not support per message headers. This field will be populated with the trace context contained in the original submission. If that was not provided, a unique ledger-api-server generated trace context will be used instead.
+ +
+ +
+
+ record_time + Timestamp + +
+ +
The time at which the transaction was recorded. The record time refers to the synchronizer which synchronized the transaction. Required
+ +
+ +
+
+ external_transaction_hash + bytes + +
+ +
For transaction externally signed, contains the external transaction hash signed by the external party. Can be used to correlate an external submission with a committed transaction. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ created + CreatedEvent + +
+ +
The event as it appeared in the context of its original daml transaction on this participant node. In particular, the offset, node_id pair of the daml transaction are preserved.
+ +
+ +
+
+ archived + ArchivedEvent + +
+ +
+ +
+
+ exercised + ExercisedEvent + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ offset + int64 + +
+ +
The offset of origin, which has contextual meaning, please see description at messages that include a CreatedEvent. Offsets are managed by the participant nodes. Transactions can thus NOT be assumed to have the same offsets on different participant nodes. Required, it is a valid absolute offset (positive integer)
+ +
+ +
+
+ node_id + int32 + +
+ +
The position of this event in the originating transaction or reassignment. The origin has contextual meaning, please see description at messages that include a CreatedEvent. Node IDs are not necessarily equal across participants, as these may see different projections/parts of transactions. Required, must be valid node ID (non-negative integer)
+ +
+ +
+
+ contract_id + string + +
+ +
The ID of the created contract. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ template_id + Identifier + +
+ +
The template of the created contract. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ contract_key + Value + +
+ +
The key of the created contract. This will be set if and only if ``template_id`` defines a contract key. Optional
+ +
+ +
+
+ create_arguments + Record + +
+ +
The arguments that have been used to create the contract. Required
+ +
+ +
+
+ created_event_blob + bytes + +
+ +
Opaque representation of contract create event payload intended for forwarding to an API server as a contract disclosed as part of a command submission. Optional
+ +
+ +
+
+ interface_views + repeated InterfaceView + +
+ +
Interface views specified in the transaction filter. Includes an ``InterfaceView`` for each interface for which there is a ``InterfaceFilter`` with - its party in the ``witness_parties`` of this event, - and which is implemented by the template of this event, - and which has ``include_interface_view`` set. Optional
+ +
+ +
+
+ witness_parties + repeated string + +
+ +
The parties that are notified of this event. When a ``CreatedEvent`` is returned as part of a transaction tree or ledger-effects transaction, this will include all the parties specified in the ``TransactionFilter`` that are witnesses of the event (the stakeholders of the contract and all informees of all the ancestors of this create action that this participant knows about). If served as part of a ACS delta transaction those will be limited to all parties specified in the ``TransactionFilter`` that are stakeholders of the contract (i.e. either signatories or observers). If the ``CreatedEvent`` is returned as part of an AssignedEvent, ActiveContract or IncompleteUnassigned (so the event is related to an assignment or unassignment): this will include all parties of the ``TransactionFilter`` that are stakeholders of the contract. The behavior of reading create events visible to parties not hosted on the participant node serving the Ledger API is undefined. Concretely, there is neither a guarantee that the participant node will serve all their create events on the ACS stream, nor is there a guarantee that matching archive events are delivered for such create events. For most clients this is not a problem, as they only read events for parties that are hosted on the participant node. If you need to read events for parties that may not be hosted at all times on the participant node, subscribe to the ``TopologyEvent``s for that party by setting a corresponding ``UpdateFormat``. Using these events, query the ACS as-of an offset where the party is hosted on the participant node, and ignore create events at offsets where the party is not hosted on the participant node. Required
+ +
+ +
+
+ signatories + repeated string + +
+ +
The signatories for this contract as specified by the template. Required
+ +
+ +
+
+ observers + repeated string + +
+ +
The observers for this contract as specified explicitly by the template or implicitly as choice controllers. This field never contains parties that are signatories. Required
+ +
+ +
+
+ created_at + Timestamp + +
+ +
Ledger effective time of the transaction that created the contract. Required
+ +
+ +
+
+ package_name + string + +
+ +
The package name of the created contract. Required
+ +
+ +
+
+ acs_delta + bool + +
+ +
Whether this event would be part of respective ACS_DELTA shaped stream, and should therefore considered when tracking contract activeness on the client-side. Required
+ +
+ +
+
+ representative_package_id + string + +
+ +
A package-id present in the participant package store that typechecks the contract's argument. This may differ from the package-id of the template used to create the contract. For contracts created before Canton 3.4, this field matches the contract's creation package-id. NOTE: Experimental, server internal concept, not for client consumption. Subject to change without notice. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ interface_id + Identifier + +
+ +
The interface implemented by the matched event. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ view_status + Status + +
+ +
Whether the view was successfully computed, and if not, the reason for the error. The error is reported using the same rules for error codes and messages as the errors returned for API requests. Required
+ +
+ +
+
+ view_value + Record + +
+ +
The value of the interface's view method on this event. Set if it was requested in the ``InterfaceFilter`` and it could be successfully computed. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ offset + int64 + +
+ +
The offset of origin. Offsets are managed by the participant nodes. Transactions can thus NOT be assumed to have the same offsets on different participant nodes. Required, it is a valid absolute offset (positive integer)
+ +
+ +
+
+ node_id + int32 + +
+ +
The position of this event in the originating transaction or reassignment. Node IDs are not necessarily equal across participants, as these may see different projections/parts of transactions. Required, must be valid node ID (non-negative integer)
+ +
+ +
+
+ contract_id + string + +
+ +
The ID of the archived contract. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ template_id + Identifier + +
+ +
Identifies the template that defines the choice that archived the contract. This template's package-id may differ from the target contract's package-id if the target contract has been upgraded or downgraded. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ witness_parties + repeated string + +
+ +
The parties that are notified of this event. For an ``ArchivedEvent``, these are the intersection of the stakeholders of the contract in question and the parties specified in the ``TransactionFilter``. The stakeholders are the union of the signatories and the observers of the contract. Each one of its elements must be a valid PartyIdString (as described in ``value.proto``). Required
+ +
+ +
+
+ package_name + string + +
+ +
The package name of the contract. Required
+ +
+ +
+
+ implemented_interfaces + repeated Identifier + +
+ +
The interfaces implemented by the target template that have been matched from the interface filter query. Populated only in case interface filters with include_interface_view set. If defined, the identifier uses the package-id reference format. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ offset + int64 + +
+ +
The offset of origin. Offsets are managed by the participant nodes. Transactions can thus NOT be assumed to have the same offsets on different participant nodes. Required, it is a valid absolute offset (positive integer)
+ +
+ +
+
+ node_id + int32 + +
+ +
The position of this event in the originating transaction or reassignment. Node IDs are not necessarily equal across participants, as these may see different projections/parts of transactions. Required, must be valid node ID (non-negative integer)
+ +
+ +
+
+ contract_id + string + +
+ +
The ID of the target contract. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ template_id + Identifier + +
+ +
Identifies the template that defines the executed choice. This template's package-id may differ from the target contract's package-id if the target contract has been upgraded or downgraded. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ interface_id + Identifier + +
+ +
The interface where the choice is defined, if inherited. If defined, the identifier uses the package-id reference format. Optional
+ +
+ +
+
+ choice + string + +
+ +
The choice that was exercised on the target contract. Must be a valid NameString (as described in ``value.proto``). Required
+ +
+ +
+
+ choice_argument + Value + +
+ +
The argument of the exercised choice. Required
+ +
+ +
+
+ acting_parties + repeated string + +
+ +
The parties that exercised the choice. Each element must be a valid PartyIdString (as described in ``value.proto``). Required
+ +
+ +
+
+ consuming + bool + +
+ +
If true, the target contract may no longer be exercised. Required
+ +
+ +
+
+ witness_parties + repeated string + +
+ +
The parties that are notified of this event. The witnesses of an exercise node will depend on whether the exercise was consuming or not. If consuming, the witnesses are the union of the stakeholders, the actors and all informees of all the ancestors of this event this participant knows about. If not consuming, the witnesses are the union of the signatories, the actors and all informees of all the ancestors of this event this participant knows about. In both cases the witnesses are limited to the querying parties, or not limited in case anyParty filters are used. Note that the actors might not necessarily be observers and thus stakeholders. This is the case when the controllers of a choice are specified using "flexible controllers", using the ``choice ... controller`` syntax, and said controllers are not explicitly marked as observers. Each element must be a valid PartyIdString (as described in ``value.proto``). Required
+ +
+ +
+
+ last_descendant_node_id + int32 + +
+ +
Specifies the upper boundary of the node ids of the events in the same transaction that appeared as a result of this ``ExercisedEvent``. This allows unambiguous identification of all the members of the subtree rooted at this node. A full subtree can be constructed when all descendant nodes are present in the stream. If nodes are heavily filtered, it is only possible to determine if a node is in a consequent subtree or not. Required
+ +
+ +
+
+ exercise_result + Value + +
+ +
The result of exercising the choice. Required
+ +
+ +
+
+ package_name + string + +
+ +
The package name of the contract. Required
+ +
+ +
+
+ implemented_interfaces + repeated Identifier + +
+ +
If the event is consuming, the interfaces implemented by the target template that have been matched from the interface filter query. Populated only in case interface filters with include_interface_view set. The identifier uses the package-id reference format. Optional
+ +
+ +
+
+ acs_delta + bool + +
+ +
Whether this event would be part of respective ACS_DELTA shaped stream, and should therefore considered when tracking contract activeness on the client-side. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ traceparent + string + +
+ +
https://www.w3.org/TR/trace-context/
+ +
+ +
+
+ tracestate + string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/getpreferredpackages.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/getpreferredpackages.mdx new file mode 100644 index 0000000..a381627 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/getpreferredpackages.mdx @@ -0,0 +1,475 @@ +--- +title: "GetPreferredPackages" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2.interactive

+ + +

GetPreferredPackages

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.interactive.InteractiveSubmissionService/GetPreferredPackages + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.interactive.InteractiveSubmissionService/GetPreferredPackages <<'EOF' +{ + "packageVettingRequirements": [ + { + "parties": [ + "string" + ], + "packageName": "string" + } + ], + "synchronizerId": "string", + "vettingValidAt": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "packageReferences": [ + { + "packageId": "string", + "packageName": "string", + "packageVersion": "string" + } + ], + "synchronizerId": "string" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
InteractiveSubmissionService
+
+ +
+
RPC
+
GetPreferredPackages
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetPreferredPackagesRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.interactive.GetPreferredPackagesRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ package_vetting_requirements + repeated PackageVettingRequirement + +
+ +
The package-name vetting requirements for which the preferred packages should be resolved. Generally it is enough to provide the requirements for the intended command's root package-names. Additional package-name requirements can be provided when additional Daml transaction informees need to use package dependencies of the command's root packages. Required
+ +
+ +
+
+ synchronizer_id + string + +
+ +
The synchronizer whose vetting state should be used for resolving this query. If not specified, the vetting states of all synchronizers to which the participant is connected are used. Optional
+ +
+ +
+
+ vetting_valid_at + Timestamp + +
+ +
The timestamp at which the package vetting validity should be computed on the latest topology snapshot as seen by the participant. If not provided, the participant's current clock time is used. Optional
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

GetPreferredPackagesResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.interactive.GetPreferredPackagesResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ package_references + repeated PackageReference + +
+ +
The package references of the preferred packages. Must contain one package reference for each requested package-name. If you build command submissions whose content depends on the returned preferred packages, then we recommend submitting the preferred package-ids in the ``package_id_selection_preference`` of the command submission to avoid race conditions with concurrent changes of the on-ledger package vetting state. Required
+ +
+ +
+
+ synchronizer_id + string + +
+ +
The synchronizer for which the package preferences are computed. If the synchronizer_id was specified in the request, then it matches the request synchronizer_id. Required
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ package_vetting_requirements + repeated PackageVettingRequirement + +
+ +
The package-name vetting requirements for which the preferred packages should be resolved. Generally it is enough to provide the requirements for the intended command's root package-names. Additional package-name requirements can be provided when additional Daml transaction informees need to use package dependencies of the command's root packages. Required
+ +
+ +
+
+ synchronizer_id + string + +
+ +
The synchronizer whose vetting state should be used for resolving this query. If not specified, the vetting states of all synchronizers to which the participant is connected are used. Optional
+ +
+ +
+
+ vetting_valid_at + Timestamp + +
+ +
The timestamp at which the package vetting validity should be computed on the latest topology snapshot as seen by the participant. If not provided, the participant's current clock time is used. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ parties + repeated string + +
+ +
The parties whose participants' vetting state should be considered when resolving the preferred package. Required
+ +
+ +
+
+ package_name + string + +
+ +
The package-name for which the preferred package should be resolved. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ package_references + repeated PackageReference + +
+ +
The package references of the preferred packages. Must contain one package reference for each requested package-name. If you build command submissions whose content depends on the returned preferred packages, then we recommend submitting the preferred package-ids in the ``package_id_selection_preference`` of the command submission to avoid race conditions with concurrent changes of the on-ledger package vetting state. Required
+ +
+ +
+
+ synchronizer_id + string + +
+ +
The synchronizer for which the package preferences are computed. If the synchronizer_id was specified in the request, then it matches the request synchronizer_id. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ package_id + string + +
+ +
Required
+ +
+ +
+
+ package_name + string + +
+ +
Required
+ +
+ +
+
+ package_version + string + +
+ +
Required
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/getpreferredpackageversion.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/getpreferredpackageversion.mdx new file mode 100644 index 0000000..b9a7e82 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/getpreferredpackageversion.mdx @@ -0,0 +1,471 @@ +--- +title: "GetPreferredPackageVersion" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2.interactive

+ + +

GetPreferredPackageVersion

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.interactive.InteractiveSubmissionService/GetPreferredPackageVersion + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.interactive.InteractiveSubmissionService/GetPreferredPackageVersion <<'EOF' +{ + "parties": [ + "string" + ], + "packageName": "string", + "synchronizerId": "string", + "vettingValidAt": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "packagePreference": { + "packageReference": { + "packageId": "string", + "packageName": "string", + "packageVersion": "string" + }, + "synchronizerId": "string" + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
InteractiveSubmissionService
+
+ +
+
RPC
+
GetPreferredPackageVersion
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetPreferredPackageVersionRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.interactive.GetPreferredPackageVersionRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ parties + repeated string + +
+ +
The parties whose participants' vetting state should be considered when resolving the preferred package. Required
+ +
+ +
+
+ package_name + string + +
+ +
The package-name for which the preferred package should be resolved. Required
+ +
+ +
+
+ synchronizer_id + string + +
+ +
The synchronizer whose vetting state should be used for resolving this query. If not specified, the vetting states of all synchronizers to which the participant is connected are used. Optional
+ +
+ +
+
+ vetting_valid_at + Timestamp + +
+ +
The timestamp at which the package vetting validity should be computed on the latest topology snapshot as seen by the participant. If not provided, the participant's current clock time is used. Optional
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

GetPreferredPackageVersionResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.interactive.GetPreferredPackageVersionResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ package_preference + PackagePreference + +
+ +
Not populated when no preferred package is found Optional
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ parties + repeated string + +
+ +
The parties whose participants' vetting state should be considered when resolving the preferred package. Required
+ +
+ +
+
+ package_name + string + +
+ +
The package-name for which the preferred package should be resolved. Required
+ +
+ +
+
+ synchronizer_id + string + +
+ +
The synchronizer whose vetting state should be used for resolving this query. If not specified, the vetting states of all synchronizers to which the participant is connected are used. Optional
+ +
+ +
+
+ vetting_valid_at + Timestamp + +
+ +
The timestamp at which the package vetting validity should be computed on the latest topology snapshot as seen by the participant. If not provided, the participant's current clock time is used. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ package_preference + PackagePreference + +
+ +
Not populated when no preferred package is found Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ package_reference + PackageReference + +
+ +
The package reference of the preferred package. Required
+ +
+ +
+
+ synchronizer_id + string + +
+ +
The synchronizer for which the preferred package was computed. If the synchronizer_id was specified in the request, then it matches the request synchronizer_id. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ package_id + string + +
+ +
Required
+ +
+ +
+
+ package_name + string + +
+ +
Required
+ +
+ +
+
+ package_version + string + +
+ +
Required
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/preparesubmission.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/preparesubmission.mdx new file mode 100644 index 0000000..dac04f2 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/preparesubmission.mdx @@ -0,0 +1,2059 @@ +--- +title: "PrepareSubmission" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2.interactive

+ + +

PrepareSubmission

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.interactive.InteractiveSubmissionService/PrepareSubmission + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.interactive.InteractiveSubmissionService/PrepareSubmission <<'EOF' +{ + "userId": "string", + "commandId": "string", + "commands": [ + { + "create": { + "templateId": "string", + "createArguments": "string" + } + } + ], + "minLedgerTime": { + "minLedgerTimeAbs": "string" + }, + "maxRecordTime": "string", + "actAs": [ + "string" + ], + "readAs": [ + "string" + ], + "disclosedContracts": [ + { + "templateId": "string", + "contractId": "string", + "createdEventBlob": "BASE64_ENCODED_BYTES", + "synchronizerId": "string" + } + ] +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "preparedTransaction": { + "transaction": { + "version": "string", + "roots": [ + "string" + ], + "nodes": [ + { + "nodeId": "string", + "v1": {} + } + ], + "nodeSeeds": [ + { + "nodeId": 0, + "seed": "BASE64_ENCODED_BYTES" + } + ] + }, + "metadata": { + "submitterInfo": { + "actAs": [ + "string" + ], + "commandId": "string" + }, + "synchronizerId": "string", + "mediatorGroup": 0, + "transactionUuid": "string", + "preparationTime": "0", + "inputContracts": [ + { + "v1": {}, + "createdAt": "0", + "eventBlob": "BASE64_ENCODED_BYTES" + } + ], + "minLedgerEffectiveTime": "0", + "maxLedgerEffectiveTime": "0" + } + }, + "preparedTransactionHash": "BASE64_ENCODED_BYTES", + "hashingSchemeVersion": "HASHING_SCHEME_VERSION_UNSPECIFIED", + "hashingDetails": "string", + "costEstimation": { + "estimationTimestamp": "string", + "confirmationRequestTrafficCostEstimation": "0", + "confirmationResponseTrafficCostEstimation": "0", + "totalTrafficCostEstimation": "0" + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
InteractiveSubmissionService
+
+ +
+
RPC
+
PrepareSubmission
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

PrepareSubmissionRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.interactive.PrepareSubmissionRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ user_id + string + +
+ +
Uniquely identifies the participant user that prepares the transaction. Must be a valid UserIdString (as described in ``value.proto``). Required unless authentication is used with a user token. In that case, the token's user-id will be used for the request's user_id. Optional
+ +
+ +
+
+ command_id + string + +
+ +
Uniquely identifies the command. The triple (user_id, act_as, command_id) constitutes the change ID for the intended ledger change, where act_as is interpreted as a set of party names. The change ID can be used for matching the intended ledger changes with all their completions. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ commands + repeated Command + +
+ +
Individual elements of this atomic command. Must be non-empty. Limitation: Only single command transaction are currently supported by the API. The field is marked as repeated in preparation for future support of multiple commands. Required
+ +
+ +
+
+ min_ledger_time + MinLedgerTime + +
+ +
Optional
+ +
+ +
+
+ max_record_time + Timestamp + +
+ +
Maximum timestamp at which the transaction can be recorded onto the ledger via the synchronizer specified in the `PrepareSubmissionResponse`. If submitted after it will be rejected even if otherwise valid, in which case it needs to be prepared and signed again with a new valid max_record_time. Use this to limit the time-to-life of a prepared transaction, which is useful to know when it can definitely not be accepted anymore and resorting to preparing another transaction for the same intent is safe again. Optional
+ +
+ +
+
+ act_as + repeated string + +
+ +
Set of parties on whose behalf the command should be executed, if submitted. If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request to **read** (not act) on behalf of each of the given parties. This is because this RPC merely prepares a transaction and does not execute it. Therefore read authorization is sufficient even for actAs parties. Note: This may change, and more specific authorization scope may be introduced in the future. Each element must be a valid PartyIdString (as described in ``value.proto``). Required, must be non-empty.
+ +
+ +
+
+ read_as + repeated string + +
+ +
Set of parties on whose behalf (in addition to all parties listed in ``act_as``) contracts can be retrieved. This affects Daml operations such as ``fetch``, ``fetchByKey``, ``lookupByKey``, ``exercise``, and ``exerciseByKey``. Note: A command can only use contracts that are visible to at least one of the parties in ``act_as`` or ``read_as``. This visibility check is independent from the Daml authorization rules for fetch operations. If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request to read contract data on behalf of each of the given parties. Optional
+ +
+ +
+
+ disclosed_contracts + repeated DisclosedContract + +
+ +
Additional contracts used to resolve contract & contract key lookups. Optional
+ +
+ +
+
+ synchronizer_id + string + +
+ +
Must be a valid synchronizer id If not set, a suitable synchronizer that this node is connected to will be chosen Optional
+ +
+ +
+
+ package_id_selection_preference + repeated string + +
+ +
The package-id selection preference of the client for resolving package names and interface instances in command submission and interpretation Optional
+ +
+ +
+
+ verbose_hashing + bool + +
+ +
When true, the response will contain additional details on how the transaction was encoded and hashed This can be useful for troubleshooting of hash mismatches. Should only be used for debugging. Optional, default to false
+ +
+ +
+
+ prefetch_contract_keys + repeated PrefetchContractKey + +
+ +
Fetches the contract keys into the caches to speed up the command processing. Should only contain contract keys that are expected to be resolved during interpretation of the commands. Keys of disclosed contracts do not need prefetching. Optional
+ +
+ +
+
+ estimate_traffic_cost + CostEstimationHints + +
+ +
Hints to improve the accuracy of traffic cost estimation. The estimation logic assumes that this node will be used for the execution of the transaction If another node is used instead, the estimation may be less precise. Request amplification is not accounted for in the estimation: each amplified request will result in the cost of the confirmation request to be charged additionally. Optional - Traffic cost estimation is enabled by default if this field is not set To turn off cost estimation, set the CostEstimationHints#disabled field to true
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

PrepareSubmissionResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.interactive.PrepareSubmissionResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ prepared_transaction + PreparedTransaction + +
+ +
The interpreted transaction, it represents the ledger changes necessary to execute the commands specified in the request. 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.
+ +
+ +
+
+ prepared_transaction_hash + bytes + +
+ +
Hash of the transaction, this is what needs to be signed by the party to authorize the transaction. Only provided for convenience, clients MUST recompute the hash from the raw transaction if the preparing participant is not trusted. May be removed in future versions
+ +
+ +
+
+ hashing_scheme_version + HashingSchemeVersion + +
+ +
The hashing scheme version used when building the hash
+ +
+ +
+
+ hashing_details + string + +
+ +
Optional additional details on how the transaction was encoded and hashed. Only set if verbose_hashing = true in the request Note that there are no guarantees on the stability of the format or content of this field. Its content should NOT be parsed and should only be used for troubleshooting purposes.
+ +
+ +
+
+ cost_estimation + CostEstimation + +
+ +
Traffic cost estimation of the prepared transaction Optional
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ user_id + string + +
+ +
Uniquely identifies the participant user that prepares the transaction. Must be a valid UserIdString (as described in ``value.proto``). Required unless authentication is used with a user token. In that case, the token's user-id will be used for the request's user_id. Optional
+ +
+ +
+
+ command_id + string + +
+ +
Uniquely identifies the command. The triple (user_id, act_as, command_id) constitutes the change ID for the intended ledger change, where act_as is interpreted as a set of party names. The change ID can be used for matching the intended ledger changes with all their completions. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ commands + repeated Command + +
+ +
Individual elements of this atomic command. Must be non-empty. Limitation: Only single command transaction are currently supported by the API. The field is marked as repeated in preparation for future support of multiple commands. Required
+ +
+ +
+
+ min_ledger_time + MinLedgerTime + +
+ +
Optional
+ +
+ +
+
+ max_record_time + Timestamp + +
+ +
Maximum timestamp at which the transaction can be recorded onto the ledger via the synchronizer specified in the `PrepareSubmissionResponse`. If submitted after it will be rejected even if otherwise valid, in which case it needs to be prepared and signed again with a new valid max_record_time. Use this to limit the time-to-life of a prepared transaction, which is useful to know when it can definitely not be accepted anymore and resorting to preparing another transaction for the same intent is safe again. Optional
+ +
+ +
+
+ act_as + repeated string + +
+ +
Set of parties on whose behalf the command should be executed, if submitted. If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request to **read** (not act) on behalf of each of the given parties. This is because this RPC merely prepares a transaction and does not execute it. Therefore read authorization is sufficient even for actAs parties. Note: This may change, and more specific authorization scope may be introduced in the future. Each element must be a valid PartyIdString (as described in ``value.proto``). Required, must be non-empty.
+ +
+ +
+
+ read_as + repeated string + +
+ +
Set of parties on whose behalf (in addition to all parties listed in ``act_as``) contracts can be retrieved. This affects Daml operations such as ``fetch``, ``fetchByKey``, ``lookupByKey``, ``exercise``, and ``exerciseByKey``. Note: A command can only use contracts that are visible to at least one of the parties in ``act_as`` or ``read_as``. This visibility check is independent from the Daml authorization rules for fetch operations. If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request to read contract data on behalf of each of the given parties. Optional
+ +
+ +
+
+ disclosed_contracts + repeated DisclosedContract + +
+ +
Additional contracts used to resolve contract & contract key lookups. Optional
+ +
+ +
+
+ synchronizer_id + string + +
+ +
Must be a valid synchronizer id If not set, a suitable synchronizer that this node is connected to will be chosen Optional
+ +
+ +
+
+ package_id_selection_preference + repeated string + +
+ +
The package-id selection preference of the client for resolving package names and interface instances in command submission and interpretation Optional
+ +
+ +
+
+ verbose_hashing + bool + +
+ +
When true, the response will contain additional details on how the transaction was encoded and hashed This can be useful for troubleshooting of hash mismatches. Should only be used for debugging. Optional, default to false
+ +
+ +
+
+ prefetch_contract_keys + repeated PrefetchContractKey + +
+ +
Fetches the contract keys into the caches to speed up the command processing. Should only contain contract keys that are expected to be resolved during interpretation of the commands. Keys of disclosed contracts do not need prefetching. Optional
+ +
+ +
+
+ estimate_traffic_cost + CostEstimationHints + +
+ +
Hints to improve the accuracy of traffic cost estimation. The estimation logic assumes that this node will be used for the execution of the transaction If another node is used instead, the estimation may be less precise. Request amplification is not accounted for in the estimation: each amplified request will result in the cost of the confirmation request to be charged additionally. Optional - Traffic cost estimation is enabled by default if this field is not set To turn off cost estimation, set the CostEstimationHints#disabled field to true
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ create + CreateCommand + +
+ +
+ +
+
+ exercise + ExerciseCommand + +
+ +
+ +
+
+ exercise_by_key + ExerciseByKeyCommand + +
+ +
+ +
+
+ create_and_exercise + CreateAndExerciseCommand + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template of contract the client wants to create. Both package-name and package-id reference identifier formats for the template-id are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ create_arguments + Record + +
+ +
The arguments required for creating a contract from this template. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template or interface of the contract the client wants to exercise. Both package-name and package-id reference identifier formats for the template-id are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. To exercise a choice on an interface, specify the interface identifier in the template_id field. Required
+ +
+ +
+
+ contract_id + string + +
+ +
The ID of the contract the client wants to exercise upon. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ choice + string + +
+ +
The name of the choice the client wants to exercise. Must be a valid NameString (as described in ``value.proto``) Required
+ +
+ +
+
+ choice_argument + Value + +
+ +
The argument for this choice. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template of contract the client wants to exercise. Both package-name and package-id reference identifier formats for the template-id are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ contract_key + Value + +
+ +
The key of the contract the client wants to exercise upon. Required
+ +
+ +
+
+ choice + string + +
+ +
The name of the choice the client wants to exercise. Must be a valid NameString (as described in ``value.proto``) Required
+ +
+ +
+
+ choice_argument + Value + +
+ +
The argument for this choice. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template of the contract the client wants to create. Both package-name and package-id reference identifier formats for the template-id are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ create_arguments + Record + +
+ +
The arguments required for creating a contract from this template. Required
+ +
+ +
+
+ choice + string + +
+ +
The name of the choice the client wants to exercise. Must be a valid NameString (as described in ``value.proto``). Required
+ +
+ +
+
+ choice_argument + Value + +
+ +
The argument for this choice. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ min_ledger_time_abs + Timestamp + +
+ +
Lower bound for the ledger time assigned to the resulting transaction. The ledger time of a transaction is assigned as part of command interpretation. Important note: for interactive submissions, if the transaction depends on time, it **must** be signed and submitted within a time window around the ledger time assigned to the transaction during the prepare method. The time delta around that ledger time is a configuration of the ledger, usually short, around 1 minute. If however the transaction does not depend on time, the available time window to sign and submit the transaction is bound by the preparation time, which is also assigned in the "prepare" step (this request), but can be configured with a much larger skew, allowing for more time to sign the request (in the order of hours). Must not be set at the same time as min_ledger_time_rel. Optional
+ +
+ +
+
+ min_ledger_time_rel + Duration + +
+ +
Same as min_ledger_time_abs, but specified as a duration, starting from the time this request is received by the server. Must not be set at the same time as min_ledger_time_abs. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template id of the contract. The identifier uses the package-id reference format. If provided, used to validate the template id of the contract serialized in the created_event_blob. Optional
+ +
+ +
+
+ contract_id + string + +
+ +
The contract id If provided, used to validate the contract id of the contract serialized in the created_event_blob. Optional
+ +
+ +
+
+ created_event_blob + bytes + +
+ +
Opaque byte string containing the complete payload required by the Daml engine to reconstruct a contract not known to the receiving participant. Required
+ +
+ +
+
+ synchronizer_id + string + +
+ +
The ID of the synchronizer where the contract is currently assigned Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template of contract the client wants to prefetch. Both package-name and package-id reference identifier formats for the template-id are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ contract_key + Value + +
+ +
The key of the contract the client wants to prefetch. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ disabled + bool + +
+ +
Disable cost estimation Default (not set) is false
+ +
+ +
+
+ expected_signatures + repeated SigningAlgorithmSpec + +
+ +
Details on the keys that will be used to sign the transaction (how many and of which type). Signature size impacts the cost of the transaction. If empty, the signature sizes will be approximated with threshold-many signatures (where threshold is defined in the PartyToKeyMapping of the external party), using keys in the order they are registered. Optional (empty list is equivalent to not providing this field)
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • SIGNING_ALGORITHM_SPEC_UNSPECIFIED
    • + +
  • SIGNING_ALGORITHM_SPEC_ED25519
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_256
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_384
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ prepared_transaction + PreparedTransaction + +
+ +
The interpreted transaction, it represents the ledger changes necessary to execute the commands specified in the request. 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.
+ +
+ +
+
+ prepared_transaction_hash + bytes + +
+ +
Hash of the transaction, this is what needs to be signed by the party to authorize the transaction. Only provided for convenience, clients MUST recompute the hash from the raw transaction if the preparing participant is not trusted. May be removed in future versions
+ +
+ +
+
+ hashing_scheme_version + HashingSchemeVersion + +
+ +
The hashing scheme version used when building the hash
+ +
+ +
+
+ hashing_details + string + +
+ +
Optional additional details on how the transaction was encoded and hashed. Only set if verbose_hashing = true in the request Note that there are no guarantees on the stability of the format or content of this field. Its content should NOT be parsed and should only be used for troubleshooting purposes.
+ +
+ +
+
+ cost_estimation + CostEstimation + +
+ +
Traffic cost estimation of the prepared transaction Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ transaction + DamlTransaction + +
+ +
Daml Transaction representing the ledger effect if executed. See below
+ +
+ +
+
+ metadata + Metadata + +
+ +
Metadata context necessary to execute the transaction
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ version + string + +
+ +
serialization version, will be >= max(nodes version)
+ +
+ +
+
+ roots + repeated string + +
+ +
Root nodes of the transaction
+ +
+ +
+
+ nodes + repeated Node + +
+ +
List of nodes in the transaction
+ +
+ +
+
+ node_seeds + repeated NodeSeed + +
+ +
Node seeds are values associated with certain nodes used for generating cryptographic salts
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ node_id + int32 + +
+ +
+ +
+
+ seed + bytes + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ node_id + string + +
+ +
+ +
+
+ v1 + Node + +
+ +
Start at 1000 so we can add more fields before if necessary When new versions will be added, they will show here
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ create + Create + +
+ +
+ +
+
+ fetch + Fetch + +
+ +
+ +
+
+ exercise + Exercise + +
+ +
+ +
+
+ rollback + Rollback + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ lf_version + string + +
+ +
Specific LF version of the node
+ +
+ +
+
+ contract_id + string + +
+ +
+ +
+
+ package_name + string + +
+ +
+ +
+
+ template_id + Identifier + +
+ +
The identifier uses the package-id reference format.
+ +
+ +
+
+ argument + Value + +
+ +
+ +
+
+ signatories + repeated string + +
+ +
+ +
+
+ stakeholders + repeated string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ lf_version + string + +
+ +
Specific LF version of the node
+ +
+ +
+
+ contract_id + string + +
+ +
+ +
+
+ package_name + string + +
+ +
+ +
+
+ template_id + Identifier + +
+ +
The identifier uses the package-id reference format.
+ +
+ +
+
+ signatories + repeated string + +
+ +
+ +
+
+ stakeholders + repeated string + +
+ +
+ +
+
+ acting_parties + repeated string + +
+ +
+ +
+
+ interface_id + Identifier + +
+ +
Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ lf_version + string + +
+ +
Specific LF version of the node
+ +
+ +
+
+ contract_id + string + +
+ +
+ +
+
+ package_name + string + +
+ +
+ +
+
+ template_id + Identifier + +
+ +
The identifier uses the package-id reference format.
+ +
+ +
+
+ signatories + repeated string + +
+ +
+ +
+
+ stakeholders + repeated string + +
+ +
+ +
+
+ acting_parties + repeated string + +
+ +
+ +
+
+ interface_id + Identifier + +
+ +
The identifier uses the package-id reference format.
+ +
+ +
+
+ choice_id + string + +
+ +
+ +
+
+ chosen_value + Value + +
+ +
+ +
+
+ consuming + bool + +
+ +
+ +
+
+ children + repeated string + +
+ +
+ +
+
+ exercise_result + Value + +
+ +
+ +
+
+ choice_observers + repeated string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ children + repeated string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ submitter_info + SubmitterInfo + +
+ +
+ +
+
+ synchronizer_id + string + +
+ +
+ +
+
+ mediator_group + uint32 + +
+ +
+ +
+
+ transaction_uuid + string + +
+ +
+ +
+
+ preparation_time + uint64 + +
+ +
+ +
+
+ input_contracts + repeated InputContract + +
+ +
+ +
+
+ min_ledger_effective_time + uint64 + +
+ +
Where ledger time constraints are imposed during the execution of the contract they will be populated in the fields below. These are optional because if the transaction does NOT depend on time, these values do not need to be set. The final ledger effective time used will be chosen when the command is submitted through the [execute] RPC. If the ledger effective time is outside of any populated min/max bounds then a different transaction can result, that will cause a confirmation message rejection.
+ +
+ +
+
+ max_ledger_effective_time + uint64 + +
+ +
+ +
+
+ global_key_mapping + repeated GlobalKeyMappingEntry + +
+ +
********************************************************** ** Metadata information that does NOT need to be signed ** ********************************************************** Contextual information needed to process the transaction but not signed, either because it's already indirectly signed by signing the transaction, or because it doesn't impact the ledger state
+ +
+ +
+
+ max_record_time + uint64 + +
+ +
Maximum timestamp at which the transaction can be recorded onto the ledger via the synchronizer `synchronizer_id`. If submitted after it will be rejected even if otherwise valid, in which case it needs to be prepared and signed again with a new valid max_record_time. Unsigned in 3.3 to avoid a breaking protocol change Will be signed in 3.4+ Set max_record_time in the PreparedTransactionRequest to get this field set accordingly
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ act_as + repeated string + +
+ +
+ +
+
+ command_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ key + GlobalKey + +
+ +
+ +
+
+ value + Value + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ template_id + Identifier + +
+ +
The identifier uses the package-id reference format.
+ +
+ +
+
+ package_name + string + +
+ +
+ +
+
+ key + Value + +
+ +
+ +
+
+ hash + bytes + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ v1 + Create + +
+ +
When new versions will be added, they will show here
+ +
+ +
+
+ created_at + uint64 + +
+ +
+ +
+
+ event_blob + bytes + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • HASHING_SCHEME_VERSION_UNSPECIFIED
    • + +
  • HASHING_SCHEME_VERSION_V2
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ estimation_timestamp + Timestamp + +
+ +
Timestamp at which the estimation was made
+ +
+ +
+
+ confirmation_request_traffic_cost_estimation + uint64 + +
+ +
Estimated traffic cost of the confirmation request associated with the transaction
+ +
+ +
+
+ confirmation_response_traffic_cost_estimation + uint64 + +
+ +
Estimated traffic cost of the confirmation response associated with the transaction This field can also be used as an indication of the cost that other potential confirming nodes of the party will incur to approve or reject the transaction
+ +
+ +
+
+ total_traffic_cost_estimation + uint64 + +
+ +
Sum of the fields above
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandcompletionservice/completionstream.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandcompletionservice/completionstream.mdx new file mode 100644 index 0000000..14b5489 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandcompletionservice/completionstream.mdx @@ -0,0 +1,620 @@ +--- +title: "CompletionStream" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2

+ + +

CompletionStream

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.CommandCompletionService/CompletionStream + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.CommandCompletionService/CompletionStream <<'EOF' +{ + "userId": "string", + "parties": [ + "string" + ], + "beginExclusive": "0" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "completion": { + "commandId": "string", + "status": "string", + "updateId": "string", + "userId": "string", + "actAs": [ + "string" + ], + "submissionId": "string", + "deduplicationOffset": "0" + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
CommandCompletionService
+
+ +
+
RPC
+
CompletionStream
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
Yes
+
+ +
+ + +## Inputs + + +
+
+

CompletionStreamRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.CompletionStreamRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ user_id + string + +
+ +
Only completions of commands submitted with the same user_id will be visible in the stream. Must be a valid UserIdString (as described in ``value.proto``). Required unless authentication is used with a user token. In that case, the token's user-id will be used for the request's user_id.
+ +
+ +
+
+ parties + repeated string + +
+ +
Non-empty list of parties whose data should be included. The stream shows only completions of commands for which at least one of the ``act_as`` parties is in the given set of parties. Must be a valid PartyIdString (as described in ``value.proto``). Required
+ +
+ +
+
+ begin_exclusive + int64 + +
+ +
This optional field indicates the minimum offset for completions. This can be used to resume an earlier completion stream. If not set the ledger uses the ledger begin offset instead. If specified, it must be a valid absolute offset (positive integer) or zero (ledger begin offset). If the ledger has been pruned, this parameter must be specified and greater than the pruning offset.
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

CompletionStreamResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.CompletionStreamResponse
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + +
+ +
+
+ completion + Completion + +
+ +
+ +
+
+ offset_checkpoint + OffsetCheckpoint + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ user_id + string + +
+ +
Only completions of commands submitted with the same user_id will be visible in the stream. Must be a valid UserIdString (as described in ``value.proto``). Required unless authentication is used with a user token. In that case, the token's user-id will be used for the request's user_id.
+ +
+ +
+
+ parties + repeated string + +
+ +
Non-empty list of parties whose data should be included. The stream shows only completions of commands for which at least one of the ``act_as`` parties is in the given set of parties. Must be a valid PartyIdString (as described in ``value.proto``). Required
+ +
+ +
+
+ begin_exclusive + int64 + +
+ +
This optional field indicates the minimum offset for completions. This can be used to resume an earlier completion stream. If not set the ledger uses the ledger begin offset instead. If specified, it must be a valid absolute offset (positive integer) or zero (ledger begin offset). If the ledger has been pruned, this parameter must be specified and greater than the pruning offset.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ completion + Completion + +
+ +
+ +
+
+ offset_checkpoint + OffsetCheckpoint + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ command_id + string + +
+ +
The ID of the succeeded or failed command. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ status + Status + +
+ +
Identifies the exact type of the error. It uses the same format of conveying error details as it is used for the RPC responses of the APIs. Optional
+ +
+ +
+
+ update_id + string + +
+ +
The update_id of the transaction or reassignment that resulted from the command with command_id. Only set for successfully executed commands. Must be a valid LedgerString (as described in ``value.proto``).
+ +
+ +
+
+ user_id + string + +
+ +
The user-id that was used for the submission, as described in ``commands.proto``. Must be a valid UserIdString (as described in ``value.proto``). Optional for historic completions where this data is not available.
+ +
+ +
+
+ act_as + repeated string + +
+ +
The set of parties on whose behalf the commands were executed. Contains the ``act_as`` parties from ``commands.proto`` filtered to the requesting parties in CompletionStreamRequest. The order of the parties need not be the same as in the submission. Each element must be a valid PartyIdString (as described in ``value.proto``). Optional for historic completions where this data is not available.
+ +
+ +
+
+ submission_id + string + +
+ +
The submission ID this completion refers to, as described in ``commands.proto``. Must be a valid LedgerString (as described in ``value.proto``). Optional
+ +
+ +
+
+ deduplication_offset + int64 + +
+ +
Specifies the start of the deduplication period by a completion stream offset (exclusive). Must be a valid absolute offset (positive integer) or participant begin (zero).
+ +
+ +
+
+ deduplication_duration + Duration + +
+ +
Specifies the length of the deduplication period. It is measured in record time of completions. Must be non-negative.
+ +
+ +
+
+ trace_context + TraceContext + +
+ +
Optional; ledger API trace context The trace context transported in this message corresponds to the trace context supplied by the client application in a HTTP2 header of the original command submission. We typically use a header to transfer this type of information. Here we use message body, because it is used in gRPC streams which do not support per message headers. This field will be populated with the trace context contained in the original submission. If that was not provided, a unique ledger-api-server generated trace context will be used instead.
+ +
+ +
+
+ offset + int64 + +
+ +
May be used in a subsequent CompletionStreamRequest to resume the consumption of this stream at a later time. Required, must be a valid absolute offset (positive integer).
+ +
+ +
+
+ synchronizer_time + SynchronizerTime + +
+ +
The synchronizer along with its record time. The synchronizer id provided, in case of - successful/failed transactions: identifies the synchronizer of the transaction - for successful/failed unassign commands: identifies the source synchronizer - for successful/failed assign commands: identifies the target synchronizer Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ traceparent + string + +
+ +
https://www.w3.org/TR/trace-context/
+ +
+ +
+
+ tracestate + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ synchronizer_id + string + +
+ +
The id of the synchronizer. Required
+ +
+ +
+
+ record_time + Timestamp + +
+ +
All commands with a maximum record time below this value MUST be considered lost if their completion has not arrived before this checkpoint. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ offset + int64 + +
+ +
The participant's offset, the details of the offset field are described in ``community/ledger-api/README.md``. Required, must be a valid absolute offset (positive integer).
+ +
+ +
+
+ synchronizer_times + repeated SynchronizerTime + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandservice/submitandwait.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandservice/submitandwait.mdx new file mode 100644 index 0000000..e120f3e --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandservice/submitandwait.mdx @@ -0,0 +1,875 @@ +--- +title: "SubmitAndWait" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2

+ + +

SubmitAndWait

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.CommandService/SubmitAndWait + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.CommandService/SubmitAndWait <<'EOF' +{ + "commands": { + "workflowId": "string", + "userId": "string", + "commandId": "string", + "commands": [ + { + "create": { + "templateId": "string", + "createArguments": "string" + } + } + ], + "deduplicationDuration": "string", + "minLedgerTimeAbs": "string", + "minLedgerTimeRel": "string" + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "updateId": "string", + "completionOffset": "0" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
CommandService
+
+ +
+
RPC
+
SubmitAndWait
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

SubmitAndWaitRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.SubmitAndWaitRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ commands + Commands + +
+ +
The commands to be submitted. Required
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

SubmitAndWaitResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.SubmitAndWaitResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ update_id + string + +
+ +
The id of the transaction that resulted from the submitted command. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ completion_offset + int64 + +
+ +
The details of the offset field are described in ``community/ledger-api/README.md``. Required
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ commands + Commands + +
+ +
The commands to be submitted. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ workflow_id + string + +
+ +
Identifier of the on-ledger workflow that this command is a part of. Must be a valid LedgerString (as described in ``value.proto``). Optional
+ +
+ +
+
+ user_id + string + +
+ +
Uniquely identifies the participant user that issued the command. Must be a valid UserIdString (as described in ``value.proto``). Required unless authentication is used with a user token. In that case, the token's user-id will be used for the request's user_id.
+ +
+ +
+
+ command_id + string + +
+ +
Uniquely identifies the command. The triple (user_id, act_as, command_id) constitutes the change ID for the intended ledger change, where act_as is interpreted as a set of party names. The change ID can be used for matching the intended ledger changes with all their completions. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ commands + repeated Command + +
+ +
Individual elements of this atomic command. Must be non-empty. Required
+ +
+ +
+
+ deduplication_duration + Duration + +
+ +
Specifies the length of the deduplication period. It is interpreted relative to the local clock at some point during the submission's processing. Must be non-negative. Must not exceed the maximum deduplication time.
+ +
+ +
+
+ deduplication_offset + int64 + +
+ +
Specifies the start of the deduplication period by a completion stream offset (exclusive). Must be a valid absolute offset (positive integer) or participant begin (zero).
+ +
+ +
+
+ min_ledger_time_abs + Timestamp + +
+ +
Lower bound for the ledger time assigned to the resulting transaction. Note: The ledger time of a transaction is assigned as part of command interpretation. Use this property if you expect that command interpretation will take a considerate amount of time, such that by the time the resulting transaction is sequenced, its assigned ledger time is not valid anymore. Must not be set at the same time as min_ledger_time_rel. Optional
+ +
+ +
+
+ min_ledger_time_rel + Duration + +
+ +
Same as min_ledger_time_abs, but specified as a duration, starting from the time the command is received by the server. Must not be set at the same time as min_ledger_time_abs. Optional
+ +
+ +
+
+ act_as + repeated string + +
+ +
Set of parties on whose behalf the command should be executed. If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request to act on behalf of each of the given parties. Each element must be a valid PartyIdString (as described in ``value.proto``). Required, must be non-empty.
+ +
+ +
+
+ read_as + repeated string + +
+ +
Set of parties on whose behalf (in addition to all parties listed in ``act_as``) contracts can be retrieved. This affects Daml operations such as ``fetch``, ``fetchByKey``, ``lookupByKey``, ``exercise``, and ``exerciseByKey``. Note: A participant node of a Daml network can host multiple parties. Each contract present on the participant node is only visible to a subset of these parties. A command can only use contracts that are visible to at least one of the parties in ``act_as`` or ``read_as``. This visibility check is independent from the Daml authorization rules for fetch operations. If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request to read contract data on behalf of each of the given parties. Optional
+ +
+ +
+
+ submission_id + string + +
+ +
A unique identifier to distinguish completions for different submissions with the same change ID. Typically a random UUID. Applications are expected to use a different UUID for each retry of a submission with the same change ID. Must be a valid LedgerString (as described in ``value.proto``). If omitted, the participant or the committer may set a value of their choice. Optional
+ +
+ +
+
+ disclosed_contracts + repeated DisclosedContract + +
+ +
Additional contracts used to resolve contract & contract key lookups. Optional
+ +
+ +
+
+ synchronizer_id + string + +
+ +
Must be a valid synchronizer id Optional
+ +
+ +
+
+ package_id_selection_preference + repeated string + +
+ +
The package-id selection preference of the client for resolving package names and interface instances in command submission and interpretation
+ +
+ +
+
+ prefetch_contract_keys + repeated PrefetchContractKey + +
+ +
Fetches the contract keys into the caches to speed up the command processing. Should only contain contract keys that are expected to be resolved during interpretation of the commands. Keys of disclosed contracts do not need prefetching. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ create + CreateCommand + +
+ +
+ +
+
+ exercise + ExerciseCommand + +
+ +
+ +
+
+ exercise_by_key + ExerciseByKeyCommand + +
+ +
+ +
+
+ create_and_exercise + CreateAndExerciseCommand + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template of contract the client wants to create. Both package-name and package-id reference identifier formats for the template-id are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ create_arguments + Record + +
+ +
The arguments required for creating a contract from this template. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template or interface of the contract the client wants to exercise. Both package-name and package-id reference identifier formats for the template-id are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. To exercise a choice on an interface, specify the interface identifier in the template_id field. Required
+ +
+ +
+
+ contract_id + string + +
+ +
The ID of the contract the client wants to exercise upon. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ choice + string + +
+ +
The name of the choice the client wants to exercise. Must be a valid NameString (as described in ``value.proto``) Required
+ +
+ +
+
+ choice_argument + Value + +
+ +
The argument for this choice. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template of contract the client wants to exercise. Both package-name and package-id reference identifier formats for the template-id are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ contract_key + Value + +
+ +
The key of the contract the client wants to exercise upon. Required
+ +
+ +
+
+ choice + string + +
+ +
The name of the choice the client wants to exercise. Must be a valid NameString (as described in ``value.proto``) Required
+ +
+ +
+
+ choice_argument + Value + +
+ +
The argument for this choice. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template of the contract the client wants to create. Both package-name and package-id reference identifier formats for the template-id are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ create_arguments + Record + +
+ +
The arguments required for creating a contract from this template. Required
+ +
+ +
+
+ choice + string + +
+ +
The name of the choice the client wants to exercise. Must be a valid NameString (as described in ``value.proto``). Required
+ +
+ +
+
+ choice_argument + Value + +
+ +
The argument for this choice. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template id of the contract. The identifier uses the package-id reference format. If provided, used to validate the template id of the contract serialized in the created_event_blob. Optional
+ +
+ +
+
+ contract_id + string + +
+ +
The contract id If provided, used to validate the contract id of the contract serialized in the created_event_blob. Optional
+ +
+ +
+
+ created_event_blob + bytes + +
+ +
Opaque byte string containing the complete payload required by the Daml engine to reconstruct a contract not known to the receiving participant. Required
+ +
+ +
+
+ synchronizer_id + string + +
+ +
The ID of the synchronizer where the contract is currently assigned Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template of contract the client wants to prefetch. Both package-name and package-id reference identifier formats for the template-id are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ contract_key + Value + +
+ +
The key of the contract the client wants to prefetch. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ update_id + string + +
+ +
The id of the transaction that resulted from the submitted command. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ completion_offset + int64 + +
+ +
The details of the offset field are described in ``community/ledger-api/README.md``. Required
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandservice/submitandwaitforreassignment.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandservice/submitandwaitforreassignment.mdx new file mode 100644 index 0000000..79085b5 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandservice/submitandwaitforreassignment.mdx @@ -0,0 +1,1431 @@ +--- +title: "SubmitAndWaitForReassignment" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2

+ + +

SubmitAndWaitForReassignment

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.CommandService/SubmitAndWaitForReassignment + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.CommandService/SubmitAndWaitForReassignment <<'EOF' +{ + "reassignmentCommands": { + "workflowId": "string", + "userId": "string", + "commandId": "string", + "submitter": "string", + "submissionId": "string", + "commands": [ + { + "unassignCommand": { + "contractId": "string", + "source": "string", + "target": "string" + } + } + ] + }, + "eventFormat": { + "filtersByParty": [ + { + "key": { + "cumulative": [ + { + "wildcardFilter": {} + } + ] + } + } + ], + "filtersForAnyParty": { + "cumulative": [ + { + "wildcardFilter": {} + } + ] + }, + "verbose": true + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "reassignment": { + "updateId": "string", + "commandId": "string", + "workflowId": "string", + "offset": "0", + "events": [ + { + "unassigned": { + "reassignmentId": "string", + "contractId": "string", + "templateId": "string", + "source": "string", + "target": "string", + "submitter": "string", + "reassignmentCounter": "0", + "assignmentExclusivity": "string" + } + } + ], + "traceContext": { + "traceparent": "string", + "tracestate": "string" + }, + "recordTime": "string", + "synchronizerId": "string" + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
CommandService
+
+ +
+
RPC
+
SubmitAndWaitForReassignment
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

SubmitAndWaitForReassignmentRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.SubmitAndWaitForReassignmentRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ reassignment_commands + ReassignmentCommands + +
+ +
The reassignment commands to be submitted. Required
+ +
+ +
+
+ event_format + EventFormat + +
+ +
Optional If no event_format provided, the result will contain no events. The events in the result, will take shape TRANSACTION_SHAPE_ACS_DELTA.
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

SubmitAndWaitForReassignmentResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.SubmitAndWaitForReassignmentResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ reassignment + Reassignment + +
+ +
The reassignment that resulted from the submitted reassignment command. The reassignment might contain no events (request conditions result in filtering out all of them). Required
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ reassignment_commands + ReassignmentCommands + +
+ +
The reassignment commands to be submitted. Required
+ +
+ +
+
+ event_format + EventFormat + +
+ +
Optional If no event_format provided, the result will contain no events. The events in the result, will take shape TRANSACTION_SHAPE_ACS_DELTA.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ workflow_id + string + +
+ +
Identifier of the on-ledger workflow that this command is a part of. Must be a valid LedgerString (as described in ``value.proto``). Optional
+ +
+ +
+
+ user_id + string + +
+ +
Uniquely identifies the participant user that issued the command. Must be a valid UserIdString (as described in ``value.proto``). Required unless authentication is used with a user token. In that case, the token's user-id will be used for the request's user_id.
+ +
+ +
+
+ command_id + string + +
+ +
Uniquely identifies the command. The triple (user_id, submitter, command_id) constitutes the change ID for the intended ledger change. The change ID can be used for matching the intended ledger changes with all their completions. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ submitter + string + +
+ +
Party on whose behalf the command should be executed. If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request to act on behalf of the given party. Must be a valid PartyIdString (as described in ``value.proto``). Required
+ +
+ +
+
+ submission_id + string + +
+ +
A unique identifier to distinguish completions for different submissions with the same change ID. Typically a random UUID. Applications are expected to use a different UUID for each retry of a submission with the same change ID. Must be a valid LedgerString (as described in ``value.proto``). If omitted, the participant or the committer may set a value of their choice. Optional
+ +
+ +
+
+ commands + repeated ReassignmentCommand + +
+ +
Individual elements of this reassignment. Must be non-empty.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ unassign_command + UnassignCommand + +
+ +
+ +
+
+ assign_command + AssignCommand + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ contract_id + string + +
+ +
The ID of the contract the client wants to unassign. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ source + string + +
+ +
The ID of the source synchronizer Must be a valid synchronizer id Required
+ +
+ +
+
+ target + string + +
+ +
The ID of the target synchronizer Must be a valid synchronizer id Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ reassignment_id + string + +
+ +
The ID from the unassigned event to be completed by this assignment. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ source + string + +
+ +
The ID of the source synchronizer Must be a valid synchronizer id Required
+ +
+ +
+
+ target + string + +
+ +
The ID of the target synchronizer Must be a valid synchronizer id Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ filters_by_party + repeated map + +
+ +
Each key must be a valid PartyIdString (as described in ``value.proto``). The interpretation of the filter depends on the transaction-shape being filtered: 1. For **ledger-effects** create and exercise events are returned, for which the witnesses include at least one of the listed parties and match the per-party filter. 2. For **transaction and active-contract-set streams** create and archive events are returned for all contracts whose stakeholders include at least one of the listed parties and match the per-party filter. Optional
+ +
+ +
+
+ filters_for_any_party + Filters + +
+ +
Wildcard filters that apply to all the parties existing on the participant. The interpretation of the filters is the same with the per-party filter as described above. Optional
+ +
+ +
+
+ verbose + bool + +
+ +
If enabled, values served over the API will contain more information than strictly necessary to interpret the data. In particular, setting the verbose flag to true triggers the ledger to include labels for record fields. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ cumulative + repeated CumulativeFilter + +
+ +
Every filter in the cumulative list expands the scope of the resulting stream. Each interface, template or wildcard filter means additional events that will match the query. The impact of include_interface_view and include_created_event_blob fields in the filters will also be accumulated. A template or an interface SHOULD NOT appear twice in the accumulative field. A wildcard filter SHOULD NOT be defined more than once in the accumulative field. Optional, if no ``CumulativeFilter`` defined, the default of a single ``WildcardFilter`` with include_created_event_blob unset is used.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ wildcard_filter + WildcardFilter + +
+ +
A wildcard filter that matches all templates Optional
+ +
+ +
+
+ interface_filter + InterfaceFilter + +
+ +
Include an ``InterfaceView`` for every ``InterfaceFilter`` matching a contract. The ``InterfaceFilter`` instances MUST each use a unique ``interface_id``. Optional
+ +
+ +
+
+ template_filter + TemplateFilter + +
+ +
A template for which the data will be included in the ``create_arguments`` of a matching ``CreatedEvent``. If a contract is simultaneously selected by a template filter and one or more interface filters, the corresponding ``include_created_event_blob`` are consolidated using an OR operation. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ include_created_event_blob + bool + +
+ +
Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``. Use this to access the contract create event payload in your API client for submitting it as a disclosed contract with future commands. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ interface_id + Identifier + +
+ +
The interface that a matching contract must implement. The ``interface_id`` needs to be valid: corresponding interface should be defined in one of the available packages at the time of the query. Both package-name and package-id reference formats for the identifier are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ include_interface_view + bool + +
+ +
Whether to include the interface view on the contract in the returned ``CreatedEvent``. Use this to access contract data in a uniform manner in your API client. Optional
+ +
+ +
+
+ include_created_event_blob + bool + +
+ +
Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``. Use this to access the contract create event payload in your API client for submitting it as a disclosed contract with future commands. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ template_id + Identifier + +
+ +
A template for which the payload should be included in the response. The ``template_id`` needs to be valid: corresponding template should be defined in one of the available packages at the time of the query. Both package-name and package-id reference formats for the identifier are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ include_created_event_blob + bool + +
+ +
Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``. Use this to access the contract event payload in your API client for submitting it as a disclosed contract with future commands. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ reassignment + Reassignment + +
+ +
The reassignment that resulted from the submitted reassignment command. The reassignment might contain no events (request conditions result in filtering out all of them). Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ update_id + string + +
+ +
Assigned by the server. Useful for correlating logs. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ command_id + string + +
+ +
The ID of the command which resulted in this reassignment. Missing for everyone except the submitting party on the submitting participant. Must be a valid LedgerString (as described in ``value.proto``). Optional
+ +
+ +
+
+ workflow_id + string + +
+ +
The workflow ID used in reassignment command submission. Only set if the ``workflow_id`` for the command was set. Must be a valid LedgerString (as described in ``value.proto``). Optional
+ +
+ +
+
+ offset + int64 + +
+ +
The participant's offset. The details of this field are described in ``community/ledger-api/README.md``. Required, must be a valid absolute offset (positive integer).
+ +
+ +
+
+ events + repeated ReassignmentEvent + +
+ +
The collection of reassignment events. Required.
+ +
+ +
+
+ trace_context + TraceContext + +
+ +
Optional; ledger API trace context The trace context transported in this message corresponds to the trace context supplied by the client application in a HTTP2 header of the original command submission. We typically use a header to transfer this type of information. Here we use message body, because it is used in gRPC streams which do not support per message headers. This field will be populated with the trace context contained in the original submission. If that was not provided, a unique ledger-api-server generated trace context will be used instead.
+ +
+ +
+
+ record_time + Timestamp + +
+ +
The time at which the reassignment was recorded. The record time refers to the source/target synchronizer for an unassign/assign event respectively. Required
+ +
+ +
+
+ synchronizer_id + string + +
+ +
A valid synchronizer id. Identifies the synchronizer that synchronized this Reassignment. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ unassigned + UnassignedEvent + +
+ +
+ +
+
+ assigned + AssignedEvent + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ reassignment_id + string + +
+ +
The ID of the unassignment. This needs to be used as an input for a assign ReassignmentCommand. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ contract_id + string + +
+ +
The ID of the reassigned contract. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ template_id + Identifier + +
+ +
The template of the reassigned contract. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ source + string + +
+ +
The ID of the source synchronizer Must be a valid synchronizer id Required
+ +
+ +
+
+ target + string + +
+ +
The ID of the target synchronizer Must be a valid synchronizer id Required
+ +
+ +
+
+ submitter + string + +
+ +
Party on whose behalf the unassign command was executed. Empty if the unassignment happened offline via the repair service. Must be a valid PartyIdString (as described in ``value.proto``). Optional
+ +
+ +
+
+ reassignment_counter + uint64 + +
+ +
Each corresponding assigned and unassigned event has the same reassignment_counter. This strictly increases with each unassign command for the same contract. Creation of the contract corresponds to reassignment_counter equals zero. Required
+ +
+ +
+
+ assignment_exclusivity + Timestamp + +
+ +
Assignment exclusivity Before this time (measured on the target synchronizer), only the submitter of the unassignment can initiate the assignment Defined for reassigning participants. Optional
+ +
+ +
+
+ witness_parties + repeated string + +
+ +
The parties that are notified of this event. Required
+ +
+ +
+
+ package_name + string + +
+ +
The package name of the contract. Required
+ +
+ +
+
+ offset + int64 + +
+ +
The offset of origin. Offsets are managed by the participant nodes. Reassignments can thus NOT be assumed to have the same offsets on different participant nodes. Required, it is a valid absolute offset (positive integer)
+ +
+ +
+
+ node_id + int32 + +
+ +
The position of this event in the originating reassignment. Node IDs are not necessarily equal across participants, as these may see different projections/parts of reassignments. Required, must be valid node ID (non-negative integer)
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ source + string + +
+ +
The ID of the source synchronizer. Must be a valid synchronizer id. Required
+ +
+ +
+
+ target + string + +
+ +
The ID of the target synchronizer. Must be a valid synchronizer id. Required
+ +
+ +
+
+ reassignment_id + string + +
+ +
The ID from the unassigned event. For correlation capabilities. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ submitter + string + +
+ +
Party on whose behalf the assign command was executed. Empty if the assignment happened offline via the repair service. Must be a valid PartyIdString (as described in ``value.proto``). Optional
+ +
+ +
+
+ reassignment_counter + uint64 + +
+ +
Each corresponding assigned and unassigned event has the same reassignment_counter. This strictly increases with each unassign command for the same contract. Creation of the contract corresponds to reassignment_counter equals zero. Required
+ +
+ +
+
+ created_event + CreatedEvent + +
+ +
Required The offset of this event refers to the offset of the assignment, while the node_id is the index of within the batch.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ offset + int64 + +
+ +
The offset of origin, which has contextual meaning, please see description at messages that include a CreatedEvent. Offsets are managed by the participant nodes. Transactions can thus NOT be assumed to have the same offsets on different participant nodes. Required, it is a valid absolute offset (positive integer)
+ +
+ +
+
+ node_id + int32 + +
+ +
The position of this event in the originating transaction or reassignment. The origin has contextual meaning, please see description at messages that include a CreatedEvent. Node IDs are not necessarily equal across participants, as these may see different projections/parts of transactions. Required, must be valid node ID (non-negative integer)
+ +
+ +
+
+ contract_id + string + +
+ +
The ID of the created contract. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ template_id + Identifier + +
+ +
The template of the created contract. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ contract_key + Value + +
+ +
The key of the created contract. This will be set if and only if ``template_id`` defines a contract key. Optional
+ +
+ +
+
+ create_arguments + Record + +
+ +
The arguments that have been used to create the contract. Required
+ +
+ +
+
+ created_event_blob + bytes + +
+ +
Opaque representation of contract create event payload intended for forwarding to an API server as a contract disclosed as part of a command submission. Optional
+ +
+ +
+
+ interface_views + repeated InterfaceView + +
+ +
Interface views specified in the transaction filter. Includes an ``InterfaceView`` for each interface for which there is a ``InterfaceFilter`` with - its party in the ``witness_parties`` of this event, - and which is implemented by the template of this event, - and which has ``include_interface_view`` set. Optional
+ +
+ +
+
+ witness_parties + repeated string + +
+ +
The parties that are notified of this event. When a ``CreatedEvent`` is returned as part of a transaction tree or ledger-effects transaction, this will include all the parties specified in the ``TransactionFilter`` that are witnesses of the event (the stakeholders of the contract and all informees of all the ancestors of this create action that this participant knows about). If served as part of a ACS delta transaction those will be limited to all parties specified in the ``TransactionFilter`` that are stakeholders of the contract (i.e. either signatories or observers). If the ``CreatedEvent`` is returned as part of an AssignedEvent, ActiveContract or IncompleteUnassigned (so the event is related to an assignment or unassignment): this will include all parties of the ``TransactionFilter`` that are stakeholders of the contract. The behavior of reading create events visible to parties not hosted on the participant node serving the Ledger API is undefined. Concretely, there is neither a guarantee that the participant node will serve all their create events on the ACS stream, nor is there a guarantee that matching archive events are delivered for such create events. For most clients this is not a problem, as they only read events for parties that are hosted on the participant node. If you need to read events for parties that may not be hosted at all times on the participant node, subscribe to the ``TopologyEvent``s for that party by setting a corresponding ``UpdateFormat``. Using these events, query the ACS as-of an offset where the party is hosted on the participant node, and ignore create events at offsets where the party is not hosted on the participant node. Required
+ +
+ +
+
+ signatories + repeated string + +
+ +
The signatories for this contract as specified by the template. Required
+ +
+ +
+
+ observers + repeated string + +
+ +
The observers for this contract as specified explicitly by the template or implicitly as choice controllers. This field never contains parties that are signatories. Required
+ +
+ +
+
+ created_at + Timestamp + +
+ +
Ledger effective time of the transaction that created the contract. Required
+ +
+ +
+
+ package_name + string + +
+ +
The package name of the created contract. Required
+ +
+ +
+
+ acs_delta + bool + +
+ +
Whether this event would be part of respective ACS_DELTA shaped stream, and should therefore considered when tracking contract activeness on the client-side. Required
+ +
+ +
+
+ representative_package_id + string + +
+ +
A package-id present in the participant package store that typechecks the contract's argument. This may differ from the package-id of the template used to create the contract. For contracts created before Canton 3.4, this field matches the contract's creation package-id. NOTE: Experimental, server internal concept, not for client consumption. Subject to change without notice. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ interface_id + Identifier + +
+ +
The interface implemented by the matched event. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ view_status + Status + +
+ +
Whether the view was successfully computed, and if not, the reason for the error. The error is reported using the same rules for error codes and messages as the errors returned for API requests. Required
+ +
+ +
+
+ view_value + Record + +
+ +
The value of the interface's view method on this event. Set if it was requested in the ``InterfaceFilter`` and it could be successfully computed. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ traceparent + string + +
+ +
https://www.w3.org/TR/trace-context/
+ +
+ +
+
+ tracestate + string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandservice/submitandwaitfortransaction.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandservice/submitandwaitfortransaction.mdx new file mode 100644 index 0000000..f027cdb --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandservice/submitandwaitfortransaction.mdx @@ -0,0 +1,1886 @@ +--- +title: "SubmitAndWaitForTransaction" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2

+ + +

SubmitAndWaitForTransaction

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.CommandService/SubmitAndWaitForTransaction + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.CommandService/SubmitAndWaitForTransaction <<'EOF' +{ + "commands": { + "workflowId": "string", + "userId": "string", + "commandId": "string", + "commands": [ + { + "create": { + "templateId": "string", + "createArguments": "string" + } + } + ], + "deduplicationDuration": "string", + "minLedgerTimeAbs": "string", + "minLedgerTimeRel": "string" + }, + "transactionFormat": { + "eventFormat": { + "filtersByParty": [ + { + "key": { + "cumulative": [ + {} + ] + } + } + ], + "filtersForAnyParty": { + "cumulative": [ + {} + ] + }, + "verbose": true + }, + "transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED" + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "transaction": { + "updateId": "string", + "commandId": "string", + "workflowId": "string", + "effectiveAt": "string", + "events": [ + { + "created": { + "offset": "0", + "nodeId": 0, + "contractId": "string", + "templateId": "string", + "contractKey": "string", + "createArguments": "string", + "createdEventBlob": "BASE64_ENCODED_BYTES", + "interfaceViews": [ + {} + ] + } + } + ], + "offset": "0", + "synchronizerId": "string", + "traceContext": { + "traceparent": "string", + "tracestate": "string" + } + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
CommandService
+
+ +
+
RPC
+
SubmitAndWaitForTransaction
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

SubmitAndWaitForTransactionRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.SubmitAndWaitForTransactionRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ commands + Commands + +
+ +
The commands to be submitted. Required
+ +
+ +
+
+ transaction_format + TransactionFormat + +
+ +
If no ``transaction_format`` is provided, a default will be used where ``transaction_shape`` is set to TRANSACTION_SHAPE_ACS_DELTA, ``event_format`` is defined with ``filters_by_party`` containing wildcard-template filter for all original ``act_as`` and ``read_as`` parties and the ``verbose`` flag is set. Optional
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

SubmitAndWaitForTransactionResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.SubmitAndWaitForTransactionResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ transaction + Transaction + +
+ +
The transaction that resulted from the submitted command. The transaction might contain no events (request conditions result in filtering out all of them). Required
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ commands + Commands + +
+ +
The commands to be submitted. Required
+ +
+ +
+
+ transaction_format + TransactionFormat + +
+ +
If no ``transaction_format`` is provided, a default will be used where ``transaction_shape`` is set to TRANSACTION_SHAPE_ACS_DELTA, ``event_format`` is defined with ``filters_by_party`` containing wildcard-template filter for all original ``act_as`` and ``read_as`` parties and the ``verbose`` flag is set. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ workflow_id + string + +
+ +
Identifier of the on-ledger workflow that this command is a part of. Must be a valid LedgerString (as described in ``value.proto``). Optional
+ +
+ +
+
+ user_id + string + +
+ +
Uniquely identifies the participant user that issued the command. Must be a valid UserIdString (as described in ``value.proto``). Required unless authentication is used with a user token. In that case, the token's user-id will be used for the request's user_id.
+ +
+ +
+
+ command_id + string + +
+ +
Uniquely identifies the command. The triple (user_id, act_as, command_id) constitutes the change ID for the intended ledger change, where act_as is interpreted as a set of party names. The change ID can be used for matching the intended ledger changes with all their completions. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ commands + repeated Command + +
+ +
Individual elements of this atomic command. Must be non-empty. Required
+ +
+ +
+
+ deduplication_duration + Duration + +
+ +
Specifies the length of the deduplication period. It is interpreted relative to the local clock at some point during the submission's processing. Must be non-negative. Must not exceed the maximum deduplication time.
+ +
+ +
+
+ deduplication_offset + int64 + +
+ +
Specifies the start of the deduplication period by a completion stream offset (exclusive). Must be a valid absolute offset (positive integer) or participant begin (zero).
+ +
+ +
+
+ min_ledger_time_abs + Timestamp + +
+ +
Lower bound for the ledger time assigned to the resulting transaction. Note: The ledger time of a transaction is assigned as part of command interpretation. Use this property if you expect that command interpretation will take a considerate amount of time, such that by the time the resulting transaction is sequenced, its assigned ledger time is not valid anymore. Must not be set at the same time as min_ledger_time_rel. Optional
+ +
+ +
+
+ min_ledger_time_rel + Duration + +
+ +
Same as min_ledger_time_abs, but specified as a duration, starting from the time the command is received by the server. Must not be set at the same time as min_ledger_time_abs. Optional
+ +
+ +
+
+ act_as + repeated string + +
+ +
Set of parties on whose behalf the command should be executed. If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request to act on behalf of each of the given parties. Each element must be a valid PartyIdString (as described in ``value.proto``). Required, must be non-empty.
+ +
+ +
+
+ read_as + repeated string + +
+ +
Set of parties on whose behalf (in addition to all parties listed in ``act_as``) contracts can be retrieved. This affects Daml operations such as ``fetch``, ``fetchByKey``, ``lookupByKey``, ``exercise``, and ``exerciseByKey``. Note: A participant node of a Daml network can host multiple parties. Each contract present on the participant node is only visible to a subset of these parties. A command can only use contracts that are visible to at least one of the parties in ``act_as`` or ``read_as``. This visibility check is independent from the Daml authorization rules for fetch operations. If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request to read contract data on behalf of each of the given parties. Optional
+ +
+ +
+
+ submission_id + string + +
+ +
A unique identifier to distinguish completions for different submissions with the same change ID. Typically a random UUID. Applications are expected to use a different UUID for each retry of a submission with the same change ID. Must be a valid LedgerString (as described in ``value.proto``). If omitted, the participant or the committer may set a value of their choice. Optional
+ +
+ +
+
+ disclosed_contracts + repeated DisclosedContract + +
+ +
Additional contracts used to resolve contract & contract key lookups. Optional
+ +
+ +
+
+ synchronizer_id + string + +
+ +
Must be a valid synchronizer id Optional
+ +
+ +
+
+ package_id_selection_preference + repeated string + +
+ +
The package-id selection preference of the client for resolving package names and interface instances in command submission and interpretation
+ +
+ +
+
+ prefetch_contract_keys + repeated PrefetchContractKey + +
+ +
Fetches the contract keys into the caches to speed up the command processing. Should only contain contract keys that are expected to be resolved during interpretation of the commands. Keys of disclosed contracts do not need prefetching. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ create + CreateCommand + +
+ +
+ +
+
+ exercise + ExerciseCommand + +
+ +
+ +
+
+ exercise_by_key + ExerciseByKeyCommand + +
+ +
+ +
+
+ create_and_exercise + CreateAndExerciseCommand + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template of contract the client wants to create. Both package-name and package-id reference identifier formats for the template-id are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ create_arguments + Record + +
+ +
The arguments required for creating a contract from this template. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template or interface of the contract the client wants to exercise. Both package-name and package-id reference identifier formats for the template-id are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. To exercise a choice on an interface, specify the interface identifier in the template_id field. Required
+ +
+ +
+
+ contract_id + string + +
+ +
The ID of the contract the client wants to exercise upon. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ choice + string + +
+ +
The name of the choice the client wants to exercise. Must be a valid NameString (as described in ``value.proto``) Required
+ +
+ +
+
+ choice_argument + Value + +
+ +
The argument for this choice. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template of contract the client wants to exercise. Both package-name and package-id reference identifier formats for the template-id are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ contract_key + Value + +
+ +
The key of the contract the client wants to exercise upon. Required
+ +
+ +
+
+ choice + string + +
+ +
The name of the choice the client wants to exercise. Must be a valid NameString (as described in ``value.proto``) Required
+ +
+ +
+
+ choice_argument + Value + +
+ +
The argument for this choice. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template of the contract the client wants to create. Both package-name and package-id reference identifier formats for the template-id are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ create_arguments + Record + +
+ +
The arguments required for creating a contract from this template. Required
+ +
+ +
+
+ choice + string + +
+ +
The name of the choice the client wants to exercise. Must be a valid NameString (as described in ``value.proto``). Required
+ +
+ +
+
+ choice_argument + Value + +
+ +
The argument for this choice. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template id of the contract. The identifier uses the package-id reference format. If provided, used to validate the template id of the contract serialized in the created_event_blob. Optional
+ +
+ +
+
+ contract_id + string + +
+ +
The contract id If provided, used to validate the contract id of the contract serialized in the created_event_blob. Optional
+ +
+ +
+
+ created_event_blob + bytes + +
+ +
Opaque byte string containing the complete payload required by the Daml engine to reconstruct a contract not known to the receiving participant. Required
+ +
+ +
+
+ synchronizer_id + string + +
+ +
The ID of the synchronizer where the contract is currently assigned Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template of contract the client wants to prefetch. Both package-name and package-id reference identifier formats for the template-id are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ contract_key + Value + +
+ +
The key of the contract the client wants to prefetch. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ event_format + EventFormat + +
+ +
Required
+ +
+ +
+
+ transaction_shape + TransactionShape + +
+ +
What transaction shape to use for interpreting the filters of the event format. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ filters_by_party + repeated map + +
+ +
Each key must be a valid PartyIdString (as described in ``value.proto``). The interpretation of the filter depends on the transaction-shape being filtered: 1. For **ledger-effects** create and exercise events are returned, for which the witnesses include at least one of the listed parties and match the per-party filter. 2. For **transaction and active-contract-set streams** create and archive events are returned for all contracts whose stakeholders include at least one of the listed parties and match the per-party filter. Optional
+ +
+ +
+
+ filters_for_any_party + Filters + +
+ +
Wildcard filters that apply to all the parties existing on the participant. The interpretation of the filters is the same with the per-party filter as described above. Optional
+ +
+ +
+
+ verbose + bool + +
+ +
If enabled, values served over the API will contain more information than strictly necessary to interpret the data. In particular, setting the verbose flag to true triggers the ledger to include labels for record fields. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ cumulative + repeated CumulativeFilter + +
+ +
Every filter in the cumulative list expands the scope of the resulting stream. Each interface, template or wildcard filter means additional events that will match the query. The impact of include_interface_view and include_created_event_blob fields in the filters will also be accumulated. A template or an interface SHOULD NOT appear twice in the accumulative field. A wildcard filter SHOULD NOT be defined more than once in the accumulative field. Optional, if no ``CumulativeFilter`` defined, the default of a single ``WildcardFilter`` with include_created_event_blob unset is used.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ wildcard_filter + WildcardFilter + +
+ +
A wildcard filter that matches all templates Optional
+ +
+ +
+
+ interface_filter + InterfaceFilter + +
+ +
Include an ``InterfaceView`` for every ``InterfaceFilter`` matching a contract. The ``InterfaceFilter`` instances MUST each use a unique ``interface_id``. Optional
+ +
+ +
+
+ template_filter + TemplateFilter + +
+ +
A template for which the data will be included in the ``create_arguments`` of a matching ``CreatedEvent``. If a contract is simultaneously selected by a template filter and one or more interface filters, the corresponding ``include_created_event_blob`` are consolidated using an OR operation. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ include_created_event_blob + bool + +
+ +
Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``. Use this to access the contract create event payload in your API client for submitting it as a disclosed contract with future commands. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ interface_id + Identifier + +
+ +
The interface that a matching contract must implement. The ``interface_id`` needs to be valid: corresponding interface should be defined in one of the available packages at the time of the query. Both package-name and package-id reference formats for the identifier are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ include_interface_view + bool + +
+ +
Whether to include the interface view on the contract in the returned ``CreatedEvent``. Use this to access contract data in a uniform manner in your API client. Optional
+ +
+ +
+
+ include_created_event_blob + bool + +
+ +
Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``. Use this to access the contract create event payload in your API client for submitting it as a disclosed contract with future commands. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ template_id + Identifier + +
+ +
A template for which the payload should be included in the response. The ``template_id`` needs to be valid: corresponding template should be defined in one of the available packages at the time of the query. Both package-name and package-id reference formats for the identifier are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ include_created_event_blob + bool + +
+ +
Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``. Use this to access the contract event payload in your API client for submitting it as a disclosed contract with future commands. Optional
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • TRANSACTION_SHAPE_UNSPECIFIED
    • + +
  • TRANSACTION_SHAPE_ACS_DELTA
    • + +
  • TRANSACTION_SHAPE_LEDGER_EFFECTS
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ transaction + Transaction + +
+ +
The transaction that resulted from the submitted command. The transaction might contain no events (request conditions result in filtering out all of them). Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ update_id + string + +
+ +
Assigned by the server. Useful for correlating logs. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ command_id + string + +
+ +
The ID of the command which resulted in this transaction. Missing for everyone except the submitting party. Must be a valid LedgerString (as described in ``value.proto``). Optional
+ +
+ +
+
+ workflow_id + string + +
+ +
The workflow ID used in command submission. Must be a valid LedgerString (as described in ``value.proto``). Optional
+ +
+ +
+
+ effective_at + Timestamp + +
+ +
Ledger effective time. Required
+ +
+ +
+
+ events + repeated Event + +
+ +
The collection of events. Contains: - ``CreatedEvent`` or ``ArchivedEvent`` in case of ACS_DELTA transaction shape - ``CreatedEvent`` or ``ExercisedEvent`` in case of LEDGER_EFFECTS transaction shape Required
+ +
+ +
+
+ offset + int64 + +
+ +
The absolute offset. The details of this field are described in ``community/ledger-api/README.md``. Required, it is a valid absolute offset (positive integer).
+ +
+ +
+
+ synchronizer_id + string + +
+ +
A valid synchronizer id. Identifies the synchronizer that synchronized the transaction. Required
+ +
+ +
+
+ trace_context + TraceContext + +
+ +
Optional; ledger API trace context The trace context transported in this message corresponds to the trace context supplied by the client application in a HTTP2 header of the original command submission. We typically use a header to transfer this type of information. Here we use message body, because it is used in gRPC streams which do not support per message headers. This field will be populated with the trace context contained in the original submission. If that was not provided, a unique ledger-api-server generated trace context will be used instead.
+ +
+ +
+
+ record_time + Timestamp + +
+ +
The time at which the transaction was recorded. The record time refers to the synchronizer which synchronized the transaction. Required
+ +
+ +
+
+ external_transaction_hash + bytes + +
+ +
For transaction externally signed, contains the external transaction hash signed by the external party. Can be used to correlate an external submission with a committed transaction. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ created + CreatedEvent + +
+ +
The event as it appeared in the context of its original daml transaction on this participant node. In particular, the offset, node_id pair of the daml transaction are preserved.
+ +
+ +
+
+ archived + ArchivedEvent + +
+ +
+ +
+
+ exercised + ExercisedEvent + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ offset + int64 + +
+ +
The offset of origin, which has contextual meaning, please see description at messages that include a CreatedEvent. Offsets are managed by the participant nodes. Transactions can thus NOT be assumed to have the same offsets on different participant nodes. Required, it is a valid absolute offset (positive integer)
+ +
+ +
+
+ node_id + int32 + +
+ +
The position of this event in the originating transaction or reassignment. The origin has contextual meaning, please see description at messages that include a CreatedEvent. Node IDs are not necessarily equal across participants, as these may see different projections/parts of transactions. Required, must be valid node ID (non-negative integer)
+ +
+ +
+
+ contract_id + string + +
+ +
The ID of the created contract. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ template_id + Identifier + +
+ +
The template of the created contract. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ contract_key + Value + +
+ +
The key of the created contract. This will be set if and only if ``template_id`` defines a contract key. Optional
+ +
+ +
+
+ create_arguments + Record + +
+ +
The arguments that have been used to create the contract. Required
+ +
+ +
+
+ created_event_blob + bytes + +
+ +
Opaque representation of contract create event payload intended for forwarding to an API server as a contract disclosed as part of a command submission. Optional
+ +
+ +
+
+ interface_views + repeated InterfaceView + +
+ +
Interface views specified in the transaction filter. Includes an ``InterfaceView`` for each interface for which there is a ``InterfaceFilter`` with - its party in the ``witness_parties`` of this event, - and which is implemented by the template of this event, - and which has ``include_interface_view`` set. Optional
+ +
+ +
+
+ witness_parties + repeated string + +
+ +
The parties that are notified of this event. When a ``CreatedEvent`` is returned as part of a transaction tree or ledger-effects transaction, this will include all the parties specified in the ``TransactionFilter`` that are witnesses of the event (the stakeholders of the contract and all informees of all the ancestors of this create action that this participant knows about). If served as part of a ACS delta transaction those will be limited to all parties specified in the ``TransactionFilter`` that are stakeholders of the contract (i.e. either signatories or observers). If the ``CreatedEvent`` is returned as part of an AssignedEvent, ActiveContract or IncompleteUnassigned (so the event is related to an assignment or unassignment): this will include all parties of the ``TransactionFilter`` that are stakeholders of the contract. The behavior of reading create events visible to parties not hosted on the participant node serving the Ledger API is undefined. Concretely, there is neither a guarantee that the participant node will serve all their create events on the ACS stream, nor is there a guarantee that matching archive events are delivered for such create events. For most clients this is not a problem, as they only read events for parties that are hosted on the participant node. If you need to read events for parties that may not be hosted at all times on the participant node, subscribe to the ``TopologyEvent``s for that party by setting a corresponding ``UpdateFormat``. Using these events, query the ACS as-of an offset where the party is hosted on the participant node, and ignore create events at offsets where the party is not hosted on the participant node. Required
+ +
+ +
+
+ signatories + repeated string + +
+ +
The signatories for this contract as specified by the template. Required
+ +
+ +
+
+ observers + repeated string + +
+ +
The observers for this contract as specified explicitly by the template or implicitly as choice controllers. This field never contains parties that are signatories. Required
+ +
+ +
+
+ created_at + Timestamp + +
+ +
Ledger effective time of the transaction that created the contract. Required
+ +
+ +
+
+ package_name + string + +
+ +
The package name of the created contract. Required
+ +
+ +
+
+ acs_delta + bool + +
+ +
Whether this event would be part of respective ACS_DELTA shaped stream, and should therefore considered when tracking contract activeness on the client-side. Required
+ +
+ +
+
+ representative_package_id + string + +
+ +
A package-id present in the participant package store that typechecks the contract's argument. This may differ from the package-id of the template used to create the contract. For contracts created before Canton 3.4, this field matches the contract's creation package-id. NOTE: Experimental, server internal concept, not for client consumption. Subject to change without notice. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ interface_id + Identifier + +
+ +
The interface implemented by the matched event. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ view_status + Status + +
+ +
Whether the view was successfully computed, and if not, the reason for the error. The error is reported using the same rules for error codes and messages as the errors returned for API requests. Required
+ +
+ +
+
+ view_value + Record + +
+ +
The value of the interface's view method on this event. Set if it was requested in the ``InterfaceFilter`` and it could be successfully computed. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ offset + int64 + +
+ +
The offset of origin. Offsets are managed by the participant nodes. Transactions can thus NOT be assumed to have the same offsets on different participant nodes. Required, it is a valid absolute offset (positive integer)
+ +
+ +
+
+ node_id + int32 + +
+ +
The position of this event in the originating transaction or reassignment. Node IDs are not necessarily equal across participants, as these may see different projections/parts of transactions. Required, must be valid node ID (non-negative integer)
+ +
+ +
+
+ contract_id + string + +
+ +
The ID of the archived contract. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ template_id + Identifier + +
+ +
Identifies the template that defines the choice that archived the contract. This template's package-id may differ from the target contract's package-id if the target contract has been upgraded or downgraded. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ witness_parties + repeated string + +
+ +
The parties that are notified of this event. For an ``ArchivedEvent``, these are the intersection of the stakeholders of the contract in question and the parties specified in the ``TransactionFilter``. The stakeholders are the union of the signatories and the observers of the contract. Each one of its elements must be a valid PartyIdString (as described in ``value.proto``). Required
+ +
+ +
+
+ package_name + string + +
+ +
The package name of the contract. Required
+ +
+ +
+
+ implemented_interfaces + repeated Identifier + +
+ +
The interfaces implemented by the target template that have been matched from the interface filter query. Populated only in case interface filters with include_interface_view set. If defined, the identifier uses the package-id reference format. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ offset + int64 + +
+ +
The offset of origin. Offsets are managed by the participant nodes. Transactions can thus NOT be assumed to have the same offsets on different participant nodes. Required, it is a valid absolute offset (positive integer)
+ +
+ +
+
+ node_id + int32 + +
+ +
The position of this event in the originating transaction or reassignment. Node IDs are not necessarily equal across participants, as these may see different projections/parts of transactions. Required, must be valid node ID (non-negative integer)
+ +
+ +
+
+ contract_id + string + +
+ +
The ID of the target contract. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ template_id + Identifier + +
+ +
Identifies the template that defines the executed choice. This template's package-id may differ from the target contract's package-id if the target contract has been upgraded or downgraded. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ interface_id + Identifier + +
+ +
The interface where the choice is defined, if inherited. If defined, the identifier uses the package-id reference format. Optional
+ +
+ +
+
+ choice + string + +
+ +
The choice that was exercised on the target contract. Must be a valid NameString (as described in ``value.proto``). Required
+ +
+ +
+
+ choice_argument + Value + +
+ +
The argument of the exercised choice. Required
+ +
+ +
+
+ acting_parties + repeated string + +
+ +
The parties that exercised the choice. Each element must be a valid PartyIdString (as described in ``value.proto``). Required
+ +
+ +
+
+ consuming + bool + +
+ +
If true, the target contract may no longer be exercised. Required
+ +
+ +
+
+ witness_parties + repeated string + +
+ +
The parties that are notified of this event. The witnesses of an exercise node will depend on whether the exercise was consuming or not. If consuming, the witnesses are the union of the stakeholders, the actors and all informees of all the ancestors of this event this participant knows about. If not consuming, the witnesses are the union of the signatories, the actors and all informees of all the ancestors of this event this participant knows about. In both cases the witnesses are limited to the querying parties, or not limited in case anyParty filters are used. Note that the actors might not necessarily be observers and thus stakeholders. This is the case when the controllers of a choice are specified using "flexible controllers", using the ``choice ... controller`` syntax, and said controllers are not explicitly marked as observers. Each element must be a valid PartyIdString (as described in ``value.proto``). Required
+ +
+ +
+
+ last_descendant_node_id + int32 + +
+ +
Specifies the upper boundary of the node ids of the events in the same transaction that appeared as a result of this ``ExercisedEvent``. This allows unambiguous identification of all the members of the subtree rooted at this node. A full subtree can be constructed when all descendant nodes are present in the stream. If nodes are heavily filtered, it is only possible to determine if a node is in a consequent subtree or not. Required
+ +
+ +
+
+ exercise_result + Value + +
+ +
The result of exercising the choice. Required
+ +
+ +
+
+ package_name + string + +
+ +
The package name of the contract. Required
+ +
+ +
+
+ implemented_interfaces + repeated Identifier + +
+ +
If the event is consuming, the interfaces implemented by the target template that have been matched from the interface filter query. Populated only in case interface filters with include_interface_view set. The identifier uses the package-id reference format. Optional
+ +
+ +
+
+ acs_delta + bool + +
+ +
Whether this event would be part of respective ACS_DELTA shaped stream, and should therefore considered when tracking contract activeness on the client-side. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ traceparent + string + +
+ +
https://www.w3.org/TR/trace-context/
+ +
+ +
+
+ tracestate + string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandsubmissionservice/submit.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandsubmissionservice/submit.mdx new file mode 100644 index 0000000..a316478 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandsubmissionservice/submit.mdx @@ -0,0 +1,820 @@ +--- +title: "Submit" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2

+ + +

Submit

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.CommandSubmissionService/Submit + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.CommandSubmissionService/Submit <<'EOF' +{ + "commands": { + "workflowId": "string", + "userId": "string", + "commandId": "string", + "commands": [ + { + "create": { + "templateId": "string", + "createArguments": "string" + } + } + ], + "deduplicationDuration": "string", + "minLedgerTimeAbs": "string", + "minLedgerTimeRel": "string" + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
CommandSubmissionService
+
+ +
+
RPC
+
Submit
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

SubmitRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.SubmitRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ commands + Commands + +
+ +
The commands to be submitted in a single transaction. Required
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

SubmitResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.SubmitResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ commands + Commands + +
+ +
The commands to be submitted in a single transaction. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ workflow_id + string + +
+ +
Identifier of the on-ledger workflow that this command is a part of. Must be a valid LedgerString (as described in ``value.proto``). Optional
+ +
+ +
+
+ user_id + string + +
+ +
Uniquely identifies the participant user that issued the command. Must be a valid UserIdString (as described in ``value.proto``). Required unless authentication is used with a user token. In that case, the token's user-id will be used for the request's user_id.
+ +
+ +
+
+ command_id + string + +
+ +
Uniquely identifies the command. The triple (user_id, act_as, command_id) constitutes the change ID for the intended ledger change, where act_as is interpreted as a set of party names. The change ID can be used for matching the intended ledger changes with all their completions. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ commands + repeated Command + +
+ +
Individual elements of this atomic command. Must be non-empty. Required
+ +
+ +
+
+ deduplication_duration + Duration + +
+ +
Specifies the length of the deduplication period. It is interpreted relative to the local clock at some point during the submission's processing. Must be non-negative. Must not exceed the maximum deduplication time.
+ +
+ +
+
+ deduplication_offset + int64 + +
+ +
Specifies the start of the deduplication period by a completion stream offset (exclusive). Must be a valid absolute offset (positive integer) or participant begin (zero).
+ +
+ +
+
+ min_ledger_time_abs + Timestamp + +
+ +
Lower bound for the ledger time assigned to the resulting transaction. Note: The ledger time of a transaction is assigned as part of command interpretation. Use this property if you expect that command interpretation will take a considerate amount of time, such that by the time the resulting transaction is sequenced, its assigned ledger time is not valid anymore. Must not be set at the same time as min_ledger_time_rel. Optional
+ +
+ +
+
+ min_ledger_time_rel + Duration + +
+ +
Same as min_ledger_time_abs, but specified as a duration, starting from the time the command is received by the server. Must not be set at the same time as min_ledger_time_abs. Optional
+ +
+ +
+
+ act_as + repeated string + +
+ +
Set of parties on whose behalf the command should be executed. If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request to act on behalf of each of the given parties. Each element must be a valid PartyIdString (as described in ``value.proto``). Required, must be non-empty.
+ +
+ +
+
+ read_as + repeated string + +
+ +
Set of parties on whose behalf (in addition to all parties listed in ``act_as``) contracts can be retrieved. This affects Daml operations such as ``fetch``, ``fetchByKey``, ``lookupByKey``, ``exercise``, and ``exerciseByKey``. Note: A participant node of a Daml network can host multiple parties. Each contract present on the participant node is only visible to a subset of these parties. A command can only use contracts that are visible to at least one of the parties in ``act_as`` or ``read_as``. This visibility check is independent from the Daml authorization rules for fetch operations. If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request to read contract data on behalf of each of the given parties. Optional
+ +
+ +
+
+ submission_id + string + +
+ +
A unique identifier to distinguish completions for different submissions with the same change ID. Typically a random UUID. Applications are expected to use a different UUID for each retry of a submission with the same change ID. Must be a valid LedgerString (as described in ``value.proto``). If omitted, the participant or the committer may set a value of their choice. Optional
+ +
+ +
+
+ disclosed_contracts + repeated DisclosedContract + +
+ +
Additional contracts used to resolve contract & contract key lookups. Optional
+ +
+ +
+
+ synchronizer_id + string + +
+ +
Must be a valid synchronizer id Optional
+ +
+ +
+
+ package_id_selection_preference + repeated string + +
+ +
The package-id selection preference of the client for resolving package names and interface instances in command submission and interpretation
+ +
+ +
+
+ prefetch_contract_keys + repeated PrefetchContractKey + +
+ +
Fetches the contract keys into the caches to speed up the command processing. Should only contain contract keys that are expected to be resolved during interpretation of the commands. Keys of disclosed contracts do not need prefetching. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ create + CreateCommand + +
+ +
+ +
+
+ exercise + ExerciseCommand + +
+ +
+ +
+
+ exercise_by_key + ExerciseByKeyCommand + +
+ +
+ +
+
+ create_and_exercise + CreateAndExerciseCommand + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template of contract the client wants to create. Both package-name and package-id reference identifier formats for the template-id are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ create_arguments + Record + +
+ +
The arguments required for creating a contract from this template. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template or interface of the contract the client wants to exercise. Both package-name and package-id reference identifier formats for the template-id are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. To exercise a choice on an interface, specify the interface identifier in the template_id field. Required
+ +
+ +
+
+ contract_id + string + +
+ +
The ID of the contract the client wants to exercise upon. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ choice + string + +
+ +
The name of the choice the client wants to exercise. Must be a valid NameString (as described in ``value.proto``) Required
+ +
+ +
+
+ choice_argument + Value + +
+ +
The argument for this choice. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template of contract the client wants to exercise. Both package-name and package-id reference identifier formats for the template-id are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ contract_key + Value + +
+ +
The key of the contract the client wants to exercise upon. Required
+ +
+ +
+
+ choice + string + +
+ +
The name of the choice the client wants to exercise. Must be a valid NameString (as described in ``value.proto``) Required
+ +
+ +
+
+ choice_argument + Value + +
+ +
The argument for this choice. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template of the contract the client wants to create. Both package-name and package-id reference identifier formats for the template-id are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ create_arguments + Record + +
+ +
The arguments required for creating a contract from this template. Required
+ +
+ +
+
+ choice + string + +
+ +
The name of the choice the client wants to exercise. Must be a valid NameString (as described in ``value.proto``). Required
+ +
+ +
+
+ choice_argument + Value + +
+ +
The argument for this choice. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template id of the contract. The identifier uses the package-id reference format. If provided, used to validate the template id of the contract serialized in the created_event_blob. Optional
+ +
+ +
+
+ contract_id + string + +
+ +
The contract id If provided, used to validate the contract id of the contract serialized in the created_event_blob. Optional
+ +
+ +
+
+ created_event_blob + bytes + +
+ +
Opaque byte string containing the complete payload required by the Daml engine to reconstruct a contract not known to the receiving participant. Required
+ +
+ +
+
+ synchronizer_id + string + +
+ +
The ID of the synchronizer where the contract is currently assigned Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template of contract the client wants to prefetch. Both package-name and package-id reference identifier formats for the template-id are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ contract_key + Value + +
+ +
The key of the contract the client wants to prefetch. Required
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandsubmissionservice/submitreassignment.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandsubmissionservice/submitreassignment.mdx new file mode 100644 index 0000000..fb91d06 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandsubmissionservice/submitreassignment.mdx @@ -0,0 +1,497 @@ +--- +title: "SubmitReassignment" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2

+ + +

SubmitReassignment

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.CommandSubmissionService/SubmitReassignment + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.CommandSubmissionService/SubmitReassignment <<'EOF' +{ + "reassignmentCommands": { + "workflowId": "string", + "userId": "string", + "commandId": "string", + "submitter": "string", + "submissionId": "string", + "commands": [ + { + "unassignCommand": { + "contractId": "string", + "source": "string", + "target": "string" + } + } + ] + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
CommandSubmissionService
+
+ +
+
RPC
+
SubmitReassignment
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

SubmitReassignmentRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.SubmitReassignmentRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ reassignment_commands + ReassignmentCommands + +
+ +
The reassignment command to be submitted. Required
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

SubmitReassignmentResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.SubmitReassignmentResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ reassignment_commands + ReassignmentCommands + +
+ +
The reassignment command to be submitted. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ workflow_id + string + +
+ +
Identifier of the on-ledger workflow that this command is a part of. Must be a valid LedgerString (as described in ``value.proto``). Optional
+ +
+ +
+
+ user_id + string + +
+ +
Uniquely identifies the participant user that issued the command. Must be a valid UserIdString (as described in ``value.proto``). Required unless authentication is used with a user token. In that case, the token's user-id will be used for the request's user_id.
+ +
+ +
+
+ command_id + string + +
+ +
Uniquely identifies the command. The triple (user_id, submitter, command_id) constitutes the change ID for the intended ledger change. The change ID can be used for matching the intended ledger changes with all their completions. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ submitter + string + +
+ +
Party on whose behalf the command should be executed. If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request to act on behalf of the given party. Must be a valid PartyIdString (as described in ``value.proto``). Required
+ +
+ +
+
+ submission_id + string + +
+ +
A unique identifier to distinguish completions for different submissions with the same change ID. Typically a random UUID. Applications are expected to use a different UUID for each retry of a submission with the same change ID. Must be a valid LedgerString (as described in ``value.proto``). If omitted, the participant or the committer may set a value of their choice. Optional
+ +
+ +
+
+ commands + repeated ReassignmentCommand + +
+ +
Individual elements of this reassignment. Must be non-empty.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ unassign_command + UnassignCommand + +
+ +
+ +
+
+ assign_command + AssignCommand + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ contract_id + string + +
+ +
The ID of the contract the client wants to unassign. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ source + string + +
+ +
The ID of the source synchronizer Must be a valid synchronizer id Required
+ +
+ +
+
+ target + string + +
+ +
The ID of the target synchronizer Must be a valid synchronizer id Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ reassignment_id + string + +
+ +
The ID from the unassigned event to be completed by this assignment. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ source + string + +
+ +
The ID of the source synchronizer Must be a valid synchronizer id Required
+ +
+ +
+
+ target + string + +
+ +
The ID of the target synchronizer Must be a valid synchronizer id Required
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/contractservice/getcontract.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/contractservice/getcontract.mdx new file mode 100644 index 0000000..cc6d970 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/contractservice/getcontract.mdx @@ -0,0 +1,576 @@ +--- +title: "GetContract" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2

+ + +

GetContract

+ + + +
+ + gRPC + + Since 3.4.11 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.ContractService/GetContract + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.ContractService/GetContract <<'EOF' +{ + "contractId": "string", + "queryingParties": [ + "string" + ] +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "createdEvent": { + "offset": "0", + "nodeId": 0, + "contractId": "string", + "templateId": "string", + "contractKey": "string", + "createArguments": "string", + "createdEventBlob": "BASE64_ENCODED_BYTES", + "interfaceViews": [ + { + "interfaceId": "string", + "viewStatus": "string", + "viewValue": "string" + } + ] + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
ContractService
+
+ +
+
RPC
+
GetContract
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetContractRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.GetContractRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ contract_id + string + +
+ +
The ID of the contract. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ querying_parties + repeated string + +
+ +
The list of querying parties The stakeholders of the referenced contract must have an intersection with any of these parties to return the result. Optional, if no querying_parties specified, all possible contracts could be returned.
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

GetContractResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.GetContractResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ created_event + CreatedEvent + +
+ +
The representative_package_id will be always set to the contract package ID, therefore this endpoint should not be used to lookup contract which entered the participant via party replication or repair service. The witnesses field will contain only the querying_parties which are also stakeholders of the contract as well. The following fields of the created event cannot be populated, so those should not be used / parsed: - offset - node_id - created_event_blob - interface_views - acs_delta Required
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.11 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ contract_id + string + +
+ +
The ID of the contract. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ querying_parties + repeated string + +
+ +
The list of querying parties The stakeholders of the referenced contract must have an intersection with any of these parties to return the result. Optional, if no querying_parties specified, all possible contracts could be returned.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ created_event + CreatedEvent + +
+ +
The representative_package_id will be always set to the contract package ID, therefore this endpoint should not be used to lookup contract which entered the participant via party replication or repair service. The witnesses field will contain only the querying_parties which are also stakeholders of the contract as well. The following fields of the created event cannot be populated, so those should not be used / parsed: - offset - node_id - created_event_blob - interface_views - acs_delta Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ offset + int64 + +
+ +
The offset of origin, which has contextual meaning, please see description at messages that include a CreatedEvent. Offsets are managed by the participant nodes. Transactions can thus NOT be assumed to have the same offsets on different participant nodes. Required, it is a valid absolute offset (positive integer)
+ +
+ +
+
+ node_id + int32 + +
+ +
The position of this event in the originating transaction or reassignment. The origin has contextual meaning, please see description at messages that include a CreatedEvent. Node IDs are not necessarily equal across participants, as these may see different projections/parts of transactions. Required, must be valid node ID (non-negative integer)
+ +
+ +
+
+ contract_id + string + +
+ +
The ID of the created contract. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ template_id + Identifier + +
+ +
The template of the created contract. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ contract_key + Value + +
+ +
The key of the created contract. This will be set if and only if ``template_id`` defines a contract key. Optional
+ +
+ +
+
+ create_arguments + Record + +
+ +
The arguments that have been used to create the contract. Required
+ +
+ +
+
+ created_event_blob + bytes + +
+ +
Opaque representation of contract create event payload intended for forwarding to an API server as a contract disclosed as part of a command submission. Optional
+ +
+ +
+
+ interface_views + repeated InterfaceView + +
+ +
Interface views specified in the transaction filter. Includes an ``InterfaceView`` for each interface for which there is a ``InterfaceFilter`` with - its party in the ``witness_parties`` of this event, - and which is implemented by the template of this event, - and which has ``include_interface_view`` set. Optional
+ +
+ +
+
+ witness_parties + repeated string + +
+ +
The parties that are notified of this event. When a ``CreatedEvent`` is returned as part of a transaction tree or ledger-effects transaction, this will include all the parties specified in the ``TransactionFilter`` that are witnesses of the event (the stakeholders of the contract and all informees of all the ancestors of this create action that this participant knows about). If served as part of a ACS delta transaction those will be limited to all parties specified in the ``TransactionFilter`` that are stakeholders of the contract (i.e. either signatories or observers). If the ``CreatedEvent`` is returned as part of an AssignedEvent, ActiveContract or IncompleteUnassigned (so the event is related to an assignment or unassignment): this will include all parties of the ``TransactionFilter`` that are stakeholders of the contract. The behavior of reading create events visible to parties not hosted on the participant node serving the Ledger API is undefined. Concretely, there is neither a guarantee that the participant node will serve all their create events on the ACS stream, nor is there a guarantee that matching archive events are delivered for such create events. For most clients this is not a problem, as they only read events for parties that are hosted on the participant node. If you need to read events for parties that may not be hosted at all times on the participant node, subscribe to the ``TopologyEvent``s for that party by setting a corresponding ``UpdateFormat``. Using these events, query the ACS as-of an offset where the party is hosted on the participant node, and ignore create events at offsets where the party is not hosted on the participant node. Required
+ +
+ +
+
+ signatories + repeated string + +
+ +
The signatories for this contract as specified by the template. Required
+ +
+ +
+
+ observers + repeated string + +
+ +
The observers for this contract as specified explicitly by the template or implicitly as choice controllers. This field never contains parties that are signatories. Required
+ +
+ +
+
+ created_at + Timestamp + +
+ +
Ledger effective time of the transaction that created the contract. Required
+ +
+ +
+
+ package_name + string + +
+ +
The package name of the created contract. Required
+ +
+ +
+
+ acs_delta + bool + +
+ +
Whether this event would be part of respective ACS_DELTA shaped stream, and should therefore considered when tracking contract activeness on the client-side. Required
+ +
+ +
+
+ representative_package_id + string + +
+ +
A package-id present in the participant package store that typechecks the contract's argument. This may differ from the package-id of the template used to create the contract. For contracts created before Canton 3.4, this field matches the contract's creation package-id. NOTE: Experimental, server internal concept, not for client consumption. Subject to change without notice. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ interface_id + Identifier + +
+ +
The interface implemented by the matched event. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ view_status + Status + +
+ +
Whether the view was successfully computed, and if not, the reason for the error. The error is reported using the same rules for error codes and messages as the errors returned for API requests. Required
+ +
+ +
+
+ view_value + Record + +
+ +
The value of the interface's view method on this event. Set if it was requested in the ``InterfaceFilter`` and it could be successfully computed. Optional
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/eventqueryservice/geteventsbycontractid.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/eventqueryservice/geteventsbycontractid.mdx new file mode 100644 index 0000000..e6e9d04 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/eventqueryservice/geteventsbycontractid.mdx @@ -0,0 +1,1016 @@ +--- +title: "GetEventsByContractId" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2

+ + +

GetEventsByContractId

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.EventQueryService/GetEventsByContractId + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.EventQueryService/GetEventsByContractId <<'EOF' +{ + "contractId": "string", + "eventFormat": { + "filtersByParty": [ + { + "key": { + "cumulative": [ + { + "wildcardFilter": {} + } + ] + } + } + ], + "filtersForAnyParty": { + "cumulative": [ + { + "wildcardFilter": {} + } + ] + }, + "verbose": true + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "created": { + "createdEvent": { + "offset": "0", + "nodeId": 0, + "contractId": "string", + "templateId": "string", + "contractKey": "string", + "createArguments": "string", + "createdEventBlob": "BASE64_ENCODED_BYTES", + "interfaceViews": [ + { + "interfaceId": "string", + "viewStatus": "string", + "viewValue": "string" + } + ] + }, + "synchronizerId": "string" + }, + "archived": { + "archivedEvent": { + "offset": "0", + "nodeId": 0, + "contractId": "string", + "templateId": "string", + "witnessParties": [ + "string" + ], + "packageName": "string", + "implementedInterfaces": [ + "string" + ] + }, + "synchronizerId": "string" + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
EventQueryService
+
+ +
+
RPC
+
GetEventsByContractId
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetEventsByContractIdRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.GetEventsByContractIdRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ contract_id + string + +
+ +
The contract id being queried. Required
+ +
+ +
+
+ event_format + EventFormat + +
+ +
Format of the events in the result, the presentation will be of TRANSACTION_SHAPE_ACS_DELTA. Required
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

GetEventsByContractIdResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.GetEventsByContractIdResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ created + Created + +
+ +
The create event for the contract with the ``contract_id`` given in the request provided it exists and has not yet been pruned. Optional
+ +
+ +
+
+ archived + Archived + +
+ +
The archive event for the contract with the ``contract_id`` given in the request provided such an archive event exists and it has not yet been pruned. Optional
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ contract_id + string + +
+ +
The contract id being queried. Required
+ +
+ +
+
+ event_format + EventFormat + +
+ +
Format of the events in the result, the presentation will be of TRANSACTION_SHAPE_ACS_DELTA. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ filters_by_party + repeated map + +
+ +
Each key must be a valid PartyIdString (as described in ``value.proto``). The interpretation of the filter depends on the transaction-shape being filtered: 1. For **ledger-effects** create and exercise events are returned, for which the witnesses include at least one of the listed parties and match the per-party filter. 2. For **transaction and active-contract-set streams** create and archive events are returned for all contracts whose stakeholders include at least one of the listed parties and match the per-party filter. Optional
+ +
+ +
+
+ filters_for_any_party + Filters + +
+ +
Wildcard filters that apply to all the parties existing on the participant. The interpretation of the filters is the same with the per-party filter as described above. Optional
+ +
+ +
+
+ verbose + bool + +
+ +
If enabled, values served over the API will contain more information than strictly necessary to interpret the data. In particular, setting the verbose flag to true triggers the ledger to include labels for record fields. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ cumulative + repeated CumulativeFilter + +
+ +
Every filter in the cumulative list expands the scope of the resulting stream. Each interface, template or wildcard filter means additional events that will match the query. The impact of include_interface_view and include_created_event_blob fields in the filters will also be accumulated. A template or an interface SHOULD NOT appear twice in the accumulative field. A wildcard filter SHOULD NOT be defined more than once in the accumulative field. Optional, if no ``CumulativeFilter`` defined, the default of a single ``WildcardFilter`` with include_created_event_blob unset is used.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ wildcard_filter + WildcardFilter + +
+ +
A wildcard filter that matches all templates Optional
+ +
+ +
+
+ interface_filter + InterfaceFilter + +
+ +
Include an ``InterfaceView`` for every ``InterfaceFilter`` matching a contract. The ``InterfaceFilter`` instances MUST each use a unique ``interface_id``. Optional
+ +
+ +
+
+ template_filter + TemplateFilter + +
+ +
A template for which the data will be included in the ``create_arguments`` of a matching ``CreatedEvent``. If a contract is simultaneously selected by a template filter and one or more interface filters, the corresponding ``include_created_event_blob`` are consolidated using an OR operation. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ include_created_event_blob + bool + +
+ +
Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``. Use this to access the contract create event payload in your API client for submitting it as a disclosed contract with future commands. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ interface_id + Identifier + +
+ +
The interface that a matching contract must implement. The ``interface_id`` needs to be valid: corresponding interface should be defined in one of the available packages at the time of the query. Both package-name and package-id reference formats for the identifier are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ include_interface_view + bool + +
+ +
Whether to include the interface view on the contract in the returned ``CreatedEvent``. Use this to access contract data in a uniform manner in your API client. Optional
+ +
+ +
+
+ include_created_event_blob + bool + +
+ +
Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``. Use this to access the contract create event payload in your API client for submitting it as a disclosed contract with future commands. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ template_id + Identifier + +
+ +
A template for which the payload should be included in the response. The ``template_id`` needs to be valid: corresponding template should be defined in one of the available packages at the time of the query. Both package-name and package-id reference formats for the identifier are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ include_created_event_blob + bool + +
+ +
Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``. Use this to access the contract event payload in your API client for submitting it as a disclosed contract with future commands. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ created + Created + +
+ +
The create event for the contract with the ``contract_id`` given in the request provided it exists and has not yet been pruned. Optional
+ +
+ +
+
+ archived + Archived + +
+ +
The archive event for the contract with the ``contract_id`` given in the request provided such an archive event exists and it has not yet been pruned. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ created_event + CreatedEvent + +
+ +
Required The event as it appeared in the context of its original update (i.e. daml transaction or reassignment) on this participant node. You can use its offset and node_id to find the corresponding update and the node within it.
+ +
+ +
+
+ synchronizer_id + string + +
+ +
The synchronizer which sequenced the creation of the contract Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ offset + int64 + +
+ +
The offset of origin, which has contextual meaning, please see description at messages that include a CreatedEvent. Offsets are managed by the participant nodes. Transactions can thus NOT be assumed to have the same offsets on different participant nodes. Required, it is a valid absolute offset (positive integer)
+ +
+ +
+
+ node_id + int32 + +
+ +
The position of this event in the originating transaction or reassignment. The origin has contextual meaning, please see description at messages that include a CreatedEvent. Node IDs are not necessarily equal across participants, as these may see different projections/parts of transactions. Required, must be valid node ID (non-negative integer)
+ +
+ +
+
+ contract_id + string + +
+ +
The ID of the created contract. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ template_id + Identifier + +
+ +
The template of the created contract. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ contract_key + Value + +
+ +
The key of the created contract. This will be set if and only if ``template_id`` defines a contract key. Optional
+ +
+ +
+
+ create_arguments + Record + +
+ +
The arguments that have been used to create the contract. Required
+ +
+ +
+
+ created_event_blob + bytes + +
+ +
Opaque representation of contract create event payload intended for forwarding to an API server as a contract disclosed as part of a command submission. Optional
+ +
+ +
+
+ interface_views + repeated InterfaceView + +
+ +
Interface views specified in the transaction filter. Includes an ``InterfaceView`` for each interface for which there is a ``InterfaceFilter`` with - its party in the ``witness_parties`` of this event, - and which is implemented by the template of this event, - and which has ``include_interface_view`` set. Optional
+ +
+ +
+
+ witness_parties + repeated string + +
+ +
The parties that are notified of this event. When a ``CreatedEvent`` is returned as part of a transaction tree or ledger-effects transaction, this will include all the parties specified in the ``TransactionFilter`` that are witnesses of the event (the stakeholders of the contract and all informees of all the ancestors of this create action that this participant knows about). If served as part of a ACS delta transaction those will be limited to all parties specified in the ``TransactionFilter`` that are stakeholders of the contract (i.e. either signatories or observers). If the ``CreatedEvent`` is returned as part of an AssignedEvent, ActiveContract or IncompleteUnassigned (so the event is related to an assignment or unassignment): this will include all parties of the ``TransactionFilter`` that are stakeholders of the contract. The behavior of reading create events visible to parties not hosted on the participant node serving the Ledger API is undefined. Concretely, there is neither a guarantee that the participant node will serve all their create events on the ACS stream, nor is there a guarantee that matching archive events are delivered for such create events. For most clients this is not a problem, as they only read events for parties that are hosted on the participant node. If you need to read events for parties that may not be hosted at all times on the participant node, subscribe to the ``TopologyEvent``s for that party by setting a corresponding ``UpdateFormat``. Using these events, query the ACS as-of an offset where the party is hosted on the participant node, and ignore create events at offsets where the party is not hosted on the participant node. Required
+ +
+ +
+
+ signatories + repeated string + +
+ +
The signatories for this contract as specified by the template. Required
+ +
+ +
+
+ observers + repeated string + +
+ +
The observers for this contract as specified explicitly by the template or implicitly as choice controllers. This field never contains parties that are signatories. Required
+ +
+ +
+
+ created_at + Timestamp + +
+ +
Ledger effective time of the transaction that created the contract. Required
+ +
+ +
+
+ package_name + string + +
+ +
The package name of the created contract. Required
+ +
+ +
+
+ acs_delta + bool + +
+ +
Whether this event would be part of respective ACS_DELTA shaped stream, and should therefore considered when tracking contract activeness on the client-side. Required
+ +
+ +
+
+ representative_package_id + string + +
+ +
A package-id present in the participant package store that typechecks the contract's argument. This may differ from the package-id of the template used to create the contract. For contracts created before Canton 3.4, this field matches the contract's creation package-id. NOTE: Experimental, server internal concept, not for client consumption. Subject to change without notice. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ interface_id + Identifier + +
+ +
The interface implemented by the matched event. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ view_status + Status + +
+ +
Whether the view was successfully computed, and if not, the reason for the error. The error is reported using the same rules for error codes and messages as the errors returned for API requests. Required
+ +
+ +
+
+ view_value + Record + +
+ +
The value of the interface's view method on this event. Set if it was requested in the ``InterfaceFilter`` and it could be successfully computed. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ archived_event + ArchivedEvent + +
+ +
Required
+ +
+ +
+
+ synchronizer_id + string + +
+ +
Required The synchronizer which sequenced the archival of the contract
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ offset + int64 + +
+ +
The offset of origin. Offsets are managed by the participant nodes. Transactions can thus NOT be assumed to have the same offsets on different participant nodes. Required, it is a valid absolute offset (positive integer)
+ +
+ +
+
+ node_id + int32 + +
+ +
The position of this event in the originating transaction or reassignment. Node IDs are not necessarily equal across participants, as these may see different projections/parts of transactions. Required, must be valid node ID (non-negative integer)
+ +
+ +
+
+ contract_id + string + +
+ +
The ID of the archived contract. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ template_id + Identifier + +
+ +
Identifies the template that defines the choice that archived the contract. This template's package-id may differ from the target contract's package-id if the target contract has been upgraded or downgraded. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ witness_parties + repeated string + +
+ +
The parties that are notified of this event. For an ``ArchivedEvent``, these are the intersection of the stakeholders of the contract in question and the parties specified in the ``TransactionFilter``. The stakeholders are the union of the signatories and the observers of the contract. Each one of its elements must be a valid PartyIdString (as described in ``value.proto``). Required
+ +
+ +
+
+ package_name + string + +
+ +
The package name of the contract. Required
+ +
+ +
+
+ implemented_interfaces + repeated Identifier + +
+ +
The interfaces implemented by the target template that have been matched from the interface filter query. Populated only in case interface filters with include_interface_view set. If defined, the identifier uses the package-id reference format. Optional
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/getpackage.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/getpackage.mdx new file mode 100644 index 0000000..0370e15 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/getpackage.mdx @@ -0,0 +1,373 @@ +--- +title: "GetPackage" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2

+ + +

GetPackage

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.PackageService/GetPackage + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.PackageService/GetPackage <<'EOF' +{ + "packageId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "hashFunction": "HASH_FUNCTION_SHA256", + "archivePayload": "BASE64_ENCODED_BYTES", + "hash": "string" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PackageService
+
+ +
+
RPC
+
GetPackage
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetPackageRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.GetPackageRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ package_id + string + +
+ +
The ID of the requested package. Must be a valid PackageIdString (as described in ``value.proto``). Required
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

GetPackageResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.GetPackageResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ hash_function + HashFunction + +
+ +
The hash function we use to calculate the hash. Required
+ +
+ +
+
+ archive_payload + bytes + +
+ +
Contains a ``daml_lf`` ArchivePayload. See further details in ``daml_lf.proto``. Required
+ +
+ +
+
+ hash + string + +
+ +
The hash of the archive payload, can also used as a ``package_id``. Must be a valid PackageIdString (as described in ``value.proto``). Required
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ package_id + string + +
+ +
The ID of the requested package. Must be a valid PackageIdString (as described in ``value.proto``). Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ hash_function + HashFunction + +
+ +
The hash function we use to calculate the hash. Required
+ +
+ +
+
+ archive_payload + bytes + +
+ +
Contains a ``daml_lf`` ArchivePayload. See further details in ``daml_lf.proto``. Required
+ +
+ +
+
+ hash + string + +
+ +
The hash of the archive payload, can also used as a ``package_id``. Must be a valid PackageIdString (as described in ``value.proto``). Required
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • HASH_FUNCTION_SHA256
    • + +
+ + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/getpackagestatus.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/getpackagestatus.mdx new file mode 100644 index 0000000..a284e24 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/getpackagestatus.mdx @@ -0,0 +1,329 @@ +--- +title: "GetPackageStatus" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2

+ + +

GetPackageStatus

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.PackageService/GetPackageStatus + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.PackageService/GetPackageStatus <<'EOF' +{ + "packageId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "packageStatus": "PACKAGE_STATUS_UNSPECIFIED" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PackageService
+
+ +
+
RPC
+
GetPackageStatus
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetPackageStatusRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.GetPackageStatusRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ package_id + string + +
+ +
The ID of the requested package. Must be a valid PackageIdString (as described in ``value.proto``). Required
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

GetPackageStatusResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.GetPackageStatusResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ package_status + PackageStatus + +
+ +
The status of the package.
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ package_id + string + +
+ +
The ID of the requested package. Must be a valid PackageIdString (as described in ``value.proto``). Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ package_status + PackageStatus + +
+ +
The status of the package.
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • PACKAGE_STATUS_UNSPECIFIED
    • + +
  • PACKAGE_STATUS_REGISTERED
    • + +
+ + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/listpackages.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/listpackages.mdx new file mode 100644 index 0000000..a6eda10 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/listpackages.mdx @@ -0,0 +1,282 @@ +--- +title: "ListPackages" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2

+ + +

ListPackages

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.PackageService/ListPackages + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.PackageService/ListPackages <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "packageIds": [ + "string" + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PackageService
+
+ +
+
RPC
+
ListPackages
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ListPackagesRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.ListPackagesRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

ListPackagesResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.ListPackagesResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ package_ids + repeated string + +
+ +
The IDs of all Daml-LF packages supported by the server. Each element must be a valid PackageIdString (as described in ``value.proto``). Required
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ package_ids + repeated string + +
+ +
The IDs of all Daml-LF packages supported by the server. Each element must be a valid PackageIdString (as described in ``value.proto``). Required
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/listvettedpackages.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/listvettedpackages.mdx new file mode 100644 index 0000000..964ac8f --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/listvettedpackages.mdx @@ -0,0 +1,628 @@ +--- +title: "ListVettedPackages" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2

+ + +

ListVettedPackages

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.PackageService/ListVettedPackages + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.PackageService/ListVettedPackages <<'EOF' +{ + "packageMetadataFilter": { + "packageIds": [ + "string" + ], + "packageNamePrefixes": [ + "string" + ] + }, + "topologyStateFilter": { + "participantIds": [ + "string" + ], + "synchronizerIds": [ + "string" + ] + }, + "pageToken": "string", + "pageSize": 0 +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "vettedPackages": [ + { + "packages": [ + { + "packageId": "string", + "validFromInclusive": "string", + "validUntilExclusive": "string", + "packageName": "string", + "packageVersion": "string" + } + ], + "participantId": "string", + "synchronizerId": "string", + "topologySerial": 0 + } + ], + "nextPageToken": "string" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PackageService
+
+ +
+
RPC
+
ListVettedPackages
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ListVettedPackagesRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.ListVettedPackagesRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ package_metadata_filter + PackageMetadataFilter + +
+ +
The package metadata filter the returned vetted packages set must satisfy. Optional
+ +
+ +
+
+ topology_state_filter + TopologyStateFilter + +
+ +
The topology filter the returned vetted packages set must satisfy. Optional
+ +
+ +
+
+ page_token + string + +
+ +
Pagination token to determine the specific page to fetch. Using the token guarantees that ``VettedPackages`` on a subsequent page are all greater (``VettedPackages`` are sorted by synchronizer ID then participant ID) than the last ``VettedPackages`` on a previous page. The server does not store intermediate results between calls chained by a series of page tokens. As a consequence, if new vetted packages are being added and a page is requested twice using the same token, more packages can be returned on the second call. Leave unspecified (i.e. as empty string) to fetch the first page. Optional
+ +
+ +
+
+ page_size + uint32 + +
+ +
Maximum number of ``VettedPackages`` results to return in a single page. If the page_size is unspecified (i.e. left as 0), the server will decide the number of results to be returned. If the page_size exceeds the maximum supported by the server, an error will be returned. To obtain the server's maximum consult the PackageService descriptor available in the VersionService. Optional
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ListVettedPackagesResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.ListVettedPackagesResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ vetted_packages + repeated VettedPackages + +
+ +
All ``VettedPackages`` that contain at least one ``VettedPackage`` matching both a ``PackageMetadataFilter`` and a ``TopologyStateFilter``. Sorted by synchronizer_id then participant_id.
+ +
+ +
+
+ next_page_token + string + +
+ +
Pagination token to retrieve the next page. Empty string if there are no further results.
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ package_metadata_filter + PackageMetadataFilter + +
+ +
The package metadata filter the returned vetted packages set must satisfy. Optional
+ +
+ +
+
+ topology_state_filter + TopologyStateFilter + +
+ +
The topology filter the returned vetted packages set must satisfy. Optional
+ +
+ +
+
+ page_token + string + +
+ +
Pagination token to determine the specific page to fetch. Using the token guarantees that ``VettedPackages`` on a subsequent page are all greater (``VettedPackages`` are sorted by synchronizer ID then participant ID) than the last ``VettedPackages`` on a previous page. The server does not store intermediate results between calls chained by a series of page tokens. As a consequence, if new vetted packages are being added and a page is requested twice using the same token, more packages can be returned on the second call. Leave unspecified (i.e. as empty string) to fetch the first page. Optional
+ +
+ +
+
+ page_size + uint32 + +
+ +
Maximum number of ``VettedPackages`` results to return in a single page. If the page_size is unspecified (i.e. left as 0), the server will decide the number of results to be returned. If the page_size exceeds the maximum supported by the server, an error will be returned. To obtain the server's maximum consult the PackageService descriptor available in the VersionService. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ package_ids + repeated string + +
+ +
If this list is non-empty, any vetted package with a package ID in this list will match the filter.
+ +
+ +
+
+ package_name_prefixes + repeated string + +
+ +
If this list is non-empty, any vetted package with a name matching at least one prefix in this list will match the filter.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ participant_ids + repeated string + +
+ +
If this list is non-empty, only vetted packages hosted on participants listed in this field match the filter. Query the current Ledger API's participant's ID via the public ``GetParticipantId`` command in ``PartyManagementService``.
+ +
+ +
+
+ synchronizer_ids + repeated string + +
+ +
If this list is non-empty, only vetted packages from the topology state of the synchronizers in this list match the filter.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ vetted_packages + repeated VettedPackages + +
+ +
All ``VettedPackages`` that contain at least one ``VettedPackage`` matching both a ``PackageMetadataFilter`` and a ``TopologyStateFilter``. Sorted by synchronizer_id then participant_id.
+ +
+ +
+
+ next_page_token + string + +
+ +
Pagination token to retrieve the next page. Empty string if there are no further results.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ packages + repeated VettedPackage + +
+ +
Sorted by package_name and package_version where known, and package_id as a last resort.
+ +
+ +
+
+ participant_id + string + +
+ +
Participant on which these packages are vetted. Always present.
+ +
+ +
+
+ synchronizer_id + string + +
+ +
Synchronizer on which these packages are vetted. Always present.
+ +
+ +
+
+ topology_serial + uint32 + +
+ +
Serial of last ``VettedPackages`` topology transaction of this participant and on this synchronizer. Always present.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ package_id + string + +
+ +
Package ID of this package. Always present.
+ +
+ +
+
+ valid_from_inclusive + Timestamp + +
+ +
The time from which this package is vetted. Empty if vetting time has no lower bound.
+ +
+ +
+
+ valid_until_exclusive + Timestamp + +
+ +
The time until which this package is vetted. Empty if vetting time has no upper bound.
+ +
+ +
+
+ package_name + string + +
+ +
Name of this package. Only available if the package has been uploaded to the current participant. If unavailable, is empty string.
+ +
+ +
+
+ package_version + string + +
+ +
Version of this package. Only available if the package has been uploaded to the current participant. If unavailable, is empty string.
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getactivecontracts.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getactivecontracts.mdx new file mode 100644 index 0000000..cd6ff0f --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getactivecontracts.mdx @@ -0,0 +1,1216 @@ +--- +title: "GetActiveContracts" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2

+ + +

GetActiveContracts

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.StateService/GetActiveContracts + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.StateService/GetActiveContracts <<'EOF' +{ + "activeAtOffset": "0", + "eventFormat": { + "filtersByParty": [ + { + "key": { + "cumulative": [ + { + "wildcardFilter": {} + } + ] + } + } + ], + "filtersForAnyParty": { + "cumulative": [ + { + "wildcardFilter": {} + } + ] + }, + "verbose": true + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "workflowId": "string", + "activeContract": { + "createdEvent": { + "offset": "0", + "nodeId": 0, + "contractId": "string", + "templateId": "string", + "contractKey": "string", + "createArguments": "string", + "createdEventBlob": "BASE64_ENCODED_BYTES", + "interfaceViews": [ + { + "interfaceId": "string", + "viewStatus": "string", + "viewValue": "string" + } + ] + }, + "synchronizerId": "string", + "reassignmentCounter": "0" + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
StateService
+
+ +
+
RPC
+
GetActiveContracts
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
Yes
+
+ +
+ + +## Inputs + + +
+
+

GetActiveContractsRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.GetActiveContractsRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ active_at_offset + int64 + +
+ +
The offset at which the snapshot of the active contracts will be computed. Must be no greater than the current ledger end offset. Must be greater than or equal to the last pruning offset. Required, must be a valid absolute offset (positive integer) or ledger begin offset (zero). If zero, the empty set will be returned.
+ +
+ +
+
+ event_format + EventFormat + +
+ +
Format of the contract_entries in the result. In case of CreatedEvent the presentation will be of TRANSACTION_SHAPE_ACS_DELTA. Optional for backwards compatibility, defaults to an EventFormat where: - filters_by_party is the filter.filters_by_party from this request - filters_for_any_party is the filter.filters_for_any_party from this request - verbose is the verbose field from this request
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

GetActiveContractsResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.GetActiveContractsResponse
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + +
+ +
+
+ workflow_id + string + +
+ +
The workflow ID used in command submission which corresponds to the contract_entry. Only set if the ``workflow_id`` for the command was set. Must be a valid LedgerString (as described in ``value.proto``). Optional
+ +
+ +
+
+ active_contract + ActiveContract + +
+ +
The contract is active on the assigned synchronizer, meaning: there was an activation event on the given synchronizer ( created, assigned), which is not followed by a deactivation event (archived, unassigned) on the same synchronizer, until the active_at_offset. Since activeness is defined as a per synchronizer concept, it is possible, that a contract is active on one synchronizer, but already archived on another. There will be one such message for each synchronizer the contract is active on.
+ +
+ +
+
+ incomplete_unassigned + IncompleteUnassigned + +
+ +
Included iff the unassigned event was before or at the active_at_offset, but there was no corresponding assigned event before or at the active_at_offset.
+ +
+ +
+
+ incomplete_assigned + IncompleteAssigned + +
+ +
Important: this message is not indicating that the contract is active on the target synchronizer! Included iff the assigned event was before or at the active_at_offset, but there was no corresponding unassigned event before or at the active_at_offset.
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ active_at_offset + int64 + +
+ +
The offset at which the snapshot of the active contracts will be computed. Must be no greater than the current ledger end offset. Must be greater than or equal to the last pruning offset. Required, must be a valid absolute offset (positive integer) or ledger begin offset (zero). If zero, the empty set will be returned.
+ +
+ +
+
+ event_format + EventFormat + +
+ +
Format of the contract_entries in the result. In case of CreatedEvent the presentation will be of TRANSACTION_SHAPE_ACS_DELTA. Optional for backwards compatibility, defaults to an EventFormat where: - filters_by_party is the filter.filters_by_party from this request - filters_for_any_party is the filter.filters_for_any_party from this request - verbose is the verbose field from this request
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ filters_by_party + repeated map + +
+ +
Each key must be a valid PartyIdString (as described in ``value.proto``). The interpretation of the filter depends on the transaction-shape being filtered: 1. For **ledger-effects** create and exercise events are returned, for which the witnesses include at least one of the listed parties and match the per-party filter. 2. For **transaction and active-contract-set streams** create and archive events are returned for all contracts whose stakeholders include at least one of the listed parties and match the per-party filter. Optional
+ +
+ +
+
+ filters_for_any_party + Filters + +
+ +
Wildcard filters that apply to all the parties existing on the participant. The interpretation of the filters is the same with the per-party filter as described above. Optional
+ +
+ +
+
+ verbose + bool + +
+ +
If enabled, values served over the API will contain more information than strictly necessary to interpret the data. In particular, setting the verbose flag to true triggers the ledger to include labels for record fields. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ cumulative + repeated CumulativeFilter + +
+ +
Every filter in the cumulative list expands the scope of the resulting stream. Each interface, template or wildcard filter means additional events that will match the query. The impact of include_interface_view and include_created_event_blob fields in the filters will also be accumulated. A template or an interface SHOULD NOT appear twice in the accumulative field. A wildcard filter SHOULD NOT be defined more than once in the accumulative field. Optional, if no ``CumulativeFilter`` defined, the default of a single ``WildcardFilter`` with include_created_event_blob unset is used.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ wildcard_filter + WildcardFilter + +
+ +
A wildcard filter that matches all templates Optional
+ +
+ +
+
+ interface_filter + InterfaceFilter + +
+ +
Include an ``InterfaceView`` for every ``InterfaceFilter`` matching a contract. The ``InterfaceFilter`` instances MUST each use a unique ``interface_id``. Optional
+ +
+ +
+
+ template_filter + TemplateFilter + +
+ +
A template for which the data will be included in the ``create_arguments`` of a matching ``CreatedEvent``. If a contract is simultaneously selected by a template filter and one or more interface filters, the corresponding ``include_created_event_blob`` are consolidated using an OR operation. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ include_created_event_blob + bool + +
+ +
Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``. Use this to access the contract create event payload in your API client for submitting it as a disclosed contract with future commands. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ interface_id + Identifier + +
+ +
The interface that a matching contract must implement. The ``interface_id`` needs to be valid: corresponding interface should be defined in one of the available packages at the time of the query. Both package-name and package-id reference formats for the identifier are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ include_interface_view + bool + +
+ +
Whether to include the interface view on the contract in the returned ``CreatedEvent``. Use this to access contract data in a uniform manner in your API client. Optional
+ +
+ +
+
+ include_created_event_blob + bool + +
+ +
Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``. Use this to access the contract create event payload in your API client for submitting it as a disclosed contract with future commands. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ template_id + Identifier + +
+ +
A template for which the payload should be included in the response. The ``template_id`` needs to be valid: corresponding template should be defined in one of the available packages at the time of the query. Both package-name and package-id reference formats for the identifier are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ include_created_event_blob + bool + +
+ +
Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``. Use this to access the contract event payload in your API client for submitting it as a disclosed contract with future commands. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ workflow_id + string + +
+ +
The workflow ID used in command submission which corresponds to the contract_entry. Only set if the ``workflow_id`` for the command was set. Must be a valid LedgerString (as described in ``value.proto``). Optional
+ +
+ +
+
+ active_contract + ActiveContract + +
+ +
The contract is active on the assigned synchronizer, meaning: there was an activation event on the given synchronizer ( created, assigned), which is not followed by a deactivation event (archived, unassigned) on the same synchronizer, until the active_at_offset. Since activeness is defined as a per synchronizer concept, it is possible, that a contract is active on one synchronizer, but already archived on another. There will be one such message for each synchronizer the contract is active on.
+ +
+ +
+
+ incomplete_unassigned + IncompleteUnassigned + +
+ +
Included iff the unassigned event was before or at the active_at_offset, but there was no corresponding assigned event before or at the active_at_offset.
+ +
+ +
+
+ incomplete_assigned + IncompleteAssigned + +
+ +
Important: this message is not indicating that the contract is active on the target synchronizer! Included iff the assigned event was before or at the active_at_offset, but there was no corresponding unassigned event before or at the active_at_offset.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ created_event + CreatedEvent + +
+ +
Required The event as it appeared in the context of its last update (i.e. daml transaction or reassignment). In particular, the last offset, node_id pair is preserved. The last update is the most recent update created or assigned this contract on synchronizer_id synchronizer. The offset of the CreatedEvent might point to an already pruned update, therefore it cannot necessarily be used for lookups.
+ +
+ +
+
+ synchronizer_id + string + +
+ +
A valid synchronizer id Required
+ +
+ +
+
+ reassignment_counter + uint64 + +
+ +
Each corresponding assigned and unassigned event has the same reassignment_counter. This strictly increases with each unassign command for the same contract. Creation of the contract corresponds to reassignment_counter equals zero. This field will be the reassignment_counter of the latest observable activation event on this synchronizer, which is before the active_at_offset. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ offset + int64 + +
+ +
The offset of origin, which has contextual meaning, please see description at messages that include a CreatedEvent. Offsets are managed by the participant nodes. Transactions can thus NOT be assumed to have the same offsets on different participant nodes. Required, it is a valid absolute offset (positive integer)
+ +
+ +
+
+ node_id + int32 + +
+ +
The position of this event in the originating transaction or reassignment. The origin has contextual meaning, please see description at messages that include a CreatedEvent. Node IDs are not necessarily equal across participants, as these may see different projections/parts of transactions. Required, must be valid node ID (non-negative integer)
+ +
+ +
+
+ contract_id + string + +
+ +
The ID of the created contract. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ template_id + Identifier + +
+ +
The template of the created contract. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ contract_key + Value + +
+ +
The key of the created contract. This will be set if and only if ``template_id`` defines a contract key. Optional
+ +
+ +
+
+ create_arguments + Record + +
+ +
The arguments that have been used to create the contract. Required
+ +
+ +
+
+ created_event_blob + bytes + +
+ +
Opaque representation of contract create event payload intended for forwarding to an API server as a contract disclosed as part of a command submission. Optional
+ +
+ +
+
+ interface_views + repeated InterfaceView + +
+ +
Interface views specified in the transaction filter. Includes an ``InterfaceView`` for each interface for which there is a ``InterfaceFilter`` with - its party in the ``witness_parties`` of this event, - and which is implemented by the template of this event, - and which has ``include_interface_view`` set. Optional
+ +
+ +
+
+ witness_parties + repeated string + +
+ +
The parties that are notified of this event. When a ``CreatedEvent`` is returned as part of a transaction tree or ledger-effects transaction, this will include all the parties specified in the ``TransactionFilter`` that are witnesses of the event (the stakeholders of the contract and all informees of all the ancestors of this create action that this participant knows about). If served as part of a ACS delta transaction those will be limited to all parties specified in the ``TransactionFilter`` that are stakeholders of the contract (i.e. either signatories or observers). If the ``CreatedEvent`` is returned as part of an AssignedEvent, ActiveContract or IncompleteUnassigned (so the event is related to an assignment or unassignment): this will include all parties of the ``TransactionFilter`` that are stakeholders of the contract. The behavior of reading create events visible to parties not hosted on the participant node serving the Ledger API is undefined. Concretely, there is neither a guarantee that the participant node will serve all their create events on the ACS stream, nor is there a guarantee that matching archive events are delivered for such create events. For most clients this is not a problem, as they only read events for parties that are hosted on the participant node. If you need to read events for parties that may not be hosted at all times on the participant node, subscribe to the ``TopologyEvent``s for that party by setting a corresponding ``UpdateFormat``. Using these events, query the ACS as-of an offset where the party is hosted on the participant node, and ignore create events at offsets where the party is not hosted on the participant node. Required
+ +
+ +
+
+ signatories + repeated string + +
+ +
The signatories for this contract as specified by the template. Required
+ +
+ +
+
+ observers + repeated string + +
+ +
The observers for this contract as specified explicitly by the template or implicitly as choice controllers. This field never contains parties that are signatories. Required
+ +
+ +
+
+ created_at + Timestamp + +
+ +
Ledger effective time of the transaction that created the contract. Required
+ +
+ +
+
+ package_name + string + +
+ +
The package name of the created contract. Required
+ +
+ +
+
+ acs_delta + bool + +
+ +
Whether this event would be part of respective ACS_DELTA shaped stream, and should therefore considered when tracking contract activeness on the client-side. Required
+ +
+ +
+
+ representative_package_id + string + +
+ +
A package-id present in the participant package store that typechecks the contract's argument. This may differ from the package-id of the template used to create the contract. For contracts created before Canton 3.4, this field matches the contract's creation package-id. NOTE: Experimental, server internal concept, not for client consumption. Subject to change without notice. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ interface_id + Identifier + +
+ +
The interface implemented by the matched event. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ view_status + Status + +
+ +
Whether the view was successfully computed, and if not, the reason for the error. The error is reported using the same rules for error codes and messages as the errors returned for API requests. Required
+ +
+ +
+
+ view_value + Record + +
+ +
The value of the interface's view method on this event. Set if it was requested in the ``InterfaceFilter`` and it could be successfully computed. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ created_event + CreatedEvent + +
+ +
Required The event as it appeared in the context of its last activation update (i.e. daml transaction or reassignment). In particular, the last activation offset, node_id pair is preserved. The last activation update is the most recent update created or assigned this contract on synchronizer_id synchronizer before the unassigned_event. The offset of the CreatedEvent might point to an already pruned update, therefore it cannot necessarily be used for lookups.
+ +
+ +
+
+ unassigned_event + UnassignedEvent + +
+ +
Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ reassignment_id + string + +
+ +
The ID of the unassignment. This needs to be used as an input for a assign ReassignmentCommand. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ contract_id + string + +
+ +
The ID of the reassigned contract. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ template_id + Identifier + +
+ +
The template of the reassigned contract. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ source + string + +
+ +
The ID of the source synchronizer Must be a valid synchronizer id Required
+ +
+ +
+
+ target + string + +
+ +
The ID of the target synchronizer Must be a valid synchronizer id Required
+ +
+ +
+
+ submitter + string + +
+ +
Party on whose behalf the unassign command was executed. Empty if the unassignment happened offline via the repair service. Must be a valid PartyIdString (as described in ``value.proto``). Optional
+ +
+ +
+
+ reassignment_counter + uint64 + +
+ +
Each corresponding assigned and unassigned event has the same reassignment_counter. This strictly increases with each unassign command for the same contract. Creation of the contract corresponds to reassignment_counter equals zero. Required
+ +
+ +
+
+ assignment_exclusivity + Timestamp + +
+ +
Assignment exclusivity Before this time (measured on the target synchronizer), only the submitter of the unassignment can initiate the assignment Defined for reassigning participants. Optional
+ +
+ +
+
+ witness_parties + repeated string + +
+ +
The parties that are notified of this event. Required
+ +
+ +
+
+ package_name + string + +
+ +
The package name of the contract. Required
+ +
+ +
+
+ offset + int64 + +
+ +
The offset of origin. Offsets are managed by the participant nodes. Reassignments can thus NOT be assumed to have the same offsets on different participant nodes. Required, it is a valid absolute offset (positive integer)
+ +
+ +
+
+ node_id + int32 + +
+ +
The position of this event in the originating reassignment. Node IDs are not necessarily equal across participants, as these may see different projections/parts of reassignments. Required, must be valid node ID (non-negative integer)
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ assigned_event + AssignedEvent + +
+ +
Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ source + string + +
+ +
The ID of the source synchronizer. Must be a valid synchronizer id. Required
+ +
+ +
+
+ target + string + +
+ +
The ID of the target synchronizer. Must be a valid synchronizer id. Required
+ +
+ +
+
+ reassignment_id + string + +
+ +
The ID from the unassigned event. For correlation capabilities. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ submitter + string + +
+ +
Party on whose behalf the assign command was executed. Empty if the assignment happened offline via the repair service. Must be a valid PartyIdString (as described in ``value.proto``). Optional
+ +
+ +
+
+ reassignment_counter + uint64 + +
+ +
Each corresponding assigned and unassigned event has the same reassignment_counter. This strictly increases with each unassign command for the same contract. Creation of the contract corresponds to reassignment_counter equals zero. Required
+ +
+ +
+
+ created_event + CreatedEvent + +
+ +
Required The offset of this event refers to the offset of the assignment, while the node_id is the index of within the batch.
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getconnectedsynchronizers.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getconnectedsynchronizers.mdx new file mode 100644 index 0000000..a01fa71 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getconnectedsynchronizers.mdx @@ -0,0 +1,427 @@ +--- +title: "GetConnectedSynchronizers" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2

+ + +

GetConnectedSynchronizers

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.StateService/GetConnectedSynchronizers + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.StateService/GetConnectedSynchronizers <<'EOF' +{ + "party": "string", + "participantId": "string", + "identityProviderId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "connectedSynchronizers": [ + { + "synchronizerAlias": "string", + "synchronizerId": "string", + "permission": "PARTICIPANT_PERMISSION_UNSPECIFIED" + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
StateService
+
+ +
+
RPC
+
GetConnectedSynchronizers
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetConnectedSynchronizersRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.GetConnectedSynchronizersRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ party + string + +
+ +
The party of interest Must be a valid PartyIdString (as described in ``value.proto``). If empty, all synchronizers this node is connected to will be returned Optional
+ +
+ +
+
+ participant_id + string + +
+ +
The id of a participant whose mapping of a party to connected synchronizers is requested. Must be a valid participant-id retrieved through a prior call to getParticipantId. Defaults to the participant id of the host participant. Optional
+ +
+ +
+
+ identity_provider_id + string + +
+ +
The ID of the identity provider configured by ``Identity Provider Config`` Optional, if not set, assume the user is managed by the default identity provider.
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

GetConnectedSynchronizersResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.GetConnectedSynchronizersResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ connected_synchronizers + repeated ConnectedSynchronizer + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ party + string + +
+ +
The party of interest Must be a valid PartyIdString (as described in ``value.proto``). If empty, all synchronizers this node is connected to will be returned Optional
+ +
+ +
+
+ participant_id + string + +
+ +
The id of a participant whose mapping of a party to connected synchronizers is requested. Must be a valid participant-id retrieved through a prior call to getParticipantId. Defaults to the participant id of the host participant. Optional
+ +
+ +
+
+ identity_provider_id + string + +
+ +
The ID of the identity provider configured by ``Identity Provider Config`` Optional, if not set, assume the user is managed by the default identity provider.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ connected_synchronizers + repeated ConnectedSynchronizer + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ synchronizer_alias + string + +
+ +
The alias of the synchronizer Required
+ +
+ +
+
+ synchronizer_id + string + +
+ +
The ID of the synchronizer Required
+ +
+ +
+
+ permission + ParticipantPermission + +
+ +
The permission on the synchronizer Set if a party was used in the request, otherwise unspecified. Optional
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • PARTICIPANT_PERMISSION_UNSPECIFIED
    • + +
  • PARTICIPANT_PERMISSION_SUBMISSION
    • + +
  • PARTICIPANT_PERMISSION_CONFIRMATION
    • + +
  • PARTICIPANT_PERMISSION_OBSERVATION
    • + +
+ + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getlatestprunedoffsets.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getlatestprunedoffsets.mdx new file mode 100644 index 0000000..1bde9ef --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getlatestprunedoffsets.mdx @@ -0,0 +1,303 @@ +--- +title: "GetLatestPrunedOffsets" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2

+ + +

GetLatestPrunedOffsets

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.StateService/GetLatestPrunedOffsets + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.StateService/GetLatestPrunedOffsets <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "participantPrunedUpToInclusive": "0", + "allDivulgedContractsPrunedUpToInclusive": "0" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
StateService
+
+ +
+
RPC
+
GetLatestPrunedOffsets
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetLatestPrunedOffsetsRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.GetLatestPrunedOffsetsRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

GetLatestPrunedOffsetsResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.GetLatestPrunedOffsetsResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ participant_pruned_up_to_inclusive + int64 + +
+ +
It will always be a non-negative integer. If positive, the absolute offset up to which the ledger has been pruned, disregarding the state of all divulged contracts pruning. If zero, the ledger has not been pruned yet.
+ +
+ +
+
+ all_divulged_contracts_pruned_up_to_inclusive + int64 + +
+ +
It will always be a non-negative integer. If positive, the absolute offset up to which all divulged events have been pruned on the ledger. It can be at or before the ``participant_pruned_up_to_inclusive`` offset. For more details about all divulged events pruning, see ``PruneRequest.prune_all_divulged_contracts`` in ``participant_pruning_service.proto``. If zero, the divulged events have not been pruned yet.
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ participant_pruned_up_to_inclusive + int64 + +
+ +
It will always be a non-negative integer. If positive, the absolute offset up to which the ledger has been pruned, disregarding the state of all divulged contracts pruning. If zero, the ledger has not been pruned yet.
+ +
+ +
+
+ all_divulged_contracts_pruned_up_to_inclusive + int64 + +
+ +
It will always be a non-negative integer. If positive, the absolute offset up to which all divulged events have been pruned on the ledger. It can be at or before the ``participant_pruned_up_to_inclusive`` offset. For more details about all divulged events pruning, see ``PruneRequest.prune_all_divulged_contracts`` in ``participant_pruning_service.proto``. If zero, the divulged events have not been pruned yet.
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getledgerend.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getledgerend.mdx new file mode 100644 index 0000000..c7516ea --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getledgerend.mdx @@ -0,0 +1,280 @@ +--- +title: "GetLedgerEnd" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2

+ + +

GetLedgerEnd

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.StateService/GetLedgerEnd + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.StateService/GetLedgerEnd <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "offset": "0" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
StateService
+
+ +
+
RPC
+
GetLedgerEnd
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetLedgerEndRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.GetLedgerEndRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

GetLedgerEndResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.GetLedgerEndResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ offset + int64 + +
+ +
It will always be a non-negative integer. If zero, the participant view of the ledger is empty. If positive, the absolute offset of the ledger as viewed by the participant.
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ offset + int64 + +
+ +
It will always be a non-negative integer. If zero, the participant view of the ledger is empty. If positive, the absolute offset of the ledger as viewed by the participant.
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/updateservice/getupdatebyid.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/updateservice/getupdatebyid.mdx new file mode 100644 index 0000000..1555986 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/updateservice/getupdatebyid.mdx @@ -0,0 +1,2113 @@ +--- +title: "GetUpdateById" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2

+ + +

GetUpdateById

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.UpdateService/GetUpdateById + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.UpdateService/GetUpdateById <<'EOF' +{ + "updateId": "string", + "updateFormat": { + "includeTransactions": { + "eventFormat": { + "filtersByParty": [ + { + "key": {} + } + ], + "filtersForAnyParty": {}, + "verbose": true + }, + "transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED" + }, + "includeReassignments": { + "filtersByParty": [ + { + "key": { + "cumulative": [ + {} + ] + } + } + ], + "filtersForAnyParty": { + "cumulative": [ + {} + ] + }, + "verbose": true + }, + "includeTopologyEvents": { + "includeParticipantAuthorizationEvents": { + "parties": [ + "string" + ] + } + } + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "transaction": { + "updateId": "string", + "commandId": "string", + "workflowId": "string", + "effectiveAt": "string", + "events": [ + { + "created": { + "offset": "0", + "nodeId": 0, + "contractId": "string", + "templateId": "string", + "contractKey": "string", + "createArguments": "string", + "createdEventBlob": "BASE64_ENCODED_BYTES", + "interfaceViews": [ + {} + ] + } + } + ], + "offset": "0", + "synchronizerId": "string", + "traceContext": { + "traceparent": "string", + "tracestate": "string" + } + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
UpdateService
+
+ +
+
RPC
+
GetUpdateById
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetUpdateByIdRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.GetUpdateByIdRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ update_id + string + +
+ +
The ID of a particular update. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ update_format + UpdateFormat + +
+ +
The format for the update. Required
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

GetUpdateResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.GetUpdateResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ transaction + Transaction + +
+ +
+ +
+
+ reassignment + Reassignment + +
+ +
+ +
+
+ topology_transaction + TopologyTransaction + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ update_id + string + +
+ +
The ID of a particular update. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ update_format + UpdateFormat + +
+ +
The format for the update. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ include_transactions + TransactionFormat + +
+ +
Include Daml transactions in streams. Optional, if unset, no transactions are emitted in the stream.
+ +
+ +
+
+ include_reassignments + EventFormat + +
+ +
Include (un)assignments in the stream. The events in the result take the shape TRANSACTION_SHAPE_ACS_DELTA. Optional, if unset, no (un)assignments are emitted in the stream.
+ +
+ +
+
+ include_topology_events + TopologyFormat + +
+ +
Include topology events in streams. Optional, if unset no topology events are emitted in the stream.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ event_format + EventFormat + +
+ +
Required
+ +
+ +
+
+ transaction_shape + TransactionShape + +
+ +
What transaction shape to use for interpreting the filters of the event format. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ filters_by_party + repeated map + +
+ +
Each key must be a valid PartyIdString (as described in ``value.proto``). The interpretation of the filter depends on the transaction-shape being filtered: 1. For **ledger-effects** create and exercise events are returned, for which the witnesses include at least one of the listed parties and match the per-party filter. 2. For **transaction and active-contract-set streams** create and archive events are returned for all contracts whose stakeholders include at least one of the listed parties and match the per-party filter. Optional
+ +
+ +
+
+ filters_for_any_party + Filters + +
+ +
Wildcard filters that apply to all the parties existing on the participant. The interpretation of the filters is the same with the per-party filter as described above. Optional
+ +
+ +
+
+ verbose + bool + +
+ +
If enabled, values served over the API will contain more information than strictly necessary to interpret the data. In particular, setting the verbose flag to true triggers the ledger to include labels for record fields. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ cumulative + repeated CumulativeFilter + +
+ +
Every filter in the cumulative list expands the scope of the resulting stream. Each interface, template or wildcard filter means additional events that will match the query. The impact of include_interface_view and include_created_event_blob fields in the filters will also be accumulated. A template or an interface SHOULD NOT appear twice in the accumulative field. A wildcard filter SHOULD NOT be defined more than once in the accumulative field. Optional, if no ``CumulativeFilter`` defined, the default of a single ``WildcardFilter`` with include_created_event_blob unset is used.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ wildcard_filter + WildcardFilter + +
+ +
A wildcard filter that matches all templates Optional
+ +
+ +
+
+ interface_filter + InterfaceFilter + +
+ +
Include an ``InterfaceView`` for every ``InterfaceFilter`` matching a contract. The ``InterfaceFilter`` instances MUST each use a unique ``interface_id``. Optional
+ +
+ +
+
+ template_filter + TemplateFilter + +
+ +
A template for which the data will be included in the ``create_arguments`` of a matching ``CreatedEvent``. If a contract is simultaneously selected by a template filter and one or more interface filters, the corresponding ``include_created_event_blob`` are consolidated using an OR operation. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ include_created_event_blob + bool + +
+ +
Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``. Use this to access the contract create event payload in your API client for submitting it as a disclosed contract with future commands. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ interface_id + Identifier + +
+ +
The interface that a matching contract must implement. The ``interface_id`` needs to be valid: corresponding interface should be defined in one of the available packages at the time of the query. Both package-name and package-id reference formats for the identifier are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ include_interface_view + bool + +
+ +
Whether to include the interface view on the contract in the returned ``CreatedEvent``. Use this to access contract data in a uniform manner in your API client. Optional
+ +
+ +
+
+ include_created_event_blob + bool + +
+ +
Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``. Use this to access the contract create event payload in your API client for submitting it as a disclosed contract with future commands. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ template_id + Identifier + +
+ +
A template for which the payload should be included in the response. The ``template_id`` needs to be valid: corresponding template should be defined in one of the available packages at the time of the query. Both package-name and package-id reference formats for the identifier are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ include_created_event_blob + bool + +
+ +
Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``. Use this to access the contract event payload in your API client for submitting it as a disclosed contract with future commands. Optional
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • TRANSACTION_SHAPE_UNSPECIFIED
    • + +
  • TRANSACTION_SHAPE_ACS_DELTA
    • + +
  • TRANSACTION_SHAPE_LEDGER_EFFECTS
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ include_participant_authorization_events + ParticipantAuthorizationTopologyFormat + +
+ +
Include participant authorization topology events in streams. Optional, if unset no participant authorization topology events are emitted in the stream.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ parties + repeated string + +
+ +
List of parties for which the topology transactions should be sent. Empty means: for all parties.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ transaction + Transaction + +
+ +
+ +
+
+ reassignment + Reassignment + +
+ +
+ +
+
+ topology_transaction + TopologyTransaction + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ update_id + string + +
+ +
Assigned by the server. Useful for correlating logs. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ command_id + string + +
+ +
The ID of the command which resulted in this transaction. Missing for everyone except the submitting party. Must be a valid LedgerString (as described in ``value.proto``). Optional
+ +
+ +
+
+ workflow_id + string + +
+ +
The workflow ID used in command submission. Must be a valid LedgerString (as described in ``value.proto``). Optional
+ +
+ +
+
+ effective_at + Timestamp + +
+ +
Ledger effective time. Required
+ +
+ +
+
+ events + repeated Event + +
+ +
The collection of events. Contains: - ``CreatedEvent`` or ``ArchivedEvent`` in case of ACS_DELTA transaction shape - ``CreatedEvent`` or ``ExercisedEvent`` in case of LEDGER_EFFECTS transaction shape Required
+ +
+ +
+
+ offset + int64 + +
+ +
The absolute offset. The details of this field are described in ``community/ledger-api/README.md``. Required, it is a valid absolute offset (positive integer).
+ +
+ +
+
+ synchronizer_id + string + +
+ +
A valid synchronizer id. Identifies the synchronizer that synchronized the transaction. Required
+ +
+ +
+
+ trace_context + TraceContext + +
+ +
Optional; ledger API trace context The trace context transported in this message corresponds to the trace context supplied by the client application in a HTTP2 header of the original command submission. We typically use a header to transfer this type of information. Here we use message body, because it is used in gRPC streams which do not support per message headers. This field will be populated with the trace context contained in the original submission. If that was not provided, a unique ledger-api-server generated trace context will be used instead.
+ +
+ +
+
+ record_time + Timestamp + +
+ +
The time at which the transaction was recorded. The record time refers to the synchronizer which synchronized the transaction. Required
+ +
+ +
+
+ external_transaction_hash + bytes + +
+ +
For transaction externally signed, contains the external transaction hash signed by the external party. Can be used to correlate an external submission with a committed transaction. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ created + CreatedEvent + +
+ +
The event as it appeared in the context of its original daml transaction on this participant node. In particular, the offset, node_id pair of the daml transaction are preserved.
+ +
+ +
+
+ archived + ArchivedEvent + +
+ +
+ +
+
+ exercised + ExercisedEvent + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ offset + int64 + +
+ +
The offset of origin, which has contextual meaning, please see description at messages that include a CreatedEvent. Offsets are managed by the participant nodes. Transactions can thus NOT be assumed to have the same offsets on different participant nodes. Required, it is a valid absolute offset (positive integer)
+ +
+ +
+
+ node_id + int32 + +
+ +
The position of this event in the originating transaction or reassignment. The origin has contextual meaning, please see description at messages that include a CreatedEvent. Node IDs are not necessarily equal across participants, as these may see different projections/parts of transactions. Required, must be valid node ID (non-negative integer)
+ +
+ +
+
+ contract_id + string + +
+ +
The ID of the created contract. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ template_id + Identifier + +
+ +
The template of the created contract. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ contract_key + Value + +
+ +
The key of the created contract. This will be set if and only if ``template_id`` defines a contract key. Optional
+ +
+ +
+
+ create_arguments + Record + +
+ +
The arguments that have been used to create the contract. Required
+ +
+ +
+
+ created_event_blob + bytes + +
+ +
Opaque representation of contract create event payload intended for forwarding to an API server as a contract disclosed as part of a command submission. Optional
+ +
+ +
+
+ interface_views + repeated InterfaceView + +
+ +
Interface views specified in the transaction filter. Includes an ``InterfaceView`` for each interface for which there is a ``InterfaceFilter`` with - its party in the ``witness_parties`` of this event, - and which is implemented by the template of this event, - and which has ``include_interface_view`` set. Optional
+ +
+ +
+
+ witness_parties + repeated string + +
+ +
The parties that are notified of this event. When a ``CreatedEvent`` is returned as part of a transaction tree or ledger-effects transaction, this will include all the parties specified in the ``TransactionFilter`` that are witnesses of the event (the stakeholders of the contract and all informees of all the ancestors of this create action that this participant knows about). If served as part of a ACS delta transaction those will be limited to all parties specified in the ``TransactionFilter`` that are stakeholders of the contract (i.e. either signatories or observers). If the ``CreatedEvent`` is returned as part of an AssignedEvent, ActiveContract or IncompleteUnassigned (so the event is related to an assignment or unassignment): this will include all parties of the ``TransactionFilter`` that are stakeholders of the contract. The behavior of reading create events visible to parties not hosted on the participant node serving the Ledger API is undefined. Concretely, there is neither a guarantee that the participant node will serve all their create events on the ACS stream, nor is there a guarantee that matching archive events are delivered for such create events. For most clients this is not a problem, as they only read events for parties that are hosted on the participant node. If you need to read events for parties that may not be hosted at all times on the participant node, subscribe to the ``TopologyEvent``s for that party by setting a corresponding ``UpdateFormat``. Using these events, query the ACS as-of an offset where the party is hosted on the participant node, and ignore create events at offsets where the party is not hosted on the participant node. Required
+ +
+ +
+
+ signatories + repeated string + +
+ +
The signatories for this contract as specified by the template. Required
+ +
+ +
+
+ observers + repeated string + +
+ +
The observers for this contract as specified explicitly by the template or implicitly as choice controllers. This field never contains parties that are signatories. Required
+ +
+ +
+
+ created_at + Timestamp + +
+ +
Ledger effective time of the transaction that created the contract. Required
+ +
+ +
+
+ package_name + string + +
+ +
The package name of the created contract. Required
+ +
+ +
+
+ acs_delta + bool + +
+ +
Whether this event would be part of respective ACS_DELTA shaped stream, and should therefore considered when tracking contract activeness on the client-side. Required
+ +
+ +
+
+ representative_package_id + string + +
+ +
A package-id present in the participant package store that typechecks the contract's argument. This may differ from the package-id of the template used to create the contract. For contracts created before Canton 3.4, this field matches the contract's creation package-id. NOTE: Experimental, server internal concept, not for client consumption. Subject to change without notice. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ interface_id + Identifier + +
+ +
The interface implemented by the matched event. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ view_status + Status + +
+ +
Whether the view was successfully computed, and if not, the reason for the error. The error is reported using the same rules for error codes and messages as the errors returned for API requests. Required
+ +
+ +
+
+ view_value + Record + +
+ +
The value of the interface's view method on this event. Set if it was requested in the ``InterfaceFilter`` and it could be successfully computed. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ offset + int64 + +
+ +
The offset of origin. Offsets are managed by the participant nodes. Transactions can thus NOT be assumed to have the same offsets on different participant nodes. Required, it is a valid absolute offset (positive integer)
+ +
+ +
+
+ node_id + int32 + +
+ +
The position of this event in the originating transaction or reassignment. Node IDs are not necessarily equal across participants, as these may see different projections/parts of transactions. Required, must be valid node ID (non-negative integer)
+ +
+ +
+
+ contract_id + string + +
+ +
The ID of the archived contract. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ template_id + Identifier + +
+ +
Identifies the template that defines the choice that archived the contract. This template's package-id may differ from the target contract's package-id if the target contract has been upgraded or downgraded. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ witness_parties + repeated string + +
+ +
The parties that are notified of this event. For an ``ArchivedEvent``, these are the intersection of the stakeholders of the contract in question and the parties specified in the ``TransactionFilter``. The stakeholders are the union of the signatories and the observers of the contract. Each one of its elements must be a valid PartyIdString (as described in ``value.proto``). Required
+ +
+ +
+
+ package_name + string + +
+ +
The package name of the contract. Required
+ +
+ +
+
+ implemented_interfaces + repeated Identifier + +
+ +
The interfaces implemented by the target template that have been matched from the interface filter query. Populated only in case interface filters with include_interface_view set. If defined, the identifier uses the package-id reference format. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ offset + int64 + +
+ +
The offset of origin. Offsets are managed by the participant nodes. Transactions can thus NOT be assumed to have the same offsets on different participant nodes. Required, it is a valid absolute offset (positive integer)
+ +
+ +
+
+ node_id + int32 + +
+ +
The position of this event in the originating transaction or reassignment. Node IDs are not necessarily equal across participants, as these may see different projections/parts of transactions. Required, must be valid node ID (non-negative integer)
+ +
+ +
+
+ contract_id + string + +
+ +
The ID of the target contract. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ template_id + Identifier + +
+ +
Identifies the template that defines the executed choice. This template's package-id may differ from the target contract's package-id if the target contract has been upgraded or downgraded. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ interface_id + Identifier + +
+ +
The interface where the choice is defined, if inherited. If defined, the identifier uses the package-id reference format. Optional
+ +
+ +
+
+ choice + string + +
+ +
The choice that was exercised on the target contract. Must be a valid NameString (as described in ``value.proto``). Required
+ +
+ +
+
+ choice_argument + Value + +
+ +
The argument of the exercised choice. Required
+ +
+ +
+
+ acting_parties + repeated string + +
+ +
The parties that exercised the choice. Each element must be a valid PartyIdString (as described in ``value.proto``). Required
+ +
+ +
+
+ consuming + bool + +
+ +
If true, the target contract may no longer be exercised. Required
+ +
+ +
+
+ witness_parties + repeated string + +
+ +
The parties that are notified of this event. The witnesses of an exercise node will depend on whether the exercise was consuming or not. If consuming, the witnesses are the union of the stakeholders, the actors and all informees of all the ancestors of this event this participant knows about. If not consuming, the witnesses are the union of the signatories, the actors and all informees of all the ancestors of this event this participant knows about. In both cases the witnesses are limited to the querying parties, or not limited in case anyParty filters are used. Note that the actors might not necessarily be observers and thus stakeholders. This is the case when the controllers of a choice are specified using "flexible controllers", using the ``choice ... controller`` syntax, and said controllers are not explicitly marked as observers. Each element must be a valid PartyIdString (as described in ``value.proto``). Required
+ +
+ +
+
+ last_descendant_node_id + int32 + +
+ +
Specifies the upper boundary of the node ids of the events in the same transaction that appeared as a result of this ``ExercisedEvent``. This allows unambiguous identification of all the members of the subtree rooted at this node. A full subtree can be constructed when all descendant nodes are present in the stream. If nodes are heavily filtered, it is only possible to determine if a node is in a consequent subtree or not. Required
+ +
+ +
+
+ exercise_result + Value + +
+ +
The result of exercising the choice. Required
+ +
+ +
+
+ package_name + string + +
+ +
The package name of the contract. Required
+ +
+ +
+
+ implemented_interfaces + repeated Identifier + +
+ +
If the event is consuming, the interfaces implemented by the target template that have been matched from the interface filter query. Populated only in case interface filters with include_interface_view set. The identifier uses the package-id reference format. Optional
+ +
+ +
+
+ acs_delta + bool + +
+ +
Whether this event would be part of respective ACS_DELTA shaped stream, and should therefore considered when tracking contract activeness on the client-side. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ traceparent + string + +
+ +
https://www.w3.org/TR/trace-context/
+ +
+ +
+
+ tracestate + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ update_id + string + +
+ +
Assigned by the server. Useful for correlating logs. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ command_id + string + +
+ +
The ID of the command which resulted in this reassignment. Missing for everyone except the submitting party on the submitting participant. Must be a valid LedgerString (as described in ``value.proto``). Optional
+ +
+ +
+
+ workflow_id + string + +
+ +
The workflow ID used in reassignment command submission. Only set if the ``workflow_id`` for the command was set. Must be a valid LedgerString (as described in ``value.proto``). Optional
+ +
+ +
+
+ offset + int64 + +
+ +
The participant's offset. The details of this field are described in ``community/ledger-api/README.md``. Required, must be a valid absolute offset (positive integer).
+ +
+ +
+
+ events + repeated ReassignmentEvent + +
+ +
The collection of reassignment events. Required.
+ +
+ +
+
+ trace_context + TraceContext + +
+ +
Optional; ledger API trace context The trace context transported in this message corresponds to the trace context supplied by the client application in a HTTP2 header of the original command submission. We typically use a header to transfer this type of information. Here we use message body, because it is used in gRPC streams which do not support per message headers. This field will be populated with the trace context contained in the original submission. If that was not provided, a unique ledger-api-server generated trace context will be used instead.
+ +
+ +
+
+ record_time + Timestamp + +
+ +
The time at which the reassignment was recorded. The record time refers to the source/target synchronizer for an unassign/assign event respectively. Required
+ +
+ +
+
+ synchronizer_id + string + +
+ +
A valid synchronizer id. Identifies the synchronizer that synchronized this Reassignment. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ unassigned + UnassignedEvent + +
+ +
+ +
+
+ assigned + AssignedEvent + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ reassignment_id + string + +
+ +
The ID of the unassignment. This needs to be used as an input for a assign ReassignmentCommand. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ contract_id + string + +
+ +
The ID of the reassigned contract. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ template_id + Identifier + +
+ +
The template of the reassigned contract. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ source + string + +
+ +
The ID of the source synchronizer Must be a valid synchronizer id Required
+ +
+ +
+
+ target + string + +
+ +
The ID of the target synchronizer Must be a valid synchronizer id Required
+ +
+ +
+
+ submitter + string + +
+ +
Party on whose behalf the unassign command was executed. Empty if the unassignment happened offline via the repair service. Must be a valid PartyIdString (as described in ``value.proto``). Optional
+ +
+ +
+
+ reassignment_counter + uint64 + +
+ +
Each corresponding assigned and unassigned event has the same reassignment_counter. This strictly increases with each unassign command for the same contract. Creation of the contract corresponds to reassignment_counter equals zero. Required
+ +
+ +
+
+ assignment_exclusivity + Timestamp + +
+ +
Assignment exclusivity Before this time (measured on the target synchronizer), only the submitter of the unassignment can initiate the assignment Defined for reassigning participants. Optional
+ +
+ +
+
+ witness_parties + repeated string + +
+ +
The parties that are notified of this event. Required
+ +
+ +
+
+ package_name + string + +
+ +
The package name of the contract. Required
+ +
+ +
+
+ offset + int64 + +
+ +
The offset of origin. Offsets are managed by the participant nodes. Reassignments can thus NOT be assumed to have the same offsets on different participant nodes. Required, it is a valid absolute offset (positive integer)
+ +
+ +
+
+ node_id + int32 + +
+ +
The position of this event in the originating reassignment. Node IDs are not necessarily equal across participants, as these may see different projections/parts of reassignments. Required, must be valid node ID (non-negative integer)
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ source + string + +
+ +
The ID of the source synchronizer. Must be a valid synchronizer id. Required
+ +
+ +
+
+ target + string + +
+ +
The ID of the target synchronizer. Must be a valid synchronizer id. Required
+ +
+ +
+
+ reassignment_id + string + +
+ +
The ID from the unassigned event. For correlation capabilities. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ submitter + string + +
+ +
Party on whose behalf the assign command was executed. Empty if the assignment happened offline via the repair service. Must be a valid PartyIdString (as described in ``value.proto``). Optional
+ +
+ +
+
+ reassignment_counter + uint64 + +
+ +
Each corresponding assigned and unassigned event has the same reassignment_counter. This strictly increases with each unassign command for the same contract. Creation of the contract corresponds to reassignment_counter equals zero. Required
+ +
+ +
+
+ created_event + CreatedEvent + +
+ +
Required The offset of this event refers to the offset of the assignment, while the node_id is the index of within the batch.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ update_id + string + +
+ +
Assigned by the server. Useful for correlating logs. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ offset + int64 + +
+ +
The absolute offset. The details of this field are described in ``community/ledger-api/README.md``. Required, it is a valid absolute offset (positive integer).
+ +
+ +
+
+ synchronizer_id + string + +
+ +
A valid synchronizer id. Identifies the synchronizer that synchronized the topology transaction. Required
+ +
+ +
+
+ record_time + Timestamp + +
+ +
The time at which the changes in the topology transaction become effective. There is a small delay between a topology transaction being sequenced and the changes it contains becoming effective. Topology transactions appear in order relative to a synchronizer based on their effective time rather than their sequencing time. Required
+ +
+ +
+
+ events + repeated TopologyEvent + +
+ +
A non-empty list of topology events. Required
+ +
+ +
+
+ trace_context + TraceContext + +
+ +
Optional; ledger API trace context The trace context transported in this message corresponds to the trace context supplied by the client application in a HTTP2 header of the original command submission. We typically use a header to transfer this type of information. Here we use message body, because it is used in gRPC streams which do not support per message headers. This field will be populated with the trace context contained in the original submission. If that was not provided, a unique ledger-api-server generated trace context will be used instead.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ participant_authorization_changed + ParticipantAuthorizationChanged + +
+ +
+ +
+
+ participant_authorization_revoked + ParticipantAuthorizationRevoked + +
+ +
+ +
+
+ participant_authorization_added + ParticipantAuthorizationAdded + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ party_id + string + +
+ +
Required
+ +
+ +
+
+ participant_id + string + +
+ +
Required
+ +
+ +
+
+ participant_permission + ParticipantPermission + +
+ +
Required
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • PARTICIPANT_PERMISSION_UNSPECIFIED
    • + +
  • PARTICIPANT_PERMISSION_SUBMISSION
    • + +
  • PARTICIPANT_PERMISSION_CONFIRMATION
    • + +
  • PARTICIPANT_PERMISSION_OBSERVATION
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ party_id + string + +
+ +
Required
+ +
+ +
+
+ participant_id + string + +
+ +
Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ party_id + string + +
+ +
Required
+ +
+ +
+
+ participant_id + string + +
+ +
Required
+ +
+ +
+
+ participant_permission + ParticipantPermission + +
+ +
Required
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/updateservice/getupdatebyoffset.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/updateservice/getupdatebyoffset.mdx new file mode 100644 index 0000000..a3335fd --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/updateservice/getupdatebyoffset.mdx @@ -0,0 +1,2113 @@ +--- +title: "GetUpdateByOffset" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2

+ + +

GetUpdateByOffset

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.UpdateService/GetUpdateByOffset + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.UpdateService/GetUpdateByOffset <<'EOF' +{ + "offset": "0", + "updateFormat": { + "includeTransactions": { + "eventFormat": { + "filtersByParty": [ + { + "key": {} + } + ], + "filtersForAnyParty": {}, + "verbose": true + }, + "transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED" + }, + "includeReassignments": { + "filtersByParty": [ + { + "key": { + "cumulative": [ + {} + ] + } + } + ], + "filtersForAnyParty": { + "cumulative": [ + {} + ] + }, + "verbose": true + }, + "includeTopologyEvents": { + "includeParticipantAuthorizationEvents": { + "parties": [ + "string" + ] + } + } + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "transaction": { + "updateId": "string", + "commandId": "string", + "workflowId": "string", + "effectiveAt": "string", + "events": [ + { + "created": { + "offset": "0", + "nodeId": 0, + "contractId": "string", + "templateId": "string", + "contractKey": "string", + "createArguments": "string", + "createdEventBlob": "BASE64_ENCODED_BYTES", + "interfaceViews": [ + {} + ] + } + } + ], + "offset": "0", + "synchronizerId": "string", + "traceContext": { + "traceparent": "string", + "tracestate": "string" + } + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
UpdateService
+
+ +
+
RPC
+
GetUpdateByOffset
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetUpdateByOffsetRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.GetUpdateByOffsetRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ offset + int64 + +
+ +
The offset of the update being looked up. Must be a valid absolute offset (positive integer). Required
+ +
+ +
+
+ update_format + UpdateFormat + +
+ +
The format for the update. Required
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

GetUpdateResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.GetUpdateResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ transaction + Transaction + +
+ +
+ +
+
+ reassignment + Reassignment + +
+ +
+ +
+
+ topology_transaction + TopologyTransaction + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ offset + int64 + +
+ +
The offset of the update being looked up. Must be a valid absolute offset (positive integer). Required
+ +
+ +
+
+ update_format + UpdateFormat + +
+ +
The format for the update. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ include_transactions + TransactionFormat + +
+ +
Include Daml transactions in streams. Optional, if unset, no transactions are emitted in the stream.
+ +
+ +
+
+ include_reassignments + EventFormat + +
+ +
Include (un)assignments in the stream. The events in the result take the shape TRANSACTION_SHAPE_ACS_DELTA. Optional, if unset, no (un)assignments are emitted in the stream.
+ +
+ +
+
+ include_topology_events + TopologyFormat + +
+ +
Include topology events in streams. Optional, if unset no topology events are emitted in the stream.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ event_format + EventFormat + +
+ +
Required
+ +
+ +
+
+ transaction_shape + TransactionShape + +
+ +
What transaction shape to use for interpreting the filters of the event format. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ filters_by_party + repeated map + +
+ +
Each key must be a valid PartyIdString (as described in ``value.proto``). The interpretation of the filter depends on the transaction-shape being filtered: 1. For **ledger-effects** create and exercise events are returned, for which the witnesses include at least one of the listed parties and match the per-party filter. 2. For **transaction and active-contract-set streams** create and archive events are returned for all contracts whose stakeholders include at least one of the listed parties and match the per-party filter. Optional
+ +
+ +
+
+ filters_for_any_party + Filters + +
+ +
Wildcard filters that apply to all the parties existing on the participant. The interpretation of the filters is the same with the per-party filter as described above. Optional
+ +
+ +
+
+ verbose + bool + +
+ +
If enabled, values served over the API will contain more information than strictly necessary to interpret the data. In particular, setting the verbose flag to true triggers the ledger to include labels for record fields. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ cumulative + repeated CumulativeFilter + +
+ +
Every filter in the cumulative list expands the scope of the resulting stream. Each interface, template or wildcard filter means additional events that will match the query. The impact of include_interface_view and include_created_event_blob fields in the filters will also be accumulated. A template or an interface SHOULD NOT appear twice in the accumulative field. A wildcard filter SHOULD NOT be defined more than once in the accumulative field. Optional, if no ``CumulativeFilter`` defined, the default of a single ``WildcardFilter`` with include_created_event_blob unset is used.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ wildcard_filter + WildcardFilter + +
+ +
A wildcard filter that matches all templates Optional
+ +
+ +
+
+ interface_filter + InterfaceFilter + +
+ +
Include an ``InterfaceView`` for every ``InterfaceFilter`` matching a contract. The ``InterfaceFilter`` instances MUST each use a unique ``interface_id``. Optional
+ +
+ +
+
+ template_filter + TemplateFilter + +
+ +
A template for which the data will be included in the ``create_arguments`` of a matching ``CreatedEvent``. If a contract is simultaneously selected by a template filter and one or more interface filters, the corresponding ``include_created_event_blob`` are consolidated using an OR operation. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ include_created_event_blob + bool + +
+ +
Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``. Use this to access the contract create event payload in your API client for submitting it as a disclosed contract with future commands. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ interface_id + Identifier + +
+ +
The interface that a matching contract must implement. The ``interface_id`` needs to be valid: corresponding interface should be defined in one of the available packages at the time of the query. Both package-name and package-id reference formats for the identifier are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ include_interface_view + bool + +
+ +
Whether to include the interface view on the contract in the returned ``CreatedEvent``. Use this to access contract data in a uniform manner in your API client. Optional
+ +
+ +
+
+ include_created_event_blob + bool + +
+ +
Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``. Use this to access the contract create event payload in your API client for submitting it as a disclosed contract with future commands. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ template_id + Identifier + +
+ +
A template for which the payload should be included in the response. The ``template_id`` needs to be valid: corresponding template should be defined in one of the available packages at the time of the query. Both package-name and package-id reference formats for the identifier are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ include_created_event_blob + bool + +
+ +
Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``. Use this to access the contract event payload in your API client for submitting it as a disclosed contract with future commands. Optional
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • TRANSACTION_SHAPE_UNSPECIFIED
    • + +
  • TRANSACTION_SHAPE_ACS_DELTA
    • + +
  • TRANSACTION_SHAPE_LEDGER_EFFECTS
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ include_participant_authorization_events + ParticipantAuthorizationTopologyFormat + +
+ +
Include participant authorization topology events in streams. Optional, if unset no participant authorization topology events are emitted in the stream.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ parties + repeated string + +
+ +
List of parties for which the topology transactions should be sent. Empty means: for all parties.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ transaction + Transaction + +
+ +
+ +
+
+ reassignment + Reassignment + +
+ +
+ +
+
+ topology_transaction + TopologyTransaction + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ update_id + string + +
+ +
Assigned by the server. Useful for correlating logs. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ command_id + string + +
+ +
The ID of the command which resulted in this transaction. Missing for everyone except the submitting party. Must be a valid LedgerString (as described in ``value.proto``). Optional
+ +
+ +
+
+ workflow_id + string + +
+ +
The workflow ID used in command submission. Must be a valid LedgerString (as described in ``value.proto``). Optional
+ +
+ +
+
+ effective_at + Timestamp + +
+ +
Ledger effective time. Required
+ +
+ +
+
+ events + repeated Event + +
+ +
The collection of events. Contains: - ``CreatedEvent`` or ``ArchivedEvent`` in case of ACS_DELTA transaction shape - ``CreatedEvent`` or ``ExercisedEvent`` in case of LEDGER_EFFECTS transaction shape Required
+ +
+ +
+
+ offset + int64 + +
+ +
The absolute offset. The details of this field are described in ``community/ledger-api/README.md``. Required, it is a valid absolute offset (positive integer).
+ +
+ +
+
+ synchronizer_id + string + +
+ +
A valid synchronizer id. Identifies the synchronizer that synchronized the transaction. Required
+ +
+ +
+
+ trace_context + TraceContext + +
+ +
Optional; ledger API trace context The trace context transported in this message corresponds to the trace context supplied by the client application in a HTTP2 header of the original command submission. We typically use a header to transfer this type of information. Here we use message body, because it is used in gRPC streams which do not support per message headers. This field will be populated with the trace context contained in the original submission. If that was not provided, a unique ledger-api-server generated trace context will be used instead.
+ +
+ +
+
+ record_time + Timestamp + +
+ +
The time at which the transaction was recorded. The record time refers to the synchronizer which synchronized the transaction. Required
+ +
+ +
+
+ external_transaction_hash + bytes + +
+ +
For transaction externally signed, contains the external transaction hash signed by the external party. Can be used to correlate an external submission with a committed transaction. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ created + CreatedEvent + +
+ +
The event as it appeared in the context of its original daml transaction on this participant node. In particular, the offset, node_id pair of the daml transaction are preserved.
+ +
+ +
+
+ archived + ArchivedEvent + +
+ +
+ +
+
+ exercised + ExercisedEvent + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ offset + int64 + +
+ +
The offset of origin, which has contextual meaning, please see description at messages that include a CreatedEvent. Offsets are managed by the participant nodes. Transactions can thus NOT be assumed to have the same offsets on different participant nodes. Required, it is a valid absolute offset (positive integer)
+ +
+ +
+
+ node_id + int32 + +
+ +
The position of this event in the originating transaction or reassignment. The origin has contextual meaning, please see description at messages that include a CreatedEvent. Node IDs are not necessarily equal across participants, as these may see different projections/parts of transactions. Required, must be valid node ID (non-negative integer)
+ +
+ +
+
+ contract_id + string + +
+ +
The ID of the created contract. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ template_id + Identifier + +
+ +
The template of the created contract. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ contract_key + Value + +
+ +
The key of the created contract. This will be set if and only if ``template_id`` defines a contract key. Optional
+ +
+ +
+
+ create_arguments + Record + +
+ +
The arguments that have been used to create the contract. Required
+ +
+ +
+
+ created_event_blob + bytes + +
+ +
Opaque representation of contract create event payload intended for forwarding to an API server as a contract disclosed as part of a command submission. Optional
+ +
+ +
+
+ interface_views + repeated InterfaceView + +
+ +
Interface views specified in the transaction filter. Includes an ``InterfaceView`` for each interface for which there is a ``InterfaceFilter`` with - its party in the ``witness_parties`` of this event, - and which is implemented by the template of this event, - and which has ``include_interface_view`` set. Optional
+ +
+ +
+
+ witness_parties + repeated string + +
+ +
The parties that are notified of this event. When a ``CreatedEvent`` is returned as part of a transaction tree or ledger-effects transaction, this will include all the parties specified in the ``TransactionFilter`` that are witnesses of the event (the stakeholders of the contract and all informees of all the ancestors of this create action that this participant knows about). If served as part of a ACS delta transaction those will be limited to all parties specified in the ``TransactionFilter`` that are stakeholders of the contract (i.e. either signatories or observers). If the ``CreatedEvent`` is returned as part of an AssignedEvent, ActiveContract or IncompleteUnassigned (so the event is related to an assignment or unassignment): this will include all parties of the ``TransactionFilter`` that are stakeholders of the contract. The behavior of reading create events visible to parties not hosted on the participant node serving the Ledger API is undefined. Concretely, there is neither a guarantee that the participant node will serve all their create events on the ACS stream, nor is there a guarantee that matching archive events are delivered for such create events. For most clients this is not a problem, as they only read events for parties that are hosted on the participant node. If you need to read events for parties that may not be hosted at all times on the participant node, subscribe to the ``TopologyEvent``s for that party by setting a corresponding ``UpdateFormat``. Using these events, query the ACS as-of an offset where the party is hosted on the participant node, and ignore create events at offsets where the party is not hosted on the participant node. Required
+ +
+ +
+
+ signatories + repeated string + +
+ +
The signatories for this contract as specified by the template. Required
+ +
+ +
+
+ observers + repeated string + +
+ +
The observers for this contract as specified explicitly by the template or implicitly as choice controllers. This field never contains parties that are signatories. Required
+ +
+ +
+
+ created_at + Timestamp + +
+ +
Ledger effective time of the transaction that created the contract. Required
+ +
+ +
+
+ package_name + string + +
+ +
The package name of the created contract. Required
+ +
+ +
+
+ acs_delta + bool + +
+ +
Whether this event would be part of respective ACS_DELTA shaped stream, and should therefore considered when tracking contract activeness on the client-side. Required
+ +
+ +
+
+ representative_package_id + string + +
+ +
A package-id present in the participant package store that typechecks the contract's argument. This may differ from the package-id of the template used to create the contract. For contracts created before Canton 3.4, this field matches the contract's creation package-id. NOTE: Experimental, server internal concept, not for client consumption. Subject to change without notice. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ interface_id + Identifier + +
+ +
The interface implemented by the matched event. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ view_status + Status + +
+ +
Whether the view was successfully computed, and if not, the reason for the error. The error is reported using the same rules for error codes and messages as the errors returned for API requests. Required
+ +
+ +
+
+ view_value + Record + +
+ +
The value of the interface's view method on this event. Set if it was requested in the ``InterfaceFilter`` and it could be successfully computed. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ offset + int64 + +
+ +
The offset of origin. Offsets are managed by the participant nodes. Transactions can thus NOT be assumed to have the same offsets on different participant nodes. Required, it is a valid absolute offset (positive integer)
+ +
+ +
+
+ node_id + int32 + +
+ +
The position of this event in the originating transaction or reassignment. Node IDs are not necessarily equal across participants, as these may see different projections/parts of transactions. Required, must be valid node ID (non-negative integer)
+ +
+ +
+
+ contract_id + string + +
+ +
The ID of the archived contract. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ template_id + Identifier + +
+ +
Identifies the template that defines the choice that archived the contract. This template's package-id may differ from the target contract's package-id if the target contract has been upgraded or downgraded. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ witness_parties + repeated string + +
+ +
The parties that are notified of this event. For an ``ArchivedEvent``, these are the intersection of the stakeholders of the contract in question and the parties specified in the ``TransactionFilter``. The stakeholders are the union of the signatories and the observers of the contract. Each one of its elements must be a valid PartyIdString (as described in ``value.proto``). Required
+ +
+ +
+
+ package_name + string + +
+ +
The package name of the contract. Required
+ +
+ +
+
+ implemented_interfaces + repeated Identifier + +
+ +
The interfaces implemented by the target template that have been matched from the interface filter query. Populated only in case interface filters with include_interface_view set. If defined, the identifier uses the package-id reference format. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ offset + int64 + +
+ +
The offset of origin. Offsets are managed by the participant nodes. Transactions can thus NOT be assumed to have the same offsets on different participant nodes. Required, it is a valid absolute offset (positive integer)
+ +
+ +
+
+ node_id + int32 + +
+ +
The position of this event in the originating transaction or reassignment. Node IDs are not necessarily equal across participants, as these may see different projections/parts of transactions. Required, must be valid node ID (non-negative integer)
+ +
+ +
+
+ contract_id + string + +
+ +
The ID of the target contract. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ template_id + Identifier + +
+ +
Identifies the template that defines the executed choice. This template's package-id may differ from the target contract's package-id if the target contract has been upgraded or downgraded. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ interface_id + Identifier + +
+ +
The interface where the choice is defined, if inherited. If defined, the identifier uses the package-id reference format. Optional
+ +
+ +
+
+ choice + string + +
+ +
The choice that was exercised on the target contract. Must be a valid NameString (as described in ``value.proto``). Required
+ +
+ +
+
+ choice_argument + Value + +
+ +
The argument of the exercised choice. Required
+ +
+ +
+
+ acting_parties + repeated string + +
+ +
The parties that exercised the choice. Each element must be a valid PartyIdString (as described in ``value.proto``). Required
+ +
+ +
+
+ consuming + bool + +
+ +
If true, the target contract may no longer be exercised. Required
+ +
+ +
+
+ witness_parties + repeated string + +
+ +
The parties that are notified of this event. The witnesses of an exercise node will depend on whether the exercise was consuming or not. If consuming, the witnesses are the union of the stakeholders, the actors and all informees of all the ancestors of this event this participant knows about. If not consuming, the witnesses are the union of the signatories, the actors and all informees of all the ancestors of this event this participant knows about. In both cases the witnesses are limited to the querying parties, or not limited in case anyParty filters are used. Note that the actors might not necessarily be observers and thus stakeholders. This is the case when the controllers of a choice are specified using "flexible controllers", using the ``choice ... controller`` syntax, and said controllers are not explicitly marked as observers. Each element must be a valid PartyIdString (as described in ``value.proto``). Required
+ +
+ +
+
+ last_descendant_node_id + int32 + +
+ +
Specifies the upper boundary of the node ids of the events in the same transaction that appeared as a result of this ``ExercisedEvent``. This allows unambiguous identification of all the members of the subtree rooted at this node. A full subtree can be constructed when all descendant nodes are present in the stream. If nodes are heavily filtered, it is only possible to determine if a node is in a consequent subtree or not. Required
+ +
+ +
+
+ exercise_result + Value + +
+ +
The result of exercising the choice. Required
+ +
+ +
+
+ package_name + string + +
+ +
The package name of the contract. Required
+ +
+ +
+
+ implemented_interfaces + repeated Identifier + +
+ +
If the event is consuming, the interfaces implemented by the target template that have been matched from the interface filter query. Populated only in case interface filters with include_interface_view set. The identifier uses the package-id reference format. Optional
+ +
+ +
+
+ acs_delta + bool + +
+ +
Whether this event would be part of respective ACS_DELTA shaped stream, and should therefore considered when tracking contract activeness on the client-side. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ traceparent + string + +
+ +
https://www.w3.org/TR/trace-context/
+ +
+ +
+
+ tracestate + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ update_id + string + +
+ +
Assigned by the server. Useful for correlating logs. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ command_id + string + +
+ +
The ID of the command which resulted in this reassignment. Missing for everyone except the submitting party on the submitting participant. Must be a valid LedgerString (as described in ``value.proto``). Optional
+ +
+ +
+
+ workflow_id + string + +
+ +
The workflow ID used in reassignment command submission. Only set if the ``workflow_id`` for the command was set. Must be a valid LedgerString (as described in ``value.proto``). Optional
+ +
+ +
+
+ offset + int64 + +
+ +
The participant's offset. The details of this field are described in ``community/ledger-api/README.md``. Required, must be a valid absolute offset (positive integer).
+ +
+ +
+
+ events + repeated ReassignmentEvent + +
+ +
The collection of reassignment events. Required.
+ +
+ +
+
+ trace_context + TraceContext + +
+ +
Optional; ledger API trace context The trace context transported in this message corresponds to the trace context supplied by the client application in a HTTP2 header of the original command submission. We typically use a header to transfer this type of information. Here we use message body, because it is used in gRPC streams which do not support per message headers. This field will be populated with the trace context contained in the original submission. If that was not provided, a unique ledger-api-server generated trace context will be used instead.
+ +
+ +
+
+ record_time + Timestamp + +
+ +
The time at which the reassignment was recorded. The record time refers to the source/target synchronizer for an unassign/assign event respectively. Required
+ +
+ +
+
+ synchronizer_id + string + +
+ +
A valid synchronizer id. Identifies the synchronizer that synchronized this Reassignment. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ unassigned + UnassignedEvent + +
+ +
+ +
+
+ assigned + AssignedEvent + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ reassignment_id + string + +
+ +
The ID of the unassignment. This needs to be used as an input for a assign ReassignmentCommand. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ contract_id + string + +
+ +
The ID of the reassigned contract. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ template_id + Identifier + +
+ +
The template of the reassigned contract. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ source + string + +
+ +
The ID of the source synchronizer Must be a valid synchronizer id Required
+ +
+ +
+
+ target + string + +
+ +
The ID of the target synchronizer Must be a valid synchronizer id Required
+ +
+ +
+
+ submitter + string + +
+ +
Party on whose behalf the unassign command was executed. Empty if the unassignment happened offline via the repair service. Must be a valid PartyIdString (as described in ``value.proto``). Optional
+ +
+ +
+
+ reassignment_counter + uint64 + +
+ +
Each corresponding assigned and unassigned event has the same reassignment_counter. This strictly increases with each unassign command for the same contract. Creation of the contract corresponds to reassignment_counter equals zero. Required
+ +
+ +
+
+ assignment_exclusivity + Timestamp + +
+ +
Assignment exclusivity Before this time (measured on the target synchronizer), only the submitter of the unassignment can initiate the assignment Defined for reassigning participants. Optional
+ +
+ +
+
+ witness_parties + repeated string + +
+ +
The parties that are notified of this event. Required
+ +
+ +
+
+ package_name + string + +
+ +
The package name of the contract. Required
+ +
+ +
+
+ offset + int64 + +
+ +
The offset of origin. Offsets are managed by the participant nodes. Reassignments can thus NOT be assumed to have the same offsets on different participant nodes. Required, it is a valid absolute offset (positive integer)
+ +
+ +
+
+ node_id + int32 + +
+ +
The position of this event in the originating reassignment. Node IDs are not necessarily equal across participants, as these may see different projections/parts of reassignments. Required, must be valid node ID (non-negative integer)
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ source + string + +
+ +
The ID of the source synchronizer. Must be a valid synchronizer id. Required
+ +
+ +
+
+ target + string + +
+ +
The ID of the target synchronizer. Must be a valid synchronizer id. Required
+ +
+ +
+
+ reassignment_id + string + +
+ +
The ID from the unassigned event. For correlation capabilities. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ submitter + string + +
+ +
Party on whose behalf the assign command was executed. Empty if the assignment happened offline via the repair service. Must be a valid PartyIdString (as described in ``value.proto``). Optional
+ +
+ +
+
+ reassignment_counter + uint64 + +
+ +
Each corresponding assigned and unassigned event has the same reassignment_counter. This strictly increases with each unassign command for the same contract. Creation of the contract corresponds to reassignment_counter equals zero. Required
+ +
+ +
+
+ created_event + CreatedEvent + +
+ +
Required The offset of this event refers to the offset of the assignment, while the node_id is the index of within the batch.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ update_id + string + +
+ +
Assigned by the server. Useful for correlating logs. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ offset + int64 + +
+ +
The absolute offset. The details of this field are described in ``community/ledger-api/README.md``. Required, it is a valid absolute offset (positive integer).
+ +
+ +
+
+ synchronizer_id + string + +
+ +
A valid synchronizer id. Identifies the synchronizer that synchronized the topology transaction. Required
+ +
+ +
+
+ record_time + Timestamp + +
+ +
The time at which the changes in the topology transaction become effective. There is a small delay between a topology transaction being sequenced and the changes it contains becoming effective. Topology transactions appear in order relative to a synchronizer based on their effective time rather than their sequencing time. Required
+ +
+ +
+
+ events + repeated TopologyEvent + +
+ +
A non-empty list of topology events. Required
+ +
+ +
+
+ trace_context + TraceContext + +
+ +
Optional; ledger API trace context The trace context transported in this message corresponds to the trace context supplied by the client application in a HTTP2 header of the original command submission. We typically use a header to transfer this type of information. Here we use message body, because it is used in gRPC streams which do not support per message headers. This field will be populated with the trace context contained in the original submission. If that was not provided, a unique ledger-api-server generated trace context will be used instead.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ participant_authorization_changed + ParticipantAuthorizationChanged + +
+ +
+ +
+
+ participant_authorization_revoked + ParticipantAuthorizationRevoked + +
+ +
+ +
+
+ participant_authorization_added + ParticipantAuthorizationAdded + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ party_id + string + +
+ +
Required
+ +
+ +
+
+ participant_id + string + +
+ +
Required
+ +
+ +
+
+ participant_permission + ParticipantPermission + +
+ +
Required
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • PARTICIPANT_PERMISSION_UNSPECIFIED
    • + +
  • PARTICIPANT_PERMISSION_SUBMISSION
    • + +
  • PARTICIPANT_PERMISSION_CONFIRMATION
    • + +
  • PARTICIPANT_PERMISSION_OBSERVATION
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ party_id + string + +
+ +
Required
+ +
+ +
+
+ participant_id + string + +
+ +
Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ party_id + string + +
+ +
Required
+ +
+ +
+
+ participant_id + string + +
+ +
Required
+ +
+ +
+
+ participant_permission + ParticipantPermission + +
+ +
Required
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/updateservice/getupdates.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/updateservice/getupdates.mdx new file mode 100644 index 0000000..c7bbd81 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/updateservice/getupdates.mdx @@ -0,0 +1,2223 @@ +--- +title: "GetUpdates" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2

+ + +

GetUpdates

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.UpdateService/GetUpdates + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.UpdateService/GetUpdates <<'EOF' +{ + "beginExclusive": "0", + "endInclusive": "0", + "updateFormat": { + "includeTransactions": { + "eventFormat": { + "filtersByParty": [ + { + "key": {} + } + ], + "filtersForAnyParty": {}, + "verbose": true + }, + "transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED" + }, + "includeReassignments": { + "filtersByParty": [ + { + "key": { + "cumulative": [ + {} + ] + } + } + ], + "filtersForAnyParty": { + "cumulative": [ + {} + ] + }, + "verbose": true + }, + "includeTopologyEvents": { + "includeParticipantAuthorizationEvents": { + "parties": [ + "string" + ] + } + } + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "transaction": { + "updateId": "string", + "commandId": "string", + "workflowId": "string", + "effectiveAt": "string", + "events": [ + { + "created": { + "offset": "0", + "nodeId": 0, + "contractId": "string", + "templateId": "string", + "contractKey": "string", + "createArguments": "string", + "createdEventBlob": "BASE64_ENCODED_BYTES", + "interfaceViews": [ + {} + ] + } + } + ], + "offset": "0", + "synchronizerId": "string", + "traceContext": { + "traceparent": "string", + "tracestate": "string" + } + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
UpdateService
+
+ +
+
RPC
+
GetUpdates
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
Yes
+
+ +
+ + +## Inputs + + +
+
+

GetUpdatesRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.GetUpdatesRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ begin_exclusive + int64 + +
+ +
Beginning of the requested ledger section (non-negative integer). The response will only contain transactions whose offset is strictly greater than this. If zero, the stream will start from the beginning of the ledger. If positive, the streaming will start after this absolute offset. If the ledger has been pruned, this parameter must be specified and be greater than the pruning offset.
+ +
+ +
+
+ end_inclusive + int64 + +
+ +
End of the requested ledger section. The response will only contain transactions whose offset is less than or equal to this. Optional, if empty, the stream will not terminate. If specified, the stream will terminate after this absolute offset (positive integer) is reached.
+ +
+ +
+
+ update_format + UpdateFormat + +
+ +
Must be unset for GetUpdateTrees request. Optional for backwards compatibility for GetUpdates request: defaults to an UpdateFormat where: - include_transactions.event_format.filters_by_party = the filter.filters_by_party on this request - include_transactions.event_format.filters_for_any_party = the filter.filters_for_any_party on this request - include_transactions.event_format.verbose = the same flag specified on this request - include_transactions.transaction_shape = TRANSACTION_SHAPE_ACS_DELTA - include_reassignments.filter = the same filter specified on this request - include_reassignments.verbose = the same flag specified on this request - include_topology_events.include_participant_authorization_events.parties = all the parties specified in filter
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

GetUpdatesResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.GetUpdatesResponse
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + +
+ +
+
+ transaction + Transaction + +
+ +
+ +
+
+ reassignment + Reassignment + +
+ +
+ +
+
+ offset_checkpoint + OffsetCheckpoint + +
+ +
+ +
+
+ topology_transaction + TopologyTransaction + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ begin_exclusive + int64 + +
+ +
Beginning of the requested ledger section (non-negative integer). The response will only contain transactions whose offset is strictly greater than this. If zero, the stream will start from the beginning of the ledger. If positive, the streaming will start after this absolute offset. If the ledger has been pruned, this parameter must be specified and be greater than the pruning offset.
+ +
+ +
+
+ end_inclusive + int64 + +
+ +
End of the requested ledger section. The response will only contain transactions whose offset is less than or equal to this. Optional, if empty, the stream will not terminate. If specified, the stream will terminate after this absolute offset (positive integer) is reached.
+ +
+ +
+
+ update_format + UpdateFormat + +
+ +
Must be unset for GetUpdateTrees request. Optional for backwards compatibility for GetUpdates request: defaults to an UpdateFormat where: - include_transactions.event_format.filters_by_party = the filter.filters_by_party on this request - include_transactions.event_format.filters_for_any_party = the filter.filters_for_any_party on this request - include_transactions.event_format.verbose = the same flag specified on this request - include_transactions.transaction_shape = TRANSACTION_SHAPE_ACS_DELTA - include_reassignments.filter = the same filter specified on this request - include_reassignments.verbose = the same flag specified on this request - include_topology_events.include_participant_authorization_events.parties = all the parties specified in filter
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ include_transactions + TransactionFormat + +
+ +
Include Daml transactions in streams. Optional, if unset, no transactions are emitted in the stream.
+ +
+ +
+
+ include_reassignments + EventFormat + +
+ +
Include (un)assignments in the stream. The events in the result take the shape TRANSACTION_SHAPE_ACS_DELTA. Optional, if unset, no (un)assignments are emitted in the stream.
+ +
+ +
+
+ include_topology_events + TopologyFormat + +
+ +
Include topology events in streams. Optional, if unset no topology events are emitted in the stream.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ event_format + EventFormat + +
+ +
Required
+ +
+ +
+
+ transaction_shape + TransactionShape + +
+ +
What transaction shape to use for interpreting the filters of the event format. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ filters_by_party + repeated map + +
+ +
Each key must be a valid PartyIdString (as described in ``value.proto``). The interpretation of the filter depends on the transaction-shape being filtered: 1. For **ledger-effects** create and exercise events are returned, for which the witnesses include at least one of the listed parties and match the per-party filter. 2. For **transaction and active-contract-set streams** create and archive events are returned for all contracts whose stakeholders include at least one of the listed parties and match the per-party filter. Optional
+ +
+ +
+
+ filters_for_any_party + Filters + +
+ +
Wildcard filters that apply to all the parties existing on the participant. The interpretation of the filters is the same with the per-party filter as described above. Optional
+ +
+ +
+
+ verbose + bool + +
+ +
If enabled, values served over the API will contain more information than strictly necessary to interpret the data. In particular, setting the verbose flag to true triggers the ledger to include labels for record fields. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ cumulative + repeated CumulativeFilter + +
+ +
Every filter in the cumulative list expands the scope of the resulting stream. Each interface, template or wildcard filter means additional events that will match the query. The impact of include_interface_view and include_created_event_blob fields in the filters will also be accumulated. A template or an interface SHOULD NOT appear twice in the accumulative field. A wildcard filter SHOULD NOT be defined more than once in the accumulative field. Optional, if no ``CumulativeFilter`` defined, the default of a single ``WildcardFilter`` with include_created_event_blob unset is used.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ wildcard_filter + WildcardFilter + +
+ +
A wildcard filter that matches all templates Optional
+ +
+ +
+
+ interface_filter + InterfaceFilter + +
+ +
Include an ``InterfaceView`` for every ``InterfaceFilter`` matching a contract. The ``InterfaceFilter`` instances MUST each use a unique ``interface_id``. Optional
+ +
+ +
+
+ template_filter + TemplateFilter + +
+ +
A template for which the data will be included in the ``create_arguments`` of a matching ``CreatedEvent``. If a contract is simultaneously selected by a template filter and one or more interface filters, the corresponding ``include_created_event_blob`` are consolidated using an OR operation. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ include_created_event_blob + bool + +
+ +
Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``. Use this to access the contract create event payload in your API client for submitting it as a disclosed contract with future commands. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ interface_id + Identifier + +
+ +
The interface that a matching contract must implement. The ``interface_id`` needs to be valid: corresponding interface should be defined in one of the available packages at the time of the query. Both package-name and package-id reference formats for the identifier are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ include_interface_view + bool + +
+ +
Whether to include the interface view on the contract in the returned ``CreatedEvent``. Use this to access contract data in a uniform manner in your API client. Optional
+ +
+ +
+
+ include_created_event_blob + bool + +
+ +
Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``. Use this to access the contract create event payload in your API client for submitting it as a disclosed contract with future commands. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ template_id + Identifier + +
+ +
A template for which the payload should be included in the response. The ``template_id`` needs to be valid: corresponding template should be defined in one of the available packages at the time of the query. Both package-name and package-id reference formats for the identifier are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ include_created_event_blob + bool + +
+ +
Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``. Use this to access the contract event payload in your API client for submitting it as a disclosed contract with future commands. Optional
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • TRANSACTION_SHAPE_UNSPECIFIED
    • + +
  • TRANSACTION_SHAPE_ACS_DELTA
    • + +
  • TRANSACTION_SHAPE_LEDGER_EFFECTS
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ include_participant_authorization_events + ParticipantAuthorizationTopologyFormat + +
+ +
Include participant authorization topology events in streams. Optional, if unset no participant authorization topology events are emitted in the stream.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ parties + repeated string + +
+ +
List of parties for which the topology transactions should be sent. Empty means: for all parties.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ transaction + Transaction + +
+ +
+ +
+
+ reassignment + Reassignment + +
+ +
+ +
+
+ offset_checkpoint + OffsetCheckpoint + +
+ +
+ +
+
+ topology_transaction + TopologyTransaction + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ update_id + string + +
+ +
Assigned by the server. Useful for correlating logs. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ command_id + string + +
+ +
The ID of the command which resulted in this transaction. Missing for everyone except the submitting party. Must be a valid LedgerString (as described in ``value.proto``). Optional
+ +
+ +
+
+ workflow_id + string + +
+ +
The workflow ID used in command submission. Must be a valid LedgerString (as described in ``value.proto``). Optional
+ +
+ +
+
+ effective_at + Timestamp + +
+ +
Ledger effective time. Required
+ +
+ +
+
+ events + repeated Event + +
+ +
The collection of events. Contains: - ``CreatedEvent`` or ``ArchivedEvent`` in case of ACS_DELTA transaction shape - ``CreatedEvent`` or ``ExercisedEvent`` in case of LEDGER_EFFECTS transaction shape Required
+ +
+ +
+
+ offset + int64 + +
+ +
The absolute offset. The details of this field are described in ``community/ledger-api/README.md``. Required, it is a valid absolute offset (positive integer).
+ +
+ +
+
+ synchronizer_id + string + +
+ +
A valid synchronizer id. Identifies the synchronizer that synchronized the transaction. Required
+ +
+ +
+
+ trace_context + TraceContext + +
+ +
Optional; ledger API trace context The trace context transported in this message corresponds to the trace context supplied by the client application in a HTTP2 header of the original command submission. We typically use a header to transfer this type of information. Here we use message body, because it is used in gRPC streams which do not support per message headers. This field will be populated with the trace context contained in the original submission. If that was not provided, a unique ledger-api-server generated trace context will be used instead.
+ +
+ +
+
+ record_time + Timestamp + +
+ +
The time at which the transaction was recorded. The record time refers to the synchronizer which synchronized the transaction. Required
+ +
+ +
+
+ external_transaction_hash + bytes + +
+ +
For transaction externally signed, contains the external transaction hash signed by the external party. Can be used to correlate an external submission with a committed transaction. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ created + CreatedEvent + +
+ +
The event as it appeared in the context of its original daml transaction on this participant node. In particular, the offset, node_id pair of the daml transaction are preserved.
+ +
+ +
+
+ archived + ArchivedEvent + +
+ +
+ +
+
+ exercised + ExercisedEvent + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ offset + int64 + +
+ +
The offset of origin, which has contextual meaning, please see description at messages that include a CreatedEvent. Offsets are managed by the participant nodes. Transactions can thus NOT be assumed to have the same offsets on different participant nodes. Required, it is a valid absolute offset (positive integer)
+ +
+ +
+
+ node_id + int32 + +
+ +
The position of this event in the originating transaction or reassignment. The origin has contextual meaning, please see description at messages that include a CreatedEvent. Node IDs are not necessarily equal across participants, as these may see different projections/parts of transactions. Required, must be valid node ID (non-negative integer)
+ +
+ +
+
+ contract_id + string + +
+ +
The ID of the created contract. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ template_id + Identifier + +
+ +
The template of the created contract. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ contract_key + Value + +
+ +
The key of the created contract. This will be set if and only if ``template_id`` defines a contract key. Optional
+ +
+ +
+
+ create_arguments + Record + +
+ +
The arguments that have been used to create the contract. Required
+ +
+ +
+
+ created_event_blob + bytes + +
+ +
Opaque representation of contract create event payload intended for forwarding to an API server as a contract disclosed as part of a command submission. Optional
+ +
+ +
+
+ interface_views + repeated InterfaceView + +
+ +
Interface views specified in the transaction filter. Includes an ``InterfaceView`` for each interface for which there is a ``InterfaceFilter`` with - its party in the ``witness_parties`` of this event, - and which is implemented by the template of this event, - and which has ``include_interface_view`` set. Optional
+ +
+ +
+
+ witness_parties + repeated string + +
+ +
The parties that are notified of this event. When a ``CreatedEvent`` is returned as part of a transaction tree or ledger-effects transaction, this will include all the parties specified in the ``TransactionFilter`` that are witnesses of the event (the stakeholders of the contract and all informees of all the ancestors of this create action that this participant knows about). If served as part of a ACS delta transaction those will be limited to all parties specified in the ``TransactionFilter`` that are stakeholders of the contract (i.e. either signatories or observers). If the ``CreatedEvent`` is returned as part of an AssignedEvent, ActiveContract or IncompleteUnassigned (so the event is related to an assignment or unassignment): this will include all parties of the ``TransactionFilter`` that are stakeholders of the contract. The behavior of reading create events visible to parties not hosted on the participant node serving the Ledger API is undefined. Concretely, there is neither a guarantee that the participant node will serve all their create events on the ACS stream, nor is there a guarantee that matching archive events are delivered for such create events. For most clients this is not a problem, as they only read events for parties that are hosted on the participant node. If you need to read events for parties that may not be hosted at all times on the participant node, subscribe to the ``TopologyEvent``s for that party by setting a corresponding ``UpdateFormat``. Using these events, query the ACS as-of an offset where the party is hosted on the participant node, and ignore create events at offsets where the party is not hosted on the participant node. Required
+ +
+ +
+
+ signatories + repeated string + +
+ +
The signatories for this contract as specified by the template. Required
+ +
+ +
+
+ observers + repeated string + +
+ +
The observers for this contract as specified explicitly by the template or implicitly as choice controllers. This field never contains parties that are signatories. Required
+ +
+ +
+
+ created_at + Timestamp + +
+ +
Ledger effective time of the transaction that created the contract. Required
+ +
+ +
+
+ package_name + string + +
+ +
The package name of the created contract. Required
+ +
+ +
+
+ acs_delta + bool + +
+ +
Whether this event would be part of respective ACS_DELTA shaped stream, and should therefore considered when tracking contract activeness on the client-side. Required
+ +
+ +
+
+ representative_package_id + string + +
+ +
A package-id present in the participant package store that typechecks the contract's argument. This may differ from the package-id of the template used to create the contract. For contracts created before Canton 3.4, this field matches the contract's creation package-id. NOTE: Experimental, server internal concept, not for client consumption. Subject to change without notice. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ interface_id + Identifier + +
+ +
The interface implemented by the matched event. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ view_status + Status + +
+ +
Whether the view was successfully computed, and if not, the reason for the error. The error is reported using the same rules for error codes and messages as the errors returned for API requests. Required
+ +
+ +
+
+ view_value + Record + +
+ +
The value of the interface's view method on this event. Set if it was requested in the ``InterfaceFilter`` and it could be successfully computed. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ offset + int64 + +
+ +
The offset of origin. Offsets are managed by the participant nodes. Transactions can thus NOT be assumed to have the same offsets on different participant nodes. Required, it is a valid absolute offset (positive integer)
+ +
+ +
+
+ node_id + int32 + +
+ +
The position of this event in the originating transaction or reassignment. Node IDs are not necessarily equal across participants, as these may see different projections/parts of transactions. Required, must be valid node ID (non-negative integer)
+ +
+ +
+
+ contract_id + string + +
+ +
The ID of the archived contract. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ template_id + Identifier + +
+ +
Identifies the template that defines the choice that archived the contract. This template's package-id may differ from the target contract's package-id if the target contract has been upgraded or downgraded. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ witness_parties + repeated string + +
+ +
The parties that are notified of this event. For an ``ArchivedEvent``, these are the intersection of the stakeholders of the contract in question and the parties specified in the ``TransactionFilter``. The stakeholders are the union of the signatories and the observers of the contract. Each one of its elements must be a valid PartyIdString (as described in ``value.proto``). Required
+ +
+ +
+
+ package_name + string + +
+ +
The package name of the contract. Required
+ +
+ +
+
+ implemented_interfaces + repeated Identifier + +
+ +
The interfaces implemented by the target template that have been matched from the interface filter query. Populated only in case interface filters with include_interface_view set. If defined, the identifier uses the package-id reference format. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ offset + int64 + +
+ +
The offset of origin. Offsets are managed by the participant nodes. Transactions can thus NOT be assumed to have the same offsets on different participant nodes. Required, it is a valid absolute offset (positive integer)
+ +
+ +
+
+ node_id + int32 + +
+ +
The position of this event in the originating transaction or reassignment. Node IDs are not necessarily equal across participants, as these may see different projections/parts of transactions. Required, must be valid node ID (non-negative integer)
+ +
+ +
+
+ contract_id + string + +
+ +
The ID of the target contract. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ template_id + Identifier + +
+ +
Identifies the template that defines the executed choice. This template's package-id may differ from the target contract's package-id if the target contract has been upgraded or downgraded. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ interface_id + Identifier + +
+ +
The interface where the choice is defined, if inherited. If defined, the identifier uses the package-id reference format. Optional
+ +
+ +
+
+ choice + string + +
+ +
The choice that was exercised on the target contract. Must be a valid NameString (as described in ``value.proto``). Required
+ +
+ +
+
+ choice_argument + Value + +
+ +
The argument of the exercised choice. Required
+ +
+ +
+
+ acting_parties + repeated string + +
+ +
The parties that exercised the choice. Each element must be a valid PartyIdString (as described in ``value.proto``). Required
+ +
+ +
+
+ consuming + bool + +
+ +
If true, the target contract may no longer be exercised. Required
+ +
+ +
+
+ witness_parties + repeated string + +
+ +
The parties that are notified of this event. The witnesses of an exercise node will depend on whether the exercise was consuming or not. If consuming, the witnesses are the union of the stakeholders, the actors and all informees of all the ancestors of this event this participant knows about. If not consuming, the witnesses are the union of the signatories, the actors and all informees of all the ancestors of this event this participant knows about. In both cases the witnesses are limited to the querying parties, or not limited in case anyParty filters are used. Note that the actors might not necessarily be observers and thus stakeholders. This is the case when the controllers of a choice are specified using "flexible controllers", using the ``choice ... controller`` syntax, and said controllers are not explicitly marked as observers. Each element must be a valid PartyIdString (as described in ``value.proto``). Required
+ +
+ +
+
+ last_descendant_node_id + int32 + +
+ +
Specifies the upper boundary of the node ids of the events in the same transaction that appeared as a result of this ``ExercisedEvent``. This allows unambiguous identification of all the members of the subtree rooted at this node. A full subtree can be constructed when all descendant nodes are present in the stream. If nodes are heavily filtered, it is only possible to determine if a node is in a consequent subtree or not. Required
+ +
+ +
+
+ exercise_result + Value + +
+ +
The result of exercising the choice. Required
+ +
+ +
+
+ package_name + string + +
+ +
The package name of the contract. Required
+ +
+ +
+
+ implemented_interfaces + repeated Identifier + +
+ +
If the event is consuming, the interfaces implemented by the target template that have been matched from the interface filter query. Populated only in case interface filters with include_interface_view set. The identifier uses the package-id reference format. Optional
+ +
+ +
+
+ acs_delta + bool + +
+ +
Whether this event would be part of respective ACS_DELTA shaped stream, and should therefore considered when tracking contract activeness on the client-side. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ traceparent + string + +
+ +
https://www.w3.org/TR/trace-context/
+ +
+ +
+
+ tracestate + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ update_id + string + +
+ +
Assigned by the server. Useful for correlating logs. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ command_id + string + +
+ +
The ID of the command which resulted in this reassignment. Missing for everyone except the submitting party on the submitting participant. Must be a valid LedgerString (as described in ``value.proto``). Optional
+ +
+ +
+
+ workflow_id + string + +
+ +
The workflow ID used in reassignment command submission. Only set if the ``workflow_id`` for the command was set. Must be a valid LedgerString (as described in ``value.proto``). Optional
+ +
+ +
+
+ offset + int64 + +
+ +
The participant's offset. The details of this field are described in ``community/ledger-api/README.md``. Required, must be a valid absolute offset (positive integer).
+ +
+ +
+
+ events + repeated ReassignmentEvent + +
+ +
The collection of reassignment events. Required.
+ +
+ +
+
+ trace_context + TraceContext + +
+ +
Optional; ledger API trace context The trace context transported in this message corresponds to the trace context supplied by the client application in a HTTP2 header of the original command submission. We typically use a header to transfer this type of information. Here we use message body, because it is used in gRPC streams which do not support per message headers. This field will be populated with the trace context contained in the original submission. If that was not provided, a unique ledger-api-server generated trace context will be used instead.
+ +
+ +
+
+ record_time + Timestamp + +
+ +
The time at which the reassignment was recorded. The record time refers to the source/target synchronizer for an unassign/assign event respectively. Required
+ +
+ +
+
+ synchronizer_id + string + +
+ +
A valid synchronizer id. Identifies the synchronizer that synchronized this Reassignment. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ unassigned + UnassignedEvent + +
+ +
+ +
+
+ assigned + AssignedEvent + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ reassignment_id + string + +
+ +
The ID of the unassignment. This needs to be used as an input for a assign ReassignmentCommand. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ contract_id + string + +
+ +
The ID of the reassigned contract. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ template_id + Identifier + +
+ +
The template of the reassigned contract. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ source + string + +
+ +
The ID of the source synchronizer Must be a valid synchronizer id Required
+ +
+ +
+
+ target + string + +
+ +
The ID of the target synchronizer Must be a valid synchronizer id Required
+ +
+ +
+
+ submitter + string + +
+ +
Party on whose behalf the unassign command was executed. Empty if the unassignment happened offline via the repair service. Must be a valid PartyIdString (as described in ``value.proto``). Optional
+ +
+ +
+
+ reassignment_counter + uint64 + +
+ +
Each corresponding assigned and unassigned event has the same reassignment_counter. This strictly increases with each unassign command for the same contract. Creation of the contract corresponds to reassignment_counter equals zero. Required
+ +
+ +
+
+ assignment_exclusivity + Timestamp + +
+ +
Assignment exclusivity Before this time (measured on the target synchronizer), only the submitter of the unassignment can initiate the assignment Defined for reassigning participants. Optional
+ +
+ +
+
+ witness_parties + repeated string + +
+ +
The parties that are notified of this event. Required
+ +
+ +
+
+ package_name + string + +
+ +
The package name of the contract. Required
+ +
+ +
+
+ offset + int64 + +
+ +
The offset of origin. Offsets are managed by the participant nodes. Reassignments can thus NOT be assumed to have the same offsets on different participant nodes. Required, it is a valid absolute offset (positive integer)
+ +
+ +
+
+ node_id + int32 + +
+ +
The position of this event in the originating reassignment. Node IDs are not necessarily equal across participants, as these may see different projections/parts of reassignments. Required, must be valid node ID (non-negative integer)
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ source + string + +
+ +
The ID of the source synchronizer. Must be a valid synchronizer id. Required
+ +
+ +
+
+ target + string + +
+ +
The ID of the target synchronizer. Must be a valid synchronizer id. Required
+ +
+ +
+
+ reassignment_id + string + +
+ +
The ID from the unassigned event. For correlation capabilities. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ submitter + string + +
+ +
Party on whose behalf the assign command was executed. Empty if the assignment happened offline via the repair service. Must be a valid PartyIdString (as described in ``value.proto``). Optional
+ +
+ +
+
+ reassignment_counter + uint64 + +
+ +
Each corresponding assigned and unassigned event has the same reassignment_counter. This strictly increases with each unassign command for the same contract. Creation of the contract corresponds to reassignment_counter equals zero. Required
+ +
+ +
+
+ created_event + CreatedEvent + +
+ +
Required The offset of this event refers to the offset of the assignment, while the node_id is the index of within the batch.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ offset + int64 + +
+ +
The participant's offset, the details of the offset field are described in ``community/ledger-api/README.md``. Required, must be a valid absolute offset (positive integer).
+ +
+ +
+
+ synchronizer_times + repeated SynchronizerTime + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ synchronizer_id + string + +
+ +
The id of the synchronizer. Required
+ +
+ +
+
+ record_time + Timestamp + +
+ +
All commands with a maximum record time below this value MUST be considered lost if their completion has not arrived before this checkpoint. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ update_id + string + +
+ +
Assigned by the server. Useful for correlating logs. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ offset + int64 + +
+ +
The absolute offset. The details of this field are described in ``community/ledger-api/README.md``. Required, it is a valid absolute offset (positive integer).
+ +
+ +
+
+ synchronizer_id + string + +
+ +
A valid synchronizer id. Identifies the synchronizer that synchronized the topology transaction. Required
+ +
+ +
+
+ record_time + Timestamp + +
+ +
The time at which the changes in the topology transaction become effective. There is a small delay between a topology transaction being sequenced and the changes it contains becoming effective. Topology transactions appear in order relative to a synchronizer based on their effective time rather than their sequencing time. Required
+ +
+ +
+
+ events + repeated TopologyEvent + +
+ +
A non-empty list of topology events. Required
+ +
+ +
+
+ trace_context + TraceContext + +
+ +
Optional; ledger API trace context The trace context transported in this message corresponds to the trace context supplied by the client application in a HTTP2 header of the original command submission. We typically use a header to transfer this type of information. Here we use message body, because it is used in gRPC streams which do not support per message headers. This field will be populated with the trace context contained in the original submission. If that was not provided, a unique ledger-api-server generated trace context will be used instead.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ participant_authorization_changed + ParticipantAuthorizationChanged + +
+ +
+ +
+
+ participant_authorization_revoked + ParticipantAuthorizationRevoked + +
+ +
+ +
+
+ participant_authorization_added + ParticipantAuthorizationAdded + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ party_id + string + +
+ +
Required
+ +
+ +
+
+ participant_id + string + +
+ +
Required
+ +
+ +
+
+ participant_permission + ParticipantPermission + +
+ +
Required
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • PARTICIPANT_PERMISSION_UNSPECIFIED
    • + +
  • PARTICIPANT_PERMISSION_SUBMISSION
    • + +
  • PARTICIPANT_PERMISSION_CONFIRMATION
    • + +
  • PARTICIPANT_PERMISSION_OBSERVATION
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ party_id + string + +
+ +
Required
+ +
+ +
+
+ participant_id + string + +
+ +
Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ party_id + string + +
+ +
Required
+ +
+ +
+
+ participant_id + string + +
+ +
Required
+ +
+ +
+
+ participant_permission + ParticipantPermission + +
+ +
Required
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/versionservice/getledgerapiversion.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/versionservice/getledgerapiversion.mdx new file mode 100644 index 0000000..d5607b4 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/versionservice/getledgerapiversion.mdx @@ -0,0 +1,587 @@ +--- +title: "GetLedgerApiVersion" +--- + +
+ + + + +
+ +

com.daml.ledger.api.v2

+ + +

GetLedgerApiVersion

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.VersionService/GetLedgerApiVersion + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.VersionService/GetLedgerApiVersion <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "version": "string", + "features": { + "experimental": { + "staticTime": { + "supported": true + }, + "commandInspectionService": { + "supported": true + } + }, + "userManagement": { + "supported": true, + "maxRightsPerUser": 0, + "maxUsersPageSize": 0 + }, + "partyManagement": { + "maxPartiesPageSize": 0 + }, + "offsetCheckpoint": { + "maxOffsetCheckpointEmissionDelay": "string" + }, + "packageFeature": { + "maxVettedPackagesPageSize": 0 + } + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
VersionService
+
+ +
+
RPC
+
GetLedgerApiVersion
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetLedgerApiVersionRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.GetLedgerApiVersionRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

GetLedgerApiVersionResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.GetLedgerApiVersionResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ version + string + +
+ +
The version of the ledger API.
+ +
+ +
+
+ features + FeaturesDescriptor + +
+ +
The features supported by this Ledger API endpoint. Daml applications CAN use the feature descriptor on top of version constraints on the Ledger API version to determine whether a given Ledger API endpoint supports the features required to run the application. See the feature descriptions themselves for the relation between Ledger API versions and feature presence.
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ version + string + +
+ +
The version of the ledger API.
+ +
+ +
+
+ features + FeaturesDescriptor + +
+ +
The features supported by this Ledger API endpoint. Daml applications CAN use the feature descriptor on top of version constraints on the Ledger API version to determine whether a given Ledger API endpoint supports the features required to run the application. See the feature descriptions themselves for the relation between Ledger API versions and feature presence.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ experimental + ExperimentalFeatures + +
+ +
Features under development or features that are used for ledger implementation testing purposes only. Daml applications SHOULD not depend on these in production.
+ +
+ +
+
+ user_management + UserManagementFeature + +
+ +
If set, then the Ledger API server supports user management. It is recommended that clients query this field to gracefully adjust their behavior for ledgers that do not support user management.
+ +
+ +
+
+ party_management + PartyManagementFeature + +
+ +
If set, then the Ledger API server supports party management configurability. It is recommended that clients query this field to gracefully adjust their behavior to maximum party page size.
+ +
+ +
+
+ offset_checkpoint + OffsetCheckpointFeature + +
+ +
It contains the timeouts related to the periodic offset checkpoint emission
+ +
+ +
+
+ package_feature + PackageFeature + +
+ +
If set, then the Ledger API server supports package listing configurability. It is recommended that clients query this field to gracefully adjust their behavior to maximum package listing page size.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ static_time + ExperimentalStaticTime + +
+ +
+ +
+
+ command_inspection_service + ExperimentalCommandInspectionService + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ supported + bool + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ supported + bool + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ supported + bool + +
+ +
Whether the Ledger API server provides the user management service.
+ +
+ +
+
+ max_rights_per_user + int32 + +
+ +
The maximum number of rights that can be assigned to a single user. Servers MUST support at least 100 rights per user. A value of 0 means that the server enforces no rights per user limit.
+ +
+ +
+
+ max_users_page_size + int32 + +
+ +
The maximum number of users the server can return in a single response (page). Servers MUST support at least a 100 users per page. A value of 0 means that the server enforces no page size limit.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ max_parties_page_size + int32 + +
+ +
The maximum number of parties the server can return in a single response (page).
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ max_offset_checkpoint_emission_delay + Duration + +
+ +
The maximum delay to emmit a new OffsetCheckpoint if it exists
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ max_vetted_packages_page_size + int32 + +
+ +
The maximum number of vetted packages the server can return in a single response (page) when listing them.
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/getlasterrors.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/getlasterrors.mdx new file mode 100644 index 0000000..2d837fd --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/getlasterrors.mdx @@ -0,0 +1,312 @@ +--- +title: "GetLastErrors" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.health.v30

+ + +

GetLastErrors

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.health.v30.StatusService/GetLastErrors + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.health.v30.StatusService/GetLastErrors <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "errors": [ + { + "traceId": "string", + "message": "string" + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
StatusService
+
+ +
+
RPC
+
GetLastErrors
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetLastErrorsRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.health.v30.GetLastErrorsRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

GetLastErrorsResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.health.v30.GetLastErrorsResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ errors + repeated Error + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ errors + repeated Error + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ trace_id + string + +
+ +
+ +
+
+ message + string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/getlasterrortrace.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/getlasterrortrace.mdx new file mode 100644 index 0000000..1b85169 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/getlasterrortrace.mdx @@ -0,0 +1,310 @@ +--- +title: "GetLastErrorTrace" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.health.v30

+ + +

GetLastErrorTrace

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.health.v30.StatusService/GetLastErrorTrace + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.health.v30.StatusService/GetLastErrorTrace <<'EOF' +{ + "traceId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "messages": [ + "string" + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
StatusService
+
+ +
+
RPC
+
GetLastErrorTrace
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetLastErrorTraceRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.health.v30.GetLastErrorTraceRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ trace_id + string + +
+ +
The trace id of the error
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

GetLastErrorTraceResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.health.v30.GetLastErrorTraceResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ messages + repeated string + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ trace_id + string + +
+ +
The trace id of the error
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ messages + repeated string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/healthdump.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/healthdump.mdx new file mode 100644 index 0000000..aa631a4 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/healthdump.mdx @@ -0,0 +1,313 @@ +--- +title: "HealthDump" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.health.v30

+ + +

HealthDump

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.health.v30.StatusService/HealthDump + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.health.v30.StatusService/HealthDump <<'EOF' +{ + "chunkSize": 0 +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "chunk": "BASE64_ENCODED_BYTES" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
StatusService
+
+ +
+
RPC
+
HealthDump
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
Yes
+
+ +
+ + +## Inputs + + +
+
+

HealthDumpRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.health.v30.HealthDumpRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ chunk_size + uint32 + +
+ +
Size of the byte chunks to stream back. Defaults to 2MB (half of the default gRPC max message size)
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

HealthDumpResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.health.v30.HealthDumpResponse
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + +
+ +
+
+ chunk + bytes + +
+ +
A chunk of of the health dump file
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ chunk_size + uint32 + +
+ +
Size of the byte chunks to stream back. Defaults to 2MB (half of the default gRPC max message size)
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ chunk + bytes + +
+ +
A chunk of of the health dump file
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/setloglevel.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/setloglevel.mdx new file mode 100644 index 0000000..64e6333 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/setloglevel.mdx @@ -0,0 +1,280 @@ +--- +title: "SetLogLevel" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.health.v30

+ + +

SetLogLevel

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.health.v30.StatusService/SetLogLevel + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.health.v30.StatusService/SetLogLevel <<'EOF' +{ + "level": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
StatusService
+
+ +
+
RPC
+
SetLogLevel
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

SetLogLevelRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.health.v30.SetLogLevelRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ level + string + +
+ +
TODO(#18445) use an enum for the log level as right now, it also accepts OFF and null The log level to set (DEBUG, INFO, WARN, ERROR, OFF)
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

SetLogLevelResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.health.v30.SetLogLevelResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ level + string + +
+ +
TODO(#18445) use an enum for the log level as right now, it also accepts OFF and null The log level to set (DEBUG, INFO, WARN, ERROR, OFF)
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-mediator-v30/mediatorstatusservice/mediatorstatus.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-mediator-v30/mediatorstatusservice/mediatorstatus.mdx new file mode 100644 index 0000000..f1543ae --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-mediator-v30/mediatorstatusservice/mediatorstatus.mdx @@ -0,0 +1,625 @@ +--- +title: "MediatorStatus" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.mediator.v30

+ + +

MediatorStatus

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.mediator.v30.MediatorStatusService/MediatorStatus + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.mediator.v30.MediatorStatusService/MediatorStatus <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "status": { + "commonStatus": { + "uid": "string", + "uptime": "string", + "ports": [ + { + "key": 0 + } + ], + "active": true, + "topologyQueues": { + "manager": 0, + "dispatcher": 0, + "clients": 0 + }, + "components": [ + { + "name": "string", + "ok": {} + } + ], + "version": "string" + }, + "physicalSynchronizerId": "string", + "protocolVersion": 0 + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
MediatorStatusService
+
+ +
+
RPC
+
MediatorStatus
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

MediatorStatusRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.mediator.v30.MediatorStatusRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

MediatorStatusResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.mediator.v30.MediatorStatusResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ status + MediatorStatusResponseStatus + +
+ +
+ +
+
+ not_initialized + NotInitialized + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ status + MediatorStatusResponseStatus + +
+ +
+ +
+
+ not_initialized + NotInitialized + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ common_status + Status + +
+ +
+ +
+
+ physical_synchronizer_id + string + +
+ +
+ +
+
+ protocol_version + int32 + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ uid + string + +
+ +
+ +
+
+ uptime + Duration + +
+ +
+ +
+
+ ports + repeated map + +
+ +
+ +
+
+ active + bool + +
+ +
Indicate if the node is active, usually true unless it's a replicated node that is passive
+ +
+ +
+
+ topology_queues + TopologyQueueStatus + +
+ +
indicates the state of the topology queues (manager / dispatcher only where they exist)
+ +
+ +
+
+ components + repeated ComponentStatus + +
+ +
Health state of component dependencies of the node
+ +
+ +
+
+ version + string + +
+ +
Version of the binary
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ manager + uint32 + +
+ +
how many topology changes are currently queued at the manager
+ +
+ +
+
+ dispatcher + uint32 + +
+ +
how many topology changes are currently queued at the dispatcher
+ +
+ +
+
+ clients + uint32 + +
+ +
how many topology changes are currently waiting to become effective (across all connected synchronizers in the case of participants)
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ name + string + +
+ +
+ +
+
+ ok + StatusData + +
+ +
+ +
+
+ degraded + StatusData + +
+ +
+ +
+
+ failed + StatusData + +
+ +
+ +
+
+ fatal + StatusData + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ description + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ active + bool + +
+ +
Indicate if the node is active, usually true unless it's a replicated node that is passive
+ +
+ +
+
+ waiting_for_external_input + WaitingForExternalInput + +
+ +
Indicates whether the node is waiting for external input
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • WAITING_FOR_EXTERNAL_INPUT_UNSPECIFIED
    • + +
  • WAITING_FOR_EXTERNAL_INPUT_ID
    • + +
  • WAITING_FOR_EXTERNAL_INPUT_NODE_TOPOLOGY
    • + +
  • WAITING_FOR_EXTERNAL_INPUT_INITIALIZATION
    • + +
+ + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/enterpriseparticipantreplicationservice/setpassive.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/enterpriseparticipantreplicationservice/setpassive.mdx new file mode 100644 index 0000000..b675d96 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/enterpriseparticipantreplicationservice/setpassive.mdx @@ -0,0 +1,248 @@ +--- +title: "SetPassive" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

SetPassive

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.EnterpriseParticipantReplicationService/SetPassive + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.EnterpriseParticipantReplicationService/SetPassive <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
EnterpriseParticipantReplicationService
+
+ +
+
RPC
+
SetPassive
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

SetPassiveRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.SetPassiveRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

SetPassiveResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.SetPassiveResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getdar.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getdar.mdx new file mode 100644 index 0000000..ee45abe --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getdar.mdx @@ -0,0 +1,377 @@ +--- +title: "GetDar" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

GetDar

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.PackageService/GetDar + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PackageService/GetDar <<'EOF' +{ + "mainPackageId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "payload": "BASE64_ENCODED_BYTES", + "data": { + "main": "string", + "name": "string", + "version": "string", + "description": "string" + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PackageService
+
+ +
+
RPC
+
GetDar
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetDarRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.GetDarRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ main_package_id + string + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

GetDarResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.GetDarResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ payload + bytes + +
+ +
+ +
+
+ data + DarDescription + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ main_package_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ payload + bytes + +
+ +
+ +
+
+ data + DarDescription + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ main + string + +
+ +
+ +
+
+ name + string + +
+ +
+ +
+
+ version + string + +
+ +
+ +
+
+ description + string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getdarcontents.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getdarcontents.mdx new file mode 100644 index 0000000..5204489 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getdarcontents.mdx @@ -0,0 +1,443 @@ +--- +title: "GetDarContents" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

GetDarContents

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.PackageService/GetDarContents + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PackageService/GetDarContents <<'EOF' +{ + "mainPackageId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "description": { + "main": "string", + "name": "string", + "version": "string", + "description": "string" + }, + "packages": [ + { + "packageId": "string", + "name": "string", + "version": "string", + "uploadedAt": "string", + "size": 0 + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PackageService
+
+ +
+
RPC
+
GetDarContents
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetDarContentsRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.GetDarContentsRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ main_package_id + string + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

GetDarContentsResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.GetDarContentsResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ description + DarDescription + +
+ +
+ +
+
+ packages + repeated PackageDescription + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ main_package_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ description + DarDescription + +
+ +
+ +
+
+ packages + repeated PackageDescription + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ main + string + +
+ +
+ +
+
+ name + string + +
+ +
+ +
+
+ version + string + +
+ +
+ +
+
+ description + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ package_id + string + +
+ +
+ +
+
+ name + string + +
+ +
+ +
+
+ version + string + +
+ +
+ +
+
+ uploaded_at + Timestamp + +
+ +
+ +
+
+ size + uint32 + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getpackagecontents.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getpackagecontents.mdx new file mode 100644 index 0000000..6774e14 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getpackagecontents.mdx @@ -0,0 +1,451 @@ +--- +title: "GetPackageContents" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

GetPackageContents

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.PackageService/GetPackageContents + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PackageService/GetPackageContents <<'EOF' +{ + "packageId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "description": { + "packageId": "string", + "name": "string", + "version": "string", + "uploadedAt": "string", + "size": 0 + }, + "modules": [ + { + "name": "string" + } + ], + "isUtilityPackage": true, + "languageVersion": "string" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PackageService
+
+ +
+
RPC
+
GetPackageContents
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetPackageContentsRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.GetPackageContentsRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ package_id + string + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

GetPackageContentsResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.GetPackageContentsResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ description + PackageDescription + +
+ +
+ +
+
+ modules + repeated ModuleDescription + +
+ +
+ +
+
+ is_utility_package + bool + +
+ +
+ +
+
+ language_version + string + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ package_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ description + PackageDescription + +
+ +
+ +
+
+ modules + repeated ModuleDescription + +
+ +
+ +
+
+ is_utility_package + bool + +
+ +
+ +
+
+ language_version + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ package_id + string + +
+ +
+ +
+
+ name + string + +
+ +
+ +
+
+ version + string + +
+ +
+ +
+
+ uploaded_at + Timestamp + +
+ +
+ +
+
+ size + uint32 + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ name + string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getpackagereferences.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getpackagereferences.mdx new file mode 100644 index 0000000..4f3561f --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getpackagereferences.mdx @@ -0,0 +1,360 @@ +--- +title: "GetPackageReferences" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

GetPackageReferences

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.PackageService/GetPackageReferences + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PackageService/GetPackageReferences <<'EOF' +{ + "packageId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "dars": [ + { + "main": "string", + "name": "string", + "version": "string", + "description": "string" + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PackageService
+
+ +
+
RPC
+
GetPackageReferences
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetPackageReferencesRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.GetPackageReferencesRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ package_id + string + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

GetPackageReferencesResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.GetPackageReferencesResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ dars + repeated DarDescription + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ package_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ dars + repeated DarDescription + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ main + string + +
+ +
+ +
+
+ name + string + +
+ +
+ +
+
+ version + string + +
+ +
+ +
+
+ description + string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/listdars.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/listdars.mdx new file mode 100644 index 0000000..c62cd11 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/listdars.mdx @@ -0,0 +1,379 @@ +--- +title: "ListDars" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

ListDars

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.PackageService/ListDars + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PackageService/ListDars <<'EOF' +{ + "limit": 0, + "filterName": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "dars": [ + { + "main": "string", + "name": "string", + "version": "string", + "description": "string" + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PackageService
+
+ +
+
RPC
+
ListDars
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ListDarsRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.ListDarsRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ limit + int32 + +
+ +
+ +
+
+ filter_name + string + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ListDarsResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.ListDarsResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ dars + repeated DarDescription + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ limit + int32 + +
+ +
+ +
+
+ filter_name + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ dars + repeated DarDescription + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ main + string + +
+ +
+ +
+
+ name + string + +
+ +
+ +
+
+ version + string + +
+ +
+ +
+
+ description + string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/listpackages.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/listpackages.mdx new file mode 100644 index 0000000..9697957 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/listpackages.mdx @@ -0,0 +1,389 @@ +--- +title: "ListPackages" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

ListPackages

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.PackageService/ListPackages + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PackageService/ListPackages <<'EOF' +{ + "limit": 0, + "filterName": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "packageDescriptions": [ + { + "packageId": "string", + "name": "string", + "version": "string", + "uploadedAt": "string", + "size": 0 + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PackageService
+
+ +
+
RPC
+
ListPackages
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ListPackagesRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.ListPackagesRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ limit + int32 + +
+ +
+ +
+
+ filter_name + string + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ListPackagesResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.ListPackagesResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ package_descriptions + repeated PackageDescription + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ limit + int32 + +
+ +
+ +
+
+ filter_name + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ package_descriptions + repeated PackageDescription + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ package_id + string + +
+ +
+ +
+
+ name + string + +
+ +
+ +
+
+ version + string + +
+ +
+ +
+
+ uploaded_at + Timestamp + +
+ +
+ +
+
+ size + uint32 + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/removedar.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/removedar.mdx new file mode 100644 index 0000000..f8796ee --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/removedar.mdx @@ -0,0 +1,276 @@ +--- +title: "RemoveDar" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

RemoveDar

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.PackageService/RemoveDar + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PackageService/RemoveDar <<'EOF' +{ + "mainPackageId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PackageService
+
+ +
+
RPC
+
RemoveDar
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

RemoveDarRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.RemoveDarRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ main_package_id + string + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

RemoveDarResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.RemoveDarResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ main_package_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/removepackage.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/removepackage.mdx new file mode 100644 index 0000000..10c953c --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/removepackage.mdx @@ -0,0 +1,323 @@ +--- +title: "RemovePackage" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

RemovePackage

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.PackageService/RemovePackage + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PackageService/RemovePackage <<'EOF' +{ + "packageId": "string", + "force": true +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "success": "string" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PackageService
+
+ +
+
RPC
+
RemovePackage
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

RemovePackageRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.RemovePackageRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ package_id + string + +
+ +
+ +
+
+ force + bool + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

RemovePackageResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.RemovePackageResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ success + Empty + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ package_id + string + +
+ +
+ +
+
+ force + bool + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ success + Empty + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/unvetdar.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/unvetdar.mdx new file mode 100644 index 0000000..3912f3e --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/unvetdar.mdx @@ -0,0 +1,299 @@ +--- +title: "UnvetDar" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

UnvetDar

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.PackageService/UnvetDar + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PackageService/UnvetDar <<'EOF' +{ + "mainPackageId": "string", + "synchronizerId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PackageService
+
+ +
+
RPC
+
UnvetDar
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

UnvetDarRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.UnvetDarRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ main_package_id + string + +
+ +
+ +
+
+ synchronizer_id + string + +
+ +
the synchronizer on which to unvet the package. can be omitted if the participant is connected to only one synchronizer.
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

UnvetDarResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.UnvetDarResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ main_package_id + string + +
+ +
+ +
+
+ synchronizer_id + string + +
+ +
the synchronizer on which to unvet the package. can be omitted if the participant is connected to only one synchronizer.
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/uploaddar.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/uploaddar.mdx new file mode 100644 index 0000000..b6ee2be --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/uploaddar.mdx @@ -0,0 +1,423 @@ +--- +title: "UploadDar" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

UploadDar

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.PackageService/UploadDar + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PackageService/UploadDar <<'EOF' +{ + "dars": [ + { + "bytes": "BASE64_ENCODED_BYTES", + "description": "string", + "expectedMainPackageId": "string" + } + ], + "vetAllPackages": true, + "synchronizeVetting": true, + "synchronizerId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "darIds": [ + "string" + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PackageService
+
+ +
+
RPC
+
UploadDar
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

UploadDarRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.UploadDarRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ dars + repeated UploadDarData + +
+ +
+ +
+
+ vet_all_packages + bool + +
+ +
If set to true (default), the node will register the vetting topology transactions on the specified synchronizer or autodetect the synchronizer if the participant is only connected to a single one. If multiple synchronizers are connected and no synchronizer is specified, the request returns a PACKAGE_SERVICE_CANNOT_AUTODETECT_SYNCHRONIZER error.
+ +
+ +
+
+ synchronize_vetting + bool + +
+ +
If set to true, we'll wait until the vetting transaction has been observed by this participant for the target synchronizer.
+ +
+ +
+
+ synchronizer_id + string + +
+ +
Used to specify the synchronizer to vet packages on when vet_all_packages is true.
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

UploadDarResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.UploadDarResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ dar_ids + repeated string + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ dars + repeated UploadDarData + +
+ +
+ +
+
+ vet_all_packages + bool + +
+ +
If set to true (default), the node will register the vetting topology transactions on the specified synchronizer or autodetect the synchronizer if the participant is only connected to a single one. If multiple synchronizers are connected and no synchronizer is specified, the request returns a PACKAGE_SERVICE_CANNOT_AUTODETECT_SYNCHRONIZER error.
+ +
+ +
+
+ synchronize_vetting + bool + +
+ +
If set to true, we'll wait until the vetting transaction has been observed by this participant for the target synchronizer.
+ +
+ +
+
+ synchronizer_id + string + +
+ +
Used to specify the synchronizer to vet packages on when vet_all_packages is true.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ bytes + bytes + +
+ +
+ +
+
+ description + string + +
+ +
+ +
+
+ expected_main_package_id + string + +
+ +
optionally the expected package id of the main package
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ dar_ids + repeated string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/validatedar.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/validatedar.mdx new file mode 100644 index 0000000..578f4b6 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/validatedar.mdx @@ -0,0 +1,346 @@ +--- +title: "ValidateDar" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

ValidateDar

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.PackageService/ValidateDar + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PackageService/ValidateDar <<'EOF' +{ + "data": "BASE64_ENCODED_BYTES", + "filename": "string", + "synchronizerId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "mainPackageId": "string" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PackageService
+
+ +
+
RPC
+
ValidateDar
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ValidateDarRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.ValidateDarRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ data + bytes + +
+ +
+ +
+
+ filename + string + +
+ +
+ +
+
+ synchronizer_id + string + +
+ +
Used to specify the synchronizer on which to validate that vetting is correct.
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ValidateDarResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.ValidateDarResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ main_package_id + string + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ data + bytes + +
+ +
+ +
+
+ filename + string + +
+ +
+ +
+
+ synchronizer_id + string + +
+ +
Used to specify the synchronizer on which to validate that vetting is correct.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ main_package_id + string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/vetdar.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/vetdar.mdx new file mode 100644 index 0000000..baa1433 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/vetdar.mdx @@ -0,0 +1,322 @@ +--- +title: "VetDar" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

VetDar

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.PackageService/VetDar + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PackageService/VetDar <<'EOF' +{ + "mainPackageId": "string", + "synchronize": true, + "synchronizerId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PackageService
+
+ +
+
RPC
+
VetDar
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

VetDarRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.VetDarRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ main_package_id + string + +
+ +
+ +
+
+ synchronize + bool + +
+ +
if set to true, the API call waits until the vetting transaction has been observed by this participant on the specified synchronizer.
+ +
+ +
+
+ synchronizer_id + string + +
+ +
the synchronizer on which to vet the package. can be omitted if the participant is connected to only one synchronizer.
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

VetDarResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.VetDarResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ main_package_id + string + +
+ +
+ +
+
+ synchronize + bool + +
+ +
if set to true, the API call waits until the vetting transaction has been observed by this participant on the specified synchronizer.
+ +
+ +
+
+ synchronizer_id + string + +
+ +
the synchronizer on which to vet the package. can be omitted if the participant is connected to only one synchronizer.
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/countinflight.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/countinflight.mdx new file mode 100644 index 0000000..ca6704d --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/countinflight.mdx @@ -0,0 +1,327 @@ +--- +title: "CountInFlight" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

CountInFlight

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/CountInFlight + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/CountInFlight <<'EOF' +{ + "synchronizerId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "pendingSubmissions": 0, + "pendingTransactions": 0 +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
ParticipantInspectionService
+
+ +
+
RPC
+
CountInFlight
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

CountInFlightRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.CountInFlightRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ synchronizer_id + string + +
+ +
the synchronizer to query for pending submissions and in-flight transactions
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

CountInFlightResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.CountInFlightResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ pending_submissions + uint32 + +
+ +
+ +
+
+ pending_transactions + uint32 + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ synchronizer_id + string + +
+ +
the synchronizer to query for pending submissions and in-flight transactions
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ pending_submissions + uint32 + +
+ +
+ +
+
+ pending_transactions + uint32 + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/getconfigforslowcounterparticipants.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/getconfigforslowcounterparticipants.mdx new file mode 100644 index 0000000..1e7d6ad --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/getconfigforslowcounterparticipants.mdx @@ -0,0 +1,392 @@ +--- +title: "GetConfigForSlowCounterParticipants" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

GetConfigForSlowCounterParticipants

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/GetConfigForSlowCounterParticipants + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/GetConfigForSlowCounterParticipants <<'EOF' +{ + "synchronizerIds": [ + "string" + ] +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "configs": [ + { + "synchronizerIds": [ + "string" + ], + "distinguishedParticipantUids": [ + "string" + ], + "thresholdDistinguished": "0", + "thresholdDefault": "0", + "participantUidsMetrics": [ + "string" + ] + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
ParticipantInspectionService
+
+ +
+
RPC
+
GetConfigForSlowCounterParticipants
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetConfigForSlowCounterParticipantsRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.GetConfigForSlowCounterParticipantsRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ synchronizer_ids + repeated string + +
+ +
filters by synchronizers
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

GetConfigForSlowCounterParticipantsResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.GetConfigForSlowCounterParticipantsResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ configs + repeated SlowCounterParticipantSynchronizerConfig + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ synchronizer_ids + repeated string + +
+ +
filters by synchronizers
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ configs + repeated SlowCounterParticipantSynchronizerConfig + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ synchronizer_ids + repeated string + +
+ +
the synchronizers for which we apply the settings below
+ +
+ +
+
+ distinguished_participant_uids + repeated string + +
+ +
all non-distinguished counter-participants are implicitly part of the group "default"
+ +
+ +
+
+ threshold_distinguished + uint64 + +
+ +
the number of reconciliation intervals for a distinguished counter-participant to be considered slow
+ +
+ +
+
+ threshold_default + uint64 + +
+ +
the number of reconciliation intervals for an "other" counter-participant to be considered slow
+ +
+ +
+
+ participant_uids_metrics + repeated string + +
+ +
participants for which we publish independent metrics counting how many intervals they are behind
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/getintervalsbehindforcounterparticipants.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/getintervalsbehindforcounterparticipants.mdx new file mode 100644 index 0000000..ad58b2f --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/getintervalsbehindforcounterparticipants.mdx @@ -0,0 +1,430 @@ +--- +title: "GetIntervalsBehindForCounterParticipants" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

GetIntervalsBehindForCounterParticipants

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/GetIntervalsBehindForCounterParticipants + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/GetIntervalsBehindForCounterParticipants <<'EOF' +{ + "counterParticipantIds": [ + "string" + ], + "synchronizerIds": [ + "string" + ], + "threshold": "0" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "intervalsBehind": [ + { + "counterParticipantUid": "string", + "synchronizerId": "string", + "intervalsBehind": "0", + "behindSince": "string", + "asOfSequencingTimestamp": "string" + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
ParticipantInspectionService
+
+ +
+
RPC
+
GetIntervalsBehindForCounterParticipants
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetIntervalsBehindForCounterParticipantsRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.GetIntervalsBehindForCounterParticipantsRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ counter_participant_ids + repeated string + +
+ +
if empty, all counter-participants are considered
+ +
+ +
+
+ synchronizer_ids + repeated string + +
+ +
if empty, all synchronizers are considered
+ +
+ +
+
+ threshold + uint64 + +
+ +
if set, only counter-participants that are behind by at least this number of intervals are returned
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

GetIntervalsBehindForCounterParticipantsResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.GetIntervalsBehindForCounterParticipantsResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ intervals_behind + repeated CounterParticipantInfo + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ counter_participant_ids + repeated string + +
+ +
if empty, all counter-participants are considered
+ +
+ +
+
+ synchronizer_ids + repeated string + +
+ +
if empty, all synchronizers are considered
+ +
+ +
+
+ threshold + uint64 + +
+ +
if set, only counter-participants that are behind by at least this number of intervals are returned
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ intervals_behind + repeated CounterParticipantInfo + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ counter_participant_uid + string + +
+ +
+ +
+
+ synchronizer_id + string + +
+ +
+ +
+
+ intervals_behind + uint64 + +
+ +
MaxInt(2147483647) means that the counter-participant never sent a commitment
+ +
+ +
+
+ behind_since + Duration + +
+ +
how long time the corresponding intervals correlate to (Timestamp in the future means it has never sent a commitment) this is to help debugging, especially in the case where the reconciliation interval have been changed. for example, if we have a counter participant that is three intervals behind, and each interval is one minute. if the reconciliation interval is changed to 24 hours, then it might look like that counter-participant is three days behind (when it is actually only three minutes behind).
+ +
+ +
+
+ as_of_sequencing_timestamp + Timestamp + +
+ +
the "as of" sequencing timestamp at which this information was obtained
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/inspectcommitmentcontracts.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/inspectcommitmentcontracts.mdx new file mode 100644 index 0000000..1cff791 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/inspectcommitmentcontracts.mdx @@ -0,0 +1,384 @@ +--- +title: "InspectCommitmentContracts" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

InspectCommitmentContracts

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/InspectCommitmentContracts + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/InspectCommitmentContracts <<'EOF' +{ + "cids": [ + "BASE64_ENCODED_BYTES" + ], + "expectedSynchronizerId": "string", + "timestamp": "string", + "downloadPayload": true +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "chunk": "BASE64_ENCODED_BYTES" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
ParticipantInspectionService
+
+ +
+
RPC
+
InspectCommitmentContracts
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
Yes
+
+ +
+ + +## Inputs + + +
+
+

InspectCommitmentContractsRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.InspectCommitmentContractsRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ cids + repeated bytes + +
+ +
the contracts whose state and payload we want to retrieve
+ +
+ +
+
+ expected_synchronizer_id + string + +
+ +
the synchronizer on which we expect the contracts to be active
+ +
+ +
+
+ timestamp + Timestamp + +
+ +
timestamp at which we retrieve the state of the contracts on the expected synchronizer
+ +
+ +
+
+ download_payload + bool + +
+ +
whether to retrieve the payload of the contracts
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

InspectCommitmentContractsResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.InspectCommitmentContractsResponse
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + +
+ +
+
+ chunk + bytes + +
+ +
commitment contracts
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ cids + repeated bytes + +
+ +
the contracts whose state and payload we want to retrieve
+ +
+ +
+
+ expected_synchronizer_id + string + +
+ +
the synchronizer on which we expect the contracts to be active
+ +
+ +
+
+ timestamp + Timestamp + +
+ +
timestamp at which we retrieve the state of the contracts on the expected synchronizer
+ +
+ +
+
+ download_payload + bool + +
+ +
whether to retrieve the payload of the contracts
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ chunk + bytes + +
+ +
commitment contracts
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/lookupoffsetbytime.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/lookupoffsetbytime.mdx new file mode 100644 index 0000000..d03fcda --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/lookupoffsetbytime.mdx @@ -0,0 +1,312 @@ +--- +title: "LookupOffsetByTime" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

LookupOffsetByTime

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/LookupOffsetByTime + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/LookupOffsetByTime <<'EOF' +{ + "timestamp": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "offset": "0" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
ParticipantInspectionService
+
+ +
+
RPC
+
LookupOffsetByTime
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

LookupOffsetByTimeRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.LookupOffsetByTimeRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ timestamp + Timestamp + +
+ +
the timestamp to look up the offset for
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

LookupOffsetByTimeResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.LookupOffsetByTimeResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ offset + int64 + +
+ +
if specified, the absolute offset as an integer corresponding to the specified timestamp. if absent, no such offset exists.
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ timestamp + Timestamp + +
+ +
the timestamp to look up the offset for
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ offset + int64 + +
+ +
if specified, the absolute offset as an integer corresponding to the specified timestamp. if absent, no such offset exists.
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/lookupreceivedacscommitments.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/lookupreceivedacscommitments.mdx new file mode 100644 index 0000000..edf4faa --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/lookupreceivedacscommitments.mdx @@ -0,0 +1,618 @@ +--- +title: "LookupReceivedAcsCommitments" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

LookupReceivedAcsCommitments

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/LookupReceivedAcsCommitments + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/LookupReceivedAcsCommitments <<'EOF' +{ + "timeRanges": [ + { + "synchronizerId": "string", + "interval": { + "fromExclusive": "string", + "toInclusive": "string" + } + } + ], + "counterParticipantIds": [ + "string" + ], + "commitmentState": [ + "RECEIVED_COMMITMENT_STATE_UNSPECIFIED" + ], + "verbose": true +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "received": [ + { + "synchronizerId": "string", + "received": [ + { + "interval": { + "startTickExclusive": "string", + "endTickInclusive": "string" + }, + "originCounterParticipantUid": "string", + "receivedCommitment": "BASE64_ENCODED_BYTES", + "ownCommitment": "BASE64_ENCODED_BYTES", + "state": "RECEIVED_COMMITMENT_STATE_UNSPECIFIED" + } + ] + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
ParticipantInspectionService
+
+ +
+
RPC
+
LookupReceivedAcsCommitments
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

LookupReceivedAcsCommitmentsRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.LookupReceivedAcsCommitmentsRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ time_ranges + repeated SynchronizerTimeRange + +
+ +
filter specific time ranges per synchronizer a synchronizer can appear multiple times with various time ranges, in which case we consider the union of the time ranges. return only the received commitments with an interval overlapping any of the given time ranges per synchronizer defaults: if empty, all synchronizers known to the participant are considered
+ +
+ +
+
+ counter_participant_ids + repeated string + +
+ +
retrieve commitments received from specific counter participants if a specified counter participant is not a counter-participant in some synchronizer, we do not return it in the response an empty set means we return commitments received from all counter participants on the synchronizers matching the synchronizer filter.
+ +
+ +
+
+ commitment_state + repeated ReceivedCommitmentState + +
+ +
filter by commitment state: only return commitments with the states below if no state is given, we return all commitments
+ +
+ +
+
+ verbose + bool + +
+ +
include the actual commitment in the response
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

LookupReceivedAcsCommitmentsResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.LookupReceivedAcsCommitmentsResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ received + repeated ReceivedAcsCommitmentPerSynchronizer + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ time_ranges + repeated SynchronizerTimeRange + +
+ +
filter specific time ranges per synchronizer a synchronizer can appear multiple times with various time ranges, in which case we consider the union of the time ranges. return only the received commitments with an interval overlapping any of the given time ranges per synchronizer defaults: if empty, all synchronizers known to the participant are considered
+ +
+ +
+
+ counter_participant_ids + repeated string + +
+ +
retrieve commitments received from specific counter participants if a specified counter participant is not a counter-participant in some synchronizer, we do not return it in the response an empty set means we return commitments received from all counter participants on the synchronizers matching the synchronizer filter.
+ +
+ +
+
+ commitment_state + repeated ReceivedCommitmentState + +
+ +
filter by commitment state: only return commitments with the states below if no state is given, we return all commitments
+ +
+ +
+
+ verbose + bool + +
+ +
include the actual commitment in the response
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ synchronizer_id + string + +
+ +
+ +
+
+ interval + TimeRange + +
+ +
optional; if not given, the latest reconciliation period the participant knows of for that synchronizer is considered
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ from_exclusive + Timestamp + +
+ +
+ +
+
+ to_inclusive + Timestamp + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • RECEIVED_COMMITMENT_STATE_UNSPECIFIED
    • + +
  • RECEIVED_COMMITMENT_STATE_MATCH
    • + +
  • RECEIVED_COMMITMENT_STATE_MISMATCH
    • + +
  • RECEIVED_COMMITMENT_STATE_BUFFERED
    • + +
  • RECEIVED_COMMITMENT_STATE_OUTSTANDING
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ received + repeated ReceivedAcsCommitmentPerSynchronizer + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ synchronizer_id + string + +
+ +
+ +
+
+ received + repeated ReceivedAcsCommitment + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ interval + Interval + +
+ +
+ +
+
+ origin_counter_participant_uid + string + +
+ +
the counter participant that computed and sent the commitment, from whom the current participant received the commitment
+ +
+ +
+
+ received_commitment + bytes + +
+ +
the commitment received from the counter participant, unsigned because the admin trusts own participant's reply populated only if verbose mode is on
+ +
+ +
+
+ own_commitment + bytes + +
+ +
own commitment of participant that was compared with the received commitment, unsigned because the admin trusts own participant's reply populated only in case there is a mismatch and verbose mode is on might not correspond to the same interval as the received commitment, however, the matching timestamp is the end of the returned interval
+ +
+ +
+
+ state + ReceivedCommitmentState + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ start_tick_exclusive + Timestamp + +
+ +
+ +
+
+ end_tick_inclusive + Timestamp + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/lookupsentacscommitments.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/lookupsentacscommitments.mdx new file mode 100644 index 0000000..76e3d00 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/lookupsentacscommitments.mdx @@ -0,0 +1,616 @@ +--- +title: "LookupSentAcsCommitments" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

LookupSentAcsCommitments

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/LookupSentAcsCommitments + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/LookupSentAcsCommitments <<'EOF' +{ + "timeRanges": [ + { + "synchronizerId": "string", + "interval": { + "fromExclusive": "string", + "toInclusive": "string" + } + } + ], + "counterParticipantIds": [ + "string" + ], + "commitmentState": [ + "SENT_COMMITMENT_STATE_UNSPECIFIED" + ], + "verbose": true +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "sent": [ + { + "synchronizerId": "string", + "sent": [ + { + "interval": { + "startTickExclusive": "string", + "endTickInclusive": "string" + }, + "destCounterParticipantUid": "string", + "ownCommitment": "BASE64_ENCODED_BYTES", + "receivedCommitment": "BASE64_ENCODED_BYTES", + "state": "SENT_COMMITMENT_STATE_UNSPECIFIED" + } + ] + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
ParticipantInspectionService
+
+ +
+
RPC
+
LookupSentAcsCommitments
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

LookupSentAcsCommitmentsRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.LookupSentAcsCommitmentsRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ time_ranges + repeated SynchronizerTimeRange + +
+ +
filter specific time ranges per synchronizer a synchronizer can appear multiple times with various time ranges, in which case we consider the union of the time ranges. return only the sent commitments with an interval overlapping any of the given time ranges per synchronizer defaults: if empty, all synchronizers known to the participant are considered
+ +
+ +
+
+ counter_participant_ids + repeated string + +
+ +
retrieve commitments sent to specific counter participants if a specified counter participant is not a counter-participant in some synchronizer, we do not return it in the response an empty set means we return commitments sent to all counter participants on the synchronizers matching the synchronizer filter.
+ +
+ +
+
+ commitment_state + repeated SentCommitmentState + +
+ +
filter by commitment state: only return commitments with the states below if no state is given, we return all commitments
+ +
+ +
+
+ verbose + bool + +
+ +
include the actual commitment in the response
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

LookupSentAcsCommitmentsResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.LookupSentAcsCommitmentsResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ sent + repeated SentAcsCommitmentPerSynchronizer + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ time_ranges + repeated SynchronizerTimeRange + +
+ +
filter specific time ranges per synchronizer a synchronizer can appear multiple times with various time ranges, in which case we consider the union of the time ranges. return only the sent commitments with an interval overlapping any of the given time ranges per synchronizer defaults: if empty, all synchronizers known to the participant are considered
+ +
+ +
+
+ counter_participant_ids + repeated string + +
+ +
retrieve commitments sent to specific counter participants if a specified counter participant is not a counter-participant in some synchronizer, we do not return it in the response an empty set means we return commitments sent to all counter participants on the synchronizers matching the synchronizer filter.
+ +
+ +
+
+ commitment_state + repeated SentCommitmentState + +
+ +
filter by commitment state: only return commitments with the states below if no state is given, we return all commitments
+ +
+ +
+
+ verbose + bool + +
+ +
include the actual commitment in the response
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ synchronizer_id + string + +
+ +
+ +
+
+ interval + TimeRange + +
+ +
optional; if not given, the latest reconciliation period the participant knows of for that synchronizer is considered
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ from_exclusive + Timestamp + +
+ +
+ +
+
+ to_inclusive + Timestamp + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • SENT_COMMITMENT_STATE_UNSPECIFIED
    • + +
  • SENT_COMMITMENT_STATE_MATCH
    • + +
  • SENT_COMMITMENT_STATE_MISMATCH
    • + +
  • SENT_COMMITMENT_STATE_NOT_COMPARED
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ sent + repeated SentAcsCommitmentPerSynchronizer + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ synchronizer_id + string + +
+ +
+ +
+
+ sent + repeated SentAcsCommitment + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ interval + Interval + +
+ +
+ +
+
+ dest_counter_participant_uid + string + +
+ +
the counter participant to whom we sent the commitment
+ +
+ +
+
+ own_commitment + bytes + +
+ +
own computed commitment sent to counter participant, unsigned because the admin trusts own participant's reply populated only if verbose mode is on
+ +
+ +
+
+ received_commitment + bytes + +
+ +
commitment of the counter participant that was compared with own commitment, unsigned because the admin trusts own participant's reply populated only in case there is a mismatch and verbose mode is on might not correspond to the same interval as the sent commitment, however, the mismatch timestamp is the end of the returned interval
+ +
+ +
+
+ state + SentCommitmentState + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ start_tick_exclusive + Timestamp + +
+ +
+ +
+
+ end_tick_inclusive + Timestamp + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/opencommitment.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/opencommitment.mdx new file mode 100644 index 0000000..7ceabf5 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/opencommitment.mdx @@ -0,0 +1,378 @@ +--- +title: "OpenCommitment" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

OpenCommitment

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/OpenCommitment + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/OpenCommitment <<'EOF' +{ + "commitment": "BASE64_ENCODED_BYTES", + "physicalSynchronizerId": "string", + "computedForCounterParticipantUid": "string", + "periodEndTick": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "chunk": "BASE64_ENCODED_BYTES" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
ParticipantInspectionService
+
+ +
+
RPC
+
OpenCommitment
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
Yes
+
+ +
+ + +## Inputs + + +
+
+

OpenCommitmentRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.OpenCommitmentRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ commitment + bytes + +
+ +
the commitment to be opened
+ +
+ +
+
+ physical_synchronizer_id + string + +
+ +
+ +
+
+ computed_for_counter_participant_uid + string + +
+ +
the participant for whom the receiving participant computed the commitment
+ +
+ +
+
+ period_end_tick + Timestamp + +
+ +
interval end tick which the commitment corresponds to
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

OpenCommitmentResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.OpenCommitmentResponse
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + +
+ +
+
+ chunk + bytes + +
+ +
commitment contracts metadata
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ commitment + bytes + +
+ +
the commitment to be opened
+ +
+ +
+
+ physical_synchronizer_id + string + +
+ +
+ +
+
+ computed_for_counter_participant_uid + string + +
+ +
the participant for whom the receiving participant computed the commitment
+ +
+ +
+
+ period_end_tick + Timestamp + +
+ +
interval end tick which the commitment corresponds to
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ chunk + bytes + +
+ +
commitment contracts metadata
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/setconfigforslowcounterparticipants.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/setconfigforslowcounterparticipants.mdx new file mode 100644 index 0000000..2adb88a --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/setconfigforslowcounterparticipants.mdx @@ -0,0 +1,362 @@ +--- +title: "SetConfigForSlowCounterParticipants" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

SetConfigForSlowCounterParticipants

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/SetConfigForSlowCounterParticipants + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/SetConfigForSlowCounterParticipants <<'EOF' +{ + "configs": [ + { + "synchronizerIds": [ + "string" + ], + "distinguishedParticipantUids": [ + "string" + ], + "thresholdDistinguished": "0", + "thresholdDefault": "0", + "participantUidsMetrics": [ + "string" + ] + } + ] +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
ParticipantInspectionService
+
+ +
+
RPC
+
SetConfigForSlowCounterParticipants
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

SetConfigForSlowCounterParticipantsRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.SetConfigForSlowCounterParticipantsRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ configs + repeated SlowCounterParticipantSynchronizerConfig + +
+ +
we can specify multiple configurations, each being applied to one or more synchronizers if the synchronizer ids in the different configs overlap, the latest config in the order of the "configs" takes precedence
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

SetConfigForSlowCounterParticipantsResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.SetConfigForSlowCounterParticipantsResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ configs + repeated SlowCounterParticipantSynchronizerConfig + +
+ +
we can specify multiple configurations, each being applied to one or more synchronizers if the synchronizer ids in the different configs overlap, the latest config in the order of the "configs" takes precedence
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ synchronizer_ids + repeated string + +
+ +
the synchronizers for which we apply the settings below
+ +
+ +
+
+ distinguished_participant_uids + repeated string + +
+ +
all non-distinguished counter-participants are implicitly part of the group "default"
+ +
+ +
+
+ threshold_distinguished + uint64 + +
+ +
the number of reconciliation intervals for a distinguished counter-participant to be considered slow
+ +
+ +
+
+ threshold_default + uint64 + +
+ +
the number of reconciliation intervals for an "other" counter-participant to be considered slow
+ +
+ +
+
+ participant_uids_metrics + repeated string + +
+ +
participants for which we publish independent metrics counting how many intervals they are behind
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/changeassignation.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/changeassignation.mdx new file mode 100644 index 0000000..9597308 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/changeassignation.mdx @@ -0,0 +1,383 @@ +--- +title: "ChangeAssignation" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

ChangeAssignation

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/ChangeAssignation + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/ChangeAssignation <<'EOF' +{ + "sourceSynchronizerAlias": "string", + "targetSynchronizerAlias": "string", + "skipInactive": true, + "contracts": [ + { + "id": "string", + "reassignmentCounterOverride": "0" + } + ] +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
ParticipantRepairService
+
+ +
+
RPC
+
ChangeAssignation
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ChangeAssignationRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.ChangeAssignationRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ source_synchronizer_alias + string + +
+ +
Alias of the synchronizer to which the contracts are currently assigned Required
+ +
+ +
+
+ target_synchronizer_alias + string + +
+ +
New assignation Required
+ +
+ +
+
+ skip_inactive + bool + +
+ +
Whether to skip inactive contracts. Default: true.
+ +
+ +
+
+ contracts + repeated Contract + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ChangeAssignationResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.ChangeAssignationResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ source_synchronizer_alias + string + +
+ +
Alias of the synchronizer to which the contracts are currently assigned Required
+ +
+ +
+
+ target_synchronizer_alias + string + +
+ +
New assignation Required
+ +
+ +
+
+ skip_inactive + bool + +
+ +
Whether to skip inactive contracts. Default: true.
+ +
+ +
+
+ contracts + repeated Contract + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ id + string + +
+ +
+ +
+
+ reassignment_counter_override + int64 + +
+ +
By default, reassignment counter will be increased by 1 This can be overridden by a non-empty value.
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/exportacs.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/exportacs.mdx new file mode 100644 index 0000000..cf6f150 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/exportacs.mdx @@ -0,0 +1,415 @@ +--- +title: "ExportAcs" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

ExportAcs

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/ExportAcs + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/ExportAcs <<'EOF' +{ + "partyIds": [ + "string" + ], + "synchronizerId": "string", + "ledgerOffset": "0", + "contractSynchronizerRenames": [ + { + "key": { + "targetSynchronizerId": "string" + } + } + ], + "excludedStakeholderIds": [ + "string" + ] +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "chunk": "BASE64_ENCODED_BYTES" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
ParticipantRepairService
+
+ +
+
RPC
+
ExportAcs
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
Yes
+
+ +
+ + +## Inputs + + +
+
+

ExportAcsRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.ExportAcsRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ party_ids + repeated string + +
+ +
The identifiers of the parties for which the Active Contract Set (ACS) will be exported. This field must contain at least one party ID. Required
+ +
+ +
+
+ synchronizer_id + string + +
+ +
The identifier of the synchronizer to filter contracts. Optional. If provided, only contracts assigned to a synchronizer with this exact ID will be included in the exported ACS. If not set (empty string), all contracts for the specified parties will be included.
+ +
+ +
+
+ ledger_offset + int64 + +
+ +
The ledger offset at which the ACS snapshot should be taken. This determines the point in the ledger history from which the active contracts will be retrieved. Required
+ +
+ +
+
+ contract_synchronizer_renames + repeated map + +
+ +
A mapping to modify the synchronizer assignment of contracts in the exported ACS. Note: This mapping is not a proper contract reassignment. That is no actual reassignment happens, and thus the reassignment counter is not increased. Optional. If not provided (empty map), the contracts in the exported ACS will retain their original synchronizer assignments.
+ +
+ +
+
+ excluded_stakeholder_ids + repeated string + +
+ +
A list of party IDs to exclude from the export. Any contract that has one or more of these parties as a stakeholder will be omitted from the ACS snapshot. Optional
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ExportAcsResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.ExportAcsResponse
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + +
+ +
+
+ chunk + bytes + +
+ +
A chunk of the Active Contract Set (ACS) snapshot. This response is streamed, with each message containing a portion of the complete ACS data. The raw binary data within each chunk consists of Ledger API active contract messages, specifically wrapped in `v30.active_contract.ActiveContract` messages. However, a single chunk does not necessarily contain exactly one complete message. This field will be populated in each streamed response. Required
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ party_ids + repeated string + +
+ +
The identifiers of the parties for which the Active Contract Set (ACS) will be exported. This field must contain at least one party ID. Required
+ +
+ +
+
+ synchronizer_id + string + +
+ +
The identifier of the synchronizer to filter contracts. Optional. If provided, only contracts assigned to a synchronizer with this exact ID will be included in the exported ACS. If not set (empty string), all contracts for the specified parties will be included.
+ +
+ +
+
+ ledger_offset + int64 + +
+ +
The ledger offset at which the ACS snapshot should be taken. This determines the point in the ledger history from which the active contracts will be retrieved. Required
+ +
+ +
+
+ contract_synchronizer_renames + repeated map + +
+ +
A mapping to modify the synchronizer assignment of contracts in the exported ACS. Note: This mapping is not a proper contract reassignment. That is no actual reassignment happens, and thus the reassignment counter is not increased. Optional. If not provided (empty map), the contracts in the exported ACS will retain their original synchronizer assignments.
+ +
+ +
+
+ excluded_stakeholder_ids + repeated string + +
+ +
A list of party IDs to exclude from the export. Any contract that has one or more of these parties as a stakeholder will be omitted from the ACS snapshot. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ chunk + bytes + +
+ +
A chunk of the Active Contract Set (ACS) snapshot. This response is streamed, with each message containing a portion of the complete ACS data. The raw binary data within each chunk consists of Ledger API active contract messages, specifically wrapped in `v30.active_contract.ActiveContract` messages. However, a single chunk does not necessarily contain exactly one complete message. This field will be populated in each streamed response. Required
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/exportacsold.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/exportacsold.mdx new file mode 100644 index 0000000..17cd99f --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/exportacsold.mdx @@ -0,0 +1,407 @@ +--- +title: "ExportAcsOld" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

ExportAcsOld

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/ExportAcsOld + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/ExportAcsOld <<'EOF' +{ + "parties": [ + "string" + ], + "filterSynchronizerId": "string", + "timestamp": "string", + "force": true, + "partiesOffboarding": true +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "chunk": "BASE64_ENCODED_BYTES" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
ParticipantRepairService
+
+ +
+
RPC
+
ExportAcsOld
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
Yes
+
+ +
+ + +## Inputs + + +
+
+

ExportAcsOldRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.ExportAcsOldRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ parties + repeated string + +
+ +
The parties for which the ACS should be exported. If empty, the ACS of all parties will be exported. Optional
+ +
+ +
+
+ filter_synchronizer_id + string + +
+ +
The IDs of the synchronizers to filter the contracts by Optional, if set the contracts will be filtered by the exact match of the ID of the synchronizer to which it's assigned
+ +
+ +
+
+ timestamp + Timestamp + +
+ +
The timestamp at which the ACS should be valid. If provided, it will be checked that the ACS is available at the given timestamp (i.e. the timestamp is considered clean and the ACS has not been pruned). Optional, if missing the latest clean timestamp will be used
+ +
+ +
+
+ force + bool + +
+ +
If true, do not check whether the provided timestamp is clean (see `timestamp` field). NOT FOR PRODUCTION USE. For this option to yield a consistent snapshot, you need to wait at least confirmationResponseTimeout + mediatorReactionTimeout after the last submitted request. Recommended value is `false`
+ +
+ +
+
+ parties_offboarding + bool + +
+ +
true if the parties will be offboarded after the replication (party migration) Recommended value is `false`
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ExportAcsOldResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.ExportAcsOldResponse
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + +
+ +
+
+ chunk + bytes + +
+ +
The raw binary of the ACS snapshot to be imported This is meant to be streamed and every message should be a chunk of the snapshot Required
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ parties + repeated string + +
+ +
The parties for which the ACS should be exported. If empty, the ACS of all parties will be exported. Optional
+ +
+ +
+
+ filter_synchronizer_id + string + +
+ +
The IDs of the synchronizers to filter the contracts by Optional, if set the contracts will be filtered by the exact match of the ID of the synchronizer to which it's assigned
+ +
+ +
+
+ timestamp + Timestamp + +
+ +
The timestamp at which the ACS should be valid. If provided, it will be checked that the ACS is available at the given timestamp (i.e. the timestamp is considered clean and the ACS has not been pruned). Optional, if missing the latest clean timestamp will be used
+ +
+ +
+
+ force + bool + +
+ +
If true, do not check whether the provided timestamp is clean (see `timestamp` field). NOT FOR PRODUCTION USE. For this option to yield a consistent snapshot, you need to wait at least confirmationResponseTimeout + mediatorReactionTimeout after the last submitted request. Recommended value is `false`
+ +
+ +
+
+ parties_offboarding + bool + +
+ +
true if the parties will be offboarded after the replication (party migration) Recommended value is `false`
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ chunk + bytes + +
+ +
The raw binary of the ACS snapshot to be imported This is meant to be streamed and every message should be a chunk of the snapshot Required
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/ignoreevents.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/ignoreevents.mdx new file mode 100644 index 0000000..1708da3 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/ignoreevents.mdx @@ -0,0 +1,345 @@ +--- +title: "IgnoreEvents" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

IgnoreEvents

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/IgnoreEvents + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/IgnoreEvents <<'EOF' +{ + "physicalSynchronizerId": "string", + "fromInclusive": "0", + "toInclusive": "0", + "force": true +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
ParticipantRepairService
+
+ +
+
RPC
+
IgnoreEvents
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

IgnoreEventsRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.IgnoreEventsRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ physical_synchronizer_id + string + +
+ +
+ +
+
+ from_inclusive + int64 + +
+ +
sequencer counter of the first event to ignore
+ +
+ +
+
+ to_inclusive + int64 + +
+ +
sequencer counter of the last event to ignore
+ +
+ +
+
+ force + bool + +
+ +
allow to proceed even if some clean events have sequencer counter greater or equal than `from_inclusive`
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

IgnoreEventsResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.IgnoreEventsResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ physical_synchronizer_id + string + +
+ +
+ +
+
+ from_inclusive + int64 + +
+ +
sequencer counter of the first event to ignore
+ +
+ +
+
+ to_inclusive + int64 + +
+ +
sequencer counter of the last event to ignore
+ +
+ +
+
+ force + bool + +
+ +
allow to proceed even if some clean events have sequencer counter greater or equal than `from_inclusive`
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/importacs.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/importacs.mdx new file mode 100644 index 0000000..a7884ab --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/importacs.mdx @@ -0,0 +1,494 @@ +--- +title: "ImportAcs" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

ImportAcs

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/ImportAcs + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/ImportAcs <<'EOF' +{ + "acsSnapshot": "BASE64_ENCODED_BYTES", + "workflowIdPrefix": "string", + "contractImportMode": "CONTRACT_IMPORT_MODE_UNSPECIFIED", + "excludedStakeholderIds": [ + "string" + ], + "representativePackageIdOverride": { + "contractOverride": [ + { + "key": "string" + } + ], + "packageIdOverride": [ + { + "key": "string" + } + ], + "packageNameOverride": [ + { + "key": "string" + } + ] + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "contractIdMappings": [ + { + "key": "string" + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
ParticipantRepairService
+
+ +
+
RPC
+
ImportAcs
+
+ +
+
Client stream
+
Yes
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ImportAcsRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.ImportAcsRequest
+
+ +
+
Client stream
+
Yes
+
+ +
+ + + + +
+ +
+
+ acs_snapshot + bytes + +
+ +
The raw binary of the ACS snapshot to be imported The binary contents does not align on individual active contracts! It may contain bytes that are part of an active contract, or include several active contracts - depending on how much data fits into the configured gRPC message size. Required
+ +
+ +
+
+ workflow_id_prefix + string + +
+ +
Custom prefix for the workflow ID to easily identify all transactions generated by this import. Optional. If left empty, the service will generate a prefix such as `import-<random_UUID>`.
+ +
+ +
+
+ contract_import_mode + ContractImportMode + +
+ +
How imported contracts should be validated upon import NOTE: The representative package IDs assigned to imported contracts must ensure proper type-checking for those contracts. Importing contracts representative_package_id's that do not type-check may cause unexpected behavior, including INTERNAL errors on Ledger API read queries or incorrect Daml value representations. If unsure, perform the ACS import with ContractImportMode set to CONTRACT_IMPORT_MODE_VALIDATION to ensure that the assigned representative package IDs correctly validate the imported contracts. Required
+ +
+ +
+
+ excluded_stakeholder_ids + repeated string + +
+ +
A list of party IDs to exclude from the import. Any contract that has one or more of these parties as a stakeholder will be omitted during the import. Optional
+ +
+ +
+
+ representative_package_id_override + RepresentativePackageIdOverride + +
+ +
The representative package ID override rules to be applied during import. Optional
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ImportAcsResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.ImportAcsResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ contract_id_mappings + repeated map + +
+ +
Maps old contract IDs to newly recomputed contract IDs iff the recomputation contract ID import mode has been selected, empty otherwise.
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ acs_snapshot + bytes + +
+ +
The raw binary of the ACS snapshot to be imported The binary contents does not align on individual active contracts! It may contain bytes that are part of an active contract, or include several active contracts - depending on how much data fits into the configured gRPC message size. Required
+ +
+ +
+
+ workflow_id_prefix + string + +
+ +
Custom prefix for the workflow ID to easily identify all transactions generated by this import. Optional. If left empty, the service will generate a prefix such as `import-<random_UUID>`.
+ +
+ +
+
+ contract_import_mode + ContractImportMode + +
+ +
How imported contracts should be validated upon import NOTE: The representative package IDs assigned to imported contracts must ensure proper type-checking for those contracts. Importing contracts representative_package_id's that do not type-check may cause unexpected behavior, including INTERNAL errors on Ledger API read queries or incorrect Daml value representations. If unsure, perform the ACS import with ContractImportMode set to CONTRACT_IMPORT_MODE_VALIDATION to ensure that the assigned representative package IDs correctly validate the imported contracts. Required
+ +
+ +
+
+ excluded_stakeholder_ids + repeated string + +
+ +
A list of party IDs to exclude from the import. Any contract that has one or more of these parties as a stakeholder will be omitted during the import. Optional
+ +
+ +
+
+ representative_package_id_override + RepresentativePackageIdOverride + +
+ +
The representative package ID override rules to be applied during import. Optional
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • CONTRACT_IMPORT_MODE_UNSPECIFIED
    • + +
  • CONTRACT_IMPORT_MODE_ACCEPT
    • + +
  • CONTRACT_IMPORT_MODE_VALIDATION
    • + +
  • CONTRACT_IMPORT_MODE_RECOMPUTATION
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ contract_override + repeated map + +
+ +
Mapping from contract ID to the target representative package ID. Only contracts with IDs matching the keys in this map are affected.
+ +
+ +
+
+ package_id_override + repeated map + +
+ +
Mapping from a contract's original package IDs (either the creation or the representative package ID) to the target representative package ID. Affects only contracts with creation or representative package IDs matching the keys in this map, except if they're not already affected by `contract_override`.
+ +
+ +
+
+ package_name_override + repeated map + +
+ +
Mapping from any contract's package name to the target representative package ID Affects only contracts with package names matching the keys in this map, except if they're already affected by `contract_override` or `package_id_override`.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ contract_id_mappings + repeated map + +
+ +
Maps old contract IDs to newly recomputed contract IDs iff the recomputation contract ID import mode has been selected, empty otherwise.
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/importacsold.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/importacsold.mdx new file mode 100644 index 0000000..27808c3 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/importacsold.mdx @@ -0,0 +1,363 @@ +--- +title: "ImportAcsOld" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

ImportAcsOld

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/ImportAcsOld + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/ImportAcsOld <<'EOF' +{ + "acsSnapshot": "BASE64_ENCODED_BYTES", + "workflowIdPrefix": "string", + "allowContractIdSuffixRecomputation": true +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "contractIdMapping": [ + { + "key": "string" + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
ParticipantRepairService
+
+ +
+
RPC
+
ImportAcsOld
+
+ +
+
Client stream
+
Yes
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ImportAcsOldRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.ImportAcsOldRequest
+
+ +
+
Client stream
+
Yes
+
+ +
+ + + + +
+ +
+
+ acs_snapshot + bytes + +
+ +
The raw binary of the ACS snapshot to be imported Required
+ +
+ +
+
+ workflow_id_prefix + string + +
+ +
The synchronizer id prefix to be used for the imported contracts Optional, if not provided the service will generate a prefix
+ +
+ +
+
+ allow_contract_id_suffix_recomputation + bool + +
+ +
If false, the service will fail if any contract ID suffix doesn't match the scheme associated to the synchronizer where the contract is being assigned as a result of the import. If true, any contract ID suffix will be recomputed to match the scheme associated to the synchronizer. Recommended value is `false`
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ImportAcsOldResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.ImportAcsOldResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ contract_id_mapping + repeated map + +
+ +
Mapping from the old contract id to the new contract id
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ acs_snapshot + bytes + +
+ +
The raw binary of the ACS snapshot to be imported Required
+ +
+ +
+
+ workflow_id_prefix + string + +
+ +
The synchronizer id prefix to be used for the imported contracts Optional, if not provided the service will generate a prefix
+ +
+ +
+
+ allow_contract_id_suffix_recomputation + bool + +
+ +
If false, the service will fail if any contract ID suffix doesn't match the scheme associated to the synchronizer where the contract is being assigned as a result of the import. If true, any contract ID suffix will be recomputed to match the scheme associated to the synchronizer. Recommended value is `false`
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ contract_id_mapping + repeated map + +
+ +
Mapping from the old contract id to the new contract id
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/migratesynchronizer.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/migratesynchronizer.mdx new file mode 100644 index 0000000..da9761f --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/migratesynchronizer.mdx @@ -0,0 +1,807 @@ +--- +title: "MigrateSynchronizer" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

MigrateSynchronizer

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/MigrateSynchronizer + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/MigrateSynchronizer <<'EOF' +{ + "sourceSynchronizerAlias": "string", + "targetSynchronizerConnectionConfig": { + "synchronizerAlias": "string", + "sequencerConnections": { + "sequencerConnections": [ + { + "grpc": {}, + "alias": "string", + "sequencerId": "string" + } + ], + "sequencerTrustThreshold": 0, + "submissionRequestAmplification": { + "factor": 0, + "patience": "string" + }, + "sequencerLivenessMargin": 0, + "sequencerConnectionPoolDelays": { + "minRestartDelay": "string", + "maxRestartDelay": "string", + "subscriptionRequestDelay": "string", + "warnValidationDelay": "string" + } + }, + "manualConnect": true, + "physicalSynchronizerId": "string", + "priority": 0, + "initialRetryDelay": "string", + "maxRetryDelay": "string", + "timeTracker": { + "observationLatency": "string", + "patienceDuration": "string", + "minObservationDuration": "string", + "timeProofRequest": { + "initialRetryDelay": "string", + "maxRetryDelay": "string", + "maxSequencingDelay": "string" + } + } + }, + "force": true +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
ParticipantRepairService
+
+ +
+
RPC
+
MigrateSynchronizer
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

MigrateSynchronizerRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.MigrateSynchronizerRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ source_synchronizer_alias + string + +
+ +
Alias of the synchronizer to which the contracts are currently assigned Required
+ +
+ +
+
+ target_synchronizer_connection_config + SynchronizerConnectionConfig + +
+ +
Configuration to connect to the synchronizer on which the contracts will be assigned as a result of the migration Required
+ +
+ +
+
+ force + bool + +
+ +
Whether to force the migration in spite of risking a potential ledger fork Recommended value is `false`
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

MigrateSynchronizerResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.MigrateSynchronizerResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ source_synchronizer_alias + string + +
+ +
Alias of the synchronizer to which the contracts are currently assigned Required
+ +
+ +
+
+ target_synchronizer_connection_config + SynchronizerConnectionConfig + +
+ +
Configuration to connect to the synchronizer on which the contracts will be assigned as a result of the migration Required
+ +
+ +
+
+ force + bool + +
+ +
Whether to force the migration in spite of risking a potential ledger fork Recommended value is `false`
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ synchronizer_alias + string + +
+ +
participant local identifier of the target synchronizer
+ +
+ +
+
+ sequencer_connections + SequencerConnections + +
+ +
connection information to sequencers
+ +
+ +
+
+ manual_connect + bool + +
+ +
if false, then the synchronizer needs to be manually connected to (default false)
+ +
+ +
+
+ physical_synchronizer_id + string + +
+ +
optional physical synchronizer id (if TLS isn't to be trusted)
+ +
+ +
+
+ priority + int32 + +
+ +
optional. Influences whether the participant submits to this synchronizer, if several synchronizers are eligible
+ +
+ +
+
+ initial_retry_delay + Duration + +
+ +
initial delay before an attempt to reconnect to the sequencer
+ +
+ +
+
+ max_retry_delay + Duration + +
+ +
maximum delay before an attempt to reconnect to the sequencer
+ +
+ +
+
+ time_tracker + SynchronizerTimeTrackerConfig + +
+ +
configuration for how time is tracked and requested on this synchronizer
+ +
+ +
+
+ initialize_from_trusted_synchronizer + bool + +
+ +
If true, allows a participant to connect to a synchronizer that it was previously connected to, without issuing a new synchronizer trust certificate.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ sequencer_connections + repeated SequencerConnection + +
+ +
+ +
+
+ sequencer_trust_threshold + uint32 + +
+ +
This field determines the minimum level of agreement, or consensus, required among the sequencers before a message is considered reliable and accepted by the system. This value must be positive.
+ +
+ +
+
+ submission_request_amplification + SubmissionRequestAmplification + +
+ +
+ +
+
+ sequencer_liveness_margin + uint32 + +
+ +
This field determines the number of extra subscriptions to maintain beyond `sequencer_trust_threshold` in order to ensure liveness. This is only used when the new connection pool is enabled, and is ignored otherwise. This value must be non-negative.
+ +
+ +
+
+ sequencer_connection_pool_delays + SequencerConnectionPoolDelays + +
+ +
Configures the various delays used by the sequencer connection pool.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ grpc + Grpc + +
+ +
+ +
+
+ alias + string + +
+ +
+ +
+
+ sequencer_id + string + +
+ +
The id of the sequencer that serves the sequencer API. If empty, the node sets it after the first connection. If set, the node checks that the sequencer id reported by the sequencer matches this id.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ connections + repeated string + +
+ +
connection information to sequencer (http[s]://<host>:<port>")
+ +
+ +
+
+ transport_security + bool + +
+ +
Should the connection use TLS?
+ +
+ +
+
+ custom_trust_certificates + bytes + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ factor + uint32 + +
+ +
Determines to how often the client should try to send a submission request that is eligible for deduplication. A higher value increases the chance of a submission request being accepted by the system, but also increases the load on the sequencers and thus the costs incurred by the client. This value must be positive.
+ +
+ +
+
+ patience + Duration + +
+ +
Determines how long the sequencer client waits for observing the sequencing before it sends the submission request again. This value must be non-negative.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ min_restart_delay + Duration + +
+ +
Minimum duration after which a failed sequencer connection is restarted. This value must be non-negative.
+ +
+ +
+
+ max_restart_delay + Duration + +
+ +
Maximum duration after which a failed sequencer connection is restarted. This value must be non-negative.
+ +
+ +
+
+ subscription_request_delay + Duration + +
+ +
Delay between the attempts to obtain new sequencer connections for the sequencer subscription pool, when the current number of subscriptions is below `trustThreshold` + `livenessMargin`. This value must be non-negative.
+ +
+ +
+
+ warn_validation_delay + Duration + +
+ +
Duration after which a warning is issued if a started connection still fails validation. This value must be non-negative.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ observation_latency + Duration + +
+ +
+ +
+
+ patience_duration + Duration + +
+ +
+ +
+
+ min_observation_duration + Duration + +
+ +
+ +
+
+ time_proof_request + TimeProofRequestConfig + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ initial_retry_delay + Duration + +
+ +
+ +
+
+ max_retry_delay + Duration + +
+ +
+ +
+
+ max_sequencing_delay + Duration + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/purgecontracts.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/purgecontracts.mdx new file mode 100644 index 0000000..9f3ca10 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/purgecontracts.mdx @@ -0,0 +1,328 @@ +--- +title: "PurgeContracts" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

PurgeContracts

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/PurgeContracts + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/PurgeContracts <<'EOF' +{ + "synchronizerAlias": "string", + "contractIds": [ + "string" + ], + "ignoreAlreadyPurged": true +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
ParticipantRepairService
+
+ +
+
RPC
+
PurgeContracts
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

PurgeContractsRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.PurgeContractsRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ synchronizer_alias + string + +
+ +
Alias of the synchronizer to which the contracts are currently assigned Required
+ +
+ +
+
+ contract_ids + repeated string + +
+ +
Contracts to be purged Required
+ +
+ +
+
+ ignore_already_purged + bool + +
+ +
If true, will ignore already purged contract; if false, will return an error if a contract is already purged Useful re-run the same request in case of failure in an idempotent fashion Recommended value is `true`
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

PurgeContractsResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.PurgeContractsResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ synchronizer_alias + string + +
+ +
Alias of the synchronizer to which the contracts are currently assigned Required
+ +
+ +
+
+ contract_ids + repeated string + +
+ +
Contracts to be purged Required
+ +
+ +
+
+ ignore_already_purged + bool + +
+ +
If true, will ignore already purged contract; if false, will return an error if a contract is already purged Useful re-run the same request in case of failure in an idempotent fashion Recommended value is `true`
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/purgedeactivatedsynchronizer.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/purgedeactivatedsynchronizer.mdx new file mode 100644 index 0000000..1519277 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/purgedeactivatedsynchronizer.mdx @@ -0,0 +1,280 @@ +--- +title: "PurgeDeactivatedSynchronizer" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

PurgeDeactivatedSynchronizer

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/PurgeDeactivatedSynchronizer + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/PurgeDeactivatedSynchronizer <<'EOF' +{ + "synchronizerAlias": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
ParticipantRepairService
+
+ +
+
RPC
+
PurgeDeactivatedSynchronizer
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

PurgeDeactivatedSynchronizerRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.PurgeDeactivatedSynchronizerRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ synchronizer_alias + string + +
+ +
Alias of the deactivated synchronizer to purge data from
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

PurgeDeactivatedSynchronizerResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.PurgeDeactivatedSynchronizerResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ synchronizer_alias + string + +
+ +
Alias of the deactivated synchronizer to purge data from
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/repaircommitmentsusingacs.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/repaircommitmentsusingacs.mdx new file mode 100644 index 0000000..71b4ee9 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/repaircommitmentsusingacs.mdx @@ -0,0 +1,428 @@ +--- +title: "RepairCommitmentsUsingAcs" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

RepairCommitmentsUsingAcs

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/RepairCommitmentsUsingAcs + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/RepairCommitmentsUsingAcs <<'EOF' +{ + "synchronizerIds": [ + "string" + ], + "counterParticipantIds": [ + "string" + ], + "partyIds": [ + "string" + ], + "timeoutSeconds": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "statuses": [ + { + "synchronizerId": "string", + "errorMessage": "string" + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
ParticipantRepairService
+
+ +
+
RPC
+
RepairCommitmentsUsingAcs
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

RepairCommitmentsUsingAcsRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.RepairCommitmentsUsingAcsRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ synchronizer_ids + repeated string + +
+ +
The IDs of the synchronizers where to reinitialize commitments from ACS If empty, we reinitialize commitments for all synchronizers
+ +
+ +
+
+ counter_participant_ids + repeated string + +
+ +
Reinitialize commitments only for the given counter-participant If empty, we reinitialize commitments for all counter-participants
+ +
+ +
+
+ party_ids + repeated string + +
+ +
Reinitialize commitments only for the stakeholder groups containing the given parties If empty, we reinitialize commitments for all stakeholder groups
+ +
+ +
+
+ timeout_seconds + Duration + +
+ +
The timeout to wait for command to return success The success status can also be queried later using the `CommitmentsService`
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

RepairCommitmentsUsingAcsResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.RepairCommitmentsUsingAcsResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ statuses + repeated RepairCommitmentsStatus + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ synchronizer_ids + repeated string + +
+ +
The IDs of the synchronizers where to reinitialize commitments from ACS If empty, we reinitialize commitments for all synchronizers
+ +
+ +
+
+ counter_participant_ids + repeated string + +
+ +
Reinitialize commitments only for the given counter-participant If empty, we reinitialize commitments for all counter-participants
+ +
+ +
+
+ party_ids + repeated string + +
+ +
Reinitialize commitments only for the stakeholder groups containing the given parties If empty, we reinitialize commitments for all stakeholder groups
+ +
+ +
+
+ timeout_seconds + Duration + +
+ +
The timeout to wait for command to return success The success status can also be queried later using the `CommitmentsService`
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ statuses + repeated RepairCommitmentsStatus + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ synchronizer_id + string + +
+ +
+ +
+
+ error_message + string + +
+ +
+ +
+
+ completed_repair_timestamp + Timestamp + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/rollbackunassignment.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/rollbackunassignment.mdx new file mode 100644 index 0000000..38c50f3 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/rollbackunassignment.mdx @@ -0,0 +1,326 @@ +--- +title: "RollbackUnassignment" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

RollbackUnassignment

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/RollbackUnassignment + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/RollbackUnassignment <<'EOF' +{ + "reassignmentId": "string", + "sourceSynchronizerId": "string", + "targetSynchronizerId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
ParticipantRepairService
+
+ +
+
RPC
+
RollbackUnassignment
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

RollbackUnassignmentRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.RollbackUnassignmentRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ reassignment_id + string + +
+ +
The ID of the unassignment. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ source_synchronizer_id + string + +
+ +
The ID of the source synchronizer Must be a valid synchronizer id Required
+ +
+ +
+
+ target_synchronizer_id + string + +
+ +
The ID of the target synchronizer Must be a valid synchronizer id Required
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

RollbackUnassignmentResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.RollbackUnassignmentResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ reassignment_id + string + +
+ +
The ID of the unassignment. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ source_synchronizer_id + string + +
+ +
The ID of the source synchronizer Must be a valid synchronizer id Required
+ +
+ +
+
+ target_synchronizer_id + string + +
+ +
The ID of the target synchronizer Must be a valid synchronizer id Required
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/unignoreevents.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/unignoreevents.mdx new file mode 100644 index 0000000..625834e --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/unignoreevents.mdx @@ -0,0 +1,345 @@ +--- +title: "UnignoreEvents" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

UnignoreEvents

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/UnignoreEvents + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/UnignoreEvents <<'EOF' +{ + "physicalSynchronizerId": "string", + "fromInclusive": "0", + "toInclusive": "0", + "force": true +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
ParticipantRepairService
+
+ +
+
RPC
+
UnignoreEvents
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

UnignoreEventsRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.UnignoreEventsRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ physical_synchronizer_id + string + +
+ +
+ +
+
+ from_inclusive + int64 + +
+ +
sequencer counter of the first event to unignore
+ +
+ +
+
+ to_inclusive + int64 + +
+ +
sequencer counter of the last event to unignore
+ +
+ +
+
+ force + bool + +
+ +
allow to proceed even if some clean events have sequencer counter greater or equal than `from_inclusive`
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

UnignoreEventsResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.UnignoreEventsResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ physical_synchronizer_id + string + +
+ +
+ +
+
+ from_inclusive + int64 + +
+ +
sequencer counter of the first event to unignore
+ +
+ +
+
+ to_inclusive + int64 + +
+ +
sequencer counter of the last event to unignore
+ +
+ +
+
+ force + bool + +
+ +
allow to proceed even if some clean events have sequencer counter greater or equal than `from_inclusive`
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantstatusservice/participantstatus.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantstatusservice/participantstatus.mdx new file mode 100644 index 0000000..f938ae7 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantstatusservice/participantstatus.mdx @@ -0,0 +1,696 @@ +--- +title: "ParticipantStatus" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

ParticipantStatus

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.ParticipantStatusService/ParticipantStatus + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantStatusService/ParticipantStatus <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "status": { + "commonStatus": { + "uid": "string", + "uptime": "string", + "ports": [ + { + "key": 0 + } + ], + "active": true, + "topologyQueues": { + "manager": 0, + "dispatcher": 0, + "clients": 0 + }, + "components": [ + { + "name": "string", + "ok": {} + } + ], + "version": "string" + }, + "connectedSynchronizers": [ + { + "physicalSynchronizerId": "string", + "health": "HEALTH_UNSPECIFIED" + } + ], + "active": true, + "supportedProtocolVersions": [ + 0 + ] + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
ParticipantStatusService
+
+ +
+
RPC
+
ParticipantStatus
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ParticipantStatusRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.ParticipantStatusRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

ParticipantStatusResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.ParticipantStatusResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ status + ParticipantStatusResponseStatus + +
+ +
+ +
+
+ not_initialized + NotInitialized + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ status + ParticipantStatusResponseStatus + +
+ +
+ +
+
+ not_initialized + NotInitialized + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ common_status + Status + +
+ +
+ +
+
+ connected_synchronizers + repeated ConnectedSynchronizer + +
+ +
+ +
+
+ active + bool + +
+ +
Indicate if the participant node is active True if the participant node is replicated and is the active replica, or true if not replicated
+ +
+ +
+
+ supported_protocol_versions + repeated int32 + +
+ +
Protocol versions which this node supports Take into account config parameters such as alpha/beta version support and minimum protocol version
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ uid + string + +
+ +
+ +
+
+ uptime + Duration + +
+ +
+ +
+
+ ports + repeated map + +
+ +
+ +
+
+ active + bool + +
+ +
Indicate if the node is active, usually true unless it's a replicated node that is passive
+ +
+ +
+
+ topology_queues + TopologyQueueStatus + +
+ +
indicates the state of the topology queues (manager / dispatcher only where they exist)
+ +
+ +
+
+ components + repeated ComponentStatus + +
+ +
Health state of component dependencies of the node
+ +
+ +
+
+ version + string + +
+ +
Version of the binary
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ manager + uint32 + +
+ +
how many topology changes are currently queued at the manager
+ +
+ +
+
+ dispatcher + uint32 + +
+ +
how many topology changes are currently queued at the dispatcher
+ +
+ +
+
+ clients + uint32 + +
+ +
how many topology changes are currently waiting to become effective (across all connected synchronizers in the case of participants)
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ name + string + +
+ +
+ +
+
+ ok + StatusData + +
+ +
+ +
+
+ degraded + StatusData + +
+ +
+ +
+
+ failed + StatusData + +
+ +
+ +
+
+ fatal + StatusData + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ description + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ physical_synchronizer_id + string + +
+ +
+ +
+
+ health + Health + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • HEALTH_UNSPECIFIED
    • + +
  • HEALTH_HEALTHY
    • + +
  • HEALTH_UNHEALTHY
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ active + bool + +
+ +
Indicate if the node is active, usually true unless it's a replicated node that is passive
+ +
+ +
+
+ waiting_for_external_input + WaitingForExternalInput + +
+ +
Indicates whether the node is waiting for external input
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • WAITING_FOR_EXTERNAL_INPUT_UNSPECIFIED
    • + +
  • WAITING_FOR_EXTERNAL_INPUT_ID
    • + +
  • WAITING_FOR_EXTERNAL_INPUT_NODE_TOPOLOGY
    • + +
  • WAITING_FOR_EXTERNAL_INPUT_INITIALIZATION
    • + +
+ + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/addpartyasync.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/addpartyasync.mdx new file mode 100644 index 0000000..7efbe4c --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/addpartyasync.mdx @@ -0,0 +1,425 @@ +--- +title: "AddPartyAsync" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

AddPartyAsync

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.PartyManagementService/AddPartyAsync + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PartyManagementService/AddPartyAsync <<'EOF' +{ + "partyId": "string", + "synchronizerId": "string", + "sourceParticipantUid": "string", + "topologySerial": 0, + "participantPermission": "PARTICIPANT_PERMISSION_UNSPECIFIED" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "addPartyRequestId": "string" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PartyManagementService
+
+ +
+
RPC
+
AddPartyAsync
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

AddPartyAsyncRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.AddPartyAsyncRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ party_id + string + +
+ +
The party to replicate Required
+ +
+ +
+
+ synchronizer_id + string + +
+ +
The synchronizer in which to replicate the party Required
+ +
+ +
+
+ source_participant_uid + string + +
+ +
A source participant already hosting the party Required
+ +
+ +
+
+ topology_serial + uint32 + +
+ +
The topology serial number of the PartyToParticipant topology transaction used to add the party to this target participant. Required
+ +
+ +
+
+ participant_permission + ParticipantPermission + +
+ +
The permission level of the party on the target participant. Required
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

AddPartyAsyncResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.AddPartyAsyncResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ add_party_request_id + string + +
+ +
The identifier used to uniquely track the add party request.
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ party_id + string + +
+ +
The party to replicate Required
+ +
+ +
+
+ synchronizer_id + string + +
+ +
The synchronizer in which to replicate the party Required
+ +
+ +
+
+ source_participant_uid + string + +
+ +
A source participant already hosting the party Required
+ +
+ +
+
+ topology_serial + uint32 + +
+ +
The topology serial number of the PartyToParticipant topology transaction used to add the party to this target participant. Required
+ +
+ +
+
+ participant_permission + ParticipantPermission + +
+ +
The permission level of the party on the target participant. Required
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • PARTICIPANT_PERMISSION_UNSPECIFIED
    • + +
  • PARTICIPANT_PERMISSION_SUBMISSION
    • + +
  • PARTICIPANT_PERMISSION_CONFIRMATION
    • + +
  • PARTICIPANT_PERMISSION_OBSERVATION
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ add_party_request_id + string + +
+ +
The identifier used to uniquely track the add party request.
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/clearpartyonboardingflag.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/clearpartyonboardingflag.mdx new file mode 100644 index 0000000..f7bbcc6 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/clearpartyonboardingflag.mdx @@ -0,0 +1,404 @@ +--- +title: "ClearPartyOnboardingFlag" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

ClearPartyOnboardingFlag

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.PartyManagementService/ClearPartyOnboardingFlag + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PartyManagementService/ClearPartyOnboardingFlag <<'EOF' +{ + "partyId": "string", + "synchronizerId": "string", + "beginOffsetExclusive": "0", + "waitForActivationTimeout": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "onboarded": true, + "earliestRetryTimestamp": "string" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PartyManagementService
+
+ +
+
RPC
+
ClearPartyOnboardingFlag
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ClearPartyOnboardingFlagRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.ClearPartyOnboardingFlagRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ party_id + string + +
+ +
The identifier of the party whose onboarding flag is being cleared. This party must already be active on the target participant. Required
+ +
+ +
+
+ synchronizer_id + string + +
+ +
The identifier of the synchronizer. Required
+ +
+ +
+
+ begin_offset_exclusive + int64 + +
+ +
The exclusive ledger offset used as a starting point to find the party's most recent activation on the target participant. Required
+ +
+ +
+
+ wait_for_activation_timeout + Duration + +
+ +
The maximum duration the service will wait to find the topology transaction that activates the party. If not set, the service will use a default timeout. Optional
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ClearPartyOnboardingFlagResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.ClearPartyOnboardingFlagResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ onboarded + bool + +
+ +
Indicates the current party onboarding status. Required
+ +
+ +
+
+ earliest_retry_timestamp + Timestamp + +
+ +
The earliest time for the safe clearance of the onboarding flag. This field is only present when `onboarded` is `false`.
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ party_id + string + +
+ +
The identifier of the party whose onboarding flag is being cleared. This party must already be active on the target participant. Required
+ +
+ +
+
+ synchronizer_id + string + +
+ +
The identifier of the synchronizer. Required
+ +
+ +
+
+ begin_offset_exclusive + int64 + +
+ +
The exclusive ledger offset used as a starting point to find the party's most recent activation on the target participant. Required
+ +
+ +
+
+ wait_for_activation_timeout + Duration + +
+ +
The maximum duration the service will wait to find the topology transaction that activates the party. If not set, the service will use a default timeout. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ onboarded + bool + +
+ +
Indicates the current party onboarding status. Required
+ +
+ +
+
+ earliest_retry_timestamp + Timestamp + +
+ +
The earliest time for the safe clearance of the onboarding flag. This field is only present when `onboarded` is `false`.
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/exportpartyacs.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/exportpartyacs.mdx new file mode 100644 index 0000000..86fe6a1 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/exportpartyacs.mdx @@ -0,0 +1,405 @@ +--- +title: "ExportPartyAcs" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

ExportPartyAcs

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.PartyManagementService/ExportPartyAcs + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PartyManagementService/ExportPartyAcs <<'EOF' +{ + "partyId": "string", + "synchronizerId": "string", + "targetParticipantUid": "string", + "beginOffsetExclusive": "0", + "waitForActivationTimeout": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "chunk": "BASE64_ENCODED_BYTES" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PartyManagementService
+
+ +
+
RPC
+
ExportPartyAcs
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
Yes
+
+ +
+ + +## Inputs + + +
+
+

ExportPartyAcsRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.ExportPartyAcsRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ party_id + string + +
+ +
The identifier of the party being replicated. This party must already be active on the target participant for the ACS export to succeed. Required
+ +
+ +
+
+ synchronizer_id + string + +
+ +
The identifier of the synchronizer managing the contract to be exported. This scopes the ACS export to only contracts assigned to this synchronizer. Required
+ +
+ +
+
+ target_participant_uid + string + +
+ +
The unique identifier of the target participant where the party will be replicated. Required
+ +
+ +
+
+ begin_offset_exclusive + int64 + +
+ +
The exclusive ledger offset used as starting point to find the party's most recent activation on the target participant. Required
+ +
+ +
+
+ wait_for_activation_timeout + Duration + +
+ +
The maximum duration the service will wait to find the topology transaction that activates the party on the target participant. If not set, the service will use a default timeout. Optional
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ExportPartyAcsResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.ExportPartyAcsResponse
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + +
+ +
+
+ chunk + bytes + +
+ +
A chunk of the ACS snapshot. This response is streamed, with each message containing a portion of the complete ACS data. The raw binary data within each chunk consists of Ledger API active contract messages, specifically wrapped in `v30.active_contract.ActiveContract` messages. However, a single chunk does not necessarily contain exactly one complete message. This field will be populated in each streamed response. Required
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ party_id + string + +
+ +
The identifier of the party being replicated. This party must already be active on the target participant for the ACS export to succeed. Required
+ +
+ +
+
+ synchronizer_id + string + +
+ +
The identifier of the synchronizer managing the contract to be exported. This scopes the ACS export to only contracts assigned to this synchronizer. Required
+ +
+ +
+
+ target_participant_uid + string + +
+ +
The unique identifier of the target participant where the party will be replicated. Required
+ +
+ +
+
+ begin_offset_exclusive + int64 + +
+ +
The exclusive ledger offset used as starting point to find the party's most recent activation on the target participant. Required
+ +
+ +
+
+ wait_for_activation_timeout + Duration + +
+ +
The maximum duration the service will wait to find the topology transaction that activates the party on the target participant. If not set, the service will use a default timeout. Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ chunk + bytes + +
+ +
A chunk of the ACS snapshot. This response is streamed, with each message containing a portion of the complete ACS data. The raw binary data within each chunk consists of Ledger API active contract messages, specifically wrapped in `v30.active_contract.ActiveContract` messages. However, a single chunk does not necessarily contain exactly one complete message. This field will be populated in each streamed response. Required
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/getaddpartystatus.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/getaddpartystatus.mdx new file mode 100644 index 0000000..c4fd5a5 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/getaddpartystatus.mdx @@ -0,0 +1,830 @@ +--- +title: "GetAddPartyStatus" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

GetAddPartyStatus

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.PartyManagementService/GetAddPartyStatus + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PartyManagementService/GetAddPartyStatus <<'EOF' +{ + "addPartyRequestId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "partyId": "string", + "synchronizerId": "string", + "sourceParticipantUid": "string", + "targetParticipantUid": "string", + "topologySerial": 0, + "participantPermission": "PARTICIPANT_PERMISSION_UNSPECIFIED", + "status": { + "proposalProcessed": {} + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PartyManagementService
+
+ +
+
RPC
+
GetAddPartyStatus
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetAddPartyStatusRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ add_party_request_id + string + +
+ +
The add party request ID returned by AddPartyAsync Required
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

GetAddPartyStatusResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ party_id + string + +
+ +
+ +
+
+ synchronizer_id + string + +
+ +
+ +
+
+ source_participant_uid + string + +
+ +
+ +
+
+ target_participant_uid + string + +
+ +
+ +
+
+ topology_serial + uint32 + +
+ +
+ +
+
+ participant_permission + ParticipantPermission + +
+ +
+ +
+
+ status + Status + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ add_party_request_id + string + +
+ +
The add party request ID returned by AddPartyAsync Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ party_id + string + +
+ +
+ +
+
+ synchronizer_id + string + +
+ +
+ +
+
+ source_participant_uid + string + +
+ +
+ +
+
+ target_participant_uid + string + +
+ +
+ +
+
+ topology_serial + uint32 + +
+ +
+ +
+
+ participant_permission + ParticipantPermission + +
+ +
+ +
+
+ status + Status + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ proposal_processed + ProposalProcessed + +
+ +
Party Replication Daml admin workflow proposal and agreement handling
+ +
+ +
+
+ agreement_accepted + AgreementAccepted + +
+ +
+ +
+
+ topology_authorized + TopologyAuthorized + +
+ +
Topology management
+ +
+ +
+
+ connection_established + ConnectionEstablished + +
+ +
Party Replication ACS replication
+ +
+ +
+
+ replicating_acs + ReplicatingAcs + +
+ +
+ +
+
+ fully_replicated_acs + FullyReplicatedAcs + +
+ +
+ +
+
+ completed + Completed + +
+ +
Completed indicating that party successfully has been added to target participant.
+ +
+ +
+
+ error + Error + +
+ +
Error indicating that party replication has failed.
+ +
+ +
+
+ disconnected + Disconnected + +
+ +
Conditions that party replication is attempting to recover from.
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ sequencer_uid + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ sequencer_uid + string + +
+ +
+ +
+
+ timestamp + Timestamp + +
+ +
The timestamp at which the ACS snapshot for replication is taken.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ sequencer_uid + string + +
+ +
+ +
+
+ timestamp + Timestamp + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ sequencer_uid + string + +
+ +
+ +
+
+ timestamp + Timestamp + +
+ +
+ +
+
+ contracts_replicated + uint32 + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ sequencer_uid + string + +
+ +
+ +
+
+ timestamp + Timestamp + +
+ +
+ +
+
+ contracts_replicated + uint32 + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ sequencer_uid + string + +
+ +
+ +
+
+ timestamp + Timestamp + +
+ +
+ +
+
+ contracts_replicated + uint32 + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ error_message + string + +
+ +
+ +
+
+ status_prior_to_error + Status + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ disconnect_message + string + +
+ +
+ +
+
+ status_prior_to_disconnect + Status + +
+ +
Prior status is one of ConnectionEstablished or ReplicatingAcs.
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • PARTICIPANT_PERMISSION_UNSPECIFIED
    • + +
  • PARTICIPANT_PERMISSION_SUBMISSION
    • + +
  • PARTICIPANT_PERMISSION_CONFIRMATION
    • + +
  • PARTICIPANT_PERMISSION_OBSERVATION
    • + +
+ + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/gethighestoffsetbytimestamp.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/gethighestoffsetbytimestamp.mdx new file mode 100644 index 0000000..ffc33a2 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/gethighestoffsetbytimestamp.mdx @@ -0,0 +1,358 @@ +--- +title: "GetHighestOffsetByTimestamp" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

GetHighestOffsetByTimestamp

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.PartyManagementService/GetHighestOffsetByTimestamp + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PartyManagementService/GetHighestOffsetByTimestamp <<'EOF' +{ + "synchronizerId": "string", + "timestamp": "string", + "force": true +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "ledgerOffset": "0" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PartyManagementService
+
+ +
+
RPC
+
GetHighestOffsetByTimestamp
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetHighestOffsetByTimestampRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.GetHighestOffsetByTimestampRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ synchronizer_id + string + +
+ +
The identifier of the synchronizer. Required
+ +
+ +
+
+ timestamp + Timestamp + +
+ +
The requested timestamp for which a ledger offset should be found. Required
+ +
+ +
+
+ force + bool + +
+ +
If true, return the highest known ledger offset with a record time before or at the specified `timestamp` even if higher offsets with a record time before or at `timestamp` can be created in the future. Required, defaults to false.
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

GetHighestOffsetByTimestampResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.GetHighestOffsetByTimestampResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ ledger_offset + int64 + +
+ +
The highest ledger offset among events that have their record time before or at the requested timestamp. An error when no such offset (yet) exists. Required
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ synchronizer_id + string + +
+ +
The identifier of the synchronizer. Required
+ +
+ +
+
+ timestamp + Timestamp + +
+ +
The requested timestamp for which a ledger offset should be found. Required
+ +
+ +
+
+ force + bool + +
+ +
If true, return the highest known ledger offset with a record time before or at the specified `timestamp` even if higher offsets with a record time before or at `timestamp` can be created in the future. Required, defaults to false.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ ledger_offset + int64 + +
+ +
The highest ledger offset among events that have their record time before or at the requested timestamp. An error when no such offset (yet) exists. Required
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/importpartyacs.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/importpartyacs.mdx new file mode 100644 index 0000000..a50d59e --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/importpartyacs.mdx @@ -0,0 +1,433 @@ +--- +title: "ImportPartyAcs" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

ImportPartyAcs

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.PartyManagementService/ImportPartyAcs + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PartyManagementService/ImportPartyAcs <<'EOF' +{ + "acsSnapshot": "BASE64_ENCODED_BYTES", + "workflowIdPrefix": "string", + "contractImportMode": "CONTRACT_IMPORT_MODE_UNSPECIFIED", + "representativePackageIdOverride": { + "contractOverride": [ + { + "key": "string" + } + ], + "packageIdOverride": [ + { + "key": "string" + } + ], + "packageNameOverride": [ + { + "key": "string" + } + ] + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PartyManagementService
+
+ +
+
RPC
+
ImportPartyAcs
+
+ +
+
Client stream
+
Yes
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ImportPartyAcsRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.ImportPartyAcsRequest
+
+ +
+
Client stream
+
Yes
+
+ +
+ + + + +
+ +
+
+ acs_snapshot + bytes + +
+ +
The raw binary of the ACS snapshot to be imported The binary content does not align on individual active contracts! It may contain bytes that are part of an active contract, or include several active contracts - depending on how much data fits into the configured gRPC message size. Required
+ +
+ +
+
+ workflow_id_prefix + string + +
+ +
Custom prefix for the workflow ID to easily identify all transactions generated by this import. Optional. If left empty, the service will generate a prefix such as `import-<random_UUID>`.
+ +
+ +
+
+ contract_import_mode + ContractImportMode + +
+ +
How imported contracts should be validated upon import. NOTE: The representative package IDs assigned to imported contracts must ensure proper type-checking for those contracts. Importing contracts representative_package_id's that do not type-check may cause unexpected behavior, including INTERNAL errors on Ledger API read queries or incorrect Daml value representations. If unsure, perform the ACS import with ContractImportMode set to CONTRACT_IMPORT_MODE_VALIDATION to ensure that the assigned representative package IDs correctly validate the imported contracts. Required
+ +
+ +
+
+ representative_package_id_override + RepresentativePackageIdOverride + +
+ +
The representative package ID override rules to be applied during import. Optional
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ImportPartyAcsResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.ImportPartyAcsResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ acs_snapshot + bytes + +
+ +
The raw binary of the ACS snapshot to be imported The binary content does not align on individual active contracts! It may contain bytes that are part of an active contract, or include several active contracts - depending on how much data fits into the configured gRPC message size. Required
+ +
+ +
+
+ workflow_id_prefix + string + +
+ +
Custom prefix for the workflow ID to easily identify all transactions generated by this import. Optional. If left empty, the service will generate a prefix such as `import-<random_UUID>`.
+ +
+ +
+
+ contract_import_mode + ContractImportMode + +
+ +
How imported contracts should be validated upon import. NOTE: The representative package IDs assigned to imported contracts must ensure proper type-checking for those contracts. Importing contracts representative_package_id's that do not type-check may cause unexpected behavior, including INTERNAL errors on Ledger API read queries or incorrect Daml value representations. If unsure, perform the ACS import with ContractImportMode set to CONTRACT_IMPORT_MODE_VALIDATION to ensure that the assigned representative package IDs correctly validate the imported contracts. Required
+ +
+ +
+
+ representative_package_id_override + RepresentativePackageIdOverride + +
+ +
The representative package ID override rules to be applied during import. Optional
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • CONTRACT_IMPORT_MODE_UNSPECIFIED
    • + +
  • CONTRACT_IMPORT_MODE_ACCEPT
    • + +
  • CONTRACT_IMPORT_MODE_VALIDATION
    • + +
  • CONTRACT_IMPORT_MODE_RECOMPUTATION
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ contract_override + repeated map + +
+ +
Mapping from contract ID to the target representative package ID. Only contracts with IDs matching the keys in this map are affected.
+ +
+ +
+
+ package_id_override + repeated map + +
+ +
Mapping from a contract's original package IDs (either the creation or the representative package ID) to the target representative package ID. Affects only contracts with creation or representative package IDs matching the keys in this map, except if they're not already affected by `contract_override`.
+ +
+ +
+
+ package_name_override + repeated map + +
+ +
Mapping from any contract's package name to the target representative package ID Affects only contracts with package names matching the keys in this map, except if they're already affected by `contract_override` or `package_id_override`.
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pingservice/ping.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pingservice/ping.mdx new file mode 100644 index 0000000..4796848 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pingservice/ping.mdx @@ -0,0 +1,508 @@ +--- +title: "Ping" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

Ping

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.PingService/Ping + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PingService/Ping <<'EOF' +{ + "targetParties": [ + "string" + ], + "validators": [ + "string" + ], + "timeout": "string", + "levels": 0, + "synchronizerId": "string", + "workflowId": "string", + "id": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "success": { + "pingTime": "0", + "responder": "string" + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PingService
+
+ +
+
RPC
+
Ping
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

PingRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.PingRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ target_parties + repeated string + +
+ +
+ +
+
+ validators + repeated string + +
+ +
+ +
+
+ timeout + Duration + +
+ +
+ +
+
+ levels + uint32 + +
+ +
+ +
+
+ synchronizer_id + string + +
+ +
optional
+ +
+ +
+
+ workflow_id + string + +
+ +
optional
+ +
+ +
+
+ id + string + +
+ +
optional UUID to be used for ping test
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

PingResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.PingResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ success + PingSuccess + +
+ +
+ +
+
+ failure + PingFailure + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ target_parties + repeated string + +
+ +
+ +
+
+ validators + repeated string + +
+ +
+ +
+
+ timeout + Duration + +
+ +
+ +
+
+ levels + uint32 + +
+ +
+ +
+
+ synchronizer_id + string + +
+ +
optional
+ +
+ +
+
+ workflow_id + string + +
+ +
optional
+ +
+ +
+
+ id + string + +
+ +
optional UUID to be used for ping test
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ success + PingSuccess + +
+ +
+ +
+
+ failure + PingFailure + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ ping_time + uint64 + +
+ +
+ +
+
+ responder + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ reason + string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/clearschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/clearschedule.mdx new file mode 100644 index 0000000..508c09b --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/clearschedule.mdx @@ -0,0 +1,248 @@ +--- +title: "ClearSchedule" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

ClearSchedule

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.PruningService/ClearSchedule + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PruningService/ClearSchedule <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PruningService
+
+ +
+
RPC
+
ClearSchedule
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ClearScheduleRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.ClearScheduleRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

ClearScheduleResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.ClearScheduleResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getnowaitcommitmentsfrom.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getnowaitcommitmentsfrom.mdx new file mode 100644 index 0000000..c7d23e3 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getnowaitcommitmentsfrom.mdx @@ -0,0 +1,425 @@ +--- +title: "GetNoWaitCommitmentsFrom" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

GetNoWaitCommitmentsFrom

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.PruningService/GetNoWaitCommitmentsFrom + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PruningService/GetNoWaitCommitmentsFrom <<'EOF' +{ + "synchronizerIds": [ + "string" + ], + "participantUids": [ + "string" + ] +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "ignoredParticipants": [ + { + "counterParticipantUid": "string", + "synchronizers": { + "synchronizerIds": [ + "string" + ] + } + } + ], + "notIgnoredParticipants": [ + { + "counterParticipantUid": "string", + "synchronizers": { + "synchronizerIds": [ + "string" + ] + } + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PruningService
+
+ +
+
RPC
+
GetNoWaitCommitmentsFrom
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetNoWaitCommitmentsFromRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.GetNoWaitCommitmentsFromRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ synchronizer_ids + repeated string + +
+ +
+ +
+
+ participant_uids + repeated string + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

GetNoWaitCommitmentsFromResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.GetNoWaitCommitmentsFromResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ ignored_participants + repeated WaitCommitmentsSetup + +
+ +
participants that are ignored
+ +
+ +
+
+ not_ignored_participants + repeated WaitCommitmentsSetup + +
+ +
participants that are not ignored
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ synchronizer_ids + repeated string + +
+ +
+ +
+
+ participant_uids + repeated string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ ignored_participants + repeated WaitCommitmentsSetup + +
+ +
participants that are ignored
+ +
+ +
+
+ not_ignored_participants + repeated WaitCommitmentsSetup + +
+ +
participants that are not ignored
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ counter_participant_uid + string + +
+ +
+ +
+
+ synchronizers + Synchronizers + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ synchronizer_ids + repeated string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getparticipantschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getparticipantschedule.mdx new file mode 100644 index 0000000..dae71da --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getparticipantschedule.mdx @@ -0,0 +1,354 @@ +--- +title: "GetParticipantSchedule" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

GetParticipantSchedule

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.PruningService/GetParticipantSchedule + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PruningService/GetParticipantSchedule <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "schedule": { + "schedule": { + "cron": "string", + "maxDuration": "string", + "retention": "string" + }, + "pruneInternallyOnly": true + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PruningService
+
+ +
+
RPC
+
GetParticipantSchedule
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetParticipantScheduleRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.GetParticipantScheduleRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

GetParticipantScheduleResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.GetParticipantScheduleResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ schedule + ParticipantPruningSchedule + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ schedule + ParticipantPruningSchedule + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ schedule + PruningSchedule + +
+ +
+ +
+
+ prune_internally_only + bool + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ cron + string + +
+ +
+ +
+
+ max_duration + Duration + +
+ +
+ +
+
+ retention + Duration + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getsafepruningoffset.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getsafepruningoffset.mdx new file mode 100644 index 0000000..a51248a --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getsafepruningoffset.mdx @@ -0,0 +1,390 @@ +--- +title: "GetSafePruningOffset" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

GetSafePruningOffset

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.PruningService/GetSafePruningOffset + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PruningService/GetSafePruningOffset <<'EOF' +{ + "beforeOrAt": "string", + "ledgerEnd": "0", + "counterParticipantsCommitmentsState": "SAFE_TO_PRUNE_COMMITMENT_STATE_UNSPECIFIED" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "safePruningOffset": "0" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PruningService
+
+ +
+
RPC
+
GetSafePruningOffset
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetSafePruningOffsetRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.GetSafePruningOffsetRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ before_or_at + Timestamp + +
+ +
+ +
+
+ ledger_end + int64 + +
+ +
+ +
+
+ counter_participants_commitments_state + SafeToPruneCommitmentState + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

GetSafePruningOffsetResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.GetSafePruningOffsetResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ safe_pruning_offset + int64 + +
+ +
+ +
+
+ no_safe_pruning_offset + NoSafePruningOffset + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ before_or_at + Timestamp + +
+ +
+ +
+
+ ledger_end + int64 + +
+ +
+ +
+
+ counter_participants_commitments_state + SafeToPruneCommitmentState + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • SAFE_TO_PRUNE_COMMITMENT_STATE_UNSPECIFIED
    • + +
  • SAFE_TO_PRUNE_COMMITMENT_STATE_MATCH
    • + +
  • SAFE_TO_PRUNE_COMMITMENT_STATE_MATCH_MISMATCH
    • + +
  • SAFE_TO_PRUNE_COMMITMENT_STATE_ALL
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ safe_pruning_offset + int64 + +
+ +
+ +
+
+ no_safe_pruning_offset + NoSafePruningOffset + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getschedule.mdx new file mode 100644 index 0000000..fd4a24d --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getschedule.mdx @@ -0,0 +1,320 @@ +--- +title: "GetSchedule" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

GetSchedule

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.PruningService/GetSchedule + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PruningService/GetSchedule <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "schedule": { + "cron": "string", + "maxDuration": "string", + "retention": "string" + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PruningService
+
+ +
+
RPC
+
GetSchedule
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetScheduleRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.GetScheduleRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

GetScheduleResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.GetScheduleResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ schedule + PruningSchedule + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ schedule + PruningSchedule + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ cron + string + +
+ +
+ +
+
+ max_duration + Duration + +
+ +
+ +
+
+ retention + Duration + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/prune.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/prune.mdx new file mode 100644 index 0000000..251e0a9 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/prune.mdx @@ -0,0 +1,320 @@ +--- +title: "Prune" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

Prune

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.PruningService/Prune + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PruningService/Prune <<'EOF' +{ + "pruneUpTo": "0", + "counterParticipantsCommitmentsState": "SAFE_TO_PRUNE_COMMITMENT_STATE_UNSPECIFIED" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PruningService
+
+ +
+
RPC
+
Prune
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

PruneRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.PruneRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ prune_up_to + int64 + +
+ +
Inclusive offset up to which the ledger is to be pruned.
+ +
+ +
+
+ counter_participants_commitments_state + SafeToPruneCommitmentState + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

PruneResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.PruneResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ prune_up_to + int64 + +
+ +
Inclusive offset up to which the ledger is to be pruned.
+ +
+ +
+
+ counter_participants_commitments_state + SafeToPruneCommitmentState + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • SAFE_TO_PRUNE_COMMITMENT_STATE_UNSPECIFIED
    • + +
  • SAFE_TO_PRUNE_COMMITMENT_STATE_MATCH
    • + +
  • SAFE_TO_PRUNE_COMMITMENT_STATE_MATCH_MISMATCH
    • + +
  • SAFE_TO_PRUNE_COMMITMENT_STATE_ALL
    • + +
+ + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/resetnowaitcommitmentsfrom.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/resetnowaitcommitmentsfrom.mdx new file mode 100644 index 0000000..895270f --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/resetnowaitcommitmentsfrom.mdx @@ -0,0 +1,307 @@ +--- +title: "ResetNoWaitCommitmentsFrom" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

ResetNoWaitCommitmentsFrom

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.PruningService/ResetNoWaitCommitmentsFrom + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PruningService/ResetNoWaitCommitmentsFrom <<'EOF' +{ + "counterParticipantIds": [ + "string" + ], + "synchronizerIds": [ + "string" + ] +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PruningService
+
+ +
+
RPC
+
ResetNoWaitCommitmentsFrom
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ResetNoWaitCommitmentsFromRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.ResetNoWaitCommitmentsFromRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ counter_participant_ids + repeated string + +
+ +
an empty list has no effect
+ +
+ +
+
+ synchronizer_ids + repeated string + +
+ +
an empty list has no effect
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ResetNoWaitCommitmentsFromResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.ResetNoWaitCommitmentsFromResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ counter_participant_ids + repeated string + +
+ +
an empty list has no effect
+ +
+ +
+
+ synchronizer_ids + repeated string + +
+ +
an empty list has no effect
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setcron.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setcron.mdx new file mode 100644 index 0000000..08271a2 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setcron.mdx @@ -0,0 +1,276 @@ +--- +title: "SetCron" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

SetCron

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.PruningService/SetCron + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PruningService/SetCron <<'EOF' +{ + "cron": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PruningService
+
+ +
+
RPC
+
SetCron
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

SetCronRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.SetCronRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ cron + string + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

SetCronResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.SetCronResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ cron + string + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setmaxduration.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setmaxduration.mdx new file mode 100644 index 0000000..054cdb4 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setmaxduration.mdx @@ -0,0 +1,276 @@ +--- +title: "SetMaxDuration" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

SetMaxDuration

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.PruningService/SetMaxDuration + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PruningService/SetMaxDuration <<'EOF' +{ + "maxDuration": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PruningService
+
+ +
+
RPC
+
SetMaxDuration
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

SetMaxDurationRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.SetMaxDurationRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ max_duration + Duration + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

SetMaxDurationResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.SetMaxDurationResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ max_duration + Duration + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setnowaitcommitmentsfrom.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setnowaitcommitmentsfrom.mdx new file mode 100644 index 0000000..dc73aaf --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setnowaitcommitmentsfrom.mdx @@ -0,0 +1,307 @@ +--- +title: "SetNoWaitCommitmentsFrom" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

SetNoWaitCommitmentsFrom

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.PruningService/SetNoWaitCommitmentsFrom + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PruningService/SetNoWaitCommitmentsFrom <<'EOF' +{ + "counterParticipantIds": [ + "string" + ], + "synchronizerIds": [ + "string" + ] +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PruningService
+
+ +
+
RPC
+
SetNoWaitCommitmentsFrom
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

SetNoWaitCommitmentsFromRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.SetNoWaitCommitmentsFromRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ counter_participant_ids + repeated string + +
+ +
ignore the given participants; an empty list has no effect
+ +
+ +
+
+ synchronizer_ids + repeated string + +
+ +
ignore the given participants on these synchronizers an empty list has no effect
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

SetNoWaitCommitmentsFromResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.SetNoWaitCommitmentsFromResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ counter_participant_ids + repeated string + +
+ +
ignore the given participants; an empty list has no effect
+ +
+ +
+
+ synchronizer_ids + repeated string + +
+ +
ignore the given participants on these synchronizers an empty list has no effect
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setparticipantschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setparticipantschedule.mdx new file mode 100644 index 0000000..dd09ded --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setparticipantschedule.mdx @@ -0,0 +1,354 @@ +--- +title: "SetParticipantSchedule" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

SetParticipantSchedule

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.PruningService/SetParticipantSchedule + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PruningService/SetParticipantSchedule <<'EOF' +{ + "schedule": { + "schedule": { + "cron": "string", + "maxDuration": "string", + "retention": "string" + }, + "pruneInternallyOnly": true + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PruningService
+
+ +
+
RPC
+
SetParticipantSchedule
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

SetParticipantScheduleRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.SetParticipantScheduleRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ schedule + ParticipantPruningSchedule + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

SetParticipantScheduleResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.SetParticipantScheduleResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ schedule + ParticipantPruningSchedule + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ schedule + PruningSchedule + +
+ +
+ +
+
+ prune_internally_only + bool + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ cron + string + +
+ +
+ +
+
+ max_duration + Duration + +
+ +
+ +
+
+ retention + Duration + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setretention.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setretention.mdx new file mode 100644 index 0000000..0f4a599 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setretention.mdx @@ -0,0 +1,276 @@ +--- +title: "SetRetention" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

SetRetention

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.PruningService/SetRetention + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PruningService/SetRetention <<'EOF' +{ + "retention": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PruningService
+
+ +
+
RPC
+
SetRetention
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

SetRetentionRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.SetRetentionRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ retention + Duration + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

SetRetentionResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.SetRetentionResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ retention + Duration + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setschedule.mdx new file mode 100644 index 0000000..b68b38e --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setschedule.mdx @@ -0,0 +1,320 @@ +--- +title: "SetSchedule" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

SetSchedule

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.PruningService/SetSchedule + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PruningService/SetSchedule <<'EOF' +{ + "schedule": { + "cron": "string", + "maxDuration": "string", + "retention": "string" + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
PruningService
+
+ +
+
RPC
+
SetSchedule
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

SetScheduleRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.SetScheduleRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ schedule + PruningSchedule + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

SetScheduleResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.SetScheduleResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ schedule + PruningSchedule + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ cron + string + +
+ +
+ +
+
+ max_duration + Duration + +
+ +
+ +
+
+ retention + Duration + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/resourcemanagementservice/getresourcelimits.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/resourcemanagementservice/getresourcelimits.mdx new file mode 100644 index 0000000..703428e --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/resourcemanagementservice/getresourcelimits.mdx @@ -0,0 +1,326 @@ +--- +title: "GetResourceLimits" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

GetResourceLimits

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.ResourceManagementService/GetResourceLimits + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ResourceManagementService/GetResourceLimits <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "currentLimits": { + "maxInflightValidationRequests": 0, + "maxSubmissionRate": 0, + "maxSubmissionBurstFactor": 0.0 + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
ResourceManagementService
+
+ +
+
RPC
+
GetResourceLimits
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetResourceLimitsRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.GetResourceLimitsRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

GetResourceLimitsResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.GetResourceLimitsResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ current_limits + ResourceLimits + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ current_limits + ResourceLimits + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ max_inflight_validation_requests + uint32 + +
+ +
The maximum number of inflight validation requests. A negative value indicates that there is no limit.
+ +
+ +
+
+ max_submission_rate + uint32 + +
+ +
The maximum rate of command submissions through the ledger api. A negative value indicates that there is no limit.
+ +
+ +
+
+ max_submission_burst_factor + double + +
+ +
The maximum burst acceptable (factor > 0) before steady state throttling kicks in.
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/resourcemanagementservice/setresourcelimits.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/resourcemanagementservice/setresourcelimits.mdx new file mode 100644 index 0000000..b120b01 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/resourcemanagementservice/setresourcelimits.mdx @@ -0,0 +1,326 @@ +--- +title: "SetResourceLimits" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

SetResourceLimits

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.ResourceManagementService/SetResourceLimits + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ResourceManagementService/SetResourceLimits <<'EOF' +{ + "newLimits": { + "maxInflightValidationRequests": 0, + "maxSubmissionRate": 0, + "maxSubmissionBurstFactor": 0.0 + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
ResourceManagementService
+
+ +
+
RPC
+
SetResourceLimits
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

SetResourceLimitsRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.SetResourceLimitsRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ new_limits + ResourceLimits + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

SetResourceLimitsResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.SetResourceLimitsResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ new_limits + ResourceLimits + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ max_inflight_validation_requests + uint32 + +
+ +
The maximum number of inflight validation requests. A negative value indicates that there is no limit.
+ +
+ +
+
+ max_submission_rate + uint32 + +
+ +
The maximum rate of command submissions through the ledger api. A negative value indicates that there is no limit.
+ +
+ +
+
+ max_submission_burst_factor + double + +
+ +
The maximum burst acceptable (factor > 0) before steady state throttling kicks in.
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/connectsynchronizer.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/connectsynchronizer.mdx new file mode 100644 index 0000000..b28c4a7 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/connectsynchronizer.mdx @@ -0,0 +1,835 @@ +--- +title: "ConnectSynchronizer" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

ConnectSynchronizer

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/ConnectSynchronizer + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/ConnectSynchronizer <<'EOF' +{ + "config": { + "synchronizerAlias": "string", + "sequencerConnections": { + "sequencerConnections": [ + { + "grpc": {}, + "alias": "string", + "sequencerId": "string" + } + ], + "sequencerTrustThreshold": 0, + "submissionRequestAmplification": { + "factor": 0, + "patience": "string" + }, + "sequencerLivenessMargin": 0, + "sequencerConnectionPoolDelays": { + "minRestartDelay": "string", + "maxRestartDelay": "string", + "subscriptionRequestDelay": "string", + "warnValidationDelay": "string" + } + }, + "manualConnect": true, + "physicalSynchronizerId": "string", + "priority": 0, + "initialRetryDelay": "string", + "maxRetryDelay": "string", + "timeTracker": { + "observationLatency": "string", + "patienceDuration": "string", + "minObservationDuration": "string", + "timeProofRequest": { + "initialRetryDelay": "string", + "maxRetryDelay": "string", + "maxSequencingDelay": "string" + } + } + }, + "sequencerConnectionValidation": "SEQUENCER_CONNECTION_VALIDATION_UNSPECIFIED" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "connectedSuccessfully": true +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SynchronizerConnectivityService
+
+ +
+
RPC
+
ConnectSynchronizer
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ConnectSynchronizerRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.ConnectSynchronizerRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ config + SynchronizerConnectionConfig + +
+ +
+ +
+
+ sequencer_connection_validation + SequencerConnectionValidation + +
+ +
Determines how well the provided sequencer connections should be validated before they are persisted. The more paranoid the validation, the higher the chance of the command failing, as it will require the sequencer to be online and responsive.
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ConnectSynchronizerResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.ConnectSynchronizerResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ connected_successfully + bool + +
+ +
true if the synchronizer is connected, false if the synchronizer is offline, exception on any other error
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ config + SynchronizerConnectionConfig + +
+ +
+ +
+
+ sequencer_connection_validation + SequencerConnectionValidation + +
+ +
Determines how well the provided sequencer connections should be validated before they are persisted. The more paranoid the validation, the higher the chance of the command failing, as it will require the sequencer to be online and responsive.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ synchronizer_alias + string + +
+ +
participant local identifier of the target synchronizer
+ +
+ +
+
+ sequencer_connections + SequencerConnections + +
+ +
connection information to sequencers
+ +
+ +
+
+ manual_connect + bool + +
+ +
if false, then the synchronizer needs to be manually connected to (default false)
+ +
+ +
+
+ physical_synchronizer_id + string + +
+ +
optional physical synchronizer id (if TLS isn't to be trusted)
+ +
+ +
+
+ priority + int32 + +
+ +
optional. Influences whether the participant submits to this synchronizer, if several synchronizers are eligible
+ +
+ +
+
+ initial_retry_delay + Duration + +
+ +
initial delay before an attempt to reconnect to the sequencer
+ +
+ +
+
+ max_retry_delay + Duration + +
+ +
maximum delay before an attempt to reconnect to the sequencer
+ +
+ +
+
+ time_tracker + SynchronizerTimeTrackerConfig + +
+ +
configuration for how time is tracked and requested on this synchronizer
+ +
+ +
+
+ initialize_from_trusted_synchronizer + bool + +
+ +
If true, allows a participant to connect to a synchronizer that it was previously connected to, without issuing a new synchronizer trust certificate.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ sequencer_connections + repeated SequencerConnection + +
+ +
+ +
+
+ sequencer_trust_threshold + uint32 + +
+ +
This field determines the minimum level of agreement, or consensus, required among the sequencers before a message is considered reliable and accepted by the system. This value must be positive.
+ +
+ +
+
+ submission_request_amplification + SubmissionRequestAmplification + +
+ +
+ +
+
+ sequencer_liveness_margin + uint32 + +
+ +
This field determines the number of extra subscriptions to maintain beyond `sequencer_trust_threshold` in order to ensure liveness. This is only used when the new connection pool is enabled, and is ignored otherwise. This value must be non-negative.
+ +
+ +
+
+ sequencer_connection_pool_delays + SequencerConnectionPoolDelays + +
+ +
Configures the various delays used by the sequencer connection pool.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ grpc + Grpc + +
+ +
+ +
+
+ alias + string + +
+ +
+ +
+
+ sequencer_id + string + +
+ +
The id of the sequencer that serves the sequencer API. If empty, the node sets it after the first connection. If set, the node checks that the sequencer id reported by the sequencer matches this id.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ connections + repeated string + +
+ +
connection information to sequencer (http[s]://<host>:<port>")
+ +
+ +
+
+ transport_security + bool + +
+ +
Should the connection use TLS?
+ +
+ +
+
+ custom_trust_certificates + bytes + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ factor + uint32 + +
+ +
Determines to how often the client should try to send a submission request that is eligible for deduplication. A higher value increases the chance of a submission request being accepted by the system, but also increases the load on the sequencers and thus the costs incurred by the client. This value must be positive.
+ +
+ +
+
+ patience + Duration + +
+ +
Determines how long the sequencer client waits for observing the sequencing before it sends the submission request again. This value must be non-negative.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ min_restart_delay + Duration + +
+ +
Minimum duration after which a failed sequencer connection is restarted. This value must be non-negative.
+ +
+ +
+
+ max_restart_delay + Duration + +
+ +
Maximum duration after which a failed sequencer connection is restarted. This value must be non-negative.
+ +
+ +
+
+ subscription_request_delay + Duration + +
+ +
Delay between the attempts to obtain new sequencer connections for the sequencer subscription pool, when the current number of subscriptions is below `trustThreshold` + `livenessMargin`. This value must be non-negative.
+ +
+ +
+
+ warn_validation_delay + Duration + +
+ +
Duration after which a warning is issued if a started connection still fails validation. This value must be non-negative.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ observation_latency + Duration + +
+ +
+ +
+
+ patience_duration + Duration + +
+ +
+ +
+
+ min_observation_duration + Duration + +
+ +
+ +
+
+ time_proof_request + TimeProofRequestConfig + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ initial_retry_delay + Duration + +
+ +
+ +
+
+ max_retry_delay + Duration + +
+ +
+ +
+
+ max_sequencing_delay + Duration + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • SEQUENCER_CONNECTION_VALIDATION_UNSPECIFIED
    • + +
  • SEQUENCER_CONNECTION_VALIDATION_DISABLED
    • + +
  • SEQUENCER_CONNECTION_VALIDATION_ACTIVE
    • + +
  • SEQUENCER_CONNECTION_VALIDATION_ALL
    • + +
  • SEQUENCER_CONNECTION_VALIDATION_THRESHOLD_ACTIVE
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ connected_successfully + bool + +
+ +
true if the synchronizer is connected, false if the synchronizer is offline, exception on any other error
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/disconnectallsynchronizers.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/disconnectallsynchronizers.mdx new file mode 100644 index 0000000..2954f78 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/disconnectallsynchronizers.mdx @@ -0,0 +1,248 @@ +--- +title: "DisconnectAllSynchronizers" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

DisconnectAllSynchronizers

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/DisconnectAllSynchronizers + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/DisconnectAllSynchronizers <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SynchronizerConnectivityService
+
+ +
+
RPC
+
DisconnectAllSynchronizers
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

DisconnectAllSynchronizersRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.DisconnectAllSynchronizersRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

DisconnectAllSynchronizersResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.DisconnectAllSynchronizersResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/disconnectsynchronizer.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/disconnectsynchronizer.mdx new file mode 100644 index 0000000..a2d34cd --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/disconnectsynchronizer.mdx @@ -0,0 +1,276 @@ +--- +title: "DisconnectSynchronizer" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

DisconnectSynchronizer

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/DisconnectSynchronizer + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/DisconnectSynchronizer <<'EOF' +{ + "synchronizerAlias": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SynchronizerConnectivityService
+
+ +
+
RPC
+
DisconnectSynchronizer
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

DisconnectSynchronizerRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.DisconnectSynchronizerRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ synchronizer_alias + string + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

DisconnectSynchronizerResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.DisconnectSynchronizerResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ synchronizer_alias + string + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/getsynchronizerid.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/getsynchronizerid.mdx new file mode 100644 index 0000000..3a76b9d --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/getsynchronizerid.mdx @@ -0,0 +1,323 @@ +--- +title: "GetSynchronizerId" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

GetSynchronizerId

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/GetSynchronizerId + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/GetSynchronizerId <<'EOF' +{ + "synchronizerAlias": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "synchronizerId": "string", + "physicalSynchronizerId": "string" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SynchronizerConnectivityService
+
+ +
+
RPC
+
GetSynchronizerId
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetSynchronizerIdRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.GetSynchronizerIdRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ synchronizer_alias + string + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

GetSynchronizerIdResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.GetSynchronizerIdResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ synchronizer_id + string + +
+ +
+ +
+
+ physical_synchronizer_id + string + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ synchronizer_alias + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ synchronizer_id + string + +
+ +
+ +
+
+ physical_synchronizer_id + string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/listconnectedsynchronizers.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/listconnectedsynchronizers.mdx new file mode 100644 index 0000000..1d31c8a --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/listconnectedsynchronizers.mdx @@ -0,0 +1,332 @@ +--- +title: "ListConnectedSynchronizers" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

ListConnectedSynchronizers

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/ListConnectedSynchronizers + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/ListConnectedSynchronizers <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "connectedSynchronizers": [ + { + "synchronizerAlias": "string", + "synchronizerId": "string", + "physicalSynchronizerId": "string", + "healthy": true + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SynchronizerConnectivityService
+
+ +
+
RPC
+
ListConnectedSynchronizers
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ListConnectedSynchronizersRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.ListConnectedSynchronizersRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

ListConnectedSynchronizersResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.ListConnectedSynchronizersResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ connected_synchronizers + repeated Result + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ connected_synchronizers + repeated Result + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ synchronizer_alias + string + +
+ +
+ +
+
+ synchronizer_id + string + +
+ +
+ +
+
+ physical_synchronizer_id + string + +
+ +
+ +
+
+ healthy + bool + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/listregisteredsynchronizers.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/listregisteredsynchronizers.mdx new file mode 100644 index 0000000..f76cd46 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/listregisteredsynchronizers.mdx @@ -0,0 +1,787 @@ +--- +title: "ListRegisteredSynchronizers" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

ListRegisteredSynchronizers

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/ListRegisteredSynchronizers + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/ListRegisteredSynchronizers <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "results": [ + { + "config": { + "synchronizerAlias": "string", + "sequencerConnections": { + "sequencerConnections": [ + {} + ], + "sequencerTrustThreshold": 0, + "submissionRequestAmplification": {}, + "sequencerLivenessMargin": 0, + "sequencerConnectionPoolDelays": {} + }, + "manualConnect": true, + "physicalSynchronizerId": "string", + "priority": 0, + "initialRetryDelay": "string", + "maxRetryDelay": "string", + "timeTracker": { + "observationLatency": "string", + "patienceDuration": "string", + "minObservationDuration": "string", + "timeProofRequest": {} + } + }, + "connected": true, + "physicalSynchronizerId": "string" + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SynchronizerConnectivityService
+
+ +
+
RPC
+
ListRegisteredSynchronizers
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ListRegisteredSynchronizersRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.ListRegisteredSynchronizersRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

ListRegisteredSynchronizersResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.ListRegisteredSynchronizersResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ config + SynchronizerConnectionConfig + +
+ +
+ +
+
+ connected + bool + +
+ +
+ +
+
+ physical_synchronizer_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ synchronizer_alias + string + +
+ +
participant local identifier of the target synchronizer
+ +
+ +
+
+ sequencer_connections + SequencerConnections + +
+ +
connection information to sequencers
+ +
+ +
+
+ manual_connect + bool + +
+ +
if false, then the synchronizer needs to be manually connected to (default false)
+ +
+ +
+
+ physical_synchronizer_id + string + +
+ +
optional physical synchronizer id (if TLS isn't to be trusted)
+ +
+ +
+
+ priority + int32 + +
+ +
optional. Influences whether the participant submits to this synchronizer, if several synchronizers are eligible
+ +
+ +
+
+ initial_retry_delay + Duration + +
+ +
initial delay before an attempt to reconnect to the sequencer
+ +
+ +
+
+ max_retry_delay + Duration + +
+ +
maximum delay before an attempt to reconnect to the sequencer
+ +
+ +
+
+ time_tracker + SynchronizerTimeTrackerConfig + +
+ +
configuration for how time is tracked and requested on this synchronizer
+ +
+ +
+
+ initialize_from_trusted_synchronizer + bool + +
+ +
If true, allows a participant to connect to a synchronizer that it was previously connected to, without issuing a new synchronizer trust certificate.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ sequencer_connections + repeated SequencerConnection + +
+ +
+ +
+
+ sequencer_trust_threshold + uint32 + +
+ +
This field determines the minimum level of agreement, or consensus, required among the sequencers before a message is considered reliable and accepted by the system. This value must be positive.
+ +
+ +
+
+ submission_request_amplification + SubmissionRequestAmplification + +
+ +
+ +
+
+ sequencer_liveness_margin + uint32 + +
+ +
This field determines the number of extra subscriptions to maintain beyond `sequencer_trust_threshold` in order to ensure liveness. This is only used when the new connection pool is enabled, and is ignored otherwise. This value must be non-negative.
+ +
+ +
+
+ sequencer_connection_pool_delays + SequencerConnectionPoolDelays + +
+ +
Configures the various delays used by the sequencer connection pool.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ grpc + Grpc + +
+ +
+ +
+
+ alias + string + +
+ +
+ +
+
+ sequencer_id + string + +
+ +
The id of the sequencer that serves the sequencer API. If empty, the node sets it after the first connection. If set, the node checks that the sequencer id reported by the sequencer matches this id.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ connections + repeated string + +
+ +
connection information to sequencer (http[s]://<host>:<port>")
+ +
+ +
+
+ transport_security + bool + +
+ +
Should the connection use TLS?
+ +
+ +
+
+ custom_trust_certificates + bytes + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ factor + uint32 + +
+ +
Determines to how often the client should try to send a submission request that is eligible for deduplication. A higher value increases the chance of a submission request being accepted by the system, but also increases the load on the sequencers and thus the costs incurred by the client. This value must be positive.
+ +
+ +
+
+ patience + Duration + +
+ +
Determines how long the sequencer client waits for observing the sequencing before it sends the submission request again. This value must be non-negative.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ min_restart_delay + Duration + +
+ +
Minimum duration after which a failed sequencer connection is restarted. This value must be non-negative.
+ +
+ +
+
+ max_restart_delay + Duration + +
+ +
Maximum duration after which a failed sequencer connection is restarted. This value must be non-negative.
+ +
+ +
+
+ subscription_request_delay + Duration + +
+ +
Delay between the attempts to obtain new sequencer connections for the sequencer subscription pool, when the current number of subscriptions is below `trustThreshold` + `livenessMargin`. This value must be non-negative.
+ +
+ +
+
+ warn_validation_delay + Duration + +
+ +
Duration after which a warning is issued if a started connection still fails validation. This value must be non-negative.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ observation_latency + Duration + +
+ +
+ +
+
+ patience_duration + Duration + +
+ +
+ +
+
+ min_observation_duration + Duration + +
+ +
+ +
+
+ time_proof_request + TimeProofRequestConfig + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ initial_retry_delay + Duration + +
+ +
+ +
+
+ max_retry_delay + Duration + +
+ +
+ +
+
+ max_sequencing_delay + Duration + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/logout.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/logout.mdx new file mode 100644 index 0000000..4f057cc --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/logout.mdx @@ -0,0 +1,276 @@ +--- +title: "Logout" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

Logout

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/Logout + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/Logout <<'EOF' +{ + "synchronizerAlias": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SynchronizerConnectivityService
+
+ +
+
RPC
+
Logout
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

LogoutRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.LogoutRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ synchronizer_alias + string + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

LogoutResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.LogoutResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ synchronizer_alias + string + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/modifysynchronizer.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/modifysynchronizer.mdx new file mode 100644 index 0000000..f9886db --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/modifysynchronizer.mdx @@ -0,0 +1,822 @@ +--- +title: "ModifySynchronizer" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

ModifySynchronizer

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/ModifySynchronizer + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/ModifySynchronizer <<'EOF' +{ + "physicalSynchronizerId": "string", + "newConfig": { + "synchronizerAlias": "string", + "sequencerConnections": { + "sequencerConnections": [ + { + "grpc": {}, + "alias": "string", + "sequencerId": "string" + } + ], + "sequencerTrustThreshold": 0, + "submissionRequestAmplification": { + "factor": 0, + "patience": "string" + }, + "sequencerLivenessMargin": 0, + "sequencerConnectionPoolDelays": { + "minRestartDelay": "string", + "maxRestartDelay": "string", + "subscriptionRequestDelay": "string", + "warnValidationDelay": "string" + } + }, + "manualConnect": true, + "physicalSynchronizerId": "string", + "priority": 0, + "initialRetryDelay": "string", + "maxRetryDelay": "string", + "timeTracker": { + "observationLatency": "string", + "patienceDuration": "string", + "minObservationDuration": "string", + "timeProofRequest": { + "initialRetryDelay": "string", + "maxRetryDelay": "string", + "maxSequencingDelay": "string" + } + } + }, + "sequencerConnectionValidation": "SEQUENCER_CONNECTION_VALIDATION_UNSPECIFIED" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SynchronizerConnectivityService
+
+ +
+
RPC
+
ModifySynchronizer
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ModifySynchronizerRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.ModifySynchronizerRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ physical_synchronizer_id + string + +
+ +
If empty, the request will update the single active connection for the alias in `new_config`
+ +
+ +
+
+ new_config + SynchronizerConnectionConfig + +
+ +
+ +
+
+ sequencer_connection_validation + SequencerConnectionValidation + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ModifySynchronizerResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.ModifySynchronizerResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ physical_synchronizer_id + string + +
+ +
If empty, the request will update the single active connection for the alias in `new_config`
+ +
+ +
+
+ new_config + SynchronizerConnectionConfig + +
+ +
+ +
+
+ sequencer_connection_validation + SequencerConnectionValidation + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ synchronizer_alias + string + +
+ +
participant local identifier of the target synchronizer
+ +
+ +
+
+ sequencer_connections + SequencerConnections + +
+ +
connection information to sequencers
+ +
+ +
+
+ manual_connect + bool + +
+ +
if false, then the synchronizer needs to be manually connected to (default false)
+ +
+ +
+
+ physical_synchronizer_id + string + +
+ +
optional physical synchronizer id (if TLS isn't to be trusted)
+ +
+ +
+
+ priority + int32 + +
+ +
optional. Influences whether the participant submits to this synchronizer, if several synchronizers are eligible
+ +
+ +
+
+ initial_retry_delay + Duration + +
+ +
initial delay before an attempt to reconnect to the sequencer
+ +
+ +
+
+ max_retry_delay + Duration + +
+ +
maximum delay before an attempt to reconnect to the sequencer
+ +
+ +
+
+ time_tracker + SynchronizerTimeTrackerConfig + +
+ +
configuration for how time is tracked and requested on this synchronizer
+ +
+ +
+
+ initialize_from_trusted_synchronizer + bool + +
+ +
If true, allows a participant to connect to a synchronizer that it was previously connected to, without issuing a new synchronizer trust certificate.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ sequencer_connections + repeated SequencerConnection + +
+ +
+ +
+
+ sequencer_trust_threshold + uint32 + +
+ +
This field determines the minimum level of agreement, or consensus, required among the sequencers before a message is considered reliable and accepted by the system. This value must be positive.
+ +
+ +
+
+ submission_request_amplification + SubmissionRequestAmplification + +
+ +
+ +
+
+ sequencer_liveness_margin + uint32 + +
+ +
This field determines the number of extra subscriptions to maintain beyond `sequencer_trust_threshold` in order to ensure liveness. This is only used when the new connection pool is enabled, and is ignored otherwise. This value must be non-negative.
+ +
+ +
+
+ sequencer_connection_pool_delays + SequencerConnectionPoolDelays + +
+ +
Configures the various delays used by the sequencer connection pool.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ grpc + Grpc + +
+ +
+ +
+
+ alias + string + +
+ +
+ +
+
+ sequencer_id + string + +
+ +
The id of the sequencer that serves the sequencer API. If empty, the node sets it after the first connection. If set, the node checks that the sequencer id reported by the sequencer matches this id.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ connections + repeated string + +
+ +
connection information to sequencer (http[s]://<host>:<port>")
+ +
+ +
+
+ transport_security + bool + +
+ +
Should the connection use TLS?
+ +
+ +
+
+ custom_trust_certificates + bytes + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ factor + uint32 + +
+ +
Determines to how often the client should try to send a submission request that is eligible for deduplication. A higher value increases the chance of a submission request being accepted by the system, but also increases the load on the sequencers and thus the costs incurred by the client. This value must be positive.
+ +
+ +
+
+ patience + Duration + +
+ +
Determines how long the sequencer client waits for observing the sequencing before it sends the submission request again. This value must be non-negative.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ min_restart_delay + Duration + +
+ +
Minimum duration after which a failed sequencer connection is restarted. This value must be non-negative.
+ +
+ +
+
+ max_restart_delay + Duration + +
+ +
Maximum duration after which a failed sequencer connection is restarted. This value must be non-negative.
+ +
+ +
+
+ subscription_request_delay + Duration + +
+ +
Delay between the attempts to obtain new sequencer connections for the sequencer subscription pool, when the current number of subscriptions is below `trustThreshold` + `livenessMargin`. This value must be non-negative.
+ +
+ +
+
+ warn_validation_delay + Duration + +
+ +
Duration after which a warning is issued if a started connection still fails validation. This value must be non-negative.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ observation_latency + Duration + +
+ +
+ +
+
+ patience_duration + Duration + +
+ +
+ +
+
+ min_observation_duration + Duration + +
+ +
+ +
+
+ time_proof_request + TimeProofRequestConfig + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ initial_retry_delay + Duration + +
+ +
+ +
+
+ max_retry_delay + Duration + +
+ +
+ +
+
+ max_sequencing_delay + Duration + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • SEQUENCER_CONNECTION_VALIDATION_UNSPECIFIED
    • + +
  • SEQUENCER_CONNECTION_VALIDATION_DISABLED
    • + +
  • SEQUENCER_CONNECTION_VALIDATION_ACTIVE
    • + +
  • SEQUENCER_CONNECTION_VALIDATION_ALL
    • + +
  • SEQUENCER_CONNECTION_VALIDATION_THRESHOLD_ACTIVE
    • + +
+ + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/reconnectsynchronizer.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/reconnectsynchronizer.mdx new file mode 100644 index 0000000..baae820 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/reconnectsynchronizer.mdx @@ -0,0 +1,331 @@ +--- +title: "ReconnectSynchronizer" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

ReconnectSynchronizer

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/ReconnectSynchronizer + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/ReconnectSynchronizer <<'EOF' +{ + "synchronizerAlias": "string", + "retry": true +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "connectedSuccessfully": true +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SynchronizerConnectivityService
+
+ +
+
RPC
+
ReconnectSynchronizer
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ReconnectSynchronizerRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.ReconnectSynchronizerRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ synchronizer_alias + string + +
+ +
+ +
+
+ retry + bool + +
+ +
if retry is set to true, we will keep on retrying if the synchronizer is unavailable
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ReconnectSynchronizerResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.ReconnectSynchronizerResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ connected_successfully + bool + +
+ +
true if the synchronizer is connected, false if the synchronizer is offline, exception on any other error
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ synchronizer_alias + string + +
+ +
+ +
+
+ retry + bool + +
+ +
if retry is set to true, we will keep on retrying if the synchronizer is unavailable
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ connected_successfully + bool + +
+ +
true if the synchronizer is connected, false if the synchronizer is offline, exception on any other error
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/reconnectsynchronizers.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/reconnectsynchronizers.mdx new file mode 100644 index 0000000..b0ed3d9 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/reconnectsynchronizers.mdx @@ -0,0 +1,280 @@ +--- +title: "ReconnectSynchronizers" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

ReconnectSynchronizers

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/ReconnectSynchronizers + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/ReconnectSynchronizers <<'EOF' +{ + "ignoreFailures": true +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SynchronizerConnectivityService
+
+ +
+
RPC
+
ReconnectSynchronizers
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ReconnectSynchronizersRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.ReconnectSynchronizersRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ ignore_failures + bool + +
+ +
if set to true, the connection attempt will succeed even if one of the connection attempts failed
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ReconnectSynchronizersResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.ReconnectSynchronizersResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ ignore_failures + bool + +
+ +
if set to true, the connection attempt will succeed even if one of the connection attempts failed
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/registersynchronizer.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/registersynchronizer.mdx new file mode 100644 index 0000000..aeb4544 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/registersynchronizer.mdx @@ -0,0 +1,845 @@ +--- +title: "RegisterSynchronizer" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

RegisterSynchronizer

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/RegisterSynchronizer + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/RegisterSynchronizer <<'EOF' +{ + "config": { + "synchronizerAlias": "string", + "sequencerConnections": { + "sequencerConnections": [ + { + "grpc": {}, + "alias": "string", + "sequencerId": "string" + } + ], + "sequencerTrustThreshold": 0, + "submissionRequestAmplification": { + "factor": 0, + "patience": "string" + }, + "sequencerLivenessMargin": 0, + "sequencerConnectionPoolDelays": { + "minRestartDelay": "string", + "maxRestartDelay": "string", + "subscriptionRequestDelay": "string", + "warnValidationDelay": "string" + } + }, + "manualConnect": true, + "physicalSynchronizerId": "string", + "priority": 0, + "initialRetryDelay": "string", + "maxRetryDelay": "string", + "timeTracker": { + "observationLatency": "string", + "patienceDuration": "string", + "minObservationDuration": "string", + "timeProofRequest": { + "initialRetryDelay": "string", + "maxRetryDelay": "string", + "maxSequencingDelay": "string" + } + } + }, + "synchronizerConnection": "SYNCHRONIZER_CONNECTION_UNSPECIFIED", + "sequencerConnectionValidation": "SEQUENCER_CONNECTION_VALIDATION_UNSPECIFIED" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SynchronizerConnectivityService
+
+ +
+
RPC
+
RegisterSynchronizer
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

RegisterSynchronizerRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.RegisterSynchronizerRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ config + SynchronizerConnectionConfig + +
+ +
+ +
+
+ synchronizer_connection + SynchronizerConnection + +
+ +
Whether requests to the synchronizer are made
+ +
+ +
+
+ sequencer_connection_validation + SequencerConnectionValidation + +
+ +
Determines how well the provided sequencer connections should be validated before they are persisted. The more paranoid the validation, the higher the chance of the command failing, as it will require the sequencer to be online and responsive.
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

RegisterSynchronizerResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.RegisterSynchronizerResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ config + SynchronizerConnectionConfig + +
+ +
+ +
+
+ synchronizer_connection + SynchronizerConnection + +
+ +
Whether requests to the synchronizer are made
+ +
+ +
+
+ sequencer_connection_validation + SequencerConnectionValidation + +
+ +
Determines how well the provided sequencer connections should be validated before they are persisted. The more paranoid the validation, the higher the chance of the command failing, as it will require the sequencer to be online and responsive.
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • SYNCHRONIZER_CONNECTION_UNSPECIFIED
    • + +
  • SYNCHRONIZER_CONNECTION_NONE
    • + +
  • SYNCHRONIZER_CONNECTION_HANDSHAKE
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ synchronizer_alias + string + +
+ +
participant local identifier of the target synchronizer
+ +
+ +
+
+ sequencer_connections + SequencerConnections + +
+ +
connection information to sequencers
+ +
+ +
+
+ manual_connect + bool + +
+ +
if false, then the synchronizer needs to be manually connected to (default false)
+ +
+ +
+
+ physical_synchronizer_id + string + +
+ +
optional physical synchronizer id (if TLS isn't to be trusted)
+ +
+ +
+
+ priority + int32 + +
+ +
optional. Influences whether the participant submits to this synchronizer, if several synchronizers are eligible
+ +
+ +
+
+ initial_retry_delay + Duration + +
+ +
initial delay before an attempt to reconnect to the sequencer
+ +
+ +
+
+ max_retry_delay + Duration + +
+ +
maximum delay before an attempt to reconnect to the sequencer
+ +
+ +
+
+ time_tracker + SynchronizerTimeTrackerConfig + +
+ +
configuration for how time is tracked and requested on this synchronizer
+ +
+ +
+
+ initialize_from_trusted_synchronizer + bool + +
+ +
If true, allows a participant to connect to a synchronizer that it was previously connected to, without issuing a new synchronizer trust certificate.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ sequencer_connections + repeated SequencerConnection + +
+ +
+ +
+
+ sequencer_trust_threshold + uint32 + +
+ +
This field determines the minimum level of agreement, or consensus, required among the sequencers before a message is considered reliable and accepted by the system. This value must be positive.
+ +
+ +
+
+ submission_request_amplification + SubmissionRequestAmplification + +
+ +
+ +
+
+ sequencer_liveness_margin + uint32 + +
+ +
This field determines the number of extra subscriptions to maintain beyond `sequencer_trust_threshold` in order to ensure liveness. This is only used when the new connection pool is enabled, and is ignored otherwise. This value must be non-negative.
+ +
+ +
+
+ sequencer_connection_pool_delays + SequencerConnectionPoolDelays + +
+ +
Configures the various delays used by the sequencer connection pool.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ grpc + Grpc + +
+ +
+ +
+
+ alias + string + +
+ +
+ +
+
+ sequencer_id + string + +
+ +
The id of the sequencer that serves the sequencer API. If empty, the node sets it after the first connection. If set, the node checks that the sequencer id reported by the sequencer matches this id.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ connections + repeated string + +
+ +
connection information to sequencer (http[s]://<host>:<port>")
+ +
+ +
+
+ transport_security + bool + +
+ +
Should the connection use TLS?
+ +
+ +
+
+ custom_trust_certificates + bytes + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ factor + uint32 + +
+ +
Determines to how often the client should try to send a submission request that is eligible for deduplication. A higher value increases the chance of a submission request being accepted by the system, but also increases the load on the sequencers and thus the costs incurred by the client. This value must be positive.
+ +
+ +
+
+ patience + Duration + +
+ +
Determines how long the sequencer client waits for observing the sequencing before it sends the submission request again. This value must be non-negative.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ min_restart_delay + Duration + +
+ +
Minimum duration after which a failed sequencer connection is restarted. This value must be non-negative.
+ +
+ +
+
+ max_restart_delay + Duration + +
+ +
Maximum duration after which a failed sequencer connection is restarted. This value must be non-negative.
+ +
+ +
+
+ subscription_request_delay + Duration + +
+ +
Delay between the attempts to obtain new sequencer connections for the sequencer subscription pool, when the current number of subscriptions is below `trustThreshold` + `livenessMargin`. This value must be non-negative.
+ +
+ +
+
+ warn_validation_delay + Duration + +
+ +
Duration after which a warning is issued if a started connection still fails validation. This value must be non-negative.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ observation_latency + Duration + +
+ +
+ +
+
+ patience_duration + Duration + +
+ +
+ +
+
+ min_observation_duration + Duration + +
+ +
+ +
+
+ time_proof_request + TimeProofRequestConfig + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ initial_retry_delay + Duration + +
+ +
+ +
+
+ max_retry_delay + Duration + +
+ +
+ +
+
+ max_sequencing_delay + Duration + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • SEQUENCER_CONNECTION_VALIDATION_UNSPECIFIED
    • + +
  • SEQUENCER_CONNECTION_VALIDATION_DISABLED
    • + +
  • SEQUENCER_CONNECTION_VALIDATION_ACTIVE
    • + +
  • SEQUENCER_CONNECTION_VALIDATION_ALL
    • + +
  • SEQUENCER_CONNECTION_VALIDATION_THRESHOLD_ACTIVE
    • + +
+ + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/trafficcontrolservice/trafficcontrolstate.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/trafficcontrolservice/trafficcontrolstate.mdx new file mode 100644 index 0000000..255e39e --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/trafficcontrolservice/trafficcontrolstate.mdx @@ -0,0 +1,394 @@ +--- +title: "TrafficControlState" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.participant.v30

+ + +

TrafficControlState

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.participant.v30.TrafficControlService/TrafficControlState + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.TrafficControlService/TrafficControlState <<'EOF' +{ + "synchronizerId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "trafficState": { + "extraTrafficPurchased": "0", + "extraTrafficConsumed": "0", + "baseTrafficRemainder": "0", + "lastConsumedCost": "0", + "timestamp": "0", + "serial": 0 + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
TrafficControlService
+
+ +
+
RPC
+
TrafficControlState
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

TrafficControlStateRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.TrafficControlStateRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ synchronizer_id + string + +
+ +
Synchronizer id for which to retrieve the traffic state
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

TrafficControlStateResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.participant.v30.TrafficControlStateResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ traffic_state + TrafficState + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ synchronizer_id + string + +
+ +
Synchronizer id for which to retrieve the traffic state
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ traffic_state + TrafficState + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ extra_traffic_purchased + int64 + +
+ +
Total amount of extra traffic purchased
+ +
+ +
+
+ extra_traffic_consumed + int64 + +
+ +
Total amount of extra traffic consumed
+ +
+ +
+
+ base_traffic_remainder + int64 + +
+ +
Amount of base traffic remaining
+ +
+ +
+
+ last_consumed_cost + uint64 + +
+ +
Cost deducted at `timestamp`, only present when traffic was consumed at `timestamp`, otherwise is set to 0
+ +
+ +
+
+ timestamp + int64 + +
+ +
Timestamp at which the state is valid
+ +
+ +
+
+ serial + uint32 + +
+ +
Optional serial of the balance update that updated the extra traffic limit
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-sequencer-v30/sequencerstatusservice/sequencerstatus.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-sequencer-v30/sequencerstatusservice/sequencerstatus.mdx new file mode 100644 index 0000000..414547e --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-sequencer-v30/sequencerstatusservice/sequencerstatus.mdx @@ -0,0 +1,783 @@ +--- +title: "SequencerStatus" +--- + +
+ + + + +
+ +

com.digitalasset.canton.admin.sequencer.v30

+ + +

SequencerStatus

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.admin.sequencer.v30.SequencerStatusService/SequencerStatus + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.sequencer.v30.SequencerStatusService/SequencerStatus <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "status": { + "commonStatus": { + "uid": "string", + "uptime": "string", + "ports": [ + { + "key": 0 + } + ], + "active": true, + "topologyQueues": { + "manager": 0, + "dispatcher": 0, + "clients": 0 + }, + "components": [ + { + "name": "string", + "ok": {} + } + ], + "version": "string" + }, + "connectedParticipants": [ + { + "uid": "string" + } + ], + "connectedMediators": [ + { + "uid": "string" + } + ], + "sequencer": { + "active": true, + "details": "string" + }, + "physicalSynchronizerId": "string", + "admin": { + "acceptsAdminChanges": true + }, + "protocolVersion": 0 + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerStatusService
+
+ +
+
RPC
+
SequencerStatus
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

SequencerStatusRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.sequencer.v30.SequencerStatusRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

SequencerStatusResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.sequencer.v30.SequencerStatusResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ status + SequencerStatusResponseStatus + +
+ +
+ +
+
+ not_initialized + NotInitialized + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ status + SequencerStatusResponseStatus + +
+ +
+ +
+
+ not_initialized + NotInitialized + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ uid + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ uid + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ common_status + Status + +
+ +
+ +
+
+ connected_participants + repeated ConnectedParticipant + +
+ +
+ +
+
+ connected_mediators + repeated ConnectedMediator + +
+ +
+ +
+
+ sequencer + SequencerHealthStatus + +
+ +
required - status of the sequencer component it is running
+ +
+ +
+
+ physical_synchronizer_id + string + +
+ +
+ +
+
+ admin + SequencerAdminStatus + +
+ +
+ +
+
+ protocol_version + int32 + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ uid + string + +
+ +
+ +
+
+ uptime + Duration + +
+ +
+ +
+
+ ports + repeated map + +
+ +
+ +
+
+ active + bool + +
+ +
Indicate if the node is active, usually true unless it's a replicated node that is passive
+ +
+ +
+
+ topology_queues + TopologyQueueStatus + +
+ +
indicates the state of the topology queues (manager / dispatcher only where they exist)
+ +
+ +
+
+ components + repeated ComponentStatus + +
+ +
Health state of component dependencies of the node
+ +
+ +
+
+ version + string + +
+ +
Version of the binary
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ manager + uint32 + +
+ +
how many topology changes are currently queued at the manager
+ +
+ +
+
+ dispatcher + uint32 + +
+ +
how many topology changes are currently queued at the dispatcher
+ +
+ +
+
+ clients + uint32 + +
+ +
how many topology changes are currently waiting to become effective (across all connected synchronizers in the case of participants)
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ name + string + +
+ +
+ +
+
+ ok + StatusData + +
+ +
+ +
+
+ degraded + StatusData + +
+ +
+ +
+
+ failed + StatusData + +
+ +
+ +
+
+ fatal + StatusData + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ description + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ active + bool + +
+ +
is the sequencer component active - can vary by implementation for what this means
+ +
+ +
+
+ details + string + +
+ +
optionally set details on how sequencer is healthy/unhealthy
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ accepts_admin_changes + bool + +
+ +
Indicate if the sequencer node accepts administration changes, particularly relevant for HA sequencers where admin change ability is determined via active-passive model
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ active + bool + +
+ +
Indicate if the node is active, usually true unless it's a replicated node that is passive
+ +
+ +
+
+ waiting_for_external_input + WaitingForExternalInput + +
+ +
Indicates whether the node is waiting for external input
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • WAITING_FOR_EXTERNAL_INPUT_UNSPECIFIED
    • + +
  • WAITING_FOR_EXTERNAL_INPUT_ID
    • + +
  • WAITING_FOR_EXTERNAL_INPUT_NODE_TOPOLOGY
    • + +
  • WAITING_FOR_EXTERNAL_INPUT_INITIALIZATION
    • + +
+ + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-connection-v30/apiinfoservice/getapiinfo.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-connection-v30/apiinfoservice/getapiinfo.mdx new file mode 100644 index 0000000..35c5375 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-connection-v30/apiinfoservice/getapiinfo.mdx @@ -0,0 +1,276 @@ +--- +title: "GetApiInfo" +--- + +
+ + + + +
+ +

com.digitalasset.canton.connection.v30

+ + +

GetApiInfo

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.connection.v30.ApiInfoService/GetApiInfo + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.connection.v30.ApiInfoService/GetApiInfo <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "name": "string" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
ApiInfoService
+
+ +
+
RPC
+
GetApiInfo
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetApiInfoRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.connection.v30.GetApiInfoRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

GetApiInfoResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.connection.v30.GetApiInfoResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ name + string + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ name + string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/deletekeypair.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/deletekeypair.mdx new file mode 100644 index 0000000..c3ae143 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/deletekeypair.mdx @@ -0,0 +1,276 @@ +--- +title: "DeleteKeyPair" +--- + +
+ + + + +
+ +

com.digitalasset.canton.crypto.admin.v30

+ + +

DeleteKeyPair

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.crypto.admin.v30.VaultService/DeleteKeyPair + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.crypto.admin.v30.VaultService/DeleteKeyPair <<'EOF' +{ + "fingerprint": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
VaultService
+
+ +
+
RPC
+
DeleteKeyPair
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

DeleteKeyPairRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.crypto.admin.v30.DeleteKeyPairRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ fingerprint + string + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

DeleteKeyPairResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.crypto.admin.v30.DeleteKeyPairResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ fingerprint + string + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/exportkeypair.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/exportkeypair.mdx new file mode 100644 index 0000000..e1a7a38 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/exportkeypair.mdx @@ -0,0 +1,354 @@ +--- +title: "ExportKeyPair" +--- + +
+ + + + +
+ +

com.digitalasset.canton.crypto.admin.v30

+ + +

ExportKeyPair

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.crypto.admin.v30.VaultService/ExportKeyPair + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.crypto.admin.v30.VaultService/ExportKeyPair <<'EOF' +{ + "fingerprint": "string", + "protocolVersion": 0, + "password": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "keyPair": "BASE64_ENCODED_BYTES" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
VaultService
+
+ +
+
RPC
+
ExportKeyPair
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ExportKeyPairRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.crypto.admin.v30.ExportKeyPairRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ fingerprint + string + +
+ +
The id of the keypair to export
+ +
+ +
+
+ protocol_version + int32 + +
+ +
The protocol version that defines the serialization of the keypair
+ +
+ +
+
+ password + string + +
+ +
Optional password to use for encrypting the exported keypair NOTE: The request should be made over a TLS connection to this service
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ExportKeyPairResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.crypto.admin.v30.ExportKeyPairResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ key_pair + bytes + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ fingerprint + string + +
+ +
The id of the keypair to export
+ +
+ +
+
+ protocol_version + int32 + +
+ +
The protocol version that defines the serialization of the keypair
+ +
+ +
+
+ password + string + +
+ +
Optional password to use for encrypting the exported keypair NOTE: The request should be made over a TLS connection to this service
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ key_pair + bytes + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/generateencryptionkey.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/generateencryptionkey.mdx new file mode 100644 index 0000000..2bad0c0 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/generateencryptionkey.mdx @@ -0,0 +1,452 @@ +--- +title: "GenerateEncryptionKey" +--- + +
+ + + + +
+ +

com.digitalasset.canton.crypto.admin.v30

+ + +

GenerateEncryptionKey

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.crypto.admin.v30.VaultService/GenerateEncryptionKey + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.crypto.admin.v30.VaultService/GenerateEncryptionKey <<'EOF' +{ + "keySpec": "ENCRYPTION_KEY_SPEC_UNSPECIFIED", + "name": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "publicKey": { + "format": "CRYPTO_KEY_FORMAT_UNSPECIFIED", + "publicKey": "BASE64_ENCODED_BYTES", + "scheme": "ENCRYPTION_KEY_SCHEME_UNSPECIFIED", + "keySpec": "ENCRYPTION_KEY_SPEC_UNSPECIFIED" + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
VaultService
+
+ +
+
RPC
+
GenerateEncryptionKey
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GenerateEncryptionKeyRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.crypto.admin.v30.GenerateEncryptionKeyRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ key_spec + EncryptionKeySpec + +
+ +
+ +
+
+ name + string + +
+ +
optional descriptive name for the key
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

GenerateEncryptionKeyResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.crypto.admin.v30.GenerateEncryptionKeyResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ public_key + EncryptionPublicKey + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ key_spec + EncryptionKeySpec + +
+ +
+ +
+
+ name + string + +
+ +
optional descriptive name for the key
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • ENCRYPTION_KEY_SPEC_UNSPECIFIED
    • + +
  • ENCRYPTION_KEY_SPEC_EC_P256
    • + +
  • ENCRYPTION_KEY_SPEC_RSA_2048
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ public_key + EncryptionPublicKey + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ format + CryptoKeyFormat + +
+ +
+ +
+
+ public_key + bytes + +
+ +
Serialized public key in the format specified above
+ +
+ +
+
+ scheme + EncryptionKeyScheme + +
+ +
No longer used (only kept for backwards compatibility) stores both the crypto key scheme and algorithm.
+ +
+ +
+
+ key_spec + EncryptionKeySpec + +
+ +
The key specification that was used to generate the key pair
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • CRYPTO_KEY_FORMAT_UNSPECIFIED
    • + +
  • CRYPTO_KEY_FORMAT_DER
    • + +
  • CRYPTO_KEY_FORMAT_RAW
    • + +
  • CRYPTO_KEY_FORMAT_DER_X509_SUBJECT_PUBLIC_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_DER_PKCS8_PRIVATE_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_SYMBOLIC
    • + +
+ + +
+ + + +
+ + + +
    + +
  • ENCRYPTION_KEY_SCHEME_UNSPECIFIED
    • + +
  • ENCRYPTION_KEY_SCHEME_ECIES_P256_HKDF_HMAC_SHA256_AES128GCM
    • + +
  • ENCRYPTION_KEY_SCHEME_ECIES_P256_HMAC_SHA256A_ES128CBC
    • + +
  • ENCRYPTION_KEY_SCHEME_RSA2048_OAEP_SHA256
    • + +
+ + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/generatesigningkey.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/generatesigningkey.mdx new file mode 100644 index 0000000..762d990 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/generatesigningkey.mdx @@ -0,0 +1,520 @@ +--- +title: "GenerateSigningKey" +--- + +
+ + + + +
+ +

com.digitalasset.canton.crypto.admin.v30

+ + +

GenerateSigningKey

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.crypto.admin.v30.VaultService/GenerateSigningKey + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.crypto.admin.v30.VaultService/GenerateSigningKey <<'EOF' +{ + "keySpec": "SIGNING_KEY_SPEC_UNSPECIFIED", + "name": "string", + "usage": [ + "SIGNING_KEY_USAGE_UNSPECIFIED" + ] +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "publicKey": { + "format": "CRYPTO_KEY_FORMAT_UNSPECIFIED", + "publicKey": "BASE64_ENCODED_BYTES", + "scheme": "SIGNING_KEY_SCHEME_UNSPECIFIED", + "usage": [ + "SIGNING_KEY_USAGE_UNSPECIFIED" + ], + "keySpec": "SIGNING_KEY_SPEC_UNSPECIFIED" + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
VaultService
+
+ +
+
RPC
+
GenerateSigningKey
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GenerateSigningKeyRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.crypto.admin.v30.GenerateSigningKeyRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ key_spec + SigningKeySpec + +
+ +
+ +
+
+ name + string + +
+ +
optional descriptive name for the key
+ +
+ +
+
+ usage + repeated SigningKeyUsage + +
+ +
key can only be used for the specified usage
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

GenerateSigningKeyResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.crypto.admin.v30.GenerateSigningKeyResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ public_key + SigningPublicKey + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ key_spec + SigningKeySpec + +
+ +
+ +
+
+ name + string + +
+ +
optional descriptive name for the key
+ +
+ +
+
+ usage + repeated SigningKeyUsage + +
+ +
key can only be used for the specified usage
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_SPEC_UNSPECIFIED
    • + +
  • SIGNING_KEY_SPEC_EC_CURVE25519
    • + +
  • SIGNING_KEY_SPEC_EC_P256
    • + +
  • SIGNING_KEY_SPEC_EC_P384
    • + +
  • SIGNING_KEY_SPEC_EC_SECP256K1
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_USAGE_UNSPECIFIED
    • + +
  • SIGNING_KEY_USAGE_NAMESPACE
    • + +
  • SIGNING_KEY_USAGE_IDENTITY_DELEGATION
    • + +
  • SIGNING_KEY_USAGE_SEQUENCER_AUTHENTICATION
    • + +
  • SIGNING_KEY_USAGE_PROTOCOL
    • + +
  • SIGNING_KEY_USAGE_PROOF_OF_OWNERSHIP
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ public_key + SigningPublicKey + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ format + CryptoKeyFormat + +
+ +
+ +
+
+ public_key + bytes + +
+ +
Serialized public key in the format specified above
+ +
+ +
+
+ scheme + SigningKeyScheme + +
+ +
No longer used (only kept for backwards compatibility) stores both the crypto key scheme and algorithm.
+ +
+ +
+
+ usage + repeated SigningKeyUsage + +
+ +
Explicitly state the key's intended use
+ +
+ +
+
+ key_spec + SigningKeySpec + +
+ +
The key specification that was used to generate the key pair
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • CRYPTO_KEY_FORMAT_UNSPECIFIED
    • + +
  • CRYPTO_KEY_FORMAT_DER
    • + +
  • CRYPTO_KEY_FORMAT_RAW
    • + +
  • CRYPTO_KEY_FORMAT_DER_X509_SUBJECT_PUBLIC_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_DER_PKCS8_PRIVATE_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_SYMBOLIC
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_SCHEME_UNSPECIFIED
    • + +
  • SIGNING_KEY_SCHEME_ED25519
    • + +
  • SIGNING_KEY_SCHEME_EC_DSA_P256
    • + +
  • SIGNING_KEY_SCHEME_EC_DSA_P384
    • + +
+ + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/getwrapperkeyid.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/getwrapperkeyid.mdx new file mode 100644 index 0000000..0025027 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/getwrapperkeyid.mdx @@ -0,0 +1,276 @@ +--- +title: "GetWrapperKeyId" +--- + +
+ + + + +
+ +

com.digitalasset.canton.crypto.admin.v30

+ + +

GetWrapperKeyId

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.crypto.admin.v30.VaultService/GetWrapperKeyId + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.crypto.admin.v30.VaultService/GetWrapperKeyId <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "wrapperKeyId": "string" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
VaultService
+
+ +
+
RPC
+
GetWrapperKeyId
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetWrapperKeyIdRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.crypto.admin.v30.GetWrapperKeyIdRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

GetWrapperKeyIdResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.crypto.admin.v30.GetWrapperKeyIdResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ wrapper_key_id + string + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ wrapper_key_id + string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/importkeypair.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/importkeypair.mdx new file mode 100644 index 0000000..3a547b9 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/importkeypair.mdx @@ -0,0 +1,318 @@ +--- +title: "ImportKeyPair" +--- + +
+ + + + +
+ +

com.digitalasset.canton.crypto.admin.v30

+ + +

ImportKeyPair

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.crypto.admin.v30.VaultService/ImportKeyPair + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.crypto.admin.v30.VaultService/ImportKeyPair <<'EOF' +{ + "keyPair": "BASE64_ENCODED_BYTES", + "name": "string", + "password": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
VaultService
+
+ +
+
RPC
+
ImportKeyPair
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ImportKeyPairRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.crypto.admin.v30.ImportKeyPairRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ key_pair + bytes + +
+ +
+ +
+
+ name + string + +
+ +
+ +
+
+ password + string + +
+ +
Optional password to use for decrypting the exported keypair NOTE: The request should be made over a TLS connection to this service
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ImportKeyPairResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.crypto.admin.v30.ImportKeyPairResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ key_pair + bytes + +
+ +
+ +
+
+ name + string + +
+ +
+ +
+
+ password + string + +
+ +
Optional password to use for decrypting the exported keypair NOTE: The request should be made over a TLS connection to this service
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/importpublickey.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/importpublickey.mdx new file mode 100644 index 0000000..e4066da --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/importpublickey.mdx @@ -0,0 +1,335 @@ +--- +title: "ImportPublicKey" +--- + +
+ + + + +
+ +

com.digitalasset.canton.crypto.admin.v30

+ + +

ImportPublicKey

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.crypto.admin.v30.VaultService/ImportPublicKey + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.crypto.admin.v30.VaultService/ImportPublicKey <<'EOF' +{ + "publicKey": "BASE64_ENCODED_BYTES", + "name": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "fingerprint": "string" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
VaultService
+
+ +
+
RPC
+
ImportPublicKey
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ImportPublicKeyRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.crypto.admin.v30.ImportPublicKeyRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ public_key + bytes + +
+ +
import a crypto.PublicKey protobuf serialized key
+ +
+ +
+
+ name + string + +
+ +
an optional name that should be stored along side the key
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ImportPublicKeyResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.crypto.admin.v30.ImportPublicKeyResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ fingerprint + string + +
+ +
fingerprint of imported key
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ public_key + bytes + +
+ +
import a crypto.PublicKey protobuf serialized key
+ +
+ +
+
+ name + string + +
+ +
an optional name that should be stored along side the key
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ fingerprint + string + +
+ +
fingerprint of imported key
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/listmykeys.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/listmykeys.mdx new file mode 100644 index 0000000..e1f210e --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/listmykeys.mdx @@ -0,0 +1,763 @@ +--- +title: "ListMyKeys" +--- + +
+ + + + +
+ +

com.digitalasset.canton.crypto.admin.v30

+ + +

ListMyKeys

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.crypto.admin.v30.VaultService/ListMyKeys + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.crypto.admin.v30.VaultService/ListMyKeys <<'EOF' +{ + "filters": { + "fingerprint": "string", + "name": "string", + "purpose": [ + "KEY_PURPOSE_UNSPECIFIED" + ], + "usage": [ + "SIGNING_KEY_USAGE_UNSPECIFIED" + ] + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "privateKeysMetadata": [ + { + "publicKeyWithName": { + "publicKey": { + "signingPublicKey": {} + }, + "name": "string" + }, + "wrapperKeyId": "string", + "kmsKeyId": "string" + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
VaultService
+
+ +
+
RPC
+
ListMyKeys
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ListMyKeysRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.crypto.admin.v30.ListMyKeysRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ filters + ListKeysFilters + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ListMyKeysResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.crypto.admin.v30.ListMyKeysResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ private_keys_metadata + repeated PrivateKeyMetadata + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ filters + ListKeysFilters + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ fingerprint + string + +
+ +
the substring that needs to match a given fingerprint
+ +
+ +
+
+ name + string + +
+ +
the substring to filter the name
+ +
+ +
+
+ purpose + repeated KeyPurpose + +
+ +
filter on public key purpose
+ +
+ +
+
+ usage + repeated SigningKeyUsage + +
+ +
filter on signing public key usage
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • KEY_PURPOSE_UNSPECIFIED
    • + +
  • KEY_PURPOSE_SIGNING
    • + +
  • KEY_PURPOSE_ENCRYPTION
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_USAGE_UNSPECIFIED
    • + +
  • SIGNING_KEY_USAGE_NAMESPACE
    • + +
  • SIGNING_KEY_USAGE_IDENTITY_DELEGATION
    • + +
  • SIGNING_KEY_USAGE_SEQUENCER_AUTHENTICATION
    • + +
  • SIGNING_KEY_USAGE_PROTOCOL
    • + +
  • SIGNING_KEY_USAGE_PROOF_OF_OWNERSHIP
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ private_keys_metadata + repeated PrivateKeyMetadata + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ public_key_with_name + PublicKeyWithName + +
+ +
+ +
+
+ wrapper_key_id + string + +
+ +
If set the private key is stored encrypted by the wrapper key
+ +
+ +
+
+ kms_key_id + string + +
+ +
Set if the private key is stored in a KMS
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ public_key + PublicKey + +
+ +
+ +
+
+ name + string + +
+ +
Optional name of the public key
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ signing_public_key + SigningPublicKey + +
+ +
+ +
+
+ encryption_public_key + EncryptionPublicKey + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ format + CryptoKeyFormat + +
+ +
+ +
+
+ public_key + bytes + +
+ +
Serialized public key in the format specified above
+ +
+ +
+
+ scheme + SigningKeyScheme + +
+ +
No longer used (only kept for backwards compatibility) stores both the crypto key scheme and algorithm.
+ +
+ +
+
+ usage + repeated SigningKeyUsage + +
+ +
Explicitly state the key's intended use
+ +
+ +
+
+ key_spec + SigningKeySpec + +
+ +
The key specification that was used to generate the key pair
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • CRYPTO_KEY_FORMAT_UNSPECIFIED
    • + +
  • CRYPTO_KEY_FORMAT_DER
    • + +
  • CRYPTO_KEY_FORMAT_RAW
    • + +
  • CRYPTO_KEY_FORMAT_DER_X509_SUBJECT_PUBLIC_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_DER_PKCS8_PRIVATE_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_SYMBOLIC
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_SCHEME_UNSPECIFIED
    • + +
  • SIGNING_KEY_SCHEME_ED25519
    • + +
  • SIGNING_KEY_SCHEME_EC_DSA_P256
    • + +
  • SIGNING_KEY_SCHEME_EC_DSA_P384
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_SPEC_UNSPECIFIED
    • + +
  • SIGNING_KEY_SPEC_EC_CURVE25519
    • + +
  • SIGNING_KEY_SPEC_EC_P256
    • + +
  • SIGNING_KEY_SPEC_EC_P384
    • + +
  • SIGNING_KEY_SPEC_EC_SECP256K1
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ format + CryptoKeyFormat + +
+ +
+ +
+
+ public_key + bytes + +
+ +
Serialized public key in the format specified above
+ +
+ +
+
+ scheme + EncryptionKeyScheme + +
+ +
No longer used (only kept for backwards compatibility) stores both the crypto key scheme and algorithm.
+ +
+ +
+
+ key_spec + EncryptionKeySpec + +
+ +
The key specification that was used to generate the key pair
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • ENCRYPTION_KEY_SCHEME_UNSPECIFIED
    • + +
  • ENCRYPTION_KEY_SCHEME_ECIES_P256_HKDF_HMAC_SHA256_AES128GCM
    • + +
  • ENCRYPTION_KEY_SCHEME_ECIES_P256_HMAC_SHA256A_ES128CBC
    • + +
  • ENCRYPTION_KEY_SCHEME_RSA2048_OAEP_SHA256
    • + +
+ + +
+ + + +
+ + + +
    + +
  • ENCRYPTION_KEY_SPEC_UNSPECIFIED
    • + +
  • ENCRYPTION_KEY_SPEC_EC_P256
    • + +
  • ENCRYPTION_KEY_SPEC_RSA_2048
    • + +
+ + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/listpublickeys.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/listpublickeys.mdx new file mode 100644 index 0000000..952027d --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/listpublickeys.mdx @@ -0,0 +1,723 @@ +--- +title: "ListPublicKeys" +--- + +
+ + + + +
+ +

com.digitalasset.canton.crypto.admin.v30

+ + +

ListPublicKeys

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.crypto.admin.v30.VaultService/ListPublicKeys + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.crypto.admin.v30.VaultService/ListPublicKeys <<'EOF' +{ + "filters": { + "fingerprint": "string", + "name": "string", + "purpose": [ + "KEY_PURPOSE_UNSPECIFIED" + ], + "usage": [ + "SIGNING_KEY_USAGE_UNSPECIFIED" + ] + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "publicKeys": [ + { + "publicKey": { + "signingPublicKey": { + "format": "CRYPTO_KEY_FORMAT_UNSPECIFIED", + "publicKey": "BASE64_ENCODED_BYTES", + "scheme": "SIGNING_KEY_SCHEME_UNSPECIFIED", + "usage": [ + "SIGNING_KEY_USAGE_UNSPECIFIED" + ], + "keySpec": "SIGNING_KEY_SPEC_UNSPECIFIED" + } + }, + "name": "string" + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
VaultService
+
+ +
+
RPC
+
ListPublicKeys
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ListPublicKeysRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.crypto.admin.v30.ListPublicKeysRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ filters + ListKeysFilters + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ListPublicKeysResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.crypto.admin.v30.ListPublicKeysResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ public_keys + repeated PublicKeyWithName + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ filters + ListKeysFilters + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ fingerprint + string + +
+ +
the substring that needs to match a given fingerprint
+ +
+ +
+
+ name + string + +
+ +
the substring to filter the name
+ +
+ +
+
+ purpose + repeated KeyPurpose + +
+ +
filter on public key purpose
+ +
+ +
+
+ usage + repeated SigningKeyUsage + +
+ +
filter on signing public key usage
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • KEY_PURPOSE_UNSPECIFIED
    • + +
  • KEY_PURPOSE_SIGNING
    • + +
  • KEY_PURPOSE_ENCRYPTION
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_USAGE_UNSPECIFIED
    • + +
  • SIGNING_KEY_USAGE_NAMESPACE
    • + +
  • SIGNING_KEY_USAGE_IDENTITY_DELEGATION
    • + +
  • SIGNING_KEY_USAGE_SEQUENCER_AUTHENTICATION
    • + +
  • SIGNING_KEY_USAGE_PROTOCOL
    • + +
  • SIGNING_KEY_USAGE_PROOF_OF_OWNERSHIP
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ public_keys + repeated PublicKeyWithName + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ public_key + PublicKey + +
+ +
+ +
+
+ name + string + +
+ +
Optional name of the public key
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ signing_public_key + SigningPublicKey + +
+ +
+ +
+
+ encryption_public_key + EncryptionPublicKey + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ format + CryptoKeyFormat + +
+ +
+ +
+
+ public_key + bytes + +
+ +
Serialized public key in the format specified above
+ +
+ +
+
+ scheme + SigningKeyScheme + +
+ +
No longer used (only kept for backwards compatibility) stores both the crypto key scheme and algorithm.
+ +
+ +
+
+ usage + repeated SigningKeyUsage + +
+ +
Explicitly state the key's intended use
+ +
+ +
+
+ key_spec + SigningKeySpec + +
+ +
The key specification that was used to generate the key pair
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • CRYPTO_KEY_FORMAT_UNSPECIFIED
    • + +
  • CRYPTO_KEY_FORMAT_DER
    • + +
  • CRYPTO_KEY_FORMAT_RAW
    • + +
  • CRYPTO_KEY_FORMAT_DER_X509_SUBJECT_PUBLIC_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_DER_PKCS8_PRIVATE_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_SYMBOLIC
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_SCHEME_UNSPECIFIED
    • + +
  • SIGNING_KEY_SCHEME_ED25519
    • + +
  • SIGNING_KEY_SCHEME_EC_DSA_P256
    • + +
  • SIGNING_KEY_SCHEME_EC_DSA_P384
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_SPEC_UNSPECIFIED
    • + +
  • SIGNING_KEY_SPEC_EC_CURVE25519
    • + +
  • SIGNING_KEY_SPEC_EC_P256
    • + +
  • SIGNING_KEY_SPEC_EC_P384
    • + +
  • SIGNING_KEY_SPEC_EC_SECP256K1
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ format + CryptoKeyFormat + +
+ +
+ +
+
+ public_key + bytes + +
+ +
Serialized public key in the format specified above
+ +
+ +
+
+ scheme + EncryptionKeyScheme + +
+ +
No longer used (only kept for backwards compatibility) stores both the crypto key scheme and algorithm.
+ +
+ +
+
+ key_spec + EncryptionKeySpec + +
+ +
The key specification that was used to generate the key pair
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • ENCRYPTION_KEY_SCHEME_UNSPECIFIED
    • + +
  • ENCRYPTION_KEY_SCHEME_ECIES_P256_HKDF_HMAC_SHA256_AES128GCM
    • + +
  • ENCRYPTION_KEY_SCHEME_ECIES_P256_HMAC_SHA256A_ES128CBC
    • + +
  • ENCRYPTION_KEY_SCHEME_RSA2048_OAEP_SHA256
    • + +
+ + +
+ + + +
+ + + +
    + +
  • ENCRYPTION_KEY_SPEC_UNSPECIFIED
    • + +
  • ENCRYPTION_KEY_SPEC_EC_P256
    • + +
  • ENCRYPTION_KEY_SPEC_RSA_2048
    • + +
+ + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/registerkmsencryptionkey.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/registerkmsencryptionkey.mdx new file mode 100644 index 0000000..1894408 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/registerkmsencryptionkey.mdx @@ -0,0 +1,452 @@ +--- +title: "RegisterKmsEncryptionKey" +--- + +
+ + + + +
+ +

com.digitalasset.canton.crypto.admin.v30

+ + +

RegisterKmsEncryptionKey

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.crypto.admin.v30.VaultService/RegisterKmsEncryptionKey + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.crypto.admin.v30.VaultService/RegisterKmsEncryptionKey <<'EOF' +{ + "kmsKeyId": "string", + "name": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "publicKey": { + "format": "CRYPTO_KEY_FORMAT_UNSPECIFIED", + "publicKey": "BASE64_ENCODED_BYTES", + "scheme": "ENCRYPTION_KEY_SCHEME_UNSPECIFIED", + "keySpec": "ENCRYPTION_KEY_SPEC_UNSPECIFIED" + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
VaultService
+
+ +
+
RPC
+
RegisterKmsEncryptionKey
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

RegisterKmsEncryptionKeyRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.crypto.admin.v30.RegisterKmsEncryptionKeyRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ kms_key_id + string + +
+ +
+ +
+
+ name + string + +
+ +
optional descriptive name for the key
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

RegisterKmsEncryptionKeyResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.crypto.admin.v30.RegisterKmsEncryptionKeyResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ public_key + EncryptionPublicKey + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ kms_key_id + string + +
+ +
+ +
+
+ name + string + +
+ +
optional descriptive name for the key
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ public_key + EncryptionPublicKey + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ format + CryptoKeyFormat + +
+ +
+ +
+
+ public_key + bytes + +
+ +
Serialized public key in the format specified above
+ +
+ +
+
+ scheme + EncryptionKeyScheme + +
+ +
No longer used (only kept for backwards compatibility) stores both the crypto key scheme and algorithm.
+ +
+ +
+
+ key_spec + EncryptionKeySpec + +
+ +
The key specification that was used to generate the key pair
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • CRYPTO_KEY_FORMAT_UNSPECIFIED
    • + +
  • CRYPTO_KEY_FORMAT_DER
    • + +
  • CRYPTO_KEY_FORMAT_RAW
    • + +
  • CRYPTO_KEY_FORMAT_DER_X509_SUBJECT_PUBLIC_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_DER_PKCS8_PRIVATE_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_SYMBOLIC
    • + +
+ + +
+ + + +
+ + + +
    + +
  • ENCRYPTION_KEY_SCHEME_UNSPECIFIED
    • + +
  • ENCRYPTION_KEY_SCHEME_ECIES_P256_HKDF_HMAC_SHA256_AES128GCM
    • + +
  • ENCRYPTION_KEY_SCHEME_ECIES_P256_HMAC_SHA256A_ES128CBC
    • + +
  • ENCRYPTION_KEY_SCHEME_RSA2048_OAEP_SHA256
    • + +
+ + +
+ + + +
+ + + +
    + +
  • ENCRYPTION_KEY_SPEC_UNSPECIFIED
    • + +
  • ENCRYPTION_KEY_SPEC_EC_P256
    • + +
  • ENCRYPTION_KEY_SPEC_RSA_2048
    • + +
+ + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/registerkmssigningkey.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/registerkmssigningkey.mdx new file mode 100644 index 0000000..047b225 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/registerkmssigningkey.mdx @@ -0,0 +1,520 @@ +--- +title: "RegisterKmsSigningKey" +--- + +
+ + + + +
+ +

com.digitalasset.canton.crypto.admin.v30

+ + +

RegisterKmsSigningKey

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.crypto.admin.v30.VaultService/RegisterKmsSigningKey + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.crypto.admin.v30.VaultService/RegisterKmsSigningKey <<'EOF' +{ + "kmsKeyId": "string", + "name": "string", + "usage": [ + "SIGNING_KEY_USAGE_UNSPECIFIED" + ] +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "publicKey": { + "format": "CRYPTO_KEY_FORMAT_UNSPECIFIED", + "publicKey": "BASE64_ENCODED_BYTES", + "scheme": "SIGNING_KEY_SCHEME_UNSPECIFIED", + "usage": [ + "SIGNING_KEY_USAGE_UNSPECIFIED" + ], + "keySpec": "SIGNING_KEY_SPEC_UNSPECIFIED" + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
VaultService
+
+ +
+
RPC
+
RegisterKmsSigningKey
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

RegisterKmsSigningKeyRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.crypto.admin.v30.RegisterKmsSigningKeyRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ kms_key_id + string + +
+ +
+ +
+
+ name + string + +
+ +
optional descriptive name for the key
+ +
+ +
+
+ usage + repeated SigningKeyUsage + +
+ +
key can only be used for the specified usage
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

RegisterKmsSigningKeyResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.crypto.admin.v30.RegisterKmsSigningKeyResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ public_key + SigningPublicKey + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ kms_key_id + string + +
+ +
+ +
+
+ name + string + +
+ +
optional descriptive name for the key
+ +
+ +
+
+ usage + repeated SigningKeyUsage + +
+ +
key can only be used for the specified usage
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_USAGE_UNSPECIFIED
    • + +
  • SIGNING_KEY_USAGE_NAMESPACE
    • + +
  • SIGNING_KEY_USAGE_IDENTITY_DELEGATION
    • + +
  • SIGNING_KEY_USAGE_SEQUENCER_AUTHENTICATION
    • + +
  • SIGNING_KEY_USAGE_PROTOCOL
    • + +
  • SIGNING_KEY_USAGE_PROOF_OF_OWNERSHIP
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ public_key + SigningPublicKey + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ format + CryptoKeyFormat + +
+ +
+ +
+
+ public_key + bytes + +
+ +
Serialized public key in the format specified above
+ +
+ +
+
+ scheme + SigningKeyScheme + +
+ +
No longer used (only kept for backwards compatibility) stores both the crypto key scheme and algorithm.
+ +
+ +
+
+ usage + repeated SigningKeyUsage + +
+ +
Explicitly state the key's intended use
+ +
+ +
+
+ key_spec + SigningKeySpec + +
+ +
The key specification that was used to generate the key pair
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • CRYPTO_KEY_FORMAT_UNSPECIFIED
    • + +
  • CRYPTO_KEY_FORMAT_DER
    • + +
  • CRYPTO_KEY_FORMAT_RAW
    • + +
  • CRYPTO_KEY_FORMAT_DER_X509_SUBJECT_PUBLIC_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_DER_PKCS8_PRIVATE_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_SYMBOLIC
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_SCHEME_UNSPECIFIED
    • + +
  • SIGNING_KEY_SCHEME_ED25519
    • + +
  • SIGNING_KEY_SCHEME_EC_DSA_P256
    • + +
  • SIGNING_KEY_SCHEME_EC_DSA_P384
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_SPEC_UNSPECIFIED
    • + +
  • SIGNING_KEY_SPEC_EC_CURVE25519
    • + +
  • SIGNING_KEY_SPEC_EC_P256
    • + +
  • SIGNING_KEY_SPEC_EC_P384
    • + +
  • SIGNING_KEY_SPEC_EC_SECP256K1
    • + +
+ + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/rotatewrapperkey.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/rotatewrapperkey.mdx new file mode 100644 index 0000000..17bac49 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/rotatewrapperkey.mdx @@ -0,0 +1,276 @@ +--- +title: "RotateWrapperKey" +--- + +
+ + + + +
+ +

com.digitalasset.canton.crypto.admin.v30

+ + +

RotateWrapperKey

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.crypto.admin.v30.VaultService/RotateWrapperKey + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.crypto.admin.v30.VaultService/RotateWrapperKey <<'EOF' +{ + "newWrapperKeyId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
VaultService
+
+ +
+
RPC
+
RotateWrapperKey
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

RotateWrapperKeyRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.crypto.admin.v30.RotateWrapperKeyRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ new_wrapper_key_id + string + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

RotateWrapperKeyResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.crypto.admin.v30.RotateWrapperKeyResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ new_wrapper_key_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/clearschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/clearschedule.mdx new file mode 100644 index 0000000..37cf265 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/clearschedule.mdx @@ -0,0 +1,248 @@ +--- +title: "ClearSchedule" +--- + +
+ + + + +
+ +

com.digitalasset.canton.mediator.admin.v30

+ + +

ClearSchedule

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.mediator.admin.v30.MediatorAdministrationService/ClearSchedule + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.mediator.admin.v30.MediatorAdministrationService/ClearSchedule <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
MediatorAdministrationService
+
+ +
+
RPC
+
ClearSchedule
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ClearScheduleRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.ClearScheduleRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

ClearScheduleResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.ClearScheduleResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/findpruningtimestamp.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/findpruningtimestamp.mdx new file mode 100644 index 0000000..bd766e2 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/findpruningtimestamp.mdx @@ -0,0 +1,312 @@ +--- +title: "FindPruningTimestamp" +--- + +
+ + + + +
+ +

com.digitalasset.canton.mediator.admin.v30

+ + +

FindPruningTimestamp

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.mediator.admin.v30.MediatorAdministrationService/FindPruningTimestamp + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.mediator.admin.v30.MediatorAdministrationService/FindPruningTimestamp <<'EOF' +{ + "index": 0 +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "timestamp": "string" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
MediatorAdministrationService
+
+ +
+
RPC
+
FindPruningTimestamp
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

FindPruningTimestampRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.FindPruningTimestampRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ index + int32 + +
+ +
the index to look up the offset for, needs to be 1 or larger i.e. 1 for returning the first timestamp, 2 for the second timestamp etc
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

FindPruningTimestampResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.FindPruningTimestampResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ timestamp + Timestamp + +
+ +
optional, not set if less than `index` events exist
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ index + int32 + +
+ +
the index to look up the offset for, needs to be 1 or larger i.e. 1 for returning the first timestamp, 2 for the second timestamp etc
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ timestamp + Timestamp + +
+ +
optional, not set if less than `index` events exist
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/getschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/getschedule.mdx new file mode 100644 index 0000000..9bcbb1d --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/getschedule.mdx @@ -0,0 +1,320 @@ +--- +title: "GetSchedule" +--- + +
+ + + + +
+ +

com.digitalasset.canton.mediator.admin.v30

+ + +

GetSchedule

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.mediator.admin.v30.MediatorAdministrationService/GetSchedule + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.mediator.admin.v30.MediatorAdministrationService/GetSchedule <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "schedule": { + "cron": "string", + "maxDuration": "string", + "retention": "string" + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
MediatorAdministrationService
+
+ +
+
RPC
+
GetSchedule
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetScheduleRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.GetScheduleRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

GetScheduleResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.GetScheduleResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ schedule + PruningSchedule + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ schedule + PruningSchedule + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ cron + string + +
+ +
+ +
+
+ max_duration + Duration + +
+ +
+ +
+
+ retention + Duration + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/prune.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/prune.mdx new file mode 100644 index 0000000..7c79ea3 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/prune.mdx @@ -0,0 +1,280 @@ +--- +title: "Prune" +--- + +
+ + + + +
+ +

com.digitalasset.canton.mediator.admin.v30

+ + +

Prune

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.mediator.admin.v30.MediatorAdministrationService/Prune + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.mediator.admin.v30.MediatorAdministrationService/Prune <<'EOF' +{ + "timestamp": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
MediatorAdministrationService
+
+ +
+
RPC
+
Prune
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

PruneRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.mediator.admin.v30.MediatorPruning.PruneRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ timestamp + Timestamp + +
+ +
timestamp to prune for
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

PruneResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.mediator.admin.v30.MediatorPruning.PruneResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ timestamp + Timestamp + +
+ +
timestamp to prune for
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setcron.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setcron.mdx new file mode 100644 index 0000000..9f0e069 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setcron.mdx @@ -0,0 +1,276 @@ +--- +title: "SetCron" +--- + +
+ + + + +
+ +

com.digitalasset.canton.mediator.admin.v30

+ + +

SetCron

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.mediator.admin.v30.MediatorAdministrationService/SetCron + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.mediator.admin.v30.MediatorAdministrationService/SetCron <<'EOF' +{ + "cron": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
MediatorAdministrationService
+
+ +
+
RPC
+
SetCron
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

SetCronRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.SetCronRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ cron + string + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

SetCronResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.SetCronResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ cron + string + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setmaxduration.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setmaxduration.mdx new file mode 100644 index 0000000..8626b7e --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setmaxduration.mdx @@ -0,0 +1,276 @@ +--- +title: "SetMaxDuration" +--- + +
+ + + + +
+ +

com.digitalasset.canton.mediator.admin.v30

+ + +

SetMaxDuration

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.mediator.admin.v30.MediatorAdministrationService/SetMaxDuration + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.mediator.admin.v30.MediatorAdministrationService/SetMaxDuration <<'EOF' +{ + "maxDuration": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
MediatorAdministrationService
+
+ +
+
RPC
+
SetMaxDuration
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

SetMaxDurationRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.SetMaxDurationRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ max_duration + Duration + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

SetMaxDurationResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.SetMaxDurationResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ max_duration + Duration + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setretention.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setretention.mdx new file mode 100644 index 0000000..ca6f3cd --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setretention.mdx @@ -0,0 +1,276 @@ +--- +title: "SetRetention" +--- + +
+ + + + +
+ +

com.digitalasset.canton.mediator.admin.v30

+ + +

SetRetention

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.mediator.admin.v30.MediatorAdministrationService/SetRetention + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.mediator.admin.v30.MediatorAdministrationService/SetRetention <<'EOF' +{ + "retention": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
MediatorAdministrationService
+
+ +
+
RPC
+
SetRetention
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

SetRetentionRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.SetRetentionRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ retention + Duration + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

SetRetentionResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.SetRetentionResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ retention + Duration + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setschedule.mdx new file mode 100644 index 0000000..250c539 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setschedule.mdx @@ -0,0 +1,320 @@ +--- +title: "SetSchedule" +--- + +
+ + + + +
+ +

com.digitalasset.canton.mediator.admin.v30

+ + +

SetSchedule

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.mediator.admin.v30.MediatorAdministrationService/SetSchedule + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.mediator.admin.v30.MediatorAdministrationService/SetSchedule <<'EOF' +{ + "schedule": { + "cron": "string", + "maxDuration": "string", + "retention": "string" + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
MediatorAdministrationService
+
+ +
+
RPC
+
SetSchedule
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

SetScheduleRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.SetScheduleRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ schedule + PruningSchedule + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

SetScheduleResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.SetScheduleResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ schedule + PruningSchedule + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ cron + string + +
+ +
+ +
+
+ max_duration + Duration + +
+ +
+ +
+
+ retention + Duration + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatorinitializationservice/initializemediator.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatorinitializationservice/initializemediator.mdx new file mode 100644 index 0000000..8d8e410 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatorinitializationservice/initializemediator.mdx @@ -0,0 +1,617 @@ +--- +title: "InitializeMediator" +--- + +
+ + + + +
+ +

com.digitalasset.canton.mediator.admin.v30

+ + +

InitializeMediator

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.mediator.admin.v30.MediatorInitializationService/InitializeMediator + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.mediator.admin.v30.MediatorInitializationService/InitializeMediator <<'EOF' +{ + "physicalSynchronizerId": "string", + "sequencerConnections": { + "sequencerConnections": [ + { + "grpc": { + "connections": [ + "string" + ], + "transportSecurity": true, + "customTrustCertificates": "BASE64_ENCODED_BYTES" + }, + "alias": "string", + "sequencerId": "string" + } + ], + "sequencerTrustThreshold": 0, + "submissionRequestAmplification": { + "factor": 0, + "patience": "string" + }, + "sequencerLivenessMargin": 0, + "sequencerConnectionPoolDelays": { + "minRestartDelay": "string", + "maxRestartDelay": "string", + "subscriptionRequestDelay": "string", + "warnValidationDelay": "string" + } + }, + "sequencerConnectionValidation": "SEQUENCER_CONNECTION_VALIDATION_UNSPECIFIED" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
MediatorInitializationService
+
+ +
+
RPC
+
InitializeMediator
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

InitializeMediatorRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.mediator.admin.v30.InitializeMediatorRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ physical_synchronizer_id + string + +
+ +
the synchronizer identifier
+ +
+ +
+
+ sequencer_connections + SequencerConnections + +
+ +
how should the member connect to the synchronizer sequencer
+ +
+ +
+
+ sequencer_connection_validation + SequencerConnectionValidation + +
+ +
how strictly we should validate the connection to the sequencer
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

InitializeMediatorResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.mediator.admin.v30.InitializeMediatorResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ physical_synchronizer_id + string + +
+ +
the synchronizer identifier
+ +
+ +
+
+ sequencer_connections + SequencerConnections + +
+ +
how should the member connect to the synchronizer sequencer
+ +
+ +
+
+ sequencer_connection_validation + SequencerConnectionValidation + +
+ +
how strictly we should validate the connection to the sequencer
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ sequencer_connections + repeated SequencerConnection + +
+ +
+ +
+
+ sequencer_trust_threshold + uint32 + +
+ +
This field determines the minimum level of agreement, or consensus, required among the sequencers before a message is considered reliable and accepted by the system. This value must be positive.
+ +
+ +
+
+ submission_request_amplification + SubmissionRequestAmplification + +
+ +
+ +
+
+ sequencer_liveness_margin + uint32 + +
+ +
This field determines the number of extra subscriptions to maintain beyond `sequencer_trust_threshold` in order to ensure liveness. This is only used when the new connection pool is enabled, and is ignored otherwise. This value must be non-negative.
+ +
+ +
+
+ sequencer_connection_pool_delays + SequencerConnectionPoolDelays + +
+ +
Configures the various delays used by the sequencer connection pool.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ grpc + Grpc + +
+ +
+ +
+
+ alias + string + +
+ +
+ +
+
+ sequencer_id + string + +
+ +
The id of the sequencer that serves the sequencer API. If empty, the node sets it after the first connection. If set, the node checks that the sequencer id reported by the sequencer matches this id.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ connections + repeated string + +
+ +
connection information to sequencer (http[s]://<host>:<port>")
+ +
+ +
+
+ transport_security + bool + +
+ +
Should the connection use TLS?
+ +
+ +
+
+ custom_trust_certificates + bytes + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ factor + uint32 + +
+ +
Determines to how often the client should try to send a submission request that is eligible for deduplication. A higher value increases the chance of a submission request being accepted by the system, but also increases the load on the sequencers and thus the costs incurred by the client. This value must be positive.
+ +
+ +
+
+ patience + Duration + +
+ +
Determines how long the sequencer client waits for observing the sequencing before it sends the submission request again. This value must be non-negative.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ min_restart_delay + Duration + +
+ +
Minimum duration after which a failed sequencer connection is restarted. This value must be non-negative.
+ +
+ +
+
+ max_restart_delay + Duration + +
+ +
Maximum duration after which a failed sequencer connection is restarted. This value must be non-negative.
+ +
+ +
+
+ subscription_request_delay + Duration + +
+ +
Delay between the attempts to obtain new sequencer connections for the sequencer subscription pool, when the current number of subscriptions is below `trustThreshold` + `livenessMargin`. This value must be non-negative.
+ +
+ +
+
+ warn_validation_delay + Duration + +
+ +
Duration after which a warning is issued if a started connection still fails validation. This value must be non-negative.
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • SEQUENCER_CONNECTION_VALIDATION_UNSPECIFIED
    • + +
  • SEQUENCER_CONNECTION_VALIDATION_DISABLED
    • + +
  • SEQUENCER_CONNECTION_VALIDATION_ACTIVE
    • + +
  • SEQUENCER_CONNECTION_VALIDATION_ALL
    • + +
  • SEQUENCER_CONNECTION_VALIDATION_THRESHOLD_ACTIVE
    • + +
+ + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatorinspectionservice/verdicts.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatorinspectionservice/verdicts.mdx new file mode 100644 index 0000000..2046512 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatorinspectionservice/verdicts.mdx @@ -0,0 +1,480 @@ +--- +title: "Verdicts" +--- + +
+ + + + +
+ +

com.digitalasset.canton.mediator.admin.v30

+ + +

Verdicts

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.mediator.admin.v30.MediatorInspectionService/Verdicts + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.mediator.admin.v30.MediatorInspectionService/Verdicts <<'EOF' +{ + "mostRecentlyReceivedRecordTime": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "verdict": { + "submittingParties": [ + "string" + ], + "submittingParticipantUid": "string", + "verdict": "VERDICT_RESULT_UNSPECIFIED", + "finalizationTime": "string", + "recordTime": "string", + "mediatorGroup": 0, + "transactionViews": { + "views": [ + { + "key": { + "informees": [ + "string" + ], + "confirmingParties": [ + {} + ], + "subViews": [ + 0 + ] + } + } + ], + "rootViews": [ + 0 + ] + }, + "updateId": "string" + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
MediatorInspectionService
+
+ +
+
RPC
+
Verdicts
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
Yes
+
+ +
+ + +## Inputs + + +
+
+

VerdictsRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.mediator.admin.v30.VerdictsRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ most_recently_received_record_time + Timestamp + +
+ +
Optional: The record_time_of_request of the most recently received verdict. If not provided, the mediator will return verdicts from the beginning.
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

VerdictsResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.mediator.admin.v30.VerdictsResponse
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + +
+ +
+
+ verdict + Verdict + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ most_recently_received_record_time + Timestamp + +
+ +
Optional: The record_time_of_request of the most recently received verdict. If not provided, the mediator will return verdicts from the beginning.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ verdict + Verdict + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ submitting_parties + repeated string + +
+ +
+ +
+
+ submitting_participant_uid + string + +
+ +
+ +
+
+ verdict + VerdictResult + +
+ +
+ +
+
+ finalization_time + Timestamp + +
+ +
the time of the finalization of the verdict, i.e.: - the nth response required to finalize the verdict - the participant response deadline in case the request timed out
+ +
+ +
+
+ record_time + Timestamp + +
+ +
record time of the request
+ +
+ +
+
+ mediator_group + uint32 + +
+ +
the mediator group of the mediator
+ +
+ +
+
+ transaction_views + TransactionViews + +
+ +
+ +
+
+ update_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • VERDICT_RESULT_UNSPECIFIED
    • + +
  • VERDICT_RESULT_ACCEPTED
    • + +
  • VERDICT_RESULT_REJECTED
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ views + repeated map + +
+ +
+ +
+
+ root_views + repeated int32 + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/sequencerconnectionservice/getconnection.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/sequencerconnectionservice/getconnection.mdx new file mode 100644 index 0000000..8682017 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/sequencerconnectionservice/getconnection.mdx @@ -0,0 +1,548 @@ +--- +title: "GetConnection" +--- + +
+ + + + +
+ +

com.digitalasset.canton.mediator.admin.v30

+ + +

GetConnection

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.mediator.admin.v30.SequencerConnectionService/GetConnection + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.mediator.admin.v30.SequencerConnectionService/GetConnection <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "sequencerConnections": { + "sequencerConnections": [ + { + "grpc": { + "connections": [ + "string" + ], + "transportSecurity": true, + "customTrustCertificates": "BASE64_ENCODED_BYTES" + }, + "alias": "string", + "sequencerId": "string" + } + ], + "sequencerTrustThreshold": 0, + "submissionRequestAmplification": { + "factor": 0, + "patience": "string" + }, + "sequencerLivenessMargin": 0, + "sequencerConnectionPoolDelays": { + "minRestartDelay": "string", + "maxRestartDelay": "string", + "subscriptionRequestDelay": "string", + "warnValidationDelay": "string" + } + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerConnectionService
+
+ +
+
RPC
+
GetConnection
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetConnectionRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.mediator.admin.v30.GetConnectionRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

GetConnectionResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.mediator.admin.v30.GetConnectionResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ sequencer_connections + SequencerConnections + +
+ +
optional
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ sequencer_connections + SequencerConnections + +
+ +
optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ sequencer_connections + repeated SequencerConnection + +
+ +
+ +
+
+ sequencer_trust_threshold + uint32 + +
+ +
This field determines the minimum level of agreement, or consensus, required among the sequencers before a message is considered reliable and accepted by the system. This value must be positive.
+ +
+ +
+
+ submission_request_amplification + SubmissionRequestAmplification + +
+ +
+ +
+
+ sequencer_liveness_margin + uint32 + +
+ +
This field determines the number of extra subscriptions to maintain beyond `sequencer_trust_threshold` in order to ensure liveness. This is only used when the new connection pool is enabled, and is ignored otherwise. This value must be non-negative.
+ +
+ +
+
+ sequencer_connection_pool_delays + SequencerConnectionPoolDelays + +
+ +
Configures the various delays used by the sequencer connection pool.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ grpc + Grpc + +
+ +
+ +
+
+ alias + string + +
+ +
+ +
+
+ sequencer_id + string + +
+ +
The id of the sequencer that serves the sequencer API. If empty, the node sets it after the first connection. If set, the node checks that the sequencer id reported by the sequencer matches this id.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ connections + repeated string + +
+ +
connection information to sequencer (http[s]://<host>:<port>")
+ +
+ +
+
+ transport_security + bool + +
+ +
Should the connection use TLS?
+ +
+ +
+
+ custom_trust_certificates + bytes + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ factor + uint32 + +
+ +
Determines to how often the client should try to send a submission request that is eligible for deduplication. A higher value increases the chance of a submission request being accepted by the system, but also increases the load on the sequencers and thus the costs incurred by the client. This value must be positive.
+ +
+ +
+
+ patience + Duration + +
+ +
Determines how long the sequencer client waits for observing the sequencing before it sends the submission request again. This value must be non-negative.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ min_restart_delay + Duration + +
+ +
Minimum duration after which a failed sequencer connection is restarted. This value must be non-negative.
+ +
+ +
+
+ max_restart_delay + Duration + +
+ +
Maximum duration after which a failed sequencer connection is restarted. This value must be non-negative.
+ +
+ +
+
+ subscription_request_delay + Duration + +
+ +
Delay between the attempts to obtain new sequencer connections for the sequencer subscription pool, when the current number of subscriptions is below `trustThreshold` + `livenessMargin`. This value must be non-negative.
+ +
+ +
+
+ warn_validation_delay + Duration + +
+ +
Duration after which a warning is issued if a started connection still fails validation. This value must be non-negative.
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/sequencerconnectionservice/logout.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/sequencerconnectionservice/logout.mdx new file mode 100644 index 0000000..9eeb54b --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/sequencerconnectionservice/logout.mdx @@ -0,0 +1,248 @@ +--- +title: "Logout" +--- + +
+ + + + +
+ +

com.digitalasset.canton.mediator.admin.v30

+ + +

Logout

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.mediator.admin.v30.SequencerConnectionService/Logout + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.mediator.admin.v30.SequencerConnectionService/Logout <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerConnectionService
+
+ +
+
RPC
+
Logout
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

LogoutRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.mediator.admin.v30.LogoutRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

LogoutResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.mediator.admin.v30.LogoutResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/sequencerconnectionservice/setconnection.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/sequencerconnectionservice/setconnection.mdx new file mode 100644 index 0000000..724a1cb --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/sequencerconnectionservice/setconnection.mdx @@ -0,0 +1,594 @@ +--- +title: "SetConnection" +--- + +
+ + + + +
+ +

com.digitalasset.canton.mediator.admin.v30

+ + +

SetConnection

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.mediator.admin.v30.SequencerConnectionService/SetConnection + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.mediator.admin.v30.SequencerConnectionService/SetConnection <<'EOF' +{ + "sequencerConnections": { + "sequencerConnections": [ + { + "grpc": { + "connections": [ + "string" + ], + "transportSecurity": true, + "customTrustCertificates": "BASE64_ENCODED_BYTES" + }, + "alias": "string", + "sequencerId": "string" + } + ], + "sequencerTrustThreshold": 0, + "submissionRequestAmplification": { + "factor": 0, + "patience": "string" + }, + "sequencerLivenessMargin": 0, + "sequencerConnectionPoolDelays": { + "minRestartDelay": "string", + "maxRestartDelay": "string", + "subscriptionRequestDelay": "string", + "warnValidationDelay": "string" + } + }, + "sequencerConnectionValidation": "SEQUENCER_CONNECTION_VALIDATION_UNSPECIFIED" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerConnectionService
+
+ +
+
RPC
+
SetConnection
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

SetConnectionRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.mediator.admin.v30.SetConnectionRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ sequencer_connections + SequencerConnections + +
+ +
required
+ +
+ +
+
+ sequencer_connection_validation + SequencerConnectionValidation + +
+ +
required
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

SetConnectionResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.mediator.admin.v30.SetConnectionResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ sequencer_connections + SequencerConnections + +
+ +
required
+ +
+ +
+
+ sequencer_connection_validation + SequencerConnectionValidation + +
+ +
required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ sequencer_connections + repeated SequencerConnection + +
+ +
+ +
+
+ sequencer_trust_threshold + uint32 + +
+ +
This field determines the minimum level of agreement, or consensus, required among the sequencers before a message is considered reliable and accepted by the system. This value must be positive.
+ +
+ +
+
+ submission_request_amplification + SubmissionRequestAmplification + +
+ +
+ +
+
+ sequencer_liveness_margin + uint32 + +
+ +
This field determines the number of extra subscriptions to maintain beyond `sequencer_trust_threshold` in order to ensure liveness. This is only used when the new connection pool is enabled, and is ignored otherwise. This value must be non-negative.
+ +
+ +
+
+ sequencer_connection_pool_delays + SequencerConnectionPoolDelays + +
+ +
Configures the various delays used by the sequencer connection pool.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ grpc + Grpc + +
+ +
+ +
+
+ alias + string + +
+ +
+ +
+
+ sequencer_id + string + +
+ +
The id of the sequencer that serves the sequencer API. If empty, the node sets it after the first connection. If set, the node checks that the sequencer id reported by the sequencer matches this id.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ connections + repeated string + +
+ +
connection information to sequencer (http[s]://<host>:<port>")
+ +
+ +
+
+ transport_security + bool + +
+ +
Should the connection use TLS?
+ +
+ +
+
+ custom_trust_certificates + bytes + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ factor + uint32 + +
+ +
Determines to how often the client should try to send a submission request that is eligible for deduplication. A higher value increases the chance of a submission request being accepted by the system, but also increases the load on the sequencers and thus the costs incurred by the client. This value must be positive.
+ +
+ +
+
+ patience + Duration + +
+ +
Determines how long the sequencer client waits for observing the sequencing before it sends the submission request again. This value must be non-negative.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ min_restart_delay + Duration + +
+ +
Minimum duration after which a failed sequencer connection is restarted. This value must be non-negative.
+ +
+ +
+
+ max_restart_delay + Duration + +
+ +
Maximum duration after which a failed sequencer connection is restarted. This value must be non-negative.
+ +
+ +
+
+ subscription_request_delay + Duration + +
+ +
Delay between the attempts to obtain new sequencer connections for the sequencer subscription pool, when the current number of subscriptions is below `trustThreshold` + `livenessMargin`. This value must be non-negative.
+ +
+ +
+
+ warn_validation_delay + Duration + +
+ +
Duration after which a warning is issued if a started connection still fails validation. This value must be non-negative.
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • SEQUENCER_CONNECTION_VALIDATION_UNSPECIFIED
    • + +
  • SEQUENCER_CONNECTION_VALIDATION_DISABLED
    • + +
  • SEQUENCER_CONNECTION_VALIDATION_ACTIVE
    • + +
  • SEQUENCER_CONNECTION_VALIDATION_ALL
    • + +
  • SEQUENCER_CONNECTION_VALIDATION_THRESHOLD_ACTIVE
    • + +
+ + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/disablemember.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/disablemember.mdx new file mode 100644 index 0000000..5d0b833 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/disablemember.mdx @@ -0,0 +1,276 @@ +--- +title: "DisableMember" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.admin.v30

+ + +

DisableMember

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.admin.v30.SequencerAdministrationService/DisableMember + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerAdministrationService/DisableMember <<'EOF' +{ + "member": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerAdministrationService
+
+ +
+
RPC
+
DisableMember
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

DisableMemberRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.DisableMemberRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ member + string + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

DisableMemberResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.DisableMemberResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ member + string + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/generateauthenticationtoken.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/generateauthenticationtoken.mdx new file mode 100644 index 0000000..756ed69 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/generateauthenticationtoken.mdx @@ -0,0 +1,358 @@ +--- +title: "GenerateAuthenticationToken" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.admin.v30

+ + +

GenerateAuthenticationToken

+ + + +
+ + gRPC + + Since 3.4.11 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.admin.v30.SequencerAdministrationService/GenerateAuthenticationToken + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerAdministrationService/GenerateAuthenticationToken <<'EOF' +{ + "member": "string", + "expiresIn": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "token": "BASE64_ENCODED_BYTES", + "expiresAt": "string" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerAdministrationService
+
+ +
+
RPC
+
GenerateAuthenticationToken
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GenerateAuthenticationTokenRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.GenerateAuthenticationTokenRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ member + string + +
+ +
Member for which the token is valid
+ +
+ +
+
+ expires_in + Duration + +
+ +
Duration after which the token will expire. If unset, the maxTokenExpirationInterval configured on the sequencer will be used
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

GenerateAuthenticationTokenResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.GenerateAuthenticationTokenResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ token + bytes + +
+ +
Auth token for the member
+ +
+ +
+
+ expires_at + Timestamp + +
+ +
Timestamp when the token expires
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.11 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ member + string + +
+ +
Member for which the token is valid
+ +
+ +
+
+ expires_in + Duration + +
+ +
Duration after which the token will expire. If unset, the maxTokenExpirationInterval configured on the sequencer will be used
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ token + bytes + +
+ +
Auth token for the member
+ +
+ +
+
+ expires_at + Timestamp + +
+ +
Timestamp when the token expires
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/onboardingstate.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/onboardingstate.mdx new file mode 100644 index 0000000..178a442 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/onboardingstate.mdx @@ -0,0 +1,335 @@ +--- +title: "OnboardingState" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.admin.v30

+ + +

OnboardingState

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.admin.v30.SequencerAdministrationService/OnboardingState + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerAdministrationService/OnboardingState <<'EOF' +{ + "sequencerUid": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "onboardingStateForSequencer": "BASE64_ENCODED_BYTES" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerAdministrationService
+
+ +
+
RPC
+
OnboardingState
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
Yes
+
+ +
+ + +## Inputs + + +
+
+

OnboardingStateRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.OnboardingStateRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ sequencer_uid + string + +
+ +
The sequencer for which to fetch the onboarding state
+ +
+ +
+
+ timestamp + Timestamp + +
+ +
The effective time the should be "contained" in the sequencer snapshot
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

OnboardingStateResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.OnboardingStateResponse
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + +
+ +
+
+ onboarding_state_for_sequencer + bytes + +
+ +
versioned OnboardingStateForSequencer
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ sequencer_uid + string + +
+ +
The sequencer for which to fetch the onboarding state
+ +
+ +
+
+ timestamp + Timestamp + +
+ +
The effective time the should be "contained" in the sequencer snapshot
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ onboarding_state_for_sequencer + bytes + +
+ +
versioned OnboardingStateForSequencer
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/onboardingstatev2.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/onboardingstatev2.mdx new file mode 100644 index 0000000..1c4343e --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/onboardingstatev2.mdx @@ -0,0 +1,335 @@ +--- +title: "OnboardingStateV2" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.admin.v30

+ + +

OnboardingStateV2

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.admin.v30.SequencerAdministrationService/OnboardingStateV2 + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerAdministrationService/OnboardingStateV2 <<'EOF' +{ + "sequencerUid": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "onboardingStateForSequencer": "BASE64_ENCODED_BYTES" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerAdministrationService
+
+ +
+
RPC
+
OnboardingStateV2
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
Yes
+
+ +
+ + +## Inputs + + +
+
+

OnboardingStateV2Request

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.OnboardingStateV2Request
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ sequencer_uid + string + +
+ +
The sequencer for which to fetch the onboarding state
+ +
+ +
+
+ timestamp + Timestamp + +
+ +
The effective time the should be "contained" in the sequencer snapshot
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

OnboardingStateV2Response

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.OnboardingStateV2Response
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + +
+ +
+
+ onboarding_state_for_sequencer + bytes + +
+ +
versioned OnboardingStateForSequencerV2
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ sequencer_uid + string + +
+ +
The sequencer for which to fetch the onboarding state
+ +
+ +
+
+ timestamp + Timestamp + +
+ +
The effective time the should be "contained" in the sequencer snapshot
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ onboarding_state_for_sequencer + bytes + +
+ +
versioned OnboardingStateForSequencerV2
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/pruningstatus.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/pruningstatus.mdx new file mode 100644 index 0000000..071976f --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/pruningstatus.mdx @@ -0,0 +1,386 @@ +--- +title: "PruningStatus" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.admin.v30

+ + +

PruningStatus

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.admin.v30.SequencerAdministrationService/PruningStatus + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerAdministrationService/PruningStatus <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "pruningStatus": { + "now": "0", + "earliestEventTimestamp": "0", + "members": [ + { + "member": "string", + "registeredAt": "0", + "lastAcknowledged": "0", + "enabled": true + } + ] + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerAdministrationService
+
+ +
+
RPC
+
PruningStatus
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

PruningStatusRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.PruningStatusRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

PruningStatusResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.PruningStatusResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ pruning_status + SequencerPruningStatus + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ pruning_status + SequencerPruningStatus + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ now + int64 + +
+ +
current time according to the sequencer in microseconds of UTC time since Unix epoch
+ +
+ +
+
+ earliest_event_timestamp + int64 + +
+ +
the earliest event we are currently storing in microseconds of UTC time since Unix epoch
+ +
+ +
+
+ members + repeated SequencerMemberStatus + +
+ +
details of each member registered on the sequencer
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ member + string + +
+ +
+ +
+
+ registered_at + int64 + +
+ +
in microseconds of UTC time since Unix epoch
+ +
+ +
+
+ last_acknowledged + int64 + +
+ +
in microseconds of UTC time since Unix epoch
+ +
+ +
+
+ enabled + bool + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/settrafficpurchased.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/settrafficpurchased.mdx new file mode 100644 index 0000000..3de89c2 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/settrafficpurchased.mdx @@ -0,0 +1,326 @@ +--- +title: "SetTrafficPurchased" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.admin.v30

+ + +

SetTrafficPurchased

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.admin.v30.SequencerAdministrationService/SetTrafficPurchased + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerAdministrationService/SetTrafficPurchased <<'EOF' +{ + "member": "string", + "serial": 0, + "totalTrafficPurchased": "0" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerAdministrationService
+
+ +
+
RPC
+
SetTrafficPurchased
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

SetTrafficPurchasedRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.SetTrafficPurchasedRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ member + string + +
+ +
Member to top up
+ +
+ +
+
+ serial + uint32 + +
+ +
Serial number of the request, will be used for idempotency
+ +
+ +
+
+ total_traffic_purchased + int64 + +
+ +
Amount of traffic to purchase
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

SetTrafficPurchasedResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.SetTrafficPurchasedResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ member + string + +
+ +
Member to top up
+ +
+ +
+
+ serial + uint32 + +
+ +
Serial number of the request, will be used for idempotency
+ +
+ +
+
+ total_traffic_purchased + int64 + +
+ +
Amount of traffic to purchase
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/snapshot.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/snapshot.mdx new file mode 100644 index 0000000..af40935 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/snapshot.mdx @@ -0,0 +1,1209 @@ +--- +title: "Snapshot" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.admin.v30

+ + +

Snapshot

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.admin.v30.SequencerAdministrationService/Snapshot + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerAdministrationService/Snapshot <<'EOF' +{ + "timestamp": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "success": { + "state": { + "latestTimestamp": "0", + "lastBlockHeight": "0", + "status": { + "now": "0", + "earliestEventTimestamp": "0", + "members": [ + {} + ] + }, + "additional": { + "implementationName": "string", + "info": "BASE64_ENCODED_BYTES" + }, + "inFlightAggregations": [ + { + "aggregationId": "BASE64_ENCODED_BYTES", + "aggregationRule": {}, + "maxSequencingTime": "0", + "aggregatedSenders": [ + {} + ] + } + ], + "trafficPurchased": [ + { + "member": "string", + "serial": 0, + "extraTrafficPurchased": "0", + "sequencingTimestamp": "0" + } + ], + "trafficConsumed": [ + { + "member": "string", + "extraTrafficConsumed": "0", + "baseTrafficRemainder": "0", + "lastConsumedCost": "0", + "sequencingTimestamp": "0" + } + ], + "memberPreviousTimestamps": [ + { + "member": "string", + "previousTimestamp": "0" + } + ] + } + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerAdministrationService
+
+ +
+
RPC
+
Snapshot
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

SnapshotRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.SnapshotRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ timestamp + Timestamp + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

SnapshotResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.SnapshotResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ success + Success + +
+ +
Used for sequencers running protocol versions up to v5
+ +
+ +
+
+ failure + Failure + +
+ +
+ +
+
+ versioned_success + VersionedSuccess + +
+ +
Used for sequencers running protocol version CNTestNet or higher.
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ timestamp + Timestamp + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ success + Success + +
+ +
Used for sequencers running protocol versions up to v5
+ +
+ +
+
+ failure + Failure + +
+ +
+ +
+
+ versioned_success + VersionedSuccess + +
+ +
Used for sequencers running protocol version CNTestNet or higher.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ state + SequencerSnapshot + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ latest_timestamp + int64 + +
+ +
in microseconds of UTC time since Unix epoch
+ +
+ +
+
+ last_block_height + uint64 + +
+ +
+ +
+
+ status + SequencerPruningStatus + +
+ +
+ +
+
+ additional + ImplementationSpecificInfo + +
+ +
+ +
+
+ in_flight_aggregations + repeated InFlightAggregationWithId + +
+ +
+ +
+
+ traffic_purchased + repeated TrafficPurchased + +
+ +
+ +
+
+ traffic_consumed + repeated TrafficConsumed + +
+ +
+ +
+
+ member_previous_timestamps + repeated MemberPreviousTimestamp + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ member + string + +
+ +
+ +
+
+ previous_timestamp + int64 + +
+ +
The value below must be: - None if member doesn't have any events in its event stream <= SequencerSnapshot.latest_timestamp - Set to the timestamp of the last event in the member's event stream <= SequencerSnapshot.latest_timestamp in microseconds of UTC time since Unix epoch
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ aggregation_id + bytes + +
+ +
+ +
+
+ aggregation_rule + AggregationRule + +
+ +
+ +
+
+ max_sequencing_time + int64 + +
+ +
in microseconds of UTC time since Unix epoch
+ +
+ +
+
+ aggregated_senders + repeated AggregationBySender + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ eligible_members + repeated string + +
+ +
Members who are allowed to send a request for the underlying aggregation. Must contain SubmissionRequest.sender, otherwise the request is rejected. Must have at least threshold many elements.
+ +
+ +
+
+ threshold + int32 + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ sender + string + +
+ +
+ +
+
+ sequencing_timestamp + int64 + +
+ +
in microseconds of UTC time since Unix epoch
+ +
+ +
+
+ signatures_by_envelope + repeated SignaturesForEnvelope + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ signatures + repeated Signature + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ format + SignatureFormat + +
+ +
+ +
+
+ signature + bytes + +
+ +
+ +
+
+ signed_by + string + +
+ +
The fingerprint/id of the keypair used to create this signature and needed to verify. If a signature delegation is defined, this fingerprint/id is not used to produce the signature, and, instead is used to sign the delegation.
+ +
+ +
+
+ signing_algorithm_spec + SigningAlgorithmSpec + +
+ +
The signing algorithm specification used to produce this signature
+ +
+ +
+
+ signature_delegation + SignatureDelegation + +
+ +
An optional signature delegation where a long-term signing key authorizes a session signing key to sign on its behalf.
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • SIGNATURE_FORMAT_UNSPECIFIED
    • + +
  • SIGNATURE_FORMAT_RAW
    • + +
  • SIGNATURE_FORMAT_DER
    • + +
  • SIGNATURE_FORMAT_CONCAT
    • + +
  • SIGNATURE_FORMAT_SYMBOLIC
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_ALGORITHM_SPEC_UNSPECIFIED
    • + +
  • SIGNING_ALGORITHM_SPEC_ED25519
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_256
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_384
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ session_key + bytes + +
+ +
ASN.1 + DER-encoding of X.509 SubjectPublicKeyInfo structure of the session public key: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1. This key was used to produce the actual signature.
+ +
+ +
+
+ session_key_spec + SigningKeySpec + +
+ +
The signing key spec for the session key.
+ +
+ +
+
+ validity_period_from_inclusive + int64 + +
+ +
A timestamp in microseconds of UTC time since Unix epoch that indicates when the session key is considered valid.
+ +
+ +
+
+ validity_period_duration_seconds + uint32 + +
+ +
Duration in seconds indicating how long the session key remains valid. The validity period starts from `validity_period_from_inclusive` above.
+ +
+ +
+
+ format + SignatureFormat + +
+ +
The format of the signature
+ +
+ +
+
+ signature + bytes + +
+ +
The signature of the combined hash of the session key fingerprint, validity period, and synchronizer id, by the long-term key. This signature authorizes the session key to act on behalf of the long-term key.
+ +
+ +
+
+ signing_algorithm_spec + SigningAlgorithmSpec + +
+ +
The signing algorithm specification used to produce this signature
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_SPEC_UNSPECIFIED
    • + +
  • SIGNING_KEY_SPEC_EC_CURVE25519
    • + +
  • SIGNING_KEY_SPEC_EC_P256
    • + +
  • SIGNING_KEY_SPEC_EC_P384
    • + +
  • SIGNING_KEY_SPEC_EC_SECP256K1
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ now + int64 + +
+ +
current time according to the sequencer in microseconds of UTC time since Unix epoch
+ +
+ +
+
+ earliest_event_timestamp + int64 + +
+ +
the earliest event we are currently storing in microseconds of UTC time since Unix epoch
+ +
+ +
+
+ members + repeated SequencerMemberStatus + +
+ +
details of each member registered on the sequencer
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ member + string + +
+ +
+ +
+
+ registered_at + int64 + +
+ +
in microseconds of UTC time since Unix epoch
+ +
+ +
+
+ last_acknowledged + int64 + +
+ +
in microseconds of UTC time since Unix epoch
+ +
+ +
+
+ enabled + bool + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ implementation_name + string + +
+ +
+ +
+
+ info + bytes + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ member + string + +
+ +
Member receiving the traffic
+ +
+ +
+
+ serial + uint32 + +
+ +
Serial of the update
+ +
+ +
+
+ extra_traffic_purchased + uint64 + +
+ +
New total extra traffic purchased
+ +
+ +
+
+ sequencing_timestamp + int64 + +
+ +
Timestamp at which this state is valid
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ member + string + +
+ +
Member consuming the traffic
+ +
+ +
+
+ extra_traffic_consumed + uint64 + +
+ +
Total extra traffic consumed
+ +
+ +
+
+ base_traffic_remainder + uint64 + +
+ +
Remaining free base traffic
+ +
+ +
+
+ last_consumed_cost + uint64 + +
+ +
Cost deducted at `timestamp`, only present when traffic was consumed at `timestamp`, otherwise is set to 0
+ +
+ +
+
+ sequencing_timestamp + int64 + +
+ +
Timestamp at which this state is valid - this timestamp is used to compute the base traffic remainder above
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ reason + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ snapshot + bytes + +
+ +
Contains a versioned SequencerSnapshot of version v1 or higher
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/trafficcontrolstate.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/trafficcontrolstate.mdx new file mode 100644 index 0000000..9309283 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/trafficcontrolstate.mdx @@ -0,0 +1,389 @@ +--- +title: "TrafficControlState" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.admin.v30

+ + +

TrafficControlState

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.admin.v30.SequencerAdministrationService/TrafficControlState + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerAdministrationService/TrafficControlState <<'EOF' +{ + "members": [ + "string" + ], + "exactTimestamp": "0" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "trafficStates": [ + { + "key": { + "extraTrafficPurchased": "0", + "extraTrafficConsumed": "0", + "baseTrafficRemainder": "0", + "lastConsumedCost": "0", + "timestamp": "0", + "serial": 0 + } + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerAdministrationService
+
+ +
+
RPC
+
TrafficControlState
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

TrafficControlStateRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.TrafficControlStateRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ members + repeated string + +
+ +
Members for which to retrieve the traffic state
+ +
+ +
+
+ exact_timestamp + uint64 + +
+ +
Provide an exact timestamp at which traffic states must be returned
+ +
+ +
+
+ relative_timestamp + RelativeTimestamp + +
+ +
A relative timestamp based on the sequencer's state at the time of the request, see above for details
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

TrafficControlStateResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.TrafficControlStateResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ traffic_states + repeated map + +
+ +
The key is the serialized member value The value is their currently known traffic state (the traffic state contains a timestamp at which it is valid)
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ members + repeated string + +
+ +
Members for which to retrieve the traffic state
+ +
+ +
+
+ exact_timestamp + uint64 + +
+ +
Provide an exact timestamp at which traffic states must be returned
+ +
+ +
+
+ relative_timestamp + RelativeTimestamp + +
+ +
A relative timestamp based on the sequencer's state at the time of the request, see above for details
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • RELATIVE_TIMESTAMP_LATEST_SAFE_UNSPECIFIED
    • + +
  • RELATIVE_TIMESTAMP_LAST_UPDATE_PER_MEMBER
    • + +
  • RELATIVE_TIMESTAMP_LATEST_APPROXIMATE
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ traffic_states + repeated map + +
+ +
The key is the serialized member value The value is their currently known traffic state (the traffic state contains a timestamp at which it is valid)
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/addpeerendpoint.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/addpeerendpoint.mdx new file mode 100644 index 0000000..af8b401 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/addpeerendpoint.mdx @@ -0,0 +1,432 @@ +--- +title: "AddPeerEndpoint" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.admin.v30

+ + +

AddPeerEndpoint

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.admin.v30.SequencerBftAdministrationService/AddPeerEndpoint + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerBftAdministrationService/AddPeerEndpoint <<'EOF' +{ + "endpoint": { + "address": "string", + "port": 0, + "plainText": {} + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "added": true +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerBftAdministrationService
+
+ +
+
RPC
+
AddPeerEndpoint
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

AddPeerEndpointRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.AddPeerEndpointRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ endpoint + PeerEndpoint + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

AddPeerEndpointResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.AddPeerEndpointResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ added + bool + +
+ +
False if already present
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ endpoint + PeerEndpoint + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ address + string + +
+ +
+ +
+
+ port + uint32 + +
+ +
+ +
+
+ plain_text + PlainTextPeerEndpoint + +
+ +
+ +
+
+ tls + TlsPeerEndpoint + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ custom_server_trust_certificate + bytes + +
+ +
+ +
+
+ client_certificate + TlsClientCertificate + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ certificate_chain + bytes + +
+ +
+ +
+
+ private_key_file + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ added + bool + +
+ +
False if already present
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/getorderingtopology.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/getorderingtopology.mdx new file mode 100644 index 0000000..e0511b2 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/getorderingtopology.mdx @@ -0,0 +1,305 @@ +--- +title: "GetOrderingTopology" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.admin.v30

+ + +

GetOrderingTopology

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.admin.v30.SequencerBftAdministrationService/GetOrderingTopology + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerBftAdministrationService/GetOrderingTopology <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "currentEpoch": "0", + "sequencerIds": [ + "string" + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerBftAdministrationService
+
+ +
+
RPC
+
GetOrderingTopology
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetOrderingTopologyRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.GetOrderingTopologyRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

GetOrderingTopologyResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.GetOrderingTopologyResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ current_epoch + int64 + +
+ +
The current epoch, through which the topology is valid.
+ +
+ +
+
+ sequencer_ids + repeated string + +
+ +
The sequencer IDs of the active BFT ordering nodes in the network.
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ current_epoch + int64 + +
+ +
The current epoch, through which the topology is valid.
+ +
+ +
+
+ sequencer_ids + repeated string + +
+ +
The sequencer IDs of the active BFT ordering nodes in the network.
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/getpeernetworkstatus.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/getpeernetworkstatus.mdx new file mode 100644 index 0000000..b3a5194 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/getpeernetworkstatus.mdx @@ -0,0 +1,569 @@ +--- +title: "GetPeerNetworkStatus" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.admin.v30

+ + +

GetPeerNetworkStatus

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.admin.v30.SequencerBftAdministrationService/GetPeerNetworkStatus + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerBftAdministrationService/GetPeerNetworkStatus <<'EOF' +{ + "endpointIds": [ + { + "address": "string", + "port": 0, + "tls": true + } + ] +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "statuses": [ + { + "peerEndpointStatus": { + "endpointId": { + "address": "string", + "port": 0, + "tls": true + }, + "isOutgoingConnection": true, + "health": { + "status": {}, + "description": "string" + } + } + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerBftAdministrationService
+
+ +
+
RPC
+
GetPeerNetworkStatus
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetPeerNetworkStatusRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.GetPeerNetworkStatusRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ endpoint_ids + repeated PeerEndpointId + +
+ +
If empty, the status of all known endpoints will be returned
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

GetPeerNetworkStatusResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.GetPeerNetworkStatusResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ statuses + repeated PeerConnectionStatus + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ endpoint_ids + repeated PeerEndpointId + +
+ +
If empty, the status of all known endpoints will be returned
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ address + string + +
+ +
+ +
+
+ port + uint32 + +
+ +
+ +
+
+ tls + bool + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ statuses + repeated PeerConnectionStatus + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ peer_endpoint_status + PeerEndpointStatus + +
+ +
+ +
+
+ peer_incoming_connection + Authenticated + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ endpoint_id + PeerEndpointId + +
+ +
+ +
+
+ is_outgoing_connection + bool + +
+ +
+ +
+
+ health + PeerEndpointHealth + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ status + PeerEndpointHealthStatus + +
+ +
+ +
+
+ description + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ unknown_endpoint + UnknownEndpoint + +
+ +
+ +
+
+ disconnected + Disconnected + +
+ +
+ +
+
+ unauthenticated + Unauthenticated + +
+ +
+ +
+
+ authenticated + Authenticated + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + + + +
+ + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ sequencer_id + string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/removepeerendpoint.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/removepeerendpoint.mdx new file mode 100644 index 0000000..49b90cf --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/removepeerendpoint.mdx @@ -0,0 +1,352 @@ +--- +title: "RemovePeerEndpoint" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.admin.v30

+ + +

RemovePeerEndpoint

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.admin.v30.SequencerBftAdministrationService/RemovePeerEndpoint + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerBftAdministrationService/RemovePeerEndpoint <<'EOF' +{ + "endpointId": { + "address": "string", + "port": 0, + "tls": true + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "removed": true +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerBftAdministrationService
+
+ +
+
RPC
+
RemovePeerEndpoint
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

RemovePeerEndpointRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.RemovePeerEndpointRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ endpoint_id + PeerEndpointId + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

RemovePeerEndpointResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.RemovePeerEndpointResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ removed + bool + +
+ +
False if not found
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ endpoint_id + PeerEndpointId + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ address + string + +
+ +
+ +
+
+ port + uint32 + +
+ +
+ +
+
+ tls + bool + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ removed + bool + +
+ +
False if not found
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/setperformancemetricsenabled.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/setperformancemetricsenabled.mdx new file mode 100644 index 0000000..34eae96 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/setperformancemetricsenabled.mdx @@ -0,0 +1,276 @@ +--- +title: "SetPerformanceMetricsEnabled" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.admin.v30

+ + +

SetPerformanceMetricsEnabled

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.admin.v30.SequencerBftAdministrationService/SetPerformanceMetricsEnabled + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerBftAdministrationService/SetPerformanceMetricsEnabled <<'EOF' +{ + "enabled": true +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerBftAdministrationService
+
+ +
+
RPC
+
SetPerformanceMetricsEnabled
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

SetPerformanceMetricsEnabledRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.SetPerformanceMetricsEnabledRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ enabled + bool + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

SetPerformanceMetricsEnabledResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.SetPerformanceMetricsEnabledResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ enabled + bool + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/bftprune.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/bftprune.mdx new file mode 100644 index 0000000..4fe8ee5 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/bftprune.mdx @@ -0,0 +1,323 @@ +--- +title: "BftPrune" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.admin.v30

+ + +

BftPrune

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/BftPrune + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/BftPrune <<'EOF' +{ + "retention": "string", + "minBlocksToKeep": 0 +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "message": "string" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerBftPruningAdministrationService
+
+ +
+
RPC
+
BftPrune
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

BftPruneRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.BftPruneRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ retention + Duration + +
+ +
+ +
+
+ min_blocks_to_keep + int32 + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

BftPruneResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.BftPruneResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ message + string + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ retention + Duration + +
+ +
+ +
+
+ min_blocks_to_keep + int32 + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ message + string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/bftpruningstatus.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/bftpruningstatus.mdx new file mode 100644 index 0000000..8328f3b --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/bftpruningstatus.mdx @@ -0,0 +1,352 @@ +--- +title: "BftPruningStatus" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.admin.v30

+ + +

BftPruningStatus

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/BftPruningStatus + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/BftPruningStatus <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "latestBlockEpoch": "0", + "latestBlock": "0", + "latestBlockTimestamp": "string", + "lowerBoundEpoch": "0", + "lowerBoundBlock": "0" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerBftPruningAdministrationService
+
+ +
+
RPC
+
BftPruningStatus
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

BftPruningStatusRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.BftPruningStatusRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

BftPruningStatusResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.BftPruningStatusResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ latest_block_epoch + int64 + +
+ +
+ +
+
+ latest_block + int64 + +
+ +
+ +
+
+ latest_block_timestamp + Timestamp + +
+ +
+ +
+
+ lower_bound_epoch + int64 + +
+ +
+ +
+
+ lower_bound_block + int64 + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ latest_block_epoch + int64 + +
+ +
+ +
+
+ latest_block + int64 + +
+ +
+ +
+
+ latest_block_timestamp + Timestamp + +
+ +
+ +
+
+ lower_bound_epoch + int64 + +
+ +
+ +
+
+ lower_bound_block + int64 + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/clearschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/clearschedule.mdx new file mode 100644 index 0000000..229665b --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/clearschedule.mdx @@ -0,0 +1,248 @@ +--- +title: "ClearSchedule" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.admin.v30

+ + +

ClearSchedule

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/ClearSchedule + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/ClearSchedule <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerBftPruningAdministrationService
+
+ +
+
RPC
+
ClearSchedule
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ClearScheduleRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.ClearScheduleRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

ClearScheduleResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.ClearScheduleResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/getbftschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/getbftschedule.mdx new file mode 100644 index 0000000..cae3f81 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/getbftschedule.mdx @@ -0,0 +1,354 @@ +--- +title: "GetBftSchedule" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.admin.v30

+ + +

GetBftSchedule

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/GetBftSchedule + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/GetBftSchedule <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "schedule": { + "schedule": { + "cron": "string", + "maxDuration": "string", + "retention": "string" + }, + "minBlocksToKeep": 0 + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerBftPruningAdministrationService
+
+ +
+
RPC
+
GetBftSchedule
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetBftScheduleRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.GetBftScheduleRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

GetBftScheduleResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.GetBftScheduleResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ schedule + BftOrdererPruningSchedule + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ schedule + BftOrdererPruningSchedule + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ schedule + PruningSchedule + +
+ +
+ +
+
+ min_blocks_to_keep + int32 + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ cron + string + +
+ +
+ +
+
+ max_duration + Duration + +
+ +
+ +
+
+ retention + Duration + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/getschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/getschedule.mdx new file mode 100644 index 0000000..66c7bfd --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/getschedule.mdx @@ -0,0 +1,320 @@ +--- +title: "GetSchedule" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.admin.v30

+ + +

GetSchedule

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/GetSchedule + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/GetSchedule <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "schedule": { + "cron": "string", + "maxDuration": "string", + "retention": "string" + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerBftPruningAdministrationService
+
+ +
+
RPC
+
GetSchedule
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetScheduleRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.GetScheduleRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

GetScheduleResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.GetScheduleResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ schedule + PruningSchedule + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ schedule + PruningSchedule + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ cron + string + +
+ +
+ +
+
+ max_duration + Duration + +
+ +
+ +
+
+ retention + Duration + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setbftschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setbftschedule.mdx new file mode 100644 index 0000000..00a7c53 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setbftschedule.mdx @@ -0,0 +1,354 @@ +--- +title: "SetBftSchedule" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.admin.v30

+ + +

SetBftSchedule

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/SetBftSchedule + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/SetBftSchedule <<'EOF' +{ + "schedule": { + "schedule": { + "cron": "string", + "maxDuration": "string", + "retention": "string" + }, + "minBlocksToKeep": 0 + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerBftPruningAdministrationService
+
+ +
+
RPC
+
SetBftSchedule
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

SetBftScheduleRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.SetBftScheduleRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ schedule + BftOrdererPruningSchedule + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

SetBftScheduleResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.SetBftScheduleResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ schedule + BftOrdererPruningSchedule + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ schedule + PruningSchedule + +
+ +
+ +
+
+ min_blocks_to_keep + int32 + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ cron + string + +
+ +
+ +
+
+ max_duration + Duration + +
+ +
+ +
+
+ retention + Duration + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setcron.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setcron.mdx new file mode 100644 index 0000000..d5b1ad0 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setcron.mdx @@ -0,0 +1,276 @@ +--- +title: "SetCron" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.admin.v30

+ + +

SetCron

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/SetCron + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/SetCron <<'EOF' +{ + "cron": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerBftPruningAdministrationService
+
+ +
+
RPC
+
SetCron
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

SetCronRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.SetCronRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ cron + string + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

SetCronResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.SetCronResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ cron + string + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setmaxduration.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setmaxduration.mdx new file mode 100644 index 0000000..c45f079 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setmaxduration.mdx @@ -0,0 +1,276 @@ +--- +title: "SetMaxDuration" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.admin.v30

+ + +

SetMaxDuration

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/SetMaxDuration + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/SetMaxDuration <<'EOF' +{ + "maxDuration": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerBftPruningAdministrationService
+
+ +
+
RPC
+
SetMaxDuration
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

SetMaxDurationRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.SetMaxDurationRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ max_duration + Duration + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

SetMaxDurationResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.SetMaxDurationResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ max_duration + Duration + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setminblockstokeep.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setminblockstokeep.mdx new file mode 100644 index 0000000..83d5caf --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setminblockstokeep.mdx @@ -0,0 +1,276 @@ +--- +title: "SetMinBlocksToKeep" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.admin.v30

+ + +

SetMinBlocksToKeep

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/SetMinBlocksToKeep + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/SetMinBlocksToKeep <<'EOF' +{ + "minBlocksToKeep": 0 +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerBftPruningAdministrationService
+
+ +
+
RPC
+
SetMinBlocksToKeep
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

SetMinBlocksToKeepRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.SetMinBlocksToKeepRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ min_blocks_to_keep + int32 + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

SetMinBlocksToKeepResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.SetMinBlocksToKeepResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ min_blocks_to_keep + int32 + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setretention.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setretention.mdx new file mode 100644 index 0000000..20f50eb --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setretention.mdx @@ -0,0 +1,276 @@ +--- +title: "SetRetention" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.admin.v30

+ + +

SetRetention

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/SetRetention + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/SetRetention <<'EOF' +{ + "retention": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerBftPruningAdministrationService
+
+ +
+
RPC
+
SetRetention
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

SetRetentionRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.SetRetentionRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ retention + Duration + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

SetRetentionResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.SetRetentionResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ retention + Duration + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setschedule.mdx new file mode 100644 index 0000000..cdc1a6a --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setschedule.mdx @@ -0,0 +1,320 @@ +--- +title: "SetSchedule" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.admin.v30

+ + +

SetSchedule

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/SetSchedule + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/SetSchedule <<'EOF' +{ + "schedule": { + "cron": "string", + "maxDuration": "string", + "retention": "string" + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerBftPruningAdministrationService
+
+ +
+
RPC
+
SetSchedule
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

SetScheduleRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.SetScheduleRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ schedule + PruningSchedule + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

SetScheduleResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.SetScheduleResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ schedule + PruningSchedule + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ cron + string + +
+ +
+ +
+
+ max_duration + Duration + +
+ +
+ +
+
+ retention + Duration + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromgenesisstate.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromgenesisstate.mdx new file mode 100644 index 0000000..0a2d0fe --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromgenesisstate.mdx @@ -0,0 +1,696 @@ +--- +title: "InitializeSequencerFromGenesisState" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.admin.v30

+ + +

InitializeSequencerFromGenesisState

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.admin.v30.SequencerInitializationService/InitializeSequencerFromGenesisState + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerInitializationService/InitializeSequencerFromGenesisState <<'EOF' +{ + "topologySnapshot": "BASE64_ENCODED_BYTES", + "synchronizerParameters": { + "requiredSigningSpecs": { + "algorithms": [ + "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" + ], + "keys": [ + "SIGNING_KEY_SPEC_UNSPECIFIED" + ] + }, + "requiredEncryptionSpecs": { + "algorithms": [ + "ENCRYPTION_ALGORITHM_SPEC_UNSPECIFIED" + ], + "keys": [ + "ENCRYPTION_KEY_SPEC_UNSPECIFIED" + ] + }, + "requiredSymmetricKeySchemes": [ + "SYMMETRIC_KEY_SCHEME_UNSPECIFIED" + ], + "requiredHashAlgorithms": [ + "HASH_ALGORITHM_UNSPECIFIED" + ], + "requiredCryptoKeyFormats": [ + "CRYPTO_KEY_FORMAT_UNSPECIFIED" + ], + "requiredSignatureFormats": [ + "SIGNATURE_FORMAT_UNSPECIFIED" + ], + "protocolVersion": 0, + "serial": 0 + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "replicated": true +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerInitializationService
+
+ +
+
RPC
+
InitializeSequencerFromGenesisState
+
+ +
+
Client stream
+
Yes
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

InitializeSequencerFromGenesisStateRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromGenesisStateRequest
+
+ +
+
Client stream
+
Yes
+
+ +
+ + + + +
+ +
+
+ topology_snapshot + bytes + +
+ +
a topology snapshot up until (including) the point where this sequencer is becoming active on the synchronizer the topology snapshot will be persisted in the synchronizer store of the sequencer
+ +
+ +
+
+ synchronizer_parameters + StaticSynchronizerParameters + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

InitializeSequencerFromGenesisStateResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromGenesisStateResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ replicated + bool + +
+ +
Indicate if the initialized sequencer is replicated
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ topology_snapshot + bytes + +
+ +
a topology snapshot up until (including) the point where this sequencer is becoming active on the synchronizer the topology snapshot will be persisted in the synchronizer store of the sequencer
+ +
+ +
+
+ synchronizer_parameters + StaticSynchronizerParameters + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ required_signing_specs + RequiredSigningSpecs + +
+ +
+ +
+
+ required_encryption_specs + RequiredEncryptionSpecs + +
+ +
+ +
+
+ required_symmetric_key_schemes + repeated SymmetricKeyScheme + +
+ +
+ +
+
+ required_hash_algorithms + repeated HashAlgorithm + +
+ +
+ +
+
+ required_crypto_key_formats + repeated CryptoKeyFormat + +
+ +
+ +
+
+ required_signature_formats + repeated SignatureFormat + +
+ +
+ +
+
+ protocol_version + int32 + +
+ +
+ +
+
+ serial + int32 + +
+ +
Serial of the synchronizer. Must be non-negative.
+ +
+ +
+
+ enable_transparency_checks + bool + +
+ +
Flag to enable transparency checks.
+ +
+ +
+
+ topology_change_delay + Duration + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ algorithms + repeated SigningAlgorithmSpec + +
+ +
+ +
+
+ keys + repeated SigningKeySpec + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • SIGNING_ALGORITHM_SPEC_UNSPECIFIED
    • + +
  • SIGNING_ALGORITHM_SPEC_ED25519
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_256
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_384
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_SPEC_UNSPECIFIED
    • + +
  • SIGNING_KEY_SPEC_EC_CURVE25519
    • + +
  • SIGNING_KEY_SPEC_EC_P256
    • + +
  • SIGNING_KEY_SPEC_EC_P384
    • + +
  • SIGNING_KEY_SPEC_EC_SECP256K1
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ algorithms + repeated EncryptionAlgorithmSpec + +
+ +
+ +
+
+ keys + repeated EncryptionKeySpec + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • ENCRYPTION_ALGORITHM_SPEC_UNSPECIFIED
    • + +
  • ENCRYPTION_ALGORITHM_SPEC_ECIES_HKDF_HMAC_SHA256_AES128CBC
    • + +
  • ENCRYPTION_ALGORITHM_SPEC_RSA_OAEP_SHA256
    • + +
+ + +
+ + + +
+ + + +
    + +
  • ENCRYPTION_KEY_SPEC_UNSPECIFIED
    • + +
  • ENCRYPTION_KEY_SPEC_EC_P256
    • + +
  • ENCRYPTION_KEY_SPEC_RSA_2048
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SYMMETRIC_KEY_SCHEME_UNSPECIFIED
    • + +
  • SYMMETRIC_KEY_SCHEME_AES128GCM
    • + +
+ + +
+ + + +
+ + + +
    + +
  • HASH_ALGORITHM_UNSPECIFIED
    • + +
  • HASH_ALGORITHM_SHA256
    • + +
+ + +
+ + + +
+ + + +
    + +
  • CRYPTO_KEY_FORMAT_UNSPECIFIED
    • + +
  • CRYPTO_KEY_FORMAT_DER
    • + +
  • CRYPTO_KEY_FORMAT_RAW
    • + +
  • CRYPTO_KEY_FORMAT_DER_X509_SUBJECT_PUBLIC_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_DER_PKCS8_PRIVATE_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_SYMBOLIC
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNATURE_FORMAT_UNSPECIFIED
    • + +
  • SIGNATURE_FORMAT_RAW
    • + +
  • SIGNATURE_FORMAT_DER
    • + +
  • SIGNATURE_FORMAT_CONCAT
    • + +
  • SIGNATURE_FORMAT_SYMBOLIC
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ replicated + bool + +
+ +
Indicate if the initialized sequencer is replicated
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromgenesisstatev2.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromgenesisstatev2.mdx new file mode 100644 index 0000000..84f8d7b --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromgenesisstatev2.mdx @@ -0,0 +1,696 @@ +--- +title: "InitializeSequencerFromGenesisStateV2" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.admin.v30

+ + +

InitializeSequencerFromGenesisStateV2

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.admin.v30.SequencerInitializationService/InitializeSequencerFromGenesisStateV2 + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerInitializationService/InitializeSequencerFromGenesisStateV2 <<'EOF' +{ + "topologySnapshot": "BASE64_ENCODED_BYTES", + "synchronizerParameters": { + "requiredSigningSpecs": { + "algorithms": [ + "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" + ], + "keys": [ + "SIGNING_KEY_SPEC_UNSPECIFIED" + ] + }, + "requiredEncryptionSpecs": { + "algorithms": [ + "ENCRYPTION_ALGORITHM_SPEC_UNSPECIFIED" + ], + "keys": [ + "ENCRYPTION_KEY_SPEC_UNSPECIFIED" + ] + }, + "requiredSymmetricKeySchemes": [ + "SYMMETRIC_KEY_SCHEME_UNSPECIFIED" + ], + "requiredHashAlgorithms": [ + "HASH_ALGORITHM_UNSPECIFIED" + ], + "requiredCryptoKeyFormats": [ + "CRYPTO_KEY_FORMAT_UNSPECIFIED" + ], + "requiredSignatureFormats": [ + "SIGNATURE_FORMAT_UNSPECIFIED" + ], + "protocolVersion": 0, + "serial": 0 + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "replicated": true +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerInitializationService
+
+ +
+
RPC
+
InitializeSequencerFromGenesisStateV2
+
+ +
+
Client stream
+
Yes
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

InitializeSequencerFromGenesisStateV2Request

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromGenesisStateV2Request
+
+ +
+
Client stream
+
Yes
+
+ +
+ + + + +
+ +
+
+ topology_snapshot + bytes + +
+ +
a topology snapshot up until (including) the point where this sequencer is becoming active on the synchronizer the topology snapshot will be persisted in the synchronizer store of the sequencer
+ +
+ +
+
+ synchronizer_parameters + StaticSynchronizerParameters + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

InitializeSequencerFromGenesisStateV2Response

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromGenesisStateV2Response
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ replicated + bool + +
+ +
Indicate if the initialized sequencer is replicated
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ topology_snapshot + bytes + +
+ +
a topology snapshot up until (including) the point where this sequencer is becoming active on the synchronizer the topology snapshot will be persisted in the synchronizer store of the sequencer
+ +
+ +
+
+ synchronizer_parameters + StaticSynchronizerParameters + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ required_signing_specs + RequiredSigningSpecs + +
+ +
+ +
+
+ required_encryption_specs + RequiredEncryptionSpecs + +
+ +
+ +
+
+ required_symmetric_key_schemes + repeated SymmetricKeyScheme + +
+ +
+ +
+
+ required_hash_algorithms + repeated HashAlgorithm + +
+ +
+ +
+
+ required_crypto_key_formats + repeated CryptoKeyFormat + +
+ +
+ +
+
+ required_signature_formats + repeated SignatureFormat + +
+ +
+ +
+
+ protocol_version + int32 + +
+ +
+ +
+
+ serial + int32 + +
+ +
Serial of the synchronizer. Must be non-negative.
+ +
+ +
+
+ enable_transparency_checks + bool + +
+ +
Flag to enable transparency checks.
+ +
+ +
+
+ topology_change_delay + Duration + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ algorithms + repeated SigningAlgorithmSpec + +
+ +
+ +
+
+ keys + repeated SigningKeySpec + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • SIGNING_ALGORITHM_SPEC_UNSPECIFIED
    • + +
  • SIGNING_ALGORITHM_SPEC_ED25519
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_256
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_384
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_SPEC_UNSPECIFIED
    • + +
  • SIGNING_KEY_SPEC_EC_CURVE25519
    • + +
  • SIGNING_KEY_SPEC_EC_P256
    • + +
  • SIGNING_KEY_SPEC_EC_P384
    • + +
  • SIGNING_KEY_SPEC_EC_SECP256K1
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ algorithms + repeated EncryptionAlgorithmSpec + +
+ +
+ +
+
+ keys + repeated EncryptionKeySpec + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • ENCRYPTION_ALGORITHM_SPEC_UNSPECIFIED
    • + +
  • ENCRYPTION_ALGORITHM_SPEC_ECIES_HKDF_HMAC_SHA256_AES128CBC
    • + +
  • ENCRYPTION_ALGORITHM_SPEC_RSA_OAEP_SHA256
    • + +
+ + +
+ + + +
+ + + +
    + +
  • ENCRYPTION_KEY_SPEC_UNSPECIFIED
    • + +
  • ENCRYPTION_KEY_SPEC_EC_P256
    • + +
  • ENCRYPTION_KEY_SPEC_RSA_2048
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SYMMETRIC_KEY_SCHEME_UNSPECIFIED
    • + +
  • SYMMETRIC_KEY_SCHEME_AES128GCM
    • + +
+ + +
+ + + +
+ + + +
    + +
  • HASH_ALGORITHM_UNSPECIFIED
    • + +
  • HASH_ALGORITHM_SHA256
    • + +
+ + +
+ + + +
+ + + +
    + +
  • CRYPTO_KEY_FORMAT_UNSPECIFIED
    • + +
  • CRYPTO_KEY_FORMAT_DER
    • + +
  • CRYPTO_KEY_FORMAT_RAW
    • + +
  • CRYPTO_KEY_FORMAT_DER_X509_SUBJECT_PUBLIC_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_DER_PKCS8_PRIVATE_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_SYMBOLIC
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNATURE_FORMAT_UNSPECIFIED
    • + +
  • SIGNATURE_FORMAT_RAW
    • + +
  • SIGNATURE_FORMAT_DER
    • + +
  • SIGNATURE_FORMAT_CONCAT
    • + +
  • SIGNATURE_FORMAT_SYMBOLIC
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ replicated + bool + +
+ +
Indicate if the initialized sequencer is replicated
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromonboardingstate.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromonboardingstate.mdx new file mode 100644 index 0000000..1f60e82 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromonboardingstate.mdx @@ -0,0 +1,309 @@ +--- +title: "InitializeSequencerFromOnboardingState" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.admin.v30

+ + +

InitializeSequencerFromOnboardingState

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.admin.v30.SequencerInitializationService/InitializeSequencerFromOnboardingState + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerInitializationService/InitializeSequencerFromOnboardingState <<'EOF' +{ + "onboardingState": "BASE64_ENCODED_BYTES" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "replicated": true +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerInitializationService
+
+ +
+
RPC
+
InitializeSequencerFromOnboardingState
+
+ +
+
Client stream
+
Yes
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

InitializeSequencerFromOnboardingStateRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromOnboardingStateRequest
+
+ +
+
Client stream
+
Yes
+
+ +
+ + + + +
+ +
+
+ onboarding_state + bytes + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

InitializeSequencerFromOnboardingStateResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromOnboardingStateResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ replicated + bool + +
+ +
Indicate if the initialized sequencer is replicated
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ onboarding_state + bytes + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ replicated + bool + +
+ +
Indicate if the initialized sequencer is replicated
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromonboardingstatev2.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromonboardingstatev2.mdx new file mode 100644 index 0000000..46d2e37 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromonboardingstatev2.mdx @@ -0,0 +1,309 @@ +--- +title: "InitializeSequencerFromOnboardingStateV2" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.admin.v30

+ + +

InitializeSequencerFromOnboardingStateV2

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.admin.v30.SequencerInitializationService/InitializeSequencerFromOnboardingStateV2 + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerInitializationService/InitializeSequencerFromOnboardingStateV2 <<'EOF' +{ + "onboardingState": "BASE64_ENCODED_BYTES" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "replicated": true +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerInitializationService
+
+ +
+
RPC
+
InitializeSequencerFromOnboardingStateV2
+
+ +
+
Client stream
+
Yes
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

InitializeSequencerFromOnboardingStateV2Request

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromOnboardingStateV2Request
+
+ +
+
Client stream
+
Yes
+
+ +
+ + + + +
+ +
+
+ onboarding_state + bytes + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

InitializeSequencerFromOnboardingStateV2Response

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromOnboardingStateV2Response
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ replicated + bool + +
+ +
Indicate if the initialized sequencer is replicated
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ onboarding_state + bytes + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ replicated + bool + +
+ +
Indicate if the initialized sequencer is replicated
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfrompredecessor.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfrompredecessor.mdx new file mode 100644 index 0000000..f8d3bb6 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfrompredecessor.mdx @@ -0,0 +1,660 @@ +--- +title: "InitializeSequencerFromPredecessor" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.admin.v30

+ + +

InitializeSequencerFromPredecessor

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.admin.v30.SequencerInitializationService/InitializeSequencerFromPredecessor + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerInitializationService/InitializeSequencerFromPredecessor <<'EOF' +{ + "topologySnapshot": "BASE64_ENCODED_BYTES", + "synchronizerParameters": { + "requiredSigningSpecs": { + "algorithms": [ + "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" + ], + "keys": [ + "SIGNING_KEY_SPEC_UNSPECIFIED" + ] + }, + "requiredEncryptionSpecs": { + "algorithms": [ + "ENCRYPTION_ALGORITHM_SPEC_UNSPECIFIED" + ], + "keys": [ + "ENCRYPTION_KEY_SPEC_UNSPECIFIED" + ] + }, + "requiredSymmetricKeySchemes": [ + "SYMMETRIC_KEY_SCHEME_UNSPECIFIED" + ], + "requiredHashAlgorithms": [ + "HASH_ALGORITHM_UNSPECIFIED" + ], + "requiredCryptoKeyFormats": [ + "CRYPTO_KEY_FORMAT_UNSPECIFIED" + ], + "requiredSignatureFormats": [ + "SIGNATURE_FORMAT_UNSPECIFIED" + ], + "protocolVersion": 0, + "serial": 0 + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerInitializationService
+
+ +
+
RPC
+
InitializeSequencerFromPredecessor
+
+ +
+
Client stream
+
Yes
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

InitializeSequencerFromPredecessorRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromPredecessorRequest
+
+ +
+
Client stream
+
Yes
+
+ +
+ + + + +
+ +
+
+ topology_snapshot + bytes + +
+ +
+ +
+
+ synchronizer_parameters + StaticSynchronizerParameters + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

InitializeSequencerFromPredecessorResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromPredecessorResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ topology_snapshot + bytes + +
+ +
+ +
+
+ synchronizer_parameters + StaticSynchronizerParameters + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ required_signing_specs + RequiredSigningSpecs + +
+ +
+ +
+
+ required_encryption_specs + RequiredEncryptionSpecs + +
+ +
+ +
+
+ required_symmetric_key_schemes + repeated SymmetricKeyScheme + +
+ +
+ +
+
+ required_hash_algorithms + repeated HashAlgorithm + +
+ +
+ +
+
+ required_crypto_key_formats + repeated CryptoKeyFormat + +
+ +
+ +
+
+ required_signature_formats + repeated SignatureFormat + +
+ +
+ +
+
+ protocol_version + int32 + +
+ +
+ +
+
+ serial + int32 + +
+ +
Serial of the synchronizer. Must be non-negative.
+ +
+ +
+
+ enable_transparency_checks + bool + +
+ +
Flag to enable transparency checks.
+ +
+ +
+
+ topology_change_delay + Duration + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ algorithms + repeated SigningAlgorithmSpec + +
+ +
+ +
+
+ keys + repeated SigningKeySpec + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • SIGNING_ALGORITHM_SPEC_UNSPECIFIED
    • + +
  • SIGNING_ALGORITHM_SPEC_ED25519
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_256
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_384
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_SPEC_UNSPECIFIED
    • + +
  • SIGNING_KEY_SPEC_EC_CURVE25519
    • + +
  • SIGNING_KEY_SPEC_EC_P256
    • + +
  • SIGNING_KEY_SPEC_EC_P384
    • + +
  • SIGNING_KEY_SPEC_EC_SECP256K1
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ algorithms + repeated EncryptionAlgorithmSpec + +
+ +
+ +
+
+ keys + repeated EncryptionKeySpec + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • ENCRYPTION_ALGORITHM_SPEC_UNSPECIFIED
    • + +
  • ENCRYPTION_ALGORITHM_SPEC_ECIES_HKDF_HMAC_SHA256_AES128CBC
    • + +
  • ENCRYPTION_ALGORITHM_SPEC_RSA_OAEP_SHA256
    • + +
+ + +
+ + + +
+ + + +
    + +
  • ENCRYPTION_KEY_SPEC_UNSPECIFIED
    • + +
  • ENCRYPTION_KEY_SPEC_EC_P256
    • + +
  • ENCRYPTION_KEY_SPEC_RSA_2048
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SYMMETRIC_KEY_SCHEME_UNSPECIFIED
    • + +
  • SYMMETRIC_KEY_SCHEME_AES128GCM
    • + +
+ + +
+ + + +
+ + + +
    + +
  • HASH_ALGORITHM_UNSPECIFIED
    • + +
  • HASH_ALGORITHM_SHA256
    • + +
+ + +
+ + + +
+ + + +
    + +
  • CRYPTO_KEY_FORMAT_UNSPECIFIED
    • + +
  • CRYPTO_KEY_FORMAT_DER
    • + +
  • CRYPTO_KEY_FORMAT_RAW
    • + +
  • CRYPTO_KEY_FORMAT_DER_X509_SUBJECT_PUBLIC_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_DER_PKCS8_PRIVATE_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_SYMBOLIC
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNATURE_FORMAT_UNSPECIFIED
    • + +
  • SIGNATURE_FORMAT_RAW
    • + +
  • SIGNATURE_FORMAT_DER
    • + +
  • SIGNATURE_FORMAT_CONCAT
    • + +
  • SIGNATURE_FORMAT_SYMBOLIC
    • + +
+ + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/clearschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/clearschedule.mdx new file mode 100644 index 0000000..68eace4 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/clearschedule.mdx @@ -0,0 +1,248 @@ +--- +title: "ClearSchedule" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.admin.v30

+ + +

ClearSchedule

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.admin.v30.SequencerPruningAdministrationService/ClearSchedule + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerPruningAdministrationService/ClearSchedule <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerPruningAdministrationService
+
+ +
+
RPC
+
ClearSchedule
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ClearScheduleRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.ClearScheduleRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

ClearScheduleResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.ClearScheduleResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/findpruningtimestamp.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/findpruningtimestamp.mdx new file mode 100644 index 0000000..fa7a38e --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/findpruningtimestamp.mdx @@ -0,0 +1,312 @@ +--- +title: "FindPruningTimestamp" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.admin.v30

+ + +

FindPruningTimestamp

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.admin.v30.SequencerPruningAdministrationService/FindPruningTimestamp + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerPruningAdministrationService/FindPruningTimestamp <<'EOF' +{ + "index": 0 +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "timestamp": "string" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerPruningAdministrationService
+
+ +
+
RPC
+
FindPruningTimestamp
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

FindPruningTimestampRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.FindPruningTimestampRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ index + int32 + +
+ +
the index to look up the offset for, needs to be 1 or larger i.e. 1 for returning the first timestamp, 2 for the second timestamp etc
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

FindPruningTimestampResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.FindPruningTimestampResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ timestamp + Timestamp + +
+ +
optional, not set if less than `index` events exist
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ index + int32 + +
+ +
the index to look up the offset for, needs to be 1 or larger i.e. 1 for returning the first timestamp, 2 for the second timestamp etc
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ timestamp + Timestamp + +
+ +
optional, not set if less than `index` events exist
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/getschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/getschedule.mdx new file mode 100644 index 0000000..c4de4a1 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/getschedule.mdx @@ -0,0 +1,320 @@ +--- +title: "GetSchedule" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.admin.v30

+ + +

GetSchedule

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.admin.v30.SequencerPruningAdministrationService/GetSchedule + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerPruningAdministrationService/GetSchedule <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "schedule": { + "cron": "string", + "maxDuration": "string", + "retention": "string" + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerPruningAdministrationService
+
+ +
+
RPC
+
GetSchedule
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetScheduleRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.GetScheduleRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

GetScheduleResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.GetScheduleResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ schedule + PruningSchedule + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ schedule + PruningSchedule + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ cron + string + +
+ +
+ +
+
+ max_duration + Duration + +
+ +
+ +
+
+ retention + Duration + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/prune.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/prune.mdx new file mode 100644 index 0000000..ce151f4 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/prune.mdx @@ -0,0 +1,308 @@ +--- +title: "Prune" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.admin.v30

+ + +

Prune

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.admin.v30.SequencerPruningAdministrationService/Prune + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerPruningAdministrationService/Prune <<'EOF' +{ + "timestamp": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "details": "string" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerPruningAdministrationService
+
+ +
+
RPC
+
Prune
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

PruneRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.PruneRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ timestamp + Timestamp + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

PruneResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.admin.v30.PruneResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ details + string + +
+ +
description of what was removed
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ timestamp + Timestamp + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ details + string + +
+ +
description of what was removed
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setcron.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setcron.mdx new file mode 100644 index 0000000..fb604ec --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setcron.mdx @@ -0,0 +1,276 @@ +--- +title: "SetCron" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.admin.v30

+ + +

SetCron

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.admin.v30.SequencerPruningAdministrationService/SetCron + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerPruningAdministrationService/SetCron <<'EOF' +{ + "cron": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerPruningAdministrationService
+
+ +
+
RPC
+
SetCron
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

SetCronRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.SetCronRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ cron + string + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

SetCronResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.SetCronResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ cron + string + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setmaxduration.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setmaxduration.mdx new file mode 100644 index 0000000..0bb1331 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setmaxduration.mdx @@ -0,0 +1,276 @@ +--- +title: "SetMaxDuration" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.admin.v30

+ + +

SetMaxDuration

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.admin.v30.SequencerPruningAdministrationService/SetMaxDuration + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerPruningAdministrationService/SetMaxDuration <<'EOF' +{ + "maxDuration": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerPruningAdministrationService
+
+ +
+
RPC
+
SetMaxDuration
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

SetMaxDurationRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.SetMaxDurationRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ max_duration + Duration + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

SetMaxDurationResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.SetMaxDurationResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ max_duration + Duration + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setretention.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setretention.mdx new file mode 100644 index 0000000..279f11a --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setretention.mdx @@ -0,0 +1,276 @@ +--- +title: "SetRetention" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.admin.v30

+ + +

SetRetention

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.admin.v30.SequencerPruningAdministrationService/SetRetention + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerPruningAdministrationService/SetRetention <<'EOF' +{ + "retention": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerPruningAdministrationService
+
+ +
+
RPC
+
SetRetention
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

SetRetentionRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.SetRetentionRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ retention + Duration + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

SetRetentionResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.SetRetentionResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ retention + Duration + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setschedule.mdx new file mode 100644 index 0000000..58f4ac7 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setschedule.mdx @@ -0,0 +1,320 @@ +--- +title: "SetSchedule" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.admin.v30

+ + +

SetSchedule

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.admin.v30.SequencerPruningAdministrationService/SetSchedule + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerPruningAdministrationService/SetSchedule <<'EOF' +{ + "schedule": { + "cron": "string", + "maxDuration": "string", + "retention": "string" + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerPruningAdministrationService
+
+ +
+
RPC
+
SetSchedule
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

SetScheduleRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.SetScheduleRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ schedule + PruningSchedule + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

SetScheduleResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.admin.pruning.v30.SetScheduleResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ schedule + PruningSchedule + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ cron + string + +
+ +
+ +
+
+ max_duration + Duration + +
+ +
+ +
+
+ retention + Duration + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerauthenticationservice/authenticate.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerauthenticationservice/authenticate.mdx new file mode 100644 index 0000000..66ba272 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerauthenticationservice/authenticate.mdx @@ -0,0 +1,608 @@ +--- +title: "Authenticate" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.api.v30

+ + +

Authenticate

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.api.v30.SequencerAuthenticationService/Authenticate + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.api.v30.SequencerAuthenticationService/Authenticate <<'EOF' +{ + "member": "string", + "signature": { + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signedBy": "string", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", + "signatureDelegation": { + "sessionKey": "BASE64_ENCODED_BYTES", + "sessionKeySpec": "SIGNING_KEY_SPEC_UNSPECIFIED", + "validityPeriodFromInclusive": "0", + "validityPeriodDurationSeconds": 0, + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" + } + }, + "nonce": "BASE64_ENCODED_BYTES" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "token": "BASE64_ENCODED_BYTES", + "expiresAt": "string" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerAuthenticationService
+
+ +
+
RPC
+
Authenticate
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

AuthenticateRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication.AuthenticateRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ member + string + +
+ +
member sending request
+ +
+ +
+
+ signature + Signature + +
+ +
signature of the handshake nonce Any key that is valid at time of verification may be used
+ +
+ +
+
+ nonce + bytes + +
+ +
nonce value that was signed is sent back to identify the challenge
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

AuthenticateResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication.AuthenticateResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ token + bytes + +
+ +
+ +
+
+ expires_at + Timestamp + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ member + string + +
+ +
member sending request
+ +
+ +
+
+ signature + Signature + +
+ +
signature of the handshake nonce Any key that is valid at time of verification may be used
+ +
+ +
+
+ nonce + bytes + +
+ +
nonce value that was signed is sent back to identify the challenge
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ format + SignatureFormat + +
+ +
+ +
+
+ signature + bytes + +
+ +
+ +
+
+ signed_by + string + +
+ +
The fingerprint/id of the keypair used to create this signature and needed to verify. If a signature delegation is defined, this fingerprint/id is not used to produce the signature, and, instead is used to sign the delegation.
+ +
+ +
+
+ signing_algorithm_spec + SigningAlgorithmSpec + +
+ +
The signing algorithm specification used to produce this signature
+ +
+ +
+
+ signature_delegation + SignatureDelegation + +
+ +
An optional signature delegation where a long-term signing key authorizes a session signing key to sign on its behalf.
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • SIGNATURE_FORMAT_UNSPECIFIED
    • + +
  • SIGNATURE_FORMAT_RAW
    • + +
  • SIGNATURE_FORMAT_DER
    • + +
  • SIGNATURE_FORMAT_CONCAT
    • + +
  • SIGNATURE_FORMAT_SYMBOLIC
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_ALGORITHM_SPEC_UNSPECIFIED
    • + +
  • SIGNING_ALGORITHM_SPEC_ED25519
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_256
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_384
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ session_key + bytes + +
+ +
ASN.1 + DER-encoding of X.509 SubjectPublicKeyInfo structure of the session public key: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1. This key was used to produce the actual signature.
+ +
+ +
+
+ session_key_spec + SigningKeySpec + +
+ +
The signing key spec for the session key.
+ +
+ +
+
+ validity_period_from_inclusive + int64 + +
+ +
A timestamp in microseconds of UTC time since Unix epoch that indicates when the session key is considered valid.
+ +
+ +
+
+ validity_period_duration_seconds + uint32 + +
+ +
Duration in seconds indicating how long the session key remains valid. The validity period starts from `validity_period_from_inclusive` above.
+ +
+ +
+
+ format + SignatureFormat + +
+ +
The format of the signature
+ +
+ +
+
+ signature + bytes + +
+ +
The signature of the combined hash of the session key fingerprint, validity period, and synchronizer id, by the long-term key. This signature authorizes the session key to act on behalf of the long-term key.
+ +
+ +
+
+ signing_algorithm_spec + SigningAlgorithmSpec + +
+ +
The signing algorithm specification used to produce this signature
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_SPEC_UNSPECIFIED
    • + +
  • SIGNING_KEY_SPEC_EC_CURVE25519
    • + +
  • SIGNING_KEY_SPEC_EC_P256
    • + +
  • SIGNING_KEY_SPEC_EC_P384
    • + +
  • SIGNING_KEY_SPEC_EC_SECP256K1
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ token + bytes + +
+ +
+ +
+
+ expires_at + Timestamp + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerauthenticationservice/challenge.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerauthenticationservice/challenge.mdx new file mode 100644 index 0000000..6545e4f --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerauthenticationservice/challenge.mdx @@ -0,0 +1,354 @@ +--- +title: "Challenge" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.api.v30

+ + +

Challenge

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.api.v30.SequencerAuthenticationService/Challenge + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.api.v30.SequencerAuthenticationService/Challenge <<'EOF' +{ + "member": "string", + "memberProtocolVersions": [ + 0 + ] +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "nonce": "BASE64_ENCODED_BYTES", + "fingerprints": [ + "string" + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerAuthenticationService
+
+ +
+
RPC
+
Challenge
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ChallengeRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication.ChallengeRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ member + string + +
+ +
+ +
+
+ member_protocol_versions + repeated int32 + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ChallengeResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication.ChallengeResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ nonce + bytes + +
+ +
random nonce to be used for authentication
+ +
+ +
+
+ fingerprints + repeated string + +
+ +
A hint containing fingerprints of keys that the sequencer considers valid This is helpful, because the client does not necessarily have the current topology state before connecting.
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ member + string + +
+ +
+ +
+
+ member_protocol_versions + repeated int32 + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ nonce + bytes + +
+ +
random nonce to be used for authentication
+ +
+ +
+
+ fingerprints + repeated string + +
+ +
A hint containing fingerprints of keys that the sequencer considers valid This is helpful, because the client does not necessarily have the current topology state before connecting.
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerauthenticationservice/logout.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerauthenticationservice/logout.mdx new file mode 100644 index 0000000..18ce51f --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerauthenticationservice/logout.mdx @@ -0,0 +1,280 @@ +--- +title: "Logout" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.api.v30

+ + +

Logout

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.api.v30.SequencerAuthenticationService/Logout + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.api.v30.SequencerAuthenticationService/Logout <<'EOF' +{ + "token": "BASE64_ENCODED_BYTES" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerAuthenticationService
+
+ +
+
RPC
+
Logout
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

LogoutRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication.LogoutRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ token + bytes + +
+ +
token to identify the member to invalidate
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

LogoutResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication.LogoutResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ token + bytes + +
+ +
token to identify the member to invalidate
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerchannelservice/connecttosequencerchannel.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerchannelservice/connecttosequencerchannel.mdx new file mode 100644 index 0000000..9ffb6ba --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerchannelservice/connecttosequencerchannel.mdx @@ -0,0 +1,679 @@ +--- +title: "ConnectToSequencerChannel" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.api.v30

+ + +

ConnectToSequencerChannel

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.api.v30.SequencerChannelService/ConnectToSequencerChannel + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.api.v30.SequencerChannelService/ConnectToSequencerChannel <<'EOF' +{ + "metadata": { + "channelId": "string", + "initiatingMember": "string", + "receivingMember": "string" + }, + "traceContext": { + "traceparent": "string", + "tracestate": "string" + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "connected": {}, + "traceContext": { + "traceparent": "string", + "tracestate": "string" + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerChannelService
+
+ +
+
RPC
+
ConnectToSequencerChannel
+
+ +
+
Client stream
+
Yes
+
+ +
+
Server stream
+
Yes
+
+ +
+ + +## Inputs + + +
+
+

ConnectToSequencerChannelRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.api.v30.ConnectToSequencerChannelRequest
+
+ +
+
Client stream
+
Yes
+
+ +
+ + + + +
+ +
+
+ metadata + SequencerChannelMetadata + +
+ +
Exactly the first message of the channel request stream must be SequencerChannelMetadata for use by the sequencer channel service to match channel endpoint members.
+ +
+ +
+
+ session_key + SequencerChannelSessionKey + +
+ +
SequencerChannelSessionKey and SequencerChannelSessionKeyAck are used to send and acknowledge an asymmetrically encrypted session key between the sequencer channel client endpoints. The SequencerChannelSessionKey is opaque to sequencer channel service.
+ +
+ +
+
+ session_key_acknowledgement + SequencerChannelSessionKeyAck + +
+ +
+ +
+
+ payload + bytes + +
+ +
Payload is opaque to the sequencer channel service and client.
+ +
+ +
+
+ trace_context + TraceContext + +
+ +
Canton trace context Required
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ConnectToSequencerChannelResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.api.v30.ConnectToSequencerChannelResponse
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + +
+ +
+
+ connected + SequencerChannelConnectedToAllEndpoints + +
+ +
Exactly the first message of the channel response stream must be SequencerChannelConnectedToAllEndpoints for use by the sequencer channel client to notify the request initiator that the channel is ready for use.
+ +
+ +
+
+ session_key + SequencerChannelSessionKey + +
+ +
SequencerChannelSessionKey and SequencerChannelSessionKeyAck are used to send and acknowledge an asymmetrically encrypted session key between the sequencer channel client endpoints. The SequencerChannelSessionKey is opaque to sequencer channel service.
+ +
+ +
+
+ session_key_acknowledgement + SequencerChannelSessionKeyAck + +
+ +
+ +
+
+ payload + bytes + +
+ +
Payload is opaque to the sequencer channel service and client.
+ +
+ +
+
+ trace_context + TraceContext + +
+ +
Canton trace context Required
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ metadata + SequencerChannelMetadata + +
+ +
Exactly the first message of the channel request stream must be SequencerChannelMetadata for use by the sequencer channel service to match channel endpoint members.
+ +
+ +
+
+ session_key + SequencerChannelSessionKey + +
+ +
SequencerChannelSessionKey and SequencerChannelSessionKeyAck are used to send and acknowledge an asymmetrically encrypted session key between the sequencer channel client endpoints. The SequencerChannelSessionKey is opaque to sequencer channel service.
+ +
+ +
+
+ session_key_acknowledgement + SequencerChannelSessionKeyAck + +
+ +
+ +
+
+ payload + bytes + +
+ +
Payload is opaque to the sequencer channel service and client.
+ +
+ +
+
+ trace_context + TraceContext + +
+ +
Canton trace context Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ channel_id + string + +
+ +
Channel identifier Required
+ +
+ +
+
+ initiating_member + string + +
+ +
The member initiating the channel connect request Required
+ +
+ +
+
+ receiving_member + string + +
+ +
The member to connect to via the channel Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ encrypted_session_key + AsymmetricEncrypted + +
+ +
The public key is determined by the timestamp as agreed by the connecting members beforehand. The timestamp is expected to originate from a recent topology transaction that has already taken effect; meaning it's not a future timestamp. Required
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ ciphertext + bytes + +
+ +
Asymmetrically encrypted data
+ +
+ +
+
+ encryption_algorithm_spec + EncryptionAlgorithmSpec + +
+ +
The asymmetric encryption specification used for the encryption
+ +
+ +
+
+ fingerprint + string + +
+ +
The fingerprint of the public key that was used for the encryption
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • ENCRYPTION_ALGORITHM_SPEC_UNSPECIFIED
    • + +
  • ENCRYPTION_ALGORITHM_SPEC_ECIES_HKDF_HMAC_SHA256_AES128CBC
    • + +
  • ENCRYPTION_ALGORITHM_SPEC_RSA_OAEP_SHA256
    • + +
+ + +
+ + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ traceparent + string + +
+ +
https://www.w3.org/TR/trace-context/
+ +
+ +
+
+ tracestate + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ connected + SequencerChannelConnectedToAllEndpoints + +
+ +
Exactly the first message of the channel response stream must be SequencerChannelConnectedToAllEndpoints for use by the sequencer channel client to notify the request initiator that the channel is ready for use.
+ +
+ +
+
+ session_key + SequencerChannelSessionKey + +
+ +
SequencerChannelSessionKey and SequencerChannelSessionKeyAck are used to send and acknowledge an asymmetrically encrypted session key between the sequencer channel client endpoints. The SequencerChannelSessionKey is opaque to sequencer channel service.
+ +
+ +
+
+ session_key_acknowledgement + SequencerChannelSessionKeyAck + +
+ +
+ +
+
+ payload + bytes + +
+ +
Payload is opaque to the sequencer channel service and client.
+ +
+ +
+
+ trace_context + TraceContext + +
+ +
Canton trace context Required
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerchannelservice/ping.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerchannelservice/ping.mdx new file mode 100644 index 0000000..5938f4e --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerchannelservice/ping.mdx @@ -0,0 +1,248 @@ +--- +title: "Ping" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.api.v30

+ + +

Ping

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.api.v30.SequencerChannelService/Ping + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.api.v30.SequencerChannelService/Ping <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerChannelService
+
+ +
+
RPC
+
Ping
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

PingRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.api.v30.PingRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

PingResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.api.v30.PingResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/getsynchronizerid.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/getsynchronizerid.mdx new file mode 100644 index 0000000..c76aea0 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/getsynchronizerid.mdx @@ -0,0 +1,295 @@ +--- +title: "GetSynchronizerId" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.api.v30

+ + +

GetSynchronizerId

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.api.v30.SequencerConnectService/GetSynchronizerId + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.api.v30.SequencerConnectService/GetSynchronizerId <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "physicalSynchronizerId": "string", + "sequencerUid": "string" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerConnectService
+
+ +
+
RPC
+
GetSynchronizerId
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetSynchronizerIdRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.api.v30.SequencerConnect.GetSynchronizerIdRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

GetSynchronizerIdResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.api.v30.SequencerConnect.GetSynchronizerIdResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ physical_synchronizer_id + string + +
+ +
+ +
+
+ sequencer_uid + string + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ physical_synchronizer_id + string + +
+ +
+ +
+
+ sequencer_uid + string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/getsynchronizerparameters.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/getsynchronizerparameters.mdx new file mode 100644 index 0000000..68fde1c --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/getsynchronizerparameters.mdx @@ -0,0 +1,640 @@ +--- +title: "GetSynchronizerParameters" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.api.v30

+ + +

GetSynchronizerParameters

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.api.v30.SequencerConnectService/GetSynchronizerParameters + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.api.v30.SequencerConnectService/GetSynchronizerParameters <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "parametersV1": { + "requiredSigningSpecs": { + "algorithms": [ + "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" + ], + "keys": [ + "SIGNING_KEY_SPEC_UNSPECIFIED" + ] + }, + "requiredEncryptionSpecs": { + "algorithms": [ + "ENCRYPTION_ALGORITHM_SPEC_UNSPECIFIED" + ], + "keys": [ + "ENCRYPTION_KEY_SPEC_UNSPECIFIED" + ] + }, + "requiredSymmetricKeySchemes": [ + "SYMMETRIC_KEY_SCHEME_UNSPECIFIED" + ], + "requiredHashAlgorithms": [ + "HASH_ALGORITHM_UNSPECIFIED" + ], + "requiredCryptoKeyFormats": [ + "CRYPTO_KEY_FORMAT_UNSPECIFIED" + ], + "requiredSignatureFormats": [ + "SIGNATURE_FORMAT_UNSPECIFIED" + ], + "protocolVersion": 0, + "serial": 0 + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerConnectService
+
+ +
+
RPC
+
GetSynchronizerParameters
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetSynchronizerParametersRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.api.v30.SequencerConnect.GetSynchronizerParametersRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

GetSynchronizerParametersResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.api.v30.SequencerConnect.GetSynchronizerParametersResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ parameters_v1 + StaticSynchronizerParameters + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ parameters_v1 + StaticSynchronizerParameters + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ required_signing_specs + RequiredSigningSpecs + +
+ +
+ +
+
+ required_encryption_specs + RequiredEncryptionSpecs + +
+ +
+ +
+
+ required_symmetric_key_schemes + repeated SymmetricKeyScheme + +
+ +
+ +
+
+ required_hash_algorithms + repeated HashAlgorithm + +
+ +
+ +
+
+ required_crypto_key_formats + repeated CryptoKeyFormat + +
+ +
+ +
+
+ required_signature_formats + repeated SignatureFormat + +
+ +
+ +
+
+ protocol_version + int32 + +
+ +
+ +
+
+ serial + int32 + +
+ +
Serial of the synchronizer. Must be non-negative.
+ +
+ +
+
+ enable_transparency_checks + bool + +
+ +
Flag to enable transparency checks.
+ +
+ +
+
+ topology_change_delay + Duration + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ algorithms + repeated SigningAlgorithmSpec + +
+ +
+ +
+
+ keys + repeated SigningKeySpec + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • SIGNING_ALGORITHM_SPEC_UNSPECIFIED
    • + +
  • SIGNING_ALGORITHM_SPEC_ED25519
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_256
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_384
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_SPEC_UNSPECIFIED
    • + +
  • SIGNING_KEY_SPEC_EC_CURVE25519
    • + +
  • SIGNING_KEY_SPEC_EC_P256
    • + +
  • SIGNING_KEY_SPEC_EC_P384
    • + +
  • SIGNING_KEY_SPEC_EC_SECP256K1
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ algorithms + repeated EncryptionAlgorithmSpec + +
+ +
+ +
+
+ keys + repeated EncryptionKeySpec + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • ENCRYPTION_ALGORITHM_SPEC_UNSPECIFIED
    • + +
  • ENCRYPTION_ALGORITHM_SPEC_ECIES_HKDF_HMAC_SHA256_AES128CBC
    • + +
  • ENCRYPTION_ALGORITHM_SPEC_RSA_OAEP_SHA256
    • + +
+ + +
+ + + +
+ + + +
    + +
  • ENCRYPTION_KEY_SPEC_UNSPECIFIED
    • + +
  • ENCRYPTION_KEY_SPEC_EC_P256
    • + +
  • ENCRYPTION_KEY_SPEC_RSA_2048
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SYMMETRIC_KEY_SCHEME_UNSPECIFIED
    • + +
  • SYMMETRIC_KEY_SCHEME_AES128GCM
    • + +
+ + +
+ + + +
+ + + +
    + +
  • HASH_ALGORITHM_UNSPECIFIED
    • + +
  • HASH_ALGORITHM_SHA256
    • + +
+ + +
+ + + +
+ + + +
    + +
  • CRYPTO_KEY_FORMAT_UNSPECIFIED
    • + +
  • CRYPTO_KEY_FORMAT_DER
    • + +
  • CRYPTO_KEY_FORMAT_RAW
    • + +
  • CRYPTO_KEY_FORMAT_DER_X509_SUBJECT_PUBLIC_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_DER_PKCS8_PRIVATE_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_SYMBOLIC
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNATURE_FORMAT_UNSPECIFIED
    • + +
  • SIGNATURE_FORMAT_RAW
    • + +
  • SIGNATURE_FORMAT_DER
    • + +
  • SIGNATURE_FORMAT_CONCAT
    • + +
  • SIGNATURE_FORMAT_SYMBOLIC
    • + +
+ + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/handshake.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/handshake.mdx new file mode 100644 index 0000000..8df35c7 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/handshake.mdx @@ -0,0 +1,393 @@ +--- +title: "Handshake" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.api.v30

+ + +

Handshake

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.api.v30.SequencerConnectService/Handshake + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.api.v30.SequencerConnectService/Handshake <<'EOF' +{ + "clientProtocolVersions": [ + 0 + ], + "minimumProtocolVersion": 0 +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "serverProtocolVersion": 0, + "success": {} +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerConnectService
+
+ +
+
RPC
+
Handshake
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

HandshakeRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.api.v30.SequencerConnect.HandshakeRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ client_protocol_versions + repeated int32 + +
+ +
+ +
+
+ minimum_protocol_version + int32 + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

HandshakeResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.api.v30.SequencerConnect.HandshakeResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ server_protocol_version + int32 + +
+ +
+ +
+
+ success + Success + +
+ +
+ +
+
+ failure + Failure + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ client_protocol_versions + repeated int32 + +
+ +
+ +
+
+ minimum_protocol_version + int32 + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ server_protocol_version + int32 + +
+ +
+ +
+
+ success + Success + +
+ +
+ +
+
+ failure + Failure + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ reason + string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/registeronboardingtopologytransactions.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/registeronboardingtopologytransactions.mdx new file mode 100644 index 0000000..c3371ca --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/registeronboardingtopologytransactions.mdx @@ -0,0 +1,627 @@ +--- +title: "RegisterOnboardingTopologyTransactions" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.api.v30

+ + +

RegisterOnboardingTopologyTransactions

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.api.v30.SequencerConnectService/RegisterOnboardingTopologyTransactions + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.api.v30.SequencerConnectService/RegisterOnboardingTopologyTransactions <<'EOF' +{ + "topologyTransactions": [ + { + "transaction": "BASE64_ENCODED_BYTES", + "signatures": [ + { + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signedBy": "string", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", + "signatureDelegation": { + "sessionKey": "BASE64_ENCODED_BYTES", + "sessionKeySpec": "SIGNING_KEY_SPEC_UNSPECIFIED", + "validityPeriodFromInclusive": "0", + "validityPeriodDurationSeconds": 0, + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" + } + } + ], + "proposal": true, + "multiTransactionSignatures": [ + { + "transactionHashes": [ + "BASE64_ENCODED_BYTES" + ], + "signatures": [ + { + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signedBy": "string", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", + "signatureDelegation": {} + } + ] + } + ] + } + ] +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerConnectService
+
+ +
+
RPC
+
RegisterOnboardingTopologyTransactions
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

RegisterOnboardingTopologyTransactionsRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.api.v30.SequencerConnect.RegisterOnboardingTopologyTransactionsRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ topology_transactions + repeated SignedTopologyTransaction + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

RegisterOnboardingTopologyTransactionsResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.api.v30.SequencerConnect.RegisterOnboardingTopologyTransactionsResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ topology_transactions + repeated SignedTopologyTransaction + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ transaction + bytes + +
+ +
serialized topology transaction (protobuf bytestring)
+ +
+ +
+
+ signatures + repeated Signature + +
+ +
multiple signatures Either this field OR the multi_transaction_signatures field MUST contain at least one signature
+ +
+ +
+
+ proposal + bool + +
+ +
if true, this transaction is just a proposal. this means that every signature is valid, but the signatures are insufficient to properly authorize the transaction. proposals are distributed via the topology channel too. proposals will be pruned automatically when the nodes are pruned TODO(#14045) implement pruning
+ +
+ +
+
+ multi_transaction_signatures + repeated MultiTransactionSignatures + +
+ +
If set, the transaction may be authorized by signing a hash computed from multiple transaction hashes This allows to effectively authorize multiple transactions with a single signature. Each item MUST contain the hash of this transaction Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ format + SignatureFormat + +
+ +
+ +
+
+ signature + bytes + +
+ +
+ +
+
+ signed_by + string + +
+ +
The fingerprint/id of the keypair used to create this signature and needed to verify. If a signature delegation is defined, this fingerprint/id is not used to produce the signature, and, instead is used to sign the delegation.
+ +
+ +
+
+ signing_algorithm_spec + SigningAlgorithmSpec + +
+ +
The signing algorithm specification used to produce this signature
+ +
+ +
+
+ signature_delegation + SignatureDelegation + +
+ +
An optional signature delegation where a long-term signing key authorizes a session signing key to sign on its behalf.
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • SIGNATURE_FORMAT_UNSPECIFIED
    • + +
  • SIGNATURE_FORMAT_RAW
    • + +
  • SIGNATURE_FORMAT_DER
    • + +
  • SIGNATURE_FORMAT_CONCAT
    • + +
  • SIGNATURE_FORMAT_SYMBOLIC
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_ALGORITHM_SPEC_UNSPECIFIED
    • + +
  • SIGNING_ALGORITHM_SPEC_ED25519
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_256
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_384
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ session_key + bytes + +
+ +
ASN.1 + DER-encoding of X.509 SubjectPublicKeyInfo structure of the session public key: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1. This key was used to produce the actual signature.
+ +
+ +
+
+ session_key_spec + SigningKeySpec + +
+ +
The signing key spec for the session key.
+ +
+ +
+
+ validity_period_from_inclusive + int64 + +
+ +
A timestamp in microseconds of UTC time since Unix epoch that indicates when the session key is considered valid.
+ +
+ +
+
+ validity_period_duration_seconds + uint32 + +
+ +
Duration in seconds indicating how long the session key remains valid. The validity period starts from `validity_period_from_inclusive` above.
+ +
+ +
+
+ format + SignatureFormat + +
+ +
The format of the signature
+ +
+ +
+
+ signature + bytes + +
+ +
The signature of the combined hash of the session key fingerprint, validity period, and synchronizer id, by the long-term key. This signature authorizes the session key to act on behalf of the long-term key.
+ +
+ +
+
+ signing_algorithm_spec + SigningAlgorithmSpec + +
+ +
The signing algorithm specification used to produce this signature
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_SPEC_UNSPECIFIED
    • + +
  • SIGNING_KEY_SPEC_EC_CURVE25519
    • + +
  • SIGNING_KEY_SPEC_EC_P256
    • + +
  • SIGNING_KEY_SPEC_EC_P384
    • + +
  • SIGNING_KEY_SPEC_EC_SECP256K1
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ transaction_hashes + repeated bytes + +
+ +
List of topology transaction hashes. Required
+ +
+ +
+
+ signatures + repeated Signature + +
+ +
Signatures on the combined hash computed over the transaction_hashes MUST contain at least one
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/verifyactive.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/verifyactive.mdx new file mode 100644 index 0000000..9f6c962 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/verifyactive.mdx @@ -0,0 +1,340 @@ +--- +title: "VerifyActive" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.api.v30

+ + +

VerifyActive

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.api.v30.SequencerConnectService/VerifyActive + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.api.v30.SequencerConnectService/VerifyActive <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "success": { + "isActive": true + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerConnectService
+
+ +
+
RPC
+
VerifyActive
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

VerifyActiveRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.api.v30.SequencerConnect.VerifyActiveRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

VerifyActiveResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.api.v30.SequencerConnect.VerifyActiveResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ success + Success + +
+ +
+ +
+
+ failure + Failure + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ success + Success + +
+ +
+ +
+
+ failure + Failure + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ is_active + bool + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ reason + string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/acknowledgesigned.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/acknowledgesigned.mdx new file mode 100644 index 0000000..e6c9f4c --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/acknowledgesigned.mdx @@ -0,0 +1,280 @@ +--- +title: "AcknowledgeSigned" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.api.v30

+ + +

AcknowledgeSigned

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.api.v30.SequencerService/AcknowledgeSigned + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.api.v30.SequencerService/AcknowledgeSigned <<'EOF' +{ + "signedAcknowledgeRequest": "BASE64_ENCODED_BYTES" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerService
+
+ +
+
RPC
+
AcknowledgeSigned
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

AcknowledgeSignedRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.api.v30.AcknowledgeSignedRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ signed_acknowledge_request + bytes + +
+ +
contains a versioned AcknowledgeRequest TODO(i17383): Have exactly one signature instead of multiple signatures. Serialized SignedContent[AcknowledgeRequest]
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

AcknowledgeSignedResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.api.v30.AcknowledgeSignedResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ signed_acknowledge_request + bytes + +
+ +
contains a versioned AcknowledgeRequest TODO(i17383): Have exactly one signature instead of multiple signatures. Serialized SignedContent[AcknowledgeRequest]
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/downloadtopologystateforinit.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/downloadtopologystateforinit.mdx new file mode 100644 index 0000000..c1b0708 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/downloadtopologystateforinit.mdx @@ -0,0 +1,401 @@ +--- +title: "DownloadTopologyStateForInit" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.api.v30

+ + +

DownloadTopologyStateForInit

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.api.v30.SequencerService/DownloadTopologyStateForInit + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.api.v30.SequencerService/DownloadTopologyStateForInit <<'EOF' +{ + "member": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "topologyTransactions": { + "items": [ + { + "sequenced": "string", + "validFrom": "string", + "validUntil": "string", + "transaction": "BASE64_ENCODED_BYTES", + "rejectionReason": "string" + } + ] + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerService
+
+ +
+
RPC
+
DownloadTopologyStateForInit
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
Yes
+
+ +
+ + +## Inputs + + +
+
+

DownloadTopologyStateForInitRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.api.v30.DownloadTopologyStateForInitRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ member + string + +
+ +
Member for which to get the topology state
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

DownloadTopologyStateForInitResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.api.v30.DownloadTopologyStateForInitResponse
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + +
+ +
+
+ topology_transactions + TopologyTransactions + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ member + string + +
+ +
Member for which to get the topology state
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ topology_transactions + TopologyTransactions + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ items + repeated Item + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ sequenced + Timestamp + +
+ +
+ +
+
+ valid_from + Timestamp + +
+ +
+ +
+
+ valid_until + Timestamp + +
+ +
+ +
+
+ transaction + bytes + +
+ +
* Versioned signed topology transactions serialized as byte-strings. Note that we use here the serialized version that contains the version number. Using the "Versioned" version directly here would create a circular dependency between the proto files. The only proper solution would be to move this into a third separate file with "cross version data files", which we might do at some point.
+ +
+ +
+
+ rejection_reason + string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/downloadtopologystateforinithash.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/downloadtopologystateforinithash.mdx new file mode 100644 index 0000000..7821ddc --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/downloadtopologystateforinithash.mdx @@ -0,0 +1,312 @@ +--- +title: "DownloadTopologyStateForInitHash" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.api.v30

+ + +

DownloadTopologyStateForInitHash

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.api.v30.SequencerService/DownloadTopologyStateForInitHash + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.api.v30.SequencerService/DownloadTopologyStateForInitHash <<'EOF' +{ + "member": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "topologyStateHash": "BASE64_ENCODED_BYTES" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerService
+
+ +
+
RPC
+
DownloadTopologyStateForInitHash
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

DownloadTopologyStateForInitHashRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.api.v30.DownloadTopologyStateForInitHashRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ member + string + +
+ +
Member for which to get the topology state hash
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

DownloadTopologyStateForInitHashResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.api.v30.DownloadTopologyStateForInitHashResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ topology_state_hash + bytes + +
+ +
Hash of contents of a call to DownloadTopologyStateForInit
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ member + string + +
+ +
Member for which to get the topology state hash
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ topology_state_hash + bytes + +
+ +
Hash of contents of a call to DownloadTopologyStateForInit
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/gettime.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/gettime.mdx new file mode 100644 index 0000000..739c180 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/gettime.mdx @@ -0,0 +1,280 @@ +--- +title: "GetTime" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.api.v30

+ + +

GetTime

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.api.v30.SequencerService/GetTime + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.api.v30.SequencerService/GetTime <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "sequencingTimestamp": "0" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerService
+
+ +
+
RPC
+
GetTime
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetTimeRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.api.v30.GetTimeRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

GetTimeResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.api.v30.GetTimeResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ sequencing_timestamp + int64 + +
+ +
The result can be empty if the sequencer is still initializing.
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ sequencing_timestamp + int64 + +
+ +
The result can be empty if the sequencer is still initializing.
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/gettrafficstateformember.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/gettrafficstateformember.mdx new file mode 100644 index 0000000..d4a5a8d --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/gettrafficstateformember.mdx @@ -0,0 +1,417 @@ +--- +title: "GetTrafficStateForMember" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.api.v30

+ + +

GetTrafficStateForMember

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.api.v30.SequencerService/GetTrafficStateForMember + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.api.v30.SequencerService/GetTrafficStateForMember <<'EOF' +{ + "member": "string", + "timestamp": "0" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "trafficState": { + "extraTrafficPurchased": "0", + "extraTrafficConsumed": "0", + "baseTrafficRemainder": "0", + "lastConsumedCost": "0", + "timestamp": "0", + "serial": 0 + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerService
+
+ +
+
RPC
+
GetTrafficStateForMember
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetTrafficStateForMemberRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.api.v30.GetTrafficStateForMemberRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ member + string + +
+ +
Member for which to get the traffic state
+ +
+ +
+
+ timestamp + int64 + +
+ +
Timestamp at which to to get the traffic state
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

GetTrafficStateForMemberResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.api.v30.GetTrafficStateForMemberResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ traffic_state + TrafficState + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ member + string + +
+ +
Member for which to get the traffic state
+ +
+ +
+
+ timestamp + int64 + +
+ +
Timestamp at which to to get the traffic state
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ traffic_state + TrafficState + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ extra_traffic_purchased + int64 + +
+ +
Total amount of extra traffic purchased
+ +
+ +
+
+ extra_traffic_consumed + int64 + +
+ +
Total amount of extra traffic consumed
+ +
+ +
+
+ base_traffic_remainder + int64 + +
+ +
Amount of base traffic remaining
+ +
+ +
+
+ last_consumed_cost + uint64 + +
+ +
Cost deducted at `timestamp`, only present when traffic was consumed at `timestamp`, otherwise is set to 0
+ +
+ +
+
+ timestamp + int64 + +
+ +
Timestamp at which the state is valid
+ +
+ +
+
+ serial + uint32 + +
+ +
Optional serial of the balance update that updated the extra traffic limit
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/sendasync.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/sendasync.mdx new file mode 100644 index 0000000..f99b426 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/sendasync.mdx @@ -0,0 +1,280 @@ +--- +title: "SendAsync" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.api.v30

+ + +

SendAsync

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.api.v30.SequencerService/SendAsync + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.api.v30.SequencerService/SendAsync <<'EOF' +{ + "signedSubmissionRequest": "BASE64_ENCODED_BYTES" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerService
+
+ +
+
RPC
+
SendAsync
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

SendAsyncRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.api.v30.SendAsyncRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ signed_submission_request + bytes + +
+ +
Contains a versioned SignedContent which itself contains a versioned SubmissionRequest. TODO(i17383): Have exactly one signature instead of multiple signatures.
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

SendAsyncResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.api.v30.SendAsyncResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ signed_submission_request + bytes + +
+ +
Contains a versioned SignedContent which itself contains a versioned SubmissionRequest. TODO(i17383): Have exactly one signature instead of multiple signatures.
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/subscribe.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/subscribe.mdx new file mode 100644 index 0000000..1b10431 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/subscribe.mdx @@ -0,0 +1,391 @@ +--- +title: "Subscribe" +--- + +
+ + + + +
+ +

com.digitalasset.canton.sequencer.api.v30

+ + +

Subscribe

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.sequencer.api.v30.SequencerService/Subscribe + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.api.v30.SequencerService/Subscribe <<'EOF' +{ + "member": "string", + "timestamp": "0" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "signedSequencedEvent": "BASE64_ENCODED_BYTES", + "traceContext": { + "traceparent": "string", + "tracestate": "string" + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SequencerService
+
+ +
+
RPC
+
Subscribe
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
Yes
+
+ +
+ + +## Inputs + + +
+
+

SubscriptionRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.api.v30.SubscriptionRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ member + string + +
+ +
+ +
+
+ timestamp + int64 + +
+ +
Timestamp to start the subscription from (inclusive). Members can use the timestamp of the last event they have received to continue from there and compare the event, or can subscribe from previous event timestamp's immediate successor to get the next event. To subscribe from the beginning, set the optional to None. If it refers to an event that has already been acknowledged, the sequencer may reject the request. In microseconds of UTC time since Unix epoch
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

SubscriptionResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.sequencer.api.v30.SubscriptionResponse
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + +
+ +
+
+ signed_sequenced_event + bytes + +
+ +
Contains a versioned SignedContent which itself contains a versioned SequencedEvent Serialized SignedContent[SequencedEvent[ClosedEnvelope]]
+ +
+ +
+
+ trace_context + TraceContext + +
+ +
optional, canton trace context DO NOT RENAME this field, as the ApiRequestLogger uses reflection to read this field. We typically use a header to transfer this information however streamed items do not have per item/message headers, so we instead in this instance set it in the body.
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ member + string + +
+ +
+ +
+
+ timestamp + int64 + +
+ +
Timestamp to start the subscription from (inclusive). Members can use the timestamp of the last event they have received to continue from there and compare the event, or can subscribe from previous event timestamp's immediate successor to get the next event. To subscribe from the beginning, set the optional to None. If it refers to an event that has already been acknowledged, the sequencer may reject the request. In microseconds of UTC time since Unix epoch
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ signed_sequenced_event + bytes + +
+ +
Contains a versioned SignedContent which itself contains a versioned SequencedEvent Serialized SignedContent[SequencedEvent[ClosedEnvelope]]
+ +
+ +
+
+ trace_context + TraceContext + +
+ +
optional, canton trace context DO NOT RENAME this field, as the ApiRequestLogger uses reflection to read this field. We typically use a header to transfer this information however streamed items do not have per item/message headers, so we instead in this instance set it in the body.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ traceparent + string + +
+ +
https://www.w3.org/TR/trace-context/
+ +
+ +
+
+ tracestate + string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-standalone-v1/standalonebftorderingservice/readordered.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-standalone-v1/standalonebftorderingservice/readordered.mdx new file mode 100644 index 0000000..f2aee2e --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-standalone-v1/standalonebftorderingservice/readordered.mdx @@ -0,0 +1,360 @@ +--- +title: "ReadOrdered" +--- + +
+ + + + +
+ +

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1

+ + +

ReadOrdered

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1.StandaloneBftOrderingService/ReadOrdered + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1.StandaloneBftOrderingService/ReadOrdered <<'EOF' +{ + "startHeight": "0" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "height": "0", + "block": [ + { + "tag": "string", + "payload": "BASE64_ENCODED_BYTES" + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
StandaloneBftOrderingService
+
+ +
+
RPC
+
ReadOrdered
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
Yes
+
+ +
+ + +## Inputs + + +
+
+

ReadOrderedRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1.ReadOrderedRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ start_height + int64 + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ReadOrderedResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1.ReadOrderedResponse
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + +
+ +
+
+ height + int64 + +
+ +
+ +
+
+ block + repeated Ordered + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ start_height + int64 + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ height + int64 + +
+ +
+ +
+
+ block + repeated Ordered + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ tag + string + +
+ +
+ +
+
+ payload + bytes + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-standalone-v1/standalonebftorderingservice/send.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-standalone-v1/standalonebftorderingservice/send.mdx new file mode 100644 index 0000000..6562d3b --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-standalone-v1/standalonebftorderingservice/send.mdx @@ -0,0 +1,323 @@ +--- +title: "Send" +--- + +
+ + + + +
+ +

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1

+ + +

Send

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1.StandaloneBftOrderingService/Send + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1.StandaloneBftOrderingService/Send <<'EOF' +{ + "tag": "string", + "payload": "BASE64_ENCODED_BYTES" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "rejectionReason": "string" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
StandaloneBftOrderingService
+
+ +
+
RPC
+
Send
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

SendRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1.SendRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ tag + string + +
+ +
+ +
+
+ payload + bytes + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

SendResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1.SendResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ rejection_reason + string + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ tag + string + +
+ +
+ +
+
+ payload + bytes + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ rejection_reason + string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30/bftorderingservice/receive.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30/bftorderingservice/receive.mdx new file mode 100644 index 0000000..3e400a8 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30/bftorderingservice/receive.mdx @@ -0,0 +1,806 @@ +--- +title: "Receive" +--- + +
+ + + + +
+ +

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30

+ + +

Receive

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.BftOrderingService/Receive + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.BftOrderingService/Receive <<'EOF' +{ + "traceContext": "string", + "body": { + "availabilityMessage": { + "message": "BASE64_ENCODED_BYTES", + "from": "string", + "signature": { + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signedBy": "string", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", + "signatureDelegation": {} + } + } + }, + "sentBy": "string", + "sentAt": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "traceContext": "string", + "body": { + "availabilityMessage": { + "message": "BASE64_ENCODED_BYTES", + "from": "string", + "signature": { + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signedBy": "string", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", + "signatureDelegation": {} + } + } + }, + "sentBy": "string", + "sentAt": "string" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
BftOrderingService
+
+ +
+
RPC
+
Receive
+
+ +
+
Client stream
+
Yes
+
+ +
+
Server stream
+
Yes
+
+ +
+ + +## Inputs + + +
+
+

BftOrderingMessage

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.BftOrderingMessage
+
+ +
+
Client stream
+
Yes
+
+ +
+ + + + +
+ +
+
+ trace_context + string + +
+ +
+ +
+
+ body + BftOrderingMessageBody + +
+ +
+ +
+
+ sent_by + string + +
+ +
+ +
+
+ sent_at + Timestamp + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

BftOrderingMessage

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.BftOrderingMessage
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + +
+ +
+
+ trace_context + string + +
+ +
+ +
+
+ body + BftOrderingMessageBody + +
+ +
+ +
+
+ sent_by + string + +
+ +
+ +
+
+ sent_at + Timestamp + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ trace_context + string + +
+ +
+ +
+
+ body + BftOrderingMessageBody + +
+ +
+ +
+
+ sent_by + string + +
+ +
+ +
+
+ sent_at + Timestamp + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ availability_message + SignedMessage + +
+ +
+ +
+
+ consensus_message + SignedMessage + +
+ +
+ +
+
+ state_transfer_message + SignedMessage + +
+ +
+ +
+
+ retransmission_message + RetransmissionMessage + +
+ +
+ +
+
+ connection_opened + ConnectionOpened + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ message + bytes + +
+ +
+ +
+
+ from + string + +
+ +
+ +
+
+ signature + Signature + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ format + SignatureFormat + +
+ +
+ +
+
+ signature + bytes + +
+ +
+ +
+
+ signed_by + string + +
+ +
The fingerprint/id of the keypair used to create this signature and needed to verify. If a signature delegation is defined, this fingerprint/id is not used to produce the signature, and, instead is used to sign the delegation.
+ +
+ +
+
+ signing_algorithm_spec + SigningAlgorithmSpec + +
+ +
The signing algorithm specification used to produce this signature
+ +
+ +
+
+ signature_delegation + SignatureDelegation + +
+ +
An optional signature delegation where a long-term signing key authorizes a session signing key to sign on its behalf.
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • SIGNATURE_FORMAT_UNSPECIFIED
    • + +
  • SIGNATURE_FORMAT_RAW
    • + +
  • SIGNATURE_FORMAT_DER
    • + +
  • SIGNATURE_FORMAT_CONCAT
    • + +
  • SIGNATURE_FORMAT_SYMBOLIC
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_ALGORITHM_SPEC_UNSPECIFIED
    • + +
  • SIGNING_ALGORITHM_SPEC_ED25519
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_256
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_384
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ session_key + bytes + +
+ +
ASN.1 + DER-encoding of X.509 SubjectPublicKeyInfo structure of the session public key: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1. This key was used to produce the actual signature.
+ +
+ +
+
+ session_key_spec + SigningKeySpec + +
+ +
The signing key spec for the session key.
+ +
+ +
+
+ validity_period_from_inclusive + int64 + +
+ +
A timestamp in microseconds of UTC time since Unix epoch that indicates when the session key is considered valid.
+ +
+ +
+
+ validity_period_duration_seconds + uint32 + +
+ +
Duration in seconds indicating how long the session key remains valid. The validity period starts from `validity_period_from_inclusive` above.
+ +
+ +
+
+ format + SignatureFormat + +
+ +
The format of the signature
+ +
+ +
+
+ signature + bytes + +
+ +
The signature of the combined hash of the session key fingerprint, validity period, and synchronizer id, by the long-term key. This signature authorizes the session key to act on behalf of the long-term key.
+ +
+ +
+
+ signing_algorithm_spec + SigningAlgorithmSpec + +
+ +
The signing algorithm specification used to produce this signature
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_SPEC_UNSPECIFIED
    • + +
  • SIGNING_KEY_SPEC_EC_CURVE25519
    • + +
  • SIGNING_KEY_SPEC_EC_P256
    • + +
  • SIGNING_KEY_SPEC_EC_P384
    • + +
  • SIGNING_KEY_SPEC_EC_SECP256K1
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ retransmission_request + SignedMessage + +
+ +
+ +
+
+ retransmission_response + RetransmissionResponse + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ commit_certificates + repeated CommitCertificate + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ pre_prepare + SignedMessage + +
+ +
+ +
+
+ commits + repeated SignedMessage + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-time-admin-v30/synchronizertimeservice/awaittime.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-time-admin-v30/synchronizertimeservice/awaittime.mdx new file mode 100644 index 0000000..dd90e1e --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-time-admin-v30/synchronizertimeservice/awaittime.mdx @@ -0,0 +1,336 @@ +--- +title: "AwaitTime" +--- + +
+ + + + +
+ +

com.digitalasset.canton.time.admin.v30

+ + +

AwaitTime

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.time.admin.v30.SynchronizerTimeService/AwaitTime + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.time.admin.v30.SynchronizerTimeService/AwaitTime <<'EOF' +{ + "synchronizer": { + "id": "string" + }, + "timestamp": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SynchronizerTimeService
+
+ +
+
RPC
+
AwaitTime
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

AwaitTimeRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.time.admin.v30.AwaitTimeRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ synchronizer + Synchronizer + +
+ +
optional - must be specified for participants but can be defaulted for synchronizer entities as they only have one possible synchronizer
+ +
+ +
+
+ timestamp + Timestamp + +
+ +
the synchronizer time to wait for
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

AwaitTimeResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.time.admin.v30.AwaitTimeResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ synchronizer + Synchronizer + +
+ +
optional - must be specified for participants but can be defaulted for synchronizer entities as they only have one possible synchronizer
+ +
+ +
+
+ timestamp + Timestamp + +
+ +
the synchronizer time to wait for
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ id + string + +
+ +
+ +
+
+ physical_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-time-admin-v30/synchronizertimeservice/fetchtime.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-time-admin-v30/synchronizertimeservice/fetchtime.mdx new file mode 100644 index 0000000..d3b97da --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-time-admin-v30/synchronizertimeservice/fetchtime.mdx @@ -0,0 +1,360 @@ +--- +title: "FetchTime" +--- + +
+ + + + +
+ +

com.digitalasset.canton.time.admin.v30

+ + +

FetchTime

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.time.admin.v30.SynchronizerTimeService/FetchTime + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.time.admin.v30.SynchronizerTimeService/FetchTime <<'EOF' +{ + "synchronizer": { + "id": "string" + }, + "freshnessBound": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "timestamp": "string" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
SynchronizerTimeService
+
+ +
+
RPC
+
FetchTime
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

FetchTimeRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.time.admin.v30.FetchTimeRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ synchronizer + Synchronizer + +
+ +
optional - must be specified for participants but can be defaulted for synchronizer entities as they only have one possible synchronizer
+ +
+ +
+
+ freshness_bound + Duration + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

FetchTimeResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.time.admin.v30.FetchTimeResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ timestamp + Timestamp + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ synchronizer + Synchronizer + +
+ +
optional - must be specified for participants but can be defaulted for synchronizer entities as they only have one possible synchronizer
+ +
+ +
+
+ freshness_bound + Duration + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ id + string + +
+ +
+ +
+
+ physical_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ timestamp + Timestamp + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/identityinitializationservice/currenttime.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/identityinitializationservice/currenttime.mdx new file mode 100644 index 0000000..3d557d0 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/identityinitializationservice/currenttime.mdx @@ -0,0 +1,276 @@ +--- +title: "CurrentTime" +--- + +
+ + + + +
+ +

com.digitalasset.canton.topology.admin.v30

+ + +

CurrentTime

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.topology.admin.v30.IdentityInitializationService/CurrentTime + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.IdentityInitializationService/CurrentTime <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "currentTime": "0" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
IdentityInitializationService
+
+ +
+
RPC
+
CurrentTime
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

CurrentTimeRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.CurrentTimeRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

CurrentTimeResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.CurrentTimeResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ current_time + int64 + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ current_time + int64 + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/identityinitializationservice/getid.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/identityinitializationservice/getid.mdx new file mode 100644 index 0000000..6369df6 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/identityinitializationservice/getid.mdx @@ -0,0 +1,295 @@ +--- +title: "GetId" +--- + +
+ + + + +
+ +

com.digitalasset.canton.topology.admin.v30

+ + +

GetId

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.topology.admin.v30.IdentityInitializationService/GetId + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.IdentityInitializationService/GetId <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "initialized": true, + "uniqueIdentifier": "string" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
IdentityInitializationService
+
+ +
+
RPC
+
GetId
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GetIdRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.GetIdRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

GetIdResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.GetIdResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ initialized + bool + +
+ +
+ +
+
+ unique_identifier + string + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ initialized + bool + +
+ +
+ +
+
+ unique_identifier + string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/identityinitializationservice/initid.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/identityinitializationservice/initid.mdx new file mode 100644 index 0000000..aa27648 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/identityinitializationservice/initid.mdx @@ -0,0 +1,677 @@ +--- +title: "InitId" +--- + +
+ + + + +
+ +

com.digitalasset.canton.topology.admin.v30

+ + +

InitId

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.topology.admin.v30.IdentityInitializationService/InitId + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.IdentityInitializationService/InitId <<'EOF' +{ + "identifier": "string", + "namespace": "string", + "namespaceDelegations": [ + { + "transaction": "BASE64_ENCODED_BYTES", + "signatures": [ + { + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signedBy": "string", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", + "signatureDelegation": { + "sessionKey": "BASE64_ENCODED_BYTES", + "sessionKeySpec": "SIGNING_KEY_SPEC_UNSPECIFIED", + "validityPeriodFromInclusive": "0", + "validityPeriodDurationSeconds": 0, + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" + } + } + ], + "proposal": true, + "multiTransactionSignatures": [ + { + "transactionHashes": [ + "BASE64_ENCODED_BYTES" + ], + "signatures": [ + { + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signedBy": "string", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", + "signatureDelegation": {} + } + ] + } + ] + } + ] +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
IdentityInitializationService
+
+ +
+
RPC
+
InitId
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

InitIdRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.InitIdRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ identifier + string + +
+ +
The identifier of this node
+ +
+ +
+
+ namespace + string + +
+ +
The namespace of this node If empty, then we use the namespace of the first certificate. If both are set, then we assert that the namespace matches the namespace of the first certificate.
+ +
+ +
+
+ namespace_delegations + repeated SignedTopologyTransaction + +
+ +
Optional set of namespace_delegations for this node (in case we are using external root keys)
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

InitIdResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.InitIdResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ identifier + string + +
+ +
The identifier of this node
+ +
+ +
+
+ namespace + string + +
+ +
The namespace of this node If empty, then we use the namespace of the first certificate. If both are set, then we assert that the namespace matches the namespace of the first certificate.
+ +
+ +
+
+ namespace_delegations + repeated SignedTopologyTransaction + +
+ +
Optional set of namespace_delegations for this node (in case we are using external root keys)
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ transaction + bytes + +
+ +
serialized topology transaction (protobuf bytestring)
+ +
+ +
+
+ signatures + repeated Signature + +
+ +
multiple signatures Either this field OR the multi_transaction_signatures field MUST contain at least one signature
+ +
+ +
+
+ proposal + bool + +
+ +
if true, this transaction is just a proposal. this means that every signature is valid, but the signatures are insufficient to properly authorize the transaction. proposals are distributed via the topology channel too. proposals will be pruned automatically when the nodes are pruned TODO(#14045) implement pruning
+ +
+ +
+
+ multi_transaction_signatures + repeated MultiTransactionSignatures + +
+ +
If set, the transaction may be authorized by signing a hash computed from multiple transaction hashes This allows to effectively authorize multiple transactions with a single signature. Each item MUST contain the hash of this transaction Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ format + SignatureFormat + +
+ +
+ +
+
+ signature + bytes + +
+ +
+ +
+
+ signed_by + string + +
+ +
The fingerprint/id of the keypair used to create this signature and needed to verify. If a signature delegation is defined, this fingerprint/id is not used to produce the signature, and, instead is used to sign the delegation.
+ +
+ +
+
+ signing_algorithm_spec + SigningAlgorithmSpec + +
+ +
The signing algorithm specification used to produce this signature
+ +
+ +
+
+ signature_delegation + SignatureDelegation + +
+ +
An optional signature delegation where a long-term signing key authorizes a session signing key to sign on its behalf.
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • SIGNATURE_FORMAT_UNSPECIFIED
    • + +
  • SIGNATURE_FORMAT_RAW
    • + +
  • SIGNATURE_FORMAT_DER
    • + +
  • SIGNATURE_FORMAT_CONCAT
    • + +
  • SIGNATURE_FORMAT_SYMBOLIC
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_ALGORITHM_SPEC_UNSPECIFIED
    • + +
  • SIGNING_ALGORITHM_SPEC_ED25519
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_256
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_384
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ session_key + bytes + +
+ +
ASN.1 + DER-encoding of X.509 SubjectPublicKeyInfo structure of the session public key: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1. This key was used to produce the actual signature.
+ +
+ +
+
+ session_key_spec + SigningKeySpec + +
+ +
The signing key spec for the session key.
+ +
+ +
+
+ validity_period_from_inclusive + int64 + +
+ +
A timestamp in microseconds of UTC time since Unix epoch that indicates when the session key is considered valid.
+ +
+ +
+
+ validity_period_duration_seconds + uint32 + +
+ +
Duration in seconds indicating how long the session key remains valid. The validity period starts from `validity_period_from_inclusive` above.
+ +
+ +
+
+ format + SignatureFormat + +
+ +
The format of the signature
+ +
+ +
+
+ signature + bytes + +
+ +
The signature of the combined hash of the session key fingerprint, validity period, and synchronizer id, by the long-term key. This signature authorizes the session key to act on behalf of the long-term key.
+ +
+ +
+
+ signing_algorithm_spec + SigningAlgorithmSpec + +
+ +
The signing algorithm specification used to produce this signature
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_SPEC_UNSPECIFIED
    • + +
  • SIGNING_KEY_SPEC_EC_CURVE25519
    • + +
  • SIGNING_KEY_SPEC_EC_P256
    • + +
  • SIGNING_KEY_SPEC_EC_P384
    • + +
  • SIGNING_KEY_SPEC_EC_SECP256K1
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ transaction_hashes + repeated bytes + +
+ +
List of topology transaction hashes. Required
+ +
+ +
+
+ signatures + repeated Signature + +
+ +
Signatures on the combined hash computed over the transaction_hashes MUST contain at least one
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologyaggregationservice/listkeyowners.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologyaggregationservice/listkeyowners.mdx new file mode 100644 index 0000000..1cb55b4 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologyaggregationservice/listkeyowners.mdx @@ -0,0 +1,720 @@ +--- +title: "ListKeyOwners" +--- + +
+ + + + +
+ +

com.digitalasset.canton.topology.admin.v30

+ + +

ListKeyOwners

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.topology.admin.v30.TopologyAggregationService/ListKeyOwners + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyAggregationService/ListKeyOwners <<'EOF' +{ + "asOf": "string", + "limit": 0, + "synchronizerIds": [ + "string" + ], + "filterKeyOwnerType": "string", + "filterKeyOwnerUid": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "results": [ + { + "synchronizerId": "string", + "keyOwner": "string", + "signingKeys": [ + { + "format": "CRYPTO_KEY_FORMAT_UNSPECIFIED", + "publicKey": "BASE64_ENCODED_BYTES", + "scheme": "SIGNING_KEY_SCHEME_UNSPECIFIED", + "usage": [ + "SIGNING_KEY_USAGE_UNSPECIFIED" + ], + "keySpec": "SIGNING_KEY_SPEC_UNSPECIFIED" + } + ], + "encryptionKeys": [ + { + "format": "CRYPTO_KEY_FORMAT_UNSPECIFIED", + "publicKey": "BASE64_ENCODED_BYTES", + "scheme": "ENCRYPTION_KEY_SCHEME_UNSPECIFIED", + "keySpec": "ENCRYPTION_KEY_SPEC_UNSPECIFIED" + } + ], + "physicalSynchronizerId": "string" + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
TopologyAggregationService
+
+ +
+
RPC
+
ListKeyOwners
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ListKeyOwnersRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ListKeyOwnersRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ as_of + Timestamp + +
+ +
+ +
+
+ limit + int32 + +
+ +
+ +
+
+ synchronizer_ids + repeated string + +
+ +
+ +
+
+ filter_key_owner_type + string + +
+ +
+ +
+
+ filter_key_owner_uid + string + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ListKeyOwnersResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ListKeyOwnersResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ as_of + Timestamp + +
+ +
+ +
+
+ limit + int32 + +
+ +
+ +
+
+ synchronizer_ids + repeated string + +
+ +
+ +
+
+ filter_key_owner_type + string + +
+ +
+ +
+
+ filter_key_owner_uid + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ synchronizer_id + string + +
+ +
+ +
+
+ key_owner + string + +
+ +
+ +
+
+ signing_keys + repeated SigningPublicKey + +
+ +
+ +
+
+ encryption_keys + repeated EncryptionPublicKey + +
+ +
+ +
+
+ physical_synchronizer_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ format + CryptoKeyFormat + +
+ +
+ +
+
+ public_key + bytes + +
+ +
Serialized public key in the format specified above
+ +
+ +
+
+ scheme + SigningKeyScheme + +
+ +
No longer used (only kept for backwards compatibility) stores both the crypto key scheme and algorithm.
+ +
+ +
+
+ usage + repeated SigningKeyUsage + +
+ +
Explicitly state the key's intended use
+ +
+ +
+
+ key_spec + SigningKeySpec + +
+ +
The key specification that was used to generate the key pair
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • CRYPTO_KEY_FORMAT_UNSPECIFIED
    • + +
  • CRYPTO_KEY_FORMAT_DER
    • + +
  • CRYPTO_KEY_FORMAT_RAW
    • + +
  • CRYPTO_KEY_FORMAT_DER_X509_SUBJECT_PUBLIC_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_DER_PKCS8_PRIVATE_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_SYMBOLIC
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_SCHEME_UNSPECIFIED
    • + +
  • SIGNING_KEY_SCHEME_ED25519
    • + +
  • SIGNING_KEY_SCHEME_EC_DSA_P256
    • + +
  • SIGNING_KEY_SCHEME_EC_DSA_P384
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_USAGE_UNSPECIFIED
    • + +
  • SIGNING_KEY_USAGE_NAMESPACE
    • + +
  • SIGNING_KEY_USAGE_IDENTITY_DELEGATION
    • + +
  • SIGNING_KEY_USAGE_SEQUENCER_AUTHENTICATION
    • + +
  • SIGNING_KEY_USAGE_PROTOCOL
    • + +
  • SIGNING_KEY_USAGE_PROOF_OF_OWNERSHIP
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_SPEC_UNSPECIFIED
    • + +
  • SIGNING_KEY_SPEC_EC_CURVE25519
    • + +
  • SIGNING_KEY_SPEC_EC_P256
    • + +
  • SIGNING_KEY_SPEC_EC_P384
    • + +
  • SIGNING_KEY_SPEC_EC_SECP256K1
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ format + CryptoKeyFormat + +
+ +
+ +
+
+ public_key + bytes + +
+ +
Serialized public key in the format specified above
+ +
+ +
+
+ scheme + EncryptionKeyScheme + +
+ +
No longer used (only kept for backwards compatibility) stores both the crypto key scheme and algorithm.
+ +
+ +
+
+ key_spec + EncryptionKeySpec + +
+ +
The key specification that was used to generate the key pair
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • ENCRYPTION_KEY_SCHEME_UNSPECIFIED
    • + +
  • ENCRYPTION_KEY_SCHEME_ECIES_P256_HKDF_HMAC_SHA256_AES128GCM
    • + +
  • ENCRYPTION_KEY_SCHEME_ECIES_P256_HMAC_SHA256A_ES128CBC
    • + +
  • ENCRYPTION_KEY_SCHEME_RSA2048_OAEP_SHA256
    • + +
+ + +
+ + + +
+ + + +
    + +
  • ENCRYPTION_KEY_SPEC_UNSPECIFIED
    • + +
  • ENCRYPTION_KEY_SPEC_EC_P256
    • + +
  • ENCRYPTION_KEY_SPEC_RSA_2048
    • + +
+ + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologyaggregationservice/listparties.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologyaggregationservice/listparties.mdx new file mode 100644 index 0000000..7e7823a --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologyaggregationservice/listparties.mdx @@ -0,0 +1,523 @@ +--- +title: "ListParties" +--- + +
+ + + + +
+ +

com.digitalasset.canton.topology.admin.v30

+ + +

ListParties

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.topology.admin.v30.TopologyAggregationService/ListParties + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyAggregationService/ListParties <<'EOF' +{ + "asOf": "string", + "limit": 0, + "synchronizerIds": [ + "string" + ], + "filterParty": "string", + "filterParticipant": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "results": [ + { + "party": "string", + "participants": [ + { + "participantUid": "string", + "synchronizers": [ + { + "synchronizerId": "string", + "permission": "PARTICIPANT_PERMISSION_UNSPECIFIED", + "physicalSynchronizerId": "string" + } + ] + } + ] + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
TopologyAggregationService
+
+ +
+
RPC
+
ListParties
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ListPartiesRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ListPartiesRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ as_of + Timestamp + +
+ +
+ +
+
+ limit + int32 + +
+ +
+ +
+
+ synchronizer_ids + repeated string + +
+ +
+ +
+
+ filter_party + string + +
+ +
+ +
+
+ filter_participant + string + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ListPartiesResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ListPartiesResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ as_of + Timestamp + +
+ +
+ +
+
+ limit + int32 + +
+ +
+ +
+
+ synchronizer_ids + repeated string + +
+ +
+ +
+
+ filter_party + string + +
+ +
+ +
+
+ filter_participant + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ party + string + +
+ +
+ +
+
+ participants + repeated ParticipantSynchronizers + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ participant_uid + string + +
+ +
+ +
+
+ synchronizers + repeated SynchronizerPermissions + +
+ +
* permissions of this participant for this party on a per synchronizer basis for records that only exist in the authorized store, this list will be empty.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ synchronizer_id + string + +
+ +
+ +
+
+ permission + ParticipantPermission + +
+ +
+ +
+
+ physical_synchronizer_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • PARTICIPANT_PERMISSION_UNSPECIFIED
    • + +
  • PARTICIPANT_PERMISSION_SUBMISSION
    • + +
  • PARTICIPANT_PERMISSION_CONFIRMATION
    • + +
  • PARTICIPANT_PERMISSION_OBSERVATION
    • + +
+ + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/exporttopologysnapshot.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/exporttopologysnapshot.mdx new file mode 100644 index 0000000..f006c90 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/exporttopologysnapshot.mdx @@ -0,0 +1,593 @@ +--- +title: "ExportTopologySnapshot" +--- + +
+ + + + +
+ +

com.digitalasset.canton.topology.admin.v30

+ + +

ExportTopologySnapshot

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ExportTopologySnapshot + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ExportTopologySnapshot <<'EOF' +{ + "baseQuery": { + "store": { + "authorized": {} + }, + "proposals": true, + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "snapshot": "string", + "filterSignedKey": "string", + "protocolVersion": 0 + }, + "excludeMappings": [ + "string" + ], + "filterNamespace": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "chunk": "BASE64_ENCODED_BYTES" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
TopologyManagerReadService
+
+ +
+
RPC
+
ExportTopologySnapshot
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
Yes
+
+ +
+ + +## Inputs + + +
+
+

ExportTopologySnapshotRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ExportTopologySnapshotRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ exclude_mappings + repeated string + +
+ +
+ +
+
+ filter_namespace + string + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ExportTopologySnapshotResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ExportTopologySnapshotResponse
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + +
+ +
+
+ chunk + bytes + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ exclude_mappings + repeated string + +
+ +
+ +
+
+ filter_namespace + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ store + StoreId + +
+ +
+ +
+
+ proposals + bool + +
+ +
whether to query only for proposals instead of approved topology mappings
+ +
+ +
+
+ operation + TopologyChangeOp + +
+ +
+ +
+
+ snapshot + Timestamp + +
+ +
+ +
+
+ head_state + Empty + +
+ +
+ +
+
+ range + TimeRange + +
+ +
+ +
+
+ filter_signed_key + string + +
+ +
+ +
+
+ protocol_version + int32 + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ from + Timestamp + +
+ +
+ +
+
+ until + Timestamp + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ authorized + Authorized + +
+ +
+ +
+
+ synchronizer + Synchronizer + +
+ +
+ +
+
+ temporary + Temporary + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ name + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ id + string + +
+ +
+ +
+
+ physical_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • TOPOLOGY_CHANGE_OP_UNSPECIFIED
    • + +
  • TOPOLOGY_CHANGE_OP_ADD_REPLACE
    • + +
  • TOPOLOGY_CHANGE_OP_REMOVE
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ chunk + bytes + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/exporttopologysnapshotv2.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/exporttopologysnapshotv2.mdx new file mode 100644 index 0000000..2e971d3 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/exporttopologysnapshotv2.mdx @@ -0,0 +1,593 @@ +--- +title: "ExportTopologySnapshotV2" +--- + +
+ + + + +
+ +

com.digitalasset.canton.topology.admin.v30

+ + +

ExportTopologySnapshotV2

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ExportTopologySnapshotV2 + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ExportTopologySnapshotV2 <<'EOF' +{ + "baseQuery": { + "store": { + "authorized": {} + }, + "proposals": true, + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "snapshot": "string", + "filterSignedKey": "string", + "protocolVersion": 0 + }, + "excludeMappings": [ + "string" + ], + "filterNamespace": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "chunk": "BASE64_ENCODED_BYTES" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
TopologyManagerReadService
+
+ +
+
RPC
+
ExportTopologySnapshotV2
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
Yes
+
+ +
+ + +## Inputs + + +
+
+

ExportTopologySnapshotV2Request

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ExportTopologySnapshotV2Request
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ exclude_mappings + repeated string + +
+ +
+ +
+
+ filter_namespace + string + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ExportTopologySnapshotV2Response

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ExportTopologySnapshotV2Response
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + +
+ +
+
+ chunk + bytes + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ exclude_mappings + repeated string + +
+ +
+ +
+
+ filter_namespace + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ store + StoreId + +
+ +
+ +
+
+ proposals + bool + +
+ +
whether to query only for proposals instead of approved topology mappings
+ +
+ +
+
+ operation + TopologyChangeOp + +
+ +
+ +
+
+ snapshot + Timestamp + +
+ +
+ +
+
+ head_state + Empty + +
+ +
+ +
+
+ range + TimeRange + +
+ +
+ +
+
+ filter_signed_key + string + +
+ +
+ +
+
+ protocol_version + int32 + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ from + Timestamp + +
+ +
+ +
+
+ until + Timestamp + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ authorized + Authorized + +
+ +
+ +
+
+ synchronizer + Synchronizer + +
+ +
+ +
+
+ temporary + Temporary + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ name + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ id + string + +
+ +
+ +
+
+ physical_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • TOPOLOGY_CHANGE_OP_UNSPECIFIED
    • + +
  • TOPOLOGY_CHANGE_OP_ADD_REPLACE
    • + +
  • TOPOLOGY_CHANGE_OP_REMOVE
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ chunk + bytes + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/genesisstate.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/genesisstate.mdx new file mode 100644 index 0000000..a286cb4 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/genesisstate.mdx @@ -0,0 +1,440 @@ +--- +title: "GenesisState" +--- + +
+ + + + +
+ +

com.digitalasset.canton.topology.admin.v30

+ + +

GenesisState

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/GenesisState + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/GenesisState <<'EOF' +{ + "synchronizerStore": { + "authorized": {} + }, + "timestamp": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "chunk": "BASE64_ENCODED_BYTES" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
TopologyManagerReadService
+
+ +
+
RPC
+
GenesisState
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
Yes
+
+ +
+ + +## Inputs + + +
+
+

GenesisStateRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.GenesisStateRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ synchronizer_store + StoreId + +
+ +
Must be specified if the genesis state is requested from a participant node.
+ +
+ +
+
+ timestamp + Timestamp + +
+ +
Optional - the effective time used to fetch the topology transactions. If not provided the effective time of the last topology transaction is used.
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

GenesisStateResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.GenesisStateResponse
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + +
+ +
+
+ chunk + bytes + +
+ +
versioned stored topology transactions
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ synchronizer_store + StoreId + +
+ +
Must be specified if the genesis state is requested from a participant node.
+ +
+ +
+
+ timestamp + Timestamp + +
+ +
Optional - the effective time used to fetch the topology transactions. If not provided the effective time of the last topology transaction is used.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ authorized + Authorized + +
+ +
+ +
+
+ synchronizer + Synchronizer + +
+ +
+ +
+
+ temporary + Temporary + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ name + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ id + string + +
+ +
+ +
+
+ physical_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ chunk + bytes + +
+ +
versioned stored topology transactions
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/genesisstatev2.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/genesisstatev2.mdx new file mode 100644 index 0000000..7c3e480 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/genesisstatev2.mdx @@ -0,0 +1,440 @@ +--- +title: "GenesisStateV2" +--- + +
+ + + + +
+ +

com.digitalasset.canton.topology.admin.v30

+ + +

GenesisStateV2

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/GenesisStateV2 + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/GenesisStateV2 <<'EOF' +{ + "synchronizerStore": { + "authorized": {} + }, + "timestamp": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "chunk": "BASE64_ENCODED_BYTES" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
TopologyManagerReadService
+
+ +
+
RPC
+
GenesisStateV2
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
Yes
+
+ +
+ + +## Inputs + + +
+
+

GenesisStateV2Request

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.GenesisStateV2Request
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ synchronizer_store + StoreId + +
+ +
Must be specified if the genesis state is requested from a participant node.
+ +
+ +
+
+ timestamp + Timestamp + +
+ +
Optional - the effective time used to fetch the topology transactions. If not provided the effective time of the last topology transaction is used.
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

GenesisStateV2Response

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.GenesisStateV2Response
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + +
+ +
+
+ chunk + bytes + +
+ +
versioned stored topology transactions
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ synchronizer_store + StoreId + +
+ +
Must be specified if the genesis state is requested from a participant node.
+ +
+ +
+
+ timestamp + Timestamp + +
+ +
Optional - the effective time used to fetch the topology transactions. If not provided the effective time of the last topology transaction is used.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ authorized + Authorized + +
+ +
+ +
+
+ synchronizer + Synchronizer + +
+ +
+ +
+
+ temporary + Temporary + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ name + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ id + string + +
+ +
+ +
+
+ physical_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ chunk + bytes + +
+ +
versioned stored topology transactions
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listall.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listall.mdx new file mode 100644 index 0000000..2618a45 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listall.mdx @@ -0,0 +1,688 @@ +--- +title: "ListAll" +--- + +
+ + + + +
+ +

com.digitalasset.canton.topology.admin.v30

+ + +

ListAll

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListAll + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListAll <<'EOF' +{ + "baseQuery": { + "store": { + "authorized": {} + }, + "proposals": true, + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "snapshot": "string", + "filterSignedKey": "string", + "protocolVersion": 0 + }, + "excludeMappings": [ + "string" + ], + "filterNamespace": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "result": { + "items": [ + { + "sequenced": "string", + "validFrom": "string", + "validUntil": "string", + "transaction": "BASE64_ENCODED_BYTES", + "rejectionReason": "string" + } + ] + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
TopologyManagerReadService
+
+ +
+
RPC
+
ListAll
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ListAllRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ListAllRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ exclude_mappings + repeated string + +
+ +
* The list of topology mappings to exclude from the result.
+ +
+ +
+
+ filter_namespace + string + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ListAllResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ListAllResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ result + TopologyTransactions + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ exclude_mappings + repeated string + +
+ +
* The list of topology mappings to exclude from the result.
+ +
+ +
+
+ filter_namespace + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ store + StoreId + +
+ +
+ +
+
+ proposals + bool + +
+ +
whether to query only for proposals instead of approved topology mappings
+ +
+ +
+
+ operation + TopologyChangeOp + +
+ +
+ +
+
+ snapshot + Timestamp + +
+ +
+ +
+
+ head_state + Empty + +
+ +
+ +
+
+ range + TimeRange + +
+ +
+ +
+
+ filter_signed_key + string + +
+ +
+ +
+
+ protocol_version + int32 + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ from + Timestamp + +
+ +
+ +
+
+ until + Timestamp + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ authorized + Authorized + +
+ +
+ +
+
+ synchronizer + Synchronizer + +
+ +
+ +
+
+ temporary + Temporary + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ name + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ id + string + +
+ +
+ +
+
+ physical_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • TOPOLOGY_CHANGE_OP_UNSPECIFIED
    • + +
  • TOPOLOGY_CHANGE_OP_ADD_REPLACE
    • + +
  • TOPOLOGY_CHANGE_OP_REMOVE
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ result + TopologyTransactions + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ items + repeated Item + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ sequenced + Timestamp + +
+ +
+ +
+
+ valid_from + Timestamp + +
+ +
+ +
+
+ valid_until + Timestamp + +
+ +
+ +
+
+ transaction + bytes + +
+ +
* Versioned signed topology transactions serialized as byte-strings. Note that we use here the serialized version that contains the version number. Using the "Versioned" version directly here would create a circular dependency between the proto files. The only proper solution would be to move this into a third separate file with "cross version data files", which we might do at some point.
+ +
+ +
+
+ rejection_reason + string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listavailablestores.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listavailablestores.mdx new file mode 100644 index 0000000..7407efa --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listavailablestores.mdx @@ -0,0 +1,382 @@ +--- +title: "ListAvailableStores" +--- + +
+ + + + +
+ +

com.digitalasset.canton.topology.admin.v30

+ + +

ListAvailableStores

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListAvailableStores + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListAvailableStores <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "storeIds": [ + { + "authorized": {} + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
TopologyManagerReadService
+
+ +
+
RPC
+
ListAvailableStores
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ListAvailableStoresRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ListAvailableStoresRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

ListAvailableStoresResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ListAvailableStoresResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ store_ids + repeated StoreId + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ store_ids + repeated StoreId + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ authorized + Authorized + +
+ +
+ +
+
+ synchronizer + Synchronizer + +
+ +
+ +
+
+ temporary + Temporary + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ name + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ id + string + +
+ +
+ +
+
+ physical_id + string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listdecentralizednamespacedefinition.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listdecentralizednamespacedefinition.mdx new file mode 100644 index 0000000..8188d42 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listdecentralizednamespacedefinition.mdx @@ -0,0 +1,757 @@ +--- +title: "ListDecentralizedNamespaceDefinition" +--- + +
+ + + + +
+ +

com.digitalasset.canton.topology.admin.v30

+ + +

ListDecentralizedNamespaceDefinition

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListDecentralizedNamespaceDefinition + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListDecentralizedNamespaceDefinition <<'EOF' +{ + "baseQuery": { + "store": { + "authorized": {} + }, + "proposals": true, + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "snapshot": "string", + "filterSignedKey": "string", + "protocolVersion": 0 + }, + "filterNamespace": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "results": [ + { + "context": { + "store": { + "authorized": {} + }, + "sequenced": "string", + "validFrom": "string", + "validUntil": "string", + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "transactionHash": "BASE64_ENCODED_BYTES", + "serial": 0, + "signedByFingerprints": [ + "string" + ] + }, + "item": { + "decentralizedNamespace": "string", + "threshold": 0, + "owners": [ + "string" + ] + } + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
TopologyManagerReadService
+
+ +
+
RPC
+
ListDecentralizedNamespaceDefinition
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ListDecentralizedNamespaceDefinitionRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ListDecentralizedNamespaceDefinitionRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ filter_namespace + string + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ListDecentralizedNamespaceDefinitionResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ListDecentralizedNamespaceDefinitionResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ filter_namespace + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ store + StoreId + +
+ +
+ +
+
+ proposals + bool + +
+ +
whether to query only for proposals instead of approved topology mappings
+ +
+ +
+
+ operation + TopologyChangeOp + +
+ +
+ +
+
+ snapshot + Timestamp + +
+ +
+ +
+
+ head_state + Empty + +
+ +
+ +
+
+ range + TimeRange + +
+ +
+ +
+
+ filter_signed_key + string + +
+ +
+ +
+
+ protocol_version + int32 + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ from + Timestamp + +
+ +
+ +
+
+ until + Timestamp + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ authorized + Authorized + +
+ +
+ +
+
+ synchronizer + Synchronizer + +
+ +
+ +
+
+ temporary + Temporary + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ name + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ id + string + +
+ +
+ +
+
+ physical_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • TOPOLOGY_CHANGE_OP_UNSPECIFIED
    • + +
  • TOPOLOGY_CHANGE_OP_ADD_REPLACE
    • + +
  • TOPOLOGY_CHANGE_OP_REMOVE
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ context + BaseResult + +
+ +
+ +
+
+ item + DecentralizedNamespaceDefinition + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ store + StoreId + +
+ +
+ +
+
+ sequenced + Timestamp + +
+ +
+ +
+
+ valid_from + Timestamp + +
+ +
+ +
+
+ valid_until + Timestamp + +
+ +
+ +
+
+ operation + TopologyChangeOp + +
+ +
+ +
+
+ transaction_hash + bytes + +
+ +
+ +
+
+ serial + int32 + +
+ +
+ +
+
+ signed_by_fingerprints + repeated string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ decentralized_namespace + string + +
+ +
name of the decentralized namespace, computed from the hash of its initial owners
+ +
+ +
+
+ threshold + int32 + +
+ +
the threshold required for any subsequent update signing
+ +
+ +
+
+ owners + repeated string + +
+ +
the namespaces of the owners
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listmediatorsynchronizerstate.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listmediatorsynchronizerstate.mdx new file mode 100644 index 0000000..2c92ab9 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listmediatorsynchronizerstate.mdx @@ -0,0 +1,783 @@ +--- +title: "ListMediatorSynchronizerState" +--- + +
+ + + + +
+ +

com.digitalasset.canton.topology.admin.v30

+ + +

ListMediatorSynchronizerState

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListMediatorSynchronizerState + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListMediatorSynchronizerState <<'EOF' +{ + "baseQuery": { + "store": { + "authorized": {} + }, + "proposals": true, + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "snapshot": "string", + "filterSignedKey": "string", + "protocolVersion": 0 + }, + "filterSynchronizerId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "results": [ + { + "context": { + "store": { + "authorized": {} + }, + "sequenced": "string", + "validFrom": "string", + "validUntil": "string", + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "transactionHash": "BASE64_ENCODED_BYTES", + "serial": 0, + "signedByFingerprints": [ + "string" + ] + }, + "item": { + "synchronizerId": "string", + "group": 0, + "threshold": 0, + "active": [ + "string" + ], + "observers": [ + "string" + ] + } + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
TopologyManagerReadService
+
+ +
+
RPC
+
ListMediatorSynchronizerState
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ListMediatorSynchronizerStateRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ListMediatorSynchronizerStateRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ filter_synchronizer_id + string + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ListMediatorSynchronizerStateResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ListMediatorSynchronizerStateResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ filter_synchronizer_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ store + StoreId + +
+ +
+ +
+
+ proposals + bool + +
+ +
whether to query only for proposals instead of approved topology mappings
+ +
+ +
+
+ operation + TopologyChangeOp + +
+ +
+ +
+
+ snapshot + Timestamp + +
+ +
+ +
+
+ head_state + Empty + +
+ +
+ +
+
+ range + TimeRange + +
+ +
+ +
+
+ filter_signed_key + string + +
+ +
+ +
+
+ protocol_version + int32 + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ from + Timestamp + +
+ +
+ +
+
+ until + Timestamp + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ authorized + Authorized + +
+ +
+ +
+
+ synchronizer + Synchronizer + +
+ +
+ +
+
+ temporary + Temporary + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ name + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ id + string + +
+ +
+ +
+
+ physical_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • TOPOLOGY_CHANGE_OP_UNSPECIFIED
    • + +
  • TOPOLOGY_CHANGE_OP_ADD_REPLACE
    • + +
  • TOPOLOGY_CHANGE_OP_REMOVE
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ context + BaseResult + +
+ +
+ +
+
+ item + MediatorSynchronizerState + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ store + StoreId + +
+ +
+ +
+
+ sequenced + Timestamp + +
+ +
+ +
+
+ valid_from + Timestamp + +
+ +
+ +
+
+ valid_until + Timestamp + +
+ +
+ +
+
+ operation + TopologyChangeOp + +
+ +
+ +
+
+ transaction_hash + bytes + +
+ +
+ +
+
+ serial + int32 + +
+ +
+ +
+
+ signed_by_fingerprints + repeated string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ synchronizer_id + string + +
+ +
the synchronizer id of the mediator group
+ +
+ +
+
+ group + uint32 + +
+ +
the group-id used for sharding multiple mediator groups
+ +
+ +
+
+ threshold + uint32 + +
+ +
the signature threshold required to reach consensus among the mediators
+ +
+ +
+
+ active + repeated string + +
+ +
the list of active mediators (uid) within the group
+ +
+ +
+
+ observers + repeated string + +
+ +
the list of observing mediators (uid) within the group (read messages but don't respond)
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listnamespacedelegation.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listnamespacedelegation.mdx new file mode 100644 index 0000000..c98f55e --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listnamespacedelegation.mdx @@ -0,0 +1,1055 @@ +--- +title: "ListNamespaceDelegation" +--- + +
+ + + + +
+ +

com.digitalasset.canton.topology.admin.v30

+ + +

ListNamespaceDelegation

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListNamespaceDelegation + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListNamespaceDelegation <<'EOF' +{ + "baseQuery": { + "store": { + "authorized": {} + }, + "proposals": true, + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "snapshot": "string", + "filterSignedKey": "string", + "protocolVersion": 0 + }, + "filterNamespace": "string", + "filterTargetKeyFingerprint": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "results": [ + { + "context": { + "store": { + "authorized": {} + }, + "sequenced": "string", + "validFrom": "string", + "validUntil": "string", + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "transactionHash": "BASE64_ENCODED_BYTES", + "serial": 0, + "signedByFingerprints": [ + "string" + ] + }, + "item": { + "namespace": "string", + "targetKey": { + "format": "CRYPTO_KEY_FORMAT_UNSPECIFIED", + "publicKey": "BASE64_ENCODED_BYTES", + "scheme": "SIGNING_KEY_SCHEME_UNSPECIFIED", + "usage": [ + "SIGNING_KEY_USAGE_UNSPECIFIED" + ], + "keySpec": "SIGNING_KEY_SPEC_UNSPECIFIED" + }, + "isRootDelegation": true, + "canSignAllMappings": {} + } + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
TopologyManagerReadService
+
+ +
+
RPC
+
ListNamespaceDelegation
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ListNamespaceDelegationRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ListNamespaceDelegationRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ filter_namespace + string + +
+ +
+ +
+
+ filter_target_key_fingerprint + string + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ListNamespaceDelegationResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ListNamespaceDelegationResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ filter_namespace + string + +
+ +
+ +
+
+ filter_target_key_fingerprint + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ store + StoreId + +
+ +
+ +
+
+ proposals + bool + +
+ +
whether to query only for proposals instead of approved topology mappings
+ +
+ +
+
+ operation + TopologyChangeOp + +
+ +
+ +
+
+ snapshot + Timestamp + +
+ +
+ +
+
+ head_state + Empty + +
+ +
+ +
+
+ range + TimeRange + +
+ +
+ +
+
+ filter_signed_key + string + +
+ +
+ +
+
+ protocol_version + int32 + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ from + Timestamp + +
+ +
+ +
+
+ until + Timestamp + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ authorized + Authorized + +
+ +
+ +
+
+ synchronizer + Synchronizer + +
+ +
+ +
+
+ temporary + Temporary + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ name + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ id + string + +
+ +
+ +
+
+ physical_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • TOPOLOGY_CHANGE_OP_UNSPECIFIED
    • + +
  • TOPOLOGY_CHANGE_OP_ADD_REPLACE
    • + +
  • TOPOLOGY_CHANGE_OP_REMOVE
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ context + BaseResult + +
+ +
+ +
+
+ item + NamespaceDelegation + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ store + StoreId + +
+ +
+ +
+
+ sequenced + Timestamp + +
+ +
+ +
+
+ valid_from + Timestamp + +
+ +
+ +
+
+ valid_until + Timestamp + +
+ +
+ +
+
+ operation + TopologyChangeOp + +
+ +
+ +
+
+ transaction_hash + bytes + +
+ +
+ +
+
+ serial + int32 + +
+ +
+ +
+
+ signed_by_fingerprints + repeated string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ namespace + string + +
+ +
fingerprint of the root key defining the namespace
+ +
+ +
+
+ target_key + SigningPublicKey + +
+ +
target key of getting full rights on the namespace (if target == namespace, it's a root CA)
+ +
+ +
+
+ is_root_delegation + bool + +
+ +
flag indicating whether the given delegation is a root delegation or not a root delegation is also allowed to issue other NamespaceDelegations.
+ +
+ +
+
+ can_sign_all_mappings + CanSignAllMappings + +
+ +
+ +
+
+ can_sign_all_but_namespace_delegations + CanSignAllButNamespaceDelegations + +
+ +
+ +
+
+ can_sign_specific_mapings + CanSignSpecificMappings + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ mappings + repeated TopologyMappingCode + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • TOPOLOGY_MAPPING_CODE_UNSPECIFIED
    • + +
  • TOPOLOGY_MAPPING_CODE_NAMESPACE_DELEGATION
    • + +
  • TOPOLOGY_MAPPING_CODE_DECENTRALIZED_NAMESPACE_DEFINITION
    • + +
  • TOPOLOGY_MAPPING_CODE_OWNER_TO_KEY_MAPPING
    • + +
  • TOPOLOGY_MAPPING_CODE_SYNCHRONIZER_TRUST_CERTIFICATE
    • + +
  • TOPOLOGY_MAPPING_CODE_PARTICIPANT_PERMISSION
    • + +
  • TOPOLOGY_MAPPING_CODE_PARTY_HOSTING_LIMITS
    • + +
  • TOPOLOGY_MAPPING_CODE_VETTED_PACKAGES
    • + +
  • TOPOLOGY_MAPPING_CODE_PARTY_TO_PARTICIPANT
    • + +
  • TOPOLOGY_MAPPING_CODE_SYNCHRONIZER_PARAMETERS_STATE
    • + +
  • TOPOLOGY_MAPPING_CODE_MEDIATOR_SYNCHRONIZER_STATE
    • + +
  • TOPOLOGY_MAPPING_CODE_SEQUENCER_SYNCHRONIZER_STATE
    • + +
  • TOPOLOGY_MAPPING_CODE_SEQUENCING_DYNAMIC_PARAMETERS_STATE
    • + +
  • TOPOLOGY_MAPPING_CODE_PARTY_TO_KEY_MAPPING
    • + +
  • TOPOLOGY_MAPPING_CODE_SYNCHRONIZER_MIGRATION_ANNOUNCEMENT
    • + +
  • TOPOLOGY_MAPPING_CODE_SEQUENCER_CONNECTION_SUCCESSOR
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ format + CryptoKeyFormat + +
+ +
+ +
+
+ public_key + bytes + +
+ +
Serialized public key in the format specified above
+ +
+ +
+
+ scheme + SigningKeyScheme + +
+ +
No longer used (only kept for backwards compatibility) stores both the crypto key scheme and algorithm.
+ +
+ +
+
+ usage + repeated SigningKeyUsage + +
+ +
Explicitly state the key's intended use
+ +
+ +
+
+ key_spec + SigningKeySpec + +
+ +
The key specification that was used to generate the key pair
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • CRYPTO_KEY_FORMAT_UNSPECIFIED
    • + +
  • CRYPTO_KEY_FORMAT_DER
    • + +
  • CRYPTO_KEY_FORMAT_RAW
    • + +
  • CRYPTO_KEY_FORMAT_DER_X509_SUBJECT_PUBLIC_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_DER_PKCS8_PRIVATE_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_SYMBOLIC
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_SCHEME_UNSPECIFIED
    • + +
  • SIGNING_KEY_SCHEME_ED25519
    • + +
  • SIGNING_KEY_SCHEME_EC_DSA_P256
    • + +
  • SIGNING_KEY_SCHEME_EC_DSA_P384
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_USAGE_UNSPECIFIED
    • + +
  • SIGNING_KEY_USAGE_NAMESPACE
    • + +
  • SIGNING_KEY_USAGE_IDENTITY_DELEGATION
    • + +
  • SIGNING_KEY_USAGE_SEQUENCER_AUTHENTICATION
    • + +
  • SIGNING_KEY_USAGE_PROTOCOL
    • + +
  • SIGNING_KEY_USAGE_PROOF_OF_OWNERSHIP
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_SPEC_UNSPECIFIED
    • + +
  • SIGNING_KEY_SPEC_EC_CURVE25519
    • + +
  • SIGNING_KEY_SPEC_EC_P256
    • + +
  • SIGNING_KEY_SPEC_EC_P384
    • + +
  • SIGNING_KEY_SPEC_EC_SECP256K1
    • + +
+ + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listownertokeymapping.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listownertokeymapping.mdx new file mode 100644 index 0000000..d12b76b --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listownertokeymapping.mdx @@ -0,0 +1,1052 @@ +--- +title: "ListOwnerToKeyMapping" +--- + +
+ + + + +
+ +

com.digitalasset.canton.topology.admin.v30

+ + +

ListOwnerToKeyMapping

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListOwnerToKeyMapping + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListOwnerToKeyMapping <<'EOF' +{ + "baseQuery": { + "store": { + "authorized": {} + }, + "proposals": true, + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "snapshot": "string", + "filterSignedKey": "string", + "protocolVersion": 0 + }, + "filterKeyOwnerType": "string", + "filterKeyOwnerUid": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "results": [ + { + "context": { + "store": { + "authorized": {} + }, + "sequenced": "string", + "validFrom": "string", + "validUntil": "string", + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "transactionHash": "BASE64_ENCODED_BYTES", + "serial": 0, + "signedByFingerprints": [ + "string" + ] + }, + "item": { + "member": "string", + "publicKeys": [ + { + "signingPublicKey": {} + } + ] + } + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
TopologyManagerReadService
+
+ +
+
RPC
+
ListOwnerToKeyMapping
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ListOwnerToKeyMappingRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ListOwnerToKeyMappingRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ filter_key_owner_type + string + +
+ +
+ +
+
+ filter_key_owner_uid + string + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ListOwnerToKeyMappingResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ListOwnerToKeyMappingResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ filter_key_owner_type + string + +
+ +
+ +
+
+ filter_key_owner_uid + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ store + StoreId + +
+ +
+ +
+
+ proposals + bool + +
+ +
whether to query only for proposals instead of approved topology mappings
+ +
+ +
+
+ operation + TopologyChangeOp + +
+ +
+ +
+
+ snapshot + Timestamp + +
+ +
+ +
+
+ head_state + Empty + +
+ +
+ +
+
+ range + TimeRange + +
+ +
+ +
+
+ filter_signed_key + string + +
+ +
+ +
+
+ protocol_version + int32 + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ from + Timestamp + +
+ +
+ +
+
+ until + Timestamp + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ authorized + Authorized + +
+ +
+ +
+
+ synchronizer + Synchronizer + +
+ +
+ +
+
+ temporary + Temporary + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ name + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ id + string + +
+ +
+ +
+
+ physical_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • TOPOLOGY_CHANGE_OP_UNSPECIFIED
    • + +
  • TOPOLOGY_CHANGE_OP_ADD_REPLACE
    • + +
  • TOPOLOGY_CHANGE_OP_REMOVE
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ context + BaseResult + +
+ +
+ +
+
+ item + OwnerToKeyMapping + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ store + StoreId + +
+ +
+ +
+
+ sequenced + Timestamp + +
+ +
+ +
+
+ valid_from + Timestamp + +
+ +
+ +
+
+ valid_until + Timestamp + +
+ +
+ +
+
+ operation + TopologyChangeOp + +
+ +
+ +
+
+ transaction_hash + bytes + +
+ +
+ +
+
+ serial + int32 + +
+ +
+ +
+
+ signed_by_fingerprints + repeated string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ member + string + +
+ +
the sequencing process member
+ +
+ +
+
+ public_keys + repeated PublicKey + +
+ +
the designated keys
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ signing_public_key + SigningPublicKey + +
+ +
+ +
+
+ encryption_public_key + EncryptionPublicKey + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ format + CryptoKeyFormat + +
+ +
+ +
+
+ public_key + bytes + +
+ +
Serialized public key in the format specified above
+ +
+ +
+
+ scheme + SigningKeyScheme + +
+ +
No longer used (only kept for backwards compatibility) stores both the crypto key scheme and algorithm.
+ +
+ +
+
+ usage + repeated SigningKeyUsage + +
+ +
Explicitly state the key's intended use
+ +
+ +
+
+ key_spec + SigningKeySpec + +
+ +
The key specification that was used to generate the key pair
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • CRYPTO_KEY_FORMAT_UNSPECIFIED
    • + +
  • CRYPTO_KEY_FORMAT_DER
    • + +
  • CRYPTO_KEY_FORMAT_RAW
    • + +
  • CRYPTO_KEY_FORMAT_DER_X509_SUBJECT_PUBLIC_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_DER_PKCS8_PRIVATE_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_SYMBOLIC
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_SCHEME_UNSPECIFIED
    • + +
  • SIGNING_KEY_SCHEME_ED25519
    • + +
  • SIGNING_KEY_SCHEME_EC_DSA_P256
    • + +
  • SIGNING_KEY_SCHEME_EC_DSA_P384
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_USAGE_UNSPECIFIED
    • + +
  • SIGNING_KEY_USAGE_NAMESPACE
    • + +
  • SIGNING_KEY_USAGE_IDENTITY_DELEGATION
    • + +
  • SIGNING_KEY_USAGE_SEQUENCER_AUTHENTICATION
    • + +
  • SIGNING_KEY_USAGE_PROTOCOL
    • + +
  • SIGNING_KEY_USAGE_PROOF_OF_OWNERSHIP
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_SPEC_UNSPECIFIED
    • + +
  • SIGNING_KEY_SPEC_EC_CURVE25519
    • + +
  • SIGNING_KEY_SPEC_EC_P256
    • + +
  • SIGNING_KEY_SPEC_EC_P384
    • + +
  • SIGNING_KEY_SPEC_EC_SECP256K1
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ format + CryptoKeyFormat + +
+ +
+ +
+
+ public_key + bytes + +
+ +
Serialized public key in the format specified above
+ +
+ +
+
+ scheme + EncryptionKeyScheme + +
+ +
No longer used (only kept for backwards compatibility) stores both the crypto key scheme and algorithm.
+ +
+ +
+
+ key_spec + EncryptionKeySpec + +
+ +
The key specification that was used to generate the key pair
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • ENCRYPTION_KEY_SCHEME_UNSPECIFIED
    • + +
  • ENCRYPTION_KEY_SCHEME_ECIES_P256_HKDF_HMAC_SHA256_AES128GCM
    • + +
  • ENCRYPTION_KEY_SCHEME_ECIES_P256_HMAC_SHA256A_ES128CBC
    • + +
  • ENCRYPTION_KEY_SCHEME_RSA2048_OAEP_SHA256
    • + +
+ + +
+ + + +
+ + + +
    + +
  • ENCRYPTION_KEY_SPEC_UNSPECIFIED
    • + +
  • ENCRYPTION_KEY_SPEC_EC_P256
    • + +
  • ENCRYPTION_KEY_SPEC_RSA_2048
    • + +
+ + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listparticipantsynchronizerpermission.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listparticipantsynchronizerpermission.mdx new file mode 100644 index 0000000..b3ea19e --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listparticipantsynchronizerpermission.mdx @@ -0,0 +1,820 @@ +--- +title: "ListParticipantSynchronizerPermission" +--- + +
+ + + + +
+ +

com.digitalasset.canton.topology.admin.v30

+ + +

ListParticipantSynchronizerPermission

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListParticipantSynchronizerPermission + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListParticipantSynchronizerPermission <<'EOF' +{ + "baseQuery": { + "store": { + "authorized": {} + }, + "proposals": true, + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "snapshot": "string", + "filterSignedKey": "string", + "protocolVersion": 0 + }, + "filterUid": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "results": [ + { + "context": { + "store": { + "authorized": {} + }, + "sequenced": "string", + "validFrom": "string", + "validUntil": "string", + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "transactionHash": "BASE64_ENCODED_BYTES", + "serial": 0, + "signedByFingerprints": [ + "string" + ] + }, + "item": { + "synchronizerId": "string", + "participantUid": "string", + "permission": "PARTICIPANT_PERMISSION_UNSPECIFIED", + "limits": { + "confirmationRequestsMaxRate": 0 + }, + "loginAfter": "0" + } + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
TopologyManagerReadService
+
+ +
+
RPC
+
ListParticipantSynchronizerPermission
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ListParticipantSynchronizerPermissionRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ListParticipantSynchronizerPermissionRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ filter_uid + string + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ListParticipantSynchronizerPermissionResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ListParticipantSynchronizerPermissionResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ filter_uid + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ store + StoreId + +
+ +
+ +
+
+ proposals + bool + +
+ +
whether to query only for proposals instead of approved topology mappings
+ +
+ +
+
+ operation + TopologyChangeOp + +
+ +
+ +
+
+ snapshot + Timestamp + +
+ +
+ +
+
+ head_state + Empty + +
+ +
+ +
+
+ range + TimeRange + +
+ +
+ +
+
+ filter_signed_key + string + +
+ +
+ +
+
+ protocol_version + int32 + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ from + Timestamp + +
+ +
+ +
+
+ until + Timestamp + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ authorized + Authorized + +
+ +
+ +
+
+ synchronizer + Synchronizer + +
+ +
+ +
+
+ temporary + Temporary + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ name + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ id + string + +
+ +
+ +
+
+ physical_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • TOPOLOGY_CHANGE_OP_UNSPECIFIED
    • + +
  • TOPOLOGY_CHANGE_OP_ADD_REPLACE
    • + +
  • TOPOLOGY_CHANGE_OP_REMOVE
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ context + BaseResult + +
+ +
+ +
+
+ item + ParticipantSynchronizerPermission + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ store + StoreId + +
+ +
+ +
+
+ sequenced + Timestamp + +
+ +
+ +
+
+ valid_from + Timestamp + +
+ +
+ +
+
+ valid_until + Timestamp + +
+ +
+ +
+
+ operation + TopologyChangeOp + +
+ +
+ +
+
+ transaction_hash + bytes + +
+ +
+ +
+
+ serial + int32 + +
+ +
+ +
+
+ signed_by_fingerprints + repeated string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ synchronizer_id + string + +
+ +
+ +
+
+ participant_uid + string + +
+ +
+ +
+
+ permission + ParticipantPermission + +
+ +
the permission level of the participant on this synchronizer (usually submission)
+ +
+ +
+
+ limits + ParticipantSynchronizerLimits + +
+ +
optional individual limits for this participant
+ +
+ +
+
+ login_after + int64 + +
+ +
optional earliest time when participant can log in (again) used to temporarily disable participants In microseconds of UTC time since Unix epoch
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • PARTICIPANT_PERMISSION_UNSPECIFIED
    • + +
  • PARTICIPANT_PERMISSION_SUBMISSION
    • + +
  • PARTICIPANT_PERMISSION_CONFIRMATION
    • + +
  • PARTICIPANT_PERMISSION_OBSERVATION
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ confirmation_requests_max_rate + uint32 + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listpartyhostinglimits.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listpartyhostinglimits.mdx new file mode 100644 index 0000000..0a07c90 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listpartyhostinglimits.mdx @@ -0,0 +1,739 @@ +--- +title: "ListPartyHostingLimits" +--- + +
+ + + + +
+ +

com.digitalasset.canton.topology.admin.v30

+ + +

ListPartyHostingLimits

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListPartyHostingLimits + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListPartyHostingLimits <<'EOF' +{ + "baseQuery": { + "store": { + "authorized": {} + }, + "proposals": true, + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "snapshot": "string", + "filterSignedKey": "string", + "protocolVersion": 0 + }, + "filterUid": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "results": [ + { + "context": { + "store": { + "authorized": {} + }, + "sequenced": "string", + "validFrom": "string", + "validUntil": "string", + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "transactionHash": "BASE64_ENCODED_BYTES", + "serial": 0, + "signedByFingerprints": [ + "string" + ] + }, + "item": { + "synchronizerId": "string", + "party": "string" + } + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
TopologyManagerReadService
+
+ +
+
RPC
+
ListPartyHostingLimits
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ListPartyHostingLimitsRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ListPartyHostingLimitsRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ filter_uid + string + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ListPartyHostingLimitsResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ListPartyHostingLimitsResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ filter_uid + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ store + StoreId + +
+ +
+ +
+
+ proposals + bool + +
+ +
whether to query only for proposals instead of approved topology mappings
+ +
+ +
+
+ operation + TopologyChangeOp + +
+ +
+ +
+
+ snapshot + Timestamp + +
+ +
+ +
+
+ head_state + Empty + +
+ +
+ +
+
+ range + TimeRange + +
+ +
+ +
+
+ filter_signed_key + string + +
+ +
+ +
+
+ protocol_version + int32 + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ from + Timestamp + +
+ +
+ +
+
+ until + Timestamp + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ authorized + Authorized + +
+ +
+ +
+
+ synchronizer + Synchronizer + +
+ +
+ +
+
+ temporary + Temporary + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ name + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ id + string + +
+ +
+ +
+
+ physical_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • TOPOLOGY_CHANGE_OP_UNSPECIFIED
    • + +
  • TOPOLOGY_CHANGE_OP_ADD_REPLACE
    • + +
  • TOPOLOGY_CHANGE_OP_REMOVE
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ context + BaseResult + +
+ +
+ +
+
+ item + PartyHostingLimits + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ store + StoreId + +
+ +
+ +
+
+ sequenced + Timestamp + +
+ +
+ +
+
+ valid_from + Timestamp + +
+ +
+ +
+
+ valid_until + Timestamp + +
+ +
+ +
+
+ operation + TopologyChangeOp + +
+ +
+ +
+
+ transaction_hash + bytes + +
+ +
+ +
+
+ serial + int32 + +
+ +
+ +
+
+ signed_by_fingerprints + repeated string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ synchronizer_id + string + +
+ +
+ +
+
+ party + string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listpartytokeymapping.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listpartytokeymapping.mdx new file mode 100644 index 0000000..2c5e537 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listpartytokeymapping.mdx @@ -0,0 +1,925 @@ +--- +title: "ListPartyToKeyMapping" +--- + +
+ + + + +
+ +

com.digitalasset.canton.topology.admin.v30

+ + +

ListPartyToKeyMapping

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListPartyToKeyMapping + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListPartyToKeyMapping <<'EOF' +{ + "baseQuery": { + "store": { + "authorized": {} + }, + "proposals": true, + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "snapshot": "string", + "filterSignedKey": "string", + "protocolVersion": 0 + }, + "filterParty": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "results": [ + { + "context": { + "store": { + "authorized": {} + }, + "sequenced": "string", + "validFrom": "string", + "validUntil": "string", + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "transactionHash": "BASE64_ENCODED_BYTES", + "serial": 0, + "signedByFingerprints": [ + "string" + ] + }, + "item": { + "party": "string", + "threshold": 0, + "signingKeys": [ + { + "format": "CRYPTO_KEY_FORMAT_UNSPECIFIED", + "publicKey": "BASE64_ENCODED_BYTES", + "scheme": "SIGNING_KEY_SCHEME_UNSPECIFIED", + "usage": [ + "SIGNING_KEY_USAGE_UNSPECIFIED" + ], + "keySpec": "SIGNING_KEY_SPEC_UNSPECIFIED" + } + ] + } + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
TopologyManagerReadService
+
+ +
+
RPC
+
ListPartyToKeyMapping
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ListPartyToKeyMappingRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ListPartyToKeyMappingRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ filter_party + string + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ListPartyToKeyMappingResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ListPartyToKeyMappingResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ filter_party + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ store + StoreId + +
+ +
+ +
+
+ proposals + bool + +
+ +
whether to query only for proposals instead of approved topology mappings
+ +
+ +
+
+ operation + TopologyChangeOp + +
+ +
+ +
+
+ snapshot + Timestamp + +
+ +
+ +
+
+ head_state + Empty + +
+ +
+ +
+
+ range + TimeRange + +
+ +
+ +
+
+ filter_signed_key + string + +
+ +
+ +
+
+ protocol_version + int32 + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ from + Timestamp + +
+ +
+ +
+
+ until + Timestamp + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ authorized + Authorized + +
+ +
+ +
+
+ synchronizer + Synchronizer + +
+ +
+ +
+
+ temporary + Temporary + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ name + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ id + string + +
+ +
+ +
+
+ physical_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • TOPOLOGY_CHANGE_OP_UNSPECIFIED
    • + +
  • TOPOLOGY_CHANGE_OP_ADD_REPLACE
    • + +
  • TOPOLOGY_CHANGE_OP_REMOVE
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ context + BaseResult + +
+ +
+ +
+
+ item + PartyToKeyMapping + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ store + StoreId + +
+ +
+ +
+
+ sequenced + Timestamp + +
+ +
+ +
+
+ valid_from + Timestamp + +
+ +
+ +
+
+ valid_until + Timestamp + +
+ +
+ +
+
+ operation + TopologyChangeOp + +
+ +
+ +
+
+ transaction_hash + bytes + +
+ +
+ +
+
+ serial + int32 + +
+ +
+ +
+
+ signed_by_fingerprints + repeated string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ party + string + +
+ +
the party
+ +
+ +
+
+ threshold + uint32 + +
+ +
the authorization threshold
+ +
+ +
+
+ signing_keys + repeated SigningPublicKey + +
+ +
the designated signing keys
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ format + CryptoKeyFormat + +
+ +
+ +
+
+ public_key + bytes + +
+ +
Serialized public key in the format specified above
+ +
+ +
+
+ scheme + SigningKeyScheme + +
+ +
No longer used (only kept for backwards compatibility) stores both the crypto key scheme and algorithm.
+ +
+ +
+
+ usage + repeated SigningKeyUsage + +
+ +
Explicitly state the key's intended use
+ +
+ +
+
+ key_spec + SigningKeySpec + +
+ +
The key specification that was used to generate the key pair
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • CRYPTO_KEY_FORMAT_UNSPECIFIED
    • + +
  • CRYPTO_KEY_FORMAT_DER
    • + +
  • CRYPTO_KEY_FORMAT_RAW
    • + +
  • CRYPTO_KEY_FORMAT_DER_X509_SUBJECT_PUBLIC_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_DER_PKCS8_PRIVATE_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_SYMBOLIC
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_SCHEME_UNSPECIFIED
    • + +
  • SIGNING_KEY_SCHEME_ED25519
    • + +
  • SIGNING_KEY_SCHEME_EC_DSA_P256
    • + +
  • SIGNING_KEY_SCHEME_EC_DSA_P384
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_USAGE_UNSPECIFIED
    • + +
  • SIGNING_KEY_USAGE_NAMESPACE
    • + +
  • SIGNING_KEY_USAGE_IDENTITY_DELEGATION
    • + +
  • SIGNING_KEY_USAGE_SEQUENCER_AUTHENTICATION
    • + +
  • SIGNING_KEY_USAGE_PROTOCOL
    • + +
  • SIGNING_KEY_USAGE_PROOF_OF_OWNERSHIP
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_SPEC_UNSPECIFIED
    • + +
  • SIGNING_KEY_SPEC_EC_CURVE25519
    • + +
  • SIGNING_KEY_SPEC_EC_P256
    • + +
  • SIGNING_KEY_SPEC_EC_P384
    • + +
  • SIGNING_KEY_SPEC_EC_SECP256K1
    • + +
+ + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listpartytoparticipant.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listpartytoparticipant.mdx new file mode 100644 index 0000000..bd9bc2b --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listpartytoparticipant.mdx @@ -0,0 +1,1068 @@ +--- +title: "ListPartyToParticipant" +--- + +
+ + + + +
+ +

com.digitalasset.canton.topology.admin.v30

+ + +

ListPartyToParticipant

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListPartyToParticipant + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListPartyToParticipant <<'EOF' +{ + "baseQuery": { + "store": { + "authorized": {} + }, + "proposals": true, + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "snapshot": "string", + "filterSignedKey": "string", + "protocolVersion": 0 + }, + "filterParty": "string", + "filterParticipant": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "results": [ + { + "context": { + "store": { + "authorized": {} + }, + "sequenced": "string", + "validFrom": "string", + "validUntil": "string", + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "transactionHash": "BASE64_ENCODED_BYTES", + "serial": 0, + "signedByFingerprints": [ + "string" + ] + }, + "item": { + "party": "string", + "threshold": 0, + "participants": [ + { + "participantUid": "string", + "permission": "PARTICIPANT_PERMISSION_UNSPECIFIED", + "onboarding": {} + } + ], + "partySigningKeys": { + "keys": [ + {} + ], + "threshold": 0 + } + } + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
TopologyManagerReadService
+
+ +
+
RPC
+
ListPartyToParticipant
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ListPartyToParticipantRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ListPartyToParticipantRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ filter_party + string + +
+ +
+ +
+
+ filter_participant + string + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ListPartyToParticipantResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ListPartyToParticipantResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ filter_party + string + +
+ +
+ +
+
+ filter_participant + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ store + StoreId + +
+ +
+ +
+
+ proposals + bool + +
+ +
whether to query only for proposals instead of approved topology mappings
+ +
+ +
+
+ operation + TopologyChangeOp + +
+ +
+ +
+
+ snapshot + Timestamp + +
+ +
+ +
+
+ head_state + Empty + +
+ +
+ +
+
+ range + TimeRange + +
+ +
+ +
+
+ filter_signed_key + string + +
+ +
+ +
+
+ protocol_version + int32 + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ from + Timestamp + +
+ +
+ +
+
+ until + Timestamp + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ authorized + Authorized + +
+ +
+ +
+
+ synchronizer + Synchronizer + +
+ +
+ +
+
+ temporary + Temporary + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ name + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ id + string + +
+ +
+ +
+
+ physical_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • TOPOLOGY_CHANGE_OP_UNSPECIFIED
    • + +
  • TOPOLOGY_CHANGE_OP_ADD_REPLACE
    • + +
  • TOPOLOGY_CHANGE_OP_REMOVE
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ context + BaseResult + +
+ +
+ +
+
+ item + PartyToParticipant + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ store + StoreId + +
+ +
+ +
+
+ sequenced + Timestamp + +
+ +
+ +
+
+ valid_from + Timestamp + +
+ +
+ +
+
+ valid_until + Timestamp + +
+ +
+ +
+
+ operation + TopologyChangeOp + +
+ +
+ +
+
+ transaction_hash + bytes + +
+ +
+ +
+
+ serial + int32 + +
+ +
+ +
+
+ signed_by_fingerprints + repeated string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ party + string + +
+ +
the party that is to be represented by the participants
+ +
+ +
+
+ threshold + uint32 + +
+ +
the signatory threshold required by the participants to be able to act on behalf of the party. a mapping with threshold > 1 is considered a definition of a consortium party
+ +
+ +
+
+ participants + repeated HostingParticipant + +
+ +
which participants will host the party. if threshold > 1, must be Confirmation or Observation. if all participants have Observation permission, the confirmation treshold is ignored, making the party a purely observing party.
+ +
+ +
+
+ party_signing_keys + SigningKeysWithThreshold + +
+ +
Contains protocol signing keys for the party used to authorize externally signed Daml transactions, along with a signing threshold. The max number of keys is 20
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ participant_uid + string + +
+ +
the target participant that the party should be mapped to
+ +
+ +
+
+ permission + ParticipantPermission + +
+ +
permission of the participant for this particular party (the actual will be min of ParticipantSynchronizerPermission.ParticipantPermission and this setting)
+ +
+ +
+
+ onboarding + Onboarding + +
+ +
optional, present iff the party is being onboarded to the participant
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + + +
    + +
  • PARTICIPANT_PERMISSION_UNSPECIFIED
    • + +
  • PARTICIPANT_PERMISSION_SUBMISSION
    • + +
  • PARTICIPANT_PERMISSION_CONFIRMATION
    • + +
  • PARTICIPANT_PERMISSION_OBSERVATION
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ keys + repeated SigningPublicKey + +
+ +
the designated signing keys
+ +
+ +
+
+ threshold + uint32 + +
+ +
the authorization threshold
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ format + CryptoKeyFormat + +
+ +
+ +
+
+ public_key + bytes + +
+ +
Serialized public key in the format specified above
+ +
+ +
+
+ scheme + SigningKeyScheme + +
+ +
No longer used (only kept for backwards compatibility) stores both the crypto key scheme and algorithm.
+ +
+ +
+
+ usage + repeated SigningKeyUsage + +
+ +
Explicitly state the key's intended use
+ +
+ +
+
+ key_spec + SigningKeySpec + +
+ +
The key specification that was used to generate the key pair
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • CRYPTO_KEY_FORMAT_UNSPECIFIED
    • + +
  • CRYPTO_KEY_FORMAT_DER
    • + +
  • CRYPTO_KEY_FORMAT_RAW
    • + +
  • CRYPTO_KEY_FORMAT_DER_X509_SUBJECT_PUBLIC_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_DER_PKCS8_PRIVATE_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_SYMBOLIC
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_SCHEME_UNSPECIFIED
    • + +
  • SIGNING_KEY_SCHEME_ED25519
    • + +
  • SIGNING_KEY_SCHEME_EC_DSA_P256
    • + +
  • SIGNING_KEY_SCHEME_EC_DSA_P384
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_USAGE_UNSPECIFIED
    • + +
  • SIGNING_KEY_USAGE_NAMESPACE
    • + +
  • SIGNING_KEY_USAGE_IDENTITY_DELEGATION
    • + +
  • SIGNING_KEY_USAGE_SEQUENCER_AUTHENTICATION
    • + +
  • SIGNING_KEY_USAGE_PROTOCOL
    • + +
  • SIGNING_KEY_USAGE_PROOF_OF_OWNERSHIP
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_SPEC_UNSPECIFIED
    • + +
  • SIGNING_KEY_SPEC_EC_CURVE25519
    • + +
  • SIGNING_KEY_SPEC_EC_P256
    • + +
  • SIGNING_KEY_SPEC_EC_P384
    • + +
  • SIGNING_KEY_SPEC_EC_SECP256K1
    • + +
+ + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsequencerconnectionsuccessor.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsequencerconnectionsuccessor.mdx new file mode 100644 index 0000000..12fc364 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsequencerconnectionsuccessor.mdx @@ -0,0 +1,812 @@ +--- +title: "ListSequencerConnectionSuccessor" +--- + +
+ + + + +
+ +

com.digitalasset.canton.topology.admin.v30

+ + +

ListSequencerConnectionSuccessor

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListSequencerConnectionSuccessor + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListSequencerConnectionSuccessor <<'EOF' +{ + "baseQuery": { + "store": { + "authorized": {} + }, + "proposals": true, + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "snapshot": "string", + "filterSignedKey": "string", + "protocolVersion": 0 + }, + "filterSequencerId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "results": [ + { + "context": { + "store": { + "authorized": {} + }, + "sequenced": "string", + "validFrom": "string", + "validUntil": "string", + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "transactionHash": "BASE64_ENCODED_BYTES", + "serial": 0, + "signedByFingerprints": [ + "string" + ] + }, + "item": { + "sequencerId": "string", + "synchronizerId": "string", + "connection": { + "grpc": {} + } + } + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
TopologyManagerReadService
+
+ +
+
RPC
+
ListSequencerConnectionSuccessor
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ListSequencerConnectionSuccessorRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ListSequencerConnectionSuccessorRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ filter_sequencer_id + string + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ListSequencerConnectionSuccessorResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ListSequencerConnectionSuccessorResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ filter_sequencer_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ store + StoreId + +
+ +
+ +
+
+ proposals + bool + +
+ +
whether to query only for proposals instead of approved topology mappings
+ +
+ +
+
+ operation + TopologyChangeOp + +
+ +
+ +
+
+ snapshot + Timestamp + +
+ +
+ +
+
+ head_state + Empty + +
+ +
+ +
+
+ range + TimeRange + +
+ +
+ +
+
+ filter_signed_key + string + +
+ +
+ +
+
+ protocol_version + int32 + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ from + Timestamp + +
+ +
+ +
+
+ until + Timestamp + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ authorized + Authorized + +
+ +
+ +
+
+ synchronizer + Synchronizer + +
+ +
+ +
+
+ temporary + Temporary + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ name + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ id + string + +
+ +
+ +
+
+ physical_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • TOPOLOGY_CHANGE_OP_UNSPECIFIED
    • + +
  • TOPOLOGY_CHANGE_OP_ADD_REPLACE
    • + +
  • TOPOLOGY_CHANGE_OP_REMOVE
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ context + BaseResult + +
+ +
+ +
+
+ item + SequencerConnectionSuccessor + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ store + StoreId + +
+ +
+ +
+
+ sequenced + Timestamp + +
+ +
+ +
+
+ valid_from + Timestamp + +
+ +
+ +
+
+ valid_until + Timestamp + +
+ +
+ +
+
+ operation + TopologyChangeOp + +
+ +
+ +
+
+ transaction_hash + bytes + +
+ +
+ +
+
+ serial + int32 + +
+ +
+ +
+
+ signed_by_fingerprints + repeated string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ sequencer_id + string + +
+ +
the sequencer id
+ +
+ +
+
+ synchronizer_id + string + +
+ +
to synchronizer id
+ +
+ +
+
+ connection + SequencerConnection + +
+ +
the connection details with which members can connect to the sequencer on the successor synchronizer
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ grpc + Grpc + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ endpoints + repeated string + +
+ +
connection information to sequencer (http[s]://<host>:<port>") all endpoints must agree on using HTTPS or HTTP
+ +
+ +
+
+ custom_trust_certificates + bytes + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsequencersynchronizerstate.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsequencersynchronizerstate.mdx new file mode 100644 index 0000000..8cdb445 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsequencersynchronizerstate.mdx @@ -0,0 +1,771 @@ +--- +title: "ListSequencerSynchronizerState" +--- + +
+ + + + +
+ +

com.digitalasset.canton.topology.admin.v30

+ + +

ListSequencerSynchronizerState

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListSequencerSynchronizerState + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListSequencerSynchronizerState <<'EOF' +{ + "baseQuery": { + "store": { + "authorized": {} + }, + "proposals": true, + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "snapshot": "string", + "filterSignedKey": "string", + "protocolVersion": 0 + }, + "filterSynchronizerId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "results": [ + { + "context": { + "store": { + "authorized": {} + }, + "sequenced": "string", + "validFrom": "string", + "validUntil": "string", + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "transactionHash": "BASE64_ENCODED_BYTES", + "serial": 0, + "signedByFingerprints": [ + "string" + ] + }, + "item": { + "synchronizerId": "string", + "threshold": 0, + "active": [ + "string" + ], + "observers": [ + "string" + ] + } + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
TopologyManagerReadService
+
+ +
+
RPC
+
ListSequencerSynchronizerState
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ListSequencerSynchronizerStateRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ListSequencerSynchronizerStateRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ filter_synchronizer_id + string + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ListSequencerSynchronizerStateResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ListSequencerSynchronizerStateResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ filter_synchronizer_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ store + StoreId + +
+ +
+ +
+
+ proposals + bool + +
+ +
whether to query only for proposals instead of approved topology mappings
+ +
+ +
+
+ operation + TopologyChangeOp + +
+ +
+ +
+
+ snapshot + Timestamp + +
+ +
+ +
+
+ head_state + Empty + +
+ +
+ +
+
+ range + TimeRange + +
+ +
+ +
+
+ filter_signed_key + string + +
+ +
+ +
+
+ protocol_version + int32 + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ from + Timestamp + +
+ +
+ +
+
+ until + Timestamp + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ authorized + Authorized + +
+ +
+ +
+
+ synchronizer + Synchronizer + +
+ +
+ +
+
+ temporary + Temporary + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ name + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ id + string + +
+ +
+ +
+
+ physical_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • TOPOLOGY_CHANGE_OP_UNSPECIFIED
    • + +
  • TOPOLOGY_CHANGE_OP_ADD_REPLACE
    • + +
  • TOPOLOGY_CHANGE_OP_REMOVE
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ context + BaseResult + +
+ +
+ +
+
+ item + SequencerSynchronizerState + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ store + StoreId + +
+ +
+ +
+
+ sequenced + Timestamp + +
+ +
+ +
+
+ valid_from + Timestamp + +
+ +
+ +
+
+ valid_until + Timestamp + +
+ +
+ +
+
+ operation + TopologyChangeOp + +
+ +
+ +
+
+ transaction_hash + bytes + +
+ +
+ +
+
+ serial + int32 + +
+ +
+ +
+
+ signed_by_fingerprints + repeated string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ synchronizer_id + string + +
+ +
the synchronizer id of the sequencer group
+ +
+ +
+
+ threshold + uint32 + +
+ +
The system can tolerate up to min(threshold - 1, (activeWithSigningKey.size - 1)/3) malicious active sequencers, where activeWithSigningKey is the set of sequencers from active that have an active OwnerToKeyMapping with a signing key. In order to make the system resilient against f malicious active sequencers, you need to: (1) configure threshold := f + 1, (2) possibly add active sequencers such that f <= (activeWithSigningKey.size - 1)/3. (3) possibly register signing keys for active sequencers,
+ +
+ +
+
+ active + repeated string + +
+ +
the list of active sequencers If a sequencer without an active signing key is added to this set, it has no effect on the topology state.
+ +
+ +
+
+ observers + repeated string + +
+ +
the list of observing sequencers (uid) within the group (read messages but don't respond)
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsynchronizerparametersstate.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsynchronizerparametersstate.mdx new file mode 100644 index 0000000..00af770 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsynchronizerparametersstate.mdx @@ -0,0 +1,1012 @@ +--- +title: "ListSynchronizerParametersState" +--- + +
+ + + + +
+ +

com.digitalasset.canton.topology.admin.v30

+ + +

ListSynchronizerParametersState

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListSynchronizerParametersState + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListSynchronizerParametersState <<'EOF' +{ + "baseQuery": { + "store": { + "authorized": {} + }, + "proposals": true, + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "snapshot": "string", + "filterSignedKey": "string", + "protocolVersion": 0 + }, + "filterSynchronizerId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "results": [ + { + "context": { + "store": { + "authorized": {} + }, + "sequenced": "string", + "validFrom": "string", + "validUntil": "string", + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "transactionHash": "BASE64_ENCODED_BYTES", + "serial": 0, + "signedByFingerprints": [ + "string" + ] + }, + "item": { + "confirmationResponseTimeout": "string", + "mediatorReactionTimeout": "string", + "assignmentExclusivityTimeout": "string", + "ledgerTimeRecordTimeTolerance": "string", + "reconciliationInterval": "string", + "mediatorDeduplicationTimeout": "string", + "maxRequestSize": 0, + "onboardingRestriction": "ONBOARDING_RESTRICTION_UNSPECIFIED" + } + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
TopologyManagerReadService
+
+ +
+
RPC
+
ListSynchronizerParametersState
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ListSynchronizerParametersStateRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ListSynchronizerParametersStateRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ filter_synchronizer_id + string + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ListSynchronizerParametersStateResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ListSynchronizerParametersStateResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ filter_synchronizer_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ store + StoreId + +
+ +
+ +
+
+ proposals + bool + +
+ +
whether to query only for proposals instead of approved topology mappings
+ +
+ +
+
+ operation + TopologyChangeOp + +
+ +
+ +
+
+ snapshot + Timestamp + +
+ +
+ +
+
+ head_state + Empty + +
+ +
+ +
+
+ range + TimeRange + +
+ +
+ +
+
+ filter_signed_key + string + +
+ +
+ +
+
+ protocol_version + int32 + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ from + Timestamp + +
+ +
+ +
+
+ until + Timestamp + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ authorized + Authorized + +
+ +
+ +
+
+ synchronizer + Synchronizer + +
+ +
+ +
+
+ temporary + Temporary + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ name + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ id + string + +
+ +
+ +
+
+ physical_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • TOPOLOGY_CHANGE_OP_UNSPECIFIED
    • + +
  • TOPOLOGY_CHANGE_OP_ADD_REPLACE
    • + +
  • TOPOLOGY_CHANGE_OP_REMOVE
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ context + BaseResult + +
+ +
+ +
+
+ item + DynamicSynchronizerParameters + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ store + StoreId + +
+ +
+ +
+
+ sequenced + Timestamp + +
+ +
+ +
+
+ valid_from + Timestamp + +
+ +
+ +
+
+ valid_until + Timestamp + +
+ +
+ +
+
+ operation + TopologyChangeOp + +
+ +
+ +
+
+ transaction_hash + bytes + +
+ +
+ +
+
+ serial + int32 + +
+ +
+ +
+
+ signed_by_fingerprints + repeated string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ confirmation_response_timeout + Duration + +
+ +
+ +
+
+ mediator_reaction_timeout + Duration + +
+ +
+ +
+
+ assignment_exclusivity_timeout + Duration + +
+ +
+ +
+
+ ledger_time_record_time_tolerance + Duration + +
+ +
+ +
+
+ reconciliation_interval + Duration + +
+ +
+ +
+
+ mediator_deduplication_timeout + Duration + +
+ +
+ +
+
+ max_request_size + uint32 + +
+ +
+ +
+
+ onboarding_restriction + OnboardingRestriction + +
+ +
topology related validation parameters permissioned synchronizer: if true, only participants which have been explicitly put on the allow list can onboard to the synchronizer
+ +
+ +
+
+ participant_synchronizer_limits + ParticipantSynchronizerLimits + +
+ +
+ +
+
+ sequencer_aggregate_submission_timeout + Duration + +
+ +
+ +
+
+ traffic_control + TrafficControlParameters + +
+ +
+ +
+
+ acs_commitments_catchup + AcsCommitmentsCatchUpConfig + +
+ +
+ +
+
+ preparation_time_record_time_tolerance + Duration + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • ONBOARDING_RESTRICTION_UNSPECIFIED
    • + +
  • ONBOARDING_RESTRICTION_UNRESTRICTED_OPEN
    • + +
  • ONBOARDING_RESTRICTION_UNRESTRICTED_LOCKED
    • + +
  • ONBOARDING_RESTRICTION_RESTRICTED_OPEN
    • + +
  • ONBOARDING_RESTRICTION_RESTRICTED_LOCKED
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ confirmation_requests_max_rate + uint32 + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ max_base_traffic_amount + uint64 + +
+ +
[doc-entry-start: TrafficControlParameters] In bytes, the maximum amount of base traffic that can be accumulated
+ +
+ +
+
+ max_base_traffic_accumulation_duration + Duration + +
+ +
Maximum duration over which the base rate can be accumulated Consequently, base_traffic_rate = max_base_traffic_amount / max_base_traffic_accumulation_duration
+ +
+ +
+
+ read_vs_write_scaling_factor + uint32 + +
+ +
Read scaling factor to compute the event cost. In parts per 10 000.
+ +
+ +
+
+ set_balance_request_submission_window_size + Duration + +
+ +
Window size used to compute the max sequencing time of a submission request This impacts how quickly a submission is expected to be accepted before a retry should be attempted by the caller Default is 5 minutes
+ +
+ +
+
+ enforce_rate_limiting + bool + +
+ +
If true, submission requests without enough traffic credit will not be delivered
+ +
+ +
+
+ base_event_cost + uint64 + +
+ +
In bytes, base event cost added to all sequenced events. Optional
+ +
+ +
+
+ free_confirmation_responses + bool + +
+ +
Whether to charge for confirmation responses Default: false
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ catchup_interval_skip + uint32 + +
+ +
+ +
+
+ nr_intervals_to_trigger_catchup + uint32 + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsynchronizertrustcertificate.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsynchronizertrustcertificate.mdx new file mode 100644 index 0000000..87a9c2f --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsynchronizertrustcertificate.mdx @@ -0,0 +1,774 @@ +--- +title: "ListSynchronizerTrustCertificate" +--- + +
+ + + + +
+ +

com.digitalasset.canton.topology.admin.v30

+ + +

ListSynchronizerTrustCertificate

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListSynchronizerTrustCertificate + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListSynchronizerTrustCertificate <<'EOF' +{ + "baseQuery": { + "store": { + "authorized": {} + }, + "proposals": true, + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "snapshot": "string", + "filterSignedKey": "string", + "protocolVersion": 0 + }, + "filterUid": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "results": [ + { + "context": { + "store": { + "authorized": {} + }, + "sequenced": "string", + "validFrom": "string", + "validUntil": "string", + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "transactionHash": "BASE64_ENCODED_BYTES", + "serial": 0, + "signedByFingerprints": [ + "string" + ] + }, + "item": { + "participantUid": "string", + "synchronizerId": "string", + "featureFlags": [ + "PARTICIPANT_FEATURE_FLAG_UNSPECIFIED" + ] + } + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
TopologyManagerReadService
+
+ +
+
RPC
+
ListSynchronizerTrustCertificate
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ListSynchronizerTrustCertificateRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ListSynchronizerTrustCertificateRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ filter_uid + string + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ListSynchronizerTrustCertificateResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ListSynchronizerTrustCertificateResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ filter_uid + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ store + StoreId + +
+ +
+ +
+
+ proposals + bool + +
+ +
whether to query only for proposals instead of approved topology mappings
+ +
+ +
+
+ operation + TopologyChangeOp + +
+ +
+ +
+
+ snapshot + Timestamp + +
+ +
+ +
+
+ head_state + Empty + +
+ +
+ +
+
+ range + TimeRange + +
+ +
+ +
+
+ filter_signed_key + string + +
+ +
+ +
+
+ protocol_version + int32 + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ from + Timestamp + +
+ +
+ +
+
+ until + Timestamp + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ authorized + Authorized + +
+ +
+ +
+
+ synchronizer + Synchronizer + +
+ +
+ +
+
+ temporary + Temporary + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ name + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ id + string + +
+ +
+ +
+
+ physical_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • TOPOLOGY_CHANGE_OP_UNSPECIFIED
    • + +
  • TOPOLOGY_CHANGE_OP_ADD_REPLACE
    • + +
  • TOPOLOGY_CHANGE_OP_REMOVE
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ context + BaseResult + +
+ +
+ +
+
+ item + SynchronizerTrustCertificate + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ store + StoreId + +
+ +
+ +
+
+ sequenced + Timestamp + +
+ +
+ +
+
+ valid_from + Timestamp + +
+ +
+ +
+
+ valid_until + Timestamp + +
+ +
+ +
+
+ operation + TopologyChangeOp + +
+ +
+ +
+
+ transaction_hash + bytes + +
+ +
+ +
+
+ serial + int32 + +
+ +
+ +
+
+ signed_by_fingerprints + repeated string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ participant_uid + string + +
+ +
the uid of the participant
+ +
+ +
+
+ synchronizer_id + string + +
+ +
the uid of the synchronizer that the participant trusts
+ +
+ +
+
+ feature_flags + repeated ParticipantFeatureFlag + +
+ +
Feature flags that this node declares to support on this synchronizer
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • PARTICIPANT_FEATURE_FLAG_UNSPECIFIED
    • + +
  • PARTICIPANT_FEATURE_FLAG_PV33_EXTERNAL_SIGNING_LOCAL_CONTRACT_IN_SUBVIEW
    • + +
+ + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsynchronizerupgradeannouncement.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsynchronizerupgradeannouncement.mdx new file mode 100644 index 0000000..7d7fa60 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsynchronizerupgradeannouncement.mdx @@ -0,0 +1,743 @@ +--- +title: "ListSynchronizerUpgradeAnnouncement" +--- + +
+ + + + +
+ +

com.digitalasset.canton.topology.admin.v30

+ + +

ListSynchronizerUpgradeAnnouncement

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListSynchronizerUpgradeAnnouncement + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListSynchronizerUpgradeAnnouncement <<'EOF' +{ + "baseQuery": { + "store": { + "authorized": {} + }, + "proposals": true, + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "snapshot": "string", + "filterSignedKey": "string", + "protocolVersion": 0 + }, + "filterSynchronizerId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "results": [ + { + "context": { + "store": { + "authorized": {} + }, + "sequenced": "string", + "validFrom": "string", + "validUntil": "string", + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "transactionHash": "BASE64_ENCODED_BYTES", + "serial": 0, + "signedByFingerprints": [ + "string" + ] + }, + "item": { + "successorPhysicalSynchronizerId": "string", + "upgradeTime": "string" + } + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
TopologyManagerReadService
+
+ +
+
RPC
+
ListSynchronizerUpgradeAnnouncement
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ListSynchronizerUpgradeAnnouncementRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ListSynchronizerUpgradeAnnouncementRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ filter_synchronizer_id + string + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ListSynchronizerUpgradeAnnouncementResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ListSynchronizerUpgradeAnnouncementResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ filter_synchronizer_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ store + StoreId + +
+ +
+ +
+
+ proposals + bool + +
+ +
whether to query only for proposals instead of approved topology mappings
+ +
+ +
+
+ operation + TopologyChangeOp + +
+ +
+ +
+
+ snapshot + Timestamp + +
+ +
+ +
+
+ head_state + Empty + +
+ +
+ +
+
+ range + TimeRange + +
+ +
+ +
+
+ filter_signed_key + string + +
+ +
+ +
+
+ protocol_version + int32 + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ from + Timestamp + +
+ +
+ +
+
+ until + Timestamp + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ authorized + Authorized + +
+ +
+ +
+
+ synchronizer + Synchronizer + +
+ +
+ +
+
+ temporary + Temporary + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ name + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ id + string + +
+ +
+ +
+
+ physical_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • TOPOLOGY_CHANGE_OP_UNSPECIFIED
    • + +
  • TOPOLOGY_CHANGE_OP_ADD_REPLACE
    • + +
  • TOPOLOGY_CHANGE_OP_REMOVE
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ context + BaseResult + +
+ +
+ +
+
+ item + SynchronizerUpgradeAnnouncement + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ store + StoreId + +
+ +
+ +
+
+ sequenced + Timestamp + +
+ +
+ +
+
+ valid_from + Timestamp + +
+ +
+ +
+
+ valid_until + Timestamp + +
+ +
+ +
+
+ operation + TopologyChangeOp + +
+ +
+ +
+
+ transaction_hash + bytes + +
+ +
+ +
+
+ serial + int32 + +
+ +
+ +
+
+ signed_by_fingerprints + repeated string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ successor_physical_synchronizer_id + string + +
+ +
the physical synchronizer id of the successor synchronizer
+ +
+ +
+
+ upgrade_time + Timestamp + +
+ +
when the upgrade happens
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listvettedpackages.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listvettedpackages.mdx new file mode 100644 index 0000000..0781cf5 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listvettedpackages.mdx @@ -0,0 +1,809 @@ +--- +title: "ListVettedPackages" +--- + +
+ + + + +
+ +

com.digitalasset.canton.topology.admin.v30

+ + +

ListVettedPackages

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListVettedPackages + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListVettedPackages <<'EOF' +{ + "baseQuery": { + "store": { + "authorized": {} + }, + "proposals": true, + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "snapshot": "string", + "filterSignedKey": "string", + "protocolVersion": 0 + }, + "filterParticipant": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "results": [ + { + "context": { + "store": { + "authorized": {} + }, + "sequenced": "string", + "validFrom": "string", + "validUntil": "string", + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "transactionHash": "BASE64_ENCODED_BYTES", + "serial": 0, + "signedByFingerprints": [ + "string" + ] + }, + "item": { + "participantUid": "string", + "packageIds": [ + "string" + ], + "packages": [ + { + "packageId": "string", + "validFromInclusive": "string", + "validUntilExclusive": "string" + } + ] + } + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
TopologyManagerReadService
+
+ +
+
RPC
+
ListVettedPackages
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ListVettedPackagesRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ListVettedPackagesRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ filter_participant + string + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ListVettedPackagesResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ListVettedPackagesResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ filter_participant + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ store + StoreId + +
+ +
+ +
+
+ proposals + bool + +
+ +
whether to query only for proposals instead of approved topology mappings
+ +
+ +
+
+ operation + TopologyChangeOp + +
+ +
+ +
+
+ snapshot + Timestamp + +
+ +
+ +
+
+ head_state + Empty + +
+ +
+ +
+
+ range + TimeRange + +
+ +
+ +
+
+ filter_signed_key + string + +
+ +
+ +
+
+ protocol_version + int32 + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ from + Timestamp + +
+ +
+ +
+
+ until + Timestamp + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ authorized + Authorized + +
+ +
+ +
+
+ synchronizer + Synchronizer + +
+ +
+ +
+
+ temporary + Temporary + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ name + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ id + string + +
+ +
+ +
+
+ physical_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • TOPOLOGY_CHANGE_OP_UNSPECIFIED
    • + +
  • TOPOLOGY_CHANGE_OP_ADD_REPLACE
    • + +
  • TOPOLOGY_CHANGE_OP_REMOVE
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ context + BaseResult + +
+ +
+ +
+
+ item + VettedPackages + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ store + StoreId + +
+ +
+ +
+
+ sequenced + Timestamp + +
+ +
+ +
+
+ valid_from + Timestamp + +
+ +
+ +
+
+ valid_until + Timestamp + +
+ +
+ +
+
+ operation + TopologyChangeOp + +
+ +
+ +
+
+ transaction_hash + bytes + +
+ +
+ +
+
+ serial + int32 + +
+ +
+ +
+
+ signed_by_fingerprints + repeated string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ participant_uid + string + +
+ +
the participant vetting the packages
+ +
+ +
+
+ package_ids + repeated string + +
+ +
DEPRECATED: no longer used, but kept for backwards compatibility. the hashes of the vetted packages. package hashes may only be listed in one of the two fields: package_ids or packages. a package listed in package_ids is equivalent to a package listed in packages with unbounded validity.
+ +
+ +
+
+ packages + repeated VettedPackage + +
+ +
the hashes of vetted packages with a validity period. only one entry per package_id is permitted.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ package_id + string + +
+ +
the hash of the vetted package
+ +
+ +
+
+ valid_from_inclusive + Timestamp + +
+ +
optional earliest ledger effective time (inclusive) as of which the package is considered valid. must be less than or equal to valid_until if both are present.
+ +
+ +
+
+ valid_until_exclusive + Timestamp + +
+ +
optional latest ledger effective time (exclusive) until which the package is considered valid. must be greater than or equal to valid_from if both are present.
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/logicalupgradestate.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/logicalupgradestate.mdx new file mode 100644 index 0000000..bc9c37f --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/logicalupgradestate.mdx @@ -0,0 +1,281 @@ +--- +title: "LogicalUpgradeState" +--- + +
+ + + + +
+ +

com.digitalasset.canton.topology.admin.v30

+ + +

LogicalUpgradeState

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/LogicalUpgradeState + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/LogicalUpgradeState <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "chunk": "BASE64_ENCODED_BYTES" +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
TopologyManagerReadService
+
+ +
+
RPC
+
LogicalUpgradeState
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
Yes
+
+ +
+ + +## Inputs + + +
+
+

LogicalUpgradeStateRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.LogicalUpgradeStateRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + + + + + +
+ + +## Outputs + + +
+
+

LogicalUpgradeStateResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.LogicalUpgradeStateResponse
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + +
+ +
+
+ chunk + bytes + +
+ +
versioned stored topology transactions
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ chunk + bytes + +
+ +
versioned stored topology transactions
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/addtransactions.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/addtransactions.mdx new file mode 100644 index 0000000..124ce77 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/addtransactions.mdx @@ -0,0 +1,845 @@ +--- +title: "AddTransactions" +--- + +
+ + + + +
+ +

com.digitalasset.canton.topology.admin.v30

+ + +

AddTransactions

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.topology.admin.v30.TopologyManagerWriteService/AddTransactions + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerWriteService/AddTransactions <<'EOF' +{ + "transactions": [ + { + "transaction": "BASE64_ENCODED_BYTES", + "signatures": [ + { + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signedBy": "string", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", + "signatureDelegation": { + "sessionKey": "BASE64_ENCODED_BYTES", + "sessionKeySpec": "SIGNING_KEY_SPEC_UNSPECIFIED", + "validityPeriodFromInclusive": "0", + "validityPeriodDurationSeconds": 0, + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" + } + } + ], + "proposal": true, + "multiTransactionSignatures": [ + { + "transactionHashes": [ + "BASE64_ENCODED_BYTES" + ], + "signatures": [ + { + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signedBy": "string", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", + "signatureDelegation": {} + } + ] + } + ] + } + ], + "forceChanges": [ + "FORCE_FLAG_UNSPECIFIED" + ], + "store": { + "authorized": {} + }, + "waitToBecomeEffective": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
TopologyManagerWriteService
+
+ +
+
RPC
+
AddTransactions
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

AddTransactionsRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.AddTransactionsRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ transactions + repeated SignedTopologyTransaction + +
+ +
* The transactions that should be added to the target store as indicated by the parameter `store`.
+ +
+ +
+
+ force_changes + repeated ForceFlag + +
+ +
* Force specific changes even if dangerous
+ +
+ +
+
+ store + StoreId + +
+ +
* The store that is used as the underlying source for executing this request. If `store` is a synchronizers store, the resulting topology transaction will only be available on the respective synchronizers. If `store` is the authorized store, the resulting topology transaction may or may not be synchronized automatically to all synchronizers that the node is currently connected to or will be connected to in the future. Selecting a specific synchronizers store might be necessary, if the transaction to authorize by hash or the previous generation of the submitted proposal is only available on the synchronizers store and not in the authorized store.
+ +
+ +
+
+ wait_to_become_effective + Duration + +
+ +
* Optional timeout to wait for the transaction to become effective in the store.
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

AddTransactionsResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.AddTransactionsResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ transactions + repeated SignedTopologyTransaction + +
+ +
* The transactions that should be added to the target store as indicated by the parameter `store`.
+ +
+ +
+
+ force_changes + repeated ForceFlag + +
+ +
* Force specific changes even if dangerous
+ +
+ +
+
+ store + StoreId + +
+ +
* The store that is used as the underlying source for executing this request. If `store` is a synchronizers store, the resulting topology transaction will only be available on the respective synchronizers. If `store` is the authorized store, the resulting topology transaction may or may not be synchronized automatically to all synchronizers that the node is currently connected to or will be connected to in the future. Selecting a specific synchronizers store might be necessary, if the transaction to authorize by hash or the previous generation of the submitted proposal is only available on the synchronizers store and not in the authorized store.
+ +
+ +
+
+ wait_to_become_effective + Duration + +
+ +
* Optional timeout to wait for the transaction to become effective in the store.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ transaction + bytes + +
+ +
serialized topology transaction (protobuf bytestring)
+ +
+ +
+
+ signatures + repeated Signature + +
+ +
multiple signatures Either this field OR the multi_transaction_signatures field MUST contain at least one signature
+ +
+ +
+
+ proposal + bool + +
+ +
if true, this transaction is just a proposal. this means that every signature is valid, but the signatures are insufficient to properly authorize the transaction. proposals are distributed via the topology channel too. proposals will be pruned automatically when the nodes are pruned TODO(#14045) implement pruning
+ +
+ +
+
+ multi_transaction_signatures + repeated MultiTransactionSignatures + +
+ +
If set, the transaction may be authorized by signing a hash computed from multiple transaction hashes This allows to effectively authorize multiple transactions with a single signature. Each item MUST contain the hash of this transaction Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ format + SignatureFormat + +
+ +
+ +
+
+ signature + bytes + +
+ +
+ +
+
+ signed_by + string + +
+ +
The fingerprint/id of the keypair used to create this signature and needed to verify. If a signature delegation is defined, this fingerprint/id is not used to produce the signature, and, instead is used to sign the delegation.
+ +
+ +
+
+ signing_algorithm_spec + SigningAlgorithmSpec + +
+ +
The signing algorithm specification used to produce this signature
+ +
+ +
+
+ signature_delegation + SignatureDelegation + +
+ +
An optional signature delegation where a long-term signing key authorizes a session signing key to sign on its behalf.
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • SIGNATURE_FORMAT_UNSPECIFIED
    • + +
  • SIGNATURE_FORMAT_RAW
    • + +
  • SIGNATURE_FORMAT_DER
    • + +
  • SIGNATURE_FORMAT_CONCAT
    • + +
  • SIGNATURE_FORMAT_SYMBOLIC
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_ALGORITHM_SPEC_UNSPECIFIED
    • + +
  • SIGNING_ALGORITHM_SPEC_ED25519
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_256
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_384
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ session_key + bytes + +
+ +
ASN.1 + DER-encoding of X.509 SubjectPublicKeyInfo structure of the session public key: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1. This key was used to produce the actual signature.
+ +
+ +
+
+ session_key_spec + SigningKeySpec + +
+ +
The signing key spec for the session key.
+ +
+ +
+
+ validity_period_from_inclusive + int64 + +
+ +
A timestamp in microseconds of UTC time since Unix epoch that indicates when the session key is considered valid.
+ +
+ +
+
+ validity_period_duration_seconds + uint32 + +
+ +
Duration in seconds indicating how long the session key remains valid. The validity period starts from `validity_period_from_inclusive` above.
+ +
+ +
+
+ format + SignatureFormat + +
+ +
The format of the signature
+ +
+ +
+
+ signature + bytes + +
+ +
The signature of the combined hash of the session key fingerprint, validity period, and synchronizer id, by the long-term key. This signature authorizes the session key to act on behalf of the long-term key.
+ +
+ +
+
+ signing_algorithm_spec + SigningAlgorithmSpec + +
+ +
The signing algorithm specification used to produce this signature
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_SPEC_UNSPECIFIED
    • + +
  • SIGNING_KEY_SPEC_EC_CURVE25519
    • + +
  • SIGNING_KEY_SPEC_EC_P256
    • + +
  • SIGNING_KEY_SPEC_EC_P384
    • + +
  • SIGNING_KEY_SPEC_EC_SECP256K1
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ transaction_hashes + repeated bytes + +
+ +
List of topology transaction hashes. Required
+ +
+ +
+
+ signatures + repeated Signature + +
+ +
Signatures on the combined hash computed over the transaction_hashes MUST contain at least one
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • FORCE_FLAG_UNSPECIFIED
    • + +
  • FORCE_FLAG_ALIEN_MEMBER
    • + +
  • FORCE_FLAG_LEDGER_TIME_RECORD_TIME_TOLERANCE_INCREASE
    • + +
  • FORCE_FLAG_ALLOW_UNKNOWN_PACKAGE
    • + +
  • FORCE_FLAG_ALLOW_UNVETTED_DEPENDENCIES
    • + +
  • FORCE_FLAG_DISABLE_PARTY_WITH_ACTIVE_CONTRACTS
    • + +
  • FORCE_FLAG_ALLOW_UNVALIDATED_SIGNING_KEYS
    • + +
  • FORCE_FLAG_PREPARATION_TIME_RECORD_TIME_TOLERANCE_INCREASE
    • + +
  • FORCE_FLAG_ALLOW_INSUFFICIENT_PARTICIPANT_PERMISSION_FOR_SIGNATORY_PARTY
    • + +
  • FORCE_FLAG_ALLOW_INSUFFICIENT_SIGNATORY_ASSIGNING_PARTICIPANTS_FOR_PARTY
    • + +
  • FORCE_FLAG_ALLOW_VET_INCOMPATIBLE_UPGRADES
    • + +
  • FORCE_FLAG_ALLOW_OUT_OF_BOUNDS_VALUE
    • + +
  • FORCE_FLAG_ALLOW_CONFIRMING_THRESHOLD_CANNOT_BE_MET
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ authorized + Authorized + +
+ +
+ +
+
+ synchronizer + Synchronizer + +
+ +
+ +
+
+ temporary + Temporary + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ name + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ id + string + +
+ +
+ +
+
+ physical_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/authorize.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/authorize.mdx new file mode 100644 index 0000000..3d3d362 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/authorize.mdx @@ -0,0 +1,2784 @@ +--- +title: "Authorize" +--- + +
+ + + + +
+ +

com.digitalasset.canton.topology.admin.v30

+ + +

Authorize

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.topology.admin.v30.TopologyManagerWriteService/Authorize + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerWriteService/Authorize <<'EOF' +{ + "proposal": { + "change": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "serial": 0, + "mapping": { + "namespaceDelegation": { + "namespace": "string", + "targetKey": {}, + "isRootDelegation": true, + "canSignAllMappings": {} + } + } + }, + "mustFullyAuthorize": true, + "forceChanges": [ + "FORCE_FLAG_UNSPECIFIED" + ], + "signedBy": [ + "string" + ], + "store": { + "authorized": {} + }, + "waitToBecomeEffective": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "transaction": { + "transaction": "BASE64_ENCODED_BYTES", + "signatures": [ + { + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signedBy": "string", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", + "signatureDelegation": { + "sessionKey": "BASE64_ENCODED_BYTES", + "sessionKeySpec": "SIGNING_KEY_SPEC_UNSPECIFIED", + "validityPeriodFromInclusive": "0", + "validityPeriodDurationSeconds": 0, + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" + } + } + ], + "proposal": true, + "multiTransactionSignatures": [ + { + "transactionHashes": [ + "BASE64_ENCODED_BYTES" + ], + "signatures": [ + { + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signedBy": "string", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", + "signatureDelegation": {} + } + ] + } + ] + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
TopologyManagerWriteService
+
+ +
+
RPC
+
Authorize
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

AuthorizeRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.AuthorizeRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ proposal + Proposal + +
+ +
* Propose a transaction and distribute it. If authorize if the node has enough signing keys
+ +
+ +
+
+ transaction_hash + string + +
+ +
* Authorize a transaction, meaning the node needs to be able to fully sign it locally. Hash is in hexadecimal format.
+ +
+ +
+
+ must_fully_authorize + bool + +
+ +
* If true: the transaction is only signed if the new signatures will result in the transaction being fully authorized. Otherwise returns as an error. If false: the transaction is signed and the signature distributed. The transaction may still not be fully authorized and remain as a proposal.
+ +
+ +
+
+ force_changes + repeated ForceFlag + +
+ +
* Force specific changes even if dangerous
+ +
+ +
+
+ signed_by + repeated string + +
+ +
* Fingerprint of the keys signing the authorization The signing key is used to identify a particular `NamespaceDelegation` certificate, which is used to justify the given authorization. Optional, if empty, suitable signing keys available known to the node are automatically selected.
+ +
+ +
+
+ store + StoreId + +
+ +
* The store that is used as the underlying source for executing this request. If `store` is a synchronizer store, the resulting topology transaction will only be available on the respective synchronizer. If `store` is the authorized store, the resulting topology transaction may or may not be synchronized automatically to all synchronizers that the node is currently connected to or will be connected to in the future. Selecting a specific synchronizers store might be necessary, if the transaction to authorize by hash or the previous generation of the submitted proposal is only available on the synchronizers store and not in the authorized store.
+ +
+ +
+
+ wait_to_become_effective + Duration + +
+ +
* Optional timeout to wait for the transaction to become effective in the store.
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

AuthorizeResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.AuthorizeResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ transaction + SignedTopologyTransaction + +
+ +
* the generated signed topology transaction
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ proposal + Proposal + +
+ +
* Propose a transaction and distribute it. If authorize if the node has enough signing keys
+ +
+ +
+
+ transaction_hash + string + +
+ +
* Authorize a transaction, meaning the node needs to be able to fully sign it locally. Hash is in hexadecimal format.
+ +
+ +
+
+ must_fully_authorize + bool + +
+ +
* If true: the transaction is only signed if the new signatures will result in the transaction being fully authorized. Otherwise returns as an error. If false: the transaction is signed and the signature distributed. The transaction may still not be fully authorized and remain as a proposal.
+ +
+ +
+
+ force_changes + repeated ForceFlag + +
+ +
* Force specific changes even if dangerous
+ +
+ +
+
+ signed_by + repeated string + +
+ +
* Fingerprint of the keys signing the authorization The signing key is used to identify a particular `NamespaceDelegation` certificate, which is used to justify the given authorization. Optional, if empty, suitable signing keys available known to the node are automatically selected.
+ +
+ +
+
+ store + StoreId + +
+ +
* The store that is used as the underlying source for executing this request. If `store` is a synchronizer store, the resulting topology transaction will only be available on the respective synchronizer. If `store` is the authorized store, the resulting topology transaction may or may not be synchronized automatically to all synchronizers that the node is currently connected to or will be connected to in the future. Selecting a specific synchronizers store might be necessary, if the transaction to authorize by hash or the previous generation of the submitted proposal is only available on the synchronizers store and not in the authorized store.
+ +
+ +
+
+ wait_to_become_effective + Duration + +
+ +
* Optional timeout to wait for the transaction to become effective in the store.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ change + TopologyChangeOp + +
+ +
* Replace / Remove
+ +
+ +
+
+ serial + uint32 + +
+ +
* Optionally, the serial number of this request (auto-determined if omitted)
+ +
+ +
+
+ mapping + TopologyMapping + +
+ +
* The mapping to be authorized
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • TOPOLOGY_CHANGE_OP_UNSPECIFIED
    • + +
  • TOPOLOGY_CHANGE_OP_ADD_REPLACE
    • + +
  • TOPOLOGY_CHANGE_OP_REMOVE
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ namespace_delegation + NamespaceDelegation + +
+ +
+ +
+
+ decentralized_namespace_definition + DecentralizedNamespaceDefinition + +
+ +
+ +
+
+ owner_to_key_mapping + OwnerToKeyMapping + +
+ +
+ +
+
+ synchronizer_trust_certificate + SynchronizerTrustCertificate + +
+ +
+ +
+
+ participant_permission + ParticipantSynchronizerPermission + +
+ +
+ +
+
+ party_hosting_limits + PartyHostingLimits + +
+ +
+ +
+
+ vetted_packages + VettedPackages + +
+ +
+ +
+
+ party_to_participant + PartyToParticipant + +
+ +
+ +
+
+ synchronizer_parameters_state + SynchronizerParametersState + +
+ +
+ +
+
+ mediator_synchronizer_state + MediatorSynchronizerState + +
+ +
+ +
+
+ sequencer_synchronizer_state + SequencerSynchronizerState + +
+ +
+ +
+
+ sequencing_dynamic_parameters_state + DynamicSequencingParametersState + +
+ +
+ +
+
+ party_to_key_mapping + PartyToKeyMapping + +
+ +
+ +
+
+ synchronizer_upgrade_announcement + SynchronizerUpgradeAnnouncement + +
+ +
+ +
+
+ sequencer_connection_successor + SequencerConnectionSuccessor + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ namespace + string + +
+ +
fingerprint of the root key defining the namespace
+ +
+ +
+
+ target_key + SigningPublicKey + +
+ +
target key of getting full rights on the namespace (if target == namespace, it's a root CA)
+ +
+ +
+
+ is_root_delegation + bool + +
+ +
flag indicating whether the given delegation is a root delegation or not a root delegation is also allowed to issue other NamespaceDelegations.
+ +
+ +
+
+ can_sign_all_mappings + CanSignAllMappings + +
+ +
+ +
+
+ can_sign_all_but_namespace_delegations + CanSignAllButNamespaceDelegations + +
+ +
+ +
+
+ can_sign_specific_mapings + CanSignSpecificMappings + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ mappings + repeated TopologyMappingCode + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • TOPOLOGY_MAPPING_CODE_UNSPECIFIED
    • + +
  • TOPOLOGY_MAPPING_CODE_NAMESPACE_DELEGATION
    • + +
  • TOPOLOGY_MAPPING_CODE_DECENTRALIZED_NAMESPACE_DEFINITION
    • + +
  • TOPOLOGY_MAPPING_CODE_OWNER_TO_KEY_MAPPING
    • + +
  • TOPOLOGY_MAPPING_CODE_SYNCHRONIZER_TRUST_CERTIFICATE
    • + +
  • TOPOLOGY_MAPPING_CODE_PARTICIPANT_PERMISSION
    • + +
  • TOPOLOGY_MAPPING_CODE_PARTY_HOSTING_LIMITS
    • + +
  • TOPOLOGY_MAPPING_CODE_VETTED_PACKAGES
    • + +
  • TOPOLOGY_MAPPING_CODE_PARTY_TO_PARTICIPANT
    • + +
  • TOPOLOGY_MAPPING_CODE_SYNCHRONIZER_PARAMETERS_STATE
    • + +
  • TOPOLOGY_MAPPING_CODE_MEDIATOR_SYNCHRONIZER_STATE
    • + +
  • TOPOLOGY_MAPPING_CODE_SEQUENCER_SYNCHRONIZER_STATE
    • + +
  • TOPOLOGY_MAPPING_CODE_SEQUENCING_DYNAMIC_PARAMETERS_STATE
    • + +
  • TOPOLOGY_MAPPING_CODE_PARTY_TO_KEY_MAPPING
    • + +
  • TOPOLOGY_MAPPING_CODE_SYNCHRONIZER_MIGRATION_ANNOUNCEMENT
    • + +
  • TOPOLOGY_MAPPING_CODE_SEQUENCER_CONNECTION_SUCCESSOR
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ format + CryptoKeyFormat + +
+ +
+ +
+
+ public_key + bytes + +
+ +
Serialized public key in the format specified above
+ +
+ +
+
+ scheme + SigningKeyScheme + +
+ +
No longer used (only kept for backwards compatibility) stores both the crypto key scheme and algorithm.
+ +
+ +
+
+ usage + repeated SigningKeyUsage + +
+ +
Explicitly state the key's intended use
+ +
+ +
+
+ key_spec + SigningKeySpec + +
+ +
The key specification that was used to generate the key pair
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • CRYPTO_KEY_FORMAT_UNSPECIFIED
    • + +
  • CRYPTO_KEY_FORMAT_DER
    • + +
  • CRYPTO_KEY_FORMAT_RAW
    • + +
  • CRYPTO_KEY_FORMAT_DER_X509_SUBJECT_PUBLIC_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_DER_PKCS8_PRIVATE_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_SYMBOLIC
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_SCHEME_UNSPECIFIED
    • + +
  • SIGNING_KEY_SCHEME_ED25519
    • + +
  • SIGNING_KEY_SCHEME_EC_DSA_P256
    • + +
  • SIGNING_KEY_SCHEME_EC_DSA_P384
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_USAGE_UNSPECIFIED
    • + +
  • SIGNING_KEY_USAGE_NAMESPACE
    • + +
  • SIGNING_KEY_USAGE_IDENTITY_DELEGATION
    • + +
  • SIGNING_KEY_USAGE_SEQUENCER_AUTHENTICATION
    • + +
  • SIGNING_KEY_USAGE_PROTOCOL
    • + +
  • SIGNING_KEY_USAGE_PROOF_OF_OWNERSHIP
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_SPEC_UNSPECIFIED
    • + +
  • SIGNING_KEY_SPEC_EC_CURVE25519
    • + +
  • SIGNING_KEY_SPEC_EC_P256
    • + +
  • SIGNING_KEY_SPEC_EC_P384
    • + +
  • SIGNING_KEY_SPEC_EC_SECP256K1
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ decentralized_namespace + string + +
+ +
name of the decentralized namespace, computed from the hash of its initial owners
+ +
+ +
+
+ threshold + int32 + +
+ +
the threshold required for any subsequent update signing
+ +
+ +
+
+ owners + repeated string + +
+ +
the namespaces of the owners
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ member + string + +
+ +
the sequencing process member
+ +
+ +
+
+ public_keys + repeated PublicKey + +
+ +
the designated keys
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ signing_public_key + SigningPublicKey + +
+ +
+ +
+
+ encryption_public_key + EncryptionPublicKey + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ format + CryptoKeyFormat + +
+ +
+ +
+
+ public_key + bytes + +
+ +
Serialized public key in the format specified above
+ +
+ +
+
+ scheme + EncryptionKeyScheme + +
+ +
No longer used (only kept for backwards compatibility) stores both the crypto key scheme and algorithm.
+ +
+ +
+
+ key_spec + EncryptionKeySpec + +
+ +
The key specification that was used to generate the key pair
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • ENCRYPTION_KEY_SCHEME_UNSPECIFIED
    • + +
  • ENCRYPTION_KEY_SCHEME_ECIES_P256_HKDF_HMAC_SHA256_AES128GCM
    • + +
  • ENCRYPTION_KEY_SCHEME_ECIES_P256_HMAC_SHA256A_ES128CBC
    • + +
  • ENCRYPTION_KEY_SCHEME_RSA2048_OAEP_SHA256
    • + +
+ + +
+ + + +
+ + + +
    + +
  • ENCRYPTION_KEY_SPEC_UNSPECIFIED
    • + +
  • ENCRYPTION_KEY_SPEC_EC_P256
    • + +
  • ENCRYPTION_KEY_SPEC_RSA_2048
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ participant_uid + string + +
+ +
the uid of the participant
+ +
+ +
+
+ synchronizer_id + string + +
+ +
the uid of the synchronizer that the participant trusts
+ +
+ +
+
+ feature_flags + repeated ParticipantFeatureFlag + +
+ +
Feature flags that this node declares to support on this synchronizer
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • PARTICIPANT_FEATURE_FLAG_UNSPECIFIED
    • + +
  • PARTICIPANT_FEATURE_FLAG_PV33_EXTERNAL_SIGNING_LOCAL_CONTRACT_IN_SUBVIEW
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ synchronizer_id + string + +
+ +
+ +
+
+ participant_uid + string + +
+ +
+ +
+
+ permission + ParticipantPermission + +
+ +
the permission level of the participant on this synchronizer (usually submission)
+ +
+ +
+
+ limits + ParticipantSynchronizerLimits + +
+ +
optional individual limits for this participant
+ +
+ +
+
+ login_after + int64 + +
+ +
optional earliest time when participant can log in (again) used to temporarily disable participants In microseconds of UTC time since Unix epoch
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • PARTICIPANT_PERMISSION_UNSPECIFIED
    • + +
  • PARTICIPANT_PERMISSION_SUBMISSION
    • + +
  • PARTICIPANT_PERMISSION_CONFIRMATION
    • + +
  • PARTICIPANT_PERMISSION_OBSERVATION
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ confirmation_requests_max_rate + uint32 + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ synchronizer_id + string + +
+ +
+ +
+
+ party + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ participant_uid + string + +
+ +
the participant vetting the packages
+ +
+ +
+
+ package_ids + repeated string + +
+ +
DEPRECATED: no longer used, but kept for backwards compatibility. the hashes of the vetted packages. package hashes may only be listed in one of the two fields: package_ids or packages. a package listed in package_ids is equivalent to a package listed in packages with unbounded validity.
+ +
+ +
+
+ packages + repeated VettedPackage + +
+ +
the hashes of vetted packages with a validity period. only one entry per package_id is permitted.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ package_id + string + +
+ +
the hash of the vetted package
+ +
+ +
+
+ valid_from_inclusive + Timestamp + +
+ +
optional earliest ledger effective time (inclusive) as of which the package is considered valid. must be less than or equal to valid_until if both are present.
+ +
+ +
+
+ valid_until_exclusive + Timestamp + +
+ +
optional latest ledger effective time (exclusive) until which the package is considered valid. must be greater than or equal to valid_from if both are present.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ party + string + +
+ +
the party that is to be represented by the participants
+ +
+ +
+
+ threshold + uint32 + +
+ +
the signatory threshold required by the participants to be able to act on behalf of the party. a mapping with threshold > 1 is considered a definition of a consortium party
+ +
+ +
+
+ participants + repeated HostingParticipant + +
+ +
which participants will host the party. if threshold > 1, must be Confirmation or Observation. if all participants have Observation permission, the confirmation treshold is ignored, making the party a purely observing party.
+ +
+ +
+
+ party_signing_keys + SigningKeysWithThreshold + +
+ +
Contains protocol signing keys for the party used to authorize externally signed Daml transactions, along with a signing threshold. The max number of keys is 20
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ participant_uid + string + +
+ +
the target participant that the party should be mapped to
+ +
+ +
+
+ permission + ParticipantPermission + +
+ +
permission of the participant for this particular party (the actual will be min of ParticipantSynchronizerPermission.ParticipantPermission and this setting)
+ +
+ +
+
+ onboarding + Onboarding + +
+ +
optional, present iff the party is being onboarded to the participant
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ keys + repeated SigningPublicKey + +
+ +
the designated signing keys
+ +
+ +
+
+ threshold + uint32 + +
+ +
the authorization threshold
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ synchronizer_id + string + +
+ +
synchronizer affected by the new synchronizer parameters
+ +
+ +
+
+ synchronizer_parameters + DynamicSynchronizerParameters + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ confirmation_response_timeout + Duration + +
+ +
+ +
+
+ mediator_reaction_timeout + Duration + +
+ +
+ +
+
+ assignment_exclusivity_timeout + Duration + +
+ +
+ +
+
+ ledger_time_record_time_tolerance + Duration + +
+ +
+ +
+
+ reconciliation_interval + Duration + +
+ +
+ +
+
+ mediator_deduplication_timeout + Duration + +
+ +
+ +
+
+ max_request_size + uint32 + +
+ +
+ +
+
+ onboarding_restriction + OnboardingRestriction + +
+ +
topology related validation parameters permissioned synchronizer: if true, only participants which have been explicitly put on the allow list can onboard to the synchronizer
+ +
+ +
+
+ participant_synchronizer_limits + ParticipantSynchronizerLimits + +
+ +
+ +
+
+ sequencer_aggregate_submission_timeout + Duration + +
+ +
+ +
+
+ traffic_control + TrafficControlParameters + +
+ +
+ +
+
+ acs_commitments_catchup + AcsCommitmentsCatchUpConfig + +
+ +
+ +
+
+ preparation_time_record_time_tolerance + Duration + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • ONBOARDING_RESTRICTION_UNSPECIFIED
    • + +
  • ONBOARDING_RESTRICTION_UNRESTRICTED_OPEN
    • + +
  • ONBOARDING_RESTRICTION_UNRESTRICTED_LOCKED
    • + +
  • ONBOARDING_RESTRICTION_RESTRICTED_OPEN
    • + +
  • ONBOARDING_RESTRICTION_RESTRICTED_LOCKED
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ max_base_traffic_amount + uint64 + +
+ +
[doc-entry-start: TrafficControlParameters] In bytes, the maximum amount of base traffic that can be accumulated
+ +
+ +
+
+ max_base_traffic_accumulation_duration + Duration + +
+ +
Maximum duration over which the base rate can be accumulated Consequently, base_traffic_rate = max_base_traffic_amount / max_base_traffic_accumulation_duration
+ +
+ +
+
+ read_vs_write_scaling_factor + uint32 + +
+ +
Read scaling factor to compute the event cost. In parts per 10 000.
+ +
+ +
+
+ set_balance_request_submission_window_size + Duration + +
+ +
Window size used to compute the max sequencing time of a submission request This impacts how quickly a submission is expected to be accepted before a retry should be attempted by the caller Default is 5 minutes
+ +
+ +
+
+ enforce_rate_limiting + bool + +
+ +
If true, submission requests without enough traffic credit will not be delivered
+ +
+ +
+
+ base_event_cost + uint64 + +
+ +
In bytes, base event cost added to all sequenced events. Optional
+ +
+ +
+
+ free_confirmation_responses + bool + +
+ +
Whether to charge for confirmation responses Default: false
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ catchup_interval_skip + uint32 + +
+ +
+ +
+
+ nr_intervals_to_trigger_catchup + uint32 + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ synchronizer_id + string + +
+ +
the synchronizer id of the mediator group
+ +
+ +
+
+ group + uint32 + +
+ +
the group-id used for sharding multiple mediator groups
+ +
+ +
+
+ threshold + uint32 + +
+ +
the signature threshold required to reach consensus among the mediators
+ +
+ +
+
+ active + repeated string + +
+ +
the list of active mediators (uid) within the group
+ +
+ +
+
+ observers + repeated string + +
+ +
the list of observing mediators (uid) within the group (read messages but don't respond)
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ synchronizer_id + string + +
+ +
the synchronizer id of the sequencer group
+ +
+ +
+
+ threshold + uint32 + +
+ +
The system can tolerate up to min(threshold - 1, (activeWithSigningKey.size - 1)/3) malicious active sequencers, where activeWithSigningKey is the set of sequencers from active that have an active OwnerToKeyMapping with a signing key. In order to make the system resilient against f malicious active sequencers, you need to: (1) configure threshold := f + 1, (2) possibly add active sequencers such that f <= (activeWithSigningKey.size - 1)/3. (3) possibly register signing keys for active sequencers,
+ +
+ +
+
+ active + repeated string + +
+ +
the list of active sequencers If a sequencer without an active signing key is added to this set, it has no effect on the topology state.
+ +
+ +
+
+ observers + repeated string + +
+ +
the list of observing sequencers (uid) within the group (read messages but don't respond)
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ synchronizer_id + string + +
+ +
synchronizer affected by the new synchronizer parameters
+ +
+ +
+
+ sequencing_parameters + DynamicSequencingParameters + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ payload + bytes + +
+ +
Sequencing dynamic synchronizer parameters can only be interpreted by a sequencer implementation and are opaque to the rest of the synchronizer.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ party + string + +
+ +
the party
+ +
+ +
+
+ threshold + uint32 + +
+ +
the authorization threshold
+ +
+ +
+
+ signing_keys + repeated SigningPublicKey + +
+ +
the designated signing keys
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ successor_physical_synchronizer_id + string + +
+ +
the physical synchronizer id of the successor synchronizer
+ +
+ +
+
+ upgrade_time + Timestamp + +
+ +
when the upgrade happens
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ sequencer_id + string + +
+ +
the sequencer id
+ +
+ +
+
+ synchronizer_id + string + +
+ +
to synchronizer id
+ +
+ +
+
+ connection + SequencerConnection + +
+ +
the connection details with which members can connect to the sequencer on the successor synchronizer
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ grpc + Grpc + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ endpoints + repeated string + +
+ +
connection information to sequencer (http[s]://<host>:<port>") all endpoints must agree on using HTTPS or HTTP
+ +
+ +
+
+ custom_trust_certificates + bytes + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • FORCE_FLAG_UNSPECIFIED
    • + +
  • FORCE_FLAG_ALIEN_MEMBER
    • + +
  • FORCE_FLAG_LEDGER_TIME_RECORD_TIME_TOLERANCE_INCREASE
    • + +
  • FORCE_FLAG_ALLOW_UNKNOWN_PACKAGE
    • + +
  • FORCE_FLAG_ALLOW_UNVETTED_DEPENDENCIES
    • + +
  • FORCE_FLAG_DISABLE_PARTY_WITH_ACTIVE_CONTRACTS
    • + +
  • FORCE_FLAG_ALLOW_UNVALIDATED_SIGNING_KEYS
    • + +
  • FORCE_FLAG_PREPARATION_TIME_RECORD_TIME_TOLERANCE_INCREASE
    • + +
  • FORCE_FLAG_ALLOW_INSUFFICIENT_PARTICIPANT_PERMISSION_FOR_SIGNATORY_PARTY
    • + +
  • FORCE_FLAG_ALLOW_INSUFFICIENT_SIGNATORY_ASSIGNING_PARTICIPANTS_FOR_PARTY
    • + +
  • FORCE_FLAG_ALLOW_VET_INCOMPATIBLE_UPGRADES
    • + +
  • FORCE_FLAG_ALLOW_OUT_OF_BOUNDS_VALUE
    • + +
  • FORCE_FLAG_ALLOW_CONFIRMING_THRESHOLD_CANNOT_BE_MET
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ authorized + Authorized + +
+ +
+ +
+
+ synchronizer + Synchronizer + +
+ +
+ +
+
+ temporary + Temporary + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ name + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ id + string + +
+ +
+ +
+
+ physical_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ transaction + SignedTopologyTransaction + +
+ +
* the generated signed topology transaction
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ transaction + bytes + +
+ +
serialized topology transaction (protobuf bytestring)
+ +
+ +
+
+ signatures + repeated Signature + +
+ +
multiple signatures Either this field OR the multi_transaction_signatures field MUST contain at least one signature
+ +
+ +
+
+ proposal + bool + +
+ +
if true, this transaction is just a proposal. this means that every signature is valid, but the signatures are insufficient to properly authorize the transaction. proposals are distributed via the topology channel too. proposals will be pruned automatically when the nodes are pruned TODO(#14045) implement pruning
+ +
+ +
+
+ multi_transaction_signatures + repeated MultiTransactionSignatures + +
+ +
If set, the transaction may be authorized by signing a hash computed from multiple transaction hashes This allows to effectively authorize multiple transactions with a single signature. Each item MUST contain the hash of this transaction Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ format + SignatureFormat + +
+ +
+ +
+
+ signature + bytes + +
+ +
+ +
+
+ signed_by + string + +
+ +
The fingerprint/id of the keypair used to create this signature and needed to verify. If a signature delegation is defined, this fingerprint/id is not used to produce the signature, and, instead is used to sign the delegation.
+ +
+ +
+
+ signing_algorithm_spec + SigningAlgorithmSpec + +
+ +
The signing algorithm specification used to produce this signature
+ +
+ +
+
+ signature_delegation + SignatureDelegation + +
+ +
An optional signature delegation where a long-term signing key authorizes a session signing key to sign on its behalf.
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • SIGNATURE_FORMAT_UNSPECIFIED
    • + +
  • SIGNATURE_FORMAT_RAW
    • + +
  • SIGNATURE_FORMAT_DER
    • + +
  • SIGNATURE_FORMAT_CONCAT
    • + +
  • SIGNATURE_FORMAT_SYMBOLIC
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_ALGORITHM_SPEC_UNSPECIFIED
    • + +
  • SIGNING_ALGORITHM_SPEC_ED25519
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_256
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_384
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ session_key + bytes + +
+ +
ASN.1 + DER-encoding of X.509 SubjectPublicKeyInfo structure of the session public key: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1. This key was used to produce the actual signature.
+ +
+ +
+
+ session_key_spec + SigningKeySpec + +
+ +
The signing key spec for the session key.
+ +
+ +
+
+ validity_period_from_inclusive + int64 + +
+ +
A timestamp in microseconds of UTC time since Unix epoch that indicates when the session key is considered valid.
+ +
+ +
+
+ validity_period_duration_seconds + uint32 + +
+ +
Duration in seconds indicating how long the session key remains valid. The validity period starts from `validity_period_from_inclusive` above.
+ +
+ +
+
+ format + SignatureFormat + +
+ +
The format of the signature
+ +
+ +
+
+ signature + bytes + +
+ +
The signature of the combined hash of the session key fingerprint, validity period, and synchronizer id, by the long-term key. This signature authorizes the session key to act on behalf of the long-term key.
+ +
+ +
+
+ signing_algorithm_spec + SigningAlgorithmSpec + +
+ +
The signing algorithm specification used to produce this signature
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ transaction_hashes + repeated bytes + +
+ +
List of topology transaction hashes. Required
+ +
+ +
+
+ signatures + repeated Signature + +
+ +
Signatures on the combined hash computed over the transaction_hashes MUST contain at least one
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/createtemporarytopologystore.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/createtemporarytopologystore.mdx new file mode 100644 index 0000000..f23d5b7 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/createtemporarytopologystore.mdx @@ -0,0 +1,359 @@ +--- +title: "CreateTemporaryTopologyStore" +--- + +
+ + + + +
+ +

com.digitalasset.canton.topology.admin.v30

+ + +

CreateTemporaryTopologyStore

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.topology.admin.v30.TopologyManagerWriteService/CreateTemporaryTopologyStore + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerWriteService/CreateTemporaryTopologyStore <<'EOF' +{ + "name": "string", + "protocolVersion": 0 +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "storeId": { + "name": "string" + } +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
TopologyManagerWriteService
+
+ +
+
RPC
+
CreateTemporaryTopologyStore
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

CreateTemporaryTopologyStoreRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.CreateTemporaryTopologyStoreRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ name + string + +
+ +
* The name of the topology store
+ +
+ +
+
+ protocol_version + uint32 + +
+ +
* The protocol version that should be used by the store
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

CreateTemporaryTopologyStoreResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.CreateTemporaryTopologyStoreResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ store_id + Temporary + +
+ +
* The identifier of the topology store that should be used as a store filter string
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ name + string + +
+ +
* The name of the topology store
+ +
+ +
+
+ protocol_version + uint32 + +
+ +
* The protocol version that should be used by the store
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ store_id + Temporary + +
+ +
* The identifier of the topology store that should be used as a store filter string
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ name + string + +
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/droptemporarytopologystore.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/droptemporarytopologystore.mdx new file mode 100644 index 0000000..4d93527 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/droptemporarytopologystore.mdx @@ -0,0 +1,304 @@ +--- +title: "DropTemporaryTopologyStore" +--- + +
+ + + + +
+ +

com.digitalasset.canton.topology.admin.v30

+ + +

DropTemporaryTopologyStore

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.topology.admin.v30.TopologyManagerWriteService/DropTemporaryTopologyStore + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerWriteService/DropTemporaryTopologyStore <<'EOF' +{ + "storeId": { + "name": "string" + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
TopologyManagerWriteService
+
+ +
+
RPC
+
DropTemporaryTopologyStore
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

DropTemporaryTopologyStoreRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.DropTemporaryTopologyStoreRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ store_id + Temporary + +
+ +
* The identifier of the topology store that should be dropped
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

DropTemporaryTopologyStoreResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.DropTemporaryTopologyStoreResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ store_id + Temporary + +
+ +
* The identifier of the topology store that should be dropped
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ name + string + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/generatetransactions.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/generatetransactions.mdx new file mode 100644 index 0000000..9b090ef --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/generatetransactions.mdx @@ -0,0 +1,2332 @@ +--- +title: "GenerateTransactions" +--- + +
+ + + + +
+ +

com.digitalasset.canton.topology.admin.v30

+ + +

GenerateTransactions

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.topology.admin.v30.TopologyManagerWriteService/GenerateTransactions + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerWriteService/GenerateTransactions <<'EOF' +{ + "proposals": [ + { + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "serial": 0, + "mapping": { + "namespaceDelegation": { + "namespace": "string", + "targetKey": {}, + "isRootDelegation": true, + "canSignAllMappings": {} + } + }, + "store": { + "authorized": {} + } + } + ] +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "generatedTransactions": [ + { + "serializedTransaction": "BASE64_ENCODED_BYTES", + "transactionHash": "BASE64_ENCODED_BYTES" + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
TopologyManagerWriteService
+
+ +
+
RPC
+
GenerateTransactions
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

GenerateTransactionsRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.GenerateTransactionsRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ proposals + repeated Proposal + +
+ +
transaction proposals for which to generate topology transactions
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

GenerateTransactionsResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.GenerateTransactionsResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ generated_transactions + repeated GeneratedTransaction + +
+ +
Generated transactions, in the same order as the mappings provided in the request
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ proposals + repeated Proposal + +
+ +
transaction proposals for which to generate topology transactions
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ operation + TopologyChangeOp + +
+ +
* Replace / Remove
+ +
+ +
+
+ serial + uint32 + +
+ +
* Optionally, the serial number of this request (auto-determined if omitted) NOTE: omitting the serial MAY end up overwriting previous mappings processed concurrently. To avoid such cases, First read the state using the TopologyManagerReadService and update the mappings accordingly, incrementing the serial by one and setting it here explicitly.
+ +
+ +
+
+ mapping + TopologyMapping + +
+ +
* The mapping to be authorized
+ +
+ +
+
+ store + StoreId + +
+ +
Target store
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • TOPOLOGY_CHANGE_OP_UNSPECIFIED
    • + +
  • TOPOLOGY_CHANGE_OP_ADD_REPLACE
    • + +
  • TOPOLOGY_CHANGE_OP_REMOVE
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ namespace_delegation + NamespaceDelegation + +
+ +
+ +
+
+ decentralized_namespace_definition + DecentralizedNamespaceDefinition + +
+ +
+ +
+
+ owner_to_key_mapping + OwnerToKeyMapping + +
+ +
+ +
+
+ synchronizer_trust_certificate + SynchronizerTrustCertificate + +
+ +
+ +
+
+ participant_permission + ParticipantSynchronizerPermission + +
+ +
+ +
+
+ party_hosting_limits + PartyHostingLimits + +
+ +
+ +
+
+ vetted_packages + VettedPackages + +
+ +
+ +
+
+ party_to_participant + PartyToParticipant + +
+ +
+ +
+
+ synchronizer_parameters_state + SynchronizerParametersState + +
+ +
+ +
+
+ mediator_synchronizer_state + MediatorSynchronizerState + +
+ +
+ +
+
+ sequencer_synchronizer_state + SequencerSynchronizerState + +
+ +
+ +
+
+ sequencing_dynamic_parameters_state + DynamicSequencingParametersState + +
+ +
+ +
+
+ party_to_key_mapping + PartyToKeyMapping + +
+ +
+ +
+
+ synchronizer_upgrade_announcement + SynchronizerUpgradeAnnouncement + +
+ +
+ +
+
+ sequencer_connection_successor + SequencerConnectionSuccessor + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ namespace + string + +
+ +
fingerprint of the root key defining the namespace
+ +
+ +
+
+ target_key + SigningPublicKey + +
+ +
target key of getting full rights on the namespace (if target == namespace, it's a root CA)
+ +
+ +
+
+ is_root_delegation + bool + +
+ +
flag indicating whether the given delegation is a root delegation or not a root delegation is also allowed to issue other NamespaceDelegations.
+ +
+ +
+
+ can_sign_all_mappings + CanSignAllMappings + +
+ +
+ +
+
+ can_sign_all_but_namespace_delegations + CanSignAllButNamespaceDelegations + +
+ +
+ +
+
+ can_sign_specific_mapings + CanSignSpecificMappings + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ mappings + repeated TopologyMappingCode + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • TOPOLOGY_MAPPING_CODE_UNSPECIFIED
    • + +
  • TOPOLOGY_MAPPING_CODE_NAMESPACE_DELEGATION
    • + +
  • TOPOLOGY_MAPPING_CODE_DECENTRALIZED_NAMESPACE_DEFINITION
    • + +
  • TOPOLOGY_MAPPING_CODE_OWNER_TO_KEY_MAPPING
    • + +
  • TOPOLOGY_MAPPING_CODE_SYNCHRONIZER_TRUST_CERTIFICATE
    • + +
  • TOPOLOGY_MAPPING_CODE_PARTICIPANT_PERMISSION
    • + +
  • TOPOLOGY_MAPPING_CODE_PARTY_HOSTING_LIMITS
    • + +
  • TOPOLOGY_MAPPING_CODE_VETTED_PACKAGES
    • + +
  • TOPOLOGY_MAPPING_CODE_PARTY_TO_PARTICIPANT
    • + +
  • TOPOLOGY_MAPPING_CODE_SYNCHRONIZER_PARAMETERS_STATE
    • + +
  • TOPOLOGY_MAPPING_CODE_MEDIATOR_SYNCHRONIZER_STATE
    • + +
  • TOPOLOGY_MAPPING_CODE_SEQUENCER_SYNCHRONIZER_STATE
    • + +
  • TOPOLOGY_MAPPING_CODE_SEQUENCING_DYNAMIC_PARAMETERS_STATE
    • + +
  • TOPOLOGY_MAPPING_CODE_PARTY_TO_KEY_MAPPING
    • + +
  • TOPOLOGY_MAPPING_CODE_SYNCHRONIZER_MIGRATION_ANNOUNCEMENT
    • + +
  • TOPOLOGY_MAPPING_CODE_SEQUENCER_CONNECTION_SUCCESSOR
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ format + CryptoKeyFormat + +
+ +
+ +
+
+ public_key + bytes + +
+ +
Serialized public key in the format specified above
+ +
+ +
+
+ scheme + SigningKeyScheme + +
+ +
No longer used (only kept for backwards compatibility) stores both the crypto key scheme and algorithm.
+ +
+ +
+
+ usage + repeated SigningKeyUsage + +
+ +
Explicitly state the key's intended use
+ +
+ +
+
+ key_spec + SigningKeySpec + +
+ +
The key specification that was used to generate the key pair
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • CRYPTO_KEY_FORMAT_UNSPECIFIED
    • + +
  • CRYPTO_KEY_FORMAT_DER
    • + +
  • CRYPTO_KEY_FORMAT_RAW
    • + +
  • CRYPTO_KEY_FORMAT_DER_X509_SUBJECT_PUBLIC_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_DER_PKCS8_PRIVATE_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_SYMBOLIC
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_SCHEME_UNSPECIFIED
    • + +
  • SIGNING_KEY_SCHEME_ED25519
    • + +
  • SIGNING_KEY_SCHEME_EC_DSA_P256
    • + +
  • SIGNING_KEY_SCHEME_EC_DSA_P384
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_USAGE_UNSPECIFIED
    • + +
  • SIGNING_KEY_USAGE_NAMESPACE
    • + +
  • SIGNING_KEY_USAGE_IDENTITY_DELEGATION
    • + +
  • SIGNING_KEY_USAGE_SEQUENCER_AUTHENTICATION
    • + +
  • SIGNING_KEY_USAGE_PROTOCOL
    • + +
  • SIGNING_KEY_USAGE_PROOF_OF_OWNERSHIP
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_SPEC_UNSPECIFIED
    • + +
  • SIGNING_KEY_SPEC_EC_CURVE25519
    • + +
  • SIGNING_KEY_SPEC_EC_P256
    • + +
  • SIGNING_KEY_SPEC_EC_P384
    • + +
  • SIGNING_KEY_SPEC_EC_SECP256K1
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ decentralized_namespace + string + +
+ +
name of the decentralized namespace, computed from the hash of its initial owners
+ +
+ +
+
+ threshold + int32 + +
+ +
the threshold required for any subsequent update signing
+ +
+ +
+
+ owners + repeated string + +
+ +
the namespaces of the owners
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ member + string + +
+ +
the sequencing process member
+ +
+ +
+
+ public_keys + repeated PublicKey + +
+ +
the designated keys
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ signing_public_key + SigningPublicKey + +
+ +
+ +
+
+ encryption_public_key + EncryptionPublicKey + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ format + CryptoKeyFormat + +
+ +
+ +
+
+ public_key + bytes + +
+ +
Serialized public key in the format specified above
+ +
+ +
+
+ scheme + EncryptionKeyScheme + +
+ +
No longer used (only kept for backwards compatibility) stores both the crypto key scheme and algorithm.
+ +
+ +
+
+ key_spec + EncryptionKeySpec + +
+ +
The key specification that was used to generate the key pair
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • ENCRYPTION_KEY_SCHEME_UNSPECIFIED
    • + +
  • ENCRYPTION_KEY_SCHEME_ECIES_P256_HKDF_HMAC_SHA256_AES128GCM
    • + +
  • ENCRYPTION_KEY_SCHEME_ECIES_P256_HMAC_SHA256A_ES128CBC
    • + +
  • ENCRYPTION_KEY_SCHEME_RSA2048_OAEP_SHA256
    • + +
+ + +
+ + + +
+ + + +
    + +
  • ENCRYPTION_KEY_SPEC_UNSPECIFIED
    • + +
  • ENCRYPTION_KEY_SPEC_EC_P256
    • + +
  • ENCRYPTION_KEY_SPEC_RSA_2048
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ participant_uid + string + +
+ +
the uid of the participant
+ +
+ +
+
+ synchronizer_id + string + +
+ +
the uid of the synchronizer that the participant trusts
+ +
+ +
+
+ feature_flags + repeated ParticipantFeatureFlag + +
+ +
Feature flags that this node declares to support on this synchronizer
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • PARTICIPANT_FEATURE_FLAG_UNSPECIFIED
    • + +
  • PARTICIPANT_FEATURE_FLAG_PV33_EXTERNAL_SIGNING_LOCAL_CONTRACT_IN_SUBVIEW
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ synchronizer_id + string + +
+ +
+ +
+
+ participant_uid + string + +
+ +
+ +
+
+ permission + ParticipantPermission + +
+ +
the permission level of the participant on this synchronizer (usually submission)
+ +
+ +
+
+ limits + ParticipantSynchronizerLimits + +
+ +
optional individual limits for this participant
+ +
+ +
+
+ login_after + int64 + +
+ +
optional earliest time when participant can log in (again) used to temporarily disable participants In microseconds of UTC time since Unix epoch
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • PARTICIPANT_PERMISSION_UNSPECIFIED
    • + +
  • PARTICIPANT_PERMISSION_SUBMISSION
    • + +
  • PARTICIPANT_PERMISSION_CONFIRMATION
    • + +
  • PARTICIPANT_PERMISSION_OBSERVATION
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ confirmation_requests_max_rate + uint32 + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ synchronizer_id + string + +
+ +
+ +
+
+ party + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ participant_uid + string + +
+ +
the participant vetting the packages
+ +
+ +
+
+ package_ids + repeated string + +
+ +
DEPRECATED: no longer used, but kept for backwards compatibility. the hashes of the vetted packages. package hashes may only be listed in one of the two fields: package_ids or packages. a package listed in package_ids is equivalent to a package listed in packages with unbounded validity.
+ +
+ +
+
+ packages + repeated VettedPackage + +
+ +
the hashes of vetted packages with a validity period. only one entry per package_id is permitted.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ package_id + string + +
+ +
the hash of the vetted package
+ +
+ +
+
+ valid_from_inclusive + Timestamp + +
+ +
optional earliest ledger effective time (inclusive) as of which the package is considered valid. must be less than or equal to valid_until if both are present.
+ +
+ +
+
+ valid_until_exclusive + Timestamp + +
+ +
optional latest ledger effective time (exclusive) until which the package is considered valid. must be greater than or equal to valid_from if both are present.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ party + string + +
+ +
the party that is to be represented by the participants
+ +
+ +
+
+ threshold + uint32 + +
+ +
the signatory threshold required by the participants to be able to act on behalf of the party. a mapping with threshold > 1 is considered a definition of a consortium party
+ +
+ +
+
+ participants + repeated HostingParticipant + +
+ +
which participants will host the party. if threshold > 1, must be Confirmation or Observation. if all participants have Observation permission, the confirmation treshold is ignored, making the party a purely observing party.
+ +
+ +
+
+ party_signing_keys + SigningKeysWithThreshold + +
+ +
Contains protocol signing keys for the party used to authorize externally signed Daml transactions, along with a signing threshold. The max number of keys is 20
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ participant_uid + string + +
+ +
the target participant that the party should be mapped to
+ +
+ +
+
+ permission + ParticipantPermission + +
+ +
permission of the participant for this particular party (the actual will be min of ParticipantSynchronizerPermission.ParticipantPermission and this setting)
+ +
+ +
+
+ onboarding + Onboarding + +
+ +
optional, present iff the party is being onboarded to the participant
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ keys + repeated SigningPublicKey + +
+ +
the designated signing keys
+ +
+ +
+
+ threshold + uint32 + +
+ +
the authorization threshold
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ synchronizer_id + string + +
+ +
synchronizer affected by the new synchronizer parameters
+ +
+ +
+
+ synchronizer_parameters + DynamicSynchronizerParameters + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ confirmation_response_timeout + Duration + +
+ +
+ +
+
+ mediator_reaction_timeout + Duration + +
+ +
+ +
+
+ assignment_exclusivity_timeout + Duration + +
+ +
+ +
+
+ ledger_time_record_time_tolerance + Duration + +
+ +
+ +
+
+ reconciliation_interval + Duration + +
+ +
+ +
+
+ mediator_deduplication_timeout + Duration + +
+ +
+ +
+
+ max_request_size + uint32 + +
+ +
+ +
+
+ onboarding_restriction + OnboardingRestriction + +
+ +
topology related validation parameters permissioned synchronizer: if true, only participants which have been explicitly put on the allow list can onboard to the synchronizer
+ +
+ +
+
+ participant_synchronizer_limits + ParticipantSynchronizerLimits + +
+ +
+ +
+
+ sequencer_aggregate_submission_timeout + Duration + +
+ +
+ +
+
+ traffic_control + TrafficControlParameters + +
+ +
+ +
+
+ acs_commitments_catchup + AcsCommitmentsCatchUpConfig + +
+ +
+ +
+
+ preparation_time_record_time_tolerance + Duration + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • ONBOARDING_RESTRICTION_UNSPECIFIED
    • + +
  • ONBOARDING_RESTRICTION_UNRESTRICTED_OPEN
    • + +
  • ONBOARDING_RESTRICTION_UNRESTRICTED_LOCKED
    • + +
  • ONBOARDING_RESTRICTION_RESTRICTED_OPEN
    • + +
  • ONBOARDING_RESTRICTION_RESTRICTED_LOCKED
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ max_base_traffic_amount + uint64 + +
+ +
[doc-entry-start: TrafficControlParameters] In bytes, the maximum amount of base traffic that can be accumulated
+ +
+ +
+
+ max_base_traffic_accumulation_duration + Duration + +
+ +
Maximum duration over which the base rate can be accumulated Consequently, base_traffic_rate = max_base_traffic_amount / max_base_traffic_accumulation_duration
+ +
+ +
+
+ read_vs_write_scaling_factor + uint32 + +
+ +
Read scaling factor to compute the event cost. In parts per 10 000.
+ +
+ +
+
+ set_balance_request_submission_window_size + Duration + +
+ +
Window size used to compute the max sequencing time of a submission request This impacts how quickly a submission is expected to be accepted before a retry should be attempted by the caller Default is 5 minutes
+ +
+ +
+
+ enforce_rate_limiting + bool + +
+ +
If true, submission requests without enough traffic credit will not be delivered
+ +
+ +
+
+ base_event_cost + uint64 + +
+ +
In bytes, base event cost added to all sequenced events. Optional
+ +
+ +
+
+ free_confirmation_responses + bool + +
+ +
Whether to charge for confirmation responses Default: false
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ catchup_interval_skip + uint32 + +
+ +
+ +
+
+ nr_intervals_to_trigger_catchup + uint32 + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ synchronizer_id + string + +
+ +
the synchronizer id of the mediator group
+ +
+ +
+
+ group + uint32 + +
+ +
the group-id used for sharding multiple mediator groups
+ +
+ +
+
+ threshold + uint32 + +
+ +
the signature threshold required to reach consensus among the mediators
+ +
+ +
+
+ active + repeated string + +
+ +
the list of active mediators (uid) within the group
+ +
+ +
+
+ observers + repeated string + +
+ +
the list of observing mediators (uid) within the group (read messages but don't respond)
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ synchronizer_id + string + +
+ +
the synchronizer id of the sequencer group
+ +
+ +
+
+ threshold + uint32 + +
+ +
The system can tolerate up to min(threshold - 1, (activeWithSigningKey.size - 1)/3) malicious active sequencers, where activeWithSigningKey is the set of sequencers from active that have an active OwnerToKeyMapping with a signing key. In order to make the system resilient against f malicious active sequencers, you need to: (1) configure threshold := f + 1, (2) possibly add active sequencers such that f <= (activeWithSigningKey.size - 1)/3. (3) possibly register signing keys for active sequencers,
+ +
+ +
+
+ active + repeated string + +
+ +
the list of active sequencers If a sequencer without an active signing key is added to this set, it has no effect on the topology state.
+ +
+ +
+
+ observers + repeated string + +
+ +
the list of observing sequencers (uid) within the group (read messages but don't respond)
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ synchronizer_id + string + +
+ +
synchronizer affected by the new synchronizer parameters
+ +
+ +
+
+ sequencing_parameters + DynamicSequencingParameters + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ payload + bytes + +
+ +
Sequencing dynamic synchronizer parameters can only be interpreted by a sequencer implementation and are opaque to the rest of the synchronizer.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ party + string + +
+ +
the party
+ +
+ +
+
+ threshold + uint32 + +
+ +
the authorization threshold
+ +
+ +
+
+ signing_keys + repeated SigningPublicKey + +
+ +
the designated signing keys
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ successor_physical_synchronizer_id + string + +
+ +
the physical synchronizer id of the successor synchronizer
+ +
+ +
+
+ upgrade_time + Timestamp + +
+ +
when the upgrade happens
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ sequencer_id + string + +
+ +
the sequencer id
+ +
+ +
+
+ synchronizer_id + string + +
+ +
to synchronizer id
+ +
+ +
+
+ connection + SequencerConnection + +
+ +
the connection details with which members can connect to the sequencer on the successor synchronizer
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ grpc + Grpc + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ endpoints + repeated string + +
+ +
connection information to sequencer (http[s]://<host>:<port>") all endpoints must agree on using HTTPS or HTTP
+ +
+ +
+
+ custom_trust_certificates + bytes + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ authorized + Authorized + +
+ +
+ +
+
+ synchronizer + Synchronizer + +
+ +
+ +
+
+ temporary + Temporary + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ name + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ id + string + +
+ +
+ +
+
+ physical_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ generated_transactions + repeated GeneratedTransaction + +
+ +
Generated transactions, in the same order as the mappings provided in the request
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ serialized_transaction + bytes + +
+ +
Serialized com.digitalasset.canton.protocol.v30.TopologyTransaction
+ +
+ +
+
+ transaction_hash + bytes + +
+ +
Hash of the transaction - this should be signed by the submitter to authorize the transaction
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/importtopologysnapshot.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/importtopologysnapshot.mdx new file mode 100644 index 0000000..ae19e4b --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/importtopologysnapshot.mdx @@ -0,0 +1,423 @@ +--- +title: "ImportTopologySnapshot" +--- + +
+ + + + +
+ +

com.digitalasset.canton.topology.admin.v30

+ + +

ImportTopologySnapshot

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.topology.admin.v30.TopologyManagerWriteService/ImportTopologySnapshot + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerWriteService/ImportTopologySnapshot <<'EOF' +{ + "topologySnapshot": "BASE64_ENCODED_BYTES", + "store": { + "authorized": {} + }, + "waitToBecomeEffective": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
TopologyManagerWriteService
+
+ +
+
RPC
+
ImportTopologySnapshot
+
+ +
+
Client stream
+
Yes
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ImportTopologySnapshotRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ImportTopologySnapshotRequest
+
+ +
+
Client stream
+
Yes
+
+ +
+ + + + +
+ +
+
+ topology_snapshot + bytes + +
+ +
+ +
+
+ store + StoreId + +
+ +
+ +
+
+ wait_to_become_effective + Duration + +
+ +
* Optional timeout to wait for the transaction to become effective in the store.
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ImportTopologySnapshotResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ImportTopologySnapshotResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ topology_snapshot + bytes + +
+ +
+ +
+
+ store + StoreId + +
+ +
+ +
+
+ wait_to_become_effective + Duration + +
+ +
* Optional timeout to wait for the transaction to become effective in the store.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ authorized + Authorized + +
+ +
+ +
+
+ synchronizer + Synchronizer + +
+ +
+ +
+
+ temporary + Temporary + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ name + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ id + string + +
+ +
+ +
+
+ physical_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/importtopologysnapshotv2.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/importtopologysnapshotv2.mdx new file mode 100644 index 0000000..f0048c0 --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/importtopologysnapshotv2.mdx @@ -0,0 +1,423 @@ +--- +title: "ImportTopologySnapshotV2" +--- + +
+ + + + +
+ +

com.digitalasset.canton.topology.admin.v30

+ + +

ImportTopologySnapshotV2

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.topology.admin.v30.TopologyManagerWriteService/ImportTopologySnapshotV2 + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerWriteService/ImportTopologySnapshotV2 <<'EOF' +{ + "topologySnapshot": "BASE64_ENCODED_BYTES", + "store": { + "authorized": {} + }, + "waitToBecomeEffective": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
TopologyManagerWriteService
+
+ +
+
RPC
+
ImportTopologySnapshotV2
+
+ +
+
Client stream
+
Yes
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

ImportTopologySnapshotV2Request

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ImportTopologySnapshotV2Request
+
+ +
+
Client stream
+
Yes
+
+ +
+ + + + +
+ +
+
+ topology_snapshot + bytes + +
+ +
+ +
+
+ store + StoreId + +
+ +
+ +
+
+ wait_to_become_effective + Duration + +
+ +
* Optional timeout to wait for the transaction to become effective in the store.
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

ImportTopologySnapshotV2Response

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.ImportTopologySnapshotV2Response
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ topology_snapshot + bytes + +
+ +
+ +
+
+ store + StoreId + +
+ +
+ +
+
+ wait_to_become_effective + Duration + +
+ +
* Optional timeout to wait for the transaction to become effective in the store.
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ authorized + Authorized + +
+ +
+ +
+
+ synchronizer + Synchronizer + +
+ +
+ +
+
+ temporary + Temporary + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ name + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ id + string + +
+ +
+ +
+
+ physical_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/signtransactions.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/signtransactions.mdx new file mode 100644 index 0000000..84d193c --- /dev/null +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/signtransactions.mdx @@ -0,0 +1,917 @@ +--- +title: "SignTransactions" +--- + +
+ + + + +
+ +

com.digitalasset.canton.topology.admin.v30

+ + +

SignTransactions

+ + + +
+ + gRPC + + Since 3.4.0 + +
+ + +
+ +
+ + RPC + + /com.digitalasset.canton.topology.admin.v30.TopologyManagerWriteService/SignTransactions + Try it +
+ + +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerWriteService/SignTransactions <<'EOF' +{ + "transactions": [ + { + "transaction": "BASE64_ENCODED_BYTES", + "signatures": [ + { + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signedBy": "string", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", + "signatureDelegation": { + "sessionKey": "BASE64_ENCODED_BYTES", + "sessionKeySpec": "SIGNING_KEY_SPEC_UNSPECIFIED", + "validityPeriodFromInclusive": "0", + "validityPeriodDurationSeconds": 0, + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" + } + } + ], + "proposal": true, + "multiTransactionSignatures": [ + { + "transactionHashes": [ + "BASE64_ENCODED_BYTES" + ], + "signatures": [ + { + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signedBy": "string", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", + "signatureDelegation": {} + } + ] + } + ] + } + ], + "signedBy": [ + "string" + ], + "store": { + "authorized": {} + }, + "forceFlags": [ + "FORCE_FLAG_UNSPECIFIED" + ] +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "transactions": [ + { + "transaction": "BASE64_ENCODED_BYTES", + "signatures": [ + { + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signedBy": "string", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", + "signatureDelegation": { + "sessionKey": "BASE64_ENCODED_BYTES", + "sessionKeySpec": "SIGNING_KEY_SPEC_UNSPECIFIED", + "validityPeriodFromInclusive": "0", + "validityPeriodDurationSeconds": 0, + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" + } + } + ], + "proposal": true, + "multiTransactionSignatures": [ + { + "transactionHashes": [ + "BASE64_ENCODED_BYTES" + ], + "signatures": [ + { + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signedBy": "string", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", + "signatureDelegation": {} + } + ] + } + ] + } + ] +} +``` + +
+
+ +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
TopologyManagerWriteService
+
+ +
+
RPC
+
SignTransactions
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + +## Inputs + + +
+
+

SignTransactionsRequest

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.SignTransactionsRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ transactions + repeated SignedTopologyTransaction + +
+ +
* The transactions to be signed, but will not be stored in the authorized store
+ +
+ +
+
+ signed_by + repeated string + +
+ +
* Fingerprint of the keys signing the authorization The signing key is used to identify a particular `NamespaceDelegation` certificate, which is used to justify the given authorization. Optional, if empty, suitable signing keys available known to the node are automatically selected.
+ +
+ +
+
+ store + StoreId + +
+ +
Target store
+ +
+ +
+
+ force_flags + repeated ForceFlag + +
+ +
* Force specific changes even if dangerous
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

SignTransactionsResponse

+ +
+ + + +
+ +
+
Message
+
com.digitalasset.canton.topology.admin.v30.SignTransactionsResponse
+
+ +
+
Server stream
+
No
+
+ +
+ + + + +
+ +
+
+ transactions + repeated SignedTopologyTransaction + +
+ +
* The transactions with the additional signatures from this node.
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.4.0 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ transactions + repeated SignedTopologyTransaction + +
+ +
* The transactions to be signed, but will not be stored in the authorized store
+ +
+ +
+
+ signed_by + repeated string + +
+ +
* Fingerprint of the keys signing the authorization The signing key is used to identify a particular `NamespaceDelegation` certificate, which is used to justify the given authorization. Optional, if empty, suitable signing keys available known to the node are automatically selected.
+ +
+ +
+
+ store + StoreId + +
+ +
Target store
+ +
+ +
+
+ force_flags + repeated ForceFlag + +
+ +
* Force specific changes even if dangerous
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ transaction + bytes + +
+ +
serialized topology transaction (protobuf bytestring)
+ +
+ +
+
+ signatures + repeated Signature + +
+ +
multiple signatures Either this field OR the multi_transaction_signatures field MUST contain at least one signature
+ +
+ +
+
+ proposal + bool + +
+ +
if true, this transaction is just a proposal. this means that every signature is valid, but the signatures are insufficient to properly authorize the transaction. proposals are distributed via the topology channel too. proposals will be pruned automatically when the nodes are pruned TODO(#14045) implement pruning
+ +
+ +
+
+ multi_transaction_signatures + repeated MultiTransactionSignatures + +
+ +
If set, the transaction may be authorized by signing a hash computed from multiple transaction hashes This allows to effectively authorize multiple transactions with a single signature. Each item MUST contain the hash of this transaction Optional
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ format + SignatureFormat + +
+ +
+ +
+
+ signature + bytes + +
+ +
+ +
+
+ signed_by + string + +
+ +
The fingerprint/id of the keypair used to create this signature and needed to verify. If a signature delegation is defined, this fingerprint/id is not used to produce the signature, and, instead is used to sign the delegation.
+ +
+ +
+
+ signing_algorithm_spec + SigningAlgorithmSpec + +
+ +
The signing algorithm specification used to produce this signature
+ +
+ +
+
+ signature_delegation + SignatureDelegation + +
+ +
An optional signature delegation where a long-term signing key authorizes a session signing key to sign on its behalf.
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • SIGNATURE_FORMAT_UNSPECIFIED
    • + +
  • SIGNATURE_FORMAT_RAW
    • + +
  • SIGNATURE_FORMAT_DER
    • + +
  • SIGNATURE_FORMAT_CONCAT
    • + +
  • SIGNATURE_FORMAT_SYMBOLIC
    • + +
+ + +
+ + + +
+ + + +
    + +
  • SIGNING_ALGORITHM_SPEC_UNSPECIFIED
    • + +
  • SIGNING_ALGORITHM_SPEC_ED25519
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_256
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_384
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ session_key + bytes + +
+ +
ASN.1 + DER-encoding of X.509 SubjectPublicKeyInfo structure of the session public key: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1. This key was used to produce the actual signature.
+ +
+ +
+
+ session_key_spec + SigningKeySpec + +
+ +
The signing key spec for the session key.
+ +
+ +
+
+ validity_period_from_inclusive + int64 + +
+ +
A timestamp in microseconds of UTC time since Unix epoch that indicates when the session key is considered valid.
+ +
+ +
+
+ validity_period_duration_seconds + uint32 + +
+ +
Duration in seconds indicating how long the session key remains valid. The validity period starts from `validity_period_from_inclusive` above.
+ +
+ +
+
+ format + SignatureFormat + +
+ +
The format of the signature
+ +
+ +
+
+ signature + bytes + +
+ +
The signature of the combined hash of the session key fingerprint, validity period, and synchronizer id, by the long-term key. This signature authorizes the session key to act on behalf of the long-term key.
+ +
+ +
+
+ signing_algorithm_spec + SigningAlgorithmSpec + +
+ +
The signing algorithm specification used to produce this signature
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • SIGNING_KEY_SPEC_UNSPECIFIED
    • + +
  • SIGNING_KEY_SPEC_EC_CURVE25519
    • + +
  • SIGNING_KEY_SPEC_EC_P256
    • + +
  • SIGNING_KEY_SPEC_EC_P384
    • + +
  • SIGNING_KEY_SPEC_EC_SECP256K1
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ transaction_hashes + repeated bytes + +
+ +
List of topology transaction hashes. Required
+ +
+ +
+
+ signatures + repeated Signature + +
+ +
Signatures on the combined hash computed over the transaction_hashes MUST contain at least one
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ authorized + Authorized + +
+ +
+ +
+
+ synchronizer + Synchronizer + +
+ +
+ +
+
+ temporary + Temporary + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + +
+ + +
+ +
+
+ name + string + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ id + string + +
+ +
+ +
+
+ physical_id + string + +
+ +
+ +
+ + + +
+ + + +
+ + + +
    + +
  • FORCE_FLAG_UNSPECIFIED
    • + +
  • FORCE_FLAG_ALIEN_MEMBER
    • + +
  • FORCE_FLAG_LEDGER_TIME_RECORD_TIME_TOLERANCE_INCREASE
    • + +
  • FORCE_FLAG_ALLOW_UNKNOWN_PACKAGE
    • + +
  • FORCE_FLAG_ALLOW_UNVETTED_DEPENDENCIES
    • + +
  • FORCE_FLAG_DISABLE_PARTY_WITH_ACTIVE_CONTRACTS
    • + +
  • FORCE_FLAG_ALLOW_UNVALIDATED_SIGNING_KEYS
    • + +
  • FORCE_FLAG_PREPARATION_TIME_RECORD_TIME_TOLERANCE_INCREASE
    • + +
  • FORCE_FLAG_ALLOW_INSUFFICIENT_PARTICIPANT_PERMISSION_FOR_SIGNATORY_PARTY
    • + +
  • FORCE_FLAG_ALLOW_INSUFFICIENT_SIGNATORY_ASSIGNING_PARTICIPANTS_FOR_PARTY
    • + +
  • FORCE_FLAG_ALLOW_VET_INCOMPATIBLE_UPGRADES
    • + +
  • FORCE_FLAG_ALLOW_OUT_OF_BOUNDS_VALUE
    • + +
  • FORCE_FLAG_ALLOW_CONFIRMING_THRESHOLD_CANNOT_BE_MET
    • + +
+ + +
+ + + +
+ + +
+ +
+
+ transactions + repeated SignedTopologyTransaction + +
+ +
* The transactions with the additional signatures from this node.
+ +
+ +
+ + + +
+ + + diff --git a/tests/fixtures/characterization/protobuf/expected/packages/com-daml-ledger-api-v2-admin.mdx b/tests/fixtures/characterization/protobuf/expected/packages/com-daml-ledger-api-v2-admin.mdx index a906a03..b166599 100644 --- a/tests/fixtures/characterization/protobuf/expected/packages/com-daml-ledger-api-v2-admin.mdx +++ b/tests/fixtures/characterization/protobuf/expected/packages/com-daml-ledger-api-v2-admin.mdx @@ -1,49 +1,348 @@ --- title: "com.daml.ledger.api.v2.admin" -description: "Descriptor-backed protobuf API history for package com.daml.ledger.api.v2.admin." +description: "Package-level overview for com.daml.ledger.api.v2.admin." --- -# Package `com.daml.ledger.api.v2.admin` +

Back to overview

+ +
+ +

Protobuf Package

+ + +

com.daml.ledger.api.v2.admin

+ + +

6 services, 28 endpoints, 78 messages, 3 enums

+ + +
+ + gRPC + +
+ + +
+ +
+
Files
+
7
+
+ +
+
Services
+
6
+
+ +
+
Endpoints
+
28
+
+ +
+
Messages
+
78
+
+ +
+
Enums
+
3
+
+ +
+ +
-[Back to Canton Protobuf History](../index) -## Snapshot +## Source Files -- Current files: `7` -- Current services: `6` -- Current endpoints: `28` -- Current messages: `78` -- Current enums: `3` -- Lifecycle endpoints tracked: `28` -## Source Files -| File | Services | Messages | Enums | Source | -| --- | --- | --- | --- | --- | -| community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/command_inspection_service.proto | `1` | `6` | `1` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/command_inspection_service.proto#L4) | -| community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto | `1` | `11` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto#L4) | -| community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/object_meta.proto | `0` | `1` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/object_meta.proto#L4) | -| community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto | `1` | `11` | `1` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto#L4) | -| community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/participant_pruning_service.proto | `1` | `2` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/participant_pruning_service.proto#L4) | -| community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto | `1` | `17` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto#L4) | -| community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto | `1` | `20` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L4) | - -## Services - -| Service | Endpoints | Source | Description | -| --- | --- | --- | --- | -| [`CommandInspectionService`](#service-com-daml-ledger-api-v2-admin-commandinspectionservice) | `1` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/command_inspection_service.proto#L23) | Status: experimental interface, will change before it is deemed production ready The inspection service provides meth... | -| [`IdentityProviderConfigService`](#service-com-daml-ledger-api-v2-admin-identityproviderconfigservice) | `5` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto#L37) | Identity Provider Config Service makes it possible for participant node administrators to setup and manage additional... | -| [`PackageManagementService`](#service-com-daml-ledger-api-v2-admin-packagemanagementservice) | `4` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto#L21) | Status: experimental interface, will change before it is deemed production ready Query the Daml-LF packages supported... | -| [`ParticipantPruningService`](#service-com-daml-ledger-api-v2-admin-participantpruningservice) | `1` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/participant_pruning_service.proto#L23) | Status: experimental interface, will change before it is deemed production ready Prunes/truncates the "oldest" transa... | -| [`PartyManagementService`](#service-com-daml-ledger-api-v2-admin-partymanagementservice) | `8` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto#L37) | This service allows inspecting the party management state of the ledger known to the participant and managing the par... | -| [`UserManagementService`](#service-com-daml-ledger-api-v2-admin-usermanagementservice) | `9` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L43) | Service to manage users and their rights for interacting with the Ledger API served by a participant node. The author... | - - -### Service `CommandInspectionService` - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/command_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/command_inspection_service.proto#L23) -- Endpoints tracked: `1` + +
+ + +
+ +
+

community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/command_inspection_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
6
+
+ +
+
Enums
+
1
+
+ +
+
Source
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/command_inspection_service.proto
+
+ +
+ + +
+ + + +
+ +
+

community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
11
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto
+
+ +
+ + +
+ + + +
+ +
+

community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/object_meta.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
1
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/object_meta.proto
+
+ +
+ + +
+ + + +
+ +
+

community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
11
+
+ +
+
Enums
+
1
+
+ +
+
Source
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto
+
+ +
+ + +
+ + + +
+ +
+

community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/participant_pruning_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
2
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/participant_pruning_service.proto
+
+ +
+ + +
+ + + +
+ +
+

community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
17
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto
+
+ +
+ + +
+ + + +
+ +
+

community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
20
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto
+
+ +
+ + +
+ + +
+ + + + + +## CommandInspectionService + Status: experimental interface, will change before it is deemed production ready @@ -52,50 +351,79 @@ Status: experimental interface, will change before it is deemed production to look under the hood of a running system. In V2 Ledger API this service is not available. -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`GetCommandStatus`](#endpoint-com-daml-ledger-api-v2-admin-commandinspectionservice-getcommandstatus) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.admin.GetCommandStatusRequest`](#type-com-daml-ledger-api-v2-admin-getcommandstatusrequest) | [`com.daml.ledger.api.v2.admin.GetCommandStatusResponse`](#type-com-daml-ledger-api-v2-admin-getcommandstatusresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/command_inspection_service.proto#L29) | - - -**Endpoint `CommandInspectionService.GetCommandStatus`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/command_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/command_inspection_service.proto#L29) - -**Signature** - -```protobuf -rpc CommandInspectionService.GetCommandStatus(com.daml.ledger.api.v2.admin.GetCommandStatusRequest) returns (com.daml.ledger.api.v2.admin.GetCommandStatusResponse); -``` -Inquire about the status of a command. - This service is used for debugging only. The command status is only tracked in memory and is not persisted. - The service can be used to understand the failure status and the structure of a command. - Requires admin privileges - The service is alpha without backward compatibility guarantees. +
+ +
+
Source file
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/command_inspection_service.proto
+
+ +
+
Operations
+
1
+
+ +
+ + +
+ + + + +
+

CommandInspectionService.GetCommandStatus

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Inquire about the status of a command. This service is used for debugging only. The command status is only tracked in memory and is not persisted. The service can be used to und...

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.admin.GetCommandStatusRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.admin.GetCommandStatusResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## IdentityProviderConfigService -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.admin.GetCommandStatusRequest`](#type-com-daml-ledger-api-v2-admin-getcommandstatusrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.admin.GetCommandStatusResponse`](#type-com-daml-ledger-api-v2-admin-getcommandstatusresponse) - - -### Service `IdentityProviderConfigService` - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto#L37) -- Endpoints tracked: `5` Identity Provider Config Service makes it possible for participant node administrators to setup and manage additional identity providers at runtime. @@ -121,176 +449,267 @@ Identity Provider Config Service makes it possible for participant node administ In order to update the properties represented by the ``IdentityProviderConfig`` message use the ``UpdateIdentityProviderConfig`` RPC. The only fields that can be modified are those marked as ``Modifiable``. -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`CreateIdentityProviderConfig`](#endpoint-com-daml-ledger-api-v2-admin-identityproviderconfigservice-createidentityproviderconfig) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.admin.CreateIdentityProviderConfigRequest`](#type-com-daml-ledger-api-v2-admin-createidentityproviderconfigrequest) | [`com.daml.ledger.api.v2.admin.CreateIdentityProviderConfigResponse`](#type-com-daml-ledger-api-v2-admin-createidentityproviderconfigresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto#L40) | -| [`DeleteIdentityProviderConfig`](#endpoint-com-daml-ledger-api-v2-admin-identityproviderconfigservice-deleteidentityproviderconfig) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.admin.DeleteIdentityProviderConfigRequest`](#type-com-daml-ledger-api-v2-admin-deleteidentityproviderconfigrequest) | [`com.daml.ledger.api.v2.admin.DeleteIdentityProviderConfigResponse`](#type-com-daml-ledger-api-v2-admin-deleteidentityproviderconfigresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto#L53) | -| [`GetIdentityProviderConfig`](#endpoint-com-daml-ledger-api-v2-admin-identityproviderconfigservice-getidentityproviderconfig) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.admin.GetIdentityProviderConfigRequest`](#type-com-daml-ledger-api-v2-admin-getidentityproviderconfigrequest) | [`com.daml.ledger.api.v2.admin.GetIdentityProviderConfigResponse`](#type-com-daml-ledger-api-v2-admin-getidentityproviderconfigresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto#L43) | -| [`ListIdentityProviderConfigs`](#endpoint-com-daml-ledger-api-v2-admin-identityproviderconfigservice-listidentityproviderconfigs) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.admin.ListIdentityProviderConfigsRequest`](#type-com-daml-ledger-api-v2-admin-listidentityproviderconfigsrequest) | [`com.daml.ledger.api.v2.admin.ListIdentityProviderConfigsResponse`](#type-com-daml-ledger-api-v2-admin-listidentityproviderconfigsresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto#L50) | -| [`UpdateIdentityProviderConfig`](#endpoint-com-daml-ledger-api-v2-admin-identityproviderconfigservice-updateidentityproviderconfig) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.admin.UpdateIdentityProviderConfigRequest`](#type-com-daml-ledger-api-v2-admin-updateidentityproviderconfigrequest) | [`com.daml.ledger.api.v2.admin.UpdateIdentityProviderConfigResponse`](#type-com-daml-ledger-api-v2-admin-updateidentityproviderconfigresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto#L47) | - - -**Endpoint `IdentityProviderConfigService.CreateIdentityProviderConfig`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto#L40) - -**Signature** - -```protobuf -rpc IdentityProviderConfigService.CreateIdentityProviderConfig(com.daml.ledger.api.v2.admin.CreateIdentityProviderConfigRequest) returns (com.daml.ledger.api.v2.admin.CreateIdentityProviderConfigResponse); -``` - -Create a new identity provider configuration. - The request will fail if the maximum allowed number of separate configurations is reached. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.admin.CreateIdentityProviderConfigRequest`](#type-com-daml-ledger-api-v2-admin-createidentityproviderconfigrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.admin.CreateIdentityProviderConfigResponse`](#type-com-daml-ledger-api-v2-admin-createidentityproviderconfigresponse) - - -**Endpoint `IdentityProviderConfigService.DeleteIdentityProviderConfig`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto#L53) - -**Signature** - -```protobuf -rpc IdentityProviderConfigService.DeleteIdentityProviderConfig(com.daml.ledger.api.v2.admin.DeleteIdentityProviderConfigRequest) returns (com.daml.ledger.api.v2.admin.DeleteIdentityProviderConfigResponse); -``` - -Delete an existing identity provider configuration. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.admin.DeleteIdentityProviderConfigRequest`](#type-com-daml-ledger-api-v2-admin-deleteidentityproviderconfigrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.admin.DeleteIdentityProviderConfigResponse`](#type-com-daml-ledger-api-v2-admin-deleteidentityproviderconfigresponse) - - -**Endpoint `IdentityProviderConfigService.GetIdentityProviderConfig`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto#L43) - -**Signature** - -```protobuf -rpc IdentityProviderConfigService.GetIdentityProviderConfig(com.daml.ledger.api.v2.admin.GetIdentityProviderConfigRequest) returns (com.daml.ledger.api.v2.admin.GetIdentityProviderConfigResponse); -``` - -Get the identity provider configuration data by id. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.admin.GetIdentityProviderConfigRequest`](#type-com-daml-ledger-api-v2-admin-getidentityproviderconfigrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.admin.GetIdentityProviderConfigResponse`](#type-com-daml-ledger-api-v2-admin-getidentityproviderconfigresponse) - - -**Endpoint `IdentityProviderConfigService.ListIdentityProviderConfigs`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto#L50) - -**Signature** - -```protobuf -rpc IdentityProviderConfigService.ListIdentityProviderConfigs(com.daml.ledger.api.v2.admin.ListIdentityProviderConfigsRequest) returns (com.daml.ledger.api.v2.admin.ListIdentityProviderConfigsResponse); -``` - -List all existing identity provider configurations. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.admin.ListIdentityProviderConfigsRequest`](#type-com-daml-ledger-api-v2-admin-listidentityproviderconfigsrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.admin.ListIdentityProviderConfigsResponse`](#type-com-daml-ledger-api-v2-admin-listidentityproviderconfigsresponse) - - -**Endpoint `IdentityProviderConfigService.UpdateIdentityProviderConfig`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto#L47) - -**Signature** - -```protobuf -rpc IdentityProviderConfigService.UpdateIdentityProviderConfig(com.daml.ledger.api.v2.admin.UpdateIdentityProviderConfigRequest) returns (com.daml.ledger.api.v2.admin.UpdateIdentityProviderConfigResponse); -``` - -Update selected modifiable attribute of an identity provider config resource described - by the ``IdentityProviderConfig`` message. -**History** +
+ +
+
Source file
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto
+
+ +
+
Operations
+
5
+
+ +
+ + +
+ + + + +
+

IdentityProviderConfigService.CreateIdentityProviderConfig

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Create a new identity provider configuration. The request will fail if the maximum allowed number of separate configurations is reached.

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.admin.CreateIdentityProviderConfigRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.admin.CreateIdentityProviderConfigResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

IdentityProviderConfigService.DeleteIdentityProviderConfig

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Delete an existing identity provider configuration.

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.admin.DeleteIdentityProviderConfigRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.admin.DeleteIdentityProviderConfigResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

IdentityProviderConfigService.GetIdentityProviderConfig

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Get the identity provider configuration data by id.

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.admin.GetIdentityProviderConfigRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.admin.GetIdentityProviderConfigResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

IdentityProviderConfigService.ListIdentityProviderConfigs

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

List all existing identity provider configurations.

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.admin.ListIdentityProviderConfigsRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.admin.ListIdentityProviderConfigsResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

IdentityProviderConfigService.UpdateIdentityProviderConfig

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Update selected modifiable attribute of an identity provider config resource described by the ``IdentityProviderConfig`` message.

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.admin.UpdateIdentityProviderConfigRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.admin.UpdateIdentityProviderConfigResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## PackageManagementService -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.admin.UpdateIdentityProviderConfigRequest`](#type-com-daml-ledger-api-v2-admin-updateidentityproviderconfigrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.admin.UpdateIdentityProviderConfigResponse`](#type-com-daml-ledger-api-v2-admin-updateidentityproviderconfigresponse) - - -### Service `PackageManagementService` - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto#L21) -- Endpoints tracked: `4` Status: experimental interface, will change before it is deemed production ready @@ -299,151 +718,220 @@ Status: experimental interface, will change before it is deemed production DAR files. We use 'backing participant' to refer to this specific participant in the methods of this API. -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`ListKnownPackages`](#endpoint-com-daml-ledger-api-v2-admin-packagemanagementservice-listknownpackages) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.admin.ListKnownPackagesRequest`](#type-com-daml-ledger-api-v2-admin-listknownpackagesrequest) | [`com.daml.ledger.api.v2.admin.ListKnownPackagesResponse`](#type-com-daml-ledger-api-v2-admin-listknownpackagesresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto#L23) | -| [`UpdateVettedPackages`](#endpoint-com-daml-ledger-api-v2-admin-packagemanagementservice-updatevettedpackages) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.admin.UpdateVettedPackagesRequest`](#type-com-daml-ledger-api-v2-admin-updatevettedpackagesrequest) | [`com.daml.ledger.api.v2.admin.UpdateVettedPackagesResponse`](#type-com-daml-ledger-api-v2-admin-updatevettedpackagesresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto#L41) | -| [`UploadDarFile`](#endpoint-com-daml-ledger-api-v2-admin-packagemanagementservice-uploaddarfile) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.admin.UploadDarFileRequest`](#type-com-daml-ledger-api-v2-admin-uploaddarfilerequest) | [`com.daml.ledger.api.v2.admin.UploadDarFileResponse`](#type-com-daml-ledger-api-v2-admin-uploaddarfileresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto#L30) | -| [`ValidateDarFile`](#endpoint-com-daml-ledger-api-v2-admin-packagemanagementservice-validatedarfile) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.admin.ValidateDarFileRequest`](#type-com-daml-ledger-api-v2-admin-validatedarfilerequest) | [`com.daml.ledger.api.v2.admin.ValidateDarFileResponse`](#type-com-daml-ledger-api-v2-admin-validatedarfileresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto#L38) | - - -**Endpoint `PackageManagementService.ListKnownPackages`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto#L23) - -**Signature** - -```protobuf -rpc PackageManagementService.ListKnownPackages(com.daml.ledger.api.v2.admin.ListKnownPackagesRequest) returns (com.daml.ledger.api.v2.admin.ListKnownPackagesResponse); -``` - -Returns the details of all Daml-LF packages known to the backing participant. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.admin.ListKnownPackagesRequest`](#type-com-daml-ledger-api-v2-admin-listknownpackagesrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.admin.ListKnownPackagesResponse`](#type-com-daml-ledger-api-v2-admin-listknownpackagesresponse) - - -**Endpoint `PackageManagementService.UpdateVettedPackages`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto#L41) - -**Signature** - -```protobuf -rpc PackageManagementService.UpdateVettedPackages(com.daml.ledger.api.v2.admin.UpdateVettedPackagesRequest) returns (com.daml.ledger.api.v2.admin.UpdateVettedPackagesResponse); -``` - -Update the vetted packages of this participant - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.admin.UpdateVettedPackagesRequest`](#type-com-daml-ledger-api-v2-admin-updatevettedpackagesrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.admin.UpdateVettedPackagesResponse`](#type-com-daml-ledger-api-v2-admin-updatevettedpackagesresponse) - - -**Endpoint `PackageManagementService.UploadDarFile`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto#L30) - -**Signature** - -```protobuf -rpc PackageManagementService.UploadDarFile(com.daml.ledger.api.v2.admin.UploadDarFileRequest) returns (com.daml.ledger.api.v2.admin.UploadDarFileResponse); -``` -Upload a DAR file to the participant. +
+ +
+
Source file
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto
+
+ +
+
Operations
+
4
+
+ +
+ + +
+ + + + +
+

PackageManagementService.ListKnownPackages

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Returns the details of all Daml-LF packages known to the backing participant.

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.admin.ListKnownPackagesRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.admin.ListKnownPackagesResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

PackageManagementService.UpdateVettedPackages

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Update the vetted packages of this participant

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.admin.UpdateVettedPackagesRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.admin.UpdateVettedPackagesResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

PackageManagementService.UploadDarFile

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Upload a DAR file to the participant. If vetting is enabled in the request, the DAR is checked for upgrade compatibility with the set of the already vetted packages on the targe...

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.admin.UploadDarFileRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.admin.UploadDarFileResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

PackageManagementService.ValidateDarFile

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Validates the DAR and checks the upgrade compatibility of the DAR's packages with the set of the already vetted packages on the target vetting synchronizer. See ValidateDarFileR...

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.admin.ValidateDarFileRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.admin.ValidateDarFileResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## ParticipantPruningService - If vetting is enabled in the request, the DAR is checked for upgrade compatibility - with the set of the already vetted packages on the target vetting synchronizer - See UploadDarFileRequest for details regarding vetting and the target vetting synchronizer. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.admin.UploadDarFileRequest`](#type-com-daml-ledger-api-v2-admin-uploaddarfilerequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.admin.UploadDarFileResponse`](#type-com-daml-ledger-api-v2-admin-uploaddarfileresponse) - - -**Endpoint `PackageManagementService.ValidateDarFile`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto#L38) - -**Signature** - -```protobuf -rpc PackageManagementService.ValidateDarFile(com.daml.ledger.api.v2.admin.ValidateDarFileRequest) returns (com.daml.ledger.api.v2.admin.ValidateDarFileResponse); -``` - -Validates the DAR and checks the upgrade compatibility of the DAR's packages - with the set of the already vetted packages on the target vetting synchronizer. - See ValidateDarFileRequest for details regarding the target vetting synchronizer. - - The operation has no effect on the state of the participant or the Canton ledger: - the DAR payload and its packages are not persisted neither are the packages vetted. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.admin.ValidateDarFileRequest`](#type-com-daml-ledger-api-v2-admin-validatedarfilerequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.admin.ValidateDarFileResponse`](#type-com-daml-ledger-api-v2-admin-validatedarfileresponse) - - -### Service `ParticipantPruningService` - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/participant_pruning_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/participant_pruning_service.proto#L23) -- Endpoints tracked: `1` Status: experimental interface, will change before it is deemed production ready @@ -457,52 +945,84 @@ Prunes/truncates the "oldest" transactions from the participant (the participant 1. keeping the "inactive" portion of the ledger to a manageable size and 2. removing inactive state to honor the right to be forgotten. -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`Prune`](#endpoint-com-daml-ledger-api-v2-admin-participantpruningservice-prune) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.admin.PruneRequest`](#type-com-daml-ledger-api-v2-admin-prunerequest) | [`com.daml.ledger.api.v2.admin.PruneResponse`](#type-com-daml-ledger-api-v2-admin-pruneresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/participant_pruning_service.proto#L26) | - - -**Endpoint `ParticipantPruningService.Prune`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/participant_pruning_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/participant_pruning_service.proto#L26) - -**Signature** - -```protobuf -rpc ParticipantPruningService.Prune(com.daml.ledger.api.v2.admin.PruneRequest) returns (com.daml.ledger.api.v2.admin.PruneResponse); -``` -Prune the ledger specifying the offset before and at which ledger transactions should be removed. Only returns when - the potentially long-running prune request ends successfully or with an error. +
+ +
+
Source file
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/participant_pruning_service.proto
+
+ +
+
Operations
+
1
+
+ +
+ + +
+ + + + +
+

ParticipantPruningService.Prune

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Prune the ledger specifying the offset before and at which ledger transactions should be removed. Only returns when the potentially long-running prune request ends successfully...

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.admin.PruneRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.admin.PruneResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## PartyManagementService -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.admin.PruneRequest`](#type-com-daml-ledger-api-v2-admin-prunerequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.admin.PruneResponse`](#type-com-daml-ledger-api-v2-admin-pruneresponse) - - -### Service `PartyManagementService` - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto#L37) -- Endpoints tracked: `8` This service allows inspecting the party management state of the ledger known to the participant and managing the participant-local party metadata. - The authorization rules for its RPCs are specified on the ``<RpcName>Request`` + The authorization rules for its RPCs are specified on the ``<RpcName>Request`` messages as boolean expressions over these facts: 1. ``HasRight(r)`` denoting whether the authenticated user has right ``r`` and @@ -521,319 +1041,413 @@ This service allows inspecting the party management state of the ledger known to A party details resource, once it has been created, can be modified using the ``UpdatePartyDetails`` RPC. The only fields that can be modified are those marked as ``Modifiable``. -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`AllocateExternalParty`](#endpoint-com-daml-ledger-api-v2-admin-partymanagementservice-allocateexternalparty) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.admin.AllocateExternalPartyRequest`](#type-com-daml-ledger-api-v2-admin-allocateexternalpartyrequest) | [`com.daml.ledger.api.v2.admin.AllocateExternalPartyResponse`](#type-com-daml-ledger-api-v2-admin-allocateexternalpartyresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto#L85) | -| [`AllocateParty`](#endpoint-com-daml-ledger-api-v2-admin-partymanagementservice-allocateparty) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.admin.AllocatePartyRequest`](#type-com-daml-ledger-api-v2-admin-allocatepartyrequest) | [`com.daml.ledger.api.v2.admin.AllocatePartyResponse`](#type-com-daml-ledger-api-v2-admin-allocatepartyresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto#L70) | -| [`GenerateExternalPartyTopology`](#endpoint-com-daml-ledger-api-v2-admin-partymanagementservice-generateexternalpartytopology) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.admin.GenerateExternalPartyTopologyRequest`](#type-com-daml-ledger-api-v2-admin-generateexternalpartytopologyrequest) | [`com.daml.ledger.api.v2.admin.GenerateExternalPartyTopologyResponse`](#type-com-daml-ledger-api-v2-admin-generateexternalpartytopologyresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto#L104) | -| [`GetParticipantId`](#endpoint-com-daml-ledger-api-v2-admin-partymanagementservice-getparticipantid) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.admin.GetParticipantIdRequest`](#type-com-daml-ledger-api-v2-admin-getparticipantidrequest) | [`com.daml.ledger.api.v2.admin.GetParticipantIdResponse`](#type-com-daml-ledger-api-v2-admin-getparticipantidresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto#L42) | -| [`GetParties`](#endpoint-com-daml-ledger-api-v2-admin-partymanagementservice-getparties) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.admin.GetPartiesRequest`](#type-com-daml-ledger-api-v2-admin-getpartiesrequest) | [`com.daml.ledger.api.v2.admin.GetPartiesResponse`](#type-com-daml-ledger-api-v2-admin-getpartiesresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto#L46) | -| [`ListKnownParties`](#endpoint-com-daml-ledger-api-v2-admin-partymanagementservice-listknownparties) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.admin.ListKnownPartiesRequest`](#type-com-daml-ledger-api-v2-admin-listknownpartiesrequest) | [`com.daml.ledger.api.v2.admin.ListKnownPartiesResponse`](#type-com-daml-ledger-api-v2-admin-listknownpartiesresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto#L51) | -| [`UpdatePartyDetails`](#endpoint-com-daml-ledger-api-v2-admin-partymanagementservice-updatepartydetails) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.admin.UpdatePartyDetailsRequest`](#type-com-daml-ledger-api-v2-admin-updatepartydetailsrequest) | [`com.daml.ledger.api.v2.admin.UpdatePartyDetailsResponse`](#type-com-daml-ledger-api-v2-admin-updatepartydetailsresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto#L89) | -| [`UpdatePartyIdentityProviderId`](#endpoint-com-daml-ledger-api-v2-admin-partymanagementservice-updatepartyidentityproviderid) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.admin.UpdatePartyIdentityProviderIdRequest`](#type-com-daml-ledger-api-v2-admin-updatepartyidentityprovideridrequest) | [`com.daml.ledger.api.v2.admin.UpdatePartyIdentityProviderIdResponse`](#type-com-daml-ledger-api-v2-admin-updatepartyidentityprovideridresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto#L92) | - - -**Endpoint `PartyManagementService.AllocateExternalParty`** -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto#L85) +
+ +
+
Source file
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto
+
+ +
+
Operations
+
8
+
+ +
+ + +
+ + + + +
+

PartyManagementService.AllocateExternalParty

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Alpha 3.3: Endpoint to allocate a new external party on a synchronizer Expected to be stable in 3.5 The external party must be hosted (at least) on this node with either confirm...

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.admin.AllocateExternalPartyRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.admin.AllocateExternalPartyResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

PartyManagementService.AllocateParty

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Allocates a new party on a ledger and adds it to the set managed by the participant. Caller specifies a party identifier suggestion, the actual identifier allocated might be dif...

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.admin.AllocatePartyRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.admin.AllocatePartyResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

PartyManagementService.GenerateExternalPartyTopology

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Alpha 3.3: Convenience endpoint to generate topology transactions for external signing Expected to be stable in 3.5 You may use this endpoint to generate the common external top...

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.admin.GenerateExternalPartyTopologyRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.admin.GenerateExternalPartyTopologyResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

PartyManagementService.GetParticipantId

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Return the identifier of the participant. All horizontally scaled replicas should return the same id. daml-on-kv-ledger: returns an identifier supplied on command line at launch...

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.admin.GetParticipantIdRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.admin.GetParticipantIdResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

PartyManagementService.GetParties

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Get the party details of the given parties. Only known parties will be returned in the list.

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.admin.GetPartiesRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.admin.GetPartiesResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

PartyManagementService.ListKnownParties

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

List the parties known by the participant. The list returned contains parties whose ledger access is facilitated by the participant and the ones maintained elsewhere.

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.admin.ListKnownPartiesRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.admin.ListKnownPartiesResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

PartyManagementService.UpdatePartyDetails

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Update selected modifiable participant-local attributes of a party details resource. Can update the participant's local information for local parties.

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.admin.UpdatePartyDetailsRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.admin.UpdatePartyDetailsResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

PartyManagementService.UpdatePartyIdentityProviderId

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Update the assignment of a party from one IDP to another.

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.admin.UpdatePartyIdentityProviderIdRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.admin.UpdatePartyIdentityProviderIdResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## UserManagementService -**Signature** - -```protobuf -rpc PartyManagementService.AllocateExternalParty(com.daml.ledger.api.v2.admin.AllocateExternalPartyRequest) returns (com.daml.ledger.api.v2.admin.AllocateExternalPartyResponse); -``` - -Alpha 3.3: Endpoint to allocate a new external party on a synchronizer - - Expected to be stable in 3.5 - - The external party must be hosted (at least) on this node with either confirmation or observation permissions - It can optionally be hosted on other nodes (then called a multi-hosted party). - If hosted on additional nodes, explicit authorization of the hosting relationship must be performed on those nodes - before the party can be used. - Decentralized namespaces are supported but must be provided fully authorized by their owners. - The individual owner namespace transactions can be submitted in the same call (fully authorized as well). - In the simple case of a non-multi hosted, non-decentralized party, the RPC will return once the party is - effectively allocated and ready to use, similarly to the AllocateParty behavior. - For more complex scenarios applications may need to query the party status explicitly (only through the admin API as of now). - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.admin.AllocateExternalPartyRequest`](#type-com-daml-ledger-api-v2-admin-allocateexternalpartyrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.admin.AllocateExternalPartyResponse`](#type-com-daml-ledger-api-v2-admin-allocateexternalpartyresponse) - - -**Endpoint `PartyManagementService.AllocateParty`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto#L70) - -**Signature** - -```protobuf -rpc PartyManagementService.AllocateParty(com.daml.ledger.api.v2.admin.AllocatePartyRequest) returns (com.daml.ledger.api.v2.admin.AllocatePartyResponse); -``` - -Allocates a new party on a ledger and adds it to the set managed by the participant. - Caller specifies a party identifier suggestion, the actual identifier - allocated might be different and is implementation specific. - Caller can specify party metadata that is stored locally on the participant. - This call may: - - - Succeed, in which case the actual allocated identifier is visible in - the response. - - Respond with a gRPC error - - daml-on-kv-ledger: suggestion's uniqueness is checked by the validators in - the consensus layer and call rejected if the identifier is already present. - canton: completely different globally unique identifier is allocated. - Behind the scenes calls to an internal protocol are made. As that protocol - is richer than the surface protocol, the arguments take implicit values - The party identifier suggestion must be a valid party name. Party names are required to be non-empty US-ASCII strings built from letters, digits, space, - colon, minus and underscore limited to 255 chars - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.admin.AllocatePartyRequest`](#type-com-daml-ledger-api-v2-admin-allocatepartyrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.admin.AllocatePartyResponse`](#type-com-daml-ledger-api-v2-admin-allocatepartyresponse) - - -**Endpoint `PartyManagementService.GenerateExternalPartyTopology`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto#L104) - -**Signature** - -```protobuf -rpc PartyManagementService.GenerateExternalPartyTopology(com.daml.ledger.api.v2.admin.GenerateExternalPartyTopologyRequest) returns (com.daml.ledger.api.v2.admin.GenerateExternalPartyTopologyResponse); -``` - -Alpha 3.3: Convenience endpoint to generate topology transactions for external signing - - Expected to be stable in 3.5 - - You may use this endpoint to generate the common external topology transactions - which can be signed externally and uploaded as part of the allocate party process - - Note that this request will create a normal namespace using the same key for the - identity as for signing. More elaborate schemes such as multi-signature - or decentralized parties require you to construct the topology transactions yourself. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.admin.GenerateExternalPartyTopologyRequest`](#type-com-daml-ledger-api-v2-admin-generateexternalpartytopologyrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.admin.GenerateExternalPartyTopologyResponse`](#type-com-daml-ledger-api-v2-admin-generateexternalpartytopologyresponse) - - -**Endpoint `PartyManagementService.GetParticipantId`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto#L42) - -**Signature** - -```protobuf -rpc PartyManagementService.GetParticipantId(com.daml.ledger.api.v2.admin.GetParticipantIdRequest) returns (com.daml.ledger.api.v2.admin.GetParticipantIdResponse); -``` - -Return the identifier of the participant. - All horizontally scaled replicas should return the same id. - daml-on-kv-ledger: returns an identifier supplied on command line at launch time - canton: returns globally unique identifier of the participant - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.admin.GetParticipantIdRequest`](#type-com-daml-ledger-api-v2-admin-getparticipantidrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.admin.GetParticipantIdResponse`](#type-com-daml-ledger-api-v2-admin-getparticipantidresponse) - - -**Endpoint `PartyManagementService.GetParties`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto#L46) - -**Signature** - -```protobuf -rpc PartyManagementService.GetParties(com.daml.ledger.api.v2.admin.GetPartiesRequest) returns (com.daml.ledger.api.v2.admin.GetPartiesResponse); -``` - -Get the party details of the given parties. Only known parties will be - returned in the list. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.admin.GetPartiesRequest`](#type-com-daml-ledger-api-v2-admin-getpartiesrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.admin.GetPartiesResponse`](#type-com-daml-ledger-api-v2-admin-getpartiesresponse) - - -**Endpoint `PartyManagementService.ListKnownParties`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto#L51) - -**Signature** - -```protobuf -rpc PartyManagementService.ListKnownParties(com.daml.ledger.api.v2.admin.ListKnownPartiesRequest) returns (com.daml.ledger.api.v2.admin.ListKnownPartiesResponse); -``` - -List the parties known by the participant. - The list returned contains parties whose ledger access is facilitated by - the participant and the ones maintained elsewhere. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.admin.ListKnownPartiesRequest`](#type-com-daml-ledger-api-v2-admin-listknownpartiesrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.admin.ListKnownPartiesResponse`](#type-com-daml-ledger-api-v2-admin-listknownpartiesresponse) - - -**Endpoint `PartyManagementService.UpdatePartyDetails`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto#L89) - -**Signature** - -```protobuf -rpc PartyManagementService.UpdatePartyDetails(com.daml.ledger.api.v2.admin.UpdatePartyDetailsRequest) returns (com.daml.ledger.api.v2.admin.UpdatePartyDetailsResponse); -``` - -Update selected modifiable participant-local attributes of a party details resource. - Can update the participant's local information for local parties. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.admin.UpdatePartyDetailsRequest`](#type-com-daml-ledger-api-v2-admin-updatepartydetailsrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.admin.UpdatePartyDetailsResponse`](#type-com-daml-ledger-api-v2-admin-updatepartydetailsresponse) - - -**Endpoint `PartyManagementService.UpdatePartyIdentityProviderId`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto#L92) - -**Signature** - -```protobuf -rpc PartyManagementService.UpdatePartyIdentityProviderId(com.daml.ledger.api.v2.admin.UpdatePartyIdentityProviderIdRequest) returns (com.daml.ledger.api.v2.admin.UpdatePartyIdentityProviderIdResponse); -``` - -Update the assignment of a party from one IDP to another. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.admin.UpdatePartyIdentityProviderIdRequest`](#type-com-daml-ledger-api-v2-admin-updatepartyidentityprovideridrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.admin.UpdatePartyIdentityProviderIdResponse`](#type-com-daml-ledger-api-v2-admin-updatepartyidentityprovideridresponse) - - -### Service `UserManagementService` - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L43) -- Endpoints tracked: `9` Service to manage users and their rights for interacting with the Ledger API served by a participant node. - The authorization rules for its RPCs are specified on the ``<RpcName>Request`` + The authorization rules for its RPCs are specified on the ``<RpcName>Request`` messages as boolean expressions over these facts: 1. ``HasRight(r)`` denoting whether the authenticated user has right ``r`` and @@ -859,1344 +1473,4467 @@ Service to manage users and their rights for interacting with the Ledger API In order to update the properties represented by the ``User`` message use the ``UpdateUser`` RPC. The only fields that can be modified are those marked as ``Modifiable``. In order to grant or revoke user rights use ``GrantRights' and ``RevokeRights`` RPCs. -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`CreateUser`](#endpoint-com-daml-ledger-api-v2-admin-usermanagementservice-createuser) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.admin.CreateUserRequest`](#type-com-daml-ledger-api-v2-admin-createuserrequest) | [`com.daml.ledger.api.v2.admin.CreateUserResponse`](#type-com-daml-ledger-api-v2-admin-createuserresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L45) | -| [`DeleteUser`](#endpoint-com-daml-ledger-api-v2-admin-usermanagementservice-deleteuser) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.admin.DeleteUserRequest`](#type-com-daml-ledger-api-v2-admin-deleteuserrequest) | [`com.daml.ledger.api.v2.admin.DeleteUserResponse`](#type-com-daml-ledger-api-v2-admin-deleteuserresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L54) | -| [`GetUser`](#endpoint-com-daml-ledger-api-v2-admin-usermanagementservice-getuser) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.admin.GetUserRequest`](#type-com-daml-ledger-api-v2-admin-getuserrequest) | [`com.daml.ledger.api.v2.admin.GetUserResponse`](#type-com-daml-ledger-api-v2-admin-getuserresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L48) | -| [`GrantUserRights`](#endpoint-com-daml-ledger-api-v2-admin-usermanagementservice-grantuserrights) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.admin.GrantUserRightsRequest`](#type-com-daml-ledger-api-v2-admin-grantuserrightsrequest) | [`com.daml.ledger.api.v2.admin.GrantUserRightsResponse`](#type-com-daml-ledger-api-v2-admin-grantuserrightsresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L61) | -| [`ListUserRights`](#endpoint-com-daml-ledger-api-v2-admin-usermanagementservice-listuserrights) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.admin.ListUserRightsRequest`](#type-com-daml-ledger-api-v2-admin-listuserrightsrequest) | [`com.daml.ledger.api.v2.admin.ListUserRightsResponse`](#type-com-daml-ledger-api-v2-admin-listuserrightsresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L68) | -| [`ListUsers`](#endpoint-com-daml-ledger-api-v2-admin-usermanagementservice-listusers) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.admin.ListUsersRequest`](#type-com-daml-ledger-api-v2-admin-listusersrequest) | [`com.daml.ledger.api.v2.admin.ListUsersResponse`](#type-com-daml-ledger-api-v2-admin-listusersresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L57) | -| [`RevokeUserRights`](#endpoint-com-daml-ledger-api-v2-admin-usermanagementservice-revokeuserrights) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.admin.RevokeUserRightsRequest`](#type-com-daml-ledger-api-v2-admin-revokeuserrightsrequest) | [`com.daml.ledger.api.v2.admin.RevokeUserRightsResponse`](#type-com-daml-ledger-api-v2-admin-revokeuserrightsresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L65) | -| [`UpdateUser`](#endpoint-com-daml-ledger-api-v2-admin-usermanagementservice-updateuser) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.admin.UpdateUserRequest`](#type-com-daml-ledger-api-v2-admin-updateuserrequest) | [`com.daml.ledger.api.v2.admin.UpdateUserResponse`](#type-com-daml-ledger-api-v2-admin-updateuserresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L51) | -| [`UpdateUserIdentityProviderId`](#endpoint-com-daml-ledger-api-v2-admin-usermanagementservice-updateuseridentityproviderid) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.admin.UpdateUserIdentityProviderIdRequest`](#type-com-daml-ledger-api-v2-admin-updateuseridentityprovideridrequest) | [`com.daml.ledger.api.v2.admin.UpdateUserIdentityProviderIdResponse`](#type-com-daml-ledger-api-v2-admin-updateuseridentityprovideridresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L71) | - - -**Endpoint `UserManagementService.CreateUser`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L45) - -**Signature** - -```protobuf -rpc UserManagementService.CreateUser(com.daml.ledger.api.v2.admin.CreateUserRequest) returns (com.daml.ledger.api.v2.admin.CreateUserResponse); -``` - -Create a new user. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.admin.CreateUserRequest`](#type-com-daml-ledger-api-v2-admin-createuserrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.admin.CreateUserResponse`](#type-com-daml-ledger-api-v2-admin-createuserresponse) - - -**Endpoint `UserManagementService.DeleteUser`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L54) - -**Signature** - -```protobuf -rpc UserManagementService.DeleteUser(com.daml.ledger.api.v2.admin.DeleteUserRequest) returns (com.daml.ledger.api.v2.admin.DeleteUserResponse); -``` - -Delete an existing user and all its rights. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.admin.DeleteUserRequest`](#type-com-daml-ledger-api-v2-admin-deleteuserrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.admin.DeleteUserResponse`](#type-com-daml-ledger-api-v2-admin-deleteuserresponse) - - -**Endpoint `UserManagementService.GetUser`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L48) - -**Signature** - -```protobuf -rpc UserManagementService.GetUser(com.daml.ledger.api.v2.admin.GetUserRequest) returns (com.daml.ledger.api.v2.admin.GetUserResponse); -``` - -Get the user data of a specific user or the authenticated user. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.admin.GetUserRequest`](#type-com-daml-ledger-api-v2-admin-getuserrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.admin.GetUserResponse`](#type-com-daml-ledger-api-v2-admin-getuserresponse) - - -**Endpoint `UserManagementService.GrantUserRights`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L61) - -**Signature** - -```protobuf -rpc UserManagementService.GrantUserRights(com.daml.ledger.api.v2.admin.GrantUserRightsRequest) returns (com.daml.ledger.api.v2.admin.GrantUserRightsResponse); -``` - -Grant rights to a user. - Granting rights does not affect the resource version of the corresponding user. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.admin.GrantUserRightsRequest`](#type-com-daml-ledger-api-v2-admin-grantuserrightsrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.admin.GrantUserRightsResponse`](#type-com-daml-ledger-api-v2-admin-grantuserrightsresponse) - - -**Endpoint `UserManagementService.ListUserRights`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L68) - -**Signature** - -```protobuf -rpc UserManagementService.ListUserRights(com.daml.ledger.api.v2.admin.ListUserRightsRequest) returns (com.daml.ledger.api.v2.admin.ListUserRightsResponse); -``` - -List the set of all rights granted to a user. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.admin.ListUserRightsRequest`](#type-com-daml-ledger-api-v2-admin-listuserrightsrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.admin.ListUserRightsResponse`](#type-com-daml-ledger-api-v2-admin-listuserrightsresponse) - - -**Endpoint `UserManagementService.ListUsers`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L57) - -**Signature** - -```protobuf -rpc UserManagementService.ListUsers(com.daml.ledger.api.v2.admin.ListUsersRequest) returns (com.daml.ledger.api.v2.admin.ListUsersResponse); -``` - -List all existing users. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.admin.ListUsersRequest`](#type-com-daml-ledger-api-v2-admin-listusersrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.admin.ListUsersResponse`](#type-com-daml-ledger-api-v2-admin-listusersresponse) - - -**Endpoint `UserManagementService.RevokeUserRights`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L65) - -**Signature** - -```protobuf -rpc UserManagementService.RevokeUserRights(com.daml.ledger.api.v2.admin.RevokeUserRightsRequest) returns (com.daml.ledger.api.v2.admin.RevokeUserRightsResponse); -``` - -Revoke rights from a user. - Revoking rights does not affect the resource version of the corresponding user. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.admin.RevokeUserRightsRequest`](#type-com-daml-ledger-api-v2-admin-revokeuserrightsrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.admin.RevokeUserRightsResponse`](#type-com-daml-ledger-api-v2-admin-revokeuserrightsresponse) - - -**Endpoint `UserManagementService.UpdateUser`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L51) - -**Signature** - -```protobuf -rpc UserManagementService.UpdateUser(com.daml.ledger.api.v2.admin.UpdateUserRequest) returns (com.daml.ledger.api.v2.admin.UpdateUserResponse); -``` - -Update selected modifiable attribute of a user resource described by the ``User`` message. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.admin.UpdateUserRequest`](#type-com-daml-ledger-api-v2-admin-updateuserrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.admin.UpdateUserResponse`](#type-com-daml-ledger-api-v2-admin-updateuserresponse) - - -**Endpoint `UserManagementService.UpdateUserIdentityProviderId`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L71) - -**Signature** - -```protobuf -rpc UserManagementService.UpdateUserIdentityProviderId(com.daml.ledger.api.v2.admin.UpdateUserIdentityProviderIdRequest) returns (com.daml.ledger.api.v2.admin.UpdateUserIdentityProviderIdResponse); -``` - -Update the assignment of a user from one IDP to another. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.admin.UpdateUserIdentityProviderIdRequest`](#type-com-daml-ledger-api-v2-admin-updateuseridentityprovideridrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.admin.UpdateUserIdentityProviderIdResponse`](#type-com-daml-ledger-api-v2-admin-updateuseridentityprovideridresponse) - -## Type Reference - - -**Message `com.daml.ledger.api.v2.admin.AllocateExternalPartyRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto#L208) -- Fields: 4 - -Required authorization: ``HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(identity_provider_id)`` - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| synchronizer | `string` | optional | TODO(#27670) support synchronizer aliases
Synchronizer ID on which to onboard the party
Required | -| onboarding_transactions | [`com.daml.ledger.api.v2.admin.AllocateExternalPartyRequest.SignedTransaction`](#type-com-daml-ledger-api-v2-admin-allocateexternalpartyrequest-signedtransaction) | repeated | TopologyTransactions to onboard the external party
Can contain:
- A namespace for the party.
This can be either a single NamespaceDelegation,
or DecentralizedNamespaceDefinition along with its authorized namespace owners in the form of NamespaceDelegations.
May be provided, if so it must be fully authorized by the signatures in this request combined with the existing topology state.
- A PartyToKeyMapping to register the party's signing keys.
May be provided, if so it must be fully authorized by the signatures in this request combined with the existing topology state.
- A PartyToParticipant to register the hosting relationship of the party.
Must be provided.
Required | -| multi_hash_signatures | [`com.daml.ledger.api.v2.Signature`](com-daml-ledger-api-v2#type-com-daml-ledger-api-v2-signature) | repeated | Optional signatures of the combined hash of all onboarding_transactions
This may be used instead of providing signatures on each individual transaction | -| identity_provider_id | `string` | optional | The id of the ``Identity Provider``
If not set, assume the party is managed by the default identity provider.
Optional | - - -**Message `com.daml.ledger.api.v2.admin.AllocateExternalPartyRequest.SignedTransaction`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto#L209) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| transaction | `bytes` | optional | The serialized TopologyTransaction | -| signatures | [`com.daml.ledger.api.v2.Signature`](com-daml-ledger-api-v2#type-com-daml-ledger-api-v2-signature) | repeated | Additional signatures for this transaction specifically
Use for transactions that require additional signatures beyond the namespace key signatures
e.g: PartyToKeyMapping must be signed by all registered keys | - - -**Message `com.daml.ledger.api.v2.admin.AllocateExternalPartyResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto#L245) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| party_id | `string` | optional | | - - -**Message `com.daml.ledger.api.v2.admin.AllocatePartyRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto#L174) -- Fields: 5 - -Required authorization: ``HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(identity_provider_id)`` - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| party_id_hint | `string` | optional | A hint to the participant which party ID to allocate. It can be
ignored.
Must be a valid PartyIdString (as described in ``value.proto``).
Optional | -| local_metadata | [`com.daml.ledger.api.v2.admin.ObjectMeta`](#type-com-daml-ledger-api-v2-admin-objectmeta) | optional | Participant-local metadata to be stored in the ``PartyDetails`` of this newly allocated party.
Optional | -| identity_provider_id | `string` | optional | The id of the ``Identity Provider``
Optional, if not set, assume the party is managed by the default identity provider or party is not hosted by the participant. | -| synchronizer_id | `string` | optional | The synchronizer, on which the party should be allocated.
For backwards compatibility, this field may be omitted, if the participant is connected to only one synchronizer.
Otherwise a synchronizer must be specified.
Optional | -| user_id | `string` | optional | The user who will get the act_as rights to the newly allocated party.
If set to an empty string (the default), no user will get rights to the party.
Optional | - - -**Message `com.daml.ledger.api.v2.admin.AllocatePartyResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto#L203) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| party_details | [`com.daml.ledger.api.v2.admin.PartyDetails`](#type-com-daml-ledger-api-v2-admin-partydetails) | optional | | - - -**Message `com.daml.ledger.api.v2.admin.CommandStatus`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/command_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/command_inspection_service.proto#L49) -- Fields: 7 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| started | `google.protobuf.Timestamp` | optional | | -| completed | `google.protobuf.Timestamp` | optional | | -| completion | [`com.daml.ledger.api.v2.Completion`](com-daml-ledger-api-v2#type-com-daml-ledger-api-v2-completion) | optional | | -| state | [`com.daml.ledger.api.v2.admin.CommandState`](#type-com-daml-ledger-api-v2-admin-commandstate) | optional | | -| commands | [`com.daml.ledger.api.v2.Command`](com-daml-ledger-api-v2#type-com-daml-ledger-api-v2-command) | repeated | | -| request_statistics | [`com.daml.ledger.api.v2.admin.RequestStatistics`](#type-com-daml-ledger-api-v2-admin-requeststatistics) | optional | | -| updates | [`com.daml.ledger.api.v2.admin.CommandUpdates`](#type-com-daml-ledger-api-v2-admin-commandupdates) | optional | | - - -**Message `com.daml.ledger.api.v2.admin.CommandUpdates`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/command_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/command_inspection_service.proto#L65) -- Fields: 5 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| created | [`com.daml.ledger.api.v2.admin.Contract`](#type-com-daml-ledger-api-v2-admin-contract) | repeated | | -| archived | [`com.daml.ledger.api.v2.admin.Contract`](#type-com-daml-ledger-api-v2-admin-contract) | repeated | | -| exercised | `uint32` | optional | | -| fetched | `uint32` | optional | | -| looked_up_by_key | `uint32` | optional | | - - -**Message `com.daml.ledger.api.v2.admin.Contract`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/command_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/command_inspection_service.proto#L73) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| template_id | `com.daml.ledger.api.v2.Identifier` | optional | The identifier of the template used to create the contract.
The identifier uses the package-id reference format.

Required | -| contract_id | `string` | optional | The contract's ID

Required | -| contract_key | `com.daml.ledger.api.v2.Value` | optional | The contract key, if defined

Optional | - - -**Message `com.daml.ledger.api.v2.admin.CreateIdentityProviderConfigRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto#L90) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| identity_provider_config | [`com.daml.ledger.api.v2.admin.IdentityProviderConfig`](#type-com-daml-ledger-api-v2-admin-identityproviderconfig) | optional | Required | - - -**Message `com.daml.ledger.api.v2.admin.CreateIdentityProviderConfigResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto#L95) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| identity_provider_config | [`com.daml.ledger.api.v2.admin.IdentityProviderConfig`](#type-com-daml-ledger-api-v2-admin-identityproviderconfig) | optional | | - - -**Message `com.daml.ledger.api.v2.admin.CreateUserRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L173) -- Fields: 2 - -RPC requests and responses -/////////////////////////// - -Required authorization: ``HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(user.identity_provider_id)`` - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| user | [`com.daml.ledger.api.v2.admin.User`](#type-com-daml-ledger-api-v2-admin-user) | optional | The user to create.
Required | -| rights | [`com.daml.ledger.api.v2.admin.Right`](#type-com-daml-ledger-api-v2-admin-right) | repeated | The rights to be assigned to the user upon creation,
which SHOULD include appropriate rights for the ``user.primary_party``.
Optional | - - -**Message `com.daml.ledger.api.v2.admin.CreateUserResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L184) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| user | [`com.daml.ledger.api.v2.admin.User`](#type-com-daml-ledger-api-v2-admin-user) | optional | Created user. | - - -**Message `com.daml.ledger.api.v2.admin.DeleteIdentityProviderConfigRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto#L141) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| identity_provider_id | `string` | optional | The identity provider config to delete.
Required | - - -**Message `com.daml.ledger.api.v2.admin.DeleteIdentityProviderConfigResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto#L148) -- Fields: 0 - -Does not (yet) contain any data. - - -**Message `com.daml.ledger.api.v2.admin.DeleteUserRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L241) -- Fields: 2 - -Required authorization: ``HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(identity_provider_id)`` - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| user_id | `string` | optional | The user to delete.
Required | -| identity_provider_id | `string` | optional | The id of the ``Identity Provider``
Optional, if not set, assume the user is managed by the default identity provider. | - - -**Message `com.daml.ledger.api.v2.admin.DeleteUserResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L252) -- Fields: 0 - -Does not (yet) contain any data. - - -**Message `com.daml.ledger.api.v2.admin.GenerateExternalPartyTopologyRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto#L321) -- Fields: 7 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| synchronizer | `string` | optional | TODO(#27670) support synchronizer aliases
Required: synchronizer-id for which we are building this request. | -| party_hint | `string` | optional | Required: the actual party id will be constructed from this hint and a fingerprint of the public key | -| public_key | [`com.daml.ledger.api.v2.SigningPublicKey`](com-daml-ledger-api-v2#type-com-daml-ledger-api-v2-signingpublickey) | optional | Required: public key | -| local_participant_observation_only | `bool` | optional | Optional: if true, then the local participant will only be observing, not confirming. Default false. | -| other_confirming_participant_uids | `string` | repeated | Optional: other participant ids which should be confirming for this party | -| confirmation_threshold | `uint32` | optional | Optional: Confirmation threshold >= 1 for the party. Defaults to all available confirmers (or if set to 0). | -| observing_participant_uids | `string` | repeated | Optional: other observing participant ids for this party | - - -**Message `com.daml.ledger.api.v2.admin.GenerateExternalPartyTopologyResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto#L340) -- Fields: 4 - -Response message with topology transactions and the multi-hash to be signed. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| party_id | `string` | optional | the generated party id | -| public_key_fingerprint | `string` | optional | the fingerprint of the supplied public key | -| topology_transactions | `bytes` | repeated | The serialized topology transactions which need to be signed and submitted as part of the allocate party process
Note that the serialization includes the versioning information. Therefore, the transaction here is serialized
as an `UntypedVersionedMessage` which in turn contains the serialized `TopologyTransaction` in the version
supported by the synchronizer. | -| multi_hash | `bytes` | optional | the multi-hash which may be signed instead of each individual transaction | - - -**Message `com.daml.ledger.api.v2.admin.GetCommandStatusRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/command_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/command_inspection_service.proto#L39) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| command_id_prefix | `string` | optional | optional filter by command id | -| state | [`com.daml.ledger.api.v2.admin.CommandState`](#type-com-daml-ledger-api-v2-admin-commandstate) | optional | optional filter by state | -| limit | `uint32` | optional | optional limit of returned statuses, defaults to 100 | - - -**Message `com.daml.ledger.api.v2.admin.GetCommandStatusResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/command_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/command_inspection_service.proto#L45) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| command_status | [`com.daml.ledger.api.v2.admin.CommandStatus`](#type-com-daml-ledger-api-v2-admin-commandstatus) | repeated | | - - -**Message `com.daml.ledger.api.v2.admin.GetIdentityProviderConfigRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto#L99) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| identity_provider_id | `string` | optional | Required | - - -**Message `com.daml.ledger.api.v2.admin.GetIdentityProviderConfigResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto#L104) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| identity_provider_config | [`com.daml.ledger.api.v2.admin.IdentityProviderConfig`](#type-com-daml-ledger-api-v2-admin-identityproviderconfig) | optional | | - - -**Message `com.daml.ledger.api.v2.admin.GetParticipantIdRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto#L108) -- Fields: 0 - -Required authorization: ``HasRight(ParticipantAdmin)`` - - -**Message `com.daml.ledger.api.v2.admin.GetParticipantIdResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto#L110) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| participant_id | `string` | optional | Identifier of the participant, which SHOULD be globally unique.
Must be a valid LedgerString (as describe in ``value.proto``). | - - -**Message `com.daml.ledger.api.v2.admin.GetPartiesRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto#L117) -- Fields: 2 - -Required authorization: ``HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(identity_provider_id)`` - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| parties | `string` | repeated | The stable, unique identifier of the Daml parties.
Must be valid PartyIdStrings (as described in ``value.proto``).
Required | -| identity_provider_id | `string` | optional | The id of the ``Identity Provider`` whose parties should be retrieved.
Optional, if not set, assume the party is managed by the default identity provider or party is not hosted by the participant. | - - -**Message `com.daml.ledger.api.v2.admin.GetPartiesResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto#L128) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| party_details | [`com.daml.ledger.api.v2.admin.PartyDetails`](#type-com-daml-ledger-api-v2-admin-partydetails) | repeated | The details of the requested Daml parties by the participant, if known.
The party details may not be in the same order as requested.
Required | - - -**Message `com.daml.ledger.api.v2.admin.GetUserRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L190) -- Fields: 2 - -Required authorization: ``HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(identity_provider_id) OR IsAuthenticatedUser(user_id)`` - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| user_id | `string` | optional | The user whose data to retrieve.
If set to empty string (the default), then the data for the authenticated user will be retrieved.
Optional | -| identity_provider_id | `string` | optional | The id of the ``Identity Provider``
Optional, if not set, assume the user is managed by the default identity provider. | - - -**Message `com.daml.ledger.api.v2.admin.GetUserResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L201) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| user | [`com.daml.ledger.api.v2.admin.User`](#type-com-daml-ledger-api-v2-admin-user) | optional | Retrieved user. | - - -**Message `com.daml.ledger.api.v2.admin.GrantUserRightsRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L283) -- Fields: 3 - -Add the rights to the set of rights granted to the user. - - Required authorization: ``HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(identity_provider_id)`` - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| user_id | `string` | optional | The user to whom to grant rights.
Required | -| rights | [`com.daml.ledger.api.v2.admin.Right`](#type-com-daml-ledger-api-v2-admin-right) | repeated | The rights to grant.
Optional | -| identity_provider_id | `string` | optional | The id of the ``Identity Provider``
Optional, if not set, assume the user is managed by the default identity provider. | - - -**Message `com.daml.ledger.api.v2.admin.GrantUserRightsResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L297) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| newly_granted_rights | [`com.daml.ledger.api.v2.admin.Right`](#type-com-daml-ledger-api-v2-admin-right) | repeated | The rights that were newly granted by the request. | - - -**Message `com.daml.ledger.api.v2.admin.IdentityProviderConfig`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto#L56) -- Fields: 5 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| identity_provider_id | `string` | optional | The identity provider identifier
Must be a valid LedgerString (as describe in ``value.proto``).
Required | -| is_deactivated | `bool` | optional | When set, the callers using JWT tokens issued by this identity provider are denied all access
to the Ledger API.
Optional,
Modifiable | -| issuer | `string` | optional | Specifies the issuer of the JWT token.
The issuer value is a case sensitive URL using the https scheme that contains scheme, host,
and optionally, port number and path components and no query or fragment components.
Required
Modifiable | -| jwks_url | `string` | optional | The JWKS (JSON Web Key Set) URL.
The Ledger API uses JWKs (JSON Web Keys) from the provided URL to verify that the JWT has been
signed with the loaded JWK. Only RS256 (RSA Signature with SHA-256) signing algorithm is supported.
Required
Modifiable | -| audience | `string` | optional | Specifies the audience of the JWT token.
When set, the callers using JWT tokens issued by this identity provider are allowed to get an access
only if the "aud" claim includes the string specified here
Optional,
Modifiable | - - -**Message `com.daml.ledger.api.v2.admin.ListIdentityProviderConfigsRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto#L108) -- Fields: 0 - -Pagination is not required as the resulting data set is small enough to be returned in a single call - - -**Message `com.daml.ledger.api.v2.admin.ListIdentityProviderConfigsResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto#L112) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| identity_provider_configs | [`com.daml.ledger.api.v2.admin.IdentityProviderConfig`](#type-com-daml-ledger-api-v2-admin-identityproviderconfig) | repeated | | - - -**Message `com.daml.ledger.api.v2.admin.ListKnownPackagesRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto#L44) -- Fields: 0 - -_No description._ - - -**Message `com.daml.ledger.api.v2.admin.ListKnownPackagesResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto#L46) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| package_details | [`com.daml.ledger.api.v2.admin.PackageDetails`](#type-com-daml-ledger-api-v2-admin-packagedetails) | repeated | The details of all Daml-LF packages known to backing participant.
Required | - - -**Message `com.daml.ledger.api.v2.admin.ListKnownPartiesRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto#L136) -- Fields: 4 - -Required authorization: ``HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(identity_provider_id)`` - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| page_token | `string` | optional | Pagination token to determine the specific page to fetch. Using the token guarantees that parties on a subsequent
page are all lexically greater than the last party on a previous page. Server does not store intermediate results
between calls chained by a series of page tokens. As a consequence, if new parties are being added and a page is
requested twice using the same token, more parties can be returned on the second call.
Leave empty to fetch the first page.
Optional | -| page_size | `int32` | optional | Maximum number of results to be returned by the server. The server will return no more than that many results,
but it might return fewer. If the page_size is 0, the server will decide the number of results to be returned.
If the page_size exceeds the maximum supported by the server, an error will be returned. To obtain the server's
maximum consult the PartyManagementFeature descriptor available in the VersionService.
Optional | -| identity_provider_id | `string` | optional | The id of the ``Identity Provider`` whose parties should be retrieved.
Optional, if not set, assume the party is managed by the default identity provider or party is not hosted by the participant. | -| filter_party | `string` | optional | An optional filter for the party name, searching for all party names known to this node
starting with the given prefix. This can either be just a string or extend up to the full
identifier.
Optional | - - -**Message `com.daml.ledger.api.v2.admin.ListKnownPartiesResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto#L163) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| party_details | [`com.daml.ledger.api.v2.admin.PartyDetails`](#type-com-daml-ledger-api-v2-admin-partydetails) | repeated | The details of all Daml parties known by the participant.
Required | -| next_page_token | `string` | optional | Pagination token to retrieve the next page.
Empty, if there are no further results. | - - -**Message `com.daml.ledger.api.v2.admin.ListUserRightsRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L325) -- Fields: 2 - -Required authorization: ``HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(identity_provider_id) OR IsAuthenticatedUser(user_id)`` - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| user_id | `string` | optional | The user for which to list the rights.
If set to empty string (the default), then the rights for the authenticated user will be listed.
Required | -| identity_provider_id | `string` | optional | The id of the ``Identity Provider``
Optional, if not set, assume the user is managed by the default identity provider. | - - -**Message `com.daml.ledger.api.v2.admin.ListUserRightsResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L336) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| rights | [`com.daml.ledger.api.v2.admin.Right`](#type-com-daml-ledger-api-v2-admin-right) | repeated | All rights of the user. | - - -**Message `com.daml.ledger.api.v2.admin.ListUsersRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L255) -- Fields: 3 - -Required authorization: ``HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(identity_provider_id)`` - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| page_token | `string` | optional | Pagination token to determine the specific page to fetch.
Leave empty to fetch the first page.
Optional | -| page_size | `int32` | optional | Maximum number of results to be returned by the server. The server will return no more than that many results, but it might return fewer.
If 0, the server will decide the number of results to be returned.
Optional | -| identity_provider_id | `string` | optional | The id of the ``Identity Provider``
Optional, if not set, assume the user is managed by the default identity provider. | - - -**Message `com.daml.ledger.api.v2.admin.ListUsersResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L271) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| users | [`com.daml.ledger.api.v2.admin.User`](#type-com-daml-ledger-api-v2-admin-user) | repeated | A subset of users of the participant node that fit into this page. | -| next_page_token | `string` | optional | Pagination token to retrieve the next page.
Empty, if there are no further results. | - - -**Message `com.daml.ledger.api.v2.admin.ObjectMeta`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/object_meta.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/object_meta.proto#L16) -- Fields: 2 - -Represents metadata corresponding to a participant resource (e.g. a participant user or participant local information about a party). - - Based on ``ObjectMeta`` meta used in Kubernetes API. - See https://github.com/kubernetes/apimachinery/blob/master/pkg/apis/meta/v1/generated.proto#L640 - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| resource_version | `string` | optional | An opaque, non-empty value, populated by a participant server which represents the internal version of the resource
this ``ObjectMeta`` message is attached to. The participant server will change it to a unique value each time the corresponding resource is updated.
You must not rely on the format of resource version. The participant server might change it without notice.
You can obtain the newest resource version value by issuing a read request.
You may use it for concurrent change detection by passing it back unmodified in an update request.
The participant server will then compare the passed value with the value maintained by the system to determine
if any other updates took place since you had read the resource version.
Upon a successful update you are guaranteed that no other update took place during your read-modify-write sequence.
However, if another update took place during your read-modify-write sequence then your update will fail with an appropriate error.
Concurrent change control is optional. It will be applied only if you include a resource version in an update request.
When creating a new instance of a resource you must leave the resource version empty.
Its value will be populated by the participant server upon successful resource creation.
Optional | -| annotations | `map` | repeated | A set of modifiable key-value pairs that can be used to represent arbitrary, client-specific metadata.
Constraints:

1. The total size over all keys and values cannot exceed 256kb in UTF-8 encoding.
2. Keys are composed of an optional prefix segment and a required name segment such that:

- key prefix, when present, must be a valid DNS subdomain with at most 253 characters, followed by a '/' (forward slash) character,
- name segment must have at most 63 characters that are either alphanumeric ([a-z0-9A-Z]), or a '.' (dot), '-' (dash) or '_' (underscore);
and it must start and end with an alphanumeric character.

3. Values can be any non-empty strings.

Keys with empty prefix are reserved for end-users.
Properties set by external tools or internally by the participant server must use non-empty key prefixes.
Duplicate keys are disallowed by the semantics of the protobuf3 maps.
See: https://developers.google.com/protocol-buffers/docs/proto3#maps
Annotations may be a part of a modifiable resource.
Use the resource's update RPC to update its annotations.
In order to add a new annotation or update an existing one using an update RPC, provide the desired annotation in the update request.
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.
Optional
Modifiable | - - -**Message `com.daml.ledger.api.v2.admin.PackageDetails`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto#L52) -- Fields: 5 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| package_id | `string` | optional | The identity of the Daml-LF package.
Must be a valid PackageIdString (as describe in ``value.proto``).
Required | -| package_size | `uint64` | optional | Size of the package in bytes.
The size of the package is given by the size of the ``daml_lf``
ArchivePayload. See further details in ``daml_lf.proto``.
Required | -| known_since | `google.protobuf.Timestamp` | optional | Indicates since when the package is known to the backing participant.
Required | -| name | `string` | optional | Name of the package as defined by the package metadata | -| version | `string` | optional | Version of the package as defined by the package metadata | - - -**Message `com.daml.ledger.api.v2.admin.PartyDetails`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto#L285) -- Fields: 4 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| party | `string` | optional | The stable unique identifier of a Daml party.
Must be a valid PartyIdString (as described in ``value.proto``).
Required | -| is_local | `bool` | optional | true if party is hosted by the participant and the party shares the same identity provider as the user issuing the request.
Optional | -| local_metadata | [`com.daml.ledger.api.v2.admin.ObjectMeta`](#type-com-daml-ledger-api-v2-admin-objectmeta) | optional | Participant-local metadata of this party.
Optional,
Modifiable | -| identity_provider_id | `string` | optional | The id of the ``Identity Provider``
Optional, if not set, there could be 3 options:

1. the party is managed by the default identity provider.
2. party is not hosted by the participant.
3. party is hosted by the participant, but is outside of the user's identity provider. | - - -**Message `com.daml.ledger.api.v2.admin.PruneRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/participant_pruning_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/participant_pruning_service.proto#L29) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| prune_up_to | `int64` | optional | Inclusive valid absolute offset (positive integer) up to which the ledger is to be pruned.
By default the following data is pruned:

1. All normal and divulged contracts that have been archived before
`prune_up_to`.
2. All transaction events and completions before `prune_up_to`
3. All immediately divulged contracts created before `prune_up_to` independent of whether
they were archived before `prune_up_to`. | -| submission_id | `string` | optional | Unique submission identifier.
Optional, defaults to a random identifier, used for logging. | -| prune_all_divulged_contracts | `bool` | optional | Deprecated flag used to prune all immediately and retroactively divulged contracts.
It is a no-op since the divulged contracts are pruned along with the deactivated contracts. | - - -**Message `com.daml.ledger.api.v2.admin.PruneResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/participant_pruning_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/participant_pruning_service.proto#L49) -- Fields: 0 - -Empty for now, but may contain fields in the future - - -**Message `com.daml.ledger.api.v2.admin.RequestStatistics`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/command_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/command_inspection_service.proto#L59) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| envelopes | `uint32` | optional | | -| request_size | `uint32` | optional | | -| recipients | `uint32` | optional | | - - -**Message `com.daml.ledger.api.v2.admin.RevokeUserRightsRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L305) -- Fields: 3 - -Remove the rights from the set of rights granted to the user. - - Required authorization: ``HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(identity_provider_id)`` - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| user_id | `string` | optional | The user from whom to revoke rights.
Required | -| rights | [`com.daml.ledger.api.v2.admin.Right`](#type-com-daml-ledger-api-v2-admin-right) | repeated | The rights to revoke.
Optional | -| identity_provider_id | `string` | optional | The id of the ``Identity Provider``
Optional, if not set, assume the user is managed by the default identity provider. | - - -**Message `com.daml.ledger.api.v2.admin.RevokeUserRightsResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L319) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| newly_revoked_rights | [`com.daml.ledger.api.v2.admin.Right`](#type-com-daml-ledger-api-v2-admin-right) | repeated | The rights that were actually revoked by the request. | - - -**Message `com.daml.ledger.api.v2.admin.Right`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L113) -- Fields: 7 - -A right granted to a user. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| participant_admin | [`com.daml.ledger.api.v2.admin.Right.ParticipantAdmin`](#type-com-daml-ledger-api-v2-admin-right-participantadmin) | optional | The user can administer the participant node. | -| can_act_as | [`com.daml.ledger.api.v2.admin.Right.CanActAs`](#type-com-daml-ledger-api-v2-admin-right-canactas) | optional | The user can act as a specific party. | -| can_read_as | [`com.daml.ledger.api.v2.admin.Right.CanReadAs`](#type-com-daml-ledger-api-v2-admin-right-canreadas) | optional | The user can read ledger data visible to a specific party. | -| identity_provider_admin | [`com.daml.ledger.api.v2.admin.Right.IdentityProviderAdmin`](#type-com-daml-ledger-api-v2-admin-right-identityprovideradmin) | optional | The user can administer users and parties assigned to the same identity provider as the one of the user. | -| can_read_as_any_party | [`com.daml.ledger.api.v2.admin.Right.CanReadAsAnyParty`](#type-com-daml-ledger-api-v2-admin-right-canreadasanyparty) | optional | The user can read as any party on a participant | -| can_execute_as | [`com.daml.ledger.api.v2.admin.Right.CanExecuteAs`](#type-com-daml-ledger-api-v2-admin-right-canexecuteas) | optional | The user can prepare and execute submissions as a specific party. | -| can_execute_as_any_party | [`com.daml.ledger.api.v2.admin.Right.CanExecuteAsAnyParty`](#type-com-daml-ledger-api-v2-admin-right-canexecuteasanyparty) | optional | The user can prepare and execute submissions as any party on a participant. | - - -**Message `com.daml.ledger.api.v2.admin.Right.ParticipantAdmin`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L115) -- Fields: 0 - -The right to administer the participant node. - - -**Message `com.daml.ledger.api.v2.admin.Right.CanActAs`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L117) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| party | `string` | optional | The right to authorize commands for this party. | - - -**Message `com.daml.ledger.api.v2.admin.Right.CanReadAs`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L122) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| party | `string` | optional | The right to read ledger data visible to this party. | - - -**Message `com.daml.ledger.api.v2.admin.Right.CanExecuteAs`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L127) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| party | `string` | optional | The right to prepare and execute submissions as this party.
This right does not entitle the user to perform any reads.
If reading is required, a separate ReadAs right must be added.
Right to execute as a party is also implicitly contained in the CanActAs right. | - - -**Message `com.daml.ledger.api.v2.admin.Right.IdentityProviderAdmin`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L138) -- Fields: 0 - -The right to administer the identity provider that the user is assigned to. - It means, being able to manage users and parties that are also assigned - to the same identity provider. - - -**Message `com.daml.ledger.api.v2.admin.Right.CanReadAsAnyParty`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L143) -- Fields: 0 - -The rights of a participant's super reader. Its utility is predominantly for - feeding external tools, such as PQS, continually without the need to change subscriptions - as new parties pop in and out of existence. - - -**Message `com.daml.ledger.api.v2.admin.Right.CanExecuteAsAnyParty`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L148) -- Fields: 0 - -The rights of a user to prepare and execute transactions as any party. - Its utility is predominantly for users that perform interactive submissions - on behalf of many parties. - - -**Message `com.daml.ledger.api.v2.admin.UpdateIdentityProviderConfigRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto#L116) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| identity_provider_config | [`com.daml.ledger.api.v2.admin.IdentityProviderConfig`](#type-com-daml-ledger-api-v2-admin-identityproviderconfig) | optional | The identity provider config to update.
Required,
Modifiable | -| update_mask | `google.protobuf.FieldMask` | optional | An update mask specifies how and which properties of the ``IdentityProviderConfig`` message are to be updated.
An update mask consists of a set of update paths.
A valid update path points to a field or a subfield relative to the ``IdentityProviderConfig`` message.
A valid update mask must:

1. contain at least one update path,
2. contain only valid update paths.

Fields that can be updated are marked as ``Modifiable``.
For additional information see the documentation for standard protobuf3's ``google.protobuf.FieldMask``.
Required | - - -**Message `com.daml.ledger.api.v2.admin.UpdateIdentityProviderConfigResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto#L136) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| identity_provider_config | [`com.daml.ledger.api.v2.admin.IdentityProviderConfig`](#type-com-daml-ledger-api-v2-admin-identityproviderconfig) | optional | Updated identity provider config | - - -**Message `com.daml.ledger.api.v2.admin.UpdatePartyDetailsRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto#L250) -- Fields: 2 - -Required authorization: ``HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(party_details.identity_provider_id)`` - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| party_details | [`com.daml.ledger.api.v2.admin.PartyDetails`](#type-com-daml-ledger-api-v2-admin-partydetails) | optional | Party to be updated
Required,
Modifiable | -| update_mask | `google.protobuf.FieldMask` | optional | An update mask specifies how and which properties of the ``PartyDetails`` message are to be updated.
An update mask consists of a set of update paths.
A valid update path points to a field or a subfield relative to the ``PartyDetails`` message.
A valid update mask must:

1. contain at least one update path,
2. contain only valid update paths.

Fields that can be updated are marked as ``Modifiable``.
An update path can also point to non-``Modifiable`` fields such as 'party' and 'local_metadata.resource_version'
because they are used:

1. to identify the party details resource subject to the update,
2. for concurrent change control.

An update path can also point to non-``Modifiable`` fields such as 'is_local'
as long as the values provided in the update request match the server values.
Examples of update paths: 'local_metadata.annotations', 'local_metadata'.
For additional information see the documentation for standard protobuf3's ``google.protobuf.FieldMask``.
For similar Ledger API see ``com.daml.ledger.api.v2.admin.UpdateUserRequest``.
Required | - - -**Message `com.daml.ledger.api.v2.admin.UpdatePartyDetailsResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto#L280) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| party_details | [`com.daml.ledger.api.v2.admin.PartyDetails`](#type-com-daml-ledger-api-v2-admin-partydetails) | optional | Updated party details | - - -**Message `com.daml.ledger.api.v2.admin.UpdatePartyIdentityProviderIdRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto#L310) -- Fields: 3 - -Required authorization: ``HasRight(ParticipantAdmin)`` - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| party | `string` | optional | Party to update | -| source_identity_provider_id | `string` | optional | Current identity provider id of the party | -| target_identity_provider_id | `string` | optional | Target identity provider id of the party | - - -**Message `com.daml.ledger.api.v2.admin.UpdatePartyIdentityProviderIdResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto#L319) -- Fields: 0 - -_No description._ - - -**Message `com.daml.ledger.api.v2.admin.UpdateUserIdentityProviderIdRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L342) -- Fields: 3 - -Required authorization: ``HasRight(ParticipantAdmin)`` - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| user_id | `string` | optional | User to update | -| source_identity_provider_id | `string` | optional | Current identity provider ID of the user | -| target_identity_provider_id | `string` | optional | Target identity provider ID of the user | - - -**Message `com.daml.ledger.api.v2.admin.UpdateUserIdentityProviderIdResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L351) -- Fields: 0 - -_No description._ - - -**Message `com.daml.ledger.api.v2.admin.UpdateUserRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L207) -- Fields: 2 - -Required authorization: ``HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(user.identity_provider_id)`` - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| user | [`com.daml.ledger.api.v2.admin.User`](#type-com-daml-ledger-api-v2-admin-user) | optional | The user to update.
Required,
Modifiable | -| update_mask | `google.protobuf.FieldMask` | optional | An update mask specifies how and which properties of the ``User`` message are to be updated.
An update mask consists of a set of update paths.
A valid update path points to a field or a subfield relative to the ``User`` message.
A valid update mask must:

1. contain at least one update path,
2. contain only valid update paths.

Fields that can be updated are marked as ``Modifiable``.
An update path can also point to a non-``Modifiable`` fields such as 'id' and 'metadata.resource_version'
because they are used:

1. to identify the user resource subject to the update,
2. for concurrent change control.

Examples of valid update paths: 'primary_party', 'metadata', 'metadata.annotations'.
For additional information see the documentation for standard protobuf3's ``google.protobuf.FieldMask``.
For similar Ledger API see ``com.daml.ledger.api.v2.admin.UpdatePartyDetailsRequest``.
Required | - - -**Message `com.daml.ledger.api.v2.admin.UpdateUserResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L235) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| user | [`com.daml.ledger.api.v2.admin.User`](#type-com-daml-ledger-api-v2-admin-user) | optional | Updated user | - - -**Message `com.daml.ledger.api.v2.admin.UpdateVettedPackagesRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto#L204) -- Fields: 5 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| changes | [`com.daml.ledger.api.v2.admin.VettedPackagesChange`](#type-com-daml-ledger-api-v2-admin-vettedpackageschange) | repeated | Changes to apply to the current vetting state of the participant on the
specified synchronizer. The changes are applied in order.
Any package not changed will keep their previous vetting state. | -| dry_run | `bool` | optional | If dry_run is true, then the changes are only prepared, but not applied. If
a request would trigger an error when run (e.g. TOPOLOGY_DEPENDENCIES_NOT_VETTED),
it will also trigger an error when dry_run.

Use this flag to preview a change before applying it. | -| synchronizer_id | `string` | optional | If set, the requested changes will take place on the specified
synchronizer. If synchronizer_id is unset and the participant is only
connected to a single synchronizer, that synchronizer will be used by
default. If synchronizer_id is unset and the participant is connected to
multiple synchronizers, the request will error out with
PACKAGE_SERVICE_CANNOT_AUTODETECT_SYNCHRONIZER.

Optional | -| expected_topology_serial | [`com.daml.ledger.api.v2.PriorTopologySerial`](com-daml-ledger-api-v2#type-com-daml-ledger-api-v2-priortopologyserial) | optional | The serial of the last ``VettedPackages`` topology transaction of this
participant and on this synchronizer.

Execution of the request fails if this is not correct. Use this to guard
against concurrent changes.

If left unspecified, no validation is done against the last transaction's
serial.

Optional | -| update_vetted_packages_force_flags | [`com.daml.ledger.api.v2.admin.UpdateVettedPackagesForceFlag`](#type-com-daml-ledger-api-v2-admin-updatevettedpackagesforceflag) | repeated | Controls whether potentially unsafe vetting updates are allowed.

Optional, defaults to FORCE_FLAG_UNSPECIFIED. | - - -**Message `com.daml.ledger.api.v2.admin.UpdateVettedPackagesResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto#L256) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| past_vetted_packages | [`com.daml.ledger.api.v2.VettedPackages`](com-daml-ledger-api-v2#type-com-daml-ledger-api-v2-vettedpackages) | optional | All vetted packages on this participant and synchronizer, before the
specified changes. Empty if no vetting state existed beforehand. | -| new_vetted_packages | [`com.daml.ledger.api.v2.VettedPackages`](com-daml-ledger-api-v2#type-com-daml-ledger-api-v2-vettedpackages) | optional | All vetted packages on this participant and synchronizer, after the specified changes. | - - -**Message `com.daml.ledger.api.v2.admin.UploadDarFileRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto#L74) -- Fields: 4 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| dar_file | `bytes` | optional | Contains a Daml archive DAR file, which in turn is a jar like zipped
container for ``daml_lf`` archives. See further details in
``daml_lf.proto``.
Required | -| submission_id | `string` | optional | Unique submission identifier.
Optional, defaults to a random identifier. | -| vetting_change | [`com.daml.ledger.api.v2.admin.UploadDarFileRequest.VettingChange`](#type-com-daml-ledger-api-v2-admin-uploaddarfilerequest-vettingchange) | optional | How to vet packages in the DAR being uploaded | -| synchronizer_id | `string` | optional | Only used if VettingChange is set to VETTING_CHANGE_VET_ALL_PACKAGES, in
order to specify which synchronizer to vet on.

If synchronizer_id is set, the synchronizer with this ID will be used. If
synchronizer_id is unset and the participant is only connected to a single
synchronizer, that synchronizer will be used by default. If synchronizer_id
is unset and the participant is connected to multiple synchronizers, the
request will error out with PACKAGE_SERVICE_CANNOT_AUTODETECT_SYNCHRONIZER.

Optional | - - -**Enum `com.daml.ledger.api.v2.admin.UploadDarFileRequest.VettingChange`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto#L85) - -_No description._ - -| Name | Number | -| --- | --- | -| VETTING_CHANGE_UNSPECIFIED | `0` | -| VETTING_CHANGE_VET_ALL_PACKAGES | `1` | -| VETTING_CHANGE_DONT_VET_ANY_PACKAGES | `2` | - - -**Message `com.daml.ledger.api.v2.admin.UploadDarFileResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto#L112) -- Fields: 0 - -A message that is received when the upload operation succeeded. - - -**Message `com.daml.ledger.api.v2.admin.User`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto#L79) -- Fields: 5 - -Users and rights -///////////////// - -Users are used to dynamically manage the rights given to Daml applications. - They are stored and managed per participant node. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| id | `string` | optional | The user identifier, which must be a non-empty string of at most 128
characters that are either alphanumeric ASCII characters or one of the symbols "@^$.!`-#+'~_\|:()".
Required | -| primary_party | `string` | optional | The primary party as which this user reads and acts by default on the ledger
*provided* it has the corresponding ``CanReadAs(primary_party)`` or
``CanActAs(primary_party)`` rights.
Ledger API clients SHOULD set this field to a non-empty value for all users to
enable the users to act on the ledger using their own Daml party.
Users for participant administrators MAY have an associated primary party.
Optional,
Modifiable | -| is_deactivated | `bool` | optional | When set, then the user is denied all access to the Ledger API.
Otherwise, the user has access to the Ledger API as per the user's rights.
Optional,
Modifiable | -| metadata | [`com.daml.ledger.api.v2.admin.ObjectMeta`](#type-com-daml-ledger-api-v2-admin-objectmeta) | optional | The metadata of this user.
Note that the ``metadata.resource_version`` tracks changes to the properties described by the ``User`` message and not the user's rights.
Optional,
Modifiable | -| identity_provider_id | `string` | optional | The ID of the identity provider configured by ``Identity Provider Config``
Optional, if not set, assume the user is managed by the default identity provider. | - - -**Message `com.daml.ledger.api.v2.admin.ValidateDarFileRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto#L116) -- Fields: 3 - -Performs the same checks that UploadDarFileRequest would perform, but doesn't - upload the DAR. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| dar_file | `bytes` | optional | Contains a Daml archive DAR file, which in turn is a jar like zipped
container for ``daml_lf`` archives. See further details in
``daml_lf.proto``.
Required | -| submission_id | `string` | optional | Unique submission identifier.
Optional, defaults to a random identifier. | -| synchronizer_id | `string` | optional | If synchronizer_id is set, the synchronizer with this ID will be used. If
synchronizer_id is unset and the participant is only connected to a single
synchronizer, that synchronizer will be used by default. If synchronizer_id
is unset and the participant is connected to multiple synchronizers, the
request will error out with PACKAGE_SERVICE_CANNOT_AUTODETECT_SYNCHRONIZER.

Optional | - - -**Message `com.daml.ledger.api.v2.admin.ValidateDarFileResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto#L137) -- Fields: 0 - -_No description._ - - -**Message `com.daml.ledger.api.v2.admin.VettedPackagesChange`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto#L140) -- Fields: 2 - -A change to the set of vetted packages. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| vet | [`com.daml.ledger.api.v2.admin.VettedPackagesChange.Vet`](#type-com-daml-ledger-api-v2-admin-vettedpackageschange-vet) | optional | Add packages to or update packages in the set of vetted packages. | -| unvet | [`com.daml.ledger.api.v2.admin.VettedPackagesChange.Unvet`](#type-com-daml-ledger-api-v2-admin-vettedpackageschange-unvet) | optional | Remove packages from the set of vetted packages. | - - -**Message `com.daml.ledger.api.v2.admin.VettedPackagesChange.Unvet`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto#L142) -- Fields: 1 - -Remove packages from the set of vetted packages - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| packages | [`com.daml.ledger.api.v2.admin.VettedPackagesRef`](#type-com-daml-ledger-api-v2-admin-vettedpackagesref) | repeated | Packages to be unvetted.

If a reference in this list matches multiple packages, they are all
unvetted. | - - -**Message `com.daml.ledger.api.v2.admin.VettedPackagesChange.Vet`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto#L152) -- Fields: 3 - -Set vetting bounds of a list of packages. Packages that were not previously - vetted have their bounds added, previous vetting bounds are overwritten. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| packages | [`com.daml.ledger.api.v2.admin.VettedPackagesRef`](#type-com-daml-ledger-api-v2-admin-vettedpackagesref) | repeated | Packages to be vetted.

If a reference in this list matches more than one package, the change is
considered ambiguous and the entire update request is rejected. In other
words, every reference must match exactly one package. | -| new_valid_from_inclusive | `google.protobuf.Timestamp` | optional | The time from which these packages should be vetted, prior lower bounds
are overwritten.
Optional | -| new_valid_until_exclusive | `google.protobuf.Timestamp` | optional | The time until which these packages should be vetted, prior upper bounds
are overwritten.
Optional | - - -**Message `com.daml.ledger.api.v2.admin.VettedPackagesRef`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto#L190) -- Fields: 3 - -A reference to identify one or more packages. - - A reference matches a package if its ``package_id`` matches the package's ID, - its ``package_name`` matches the package's name, and its ``package_version`` - matches the package's version. If an attribute in the reference is left - unspecified (i.e. as an empty string), that attribute is treated as a - wildcard. At a minimum, ``package_id`` or the ``package_name`` must be - specified. - - If a reference does not match any package, the reference is considered - unresolved and the entire update request is rejected. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| package_id | `string` | optional | Package's package id must be the same as this field.
Optional | -| package_name | `string` | optional | Package's name must be the same as this field.
Optional | -| package_version | `string` | optional | Package's version must be the same as this field.
Optional | - - -**Enum `com.daml.ledger.api.v2.admin.CommandState`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/command_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/command_inspection_service.proto#L32) - -_No description._ - -| Name | Number | -| --- | --- | -| COMMAND_STATE_UNSPECIFIED | `0` | -| COMMAND_STATE_PENDING | `1` | -| COMMAND_STATE_SUCCEEDED | `2` | -| COMMAND_STATE_FAILED | `3` | - - -**Enum `com.daml.ledger.api.v2.admin.UpdateVettedPackagesForceFlag`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto#L245) - -_No description._ -| Name | Number | -| --- | --- | -| UPDATE_VETTED_PACKAGES_FORCE_FLAG_UNSPECIFIED | `0` | -| UPDATE_VETTED_PACKAGES_FORCE_FLAG_ALLOW_VET_INCOMPATIBLE_UPGRADES | `2` | -| UPDATE_VETTED_PACKAGES_FORCE_FLAG_ALLOW_UNVETTED_DEPENDENCIES | `3` | +
+ +
+
Source file
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto
+
+ +
+
Operations
+
9
+
+ +
+ + +
+ + + + +
+

UserManagementService.CreateUser

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Create a new user.

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.admin.CreateUserRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.admin.CreateUserResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

UserManagementService.DeleteUser

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Delete an existing user and all its rights.

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.admin.DeleteUserRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.admin.DeleteUserResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

UserManagementService.GetUser

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Get the user data of a specific user or the authenticated user.

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.admin.GetUserRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.admin.GetUserResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

UserManagementService.GrantUserRights

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Grant rights to a user. Granting rights does not affect the resource version of the corresponding user.

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.admin.GrantUserRightsRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.admin.GrantUserRightsResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

UserManagementService.ListUserRights

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

List the set of all rights granted to a user.

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.admin.ListUserRightsRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.admin.ListUserRightsResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

UserManagementService.ListUsers

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

List all existing users.

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.admin.ListUsersRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.admin.ListUsersResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

UserManagementService.RevokeUserRights

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Revoke rights from a user. Revoking rights does not affect the resource version of the corresponding user.

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.admin.RevokeUserRightsRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.admin.RevokeUserRightsResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

UserManagementService.UpdateUser

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Update selected modifiable attribute of a user resource described by the ``User`` message.

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.admin.UpdateUserRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.admin.UpdateUserResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

UserManagementService.UpdateUserIdentityProviderId

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Update the assignment of a user from one IDP to another.

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.admin.UpdateUserIdentityProviderIdRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.admin.UpdateUserIdentityProviderIdResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## Type Inventory + + +These are the package-level message and enum shapes in the publish-version snapshot. + + + + +
+
+

com.daml.ledger.api.v2.admin.AllocateExternalPartyRequest

+ +

4 fields

+ +
+ +

Required authorization: ``HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(identity_provider_id)``

+ + +
+ +
+
+ synchronizer + string + +
+ +
TODO(#27670) support synchronizer aliases Synchronizer ID on which to onboard the party Required
+ +
+ +
+
+ onboarding_transactions + repeated SignedTransaction + +
+ +
TopologyTransactions to onboard the external party Can contain: - A namespace for the party. This can be either a single NamespaceDelegation, or DecentralizedNamespaceDefinition along with its authorized namespace owners in the form of NamespaceDelegations. May be provided, if so it must be fully authorized by the signatures in this request combined with the existing topology state. - A PartyToKeyMapping to register the party's signing keys. May be provided, if so it must be fully authorized by the signatures in this request combined with the existing topology state. - A PartyToParticipant to register the hosting relationship of the party. Must be provided. Required
+ +
+ +
+
+ multi_hash_signatures + repeated Signature + +
+ +
Optional signatures of the combined hash of all onboarding_transactions This may be used instead of providing signatures on each individual transaction
+ +
+ +
+
+ identity_provider_id + string + +
+ +
The id of the ``Identity Provider`` If not set, assume the party is managed by the default identity provider. Optional
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.AllocateExternalPartyRequest.SignedTransaction

+ +

2 fields

+ +
+ + +
+ +
+
+ transaction + bytes + +
+ +
The serialized TopologyTransaction
+ +
+ +
+
+ signatures + repeated Signature + +
+ +
Additional signatures for this transaction specifically Use for transactions that require additional signatures beyond the namespace key signatures e.g: PartyToKeyMapping must be signed by all registered keys
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.Signature

+ +

4 fields

+ +
+ + +
+ +
+
+ format + SignatureFormat + +
+ +
+ +
+
+ signature + bytes + +
+ +
+ +
+
+ signed_by + string + +
+ +
The fingerprint/id of the keypair used to create this signature and needed to verify.
+ +
+ +
+
+ signing_algorithm_spec + SigningAlgorithmSpec + +
+ +
The signing algorithm specification used to produce this signature
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.SignatureFormat

+ +

5 values

+ +
+ + + +
    + +
  • SIGNATURE_FORMAT_UNSPECIFIED
    • + +
  • SIGNATURE_FORMAT_RAW
    • + +
  • SIGNATURE_FORMAT_DER
    • + +
  • SIGNATURE_FORMAT_CONCAT
    • + +
  • SIGNATURE_FORMAT_SYMBOLIC
    • + +
+ + +
+ +
+
+

com.daml.ledger.api.v2.SigningAlgorithmSpec

+ +

4 values

+ +
+ + + +
    + +
  • SIGNING_ALGORITHM_SPEC_UNSPECIFIED
    • + +
  • SIGNING_ALGORITHM_SPEC_ED25519
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_256
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_384
    • + +
+ + +
+ +
+
+

com.daml.ledger.api.v2.admin.AllocateExternalPartyResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ party_id + string + +
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.AllocatePartyRequest

+ +

5 fields

+ +
+ +

Required authorization: ``HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(identity_provider_id)``

+ + +
+ +
+
+ party_id_hint + string + +
+ +
A hint to the participant which party ID to allocate. It can be ignored. Must be a valid PartyIdString (as described in ``value.proto``). Optional
+ +
+ +
+
+ local_metadata + ObjectMeta + +
+ +
Participant-local metadata to be stored in the ``PartyDetails`` of this newly allocated party. Optional
+ +
+ +
+
+ identity_provider_id + string + +
+ +
The id of the ``Identity Provider`` Optional, if not set, assume the party is managed by the default identity provider or party is not hosted by the participant.
+ +
+ +
+
+ synchronizer_id + string + +
+ +
The synchronizer, on which the party should be allocated. For backwards compatibility, this field may be omitted, if the participant is connected to only one synchronizer. Otherwise a synchronizer must be specified. Optional
+ +
+ +
+
+ user_id + string + +
+ +
The user who will get the act_as rights to the newly allocated party. If set to an empty string (the default), no user will get rights to the party. Optional
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.ObjectMeta

+ +

2 fields

+ +
+ +

Represents metadata corresponding to a participant resource (e.g. a participant user or participant local information about a party). Based on ``ObjectMeta`` meta used in Kubernetes API. See https://github.com/kubernetes/apimachinery/blob/master/pkg/apis/meta/v1/generated.proto#L640

+ + +
+ +
+
+ resource_version + string + +
+ +
An opaque, non-empty value, populated by a participant server which represents the internal version of the resource this ``ObjectMeta`` message is attached to. The participant server will change it to a unique value each time the corresponding resource is updated. You must not rely on the format of resource version. The participant server might change it without notice. You can obtain the newest resource version value by issuing a read request. You may use it for concurrent change detection by passing it back unmodified in an update request. The participant server will then compare the passed value with the value maintained by the system to determine if any other updates took place since you had read the resource version. Upon a successful update you are guaranteed that no other update took place during your read-modify-write sequence. However, if another update took place during your read-modify-write sequence then your update will fail with an appropriate error. Concurrent change control is optional. It will be applied only if you include a resource version in an update request. When creating a new instance of a resource you must leave the resource version empty. Its value will be populated by the participant server upon successful resource creation. Optional
+ +
+ +
+
+ annotations + repeated map + +
+ +
A set of modifiable key-value pairs that can be used to represent arbitrary, client-specific metadata. Constraints: 1. The total size over all keys and values cannot exceed 256kb in UTF-8 encoding. 2. Keys are composed of an optional prefix segment and a required name segment such that: - key prefix, when present, must be a valid DNS subdomain with at most 253 characters, followed by a '/' (forward slash) character, - name segment must have at most 63 characters that are either alphanumeric ([a-z0-9A-Z]), or a '.' (dot), '-' (dash) or '_' (underscore); and it must start and end with an alphanumeric character. 3. Values can be any non-empty strings. Keys with empty prefix are reserved for end-users. Properties set by external tools or internally by the participant server must use non-empty key prefixes. Duplicate keys are disallowed by the semantics of the protobuf3 maps. See: https://developers.google.com/protocol-buffers/docs/proto3#maps Annotations may be a part of a modifiable resource. Use the resource's update RPC to update its annotations. In order to add a new annotation or update an existing one using an update RPC, provide the desired annotation in the update request. 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. Optional Modifiable
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.AllocatePartyResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ party_details + PartyDetails + +
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.PartyDetails

+ +

4 fields

+ +
+ + +
+ +
+
+ party + string + +
+ +
The stable unique identifier of a Daml party. Must be a valid PartyIdString (as described in ``value.proto``). Required
+ +
+ +
+
+ is_local + bool + +
+ +
true if party is hosted by the participant and the party shares the same identity provider as the user issuing the request. Optional
+ +
+ +
+
+ local_metadata + ObjectMeta + +
+ +
Participant-local metadata of this party. Optional, Modifiable
+ +
+ +
+
+ identity_provider_id + string + +
+ +
The id of the ``Identity Provider`` Optional, if not set, there could be 3 options: 1. the party is managed by the default identity provider. 2. party is not hosted by the participant. 3. party is hosted by the participant, but is outside of the user's identity provider.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.CommandStatus

+ +

7 fields

+ +
+ + +
+ +
+
+ started + Timestamp + +
+ +
+ +
+
+ completed + Timestamp + +
+ +
+ +
+
+ completion + Completion + +
+ +
+ +
+
+ state + CommandState + +
+ +
+ +
+
+ commands + repeated Command + +
+ +
+ +
+
+ request_statistics + RequestStatistics + +
+ +
+ +
+
+ updates + CommandUpdates + +
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.Completion

+ +

11 fields

+ +
+ +

A completion represents the status of a submitted command on the ledger: it can be successful or failed.

+ + +
+ +
+
+ command_id + string + +
+ +
The ID of the succeeded or failed command. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ status + Status + +
+ +
Identifies the exact type of the error. It uses the same format of conveying error details as it is used for the RPC responses of the APIs. Optional
+ +
+ +
+
+ update_id + string + +
+ +
The update_id of the transaction or reassignment that resulted from the command with command_id. Only set for successfully executed commands. Must be a valid LedgerString (as described in ``value.proto``).
+ +
+ +
+
+ user_id + string + +
+ +
The user-id that was used for the submission, as described in ``commands.proto``. Must be a valid UserIdString (as described in ``value.proto``). Optional for historic completions where this data is not available.
+ +
+ +
+
+ act_as + repeated string + +
+ +
The set of parties on whose behalf the commands were executed. Contains the ``act_as`` parties from ``commands.proto`` filtered to the requesting parties in CompletionStreamRequest. The order of the parties need not be the same as in the submission. Each element must be a valid PartyIdString (as described in ``value.proto``). Optional for historic completions where this data is not available.
+ +
+ +
+
+ submission_id + string + +
+ +
The submission ID this completion refers to, as described in ``commands.proto``. Must be a valid LedgerString (as described in ``value.proto``). Optional
+ +
+ +
+
+ deduplication_offset + int64 + +
+ +
Specifies the start of the deduplication period by a completion stream offset (exclusive). Must be a valid absolute offset (positive integer) or participant begin (zero).
+ +
+ +
+
+ deduplication_duration + Duration + +
+ +
Specifies the length of the deduplication period. It is measured in record time of completions. Must be non-negative.
+ +
+ +
+
+ trace_context + TraceContext + +
+ +
Optional; ledger API trace context The trace context transported in this message corresponds to the trace context supplied by the client application in a HTTP2 header of the original command submission. We typically use a header to transfer this type of information. Here we use message body, because it is used in gRPC streams which do not support per message headers. This field will be populated with the trace context contained in the original submission. If that was not provided, a unique ledger-api-server generated trace context will be used instead.
+ +
+ +
+
+ offset + int64 + +
+ +
May be used in a subsequent CompletionStreamRequest to resume the consumption of this stream at a later time. Required, must be a valid absolute offset (positive integer).
+ +
+ +
+
+ synchronizer_time + SynchronizerTime + +
+ +
The synchronizer along with its record time. The synchronizer id provided, in case of - successful/failed transactions: identifies the synchronizer of the transaction - for successful/failed unassign commands: identifies the source synchronizer - for successful/failed assign commands: identifies the target synchronizer Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.TraceContext

+ +

2 fields

+ +
+ + +
+ +
+
+ traceparent + string + +
+ +
https://www.w3.org/TR/trace-context/
+ +
+ +
+
+ tracestate + string + +
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.SynchronizerTime

+ +

2 fields

+ +
+ + +
+ +
+
+ synchronizer_id + string + +
+ +
The id of the synchronizer. Required
+ +
+ +
+
+ record_time + Timestamp + +
+ +
All commands with a maximum record time below this value MUST be considered lost if their completion has not arrived before this checkpoint. Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.CommandState

+ +

4 values

+ +
+ + + +
    + +
  • COMMAND_STATE_UNSPECIFIED
    • + +
  • COMMAND_STATE_PENDING
    • + +
  • COMMAND_STATE_SUCCEEDED
    • + +
  • COMMAND_STATE_FAILED
    • + +
+ + +
+ +
+
+

com.daml.ledger.api.v2.Command

+ +

4 fields

+ +
+ +

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

+ + +
+ +
+
+ create + CreateCommand + +
+ +
+ +
+
+ exercise + ExerciseCommand + +
+ +
+ +
+
+ exercise_by_key + ExerciseByKeyCommand + +
+ +
+ +
+
+ create_and_exercise + CreateAndExerciseCommand + +
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.CreateCommand

+ +

2 fields

+ +
+ +

Create a new contract instance based on a template.

+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template of contract the client wants to create. Both package-name and package-id reference identifier formats for the template-id are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ create_arguments + Record + +
+ +
The arguments required for creating a contract from this template. Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.ExerciseCommand

+ +

4 fields

+ +
+ +

Exercise a choice on an existing contract.

+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template or interface of the contract the client wants to exercise. Both package-name and package-id reference identifier formats for the template-id are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. To exercise a choice on an interface, specify the interface identifier in the template_id field. Required
+ +
+ +
+
+ contract_id + string + +
+ +
The ID of the contract the client wants to exercise upon. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ choice + string + +
+ +
The name of the choice the client wants to exercise. Must be a valid NameString (as described in ``value.proto``) Required
+ +
+ +
+
+ choice_argument + Value + +
+ +
The argument for this choice. Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.ExerciseByKeyCommand

+ +

4 fields

+ +
+ +

Exercise a choice on an existing contract specified by its key.

+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template of contract the client wants to exercise. Both package-name and package-id reference identifier formats for the template-id are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ contract_key + Value + +
+ +
The key of the contract the client wants to exercise upon. Required
+ +
+ +
+
+ choice + string + +
+ +
The name of the choice the client wants to exercise. Must be a valid NameString (as described in ``value.proto``) Required
+ +
+ +
+
+ choice_argument + Value + +
+ +
The argument for this choice. Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.CreateAndExerciseCommand

+ +

4 fields

+ +
+ +

Create a contract and exercise a choice on it in the same transaction.

+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template of the contract the client wants to create. Both package-name and package-id reference identifier formats for the template-id are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ create_arguments + Record + +
+ +
The arguments required for creating a contract from this template. Required
+ +
+ +
+
+ choice + string + +
+ +
The name of the choice the client wants to exercise. Must be a valid NameString (as described in ``value.proto``). Required
+ +
+ +
+
+ choice_argument + Value + +
+ +
The argument for this choice. Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.RequestStatistics

+ +

3 fields

+ +
+ + +
+ +
+
+ envelopes + uint32 + +
+ +
+ +
+
+ request_size + uint32 + +
+ +
+ +
+
+ recipients + uint32 + +
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.CommandUpdates

+ +

5 fields

+ +
+ + +
+ +
+
+ created + repeated Contract + +
+ +
+ +
+
+ archived + repeated Contract + +
+ +
+ +
+
+ exercised + uint32 + +
+ +
+ +
+
+ fetched + uint32 + +
+ +
+ +
+
+ looked_up_by_key + uint32 + +
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.Contract

+ +

3 fields

+ +
+ + +
+ +
+
+ template_id + Identifier + +
+ +
The identifier of the template used to create the contract. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ contract_id + string + +
+ +
The contract's ID Required
+ +
+ +
+
+ contract_key + Value + +
+ +
The contract key, if defined Optional
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.CreateIdentityProviderConfigRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ identity_provider_config + IdentityProviderConfig + +
+ +
Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.IdentityProviderConfig

+ +

5 fields

+ +
+ + +
+ +
+
+ identity_provider_id + string + +
+ +
The identity provider identifier Must be a valid LedgerString (as describe in ``value.proto``). Required
+ +
+ +
+
+ is_deactivated + bool + +
+ +
When set, the callers using JWT tokens issued by this identity provider are denied all access to the Ledger API. Optional, Modifiable
+ +
+ +
+
+ issuer + string + +
+ +
Specifies the issuer of the JWT token. The issuer value is a case sensitive URL using the https scheme that contains scheme, host, and optionally, port number and path components and no query or fragment components. Required Modifiable
+ +
+ +
+
+ jwks_url + string + +
+ +
The JWKS (JSON Web Key Set) URL. The Ledger API uses JWKs (JSON Web Keys) from the provided URL to verify that the JWT has been signed with the loaded JWK. Only RS256 (RSA Signature with SHA-256) signing algorithm is supported. Required Modifiable
+ +
+ +
+
+ audience + string + +
+ +
Specifies the audience of the JWT token. When set, the callers using JWT tokens issued by this identity provider are allowed to get an access only if the "aud" claim includes the string specified here Optional, Modifiable
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.CreateIdentityProviderConfigResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ identity_provider_config + IdentityProviderConfig + +
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.CreateUserRequest

+ +

2 fields

+ +
+ +

RPC requests and responses /////////////////////////// Required authorization: ``HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(user.identity_provider_id)``

+ + +
+ +
+
+ user + User + +
+ +
The user to create. Required
+ +
+ +
+
+ rights + repeated Right + +
+ +
The rights to be assigned to the user upon creation, which SHOULD include appropriate rights for the ``user.primary_party``. Optional
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.User

+ +

5 fields

+ +
+ +

Users and rights ///////////////// Users are used to dynamically manage the rights given to Daml applications. They are stored and managed per participant node.

+ + +
+ +
+
+ id + string + +
+ +
The user identifier, which must be a non-empty string of at most 128 characters that are either alphanumeric ASCII characters or one of the symbols "@^$.!`-#+'~_|:()". Required
+ +
+ +
+
+ primary_party + string + +
+ +
The primary party as which this user reads and acts by default on the ledger *provided* it has the corresponding ``CanReadAs(primary_party)`` or ``CanActAs(primary_party)`` rights. Ledger API clients SHOULD set this field to a non-empty value for all users to enable the users to act on the ledger using their own Daml party. Users for participant administrators MAY have an associated primary party. Optional, Modifiable
+ +
+ +
+
+ is_deactivated + bool + +
+ +
When set, then the user is denied all access to the Ledger API. Otherwise, the user has access to the Ledger API as per the user's rights. Optional, Modifiable
+ +
+ +
+
+ metadata + ObjectMeta + +
+ +
The metadata of this user. Note that the ``metadata.resource_version`` tracks changes to the properties described by the ``User`` message and not the user's rights. Optional, Modifiable
+ +
+ +
+
+ identity_provider_id + string + +
+ +
The ID of the identity provider configured by ``Identity Provider Config`` Optional, if not set, assume the user is managed by the default identity provider.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.Right

+ +

7 fields

+ +
+ +

A right granted to a user.

+ + +
+ +
+
+ participant_admin + ParticipantAdmin + +
+ +
The user can administer the participant node.
+ +
+ +
+
+ can_act_as + CanActAs + +
+ +
The user can act as a specific party.
+ +
+ +
+
+ can_read_as + CanReadAs + +
+ +
The user can read ledger data visible to a specific party.
+ +
+ +
+
+ identity_provider_admin + IdentityProviderAdmin + +
+ +
The user can administer users and parties assigned to the same identity provider as the one of the user.
+ +
+ +
+
+ can_read_as_any_party + CanReadAsAnyParty + +
+ +
The user can read as any party on a participant
+ +
+ +
+
+ can_execute_as + CanExecuteAs + +
+ +
The user can prepare and execute submissions as a specific party.
+ +
+ +
+
+ can_execute_as_any_party + CanExecuteAsAnyParty + +
+ +
The user can prepare and execute submissions as any party on a participant.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.Right.ParticipantAdmin

+ +

0 fields

+ +
+ +

The right to administer the participant node.

+ + + + +
+ +
+
+

com.daml.ledger.api.v2.admin.Right.CanActAs

+ +

1 fields

+ +
+ + +
+ +
+
+ party + string + +
+ +
The right to authorize commands for this party.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.Right.CanReadAs

+ +

1 fields

+ +
+ + +
+ +
+
+ party + string + +
+ +
The right to read ledger data visible to this party.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.Right.CanExecuteAs

+ +

1 fields

+ +
+ + +
+ +
+
+ party + string + +
+ +
The right to prepare and execute submissions as this party. This right does not entitle the user to perform any reads. If reading is required, a separate ReadAs right must be added. Right to execute as a party is also implicitly contained in the CanActAs right.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.Right.IdentityProviderAdmin

+ +

0 fields

+ +
+ +

The right to administer the identity provider that the user is assigned to. It means, being able to manage users and parties that are also assigned to the same identity provider.

+ + + + +
+ +
+
+

com.daml.ledger.api.v2.admin.Right.CanReadAsAnyParty

+ +

0 fields

+ +
+ +

The rights of a participant's super reader. Its utility is predominantly for feeding external tools, such as PQS, continually without the need to change subscriptions as new parties pop in and out of existence.

+ + + + +
+ +
+
+

com.daml.ledger.api.v2.admin.Right.CanExecuteAsAnyParty

+ +

0 fields

+ +
+ +

The rights of a user to prepare and execute transactions as any party. Its utility is predominantly for users that perform interactive submissions on behalf of many parties.

+ + + + +
+ +
+
+

com.daml.ledger.api.v2.admin.CreateUserResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ user + User + +
+ +
Created user.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.DeleteIdentityProviderConfigRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ identity_provider_id + string + +
+ +
The identity provider config to delete. Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.DeleteIdentityProviderConfigResponse

+ +

0 fields

+ +
+ +

Does not (yet) contain any data.

+ + + + +
+ +
+
+

com.daml.ledger.api.v2.admin.DeleteUserRequest

+ +

2 fields

+ +
+ +

Required authorization: ``HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(identity_provider_id)``

+ + +
+ +
+
+ user_id + string + +
+ +
The user to delete. Required
+ +
+ +
+
+ identity_provider_id + string + +
+ +
The id of the ``Identity Provider`` Optional, if not set, assume the user is managed by the default identity provider.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.DeleteUserResponse

+ +

0 fields

+ +
+ +

Does not (yet) contain any data.

+ + + + +
+ +
+
+

com.daml.ledger.api.v2.admin.GenerateExternalPartyTopologyRequest

+ +

7 fields

+ +
+ + +
+ +
+
+ synchronizer + string + +
+ +
TODO(#27670) support synchronizer aliases Required: synchronizer-id for which we are building this request.
+ +
+ +
+
+ party_hint + string + +
+ +
Required: the actual party id will be constructed from this hint and a fingerprint of the public key
+ +
+ +
+
+ public_key + SigningPublicKey + +
+ +
Required: public key
+ +
+ +
+
+ local_participant_observation_only + bool + +
+ +
Optional: if true, then the local participant will only be observing, not confirming. Default false.
+ +
+ +
+
+ other_confirming_participant_uids + repeated string + +
+ +
Optional: other participant ids which should be confirming for this party
+ +
+ +
+
+ confirmation_threshold + uint32 + +
+ +
Optional: Confirmation threshold >= 1 for the party. Defaults to all available confirmers (or if set to 0).
+ +
+ +
+
+ observing_participant_uids + repeated string + +
+ +
Optional: other observing participant ids for this party
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.SigningPublicKey

+ +

3 fields

+ +
+ + +
+ +
+
+ format + CryptoKeyFormat + +
+ +
The serialization format of the public key
+ +
+ +
+
+ key_data + bytes + +
+ +
Serialized public key in the format specified above
+ +
+ +
+
+ key_spec + SigningKeySpec + +
+ +
The key specification
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.CryptoKeyFormat

+ +

4 values

+ +
+ +

Serialization format for crypto keys and signatures

+ + + +
    + +
  • CRYPTO_KEY_FORMAT_UNSPECIFIED
    • + +
  • CRYPTO_KEY_FORMAT_DER
    • + +
  • CRYPTO_KEY_FORMAT_RAW
    • + +
  • CRYPTO_KEY_FORMAT_DER_X509_SUBJECT_PUBLIC_KEY_INFO
    • + +
+ + +
+ +
+
+

com.daml.ledger.api.v2.SigningKeySpec

+ +

5 values

+ +
+ +

Note: these crypto data types are a subset of the ones used internally by Canton. They have been forked from the respective com.digitalasset.canton.crypto.v30 package.

+ + + +
    + +
  • SIGNING_KEY_SPEC_UNSPECIFIED
    • + +
  • SIGNING_KEY_SPEC_EC_CURVE25519
    • + +
  • SIGNING_KEY_SPEC_EC_P256
    • + +
  • SIGNING_KEY_SPEC_EC_P384
    • + +
  • SIGNING_KEY_SPEC_EC_SECP256K1
    • + +
+ + +
+ +
+
+

com.daml.ledger.api.v2.admin.GenerateExternalPartyTopologyResponse

+ +

4 fields

+ +
+ +

Response message with topology transactions and the multi-hash to be signed.

+ + +
+ +
+
+ party_id + string + +
+ +
the generated party id
+ +
+ +
+
+ public_key_fingerprint + string + +
+ +
the fingerprint of the supplied public key
+ +
+ +
+
+ topology_transactions + repeated bytes + +
+ +
The serialized topology transactions which need to be signed and submitted as part of the allocate party process Note that the serialization includes the versioning information. Therefore, the transaction here is serialized as an `UntypedVersionedMessage` which in turn contains the serialized `TopologyTransaction` in the version supported by the synchronizer.
+ +
+ +
+
+ multi_hash + bytes + +
+ +
the multi-hash which may be signed instead of each individual transaction
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.GetCommandStatusRequest

+ +

3 fields

+ +
+ + +
+ +
+
+ command_id_prefix + string + +
+ +
optional filter by command id
+ +
+ +
+
+ state + CommandState + +
+ +
optional filter by state
+ +
+ +
+
+ limit + uint32 + +
+ +
optional limit of returned statuses, defaults to 100
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.GetCommandStatusResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ command_status + repeated CommandStatus + +
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.GetIdentityProviderConfigRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ identity_provider_id + string + +
+ +
Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.GetIdentityProviderConfigResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ identity_provider_config + IdentityProviderConfig + +
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.GetParticipantIdRequest

+ +

0 fields

+ +
+ +

Required authorization: ``HasRight(ParticipantAdmin)``

+ + + + +
+ +
+
+

com.daml.ledger.api.v2.admin.GetParticipantIdResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ participant_id + string + +
+ +
Identifier of the participant, which SHOULD be globally unique. Must be a valid LedgerString (as describe in ``value.proto``).
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.GetPartiesRequest

+ +

2 fields

+ +
+ +

Required authorization: ``HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(identity_provider_id)``

+ + +
+ +
+
+ parties + repeated string + +
+ +
The stable, unique identifier of the Daml parties. Must be valid PartyIdStrings (as described in ``value.proto``). Required
+ +
+ +
+
+ identity_provider_id + string + +
+ +
The id of the ``Identity Provider`` whose parties should be retrieved. Optional, if not set, assume the party is managed by the default identity provider or party is not hosted by the participant.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.GetPartiesResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ party_details + repeated PartyDetails + +
+ +
The details of the requested Daml parties by the participant, if known. The party details may not be in the same order as requested. Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.GetUserRequest

+ +

2 fields

+ +
+ +

Required authorization: ``HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(identity_provider_id) OR IsAuthenticatedUser(user_id)``

+ + +
+ +
+
+ user_id + string + +
+ +
The user whose data to retrieve. If set to empty string (the default), then the data for the authenticated user will be retrieved. Optional
+ +
+ +
+
+ identity_provider_id + string + +
+ +
The id of the ``Identity Provider`` Optional, if not set, assume the user is managed by the default identity provider.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.GetUserResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ user + User + +
+ +
Retrieved user.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.GrantUserRightsRequest

+ +

3 fields

+ +
+ +

Add the rights to the set of rights granted to the user. Required authorization: ``HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(identity_provider_id)``

+ + +
+ +
+
+ user_id + string + +
+ +
The user to whom to grant rights. Required
+ +
+ +
+
+ rights + repeated Right + +
+ +
The rights to grant. Optional
+ +
+ +
+
+ identity_provider_id + string + +
+ +
The id of the ``Identity Provider`` Optional, if not set, assume the user is managed by the default identity provider.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.GrantUserRightsResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ newly_granted_rights + repeated Right + +
+ +
The rights that were newly granted by the request.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.ListIdentityProviderConfigsRequest

+ +

0 fields

+ +
+ +

Pagination is not required as the resulting data set is small enough to be returned in a single call

+ + + + +
+ +
+
+

com.daml.ledger.api.v2.admin.ListIdentityProviderConfigsResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ identity_provider_configs + repeated IdentityProviderConfig + +
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.ListKnownPackagesRequest

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.daml.ledger.api.v2.admin.ListKnownPackagesResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ package_details + repeated PackageDetails + +
+ +
The details of all Daml-LF packages known to backing participant. Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.PackageDetails

+ +

5 fields

+ +
+ + +
+ +
+
+ package_id + string + +
+ +
The identity of the Daml-LF package. Must be a valid PackageIdString (as describe in ``value.proto``). Required
+ +
+ +
+
+ package_size + uint64 + +
+ +
Size of the package in bytes. The size of the package is given by the size of the ``daml_lf`` ArchivePayload. See further details in ``daml_lf.proto``. Required
+ +
+ +
+
+ known_since + Timestamp + +
+ +
Indicates since when the package is known to the backing participant. Required
+ +
+ +
+
+ name + string + +
+ +
Name of the package as defined by the package metadata
+ +
+ +
+
+ version + string + +
+ +
Version of the package as defined by the package metadata
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.ListKnownPartiesRequest

+ +

4 fields

+ +
+ +

Required authorization: ``HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(identity_provider_id)``

+ + +
+ +
+
+ page_token + string + +
+ +
Pagination token to determine the specific page to fetch. Using the token guarantees that parties on a subsequent page are all lexically greater than the last party on a previous page. Server does not store intermediate results between calls chained by a series of page tokens. As a consequence, if new parties are being added and a page is requested twice using the same token, more parties can be returned on the second call. Leave empty to fetch the first page. Optional
+ +
+ +
+
+ page_size + int32 + +
+ +
Maximum number of results to be returned by the server. The server will return no more than that many results, but it might return fewer. If the page_size is 0, the server will decide the number of results to be returned. If the page_size exceeds the maximum supported by the server, an error will be returned. To obtain the server's maximum consult the PartyManagementFeature descriptor available in the VersionService. Optional
+ +
+ +
+
+ identity_provider_id + string + +
+ +
The id of the ``Identity Provider`` whose parties should be retrieved. Optional, if not set, assume the party is managed by the default identity provider or party is not hosted by the participant.
+ +
+ +
+
+ filter_party + string + +
+ +
An optional filter for the party name, searching for all party names known to this node starting with the given prefix. This can either be just a string or extend up to the full identifier. Optional
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.ListKnownPartiesResponse

+ +

2 fields

+ +
+ + +
+ +
+
+ party_details + repeated PartyDetails + +
+ +
The details of all Daml parties known by the participant. Required
+ +
+ +
+
+ next_page_token + string + +
+ +
Pagination token to retrieve the next page. Empty, if there are no further results.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.ListUserRightsRequest

+ +

2 fields

+ +
+ +

Required authorization: ``HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(identity_provider_id) OR IsAuthenticatedUser(user_id)``

+ + +
+ +
+
+ user_id + string + +
+ +
The user for which to list the rights. If set to empty string (the default), then the rights for the authenticated user will be listed. Required
+ +
+ +
+
+ identity_provider_id + string + +
+ +
The id of the ``Identity Provider`` Optional, if not set, assume the user is managed by the default identity provider.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.ListUserRightsResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ rights + repeated Right + +
+ +
All rights of the user.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.ListUsersRequest

+ +

3 fields

+ +
+ +

Required authorization: ``HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(identity_provider_id)``

+ + +
+ +
+
+ page_token + string + +
+ +
Pagination token to determine the specific page to fetch. Leave empty to fetch the first page. Optional
+ +
+ +
+
+ page_size + int32 + +
+ +
Maximum number of results to be returned by the server. The server will return no more than that many results, but it might return fewer. If 0, the server will decide the number of results to be returned. Optional
+ +
+ +
+
+ identity_provider_id + string + +
+ +
The id of the ``Identity Provider`` Optional, if not set, assume the user is managed by the default identity provider.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.ListUsersResponse

+ +

2 fields

+ +
+ + +
+ +
+
+ users + repeated User + +
+ +
A subset of users of the participant node that fit into this page.
+ +
+ +
+
+ next_page_token + string + +
+ +
Pagination token to retrieve the next page. Empty, if there are no further results.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.PruneRequest

+ +

3 fields

+ +
+ + +
+ +
+
+ prune_up_to + int64 + +
+ +
Inclusive valid absolute offset (positive integer) up to which the ledger is to be pruned. By default the following data is pruned: 1. All normal and divulged contracts that have been archived before `prune_up_to`. 2. All transaction events and completions before `prune_up_to` 3. All immediately divulged contracts created before `prune_up_to` independent of whether they were archived before `prune_up_to`.
+ +
+ +
+
+ submission_id + string + +
+ +
Unique submission identifier. Optional, defaults to a random identifier, used for logging.
+ +
+ +
+
+ prune_all_divulged_contracts + bool + +
+ +
Deprecated flag used to prune all immediately and retroactively divulged contracts. It is a no-op since the divulged contracts are pruned along with the deactivated contracts.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.PruneResponse

+ +

0 fields

+ +
+ +

Empty for now, but may contain fields in the future

+ + + + +
+ +
+
+

com.daml.ledger.api.v2.admin.RevokeUserRightsRequest

+ +

3 fields

+ +
+ +

Remove the rights from the set of rights granted to the user. Required authorization: ``HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(identity_provider_id)``

+ + +
+ +
+
+ user_id + string + +
+ +
The user from whom to revoke rights. Required
+ +
+ +
+
+ rights + repeated Right + +
+ +
The rights to revoke. Optional
+ +
+ +
+
+ identity_provider_id + string + +
+ +
The id of the ``Identity Provider`` Optional, if not set, assume the user is managed by the default identity provider.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.RevokeUserRightsResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ newly_revoked_rights + repeated Right + +
+ +
The rights that were actually revoked by the request.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.UpdateIdentityProviderConfigRequest

+ +

2 fields

+ +
+ + +
+ +
+
+ identity_provider_config + IdentityProviderConfig + +
+ +
The identity provider config to update. Required, Modifiable
+ +
+ +
+
+ update_mask + FieldMask + +
+ +
An update mask specifies how and which properties of the ``IdentityProviderConfig`` message are to be updated. An update mask consists of a set of update paths. A valid update path points to a field or a subfield relative to the ``IdentityProviderConfig`` message. A valid update mask must: 1. contain at least one update path, 2. contain only valid update paths. Fields that can be updated are marked as ``Modifiable``. For additional information see the documentation for standard protobuf3's ``google.protobuf.FieldMask``. Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.UpdateIdentityProviderConfigResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ identity_provider_config + IdentityProviderConfig + +
+ +
Updated identity provider config
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.UpdatePartyDetailsRequest

+ +

2 fields

+ +
+ +

Required authorization: ``HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(party_details.identity_provider_id)``

+ + +
+ +
+
+ party_details + PartyDetails + +
+ +
Party to be updated Required, Modifiable
+ +
+ +
+
+ update_mask + FieldMask + +
+ +
An update mask specifies how and which properties of the ``PartyDetails`` message are to be updated. An update mask consists of a set of update paths. A valid update path points to a field or a subfield relative to the ``PartyDetails`` message. A valid update mask must: 1. contain at least one update path, 2. contain only valid update paths. Fields that can be updated are marked as ``Modifiable``. An update path can also point to non-``Modifiable`` fields such as 'party' and 'local_metadata.resource_version' because they are used: 1. to identify the party details resource subject to the update, 2. for concurrent change control. An update path can also point to non-``Modifiable`` fields such as 'is_local' as long as the values provided in the update request match the server values. Examples of update paths: 'local_metadata.annotations', 'local_metadata'. For additional information see the documentation for standard protobuf3's ``google.protobuf.FieldMask``. For similar Ledger API see ``com.daml.ledger.api.v2.admin.UpdateUserRequest``. Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.UpdatePartyDetailsResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ party_details + PartyDetails + +
+ +
Updated party details
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.UpdatePartyIdentityProviderIdRequest

+ +

3 fields

+ +
+ +

Required authorization: ``HasRight(ParticipantAdmin)``

+ + +
+ +
+
+ party + string + +
+ +
Party to update
+ +
+ +
+
+ source_identity_provider_id + string + +
+ +
Current identity provider id of the party
+ +
+ +
+
+ target_identity_provider_id + string + +
+ +
Target identity provider id of the party
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.UpdatePartyIdentityProviderIdResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.daml.ledger.api.v2.admin.UpdateUserIdentityProviderIdRequest

+ +

3 fields

+ +
+ +

Required authorization: ``HasRight(ParticipantAdmin)``

+ + +
+ +
+
+ user_id + string + +
+ +
User to update
+ +
+ +
+
+ source_identity_provider_id + string + +
+ +
Current identity provider ID of the user
+ +
+ +
+
+ target_identity_provider_id + string + +
+ +
Target identity provider ID of the user
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.UpdateUserIdentityProviderIdResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.daml.ledger.api.v2.admin.UpdateUserRequest

+ +

2 fields

+ +
+ +

Required authorization: ``HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(user.identity_provider_id)``

+ + +
+ +
+
+ user + User + +
+ +
The user to update. Required, Modifiable
+ +
+ +
+
+ update_mask + FieldMask + +
+ +
An update mask specifies how and which properties of the ``User`` message are to be updated. An update mask consists of a set of update paths. A valid update path points to a field or a subfield relative to the ``User`` message. A valid update mask must: 1. contain at least one update path, 2. contain only valid update paths. Fields that can be updated are marked as ``Modifiable``. An update path can also point to a non-``Modifiable`` fields such as 'id' and 'metadata.resource_version' because they are used: 1. to identify the user resource subject to the update, 2. for concurrent change control. Examples of valid update paths: 'primary_party', 'metadata', 'metadata.annotations'. For additional information see the documentation for standard protobuf3's ``google.protobuf.FieldMask``. For similar Ledger API see ``com.daml.ledger.api.v2.admin.UpdatePartyDetailsRequest``. Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.UpdateUserResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ user + User + +
+ +
Updated user
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.UpdateVettedPackagesRequest

+ +

5 fields

+ +
+ + +
+ +
+
+ changes + repeated VettedPackagesChange + +
+ +
Changes to apply to the current vetting state of the participant on the specified synchronizer. The changes are applied in order. Any package not changed will keep their previous vetting state.
+ +
+ +
+
+ dry_run + bool + +
+ +
If dry_run is true, then the changes are only prepared, but not applied. If a request would trigger an error when run (e.g. TOPOLOGY_DEPENDENCIES_NOT_VETTED), it will also trigger an error when dry_run. Use this flag to preview a change before applying it.
+ +
+ +
+
+ synchronizer_id + string + +
+ +
If set, the requested changes will take place on the specified synchronizer. If synchronizer_id is unset and the participant is only connected to a single synchronizer, that synchronizer will be used by default. If synchronizer_id is unset and the participant is connected to multiple synchronizers, the request will error out with PACKAGE_SERVICE_CANNOT_AUTODETECT_SYNCHRONIZER. Optional
+ +
+ +
+
+ expected_topology_serial + PriorTopologySerial + +
+ +
The serial of the last ``VettedPackages`` topology transaction of this participant and on this synchronizer. Execution of the request fails if this is not correct. Use this to guard against concurrent changes. If left unspecified, no validation is done against the last transaction's serial. Optional
+ +
+ +
+
+ update_vetted_packages_force_flags + repeated UpdateVettedPackagesForceFlag + +
+ +
Controls whether potentially unsafe vetting updates are allowed. Optional, defaults to FORCE_FLAG_UNSPECIFIED.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.VettedPackagesChange

+ +

2 fields

+ +
+ +

A change to the set of vetted packages.

+ + +
+ +
+
+ vet + Vet + +
+ +
Add packages to or update packages in the set of vetted packages.
+ +
+ +
+
+ unvet + Unvet + +
+ +
Remove packages from the set of vetted packages.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.VettedPackagesChange.Unvet

+ +

1 fields

+ +
+ +

Remove packages from the set of vetted packages

+ + +
+ +
+
+ packages + repeated VettedPackagesRef + +
+ +
Packages to be unvetted. If a reference in this list matches multiple packages, they are all unvetted.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.VettedPackagesRef

+ +

3 fields

+ +
+ +

A reference to identify one or more packages. A reference matches a package if its ``package_id`` matches the package's ID, its ``package_name`` matches the package's name, and its ``package_version`` matches the package's version. If an attribute in the reference is left unspecified (i.e. as an empty string), that attribute is treated as a wildcard. At a minimum, ``package_id`` or the ``package_name`` must be specified. If a reference does not match any package, the reference is considered unresolved and the entire update request is rejected.

+ + +
+ +
+
+ package_id + string + +
+ +
Package's package id must be the same as this field. Optional
+ +
+ +
+
+ package_name + string + +
+ +
Package's name must be the same as this field. Optional
+ +
+ +
+
+ package_version + string + +
+ +
Package's version must be the same as this field. Optional
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.VettedPackagesChange.Vet

+ +

3 fields

+ +
+ +

Set vetting bounds of a list of packages. Packages that were not previously vetted have their bounds added, previous vetting bounds are overwritten.

+ + +
+ +
+
+ packages + repeated VettedPackagesRef + +
+ +
Packages to be vetted. If a reference in this list matches more than one package, the change is considered ambiguous and the entire update request is rejected. In other words, every reference must match exactly one package.
+ +
+ +
+
+ new_valid_from_inclusive + Timestamp + +
+ +
The time from which these packages should be vetted, prior lower bounds are overwritten. Optional
+ +
+ +
+
+ new_valid_until_exclusive + Timestamp + +
+ +
The time until which these packages should be vetted, prior upper bounds are overwritten. Optional
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.PriorTopologySerial

+ +

2 fields

+ +
+ +

The serial of last ``VettedPackages`` topology transaction on a given participant and synchronizer.

+ + +
+ +
+
+ prior + uint32 + +
+ +
Previous transaction's serial.
+ +
+ +
+
+ no_prior + Empty + +
+ +
No previous transaction exists.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.UpdateVettedPackagesForceFlag

+ +

3 values

+ +
+ + + +
    + +
  • UPDATE_VETTED_PACKAGES_FORCE_FLAG_UNSPECIFIED
    • + +
  • UPDATE_VETTED_PACKAGES_FORCE_FLAG_ALLOW_VET_INCOMPATIBLE_UPGRADES
    • + +
  • UPDATE_VETTED_PACKAGES_FORCE_FLAG_ALLOW_UNVETTED_DEPENDENCIES
    • + +
+ + +
+ +
+
+

com.daml.ledger.api.v2.admin.UpdateVettedPackagesResponse

+ +

2 fields

+ +
+ + +
+ +
+
+ past_vetted_packages + VettedPackages + +
+ +
All vetted packages on this participant and synchronizer, before the specified changes. Empty if no vetting state existed beforehand.
+ +
+ +
+
+ new_vetted_packages + VettedPackages + +
+ +
All vetted packages on this participant and synchronizer, after the specified changes.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.VettedPackages

+ +

4 fields

+ +
+ +

The list of packages vetted on a given participant and synchronizer, modelled 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>`_. The list only contains packages that matched a filter in the query that originated it.

+ + +
+ +
+
+ packages + repeated VettedPackage + +
+ +
Sorted by package_name and package_version where known, and package_id as a last resort.
+ +
+ +
+
+ participant_id + string + +
+ +
Participant on which these packages are vetted. Always present.
+ +
+ +
+
+ synchronizer_id + string + +
+ +
Synchronizer on which these packages are vetted. Always present.
+ +
+ +
+
+ topology_serial + uint32 + +
+ +
Serial of last ``VettedPackages`` topology transaction of this participant and on this synchronizer. Always present.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.VettedPackage

+ +

5 fields

+ +
+ +

A package that is vetting on a given participant and synchronizer, 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>`_, enriched with the package name and version.

+ + +
+ +
+
+ package_id + string + +
+ +
Package ID of this package. Always present.
+ +
+ +
+
+ valid_from_inclusive + Timestamp + +
+ +
The time from which this package is vetted. Empty if vetting time has no lower bound.
+ +
+ +
+
+ valid_until_exclusive + Timestamp + +
+ +
The time until which this package is vetted. Empty if vetting time has no upper bound.
+ +
+ +
+
+ package_name + string + +
+ +
Name of this package. Only available if the package has been uploaded to the current participant. If unavailable, is empty string.
+ +
+ +
+
+ package_version + string + +
+ +
Version of this package. Only available if the package has been uploaded to the current participant. If unavailable, is empty string.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.UploadDarFileRequest

+ +

4 fields

+ +
+ + +
+ +
+
+ dar_file + bytes + +
+ +
Contains a Daml archive DAR file, which in turn is a jar like zipped container for ``daml_lf`` archives. See further details in ``daml_lf.proto``. Required
+ +
+ +
+
+ submission_id + string + +
+ +
Unique submission identifier. Optional, defaults to a random identifier.
+ +
+ +
+
+ vetting_change + VettingChange + +
+ +
How to vet packages in the DAR being uploaded
+ +
+ +
+
+ synchronizer_id + string + +
+ +
Only used if VettingChange is set to VETTING_CHANGE_VET_ALL_PACKAGES, in order to specify which synchronizer to vet on. If synchronizer_id is set, the synchronizer with this ID will be used. If synchronizer_id is unset and the participant is only connected to a single synchronizer, that synchronizer will be used by default. If synchronizer_id is unset and the participant is connected to multiple synchronizers, the request will error out with PACKAGE_SERVICE_CANNOT_AUTODETECT_SYNCHRONIZER. Optional
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.UploadDarFileRequest.VettingChange

+ +

3 values

+ +
+ + + +
    + +
  • VETTING_CHANGE_UNSPECIFIED
    • + +
  • VETTING_CHANGE_VET_ALL_PACKAGES
    • + +
  • VETTING_CHANGE_DONT_VET_ANY_PACKAGES
    • + +
+ + +
+ +
+
+

com.daml.ledger.api.v2.admin.UploadDarFileResponse

+ +

0 fields

+ +
+ +

A message that is received when the upload operation succeeded.

+ + + + +
+ +
+
+

com.daml.ledger.api.v2.admin.ValidateDarFileRequest

+ +

3 fields

+ +
+ +

Performs the same checks that UploadDarFileRequest would perform, but doesn't upload the DAR.

+ + +
+ +
+
+ dar_file + bytes + +
+ +
Contains a Daml archive DAR file, which in turn is a jar like zipped container for ``daml_lf`` archives. See further details in ``daml_lf.proto``. Required
+ +
+ +
+
+ submission_id + string + +
+ +
Unique submission identifier. Optional, defaults to a random identifier.
+ +
+ +
+
+ synchronizer_id + string + +
+ +
If synchronizer_id is set, the synchronizer with this ID will be used. If synchronizer_id is unset and the participant is only connected to a single synchronizer, that synchronizer will be used by default. If synchronizer_id is unset and the participant is connected to multiple synchronizers, the request will error out with PACKAGE_SERVICE_CANNOT_AUTODETECT_SYNCHRONIZER. Optional
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.admin.ValidateDarFileResponse

+ +

0 fields

+ +
+ + + + +
diff --git a/tests/fixtures/characterization/protobuf/expected/packages/com-daml-ledger-api-v2-interactive-transaction-v1.mdx b/tests/fixtures/characterization/protobuf/expected/packages/com-daml-ledger-api-v2-interactive-transaction-v1.mdx index b2ccbe8..23d0851 100644 --- a/tests/fixtures/characterization/protobuf/expected/packages/com-daml-ledger-api-v2-interactive-transaction-v1.mdx +++ b/tests/fixtures/characterization/protobuf/expected/packages/com-daml-ledger-api-v2-interactive-transaction-v1.mdx @@ -1,116 +1,531 @@ --- title: "com.daml.ledger.api.v2.interactive.transaction.v1" -description: "Descriptor-backed protobuf API history for package com.daml.ledger.api.v2.interactive.transaction.v1." +description: "Package-level overview for com.daml.ledger.api.v2.interactive.transaction.v1." --- -# Package `com.daml.ledger.api.v2.interactive.transaction.v1` +

Back to overview

-[Back to Canton Protobuf History](../index) +
+ +

Protobuf Package

+ + +

com.daml.ledger.api.v2.interactive.transaction.v1

+ + +

0 services, 0 endpoints, 5 messages

+ + +
+ + gRPC + +
-## Snapshot + +
+ +
+
Files
+
1
+
+ +
+
Services
+
0
+
+ +
+
Endpoints
+
0
+
+ +
+
Messages
+
5
+
+ +
+
Enums
+
0
+
+ +
+ +
-- Current files: `1` -- Current services: `0` -- Current endpoints: `0` -- Current messages: `5` -- Current enums: `0` -- Lifecycle endpoints tracked: `0` ## Source Files -| File | Services | Messages | Enums | Source | -| --- | --- | --- | --- | --- | -| community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/transaction/v1/interactive_submission_data.proto | `0` | `5` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/transaction/v1/interactive_submission_data.proto#L4) | - -## Type Reference - - -**Message `com.daml.ledger.api.v2.interactive.transaction.v1.Create`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/transaction/v1/interactive_submission_data.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/transaction/v1/interactive_submission_data.proto#L55) -- Fields: 7 - -Create Node - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| lf_version | `string` | optional | Specific LF version of the node | -| contract_id | `string` | optional | | -| package_name | `string` | optional | | -| template_id | `com.daml.ledger.api.v2.Identifier` | optional | The identifier uses the package-id reference format. | -| argument | `com.daml.ledger.api.v2.Value` | optional | | -| signatories | `string` | repeated | | -| stakeholders | `string` | repeated | | - - -**Message `com.daml.ledger.api.v2.interactive.transaction.v1.Exercise`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/transaction/v1/interactive_submission_data.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/transaction/v1/interactive_submission_data.proto#L34) -- Fields: 14 - -Exercise node - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| lf_version | `string` | optional | Specific LF version of the node | -| contract_id | `string` | optional | | -| package_name | `string` | optional | | -| template_id | `com.daml.ledger.api.v2.Identifier` | optional | The identifier uses the package-id reference format. | -| signatories | `string` | repeated | | -| stakeholders | `string` | repeated | | -| acting_parties | `string` | repeated | | -| interface_id | `com.daml.ledger.api.v2.Identifier` | optional | The identifier uses the package-id reference format. | -| choice_id | `string` | optional | | -| chosen_value | `com.daml.ledger.api.v2.Value` | optional | | -| consuming | `bool` | optional | | -| children | `string` | repeated | | -| exercise_result | `com.daml.ledger.api.v2.Value` | optional | | -| choice_observers | `string` | repeated | | - - -**Message `com.daml.ledger.api.v2.interactive.transaction.v1.Fetch`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/transaction/v1/interactive_submission_data.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/transaction/v1/interactive_submission_data.proto#L19) -- Fields: 8 - -Transaction Nodes - -Fetch node - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| lf_version | `string` | optional | Specific LF version of the node | -| contract_id | `string` | optional | | -| package_name | `string` | optional | | -| template_id | `com.daml.ledger.api.v2.Identifier` | optional | The identifier uses the package-id reference format. | -| signatories | `string` | repeated | | -| stakeholders | `string` | repeated | | -| acting_parties | `string` | repeated | | -| interface_id | `com.daml.ledger.api.v2.Identifier` | optional | Optional | - - -**Message `com.daml.ledger.api.v2.interactive.transaction.v1.Node`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/transaction/v1/interactive_submission_data.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/transaction/v1/interactive_submission_data.proto#L72) -- Fields: 4 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| create | [`com.daml.ledger.api.v2.interactive.transaction.v1.Create`](#type-com-daml-ledger-api-v2-interactive-transaction-v1-create) | optional | | -| fetch | [`com.daml.ledger.api.v2.interactive.transaction.v1.Fetch`](#type-com-daml-ledger-api-v2-interactive-transaction-v1-fetch) | optional | | -| exercise | [`com.daml.ledger.api.v2.interactive.transaction.v1.Exercise`](#type-com-daml-ledger-api-v2-interactive-transaction-v1-exercise) | optional | | -| rollback | [`com.daml.ledger.api.v2.interactive.transaction.v1.Rollback`](#type-com-daml-ledger-api-v2-interactive-transaction-v1-rollback) | optional | | - - -**Message `com.daml.ledger.api.v2.interactive.transaction.v1.Rollback`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/transaction/v1/interactive_submission_data.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/transaction/v1/interactive_submission_data.proto#L68) -- Fields: 1 - -Rollback Node - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| children | `string` | repeated | | + + + +
+ + +
+ +
+

community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/transaction/v1/interactive_submission_data.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
5
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/transaction/v1/interactive_submission_data.proto
+
+ +
+ + +
+ + +
+ + + + + +## Type Inventory + + +These are the package-level message and enum shapes in the publish-version snapshot. + + + + +
+
+

com.daml.ledger.api.v2.interactive.transaction.v1.Create

+ +

7 fields

+ +
+ +

Create Node

+ + +
+ +
+
+ lf_version + string + +
+ +
Specific LF version of the node
+ +
+ +
+
+ contract_id + string + +
+ +
+ +
+
+ package_name + string + +
+ +
+ +
+
+ template_id + Identifier + +
+ +
The identifier uses the package-id reference format.
+ +
+ +
+
+ argument + Value + +
+ +
+ +
+
+ signatories + repeated string + +
+ +
+ +
+
+ stakeholders + repeated string + +
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.interactive.transaction.v1.Exercise

+ +

14 fields

+ +
+ +

Exercise node

+ + +
+ +
+
+ lf_version + string + +
+ +
Specific LF version of the node
+ +
+ +
+
+ contract_id + string + +
+ +
+ +
+
+ package_name + string + +
+ +
+ +
+
+ template_id + Identifier + +
+ +
The identifier uses the package-id reference format.
+ +
+ +
+
+ signatories + repeated string + +
+ +
+ +
+
+ stakeholders + repeated string + +
+ +
+ +
+
+ acting_parties + repeated string + +
+ +
+ +
+
+ interface_id + Identifier + +
+ +
The identifier uses the package-id reference format.
+ +
+ +
+
+ choice_id + string + +
+ +
+ +
+
+ chosen_value + Value + +
+ +
+ +
+
+ consuming + bool + +
+ +
+ +
+
+ children + repeated string + +
+ +
+ +
+
+ exercise_result + Value + +
+ +
+ +
+
+ choice_observers + repeated string + +
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.interactive.transaction.v1.Fetch

+ +

8 fields

+ +
+ +

Transaction Nodes Fetch node

+ + +
+ +
+
+ lf_version + string + +
+ +
Specific LF version of the node
+ +
+ +
+
+ contract_id + string + +
+ +
+ +
+
+ package_name + string + +
+ +
+ +
+
+ template_id + Identifier + +
+ +
The identifier uses the package-id reference format.
+ +
+ +
+
+ signatories + repeated string + +
+ +
+ +
+
+ stakeholders + repeated string + +
+ +
+ +
+
+ acting_parties + repeated string + +
+ +
+ +
+
+ interface_id + Identifier + +
+ +
Optional
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.interactive.transaction.v1.Node

+ +

4 fields

+ +
+ + +
+ +
+
+ create + Create + +
+ +
+ +
+
+ fetch + Fetch + +
+ +
+ +
+
+ exercise + Exercise + +
+ +
+ +
+
+ rollback + Rollback + +
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.interactive.transaction.v1.Rollback

+ +

1 fields

+ +
+ +

Rollback Node

+ + +
+ +
+
+ children + repeated string + +
+ +
+ +
+ + + +
diff --git a/tests/fixtures/characterization/protobuf/expected/packages/com-daml-ledger-api-v2-interactive.mdx b/tests/fixtures/characterization/protobuf/expected/packages/com-daml-ledger-api-v2-interactive.mdx index b0cbe4d..3b0ba5a 100644 --- a/tests/fixtures/characterization/protobuf/expected/packages/com-daml-ledger-api-v2-interactive.mdx +++ b/tests/fixtures/characterization/protobuf/expected/packages/com-daml-ledger-api-v2-interactive.mdx @@ -1,39 +1,153 @@ --- title: "com.daml.ledger.api.v2.interactive" -description: "Descriptor-backed protobuf API history for package com.daml.ledger.api.v2.interactive." +description: "Package-level overview for com.daml.ledger.api.v2.interactive." --- -# Package `com.daml.ledger.api.v2.interactive` +

Back to overview

+ +
+ +

Protobuf Package

+ + +

com.daml.ledger.api.v2.interactive

+ + +

1 services, 6 endpoints, 28 messages, 1 enums

+ + +
+ + gRPC + +
+ + +
+ +
+
Files
+
2
+
+ +
+
Services
+
1
+
+ +
+
Endpoints
+
6
+
+ +
+
Messages
+
28
+
+ +
+
Enums
+
1
+
+ +
+ +
-[Back to Canton Protobuf History](../index) - -## Snapshot - -- Current files: `2` -- Current services: `1` -- Current endpoints: `6` -- Current messages: `28` -- Current enums: `1` -- Lifecycle endpoints tracked: `6` ## Source Files -| File | Services | Messages | Enums | Source | -| --- | --- | --- | --- | --- | -| community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_common_data.proto | `0` | `1` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_common_data.proto#L4) | -| community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto | `1` | `22` | `1` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto#L4) | -## Services -| Service | Endpoints | Source | Description | -| --- | --- | --- | --- | -| [`InteractiveSubmissionService`](#service-com-daml-ledger-api-v2-interactive-interactivesubmissionservice) | `6` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto#L31) | Service allowing interactive construction of command submissions The prepare and execute endpoints allow to submit co... | - -### Service `InteractiveSubmissionService` +
+ + +
+ +
+

community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_common_data.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
1
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_common_data.proto
+
+ +
+ + +
+ + + +
+ +
+

community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
22
+
+ +
+
Enums
+
1
+
+ +
+
Source
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto
+
+ +
+ + +
+ + +
+ + + + + +## InteractiveSubmissionService -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto#L31) -- Endpoints tracked: `6` Service allowing interactive construction of command submissions @@ -44,658 +158,3929 @@ Service allowing interactive construction of command submissions This gives callers the ability to sign the daml transaction with their own signing keys -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`ExecuteSubmission`](#endpoint-com-daml-ledger-api-v2-interactive-interactivesubmissionservice-executesubmission) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.interactive.ExecuteSubmissionRequest`](#type-com-daml-ledger-api-v2-interactive-executesubmissionrequest) | [`com.daml.ledger.api.v2.interactive.ExecuteSubmissionResponse`](#type-com-daml-ledger-api-v2-interactive-executesubmissionresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto#L36) | -| [`ExecuteSubmissionAndWait`](#endpoint-com-daml-ledger-api-v2-interactive-interactivesubmissionservice-executesubmissionandwait) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.interactive.ExecuteSubmissionAndWaitRequest`](#type-com-daml-ledger-api-v2-interactive-executesubmissionandwaitrequest) | [`com.daml.ledger.api.v2.interactive.ExecuteSubmissionAndWaitResponse`](#type-com-daml-ledger-api-v2-interactive-executesubmissionandwaitresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto#L40) | -| [`ExecuteSubmissionAndWaitForTransaction`](#endpoint-com-daml-ledger-api-v2-interactive-interactivesubmissionservice-executesubmissionandwaitfortransaction) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.interactive.ExecuteSubmissionAndWaitForTransactionRequest`](#type-com-daml-ledger-api-v2-interactive-executesubmissionandwaitfortransactionrequest) | [`com.daml.ledger.api.v2.interactive.ExecuteSubmissionAndWaitForTransactionResponse`](#type-com-daml-ledger-api-v2-interactive-executesubmissionandwaitfortransactionresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto#L44) | -| [`GetPreferredPackageVersion`](#endpoint-com-daml-ledger-api-v2-interactive-interactivesubmissionservice-getpreferredpackageversion) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.interactive.GetPreferredPackageVersionRequest`](#type-com-daml-ledger-api-v2-interactive-getpreferredpackageversionrequest) | [`com.daml.ledger.api.v2.interactive.GetPreferredPackageVersionResponse`](#type-com-daml-ledger-api-v2-interactive-getpreferredpackageversionresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto#L58) | -| [`GetPreferredPackages`](#endpoint-com-daml-ledger-api-v2-interactive-interactivesubmissionservice-getpreferredpackages) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.interactive.GetPreferredPackagesRequest`](#type-com-daml-ledger-api-v2-interactive-getpreferredpackagesrequest) | [`com.daml.ledger.api.v2.interactive.GetPreferredPackagesResponse`](#type-com-daml-ledger-api-v2-interactive-getpreferredpackagesresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto#L76) | -| [`PrepareSubmission`](#endpoint-com-daml-ledger-api-v2-interactive-interactivesubmissionservice-preparesubmission) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.interactive.PrepareSubmissionRequest`](#type-com-daml-ledger-api-v2-interactive-preparesubmissionrequest) | [`com.daml.ledger.api.v2.interactive.PrepareSubmissionResponse`](#type-com-daml-ledger-api-v2-interactive-preparesubmissionresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto#L33) | - - -**Endpoint `InteractiveSubmissionService.ExecuteSubmission`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto#L36) - -**Signature** - -```protobuf -rpc InteractiveSubmissionService.ExecuteSubmission(com.daml.ledger.api.v2.interactive.ExecuteSubmissionRequest) returns (com.daml.ledger.api.v2.interactive.ExecuteSubmissionResponse); -``` - -Execute a prepared submission _asynchronously_ on the ledger. - Requires a signature of the transaction from the submitting external party. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.interactive.ExecuteSubmissionRequest`](#type-com-daml-ledger-api-v2-interactive-executesubmissionrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.interactive.ExecuteSubmissionResponse`](#type-com-daml-ledger-api-v2-interactive-executesubmissionresponse) - - -**Endpoint `InteractiveSubmissionService.ExecuteSubmissionAndWait`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto#L40) - -**Signature** - -```protobuf -rpc InteractiveSubmissionService.ExecuteSubmissionAndWait(com.daml.ledger.api.v2.interactive.ExecuteSubmissionAndWaitRequest) returns (com.daml.ledger.api.v2.interactive.ExecuteSubmissionAndWaitResponse); -``` - -Similar to ExecuteSubmission but _synchronously_ wait for the completion of the transaction - IMPORTANT: Relying on the response from this endpoint requires trusting the Participant Node to be honest. - A malicious node could make a successfully committed request appeared failed and vice versa - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.interactive.ExecuteSubmissionAndWaitRequest`](#type-com-daml-ledger-api-v2-interactive-executesubmissionandwaitrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.interactive.ExecuteSubmissionAndWaitResponse`](#type-com-daml-ledger-api-v2-interactive-executesubmissionandwaitresponse) - - -**Endpoint `InteractiveSubmissionService.ExecuteSubmissionAndWaitForTransaction`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto#L44) - -**Signature** - -```protobuf -rpc InteractiveSubmissionService.ExecuteSubmissionAndWaitForTransaction(com.daml.ledger.api.v2.interactive.ExecuteSubmissionAndWaitForTransactionRequest) returns (com.daml.ledger.api.v2.interactive.ExecuteSubmissionAndWaitForTransactionResponse); -``` - -Similar to ExecuteSubmissionAndWait but additionally returns the transaction - IMPORTANT: Relying on the response from this endpoint requires trusting the Participant Node to be honest. - A malicious node could make a successfully committed request appear as failed and vice versa - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.interactive.ExecuteSubmissionAndWaitForTransactionRequest`](#type-com-daml-ledger-api-v2-interactive-executesubmissionandwaitfortransactionrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.interactive.ExecuteSubmissionAndWaitForTransactionResponse`](#type-com-daml-ledger-api-v2-interactive-executesubmissionandwaitfortransactionresponse) - - -**Endpoint `InteractiveSubmissionService.GetPreferredPackageVersion`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto#L58) - -**Signature** - -```protobuf -rpc InteractiveSubmissionService.GetPreferredPackageVersion(com.daml.ledger.api.v2.interactive.GetPreferredPackageVersionRequest) returns (com.daml.ledger.api.v2.interactive.GetPreferredPackageVersionResponse); -``` - -A preferred package is the highest-versioned package for a provided package-name - that is vetted by all the participants hosting the provided parties. - - Ledger API clients should use this endpoint for constructing command submissions - that are compatible with the provided preferred package, by making informed decisions on: - - which are the compatible packages that can be used to create contracts - - which contract or exercise choice argument version can be used in the command - - which choices can be executed on a template or interface of a contract - - Can be accessed by any Ledger API client with a valid token when Ledger API authorization is enabled. - - Provided for backwards compatibility, it will be removed in the Canton version 3.4.0 - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.interactive.GetPreferredPackageVersionRequest`](#type-com-daml-ledger-api-v2-interactive-getpreferredpackageversionrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.interactive.GetPreferredPackageVersionResponse`](#type-com-daml-ledger-api-v2-interactive-getpreferredpackageversionresponse) - - -**Endpoint `InteractiveSubmissionService.GetPreferredPackages`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto#L76) - -**Signature** - -```protobuf -rpc InteractiveSubmissionService.GetPreferredPackages(com.daml.ledger.api.v2.interactive.GetPreferredPackagesRequest) returns (com.daml.ledger.api.v2.interactive.GetPreferredPackagesResponse); -``` - -Compute the preferred packages for the vetting requirements in the request. - A preferred package is the highest-versioned package for a provided package-name - that is vetted by all the participants hosting the provided parties. - - Ledger API clients should use this endpoint for constructing command submissions - that are compatible with the provided preferred packages, by making informed decisions on: - - which are the compatible packages that can be used to create contracts - - which contract or exercise choice argument version can be used in the command - - which choices can be executed on a template or interface of a contract - - If the package preferences could not be computed due to no selection satisfying the requirements, - a `FAILED_PRECONDITION` error will be returned. - - Can be accessed by any Ledger API client with a valid token when Ledger API authorization is enabled. - - Experimental API: this endpoint is not guaranteed to provide backwards compatibility in future releases - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.interactive.GetPreferredPackagesRequest`](#type-com-daml-ledger-api-v2-interactive-getpreferredpackagesrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.interactive.GetPreferredPackagesResponse`](#type-com-daml-ledger-api-v2-interactive-getpreferredpackagesresponse) - - -**Endpoint `InteractiveSubmissionService.PrepareSubmission`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto#L33) - -**Signature** - -```protobuf -rpc InteractiveSubmissionService.PrepareSubmission(com.daml.ledger.api.v2.interactive.PrepareSubmissionRequest) returns (com.daml.ledger.api.v2.interactive.PrepareSubmissionResponse); -``` - -Requires `readAs` scope for the submitting party when LAPI User authorization is enabled - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.interactive.PrepareSubmissionRequest`](#type-com-daml-ledger-api-v2-interactive-preparesubmissionrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.interactive.PrepareSubmissionResponse`](#type-com-daml-ledger-api-v2-interactive-preparesubmissionresponse) - -## Type Reference - - -**Message `com.daml.ledger.api.v2.interactive.CostEstimation`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto#L96) -- Fields: 4 - -Estimation of the cost of submitting the prepared transaction - The estimation is done against the synchronizer chosen during preparation of the transaction - (or the one explicitly requested). - The cost of re-assigning contracts to another synchronizer when necessary is not included in the estimation. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| estimation_timestamp | `google.protobuf.Timestamp` | optional | Timestamp at which the estimation was made | -| confirmation_request_traffic_cost_estimation | `uint64` | optional | Estimated traffic cost of the confirmation request associated with the transaction | -| confirmation_response_traffic_cost_estimation | `uint64` | optional | Estimated traffic cost of the confirmation response associated with the transaction
This field can also be used as an indication of the cost that other potential confirming nodes
of the party will incur to approve or reject the transaction | -| total_traffic_cost_estimation | `uint64` | optional | Sum of the fields above | - - -**Message `com.daml.ledger.api.v2.interactive.CostEstimationHints`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto#L80) -- Fields: 2 - -Hints to improve cost estimation precision of a prepared transaction - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| disabled | `bool` | optional | Disable cost estimation
Default (not set) is false | -| expected_signatures | [`com.daml.ledger.api.v2.SigningAlgorithmSpec`](com-daml-ledger-api-v2#type-com-daml-ledger-api-v2-signingalgorithmspec) | repeated | Details on the keys that will be used to sign the transaction (how many and of which type).
Signature size impacts the cost of the transaction.
If empty, the signature sizes will be approximated with threshold-many signatures (where threshold is defined
in the PartyToKeyMapping of the external party), using keys in the order they are registered.
Optional (empty list is equivalent to not providing this field) | - - -**Message `com.daml.ledger.api.v2.interactive.DamlTransaction`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto#L526) -- Fields: 4 - -Daml Transaction. - This represents the effect on the ledger if this transaction is successfully committed. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| version | `string` | optional | serialization version, will be >= max(nodes version) | -| roots | `string` | repeated | Root nodes of the transaction | -| nodes | [`com.daml.ledger.api.v2.interactive.DamlTransaction.Node`](#type-com-daml-ledger-api-v2-interactive-damltransaction-node) | repeated | List of nodes in the transaction | -| node_seeds | [`com.daml.ledger.api.v2.interactive.DamlTransaction.NodeSeed`](#type-com-daml-ledger-api-v2-interactive-damltransaction-nodeseed) | repeated | Node seeds are values associated with certain nodes used for generating cryptographic salts | - - -**Message `com.daml.ledger.api.v2.interactive.DamlTransaction.NodeSeed`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto#L527) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| node_id | `int32` | optional | | -| seed | `bytes` | optional | | - - -**Message `com.daml.ledger.api.v2.interactive.DamlTransaction.Node`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto#L535) -- Fields: 2 - -A transaction may contain nodes with different versions. - Each node must be hashed using the hashing algorithm corresponding to its specific version. - [docs-entry-start: DamlTransaction.Node] - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| node_id | `string` | optional | | -| v1 | [`com.daml.ledger.api.v2.interactive.transaction.v1.Node`](com-daml-ledger-api-v2-interactive-transaction-v1#type-com-daml-ledger-api-v2-interactive-transaction-v1-node) | optional | Start at 1000 so we can add more fields before if necessary
When new versions will be added, they will show here | - - -**Message `com.daml.ledger.api.v2.interactive.ExecuteSubmissionAndWaitForTransactionRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto#L361) -- Fields: 9 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| prepared_transaction | [`com.daml.ledger.api.v2.interactive.PreparedTransaction`](#type-com-daml-ledger-api-v2-interactive-preparedtransaction) | optional | the prepared transaction
Typically this is the value of the `prepared_transaction` field in `PrepareSubmissionResponse`
obtained from calling `prepareSubmission`.
Required | -| party_signatures | [`com.daml.ledger.api.v2.interactive.PartySignatures`](#type-com-daml-ledger-api-v2-interactive-partysignatures) | optional | The party(ies) signatures that authorize the prepared submission to be executed by this node.
Each party can provide one or more signatures..
and one or more parties can sign.
Note that currently, only single party submissions are supported.
Required | -| deduplication_duration | `google.protobuf.Duration` | optional | Specifies the length of the deduplication period.
It is interpreted relative to the local clock at some point during the submission's processing.
Must be non-negative. Must not exceed the maximum deduplication time. | -| deduplication_offset | `int64` | optional | Specifies the start of the deduplication period by a completion stream offset (exclusive).
Must be a valid absolute offset (positive integer). | -| submission_id | `string` | optional | A unique identifier to distinguish completions for different submissions with the same change ID.
Typically a random UUID. Applications are expected to use a different UUID for each retry of a submission
with the same change ID.
Must be a valid LedgerString (as described in ``value.proto``).

Required | -| user_id | `string` | optional | See [PrepareSubmissionRequest.user_id]
Optional | -| hashing_scheme_version | [`com.daml.ledger.api.v2.interactive.HashingSchemeVersion`](#type-com-daml-ledger-api-v2-interactive-hashingschemeversion) | optional | The hashing scheme version used when building the hash
Required | -| min_ledger_time | [`com.daml.ledger.api.v2.interactive.MinLedgerTime`](#type-com-daml-ledger-api-v2-interactive-minledgertime) | optional | If set will influence the chosen ledger effective time but will not result in a submission delay so any override
should be scheduled to executed within the window allowed by synchronizer.
Optional | -| transaction_format | [`com.daml.ledger.api.v2.TransactionFormat`](com-daml-ledger-api-v2#type-com-daml-ledger-api-v2-transactionformat) | optional | If no ``transaction_format`` is provided, a default will be used where ``transaction_shape`` is set to
TRANSACTION_SHAPE_ACS_DELTA, ``event_format`` is defined with ``filters_by_party`` containing wildcard-template
filter for all original ``act_as`` and ``read_as`` parties and the ``verbose`` flag is set.
When the ``transaction_shape`` TRANSACTION_SHAPE_ACS_DELTA shape is used (explicitly or is defaulted to as explained above),
events will only be returned if the submitting party is hosted on this node.
Optional | - - -**Message `com.daml.ledger.api.v2.interactive.ExecuteSubmissionAndWaitForTransactionResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto#L419) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| transaction | [`com.daml.ledger.api.v2.Transaction`](com-daml-ledger-api-v2#type-com-daml-ledger-api-v2-transaction) | optional | The transaction that resulted from the submitted command.
The transaction might contain no events (request conditions result in filtering out all of them).
Required | - - -**Message `com.daml.ledger.api.v2.interactive.ExecuteSubmissionAndWaitRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto#L300) -- Fields: 8 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| prepared_transaction | [`com.daml.ledger.api.v2.interactive.PreparedTransaction`](#type-com-daml-ledger-api-v2-interactive-preparedtransaction) | optional | the prepared transaction
Typically this is the value of the `prepared_transaction` field in `PrepareSubmissionResponse`
obtained from calling `prepareSubmission`.
Required | -| party_signatures | [`com.daml.ledger.api.v2.interactive.PartySignatures`](#type-com-daml-ledger-api-v2-interactive-partysignatures) | optional | The party(ies) signatures that authorize the prepared submission to be executed by this node.
Each party can provide one or more signatures..
and one or more parties can sign.
Note that currently, only single party submissions are supported.
Required | -| deduplication_duration | `google.protobuf.Duration` | optional | Specifies the length of the deduplication period.
It is interpreted relative to the local clock at some point during the submission's processing.
Must be non-negative. Must not exceed the maximum deduplication time. | -| deduplication_offset | `int64` | optional | Specifies the start of the deduplication period by a completion stream offset (exclusive).
Must be a valid absolute offset (positive integer). | -| submission_id | `string` | optional | A unique identifier to distinguish completions for different submissions with the same change ID.
Typically a random UUID. Applications are expected to use a different UUID for each retry of a submission
with the same change ID.
Must be a valid LedgerString (as described in ``value.proto``).

Required | -| user_id | `string` | optional | See [PrepareSubmissionRequest.user_id]
Optional | -| hashing_scheme_version | [`com.daml.ledger.api.v2.interactive.HashingSchemeVersion`](#type-com-daml-ledger-api-v2-interactive-hashingschemeversion) | optional | The hashing scheme version used when building the hash
Required | -| min_ledger_time | [`com.daml.ledger.api.v2.interactive.MinLedgerTime`](#type-com-daml-ledger-api-v2-interactive-minledgertime) | optional | If set will influence the chosen ledger effective time but will not result in a submission delay so any override
should be scheduled to executed within the window allowed by synchronizer.
Optional | - - -**Message `com.daml.ledger.api.v2.interactive.ExecuteSubmissionAndWaitResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto#L350) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| update_id | `string` | optional | The id of the transaction that resulted from the submitted command.
Must be a valid LedgerString (as described in ``value.proto``).
Required | -| completion_offset | `int64` | optional | The details of the offset field are described in ``community/ledger-api/README.md``.
Required | - - -**Message `com.daml.ledger.api.v2.interactive.ExecuteSubmissionRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto#L248) -- Fields: 8 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| prepared_transaction | [`com.daml.ledger.api.v2.interactive.PreparedTransaction`](#type-com-daml-ledger-api-v2-interactive-preparedtransaction) | optional | the prepared transaction
Typically this is the value of the `prepared_transaction` field in `PrepareSubmissionResponse`
obtained from calling `prepareSubmission`.
Required | -| party_signatures | [`com.daml.ledger.api.v2.interactive.PartySignatures`](#type-com-daml-ledger-api-v2-interactive-partysignatures) | optional | The party(ies) signatures that authorize the prepared submission to be executed by this node.
Each party can provide one or more signatures..
and one or more parties can sign.
Note that currently, only single party submissions are supported.
Required | -| deduplication_duration | `google.protobuf.Duration` | optional | Specifies the length of the deduplication period.
It is interpreted relative to the local clock at some point during the submission's processing.
Must be non-negative. Must not exceed the maximum deduplication time. | -| deduplication_offset | `int64` | optional | Specifies the start of the deduplication period by a completion stream offset (exclusive).
Must be a valid absolute offset (positive integer). | -| submission_id | `string` | optional | A unique identifier to distinguish completions for different submissions with the same change ID.
Typically a random UUID. Applications are expected to use a different UUID for each retry of a submission
with the same change ID.
Must be a valid LedgerString (as described in ``value.proto``).

Required | -| user_id | `string` | optional | See [PrepareSubmissionRequest.user_id]
Optional | -| hashing_scheme_version | [`com.daml.ledger.api.v2.interactive.HashingSchemeVersion`](#type-com-daml-ledger-api-v2-interactive-hashingschemeversion) | optional | The hashing scheme version used when building the hash
Required | -| min_ledger_time | [`com.daml.ledger.api.v2.interactive.MinLedgerTime`](#type-com-daml-ledger-api-v2-interactive-minledgertime) | optional | If set will influence the chosen ledger effective time but will not result in a submission delay so any override
should be scheduled to executed within the window allowed by synchronizer.
Optional | - - -**Message `com.daml.ledger.api.v2.interactive.ExecuteSubmissionResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto#L298) -- Fields: 0 - -_No description._ - - -**Message `com.daml.ledger.api.v2.interactive.GetPreferredPackageVersionRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto#L557) -- Fields: 4 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| parties | `string` | repeated | The parties whose participants' vetting state should be considered when resolving the preferred package.
Required | -| package_name | `string` | optional | The package-name for which the preferred package should be resolved.
Required | -| synchronizer_id | `string` | optional | The synchronizer whose vetting state should be used for resolving this query.
If not specified, the vetting states of all synchronizers to which the participant is connected are used.
Optional | -| vetting_valid_at | `google.protobuf.Timestamp` | optional | The timestamp at which the package vetting validity should be computed
on the latest topology snapshot as seen by the participant.
If not provided, the participant's current clock time is used.
Optional | - - -**Message `com.daml.ledger.api.v2.interactive.GetPreferredPackageVersionResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto#L577) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| package_preference | [`com.daml.ledger.api.v2.interactive.PackagePreference`](#type-com-daml-ledger-api-v2-interactive-packagepreference) | optional | Not populated when no preferred package is found
Optional | - - -**Message `com.daml.ledger.api.v2.interactive.GetPreferredPackagesRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto#L605) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| package_vetting_requirements | [`com.daml.ledger.api.v2.interactive.PackageVettingRequirement`](#type-com-daml-ledger-api-v2-interactive-packagevettingrequirement) | repeated | The package-name vetting requirements for which the preferred packages should be resolved.

Generally it is enough to provide the requirements for the intended command's root package-names.
Additional package-name requirements can be provided when additional Daml transaction informees need to use
package dependencies of the command's root packages.

Required | -| synchronizer_id | `string` | optional | The synchronizer whose vetting state should be used for resolving this query.
If not specified, the vetting states of all synchronizers to which the participant is connected are used.
Optional | -| vetting_valid_at | `google.protobuf.Timestamp` | optional | The timestamp at which the package vetting validity should be computed
on the latest topology snapshot as seen by the participant.
If not provided, the participant's current clock time is used.
Optional | - - -**Message `com.daml.ledger.api.v2.interactive.GetPreferredPackagesResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto#L627) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| package_references | [`com.daml.ledger.api.v2.PackageReference`](com-daml-ledger-api-v2#type-com-daml-ledger-api-v2-packagereference) | repeated | The package references of the preferred packages.
Must contain one package reference for each requested package-name.

If you build command submissions whose content depends on the returned
preferred packages, then we recommend submitting the preferred package-ids
in the ``package_id_selection_preference`` of the command submission to
avoid race conditions with concurrent changes of the on-ledger package vetting state.

Required | -| synchronizer_id | `string` | optional | The synchronizer for which the package preferences are computed.
If the synchronizer_id was specified in the request, then it matches the request synchronizer_id.
Required | - - -**Message `com.daml.ledger.api.v2.interactive.GlobalKey`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_common_data.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_common_data.proto#L14) -- Fields: 4 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| template_id | `com.daml.ledger.api.v2.Identifier` | optional | The identifier uses the package-id reference format. | -| package_name | `string` | optional | | -| key | `com.daml.ledger.api.v2.Value` | optional | | -| hash | `bytes` | optional | | - - -**Message `com.daml.ledger.api.v2.interactive.Metadata`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto#L459) -- Fields: 10 - -Transaction Metadata - Refer to the hashing documentation for information on how it should be hashed. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| submitter_info | [`com.daml.ledger.api.v2.interactive.Metadata.SubmitterInfo`](#type-com-daml-ledger-api-v2-interactive-metadata-submitterinfo) | optional | | -| synchronizer_id | `string` | optional | | -| mediator_group | `uint32` | optional | | -| transaction_uuid | `string` | optional | | -| preparation_time | `uint64` | optional | | -| input_contracts | [`com.daml.ledger.api.v2.interactive.Metadata.InputContract`](#type-com-daml-ledger-api-v2-interactive-metadata-inputcontract) | repeated | | -| min_ledger_effective_time | `uint64` | optional | Where ledger time constraints are imposed during the execution of the contract they will be populated
in the fields below. These are optional because if the transaction does NOT depend on time, these values
do not need to be set.
The final ledger effective time used will be chosen when the command is submitted through the [execute] RPC.
If the ledger effective time is outside of any populated min/max bounds then a different transaction
can result, that will cause a confirmation message rejection. | -| max_ledger_effective_time | `uint64` | optional | | -| global_key_mapping | [`com.daml.ledger.api.v2.interactive.Metadata.GlobalKeyMappingEntry`](#type-com-daml-ledger-api-v2-interactive-metadata-globalkeymappingentry) | repeated | **********************************************************

** Metadata information that does NOT need to be signed **

**********************************************************

Contextual information needed to process the transaction but not signed, either because it's already indirectly
signed by signing the transaction, or because it doesn't impact the ledger state | -| max_record_time | `uint64` | optional | Maximum timestamp at which the transaction can be recorded onto the ledger via the synchronizer `synchronizer_id`.
If submitted after it will be rejected even if otherwise valid, in which case it needs to be prepared and signed again
with a new valid max_record_time.
Unsigned in 3.3 to avoid a breaking protocol change
Will be signed in 3.4+
Set max_record_time in the PreparedTransactionRequest to get this field set accordingly | - - -**Message `com.daml.ledger.api.v2.interactive.Metadata.SubmitterInfo`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto#L460) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| act_as | `string` | repeated | | -| command_id | `string` | optional | | - - -**Message `com.daml.ledger.api.v2.interactive.Metadata.GlobalKeyMappingEntry`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto#L465) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| key | [`com.daml.ledger.api.v2.interactive.GlobalKey`](#type-com-daml-ledger-api-v2-interactive-globalkey) | optional | | -| value | `com.daml.ledger.api.v2.Value` | optional | | - - -**Message `com.daml.ledger.api.v2.interactive.Metadata.InputContract`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto#L470) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| v1 | [`com.daml.ledger.api.v2.interactive.transaction.v1.Create`](com-daml-ledger-api-v2-interactive-transaction-v1#type-com-daml-ledger-api-v2-interactive-transaction-v1-create) | optional | When new versions will be added, they will show here | -| created_at | `uint64` | optional | | -| event_blob | `bytes` | optional | | - - -**Message `com.daml.ledger.api.v2.interactive.MinLedgerTime`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto#L426) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| min_ledger_time_abs | `google.protobuf.Timestamp` | optional | Lower bound for the ledger time assigned to the resulting transaction.
The ledger time of a transaction is assigned as part of command interpretation.
Important note: for interactive submissions, if the transaction depends on time, it **must** be signed
and submitted within a time window around the ledger time assigned to the transaction during the prepare method.
The time delta around that ledger time is a configuration of the ledger, usually short, around 1 minute.
If however the transaction does not depend on time, the available time window to sign and submit the transaction is bound
by the preparation time, which is also assigned in the "prepare" step (this request),
but can be configured with a much larger skew, allowing for more time to sign the request (in the order of hours).
Must not be set at the same time as min_ledger_time_rel.
Optional | -| min_ledger_time_rel | `google.protobuf.Duration` | optional | Same as min_ledger_time_abs, but specified as a duration, starting from the time this request is received by the server.
Must not be set at the same time as min_ledger_time_abs.
Optional | - - -**Message `com.daml.ledger.api.v2.interactive.PackagePreference`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto#L583) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| package_reference | [`com.daml.ledger.api.v2.PackageReference`](com-daml-ledger-api-v2#type-com-daml-ledger-api-v2-packagereference) | optional | The package reference of the preferred package.
Required | -| synchronizer_id | `string` | optional | The synchronizer for which the preferred package was computed.
If the synchronizer_id was specified in the request, then it matches the request synchronizer_id.
Required | - - -**Message `com.daml.ledger.api.v2.interactive.PackageVettingRequirement`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto#L595) -- Fields: 2 - -Defines a package-name for which the commonly vetted package with the highest version must be found. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| parties | `string` | repeated | The parties whose participants' vetting state should be considered when resolving the preferred package.
Required | -| package_name | `string` | optional | The package-name for which the preferred package should be resolved.
Required | - - -**Message `com.daml.ledger.api.v2.interactive.PartySignatures`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto#L242) -- Fields: 1 - -Additional signatures provided by the submitting parties - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| signatures | [`com.daml.ledger.api.v2.interactive.SinglePartySignatures`](#type-com-daml-ledger-api-v2-interactive-singlepartysignatures) | repeated | Additional signatures provided by all individual parties
Required | - - -**Message `com.daml.ledger.api.v2.interactive.PrepareSubmissionRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto#L109) -- Fields: 13 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| user_id | `string` | optional | Uniquely identifies the participant user that prepares the transaction.
Must be a valid UserIdString (as described in ``value.proto``).
Required unless authentication is used with a user token.
In that case, the token's user-id will be used for the request's user_id.
Optional | -| command_id | `string` | optional | Uniquely identifies the command.
The triple (user_id, act_as, command_id) constitutes the change ID for the intended ledger change,
where act_as is interpreted as a set of party names.
The change ID can be used for matching the intended ledger changes with all their completions.
Must be a valid LedgerString (as described in ``value.proto``).
Required | -| commands | [`com.daml.ledger.api.v2.Command`](com-daml-ledger-api-v2#type-com-daml-ledger-api-v2-command) | repeated | Individual elements of this atomic command. Must be non-empty.
Limitation: Only single command transaction are currently supported by the API.
The field is marked as repeated in preparation for future support of multiple commands.
Required | -| min_ledger_time | [`com.daml.ledger.api.v2.interactive.MinLedgerTime`](#type-com-daml-ledger-api-v2-interactive-minledgertime) | optional | Optional | -| max_record_time | `google.protobuf.Timestamp` | optional | Maximum timestamp at which the transaction can be recorded onto the ledger via the synchronizer specified in the `PrepareSubmissionResponse`.
If submitted after it will be rejected even if otherwise valid, in which case it needs to be prepared and signed again
with a new valid max_record_time.
Use this to limit the time-to-life of a prepared transaction,
which is useful to know when it can definitely not be accepted
anymore and resorting to preparing another transaction for the same
intent is safe again.
Optional | -| act_as | `string` | repeated | Set of parties on whose behalf the command should be executed, if submitted.
If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request
to **read** (not act) on behalf of each of the given parties. This is because this RPC merely prepares a transaction
and does not execute it. Therefore read authorization is sufficient even for actAs parties.
Note: This may change, and more specific authorization scope may be introduced in the future.
Each element must be a valid PartyIdString (as described in ``value.proto``).
Required, must be non-empty. | -| read_as | `string` | repeated | Set of parties on whose behalf (in addition to all parties listed in ``act_as``) contracts can be retrieved.
This affects Daml operations such as ``fetch``, ``fetchByKey``, ``lookupByKey``, ``exercise``, and ``exerciseByKey``.
Note: A command can only use contracts that are visible to at least
one of the parties in ``act_as`` or ``read_as``. This visibility check is independent from the Daml authorization
rules for fetch operations.
If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request
to read contract data on behalf of each of the given parties.
Optional | -| disclosed_contracts | [`com.daml.ledger.api.v2.DisclosedContract`](com-daml-ledger-api-v2#type-com-daml-ledger-api-v2-disclosedcontract) | repeated | Additional contracts used to resolve contract & contract key lookups.
Optional | -| synchronizer_id | `string` | optional | Must be a valid synchronizer id
If not set, a suitable synchronizer that this node is connected to will be chosen
Optional | -| package_id_selection_preference | `string` | repeated | The package-id selection preference of the client for resolving
package names and interface instances in command submission and interpretation
Optional | -| verbose_hashing | `bool` | optional | When true, the response will contain additional details on how the transaction was encoded and hashed
This can be useful for troubleshooting of hash mismatches. Should only be used for debugging.
Optional, default to false | -| prefetch_contract_keys | [`com.daml.ledger.api.v2.PrefetchContractKey`](com-daml-ledger-api-v2#type-com-daml-ledger-api-v2-prefetchcontractkey) | repeated | Fetches the contract keys into the caches to speed up the command processing.
Should only contain contract keys that are expected to be resolved during interpretation of the commands.
Keys of disclosed contracts do not need prefetching.

Optional | -| estimate_traffic_cost | [`com.daml.ledger.api.v2.interactive.CostEstimationHints`](#type-com-daml-ledger-api-v2-interactive-costestimationhints) | optional | Hints to improve the accuracy of traffic cost estimation.
The estimation logic assumes that this node will be used for the execution of the transaction
If another node is used instead, the estimation may be less precise.
Request amplification is not accounted for in the estimation: each amplified request will
result in the cost of the confirmation request to be charged additionally.

Optional - Traffic cost estimation is enabled by default if this field is not set
To turn off cost estimation, set the CostEstimationHints#disabled field to true | - - -**Message `com.daml.ledger.api.v2.interactive.PrepareSubmissionResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto#L209) -- Fields: 5 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| prepared_transaction | [`com.daml.ledger.api.v2.interactive.PreparedTransaction`](#type-com-daml-ledger-api-v2-interactive-preparedtransaction) | optional | The interpreted transaction, it represents the ledger changes necessary to execute the commands specified in the request.
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. | -| prepared_transaction_hash | `bytes` | optional | Hash of the transaction, this is what needs to be signed by the party to authorize the transaction.
Only provided for convenience, clients MUST recompute the hash from the raw transaction if the preparing participant is not trusted.
May be removed in future versions | -| hashing_scheme_version | [`com.daml.ledger.api.v2.interactive.HashingSchemeVersion`](#type-com-daml-ledger-api-v2-interactive-hashingschemeversion) | optional | The hashing scheme version used when building the hash | -| hashing_details | `string` | optional | Optional additional details on how the transaction was encoded and hashed. Only set if verbose_hashing = true in the request
Note that there are no guarantees on the stability of the format or content of this field.
Its content should NOT be parsed and should only be used for troubleshooting purposes. | -| cost_estimation | [`com.daml.ledger.api.v2.interactive.CostEstimation`](#type-com-daml-ledger-api-v2-interactive-costestimation) | optional | Traffic cost estimation of the prepared transaction
Optional | - - -**Message `com.daml.ledger.api.v2.interactive.PreparedTransaction`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto#L450) -- Fields: 2 - -* - Prepared Transaction Message - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| transaction | [`com.daml.ledger.api.v2.interactive.DamlTransaction`](#type-com-daml-ledger-api-v2-interactive-damltransaction) | optional | Daml Transaction representing the ledger effect if executed. See below | -| metadata | [`com.daml.ledger.api.v2.interactive.Metadata`](#type-com-daml-ledger-api-v2-interactive-metadata) | optional | Metadata context necessary to execute the transaction | - - -**Message `com.daml.ledger.api.v2.interactive.SinglePartySignatures`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto#L232) -- Fields: 2 - -Signatures provided by a single party - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| party | `string` | optional | Submitting party
Required | -| signatures | [`com.daml.ledger.api.v2.Signature`](com-daml-ledger-api-v2#type-com-daml-ledger-api-v2-signature) | repeated | Signatures
Required | - - -**Enum `com.daml.ledger.api.v2.interactive.HashingSchemeVersion`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto#L202) - -[docs-entry-start: HashingSchemeVersion] - The hashing scheme version used when building the hash of the PreparedTransaction -| Name | Number | -| --- | --- | -| HASHING_SCHEME_VERSION_UNSPECIFIED | `0` | -| HASHING_SCHEME_VERSION_V2 | `2` | +
+ +
+
Source file
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto
+
+ +
+
Operations
+
6
+
+ +
+ + +
+ + + + +
+

InteractiveSubmissionService.ExecuteSubmission

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Execute a prepared submission _asynchronously_ on the ledger. Requires a signature of the transaction from the submitting external party.

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.interactive.ExecuteSubmissionRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.interactive.ExecuteSubmissionResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

InteractiveSubmissionService.ExecuteSubmissionAndWait

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Similar to ExecuteSubmission but _synchronously_ wait for the completion of the transaction IMPORTANT: Relying on the response from this endpoint requires trusting the Participa...

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.interactive.ExecuteSubmissionAndWaitRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.interactive.ExecuteSubmissionAndWaitResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

InteractiveSubmissionService.ExecuteSubmissionAndWaitForTransaction

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Similar to ExecuteSubmissionAndWait but additionally returns the transaction IMPORTANT: Relying on the response from this endpoint requires trusting the Participant Node to be h...

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.interactive.ExecuteSubmissionAndWaitForTransactionRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.interactive.ExecuteSubmissionAndWaitForTransactionResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

InteractiveSubmissionService.GetPreferredPackageVersion

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

A preferred package is the highest-versioned package for a provided package-name that is vetted by all the participants hosting the provided parties. Ledger API clients should u...

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.interactive.GetPreferredPackageVersionRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.interactive.GetPreferredPackageVersionResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

InteractiveSubmissionService.GetPreferredPackages

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Compute the preferred packages for the vetting requirements in the request. A preferred package is the highest-versioned package for a provided package-name that is vetted by al...

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.interactive.GetPreferredPackagesRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.interactive.GetPreferredPackagesResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

InteractiveSubmissionService.PrepareSubmission

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Requires `readAs` scope for the submitting party when LAPI User authorization is enabled

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.interactive.PrepareSubmissionRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.interactive.PrepareSubmissionResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## Type Inventory + + +These are the package-level message and enum shapes in the publish-version snapshot. + + + + +
+
+

com.daml.ledger.api.v2.interactive.CostEstimation

+ +

4 fields

+ +
+ +

Estimation of the cost of submitting the prepared transaction The estimation is done against the synchronizer chosen during preparation of the transaction (or the one explicitly requested). The cost of re-assigning contracts to another synchronizer when necessary is not included in the estimation.

+ + +
+ +
+
+ estimation_timestamp + Timestamp + +
+ +
Timestamp at which the estimation was made
+ +
+ +
+
+ confirmation_request_traffic_cost_estimation + uint64 + +
+ +
Estimated traffic cost of the confirmation request associated with the transaction
+ +
+ +
+
+ confirmation_response_traffic_cost_estimation + uint64 + +
+ +
Estimated traffic cost of the confirmation response associated with the transaction This field can also be used as an indication of the cost that other potential confirming nodes of the party will incur to approve or reject the transaction
+ +
+ +
+
+ total_traffic_cost_estimation + uint64 + +
+ +
Sum of the fields above
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.interactive.CostEstimationHints

+ +

2 fields

+ +
+ +

Hints to improve cost estimation precision of a prepared transaction

+ + +
+ +
+
+ disabled + bool + +
+ +
Disable cost estimation Default (not set) is false
+ +
+ +
+
+ expected_signatures + repeated SigningAlgorithmSpec + +
+ +
Details on the keys that will be used to sign the transaction (how many and of which type). Signature size impacts the cost of the transaction. If empty, the signature sizes will be approximated with threshold-many signatures (where threshold is defined in the PartyToKeyMapping of the external party), using keys in the order they are registered. Optional (empty list is equivalent to not providing this field)
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.SigningAlgorithmSpec

+ +

4 values

+ +
+ + + +
    + +
  • SIGNING_ALGORITHM_SPEC_UNSPECIFIED
    • + +
  • SIGNING_ALGORITHM_SPEC_ED25519
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_256
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_384
    • + +
+ + +
+ +
+
+

com.daml.ledger.api.v2.interactive.DamlTransaction

+ +

4 fields

+ +
+ +

Daml Transaction. This represents the effect on the ledger if this transaction is successfully committed.

+ + +
+ +
+
+ version + string + +
+ +
serialization version, will be >= max(nodes version)
+ +
+ +
+
+ roots + repeated string + +
+ +
Root nodes of the transaction
+ +
+ +
+
+ nodes + repeated Node + +
+ +
List of nodes in the transaction
+ +
+ +
+
+ node_seeds + repeated NodeSeed + +
+ +
Node seeds are values associated with certain nodes used for generating cryptographic salts
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.interactive.DamlTransaction.NodeSeed

+ +

2 fields

+ +
+ + +
+ +
+
+ node_id + int32 + +
+ +
+ +
+
+ seed + bytes + +
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.interactive.DamlTransaction.Node

+ +

2 fields

+ +
+ +

A transaction may contain nodes with different versions. Each node must be hashed using the hashing algorithm corresponding to its specific version. [docs-entry-start: DamlTransaction.Node]

+ + +
+ +
+
+ node_id + string + +
+ +
+ +
+
+ v1 + Node + +
+ +
Start at 1000 so we can add more fields before if necessary When new versions will be added, they will show here
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.interactive.transaction.v1.Node

+ +

4 fields

+ +
+ + +
+ +
+
+ create + Create + +
+ +
+ +
+
+ fetch + Fetch + +
+ +
+ +
+
+ exercise + Exercise + +
+ +
+ +
+
+ rollback + Rollback + +
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.interactive.transaction.v1.Create

+ +

7 fields

+ +
+ +

Create Node

+ + +
+ +
+
+ lf_version + string + +
+ +
Specific LF version of the node
+ +
+ +
+
+ contract_id + string + +
+ +
+ +
+
+ package_name + string + +
+ +
+ +
+
+ template_id + Identifier + +
+ +
The identifier uses the package-id reference format.
+ +
+ +
+
+ argument + Value + +
+ +
+ +
+
+ signatories + repeated string + +
+ +
+ +
+
+ stakeholders + repeated string + +
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.interactive.transaction.v1.Fetch

+ +

8 fields

+ +
+ +

Transaction Nodes Fetch node

+ + +
+ +
+
+ lf_version + string + +
+ +
Specific LF version of the node
+ +
+ +
+
+ contract_id + string + +
+ +
+ +
+
+ package_name + string + +
+ +
+ +
+
+ template_id + Identifier + +
+ +
The identifier uses the package-id reference format.
+ +
+ +
+
+ signatories + repeated string + +
+ +
+ +
+
+ stakeholders + repeated string + +
+ +
+ +
+
+ acting_parties + repeated string + +
+ +
+ +
+
+ interface_id + Identifier + +
+ +
Optional
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.interactive.transaction.v1.Exercise

+ +

14 fields

+ +
+ +

Exercise node

+ + +
+ +
+
+ lf_version + string + +
+ +
Specific LF version of the node
+ +
+ +
+
+ contract_id + string + +
+ +
+ +
+
+ package_name + string + +
+ +
+ +
+
+ template_id + Identifier + +
+ +
The identifier uses the package-id reference format.
+ +
+ +
+
+ signatories + repeated string + +
+ +
+ +
+
+ stakeholders + repeated string + +
+ +
+ +
+
+ acting_parties + repeated string + +
+ +
+ +
+
+ interface_id + Identifier + +
+ +
The identifier uses the package-id reference format.
+ +
+ +
+
+ choice_id + string + +
+ +
+ +
+
+ chosen_value + Value + +
+ +
+ +
+
+ consuming + bool + +
+ +
+ +
+
+ children + repeated string + +
+ +
+ +
+
+ exercise_result + Value + +
+ +
+ +
+
+ choice_observers + repeated string + +
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.interactive.transaction.v1.Rollback

+ +

1 fields

+ +
+ +

Rollback Node

+ + +
+ +
+
+ children + repeated string + +
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.interactive.ExecuteSubmissionAndWaitForTransactionRequest

+ +

9 fields

+ +
+ + +
+ +
+
+ prepared_transaction + PreparedTransaction + +
+ +
the prepared transaction Typically this is the value of the `prepared_transaction` field in `PrepareSubmissionResponse` obtained from calling `prepareSubmission`. Required
+ +
+ +
+
+ party_signatures + PartySignatures + +
+ +
The party(ies) signatures that authorize the prepared submission to be executed by this node. Each party can provide one or more signatures.. and one or more parties can sign. Note that currently, only single party submissions are supported. Required
+ +
+ +
+
+ deduplication_duration + Duration + +
+ +
Specifies the length of the deduplication period. It is interpreted relative to the local clock at some point during the submission's processing. Must be non-negative. Must not exceed the maximum deduplication time.
+ +
+ +
+
+ deduplication_offset + int64 + +
+ +
Specifies the start of the deduplication period by a completion stream offset (exclusive). Must be a valid absolute offset (positive integer).
+ +
+ +
+
+ submission_id + string + +
+ +
A unique identifier to distinguish completions for different submissions with the same change ID. Typically a random UUID. Applications are expected to use a different UUID for each retry of a submission with the same change ID. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ user_id + string + +
+ +
See [PrepareSubmissionRequest.user_id] Optional
+ +
+ +
+
+ hashing_scheme_version + HashingSchemeVersion + +
+ +
The hashing scheme version used when building the hash Required
+ +
+ +
+
+ min_ledger_time + MinLedgerTime + +
+ +
If set will influence the chosen ledger effective time but will not result in a submission delay so any override should be scheduled to executed within the window allowed by synchronizer. Optional
+ +
+ +
+
+ transaction_format + TransactionFormat + +
+ +
If no ``transaction_format`` is provided, a default will be used where ``transaction_shape`` is set to TRANSACTION_SHAPE_ACS_DELTA, ``event_format`` is defined with ``filters_by_party`` containing wildcard-template filter for all original ``act_as`` and ``read_as`` parties and the ``verbose`` flag is set. When the ``transaction_shape`` TRANSACTION_SHAPE_ACS_DELTA shape is used (explicitly or is defaulted to as explained above), events will only be returned if the submitting party is hosted on this node. Optional
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.interactive.PreparedTransaction

+ +

2 fields

+ +
+ +

* Prepared Transaction Message

+ + +
+ +
+
+ transaction + DamlTransaction + +
+ +
Daml Transaction representing the ledger effect if executed. See below
+ +
+ +
+
+ metadata + Metadata + +
+ +
Metadata context necessary to execute the transaction
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.interactive.Metadata

+ +

10 fields

+ +
+ +

Transaction Metadata Refer to the hashing documentation for information on how it should be hashed.

+ + +
+ +
+
+ submitter_info + SubmitterInfo + +
+ +
+ +
+
+ synchronizer_id + string + +
+ +
+ +
+
+ mediator_group + uint32 + +
+ +
+ +
+
+ transaction_uuid + string + +
+ +
+ +
+
+ preparation_time + uint64 + +
+ +
+ +
+
+ input_contracts + repeated InputContract + +
+ +
+ +
+
+ min_ledger_effective_time + uint64 + +
+ +
Where ledger time constraints are imposed during the execution of the contract they will be populated in the fields below. These are optional because if the transaction does NOT depend on time, these values do not need to be set. The final ledger effective time used will be chosen when the command is submitted through the [execute] RPC. If the ledger effective time is outside of any populated min/max bounds then a different transaction can result, that will cause a confirmation message rejection.
+ +
+ +
+
+ max_ledger_effective_time + uint64 + +
+ +
+ +
+
+ global_key_mapping + repeated GlobalKeyMappingEntry + +
+ +
********************************************************** ** Metadata information that does NOT need to be signed ** ********************************************************** Contextual information needed to process the transaction but not signed, either because it's already indirectly signed by signing the transaction, or because it doesn't impact the ledger state
+ +
+ +
+
+ max_record_time + uint64 + +
+ +
Maximum timestamp at which the transaction can be recorded onto the ledger via the synchronizer `synchronizer_id`. If submitted after it will be rejected even if otherwise valid, in which case it needs to be prepared and signed again with a new valid max_record_time. Unsigned in 3.3 to avoid a breaking protocol change Will be signed in 3.4+ Set max_record_time in the PreparedTransactionRequest to get this field set accordingly
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.interactive.Metadata.SubmitterInfo

+ +

2 fields

+ +
+ + +
+ +
+
+ act_as + repeated string + +
+ +
+ +
+
+ command_id + string + +
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.interactive.Metadata.GlobalKeyMappingEntry

+ +

2 fields

+ +
+ + +
+ +
+
+ key + GlobalKey + +
+ +
+ +
+
+ value + Value + +
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.interactive.GlobalKey

+ +

4 fields

+ +
+ + +
+ +
+
+ template_id + Identifier + +
+ +
The identifier uses the package-id reference format.
+ +
+ +
+
+ package_name + string + +
+ +
+ +
+
+ key + Value + +
+ +
+ +
+
+ hash + bytes + +
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.interactive.Metadata.InputContract

+ +

3 fields

+ +
+ + +
+ +
+
+ v1 + Create + +
+ +
When new versions will be added, they will show here
+ +
+ +
+
+ created_at + uint64 + +
+ +
+ +
+
+ event_blob + bytes + +
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.interactive.PartySignatures

+ +

1 fields

+ +
+ +

Additional signatures provided by the submitting parties

+ + +
+ +
+
+ signatures + repeated SinglePartySignatures + +
+ +
Additional signatures provided by all individual parties Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.interactive.SinglePartySignatures

+ +

2 fields

+ +
+ +

Signatures provided by a single party

+ + +
+ +
+
+ party + string + +
+ +
Submitting party Required
+ +
+ +
+
+ signatures + repeated Signature + +
+ +
Signatures Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.Signature

+ +

4 fields

+ +
+ + +
+ +
+
+ format + SignatureFormat + +
+ +
+ +
+
+ signature + bytes + +
+ +
+ +
+
+ signed_by + string + +
+ +
The fingerprint/id of the keypair used to create this signature and needed to verify.
+ +
+ +
+
+ signing_algorithm_spec + SigningAlgorithmSpec + +
+ +
The signing algorithm specification used to produce this signature
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.SignatureFormat

+ +

5 values

+ +
+ + + +
    + +
  • SIGNATURE_FORMAT_UNSPECIFIED
    • + +
  • SIGNATURE_FORMAT_RAW
    • + +
  • SIGNATURE_FORMAT_DER
    • + +
  • SIGNATURE_FORMAT_CONCAT
    • + +
  • SIGNATURE_FORMAT_SYMBOLIC
    • + +
+ + +
+ +
+
+

com.daml.ledger.api.v2.interactive.HashingSchemeVersion

+ +

2 values

+ +
+ +

[docs-entry-start: HashingSchemeVersion] The hashing scheme version used when building the hash of the PreparedTransaction

+ + + +
    + +
  • HASHING_SCHEME_VERSION_UNSPECIFIED
    • + +
  • HASHING_SCHEME_VERSION_V2
    • + +
+ + +
+ +
+
+

com.daml.ledger.api.v2.interactive.MinLedgerTime

+ +

2 fields

+ +
+ + +
+ +
+
+ min_ledger_time_abs + Timestamp + +
+ +
Lower bound for the ledger time assigned to the resulting transaction. The ledger time of a transaction is assigned as part of command interpretation. Important note: for interactive submissions, if the transaction depends on time, it **must** be signed and submitted within a time window around the ledger time assigned to the transaction during the prepare method. The time delta around that ledger time is a configuration of the ledger, usually short, around 1 minute. If however the transaction does not depend on time, the available time window to sign and submit the transaction is bound by the preparation time, which is also assigned in the "prepare" step (this request), but can be configured with a much larger skew, allowing for more time to sign the request (in the order of hours). Must not be set at the same time as min_ledger_time_rel. Optional
+ +
+ +
+
+ min_ledger_time_rel + Duration + +
+ +
Same as min_ledger_time_abs, but specified as a duration, starting from the time this request is received by the server. Must not be set at the same time as min_ledger_time_abs. Optional
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.TransactionFormat

+ +

2 fields

+ +
+ +

A format that specifies what events to include in Daml transactions and what data to compute and include for them.

+ + +
+ +
+
+ event_format + EventFormat + +
+ +
Required
+ +
+ +
+
+ transaction_shape + TransactionShape + +
+ +
What transaction shape to use for interpreting the filters of the event format. Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.EventFormat

+ +

3 fields

+ +
+ +

A format for events which defines both which events should be included and what data should be computed and included for them. Note that some of the filtering behavior depends on the `TransactionShape`, which is expected to be specified alongside usages of `EventFormat`.

+ + +
+ +
+
+ filters_by_party + repeated map + +
+ +
Each key must be a valid PartyIdString (as described in ``value.proto``). The interpretation of the filter depends on the transaction-shape being filtered: 1. For **ledger-effects** create and exercise events are returned, for which the witnesses include at least one of the listed parties and match the per-party filter. 2. For **transaction and active-contract-set streams** create and archive events are returned for all contracts whose stakeholders include at least one of the listed parties and match the per-party filter. Optional
+ +
+ +
+
+ filters_for_any_party + Filters + +
+ +
Wildcard filters that apply to all the parties existing on the participant. The interpretation of the filters is the same with the per-party filter as described above. Optional
+ +
+ +
+
+ verbose + bool + +
+ +
If enabled, values served over the API will contain more information than strictly necessary to interpret the data. In particular, setting the verbose flag to true triggers the ledger to include labels for record fields. Optional
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.Filters

+ +

1 fields

+ +
+ +

The union of a set of template filters, interface filters, or a wildcard.

+ + +
+ +
+
+ cumulative + repeated CumulativeFilter + +
+ +
Every filter in the cumulative list expands the scope of the resulting stream. Each interface, template or wildcard filter means additional events that will match the query. The impact of include_interface_view and include_created_event_blob fields in the filters will also be accumulated. A template or an interface SHOULD NOT appear twice in the accumulative field. A wildcard filter SHOULD NOT be defined more than once in the accumulative field. Optional, if no ``CumulativeFilter`` defined, the default of a single ``WildcardFilter`` with include_created_event_blob unset is used.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.CumulativeFilter

+ +

3 fields

+ +
+ +

A filter that matches all contracts that are either an instance of one of the ``template_filters`` or that match one of the ``interface_filters``.

+ + +
+ +
+
+ wildcard_filter + WildcardFilter + +
+ +
A wildcard filter that matches all templates Optional
+ +
+ +
+
+ interface_filter + InterfaceFilter + +
+ +
Include an ``InterfaceView`` for every ``InterfaceFilter`` matching a contract. The ``InterfaceFilter`` instances MUST each use a unique ``interface_id``. Optional
+ +
+ +
+
+ template_filter + TemplateFilter + +
+ +
A template for which the data will be included in the ``create_arguments`` of a matching ``CreatedEvent``. If a contract is simultaneously selected by a template filter and one or more interface filters, the corresponding ``include_created_event_blob`` are consolidated using an OR operation. Optional
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.WildcardFilter

+ +

1 fields

+ +
+ +

This filter matches all templates.

+ + +
+ +
+
+ include_created_event_blob + bool + +
+ +
Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``. Use this to access the contract create event payload in your API client for submitting it as a disclosed contract with future commands. Optional
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.InterfaceFilter

+ +

3 fields

+ +
+ +

This filter matches contracts that implement a specific interface.

+ + +
+ +
+
+ interface_id + Identifier + +
+ +
The interface that a matching contract must implement. The ``interface_id`` needs to be valid: corresponding interface should be defined in one of the available packages at the time of the query. Both package-name and package-id reference formats for the identifier are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ include_interface_view + bool + +
+ +
Whether to include the interface view on the contract in the returned ``CreatedEvent``. Use this to access contract data in a uniform manner in your API client. Optional
+ +
+ +
+
+ include_created_event_blob + bool + +
+ +
Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``. Use this to access the contract create event payload in your API client for submitting it as a disclosed contract with future commands. Optional
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.TemplateFilter

+ +

2 fields

+ +
+ +

This filter matches contracts of a specific template.

+ + +
+ +
+
+ template_id + Identifier + +
+ +
A template for which the payload should be included in the response. The ``template_id`` needs to be valid: corresponding template should be defined in one of the available packages at the time of the query. Both package-name and package-id reference formats for the identifier are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ include_created_event_blob + bool + +
+ +
Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``. Use this to access the contract event payload in your API client for submitting it as a disclosed contract with future commands. Optional
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.TransactionShape

+ +

3 values

+ +
+ +

Event shape for Transactions. Shapes are exclusive and only one of them can be defined in queries.

+ + + +
    + +
  • TRANSACTION_SHAPE_UNSPECIFIED
    • + +
  • TRANSACTION_SHAPE_ACS_DELTA
    • + +
  • TRANSACTION_SHAPE_LEDGER_EFFECTS
    • + +
+ + +
+ +
+
+

com.daml.ledger.api.v2.interactive.ExecuteSubmissionAndWaitForTransactionResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ transaction + Transaction + +
+ +
The transaction that resulted from the submitted command. The transaction might contain no events (request conditions result in filtering out all of them). Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.Transaction

+ +

10 fields

+ +
+ +

Filtered view of an on-ledger transaction's create and archive events.

+ + +
+ +
+
+ update_id + string + +
+ +
Assigned by the server. Useful for correlating logs. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ command_id + string + +
+ +
The ID of the command which resulted in this transaction. Missing for everyone except the submitting party. Must be a valid LedgerString (as described in ``value.proto``). Optional
+ +
+ +
+
+ workflow_id + string + +
+ +
The workflow ID used in command submission. Must be a valid LedgerString (as described in ``value.proto``). Optional
+ +
+ +
+
+ effective_at + Timestamp + +
+ +
Ledger effective time. Required
+ +
+ +
+
+ events + repeated Event + +
+ +
The collection of events. Contains: - ``CreatedEvent`` or ``ArchivedEvent`` in case of ACS_DELTA transaction shape - ``CreatedEvent`` or ``ExercisedEvent`` in case of LEDGER_EFFECTS transaction shape Required
+ +
+ +
+
+ offset + int64 + +
+ +
The absolute offset. The details of this field are described in ``community/ledger-api/README.md``. Required, it is a valid absolute offset (positive integer).
+ +
+ +
+
+ synchronizer_id + string + +
+ +
A valid synchronizer id. Identifies the synchronizer that synchronized the transaction. Required
+ +
+ +
+
+ trace_context + TraceContext + +
+ +
Optional; ledger API trace context The trace context transported in this message corresponds to the trace context supplied by the client application in a HTTP2 header of the original command submission. We typically use a header to transfer this type of information. Here we use message body, because it is used in gRPC streams which do not support per message headers. This field will be populated with the trace context contained in the original submission. If that was not provided, a unique ledger-api-server generated trace context will be used instead.
+ +
+ +
+
+ record_time + Timestamp + +
+ +
The time at which the transaction was recorded. The record time refers to the synchronizer which synchronized the transaction. Required
+ +
+ +
+
+ external_transaction_hash + bytes + +
+ +
For transaction externally signed, contains the external transaction hash signed by the external party. Can be used to correlate an external submission with a committed transaction. Optional
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.Event

+ +

3 fields

+ +
+ +

Events in transactions can have two primary shapes: - ACS delta: events can be CreatedEvent or ArchivedEvent - ledger effects: events can be CreatedEvent or ExercisedEvent In the update service the events are restricted to the events visible for the parties specified in the transaction filter. Each event message type below contains a ``witness_parties`` field which indicates the subset of the requested parties that can see the event in question.

+ + +
+ +
+
+ created + CreatedEvent + +
+ +
The event as it appeared in the context of its original daml transaction on this participant node. In particular, the offset, node_id pair of the daml transaction are preserved.
+ +
+ +
+
+ archived + ArchivedEvent + +
+ +
+ +
+
+ exercised + ExercisedEvent + +
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.CreatedEvent

+ +

15 fields

+ +
+ +

Records that a contract has been created, and choices may now be exercised on it.

+ + +
+ +
+
+ offset + int64 + +
+ +
The offset of origin, which has contextual meaning, please see description at messages that include a CreatedEvent. Offsets are managed by the participant nodes. Transactions can thus NOT be assumed to have the same offsets on different participant nodes. Required, it is a valid absolute offset (positive integer)
+ +
+ +
+
+ node_id + int32 + +
+ +
The position of this event in the originating transaction or reassignment. The origin has contextual meaning, please see description at messages that include a CreatedEvent. Node IDs are not necessarily equal across participants, as these may see different projections/parts of transactions. Required, must be valid node ID (non-negative integer)
+ +
+ +
+
+ contract_id + string + +
+ +
The ID of the created contract. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ template_id + Identifier + +
+ +
The template of the created contract. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ contract_key + Value + +
+ +
The key of the created contract. This will be set if and only if ``template_id`` defines a contract key. Optional
+ +
+ +
+
+ create_arguments + Record + +
+ +
The arguments that have been used to create the contract. Required
+ +
+ +
+
+ created_event_blob + bytes + +
+ +
Opaque representation of contract create event payload intended for forwarding to an API server as a contract disclosed as part of a command submission. Optional
+ +
+ +
+
+ interface_views + repeated InterfaceView + +
+ +
Interface views specified in the transaction filter. Includes an ``InterfaceView`` for each interface for which there is a ``InterfaceFilter`` with - its party in the ``witness_parties`` of this event, - and which is implemented by the template of this event, - and which has ``include_interface_view`` set. Optional
+ +
+ +
+
+ witness_parties + repeated string + +
+ +
The parties that are notified of this event. When a ``CreatedEvent`` is returned as part of a transaction tree or ledger-effects transaction, this will include all the parties specified in the ``TransactionFilter`` that are witnesses of the event (the stakeholders of the contract and all informees of all the ancestors of this create action that this participant knows about). If served as part of a ACS delta transaction those will be limited to all parties specified in the ``TransactionFilter`` that are stakeholders of the contract (i.e. either signatories or observers). If the ``CreatedEvent`` is returned as part of an AssignedEvent, ActiveContract or IncompleteUnassigned (so the event is related to an assignment or unassignment): this will include all parties of the ``TransactionFilter`` that are stakeholders of the contract. The behavior of reading create events visible to parties not hosted on the participant node serving the Ledger API is undefined. Concretely, there is neither a guarantee that the participant node will serve all their create events on the ACS stream, nor is there a guarantee that matching archive events are delivered for such create events. For most clients this is not a problem, as they only read events for parties that are hosted on the participant node. If you need to read events for parties that may not be hosted at all times on the participant node, subscribe to the ``TopologyEvent``s for that party by setting a corresponding ``UpdateFormat``. Using these events, query the ACS as-of an offset where the party is hosted on the participant node, and ignore create events at offsets where the party is not hosted on the participant node. Required
+ +
+ +
+
+ signatories + repeated string + +
+ +
The signatories for this contract as specified by the template. Required
+ +
+ +
+
+ observers + repeated string + +
+ +
The observers for this contract as specified explicitly by the template or implicitly as choice controllers. This field never contains parties that are signatories. Required
+ +
+ +
+
+ created_at + Timestamp + +
+ +
Ledger effective time of the transaction that created the contract. Required
+ +
+ +
+
+ package_name + string + +
+ +
The package name of the created contract. Required
+ +
+ +
+
+ acs_delta + bool + +
+ +
Whether this event would be part of respective ACS_DELTA shaped stream, and should therefore considered when tracking contract activeness on the client-side. Required
+ +
+ +
+
+ representative_package_id + string + +
+ +
A package-id present in the participant package store that typechecks the contract's argument. This may differ from the package-id of the template used to create the contract. For contracts created before Canton 3.4, this field matches the contract's creation package-id. NOTE: Experimental, server internal concept, not for client consumption. Subject to change without notice. Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.InterfaceView

+ +

3 fields

+ +
+ +

View of a create event matched by an interface filter.

+ + +
+ +
+
+ interface_id + Identifier + +
+ +
The interface implemented by the matched event. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ view_status + Status + +
+ +
Whether the view was successfully computed, and if not, the reason for the error. The error is reported using the same rules for error codes and messages as the errors returned for API requests. Required
+ +
+ +
+
+ view_value + Record + +
+ +
The value of the interface's view method on this event. Set if it was requested in the ``InterfaceFilter`` and it could be successfully computed. Optional
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.ArchivedEvent

+ +

7 fields

+ +
+ +

Records that a contract has been archived, and choices may no longer be exercised on it.

+ + +
+ +
+
+ offset + int64 + +
+ +
The offset of origin. Offsets are managed by the participant nodes. Transactions can thus NOT be assumed to have the same offsets on different participant nodes. Required, it is a valid absolute offset (positive integer)
+ +
+ +
+
+ node_id + int32 + +
+ +
The position of this event in the originating transaction or reassignment. Node IDs are not necessarily equal across participants, as these may see different projections/parts of transactions. Required, must be valid node ID (non-negative integer)
+ +
+ +
+
+ contract_id + string + +
+ +
The ID of the archived contract. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ template_id + Identifier + +
+ +
Identifies the template that defines the choice that archived the contract. This template's package-id may differ from the target contract's package-id if the target contract has been upgraded or downgraded. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ witness_parties + repeated string + +
+ +
The parties that are notified of this event. For an ``ArchivedEvent``, these are the intersection of the stakeholders of the contract in question and the parties specified in the ``TransactionFilter``. The stakeholders are the union of the signatories and the observers of the contract. Each one of its elements must be a valid PartyIdString (as described in ``value.proto``). Required
+ +
+ +
+
+ package_name + string + +
+ +
The package name of the contract. Required
+ +
+ +
+
+ implemented_interfaces + repeated Identifier + +
+ +
The interfaces implemented by the target template that have been matched from the interface filter query. Populated only in case interface filters with include_interface_view set. If defined, the identifier uses the package-id reference format. Optional
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.ExercisedEvent

+ +

15 fields

+ +
+ +

Records that a choice has been exercised on a target contract.

+ + +
+ +
+
+ offset + int64 + +
+ +
The offset of origin. Offsets are managed by the participant nodes. Transactions can thus NOT be assumed to have the same offsets on different participant nodes. Required, it is a valid absolute offset (positive integer)
+ +
+ +
+
+ node_id + int32 + +
+ +
The position of this event in the originating transaction or reassignment. Node IDs are not necessarily equal across participants, as these may see different projections/parts of transactions. Required, must be valid node ID (non-negative integer)
+ +
+ +
+
+ contract_id + string + +
+ +
The ID of the target contract. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ template_id + Identifier + +
+ +
Identifies the template that defines the executed choice. This template's package-id may differ from the target contract's package-id if the target contract has been upgraded or downgraded. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ interface_id + Identifier + +
+ +
The interface where the choice is defined, if inherited. If defined, the identifier uses the package-id reference format. Optional
+ +
+ +
+
+ choice + string + +
+ +
The choice that was exercised on the target contract. Must be a valid NameString (as described in ``value.proto``). Required
+ +
+ +
+
+ choice_argument + Value + +
+ +
The argument of the exercised choice. Required
+ +
+ +
+
+ acting_parties + repeated string + +
+ +
The parties that exercised the choice. Each element must be a valid PartyIdString (as described in ``value.proto``). Required
+ +
+ +
+
+ consuming + bool + +
+ +
If true, the target contract may no longer be exercised. Required
+ +
+ +
+
+ witness_parties + repeated string + +
+ +
The parties that are notified of this event. The witnesses of an exercise node will depend on whether the exercise was consuming or not. If consuming, the witnesses are the union of the stakeholders, the actors and all informees of all the ancestors of this event this participant knows about. If not consuming, the witnesses are the union of the signatories, the actors and all informees of all the ancestors of this event this participant knows about. In both cases the witnesses are limited to the querying parties, or not limited in case anyParty filters are used. Note that the actors might not necessarily be observers and thus stakeholders. This is the case when the controllers of a choice are specified using "flexible controllers", using the ``choice ... controller`` syntax, and said controllers are not explicitly marked as observers. Each element must be a valid PartyIdString (as described in ``value.proto``). Required
+ +
+ +
+
+ last_descendant_node_id + int32 + +
+ +
Specifies the upper boundary of the node ids of the events in the same transaction that appeared as a result of this ``ExercisedEvent``. This allows unambiguous identification of all the members of the subtree rooted at this node. A full subtree can be constructed when all descendant nodes are present in the stream. If nodes are heavily filtered, it is only possible to determine if a node is in a consequent subtree or not. Required
+ +
+ +
+
+ exercise_result + Value + +
+ +
The result of exercising the choice. Required
+ +
+ +
+
+ package_name + string + +
+ +
The package name of the contract. Required
+ +
+ +
+
+ implemented_interfaces + repeated Identifier + +
+ +
If the event is consuming, the interfaces implemented by the target template that have been matched from the interface filter query. Populated only in case interface filters with include_interface_view set. The identifier uses the package-id reference format. Optional
+ +
+ +
+
+ acs_delta + bool + +
+ +
Whether this event would be part of respective ACS_DELTA shaped stream, and should therefore considered when tracking contract activeness on the client-side. Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.TraceContext

+ +

2 fields

+ +
+ + +
+ +
+
+ traceparent + string + +
+ +
https://www.w3.org/TR/trace-context/
+ +
+ +
+
+ tracestate + string + +
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.interactive.ExecuteSubmissionAndWaitRequest

+ +

8 fields

+ +
+ + +
+ +
+
+ prepared_transaction + PreparedTransaction + +
+ +
the prepared transaction Typically this is the value of the `prepared_transaction` field in `PrepareSubmissionResponse` obtained from calling `prepareSubmission`. Required
+ +
+ +
+
+ party_signatures + PartySignatures + +
+ +
The party(ies) signatures that authorize the prepared submission to be executed by this node. Each party can provide one or more signatures.. and one or more parties can sign. Note that currently, only single party submissions are supported. Required
+ +
+ +
+
+ deduplication_duration + Duration + +
+ +
Specifies the length of the deduplication period. It is interpreted relative to the local clock at some point during the submission's processing. Must be non-negative. Must not exceed the maximum deduplication time.
+ +
+ +
+
+ deduplication_offset + int64 + +
+ +
Specifies the start of the deduplication period by a completion stream offset (exclusive). Must be a valid absolute offset (positive integer).
+ +
+ +
+
+ submission_id + string + +
+ +
A unique identifier to distinguish completions for different submissions with the same change ID. Typically a random UUID. Applications are expected to use a different UUID for each retry of a submission with the same change ID. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ user_id + string + +
+ +
See [PrepareSubmissionRequest.user_id] Optional
+ +
+ +
+
+ hashing_scheme_version + HashingSchemeVersion + +
+ +
The hashing scheme version used when building the hash Required
+ +
+ +
+
+ min_ledger_time + MinLedgerTime + +
+ +
If set will influence the chosen ledger effective time but will not result in a submission delay so any override should be scheduled to executed within the window allowed by synchronizer. Optional
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.interactive.ExecuteSubmissionAndWaitResponse

+ +

2 fields

+ +
+ + +
+ +
+
+ update_id + string + +
+ +
The id of the transaction that resulted from the submitted command. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ completion_offset + int64 + +
+ +
The details of the offset field are described in ``community/ledger-api/README.md``. Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.interactive.ExecuteSubmissionRequest

+ +

8 fields

+ +
+ + +
+ +
+
+ prepared_transaction + PreparedTransaction + +
+ +
the prepared transaction Typically this is the value of the `prepared_transaction` field in `PrepareSubmissionResponse` obtained from calling `prepareSubmission`. Required
+ +
+ +
+
+ party_signatures + PartySignatures + +
+ +
The party(ies) signatures that authorize the prepared submission to be executed by this node. Each party can provide one or more signatures.. and one or more parties can sign. Note that currently, only single party submissions are supported. Required
+ +
+ +
+
+ deduplication_duration + Duration + +
+ +
Specifies the length of the deduplication period. It is interpreted relative to the local clock at some point during the submission's processing. Must be non-negative. Must not exceed the maximum deduplication time.
+ +
+ +
+
+ deduplication_offset + int64 + +
+ +
Specifies the start of the deduplication period by a completion stream offset (exclusive). Must be a valid absolute offset (positive integer).
+ +
+ +
+
+ submission_id + string + +
+ +
A unique identifier to distinguish completions for different submissions with the same change ID. Typically a random UUID. Applications are expected to use a different UUID for each retry of a submission with the same change ID. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ user_id + string + +
+ +
See [PrepareSubmissionRequest.user_id] Optional
+ +
+ +
+
+ hashing_scheme_version + HashingSchemeVersion + +
+ +
The hashing scheme version used when building the hash Required
+ +
+ +
+
+ min_ledger_time + MinLedgerTime + +
+ +
If set will influence the chosen ledger effective time but will not result in a submission delay so any override should be scheduled to executed within the window allowed by synchronizer. Optional
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.interactive.ExecuteSubmissionResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.daml.ledger.api.v2.interactive.GetPreferredPackageVersionRequest

+ +

4 fields

+ +
+ + +
+ +
+
+ parties + repeated string + +
+ +
The parties whose participants' vetting state should be considered when resolving the preferred package. Required
+ +
+ +
+
+ package_name + string + +
+ +
The package-name for which the preferred package should be resolved. Required
+ +
+ +
+
+ synchronizer_id + string + +
+ +
The synchronizer whose vetting state should be used for resolving this query. If not specified, the vetting states of all synchronizers to which the participant is connected are used. Optional
+ +
+ +
+
+ vetting_valid_at + Timestamp + +
+ +
The timestamp at which the package vetting validity should be computed on the latest topology snapshot as seen by the participant. If not provided, the participant's current clock time is used. Optional
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.interactive.GetPreferredPackageVersionResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ package_preference + PackagePreference + +
+ +
Not populated when no preferred package is found Optional
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.interactive.PackagePreference

+ +

2 fields

+ +
+ + +
+ +
+
+ package_reference + PackageReference + +
+ +
The package reference of the preferred package. Required
+ +
+ +
+
+ synchronizer_id + string + +
+ +
The synchronizer for which the preferred package was computed. If the synchronizer_id was specified in the request, then it matches the request synchronizer_id. Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.PackageReference

+ +

3 fields

+ +
+ + +
+ +
+
+ package_id + string + +
+ +
Required
+ +
+ +
+
+ package_name + string + +
+ +
Required
+ +
+ +
+
+ package_version + string + +
+ +
Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.interactive.GetPreferredPackagesRequest

+ +

3 fields

+ +
+ + +
+ +
+
+ package_vetting_requirements + repeated PackageVettingRequirement + +
+ +
The package-name vetting requirements for which the preferred packages should be resolved. Generally it is enough to provide the requirements for the intended command's root package-names. Additional package-name requirements can be provided when additional Daml transaction informees need to use package dependencies of the command's root packages. Required
+ +
+ +
+
+ synchronizer_id + string + +
+ +
The synchronizer whose vetting state should be used for resolving this query. If not specified, the vetting states of all synchronizers to which the participant is connected are used. Optional
+ +
+ +
+
+ vetting_valid_at + Timestamp + +
+ +
The timestamp at which the package vetting validity should be computed on the latest topology snapshot as seen by the participant. If not provided, the participant's current clock time is used. Optional
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.interactive.PackageVettingRequirement

+ +

2 fields

+ +
+ +

Defines a package-name for which the commonly vetted package with the highest version must be found.

+ + +
+ +
+
+ parties + repeated string + +
+ +
The parties whose participants' vetting state should be considered when resolving the preferred package. Required
+ +
+ +
+
+ package_name + string + +
+ +
The package-name for which the preferred package should be resolved. Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.interactive.GetPreferredPackagesResponse

+ +

2 fields

+ +
+ + +
+ +
+
+ package_references + repeated PackageReference + +
+ +
The package references of the preferred packages. Must contain one package reference for each requested package-name. If you build command submissions whose content depends on the returned preferred packages, then we recommend submitting the preferred package-ids in the ``package_id_selection_preference`` of the command submission to avoid race conditions with concurrent changes of the on-ledger package vetting state. Required
+ +
+ +
+
+ synchronizer_id + string + +
+ +
The synchronizer for which the package preferences are computed. If the synchronizer_id was specified in the request, then it matches the request synchronizer_id. Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.interactive.PrepareSubmissionRequest

+ +

13 fields

+ +
+ + +
+ +
+
+ user_id + string + +
+ +
Uniquely identifies the participant user that prepares the transaction. Must be a valid UserIdString (as described in ``value.proto``). Required unless authentication is used with a user token. In that case, the token's user-id will be used for the request's user_id. Optional
+ +
+ +
+
+ command_id + string + +
+ +
Uniquely identifies the command. The triple (user_id, act_as, command_id) constitutes the change ID for the intended ledger change, where act_as is interpreted as a set of party names. The change ID can be used for matching the intended ledger changes with all their completions. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ commands + repeated Command + +
+ +
Individual elements of this atomic command. Must be non-empty. Limitation: Only single command transaction are currently supported by the API. The field is marked as repeated in preparation for future support of multiple commands. Required
+ +
+ +
+
+ min_ledger_time + MinLedgerTime + +
+ +
Optional
+ +
+ +
+
+ max_record_time + Timestamp + +
+ +
Maximum timestamp at which the transaction can be recorded onto the ledger via the synchronizer specified in the `PrepareSubmissionResponse`. If submitted after it will be rejected even if otherwise valid, in which case it needs to be prepared and signed again with a new valid max_record_time. Use this to limit the time-to-life of a prepared transaction, which is useful to know when it can definitely not be accepted anymore and resorting to preparing another transaction for the same intent is safe again. Optional
+ +
+ +
+
+ act_as + repeated string + +
+ +
Set of parties on whose behalf the command should be executed, if submitted. If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request to **read** (not act) on behalf of each of the given parties. This is because this RPC merely prepares a transaction and does not execute it. Therefore read authorization is sufficient even for actAs parties. Note: This may change, and more specific authorization scope may be introduced in the future. Each element must be a valid PartyIdString (as described in ``value.proto``). Required, must be non-empty.
+ +
+ +
+
+ read_as + repeated string + +
+ +
Set of parties on whose behalf (in addition to all parties listed in ``act_as``) contracts can be retrieved. This affects Daml operations such as ``fetch``, ``fetchByKey``, ``lookupByKey``, ``exercise``, and ``exerciseByKey``. Note: A command can only use contracts that are visible to at least one of the parties in ``act_as`` or ``read_as``. This visibility check is independent from the Daml authorization rules for fetch operations. If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request to read contract data on behalf of each of the given parties. Optional
+ +
+ +
+
+ disclosed_contracts + repeated DisclosedContract + +
+ +
Additional contracts used to resolve contract & contract key lookups. Optional
+ +
+ +
+
+ synchronizer_id + string + +
+ +
Must be a valid synchronizer id If not set, a suitable synchronizer that this node is connected to will be chosen Optional
+ +
+ +
+
+ package_id_selection_preference + repeated string + +
+ +
The package-id selection preference of the client for resolving package names and interface instances in command submission and interpretation Optional
+ +
+ +
+
+ verbose_hashing + bool + +
+ +
When true, the response will contain additional details on how the transaction was encoded and hashed This can be useful for troubleshooting of hash mismatches. Should only be used for debugging. Optional, default to false
+ +
+ +
+
+ prefetch_contract_keys + repeated PrefetchContractKey + +
+ +
Fetches the contract keys into the caches to speed up the command processing. Should only contain contract keys that are expected to be resolved during interpretation of the commands. Keys of disclosed contracts do not need prefetching. Optional
+ +
+ +
+
+ estimate_traffic_cost + CostEstimationHints + +
+ +
Hints to improve the accuracy of traffic cost estimation. The estimation logic assumes that this node will be used for the execution of the transaction If another node is used instead, the estimation may be less precise. Request amplification is not accounted for in the estimation: each amplified request will result in the cost of the confirmation request to be charged additionally. Optional - Traffic cost estimation is enabled by default if this field is not set To turn off cost estimation, set the CostEstimationHints#disabled field to true
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.Command

+ +

4 fields

+ +
+ +

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

+ + +
+ +
+
+ create + CreateCommand + +
+ +
+ +
+
+ exercise + ExerciseCommand + +
+ +
+ +
+
+ exercise_by_key + ExerciseByKeyCommand + +
+ +
+ +
+
+ create_and_exercise + CreateAndExerciseCommand + +
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.CreateCommand

+ +

2 fields

+ +
+ +

Create a new contract instance based on a template.

+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template of contract the client wants to create. Both package-name and package-id reference identifier formats for the template-id are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ create_arguments + Record + +
+ +
The arguments required for creating a contract from this template. Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.ExerciseCommand

+ +

4 fields

+ +
+ +

Exercise a choice on an existing contract.

+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template or interface of the contract the client wants to exercise. Both package-name and package-id reference identifier formats for the template-id are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. To exercise a choice on an interface, specify the interface identifier in the template_id field. Required
+ +
+ +
+
+ contract_id + string + +
+ +
The ID of the contract the client wants to exercise upon. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ choice + string + +
+ +
The name of the choice the client wants to exercise. Must be a valid NameString (as described in ``value.proto``) Required
+ +
+ +
+
+ choice_argument + Value + +
+ +
The argument for this choice. Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.ExerciseByKeyCommand

+ +

4 fields

+ +
+ +

Exercise a choice on an existing contract specified by its key.

+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template of contract the client wants to exercise. Both package-name and package-id reference identifier formats for the template-id are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ contract_key + Value + +
+ +
The key of the contract the client wants to exercise upon. Required
+ +
+ +
+
+ choice + string + +
+ +
The name of the choice the client wants to exercise. Must be a valid NameString (as described in ``value.proto``) Required
+ +
+ +
+
+ choice_argument + Value + +
+ +
The argument for this choice. Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.CreateAndExerciseCommand

+ +

4 fields

+ +
+ +

Create a contract and exercise a choice on it in the same transaction.

+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template of the contract the client wants to create. Both package-name and package-id reference identifier formats for the template-id are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ create_arguments + Record + +
+ +
The arguments required for creating a contract from this template. Required
+ +
+ +
+
+ choice + string + +
+ +
The name of the choice the client wants to exercise. Must be a valid NameString (as described in ``value.proto``). Required
+ +
+ +
+
+ choice_argument + Value + +
+ +
The argument for this choice. Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.DisclosedContract

+ +

4 fields

+ +
+ +

An additional contract that is used to resolve contract & contract key lookups.

+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template id of the contract. The identifier uses the package-id reference format. If provided, used to validate the template id of the contract serialized in the created_event_blob. Optional
+ +
+ +
+
+ contract_id + string + +
+ +
The contract id If provided, used to validate the contract id of the contract serialized in the created_event_blob. Optional
+ +
+ +
+
+ created_event_blob + bytes + +
+ +
Opaque byte string containing the complete payload required by the Daml engine to reconstruct a contract not known to the receiving participant. Required
+ +
+ +
+
+ synchronizer_id + string + +
+ +
The ID of the synchronizer where the contract is currently assigned Optional
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.PrefetchContractKey

+ +

2 fields

+ +
+ +

Preload contracts

+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template of contract the client wants to prefetch. Both package-name and package-id reference identifier formats for the template-id are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ contract_key + Value + +
+ +
The key of the contract the client wants to prefetch. Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.interactive.PrepareSubmissionResponse

+ +

5 fields

+ +
+ + +
+ +
+
+ prepared_transaction + PreparedTransaction + +
+ +
The interpreted transaction, it represents the ledger changes necessary to execute the commands specified in the request. 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.
+ +
+ +
+
+ prepared_transaction_hash + bytes + +
+ +
Hash of the transaction, this is what needs to be signed by the party to authorize the transaction. Only provided for convenience, clients MUST recompute the hash from the raw transaction if the preparing participant is not trusted. May be removed in future versions
+ +
+ +
+
+ hashing_scheme_version + HashingSchemeVersion + +
+ +
The hashing scheme version used when building the hash
+ +
+ +
+
+ hashing_details + string + +
+ +
Optional additional details on how the transaction was encoded and hashed. Only set if verbose_hashing = true in the request Note that there are no guarantees on the stability of the format or content of this field. Its content should NOT be parsed and should only be used for troubleshooting purposes.
+ +
+ +
+
+ cost_estimation + CostEstimation + +
+ +
Traffic cost estimation of the prepared transaction Optional
+ +
+ +
+ + + +
diff --git a/tests/fixtures/characterization/protobuf/expected/packages/com-daml-ledger-api-v2.mdx b/tests/fixtures/characterization/protobuf/expected/packages/com-daml-ledger-api-v2.mdx index b79f52f..9617656 100644 --- a/tests/fixtures/characterization/protobuf/expected/packages/com-daml-ledger-api-v2.mdx +++ b/tests/fixtures/characterization/protobuf/expected/packages/com-daml-ledger-api-v2.mdx @@ -1,67 +1,933 @@ --- title: "com.daml.ledger.api.v2" -description: "Descriptor-backed protobuf API history for package com.daml.ledger.api.v2." +description: "Package-level overview for com.daml.ledger.api.v2." --- -# Package `com.daml.ledger.api.v2` +

Back to overview

+ +
+ +

Protobuf Package

+ + +

com.daml.ledger.api.v2

+ + +

9 services, 20 endpoints, 103 messages, 8 enums

+ + +
+ + gRPC + +
+ + +
+ +
+
Files
+
22
+
+ +
+
Services
+
9
+
+ +
+
Endpoints
+
20
+
+ +
+
Messages
+
103
+
+ +
+
Enums
+
8
+
+ +
+ +
-[Back to Canton Protobuf History](../index) -## Snapshot +## Source Files -- Current files: `22` -- Current services: `9` -- Current endpoints: `20` -- Current messages: `103` -- Current enums: `8` -- Lifecycle endpoints tracked: `20` -## Source Files -| File | Services | Messages | Enums | Source | -| --- | --- | --- | --- | --- | -| community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_completion_service.proto | `1` | `2` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_completion_service.proto#L4) | -| community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_service.proto | `1` | `6` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_service.proto#L4) | -| community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_submission_service.proto | `1` | `4` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_submission_service.proto#L4) | -| community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/commands.proto | `0` | `8` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/commands.proto#L4) | -| community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/completion.proto | `0` | `1` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/completion.proto#L4) | -| community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/contract_service.proto | `1` | `2` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/contract_service.proto#L4) | -| community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/crypto.proto | `0` | `2` | `4` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/crypto.proto#L4) | -| community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/event.proto | `0` | `5` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/event.proto#L4) | -| community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/event_query_service.proto | `1` | `4` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/event_query_service.proto#L4) | -| community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/experimental_features.proto | `0` | `4` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/experimental_features.proto#L4) | -| community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/offset_checkpoint.proto | `0` | `2` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/offset_checkpoint.proto#L4) | -| community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_reference.proto | `0` | `4` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_reference.proto#L4) | -| community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto | `1` | `10` | `2` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto#L4) | -| community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/reassignment.proto | `0` | `4` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/reassignment.proto#L4) | -| community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/reassignment_commands.proto | `0` | `4` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/reassignment_commands.proto#L4) | -| community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto | `1` | `11` | `1` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto#L4) | -| community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/topology_transaction.proto | `0` | `5` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/topology_transaction.proto#L4) | -| community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/trace_context.proto | `0` | `1` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/trace_context.proto#L4) | -| community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/transaction.proto | `0` | `1` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/transaction.proto#L4) | -| community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/transaction_filter.proto | `0` | `10` | `1` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/transaction_filter.proto#L4) | -| community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/update_service.proto | `1` | `5` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/update_service.proto#L4) | -| community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/version_service.proto | `1` | `7` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/version_service.proto#L4) | - -## Services - -| Service | Endpoints | Source | Description | -| --- | --- | --- | --- | -| [`CommandCompletionService`](#service-com-daml-ledger-api-v2-commandcompletionservice) | `1` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_completion_service.proto#L29) | Allows clients to observe the status of their submissions. Commands may be submitted via the Command Submission Servi... | -| [`CommandService`](#service-com-daml-ledger-api-v2-commandservice) | `3` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_service.proto#L23) | Command Service is able to correlate submitted commands with completion data, identify timeouts, and return contextua... | -| [`CommandSubmissionService`](#service-com-daml-ledger-api-v2-commandsubmissionservice) | `2` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_submission_service.proto#L29) | Allows clients to attempt advancing the ledger's state by submitting commands. The final states of their submissions... | -| [`ContractService`](#service-com-daml-ledger-api-v2-contractservice) | `1` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/contract_service.proto#L15) | This service is experimental / alpha, therefore no backwards compatibility is guaranteed. | -| [`EventQueryService`](#service-com-daml-ledger-api-v2-eventqueryservice) | `1` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/event_query_service.proto#L32) | Query events by contract id. Note that querying by contract key is not (yet) supported, as contract keys are not supp... | -| [`PackageService`](#service-com-daml-ledger-api-v2-packageservice) | `4` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto#L54) | Allows clients to query the Daml-LF packages that are supported by the server. | -| [`StateService`](#service-com-daml-ledger-api-v2-stateservice) | `4` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto#L17) | Allows clients to get state from the ledger. | -| [`UpdateService`](#service-com-daml-ledger-api-v2-updateservice) | `3` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/update_service.proto#L30) | Allows clients to read updates (transactions, (un)assignments, topology events) from the ledger. ``GetUpdates`` and `... | -| [`VersionService`](#service-com-daml-ledger-api-v2-versionservice) | `1` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/version_service.proto#L16) | Allows clients to retrieve information about the ledger API version | - - -### Service `CommandCompletionService` - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_completion_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_completion_service.proto#L29) -- Endpoints tracked: `1` + +
+ + +
+ +
+

community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_completion_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
2
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_completion_service.proto
+
+ +
+ + +
+ + + +
+ +
+

community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
6
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_service.proto
+
+ +
+ + +
+ + + +
+ +
+

community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_submission_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
4
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_submission_service.proto
+
+ +
+ + +
+ + + +
+ +
+

community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/commands.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
8
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/commands.proto
+
+ +
+ + +
+ + + +
+ +
+

community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/completion.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
1
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/completion.proto
+
+ +
+ + +
+ + + +
+ +
+

community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/contract_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
2
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/contract_service.proto
+
+ +
+ + +
+ + + +
+ +
+

community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/crypto.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
2
+
+ +
+
Enums
+
4
+
+ +
+
Source
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/crypto.proto
+
+ +
+ + +
+ + + +
+ +
+

community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/event.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
5
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/event.proto
+
+ +
+ + +
+ + + +
+ +
+

community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/event_query_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
4
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/event_query_service.proto
+
+ +
+ + +
+ + + +
+ +
+

community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/experimental_features.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
4
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/experimental_features.proto
+
+ +
+ + +
+ + + +
+ +
+

community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/offset_checkpoint.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
2
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/offset_checkpoint.proto
+
+ +
+ + +
+ + + +
+ +
+

community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_reference.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
4
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_reference.proto
+
+ +
+ + +
+ + + +
+ +
+

community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
10
+
+ +
+
Enums
+
2
+
+ +
+
Source
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto
+
+ +
+ + +
+ + + +
+ +
+

community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/reassignment.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
4
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/reassignment.proto
+
+ +
+ + +
+ + + +
+ +
+

community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/reassignment_commands.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
4
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/reassignment_commands.proto
+
+ +
+ + +
+ + + +
+ +
+

community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
11
+
+ +
+
Enums
+
1
+
+ +
+
Source
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto
+
+ +
+ + +
+ + + +
+ +
+

community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/topology_transaction.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
5
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/topology_transaction.proto
+
+ +
+ + +
+ + + +
+ +
+

community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/trace_context.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
1
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/trace_context.proto
+
+ +
+ + +
+ + + +
+ +
+

community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/transaction.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
1
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/transaction.proto
+
+ +
+ + +
+ + + +
+ +
+

community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/transaction_filter.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
10
+
+ +
+
Enums
+
1
+
+ +
+
Source
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/transaction_filter.proto
+
+ +
+ + +
+ + + +
+ +
+

community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/update_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
5
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/update_service.proto
+
+ +
+ + +
+ + + +
+ +
+

community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/version_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
7
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/version_service.proto
+
+ +
+ + +
+ + +
+ + + + + +## CommandCompletionService + Allows clients to observe the status of their submissions. Commands may be submitted via the Command Submission Service. @@ -78,46 +944,79 @@ Allows clients to observe the status of their submissions. Clients that do not receive a successful completion about their submission MUST NOT assume that it was successful. Clients SHOULD subscribe to the CompletionStream before starting to submit commands to prevent race conditions. -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`CompletionStream`](#endpoint-com-daml-ledger-api-v2-commandcompletionservice-completionstream) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.CompletionStreamRequest`](#type-com-daml-ledger-api-v2-completionstreamrequest) | [`com.daml.ledger.api.v2.CompletionStreamResponse`](#type-com-daml-ledger-api-v2-completionstreamresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_completion_service.proto#L31) | - - -**Endpoint `CommandCompletionService.CompletionStream`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_completion_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_completion_service.proto#L31) - -**Signature** - -```protobuf -rpc CommandCompletionService.CompletionStream(com.daml.ledger.api.v2.CompletionStreamRequest) returns (stream com.daml.ledger.api.v2.CompletionStreamResponse); -``` -Subscribe to command completion events. +
+ +
+
Source file
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_completion_service.proto
+
+ +
+
Operations
+
1
+
+ +
+ + +
+ + + + +
+

CommandCompletionService.CompletionStream

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Subscribe to command completion events.

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.CompletionStreamRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.CompletionStreamResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + + +
+ + + + + +## CommandService -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.CompletionStreamRequest`](#type-com-daml-ledger-api-v2-completionstreamrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.CompletionStreamResponse`](#type-com-daml-ledger-api-v2-completionstreamresponse) - - -### Service `CommandService` - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_service.proto#L23) -- Endpoints tracked: `3` Command Service is able to correlate submitted commands with completion data, identify timeouts, and return contextual information with each tracking result. This supports the implementation of stateless clients. @@ -125,113 +1024,173 @@ Command Service is able to correlate submitted commands with completion data, id Note that submitted commands generally produce completion events as well, even in case a command gets rejected. For example, the participant SHOULD produce a completion event for a rejection of a duplicate command. -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`SubmitAndWait`](#endpoint-com-daml-ledger-api-v2-commandservice-submitandwait) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.SubmitAndWaitRequest`](#type-com-daml-ledger-api-v2-submitandwaitrequest) | [`com.daml.ledger.api.v2.SubmitAndWaitResponse`](#type-com-daml-ledger-api-v2-submitandwaitresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_service.proto#L26) | -| [`SubmitAndWaitForReassignment`](#endpoint-com-daml-ledger-api-v2-commandservice-submitandwaitforreassignment) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.SubmitAndWaitForReassignmentRequest`](#type-com-daml-ledger-api-v2-submitandwaitforreassignmentrequest) | [`com.daml.ledger.api.v2.SubmitAndWaitForReassignmentResponse`](#type-com-daml-ledger-api-v2-submitandwaitforreassignmentresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_service.proto#L34) | -| [`SubmitAndWaitForTransaction`](#endpoint-com-daml-ledger-api-v2-commandservice-submitandwaitfortransaction) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.SubmitAndWaitForTransactionRequest`](#type-com-daml-ledger-api-v2-submitandwaitfortransactionrequest) | [`com.daml.ledger.api.v2.SubmitAndWaitForTransactionResponse`](#type-com-daml-ledger-api-v2-submitandwaitfortransactionresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_service.proto#L30) | - - -**Endpoint `CommandService.SubmitAndWait`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_service.proto#L26) - -**Signature** - -```protobuf -rpc CommandService.SubmitAndWait(com.daml.ledger.api.v2.SubmitAndWaitRequest) returns (com.daml.ledger.api.v2.SubmitAndWaitResponse); -``` - -Submits a single composite command and waits for its result. - Propagates the gRPC error of failed submissions including Daml interpretation errors. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.SubmitAndWaitRequest`](#type-com-daml-ledger-api-v2-submitandwaitrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.SubmitAndWaitResponse`](#type-com-daml-ledger-api-v2-submitandwaitresponse) - - -**Endpoint `CommandService.SubmitAndWaitForReassignment`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_service.proto#L34) - -**Signature** - -```protobuf -rpc CommandService.SubmitAndWaitForReassignment(com.daml.ledger.api.v2.SubmitAndWaitForReassignmentRequest) returns (com.daml.ledger.api.v2.SubmitAndWaitForReassignmentResponse); -``` - -Submits a single composite reassignment command, waits for its result, and returns the reassignment. - Propagates the gRPC error of failed submission. - -**History** -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | +
+ +
+
Source file
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_service.proto
+
+ +
+
Operations
+
3
+
+ +
+ + +
+ + + + +
+

CommandService.SubmitAndWait

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Submits a single composite command and waits for its result. Propagates the gRPC error of failed submissions including Daml interpretation errors.

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.SubmitAndWaitRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.SubmitAndWaitResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

CommandService.SubmitAndWaitForReassignment

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Submits a single composite reassignment command, waits for its result, and returns the reassignment. Propagates the gRPC error of failed submission.

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.SubmitAndWaitForReassignmentRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.SubmitAndWaitForReassignmentResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

CommandService.SubmitAndWaitForTransaction

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Submits a single composite command, waits for its result, and returns the transaction. Propagates the gRPC error of failed submissions including Daml interpretation errors.

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.SubmitAndWaitForTransactionRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.SubmitAndWaitForTransactionResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## CommandSubmissionService -**Request Type** - -- [`com.daml.ledger.api.v2.SubmitAndWaitForReassignmentRequest`](#type-com-daml-ledger-api-v2-submitandwaitforreassignmentrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.SubmitAndWaitForReassignmentResponse`](#type-com-daml-ledger-api-v2-submitandwaitforreassignmentresponse) - - -**Endpoint `CommandService.SubmitAndWaitForTransaction`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_service.proto#L30) - -**Signature** - -```protobuf -rpc CommandService.SubmitAndWaitForTransaction(com.daml.ledger.api.v2.SubmitAndWaitForTransactionRequest) returns (com.daml.ledger.api.v2.SubmitAndWaitForTransactionResponse); -``` - -Submits a single composite command, waits for its result, and returns the transaction. - Propagates the gRPC error of failed submissions including Daml interpretation errors. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.SubmitAndWaitForTransactionRequest`](#type-com-daml-ledger-api-v2-submitandwaitfortransactionrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.SubmitAndWaitForTransactionResponse`](#type-com-daml-ledger-api-v2-submitandwaitfortransactionresponse) - - -### Service `CommandSubmissionService` - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_submission_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_submission_service.proto#L29) -- Endpoints tracked: `2` Allows clients to attempt advancing the ledger's state by submitting commands. The final states of their submissions are disclosed by the Command Completion Service. @@ -248,459 +1207,715 @@ Allows clients to attempt advancing the ledger's state by submitting commands. Clients that do not receive a successful completion about their submission MUST NOT assume that it was successful. Clients SHOULD subscribe to the CompletionStream before starting to submit commands to prevent race conditions. -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`Submit`](#endpoint-com-daml-ledger-api-v2-commandsubmissionservice-submit) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.SubmitRequest`](#type-com-daml-ledger-api-v2-submitrequest) | [`com.daml.ledger.api.v2.SubmitResponse`](#type-com-daml-ledger-api-v2-submitresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_submission_service.proto#L31) | -| [`SubmitReassignment`](#endpoint-com-daml-ledger-api-v2-commandsubmissionservice-submitreassignment) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.SubmitReassignmentRequest`](#type-com-daml-ledger-api-v2-submitreassignmentrequest) | [`com.daml.ledger.api.v2.SubmitReassignmentResponse`](#type-com-daml-ledger-api-v2-submitreassignmentresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_submission_service.proto#L34) | - - -**Endpoint `CommandSubmissionService.Submit`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_submission_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_submission_service.proto#L31) - -**Signature** - -```protobuf -rpc CommandSubmissionService.Submit(com.daml.ledger.api.v2.SubmitRequest) returns (com.daml.ledger.api.v2.SubmitResponse); -``` - -Submit a single composite command. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.SubmitRequest`](#type-com-daml-ledger-api-v2-submitrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.SubmitResponse`](#type-com-daml-ledger-api-v2-submitresponse) - - -**Endpoint `CommandSubmissionService.SubmitReassignment`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_submission_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_submission_service.proto#L34) - -**Signature** - -```protobuf -rpc CommandSubmissionService.SubmitReassignment(com.daml.ledger.api.v2.SubmitReassignmentRequest) returns (com.daml.ledger.api.v2.SubmitReassignmentResponse); -``` - -Submit a single reassignment. -**History** +
+ +
+
Source file
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_submission_service.proto
+
+ +
+
Operations
+
2
+
+ +
+ + +
+ + + + +
+

CommandSubmissionService.Submit

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Submit a single composite command.

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.SubmitRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.SubmitResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

CommandSubmissionService.SubmitReassignment

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Submit a single reassignment.

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.SubmitReassignmentRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.SubmitReassignmentResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## ContractService -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.SubmitReassignmentRequest`](#type-com-daml-ledger-api-v2-submitreassignmentrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.SubmitReassignmentResponse`](#type-com-daml-ledger-api-v2-submitreassignmentresponse) - - -### Service `ContractService` - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/contract_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/contract_service.proto#L15) -- Endpoints tracked: `1` This service is experimental / alpha, therefore no backwards compatibility is guaranteed. -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`GetContract`](#endpoint-com-daml-ledger-api-v2-contractservice-getcontract) | `3.4.11` | `3.4.11` | `` | [`com.daml.ledger.api.v2.GetContractRequest`](#type-com-daml-ledger-api-v2-getcontractrequest) | [`com.daml.ledger.api.v2.GetContractResponse`](#type-com-daml-ledger-api-v2-getcontractresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/contract_service.proto#L22) | - - -**Endpoint `ContractService.GetContract`** - -- Introduced in: `3.4.11` -- Last changed in: `3.4.11` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/contract_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/contract_service.proto#L22) - -**Signature** - -```protobuf -rpc ContractService.GetContract(com.daml.ledger.api.v2.GetContractRequest) returns (com.daml.ledger.api.v2.GetContractResponse); -``` - -Looking up contract data by contract ID. - This endpoint is experimental / alpha, therefore no backwards compatibility is guaranteed. - This endpoint must not be used to look up contracts which entered the participant via party replication - or repair service. - If there is no contract exist with the contract ID, or there is no intersection with the querying_parties, - an CONTRACT_PAYLOAD_NOT_FOUND error will be raised. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.11` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.GetContractRequest`](#type-com-daml-ledger-api-v2-getcontractrequest) - -**Response Type** -- [`com.daml.ledger.api.v2.GetContractResponse`](#type-com-daml-ledger-api-v2-getcontractresponse) +
+ +
+
Source file
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/contract_service.proto
+
+ +
+
Operations
+
1
+
+ +
+ + +
+ + + + +
+

ContractService.GetContract

+ +
+ + gRPC + + Since 3.4.11 + +
+ +
+ +

Looking up contract data by contract ID. This endpoint is experimental / alpha, therefore no backwards compatibility is guaranteed. This endpoint must not be used to look up con...

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.GetContractRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.GetContractResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## EventQueryService - -### Service `EventQueryService` - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/event_query_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/event_query_service.proto#L32) -- Endpoints tracked: `1` Query events by contract id. Note that querying by contract key is not (yet) supported, as contract keys are not supported (yet) in multi-synchronizer scenarios. -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`GetEventsByContractId`](#endpoint-com-daml-ledger-api-v2-eventqueryservice-geteventsbycontractid) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.GetEventsByContractIdRequest`](#type-com-daml-ledger-api-v2-geteventsbycontractidrequest) | [`com.daml.ledger.api.v2.GetEventsByContractIdResponse`](#type-com-daml-ledger-api-v2-geteventsbycontractidresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/event_query_service.proto#L37) | - - -**Endpoint `EventQueryService.GetEventsByContractId`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/event_query_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/event_query_service.proto#L37) - -**Signature** - -```protobuf -rpc EventQueryService.GetEventsByContractId(com.daml.ledger.api.v2.GetEventsByContractIdRequest) returns (com.daml.ledger.api.v2.GetEventsByContractIdResponse); -``` - -Get the create and the consuming exercise event for the contract with the provided ID. - No events will be returned for contracts that have been pruned because they - have already been archived before the latest pruning offset. - If the contract cannot be found for the request, or all the contract-events are filtered, a CONTRACT_EVENTS_NOT_FOUND error will be raised. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | -**Request Type** +
+ +
+
Source file
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/event_query_service.proto
+
+ +
+
Operations
+
1
+
+ +
+ + +
+ + + + +
+

EventQueryService.GetEventsByContractId

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Get the create and the consuming exercise event for the contract with the provided ID. No events will be returned for contracts that have been pruned because they have already b...

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.GetEventsByContractIdRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.GetEventsByContractIdResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## PackageService -- [`com.daml.ledger.api.v2.GetEventsByContractIdRequest`](#type-com-daml-ledger-api-v2-geteventsbycontractidrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.GetEventsByContractIdResponse`](#type-com-daml-ledger-api-v2-geteventsbycontractidresponse) - - -### Service `PackageService` - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto#L54) -- Endpoints tracked: `4` Allows clients to query the Daml-LF packages that are supported by the server. -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`GetPackage`](#endpoint-com-daml-ledger-api-v2-packageservice-getpackage) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.GetPackageRequest`](#type-com-daml-ledger-api-v2-getpackagerequest) | [`com.daml.ledger.api.v2.GetPackageResponse`](#type-com-daml-ledger-api-v2-getpackageresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto#L59) | -| [`GetPackageStatus`](#endpoint-com-daml-ledger-api-v2-packageservice-getpackagestatus) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.GetPackageStatusRequest`](#type-com-daml-ledger-api-v2-getpackagestatusrequest) | [`com.daml.ledger.api.v2.GetPackageStatusResponse`](#type-com-daml-ledger-api-v2-getpackagestatusresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto#L62) | -| [`ListPackages`](#endpoint-com-daml-ledger-api-v2-packageservice-listpackages) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.ListPackagesRequest`](#type-com-daml-ledger-api-v2-listpackagesrequest) | [`com.daml.ledger.api.v2.ListPackagesResponse`](#type-com-daml-ledger-api-v2-listpackagesresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto#L56) | -| [`ListVettedPackages`](#endpoint-com-daml-ledger-api-v2-packageservice-listvettedpackages) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.ListVettedPackagesRequest`](#type-com-daml-ledger-api-v2-listvettedpackagesrequest) | [`com.daml.ledger.api.v2.ListVettedPackagesResponse`](#type-com-daml-ledger-api-v2-listvettedpackagesresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto#L66) | - - -**Endpoint `PackageService.GetPackage`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto#L59) - -**Signature** - -```protobuf -rpc PackageService.GetPackage(com.daml.ledger.api.v2.GetPackageRequest) returns (com.daml.ledger.api.v2.GetPackageResponse); -``` - -Returns the contents of a single package. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.GetPackageRequest`](#type-com-daml-ledger-api-v2-getpackagerequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.GetPackageResponse`](#type-com-daml-ledger-api-v2-getpackageresponse) - - -**Endpoint `PackageService.GetPackageStatus`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto#L62) - -**Signature** - -```protobuf -rpc PackageService.GetPackageStatus(com.daml.ledger.api.v2.GetPackageStatusRequest) returns (com.daml.ledger.api.v2.GetPackageStatusResponse); -``` - -Returns the status of a single package. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.GetPackageStatusRequest`](#type-com-daml-ledger-api-v2-getpackagestatusrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.GetPackageStatusResponse`](#type-com-daml-ledger-api-v2-getpackagestatusresponse) - - -**Endpoint `PackageService.ListPackages`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto#L56) - -**Signature** - -```protobuf -rpc PackageService.ListPackages(com.daml.ledger.api.v2.ListPackagesRequest) returns (com.daml.ledger.api.v2.ListPackagesResponse); -``` - -Returns the identifiers of all supported packages. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.ListPackagesRequest`](#type-com-daml-ledger-api-v2-listpackagesrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.ListPackagesResponse`](#type-com-daml-ledger-api-v2-listpackagesresponse) - - -**Endpoint `PackageService.ListVettedPackages`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto#L66) - -**Signature** -```protobuf -rpc PackageService.ListVettedPackages(com.daml.ledger.api.v2.ListVettedPackagesRequest) returns (com.daml.ledger.api.v2.ListVettedPackagesResponse); -``` +
+ +
+
Source file
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto
+
+ +
+
Operations
+
4
+
+ +
+ + +
+ + + + +
+

PackageService.GetPackage

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Returns the contents of a single package.

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.GetPackageRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.GetPackageResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

PackageService.GetPackageStatus

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Returns the status of a single package.

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.GetPackageStatusRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.GetPackageStatusResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

PackageService.ListPackages

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Returns the identifiers of all supported packages.

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.ListPackagesRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.ListPackagesResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

PackageService.ListVettedPackages

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Lists which participant node vetted what packages on which synchronizer. Can be called by any authenticated user.

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.ListVettedPackagesRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.ListVettedPackagesResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## StateService -Lists which participant node vetted what packages on which synchronizer. - Can be called by any authenticated user. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.ListVettedPackagesRequest`](#type-com-daml-ledger-api-v2-listvettedpackagesrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.ListVettedPackagesResponse`](#type-com-daml-ledger-api-v2-listvettedpackagesresponse) - - -### Service `StateService` - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto#L17) -- Endpoints tracked: `4` Allows clients to get state from the ledger. -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`GetActiveContracts`](#endpoint-com-daml-ledger-api-v2-stateservice-getactivecontracts) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.GetActiveContractsRequest`](#type-com-daml-ledger-api-v2-getactivecontractsrequest) | [`com.daml.ledger.api.v2.GetActiveContractsResponse`](#type-com-daml-ledger-api-v2-getactivecontractsresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto#L23) | -| [`GetConnectedSynchronizers`](#endpoint-com-daml-ledger-api-v2-stateservice-getconnectedsynchronizers) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.GetConnectedSynchronizersRequest`](#type-com-daml-ledger-api-v2-getconnectedsynchronizersrequest) | [`com.daml.ledger.api.v2.GetConnectedSynchronizersResponse`](#type-com-daml-ledger-api-v2-getconnectedsynchronizersresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto#L26) | -| [`GetLatestPrunedOffsets`](#endpoint-com-daml-ledger-api-v2-stateservice-getlatestprunedoffsets) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.GetLatestPrunedOffsetsRequest`](#type-com-daml-ledger-api-v2-getlatestprunedoffsetsrequest) | [`com.daml.ledger.api.v2.GetLatestPrunedOffsetsResponse`](#type-com-daml-ledger-api-v2-getlatestprunedoffsetsresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto#L33) | -| [`GetLedgerEnd`](#endpoint-com-daml-ledger-api-v2-stateservice-getledgerend) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.GetLedgerEndRequest`](#type-com-daml-ledger-api-v2-getledgerendrequest) | [`com.daml.ledger.api.v2.GetLedgerEndResponse`](#type-com-daml-ledger-api-v2-getledgerendresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto#L30) | - - -**Endpoint `StateService.GetActiveContracts`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto#L23) - -**Signature** - -```protobuf -rpc StateService.GetActiveContracts(com.daml.ledger.api.v2.GetActiveContractsRequest) returns (stream com.daml.ledger.api.v2.GetActiveContractsResponse); -``` - -Returns a stream of the snapshot of the active contracts and incomplete (un)assignments at a ledger offset. - Once the stream of GetActiveContractsResponses completes, - the client SHOULD begin streaming updates from the update service, - starting at the GetActiveContractsRequest.active_at_offset specified in this request. - Clients SHOULD NOT assume that the set of active contracts they receive reflects the state at the ledger end. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.GetActiveContractsRequest`](#type-com-daml-ledger-api-v2-getactivecontractsrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.GetActiveContractsResponse`](#type-com-daml-ledger-api-v2-getactivecontractsresponse) - - -**Endpoint `StateService.GetConnectedSynchronizers`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto#L26) - -**Signature** - -```protobuf -rpc StateService.GetConnectedSynchronizers(com.daml.ledger.api.v2.GetConnectedSynchronizersRequest) returns (com.daml.ledger.api.v2.GetConnectedSynchronizersResponse); -``` - -Get the list of connected synchronizers at the time of the query. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.GetConnectedSynchronizersRequest`](#type-com-daml-ledger-api-v2-getconnectedsynchronizersrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.GetConnectedSynchronizersResponse`](#type-com-daml-ledger-api-v2-getconnectedsynchronizersresponse) - - -**Endpoint `StateService.GetLatestPrunedOffsets`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto#L33) -**Signature** +
+ +
+
Source file
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto
+
+ +
+
Operations
+
4
+
+ +
+ + +
+ + + + +
+

StateService.GetActiveContracts

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Returns a stream of the snapshot of the active contracts and incomplete (un)assignments at a ledger offset. Once the stream of GetActiveContractsResponses completes, the client...

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.GetActiveContractsRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.GetActiveContractsResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + + + + + +
+

StateService.GetConnectedSynchronizers

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Get the list of connected synchronizers at the time of the query.

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.GetConnectedSynchronizersRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.GetConnectedSynchronizersResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

StateService.GetLatestPrunedOffsets

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Get the latest successfully pruned ledger offsets

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.GetLatestPrunedOffsetsRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.GetLatestPrunedOffsetsResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

StateService.GetLedgerEnd

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Get the current ledger end. Subscriptions started with the returned offset will serve events after this RPC was called.

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.GetLedgerEndRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.GetLedgerEndResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## UpdateService -```protobuf -rpc StateService.GetLatestPrunedOffsets(com.daml.ledger.api.v2.GetLatestPrunedOffsetsRequest) returns (com.daml.ledger.api.v2.GetLatestPrunedOffsetsResponse); -``` - -Get the latest successfully pruned ledger offsets - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.GetLatestPrunedOffsetsRequest`](#type-com-daml-ledger-api-v2-getlatestprunedoffsetsrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.GetLatestPrunedOffsetsResponse`](#type-com-daml-ledger-api-v2-getlatestprunedoffsetsresponse) - - -**Endpoint `StateService.GetLedgerEnd`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto#L30) - -**Signature** - -```protobuf -rpc StateService.GetLedgerEnd(com.daml.ledger.api.v2.GetLedgerEndRequest) returns (com.daml.ledger.api.v2.GetLedgerEndResponse); -``` - -Get the current ledger end. - Subscriptions started with the returned offset will serve events after this RPC was called. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.GetLedgerEndRequest`](#type-com-daml-ledger-api-v2-getledgerendrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.GetLedgerEndResponse`](#type-com-daml-ledger-api-v2-getledgerendresponse) - - -### Service `UpdateService` - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/update_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/update_service.proto#L30) -- Endpoints tracked: `3` Allows clients to read updates (transactions, (un)assignments, topology events) from the ledger. @@ -715,1732 +1930,5583 @@ Allows clients to read updates (transactions, (un)assignments, topology events) synchronizer: updates which have greater offsets are happened after than updates with smaller offsets for the same synchronizer. Across different synchronizers this is not guaranteed. -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`GetUpdateById`](#endpoint-com-daml-ledger-api-v2-updateservice-getupdatebyid) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.GetUpdateByIdRequest`](#type-com-daml-ledger-api-v2-getupdatebyidrequest) | [`com.daml.ledger.api.v2.GetUpdateResponse`](#type-com-daml-ledger-api-v2-getupdateresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/update_service.proto#L45) | -| [`GetUpdateByOffset`](#endpoint-com-daml-ledger-api-v2-updateservice-getupdatebyoffset) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.GetUpdateByOffsetRequest`](#type-com-daml-ledger-api-v2-getupdatebyoffsetrequest) | [`com.daml.ledger.api.v2.GetUpdateResponse`](#type-com-daml-ledger-api-v2-getupdateresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/update_service.proto#L41) | -| [`GetUpdates`](#endpoint-com-daml-ledger-api-v2-updateservice-getupdates) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.GetUpdatesRequest`](#type-com-daml-ledger-api-v2-getupdatesrequest) | [`com.daml.ledger.api.v2.GetUpdatesResponse`](#type-com-daml-ledger-api-v2-getupdatesresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/update_service.proto#L37) | - - -**Endpoint `UpdateService.GetUpdateById`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/update_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/update_service.proto#L45) - -**Signature** - -```protobuf -rpc UpdateService.GetUpdateById(com.daml.ledger.api.v2.GetUpdateByIdRequest) returns (com.daml.ledger.api.v2.GetUpdateResponse); -``` - -Lookup an update by its ID. - If there is no update with this ID, or all the events are filtered, an UPDATE_NOT_FOUND error will be raised. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.GetUpdateByIdRequest`](#type-com-daml-ledger-api-v2-getupdatebyidrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.GetUpdateResponse`](#type-com-daml-ledger-api-v2-getupdateresponse) - - -**Endpoint `UpdateService.GetUpdateByOffset`** -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/update_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/update_service.proto#L41) +
+ +
+
Source file
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/update_service.proto
+
+ +
+
Operations
+
3
+
+ +
+ + +
+ + + + +
+

UpdateService.GetUpdateById

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Lookup an update by its ID. If there is no update with this ID, or all the events are filtered, an UPDATE_NOT_FOUND error will be raised.

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.GetUpdateByIdRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.GetUpdateResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

UpdateService.GetUpdateByOffset

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Lookup an update by its offset. If there is no update with this offset, or all the events are filtered, an UPDATE_NOT_FOUND error will be raised.

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.GetUpdateByOffsetRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.GetUpdateResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

UpdateService.GetUpdates

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Read the ledger's filtered update stream for the specified contents and filters. It returns the event types in accordance with the stream contents selected. Also the selection c...

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.GetUpdatesRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.GetUpdatesResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + + +
+ + + + + +## VersionService -**Signature** - -```protobuf -rpc UpdateService.GetUpdateByOffset(com.daml.ledger.api.v2.GetUpdateByOffsetRequest) returns (com.daml.ledger.api.v2.GetUpdateResponse); -``` - -Lookup an update by its offset. - If there is no update with this offset, or all the events are filtered, an UPDATE_NOT_FOUND error will be raised. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.GetUpdateByOffsetRequest`](#type-com-daml-ledger-api-v2-getupdatebyoffsetrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.GetUpdateResponse`](#type-com-daml-ledger-api-v2-getupdateresponse) - - -**Endpoint `UpdateService.GetUpdates`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/update_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/update_service.proto#L37) - -**Signature** - -```protobuf -rpc UpdateService.GetUpdates(com.daml.ledger.api.v2.GetUpdatesRequest) returns (stream com.daml.ledger.api.v2.GetUpdatesResponse); -``` - -Read the ledger's filtered update stream for the specified contents and filters. - It returns the event types in accordance with the stream contents selected. Also the selection criteria - for individual events depends on the transaction shape chosen. - - - ACS delta: a requesting party must be a stakeholder of an event for it to be included. - - ledger effects: a requesting party must be a witness of an en event for it to be included. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.GetUpdatesRequest`](#type-com-daml-ledger-api-v2-getupdatesrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.GetUpdatesResponse`](#type-com-daml-ledger-api-v2-getupdatesresponse) - - -### Service `VersionService` - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/version_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/version_service.proto#L16) -- Endpoints tracked: `1` Allows clients to retrieve information about the ledger API version -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`GetLedgerApiVersion`](#endpoint-com-daml-ledger-api-v2-versionservice-getledgerapiversion) | `3.4.0` | `3.4.0` | `` | [`com.daml.ledger.api.v2.GetLedgerApiVersionRequest`](#type-com-daml-ledger-api-v2-getledgerapiversionrequest) | [`com.daml.ledger.api.v2.GetLedgerApiVersionResponse`](#type-com-daml-ledger-api-v2-getledgerapiversionresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/version_service.proto#L18) | - - -**Endpoint `VersionService.GetLedgerApiVersion`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/version_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/version_service.proto#L18) - -**Signature** - -```protobuf -rpc VersionService.GetLedgerApiVersion(com.daml.ledger.api.v2.GetLedgerApiVersionRequest) returns (com.daml.ledger.api.v2.GetLedgerApiVersionResponse); -``` - -Read the Ledger API version - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.daml.ledger.api.v2.GetLedgerApiVersionRequest`](#type-com-daml-ledger-api-v2-getledgerapiversionrequest) - -**Response Type** - -- [`com.daml.ledger.api.v2.GetLedgerApiVersionResponse`](#type-com-daml-ledger-api-v2-getledgerapiversionresponse) - -## Type Reference - - -**Message `com.daml.ledger.api.v2.ActiveContract`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto#L96) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| created_event | [`com.daml.ledger.api.v2.CreatedEvent`](#type-com-daml-ledger-api-v2-createdevent) | optional | Required
The event as it appeared in the context of its last update (i.e. daml transaction or
reassignment). In particular, the last offset, node_id pair is preserved.
The last update is the most recent update created or assigned this contract on synchronizer_id synchronizer.
The offset of the CreatedEvent might point to an already pruned update, therefore it cannot necessarily be used
for lookups. | -| synchronizer_id | `string` | optional | A valid synchronizer id
Required | -| reassignment_counter | `uint64` | optional | Each corresponding assigned and unassigned event has the same reassignment_counter. This strictly increases
with each unassign command for the same contract. Creation of the contract corresponds to reassignment_counter
equals zero.
This field will be the reassignment_counter of the latest observable activation event on this synchronizer, which is
before the active_at_offset.
Required | - - -**Message `com.daml.ledger.api.v2.Archived`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/event_query_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/event_query_service.proto#L64) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| archived_event | [`com.daml.ledger.api.v2.ArchivedEvent`](#type-com-daml-ledger-api-v2-archivedevent) | optional | Required | -| synchronizer_id | `string` | optional | Required
The synchronizer which sequenced the archival of the contract | - - -**Message `com.daml.ledger.api.v2.ArchivedEvent`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/event.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/event.proto#L171) -- Fields: 7 - -Records that a contract has been archived, and choices may no longer be exercised on it. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| offset | `int64` | optional | The offset of origin.
Offsets are managed by the participant nodes.
Transactions can thus NOT be assumed to have the same offsets on different participant nodes.
Required, it is a valid absolute offset (positive integer) | -| node_id | `int32` | optional | The position of this event in the originating transaction or reassignment.
Node IDs are not necessarily equal across participants,
as these may see different projections/parts of transactions.
Required, must be valid node ID (non-negative integer) | -| contract_id | `string` | optional | The ID of the archived contract.
Must be a valid LedgerString (as described in ``value.proto``).
Required | -| template_id | `com.daml.ledger.api.v2.Identifier` | optional | Identifies the template that defines the choice that archived the contract.
This template's package-id may differ from the target contract's package-id
if the target contract has been upgraded or downgraded.

The identifier uses the package-id reference format.

Required | -| witness_parties | `string` | repeated | The parties that are notified of this event. For an ``ArchivedEvent``,
these are the intersection of the stakeholders of the contract in
question and the parties specified in the ``TransactionFilter``. The
stakeholders are the union of the signatories and the observers of
the contract.
Each one of its elements must be a valid PartyIdString (as described
in ``value.proto``).
Required | -| package_name | `string` | optional | The package name of the contract.
Required | -| implemented_interfaces | `com.daml.ledger.api.v2.Identifier` | repeated | The interfaces implemented by the target template that have been
matched from the interface filter query.
Populated only in case interface filters with include_interface_view set.

If defined, the identifier uses the package-id reference format.

Optional | - - -**Message `com.daml.ledger.api.v2.AssignCommand`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/reassignment_commands.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/reassignment_commands.proto#L77) -- Fields: 3 - -Assign a contract - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| reassignment_id | `string` | optional | The ID from the unassigned event to be completed by this assignment.
Must be a valid LedgerString (as described in ``value.proto``).
Required | -| source | `string` | optional | The ID of the source synchronizer
Must be a valid synchronizer id
Required | -| target | `string` | optional | The ID of the target synchronizer
Must be a valid synchronizer id
Required | - - -**Message `com.daml.ledger.api.v2.AssignedEvent`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/reassignment.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/reassignment.proto#L138) -- Fields: 6 - -Records that a contract has been assigned, and it can be used on the target synchronizer. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| source | `string` | optional | The ID of the source synchronizer.
Must be a valid synchronizer id.
Required | -| target | `string` | optional | The ID of the target synchronizer.
Must be a valid synchronizer id.
Required | -| reassignment_id | `string` | optional | The ID from the unassigned event.
For correlation capabilities.
Must be a valid LedgerString (as described in ``value.proto``).
Required | -| submitter | `string` | optional | Party on whose behalf the assign command was executed.
Empty if the assignment happened offline via the repair service.
Must be a valid PartyIdString (as described in ``value.proto``).
Optional | -| reassignment_counter | `uint64` | optional | Each corresponding assigned and unassigned event has the same reassignment_counter. This strictly increases
with each unassign command for the same contract. Creation of the contract corresponds to reassignment_counter
equals zero.
Required | -| created_event | [`com.daml.ledger.api.v2.CreatedEvent`](#type-com-daml-ledger-api-v2-createdevent) | optional | Required
The offset of this event refers to the offset of the assignment,
while the node_id is the index of within the batch. | - - -**Message `com.daml.ledger.api.v2.Command`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/commands.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/commands.proto#L17) -- Fields: 4 - -A command can either create a new contract or exercise a choice on an existing contract. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| create | [`com.daml.ledger.api.v2.CreateCommand`](#type-com-daml-ledger-api-v2-createcommand) | optional | | -| exercise | [`com.daml.ledger.api.v2.ExerciseCommand`](#type-com-daml-ledger-api-v2-exercisecommand) | optional | | -| exercise_by_key | [`com.daml.ledger.api.v2.ExerciseByKeyCommand`](#type-com-daml-ledger-api-v2-exercisebykeycommand) | optional | | -| create_and_exercise | [`com.daml.ledger.api.v2.CreateAndExerciseCommand`](#type-com-daml-ledger-api-v2-createandexercisecommand) | optional | | - - -**Message `com.daml.ledger.api.v2.Commands`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/commands.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/commands.proto#L138) -- Fields: 15 - -A composite command that groups multiple commands together. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| workflow_id | `string` | optional | Identifier of the on-ledger workflow that this command is a part of.
Must be a valid LedgerString (as described in ``value.proto``).
Optional | -| user_id | `string` | optional | Uniquely identifies the participant user that issued the command.
Must be a valid UserIdString (as described in ``value.proto``).
Required unless authentication is used with a user token.
In that case, the token's user-id will be used for the request's user_id. | -| command_id | `string` | optional | Uniquely identifies the command.
The triple (user_id, act_as, command_id) constitutes the change ID for the intended ledger change,
where act_as is interpreted as a set of party names.
The change ID can be used for matching the intended ledger changes with all their completions.
Must be a valid LedgerString (as described in ``value.proto``).
Required | -| commands | [`com.daml.ledger.api.v2.Command`](#type-com-daml-ledger-api-v2-command) | repeated | Individual elements of this atomic command. Must be non-empty.
Required | -| deduplication_duration | `google.protobuf.Duration` | optional | Specifies the length of the deduplication period.
It is interpreted relative to the local clock at some point during the submission's processing.
Must be non-negative. Must not exceed the maximum deduplication time. | -| deduplication_offset | `int64` | optional | Specifies the start of the deduplication period by a completion stream offset (exclusive).
Must be a valid absolute offset (positive integer) or participant begin (zero). | -| min_ledger_time_abs | `google.protobuf.Timestamp` | optional | Lower bound for the ledger time assigned to the resulting transaction.
Note: The ledger time of a transaction is assigned as part of command interpretation.
Use this property if you expect that command interpretation will take a considerate amount of time, such that by
the time the resulting transaction is sequenced, its assigned ledger time is not valid anymore.
Must not be set at the same time as min_ledger_time_rel.
Optional | -| min_ledger_time_rel | `google.protobuf.Duration` | optional | Same as min_ledger_time_abs, but specified as a duration, starting from the time the command is received by the server.
Must not be set at the same time as min_ledger_time_abs.
Optional | -| act_as | `string` | repeated | Set of parties on whose behalf the command should be executed.
If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request
to act on behalf of each of the given parties.
Each element must be a valid PartyIdString (as described in ``value.proto``).
Required, must be non-empty. | -| read_as | `string` | repeated | Set of parties on whose behalf (in addition to all parties listed in ``act_as``) contracts can be retrieved.
This affects Daml operations such as ``fetch``, ``fetchByKey``, ``lookupByKey``, ``exercise``, and ``exerciseByKey``.
Note: A participant node of a Daml network can host multiple parties. Each contract present on the participant
node is only visible to a subset of these parties. A command can only use contracts that are visible to at least
one of the parties in ``act_as`` or ``read_as``. This visibility check is independent from the Daml authorization
rules for fetch operations.
If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request
to read contract data on behalf of each of the given parties.
Optional | -| submission_id | `string` | optional | A unique identifier to distinguish completions for different submissions with the same change ID.
Typically a random UUID. Applications are expected to use a different UUID for each retry of a submission
with the same change ID.
Must be a valid LedgerString (as described in ``value.proto``).

If omitted, the participant or the committer may set a value of their choice.
Optional | -| disclosed_contracts | [`com.daml.ledger.api.v2.DisclosedContract`](#type-com-daml-ledger-api-v2-disclosedcontract) | repeated | Additional contracts used to resolve contract & contract key lookups.
Optional | -| synchronizer_id | `string` | optional | Must be a valid synchronizer id
Optional | -| package_id_selection_preference | `string` | repeated | The package-id selection preference of the client for resolving
package names and interface instances in command submission and interpretation | -| prefetch_contract_keys | [`com.daml.ledger.api.v2.PrefetchContractKey`](#type-com-daml-ledger-api-v2-prefetchcontractkey) | repeated | Fetches the contract keys into the caches to speed up the command processing.
Should only contain contract keys that are expected to be resolved during interpretation of the commands.
Keys of disclosed contracts do not need prefetching.

Optional | - - -**Message `com.daml.ledger.api.v2.Completion`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/completion.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/completion.proto#L18) -- Fields: 11 - -A completion represents the status of a submitted command on the ledger: it can be successful or failed. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| command_id | `string` | optional | The ID of the succeeded or failed command.
Must be a valid LedgerString (as described in ``value.proto``).
Required | -| status | `google.rpc.Status` | optional | Identifies the exact type of the error.
It uses the same format of conveying error details as it is used for the RPC responses of the APIs.
Optional | -| update_id | `string` | optional | The update_id of the transaction or reassignment that resulted from the command with command_id.
Only set for successfully executed commands.
Must be a valid LedgerString (as described in ``value.proto``). | -| user_id | `string` | optional | The user-id that was used for the submission, as described in ``commands.proto``.
Must be a valid UserIdString (as described in ``value.proto``).
Optional for historic completions where this data is not available. | -| act_as | `string` | repeated | The set of parties on whose behalf the commands were executed.
Contains the ``act_as`` parties from ``commands.proto``
filtered to the requesting parties in CompletionStreamRequest.
The order of the parties need not be the same as in the submission.
Each element must be a valid PartyIdString (as described in ``value.proto``).
Optional for historic completions where this data is not available. | -| submission_id | `string` | optional | The submission ID this completion refers to, as described in ``commands.proto``.
Must be a valid LedgerString (as described in ``value.proto``).
Optional | -| deduplication_offset | `int64` | optional | Specifies the start of the deduplication period by a completion stream offset (exclusive).

Must be a valid absolute offset (positive integer) or participant begin (zero). | -| deduplication_duration | `google.protobuf.Duration` | optional | Specifies the length of the deduplication period.
It is measured in record time of completions.

Must be non-negative. | -| trace_context | [`com.daml.ledger.api.v2.TraceContext`](#type-com-daml-ledger-api-v2-tracecontext) | optional | Optional; ledger API trace context

The trace context transported in this message corresponds to the trace context supplied
by the client application in a HTTP2 header of the original command submission.
We typically use a header to transfer this type of information. Here we use message
body, because it is used in gRPC streams which do not support per message headers.
This field will be populated with the trace context contained in the original submission.
If that was not provided, a unique ledger-api-server generated trace context will be used
instead. | -| offset | `int64` | optional | May be used in a subsequent CompletionStreamRequest to resume the consumption of this stream at a later time.
Required, must be a valid absolute offset (positive integer). | -| synchronizer_time | [`com.daml.ledger.api.v2.SynchronizerTime`](#type-com-daml-ledger-api-v2-synchronizertime) | optional | The synchronizer along with its record time.
The synchronizer id provided, in case of

- successful/failed transactions: identifies the synchronizer of the transaction
- for successful/failed unassign commands: identifies the source synchronizer
- for successful/failed assign commands: identifies the target synchronizer

Required | - - -**Message `com.daml.ledger.api.v2.CompletionStreamRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_completion_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_completion_service.proto#L34) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| user_id | `string` | optional | Only completions of commands submitted with the same user_id will be visible in the stream.
Must be a valid UserIdString (as described in ``value.proto``).
Required unless authentication is used with a user token.
In that case, the token's user-id will be used for the request's user_id. | -| parties | `string` | repeated | Non-empty list of parties whose data should be included.
The stream shows only completions of commands for which at least one of the ``act_as`` parties is in the given set of parties.
Must be a valid PartyIdString (as described in ``value.proto``).
Required | -| begin_exclusive | `int64` | optional | This optional field indicates the minimum offset for completions. This can be used to resume an earlier completion stream.
If not set the ledger uses the ledger begin offset instead.
If specified, it must be a valid absolute offset (positive integer) or zero (ledger begin offset).
If the ledger has been pruned, this parameter must be specified and greater than the pruning offset. | - - -**Message `com.daml.ledger.api.v2.CompletionStreamResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_completion_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_completion_service.proto#L54) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| completion | [`com.daml.ledger.api.v2.Completion`](#type-com-daml-ledger-api-v2-completion) | optional | | -| offset_checkpoint | [`com.daml.ledger.api.v2.OffsetCheckpoint`](#type-com-daml-ledger-api-v2-offsetcheckpoint) | optional | | - - -**Message `com.daml.ledger.api.v2.CreateAndExerciseCommand`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/commands.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/commands.proto#L89) -- Fields: 4 - -Create a contract and exercise a choice on it in the same transaction. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| template_id | `com.daml.ledger.api.v2.Identifier` | optional | The template of the contract the client wants to create.
Both package-name and package-id reference identifier formats for the template-id are supported.
Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4.

Required | -| create_arguments | `com.daml.ledger.api.v2.Record` | optional | The arguments required for creating a contract from this template.
Required | -| choice | `string` | optional | The name of the choice the client wants to exercise.
Must be a valid NameString (as described in ``value.proto``).
Required | -| choice_argument | `com.daml.ledger.api.v2.Value` | optional | The argument for this choice.
Required | - - -**Message `com.daml.ledger.api.v2.CreateCommand`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/commands.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/commands.proto#L27) -- Fields: 2 - -Create a new contract instance based on a template. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| template_id | `com.daml.ledger.api.v2.Identifier` | optional | The template of contract the client wants to create.
Both package-name and package-id reference identifier formats for the template-id are supported.
Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4.

Required | -| create_arguments | `com.daml.ledger.api.v2.Record` | optional | The arguments required for creating a contract from this template.
Required | - - -**Message `com.daml.ledger.api.v2.Created`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/event_query_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/event_query_service.proto#L52) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| created_event | [`com.daml.ledger.api.v2.CreatedEvent`](#type-com-daml-ledger-api-v2-createdevent) | optional | Required
The event as it appeared in the context of its original update (i.e. daml transaction or
reassignment) on this participant node. You can use its offset and node_id to find the
corresponding update and the node within it. | -| synchronizer_id | `string` | optional | The synchronizer which sequenced the creation of the contract
Required | - - -**Message `com.daml.ledger.api.v2.CreatedEvent`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/event.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/event.proto#L37) -- Fields: 15 - -Records that a contract has been created, and choices may now be exercised on it. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| offset | `int64` | optional | The offset of origin, which has contextual meaning, please see description at messages that include a CreatedEvent.
Offsets are managed by the participant nodes.
Transactions can thus NOT be assumed to have the same offsets on different participant nodes.
Required, it is a valid absolute offset (positive integer) | -| node_id | `int32` | optional | The position of this event in the originating transaction or reassignment.
The origin has contextual meaning, please see description at messages that include a CreatedEvent.
Node IDs are not necessarily equal across participants,
as these may see different projections/parts of transactions.
Required, must be valid node ID (non-negative integer) | -| contract_id | `string` | optional | The ID of the created contract.
Must be a valid LedgerString (as described in ``value.proto``).
Required | -| template_id | `com.daml.ledger.api.v2.Identifier` | optional | The template of the created contract.
The identifier uses the package-id reference format.

Required | -| contract_key | `com.daml.ledger.api.v2.Value` | optional | The key of the created contract.
This will be set if and only if ``template_id`` defines a contract key.
Optional | -| create_arguments | `com.daml.ledger.api.v2.Record` | optional | The arguments that have been used to create the contract.

Required | -| created_event_blob | `bytes` | optional | Opaque representation of contract create event payload intended for forwarding
to an API server as a contract disclosed as part of a command
submission.
Optional | -| interface_views | [`com.daml.ledger.api.v2.InterfaceView`](#type-com-daml-ledger-api-v2-interfaceview) | repeated | Interface views specified in the transaction filter.
Includes an ``InterfaceView`` for each interface for which there is a ``InterfaceFilter`` with

- its party in the ``witness_parties`` of this event,
- and which is implemented by the template of this event,
- and which has ``include_interface_view`` set.

Optional | -| witness_parties | `string` | repeated | The parties that are notified of this event. When a ``CreatedEvent``
is returned as part of a transaction tree or ledger-effects transaction, this will include all
the parties specified in the ``TransactionFilter`` that are witnesses of the event
(the stakeholders of the contract and all informees of all the ancestors
of this create action that this participant knows about).
If served as part of a ACS delta transaction those will
be limited to all parties specified in the ``TransactionFilter`` that
are stakeholders of the contract (i.e. either signatories or observers).
If the ``CreatedEvent`` is returned as part of an AssignedEvent,
ActiveContract or IncompleteUnassigned (so the event is related to
an assignment or unassignment): this will include all parties of the
``TransactionFilter`` that are stakeholders of the contract.

The behavior of reading create events visible to parties not hosted
on the participant node serving the Ledger API is undefined. Concretely,
there is neither a guarantee that the participant node will serve all their
create events on the ACS stream, nor is there a guarantee that matching archive
events are delivered for such create events.

For most clients this is not a problem, as they only read events for parties
that are hosted on the participant node. If you need to read events
for parties that may not be hosted at all times on the participant node,
subscribe to the ``TopologyEvent``s for that party by setting a corresponding
``UpdateFormat``. Using these events, query the ACS as-of an offset where the
party is hosted on the participant node, and ignore create events at offsets
where the party is not hosted on the participant node.
Required | -| signatories | `string` | repeated | The signatories for this contract as specified by the template.
Required | -| observers | `string` | repeated | The observers for this contract as specified explicitly by the template or implicitly as choice controllers.
This field never contains parties that are signatories.
Required | -| created_at | `google.protobuf.Timestamp` | optional | Ledger effective time of the transaction that created the contract.
Required | -| package_name | `string` | optional | The package name of the created contract.
Required | -| acs_delta | `bool` | optional | Whether this event would be part of respective ACS_DELTA shaped stream,
and should therefore considered when tracking contract activeness on the client-side.
Required | -| representative_package_id | `string` | optional | A package-id present in the participant package store that typechecks the contract's argument.
This may differ from the package-id of the template used to create the contract.
For contracts created before Canton 3.4, this field matches the contract's creation package-id.

NOTE: Experimental, server internal concept, not for client consumption. Subject to change without notice.

Required | - - -**Message `com.daml.ledger.api.v2.CumulativeFilter`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/transaction_filter.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/transaction_filter.proto#L29) -- Fields: 3 - -A filter that matches all contracts that are either an instance of one of - the ``template_filters`` or that match one of the ``interface_filters``. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| wildcard_filter | [`com.daml.ledger.api.v2.WildcardFilter`](#type-com-daml-ledger-api-v2-wildcardfilter) | optional | A wildcard filter that matches all templates
Optional | -| interface_filter | [`com.daml.ledger.api.v2.InterfaceFilter`](#type-com-daml-ledger-api-v2-interfacefilter) | optional | Include an ``InterfaceView`` for every ``InterfaceFilter`` matching a contract.
The ``InterfaceFilter`` instances MUST each use a unique ``interface_id``.
Optional | -| template_filter | [`com.daml.ledger.api.v2.TemplateFilter`](#type-com-daml-ledger-api-v2-templatefilter) | optional | A template for which the data will be included in the
``create_arguments`` of a matching ``CreatedEvent``.
If a contract is simultaneously selected by a template filter and one or more interface filters,
the corresponding ``include_created_event_blob`` are consolidated using an OR operation.
Optional | - - -**Message `com.daml.ledger.api.v2.DisclosedContract`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/commands.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/commands.proto#L113) -- Fields: 4 - -An additional contract that is used to resolve - contract & contract key lookups. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| template_id | `com.daml.ledger.api.v2.Identifier` | optional | The template id of the contract.
The identifier uses the package-id reference format.

If provided, used to validate the template id of the contract serialized in the created_event_blob.
Optional | -| contract_id | `string` | optional | The contract id

If provided, used to validate the contract id of the contract serialized in the created_event_blob.
Optional | -| created_event_blob | `bytes` | optional | Opaque byte string containing the complete payload required by the Daml engine
to reconstruct a contract not known to the receiving participant.
Required | -| synchronizer_id | `string` | optional | The ID of the synchronizer where the contract is currently assigned
Optional | - - -**Message `com.daml.ledger.api.v2.Event`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/event.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/event.proto#L26) -- Fields: 3 - -Events in transactions can have two primary shapes: - - - ACS delta: events can be CreatedEvent or ArchivedEvent - - ledger effects: events can be CreatedEvent or ExercisedEvent - - In the update service the events are restricted to the events - visible for the parties specified in the transaction filter. Each - event message type below contains a ``witness_parties`` field which - indicates the subset of the requested parties that can see the event - in question. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| created | [`com.daml.ledger.api.v2.CreatedEvent`](#type-com-daml-ledger-api-v2-createdevent) | optional | The event as it appeared in the context of its original daml transaction on this participant node.
In particular, the offset, node_id pair of the daml transaction are preserved. | -| archived | [`com.daml.ledger.api.v2.ArchivedEvent`](#type-com-daml-ledger-api-v2-archivedevent) | optional | | -| exercised | [`com.daml.ledger.api.v2.ExercisedEvent`](#type-com-daml-ledger-api-v2-exercisedevent) | optional | | - - -**Message `com.daml.ledger.api.v2.EventFormat`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/transaction_filter.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/transaction_filter.proto#L104) -- Fields: 3 - -A format for events which defines both which events should be included - and what data should be computed and included for them. - - Note that some of the filtering behavior depends on the `TransactionShape`, - which is expected to be specified alongside usages of `EventFormat`. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| filters_by_party | `map` | repeated | Each key must be a valid PartyIdString (as described in ``value.proto``).
The interpretation of the filter depends on the transaction-shape being filtered:

1. For **ledger-effects** create and exercise events are returned, for which the witnesses include at least one of
the listed parties and match the per-party filter.
2. For **transaction and active-contract-set streams** create and archive events are returned for all contracts whose
stakeholders include at least one of the listed parties and match the per-party filter.

Optional | -| filters_for_any_party | [`com.daml.ledger.api.v2.Filters`](#type-com-daml-ledger-api-v2-filters) | optional | Wildcard filters that apply to all the parties existing on the participant. The interpretation of the filters is the same
with the per-party filter as described above.
Optional | -| verbose | `bool` | optional | If enabled, values served over the API will contain more information than strictly necessary to interpret the data.
In particular, setting the verbose flag to true triggers the ledger to include labels for record fields.
Optional | - - -**Message `com.daml.ledger.api.v2.ExerciseByKeyCommand`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/commands.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/commands.proto#L66) -- Fields: 4 - -Exercise a choice on an existing contract specified by its key. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| template_id | `com.daml.ledger.api.v2.Identifier` | optional | The template of contract the client wants to exercise.
Both package-name and package-id reference identifier formats for the template-id are supported.
Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4.

Required | -| contract_key | `com.daml.ledger.api.v2.Value` | optional | The key of the contract the client wants to exercise upon.
Required | -| choice | `string` | optional | The name of the choice the client wants to exercise.
Must be a valid NameString (as described in ``value.proto``)
Required | -| choice_argument | `com.daml.ledger.api.v2.Value` | optional | The argument for this choice.
Required | - - -**Message `com.daml.ledger.api.v2.ExerciseCommand`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/commands.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/commands.proto#L41) -- Fields: 4 - -Exercise a choice on an existing contract. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| template_id | `com.daml.ledger.api.v2.Identifier` | optional | The template or interface of the contract the client wants to exercise.
Both package-name and package-id reference identifier formats for the template-id are supported.
Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4.
To exercise a choice on an interface, specify the interface identifier in the template_id field.

Required | -| contract_id | `string` | optional | The ID of the contract the client wants to exercise upon.
Must be a valid LedgerString (as described in ``value.proto``).
Required | -| choice | `string` | optional | The name of the choice the client wants to exercise.
Must be a valid NameString (as described in ``value.proto``)
Required | -| choice_argument | `com.daml.ledger.api.v2.Value` | optional | The argument for this choice.
Required | - - -**Message `com.daml.ledger.api.v2.ExercisedEvent`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/event.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/event.proto#L223) -- Fields: 15 - -Records that a choice has been exercised on a target contract. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| offset | `int64` | optional | The offset of origin.
Offsets are managed by the participant nodes.
Transactions can thus NOT be assumed to have the same offsets on different participant nodes.
Required, it is a valid absolute offset (positive integer) | -| node_id | `int32` | optional | The position of this event in the originating transaction or reassignment.
Node IDs are not necessarily equal across participants,
as these may see different projections/parts of transactions.
Required, must be valid node ID (non-negative integer) | -| contract_id | `string` | optional | The ID of the target contract.
Must be a valid LedgerString (as described in ``value.proto``).
Required | -| template_id | `com.daml.ledger.api.v2.Identifier` | optional | Identifies the template that defines the executed choice.
This template's package-id may differ from the target contract's package-id
if the target contract has been upgraded or downgraded.

The identifier uses the package-id reference format.

Required | -| interface_id | `com.daml.ledger.api.v2.Identifier` | optional | The interface where the choice is defined, if inherited.
If defined, the identifier uses the package-id reference format.

Optional | -| choice | `string` | optional | The choice that was exercised on the target contract.
Must be a valid NameString (as described in ``value.proto``).
Required | -| choice_argument | `com.daml.ledger.api.v2.Value` | optional | The argument of the exercised choice.
Required | -| acting_parties | `string` | repeated | The parties that exercised the choice.
Each element must be a valid PartyIdString (as described in ``value.proto``).
Required | -| consuming | `bool` | optional | If true, the target contract may no longer be exercised.
Required | -| witness_parties | `string` | repeated | The parties that are notified of this event. The witnesses of an exercise
node will depend on whether the exercise was consuming or not.
If consuming, the witnesses are the union of the stakeholders,
the actors and all informees of all the ancestors of this event this
participant knows about.
If not consuming, the witnesses are the union of the signatories,
the actors and all informees of all the ancestors of this event this
participant knows about.
In both cases the witnesses are limited to the querying parties, or not
limited in case anyParty filters are used.
Note that the actors might not necessarily be observers
and thus stakeholders. This is the case when the controllers of a
choice are specified using "flexible controllers", using the
``choice ... controller`` syntax, and said controllers are not
explicitly marked as observers.
Each element must be a valid PartyIdString (as described in ``value.proto``).
Required | -| last_descendant_node_id | `int32` | optional | Specifies the upper boundary of the node ids of the events in the same transaction that appeared as a result of
this ``ExercisedEvent``. This allows unambiguous identification of all the members of the subtree rooted at this
node. A full subtree can be constructed when all descendant nodes are present in the stream. If nodes are heavily
filtered, it is only possible to determine if a node is in a consequent subtree or not.
Required | -| exercise_result | `com.daml.ledger.api.v2.Value` | optional | The result of exercising the choice.
Required | -| package_name | `string` | optional | The package name of the contract.
Required | -| implemented_interfaces | `com.daml.ledger.api.v2.Identifier` | repeated | If the event is consuming, the interfaces implemented by the target template that have been
matched from the interface filter query.
Populated only in case interface filters with include_interface_view set.

The identifier uses the package-id reference format.

Optional | -| acs_delta | `bool` | optional | Whether this event would be part of respective ACS_DELTA shaped stream,
and should therefore considered when tracking contract activeness on the client-side.
Required | - - -**Message `com.daml.ledger.api.v2.ExperimentalCommandInspectionService`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/experimental_features.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/experimental_features.proto#L29) -- Fields: 1 - -Whether the Ledger API supports command inspection service - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| supported | `bool` | optional | | - - -**Message `com.daml.ledger.api.v2.ExperimentalFeatures`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/experimental_features.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/experimental_features.proto#L18) -- Fields: 2 - -IMPORTANT: in contrast to other parts of the Ledger API, only json-wire backwards -compatibility guarantees are given for the messages in this file. - -See the feature message definitions for descriptions. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| static_time | [`com.daml.ledger.api.v2.ExperimentalStaticTime`](#type-com-daml-ledger-api-v2-experimentalstatictime) | optional | | -| command_inspection_service | [`com.daml.ledger.api.v2.ExperimentalCommandInspectionService`](#type-com-daml-ledger-api-v2-experimentalcommandinspectionservice) | optional | | - - -**Message `com.daml.ledger.api.v2.ExperimentalPartyTopologyEvents`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/experimental_features.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/experimental_features.proto#L34) -- Fields: 1 - -Whether the Ledger API supports party events - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| supported | `bool` | optional | | - - -**Message `com.daml.ledger.api.v2.ExperimentalStaticTime`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/experimental_features.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/experimental_features.proto#L24) -- Fields: 1 - -Ledger is in the static time mode and exposes a time service. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| supported | `bool` | optional | | - - -**Message `com.daml.ledger.api.v2.FeaturesDescriptor`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/version_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/version_service.proto#L39) -- Fields: 5 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| experimental | [`com.daml.ledger.api.v2.ExperimentalFeatures`](#type-com-daml-ledger-api-v2-experimentalfeatures) | optional | Features under development or features that are used
for ledger implementation testing purposes only.

Daml applications SHOULD not depend on these in production. | -| user_management | [`com.daml.ledger.api.v2.UserManagementFeature`](#type-com-daml-ledger-api-v2-usermanagementfeature) | optional | If set, then the Ledger API server supports user management.
It is recommended that clients query this field to gracefully adjust their behavior for
ledgers that do not support user management. | -| party_management | [`com.daml.ledger.api.v2.PartyManagementFeature`](#type-com-daml-ledger-api-v2-partymanagementfeature) | optional | If set, then the Ledger API server supports party management configurability.
It is recommended that clients query this field to gracefully adjust their behavior to
maximum party page size. | -| offset_checkpoint | [`com.daml.ledger.api.v2.OffsetCheckpointFeature`](#type-com-daml-ledger-api-v2-offsetcheckpointfeature) | optional | It contains the timeouts related to the periodic offset checkpoint emission | -| package_feature | [`com.daml.ledger.api.v2.PackageFeature`](#type-com-daml-ledger-api-v2-packagefeature) | optional | If set, then the Ledger API server supports package listing
configurability. It is recommended that clients query this field to
gracefully adjust their behavior to maximum package listing page size. | - - -**Message `com.daml.ledger.api.v2.Filters`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/transaction_filter.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/transaction_filter.proto#L15) -- Fields: 1 - -The union of a set of template filters, interface filters, or a wildcard. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| cumulative | [`com.daml.ledger.api.v2.CumulativeFilter`](#type-com-daml-ledger-api-v2-cumulativefilter) | repeated | Every filter in the cumulative list expands the scope of the resulting stream. Each interface,
template or wildcard filter means additional events that will match the query.
The impact of include_interface_view and include_created_event_blob fields in the filters will
also be accumulated.
A template or an interface SHOULD NOT appear twice in the accumulative field.
A wildcard filter SHOULD NOT be defined more than once in the accumulative field.
Optional, if no ``CumulativeFilter`` defined, the default of a single ``WildcardFilter`` with
include_created_event_blob unset is used. | - - -**Message `com.daml.ledger.api.v2.GetActiveContractsRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto#L40) -- Fields: 2 - -If the given offset is different than the ledger end, and there are (un)assignments in-flight at the given offset, - the snapshot may fail with "FAILED_PRECONDITION/PARTICIPANT_PRUNED_DATA_ACCESSED". - Note that it is ok to request acs snapshots for party migration with offsets other than ledger end, because party - migration is not concerned with incomplete (un)assignments. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| active_at_offset | `int64` | optional | The offset at which the snapshot of the active contracts will be computed.
Must be no greater than the current ledger end offset.
Must be greater than or equal to the last pruning offset.
Required, must be a valid absolute offset (positive integer) or ledger begin offset (zero).
If zero, the empty set will be returned. | -| event_format | [`com.daml.ledger.api.v2.EventFormat`](#type-com-daml-ledger-api-v2-eventformat) | optional | Format of the contract_entries in the result. In case of CreatedEvent the presentation will be of
TRANSACTION_SHAPE_ACS_DELTA.
Optional for backwards compatibility, defaults to an EventFormat where:

- filters_by_party is the filter.filters_by_party from this request
- filters_for_any_party is the filter.filters_for_any_party from this request
- verbose is the verbose field from this request | - - -**Message `com.daml.ledger.api.v2.GetActiveContractsResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto#L64) -- Fields: 4 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| workflow_id | `string` | optional | The workflow ID used in command submission which corresponds to the contract_entry. Only set if
the ``workflow_id`` for the command was set.
Must be a valid LedgerString (as described in ``value.proto``).
Optional | -| active_contract | [`com.daml.ledger.api.v2.ActiveContract`](#type-com-daml-ledger-api-v2-activecontract) | optional | The contract is active on the assigned synchronizer, meaning: there was an activation event on the given synchronizer (
created, assigned), which is not followed by a deactivation event (archived, unassigned) on the same
synchronizer, until the active_at_offset.
Since activeness is defined as a per synchronizer concept, it is possible, that a contract is active on one
synchronizer, but already archived on another.
There will be one such message for each synchronizer the contract is active on. | -| incomplete_unassigned | [`com.daml.ledger.api.v2.IncompleteUnassigned`](#type-com-daml-ledger-api-v2-incompleteunassigned) | optional | Included iff the unassigned event was before or at the active_at_offset, but there was no corresponding
assigned event before or at the active_at_offset. | -| incomplete_assigned | [`com.daml.ledger.api.v2.IncompleteAssigned`](#type-com-daml-ledger-api-v2-incompleteassigned) | optional | Important: this message is not indicating that the contract is active on the target synchronizer!
Included iff the assigned event was before or at the active_at_offset, but there was no corresponding
unassigned event before or at the active_at_offset. | - - -**Message `com.daml.ledger.api.v2.GetConnectedSynchronizersRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto#L137) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| party | `string` | optional | The party of interest
Must be a valid PartyIdString (as described in ``value.proto``).
If empty, all synchronizers this node is connected to will be returned
Optional | -| participant_id | `string` | optional | The id of a participant whose mapping of a party to connected synchronizers is requested.
Must be a valid participant-id retrieved through a prior call to getParticipantId.
Defaults to the participant id of the host participant.
Optional | -| identity_provider_id | `string` | optional | The ID of the identity provider configured by ``Identity Provider Config``
Optional, if not set, assume the user is managed by the default identity provider. | - - -**Message `com.daml.ledger.api.v2.GetConnectedSynchronizersResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto#L155) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| connected_synchronizers | [`com.daml.ledger.api.v2.GetConnectedSynchronizersResponse.ConnectedSynchronizer`](#type-com-daml-ledger-api-v2-getconnectedsynchronizersresponse-connectedsynchronizer) | repeated | | - - -**Message `com.daml.ledger.api.v2.GetConnectedSynchronizersResponse.ConnectedSynchronizer`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto#L156) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| synchronizer_alias | `string` | optional | The alias of the synchronizer
Required | -| synchronizer_id | `string` | optional | The ID of the synchronizer
Required | -| permission | [`com.daml.ledger.api.v2.ParticipantPermission`](#type-com-daml-ledger-api-v2-participantpermission) | optional | The permission on the synchronizer
Set if a party was used in the request, otherwise unspecified.
Optional | - - -**Message `com.daml.ledger.api.v2.GetContractRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/contract_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/contract_service.proto#L25) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| contract_id | `string` | optional | The ID of the contract.
Must be a valid LedgerString (as described in ``value.proto``).
Required | -| querying_parties | `string` | repeated | The list of querying parties
The stakeholders of the referenced contract must have an intersection with any of these parties
to return the result.
Optional, if no querying_parties specified, all possible contracts could be returned. | - - -**Message `com.daml.ledger.api.v2.GetContractResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/contract_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/contract_service.proto#L38) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| created_event | [`com.daml.ledger.api.v2.CreatedEvent`](#type-com-daml-ledger-api-v2-createdevent) | optional | The representative_package_id will be always set to the contract package ID, therefore this endpoint should
not be used to lookup contract which entered the participant via party replication or repair service.
The witnesses field will contain only the querying_parties which are also stakeholders of the contract as well.
The following fields of the created event cannot be populated, so those should not be used / parsed:

- offset
- node_id
- created_event_blob
- interface_views
- acs_delta

Required | - - -**Message `com.daml.ledger.api.v2.GetEventsByContractIdRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/event_query_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/event_query_service.proto#L15) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| contract_id | `string` | optional | The contract id being queried.
Required | -| event_format | [`com.daml.ledger.api.v2.EventFormat`](#type-com-daml-ledger-api-v2-eventformat) | optional | Format of the events in the result, the presentation will be of TRANSACTION_SHAPE_ACS_DELTA.
Required | - - -**Message `com.daml.ledger.api.v2.GetEventsByContractIdResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/event_query_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/event_query_service.proto#L40) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| created | [`com.daml.ledger.api.v2.Created`](#type-com-daml-ledger-api-v2-created) | optional | The create event for the contract with the ``contract_id`` given in the request
provided it exists and has not yet been pruned.
Optional | -| archived | [`com.daml.ledger.api.v2.Archived`](#type-com-daml-ledger-api-v2-archived) | optional | The archive event for the contract with the ``contract_id`` given in the request
provided such an archive event exists and it has not yet been pruned.
Optional | - - -**Message `com.daml.ledger.api.v2.GetLatestPrunedOffsetsRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto#L196) -- Fields: 0 - -Empty for now, but may contain fields in the future. - - -**Message `com.daml.ledger.api.v2.GetLatestPrunedOffsetsResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto#L200) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| participant_pruned_up_to_inclusive | `int64` | optional | It will always be a non-negative integer.
If positive, the absolute offset up to which the ledger has been pruned,
disregarding the state of all divulged contracts pruning.
If zero, the ledger has not been pruned yet. | -| all_divulged_contracts_pruned_up_to_inclusive | `int64` | optional | It will always be a non-negative integer.
If positive, the absolute offset up to which all divulged events have been pruned on the ledger.
It can be at or before the ``participant_pruned_up_to_inclusive`` offset.
For more details about all divulged events pruning,
see ``PruneRequest.prune_all_divulged_contracts`` in ``participant_pruning_service.proto``.
If zero, the divulged events have not been pruned yet. | - - -**Message `com.daml.ledger.api.v2.GetLedgerApiVersionRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/version_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/version_service.proto#L21) -- Fields: 0 - -_No description._ - - -**Message `com.daml.ledger.api.v2.GetLedgerApiVersionResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/version_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/version_service.proto#L23) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| version | `string` | optional | The version of the ledger API. | -| features | [`com.daml.ledger.api.v2.FeaturesDescriptor`](#type-com-daml-ledger-api-v2-featuresdescriptor) | optional | The features supported by this Ledger API endpoint.

Daml applications CAN use the feature descriptor on top of
version constraints on the Ledger API version to determine
whether a given Ledger API endpoint supports the features
required to run the application.

See the feature descriptions themselves for the relation between
Ledger API versions and feature presence. | - - -**Message `com.daml.ledger.api.v2.GetLedgerEndRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto#L187) -- Fields: 0 - -_No description._ - - -**Message `com.daml.ledger.api.v2.GetLedgerEndResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto#L189) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| offset | `int64` | optional | It will always be a non-negative integer.
If zero, the participant view of the ledger is empty.
If positive, the absolute offset of the ledger as viewed by the participant. | - - -**Message `com.daml.ledger.api.v2.GetPackageRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto#L71) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| package_id | `string` | optional | The ID of the requested package.
Must be a valid PackageIdString (as described in ``value.proto``).
Required | - - -**Message `com.daml.ledger.api.v2.GetPackageResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto#L21) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| hash_function | [`com.daml.ledger.api.v2.HashFunction`](#type-com-daml-ledger-api-v2-hashfunction) | optional | The hash function we use to calculate the hash.
Required | -| archive_payload | `bytes` | optional | Contains a ``daml_lf`` ArchivePayload. See further details in ``daml_lf.proto``.
Required | -| hash | `string` | optional | The hash of the archive payload, can also used as a ``package_id``.
Must be a valid PackageIdString (as described in ``value.proto``).
Required | - - -**Message `com.daml.ledger.api.v2.GetPackageStatusRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto#L78) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| package_id | `string` | optional | The ID of the requested package.
Must be a valid PackageIdString (as described in ``value.proto``).
Required | - - -**Message `com.daml.ledger.api.v2.GetPackageStatusResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto#L36) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| package_status | [`com.daml.ledger.api.v2.PackageStatus`](#type-com-daml-ledger-api-v2-packagestatus) | optional | The status of the package. | - - -**Message `com.daml.ledger.api.v2.GetUpdateByIdRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/update_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/update_service.proto#L102) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| update_id | `string` | optional | The ID of a particular update.
Must be a valid LedgerString (as described in ``value.proto``).
Required | -| update_format | [`com.daml.ledger.api.v2.UpdateFormat`](#type-com-daml-ledger-api-v2-updateformat) | optional | The format for the update.
Required | - - -**Message `com.daml.ledger.api.v2.GetUpdateByOffsetRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/update_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/update_service.proto#L91) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| offset | `int64` | optional | The offset of the update being looked up.
Must be a valid absolute offset (positive integer).
Required | -| update_format | [`com.daml.ledger.api.v2.UpdateFormat`](#type-com-daml-ledger-api-v2-updateformat) | optional | The format for the update.
Required | - - -**Message `com.daml.ledger.api.v2.GetUpdateResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/update_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/update_service.proto#L113) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| transaction | [`com.daml.ledger.api.v2.Transaction`](#type-com-daml-ledger-api-v2-transaction) | optional | | -| reassignment | [`com.daml.ledger.api.v2.Reassignment`](#type-com-daml-ledger-api-v2-reassignment) | optional | | -| topology_transaction | [`com.daml.ledger.api.v2.TopologyTransaction`](#type-com-daml-ledger-api-v2-topologytransaction) | optional | | - - -**Message `com.daml.ledger.api.v2.GetUpdatesRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/update_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/update_service.proto#L48) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| begin_exclusive | `int64` | optional | Beginning of the requested ledger section (non-negative integer).
The response will only contain transactions whose offset is strictly greater than this.
If zero, the stream will start from the beginning of the ledger.
If positive, the streaming will start after this absolute offset.
If the ledger has been pruned, this parameter must be specified and be greater than the pruning offset. | -| end_inclusive | `int64` | optional | End of the requested ledger section.
The response will only contain transactions whose offset is less than or equal to this.
Optional, if empty, the stream will not terminate.
If specified, the stream will terminate after this absolute offset (positive integer) is reached. | -| update_format | [`com.daml.ledger.api.v2.UpdateFormat`](#type-com-daml-ledger-api-v2-updateformat) | optional | Must be unset for GetUpdateTrees request.
Optional for backwards compatibility for GetUpdates request: defaults to an UpdateFormat where:

- include_transactions.event_format.filters_by_party = the filter.filters_by_party on this request
- include_transactions.event_format.filters_for_any_party = the filter.filters_for_any_party on this request
- include_transactions.event_format.verbose = the same flag specified on this request
- include_transactions.transaction_shape = TRANSACTION_SHAPE_ACS_DELTA
- include_reassignments.filter = the same filter specified on this request
- include_reassignments.verbose = the same flag specified on this request
- include_topology_events.include_participant_authorization_events.parties = all the parties specified in filter | - - -**Message `com.daml.ledger.api.v2.GetUpdatesResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/update_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/update_service.proto#L81) -- Fields: 4 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| transaction | [`com.daml.ledger.api.v2.Transaction`](#type-com-daml-ledger-api-v2-transaction) | optional | | -| reassignment | [`com.daml.ledger.api.v2.Reassignment`](#type-com-daml-ledger-api-v2-reassignment) | optional | | -| offset_checkpoint | [`com.daml.ledger.api.v2.OffsetCheckpoint`](#type-com-daml-ledger-api-v2-offsetcheckpoint) | optional | | -| topology_transaction | [`com.daml.ledger.api.v2.TopologyTransaction`](#type-com-daml-ledger-api-v2-topologytransaction) | optional | | - - -**Message `com.daml.ledger.api.v2.IncompleteAssigned`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto#L132) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| assigned_event | [`com.daml.ledger.api.v2.AssignedEvent`](#type-com-daml-ledger-api-v2-assignedevent) | optional | Required | - - -**Message `com.daml.ledger.api.v2.IncompleteUnassigned`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto#L118) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| created_event | [`com.daml.ledger.api.v2.CreatedEvent`](#type-com-daml-ledger-api-v2-createdevent) | optional | Required
The event as it appeared in the context of its last activation update (i.e. daml transaction or
reassignment). In particular, the last activation offset, node_id pair is preserved.
The last activation update is the most recent update created or assigned this contract on synchronizer_id synchronizer before
the unassigned_event.
The offset of the CreatedEvent might point to an already pruned update, therefore it cannot necessarily be used
for lookups. | -| unassigned_event | [`com.daml.ledger.api.v2.UnassignedEvent`](#type-com-daml-ledger-api-v2-unassignedevent) | optional | Required | - - -**Message `com.daml.ledger.api.v2.InterfaceFilter`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/transaction_filter.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/transaction_filter.proto#L59) -- Fields: 3 - -This filter matches contracts that implement a specific interface. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| interface_id | `com.daml.ledger.api.v2.Identifier` | optional | The interface that a matching contract must implement.
The ``interface_id`` needs to be valid: corresponding interface should be defined in
one of the available packages at the time of the query.
Both package-name and package-id reference formats for the identifier are supported.
Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4.

Required | -| include_interface_view | `bool` | optional | Whether to include the interface view on the contract in the returned ``CreatedEvent``.
Use this to access contract data in a uniform manner in your API client.
Optional | -| include_created_event_blob | `bool` | optional | Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``.
Use this to access the contract create event payload in your API client
for submitting it as a disclosed contract with future commands.
Optional | - - -**Message `com.daml.ledger.api.v2.InterfaceView`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/event.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/event.proto#L150) -- Fields: 3 - -View of a create event matched by an interface filter. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| interface_id | `com.daml.ledger.api.v2.Identifier` | optional | The interface implemented by the matched event.
The identifier uses the package-id reference format.

Required | -| view_status | `google.rpc.Status` | optional | Whether the view was successfully computed, and if not,
the reason for the error. The error is reported using the same rules
for error codes and messages as the errors returned for API requests.
Required | -| view_value | `com.daml.ledger.api.v2.Record` | optional | The value of the interface's view method on this event.
Set if it was requested in the ``InterfaceFilter`` and it could be
successfully computed.
Optional | - - -**Message `com.daml.ledger.api.v2.ListPackagesRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto#L69) -- Fields: 0 - -_No description._ - - -**Message `com.daml.ledger.api.v2.ListPackagesResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto#L14) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| package_ids | `string` | repeated | The IDs of all Daml-LF packages supported by the server.
Each element must be a valid PackageIdString (as described in ``value.proto``).
Required | - - -**Message `com.daml.ledger.api.v2.ListVettedPackagesRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto#L124) -- Fields: 4 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| package_metadata_filter | [`com.daml.ledger.api.v2.PackageMetadataFilter`](#type-com-daml-ledger-api-v2-packagemetadatafilter) | optional | The package metadata filter the returned vetted packages set must satisfy.
Optional | -| topology_state_filter | [`com.daml.ledger.api.v2.TopologyStateFilter`](#type-com-daml-ledger-api-v2-topologystatefilter) | optional | The topology filter the returned vetted packages set must satisfy.
Optional | -| page_token | `string` | optional | Pagination token to determine the specific page to fetch. Using the token
guarantees that ``VettedPackages`` on a subsequent page are all greater
(``VettedPackages`` are sorted by synchronizer ID then participant ID) than
the last ``VettedPackages`` on a previous page.

The server does not store intermediate results between calls chained by a
series of page tokens. As a consequence, if new vetted packages are being
added and a page is requested twice using the same token, more packages can
be returned on the second call.

Leave unspecified (i.e. as empty string) to fetch the first page.

Optional | -| page_size | `uint32` | optional | Maximum number of ``VettedPackages`` results to return in a single page.

If the page_size is unspecified (i.e. left as 0), the server will decide
the number of results to be returned.

If the page_size exceeds the maximum supported by the server, an
error will be returned.

To obtain the server's maximum consult the PackageService descriptor
available in the VersionService.

Optional | - - -**Message `com.daml.ledger.api.v2.ListVettedPackagesResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto#L163) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| vetted_packages | [`com.daml.ledger.api.v2.VettedPackages`](#type-com-daml-ledger-api-v2-vettedpackages) | repeated | All ``VettedPackages`` that contain at least one ``VettedPackage`` matching
both a ``PackageMetadataFilter`` and a ``TopologyStateFilter``.
Sorted by synchronizer_id then participant_id. | -| next_page_token | `string` | optional | Pagination token to retrieve the next page.
Empty string if there are no further results. | - - -**Message `com.daml.ledger.api.v2.OffsetCheckpoint`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/offset_checkpoint.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/offset_checkpoint.proto#L18) -- Fields: 2 - -OffsetCheckpoints may be used to: - - - detect time out of commands. - - provide an offset which can be used to restart consumption. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| offset | `int64` | optional | The participant's offset, the details of the offset field are described in ``community/ledger-api/README.md``.
Required, must be a valid absolute offset (positive integer). | -| synchronizer_times | [`com.daml.ledger.api.v2.SynchronizerTime`](#type-com-daml-ledger-api-v2-synchronizertime) | repeated | | - - -**Message `com.daml.ledger.api.v2.OffsetCheckpointFeature`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/version_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/version_service.proto#L91) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| max_offset_checkpoint_emission_delay | `google.protobuf.Duration` | optional | The maximum delay to emmit a new OffsetCheckpoint if it exists | - - -**Message `com.daml.ledger.api.v2.PackageFeature`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/version_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/version_service.proto#L85) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| max_vetted_packages_page_size | `int32` | optional | The maximum number of vetted packages the server can return in a single
response (page) when listing them. | - - -**Message `com.daml.ledger.api.v2.PackageMetadataFilter`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto#L92) -- Fields: 2 - -Filter the VettedPackages by package metadata. - - A PackageMetadataFilter without package_ids and without package_name_prefixes - matches any vetted package. - - Non-empty fields specify candidate values of which at least one must match. - If both fields are set, then a candidate is returned if it matches one of the fields. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| package_ids | `string` | repeated | If this list is non-empty, any vetted package with a package ID in this
list will match the filter. | -| package_name_prefixes | `string` | repeated | If this list is non-empty, any vetted package with a name matching at least
one prefix in this list will match the filter. | - - -**Message `com.daml.ledger.api.v2.PackageReference`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_reference.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_reference.proto#L15) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| package_id | `string` | optional | Required | -| package_name | `string` | optional | Required | -| package_version | `string` | optional | Required | - - -**Message `com.daml.ledger.api.v2.ParticipantAuthorizationAdded`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/topology_transaction.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/topology_transaction.proto#L61) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| party_id | `string` | optional | Required | -| participant_id | `string` | optional | Required | -| participant_permission | [`com.daml.ledger.api.v2.ParticipantPermission`](#type-com-daml-ledger-api-v2-participantpermission) | optional | Required | - - -**Message `com.daml.ledger.api.v2.ParticipantAuthorizationChanged`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/topology_transaction.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/topology_transaction.proto#L72) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| party_id | `string` | optional | Required | -| participant_id | `string` | optional | Required | -| participant_permission | [`com.daml.ledger.api.v2.ParticipantPermission`](#type-com-daml-ledger-api-v2-participantpermission) | optional | Required | - - -**Message `com.daml.ledger.api.v2.ParticipantAuthorizationRevoked`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/topology_transaction.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/topology_transaction.proto#L83) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| party_id | `string` | optional | Required | -| participant_id | `string` | optional | Required | - - -**Message `com.daml.ledger.api.v2.ParticipantAuthorizationTopologyFormat`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/transaction_filter.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/transaction_filter.proto#L162) -- Fields: 1 - -A format specifying which participant authorization topology transactions to include and how to render them. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| parties | `string` | repeated | List of parties for which the topology transactions should be sent.
Empty means: for all parties. | - - -**Message `com.daml.ledger.api.v2.PartyManagementFeature`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/version_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/version_service.proto#L80) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| max_parties_page_size | `int32` | optional | The maximum number of parties the server can return in a single response (page). | - - -**Message `com.daml.ledger.api.v2.PrefetchContractKey`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/commands.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/commands.proto#L236) -- Fields: 2 - -Preload contracts - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| template_id | `com.daml.ledger.api.v2.Identifier` | optional | The template of contract the client wants to prefetch.
Both package-name and package-id reference identifier formats for the template-id are supported.
Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4.

Required | -| contract_key | `com.daml.ledger.api.v2.Value` | optional | The key of the contract the client wants to prefetch.
Required | - - -**Message `com.daml.ledger.api.v2.PriorTopologySerial`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_reference.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_reference.proto#L72) -- Fields: 2 - -The serial of last ``VettedPackages`` topology transaction on a given - participant and synchronizer. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| prior | `uint32` | optional | Previous transaction's serial. | -| no_prior | `google.protobuf.Empty` | optional | No previous transaction exists. | - - -**Message `com.daml.ledger.api.v2.Reassignment`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/reassignment.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/reassignment.proto#L18) -- Fields: 8 - -Complete view of an on-ledger reassignment. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| update_id | `string` | optional | Assigned by the server. Useful for correlating logs.
Must be a valid LedgerString (as described in ``value.proto``).
Required | -| command_id | `string` | optional | The ID of the command which resulted in this reassignment. Missing for everyone except the submitting party on the submitting participant.
Must be a valid LedgerString (as described in ``value.proto``).
Optional | -| workflow_id | `string` | optional | The workflow ID used in reassignment command submission. Only set if the ``workflow_id`` for the command was set.
Must be a valid LedgerString (as described in ``value.proto``).
Optional | -| offset | `int64` | optional | The participant's offset. The details of this field are described in ``community/ledger-api/README.md``.
Required, must be a valid absolute offset (positive integer). | -| events | [`com.daml.ledger.api.v2.ReassignmentEvent`](#type-com-daml-ledger-api-v2-reassignmentevent) | repeated | The collection of reassignment events. Required. | -| trace_context | [`com.daml.ledger.api.v2.TraceContext`](#type-com-daml-ledger-api-v2-tracecontext) | optional | Optional; ledger API trace context

The trace context transported in this message corresponds to the trace context supplied
by the client application in a HTTP2 header of the original command submission.
We typically use a header to transfer this type of information. Here we use message
body, because it is used in gRPC streams which do not support per message headers.
This field will be populated with the trace context contained in the original submission.
If that was not provided, a unique ledger-api-server generated trace context will be used
instead. | -| record_time | `google.protobuf.Timestamp` | optional | The time at which the reassignment was recorded. The record time refers to the source/target
synchronizer for an unassign/assign event respectively.
Required | -| synchronizer_id | `string` | optional | A valid synchronizer id.
Identifies the synchronizer that synchronized this Reassignment.
Required | - - -**Message `com.daml.ledger.api.v2.ReassignmentCommand`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/reassignment_commands.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/reassignment_commands.proto#L51) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| unassign_command | [`com.daml.ledger.api.v2.UnassignCommand`](#type-com-daml-ledger-api-v2-unassigncommand) | optional | | -| assign_command | [`com.daml.ledger.api.v2.AssignCommand`](#type-com-daml-ledger-api-v2-assigncommand) | optional | | - - -**Message `com.daml.ledger.api.v2.ReassignmentCommands`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/reassignment_commands.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/reassignment_commands.proto#L12) -- Fields: 6 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| workflow_id | `string` | optional | Identifier of the on-ledger workflow that this command is a part of.
Must be a valid LedgerString (as described in ``value.proto``).
Optional | -| user_id | `string` | optional | Uniquely identifies the participant user that issued the command.
Must be a valid UserIdString (as described in ``value.proto``).
Required unless authentication is used with a user token.
In that case, the token's user-id will be used for the request's user_id. | -| command_id | `string` | optional | Uniquely identifies the command.
The triple (user_id, submitter, command_id) constitutes the change ID for the intended ledger change.
The change ID can be used for matching the intended ledger changes with all their completions.
Must be a valid LedgerString (as described in ``value.proto``).
Required | -| submitter | `string` | optional | Party on whose behalf the command should be executed.
If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request
to act on behalf of the given party.
Must be a valid PartyIdString (as described in ``value.proto``).
Required | -| submission_id | `string` | optional | A unique identifier to distinguish completions for different submissions with the same change ID.
Typically a random UUID. Applications are expected to use a different UUID for each retry of a submission
with the same change ID.
Must be a valid LedgerString (as described in ``value.proto``).

If omitted, the participant or the committer may set a value of their choice.
Optional | -| commands | [`com.daml.ledger.api.v2.ReassignmentCommand`](#type-com-daml-ledger-api-v2-reassignmentcommand) | repeated | Individual elements of this reassignment. Must be non-empty. | - - -**Message `com.daml.ledger.api.v2.ReassignmentEvent`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/reassignment.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/reassignment.proto#L63) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| unassigned | [`com.daml.ledger.api.v2.UnassignedEvent`](#type-com-daml-ledger-api-v2-unassignedevent) | optional | | -| assigned | [`com.daml.ledger.api.v2.AssignedEvent`](#type-com-daml-ledger-api-v2-assignedevent) | optional | | - - -**Message `com.daml.ledger.api.v2.Signature`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/crypto.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/crypto.proto#L65) -- Fields: 4 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| format | [`com.daml.ledger.api.v2.SignatureFormat`](#type-com-daml-ledger-api-v2-signatureformat) | optional | | -| signature | `bytes` | optional | | -| signed_by | `string` | optional | The fingerprint/id of the keypair used to create this signature and needed to verify. | -| signing_algorithm_spec | [`com.daml.ledger.api.v2.SigningAlgorithmSpec`](#type-com-daml-ledger-api-v2-signingalgorithmspec) | optional | The signing algorithm specification used to produce this signature | - - -**Message `com.daml.ledger.api.v2.SigningPublicKey`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/crypto.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/crypto.proto#L54) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| format | [`com.daml.ledger.api.v2.CryptoKeyFormat`](#type-com-daml-ledger-api-v2-cryptokeyformat) | optional | The serialization format of the public key | -| key_data | `bytes` | optional | Serialized public key in the format specified above | -| key_spec | [`com.daml.ledger.api.v2.SigningKeySpec`](#type-com-daml-ledger-api-v2-signingkeyspec) | optional | The key specification | - - -**Message `com.daml.ledger.api.v2.SubmitAndWaitForReassignmentRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_service.proto#L76) -- Fields: 2 - -This reassignment is executed as a single atomic update. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| reassignment_commands | [`com.daml.ledger.api.v2.ReassignmentCommands`](#type-com-daml-ledger-api-v2-reassignmentcommands) | optional | The reassignment commands to be submitted.
Required | -| event_format | [`com.daml.ledger.api.v2.EventFormat`](#type-com-daml-ledger-api-v2-eventformat) | optional | Optional
If no event_format provided, the result will contain no events.
The events in the result, will take shape TRANSACTION_SHAPE_ACS_DELTA. | - - -**Message `com.daml.ledger.api.v2.SubmitAndWaitForReassignmentResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_service.proto#L87) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| reassignment | [`com.daml.ledger.api.v2.Reassignment`](#type-com-daml-ledger-api-v2-reassignment) | optional | The reassignment that resulted from the submitted reassignment command.
The reassignment might contain no events (request conditions result in filtering out all of them).
Required | - - -**Message `com.daml.ledger.api.v2.SubmitAndWaitForTransactionRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_service.proto#L45) -- Fields: 2 - -These commands are executed as a single atomic transaction. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| commands | [`com.daml.ledger.api.v2.Commands`](#type-com-daml-ledger-api-v2-commands) | optional | The commands to be submitted.
Required | -| transaction_format | [`com.daml.ledger.api.v2.TransactionFormat`](#type-com-daml-ledger-api-v2-transactionformat) | optional | If no ``transaction_format`` is provided, a default will be used where ``transaction_shape`` is set to
TRANSACTION_SHAPE_ACS_DELTA, ``event_format`` is defined with ``filters_by_party`` containing wildcard-template
filter for all original ``act_as`` and ``read_as`` parties and the ``verbose`` flag is set.
Optional | - - -**Message `com.daml.ledger.api.v2.SubmitAndWaitForTransactionResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_service.proto#L68) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| transaction | [`com.daml.ledger.api.v2.Transaction`](#type-com-daml-ledger-api-v2-transaction) | optional | The transaction that resulted from the submitted command.
The transaction might contain no events (request conditions result in filtering out all of them).
Required | - - -**Message `com.daml.ledger.api.v2.SubmitAndWaitRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_service.proto#L38) -- Fields: 1 - -These commands are executed as a single atomic transaction. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| commands | [`com.daml.ledger.api.v2.Commands`](#type-com-daml-ledger-api-v2-commands) | optional | The commands to be submitted.
Required | - - -**Message `com.daml.ledger.api.v2.SubmitAndWaitResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_service.proto#L57) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| update_id | `string` | optional | The id of the transaction that resulted from the submitted command.
Must be a valid LedgerString (as described in ``value.proto``).
Required | -| completion_offset | `int64` | optional | The details of the offset field are described in ``community/ledger-api/README.md``.
Required | - - -**Message `com.daml.ledger.api.v2.SubmitReassignmentRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_submission_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_submission_service.proto#L46) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| reassignment_commands | [`com.daml.ledger.api.v2.ReassignmentCommands`](#type-com-daml-ledger-api-v2-reassignmentcommands) | optional | The reassignment command to be submitted.
Required | - - -**Message `com.daml.ledger.api.v2.SubmitReassignmentResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_submission_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_submission_service.proto#L52) -- Fields: 0 - -_No description._ - - -**Message `com.daml.ledger.api.v2.SubmitRequest`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_submission_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_submission_service.proto#L38) -- Fields: 1 - -The submitted commands will be processed atomically in a single transaction. Moreover, each ``Command`` in ``commands`` will be executed in the order specified by the request. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| commands | [`com.daml.ledger.api.v2.Commands`](#type-com-daml-ledger-api-v2-commands) | optional | The commands to be submitted in a single transaction.
Required | - - -**Message `com.daml.ledger.api.v2.SubmitResponse`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_submission_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/command_submission_service.proto#L44) -- Fields: 0 - -_No description._ - - -**Message `com.daml.ledger.api.v2.SynchronizerTime`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/offset_checkpoint.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/offset_checkpoint.proto#L25) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| synchronizer_id | `string` | optional | The id of the synchronizer.
Required | -| record_time | `google.protobuf.Timestamp` | optional | All commands with a maximum record time below this value MUST be considered lost if their completion has not arrived before this checkpoint.
Required | - - -**Message `com.daml.ledger.api.v2.TemplateFilter`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/transaction_filter.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/transaction_filter.proto#L82) -- Fields: 2 - -This filter matches contracts of a specific template. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| template_id | `com.daml.ledger.api.v2.Identifier` | optional | A template for which the payload should be included in the response.
The ``template_id`` needs to be valid: corresponding template should be defined in
one of the available packages at the time of the query.
Both package-name and package-id reference formats for the identifier are supported.
Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4.

Required | -| include_created_event_blob | `bool` | optional | Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``.
Use this to access the contract event payload in your API client
for submitting it as a disclosed contract with future commands.
Optional | - - -**Message `com.daml.ledger.api.v2.TopologyEvent`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/topology_transaction.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/topology_transaction.proto#L53) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| participant_authorization_changed | [`com.daml.ledger.api.v2.ParticipantAuthorizationChanged`](#type-com-daml-ledger-api-v2-participantauthorizationchanged) | optional | | -| participant_authorization_revoked | [`com.daml.ledger.api.v2.ParticipantAuthorizationRevoked`](#type-com-daml-ledger-api-v2-participantauthorizationrevoked) | optional | | -| participant_authorization_added | [`com.daml.ledger.api.v2.ParticipantAuthorizationAdded`](#type-com-daml-ledger-api-v2-participantauthorizationadded) | optional | | - - -**Message `com.daml.ledger.api.v2.TopologyFormat`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/transaction_filter.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/transaction_filter.proto#L155) -- Fields: 1 - -A format specifying which topology transactions to include and how to render them. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| include_participant_authorization_events | [`com.daml.ledger.api.v2.ParticipantAuthorizationTopologyFormat`](#type-com-daml-ledger-api-v2-participantauthorizationtopologyformat) | optional | Include participant authorization topology events in streams.
Optional, if unset no participant authorization topology events are emitted in the stream. | - - -**Message `com.daml.ledger.api.v2.TopologyStateFilter`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto#L112) -- Fields: 2 - -Filter the vetted packages by the participant and synchronizer that they are - hosted on. - - Empty fields are ignored, such that a ``TopologyStateFilter`` without - participant_ids and without synchronizer_ids matches a vetted package hosted - on any participant and synchronizer. - - Non-empty fields specify candidate values of which at least one must match. - If both fields are set then at least one candidate value must match from each - field. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| participant_ids | `string` | repeated | If this list is non-empty, only vetted packages hosted on participants
listed in this field match the filter.
Query the current Ledger API's participant's ID via the public
``GetParticipantId`` command in ``PartyManagementService``. | -| synchronizer_ids | `string` | repeated | If this list is non-empty, only vetted packages from the topology state of
the synchronizers in this list match the filter. | - - -**Message `com.daml.ledger.api.v2.TopologyTransaction`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/topology_transaction.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/topology_transaction.proto#L16) -- Fields: 6 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| update_id | `string` | optional | Assigned by the server. Useful for correlating logs.
Must be a valid LedgerString (as described in ``value.proto``).
Required | -| offset | `int64` | optional | The absolute offset. The details of this field are described in ``community/ledger-api/README.md``.
Required, it is a valid absolute offset (positive integer). | -| synchronizer_id | `string` | optional | A valid synchronizer id.
Identifies the synchronizer that synchronized the topology transaction.
Required | -| record_time | `google.protobuf.Timestamp` | optional | The time at which the changes in the topology transaction become effective. There is a small delay between a
topology transaction being sequenced and the changes it contains becoming effective. Topology transactions appear
in order relative to a synchronizer based on their effective time rather than their sequencing time.
Required | -| events | [`com.daml.ledger.api.v2.TopologyEvent`](#type-com-daml-ledger-api-v2-topologyevent) | repeated | A non-empty list of topology events.
Required | -| trace_context | [`com.daml.ledger.api.v2.TraceContext`](#type-com-daml-ledger-api-v2-tracecontext) | optional | Optional; ledger API trace context

The trace context transported in this message corresponds to the trace context supplied
by the client application in a HTTP2 header of the original command submission.
We typically use a header to transfer this type of information. Here we use message
body, because it is used in gRPC streams which do not support per message headers.
This field will be populated with the trace context contained in the original submission.
If that was not provided, a unique ledger-api-server generated trace context will be used
instead. | - - -**Message `com.daml.ledger.api.v2.TraceContext`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/trace_context.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/trace_context.proto#L12) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| traceparent | `string` | optional | https://www.w3.org/TR/trace-context/ | -| tracestate | `string` | optional | | - - -**Message `com.daml.ledger.api.v2.Transaction`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/transaction.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/transaction.proto#L17) -- Fields: 10 - -Filtered view of an on-ledger transaction's create and archive events. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| update_id | `string` | optional | Assigned by the server. Useful for correlating logs.
Must be a valid LedgerString (as described in ``value.proto``).
Required | -| command_id | `string` | optional | The ID of the command which resulted in this transaction. Missing for everyone except the submitting party.
Must be a valid LedgerString (as described in ``value.proto``).
Optional | -| workflow_id | `string` | optional | The workflow ID used in command submission.
Must be a valid LedgerString (as described in ``value.proto``).
Optional | -| effective_at | `google.protobuf.Timestamp` | optional | Ledger effective time.
Required | -| events | [`com.daml.ledger.api.v2.Event`](#type-com-daml-ledger-api-v2-event) | repeated | The collection of events.
Contains:

- ``CreatedEvent`` or ``ArchivedEvent`` in case of ACS_DELTA transaction shape
- ``CreatedEvent`` or ``ExercisedEvent`` in case of LEDGER_EFFECTS transaction shape

Required | -| offset | `int64` | optional | The absolute offset. The details of this field are described in ``community/ledger-api/README.md``.
Required, it is a valid absolute offset (positive integer). | -| synchronizer_id | `string` | optional | A valid synchronizer id.
Identifies the synchronizer that synchronized the transaction.
Required | -| trace_context | [`com.daml.ledger.api.v2.TraceContext`](#type-com-daml-ledger-api-v2-tracecontext) | optional | Optional; ledger API trace context

The trace context transported in this message corresponds to the trace context supplied
by the client application in a HTTP2 header of the original command submission.
We typically use a header to transfer this type of information. Here we use message
body, because it is used in gRPC streams which do not support per message headers.
This field will be populated with the trace context contained in the original submission.
If that was not provided, a unique ledger-api-server generated trace context will be used
instead. | -| record_time | `google.protobuf.Timestamp` | optional | The time at which the transaction was recorded. The record time refers to the synchronizer
which synchronized the transaction.
Required | -| external_transaction_hash | `bytes` | optional | For transaction externally signed, contains the external transaction hash
signed by the external party. Can be used to correlate an external submission with a committed transaction.
Optional | - - -**Message `com.daml.ledger.api.v2.TransactionFormat`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/transaction_filter.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/transaction_filter.proto#L145) -- Fields: 2 - -A format that specifies what events to include in Daml transactions - and what data to compute and include for them. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| event_format | [`com.daml.ledger.api.v2.EventFormat`](#type-com-daml-ledger-api-v2-eventformat) | optional | Required | -| transaction_shape | [`com.daml.ledger.api.v2.TransactionShape`](#type-com-daml-ledger-api-v2-transactionshape) | optional | What transaction shape to use for interpreting the filters of the event format.
Required | - - -**Message `com.daml.ledger.api.v2.UnassignCommand`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/reassignment_commands.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/reassignment_commands.proto#L59) -- Fields: 3 - -Unassign a contract - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| contract_id | `string` | optional | The ID of the contract the client wants to unassign.
Must be a valid LedgerString (as described in ``value.proto``).
Required | -| source | `string` | optional | The ID of the source synchronizer
Must be a valid synchronizer id
Required | -| target | `string` | optional | The ID of the target synchronizer
Must be a valid synchronizer id
Required | - - -**Message `com.daml.ledger.api.v2.UnassignedEvent`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/reassignment.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/reassignment.proto#L71) -- Fields: 12 - -Records that a contract has been unassigned, and it becomes unusable on the source synchronizer - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| reassignment_id | `string` | optional | The ID of the unassignment. This needs to be used as an input for a assign ReassignmentCommand.
Must be a valid LedgerString (as described in ``value.proto``).
Required | -| contract_id | `string` | optional | The ID of the reassigned contract.
Must be a valid LedgerString (as described in ``value.proto``).
Required | -| template_id | `com.daml.ledger.api.v2.Identifier` | optional | The template of the reassigned contract.
The identifier uses the package-id reference format.

Required | -| source | `string` | optional | The ID of the source synchronizer
Must be a valid synchronizer id
Required | -| target | `string` | optional | The ID of the target synchronizer
Must be a valid synchronizer id
Required | -| submitter | `string` | optional | Party on whose behalf the unassign command was executed.
Empty if the unassignment happened offline via the repair service.
Must be a valid PartyIdString (as described in ``value.proto``).
Optional | -| reassignment_counter | `uint64` | optional | Each corresponding assigned and unassigned event has the same reassignment_counter. This strictly increases
with each unassign command for the same contract. Creation of the contract corresponds to reassignment_counter
equals zero.
Required | -| assignment_exclusivity | `google.protobuf.Timestamp` | optional | Assignment exclusivity
Before this time (measured on the target synchronizer), only the submitter of the unassignment can initiate the assignment
Defined for reassigning participants.
Optional | -| witness_parties | `string` | repeated | The parties that are notified of this event.
Required | -| package_name | `string` | optional | The package name of the contract.
Required | -| offset | `int64` | optional | The offset of origin.
Offsets are managed by the participant nodes.
Reassignments can thus NOT be assumed to have the same offsets on different participant nodes.
Required, it is a valid absolute offset (positive integer) | -| node_id | `int32` | optional | The position of this event in the originating reassignment.
Node IDs are not necessarily equal across participants,
as these may see different projections/parts of reassignments.
Required, must be valid node ID (non-negative integer) | - - -**Message `com.daml.ledger.api.v2.UpdateFormat`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/transaction_filter.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/transaction_filter.proto#L169) -- Fields: 3 - -A format specifying what updates to include and how to render them. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| include_transactions | [`com.daml.ledger.api.v2.TransactionFormat`](#type-com-daml-ledger-api-v2-transactionformat) | optional | Include Daml transactions in streams.
Optional, if unset, no transactions are emitted in the stream. | -| include_reassignments | [`com.daml.ledger.api.v2.EventFormat`](#type-com-daml-ledger-api-v2-eventformat) | optional | Include (un)assignments in the stream.
The events in the result take the shape TRANSACTION_SHAPE_ACS_DELTA.
Optional, if unset, no (un)assignments are emitted in the stream. | -| include_topology_events | [`com.daml.ledger.api.v2.TopologyFormat`](#type-com-daml-ledger-api-v2-topologyformat) | optional | Include topology events in streams.
Optional, if unset no topology events are emitted in the stream. | - - -**Message `com.daml.ledger.api.v2.UserManagementFeature`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/version_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/version_service.proto#L65) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| supported | `bool` | optional | Whether the Ledger API server provides the user management service. | -| max_rights_per_user | `int32` | optional | The maximum number of rights that can be assigned to a single user.
Servers MUST support at least 100 rights per user.
A value of 0 means that the server enforces no rights per user limit. | -| max_users_page_size | `int32` | optional | The maximum number of users the server can return in a single response (page).
Servers MUST support at least a 100 users per page.
A value of 0 means that the server enforces no page size limit. | - - -**Message `com.daml.ledger.api.v2.VettedPackage`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_reference.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_reference.proto#L27) -- Fields: 5 - -A package that is vetting on a given participant and synchronizer, - 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>`_, - enriched with the package name and version. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| package_id | `string` | optional | Package ID of this package. Always present. | -| valid_from_inclusive | `google.protobuf.Timestamp` | optional | The time from which this package is vetted. Empty if vetting time has no
lower bound. | -| valid_until_exclusive | `google.protobuf.Timestamp` | optional | The time until which this package is vetted. Empty if vetting time has no
upper bound. | -| package_name | `string` | optional | Name of this package.
Only available if the package has been uploaded to the current participant.
If unavailable, is empty string. | -| package_version | `string` | optional | Version of this package.
Only available if the package has been uploaded to the current participant.
If unavailable, is empty string. | - - -**Message `com.daml.ledger.api.v2.VettedPackages`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_reference.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_reference.proto#L54) -- Fields: 4 - -The list of packages vetted on a given participant and synchronizer, modelled - 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>`_. - The list only contains packages that matched a filter in the query that - originated it. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| packages | [`com.daml.ledger.api.v2.VettedPackage`](#type-com-daml-ledger-api-v2-vettedpackage) | repeated | Sorted by package_name and package_version where known, and package_id as a
last resort. | -| participant_id | `string` | optional | Participant on which these packages are vetted. Always present. | -| synchronizer_id | `string` | optional | Synchronizer on which these packages are vetted. Always present. | -| topology_serial | `uint32` | optional | Serial of last ``VettedPackages`` topology transaction of this participant
and on this synchronizer. Always present. | - - -**Message `com.daml.ledger.api.v2.WildcardFilter`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/transaction_filter.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/transaction_filter.proto#L50) -- Fields: 1 - -This filter matches all templates. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| include_created_event_blob | `bool` | optional | Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``.
Use this to access the contract create event payload in your API client
for submitting it as a disclosed contract with future commands.
Optional | - - -**Enum `com.daml.ledger.api.v2.CryptoKeyFormat`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/crypto.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/crypto.proto#L37) - -Serialization format for crypto keys and signatures - -| Name | Number | -| --- | --- | -| CRYPTO_KEY_FORMAT_UNSPECIFIED | `0` | -| CRYPTO_KEY_FORMAT_DER | `1` | -| CRYPTO_KEY_FORMAT_RAW | `2` | -| CRYPTO_KEY_FORMAT_DER_X509_SUBJECT_PUBLIC_KEY_INFO | `3` | - - -**Enum `com.daml.ledger.api.v2.HashFunction`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto#L49) - -_No description._ - -| Name | Number | -| --- | --- | -| HASH_FUNCTION_SHA256 | `0` | - - -**Enum `com.daml.ledger.api.v2.PackageStatus`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/package_service.proto#L41) - -_No description._ - -| Name | Number | -| --- | --- | -| PACKAGE_STATUS_UNSPECIFIED | `0` | -| PACKAGE_STATUS_REGISTERED | `1` | - - -**Enum `com.daml.ledger.api.v2.ParticipantPermission`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/state_service.proto#L175) - -Enum indicating the permission level that the participant has for the party - whose connected synchronizers are being listed. - -| Name | Number | -| --- | --- | -| PARTICIPANT_PERMISSION_UNSPECIFIED | `0` | -| PARTICIPANT_PERMISSION_SUBMISSION | `1` | -| PARTICIPANT_PERMISSION_CONFIRMATION | `2` | -| PARTICIPANT_PERMISSION_OBSERVATION | `3` | - - -**Enum `com.daml.ledger.api.v2.SignatureFormat`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/crypto.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/crypto.proto#L91) - -_No description._ - -| Name | Number | -| --- | --- | -| SIGNATURE_FORMAT_UNSPECIFIED | `0` | -| SIGNATURE_FORMAT_RAW | `1` | -| SIGNATURE_FORMAT_DER | `2` | -| SIGNATURE_FORMAT_CONCAT | `3` | -| SIGNATURE_FORMAT_SYMBOLIC | `10000` | - - -**Enum `com.daml.ledger.api.v2.SigningAlgorithmSpec`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/crypto.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/crypto.proto#L77) - -_No description._ - -| Name | Number | -| --- | --- | -| SIGNING_ALGORITHM_SPEC_UNSPECIFIED | `0` | -| SIGNING_ALGORITHM_SPEC_ED25519 | `1` | -| SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_256 | `2` | -| SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_384 | `3` | - - -**Enum `com.daml.ledger.api.v2.SigningKeySpec`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/crypto.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/crypto.proto#L15) - -Note: these crypto data types are a subset of the ones used internally by Canton. - They have been forked from the respective com.digitalasset.canton.crypto.v30 package. - -| Name | Number | -| --- | --- | -| SIGNING_KEY_SPEC_UNSPECIFIED | `0` | -| SIGNING_KEY_SPEC_EC_CURVE25519 | `1` | -| SIGNING_KEY_SPEC_EC_P256 | `2` | -| SIGNING_KEY_SPEC_EC_P384 | `3` | -| SIGNING_KEY_SPEC_EC_SECP256K1 | `4` | - - -**Enum `com.daml.ledger.api.v2.TransactionShape`** - -- Source: [community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/transaction_filter.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/transaction_filter.proto#L129) - -Event shape for Transactions. - Shapes are exclusive and only one of them can be defined in queries. -| Name | Number | -| --- | --- | -| TRANSACTION_SHAPE_UNSPECIFIED | `0` | -| TRANSACTION_SHAPE_ACS_DELTA | `1` | -| TRANSACTION_SHAPE_LEDGER_EFFECTS | `2` | +
+ +
+
Source file
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/version_service.proto
+
+ +
+
Operations
+
1
+
+ +
+ + +
+ + + + +
+

VersionService.GetLedgerApiVersion

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Read the Ledger API version

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.GetLedgerApiVersionRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.GetLedgerApiVersionResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## Type Inventory + + +These are the package-level message and enum shapes in the publish-version snapshot. + + + + +
+
+

com.daml.ledger.api.v2.ActiveContract

+ +

3 fields

+ +
+ + +
+ +
+
+ created_event + CreatedEvent + +
+ +
Required The event as it appeared in the context of its last update (i.e. daml transaction or reassignment). In particular, the last offset, node_id pair is preserved. The last update is the most recent update created or assigned this contract on synchronizer_id synchronizer. The offset of the CreatedEvent might point to an already pruned update, therefore it cannot necessarily be used for lookups.
+ +
+ +
+
+ synchronizer_id + string + +
+ +
A valid synchronizer id Required
+ +
+ +
+
+ reassignment_counter + uint64 + +
+ +
Each corresponding assigned and unassigned event has the same reassignment_counter. This strictly increases with each unassign command for the same contract. Creation of the contract corresponds to reassignment_counter equals zero. This field will be the reassignment_counter of the latest observable activation event on this synchronizer, which is before the active_at_offset. Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.CreatedEvent

+ +

15 fields

+ +
+ +

Records that a contract has been created, and choices may now be exercised on it.

+ + +
+ +
+
+ offset + int64 + +
+ +
The offset of origin, which has contextual meaning, please see description at messages that include a CreatedEvent. Offsets are managed by the participant nodes. Transactions can thus NOT be assumed to have the same offsets on different participant nodes. Required, it is a valid absolute offset (positive integer)
+ +
+ +
+
+ node_id + int32 + +
+ +
The position of this event in the originating transaction or reassignment. The origin has contextual meaning, please see description at messages that include a CreatedEvent. Node IDs are not necessarily equal across participants, as these may see different projections/parts of transactions. Required, must be valid node ID (non-negative integer)
+ +
+ +
+
+ contract_id + string + +
+ +
The ID of the created contract. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ template_id + Identifier + +
+ +
The template of the created contract. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ contract_key + Value + +
+ +
The key of the created contract. This will be set if and only if ``template_id`` defines a contract key. Optional
+ +
+ +
+
+ create_arguments + Record + +
+ +
The arguments that have been used to create the contract. Required
+ +
+ +
+
+ created_event_blob + bytes + +
+ +
Opaque representation of contract create event payload intended for forwarding to an API server as a contract disclosed as part of a command submission. Optional
+ +
+ +
+
+ interface_views + repeated InterfaceView + +
+ +
Interface views specified in the transaction filter. Includes an ``InterfaceView`` for each interface for which there is a ``InterfaceFilter`` with - its party in the ``witness_parties`` of this event, - and which is implemented by the template of this event, - and which has ``include_interface_view`` set. Optional
+ +
+ +
+
+ witness_parties + repeated string + +
+ +
The parties that are notified of this event. When a ``CreatedEvent`` is returned as part of a transaction tree or ledger-effects transaction, this will include all the parties specified in the ``TransactionFilter`` that are witnesses of the event (the stakeholders of the contract and all informees of all the ancestors of this create action that this participant knows about). If served as part of a ACS delta transaction those will be limited to all parties specified in the ``TransactionFilter`` that are stakeholders of the contract (i.e. either signatories or observers). If the ``CreatedEvent`` is returned as part of an AssignedEvent, ActiveContract or IncompleteUnassigned (so the event is related to an assignment or unassignment): this will include all parties of the ``TransactionFilter`` that are stakeholders of the contract. The behavior of reading create events visible to parties not hosted on the participant node serving the Ledger API is undefined. Concretely, there is neither a guarantee that the participant node will serve all their create events on the ACS stream, nor is there a guarantee that matching archive events are delivered for such create events. For most clients this is not a problem, as they only read events for parties that are hosted on the participant node. If you need to read events for parties that may not be hosted at all times on the participant node, subscribe to the ``TopologyEvent``s for that party by setting a corresponding ``UpdateFormat``. Using these events, query the ACS as-of an offset where the party is hosted on the participant node, and ignore create events at offsets where the party is not hosted on the participant node. Required
+ +
+ +
+
+ signatories + repeated string + +
+ +
The signatories for this contract as specified by the template. Required
+ +
+ +
+
+ observers + repeated string + +
+ +
The observers for this contract as specified explicitly by the template or implicitly as choice controllers. This field never contains parties that are signatories. Required
+ +
+ +
+
+ created_at + Timestamp + +
+ +
Ledger effective time of the transaction that created the contract. Required
+ +
+ +
+
+ package_name + string + +
+ +
The package name of the created contract. Required
+ +
+ +
+
+ acs_delta + bool + +
+ +
Whether this event would be part of respective ACS_DELTA shaped stream, and should therefore considered when tracking contract activeness on the client-side. Required
+ +
+ +
+
+ representative_package_id + string + +
+ +
A package-id present in the participant package store that typechecks the contract's argument. This may differ from the package-id of the template used to create the contract. For contracts created before Canton 3.4, this field matches the contract's creation package-id. NOTE: Experimental, server internal concept, not for client consumption. Subject to change without notice. Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.InterfaceView

+ +

3 fields

+ +
+ +

View of a create event matched by an interface filter.

+ + +
+ +
+
+ interface_id + Identifier + +
+ +
The interface implemented by the matched event. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ view_status + Status + +
+ +
Whether the view was successfully computed, and if not, the reason for the error. The error is reported using the same rules for error codes and messages as the errors returned for API requests. Required
+ +
+ +
+
+ view_value + Record + +
+ +
The value of the interface's view method on this event. Set if it was requested in the ``InterfaceFilter`` and it could be successfully computed. Optional
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.Archived

+ +

2 fields

+ +
+ + +
+ +
+
+ archived_event + ArchivedEvent + +
+ +
Required
+ +
+ +
+
+ synchronizer_id + string + +
+ +
Required The synchronizer which sequenced the archival of the contract
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.ArchivedEvent

+ +

7 fields

+ +
+ +

Records that a contract has been archived, and choices may no longer be exercised on it.

+ + +
+ +
+
+ offset + int64 + +
+ +
The offset of origin. Offsets are managed by the participant nodes. Transactions can thus NOT be assumed to have the same offsets on different participant nodes. Required, it is a valid absolute offset (positive integer)
+ +
+ +
+
+ node_id + int32 + +
+ +
The position of this event in the originating transaction or reassignment. Node IDs are not necessarily equal across participants, as these may see different projections/parts of transactions. Required, must be valid node ID (non-negative integer)
+ +
+ +
+
+ contract_id + string + +
+ +
The ID of the archived contract. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ template_id + Identifier + +
+ +
Identifies the template that defines the choice that archived the contract. This template's package-id may differ from the target contract's package-id if the target contract has been upgraded or downgraded. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ witness_parties + repeated string + +
+ +
The parties that are notified of this event. For an ``ArchivedEvent``, these are the intersection of the stakeholders of the contract in question and the parties specified in the ``TransactionFilter``. The stakeholders are the union of the signatories and the observers of the contract. Each one of its elements must be a valid PartyIdString (as described in ``value.proto``). Required
+ +
+ +
+
+ package_name + string + +
+ +
The package name of the contract. Required
+ +
+ +
+
+ implemented_interfaces + repeated Identifier + +
+ +
The interfaces implemented by the target template that have been matched from the interface filter query. Populated only in case interface filters with include_interface_view set. If defined, the identifier uses the package-id reference format. Optional
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.AssignCommand

+ +

3 fields

+ +
+ +

Assign a contract

+ + +
+ +
+
+ reassignment_id + string + +
+ +
The ID from the unassigned event to be completed by this assignment. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ source + string + +
+ +
The ID of the source synchronizer Must be a valid synchronizer id Required
+ +
+ +
+
+ target + string + +
+ +
The ID of the target synchronizer Must be a valid synchronizer id Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.AssignedEvent

+ +

6 fields

+ +
+ +

Records that a contract has been assigned, and it can be used on the target synchronizer.

+ + +
+ +
+
+ source + string + +
+ +
The ID of the source synchronizer. Must be a valid synchronizer id. Required
+ +
+ +
+
+ target + string + +
+ +
The ID of the target synchronizer. Must be a valid synchronizer id. Required
+ +
+ +
+
+ reassignment_id + string + +
+ +
The ID from the unassigned event. For correlation capabilities. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ submitter + string + +
+ +
Party on whose behalf the assign command was executed. Empty if the assignment happened offline via the repair service. Must be a valid PartyIdString (as described in ``value.proto``). Optional
+ +
+ +
+
+ reassignment_counter + uint64 + +
+ +
Each corresponding assigned and unassigned event has the same reassignment_counter. This strictly increases with each unassign command for the same contract. Creation of the contract corresponds to reassignment_counter equals zero. Required
+ +
+ +
+
+ created_event + CreatedEvent + +
+ +
Required The offset of this event refers to the offset of the assignment, while the node_id is the index of within the batch.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.Command

+ +

4 fields

+ +
+ +

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

+ + +
+ +
+
+ create + CreateCommand + +
+ +
+ +
+
+ exercise + ExerciseCommand + +
+ +
+ +
+
+ exercise_by_key + ExerciseByKeyCommand + +
+ +
+ +
+
+ create_and_exercise + CreateAndExerciseCommand + +
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.CreateCommand

+ +

2 fields

+ +
+ +

Create a new contract instance based on a template.

+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template of contract the client wants to create. Both package-name and package-id reference identifier formats for the template-id are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ create_arguments + Record + +
+ +
The arguments required for creating a contract from this template. Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.ExerciseCommand

+ +

4 fields

+ +
+ +

Exercise a choice on an existing contract.

+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template or interface of the contract the client wants to exercise. Both package-name and package-id reference identifier formats for the template-id are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. To exercise a choice on an interface, specify the interface identifier in the template_id field. Required
+ +
+ +
+
+ contract_id + string + +
+ +
The ID of the contract the client wants to exercise upon. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ choice + string + +
+ +
The name of the choice the client wants to exercise. Must be a valid NameString (as described in ``value.proto``) Required
+ +
+ +
+
+ choice_argument + Value + +
+ +
The argument for this choice. Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.ExerciseByKeyCommand

+ +

4 fields

+ +
+ +

Exercise a choice on an existing contract specified by its key.

+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template of contract the client wants to exercise. Both package-name and package-id reference identifier formats for the template-id are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ contract_key + Value + +
+ +
The key of the contract the client wants to exercise upon. Required
+ +
+ +
+
+ choice + string + +
+ +
The name of the choice the client wants to exercise. Must be a valid NameString (as described in ``value.proto``) Required
+ +
+ +
+
+ choice_argument + Value + +
+ +
The argument for this choice. Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.CreateAndExerciseCommand

+ +

4 fields

+ +
+ +

Create a contract and exercise a choice on it in the same transaction.

+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template of the contract the client wants to create. Both package-name and package-id reference identifier formats for the template-id are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ create_arguments + Record + +
+ +
The arguments required for creating a contract from this template. Required
+ +
+ +
+
+ choice + string + +
+ +
The name of the choice the client wants to exercise. Must be a valid NameString (as described in ``value.proto``). Required
+ +
+ +
+
+ choice_argument + Value + +
+ +
The argument for this choice. Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.Commands

+ +

15 fields

+ +
+ +

A composite command that groups multiple commands together.

+ + +
+ +
+
+ workflow_id + string + +
+ +
Identifier of the on-ledger workflow that this command is a part of. Must be a valid LedgerString (as described in ``value.proto``). Optional
+ +
+ +
+
+ user_id + string + +
+ +
Uniquely identifies the participant user that issued the command. Must be a valid UserIdString (as described in ``value.proto``). Required unless authentication is used with a user token. In that case, the token's user-id will be used for the request's user_id.
+ +
+ +
+
+ command_id + string + +
+ +
Uniquely identifies the command. The triple (user_id, act_as, command_id) constitutes the change ID for the intended ledger change, where act_as is interpreted as a set of party names. The change ID can be used for matching the intended ledger changes with all their completions. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ commands + repeated Command + +
+ +
Individual elements of this atomic command. Must be non-empty. Required
+ +
+ +
+
+ deduplication_duration + Duration + +
+ +
Specifies the length of the deduplication period. It is interpreted relative to the local clock at some point during the submission's processing. Must be non-negative. Must not exceed the maximum deduplication time.
+ +
+ +
+
+ deduplication_offset + int64 + +
+ +
Specifies the start of the deduplication period by a completion stream offset (exclusive). Must be a valid absolute offset (positive integer) or participant begin (zero).
+ +
+ +
+
+ min_ledger_time_abs + Timestamp + +
+ +
Lower bound for the ledger time assigned to the resulting transaction. Note: The ledger time of a transaction is assigned as part of command interpretation. Use this property if you expect that command interpretation will take a considerate amount of time, such that by the time the resulting transaction is sequenced, its assigned ledger time is not valid anymore. Must not be set at the same time as min_ledger_time_rel. Optional
+ +
+ +
+
+ min_ledger_time_rel + Duration + +
+ +
Same as min_ledger_time_abs, but specified as a duration, starting from the time the command is received by the server. Must not be set at the same time as min_ledger_time_abs. Optional
+ +
+ +
+
+ act_as + repeated string + +
+ +
Set of parties on whose behalf the command should be executed. If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request to act on behalf of each of the given parties. Each element must be a valid PartyIdString (as described in ``value.proto``). Required, must be non-empty.
+ +
+ +
+
+ read_as + repeated string + +
+ +
Set of parties on whose behalf (in addition to all parties listed in ``act_as``) contracts can be retrieved. This affects Daml operations such as ``fetch``, ``fetchByKey``, ``lookupByKey``, ``exercise``, and ``exerciseByKey``. Note: A participant node of a Daml network can host multiple parties. Each contract present on the participant node is only visible to a subset of these parties. A command can only use contracts that are visible to at least one of the parties in ``act_as`` or ``read_as``. This visibility check is independent from the Daml authorization rules for fetch operations. If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request to read contract data on behalf of each of the given parties. Optional
+ +
+ +
+
+ submission_id + string + +
+ +
A unique identifier to distinguish completions for different submissions with the same change ID. Typically a random UUID. Applications are expected to use a different UUID for each retry of a submission with the same change ID. Must be a valid LedgerString (as described in ``value.proto``). If omitted, the participant or the committer may set a value of their choice. Optional
+ +
+ +
+
+ disclosed_contracts + repeated DisclosedContract + +
+ +
Additional contracts used to resolve contract & contract key lookups. Optional
+ +
+ +
+
+ synchronizer_id + string + +
+ +
Must be a valid synchronizer id Optional
+ +
+ +
+
+ package_id_selection_preference + repeated string + +
+ +
The package-id selection preference of the client for resolving package names and interface instances in command submission and interpretation
+ +
+ +
+
+ prefetch_contract_keys + repeated PrefetchContractKey + +
+ +
Fetches the contract keys into the caches to speed up the command processing. Should only contain contract keys that are expected to be resolved during interpretation of the commands. Keys of disclosed contracts do not need prefetching. Optional
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.DisclosedContract

+ +

4 fields

+ +
+ +

An additional contract that is used to resolve contract & contract key lookups.

+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template id of the contract. The identifier uses the package-id reference format. If provided, used to validate the template id of the contract serialized in the created_event_blob. Optional
+ +
+ +
+
+ contract_id + string + +
+ +
The contract id If provided, used to validate the contract id of the contract serialized in the created_event_blob. Optional
+ +
+ +
+
+ created_event_blob + bytes + +
+ +
Opaque byte string containing the complete payload required by the Daml engine to reconstruct a contract not known to the receiving participant. Required
+ +
+ +
+
+ synchronizer_id + string + +
+ +
The ID of the synchronizer where the contract is currently assigned Optional
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.PrefetchContractKey

+ +

2 fields

+ +
+ +

Preload contracts

+ + +
+ +
+
+ template_id + Identifier + +
+ +
The template of contract the client wants to prefetch. Both package-name and package-id reference identifier formats for the template-id are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ contract_key + Value + +
+ +
The key of the contract the client wants to prefetch. Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.Completion

+ +

11 fields

+ +
+ +

A completion represents the status of a submitted command on the ledger: it can be successful or failed.

+ + +
+ +
+
+ command_id + string + +
+ +
The ID of the succeeded or failed command. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ status + Status + +
+ +
Identifies the exact type of the error. It uses the same format of conveying error details as it is used for the RPC responses of the APIs. Optional
+ +
+ +
+
+ update_id + string + +
+ +
The update_id of the transaction or reassignment that resulted from the command with command_id. Only set for successfully executed commands. Must be a valid LedgerString (as described in ``value.proto``).
+ +
+ +
+
+ user_id + string + +
+ +
The user-id that was used for the submission, as described in ``commands.proto``. Must be a valid UserIdString (as described in ``value.proto``). Optional for historic completions where this data is not available.
+ +
+ +
+
+ act_as + repeated string + +
+ +
The set of parties on whose behalf the commands were executed. Contains the ``act_as`` parties from ``commands.proto`` filtered to the requesting parties in CompletionStreamRequest. The order of the parties need not be the same as in the submission. Each element must be a valid PartyIdString (as described in ``value.proto``). Optional for historic completions where this data is not available.
+ +
+ +
+
+ submission_id + string + +
+ +
The submission ID this completion refers to, as described in ``commands.proto``. Must be a valid LedgerString (as described in ``value.proto``). Optional
+ +
+ +
+
+ deduplication_offset + int64 + +
+ +
Specifies the start of the deduplication period by a completion stream offset (exclusive). Must be a valid absolute offset (positive integer) or participant begin (zero).
+ +
+ +
+
+ deduplication_duration + Duration + +
+ +
Specifies the length of the deduplication period. It is measured in record time of completions. Must be non-negative.
+ +
+ +
+
+ trace_context + TraceContext + +
+ +
Optional; ledger API trace context The trace context transported in this message corresponds to the trace context supplied by the client application in a HTTP2 header of the original command submission. We typically use a header to transfer this type of information. Here we use message body, because it is used in gRPC streams which do not support per message headers. This field will be populated with the trace context contained in the original submission. If that was not provided, a unique ledger-api-server generated trace context will be used instead.
+ +
+ +
+
+ offset + int64 + +
+ +
May be used in a subsequent CompletionStreamRequest to resume the consumption of this stream at a later time. Required, must be a valid absolute offset (positive integer).
+ +
+ +
+
+ synchronizer_time + SynchronizerTime + +
+ +
The synchronizer along with its record time. The synchronizer id provided, in case of - successful/failed transactions: identifies the synchronizer of the transaction - for successful/failed unassign commands: identifies the source synchronizer - for successful/failed assign commands: identifies the target synchronizer Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.TraceContext

+ +

2 fields

+ +
+ + +
+ +
+
+ traceparent + string + +
+ +
https://www.w3.org/TR/trace-context/
+ +
+ +
+
+ tracestate + string + +
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.SynchronizerTime

+ +

2 fields

+ +
+ + +
+ +
+
+ synchronizer_id + string + +
+ +
The id of the synchronizer. Required
+ +
+ +
+
+ record_time + Timestamp + +
+ +
All commands with a maximum record time below this value MUST be considered lost if their completion has not arrived before this checkpoint. Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.CompletionStreamRequest

+ +

3 fields

+ +
+ + +
+ +
+
+ user_id + string + +
+ +
Only completions of commands submitted with the same user_id will be visible in the stream. Must be a valid UserIdString (as described in ``value.proto``). Required unless authentication is used with a user token. In that case, the token's user-id will be used for the request's user_id.
+ +
+ +
+
+ parties + repeated string + +
+ +
Non-empty list of parties whose data should be included. The stream shows only completions of commands for which at least one of the ``act_as`` parties is in the given set of parties. Must be a valid PartyIdString (as described in ``value.proto``). Required
+ +
+ +
+
+ begin_exclusive + int64 + +
+ +
This optional field indicates the minimum offset for completions. This can be used to resume an earlier completion stream. If not set the ledger uses the ledger begin offset instead. If specified, it must be a valid absolute offset (positive integer) or zero (ledger begin offset). If the ledger has been pruned, this parameter must be specified and greater than the pruning offset.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.CompletionStreamResponse

+ +

2 fields

+ +
+ + +
+ +
+
+ completion + Completion + +
+ +
+ +
+
+ offset_checkpoint + OffsetCheckpoint + +
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.OffsetCheckpoint

+ +

2 fields

+ +
+ +

OffsetCheckpoints may be used to: - detect time out of commands. - provide an offset which can be used to restart consumption.

+ + +
+ +
+
+ offset + int64 + +
+ +
The participant's offset, the details of the offset field are described in ``community/ledger-api/README.md``. Required, must be a valid absolute offset (positive integer).
+ +
+ +
+
+ synchronizer_times + repeated SynchronizerTime + +
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.Created

+ +

2 fields

+ +
+ + +
+ +
+
+ created_event + CreatedEvent + +
+ +
Required The event as it appeared in the context of its original update (i.e. daml transaction or reassignment) on this participant node. You can use its offset and node_id to find the corresponding update and the node within it.
+ +
+ +
+
+ synchronizer_id + string + +
+ +
The synchronizer which sequenced the creation of the contract Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.CumulativeFilter

+ +

3 fields

+ +
+ +

A filter that matches all contracts that are either an instance of one of the ``template_filters`` or that match one of the ``interface_filters``.

+ + +
+ +
+
+ wildcard_filter + WildcardFilter + +
+ +
A wildcard filter that matches all templates Optional
+ +
+ +
+
+ interface_filter + InterfaceFilter + +
+ +
Include an ``InterfaceView`` for every ``InterfaceFilter`` matching a contract. The ``InterfaceFilter`` instances MUST each use a unique ``interface_id``. Optional
+ +
+ +
+
+ template_filter + TemplateFilter + +
+ +
A template for which the data will be included in the ``create_arguments`` of a matching ``CreatedEvent``. If a contract is simultaneously selected by a template filter and one or more interface filters, the corresponding ``include_created_event_blob`` are consolidated using an OR operation. Optional
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.WildcardFilter

+ +

1 fields

+ +
+ +

This filter matches all templates.

+ + +
+ +
+
+ include_created_event_blob + bool + +
+ +
Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``. Use this to access the contract create event payload in your API client for submitting it as a disclosed contract with future commands. Optional
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.InterfaceFilter

+ +

3 fields

+ +
+ +

This filter matches contracts that implement a specific interface.

+ + +
+ +
+
+ interface_id + Identifier + +
+ +
The interface that a matching contract must implement. The ``interface_id`` needs to be valid: corresponding interface should be defined in one of the available packages at the time of the query. Both package-name and package-id reference formats for the identifier are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ include_interface_view + bool + +
+ +
Whether to include the interface view on the contract in the returned ``CreatedEvent``. Use this to access contract data in a uniform manner in your API client. Optional
+ +
+ +
+
+ include_created_event_blob + bool + +
+ +
Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``. Use this to access the contract create event payload in your API client for submitting it as a disclosed contract with future commands. Optional
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.TemplateFilter

+ +

2 fields

+ +
+ +

This filter matches contracts of a specific template.

+ + +
+ +
+
+ template_id + Identifier + +
+ +
A template for which the payload should be included in the response. The ``template_id`` needs to be valid: corresponding template should be defined in one of the available packages at the time of the query. Both package-name and package-id reference formats for the identifier are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required
+ +
+ +
+
+ include_created_event_blob + bool + +
+ +
Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``. Use this to access the contract event payload in your API client for submitting it as a disclosed contract with future commands. Optional
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.Event

+ +

3 fields

+ +
+ +

Events in transactions can have two primary shapes: - ACS delta: events can be CreatedEvent or ArchivedEvent - ledger effects: events can be CreatedEvent or ExercisedEvent In the update service the events are restricted to the events visible for the parties specified in the transaction filter. Each event message type below contains a ``witness_parties`` field which indicates the subset of the requested parties that can see the event in question.

+ + +
+ +
+
+ created + CreatedEvent + +
+ +
The event as it appeared in the context of its original daml transaction on this participant node. In particular, the offset, node_id pair of the daml transaction are preserved.
+ +
+ +
+
+ archived + ArchivedEvent + +
+ +
+ +
+
+ exercised + ExercisedEvent + +
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.ExercisedEvent

+ +

15 fields

+ +
+ +

Records that a choice has been exercised on a target contract.

+ + +
+ +
+
+ offset + int64 + +
+ +
The offset of origin. Offsets are managed by the participant nodes. Transactions can thus NOT be assumed to have the same offsets on different participant nodes. Required, it is a valid absolute offset (positive integer)
+ +
+ +
+
+ node_id + int32 + +
+ +
The position of this event in the originating transaction or reassignment. Node IDs are not necessarily equal across participants, as these may see different projections/parts of transactions. Required, must be valid node ID (non-negative integer)
+ +
+ +
+
+ contract_id + string + +
+ +
The ID of the target contract. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ template_id + Identifier + +
+ +
Identifies the template that defines the executed choice. This template's package-id may differ from the target contract's package-id if the target contract has been upgraded or downgraded. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ interface_id + Identifier + +
+ +
The interface where the choice is defined, if inherited. If defined, the identifier uses the package-id reference format. Optional
+ +
+ +
+
+ choice + string + +
+ +
The choice that was exercised on the target contract. Must be a valid NameString (as described in ``value.proto``). Required
+ +
+ +
+
+ choice_argument + Value + +
+ +
The argument of the exercised choice. Required
+ +
+ +
+
+ acting_parties + repeated string + +
+ +
The parties that exercised the choice. Each element must be a valid PartyIdString (as described in ``value.proto``). Required
+ +
+ +
+
+ consuming + bool + +
+ +
If true, the target contract may no longer be exercised. Required
+ +
+ +
+
+ witness_parties + repeated string + +
+ +
The parties that are notified of this event. The witnesses of an exercise node will depend on whether the exercise was consuming or not. If consuming, the witnesses are the union of the stakeholders, the actors and all informees of all the ancestors of this event this participant knows about. If not consuming, the witnesses are the union of the signatories, the actors and all informees of all the ancestors of this event this participant knows about. In both cases the witnesses are limited to the querying parties, or not limited in case anyParty filters are used. Note that the actors might not necessarily be observers and thus stakeholders. This is the case when the controllers of a choice are specified using "flexible controllers", using the ``choice ... controller`` syntax, and said controllers are not explicitly marked as observers. Each element must be a valid PartyIdString (as described in ``value.proto``). Required
+ +
+ +
+
+ last_descendant_node_id + int32 + +
+ +
Specifies the upper boundary of the node ids of the events in the same transaction that appeared as a result of this ``ExercisedEvent``. This allows unambiguous identification of all the members of the subtree rooted at this node. A full subtree can be constructed when all descendant nodes are present in the stream. If nodes are heavily filtered, it is only possible to determine if a node is in a consequent subtree or not. Required
+ +
+ +
+
+ exercise_result + Value + +
+ +
The result of exercising the choice. Required
+ +
+ +
+
+ package_name + string + +
+ +
The package name of the contract. Required
+ +
+ +
+
+ implemented_interfaces + repeated Identifier + +
+ +
If the event is consuming, the interfaces implemented by the target template that have been matched from the interface filter query. Populated only in case interface filters with include_interface_view set. The identifier uses the package-id reference format. Optional
+ +
+ +
+
+ acs_delta + bool + +
+ +
Whether this event would be part of respective ACS_DELTA shaped stream, and should therefore considered when tracking contract activeness on the client-side. Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.EventFormat

+ +

3 fields

+ +
+ +

A format for events which defines both which events should be included and what data should be computed and included for them. Note that some of the filtering behavior depends on the `TransactionShape`, which is expected to be specified alongside usages of `EventFormat`.

+ + +
+ +
+
+ filters_by_party + repeated map + +
+ +
Each key must be a valid PartyIdString (as described in ``value.proto``). The interpretation of the filter depends on the transaction-shape being filtered: 1. For **ledger-effects** create and exercise events are returned, for which the witnesses include at least one of the listed parties and match the per-party filter. 2. For **transaction and active-contract-set streams** create and archive events are returned for all contracts whose stakeholders include at least one of the listed parties and match the per-party filter. Optional
+ +
+ +
+
+ filters_for_any_party + Filters + +
+ +
Wildcard filters that apply to all the parties existing on the participant. The interpretation of the filters is the same with the per-party filter as described above. Optional
+ +
+ +
+
+ verbose + bool + +
+ +
If enabled, values served over the API will contain more information than strictly necessary to interpret the data. In particular, setting the verbose flag to true triggers the ledger to include labels for record fields. Optional
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.Filters

+ +

1 fields

+ +
+ +

The union of a set of template filters, interface filters, or a wildcard.

+ + +
+ +
+
+ cumulative + repeated CumulativeFilter + +
+ +
Every filter in the cumulative list expands the scope of the resulting stream. Each interface, template or wildcard filter means additional events that will match the query. The impact of include_interface_view and include_created_event_blob fields in the filters will also be accumulated. A template or an interface SHOULD NOT appear twice in the accumulative field. A wildcard filter SHOULD NOT be defined more than once in the accumulative field. Optional, if no ``CumulativeFilter`` defined, the default of a single ``WildcardFilter`` with include_created_event_blob unset is used.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.ExperimentalCommandInspectionService

+ +

1 fields

+ +
+ +

Whether the Ledger API supports command inspection service

+ + +
+ +
+
+ supported + bool + +
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.ExperimentalFeatures

+ +

2 fields

+ +
+ +

IMPORTANT: in contrast to other parts of the Ledger API, only json-wire backwards compatibility guarantees are given for the messages in this file. See the feature message definitions for descriptions.

+ + +
+ +
+
+ static_time + ExperimentalStaticTime + +
+ +
+ +
+
+ command_inspection_service + ExperimentalCommandInspectionService + +
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.ExperimentalStaticTime

+ +

1 fields

+ +
+ +

Ledger is in the static time mode and exposes a time service.

+ + +
+ +
+
+ supported + bool + +
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.ExperimentalPartyTopologyEvents

+ +

1 fields

+ +
+ +

Whether the Ledger API supports party events

+ + +
+ +
+
+ supported + bool + +
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.FeaturesDescriptor

+ +

5 fields

+ +
+ + +
+ +
+
+ experimental + ExperimentalFeatures + +
+ +
Features under development or features that are used for ledger implementation testing purposes only. Daml applications SHOULD not depend on these in production.
+ +
+ +
+
+ user_management + UserManagementFeature + +
+ +
If set, then the Ledger API server supports user management. It is recommended that clients query this field to gracefully adjust their behavior for ledgers that do not support user management.
+ +
+ +
+
+ party_management + PartyManagementFeature + +
+ +
If set, then the Ledger API server supports party management configurability. It is recommended that clients query this field to gracefully adjust their behavior to maximum party page size.
+ +
+ +
+
+ offset_checkpoint + OffsetCheckpointFeature + +
+ +
It contains the timeouts related to the periodic offset checkpoint emission
+ +
+ +
+
+ package_feature + PackageFeature + +
+ +
If set, then the Ledger API server supports package listing configurability. It is recommended that clients query this field to gracefully adjust their behavior to maximum package listing page size.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.UserManagementFeature

+ +

3 fields

+ +
+ + +
+ +
+
+ supported + bool + +
+ +
Whether the Ledger API server provides the user management service.
+ +
+ +
+
+ max_rights_per_user + int32 + +
+ +
The maximum number of rights that can be assigned to a single user. Servers MUST support at least 100 rights per user. A value of 0 means that the server enforces no rights per user limit.
+ +
+ +
+
+ max_users_page_size + int32 + +
+ +
The maximum number of users the server can return in a single response (page). Servers MUST support at least a 100 users per page. A value of 0 means that the server enforces no page size limit.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.PartyManagementFeature

+ +

1 fields

+ +
+ + +
+ +
+
+ max_parties_page_size + int32 + +
+ +
The maximum number of parties the server can return in a single response (page).
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.OffsetCheckpointFeature

+ +

1 fields

+ +
+ + +
+ +
+
+ max_offset_checkpoint_emission_delay + Duration + +
+ +
The maximum delay to emmit a new OffsetCheckpoint if it exists
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.PackageFeature

+ +

1 fields

+ +
+ + +
+ +
+
+ max_vetted_packages_page_size + int32 + +
+ +
The maximum number of vetted packages the server can return in a single response (page) when listing them.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.GetActiveContractsRequest

+ +

2 fields

+ +
+ +

If the given offset is different than the ledger end, and there are (un)assignments in-flight at the given offset, the snapshot may fail with "FAILED_PRECONDITION/PARTICIPANT_PRUNED_DATA_ACCESSED". Note that it is ok to request acs snapshots for party migration with offsets other than ledger end, because party migration is not concerned with incomplete (un)assignments.

+ + +
+ +
+
+ active_at_offset + int64 + +
+ +
The offset at which the snapshot of the active contracts will be computed. Must be no greater than the current ledger end offset. Must be greater than or equal to the last pruning offset. Required, must be a valid absolute offset (positive integer) or ledger begin offset (zero). If zero, the empty set will be returned.
+ +
+ +
+
+ event_format + EventFormat + +
+ +
Format of the contract_entries in the result. In case of CreatedEvent the presentation will be of TRANSACTION_SHAPE_ACS_DELTA. Optional for backwards compatibility, defaults to an EventFormat where: - filters_by_party is the filter.filters_by_party from this request - filters_for_any_party is the filter.filters_for_any_party from this request - verbose is the verbose field from this request
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.GetActiveContractsResponse

+ +

4 fields

+ +
+ + +
+ +
+
+ workflow_id + string + +
+ +
The workflow ID used in command submission which corresponds to the contract_entry. Only set if the ``workflow_id`` for the command was set. Must be a valid LedgerString (as described in ``value.proto``). Optional
+ +
+ +
+
+ active_contract + ActiveContract + +
+ +
The contract is active on the assigned synchronizer, meaning: there was an activation event on the given synchronizer ( created, assigned), which is not followed by a deactivation event (archived, unassigned) on the same synchronizer, until the active_at_offset. Since activeness is defined as a per synchronizer concept, it is possible, that a contract is active on one synchronizer, but already archived on another. There will be one such message for each synchronizer the contract is active on.
+ +
+ +
+
+ incomplete_unassigned + IncompleteUnassigned + +
+ +
Included iff the unassigned event was before or at the active_at_offset, but there was no corresponding assigned event before or at the active_at_offset.
+ +
+ +
+
+ incomplete_assigned + IncompleteAssigned + +
+ +
Important: this message is not indicating that the contract is active on the target synchronizer! Included iff the assigned event was before or at the active_at_offset, but there was no corresponding unassigned event before or at the active_at_offset.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.IncompleteUnassigned

+ +

2 fields

+ +
+ + +
+ +
+
+ created_event + CreatedEvent + +
+ +
Required The event as it appeared in the context of its last activation update (i.e. daml transaction or reassignment). In particular, the last activation offset, node_id pair is preserved. The last activation update is the most recent update created or assigned this contract on synchronizer_id synchronizer before the unassigned_event. The offset of the CreatedEvent might point to an already pruned update, therefore it cannot necessarily be used for lookups.
+ +
+ +
+
+ unassigned_event + UnassignedEvent + +
+ +
Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.UnassignedEvent

+ +

12 fields

+ +
+ +

Records that a contract has been unassigned, and it becomes unusable on the source synchronizer

+ + +
+ +
+
+ reassignment_id + string + +
+ +
The ID of the unassignment. This needs to be used as an input for a assign ReassignmentCommand. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ contract_id + string + +
+ +
The ID of the reassigned contract. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ template_id + Identifier + +
+ +
The template of the reassigned contract. The identifier uses the package-id reference format. Required
+ +
+ +
+
+ source + string + +
+ +
The ID of the source synchronizer Must be a valid synchronizer id Required
+ +
+ +
+
+ target + string + +
+ +
The ID of the target synchronizer Must be a valid synchronizer id Required
+ +
+ +
+
+ submitter + string + +
+ +
Party on whose behalf the unassign command was executed. Empty if the unassignment happened offline via the repair service. Must be a valid PartyIdString (as described in ``value.proto``). Optional
+ +
+ +
+
+ reassignment_counter + uint64 + +
+ +
Each corresponding assigned and unassigned event has the same reassignment_counter. This strictly increases with each unassign command for the same contract. Creation of the contract corresponds to reassignment_counter equals zero. Required
+ +
+ +
+
+ assignment_exclusivity + Timestamp + +
+ +
Assignment exclusivity Before this time (measured on the target synchronizer), only the submitter of the unassignment can initiate the assignment Defined for reassigning participants. Optional
+ +
+ +
+
+ witness_parties + repeated string + +
+ +
The parties that are notified of this event. Required
+ +
+ +
+
+ package_name + string + +
+ +
The package name of the contract. Required
+ +
+ +
+
+ offset + int64 + +
+ +
The offset of origin. Offsets are managed by the participant nodes. Reassignments can thus NOT be assumed to have the same offsets on different participant nodes. Required, it is a valid absolute offset (positive integer)
+ +
+ +
+
+ node_id + int32 + +
+ +
The position of this event in the originating reassignment. Node IDs are not necessarily equal across participants, as these may see different projections/parts of reassignments. Required, must be valid node ID (non-negative integer)
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.IncompleteAssigned

+ +

1 fields

+ +
+ + +
+ +
+
+ assigned_event + AssignedEvent + +
+ +
Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.GetConnectedSynchronizersRequest

+ +

3 fields

+ +
+ + +
+ +
+
+ party + string + +
+ +
The party of interest Must be a valid PartyIdString (as described in ``value.proto``). If empty, all synchronizers this node is connected to will be returned Optional
+ +
+ +
+
+ participant_id + string + +
+ +
The id of a participant whose mapping of a party to connected synchronizers is requested. Must be a valid participant-id retrieved through a prior call to getParticipantId. Defaults to the participant id of the host participant. Optional
+ +
+ +
+
+ identity_provider_id + string + +
+ +
The ID of the identity provider configured by ``Identity Provider Config`` Optional, if not set, assume the user is managed by the default identity provider.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.GetConnectedSynchronizersResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ connected_synchronizers + repeated ConnectedSynchronizer + +
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.GetConnectedSynchronizersResponse.ConnectedSynchronizer

+ +

3 fields

+ +
+ + +
+ +
+
+ synchronizer_alias + string + +
+ +
The alias of the synchronizer Required
+ +
+ +
+
+ synchronizer_id + string + +
+ +
The ID of the synchronizer Required
+ +
+ +
+
+ permission + ParticipantPermission + +
+ +
The permission on the synchronizer Set if a party was used in the request, otherwise unspecified. Optional
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.ParticipantPermission

+ +

4 values

+ +
+ +

Enum indicating the permission level that the participant has for the party whose connected synchronizers are being listed.

+ + + +
    + +
  • PARTICIPANT_PERMISSION_UNSPECIFIED
    • + +
  • PARTICIPANT_PERMISSION_SUBMISSION
    • + +
  • PARTICIPANT_PERMISSION_CONFIRMATION
    • + +
  • PARTICIPANT_PERMISSION_OBSERVATION
    • + +
+ + +
+ +
+
+

com.daml.ledger.api.v2.GetContractRequest

+ +

2 fields

+ +
+ + +
+ +
+
+ contract_id + string + +
+ +
The ID of the contract. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ querying_parties + repeated string + +
+ +
The list of querying parties The stakeholders of the referenced contract must have an intersection with any of these parties to return the result. Optional, if no querying_parties specified, all possible contracts could be returned.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.GetContractResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ created_event + CreatedEvent + +
+ +
The representative_package_id will be always set to the contract package ID, therefore this endpoint should not be used to lookup contract which entered the participant via party replication or repair service. The witnesses field will contain only the querying_parties which are also stakeholders of the contract as well. The following fields of the created event cannot be populated, so those should not be used / parsed: - offset - node_id - created_event_blob - interface_views - acs_delta Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.GetEventsByContractIdRequest

+ +

2 fields

+ +
+ + +
+ +
+
+ contract_id + string + +
+ +
The contract id being queried. Required
+ +
+ +
+
+ event_format + EventFormat + +
+ +
Format of the events in the result, the presentation will be of TRANSACTION_SHAPE_ACS_DELTA. Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.GetEventsByContractIdResponse

+ +

2 fields

+ +
+ + +
+ +
+
+ created + Created + +
+ +
The create event for the contract with the ``contract_id`` given in the request provided it exists and has not yet been pruned. Optional
+ +
+ +
+
+ archived + Archived + +
+ +
The archive event for the contract with the ``contract_id`` given in the request provided such an archive event exists and it has not yet been pruned. Optional
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.GetLatestPrunedOffsetsRequest

+ +

0 fields

+ +
+ +

Empty for now, but may contain fields in the future.

+ + + + +
+ +
+
+

com.daml.ledger.api.v2.GetLatestPrunedOffsetsResponse

+ +

2 fields

+ +
+ + +
+ +
+
+ participant_pruned_up_to_inclusive + int64 + +
+ +
It will always be a non-negative integer. If positive, the absolute offset up to which the ledger has been pruned, disregarding the state of all divulged contracts pruning. If zero, the ledger has not been pruned yet.
+ +
+ +
+
+ all_divulged_contracts_pruned_up_to_inclusive + int64 + +
+ +
It will always be a non-negative integer. If positive, the absolute offset up to which all divulged events have been pruned on the ledger. It can be at or before the ``participant_pruned_up_to_inclusive`` offset. For more details about all divulged events pruning, see ``PruneRequest.prune_all_divulged_contracts`` in ``participant_pruning_service.proto``. If zero, the divulged events have not been pruned yet.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.GetLedgerApiVersionRequest

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.daml.ledger.api.v2.GetLedgerApiVersionResponse

+ +

2 fields

+ +
+ + +
+ +
+
+ version + string + +
+ +
The version of the ledger API.
+ +
+ +
+
+ features + FeaturesDescriptor + +
+ +
The features supported by this Ledger API endpoint. Daml applications CAN use the feature descriptor on top of version constraints on the Ledger API version to determine whether a given Ledger API endpoint supports the features required to run the application. See the feature descriptions themselves for the relation between Ledger API versions and feature presence.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.GetLedgerEndRequest

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.daml.ledger.api.v2.GetLedgerEndResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ offset + int64 + +
+ +
It will always be a non-negative integer. If zero, the participant view of the ledger is empty. If positive, the absolute offset of the ledger as viewed by the participant.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.GetPackageRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ package_id + string + +
+ +
The ID of the requested package. Must be a valid PackageIdString (as described in ``value.proto``). Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.GetPackageResponse

+ +

3 fields

+ +
+ + +
+ +
+
+ hash_function + HashFunction + +
+ +
The hash function we use to calculate the hash. Required
+ +
+ +
+
+ archive_payload + bytes + +
+ +
Contains a ``daml_lf`` ArchivePayload. See further details in ``daml_lf.proto``. Required
+ +
+ +
+
+ hash + string + +
+ +
The hash of the archive payload, can also used as a ``package_id``. Must be a valid PackageIdString (as described in ``value.proto``). Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.HashFunction

+ +

1 values

+ +
+ + + +
    + +
  • HASH_FUNCTION_SHA256
    • + +
+ + +
+ +
+
+

com.daml.ledger.api.v2.GetPackageStatusRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ package_id + string + +
+ +
The ID of the requested package. Must be a valid PackageIdString (as described in ``value.proto``). Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.GetPackageStatusResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ package_status + PackageStatus + +
+ +
The status of the package.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.PackageStatus

+ +

2 values

+ +
+ + + +
    + +
  • PACKAGE_STATUS_UNSPECIFIED
    • + +
  • PACKAGE_STATUS_REGISTERED
    • + +
+ + +
+ +
+
+

com.daml.ledger.api.v2.GetUpdateByIdRequest

+ +

2 fields

+ +
+ + +
+ +
+
+ update_id + string + +
+ +
The ID of a particular update. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ update_format + UpdateFormat + +
+ +
The format for the update. Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.UpdateFormat

+ +

3 fields

+ +
+ +

A format specifying what updates to include and how to render them.

+ + +
+ +
+
+ include_transactions + TransactionFormat + +
+ +
Include Daml transactions in streams. Optional, if unset, no transactions are emitted in the stream.
+ +
+ +
+
+ include_reassignments + EventFormat + +
+ +
Include (un)assignments in the stream. The events in the result take the shape TRANSACTION_SHAPE_ACS_DELTA. Optional, if unset, no (un)assignments are emitted in the stream.
+ +
+ +
+
+ include_topology_events + TopologyFormat + +
+ +
Include topology events in streams. Optional, if unset no topology events are emitted in the stream.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.TransactionFormat

+ +

2 fields

+ +
+ +

A format that specifies what events to include in Daml transactions and what data to compute and include for them.

+ + +
+ +
+
+ event_format + EventFormat + +
+ +
Required
+ +
+ +
+
+ transaction_shape + TransactionShape + +
+ +
What transaction shape to use for interpreting the filters of the event format. Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.TransactionShape

+ +

3 values

+ +
+ +

Event shape for Transactions. Shapes are exclusive and only one of them can be defined in queries.

+ + + +
    + +
  • TRANSACTION_SHAPE_UNSPECIFIED
    • + +
  • TRANSACTION_SHAPE_ACS_DELTA
    • + +
  • TRANSACTION_SHAPE_LEDGER_EFFECTS
    • + +
+ + +
+ +
+
+

com.daml.ledger.api.v2.TopologyFormat

+ +

1 fields

+ +
+ +

A format specifying which topology transactions to include and how to render them.

+ + +
+ +
+
+ include_participant_authorization_events + ParticipantAuthorizationTopologyFormat + +
+ +
Include participant authorization topology events in streams. Optional, if unset no participant authorization topology events are emitted in the stream.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.ParticipantAuthorizationTopologyFormat

+ +

1 fields

+ +
+ +

A format specifying which participant authorization topology transactions to include and how to render them.

+ + +
+ +
+
+ parties + repeated string + +
+ +
List of parties for which the topology transactions should be sent. Empty means: for all parties.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.GetUpdateByOffsetRequest

+ +

2 fields

+ +
+ + +
+ +
+
+ offset + int64 + +
+ +
The offset of the update being looked up. Must be a valid absolute offset (positive integer). Required
+ +
+ +
+
+ update_format + UpdateFormat + +
+ +
The format for the update. Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.GetUpdateResponse

+ +

3 fields

+ +
+ + +
+ +
+
+ transaction + Transaction + +
+ +
+ +
+
+ reassignment + Reassignment + +
+ +
+ +
+
+ topology_transaction + TopologyTransaction + +
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.Transaction

+ +

10 fields

+ +
+ +

Filtered view of an on-ledger transaction's create and archive events.

+ + +
+ +
+
+ update_id + string + +
+ +
Assigned by the server. Useful for correlating logs. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ command_id + string + +
+ +
The ID of the command which resulted in this transaction. Missing for everyone except the submitting party. Must be a valid LedgerString (as described in ``value.proto``). Optional
+ +
+ +
+
+ workflow_id + string + +
+ +
The workflow ID used in command submission. Must be a valid LedgerString (as described in ``value.proto``). Optional
+ +
+ +
+
+ effective_at + Timestamp + +
+ +
Ledger effective time. Required
+ +
+ +
+
+ events + repeated Event + +
+ +
The collection of events. Contains: - ``CreatedEvent`` or ``ArchivedEvent`` in case of ACS_DELTA transaction shape - ``CreatedEvent`` or ``ExercisedEvent`` in case of LEDGER_EFFECTS transaction shape Required
+ +
+ +
+
+ offset + int64 + +
+ +
The absolute offset. The details of this field are described in ``community/ledger-api/README.md``. Required, it is a valid absolute offset (positive integer).
+ +
+ +
+
+ synchronizer_id + string + +
+ +
A valid synchronizer id. Identifies the synchronizer that synchronized the transaction. Required
+ +
+ +
+
+ trace_context + TraceContext + +
+ +
Optional; ledger API trace context The trace context transported in this message corresponds to the trace context supplied by the client application in a HTTP2 header of the original command submission. We typically use a header to transfer this type of information. Here we use message body, because it is used in gRPC streams which do not support per message headers. This field will be populated with the trace context contained in the original submission. If that was not provided, a unique ledger-api-server generated trace context will be used instead.
+ +
+ +
+
+ record_time + Timestamp + +
+ +
The time at which the transaction was recorded. The record time refers to the synchronizer which synchronized the transaction. Required
+ +
+ +
+
+ external_transaction_hash + bytes + +
+ +
For transaction externally signed, contains the external transaction hash signed by the external party. Can be used to correlate an external submission with a committed transaction. Optional
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.Reassignment

+ +

8 fields

+ +
+ +

Complete view of an on-ledger reassignment.

+ + +
+ +
+
+ update_id + string + +
+ +
Assigned by the server. Useful for correlating logs. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ command_id + string + +
+ +
The ID of the command which resulted in this reassignment. Missing for everyone except the submitting party on the submitting participant. Must be a valid LedgerString (as described in ``value.proto``). Optional
+ +
+ +
+
+ workflow_id + string + +
+ +
The workflow ID used in reassignment command submission. Only set if the ``workflow_id`` for the command was set. Must be a valid LedgerString (as described in ``value.proto``). Optional
+ +
+ +
+
+ offset + int64 + +
+ +
The participant's offset. The details of this field are described in ``community/ledger-api/README.md``. Required, must be a valid absolute offset (positive integer).
+ +
+ +
+
+ events + repeated ReassignmentEvent + +
+ +
The collection of reassignment events. Required.
+ +
+ +
+
+ trace_context + TraceContext + +
+ +
Optional; ledger API trace context The trace context transported in this message corresponds to the trace context supplied by the client application in a HTTP2 header of the original command submission. We typically use a header to transfer this type of information. Here we use message body, because it is used in gRPC streams which do not support per message headers. This field will be populated with the trace context contained in the original submission. If that was not provided, a unique ledger-api-server generated trace context will be used instead.
+ +
+ +
+
+ record_time + Timestamp + +
+ +
The time at which the reassignment was recorded. The record time refers to the source/target synchronizer for an unassign/assign event respectively. Required
+ +
+ +
+
+ synchronizer_id + string + +
+ +
A valid synchronizer id. Identifies the synchronizer that synchronized this Reassignment. Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.ReassignmentEvent

+ +

2 fields

+ +
+ + +
+ +
+
+ unassigned + UnassignedEvent + +
+ +
+ +
+
+ assigned + AssignedEvent + +
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.TopologyTransaction

+ +

6 fields

+ +
+ + +
+ +
+
+ update_id + string + +
+ +
Assigned by the server. Useful for correlating logs. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ offset + int64 + +
+ +
The absolute offset. The details of this field are described in ``community/ledger-api/README.md``. Required, it is a valid absolute offset (positive integer).
+ +
+ +
+
+ synchronizer_id + string + +
+ +
A valid synchronizer id. Identifies the synchronizer that synchronized the topology transaction. Required
+ +
+ +
+
+ record_time + Timestamp + +
+ +
The time at which the changes in the topology transaction become effective. There is a small delay between a topology transaction being sequenced and the changes it contains becoming effective. Topology transactions appear in order relative to a synchronizer based on their effective time rather than their sequencing time. Required
+ +
+ +
+
+ events + repeated TopologyEvent + +
+ +
A non-empty list of topology events. Required
+ +
+ +
+
+ trace_context + TraceContext + +
+ +
Optional; ledger API trace context The trace context transported in this message corresponds to the trace context supplied by the client application in a HTTP2 header of the original command submission. We typically use a header to transfer this type of information. Here we use message body, because it is used in gRPC streams which do not support per message headers. This field will be populated with the trace context contained in the original submission. If that was not provided, a unique ledger-api-server generated trace context will be used instead.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.TopologyEvent

+ +

3 fields

+ +
+ + +
+ +
+
+ participant_authorization_changed + ParticipantAuthorizationChanged + +
+ +
+ +
+
+ participant_authorization_revoked + ParticipantAuthorizationRevoked + +
+ +
+ +
+
+ participant_authorization_added + ParticipantAuthorizationAdded + +
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.ParticipantAuthorizationChanged

+ +

3 fields

+ +
+ + +
+ +
+
+ party_id + string + +
+ +
Required
+ +
+ +
+
+ participant_id + string + +
+ +
Required
+ +
+ +
+
+ participant_permission + ParticipantPermission + +
+ +
Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.ParticipantAuthorizationRevoked

+ +

2 fields

+ +
+ + +
+ +
+
+ party_id + string + +
+ +
Required
+ +
+ +
+
+ participant_id + string + +
+ +
Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.ParticipantAuthorizationAdded

+ +

3 fields

+ +
+ + +
+ +
+
+ party_id + string + +
+ +
Required
+ +
+ +
+
+ participant_id + string + +
+ +
Required
+ +
+ +
+
+ participant_permission + ParticipantPermission + +
+ +
Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.GetUpdatesRequest

+ +

3 fields

+ +
+ + +
+ +
+
+ begin_exclusive + int64 + +
+ +
Beginning of the requested ledger section (non-negative integer). The response will only contain transactions whose offset is strictly greater than this. If zero, the stream will start from the beginning of the ledger. If positive, the streaming will start after this absolute offset. If the ledger has been pruned, this parameter must be specified and be greater than the pruning offset.
+ +
+ +
+
+ end_inclusive + int64 + +
+ +
End of the requested ledger section. The response will only contain transactions whose offset is less than or equal to this. Optional, if empty, the stream will not terminate. If specified, the stream will terminate after this absolute offset (positive integer) is reached.
+ +
+ +
+
+ update_format + UpdateFormat + +
+ +
Must be unset for GetUpdateTrees request. Optional for backwards compatibility for GetUpdates request: defaults to an UpdateFormat where: - include_transactions.event_format.filters_by_party = the filter.filters_by_party on this request - include_transactions.event_format.filters_for_any_party = the filter.filters_for_any_party on this request - include_transactions.event_format.verbose = the same flag specified on this request - include_transactions.transaction_shape = TRANSACTION_SHAPE_ACS_DELTA - include_reassignments.filter = the same filter specified on this request - include_reassignments.verbose = the same flag specified on this request - include_topology_events.include_participant_authorization_events.parties = all the parties specified in filter
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.GetUpdatesResponse

+ +

4 fields

+ +
+ + +
+ +
+
+ transaction + Transaction + +
+ +
+ +
+
+ reassignment + Reassignment + +
+ +
+ +
+
+ offset_checkpoint + OffsetCheckpoint + +
+ +
+ +
+
+ topology_transaction + TopologyTransaction + +
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.ListPackagesRequest

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.daml.ledger.api.v2.ListPackagesResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ package_ids + repeated string + +
+ +
The IDs of all Daml-LF packages supported by the server. Each element must be a valid PackageIdString (as described in ``value.proto``). Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.ListVettedPackagesRequest

+ +

4 fields

+ +
+ + +
+ +
+
+ package_metadata_filter + PackageMetadataFilter + +
+ +
The package metadata filter the returned vetted packages set must satisfy. Optional
+ +
+ +
+
+ topology_state_filter + TopologyStateFilter + +
+ +
The topology filter the returned vetted packages set must satisfy. Optional
+ +
+ +
+
+ page_token + string + +
+ +
Pagination token to determine the specific page to fetch. Using the token guarantees that ``VettedPackages`` on a subsequent page are all greater (``VettedPackages`` are sorted by synchronizer ID then participant ID) than the last ``VettedPackages`` on a previous page. The server does not store intermediate results between calls chained by a series of page tokens. As a consequence, if new vetted packages are being added and a page is requested twice using the same token, more packages can be returned on the second call. Leave unspecified (i.e. as empty string) to fetch the first page. Optional
+ +
+ +
+
+ page_size + uint32 + +
+ +
Maximum number of ``VettedPackages`` results to return in a single page. If the page_size is unspecified (i.e. left as 0), the server will decide the number of results to be returned. If the page_size exceeds the maximum supported by the server, an error will be returned. To obtain the server's maximum consult the PackageService descriptor available in the VersionService. Optional
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.PackageMetadataFilter

+ +

2 fields

+ +
+ +

Filter the VettedPackages by package metadata. A PackageMetadataFilter without package_ids and without package_name_prefixes matches any vetted package. Non-empty fields specify candidate values of which at least one must match. If both fields are set, then a candidate is returned if it matches one of the fields.

+ + +
+ +
+
+ package_ids + repeated string + +
+ +
If this list is non-empty, any vetted package with a package ID in this list will match the filter.
+ +
+ +
+
+ package_name_prefixes + repeated string + +
+ +
If this list is non-empty, any vetted package with a name matching at least one prefix in this list will match the filter.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.TopologyStateFilter

+ +

2 fields

+ +
+ +

Filter the vetted packages by the participant and synchronizer that they are hosted on. Empty fields are ignored, such that a ``TopologyStateFilter`` without participant_ids and without synchronizer_ids matches a vetted package hosted on any participant and synchronizer. Non-empty fields specify candidate values of which at least one must match. If both fields are set then at least one candidate value must match from each field.

+ + +
+ +
+
+ participant_ids + repeated string + +
+ +
If this list is non-empty, only vetted packages hosted on participants listed in this field match the filter. Query the current Ledger API's participant's ID via the public ``GetParticipantId`` command in ``PartyManagementService``.
+ +
+ +
+
+ synchronizer_ids + repeated string + +
+ +
If this list is non-empty, only vetted packages from the topology state of the synchronizers in this list match the filter.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.ListVettedPackagesResponse

+ +

2 fields

+ +
+ + +
+ +
+
+ vetted_packages + repeated VettedPackages + +
+ +
All ``VettedPackages`` that contain at least one ``VettedPackage`` matching both a ``PackageMetadataFilter`` and a ``TopologyStateFilter``. Sorted by synchronizer_id then participant_id.
+ +
+ +
+
+ next_page_token + string + +
+ +
Pagination token to retrieve the next page. Empty string if there are no further results.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.VettedPackages

+ +

4 fields

+ +
+ +

The list of packages vetted on a given participant and synchronizer, modelled 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>`_. The list only contains packages that matched a filter in the query that originated it.

+ + +
+ +
+
+ packages + repeated VettedPackage + +
+ +
Sorted by package_name and package_version where known, and package_id as a last resort.
+ +
+ +
+
+ participant_id + string + +
+ +
Participant on which these packages are vetted. Always present.
+ +
+ +
+
+ synchronizer_id + string + +
+ +
Synchronizer on which these packages are vetted. Always present.
+ +
+ +
+
+ topology_serial + uint32 + +
+ +
Serial of last ``VettedPackages`` topology transaction of this participant and on this synchronizer. Always present.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.VettedPackage

+ +

5 fields

+ +
+ +

A package that is vetting on a given participant and synchronizer, 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>`_, enriched with the package name and version.

+ + +
+ +
+
+ package_id + string + +
+ +
Package ID of this package. Always present.
+ +
+ +
+
+ valid_from_inclusive + Timestamp + +
+ +
The time from which this package is vetted. Empty if vetting time has no lower bound.
+ +
+ +
+
+ valid_until_exclusive + Timestamp + +
+ +
The time until which this package is vetted. Empty if vetting time has no upper bound.
+ +
+ +
+
+ package_name + string + +
+ +
Name of this package. Only available if the package has been uploaded to the current participant. If unavailable, is empty string.
+ +
+ +
+
+ package_version + string + +
+ +
Version of this package. Only available if the package has been uploaded to the current participant. If unavailable, is empty string.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.PackageReference

+ +

3 fields

+ +
+ + +
+ +
+
+ package_id + string + +
+ +
Required
+ +
+ +
+
+ package_name + string + +
+ +
Required
+ +
+ +
+
+ package_version + string + +
+ +
Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.PriorTopologySerial

+ +

2 fields

+ +
+ +

The serial of last ``VettedPackages`` topology transaction on a given participant and synchronizer.

+ + +
+ +
+
+ prior + uint32 + +
+ +
Previous transaction's serial.
+ +
+ +
+
+ no_prior + Empty + +
+ +
No previous transaction exists.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.ReassignmentCommand

+ +

2 fields

+ +
+ + +
+ +
+
+ unassign_command + UnassignCommand + +
+ +
+ +
+
+ assign_command + AssignCommand + +
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.UnassignCommand

+ +

3 fields

+ +
+ +

Unassign a contract

+ + +
+ +
+
+ contract_id + string + +
+ +
The ID of the contract the client wants to unassign. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ source + string + +
+ +
The ID of the source synchronizer Must be a valid synchronizer id Required
+ +
+ +
+
+ target + string + +
+ +
The ID of the target synchronizer Must be a valid synchronizer id Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.ReassignmentCommands

+ +

6 fields

+ +
+ + +
+ +
+
+ workflow_id + string + +
+ +
Identifier of the on-ledger workflow that this command is a part of. Must be a valid LedgerString (as described in ``value.proto``). Optional
+ +
+ +
+
+ user_id + string + +
+ +
Uniquely identifies the participant user that issued the command. Must be a valid UserIdString (as described in ``value.proto``). Required unless authentication is used with a user token. In that case, the token's user-id will be used for the request's user_id.
+ +
+ +
+
+ command_id + string + +
+ +
Uniquely identifies the command. The triple (user_id, submitter, command_id) constitutes the change ID for the intended ledger change. The change ID can be used for matching the intended ledger changes with all their completions. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ submitter + string + +
+ +
Party on whose behalf the command should be executed. If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request to act on behalf of the given party. Must be a valid PartyIdString (as described in ``value.proto``). Required
+ +
+ +
+
+ submission_id + string + +
+ +
A unique identifier to distinguish completions for different submissions with the same change ID. Typically a random UUID. Applications are expected to use a different UUID for each retry of a submission with the same change ID. Must be a valid LedgerString (as described in ``value.proto``). If omitted, the participant or the committer may set a value of their choice. Optional
+ +
+ +
+
+ commands + repeated ReassignmentCommand + +
+ +
Individual elements of this reassignment. Must be non-empty.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.Signature

+ +

4 fields

+ +
+ + +
+ +
+
+ format + SignatureFormat + +
+ +
+ +
+
+ signature + bytes + +
+ +
+ +
+
+ signed_by + string + +
+ +
The fingerprint/id of the keypair used to create this signature and needed to verify.
+ +
+ +
+
+ signing_algorithm_spec + SigningAlgorithmSpec + +
+ +
The signing algorithm specification used to produce this signature
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.SignatureFormat

+ +

5 values

+ +
+ + + +
    + +
  • SIGNATURE_FORMAT_UNSPECIFIED
    • + +
  • SIGNATURE_FORMAT_RAW
    • + +
  • SIGNATURE_FORMAT_DER
    • + +
  • SIGNATURE_FORMAT_CONCAT
    • + +
  • SIGNATURE_FORMAT_SYMBOLIC
    • + +
+ + +
+ +
+
+

com.daml.ledger.api.v2.SigningAlgorithmSpec

+ +

4 values

+ +
+ + + +
    + +
  • SIGNING_ALGORITHM_SPEC_UNSPECIFIED
    • + +
  • SIGNING_ALGORITHM_SPEC_ED25519
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_256
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_384
    • + +
+ + +
+ +
+
+

com.daml.ledger.api.v2.SigningPublicKey

+ +

3 fields

+ +
+ + +
+ +
+
+ format + CryptoKeyFormat + +
+ +
The serialization format of the public key
+ +
+ +
+
+ key_data + bytes + +
+ +
Serialized public key in the format specified above
+ +
+ +
+
+ key_spec + SigningKeySpec + +
+ +
The key specification
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.CryptoKeyFormat

+ +

4 values

+ +
+ +

Serialization format for crypto keys and signatures

+ + + +
    + +
  • CRYPTO_KEY_FORMAT_UNSPECIFIED
    • + +
  • CRYPTO_KEY_FORMAT_DER
    • + +
  • CRYPTO_KEY_FORMAT_RAW
    • + +
  • CRYPTO_KEY_FORMAT_DER_X509_SUBJECT_PUBLIC_KEY_INFO
    • + +
+ + +
+ +
+
+

com.daml.ledger.api.v2.SigningKeySpec

+ +

5 values

+ +
+ +

Note: these crypto data types are a subset of the ones used internally by Canton. They have been forked from the respective com.digitalasset.canton.crypto.v30 package.

+ + + +
    + +
  • SIGNING_KEY_SPEC_UNSPECIFIED
    • + +
  • SIGNING_KEY_SPEC_EC_CURVE25519
    • + +
  • SIGNING_KEY_SPEC_EC_P256
    • + +
  • SIGNING_KEY_SPEC_EC_P384
    • + +
  • SIGNING_KEY_SPEC_EC_SECP256K1
    • + +
+ + +
+ +
+
+

com.daml.ledger.api.v2.SubmitAndWaitForReassignmentRequest

+ +

2 fields

+ +
+ +

This reassignment is executed as a single atomic update.

+ + +
+ +
+
+ reassignment_commands + ReassignmentCommands + +
+ +
The reassignment commands to be submitted. Required
+ +
+ +
+
+ event_format + EventFormat + +
+ +
Optional If no event_format provided, the result will contain no events. The events in the result, will take shape TRANSACTION_SHAPE_ACS_DELTA.
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.SubmitAndWaitForReassignmentResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ reassignment + Reassignment + +
+ +
The reassignment that resulted from the submitted reassignment command. The reassignment might contain no events (request conditions result in filtering out all of them). Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.SubmitAndWaitForTransactionRequest

+ +

2 fields

+ +
+ +

These commands are executed as a single atomic transaction.

+ + +
+ +
+
+ commands + Commands + +
+ +
The commands to be submitted. Required
+ +
+ +
+
+ transaction_format + TransactionFormat + +
+ +
If no ``transaction_format`` is provided, a default will be used where ``transaction_shape`` is set to TRANSACTION_SHAPE_ACS_DELTA, ``event_format`` is defined with ``filters_by_party`` containing wildcard-template filter for all original ``act_as`` and ``read_as`` parties and the ``verbose`` flag is set. Optional
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.SubmitAndWaitForTransactionResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ transaction + Transaction + +
+ +
The transaction that resulted from the submitted command. The transaction might contain no events (request conditions result in filtering out all of them). Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.SubmitAndWaitRequest

+ +

1 fields

+ +
+ +

These commands are executed as a single atomic transaction.

+ + +
+ +
+
+ commands + Commands + +
+ +
The commands to be submitted. Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.SubmitAndWaitResponse

+ +

2 fields

+ +
+ + +
+ +
+
+ update_id + string + +
+ +
The id of the transaction that resulted from the submitted command. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ completion_offset + int64 + +
+ +
The details of the offset field are described in ``community/ledger-api/README.md``. Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.SubmitReassignmentRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ reassignment_commands + ReassignmentCommands + +
+ +
The reassignment command to be submitted. Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.SubmitReassignmentResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.daml.ledger.api.v2.SubmitRequest

+ +

1 fields

+ +
+ +

The submitted commands will be processed atomically in a single transaction. Moreover, each ``Command`` in ``commands`` will be executed in the order specified by the request.

+ + +
+ +
+
+ commands + Commands + +
+ +
The commands to be submitted in a single transaction. Required
+ +
+ +
+ + + +
+ +
+
+

com.daml.ledger.api.v2.SubmitResponse

+ +

0 fields

+ +
+ + + + +
diff --git a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-admin-crypto-v30.mdx b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-admin-crypto-v30.mdx index cde41e4..06c698c 100644 --- a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-admin-crypto-v30.mdx +++ b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-admin-crypto-v30.mdx @@ -1,50 +1,172 @@ --- title: "com.digitalasset.canton.admin.crypto.v30" -description: "Descriptor-backed protobuf API history for package com.digitalasset.canton.admin.crypto.v30." +description: "Package-level overview for com.digitalasset.canton.admin.crypto.v30." --- -# Package `com.digitalasset.canton.admin.crypto.v30` +

Back to overview

-[Back to Canton Protobuf History](../index) +
+ +

Protobuf Package

+ + +

com.digitalasset.canton.admin.crypto.v30

+ + +

0 services, 0 endpoints, 1 messages, 1 enums

+ + +
+ + gRPC + +
-## Snapshot + +
+ +
+
Files
+
1
+
+ +
+
Services
+
0
+
+ +
+
Endpoints
+
0
+
+ +
+
Messages
+
1
+
+ +
+
Enums
+
1
+
+ +
+ +
-- Current files: `1` -- Current services: `0` -- Current endpoints: `0` -- Current messages: `1` -- Current enums: `1` -- Lifecycle endpoints tracked: `0` ## Source Files -| File | Services | Messages | Enums | Source | -| --- | --- | --- | --- | --- | -| community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/crypto/v30/crypto.proto | `0` | `1` | `1` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/crypto/v30/crypto.proto#L4) | -## Type Reference - -**Message `com.digitalasset.canton.admin.crypto.v30.Salt`** -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/crypto/v30/crypto.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/crypto/v30/crypto.proto#L13) -- Fields: 2 +
+ + +
+ +
+

community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/crypto/v30/crypto.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
1
+
+ +
+
Enums
+
1
+
+ +
+
Source
+
community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/crypto/v30/crypto.proto
+
+ +
+ + +
+ + +
+ + + + + +## Type Inventory + + +These are the package-level message and enum shapes in the publish-version snapshot. -_No description._ -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| hmac | [`com.digitalasset.canton.admin.crypto.v30.HmacAlgorithm`](#type-com-digitalasset-canton-admin-crypto-v30-hmacalgorithm) | optional | | -| salt | `bytes` | optional | | - -**Enum `com.digitalasset.canton.admin.crypto.v30.HmacAlgorithm`** -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/crypto/v30/crypto.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/crypto/v30/crypto.proto#L8) +
+
+

com.digitalasset.canton.admin.crypto.v30.Salt

+ +

2 fields

+ +
+ + +
+ +
+
+ hmac + HmacAlgorithm + +
+ +
+ +
+
+ salt + bytes + +
+ +
+ +
-_No description._ + + +
-| Name | Number | -| --- | --- | -| HMAC_ALGORITHM_UNSPECIFIED | `0` | -| HMAC_ALGORITHM_HMAC_SHA256 | `1` | +
+
+

com.digitalasset.canton.admin.crypto.v30.HmacAlgorithm

+ +

2 values

+ +
+ + + +
    + +
  • HMAC_ALGORITHM_UNSPECIFIED
    • + +
  • HMAC_ALGORITHM_HMAC_SHA256
    • + +
+ + +
diff --git a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-admin-health-v30.mdx b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-admin-health-v30.mdx index 264162a..be36917 100644 --- a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-admin-health-v30.mdx +++ b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-admin-health-v30.mdx @@ -1,359 +1,846 @@ --- title: "com.digitalasset.canton.admin.health.v30" -description: "Descriptor-backed protobuf API history for package com.digitalasset.canton.admin.health.v30." +description: "Package-level overview for com.digitalasset.canton.admin.health.v30." --- -# Package `com.digitalasset.canton.admin.health.v30` +

Back to overview

+ +
+ +

Protobuf Package

+ + +

com.digitalasset.canton.admin.health.v30

+ + +

1 services, 4 endpoints, 14 messages, 1 enums

+ + +
+ + gRPC + +
+ + +
+ +
+
Files
+
1
+
+ +
+
Services
+
1
+
+ +
+
Endpoints
+
4
+
+ +
+
Messages
+
14
+
+ +
+
Enums
+
1
+
+ +
+ +
-[Back to Canton Protobuf History](../index) - -## Snapshot - -- Current files: `1` -- Current services: `1` -- Current endpoints: `4` -- Current messages: `14` -- Current enums: `1` -- Lifecycle endpoints tracked: `4` ## Source Files -| File | Services | Messages | Enums | Source | -| --- | --- | --- | --- | --- | -| community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto | `1` | `12` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto#L4) | - -## Services - -| Service | Endpoints | Source | Description | -| --- | --- | --- | --- | -| [`StatusService`](#service-com-digitalasset-canton-admin-health-v30-statusservice) | `4` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto#L10) | | - - -### Service `StatusService` - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto#L10) -- Endpoints tracked: `4` - -_No description._ - -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`GetLastErrorTrace`](#endpoint-com-digitalasset-canton-admin-health-v30-statusservice-getlasterrortrace) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.health.v30.GetLastErrorTraceRequest`](#type-com-digitalasset-canton-admin-health-v30-getlasterrortracerequest) | [`com.digitalasset.canton.admin.health.v30.GetLastErrorTraceResponse`](#type-com-digitalasset-canton-admin-health-v30-getlasterrortraceresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto#L19) | -| [`GetLastErrors`](#endpoint-com-digitalasset-canton-admin-health-v30-statusservice-getlasterrors) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.health.v30.GetLastErrorsRequest`](#type-com-digitalasset-canton-admin-health-v30-getlasterrorsrequest) | [`com.digitalasset.canton.admin.health.v30.GetLastErrorsResponse`](#type-com-digitalasset-canton-admin-health-v30-getlasterrorsresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto#L17) | -| [`HealthDump`](#endpoint-com-digitalasset-canton-admin-health-v30-statusservice-healthdump) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.health.v30.HealthDumpRequest`](#type-com-digitalasset-canton-admin-health-v30-healthdumprequest) | [`com.digitalasset.canton.admin.health.v30.HealthDumpResponse`](#type-com-digitalasset-canton-admin-health-v30-healthdumpresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto#L12) | -| [`SetLogLevel`](#endpoint-com-digitalasset-canton-admin-health-v30-statusservice-setloglevel) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.health.v30.SetLogLevelRequest`](#type-com-digitalasset-canton-admin-health-v30-setloglevelrequest) | [`com.digitalasset.canton.admin.health.v30.SetLogLevelResponse`](#type-com-digitalasset-canton-admin-health-v30-setloglevelresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto#L14) | - - -**Endpoint `StatusService.GetLastErrorTrace`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto#L19) - -**Signature** - -```protobuf -rpc StatusService.GetLastErrorTrace(com.digitalasset.canton.admin.health.v30.GetLastErrorTraceRequest) returns (com.digitalasset.canton.admin.health.v30.GetLastErrorTraceResponse); -``` - -Get the trace of the last errors observed - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.health.v30.GetLastErrorTraceRequest`](#type-com-digitalasset-canton-admin-health-v30-getlasterrortracerequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.health.v30.GetLastErrorTraceResponse`](#type-com-digitalasset-canton-admin-health-v30-getlasterrortraceresponse) - - -**Endpoint `StatusService.GetLastErrors`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto#L17) - -**Signature** - -```protobuf -rpc StatusService.GetLastErrors(com.digitalasset.canton.admin.health.v30.GetLastErrorsRequest) returns (com.digitalasset.canton.admin.health.v30.GetLastErrorsResponse); -``` - -Get the last errors observed on this node - This is a built in functionality where we keep track of the last errors and all messages that were logged with the same trace id within a certain time frame - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.health.v30.GetLastErrorsRequest`](#type-com-digitalasset-canton-admin-health-v30-getlasterrorsrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.health.v30.GetLastErrorsResponse`](#type-com-digitalasset-canton-admin-health-v30-getlasterrorsresponse) - - -**Endpoint `StatusService.HealthDump`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto#L12) - -**Signature** - -```protobuf -rpc StatusService.HealthDump(com.digitalasset.canton.admin.health.v30.HealthDumpRequest) returns (stream com.digitalasset.canton.admin.health.v30.HealthDumpResponse); -``` - -Streams back a zip file as byte chunks, containing a health dump of the full canton process (including other nodes) - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.health.v30.HealthDumpRequest`](#type-com-digitalasset-canton-admin-health-v30-healthdumprequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.health.v30.HealthDumpResponse`](#type-com-digitalasset-canton-admin-health-v30-healthdumpresponse) - - -**Endpoint `StatusService.SetLogLevel`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto#L14) - -**Signature** - -```protobuf -rpc StatusService.SetLogLevel(com.digitalasset.canton.admin.health.v30.SetLogLevelRequest) returns (com.digitalasset.canton.admin.health.v30.SetLogLevelResponse); -``` - -Toggle log levels - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.health.v30.SetLogLevelRequest`](#type-com-digitalasset-canton-admin-health-v30-setloglevelrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.health.v30.SetLogLevelResponse`](#type-com-digitalasset-canton-admin-health-v30-setloglevelresponse) - -## Type Reference - - -**Message `com.digitalasset.canton.admin.health.v30.ComponentStatus`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto#L31) -- Fields: 5 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| name | `string` | optional | | -| ok | [`com.digitalasset.canton.admin.health.v30.ComponentStatus.StatusData`](#type-com-digitalasset-canton-admin-health-v30-componentstatus-statusdata) | optional | | -| degraded | [`com.digitalasset.canton.admin.health.v30.ComponentStatus.StatusData`](#type-com-digitalasset-canton-admin-health-v30-componentstatus-statusdata) | optional | | -| failed | [`com.digitalasset.canton.admin.health.v30.ComponentStatus.StatusData`](#type-com-digitalasset-canton-admin-health-v30-componentstatus-statusdata) | optional | | -| fatal | [`com.digitalasset.canton.admin.health.v30.ComponentStatus.StatusData`](#type-com-digitalasset-canton-admin-health-v30-componentstatus-statusdata) | optional | | - - -**Message `com.digitalasset.canton.admin.health.v30.ComponentStatus.StatusData`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto#L39) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| description | `string` | optional | | - - -**Message `com.digitalasset.canton.admin.health.v30.GetLastErrorTraceRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto#L94) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| trace_id | `string` | optional | The trace id of the error | - - -**Message `com.digitalasset.canton.admin.health.v30.GetLastErrorTraceResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto#L98) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| messages | `string` | repeated | | - - -**Message `com.digitalasset.canton.admin.health.v30.GetLastErrorsRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto#L85) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.health.v30.GetLastErrorsResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto#L86) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| errors | [`com.digitalasset.canton.admin.health.v30.GetLastErrorsResponse.Error`](#type-com-digitalasset-canton-admin-health-v30-getlasterrorsresponse-error) | repeated | | - - -**Message `com.digitalasset.canton.admin.health.v30.GetLastErrorsResponse.Error`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto#L87) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| trace_id | `string` | optional | | -| message | `string` | optional | | - - -**Message `com.digitalasset.canton.admin.health.v30.HealthDumpRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto#L66) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| chunk_size | `uint32` | optional | Size of the byte chunks to stream back.
Defaults to 2MB (half of the default gRPC max message size) | - - -**Message `com.digitalasset.canton.admin.health.v30.HealthDumpResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto#L72) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| chunk | `bytes` | optional | A chunk of of the health dump file | - - -**Message `com.digitalasset.canton.admin.health.v30.NotInitialized`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto#L44) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| active | `bool` | optional | Indicate if the node is active, usually true unless it's a replicated node that is passive | -| waiting_for_external_input | [`com.digitalasset.canton.admin.health.v30.NotInitialized.WaitingForExternalInput`](#type-com-digitalasset-canton-admin-health-v30-notinitialized-waitingforexternalinput) | optional | Indicates whether the node is waiting for external input | - - -**Enum `com.digitalasset.canton.admin.health.v30.NotInitialized.WaitingForExternalInput`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto#L45) - -_No description._ - -| Name | Number | -| --- | --- | -| WAITING_FOR_EXTERNAL_INPUT_UNSPECIFIED | `0` | -| WAITING_FOR_EXTERNAL_INPUT_ID | `1` | -| WAITING_FOR_EXTERNAL_INPUT_NODE_TOPOLOGY | `2` | -| WAITING_FOR_EXTERNAL_INPUT_INITIALIZATION | `3` | - - -**Message `com.digitalasset.canton.admin.health.v30.SetLogLevelRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto#L76) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| level | `string` | optional | TODO(#18445) use an enum for the log level as right now, it also accepts OFF and null
The log level to set (DEBUG, INFO, WARN, ERROR, OFF) | - - -**Message `com.digitalasset.canton.admin.health.v30.SetLogLevelResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto#L83) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.health.v30.Status`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto#L56) -- Fields: 7 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| uid | `string` | optional | | -| uptime | `google.protobuf.Duration` | optional | | -| ports | `map` | repeated | | -| active | `bool` | optional | Indicate if the node is active, usually true unless it's a replicated node that is passive | -| topology_queues | [`com.digitalasset.canton.admin.health.v30.TopologyQueueStatus`](#type-com-digitalasset-canton-admin-health-v30-topologyqueuestatus) | optional | indicates the state of the topology queues (manager / dispatcher only where they exist) | -| components | [`com.digitalasset.canton.admin.health.v30.ComponentStatus`](#type-com-digitalasset-canton-admin-health-v30-componentstatus) | repeated | Health state of component dependencies of the node | -| version | `string` | optional | Version of the binary | - - -**Message `com.digitalasset.canton.admin.health.v30.TopologyQueueStatus`** -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto#L22) -- Fields: 3 -_No description._ -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| manager | `uint32` | optional | how many topology changes are currently queued at the manager | -| dispatcher | `uint32` | optional | how many topology changes are currently queued at the dispatcher | -| clients | `uint32` | optional | how many topology changes are currently waiting to become effective (across all connected synchronizers in the case of participants) | +
+ + +
+ +
+

community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
12
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto
+
+ +
+ + +
+ + +
+ + + + + +## StatusService + + + +
+ +
+
Source file
+
community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto
+
+ +
+
Operations
+
4
+
+ +
+ + +
+ + + + +
+

StatusService.GetLastErrorTrace

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Get the trace of the last errors observed

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.health.v30.GetLastErrorTraceRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.health.v30.GetLastErrorTraceResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

StatusService.GetLastErrors

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Get the last errors observed on this node This is a built in functionality where we keep track of the last errors and all messages that were logged with the same trace id within...

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.health.v30.GetLastErrorsRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.health.v30.GetLastErrorsResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

StatusService.HealthDump

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Streams back a zip file as byte chunks, containing a health dump of the full canton process (including other nodes)

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.health.v30.HealthDumpRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.health.v30.HealthDumpResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + + + + + +
+

StatusService.SetLogLevel

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Toggle log levels

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.health.v30.SetLogLevelRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.health.v30.SetLogLevelResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## Type Inventory + + +These are the package-level message and enum shapes in the publish-version snapshot. + + + + +
+
+

com.digitalasset.canton.admin.health.v30.ComponentStatus

+ +

5 fields

+ +
+ + +
+ +
+
+ name + string + +
+ +
+ +
+
+ ok + StatusData + +
+ +
+ +
+
+ degraded + StatusData + +
+ +
+ +
+
+ failed + StatusData + +
+ +
+ +
+
+ fatal + StatusData + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.health.v30.ComponentStatus.StatusData

+ +

1 fields

+ +
+ + +
+ +
+
+ description + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.health.v30.GetLastErrorTraceRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ trace_id + string + +
+ +
The trace id of the error
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.health.v30.GetLastErrorTraceResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ messages + repeated string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.health.v30.GetLastErrorsRequest

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.admin.health.v30.GetLastErrorsResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ errors + repeated Error + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.health.v30.GetLastErrorsResponse.Error

+ +

2 fields

+ +
+ + +
+ +
+
+ trace_id + string + +
+ +
+ +
+
+ message + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.health.v30.HealthDumpRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ chunk_size + uint32 + +
+ +
Size of the byte chunks to stream back. Defaults to 2MB (half of the default gRPC max message size)
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.health.v30.HealthDumpResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ chunk + bytes + +
+ +
A chunk of of the health dump file
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.health.v30.NotInitialized

+ +

2 fields

+ +
+ + +
+ +
+
+ active + bool + +
+ +
Indicate if the node is active, usually true unless it's a replicated node that is passive
+ +
+ +
+
+ waiting_for_external_input + WaitingForExternalInput + +
+ +
Indicates whether the node is waiting for external input
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.health.v30.NotInitialized.WaitingForExternalInput

+ +

4 values

+ +
+ + + +
    + +
  • WAITING_FOR_EXTERNAL_INPUT_UNSPECIFIED
    • + +
  • WAITING_FOR_EXTERNAL_INPUT_ID
    • + +
  • WAITING_FOR_EXTERNAL_INPUT_NODE_TOPOLOGY
    • + +
  • WAITING_FOR_EXTERNAL_INPUT_INITIALIZATION
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.admin.health.v30.SetLogLevelRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ level + string + +
+ +
TODO(#18445) use an enum for the log level as right now, it also accepts OFF and null The log level to set (DEBUG, INFO, WARN, ERROR, OFF)
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.health.v30.SetLogLevelResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.admin.health.v30.Status

+ +

7 fields

+ +
+ + +
+ +
+
+ uid + string + +
+ +
+ +
+
+ uptime + Duration + +
+ +
+ +
+
+ ports + repeated map + +
+ +
+ +
+
+ active + bool + +
+ +
Indicate if the node is active, usually true unless it's a replicated node that is passive
+ +
+ +
+
+ topology_queues + TopologyQueueStatus + +
+ +
indicates the state of the topology queues (manager / dispatcher only where they exist)
+ +
+ +
+
+ components + repeated ComponentStatus + +
+ +
Health state of component dependencies of the node
+ +
+ +
+
+ version + string + +
+ +
Version of the binary
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.health.v30.TopologyQueueStatus

+ +

3 fields

+ +
+ + +
+ +
+
+ manager + uint32 + +
+ +
how many topology changes are currently queued at the manager
+ +
+ +
+
+ dispatcher + uint32 + +
+ +
how many topology changes are currently queued at the dispatcher
+ +
+ +
+
+ clients + uint32 + +
+ +
how many topology changes are currently waiting to become effective (across all connected synchronizers in the case of participants)
+ +
+ +
+ + + +
diff --git a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-admin-mediator-v30.mdx b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-admin-mediator-v30.mdx index b82df6d..4b21f67 100644 --- a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-admin-mediator-v30.mdx +++ b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-admin-mediator-v30.mdx @@ -1,109 +1,572 @@ --- title: "com.digitalasset.canton.admin.mediator.v30" -description: "Descriptor-backed protobuf API history for package com.digitalasset.canton.admin.mediator.v30." +description: "Package-level overview for com.digitalasset.canton.admin.mediator.v30." --- -# Package `com.digitalasset.canton.admin.mediator.v30` +

Back to overview

+ +
+ +

Protobuf Package

+ + +

com.digitalasset.canton.admin.mediator.v30

+ + +

1 services, 1 endpoints, 3 messages

+ + +
+ + gRPC + +
+ + +
+ +
+
Files
+
1
+
+ +
+
Services
+
1
+
+ +
+
Endpoints
+
1
+
+ +
+
Messages
+
3
+
+ +
+
Enums
+
0
+
+ +
+ +
-[Back to Canton Protobuf History](../index) - -## Snapshot - -- Current files: `1` -- Current services: `1` -- Current endpoints: `1` -- Current messages: `3` -- Current enums: `0` -- Lifecycle endpoints tracked: `1` ## Source Files -| File | Services | Messages | Enums | Source | -| --- | --- | --- | --- | --- | -| community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/mediator/v30/mediator_status_service.proto | `1` | `2` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/mediator/v30/mediator_status_service.proto#L4) | - -## Services - -| Service | Endpoints | Source | Description | -| --- | --- | --- | --- | -| [`MediatorStatusService`](#service-com-digitalasset-canton-admin-mediator-v30-mediatorstatusservice) | `1` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/mediator/v30/mediator_status_service.proto#L10) | | - - -### Service `MediatorStatusService` - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/mediator/v30/mediator_status_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/mediator/v30/mediator_status_service.proto#L10) -- Endpoints tracked: `1` - -_No description._ - -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`MediatorStatus`](#endpoint-com-digitalasset-canton-admin-mediator-v30-mediatorstatusservice-mediatorstatus) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.mediator.v30.MediatorStatusRequest`](#type-com-digitalasset-canton-admin-mediator-v30-mediatorstatusrequest) | [`com.digitalasset.canton.admin.mediator.v30.MediatorStatusResponse`](#type-com-digitalasset-canton-admin-mediator-v30-mediatorstatusresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/mediator/v30/mediator_status_service.proto#L11) | - - -**Endpoint `MediatorStatusService.MediatorStatus`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/mediator/v30/mediator_status_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/mediator/v30/mediator_status_service.proto#L11) - -**Signature** - -```protobuf -rpc MediatorStatusService.MediatorStatus(com.digitalasset.canton.admin.mediator.v30.MediatorStatusRequest) returns (com.digitalasset.canton.admin.mediator.v30.MediatorStatusResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.mediator.v30.MediatorStatusRequest`](#type-com-digitalasset-canton-admin-mediator-v30-mediatorstatusrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.mediator.v30.MediatorStatusResponse`](#type-com-digitalasset-canton-admin-mediator-v30-mediatorstatusresponse) - -## Type Reference - - -**Message `com.digitalasset.canton.admin.mediator.v30.MediatorStatusRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/mediator/v30/mediator_status_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/mediator/v30/mediator_status_service.proto#L14) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.mediator.v30.MediatorStatusResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/mediator/v30/mediator_status_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/mediator/v30/mediator_status_service.proto#L16) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| status | [`com.digitalasset.canton.admin.mediator.v30.MediatorStatusResponse.MediatorStatusResponseStatus`](#type-com-digitalasset-canton-admin-mediator-v30-mediatorstatusresponse-mediatorstatusresponsestatus) | optional | | -| not_initialized | [`com.digitalasset.canton.admin.health.v30.NotInitialized`](com-digitalasset-canton-admin-health-v30#type-com-digitalasset-canton-admin-health-v30-notinitialized) | optional | | - - -**Message `com.digitalasset.canton.admin.mediator.v30.MediatorStatusResponse.MediatorStatusResponseStatus`** -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/mediator/v30/mediator_status_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/mediator/v30/mediator_status_service.proto#L22) -- Fields: 3 -_No description._ -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| common_status | [`com.digitalasset.canton.admin.health.v30.Status`](com-digitalasset-canton-admin-health-v30#type-com-digitalasset-canton-admin-health-v30-status) | optional | | -| physical_synchronizer_id | `string` | optional | | -| protocol_version | `int32` | optional | | +
+ + +
+ +
+

community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/mediator/v30/mediator_status_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
2
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/mediator/v30/mediator_status_service.proto
+
+ +
+ + +
+ + +
+ + + + + +## MediatorStatusService + + + +
+ +
+
Source file
+
community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/mediator/v30/mediator_status_service.proto
+
+ +
+
Operations
+
1
+
+ +
+ + +
+ + + + +
+

MediatorStatusService.MediatorStatus

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc MediatorStatusService.MediatorStatus(com.digitalasset.canton.admin.mediator.v30.MediatorStatusRequest) returns (com.digitalasset.canton.admin.mediator.v30.MediatorStatusResp...

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.mediator.v30.MediatorStatusRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.mediator.v30.MediatorStatusResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## Type Inventory + + +These are the package-level message and enum shapes in the publish-version snapshot. + + + + +
+
+

com.digitalasset.canton.admin.mediator.v30.MediatorStatusRequest

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.admin.mediator.v30.MediatorStatusResponse

+ +

2 fields

+ +
+ + +
+ +
+
+ status + MediatorStatusResponseStatus + +
+ +
+ +
+
+ not_initialized + NotInitialized + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.mediator.v30.MediatorStatusResponse.MediatorStatusResponseStatus

+ +

3 fields

+ +
+ + +
+ +
+
+ common_status + Status + +
+ +
+ +
+
+ physical_synchronizer_id + string + +
+ +
+ +
+
+ protocol_version + int32 + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.health.v30.Status

+ +

7 fields

+ +
+ + +
+ +
+
+ uid + string + +
+ +
+ +
+
+ uptime + Duration + +
+ +
+ +
+
+ ports + repeated map + +
+ +
+ +
+
+ active + bool + +
+ +
Indicate if the node is active, usually true unless it's a replicated node that is passive
+ +
+ +
+
+ topology_queues + TopologyQueueStatus + +
+ +
indicates the state of the topology queues (manager / dispatcher only where they exist)
+ +
+ +
+
+ components + repeated ComponentStatus + +
+ +
Health state of component dependencies of the node
+ +
+ +
+
+ version + string + +
+ +
Version of the binary
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.health.v30.TopologyQueueStatus

+ +

3 fields

+ +
+ + +
+ +
+
+ manager + uint32 + +
+ +
how many topology changes are currently queued at the manager
+ +
+ +
+
+ dispatcher + uint32 + +
+ +
how many topology changes are currently queued at the dispatcher
+ +
+ +
+
+ clients + uint32 + +
+ +
how many topology changes are currently waiting to become effective (across all connected synchronizers in the case of participants)
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.health.v30.ComponentStatus

+ +

5 fields

+ +
+ + +
+ +
+
+ name + string + +
+ +
+ +
+
+ ok + StatusData + +
+ +
+ +
+
+ degraded + StatusData + +
+ +
+ +
+
+ failed + StatusData + +
+ +
+ +
+
+ fatal + StatusData + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.health.v30.ComponentStatus.StatusData

+ +

1 fields

+ +
+ + +
+ +
+
+ description + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.health.v30.NotInitialized

+ +

2 fields

+ +
+ + +
+ +
+
+ active + bool + +
+ +
Indicate if the node is active, usually true unless it's a replicated node that is passive
+ +
+ +
+
+ waiting_for_external_input + WaitingForExternalInput + +
+ +
Indicates whether the node is waiting for external input
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.health.v30.NotInitialized.WaitingForExternalInput

+ +

4 values

+ +
+ + + +
    + +
  • WAITING_FOR_EXTERNAL_INPUT_UNSPECIFIED
    • + +
  • WAITING_FOR_EXTERNAL_INPUT_ID
    • + +
  • WAITING_FOR_EXTERNAL_INPUT_NODE_TOPOLOGY
    • + +
  • WAITING_FOR_EXTERNAL_INPUT_INITIALIZATION
    • + +
+ + +
diff --git a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-admin-participant-v30.mdx b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-admin-participant-v30.mdx index 5750c38..d86ee4b 100644 --- a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-admin-participant-v30.mdx +++ b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-admin-participant-v30.mdx @@ -1,503 +1,1286 @@ --- title: "com.digitalasset.canton.admin.participant.v30" -description: "Descriptor-backed protobuf API history for package com.digitalasset.canton.admin.participant.v30." +description: "Package-level overview for com.digitalasset.canton.admin.participant.v30." --- -# Package `com.digitalasset.canton.admin.participant.v30` +

Back to overview

+ +
+ +

Protobuf Package

+ + +

com.digitalasset.canton.admin.participant.v30

+ + +

11 services, 69 endpoints, 169 messages, 7 enums

+ + +
+ + gRPC + +
+ + +
+ +
+
Files
+
14
+
+ +
+
Services
+
11
+
+ +
+
Endpoints
+
69
+
+ +
+
Messages
+
169
+
+ +
+
Enums
+
7
+
+ +
+ +
-[Back to Canton Protobuf History](../index) - -## Snapshot - -- Current files: `14` -- Current services: `11` -- Current endpoints: `69` -- Current messages: `169` -- Current enums: `7` -- Lifecycle endpoints tracked: `69` ## Source Files -| File | Services | Messages | Enums | Source | -| --- | --- | --- | --- | --- | -| community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/acs_import.proto | `0` | `1` | `1` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/acs_import.proto#L4) | -| community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/active_contract.proto | `0` | `3` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/active_contract.proto#L4) | -| community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/enterprise_participant_replication_service.proto | `1` | `2` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/enterprise_participant_replication_service.proto#L4) | -| community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto | `1` | `27` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L4) | -| community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto | `1` | `30` | `2` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L4) | -| community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto | `1` | `26` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L4) | -| community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_status_service.proto | `1` | `3` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_status_service.proto#L4) | -| community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto | `1` | `12` | `1` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto#L4) | -| community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/ping_pong_service.proto | `1` | `4` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/ping_pong_service.proto#L4) | -| community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto | `1` | `4` | `1` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto#L4) | -| community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/reassignment_id.proto | `0` | `1` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/reassignment_id.proto#L4) | -| community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/resource_management_service.proto | `1` | `5` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/resource_management_service.proto#L4) | -| community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto | `1` | `23` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L4) | -| community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/traffic_control_service.proto | `1` | `3` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/traffic_control_service.proto#L4) | - -## Services - -| Service | Endpoints | Source | Description | -| --- | --- | --- | --- | -| [`EnterpriseParticipantReplicationService`](#service-com-digitalasset-canton-admin-participant-v30-enterpriseparticipantreplicationservice) | `1` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/enterprise_participant_replication_service.proto#L8) | | -| [`PackageService`](#service-com-digitalasset-canton-admin-participant-v30-packageservice) | `12` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L11) | | -| [`ParticipantInspectionService`](#service-com-digitalasset-canton-admin-participant-v30-participantinspectionservice) | `9` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L19) | * Inspection Service Supports inspecting the Participant for details about its ledger. This contains only a subset of... | -| [`ParticipantRepairService`](#service-com-digitalasset-canton-admin-participant-v30-participantrepairservice) | `12` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L20) | * Perform participant repair operations, including exporting and importing ACS, purging contracts, and migrating sync... | -| [`ParticipantStatusService`](#service-com-digitalasset-canton-admin-participant-v30-participantstatusservice) | `1` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_status_service.proto#L10) | | -| [`PartyManagementService`](#service-com-digitalasset-canton-admin-participant-v30-partymanagementservice) | `6` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto#L21) | * The PartyManagementService allows modifying party hosting on participants. Note that ACS refers to Active Contract... | -| [`PingService`](#service-com-digitalasset-canton-admin-participant-v30-pingservice) | `1` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/ping_pong_service.proto#L10) | | -| [`PruningService`](#service-com-digitalasset-canton-admin-participant-v30-pruningservice) | `13` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto#L11) | | -| [`ResourceManagementService`](#service-com-digitalasset-canton-admin-participant-v30-resourcemanagementservice) | `2` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/resource_management_service.proto#L8) | | -| [`SynchronizerConnectivityService`](#service-com-digitalasset-canton-admin-participant-v30-synchronizerconnectivityservice) | `11` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L18) | * Synchronizer connectivity service for adding and connecting to synchronizers The synchronizer connectivity service... | -| [`TrafficControlService`](#service-com-digitalasset-canton-admin-participant-v30-trafficcontrolservice) | `1` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/traffic_control_service.proto#L11) | Service to retrieve information about the traffic state of the participant. | - - -### Service `EnterpriseParticipantReplicationService` - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/enterprise_participant_replication_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/enterprise_participant_replication_service.proto#L8) -- Endpoints tracked: `1` - -_No description._ - -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`SetPassive`](#endpoint-com-digitalasset-canton-admin-participant-v30-enterpriseparticipantreplicationservice-setpassive) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.SetPassiveRequest`](#type-com-digitalasset-canton-admin-participant-v30-setpassiverequest) | [`com.digitalasset.canton.admin.participant.v30.SetPassiveResponse`](#type-com-digitalasset-canton-admin-participant-v30-setpassiveresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/enterprise_participant_replication_service.proto#L9) | - - -**Endpoint `EnterpriseParticipantReplicationService.SetPassive`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/enterprise_participant_replication_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/enterprise_participant_replication_service.proto#L9) - -**Signature** - -```protobuf -rpc EnterpriseParticipantReplicationService.SetPassive(com.digitalasset.canton.admin.participant.v30.SetPassiveRequest) returns (com.digitalasset.canton.admin.participant.v30.SetPassiveResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.SetPassiveRequest`](#type-com-digitalasset-canton-admin-participant-v30-setpassiverequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.SetPassiveResponse`](#type-com-digitalasset-canton-admin-participant-v30-setpassiveresponse) - - -### Service `PackageService` - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L11) -- Endpoints tracked: `12` - -_No description._ - -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`GetDar`](#endpoint-com-digitalasset-canton-admin-participant-v30-packageservice-getdar) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.GetDarRequest`](#type-com-digitalasset-canton-admin-participant-v30-getdarrequest) | [`com.digitalasset.canton.admin.participant.v30.GetDarResponse`](#type-com-digitalasset-canton-admin-participant-v30-getdarresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L36) | -| [`GetDarContents`](#endpoint-com-digitalasset-canton-admin-participant-v30-packageservice-getdarcontents) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.GetDarContentsRequest`](#type-com-digitalasset-canton-admin-participant-v30-getdarcontentsrequest) | [`com.digitalasset.canton.admin.participant.v30.GetDarContentsResponse`](#type-com-digitalasset-canton-admin-participant-v30-getdarcontentsresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L42) | -| [`GetPackageContents`](#endpoint-com-digitalasset-canton-admin-participant-v30-packageservice-getpackagecontents) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.GetPackageContentsRequest`](#type-com-digitalasset-canton-admin-participant-v30-getpackagecontentsrequest) | [`com.digitalasset.canton.admin.participant.v30.GetPackageContentsResponse`](#type-com-digitalasset-canton-admin-participant-v30-getpackagecontentsresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L16) | -| [`GetPackageReferences`](#endpoint-com-digitalasset-canton-admin-participant-v30-packageservice-getpackagereferences) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.GetPackageReferencesRequest`](#type-com-digitalasset-canton-admin-participant-v30-getpackagereferencesrequest) | [`com.digitalasset.canton.admin.participant.v30.GetPackageReferencesResponse`](#type-com-digitalasset-canton-admin-participant-v30-getpackagereferencesresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L19) | -| [`ListDars`](#endpoint-com-digitalasset-canton-admin-participant-v30-packageservice-listdars) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.ListDarsRequest`](#type-com-digitalasset-canton-admin-participant-v30-listdarsrequest) | [`com.digitalasset.canton.admin.participant.v30.ListDarsResponse`](#type-com-digitalasset-canton-admin-participant-v30-listdarsresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L39) | -| [`ListPackages`](#endpoint-com-digitalasset-canton-admin-participant-v30-packageservice-listpackages) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.ListPackagesRequest`](#type-com-digitalasset-canton-admin-participant-v30-listpackagesrequest) | [`com.digitalasset.canton.admin.participant.v30.ListPackagesResponse`](#type-com-digitalasset-canton-admin-participant-v30-listpackagesresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L13) | -| [`RemoveDar`](#endpoint-com-digitalasset-canton-admin-participant-v30-packageservice-removedar) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.RemoveDarRequest`](#type-com-digitalasset-canton-admin-participant-v30-removedarrequest) | [`com.digitalasset.canton.admin.participant.v30.RemoveDarResponse`](#type-com-digitalasset-canton-admin-participant-v30-removedarresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L33) | -| [`RemovePackage`](#endpoint-com-digitalasset-canton-admin-participant-v30-packageservice-removepackage) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.RemovePackageRequest`](#type-com-digitalasset-canton-admin-participant-v30-removepackagerequest) | [`com.digitalasset.canton.admin.participant.v30.RemovePackageResponse`](#type-com-digitalasset-canton-admin-participant-v30-removepackageresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L23) | -| [`UnvetDar`](#endpoint-com-digitalasset-canton-admin-participant-v30-packageservice-unvetdar) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.UnvetDarRequest`](#type-com-digitalasset-canton-admin-participant-v30-unvetdarrequest) | [`com.digitalasset.canton.admin.participant.v30.UnvetDarResponse`](#type-com-digitalasset-canton-admin-participant-v30-unvetdarresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L50) | -| [`UploadDar`](#endpoint-com-digitalasset-canton-admin-participant-v30-packageservice-uploaddar) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.UploadDarRequest`](#type-com-digitalasset-canton-admin-participant-v30-uploaddarrequest) | [`com.digitalasset.canton.admin.participant.v30.UploadDarResponse`](#type-com-digitalasset-canton-admin-participant-v30-uploaddarresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L29) | -| [`ValidateDar`](#endpoint-com-digitalasset-canton-admin-participant-v30-packageservice-validatedar) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.ValidateDarRequest`](#type-com-digitalasset-canton-admin-participant-v30-validatedarrequest) | [`com.digitalasset.canton.admin.participant.v30.ValidateDarResponse`](#type-com-digitalasset-canton-admin-participant-v30-validatedarresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L26) | -| [`VetDar`](#endpoint-com-digitalasset-canton-admin-participant-v30-packageservice-vetdar) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.VetDarRequest`](#type-com-digitalasset-canton-admin-participant-v30-vetdarrequest) | [`com.digitalasset.canton.admin.participant.v30.VetDarResponse`](#type-com-digitalasset-canton-admin-participant-v30-vetdarresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L45) | - - -**Endpoint `PackageService.GetDar`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L36) - -**Signature** - -```protobuf -rpc PackageService.GetDar(com.digitalasset.canton.admin.participant.v30.GetDarRequest) returns (com.digitalasset.canton.admin.participant.v30.GetDarResponse); -``` - -Obtain a DAR file by hash -- for inspection & download - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.GetDarRequest`](#type-com-digitalasset-canton-admin-participant-v30-getdarrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.GetDarResponse`](#type-com-digitalasset-canton-admin-participant-v30-getdarresponse) - - -**Endpoint `PackageService.GetDarContents`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L42) - -**Signature** - -```protobuf -rpc PackageService.GetDarContents(com.digitalasset.canton.admin.participant.v30.GetDarContentsRequest) returns (com.digitalasset.canton.admin.participant.v30.GetDarContentsResponse); -``` - -List content of a Dar - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.GetDarContentsRequest`](#type-com-digitalasset-canton-admin-participant-v30-getdarcontentsrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.GetDarContentsResponse`](#type-com-digitalasset-canton-admin-participant-v30-getdarcontentsresponse) - - -**Endpoint `PackageService.GetPackageContents`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L16) - -**Signature** - -```protobuf -rpc PackageService.GetPackageContents(com.digitalasset.canton.admin.participant.v30.GetPackageContentsRequest) returns (com.digitalasset.canton.admin.participant.v30.GetPackageContentsResponse); -``` - -Lists all the modules in package on the participant node - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.GetPackageContentsRequest`](#type-com-digitalasset-canton-admin-participant-v30-getpackagecontentsrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.GetPackageContentsResponse`](#type-com-digitalasset-canton-admin-participant-v30-getpackagecontentsresponse) - - -**Endpoint `PackageService.GetPackageReferences`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L19) - -**Signature** - -```protobuf -rpc PackageService.GetPackageReferences(com.digitalasset.canton.admin.participant.v30.GetPackageReferencesRequest) returns (com.digitalasset.canton.admin.participant.v30.GetPackageReferencesResponse); -``` - -Get a list of DARs referencing a given package - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.GetPackageReferencesRequest`](#type-com-digitalasset-canton-admin-participant-v30-getpackagereferencesrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.GetPackageReferencesResponse`](#type-com-digitalasset-canton-admin-participant-v30-getpackagereferencesresponse) - - -**Endpoint `PackageService.ListDars`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L39) - -**Signature** - -```protobuf -rpc PackageService.ListDars(com.digitalasset.canton.admin.participant.v30.ListDarsRequest) returns (com.digitalasset.canton.admin.participant.v30.ListDarsResponse); -``` - -List all DARs on the participant node - return their hashes and filenames - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.ListDarsRequest`](#type-com-digitalasset-canton-admin-participant-v30-listdarsrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.ListDarsResponse`](#type-com-digitalasset-canton-admin-participant-v30-listdarsresponse) - - -**Endpoint `PackageService.ListPackages`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L13) - -**Signature** - -```protobuf -rpc PackageService.ListPackages(com.digitalasset.canton.admin.participant.v30.ListPackagesRequest) returns (com.digitalasset.canton.admin.participant.v30.ListPackagesResponse); -``` - -List all Daml-LF archives on the participant node - return their hashes - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.ListPackagesRequest`](#type-com-digitalasset-canton-admin-participant-v30-listpackagesrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.ListPackagesResponse`](#type-com-digitalasset-canton-admin-participant-v30-listpackagesresponse) - - -**Endpoint `PackageService.RemoveDar`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L33) - -**Signature** - -```protobuf -rpc PackageService.RemoveDar(com.digitalasset.canton.admin.participant.v30.RemoveDarRequest) returns (com.digitalasset.canton.admin.participant.v30.RemoveDarResponse); -``` - -Remove a DAR that is not needed - TODO(#17635): This operation is not safe as it can remove packages still in use by the Ledger API - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.RemoveDarRequest`](#type-com-digitalasset-canton-admin-participant-v30-removedarrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.RemoveDarResponse`](#type-com-digitalasset-canton-admin-participant-v30-removedarresponse) - - -**Endpoint `PackageService.RemovePackage`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L23) - -**Signature** - -```protobuf -rpc PackageService.RemovePackage(com.digitalasset.canton.admin.participant.v30.RemovePackageRequest) returns (com.digitalasset.canton.admin.participant.v30.RemovePackageResponse); -``` - -Remove a package that is not vetted - TODO(#17635): This operation is not safe as it can remove packages still in use by the Ledger API - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.RemovePackageRequest`](#type-com-digitalasset-canton-admin-participant-v30-removepackagerequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.RemovePackageResponse`](#type-com-digitalasset-canton-admin-participant-v30-removepackageresponse) - - -**Endpoint `PackageService.UnvetDar`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L50) - -**Signature** - -```protobuf -rpc PackageService.UnvetDar(com.digitalasset.canton.admin.participant.v30.UnvetDarRequest) returns (com.digitalasset.canton.admin.participant.v30.UnvetDarResponse); -``` - -Revoke vetting for all packages pertaining to a specific DAR. - NOTE: Experimental operation for which expert-level knowledge is required. - Erroneous usage might result in the participant failing to process transactions. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.UnvetDarRequest`](#type-com-digitalasset-canton-admin-participant-v30-unvetdarrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.UnvetDarResponse`](#type-com-digitalasset-canton-admin-participant-v30-unvetdarresponse) - - -**Endpoint `PackageService.UploadDar`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L29) - -**Signature** - -```protobuf -rpc PackageService.UploadDar(com.digitalasset.canton.admin.participant.v30.UploadDarRequest) returns (com.digitalasset.canton.admin.participant.v30.UploadDarResponse); -``` - -Upload a DAR file and all packages inside to the participant node - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** -- [`com.digitalasset.canton.admin.participant.v30.UploadDarRequest`](#type-com-digitalasset-canton-admin-participant-v30-uploaddarrequest) -**Response Type** -- [`com.digitalasset.canton.admin.participant.v30.UploadDarResponse`](#type-com-digitalasset-canton-admin-participant-v30-uploaddarresponse) +
+ + +
+ +
+

community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/acs_import.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
1
+
+ +
+
Enums
+
1
+
+ +
+
Source
+
community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/acs_import.proto
+
+ +
+ + +
+ + + +
+ +
+

community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/active_contract.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
3
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/active_contract.proto
+
+ +
+ + +
+ + + +
+ +
+

community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/enterprise_participant_replication_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
2
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/enterprise_participant_replication_service.proto
+
+ +
+ + +
+ + + +
+ +
+

community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
27
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto
+
+ +
+ + +
+ + + +
+ +
+

community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
30
+
+ +
+
Enums
+
2
+
+ +
+
Source
+
community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto
+
+ +
+ + +
+ + + +
+ +
+

community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
26
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto
+
+ +
+ + +
+ + + +
+ +
+

community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_status_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
3
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_status_service.proto
+
+ +
+ + +
+ + + +
+ +
+

community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
12
+
+ +
+
Enums
+
1
+
+ +
+
Source
+
community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto
+
+ +
+ + +
+ + + +
+ +
+

community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/ping_pong_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
4
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/ping_pong_service.proto
+
+ +
+ + +
+ + + +
+ +
+

community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
4
+
+ +
+
Enums
+
1
+
+ +
+
Source
+
community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto
+
+ +
+ + +
+ + + +
+ +
+

community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/reassignment_id.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
1
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/reassignment_id.proto
+
+ +
+ + +
+ + + +
+ +
+

community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/resource_management_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
5
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/resource_management_service.proto
+
+ +
+ + +
+ + + +
+ +
+

community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
23
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto
+
+ +
+ + +
+ + + +
+ +
+

community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/traffic_control_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
3
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/traffic_control_service.proto
+
+ +
+ + +
+ + +
+ + + + + +## EnterpriseParticipantReplicationService + + + +
+ +
+
Source file
+
community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/enterprise_participant_replication_service.proto
+
+ +
+
Operations
+
1
+
+ +
+ + +
+ + + + +
+

EnterpriseParticipantReplicationService.SetPassive

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc EnterpriseParticipantReplicationService.SetPassive(com.digitalasset.canton.admin.participant.v30.SetPassiveRequest) returns (com.digitalasset.canton.admin.participant.v30.Se...

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.SetPassiveRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.SetPassiveResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## PackageService + + + +
+ +
+
Source file
+
community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto
+
+ +
+
Operations
+
12
+
+ +
+ + +
+ + + + +
+

PackageService.GetDar

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Obtain a DAR file by hash -- for inspection & download

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.GetDarRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.GetDarResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

PackageService.GetDarContents

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

List content of a Dar

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.GetDarContentsRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.GetDarContentsResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

PackageService.GetPackageContents

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Lists all the modules in package on the participant node

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.GetPackageContentsRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.GetPackageContentsResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

PackageService.GetPackageReferences

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Get a list of DARs referencing a given package

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.GetPackageReferencesRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.GetPackageReferencesResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

PackageService.ListDars

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

List all DARs on the participant node - return their hashes and filenames

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.ListDarsRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.ListDarsResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

PackageService.ListPackages

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

List all Daml-LF archives on the participant node - return their hashes

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.ListPackagesRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.ListPackagesResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

PackageService.RemoveDar

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Remove a DAR that is not needed TODO(#17635): This operation is not safe as it can remove packages still in use by the Ledger API

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.RemoveDarRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.RemoveDarResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

PackageService.RemovePackage

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Remove a package that is not vetted TODO(#17635): This operation is not safe as it can remove packages still in use by the Ledger API

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.RemovePackageRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.RemovePackageResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

PackageService.UnvetDar

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Revoke vetting for all packages pertaining to a specific DAR. NOTE: Experimental operation for which expert-level knowledge is required. Erroneous usage might result in the part...

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.UnvetDarRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.UnvetDarResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

PackageService.UploadDar

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Upload a DAR file and all packages inside to the participant node

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.UploadDarRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.UploadDarResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

PackageService.ValidateDar

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Validate a DAR file and all packages inside to the participant node

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.ValidateDarRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.ValidateDarResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

PackageService.VetDar

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Enable vetting for all packages pertaining to a specific DAR

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.VetDarRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.VetDarResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## ParticipantInspectionService - -**Endpoint `PackageService.ValidateDar`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L26) - -**Signature** - -```protobuf -rpc PackageService.ValidateDar(com.digitalasset.canton.admin.participant.v30.ValidateDarRequest) returns (com.digitalasset.canton.admin.participant.v30.ValidateDarResponse); -``` - -Validate a DAR file and all packages inside to the participant node - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.ValidateDarRequest`](#type-com-digitalasset-canton-admin-participant-v30-validatedarrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.ValidateDarResponse`](#type-com-digitalasset-canton-admin-participant-v30-validatedarresponse) - - -**Endpoint `PackageService.VetDar`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L45) - -**Signature** - -```protobuf -rpc PackageService.VetDar(com.digitalasset.canton.admin.participant.v30.VetDarRequest) returns (com.digitalasset.canton.admin.participant.v30.VetDarResponse); -``` - -Enable vetting for all packages pertaining to a specific DAR - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.VetDarRequest`](#type-com-digitalasset-canton-admin-participant-v30-vetdarrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.VetDarResponse`](#type-com-digitalasset-canton-admin-participant-v30-vetdarresponse) - - -### Service `ParticipantInspectionService` - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L19) -- Endpoints tracked: `9` * Inspection Service @@ -506,4256 +1289,9989 @@ Enable vetting for all packages pertaining to a specific DAR This contains only a subset of the ParticipantInspection commands that can run over the admin-api instead of requiring direct access to the participant node instance. -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`CountInFlight`](#endpoint-com-digitalasset-canton-admin-participant-v30-participantinspectionservice-countinflight) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.CountInFlightRequest`](#type-com-digitalasset-canton-admin-participant-v30-countinflightrequest) | [`com.digitalasset.canton.admin.participant.v30.CountInFlightResponse`](#type-com-digitalasset-canton-admin-participant-v30-countinflightresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L41) | -| [`GetConfigForSlowCounterParticipants`](#endpoint-com-digitalasset-canton-admin-participant-v30-participantinspectionservice-getconfigforslowcounterparticipants) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.GetConfigForSlowCounterParticipantsRequest`](#type-com-digitalasset-canton-admin-participant-v30-getconfigforslowcounterparticipantsrequest) | [`com.digitalasset.canton.admin.participant.v30.GetConfigForSlowCounterParticipantsResponse`](#type-com-digitalasset-canton-admin-participant-v30-getconfigforslowcounterparticipantsresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L36) | -| [`GetIntervalsBehindForCounterParticipants`](#endpoint-com-digitalasset-canton-admin-participant-v30-participantinspectionservice-getintervalsbehindforcounterparticipants) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.GetIntervalsBehindForCounterParticipantsRequest`](#type-com-digitalasset-canton-admin-participant-v30-getintervalsbehindforcounterparticipantsrequest) | [`com.digitalasset.canton.admin.participant.v30.GetIntervalsBehindForCounterParticipantsResponse`](#type-com-digitalasset-canton-admin-participant-v30-getintervalsbehindforcounterparticipantsresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L39) | -| [`InspectCommitmentContracts`](#endpoint-com-digitalasset-canton-admin-participant-v30-participantinspectionservice-inspectcommitmentcontracts) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.InspectCommitmentContractsRequest`](#type-com-digitalasset-canton-admin-participant-v30-inspectcommitmentcontractsrequest) | [`com.digitalasset.canton.admin.participant.v30.InspectCommitmentContractsResponse`](#type-com-digitalasset-canton-admin-participant-v30-inspectcommitmentcontractsresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L26) | -| [`LookupOffsetByTime`](#endpoint-com-digitalasset-canton-admin-participant-v30-participantinspectionservice-lookupoffsetbytime) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.LookupOffsetByTimeRequest`](#type-com-digitalasset-canton-admin-participant-v30-lookupoffsetbytimerequest) | [`com.digitalasset.canton.admin.participant.v30.LookupOffsetByTimeResponse`](#type-com-digitalasset-canton-admin-participant-v30-lookupoffsetbytimeresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L22) | -| [`LookupReceivedAcsCommitments`](#endpoint-com-digitalasset-canton-admin-participant-v30-participantinspectionservice-lookupreceivedacscommitments) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.LookupReceivedAcsCommitmentsRequest`](#type-com-digitalasset-canton-admin-participant-v30-lookupreceivedacscommitmentsrequest) | [`com.digitalasset.canton.admin.participant.v30.LookupReceivedAcsCommitmentsResponse`](#type-com-digitalasset-canton-admin-participant-v30-lookupreceivedacscommitmentsresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L31) | -| [`LookupSentAcsCommitments`](#endpoint-com-digitalasset-canton-admin-participant-v30-participantinspectionservice-lookupsentacscommitments) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.LookupSentAcsCommitmentsRequest`](#type-com-digitalasset-canton-admin-participant-v30-lookupsentacscommitmentsrequest) | [`com.digitalasset.canton.admin.participant.v30.LookupSentAcsCommitmentsResponse`](#type-com-digitalasset-canton-admin-participant-v30-lookupsentacscommitmentsresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L28) | -| [`OpenCommitment`](#endpoint-com-digitalasset-canton-admin-participant-v30-participantinspectionservice-opencommitment) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.OpenCommitmentRequest`](#type-com-digitalasset-canton-admin-participant-v30-opencommitmentrequest) | [`com.digitalasset.canton.admin.participant.v30.OpenCommitmentResponse`](#type-com-digitalasset-canton-admin-participant-v30-opencommitmentresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L25) | -| [`SetConfigForSlowCounterParticipants`](#endpoint-com-digitalasset-canton-admin-participant-v30-participantinspectionservice-setconfigforslowcounterparticipants) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.SetConfigForSlowCounterParticipantsRequest`](#type-com-digitalasset-canton-admin-participant-v30-setconfigforslowcounterparticipantsrequest) | [`com.digitalasset.canton.admin.participant.v30.SetConfigForSlowCounterParticipantsResponse`](#type-com-digitalasset-canton-admin-participant-v30-setconfigforslowcounterparticipantsresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L34) | - - -**Endpoint `ParticipantInspectionService.CountInFlight`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L41) - -**Signature** - -```protobuf -rpc ParticipantInspectionService.CountInFlight(com.digitalasset.canton.admin.participant.v30.CountInFlightRequest) returns (com.digitalasset.canton.admin.participant.v30.CountInFlightResponse); -``` - -Count in-flight submissions and transactions for a synchronizer - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.CountInFlightRequest`](#type-com-digitalasset-canton-admin-participant-v30-countinflightrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.CountInFlightResponse`](#type-com-digitalasset-canton-admin-participant-v30-countinflightresponse) - - -**Endpoint `ParticipantInspectionService.GetConfigForSlowCounterParticipants`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L36) - -**Signature** - -```protobuf -rpc ParticipantInspectionService.GetConfigForSlowCounterParticipants(com.digitalasset.canton.admin.participant.v30.GetConfigForSlowCounterParticipantsRequest) returns (com.digitalasset.canton.admin.participant.v30.GetConfigForSlowCounterParticipantsResponse); -``` - -Get the current configuration for metrics for slow counter-participants. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.GetConfigForSlowCounterParticipantsRequest`](#type-com-digitalasset-canton-admin-participant-v30-getconfigforslowcounterparticipantsrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.GetConfigForSlowCounterParticipantsResponse`](#type-com-digitalasset-canton-admin-participant-v30-getconfigforslowcounterparticipantsresponse) - - -**Endpoint `ParticipantInspectionService.GetIntervalsBehindForCounterParticipants`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L39) - -**Signature** - -```protobuf -rpc ParticipantInspectionService.GetIntervalsBehindForCounterParticipants(com.digitalasset.canton.admin.participant.v30.GetIntervalsBehindForCounterParticipantsRequest) returns (com.digitalasset.canton.admin.participant.v30.GetIntervalsBehindForCounterParticipantsResponse); -``` - -Get the number of intervals that counter-participants are behind in sending commitments. - Can be used to decide whether to ignore slow counter-participants w.r.t. pruning. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.GetIntervalsBehindForCounterParticipantsRequest`](#type-com-digitalasset-canton-admin-participant-v30-getintervalsbehindforcounterparticipantsrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.GetIntervalsBehindForCounterParticipantsResponse`](#type-com-digitalasset-canton-admin-participant-v30-getintervalsbehindforcounterparticipantsresponse) - - -**Endpoint `ParticipantInspectionService.InspectCommitmentContracts`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L26) - -**Signature** - -```protobuf -rpc ParticipantInspectionService.InspectCommitmentContracts(com.digitalasset.canton.admin.participant.v30.InspectCommitmentContractsRequest) returns (stream com.digitalasset.canton.admin.participant.v30.InspectCommitmentContractsResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** -- [`com.digitalasset.canton.admin.participant.v30.InspectCommitmentContractsRequest`](#type-com-digitalasset-canton-admin-participant-v30-inspectcommitmentcontractsrequest) +
+ +
+
Source file
+
community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto
+
+ +
+
Operations
+
9
+
+ +
+ + +
+ + + + +
+

ParticipantInspectionService.CountInFlight

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Count in-flight submissions and transactions for a synchronizer

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.CountInFlightRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.CountInFlightResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

ParticipantInspectionService.GetConfigForSlowCounterParticipants

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Get the current configuration for metrics for slow counter-participants.

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.GetConfigForSlowCounterParticipantsRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.GetConfigForSlowCounterParticipantsResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

ParticipantInspectionService.GetIntervalsBehindForCounterParticipants

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Get the number of intervals that counter-participants are behind in sending commitments. Can be used to decide whether to ignore slow counter-participants w.r.t. pruning.

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.GetIntervalsBehindForCounterParticipantsRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.GetIntervalsBehindForCounterParticipantsResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

ParticipantInspectionService.InspectCommitmentContracts

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc ParticipantInspectionService.InspectCommitmentContracts(com.digitalasset.canton.admin.participant.v30.InspectCommitmentContractsRequest) returns (stream com.digitalasset.can...

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.InspectCommitmentContractsRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.InspectCommitmentContractsResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + + + + + +
+

ParticipantInspectionService.LookupOffsetByTime

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Look up the ledger offset corresponding to the timestamp, specifically the largest offset such that no later offset corresponds to a later timestamp than the specified one.

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.LookupOffsetByTimeRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.LookupOffsetByTimeResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

ParticipantInspectionService.LookupReceivedAcsCommitments

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

List the counter-participants and their ACS commitments together with the match status TODO(#18749) R1 Can also be used for R1, to fetch commitments that a counter participant r...

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.LookupReceivedAcsCommitmentsRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.LookupReceivedAcsCommitmentsResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

ParticipantInspectionService.LookupSentAcsCommitments

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Look up the ACS commitments computed and sent by a participant

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.LookupSentAcsCommitmentsRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.LookupSentAcsCommitmentsResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

ParticipantInspectionService.OpenCommitment

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Request metadata about shared contracts used in commitment computation at a specific time Subject to the data still being available on the participant

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.OpenCommitmentRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.OpenCommitmentResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + + + + + +
+

ParticipantInspectionService.SetConfigForSlowCounterParticipants

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Configure metrics for slow counter-participants (i.e., that are behind in sending commitments) and configure thresholds for when a counter-participant is deemed slow.

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.SetConfigForSlowCounterParticipantsRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.SetConfigForSlowCounterParticipantsResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## ParticipantRepairService -**Response Type** -- [`com.digitalasset.canton.admin.participant.v30.InspectCommitmentContractsResponse`](#type-com-digitalasset-canton-admin-participant-v30-inspectcommitmentcontractsresponse) - - -**Endpoint `ParticipantInspectionService.LookupOffsetByTime`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L22) - -**Signature** - -```protobuf -rpc ParticipantInspectionService.LookupOffsetByTime(com.digitalasset.canton.admin.participant.v30.LookupOffsetByTimeRequest) returns (com.digitalasset.canton.admin.participant.v30.LookupOffsetByTimeResponse); -``` - -Look up the ledger offset corresponding to the timestamp, specifically the largest offset such that no later - offset corresponds to a later timestamp than the specified one. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.LookupOffsetByTimeRequest`](#type-com-digitalasset-canton-admin-participant-v30-lookupoffsetbytimerequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.LookupOffsetByTimeResponse`](#type-com-digitalasset-canton-admin-participant-v30-lookupoffsetbytimeresponse) - - -**Endpoint `ParticipantInspectionService.LookupReceivedAcsCommitments`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L31) - -**Signature** - -```protobuf -rpc ParticipantInspectionService.LookupReceivedAcsCommitments(com.digitalasset.canton.admin.participant.v30.LookupReceivedAcsCommitmentsRequest) returns (com.digitalasset.canton.admin.participant.v30.LookupReceivedAcsCommitmentsResponse); -``` - -List the counter-participants and their ACS commitments together with the match status - TODO(#18749) R1 Can also be used for R1, to fetch commitments that a counter participant received from myself - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.LookupReceivedAcsCommitmentsRequest`](#type-com-digitalasset-canton-admin-participant-v30-lookupreceivedacscommitmentsrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.LookupReceivedAcsCommitmentsResponse`](#type-com-digitalasset-canton-admin-participant-v30-lookupreceivedacscommitmentsresponse) - - -**Endpoint `ParticipantInspectionService.LookupSentAcsCommitments`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L28) - -**Signature** - -```protobuf -rpc ParticipantInspectionService.LookupSentAcsCommitments(com.digitalasset.canton.admin.participant.v30.LookupSentAcsCommitmentsRequest) returns (com.digitalasset.canton.admin.participant.v30.LookupSentAcsCommitmentsResponse); -``` - -Look up the ACS commitments computed and sent by a participant - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.LookupSentAcsCommitmentsRequest`](#type-com-digitalasset-canton-admin-participant-v30-lookupsentacscommitmentsrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.LookupSentAcsCommitmentsResponse`](#type-com-digitalasset-canton-admin-participant-v30-lookupsentacscommitmentsresponse) - - -**Endpoint `ParticipantInspectionService.OpenCommitment`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L25) - -**Signature** - -```protobuf -rpc ParticipantInspectionService.OpenCommitment(com.digitalasset.canton.admin.participant.v30.OpenCommitmentRequest) returns (stream com.digitalasset.canton.admin.participant.v30.OpenCommitmentResponse); -``` - -Request metadata about shared contracts used in commitment computation at a specific time - Subject to the data still being available on the participant - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.OpenCommitmentRequest`](#type-com-digitalasset-canton-admin-participant-v30-opencommitmentrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.OpenCommitmentResponse`](#type-com-digitalasset-canton-admin-participant-v30-opencommitmentresponse) - - -**Endpoint `ParticipantInspectionService.SetConfigForSlowCounterParticipants`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L34) - -**Signature** +* + Perform participant repair operations, including exporting and importing ACS, purging + contracts, and migrating synchronizers. These operations directly act on the internal state of the participant + and should be used with caution. -```protobuf -rpc ParticipantInspectionService.SetConfigForSlowCounterParticipants(com.digitalasset.canton.admin.participant.v30.SetConfigForSlowCounterParticipantsRequest) returns (com.digitalasset.canton.admin.participant.v30.SetConfigForSlowCounterParticipantsResponse); -``` + Note that ACS refers to Active Contract Set. -Configure metrics for slow counter-participants (i.e., that are behind in sending commitments) and - configure thresholds for when a counter-participant is deemed slow. -**History** +
+ +
+
Source file
+
community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto
+
+ +
+
Operations
+
12
+
+ +
+ + +
+ + + + +
+

ParticipantRepairService.ChangeAssignation

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Change the assignation of a bunch of contracts

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.ChangeAssignationRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.ChangeAssignationResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

ParticipantRepairService.ExportAcs

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Export the ACS from the participant.

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.ExportAcsRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.ExportAcsResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + + + + + +
+

ParticipantRepairService.ExportAcsOld

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Export the ACS for the given parties from the participant DEPRECATED: Use ExportAcs in the party_management_service.proto instead TODO(#24610) - Remove, new ExportAcs lives in t...

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.ExportAcsOldRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.ExportAcsOldResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + + + + + +
+

ParticipantRepairService.IgnoreEvents

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Ignore events that the participant is unable to process

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.IgnoreEventsRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.IgnoreEventsResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

ParticipantRepairService.ImportAcs

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Import an existing export into the participant

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.ImportAcsRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.ImportAcsResponse
+
+ +
+
Client stream
+
Yes
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

ParticipantRepairService.ImportAcsOld

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Import an existing export into the participant DEPRECATED: Use ImportAcs in this proto file

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.ImportAcsOldRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.ImportAcsOldResponse
+
+ +
+
Client stream
+
Yes
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

ParticipantRepairService.MigrateSynchronizer

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Change the assignation of contracts to the given synchronizer and decommission the source synchronizer

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.MigrateSynchronizerRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.MigrateSynchronizerResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

ParticipantRepairService.PurgeContracts

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Remove the given contracts from the participant

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.PurgeContractsRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.PurgeContractsResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

ParticipantRepairService.PurgeDeactivatedSynchronizer

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Purge deactivated synchronizer

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.PurgeDeactivatedSynchronizerRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.PurgeDeactivatedSynchronizerResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

ParticipantRepairService.RepairCommitmentsUsingAcs

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc ParticipantRepairService.RepairCommitmentsUsingAcs(com.digitalasset.canton.admin.participant.v30.RepairCommitmentsUsingAcsRequest) returns (com.digitalasset.canton.admin.par...

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.RepairCommitmentsUsingAcsRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.RepairCommitmentsUsingAcsResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

ParticipantRepairService.RollbackUnassignment

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Rollback the unassignment of a contract: the contract will be re-assigned back to the source synchronizer

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.RollbackUnassignmentRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.RollbackUnassignmentResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

ParticipantRepairService.UnignoreEvents

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Remove the ignored status from sequenced events This command has no effect on ordinary (i.e., not ignored) events and on events that do not exist.

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.UnignoreEventsRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.UnignoreEventsResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## ParticipantStatusService + + + +
+ +
+
Source file
+
community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_status_service.proto
+
+ +
+
Operations
+
1
+
+ +
+ + +
+ + + + +
+

ParticipantStatusService.ParticipantStatus

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc ParticipantStatusService.ParticipantStatus(com.digitalasset.canton.admin.participant.v30.ParticipantStatusRequest) returns (com.digitalasset.canton.admin.participant.v30.Par...

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.ParticipantStatusRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.ParticipantStatusResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## PartyManagementService -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | -**Request Type** +* + The PartyManagementService allows modifying party hosting on participants. -- [`com.digitalasset.canton.admin.participant.v30.SetConfigForSlowCounterParticipantsRequest`](#type-com-digitalasset-canton-admin-participant-v30-setconfigforslowcounterparticipantsrequest) + Note that ACS refers to Active Contract Set. -**Response Type** + Important: The online and offline party replication endpoints serve distinct workflows, + and must not be combined. -- [`com.digitalasset.canton.admin.participant.v30.SetConfigForSlowCounterParticipantsResponse`](#type-com-digitalasset-canton-admin-participant-v30-setconfigforslowcounterparticipantsresponse) - -### Service `ParticipantRepairService` +
+ +
+
Source file
+
community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto
+
+ +
+
Operations
+
6
+
+ +
+ + +
+ + + + +
+

PartyManagementService.AddPartyAsync

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Online party replication endpoint. Initiate adding a party already hosted on one or more source participants to this target participant in the specified synchronizer. Performs s...

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.AddPartyAsyncRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.AddPartyAsyncResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

PartyManagementService.ClearPartyOnboardingFlag

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Offline party replication endpoint. Instructs the target participant to unilaterally clear the 'onboarding' flag on the party-to-participant topology mapping. This operation is...

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.ClearPartyOnboardingFlagRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.ClearPartyOnboardingFlagResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

PartyManagementService.ExportPartyAcs

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Offline party replication focused ACS export. Exports the ACS of a single party from a source participant, so that the party can be replicated onto a target participant. This en...

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.ExportPartyAcsRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.ExportPartyAcsResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + + + + + +
+

PartyManagementService.GetAddPartyStatus

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Online party replication endpoint. Status endpoint that given an add_party_request_id returns status information about progress, completion, or errors of a previous call to AddP...

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

PartyManagementService.GetHighestOffsetByTimestamp

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

For a given timestamp, find the highest ledger offset among all events that have record time <= timestamp. Returns a ledger offset, or an error otherwise. Depending on the error...

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.GetHighestOffsetByTimestampRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.GetHighestOffsetByTimestampResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

PartyManagementService.ImportPartyAcs

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Offline party replication focused ACS import. Imports the party's ACS into the target participant. This endpoint works in conjunction with ExportPartyAcs endpoint.

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.ImportPartyAcsRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.ImportPartyAcsResponse
+
+ +
+
Client stream
+
Yes
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## PingService + + + +
+ +
+
Source file
+
community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/ping_pong_service.proto
+
+ +
+
Operations
+
1
+
+ +
+ + +
+ + + + +
+

PingService.Ping

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc PingService.Ping(com.digitalasset.canton.admin.participant.v30.PingRequest) returns (com.digitalasset.canton.admin.participant.v30.PingResponse);

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.PingRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.PingResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## PruningService + + + +
+ +
+
Source file
+
community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto
+
+ +
+
Operations
+
13
+
+ +
+ + +
+ + + + +
+

PruningService.ClearSchedule

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Disable automatic pruning and remove the persisted schedule configuration.

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.pruning.v30.ClearScheduleRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.pruning.v30.ClearScheduleResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

PruningService.GetNoWaitCommitmentsFrom

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Retrieve the configuration of waiting for commitments from counter-participants Participants that have been removed from the topology will still be visible in the list until the...

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.pruning.v30.GetNoWaitCommitmentsFromRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.pruning.v30.GetNoWaitCommitmentsFromResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

PruningService.GetParticipantSchedule

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Retrieve the automatic, participant-specific pruning configuration.

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.pruning.v30.GetParticipantScheduleRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.pruning.v30.GetParticipantScheduleResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

PruningService.GetSafePruningOffset

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Retrieve the safe pruning offset

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.GetSafePruningOffsetRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.GetSafePruningOffsetResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

PruningService.GetSchedule

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Retrieve the automatic pruning configuration.

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.pruning.v30.GetScheduleRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.pruning.v30.GetScheduleResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

PruningService.Prune

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Prune the participant specifying the offset before and at which ledger transactions should be removed. Only returns when the potentially long-running prune request ends successf...

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.PruneRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.PruneResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

PruningService.ResetNoWaitCommitmentsFrom

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Enable waiting for commitments from the given counter-participants Waiting for commitments is the default behavior; explicitly enabling it is useful if it was explicitly disabled

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.pruning.v30.ResetNoWaitCommitmentsFromRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.pruning.v30.ResetNoWaitCommitmentsFromResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

PruningService.SetCron

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Modify individual pruning schedule parameters. - ``INVALID_ARGUMENT``: if the payload is malformed or no schedule is configured

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.pruning.v30.SetCronRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.pruning.v30.SetCronResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

PruningService.SetMaxDuration

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc PruningService.SetMaxDuration(com.digitalasset.canton.admin.pruning.v30.SetMaxDurationRequest) returns (com.digitalasset.canton.admin.pruning.v30.SetMaxDurationResponse);

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.pruning.v30.SetMaxDurationRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.pruning.v30.SetMaxDurationResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

PruningService.SetNoWaitCommitmentsFrom

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Disable waiting for commitments from the given counter-participants Disabling waiting for commitments disregards these counter-participants w.r.t. pruning, which gives up non-re...

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.pruning.v30.SetNoWaitCommitmentsFromRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.pruning.v30.SetNoWaitCommitmentsFromResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

PruningService.SetParticipantSchedule

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Enable automatic pruning with participant-specific schedule parameters.

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.pruning.v30.SetParticipantScheduleRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.pruning.v30.SetParticipantScheduleResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

PruningService.SetRetention

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc PruningService.SetRetention(com.digitalasset.canton.admin.pruning.v30.SetRetentionRequest) returns (com.digitalasset.canton.admin.pruning.v30.SetRetentionResponse);

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.pruning.v30.SetRetentionRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.pruning.v30.SetRetentionResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

PruningService.SetSchedule

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Enable automatic pruning using the specified schedule parameters The following errors may occur on the SetSchedule or Update commands: - ``INVALID_ARGUMENT``: if a parameter is...

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.pruning.v30.SetScheduleRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.pruning.v30.SetScheduleResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## ResourceManagementService + + + +
+ +
+
Source file
+
community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/resource_management_service.proto
+
+ +
+
Operations
+
2
+
+ +
+ + +
+ + + + +
+

ResourceManagementService.GetResourceLimits

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Get the current resource limits.

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.GetResourceLimitsRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.GetResourceLimitsResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

ResourceManagementService.SetResourceLimits

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Update resource limits. Only supported if the server runs Canton enterprise.

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.SetResourceLimitsRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.SetResourceLimitsResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## SynchronizerConnectivityService -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L20) -- Endpoints tracked: `12` * - Perform participant repair operations, including exporting and importing ACS, purging - contracts, and migrating synchronizers. These operations directly act on the internal state of the participant - and should be used with caution. + Synchronizer connectivity service for adding and connecting to synchronizers - Note that ACS refers to Active Contract Set. + The synchronizer connectivity service allows to register to new synchronizers and control the + participants synchronizer connections. -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`ChangeAssignation`](#endpoint-com-digitalasset-canton-admin-participant-v30-participantrepairservice-changeassignation) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.ChangeAssignationRequest`](#type-com-digitalasset-canton-admin-participant-v30-changeassignationrequest) | [`com.digitalasset.canton.admin.participant.v30.ChangeAssignationResponse`](#type-com-digitalasset-canton-admin-participant-v30-changeassignationresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L44) | -| [`ExportAcs`](#endpoint-com-digitalasset-canton-admin-participant-v30-participantrepairservice-exportacs) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.ExportAcsRequest`](#type-com-digitalasset-canton-admin-participant-v30-exportacsrequest) | [`com.digitalasset.canton.admin.participant.v30.ExportAcsResponse`](#type-com-digitalasset-canton-admin-participant-v30-exportacsresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L33) | -| [`ExportAcsOld`](#endpoint-com-digitalasset-canton-admin-participant-v30-participantrepairservice-exportacsold) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.ExportAcsOldRequest`](#type-com-digitalasset-canton-admin-participant-v30-exportacsoldrequest) | [`com.digitalasset.canton.admin.participant.v30.ExportAcsOldResponse`](#type-com-digitalasset-canton-admin-participant-v30-exportacsoldresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L24) | -| [`IgnoreEvents`](#endpoint-com-digitalasset-canton-admin-participant-v30-participantrepairservice-ignoreevents) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.IgnoreEventsRequest`](#type-com-digitalasset-canton-admin-participant-v30-ignoreeventsrequest) | [`com.digitalasset.canton.admin.participant.v30.IgnoreEventsResponse`](#type-com-digitalasset-canton-admin-participant-v30-ignoreeventsresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L50) | -| [`ImportAcs`](#endpoint-com-digitalasset-canton-admin-participant-v30-participantrepairservice-importacs) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.ImportAcsRequest`](#type-com-digitalasset-canton-admin-participant-v30-importacsrequest) | [`com.digitalasset.canton.admin.participant.v30.ImportAcsResponse`](#type-com-digitalasset-canton-admin-participant-v30-importacsresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L36) | -| [`ImportAcsOld`](#endpoint-com-digitalasset-canton-admin-participant-v30-participantrepairservice-importacsold) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.ImportAcsOldRequest`](#type-com-digitalasset-canton-admin-participant-v30-importacsoldrequest) | [`com.digitalasset.canton.admin.participant.v30.ImportAcsOldResponse`](#type-com-digitalasset-canton-admin-participant-v30-importacsoldresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L30) | -| [`MigrateSynchronizer`](#endpoint-com-digitalasset-canton-admin-participant-v30-participantrepairservice-migratesynchronizer) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.MigrateSynchronizerRequest`](#type-com-digitalasset-canton-admin-participant-v30-migratesynchronizerrequest) | [`com.digitalasset.canton.admin.participant.v30.MigrateSynchronizerResponse`](#type-com-digitalasset-canton-admin-participant-v30-migratesynchronizerresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L42) | -| [`PurgeContracts`](#endpoint-com-digitalasset-canton-admin-participant-v30-participantrepairservice-purgecontracts) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.PurgeContractsRequest`](#type-com-digitalasset-canton-admin-participant-v30-purgecontractsrequest) | [`com.digitalasset.canton.admin.participant.v30.PurgeContractsResponse`](#type-com-digitalasset-canton-admin-participant-v30-purgecontractsresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L39) | -| [`PurgeDeactivatedSynchronizer`](#endpoint-com-digitalasset-canton-admin-participant-v30-participantrepairservice-purgedeactivatedsynchronizer) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.PurgeDeactivatedSynchronizerRequest`](#type-com-digitalasset-canton-admin-participant-v30-purgedeactivatedsynchronizerrequest) | [`com.digitalasset.canton.admin.participant.v30.PurgeDeactivatedSynchronizerResponse`](#type-com-digitalasset-canton-admin-participant-v30-purgedeactivatedsynchronizerresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L47) | -| [`RepairCommitmentsUsingAcs`](#endpoint-com-digitalasset-canton-admin-participant-v30-participantrepairservice-repaircommitmentsusingacs) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.RepairCommitmentsUsingAcsRequest`](#type-com-digitalasset-canton-admin-participant-v30-repaircommitmentsusingacsrequest) | [`com.digitalasset.canton.admin.participant.v30.RepairCommitmentsUsingAcsResponse`](#type-com-digitalasset-canton-admin-participant-v30-repaircommitmentsusingacsresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L59) | -| [`RollbackUnassignment`](#endpoint-com-digitalasset-canton-admin-participant-v30-participantrepairservice-rollbackunassignment) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.RollbackUnassignmentRequest`](#type-com-digitalasset-canton-admin-participant-v30-rollbackunassignmentrequest) | [`com.digitalasset.canton.admin.participant.v30.RollbackUnassignmentResponse`](#type-com-digitalasset-canton-admin-participant-v30-rollbackunassignmentresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L57) | -| [`UnignoreEvents`](#endpoint-com-digitalasset-canton-admin-participant-v30-participantrepairservice-unignoreevents) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.UnignoreEventsRequest`](#type-com-digitalasset-canton-admin-participant-v30-unignoreeventsrequest) | [`com.digitalasset.canton.admin.participant.v30.UnignoreEventsResponse`](#type-com-digitalasset-canton-admin-participant-v30-unignoreeventsresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L54) | - -**Endpoint `ParticipantRepairService.ChangeAssignation`** +
+ +
+
Source file
+
community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto
+
+ +
+
Operations
+
11
+
+ +
+ + +
+ + + + +
+

SynchronizerConnectivityService.ConnectSynchronizer

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Connect to a new synchronizer

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.ConnectSynchronizerRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.ConnectSynchronizerResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SynchronizerConnectivityService.DisconnectAllSynchronizers

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Disconnect from all connected synchronizers

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.DisconnectAllSynchronizersRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.DisconnectAllSynchronizersResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SynchronizerConnectivityService.DisconnectSynchronizer

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Disconnect from a connected synchronizer

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.DisconnectSynchronizerRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.DisconnectSynchronizerResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SynchronizerConnectivityService.GetSynchronizerId

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Get the physical synchronizer id of the given synchronizer alias Fail if there is more than one active synchronizer connection for the alias

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.GetSynchronizerIdRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.GetSynchronizerIdResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SynchronizerConnectivityService.ListConnectedSynchronizers

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

list connected synchronizers

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.ListConnectedSynchronizersRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.ListConnectedSynchronizersResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SynchronizerConnectivityService.ListRegisteredSynchronizers

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

list registered synchronizers

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.ListRegisteredSynchronizersRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.ListRegisteredSynchronizersResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SynchronizerConnectivityService.Logout

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Revoke the authentication tokens for all the sequencers on a synchronizer and disconnect the sequencer clients

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.LogoutRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.LogoutResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SynchronizerConnectivityService.ModifySynchronizer

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Reconfigure a synchronizer connection

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.ModifySynchronizerRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.ModifySynchronizerResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SynchronizerConnectivityService.ReconnectSynchronizer

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Reconnect to a registered synchronizer

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.ReconnectSynchronizerRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.ReconnectSynchronizerResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SynchronizerConnectivityService.ReconnectSynchronizers

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Reconnect to registered synchronizers

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.ReconnectSynchronizersRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.ReconnectSynchronizersResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SynchronizerConnectivityService.RegisterSynchronizer

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Register the configuration of a new synchronizer connection

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.RegisterSynchronizerRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.RegisterSynchronizerResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## TrafficControlService -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L44) -**Signature** - -```protobuf -rpc ParticipantRepairService.ChangeAssignation(com.digitalasset.canton.admin.participant.v30.ChangeAssignationRequest) returns (com.digitalasset.canton.admin.participant.v30.ChangeAssignationResponse); -``` - -Change the assignation of a bunch of contracts - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.ChangeAssignationRequest`](#type-com-digitalasset-canton-admin-participant-v30-changeassignationrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.ChangeAssignationResponse`](#type-com-digitalasset-canton-admin-participant-v30-changeassignationresponse) - - -**Endpoint `ParticipantRepairService.ExportAcs`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L33) - -**Signature** - -```protobuf -rpc ParticipantRepairService.ExportAcs(com.digitalasset.canton.admin.participant.v30.ExportAcsRequest) returns (stream com.digitalasset.canton.admin.participant.v30.ExportAcsResponse); -``` - -Export the ACS from the participant. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.ExportAcsRequest`](#type-com-digitalasset-canton-admin-participant-v30-exportacsrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.ExportAcsResponse`](#type-com-digitalasset-canton-admin-participant-v30-exportacsresponse) - - -**Endpoint `ParticipantRepairService.ExportAcsOld`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L24) - -**Signature** - -```protobuf -rpc ParticipantRepairService.ExportAcsOld(com.digitalasset.canton.admin.participant.v30.ExportAcsOldRequest) returns (stream com.digitalasset.canton.admin.participant.v30.ExportAcsOldResponse); -``` - -Export the ACS for the given parties from the participant - DEPRECATED: Use ExportAcs in the party_management_service.proto instead - TODO(#24610) - Remove, new ExportAcs lives in the party_management_service.proto - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.ExportAcsOldRequest`](#type-com-digitalasset-canton-admin-participant-v30-exportacsoldrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.ExportAcsOldResponse`](#type-com-digitalasset-canton-admin-participant-v30-exportacsoldresponse) - - -**Endpoint `ParticipantRepairService.IgnoreEvents`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L50) - -**Signature** - -```protobuf -rpc ParticipantRepairService.IgnoreEvents(com.digitalasset.canton.admin.participant.v30.IgnoreEventsRequest) returns (com.digitalasset.canton.admin.participant.v30.IgnoreEventsResponse); -``` - -Ignore events that the participant is unable to process - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.IgnoreEventsRequest`](#type-com-digitalasset-canton-admin-participant-v30-ignoreeventsrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.IgnoreEventsResponse`](#type-com-digitalasset-canton-admin-participant-v30-ignoreeventsresponse) - - -**Endpoint `ParticipantRepairService.ImportAcs`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L36) - -**Signature** - -```protobuf -rpc ParticipantRepairService.ImportAcs(stream com.digitalasset.canton.admin.participant.v30.ImportAcsRequest) returns (com.digitalasset.canton.admin.participant.v30.ImportAcsResponse); -``` - -Import an existing export into the participant - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.ImportAcsRequest`](#type-com-digitalasset-canton-admin-participant-v30-importacsrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.ImportAcsResponse`](#type-com-digitalasset-canton-admin-participant-v30-importacsresponse) - - -**Endpoint `ParticipantRepairService.ImportAcsOld`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L30) - -**Signature** - -```protobuf -rpc ParticipantRepairService.ImportAcsOld(stream com.digitalasset.canton.admin.participant.v30.ImportAcsOldRequest) returns (com.digitalasset.canton.admin.participant.v30.ImportAcsOldResponse); -``` - -Import an existing export into the participant - DEPRECATED: Use ImportAcs in this proto file - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.ImportAcsOldRequest`](#type-com-digitalasset-canton-admin-participant-v30-importacsoldrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.ImportAcsOldResponse`](#type-com-digitalasset-canton-admin-participant-v30-importacsoldresponse) - - -**Endpoint `ParticipantRepairService.MigrateSynchronizer`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L42) - -**Signature** - -```protobuf -rpc ParticipantRepairService.MigrateSynchronizer(com.digitalasset.canton.admin.participant.v30.MigrateSynchronizerRequest) returns (com.digitalasset.canton.admin.participant.v30.MigrateSynchronizerResponse); -``` - -Change the assignation of contracts to the given synchronizer and decommission the source synchronizer - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.MigrateSynchronizerRequest`](#type-com-digitalasset-canton-admin-participant-v30-migratesynchronizerrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.MigrateSynchronizerResponse`](#type-com-digitalasset-canton-admin-participant-v30-migratesynchronizerresponse) - - -**Endpoint `ParticipantRepairService.PurgeContracts`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L39) - -**Signature** - -```protobuf -rpc ParticipantRepairService.PurgeContracts(com.digitalasset.canton.admin.participant.v30.PurgeContractsRequest) returns (com.digitalasset.canton.admin.participant.v30.PurgeContractsResponse); -``` - -Remove the given contracts from the participant - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.PurgeContractsRequest`](#type-com-digitalasset-canton-admin-participant-v30-purgecontractsrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.PurgeContractsResponse`](#type-com-digitalasset-canton-admin-participant-v30-purgecontractsresponse) - - -**Endpoint `ParticipantRepairService.PurgeDeactivatedSynchronizer`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L47) - -**Signature** - -```protobuf -rpc ParticipantRepairService.PurgeDeactivatedSynchronizer(com.digitalasset.canton.admin.participant.v30.PurgeDeactivatedSynchronizerRequest) returns (com.digitalasset.canton.admin.participant.v30.PurgeDeactivatedSynchronizerResponse); -``` - -Purge deactivated synchronizer - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.PurgeDeactivatedSynchronizerRequest`](#type-com-digitalasset-canton-admin-participant-v30-purgedeactivatedsynchronizerrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.PurgeDeactivatedSynchronizerResponse`](#type-com-digitalasset-canton-admin-participant-v30-purgedeactivatedsynchronizerresponse) - - -**Endpoint `ParticipantRepairService.RepairCommitmentsUsingAcs`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L59) - -**Signature** - -```protobuf -rpc ParticipantRepairService.RepairCommitmentsUsingAcs(com.digitalasset.canton.admin.participant.v30.RepairCommitmentsUsingAcsRequest) returns (com.digitalasset.canton.admin.participant.v30.RepairCommitmentsUsingAcsResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.RepairCommitmentsUsingAcsRequest`](#type-com-digitalasset-canton-admin-participant-v30-repaircommitmentsusingacsrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.RepairCommitmentsUsingAcsResponse`](#type-com-digitalasset-canton-admin-participant-v30-repaircommitmentsusingacsresponse) - - -**Endpoint `ParticipantRepairService.RollbackUnassignment`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L57) - -**Signature** - -```protobuf -rpc ParticipantRepairService.RollbackUnassignment(com.digitalasset.canton.admin.participant.v30.RollbackUnassignmentRequest) returns (com.digitalasset.canton.admin.participant.v30.RollbackUnassignmentResponse); -``` - -Rollback the unassignment of a contract: the contract will be re-assigned back to the source synchronizer - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.RollbackUnassignmentRequest`](#type-com-digitalasset-canton-admin-participant-v30-rollbackunassignmentrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.RollbackUnassignmentResponse`](#type-com-digitalasset-canton-admin-participant-v30-rollbackunassignmentresponse) - - -**Endpoint `ParticipantRepairService.UnignoreEvents`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L54) - -**Signature** - -```protobuf -rpc ParticipantRepairService.UnignoreEvents(com.digitalasset.canton.admin.participant.v30.UnignoreEventsRequest) returns (com.digitalasset.canton.admin.participant.v30.UnignoreEventsResponse); -``` - -Remove the ignored status from sequenced events - This command has no effect on ordinary (i.e., not ignored) events and on events that do not exist. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.UnignoreEventsRequest`](#type-com-digitalasset-canton-admin-participant-v30-unignoreeventsrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.UnignoreEventsResponse`](#type-com-digitalasset-canton-admin-participant-v30-unignoreeventsresponse) - - -### Service `ParticipantStatusService` - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_status_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_status_service.proto#L10) -- Endpoints tracked: `1` - -_No description._ - -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`ParticipantStatus`](#endpoint-com-digitalasset-canton-admin-participant-v30-participantstatusservice-participantstatus) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.ParticipantStatusRequest`](#type-com-digitalasset-canton-admin-participant-v30-participantstatusrequest) | [`com.digitalasset.canton.admin.participant.v30.ParticipantStatusResponse`](#type-com-digitalasset-canton-admin-participant-v30-participantstatusresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_status_service.proto#L11) | - - -**Endpoint `ParticipantStatusService.ParticipantStatus`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_status_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_status_service.proto#L11) - -**Signature** - -```protobuf -rpc ParticipantStatusService.ParticipantStatus(com.digitalasset.canton.admin.participant.v30.ParticipantStatusRequest) returns (com.digitalasset.canton.admin.participant.v30.ParticipantStatusResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.ParticipantStatusRequest`](#type-com-digitalasset-canton-admin-participant-v30-participantstatusrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.ParticipantStatusResponse`](#type-com-digitalasset-canton-admin-participant-v30-participantstatusresponse) - - -### Service `PartyManagementService` - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto#L21) -- Endpoints tracked: `6` - -* - The PartyManagementService allows modifying party hosting on participants. - - Note that ACS refers to Active Contract Set. - - Important: The online and offline party replication endpoints serve distinct workflows, - and must not be combined. - -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`AddPartyAsync`](#endpoint-com-digitalasset-canton-admin-participant-v30-partymanagementservice-addpartyasync) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.AddPartyAsyncRequest`](#type-com-digitalasset-canton-admin-participant-v30-addpartyasyncrequest) | [`com.digitalasset.canton.admin.participant.v30.AddPartyAsyncResponse`](#type-com-digitalasset-canton-admin-participant-v30-addpartyasyncresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto#L33) | -| [`ClearPartyOnboardingFlag`](#endpoint-com-digitalasset-canton-admin-participant-v30-partymanagementservice-clearpartyonboardingflag) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.ClearPartyOnboardingFlagRequest`](#type-com-digitalasset-canton-admin-participant-v30-clearpartyonboardingflagrequest) | [`com.digitalasset.canton.admin.participant.v30.ClearPartyOnboardingFlagResponse`](#type-com-digitalasset-canton-admin-participant-v30-clearpartyonboardingflagresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto#L86) | -| [`ExportPartyAcs`](#endpoint-com-digitalasset-canton-admin-participant-v30-partymanagementservice-exportpartyacs) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.ExportPartyAcsRequest`](#type-com-digitalasset-canton-admin-participant-v30-exportpartyacsrequest) | [`com.digitalasset.canton.admin.participant.v30.ExportPartyAcsResponse`](#type-com-digitalasset-canton-admin-participant-v30-exportpartyacsresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto#L54) | -| [`GetAddPartyStatus`](#endpoint-com-digitalasset-canton-admin-participant-v30-partymanagementservice-getaddpartystatus) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusRequest`](#type-com-digitalasset-canton-admin-participant-v30-getaddpartystatusrequest) | [`com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusResponse`](#type-com-digitalasset-canton-admin-participant-v30-getaddpartystatusresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto#L46) | -| [`GetHighestOffsetByTimestamp`](#endpoint-com-digitalasset-canton-admin-participant-v30-partymanagementservice-gethighestoffsetbytimestamp) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.GetHighestOffsetByTimestampRequest`](#type-com-digitalasset-canton-admin-participant-v30-gethighestoffsetbytimestamprequest) | [`com.digitalasset.canton.admin.participant.v30.GetHighestOffsetByTimestampResponse`](#type-com-digitalasset-canton-admin-participant-v30-gethighestoffsetbytimestampresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto#L69) | -| [`ImportPartyAcs`](#endpoint-com-digitalasset-canton-admin-participant-v30-partymanagementservice-importpartyacs) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.ImportPartyAcsRequest`](#type-com-digitalasset-canton-admin-participant-v30-importpartyacsrequest) | [`com.digitalasset.canton.admin.participant.v30.ImportPartyAcsResponse`](#type-com-digitalasset-canton-admin-participant-v30-importpartyacsresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto#L61) | - - -**Endpoint `PartyManagementService.AddPartyAsync`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto#L33) - -**Signature** - -```protobuf -rpc PartyManagementService.AddPartyAsync(com.digitalasset.canton.admin.participant.v30.AddPartyAsyncRequest) returns (com.digitalasset.canton.admin.participant.v30.AddPartyAsyncResponse); -``` - -Online party replication endpoint. - - Initiate adding a party already hosted on one or more source participants to this - target participant in the specified synchronizer. - Performs some checks synchronously and then starts the party addition asynchronously. - - Depends on the party authorizing the PartyToParticipant topology proposal at the - specified topology_serial prior or concurrently to this endpoint. On the other hand, - this target participant authorizes the topology proposal as part of this endpoint in - a specific, intermediate step, and therefore the target participant signature must not - already be in place prior to the call. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.AddPartyAsyncRequest`](#type-com-digitalasset-canton-admin-participant-v30-addpartyasyncrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.AddPartyAsyncResponse`](#type-com-digitalasset-canton-admin-participant-v30-addpartyasyncresponse) - - -**Endpoint `PartyManagementService.ClearPartyOnboardingFlag`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto#L86) - -**Signature** - -```protobuf -rpc PartyManagementService.ClearPartyOnboardingFlag(com.digitalasset.canton.admin.participant.v30.ClearPartyOnboardingFlagRequest) returns (com.digitalasset.canton.admin.participant.v30.ClearPartyOnboardingFlagResponse); -``` - -Offline party replication endpoint. - - Instructs the target participant to unilaterally clear the 'onboarding' flag on the - party-to-participant topology mapping. - - This operation is time-sensitive and will only be attempted after a specific safe - timestamp has passed. - - Because the effect of the topology transaction is not instantaneous, this endpoint is - designed to be polled. Callers should invoke it repeatedly until the response confirms - the flag has been cleared. - - Prerequisite: A prior party-to-participant mapping topology transaction must exist - that activates the party on the target participant with the onboarding flag set to - `true`. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.ClearPartyOnboardingFlagRequest`](#type-com-digitalasset-canton-admin-participant-v30-clearpartyonboardingflagrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.ClearPartyOnboardingFlagResponse`](#type-com-digitalasset-canton-admin-participant-v30-clearpartyonboardingflagresponse) - - -**Endpoint `PartyManagementService.ExportPartyAcs`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto#L54) - -**Signature** - -```protobuf -rpc PartyManagementService.ExportPartyAcs(com.digitalasset.canton.admin.participant.v30.ExportPartyAcsRequest) returns (stream com.digitalasset.canton.admin.participant.v30.ExportPartyAcsResponse); -``` - -Offline party replication focused ACS export. - - Exports the ACS of a single party from a source participant, so that the party can be - replicated onto a target participant. - - This endpoint works in conjunction with the ImportPartyAcs endpoint. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.ExportPartyAcsRequest`](#type-com-digitalasset-canton-admin-participant-v30-exportpartyacsrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.ExportPartyAcsResponse`](#type-com-digitalasset-canton-admin-participant-v30-exportpartyacsresponse) - - -**Endpoint `PartyManagementService.GetAddPartyStatus`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto#L46) - -**Signature** - -```protobuf -rpc PartyManagementService.GetAddPartyStatus(com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusRequest) returns (com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusResponse); -``` - -Online party replication endpoint. - - Status endpoint that given an add_party_request_id returns status information about progress, - completion, or errors of a previous call to AddPartyAsync on the source or target - participant. - - Note that the status reflects the state as perceived by this participant and does not - imply the state of other participants. The status on the target participant is more - authoritative as the target participant drives the process of adding the party. For example - when the target participant status indicates "completed", the party has been added - successfully. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusRequest`](#type-com-digitalasset-canton-admin-participant-v30-getaddpartystatusrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusResponse`](#type-com-digitalasset-canton-admin-participant-v30-getaddpartystatusresponse) - - -**Endpoint `PartyManagementService.GetHighestOffsetByTimestamp`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto#L69) - -**Signature** - -```protobuf -rpc PartyManagementService.GetHighestOffsetByTimestamp(com.digitalasset.canton.admin.participant.v30.GetHighestOffsetByTimestampRequest) returns (com.digitalasset.canton.admin.participant.v30.GetHighestOffsetByTimestampResponse); -``` - -For a given timestamp, find the highest ledger offset among all events that have record time <= timestamp. - - Returns a ledger offset, or an error otherwise. Depending on the error cause, a retry may make sense. - Retryable errors are defined as: OUT_OF_RANGE/INVALID_TIMESTAMP_PARTY_MANAGEMENT_ERROR. - Further, a returned offset is guaranteed to be "clean", meaning all events have been processed fully and - published to the Ledger API DB until the requested timestamp. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.GetHighestOffsetByTimestampRequest`](#type-com-digitalasset-canton-admin-participant-v30-gethighestoffsetbytimestamprequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.GetHighestOffsetByTimestampResponse`](#type-com-digitalasset-canton-admin-participant-v30-gethighestoffsetbytimestampresponse) - - -**Endpoint `PartyManagementService.ImportPartyAcs`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto#L61) - -**Signature** - -```protobuf -rpc PartyManagementService.ImportPartyAcs(stream com.digitalasset.canton.admin.participant.v30.ImportPartyAcsRequest) returns (com.digitalasset.canton.admin.participant.v30.ImportPartyAcsResponse); -``` - -Offline party replication focused ACS import. - - Imports the party's ACS into the target participant. - - This endpoint works in conjunction with ExportPartyAcs endpoint. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.ImportPartyAcsRequest`](#type-com-digitalasset-canton-admin-participant-v30-importpartyacsrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.ImportPartyAcsResponse`](#type-com-digitalasset-canton-admin-participant-v30-importpartyacsresponse) - - -### Service `PingService` - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/ping_pong_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/ping_pong_service.proto#L10) -- Endpoints tracked: `1` - -_No description._ - -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`Ping`](#endpoint-com-digitalasset-canton-admin-participant-v30-pingservice-ping) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.PingRequest`](#type-com-digitalasset-canton-admin-participant-v30-pingrequest) | [`com.digitalasset.canton.admin.participant.v30.PingResponse`](#type-com-digitalasset-canton-admin-participant-v30-pingresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/ping_pong_service.proto#L11) | - - -**Endpoint `PingService.Ping`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/ping_pong_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/ping_pong_service.proto#L11) - -**Signature** - -```protobuf -rpc PingService.Ping(com.digitalasset.canton.admin.participant.v30.PingRequest) returns (com.digitalasset.canton.admin.participant.v30.PingResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.PingRequest`](#type-com-digitalasset-canton-admin-participant-v30-pingrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.PingResponse`](#type-com-digitalasset-canton-admin-participant-v30-pingresponse) - - -### Service `PruningService` - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto#L11) -- Endpoints tracked: `13` - -_No description._ - -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`ClearSchedule`](#endpoint-com-digitalasset-canton-admin-participant-v30-pruningservice-clearschedule) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.pruning.v30.ClearScheduleRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-clearschedulerequest) | [`com.digitalasset.canton.admin.pruning.v30.ClearScheduleResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-clearscheduleresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto#L48) | -| [`GetNoWaitCommitmentsFrom`](#endpoint-com-digitalasset-canton-admin-participant-v30-pruningservice-getnowaitcommitmentsfrom) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.pruning.v30.GetNoWaitCommitmentsFromRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-getnowaitcommitmentsfromrequest) | [`com.digitalasset.canton.admin.pruning.v30.GetNoWaitCommitmentsFromResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-getnowaitcommitmentsfromresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto#L68) | -| [`GetParticipantSchedule`](#endpoint-com-digitalasset-canton-admin-participant-v30-pruningservice-getparticipantschedule) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.pruning.v30.GetParticipantScheduleRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-getparticipantschedulerequest) | [`com.digitalasset.canton.admin.pruning.v30.GetParticipantScheduleResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-getparticipantscheduleresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto#L54) | -| [`GetSafePruningOffset`](#endpoint-com-digitalasset-canton-admin-participant-v30-pruningservice-getsafepruningoffset) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.GetSafePruningOffsetRequest`](#type-com-digitalasset-canton-admin-participant-v30-getsafepruningoffsetrequest) | [`com.digitalasset.canton.admin.participant.v30.GetSafePruningOffsetResponse`](#type-com-digitalasset-canton-admin-participant-v30-getsafepruningoffsetresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto#L28) | -| [`GetSchedule`](#endpoint-com-digitalasset-canton-admin-participant-v30-pruningservice-getschedule) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.pruning.v30.GetScheduleRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-getschedulerequest) | [`com.digitalasset.canton.admin.pruning.v30.GetScheduleResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-getscheduleresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto#L51) | -| [`Prune`](#endpoint-com-digitalasset-canton-admin-participant-v30-pruningservice-prune) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.PruneRequest`](#type-com-digitalasset-canton-admin-participant-v30-prunerequest) | [`com.digitalasset.canton.admin.participant.v30.PruneResponse`](#type-com-digitalasset-canton-admin-participant-v30-pruneresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto#L25) | -| [`ResetNoWaitCommitmentsFrom`](#endpoint-com-digitalasset-canton-admin-participant-v30-pruningservice-resetnowaitcommitmentsfrom) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.pruning.v30.ResetNoWaitCommitmentsFromRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-resetnowaitcommitmentsfromrequest) | [`com.digitalasset.canton.admin.pruning.v30.ResetNoWaitCommitmentsFromResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-resetnowaitcommitmentsfromresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto#L64) | -| [`SetCron`](#endpoint-com-digitalasset-canton-admin-participant-v30-pruningservice-setcron) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.pruning.v30.SetCronRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setcronrequest) | [`com.digitalasset.canton.admin.pruning.v30.SetCronResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setcronresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto#L43) | -| [`SetMaxDuration`](#endpoint-com-digitalasset-canton-admin-participant-v30-pruningservice-setmaxduration) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.pruning.v30.SetMaxDurationRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setmaxdurationrequest) | [`com.digitalasset.canton.admin.pruning.v30.SetMaxDurationResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setmaxdurationresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto#L44) | -| [`SetNoWaitCommitmentsFrom`](#endpoint-com-digitalasset-canton-admin-participant-v30-pruningservice-setnowaitcommitmentsfrom) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.pruning.v30.SetNoWaitCommitmentsFromRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setnowaitcommitmentsfromrequest) | [`com.digitalasset.canton.admin.pruning.v30.SetNoWaitCommitmentsFromResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setnowaitcommitmentsfromresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto#L60) | -| [`SetParticipantSchedule`](#endpoint-com-digitalasset-canton-admin-participant-v30-pruningservice-setparticipantschedule) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.pruning.v30.SetParticipantScheduleRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setparticipantschedulerequest) | [`com.digitalasset.canton.admin.pruning.v30.SetParticipantScheduleResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setparticipantscheduleresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto#L39) | -| [`SetRetention`](#endpoint-com-digitalasset-canton-admin-participant-v30-pruningservice-setretention) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.pruning.v30.SetRetentionRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setretentionrequest) | [`com.digitalasset.canton.admin.pruning.v30.SetRetentionResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setretentionresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto#L45) | -| [`SetSchedule`](#endpoint-com-digitalasset-canton-admin-participant-v30-pruningservice-setschedule) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.pruning.v30.SetScheduleRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setschedulerequest) | [`com.digitalasset.canton.admin.pruning.v30.SetScheduleResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setscheduleresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto#L36) | - - -**Endpoint `PruningService.ClearSchedule`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto#L48) - -**Signature** - -```protobuf -rpc PruningService.ClearSchedule(com.digitalasset.canton.admin.pruning.v30.ClearScheduleRequest) returns (com.digitalasset.canton.admin.pruning.v30.ClearScheduleResponse); -``` - -Disable automatic pruning and remove the persisted schedule configuration. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.pruning.v30.ClearScheduleRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-clearschedulerequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.pruning.v30.ClearScheduleResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-clearscheduleresponse) - - -**Endpoint `PruningService.GetNoWaitCommitmentsFrom`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto#L68) - -**Signature** - -```protobuf -rpc PruningService.GetNoWaitCommitmentsFrom(com.digitalasset.canton.admin.pruning.v30.GetNoWaitCommitmentsFromRequest) returns (com.digitalasset.canton.admin.pruning.v30.GetNoWaitCommitmentsFromResponse); -``` - -Retrieve the configuration of waiting for commitments from counter-participants - Participants that have been removed from the topology will still be visible in the list until they are removed from the no wait configuration. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.pruning.v30.GetNoWaitCommitmentsFromRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-getnowaitcommitmentsfromrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.pruning.v30.GetNoWaitCommitmentsFromResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-getnowaitcommitmentsfromresponse) - - -**Endpoint `PruningService.GetParticipantSchedule`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto#L54) - -**Signature** - -```protobuf -rpc PruningService.GetParticipantSchedule(com.digitalasset.canton.admin.pruning.v30.GetParticipantScheduleRequest) returns (com.digitalasset.canton.admin.pruning.v30.GetParticipantScheduleResponse); -``` - -Retrieve the automatic, participant-specific pruning configuration. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.pruning.v30.GetParticipantScheduleRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-getparticipantschedulerequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.pruning.v30.GetParticipantScheduleResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-getparticipantscheduleresponse) - - -**Endpoint `PruningService.GetSafePruningOffset`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto#L28) - -**Signature** - -```protobuf -rpc PruningService.GetSafePruningOffset(com.digitalasset.canton.admin.participant.v30.GetSafePruningOffsetRequest) returns (com.digitalasset.canton.admin.participant.v30.GetSafePruningOffsetResponse); -``` - -Retrieve the safe pruning offset - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.GetSafePruningOffsetRequest`](#type-com-digitalasset-canton-admin-participant-v30-getsafepruningoffsetrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.GetSafePruningOffsetResponse`](#type-com-digitalasset-canton-admin-participant-v30-getsafepruningoffsetresponse) - - -**Endpoint `PruningService.GetSchedule`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto#L51) - -**Signature** - -```protobuf -rpc PruningService.GetSchedule(com.digitalasset.canton.admin.pruning.v30.GetScheduleRequest) returns (com.digitalasset.canton.admin.pruning.v30.GetScheduleResponse); -``` - -Retrieve the automatic pruning configuration. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.pruning.v30.GetScheduleRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-getschedulerequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.pruning.v30.GetScheduleResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-getscheduleresponse) - - -**Endpoint `PruningService.Prune`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto#L25) - -**Signature** - -```protobuf -rpc PruningService.Prune(com.digitalasset.canton.admin.participant.v30.PruneRequest) returns (com.digitalasset.canton.admin.participant.v30.PruneResponse); -``` - -Prune the participant specifying the offset before and at which ledger transactions - should be removed. Only returns when the potentially long-running prune request ends - successfully or with one of the following errors: - - ``INVALID_ARGUMENT``: if the payload, particularly the offset is malformed or missing - - ``INTERNAL``: if the participant has encountered a failure and has potentially - applied pruning partially. Such cases warrant verifying the participant health before - retrying the prune with the same (or a larger, valid) offset. Successful retries - after such errors ensure that different components reach a consistent pruning state. - - ``FAILED_PRECONDITION``: if the participant is not yet able to prune at the specified - offset or if pruning is invoked on a participant running the Community Edition. - Note that this endpoint only prunes the Canton stores not the ledger API stores. For the latter, - use the pruning service on the ledger API. This limitation only applies to this endpoint, the other endpoints in this service, - most notably the ones for scheduled pruning prune all stores. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.PruneRequest`](#type-com-digitalasset-canton-admin-participant-v30-prunerequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.PruneResponse`](#type-com-digitalasset-canton-admin-participant-v30-pruneresponse) - - -**Endpoint `PruningService.ResetNoWaitCommitmentsFrom`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto#L64) - -**Signature** - -```protobuf -rpc PruningService.ResetNoWaitCommitmentsFrom(com.digitalasset.canton.admin.pruning.v30.ResetNoWaitCommitmentsFromRequest) returns (com.digitalasset.canton.admin.pruning.v30.ResetNoWaitCommitmentsFromResponse); -``` - -Enable waiting for commitments from the given counter-participants - Waiting for commitments is the default behavior; explicitly enabling it is useful if it was explicitly disabled - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.pruning.v30.ResetNoWaitCommitmentsFromRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-resetnowaitcommitmentsfromrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.pruning.v30.ResetNoWaitCommitmentsFromResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-resetnowaitcommitmentsfromresponse) - - -**Endpoint `PruningService.SetCron`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto#L43) - -**Signature** - -```protobuf -rpc PruningService.SetCron(com.digitalasset.canton.admin.pruning.v30.SetCronRequest) returns (com.digitalasset.canton.admin.pruning.v30.SetCronResponse); -``` - -Modify individual pruning schedule parameters. - - ``INVALID_ARGUMENT``: if the payload is malformed or no schedule is configured - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.pruning.v30.SetCronRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setcronrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.pruning.v30.SetCronResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setcronresponse) - - -**Endpoint `PruningService.SetMaxDuration`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto#L44) - -**Signature** - -```protobuf -rpc PruningService.SetMaxDuration(com.digitalasset.canton.admin.pruning.v30.SetMaxDurationRequest) returns (com.digitalasset.canton.admin.pruning.v30.SetMaxDurationResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.pruning.v30.SetMaxDurationRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setmaxdurationrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.pruning.v30.SetMaxDurationResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setmaxdurationresponse) - - -**Endpoint `PruningService.SetNoWaitCommitmentsFrom`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto#L60) - -**Signature** - -```protobuf -rpc PruningService.SetNoWaitCommitmentsFrom(com.digitalasset.canton.admin.pruning.v30.SetNoWaitCommitmentsFromRequest) returns (com.digitalasset.canton.admin.pruning.v30.SetNoWaitCommitmentsFromResponse); -``` - -Disable waiting for commitments from the given counter-participants - Disabling waiting for commitments disregards these counter-participants w.r.t. pruning, which gives up - non-repudiation for those counter-participants, but increases pruning resilience to failures - and slowdowns of those counter-participants and/or the network - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.pruning.v30.SetNoWaitCommitmentsFromRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setnowaitcommitmentsfromrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.pruning.v30.SetNoWaitCommitmentsFromResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setnowaitcommitmentsfromresponse) - - -**Endpoint `PruningService.SetParticipantSchedule`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto#L39) - -**Signature** - -```protobuf -rpc PruningService.SetParticipantSchedule(com.digitalasset.canton.admin.pruning.v30.SetParticipantScheduleRequest) returns (com.digitalasset.canton.admin.pruning.v30.SetParticipantScheduleResponse); -``` - -Enable automatic pruning with participant-specific schedule parameters. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.pruning.v30.SetParticipantScheduleRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setparticipantschedulerequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.pruning.v30.SetParticipantScheduleResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setparticipantscheduleresponse) - - -**Endpoint `PruningService.SetRetention`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto#L45) - -**Signature** - -```protobuf -rpc PruningService.SetRetention(com.digitalasset.canton.admin.pruning.v30.SetRetentionRequest) returns (com.digitalasset.canton.admin.pruning.v30.SetRetentionResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.pruning.v30.SetRetentionRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setretentionrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.pruning.v30.SetRetentionResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setretentionresponse) - - -**Endpoint `PruningService.SetSchedule`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto#L36) - -**Signature** - -```protobuf -rpc PruningService.SetSchedule(com.digitalasset.canton.admin.pruning.v30.SetScheduleRequest) returns (com.digitalasset.canton.admin.pruning.v30.SetScheduleResponse); -``` - -Enable automatic pruning using the specified schedule parameters - The following errors may occur on the SetSchedule or Update commands: - - ``INVALID_ARGUMENT``: if a parameter is missing or an invalid cron expression - or duration. - - ``FAILED_PRECONDITION``: if automatic background pruning has not been enabled - or if invoked on a participant running the Community Edition. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.pruning.v30.SetScheduleRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setschedulerequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.pruning.v30.SetScheduleResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setscheduleresponse) - - -### Service `ResourceManagementService` - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/resource_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/resource_management_service.proto#L8) -- Endpoints tracked: `2` - -_No description._ - -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`GetResourceLimits`](#endpoint-com-digitalasset-canton-admin-participant-v30-resourcemanagementservice-getresourcelimits) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.GetResourceLimitsRequest`](#type-com-digitalasset-canton-admin-participant-v30-getresourcelimitsrequest) | [`com.digitalasset.canton.admin.participant.v30.GetResourceLimitsResponse`](#type-com-digitalasset-canton-admin-participant-v30-getresourcelimitsresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/resource_management_service.proto#L14) | -| [`SetResourceLimits`](#endpoint-com-digitalasset-canton-admin-participant-v30-resourcemanagementservice-setresourcelimits) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.SetResourceLimitsRequest`](#type-com-digitalasset-canton-admin-participant-v30-setresourcelimitsrequest) | [`com.digitalasset.canton.admin.participant.v30.SetResourceLimitsResponse`](#type-com-digitalasset-canton-admin-participant-v30-setresourcelimitsresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/resource_management_service.proto#L11) | - - -**Endpoint `ResourceManagementService.GetResourceLimits`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/resource_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/resource_management_service.proto#L14) - -**Signature** - -```protobuf -rpc ResourceManagementService.GetResourceLimits(com.digitalasset.canton.admin.participant.v30.GetResourceLimitsRequest) returns (com.digitalasset.canton.admin.participant.v30.GetResourceLimitsResponse); -``` - -Get the current resource limits. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.GetResourceLimitsRequest`](#type-com-digitalasset-canton-admin-participant-v30-getresourcelimitsrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.GetResourceLimitsResponse`](#type-com-digitalasset-canton-admin-participant-v30-getresourcelimitsresponse) - - -**Endpoint `ResourceManagementService.SetResourceLimits`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/resource_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/resource_management_service.proto#L11) - -**Signature** - -```protobuf -rpc ResourceManagementService.SetResourceLimits(com.digitalasset.canton.admin.participant.v30.SetResourceLimitsRequest) returns (com.digitalasset.canton.admin.participant.v30.SetResourceLimitsResponse); -``` - -Update resource limits. - Only supported if the server runs Canton enterprise. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.SetResourceLimitsRequest`](#type-com-digitalasset-canton-admin-participant-v30-setresourcelimitsrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.SetResourceLimitsResponse`](#type-com-digitalasset-canton-admin-participant-v30-setresourcelimitsresponse) - - -### Service `SynchronizerConnectivityService` - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L18) -- Endpoints tracked: `11` - -* - Synchronizer connectivity service for adding and connecting to synchronizers - - The synchronizer connectivity service allows to register to new synchronizers and control the - participants synchronizer connections. - -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`ConnectSynchronizer`](#endpoint-com-digitalasset-canton-admin-participant-v30-synchronizerconnectivityservice-connectsynchronizer) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.ConnectSynchronizerRequest`](#type-com-digitalasset-canton-admin-participant-v30-connectsynchronizerrequest) | [`com.digitalasset.canton.admin.participant.v30.ConnectSynchronizerResponse`](#type-com-digitalasset-canton-admin-participant-v30-connectsynchronizerresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L20) | -| [`DisconnectAllSynchronizers`](#endpoint-com-digitalasset-canton-admin-participant-v30-synchronizerconnectivityservice-disconnectallsynchronizers) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.DisconnectAllSynchronizersRequest`](#type-com-digitalasset-canton-admin-participant-v30-disconnectallsynchronizersrequest) | [`com.digitalasset.canton.admin.participant.v30.DisconnectAllSynchronizersResponse`](#type-com-digitalasset-canton-admin-participant-v30-disconnectallsynchronizersresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L35) | -| [`DisconnectSynchronizer`](#endpoint-com-digitalasset-canton-admin-participant-v30-synchronizerconnectivityservice-disconnectsynchronizer) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.DisconnectSynchronizerRequest`](#type-com-digitalasset-canton-admin-participant-v30-disconnectsynchronizerrequest) | [`com.digitalasset.canton.admin.participant.v30.DisconnectSynchronizerResponse`](#type-com-digitalasset-canton-admin-participant-v30-disconnectsynchronizerresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L33) | -| [`GetSynchronizerId`](#endpoint-com-digitalasset-canton-admin-participant-v30-synchronizerconnectivityservice-getsynchronizerid) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.GetSynchronizerIdRequest`](#type-com-digitalasset-canton-admin-participant-v30-getsynchronizeridrequest) | [`com.digitalasset.canton.admin.participant.v30.GetSynchronizerIdResponse`](#type-com-digitalasset-canton-admin-participant-v30-getsynchronizeridresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L47) | -| [`ListConnectedSynchronizers`](#endpoint-com-digitalasset-canton-admin-participant-v30-synchronizerconnectivityservice-listconnectedsynchronizers) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.ListConnectedSynchronizersRequest`](#type-com-digitalasset-canton-admin-participant-v30-listconnectedsynchronizersrequest) | [`com.digitalasset.canton.admin.participant.v30.ListConnectedSynchronizersResponse`](#type-com-digitalasset-canton-admin-participant-v30-listconnectedsynchronizersresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L41) | -| [`ListRegisteredSynchronizers`](#endpoint-com-digitalasset-canton-admin-participant-v30-synchronizerconnectivityservice-listregisteredsynchronizers) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.ListRegisteredSynchronizersRequest`](#type-com-digitalasset-canton-admin-participant-v30-listregisteredsynchronizersrequest) | [`com.digitalasset.canton.admin.participant.v30.ListRegisteredSynchronizersResponse`](#type-com-digitalasset-canton-admin-participant-v30-listregisteredsynchronizersresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L43) | -| [`Logout`](#endpoint-com-digitalasset-canton-admin-participant-v30-synchronizerconnectivityservice-logout) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.LogoutRequest`](#type-com-digitalasset-canton-admin-participant-v30-logoutrequest) | [`com.digitalasset.canton.admin.participant.v30.LogoutResponse`](#type-com-digitalasset-canton-admin-participant-v30-logoutresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L38) | -| [`ModifySynchronizer`](#endpoint-com-digitalasset-canton-admin-participant-v30-synchronizerconnectivityservice-modifysynchronizer) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.ModifySynchronizerRequest`](#type-com-digitalasset-canton-admin-participant-v30-modifysynchronizerrequest) | [`com.digitalasset.canton.admin.participant.v30.ModifySynchronizerResponse`](#type-com-digitalasset-canton-admin-participant-v30-modifysynchronizerresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L30) | -| [`ReconnectSynchronizer`](#endpoint-com-digitalasset-canton-admin-participant-v30-synchronizerconnectivityservice-reconnectsynchronizer) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.ReconnectSynchronizerRequest`](#type-com-digitalasset-canton-admin-participant-v30-reconnectsynchronizerrequest) | [`com.digitalasset.canton.admin.participant.v30.ReconnectSynchronizerResponse`](#type-com-digitalasset-canton-admin-participant-v30-reconnectsynchronizerresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L27) | -| [`ReconnectSynchronizers`](#endpoint-com-digitalasset-canton-admin-participant-v30-synchronizerconnectivityservice-reconnectsynchronizers) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.ReconnectSynchronizersRequest`](#type-com-digitalasset-canton-admin-participant-v30-reconnectsynchronizersrequest) | [`com.digitalasset.canton.admin.participant.v30.ReconnectSynchronizersResponse`](#type-com-digitalasset-canton-admin-participant-v30-reconnectsynchronizersresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L25) | -| [`RegisterSynchronizer`](#endpoint-com-digitalasset-canton-admin-participant-v30-synchronizerconnectivityservice-registersynchronizer) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.RegisterSynchronizerRequest`](#type-com-digitalasset-canton-admin-participant-v30-registersynchronizerrequest) | [`com.digitalasset.canton.admin.participant.v30.RegisterSynchronizerResponse`](#type-com-digitalasset-canton-admin-participant-v30-registersynchronizerresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L22) | - - -**Endpoint `SynchronizerConnectivityService.ConnectSynchronizer`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L20) - -**Signature** - -```protobuf -rpc SynchronizerConnectivityService.ConnectSynchronizer(com.digitalasset.canton.admin.participant.v30.ConnectSynchronizerRequest) returns (com.digitalasset.canton.admin.participant.v30.ConnectSynchronizerResponse); -``` - -Connect to a new synchronizer - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.ConnectSynchronizerRequest`](#type-com-digitalasset-canton-admin-participant-v30-connectsynchronizerrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.ConnectSynchronizerResponse`](#type-com-digitalasset-canton-admin-participant-v30-connectsynchronizerresponse) - - -**Endpoint `SynchronizerConnectivityService.DisconnectAllSynchronizers`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L35) - -**Signature** - -```protobuf -rpc SynchronizerConnectivityService.DisconnectAllSynchronizers(com.digitalasset.canton.admin.participant.v30.DisconnectAllSynchronizersRequest) returns (com.digitalasset.canton.admin.participant.v30.DisconnectAllSynchronizersResponse); -``` - -Disconnect from all connected synchronizers - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.DisconnectAllSynchronizersRequest`](#type-com-digitalasset-canton-admin-participant-v30-disconnectallsynchronizersrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.DisconnectAllSynchronizersResponse`](#type-com-digitalasset-canton-admin-participant-v30-disconnectallsynchronizersresponse) - - -**Endpoint `SynchronizerConnectivityService.DisconnectSynchronizer`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L33) - -**Signature** - -```protobuf -rpc SynchronizerConnectivityService.DisconnectSynchronizer(com.digitalasset.canton.admin.participant.v30.DisconnectSynchronizerRequest) returns (com.digitalasset.canton.admin.participant.v30.DisconnectSynchronizerResponse); -``` - -Disconnect from a connected synchronizer - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.DisconnectSynchronizerRequest`](#type-com-digitalasset-canton-admin-participant-v30-disconnectsynchronizerrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.DisconnectSynchronizerResponse`](#type-com-digitalasset-canton-admin-participant-v30-disconnectsynchronizerresponse) - - -**Endpoint `SynchronizerConnectivityService.GetSynchronizerId`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L47) - -**Signature** - -```protobuf -rpc SynchronizerConnectivityService.GetSynchronizerId(com.digitalasset.canton.admin.participant.v30.GetSynchronizerIdRequest) returns (com.digitalasset.canton.admin.participant.v30.GetSynchronizerIdResponse); -``` - -Get the physical synchronizer id of the given synchronizer alias - Fail if there is more than one active synchronizer connection for the alias - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.GetSynchronizerIdRequest`](#type-com-digitalasset-canton-admin-participant-v30-getsynchronizeridrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.GetSynchronizerIdResponse`](#type-com-digitalasset-canton-admin-participant-v30-getsynchronizeridresponse) - - -**Endpoint `SynchronizerConnectivityService.ListConnectedSynchronizers`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L41) - -**Signature** - -```protobuf -rpc SynchronizerConnectivityService.ListConnectedSynchronizers(com.digitalasset.canton.admin.participant.v30.ListConnectedSynchronizersRequest) returns (com.digitalasset.canton.admin.participant.v30.ListConnectedSynchronizersResponse); -``` - -list connected synchronizers - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.ListConnectedSynchronizersRequest`](#type-com-digitalasset-canton-admin-participant-v30-listconnectedsynchronizersrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.ListConnectedSynchronizersResponse`](#type-com-digitalasset-canton-admin-participant-v30-listconnectedsynchronizersresponse) - - -**Endpoint `SynchronizerConnectivityService.ListRegisteredSynchronizers`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L43) - -**Signature** - -```protobuf -rpc SynchronizerConnectivityService.ListRegisteredSynchronizers(com.digitalasset.canton.admin.participant.v30.ListRegisteredSynchronizersRequest) returns (com.digitalasset.canton.admin.participant.v30.ListRegisteredSynchronizersResponse); -``` - -list registered synchronizers - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.ListRegisteredSynchronizersRequest`](#type-com-digitalasset-canton-admin-participant-v30-listregisteredsynchronizersrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.ListRegisteredSynchronizersResponse`](#type-com-digitalasset-canton-admin-participant-v30-listregisteredsynchronizersresponse) - - -**Endpoint `SynchronizerConnectivityService.Logout`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L38) - -**Signature** - -```protobuf -rpc SynchronizerConnectivityService.Logout(com.digitalasset.canton.admin.participant.v30.LogoutRequest) returns (com.digitalasset.canton.admin.participant.v30.LogoutResponse); -``` - -Revoke the authentication tokens for all the sequencers on a synchronizer and disconnect the sequencer clients - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.LogoutRequest`](#type-com-digitalasset-canton-admin-participant-v30-logoutrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.LogoutResponse`](#type-com-digitalasset-canton-admin-participant-v30-logoutresponse) - - -**Endpoint `SynchronizerConnectivityService.ModifySynchronizer`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L30) - -**Signature** - -```protobuf -rpc SynchronizerConnectivityService.ModifySynchronizer(com.digitalasset.canton.admin.participant.v30.ModifySynchronizerRequest) returns (com.digitalasset.canton.admin.participant.v30.ModifySynchronizerResponse); -``` - -Reconfigure a synchronizer connection - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.ModifySynchronizerRequest`](#type-com-digitalasset-canton-admin-participant-v30-modifysynchronizerrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.ModifySynchronizerResponse`](#type-com-digitalasset-canton-admin-participant-v30-modifysynchronizerresponse) - - -**Endpoint `SynchronizerConnectivityService.ReconnectSynchronizer`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L27) - -**Signature** - -```protobuf -rpc SynchronizerConnectivityService.ReconnectSynchronizer(com.digitalasset.canton.admin.participant.v30.ReconnectSynchronizerRequest) returns (com.digitalasset.canton.admin.participant.v30.ReconnectSynchronizerResponse); -``` - -Reconnect to a registered synchronizer - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.ReconnectSynchronizerRequest`](#type-com-digitalasset-canton-admin-participant-v30-reconnectsynchronizerrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.ReconnectSynchronizerResponse`](#type-com-digitalasset-canton-admin-participant-v30-reconnectsynchronizerresponse) - - -**Endpoint `SynchronizerConnectivityService.ReconnectSynchronizers`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L25) - -**Signature** - -```protobuf -rpc SynchronizerConnectivityService.ReconnectSynchronizers(com.digitalasset.canton.admin.participant.v30.ReconnectSynchronizersRequest) returns (com.digitalasset.canton.admin.participant.v30.ReconnectSynchronizersResponse); -``` - -Reconnect to registered synchronizers - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.ReconnectSynchronizersRequest`](#type-com-digitalasset-canton-admin-participant-v30-reconnectsynchronizersrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.ReconnectSynchronizersResponse`](#type-com-digitalasset-canton-admin-participant-v30-reconnectsynchronizersresponse) - - -**Endpoint `SynchronizerConnectivityService.RegisterSynchronizer`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L22) - -**Signature** - -```protobuf -rpc SynchronizerConnectivityService.RegisterSynchronizer(com.digitalasset.canton.admin.participant.v30.RegisterSynchronizerRequest) returns (com.digitalasset.canton.admin.participant.v30.RegisterSynchronizerResponse); -``` - -Register the configuration of a new synchronizer connection - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.RegisterSynchronizerRequest`](#type-com-digitalasset-canton-admin-participant-v30-registersynchronizerrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.RegisterSynchronizerResponse`](#type-com-digitalasset-canton-admin-participant-v30-registersynchronizerresponse) - - -### Service `TrafficControlService` - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/traffic_control_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/traffic_control_service.proto#L11) -- Endpoints tracked: `1` - -Service to retrieve information about the traffic state of the participant. - -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`TrafficControlState`](#endpoint-com-digitalasset-canton-admin-participant-v30-trafficcontrolservice-trafficcontrolstate) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.participant.v30.TrafficControlStateRequest`](#type-com-digitalasset-canton-admin-participant-v30-trafficcontrolstaterequest) | [`com.digitalasset.canton.admin.participant.v30.TrafficControlStateResponse`](#type-com-digitalasset-canton-admin-participant-v30-trafficcontrolstateresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/traffic_control_service.proto#L12) | - - -**Endpoint `TrafficControlService.TrafficControlState`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/traffic_control_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/traffic_control_service.proto#L12) - -**Signature** - -```protobuf -rpc TrafficControlService.TrafficControlState(com.digitalasset.canton.admin.participant.v30.TrafficControlStateRequest) returns (com.digitalasset.canton.admin.participant.v30.TrafficControlStateResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.participant.v30.TrafficControlStateRequest`](#type-com-digitalasset-canton-admin-participant-v30-trafficcontrolstaterequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.participant.v30.TrafficControlStateResponse`](#type-com-digitalasset-canton-admin-participant-v30-trafficcontrolstateresponse) - -## Type Reference - - -**Message `com.digitalasset.canton.admin.participant.v30.ActiveContract`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/active_contract.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/active_contract.proto#L49) -- Fields: 1 - -Schema definition for the exported active contract - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| active_contract | `bytes` | optional | Opaque active contract, assumed to be the bytes of a LAPI active contract
Required | - - -**Message `com.digitalasset.canton.admin.participant.v30.ActiveContractOld`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/active_contract.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/active_contract.proto#L13) -- Fields: 3 - -TODO(#24610) – Remove; replaced by the new ActiveContract that uses LAPI active contract - Schema definition for the exported ACS snapshot - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| synchronizer_id | `string` | optional | The ID of the synchronizer where the contract was assigned at the time of the export
Required | -| contract | [`com.digitalasset.canton.admin.participant.v30.Contract`](#type-com-digitalasset-canton-admin-participant-v30-contract) | optional | The contract and its associated metadata
Required | -| reassignment_counter | `int64` | optional | The number of times the contract has been reassigned at the time of the export
Required | - - -**Message `com.digitalasset.canton.admin.participant.v30.AddPartyAsyncRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto#L89) -- Fields: 5 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| party_id | `string` | optional | The party to replicate
Required | -| synchronizer_id | `string` | optional | The synchronizer in which to replicate the party
Required | -| source_participant_uid | `string` | optional | A source participant already hosting the party
Required | -| topology_serial | `uint32` | optional | The topology serial number of the PartyToParticipant topology transaction used to
add the party to this target participant.
Required | -| participant_permission | [`com.digitalasset.canton.admin.participant.v30.ParticipantPermission`](#type-com-digitalasset-canton-admin-participant-v30-participantpermission) | optional | The permission level of the party on the target participant.
Required | - - -**Message `com.digitalasset.canton.admin.participant.v30.AddPartyAsyncResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto#L110) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| add_party_request_id | `string` | optional | The identifier used to uniquely track the add party request. | - - -**Message `com.digitalasset.canton.admin.participant.v30.ChangeAssignationRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L79) -- Fields: 4 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| source_synchronizer_alias | `string` | optional | Alias of the synchronizer to which the contracts are currently assigned
Required | -| target_synchronizer_alias | `string` | optional | New assignation
Required | -| skip_inactive | `bool` | optional | Whether to skip inactive contracts. Default: true. | -| contracts | [`com.digitalasset.canton.admin.participant.v30.ChangeAssignationRequest.Contract`](#type-com-digitalasset-canton-admin-participant-v30-changeassignationrequest-contract) | repeated | | - - -**Message `com.digitalasset.canton.admin.participant.v30.ChangeAssignationRequest.Contract`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L80) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| id | `string` | optional | | -| reassignment_counter_override | `int64` | optional | By default, reassignment counter will be increased by 1
This can be overridden by a non-empty value. | - - -**Message `com.digitalasset.canton.admin.participant.v30.ChangeAssignationResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L101) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.participant.v30.ClearPartyOnboardingFlagRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto#L328) -- Fields: 4 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| party_id | `string` | optional | The identifier of the party whose onboarding flag is being cleared. This party must
already be active on the target participant.
Required | -| synchronizer_id | `string` | optional | The identifier of the synchronizer.
Required | -| begin_offset_exclusive | `int64` | optional | The exclusive ledger offset used as a starting point to find the party's most
recent activation on the target participant.
Required | -| wait_for_activation_timeout | `google.protobuf.Duration` | optional | The maximum duration the service will wait to find the topology transaction
that activates the party.
If not set, the service will use a default timeout.
Optional | - - -**Message `com.digitalasset.canton.admin.participant.v30.ClearPartyOnboardingFlagResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto#L360) -- Fields: 2 - -Responds with the current status: - - Cleared: (true, None) – The flag is successfully cleared. - - Pending: (false, Some(timestamp)) – The flag is still set. The timestamp indicates - the earliest safe time to clear the flag. - Calling the service (repeatedly) after that specific time will eventually confirm - that the onboarding flag has been cleared (that is `onboarded = true`). - - The onboarding flag remains for two reasons: - 1. The safe time to clear the flag has not yet been reached. - 2. The clearing transaction was proposed, but it has not yet become effective. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| onboarded | `bool` | optional | Indicates the current party onboarding status.
Required | -| earliest_retry_timestamp | `google.protobuf.Timestamp` | optional | The earliest time for the safe clearance of the onboarding flag.

This field is only present when `onboarded` is `false`. | - - -**Message `com.digitalasset.canton.admin.participant.v30.CommitmentContract`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L95) -- Fields: 4 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| cid | `bytes` | optional | | -| active_on_expected_synchronizer | `bool` | optional | | -| contract | `bytes` | optional | Encoded ContractInstance | -| states | [`com.digitalasset.canton.admin.participant.v30.ContractState.SynchronizerState`](#type-com-digitalasset-canton-admin-participant-v30-contractstate-synchronizerstate) | repeated | | - - -**Message `com.digitalasset.canton.admin.participant.v30.CommitmentContractMeta`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L72) -- Fields: 2 - -Contract ids (cids) need to be authenticated, otherwise the cid does not uniquely identify the stakeholders and - the contract hash - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| cid | `bytes` | optional | | -| reassignment_counter | `int64` | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.ConnectSynchronizerRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L139) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| config | [`com.digitalasset.canton.admin.participant.v30.SynchronizerConnectionConfig`](#type-com-digitalasset-canton-admin-participant-v30-synchronizerconnectionconfig) | optional | | -| sequencer_connection_validation | [`com.digitalasset.canton.admin.sequencer.v30.SequencerConnectionValidation`](com-digitalasset-canton-admin-sequencer-v30#type-com-digitalasset-canton-admin-sequencer-v30-sequencerconnectionvalidation) | optional | Determines how well the provided sequencer connections should be validated before they are
persisted. The more paranoid the validation, the higher the chance of the command failing,
as it will require the sequencer to be online and responsive. | - - -**Message `com.digitalasset.canton.admin.participant.v30.ConnectSynchronizerResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L148) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| connected_successfully | `bool` | optional | true if the synchronizer is connected, false if the synchronizer is offline, exception on any other error | - - -**Message `com.digitalasset.canton.admin.participant.v30.ConnectedSynchronizer`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_status_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_status_service.proto#L16) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| physical_synchronizer_id | `string` | optional | | -| health | [`com.digitalasset.canton.admin.participant.v30.ConnectedSynchronizer.Health`](#type-com-digitalasset-canton-admin-participant-v30-connectedsynchronizer-health) | optional | | - - -**Enum `com.digitalasset.canton.admin.participant.v30.ConnectedSynchronizer.Health`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_status_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_status_service.proto#L17) - -_No description._ - -| Name | Number | -| --- | --- | -| HEALTH_UNSPECIFIED | `0` | -| HEALTH_HEALTHY | `1` | -| HEALTH_UNHEALTHY | `2` | - - -**Message `com.digitalasset.canton.admin.participant.v30.Contract`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/active_contract.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/active_contract.proto#L27) -- Fields: 5 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| contract_id | `string` | optional | | -| raw_contract_instance | `bytes` | optional | | -| metadata | [`com.digitalasset.canton.admin.participant.v30.Contract.Metadata`](#type-com-digitalasset-canton-admin-participant-v30-contract-metadata) | optional | | -| ledger_create_time | `google.protobuf.Timestamp` | optional | in microseconds of UTC time since Unix epoch | -| authentication_data | `bytes` | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.Contract.Metadata`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/active_contract.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/active_contract.proto#L28) -- Fields: 4 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| non_maintainer_signatories | `string` | repeated | | -| non_signatory_stakeholders | `string` | repeated | | -| key | [`com.digitalasset.canton.admin.participant.v30.Contract.GlobalKey`](#type-com-digitalasset-canton-admin-participant-v30-contract-globalkey) | optional | optional: only set if contract has a key | -| maintainers | `string` | repeated | optional; only set if contract has a key | - - -**Message `com.digitalasset.canton.admin.participant.v30.Contract.GlobalKey`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/active_contract.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/active_contract.proto#L35) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| template_id | `bytes` | optional | | -| key | `bytes` | optional | | -| package_name | `string` | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.ContractState`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L103) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.participant.v30.ContractState.SynchronizerState`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L104) -- Fields: 6 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| synchronizer_id | `string` | optional | | -| created | [`com.digitalasset.canton.admin.participant.v30.ContractState.Created`](#type-com-digitalasset-canton-admin-participant-v30-contractstate-created) | optional | | -| archived | [`com.digitalasset.canton.admin.participant.v30.ContractState.Archived`](#type-com-digitalasset-canton-admin-participant-v30-contractstate-archived) | optional | | -| unassigned | [`com.digitalasset.canton.admin.participant.v30.ContractState.Unassigned`](#type-com-digitalasset-canton-admin-participant-v30-contractstate-unassigned) | optional | | -| assigned | [`com.digitalasset.canton.admin.participant.v30.ContractState.Assigned`](#type-com-digitalasset-canton-admin-participant-v30-contractstate-assigned) | optional | | -| unknown | [`com.digitalasset.canton.admin.participant.v30.ContractState.Unknown`](#type-com-digitalasset-canton-admin-participant-v30-contractstate-unknown) | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.ContractState.Created`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L118) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.participant.v30.ContractState.Assigned`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L122) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| reassignment_counter_target | `int64` | optional | | -| reassignment_id | [`com.digitalasset.canton.admin.participant.v30.ContractState.ReassignmentId`](#type-com-digitalasset-canton-admin-participant-v30-contractstate-reassignmentid) | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.ContractState.Archived`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L128) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.participant.v30.ContractState.Unassigned`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L132) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| target_synchronizer_id | `string` | optional | | -| reassignment_counter_src | `int64` | optional | | -| reassignment_id | [`com.digitalasset.canton.admin.participant.v30.ContractState.ReassignmentId`](#type-com-digitalasset-canton-admin-participant-v30-contractstate-reassignmentid) | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.ContractState.Unknown`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L140) -- Fields: 0 - -the contract is unknown to the synchronizer, but may have existed in the past and have been pruned meanwhile - - -**Message `com.digitalasset.canton.admin.participant.v30.ContractState.ReassignmentId`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L144) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| id | `string` | optional | identifies the reassignment batch, built from a hash of source, target, contract ids, contract counters and timestamp. | - - -**Message `com.digitalasset.canton.admin.participant.v30.CountInFlightRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L358) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| synchronizer_id | `string` | optional | the synchronizer to query for pending submissions and in-flight transactions | - - -**Message `com.digitalasset.canton.admin.participant.v30.CountInFlightResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L363) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| pending_submissions | `uint32` | optional | | -| pending_transactions | `uint32` | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.CounterParticipantInfo`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L330) -- Fields: 5 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| counter_participant_uid | `string` | optional | | -| synchronizer_id | `string` | optional | | -| intervals_behind | `uint64` | optional | MaxInt(2147483647) means that the counter-participant never sent a commitment | -| behind_since | `google.protobuf.Duration` | optional | how long time the corresponding intervals correlate to (Timestamp in the future means it has never sent a commitment)
this is to help debugging, especially in the case where the reconciliation interval have been changed.
for example, if we have a counter participant that is three intervals behind, and each interval is one minute.
if the reconciliation interval is changed to 24 hours,
then it might look like that counter-participant is three days behind (when it is actually only three minutes behind). | -| as_of_sequencing_timestamp | `google.protobuf.Timestamp` | optional | the "as of" sequencing timestamp at which this information was obtained | - - -**Message `com.digitalasset.canton.admin.participant.v30.DarDescription`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L156) -- Fields: 4 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| main | `string` | optional | | -| name | `string` | optional | | -| version | `string` | optional | | -| description | `string` | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.DisconnectAllSynchronizersRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L159) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.participant.v30.DisconnectAllSynchronizersResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L161) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.participant.v30.DisconnectSynchronizerRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L153) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| synchronizer_alias | `string` | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.DisconnectSynchronizerResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L157) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.participant.v30.ExportAcsOldRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L117) -- Fields: 5 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| parties | `string` | repeated | The parties for which the ACS should be exported.
If empty, the ACS of all parties will be exported.
Optional | -| filter_synchronizer_id | `string` | optional | The IDs of the synchronizers to filter the contracts by
Optional, if set the contracts will be filtered by the exact match of the ID of the synchronizer to which it's assigned | -| timestamp | `google.protobuf.Timestamp` | optional | The timestamp at which the ACS should be valid. If provided, it will be checked that the ACS is
available at the given timestamp (i.e. the timestamp is considered clean and the ACS has not been
pruned).
Optional, if missing the latest clean timestamp will be used | -| force | `bool` | optional | If true, do not check whether the provided timestamp is clean (see `timestamp` field).
NOT FOR PRODUCTION USE.
For this option to yield a consistent snapshot, you need to wait at least
confirmationResponseTimeout + mediatorReactionTimeout after the last submitted request.
Recommended value is `false` | -| parties_offboarding | `bool` | optional | true if the parties will be offboarded after the replication (party migration)
Recommended value is `false` | - - -**Message `com.digitalasset.canton.admin.participant.v30.ExportAcsOldResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L153) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| chunk | `bytes` | optional | The raw binary of the ACS snapshot to be imported
This is meant to be streamed and every message should be a chunk of the snapshot
Required | - - -**Message `com.digitalasset.canton.admin.participant.v30.ExportAcsRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L188) -- Fields: 5 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| party_ids | `string` | repeated | The identifiers of the parties for which the Active Contract Set (ACS) will be exported.
This field must contain at least one party ID.
Required | -| synchronizer_id | `string` | optional | The identifier of the synchronizer to filter contracts.
Optional. If provided, only contracts assigned to a synchronizer with this exact ID will be included
in the exported ACS. If not set (empty string), all contracts for the specified parties will be included. | -| ledger_offset | `int64` | optional | The ledger offset at which the ACS snapshot should be taken. This determines the point in the
ledger history from which the active contracts will be retrieved.
Required | -| contract_synchronizer_renames | `map` | repeated | A mapping to modify the synchronizer assignment of contracts in the exported ACS.
Note: This mapping is not a proper contract reassignment. That is no actual reassignment happens, and thus
the reassignment counter is not increased.
Optional. If not provided (empty map), the contracts in the exported ACS will retain their
original synchronizer assignments. | -| excluded_stakeholder_ids | `string` | repeated | A list of party IDs to exclude from the export.
Any contract that has one or more of these parties as a stakeholder will be omitted from the ACS snapshot.
Optional | - - -**Message `com.digitalasset.canton.admin.participant.v30.ExportAcsResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L217) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| chunk | `bytes` | optional | A chunk of the Active Contract Set (ACS) snapshot. This response is streamed, with each
message containing a portion of the complete ACS data.
The raw binary data within each chunk consists of Ledger API active contract messages, specifically wrapped
in `v30.active_contract.ActiveContract` messages. However, a single chunk does not necessarily contain
exactly one complete message.
This field will be populated in each streamed response.
Required | - - -**Message `com.digitalasset.canton.admin.participant.v30.ExportAcsTargetSynchronizer`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L181) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| target_synchronizer_id | `string` | optional | The identifier of the synchronizer to which contracts should be assigned upon exporting the
Active Contract Set (ACS).
Required. | - - -**Message `com.digitalasset.canton.admin.participant.v30.ExportPartyAcsRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto#L234) -- Fields: 5 - -Exports the ACS for a given party to facilitate its replication from a source to a target participant. - - This request uses the party's most recent activation on the target participant to determine the precise - historical state of the ACS to export from the source participant. - - "Activation" on the target participant means the new hosting arrangement has been authorized by both - the party itself and the target participant via party-to-participant topology transactions. - - This request will fail if the party has not yet been activated on the target participant. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| party_id | `string` | optional | The identifier of the party being replicated. This party must already be active on the target participant
for the ACS export to succeed.
Required | -| synchronizer_id | `string` | optional | The identifier of the synchronizer managing the contract to be exported. This scopes the ACS export to only
contracts assigned to this synchronizer.
Required | -| target_participant_uid | `string` | optional | The unique identifier of the target participant where the party will be replicated.
Required | -| begin_offset_exclusive | `int64` | optional | The exclusive ledger offset used as starting point to find the party's most recent activation on the target
participant.
Required | -| wait_for_activation_timeout | `google.protobuf.Duration` | optional | The maximum duration the service will wait to find the topology transaction that activates the party on
the target participant.
If not set, the service will use a default timeout.
Optional | - - -**Message `com.digitalasset.canton.admin.participant.v30.ExportPartyAcsResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto#L261) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| chunk | `bytes` | optional | A chunk of the ACS snapshot. This response is streamed, with each message containing a portion of the
complete ACS data. The raw binary data within each chunk consists of Ledger API active contract messages,
specifically wrapped in `v30.active_contract.ActiveContract` messages. However, a single chunk does not
necessarily contain exactly one complete message.
This field will be populated in each streamed response.
Required | - - -**Message `com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto#L117) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| add_party_request_id | `string` | optional | The add party request ID returned by AddPartyAsync
Required | - - -**Message `com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto#L125) -- Fields: 7 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| party_id | `string` | optional | | -| synchronizer_id | `string` | optional | | -| source_participant_uid | `string` | optional | | -| target_participant_uid | `string` | optional | | -| topology_serial | `uint32` | optional | | -| participant_permission | [`com.digitalasset.canton.admin.participant.v30.ParticipantPermission`](#type-com-digitalasset-canton-admin-participant-v30-participantpermission) | optional | | -| status | [`com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusResponse.Status`](#type-com-digitalasset-canton-admin-participant-v30-getaddpartystatusresponse-status) | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusResponse.Status`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto#L135) -- Fields: 9 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| proposal_processed | [`com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusResponse.Status.ProposalProcessed`](#type-com-digitalasset-canton-admin-participant-v30-getaddpartystatusresponse-status-proposalprocessed) | optional | Party Replication Daml admin workflow proposal and agreement handling | -| agreement_accepted | [`com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusResponse.Status.AgreementAccepted`](#type-com-digitalasset-canton-admin-participant-v30-getaddpartystatusresponse-status-agreementaccepted) | optional | | -| topology_authorized | [`com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusResponse.Status.TopologyAuthorized`](#type-com-digitalasset-canton-admin-participant-v30-getaddpartystatusresponse-status-topologyauthorized) | optional | Topology management | -| connection_established | [`com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusResponse.Status.ConnectionEstablished`](#type-com-digitalasset-canton-admin-participant-v30-getaddpartystatusresponse-status-connectionestablished) | optional | Party Replication ACS replication | -| replicating_acs | [`com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusResponse.Status.ReplicatingAcs`](#type-com-digitalasset-canton-admin-participant-v30-getaddpartystatusresponse-status-replicatingacs) | optional | | -| fully_replicated_acs | [`com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusResponse.Status.FullyReplicatedAcs`](#type-com-digitalasset-canton-admin-participant-v30-getaddpartystatusresponse-status-fullyreplicatedacs) | optional | | -| completed | [`com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusResponse.Status.Completed`](#type-com-digitalasset-canton-admin-participant-v30-getaddpartystatusresponse-status-completed) | optional | Completed indicating that party successfully has been added to target participant. | -| error | [`com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusResponse.Status.Error`](#type-com-digitalasset-canton-admin-participant-v30-getaddpartystatusresponse-status-error) | optional | Error indicating that party replication has failed. | -| disconnected | [`com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusResponse.Status.Disconnected`](#type-com-digitalasset-canton-admin-participant-v30-getaddpartystatusresponse-status-disconnected) | optional | Conditions that party replication is attempting to recover from. | - - -**Message `com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusResponse.Status.ProposalProcessed`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto#L138) -- Fields: 0 - -The add-party request has been submitted by the target participant, or accepted by the - source participant. - - -**Message `com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusResponse.Status.AgreementAccepted`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto#L140) -- Fields: 1 - -The add-party request has been observed as agreed to by all participants. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| sequencer_uid | `string` | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusResponse.Status.TopologyAuthorized`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto#L145) -- Fields: 2 - -The PartyToParticipant topology transaction has been authorized by all party and - participant signers. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| sequencer_uid | `string` | optional | | -| timestamp | `google.protobuf.Timestamp` | optional | The timestamp at which the ACS snapshot for replication is taken. | - - -**Message `com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusResponse.Status.ConnectionEstablished`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto#L151) -- Fields: 2 - -This participant has connected to the sequencer channel for ACS replication. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| sequencer_uid | `string` | optional | | -| timestamp | `google.protobuf.Timestamp` | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusResponse.Status.ReplicatingAcs`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto#L156) -- Fields: 3 - -This participant is ready for ACS replication or has started replicating the ACS. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| sequencer_uid | `string` | optional | | -| timestamp | `google.protobuf.Timestamp` | optional | | -| contracts_replicated | `uint32` | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusResponse.Status.FullyReplicatedAcs`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto#L163) -- Fields: 3 - -This participant has completed its part of the ACS replication: In case of the source participant - all contracts have been sent, and for the target participant all contracts have been received. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| sequencer_uid | `string` | optional | | -| timestamp | `google.protobuf.Timestamp` | optional | | -| contracts_replicated | `uint32` | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusResponse.Status.Completed`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto#L169) -- Fields: 3 - -The party has been added to the target participant. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| sequencer_uid | `string` | optional | | -| timestamp | `google.protobuf.Timestamp` | optional | | -| contracts_replicated | `uint32` | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusResponse.Status.Error`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto#L175) -- Fields: 2 - -The add-party request has failed after the specified last successful status. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| error_message | `string` | optional | | -| status_prior_to_error | [`com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusResponse.Status`](#type-com-digitalasset-canton-admin-participant-v30-getaddpartystatusresponse-status) | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusResponse.Status.Disconnected`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto#L180) -- Fields: 2 - -The participant has disconnected from the sequencer channel used for ACS replication. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| disconnect_message | `string` | optional | | -| status_prior_to_disconnect | [`com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusResponse.Status`](#type-com-digitalasset-canton-admin-participant-v30-getaddpartystatusresponse-status) | optional | Prior status is one of ConnectionEstablished or ReplicatingAcs. | - - -**Message `com.digitalasset.canton.admin.participant.v30.GetConfigForSlowCounterParticipantsRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L322) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| synchronizer_ids | `string` | repeated | filters by synchronizers | - - -**Message `com.digitalasset.canton.admin.participant.v30.GetConfigForSlowCounterParticipantsResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L326) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| configs | [`com.digitalasset.canton.admin.participant.v30.SlowCounterParticipantSynchronizerConfig`](#type-com-digitalasset-canton-admin-participant-v30-slowcounterparticipantsynchronizerconfig) | repeated | | - - -**Message `com.digitalasset.canton.admin.participant.v30.GetDarContentsRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L177) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| main_package_id | `string` | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.GetDarContentsResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L181) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| description | [`com.digitalasset.canton.admin.participant.v30.DarDescription`](#type-com-digitalasset-canton-admin-participant-v30-dardescription) | optional | | -| packages | [`com.digitalasset.canton.admin.participant.v30.PackageDescription`](#type-com-digitalasset-canton-admin-participant-v30-packagedescription) | repeated | | - - -**Message `com.digitalasset.canton.admin.participant.v30.GetDarRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L152) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| main_package_id | `string` | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.GetDarResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L163) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| payload | `bytes` | optional | | -| data | [`com.digitalasset.canton.admin.participant.v30.DarDescription`](#type-com-digitalasset-canton-admin-participant-v30-dardescription) | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.GetHighestOffsetByTimestampRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto#L306) -- Fields: 3 - -Requests the highest ledger offset among all events belonging to the synchronizer (`synchronizer_id`) - that have a record time before or at the given `timestamp`. - - This endpoint features a `force` message field. This is intended for disaster recovery scenarios only. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| synchronizer_id | `string` | optional | The identifier of the synchronizer.
Required | -| timestamp | `google.protobuf.Timestamp` | optional | The requested timestamp for which a ledger offset should be found.
Required | -| force | `bool` | optional | If true, return the highest known ledger offset with a record time before or at the specified `timestamp`
even if higher offsets with a record time before or at `timestamp` can be created in the future.
Required, defaults to false. | - - -**Message `com.digitalasset.canton.admin.participant.v30.GetHighestOffsetByTimestampResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto#L321) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| ledger_offset | `int64` | optional | The highest ledger offset among events that have their record time before or at the requested timestamp.
An error when no such offset (yet) exists.
Required | - - -**Message `com.digitalasset.canton.admin.participant.v30.GetIntervalsBehindForCounterParticipantsRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L345) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| counter_participant_ids | `string` | repeated | if empty, all counter-participants are considered | -| synchronizer_ids | `string` | repeated | if empty, all synchronizers are considered | -| threshold | `uint64` | optional | if set, only counter-participants that are behind by at least this number of intervals are returned | - - -**Message `com.digitalasset.canton.admin.participant.v30.GetIntervalsBehindForCounterParticipantsResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L354) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| intervals_behind | [`com.digitalasset.canton.admin.participant.v30.CounterParticipantInfo`](#type-com-digitalasset-canton-admin-participant-v30-counterparticipantinfo) | repeated | | - - -**Message `com.digitalasset.canton.admin.participant.v30.GetPackageContentsRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L70) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| package_id | `string` | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.GetPackageContentsResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L78) -- Fields: 4 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| description | [`com.digitalasset.canton.admin.participant.v30.PackageDescription`](#type-com-digitalasset-canton-admin-participant-v30-packagedescription) | optional | | -| modules | [`com.digitalasset.canton.admin.participant.v30.ModuleDescription`](#type-com-digitalasset-canton-admin-participant-v30-moduledescription) | repeated | | -| is_utility_package | `bool` | optional | | -| language_version | `string` | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.GetPackageReferencesRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L85) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| package_id | `string` | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.GetPackageReferencesResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L89) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| dars | [`com.digitalasset.canton.admin.participant.v30.DarDescription`](#type-com-digitalasset-canton-admin-participant-v30-dardescription) | repeated | | - - -**Message `com.digitalasset.canton.admin.participant.v30.GetResourceLimitsRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/resource_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/resource_management_service.proto#L23) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.participant.v30.GetResourceLimitsResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/resource_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/resource_management_service.proto#L25) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| current_limits | [`com.digitalasset.canton.admin.participant.v30.ResourceLimits`](#type-com-digitalasset-canton-admin-participant-v30-resourcelimits) | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.GetSafePruningOffsetRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto#L81) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| before_or_at | `google.protobuf.Timestamp` | optional | | -| ledger_end | `int64` | optional | | -| counter_participants_commitments_state | [`com.digitalasset.canton.admin.participant.v30.SafeToPruneCommitmentState`](#type-com-digitalasset-canton-admin-participant-v30-safetoprunecommitmentstate) | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.GetSafePruningOffsetResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto#L87) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| safe_pruning_offset | `int64` | optional | | -| no_safe_pruning_offset | [`com.digitalasset.canton.admin.participant.v30.GetSafePruningOffsetResponse.NoSafePruningOffset`](#type-com-digitalasset-canton-admin-participant-v30-getsafepruningoffsetresponse-nosafepruningoffset) | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.GetSafePruningOffsetResponse.NoSafePruningOffset`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto#L88) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.participant.v30.GetSynchronizerIdRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L175) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| synchronizer_alias | `string` | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.GetSynchronizerIdResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L179) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| synchronizer_id | `string` | optional | | -| physical_synchronizer_id | `string` | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.IgnoreEventsRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L275) -- Fields: 4 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| physical_synchronizer_id | `string` | optional | | -| from_inclusive | `int64` | optional | sequencer counter of the first event to ignore | -| to_inclusive | `int64` | optional | sequencer counter of the last event to ignore | -| force | `bool` | optional | allow to proceed even if some clean events have sequencer counter greater or equal than `from_inclusive` | - - -**Message `com.digitalasset.canton.admin.participant.v30.IgnoreEventsResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L285) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.participant.v30.ImportAcsOldRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L162) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| acs_snapshot | `bytes` | optional | The raw binary of the ACS snapshot to be imported
Required | -| workflow_id_prefix | `string` | optional | The synchronizer id prefix to be used for the imported contracts
Optional, if not provided the service will generate a prefix | -| allow_contract_id_suffix_recomputation | `bool` | optional | If false, the service will fail if any contract ID suffix doesn't match the scheme
associated to the synchronizer where the contract is being assigned as a result of the import.
If true, any contract ID suffix will be recomputed to match the scheme associated to the synchronizer.
Recommended value is `false` | - - -**Message `com.digitalasset.canton.admin.participant.v30.ImportAcsOldResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L176) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| contract_id_mapping | `map` | repeated | Mapping from the old contract id to the new contract id | - - -**Message `com.digitalasset.canton.admin.participant.v30.ImportAcsRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L228) -- Fields: 5 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| acs_snapshot | `bytes` | optional | The raw binary of the ACS snapshot to be imported
The binary contents does not align on individual active contracts! It may contain bytes that are part of
an active contract, or include several active contracts - depending on how much data fits into the
configured gRPC message size.
Required | -| workflow_id_prefix | `string` | optional | Custom prefix for the workflow ID to easily identify all transactions generated by this import.
Optional. If left empty, the service will generate a prefix such as `import-<random_UUID>`. | -| contract_import_mode | [`com.digitalasset.canton.admin.participant.v30.ContractImportMode`](#type-com-digitalasset-canton-admin-participant-v30-contractimportmode) | optional | How imported contracts should be validated upon import

NOTE: The representative package IDs assigned to imported contracts must ensure proper type-checking for those contracts.
Importing contracts representative_package_id's that do not type-check may cause unexpected behavior,
including INTERNAL errors on Ledger API read queries or incorrect Daml value representations.
If unsure, perform the ACS import with ContractImportMode set to CONTRACT_IMPORT_MODE_VALIDATION to ensure
that the assigned representative package IDs correctly validate the imported contracts.

Required | -| excluded_stakeholder_ids | `string` | repeated | A list of party IDs to exclude from the import.
Any contract that has one or more of these parties as a stakeholder will be omitted during the import.
Optional | -| representative_package_id_override | [`com.digitalasset.canton.admin.participant.v30.RepresentativePackageIdOverride`](#type-com-digitalasset-canton-admin-participant-v30-representativepackageidoverride) | optional | The representative package ID override rules to be applied during import.

Optional | - - -**Message `com.digitalasset.canton.admin.participant.v30.ImportAcsResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L262) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| contract_id_mappings | `map` | repeated | Maps old contract IDs to newly recomputed contract IDs iff the recomputation contract ID import mode has
been selected, empty otherwise. | - - -**Message `com.digitalasset.canton.admin.participant.v30.ImportPartyAcsRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto#L271) -- Fields: 4 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| acs_snapshot | `bytes` | optional | The raw binary of the ACS snapshot to be imported
The binary content does not align on individual active contracts! It may contain bytes that are part of
an active contract, or include several active contracts - depending on how much data fits into the
configured gRPC message size.
Required | -| workflow_id_prefix | `string` | optional | Custom prefix for the workflow ID to easily identify all transactions generated by this import.
Optional. If left empty, the service will generate a prefix such as `import-<random_UUID>`. | -| contract_import_mode | [`com.digitalasset.canton.admin.participant.v30.ContractImportMode`](#type-com-digitalasset-canton-admin-participant-v30-contractimportmode) | optional | How imported contracts should be validated upon import.

NOTE: The representative package IDs assigned to imported contracts must ensure proper type-checking for those contracts.
Importing contracts representative_package_id's that do not type-check may cause unexpected behavior,
including INTERNAL errors on Ledger API read queries or incorrect Daml value representations.
If unsure, perform the ACS import with ContractImportMode set to CONTRACT_IMPORT_MODE_VALIDATION to ensure
that the assigned representative package IDs correctly validate the imported contracts.

Required | -| representative_package_id_override | [`com.digitalasset.canton.admin.participant.v30.RepresentativePackageIdOverride`](#type-com-digitalasset-canton-admin-participant-v30-representativepackageidoverride) | optional | The representative package ID override rules to be applied during import.

Optional | - - -**Message `com.digitalasset.canton.admin.participant.v30.ImportPartyAcsResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto#L300) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.participant.v30.InspectCommitmentContractsRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L79) -- Fields: 4 - -The participant needs to be authorized to see the requested contracts, for example using JWT authorization - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| cids | `bytes` | repeated | the contracts whose state and payload we want to retrieve | -| expected_synchronizer_id | `string` | optional | the synchronizer on which we expect the contracts to be active | -| timestamp | `google.protobuf.Timestamp` | optional | timestamp at which we retrieve the state of the contracts on the expected synchronizer | -| download_payload | `bool` | optional | whether to retrieve the payload of the contracts | - - -**Message `com.digitalasset.canton.admin.participant.v30.InspectCommitmentContractsResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L90) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| chunk | `bytes` | optional | commitment contracts | - - -**Message `com.digitalasset.canton.admin.participant.v30.Interval`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L195) -- Fields: 2 - -timestamps *do fall* on commitment period boundaries/ticks - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| start_tick_exclusive | `google.protobuf.Timestamp` | optional | | -| end_tick_inclusive | `google.protobuf.Timestamp` | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.ListConnectedSynchronizersRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L163) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.participant.v30.ListConnectedSynchronizersResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L165) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| connected_synchronizers | [`com.digitalasset.canton.admin.participant.v30.ListConnectedSynchronizersResponse.Result`](#type-com-digitalasset-canton-admin-participant-v30-listconnectedsynchronizersresponse-result) | repeated | | - - -**Message `com.digitalasset.canton.admin.participant.v30.ListConnectedSynchronizersResponse.Result`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L166) -- Fields: 4 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| synchronizer_alias | `string` | optional | | -| synchronizer_id | `string` | optional | | -| physical_synchronizer_id | `string` | optional | | -| healthy | `bool` | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.ListDarsRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L168) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| limit | `int32` | optional | | -| filter_name | `string` | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.ListDarsResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L173) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| dars | [`com.digitalasset.canton.admin.participant.v30.DarDescription`](#type-com-digitalasset-canton-admin-participant-v30-dardescription) | repeated | | - - -**Message `com.digitalasset.canton.admin.participant.v30.ListPackagesRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L53) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| limit | `int32` | optional | | -| filter_name | `string` | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.ListPackagesResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L66) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| package_descriptions | [`com.digitalasset.canton.admin.participant.v30.PackageDescription`](#type-com-digitalasset-canton-admin-participant-v30-packagedescription) | repeated | | - - -**Message `com.digitalasset.canton.admin.participant.v30.ListRegisteredSynchronizersRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L117) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.participant.v30.ListRegisteredSynchronizersResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L119) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| results | [`com.digitalasset.canton.admin.participant.v30.ListRegisteredSynchronizersResponse.Result`](#type-com-digitalasset-canton-admin-participant-v30-listregisteredsynchronizersresponse-result) | repeated | | - - -**Message `com.digitalasset.canton.admin.participant.v30.ListRegisteredSynchronizersResponse.Result`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L120) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| config | [`com.digitalasset.canton.admin.participant.v30.SynchronizerConnectionConfig`](#type-com-digitalasset-canton-admin-participant-v30-synchronizerconnectionconfig) | optional | | -| connected | `bool` | optional | | -| physical_synchronizer_id | `string` | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.LogoutRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L184) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| synchronizer_alias | `string` | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.LogoutResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L188) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.participant.v30.LookupOffsetByTimeRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L44) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| timestamp | `google.protobuf.Timestamp` | optional | the timestamp to look up the offset for | - - -**Message `com.digitalasset.canton.admin.participant.v30.LookupOffsetByTimeResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L49) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| offset | `int64` | optional | if specified, the absolute offset as an integer corresponding to the specified timestamp.
if absent, no such offset exists. | - - -**Message `com.digitalasset.canton.admin.participant.v30.LookupReceivedAcsCommitmentsRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L153) -- Fields: 4 - -list the commitments received from counter-participants - optional filtering by synchronizer, time ranges, counter participants, commitment state and verbosity - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| time_ranges | [`com.digitalasset.canton.admin.participant.v30.SynchronizerTimeRange`](#type-com-digitalasset-canton-admin-participant-v30-synchronizertimerange) | repeated | filter specific time ranges per synchronizer
a synchronizer can appear multiple times with various time ranges, in which case we consider the union of the time ranges.
return only the received commitments with an interval overlapping any of the given time ranges per synchronizer
defaults: if empty, all synchronizers known to the participant are considered | -| counter_participant_ids | `string` | repeated | retrieve commitments received from specific counter participants
if a specified counter participant is not a counter-participant in some synchronizer, we do not return it in the response
an empty set means we return commitments received from all counter participants on the synchronizers matching the synchronizer filter. | -| commitment_state | [`com.digitalasset.canton.admin.participant.v30.ReceivedCommitmentState`](#type-com-digitalasset-canton-admin-participant-v30-receivedcommitmentstate) | repeated | filter by commitment state: only return commitments with the states below
if no state is given, we return all commitments | -| verbose | `bool` | optional | include the actual commitment in the response | - - -**Message `com.digitalasset.canton.admin.participant.v30.LookupReceivedAcsCommitmentsResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L178) -- Fields: 1 - -Returns a sequence of commitments for each synchronizer. - Synchronizers should not repeat in the response, otherwise the caller considers the response invalid. - If all commitments received on a synchronizer have been pruned, we return an error. - No streaming, because a response with verbose mode on contains around 1kb to 3kb of data (depending on whether - we ship the LtHash16 bytes directly or just a hash thereof). - Therefore, 1000 commitments fit into a couple of MBs, and we can expect the gRPC admin API to handle messages of - a couple of MBs. - It is the application developer's job to find suitable filter ranges. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| received | [`com.digitalasset.canton.admin.participant.v30.ReceivedAcsCommitmentPerSynchronizer`](#type-com-digitalasset-canton-admin-participant-v30-receivedacscommitmentpersynchronizer) | repeated | | - - -**Message `com.digitalasset.canton.admin.participant.v30.LookupSentAcsCommitmentsRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L261) -- Fields: 4 - -list the commitments computed and sent to counter-participants - optional filtering by synchronizer, time ranges, counter participants, commitment state and verbosity - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| time_ranges | [`com.digitalasset.canton.admin.participant.v30.SynchronizerTimeRange`](#type-com-digitalasset-canton-admin-participant-v30-synchronizertimerange) | repeated | filter specific time ranges per synchronizer
a synchronizer can appear multiple times with various time ranges, in which case we consider the union of the time ranges.
return only the sent commitments with an interval overlapping any of the given time ranges per synchronizer
defaults: if empty, all synchronizers known to the participant are considered | -| counter_participant_ids | `string` | repeated | retrieve commitments sent to specific counter participants
if a specified counter participant is not a counter-participant in some synchronizer, we do not return it in the response
an empty set means we return commitments sent to all counter participants on the synchronizers matching the synchronizer filter. | -| commitment_state | [`com.digitalasset.canton.admin.participant.v30.SentCommitmentState`](#type-com-digitalasset-canton-admin-participant-v30-sentcommitmentstate) | repeated | filter by commitment state: only return commitments with the states below
if no state is given, we return all commitments | -| verbose | `bool` | optional | include the actual commitment in the response | - - -**Message `com.digitalasset.canton.admin.participant.v30.LookupSentAcsCommitmentsResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L286) -- Fields: 1 - -Returns a sequence of commitments for each synchronizer. - Synchronizers should not repeat in the response, otherwise the caller considers the response invalid. - If all commitments sent on a synchronizer have been pruned, we return an error. - No streaming, because a response with verbose mode on contains around 1kb to 3kb of data (depending on whether - we ship the LtHash16 bytes directly or just a hash thereof). - Therefore, 1000 commitments fit into a couple of MBs, and we can expect the gRPC admin API to handle messages of - a couple of MBs. - It is the application developer's job to find suitable filter ranges. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| sent | [`com.digitalasset.canton.admin.participant.v30.SentAcsCommitmentPerSynchronizer`](#type-com-digitalasset-canton-admin-participant-v30-sentacscommitmentpersynchronizer) | repeated | | - - -**Message `com.digitalasset.canton.admin.participant.v30.MigrateSynchronizerRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L103) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| source_synchronizer_alias | `string` | optional | Alias of the synchronizer to which the contracts are currently assigned
Required | -| target_synchronizer_connection_config | [`com.digitalasset.canton.admin.participant.v30.SynchronizerConnectionConfig`](#type-com-digitalasset-canton-admin-participant-v30-synchronizerconnectionconfig) | optional | Configuration to connect to the synchronizer on which the contracts will be assigned as a result of the migration
Required | -| force | `bool` | optional | Whether to force the migration in spite of risking a potential ledger fork
Recommended value is `false` | - - -**Message `com.digitalasset.canton.admin.participant.v30.MigrateSynchronizerResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L115) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.participant.v30.ModifySynchronizerRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L107) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| physical_synchronizer_id | `string` | optional | If empty, the request will update the single active connection for the alias in `new_config` | -| new_config | [`com.digitalasset.canton.admin.participant.v30.SynchronizerConnectionConfig`](#type-com-digitalasset-canton-admin-participant-v30-synchronizerconnectionconfig) | optional | | -| sequencer_connection_validation | [`com.digitalasset.canton.admin.sequencer.v30.SequencerConnectionValidation`](com-digitalasset-canton-admin-sequencer-v30#type-com-digitalasset-canton-admin-sequencer-v30-sequencerconnectionvalidation) | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.ModifySynchronizerResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L115) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.participant.v30.ModuleDescription`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L74) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| name | `string` | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.OpenCommitmentRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L55) -- Fields: 4 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| commitment | `bytes` | optional | the commitment to be opened | -| physical_synchronizer_id | `string` | optional | | -| computed_for_counter_participant_uid | `string` | optional | the participant for whom the receiving participant computed the commitment | -| period_end_tick | `google.protobuf.Timestamp` | optional | interval end tick which the commitment corresponds to | - - -**Message `com.digitalasset.canton.admin.participant.v30.OpenCommitmentResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L65) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| chunk | `bytes` | optional | commitment contracts metadata | - - -**Message `com.digitalasset.canton.admin.participant.v30.PackageDescription`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L58) -- Fields: 5 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| package_id | `string` | optional | | -| name | `string` | optional | | -| version | `string` | optional | | -| uploaded_at | `google.protobuf.Timestamp` | optional | | -| size | `uint32` | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.ParticipantStatusRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_status_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_status_service.proto#L14) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.participant.v30.ParticipantStatusResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_status_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_status_service.proto#L27) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| status | [`com.digitalasset.canton.admin.participant.v30.ParticipantStatusResponse.ParticipantStatusResponseStatus`](#type-com-digitalasset-canton-admin-participant-v30-participantstatusresponse-participantstatusresponsestatus) | optional | | -| not_initialized | [`com.digitalasset.canton.admin.health.v30.NotInitialized`](com-digitalasset-canton-admin-health-v30#type-com-digitalasset-canton-admin-health-v30-notinitialized) | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.ParticipantStatusResponse.ParticipantStatusResponseStatus`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_status_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_status_service.proto#L33) -- Fields: 4 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| common_status | [`com.digitalasset.canton.admin.health.v30.Status`](com-digitalasset-canton-admin-health-v30#type-com-digitalasset-canton-admin-health-v30-status) | optional | | -| connected_synchronizers | [`com.digitalasset.canton.admin.participant.v30.ConnectedSynchronizer`](#type-com-digitalasset-canton-admin-participant-v30-connectedsynchronizer) | repeated | | -| active | `bool` | optional | Indicate if the participant node is active
True if the participant node is replicated and is the active replica, or true if not replicated | -| supported_protocol_versions | `int32` | repeated | Protocol versions which this node supports
Take into account config parameters such as alpha/beta version support and minimum protocol version | - - -**Message `com.digitalasset.canton.admin.participant.v30.PingFailure`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/ping_pong_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/ping_pong_service.proto#L29) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| reason | `string` | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.PingRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/ping_pong_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/ping_pong_service.proto#L14) -- Fields: 7 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| target_parties | `string` | repeated | | -| validators | `string` | repeated | | -| timeout | `google.protobuf.Duration` | optional | | -| levels | `uint32` | optional | | -| synchronizer_id | `string` | optional | optional | -| workflow_id | `string` | optional | optional | -| id | `string` | optional | optional UUID to be used for ping test | - - -**Message `com.digitalasset.canton.admin.participant.v30.PingResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/ping_pong_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/ping_pong_service.proto#L33) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| success | [`com.digitalasset.canton.admin.participant.v30.PingSuccess`](#type-com-digitalasset-canton-admin-participant-v30-pingsuccess) | optional | | -| failure | [`com.digitalasset.canton.admin.participant.v30.PingFailure`](#type-com-digitalasset-canton-admin-participant-v30-pingfailure) | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.PingSuccess`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/ping_pong_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/ping_pong_service.proto#L24) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| ping_time | `uint64` | optional | | -| responder | `string` | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.PruneRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto#L71) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| prune_up_to | `int64` | optional | Inclusive offset up to which the ledger is to be pruned. | -| counter_participants_commitments_state | [`com.digitalasset.canton.admin.participant.v30.SafeToPruneCommitmentState`](#type-com-digitalasset-canton-admin-participant-v30-safetoprunecommitmentstate) | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.PruneResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto#L77) -- Fields: 0 - -Empty for now, but may contain fields in the future - - -**Message `com.digitalasset.canton.admin.participant.v30.PurgeContractsRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L62) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| synchronizer_alias | `string` | optional | Alias of the synchronizer to which the contracts are currently assigned
Required | -| contract_ids | `string` | repeated | Contracts to be purged
Required | -| ignore_already_purged | `bool` | optional | If true, will ignore already purged contract; if false, will return an error if a contract is already purged
Useful re-run the same request in case of failure in an idempotent fashion
Recommended value is `true` | - - -**Message `com.digitalasset.canton.admin.participant.v30.PurgeContractsResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L77) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.participant.v30.PurgeDeactivatedSynchronizerRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L268) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| synchronizer_alias | `string` | optional | Alias of the deactivated synchronizer to purge data from | - - -**Message `com.digitalasset.canton.admin.participant.v30.PurgeDeactivatedSynchronizerResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L273) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.participant.v30.ReassignmentId`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/reassignment_id.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/reassignment_id.proto#L8) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| id | `string` | optional | identifies the reassignment batch, built from a hash of source, target, contract ids, contract counters and timestamp. | - - -**Message `com.digitalasset.canton.admin.participant.v30.ReceivedAcsCommitment`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L200) -- Fields: 5 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| interval | [`com.digitalasset.canton.admin.participant.v30.Interval`](#type-com-digitalasset-canton-admin-participant-v30-interval) | optional | | -| origin_counter_participant_uid | `string` | optional | the counter participant that computed and sent the commitment, from whom the current participant received the commitment | -| received_commitment | `bytes` | optional | the commitment received from the counter participant, unsigned because the admin trusts own participant's reply
populated only if verbose mode is on | -| own_commitment | `bytes` | optional | own commitment of participant that was compared with the received commitment, unsigned because the admin trusts own participant's reply
populated only in case there is a mismatch and verbose mode is on
might not correspond to the same interval as the received commitment, however, the matching timestamp is the end of
the returned interval | -| state | [`com.digitalasset.canton.admin.participant.v30.ReceivedCommitmentState`](#type-com-digitalasset-canton-admin-participant-v30-receivedcommitmentstate) | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.ReceivedAcsCommitmentPerSynchronizer`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L215) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| synchronizer_id | `string` | optional | | -| received | [`com.digitalasset.canton.admin.participant.v30.ReceivedAcsCommitment`](#type-com-digitalasset-canton-admin-participant-v30-receivedacscommitment) | repeated | | - - -**Message `com.digitalasset.canton.admin.participant.v30.ReconnectSynchronizerRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L128) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| synchronizer_alias | `string` | optional | | -| retry | `bool` | optional | if retry is set to true, we will keep on retrying if the synchronizer is unavailable | - - -**Message `com.digitalasset.canton.admin.participant.v30.ReconnectSynchronizerResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L134) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| connected_successfully | `bool` | optional | true if the synchronizer is connected, false if the synchronizer is offline, exception on any other error | - - -**Message `com.digitalasset.canton.admin.participant.v30.ReconnectSynchronizersRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L72) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| ignore_failures | `bool` | optional | if set to true, the connection attempt will succeed even if one of the connection attempts failed | - - -**Message `com.digitalasset.canton.admin.participant.v30.ReconnectSynchronizersResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L76) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.participant.v30.RegisterSynchronizerRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L79) -- Fields: 3 - -* Register connection configuration of a new synchronizer - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| config | [`com.digitalasset.canton.admin.participant.v30.SynchronizerConnectionConfig`](#type-com-digitalasset-canton-admin-participant-v30-synchronizerconnectionconfig) | optional | | -| synchronizer_connection | [`com.digitalasset.canton.admin.participant.v30.RegisterSynchronizerRequest.SynchronizerConnection`](#type-com-digitalasset-canton-admin-participant-v30-registersynchronizerrequest-synchronizerconnection) | optional | Whether requests to the synchronizer are made | -| sequencer_connection_validation | [`com.digitalasset.canton.admin.sequencer.v30.SequencerConnectionValidation`](com-digitalasset-canton-admin-sequencer-v30#type-com-digitalasset-canton-admin-sequencer-v30-sequencerconnectionvalidation) | optional | Determines how well the provided sequencer connections should be validated before they are
persisted. The more paranoid the validation, the higher the chance of the command failing,
as it will require the sequencer to be online and responsive. | - - -**Enum `com.digitalasset.canton.admin.participant.v30.RegisterSynchronizerRequest.SynchronizerConnection`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L80) - -_No description._ - -| Name | Number | -| --- | --- | -| SYNCHRONIZER_CONNECTION_UNSPECIFIED | `0` | -| SYNCHRONIZER_CONNECTION_NONE | `1` | -| SYNCHRONIZER_CONNECTION_HANDSHAKE | `2` | - - -**Message `com.digitalasset.canton.admin.participant.v30.RegisterSynchronizerResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L105) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.participant.v30.RemoveDarRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L146) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| main_package_id | `string` | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.RemoveDarResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L150) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.participant.v30.RemovePackageRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L93) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| package_id | `string` | optional | | -| force | `bool` | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.RemovePackageResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L98) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| success | `google.protobuf.Empty` | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.RepairCommitmentsStatus`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L340) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| synchronizer_id | `string` | optional | | -| error_message | `string` | optional | | -| completed_repair_timestamp | `google.protobuf.Timestamp` | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.RepairCommitmentsUsingAcsRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L318) -- Fields: 4 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| synchronizer_ids | `string` | repeated | The IDs of the synchronizers where to reinitialize commitments from ACS
If empty, we reinitialize commitments for all synchronizers | -| counter_participant_ids | `string` | repeated | Reinitialize commitments only for the given counter-participant
If empty, we reinitialize commitments for all counter-participants | -| party_ids | `string` | repeated | Reinitialize commitments only for the stakeholder groups containing the given parties
If empty, we reinitialize commitments for all stakeholder groups | -| timeout_seconds | `google.protobuf.Duration` | optional | The timeout to wait for command to return success
The success status can also be queried later using the `CommitmentsService` | - - -**Message `com.digitalasset.canton.admin.participant.v30.RepairCommitmentsUsingAcsResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L336) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| statuses | [`com.digitalasset.canton.admin.participant.v30.RepairCommitmentsStatus`](#type-com-digitalasset-canton-admin-participant-v30-repaircommitmentsstatus) | repeated | | - - -**Message `com.digitalasset.canton.admin.participant.v30.RepresentativePackageIdOverride`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/acs_import.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/acs_import.proto#L22) -- Fields: 3 - -Defines override mappings for assigning representative package IDs to contracts upon ACS import. - - The representative package ID is assigned to a contract upon ACS import based on the following precedence rules. - 1. The associated override for the contract ID in RepresentativePackageIdOverride.contract_override, if specified and present in the package store - 2. The associated override for the contract's original package ID in RepresentativePackageIdOverride.package_id_override, if specified and present in the package store - 3. The contract's representative package ID from the ACS snapshot, if present in the package store - 4. The contract's creation package ID, if present in the package store - 5. The associated override for the contract's package name in RepresentativePackageIdOverride.package_name_override, if specified and present in the package store - 6. The highest-versioned package in the participant's package store for the contract's package name - - If none of the above rules yield a representative package ID, the ACS import request will fail. - - See ``CreatedEvent.representative_package_id`` in ``event.proto`` for more details on the concept of - representative package IDs. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| contract_override | `map` | repeated | Mapping from contract ID to the target representative package ID.
Only contracts with IDs matching the keys in this map are affected. | -| package_id_override | `map` | repeated | Mapping from a contract's original package IDs (either the creation or the representative package ID) to the target representative package ID.
Affects only contracts with creation or representative package IDs matching the keys in this map,
except if they're not already affected by `contract_override`. | -| package_name_override | `map` | repeated | Mapping from any contract's package name to the target representative package ID
Affects only contracts with package names matching the keys in this map,
except if they're already affected by `contract_override` or `package_id_override`. | - - -**Message `com.digitalasset.canton.admin.participant.v30.ResourceLimits`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/resource_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/resource_management_service.proto#L29) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| max_inflight_validation_requests | `uint32` | optional | The maximum number of inflight validation requests.
A negative value indicates that there is no limit. | -| max_submission_rate | `uint32` | optional | The maximum rate of command submissions through the ledger api.
A negative value indicates that there is no limit. | -| max_submission_burst_factor | `double` | optional | The maximum burst acceptable (factor > 0) before
steady state throttling kicks in. | - - -**Message `com.digitalasset.canton.admin.participant.v30.RollbackUnassignmentRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L299) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| reassignment_id | `string` | optional | The ID of the unassignment.
Must be a valid LedgerString (as described in ``value.proto``).
Required | -| source_synchronizer_id | `string` | optional | The ID of the source synchronizer
Must be a valid synchronizer id
Required | -| target_synchronizer_id | `string` | optional | The ID of the target synchronizer
Must be a valid synchronizer id
Required | - - -**Message `com.digitalasset.canton.admin.participant.v30.RollbackUnassignmentResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L316) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.participant.v30.SentAcsCommitment`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L231) -- Fields: 5 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| interval | [`com.digitalasset.canton.admin.participant.v30.Interval`](#type-com-digitalasset-canton-admin-participant-v30-interval) | optional | | -| dest_counter_participant_uid | `string` | optional | the counter participant to whom we sent the commitment | -| own_commitment | `bytes` | optional | own computed commitment sent to counter participant, unsigned because the admin trusts own participant's reply
populated only if verbose mode is on | -| received_commitment | `bytes` | optional | commitment of the counter participant that was compared with own commitment, unsigned because the admin trusts own participant's reply
populated only in case there is a mismatch and verbose mode is on
might not correspond to the same interval as the sent commitment, however, the mismatch timestamp is the end of
the returned interval | -| state | [`com.digitalasset.canton.admin.participant.v30.SentCommitmentState`](#type-com-digitalasset-canton-admin-participant-v30-sentcommitmentstate) | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.SentAcsCommitmentPerSynchronizer`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L246) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| synchronizer_id | `string` | optional | | -| sent | [`com.digitalasset.canton.admin.participant.v30.SentAcsCommitment`](#type-com-digitalasset-canton-admin-participant-v30-sentacscommitment) | repeated | | - - -**Message `com.digitalasset.canton.admin.participant.v30.SetConfigForSlowCounterParticipantsRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L314) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| configs | [`com.digitalasset.canton.admin.participant.v30.SlowCounterParticipantSynchronizerConfig`](#type-com-digitalasset-canton-admin-participant-v30-slowcounterparticipantsynchronizerconfig) | repeated | we can specify multiple configurations, each being applied to one or more synchronizers
if the synchronizer ids in the different configs overlap, the latest config in the order of the "configs" takes precedence | - - -**Message `com.digitalasset.canton.admin.participant.v30.SetConfigForSlowCounterParticipantsResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L320) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.participant.v30.SetPassiveRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/enterprise_participant_replication_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/enterprise_participant_replication_service.proto#L12) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.participant.v30.SetPassiveResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/enterprise_participant_replication_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/enterprise_participant_replication_service.proto#L13) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.participant.v30.SetResourceLimitsRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/resource_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/resource_management_service.proto#L17) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| new_limits | [`com.digitalasset.canton.admin.participant.v30.ResourceLimits`](#type-com-digitalasset-canton-admin-participant-v30-resourcelimits) | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.SetResourceLimitsResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/resource_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/resource_management_service.proto#L21) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.participant.v30.SlowCounterParticipantSynchronizerConfig`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L301) -- Fields: 5 - -The configuration concerns the following metrics, issued per synchronizer; -threshold_distinguished & threshold_default are overwritten, distinguished_participant_uids & participant_uids_metrics is additive: -- The maximum number of intervals that a distinguished participant falls behind -- The maximum number of intervals that a participant in the "default" group falls behind -- The number of participants in the distinguished group that are behind by at least `thresholdDistinguished` -reconciliation intervals. -- The number of participants in the "default" group that are behind by at least `thresholdDefault` -reconciliation intervals. -- Selected participants for which we publish independent metrics counting how many intervals they are behind - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| synchronizer_ids | `string` | repeated | the synchronizers for which we apply the settings below | -| distinguished_participant_uids | `string` | repeated | all non-distinguished counter-participants are implicitly part of the group "default" | -| threshold_distinguished | `uint64` | optional | the number of reconciliation intervals for a distinguished counter-participant to be considered slow | -| threshold_default | `uint64` | optional | the number of reconciliation intervals for an "other" counter-participant to be considered slow | -| participant_uids_metrics | `string` | repeated | participants for which we publish independent metrics counting how many intervals they are behind | - - -**Message `com.digitalasset.canton.admin.participant.v30.SynchronizerConnectionConfig`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/synchronizer_connectivity.proto#L50) -- Fields: 9 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| synchronizer_alias | `string` | optional | participant local identifier of the target synchronizer | -| sequencer_connections | [`com.digitalasset.canton.admin.sequencer.v30.SequencerConnections`](com-digitalasset-canton-admin-sequencer-v30#type-com-digitalasset-canton-admin-sequencer-v30-sequencerconnections) | optional | connection information to sequencers | -| manual_connect | `bool` | optional | if false, then the synchronizer needs to be manually connected to (default false) | -| physical_synchronizer_id | `string` | optional | optional physical synchronizer id (if TLS isn't to be trusted) | -| priority | `int32` | optional | optional. Influences whether the participant submits to this synchronizer, if several synchronizers are eligible | -| initial_retry_delay | `google.protobuf.Duration` | optional | initial delay before an attempt to reconnect to the sequencer | -| max_retry_delay | `google.protobuf.Duration` | optional | maximum delay before an attempt to reconnect to the sequencer | -| time_tracker | [`com.digitalasset.canton.admin.time.v30.SynchronizerTimeTrackerConfig`](com-digitalasset-canton-admin-time-v30#type-com-digitalasset-canton-admin-time-v30-synchronizertimetrackerconfig) | optional | configuration for how time is tracked and requested on this synchronizer | -| initialize_from_trusted_synchronizer | `bool` | optional | If true, allows a participant to connect to a synchronizer that it was previously connected to,
without issuing a new synchronizer trust certificate. | - - -**Message `com.digitalasset.canton.admin.participant.v30.SynchronizerTimeRange`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L188) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| synchronizer_id | `string` | optional | | -| interval | [`com.digitalasset.canton.admin.participant.v30.TimeRange`](#type-com-digitalasset-canton-admin-participant-v30-timerange) | optional | optional; if not given, the latest reconciliation period the participant knows of for that synchronizer is considered | - - -**Message `com.digitalasset.canton.admin.participant.v30.TimeRange`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L183) -- Fields: 2 - -timestamps *do not* have to fall on commitment period boundaries/ticks - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| from_exclusive | `google.protobuf.Timestamp` | optional | | -| to_inclusive | `google.protobuf.Timestamp` | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.TrafficControlStateRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/traffic_control_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/traffic_control_service.proto#L15) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| synchronizer_id | `string` | optional | Synchronizer id for which to retrieve the traffic state | - - -**Message `com.digitalasset.canton.admin.participant.v30.TrafficControlStateResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/traffic_control_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/traffic_control_service.proto#L19) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| traffic_state | [`com.digitalasset.canton.admin.participant.v30.TrafficState`](#type-com-digitalasset-canton-admin-participant-v30-trafficstate) | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.TrafficState`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/traffic_control_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/traffic_control_service.proto#L25) -- Fields: 6 - -Traffic state of a member at a given timestamp - This is a clone of the TrafficState message in sequencing.proto - We have to duplicate it here because the admin API protos are self contained and do not depend on the sequencer API protos - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| extra_traffic_purchased | `int64` | optional | Total amount of extra traffic purchased | -| extra_traffic_consumed | `int64` | optional | Total amount of extra traffic consumed | -| base_traffic_remainder | `int64` | optional | Amount of base traffic remaining | -| last_consumed_cost | `uint64` | optional | Cost deducted at `timestamp`, only present when traffic was consumed at `timestamp`, otherwise is set to 0 | -| timestamp | `int64` | optional | Timestamp at which the state is valid | -| serial | `uint32` | optional | Optional serial of the balance update that updated the extra traffic limit | - - -**Message `com.digitalasset.canton.admin.participant.v30.UnignoreEventsRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L287) -- Fields: 4 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| physical_synchronizer_id | `string` | optional | | -| from_inclusive | `int64` | optional | sequencer counter of the first event to unignore | -| to_inclusive | `int64` | optional | sequencer counter of the last event to unignore | -| force | `bool` | optional | allow to proceed even if some clean events have sequencer counter greater or equal than `from_inclusive` | - - -**Message `com.digitalasset.canton.admin.participant.v30.UnignoreEventsResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_repair_service.proto#L297) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.participant.v30.UnvetDarRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L198) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| main_package_id | `string` | optional | | -| synchronizer_id | `string` | optional | the synchronizer on which to unvet the package.
can be omitted if the participant is connected to only one synchronizer. | - - -**Message `com.digitalasset.canton.admin.participant.v30.UnvetDarResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L205) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.participant.v30.UploadDarRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L117) -- Fields: 4 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| dars | [`com.digitalasset.canton.admin.participant.v30.UploadDarRequest.UploadDarData`](#type-com-digitalasset-canton-admin-participant-v30-uploaddarrequest-uploaddardata) | repeated | | -| vet_all_packages | `bool` | optional | If set to true (default), the node will register the vetting topology
transactions on the specified synchronizer or autodetect the synchronizer
if the participant is only connected to a single one. If multiple
synchronizers are connected and no synchronizer is specified, the request
returns a PACKAGE_SERVICE_CANNOT_AUTODETECT_SYNCHRONIZER error. | -| synchronize_vetting | `bool` | optional | If set to true, we'll wait until the vetting transaction has been observed
by this participant for the target synchronizer. | -| synchronizer_id | `string` | optional | Used to specify the synchronizer to vet packages on when vet_all_packages
is true. | - - -**Message `com.digitalasset.canton.admin.participant.v30.UploadDarRequest.UploadDarData`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L118) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| bytes | `bytes` | optional | | -| description | `string` | optional | | -| expected_main_package_id | `string` | optional | optionally the expected package id of the main package | - - -**Message `com.digitalasset.canton.admin.participant.v30.UploadDarResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L142) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| dar_ids | `string` | repeated | | - - -**Message `com.digitalasset.canton.admin.participant.v30.ValidateDarRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L104) -- Fields: 3 - -Performs the same checks that UploadDarRequest would perform, but doesn't - upload the DAR. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| data | `bytes` | optional | | -| filename | `string` | optional | | -| synchronizer_id | `string` | optional | Used to specify the synchronizer on which to validate that vetting is
correct. | - - -**Message `com.digitalasset.canton.admin.participant.v30.ValidateDarResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L113) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| main_package_id | `string` | optional | | - - -**Message `com.digitalasset.canton.admin.participant.v30.VetDarRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L186) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| main_package_id | `string` | optional | | -| synchronize | `bool` | optional | if set to true, the API call waits until the vetting transaction has been
observed by this participant on the specified synchronizer. | -| synchronizer_id | `string` | optional | the synchronizer on which to vet the package.
can be omitted if the participant is connected to only one synchronizer. | - - -**Message `com.digitalasset.canton.admin.participant.v30.VetDarResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/package_service.proto#L196) -- Fields: 0 - -_No description._ - - -**Enum `com.digitalasset.canton.admin.participant.v30.ContractImportMode`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/acs_import.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/acs_import.proto#L38) - -_No description._ - -| Name | Number | -| --- | --- | -| CONTRACT_IMPORT_MODE_UNSPECIFIED | `0` | -| CONTRACT_IMPORT_MODE_ACCEPT | `1` | -| CONTRACT_IMPORT_MODE_VALIDATION | `2` | -| CONTRACT_IMPORT_MODE_RECOMPUTATION | `3` | - - -**Enum `com.digitalasset.canton.admin.participant.v30.ParticipantPermission`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/party_management_service.proto#L215) - -Enum indicating the permission level of the party on the target participant. - Refer to topology.proto:`ParticipantPermission` for definitions. - -| Name | Number | -| --- | --- | -| PARTICIPANT_PERMISSION_UNSPECIFIED | `0` | -| PARTICIPANT_PERMISSION_SUBMISSION | `1` | -| PARTICIPANT_PERMISSION_CONFIRMATION | `2` | -| PARTICIPANT_PERMISSION_OBSERVATION | `3` | - - -**Enum `com.digitalasset.canton.admin.participant.v30.ReceivedCommitmentState`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L220) - -_No description._ - -| Name | Number | -| --- | --- | -| RECEIVED_COMMITMENT_STATE_UNSPECIFIED | `0` | -| RECEIVED_COMMITMENT_STATE_MATCH | `1` | -| RECEIVED_COMMITMENT_STATE_MISMATCH | `2` | -| RECEIVED_COMMITMENT_STATE_BUFFERED | `3` | -| RECEIVED_COMMITMENT_STATE_OUTSTANDING | `4` | - - -**Enum `com.digitalasset.canton.admin.participant.v30.SafeToPruneCommitmentState`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/pruning_service.proto#L106) - -The states ensure that, once a timestamp is seen as safe to prune, it cannot later be seen as unsafe to prune. - For this, we assume that the outstanding periods table ensures that a period's state can only be outstanding, mismatch, match: - - Match supersedes all other states and cannot be changed - - Mismatch can only change to match - - Outstanding can change to any other state - Therefore, in state SAFE_TO_PRUNE_COMMITMENT_STATE_NONE, we declare a state safe to prune because periods are a match, which can never change - In state SAFE_TO_PRUNE_COMMITMENT_STATE_MATCH_MISMATCH, a state match cannot change later, and a mismatch can only change to a match, - which is covered by the state. Therefore, an affirmative pruning decision for a timestamp cannot change later. - A similar argument can be made for SAFE_TO_PRUNE_COMMITMENT_STATE_ALL. - -| Name | Number | -| --- | --- | -| SAFE_TO_PRUNE_COMMITMENT_STATE_UNSPECIFIED | `0` | -| SAFE_TO_PRUNE_COMMITMENT_STATE_MATCH | `1` | -| SAFE_TO_PRUNE_COMMITMENT_STATE_MATCH_MISMATCH | `2` | -| SAFE_TO_PRUNE_COMMITMENT_STATE_ALL | `3` | - - -**Enum `com.digitalasset.canton.admin.participant.v30.SentCommitmentState`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/participant_inspection_service.proto#L251) +Service to retrieve information about the traffic state of the participant. -_No description._ -| Name | Number | -| --- | --- | -| SENT_COMMITMENT_STATE_UNSPECIFIED | `0` | -| SENT_COMMITMENT_STATE_MATCH | `1` | -| SENT_COMMITMENT_STATE_MISMATCH | `2` | -| SENT_COMMITMENT_STATE_NOT_COMPARED | `3` | +
+ +
+
Source file
+
community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/participant/v30/traffic_control_service.proto
+
+ +
+
Operations
+
1
+
+ +
+ + +
+ + + + +
+

TrafficControlService.TrafficControlState

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc TrafficControlService.TrafficControlState(com.digitalasset.canton.admin.participant.v30.TrafficControlStateRequest) returns (com.digitalasset.canton.admin.participant.v30.Tr...

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.participant.v30.TrafficControlStateRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.participant.v30.TrafficControlStateResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## Type Inventory + + +These are the package-level message and enum shapes in the publish-version snapshot. + + + + +
+
+

com.digitalasset.canton.admin.participant.v30.ActiveContract

+ +

1 fields

+ +
+ +

Schema definition for the exported active contract

+ + +
+ +
+
+ active_contract + bytes + +
+ +
Opaque active contract, assumed to be the bytes of a LAPI active contract Required
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ActiveContractOld

+ +

3 fields

+ +
+ +

TODO(#24610) – Remove; replaced by the new ActiveContract that uses LAPI active contract Schema definition for the exported ACS snapshot

+ + +
+ +
+
+ synchronizer_id + string + +
+ +
The ID of the synchronizer where the contract was assigned at the time of the export Required
+ +
+ +
+
+ contract + Contract + +
+ +
The contract and its associated metadata Required
+ +
+ +
+
+ reassignment_counter + int64 + +
+ +
The number of times the contract has been reassigned at the time of the export Required
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.Contract

+ +

5 fields

+ +
+ + +
+ +
+
+ contract_id + string + +
+ +
+ +
+
+ raw_contract_instance + bytes + +
+ +
+ +
+
+ metadata + Metadata + +
+ +
+ +
+
+ ledger_create_time + Timestamp + +
+ +
in microseconds of UTC time since Unix epoch
+ +
+ +
+
+ authentication_data + bytes + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.Contract.Metadata

+ +

4 fields

+ +
+ + +
+ +
+
+ non_maintainer_signatories + repeated string + +
+ +
+ +
+
+ non_signatory_stakeholders + repeated string + +
+ +
+ +
+
+ key + GlobalKey + +
+ +
optional: only set if contract has a key
+ +
+ +
+
+ maintainers + repeated string + +
+ +
optional; only set if contract has a key
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.Contract.GlobalKey

+ +

3 fields

+ +
+ + +
+ +
+
+ template_id + bytes + +
+ +
+ +
+
+ key + bytes + +
+ +
+ +
+
+ package_name + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.AddPartyAsyncRequest

+ +

5 fields

+ +
+ + +
+ +
+
+ party_id + string + +
+ +
The party to replicate Required
+ +
+ +
+
+ synchronizer_id + string + +
+ +
The synchronizer in which to replicate the party Required
+ +
+ +
+
+ source_participant_uid + string + +
+ +
A source participant already hosting the party Required
+ +
+ +
+
+ topology_serial + uint32 + +
+ +
The topology serial number of the PartyToParticipant topology transaction used to add the party to this target participant. Required
+ +
+ +
+
+ participant_permission + ParticipantPermission + +
+ +
The permission level of the party on the target participant. Required
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ParticipantPermission

+ +

4 values

+ +
+ +

Enum indicating the permission level of the party on the target participant. Refer to topology.proto:`ParticipantPermission` for definitions.

+ + + +
    + +
  • PARTICIPANT_PERMISSION_UNSPECIFIED
    • + +
  • PARTICIPANT_PERMISSION_SUBMISSION
    • + +
  • PARTICIPANT_PERMISSION_CONFIRMATION
    • + +
  • PARTICIPANT_PERMISSION_OBSERVATION
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.AddPartyAsyncResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ add_party_request_id + string + +
+ +
The identifier used to uniquely track the add party request.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ChangeAssignationRequest

+ +

4 fields

+ +
+ + +
+ +
+
+ source_synchronizer_alias + string + +
+ +
Alias of the synchronizer to which the contracts are currently assigned Required
+ +
+ +
+
+ target_synchronizer_alias + string + +
+ +
New assignation Required
+ +
+ +
+
+ skip_inactive + bool + +
+ +
Whether to skip inactive contracts. Default: true.
+ +
+ +
+
+ contracts + repeated Contract + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ChangeAssignationRequest.Contract

+ +

2 fields

+ +
+ + +
+ +
+
+ id + string + +
+ +
+ +
+
+ reassignment_counter_override + int64 + +
+ +
By default, reassignment counter will be increased by 1 This can be overridden by a non-empty value.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ChangeAssignationResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ClearPartyOnboardingFlagRequest

+ +

4 fields

+ +
+ + +
+ +
+
+ party_id + string + +
+ +
The identifier of the party whose onboarding flag is being cleared. This party must already be active on the target participant. Required
+ +
+ +
+
+ synchronizer_id + string + +
+ +
The identifier of the synchronizer. Required
+ +
+ +
+
+ begin_offset_exclusive + int64 + +
+ +
The exclusive ledger offset used as a starting point to find the party's most recent activation on the target participant. Required
+ +
+ +
+
+ wait_for_activation_timeout + Duration + +
+ +
The maximum duration the service will wait to find the topology transaction that activates the party. If not set, the service will use a default timeout. Optional
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ClearPartyOnboardingFlagResponse

+ +

2 fields

+ +
+ +

Responds with the current status: - Cleared: (true, None) – The flag is successfully cleared. - Pending: (false, Some(timestamp)) – The flag is still set. The timestamp indicates the earliest safe time to clear the flag. Calling the service (repeatedly) after that specific time will eventually confirm that the onboarding flag has been cleared (that is `onboarded = true`). The onboarding flag remains for two reasons: 1. The safe time to clear the flag has not yet been reached. 2. The clearing transaction was proposed, but it has not yet become effective.

+ + +
+ +
+
+ onboarded + bool + +
+ +
Indicates the current party onboarding status. Required
+ +
+ +
+
+ earliest_retry_timestamp + Timestamp + +
+ +
The earliest time for the safe clearance of the onboarding flag. This field is only present when `onboarded` is `false`.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.CommitmentContract

+ +

4 fields

+ +
+ + +
+ +
+
+ cid + bytes + +
+ +
+ +
+
+ active_on_expected_synchronizer + bool + +
+ +
+ +
+
+ contract + bytes + +
+ +
Encoded ContractInstance
+ +
+ +
+
+ states + repeated SynchronizerState + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ContractState.SynchronizerState

+ +

6 fields

+ +
+ + +
+ +
+
+ synchronizer_id + string + +
+ +
+ +
+
+ created + Created + +
+ +
+ +
+
+ archived + Archived + +
+ +
+ +
+
+ unassigned + Unassigned + +
+ +
+ +
+
+ assigned + Assigned + +
+ +
+ +
+
+ unknown + Unknown + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ContractState.Created

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ContractState.Archived

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ContractState.Unassigned

+ +

3 fields

+ +
+ + +
+ +
+
+ target_synchronizer_id + string + +
+ +
+ +
+
+ reassignment_counter_src + int64 + +
+ +
+ +
+
+ reassignment_id + ReassignmentId + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ContractState.ReassignmentId

+ +

1 fields

+ +
+ + +
+ +
+
+ id + string + +
+ +
identifies the reassignment batch, built from a hash of source, target, contract ids, contract counters and timestamp.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ContractState.Assigned

+ +

2 fields

+ +
+ + +
+ +
+
+ reassignment_counter_target + int64 + +
+ +
+ +
+
+ reassignment_id + ReassignmentId + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ContractState.Unknown

+ +

0 fields

+ +
+ +

the contract is unknown to the synchronizer, but may have existed in the past and have been pruned meanwhile

+ + + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.CommitmentContractMeta

+ +

2 fields

+ +
+ +

Contract ids (cids) need to be authenticated, otherwise the cid does not uniquely identify the stakeholders and the contract hash

+ + +
+ +
+
+ cid + bytes + +
+ +
+ +
+
+ reassignment_counter + int64 + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ConnectSynchronizerRequest

+ +

2 fields

+ +
+ + +
+ +
+
+ config + SynchronizerConnectionConfig + +
+ +
+ +
+
+ sequencer_connection_validation + SequencerConnectionValidation + +
+ +
Determines how well the provided sequencer connections should be validated before they are persisted. The more paranoid the validation, the higher the chance of the command failing, as it will require the sequencer to be online and responsive.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.SynchronizerConnectionConfig

+ +

9 fields

+ +
+ + +
+ +
+
+ synchronizer_alias + string + +
+ +
participant local identifier of the target synchronizer
+ +
+ +
+
+ sequencer_connections + SequencerConnections + +
+ +
connection information to sequencers
+ +
+ +
+
+ manual_connect + bool + +
+ +
if false, then the synchronizer needs to be manually connected to (default false)
+ +
+ +
+
+ physical_synchronizer_id + string + +
+ +
optional physical synchronizer id (if TLS isn't to be trusted)
+ +
+ +
+
+ priority + int32 + +
+ +
optional. Influences whether the participant submits to this synchronizer, if several synchronizers are eligible
+ +
+ +
+
+ initial_retry_delay + Duration + +
+ +
initial delay before an attempt to reconnect to the sequencer
+ +
+ +
+
+ max_retry_delay + Duration + +
+ +
maximum delay before an attempt to reconnect to the sequencer
+ +
+ +
+
+ time_tracker + SynchronizerTimeTrackerConfig + +
+ +
configuration for how time is tracked and requested on this synchronizer
+ +
+ +
+
+ initialize_from_trusted_synchronizer + bool + +
+ +
If true, allows a participant to connect to a synchronizer that it was previously connected to, without issuing a new synchronizer trust certificate.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.sequencer.v30.SequencerConnections

+ +

5 fields

+ +
+ + +
+ +
+
+ sequencer_connections + repeated SequencerConnection + +
+ +
+ +
+
+ sequencer_trust_threshold + uint32 + +
+ +
This field determines the minimum level of agreement, or consensus, required among the sequencers before a message is considered reliable and accepted by the system. This value must be positive.
+ +
+ +
+
+ submission_request_amplification + SubmissionRequestAmplification + +
+ +
+ +
+
+ sequencer_liveness_margin + uint32 + +
+ +
This field determines the number of extra subscriptions to maintain beyond `sequencer_trust_threshold` in order to ensure liveness. This is only used when the new connection pool is enabled, and is ignored otherwise. This value must be non-negative.
+ +
+ +
+
+ sequencer_connection_pool_delays + SequencerConnectionPoolDelays + +
+ +
Configures the various delays used by the sequencer connection pool.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.sequencer.v30.SequencerConnection

+ +

3 fields

+ +
+ + +
+ +
+
+ grpc + Grpc + +
+ +
+ +
+
+ alias + string + +
+ +
+ +
+
+ sequencer_id + string + +
+ +
The id of the sequencer that serves the sequencer API. If empty, the node sets it after the first connection. If set, the node checks that the sequencer id reported by the sequencer matches this id.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.sequencer.v30.SequencerConnection.Grpc

+ +

3 fields

+ +
+ + +
+ +
+
+ connections + repeated string + +
+ +
connection information to sequencer (http[s]://<host>:<port>")
+ +
+ +
+
+ transport_security + bool + +
+ +
Should the connection use TLS?
+ +
+ +
+
+ custom_trust_certificates + bytes + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.sequencer.v30.SubmissionRequestAmplification

+ +

2 fields

+ +
+ + +
+ +
+
+ factor + uint32 + +
+ +
Determines to how often the client should try to send a submission request that is eligible for deduplication. A higher value increases the chance of a submission request being accepted by the system, but also increases the load on the sequencers and thus the costs incurred by the client. This value must be positive.
+ +
+ +
+
+ patience + Duration + +
+ +
Determines how long the sequencer client waits for observing the sequencing before it sends the submission request again. This value must be non-negative.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.sequencer.v30.SequencerConnectionPoolDelays

+ +

4 fields

+ +
+ + +
+ +
+
+ min_restart_delay + Duration + +
+ +
Minimum duration after which a failed sequencer connection is restarted. This value must be non-negative.
+ +
+ +
+
+ max_restart_delay + Duration + +
+ +
Maximum duration after which a failed sequencer connection is restarted. This value must be non-negative.
+ +
+ +
+
+ subscription_request_delay + Duration + +
+ +
Delay between the attempts to obtain new sequencer connections for the sequencer subscription pool, when the current number of subscriptions is below `trustThreshold` + `livenessMargin`. This value must be non-negative.
+ +
+ +
+
+ warn_validation_delay + Duration + +
+ +
Duration after which a warning is issued if a started connection still fails validation. This value must be non-negative.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.time.v30.SynchronizerTimeTrackerConfig

+ +

4 fields

+ +
+ + +
+ +
+
+ observation_latency + Duration + +
+ +
+ +
+
+ patience_duration + Duration + +
+ +
+ +
+
+ min_observation_duration + Duration + +
+ +
+ +
+
+ time_proof_request + TimeProofRequestConfig + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.time.v30.TimeProofRequestConfig

+ +

3 fields

+ +
+ +

these structures are only used for where the configuration can be adjusted at runtime using the participant synchronizer connectivity commands and services. however they are defined here in common to be sat alongside the scala definitions themselves.

+ + +
+ +
+
+ initial_retry_delay + Duration + +
+ +
+ +
+
+ max_retry_delay + Duration + +
+ +
+ +
+
+ max_sequencing_delay + Duration + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.sequencer.v30.SequencerConnectionValidation

+ +

5 values

+ +
+ + + +
    + +
  • SEQUENCER_CONNECTION_VALIDATION_UNSPECIFIED
    • + +
  • SEQUENCER_CONNECTION_VALIDATION_DISABLED
    • + +
  • SEQUENCER_CONNECTION_VALIDATION_ACTIVE
    • + +
  • SEQUENCER_CONNECTION_VALIDATION_ALL
    • + +
  • SEQUENCER_CONNECTION_VALIDATION_THRESHOLD_ACTIVE
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ConnectSynchronizerResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ connected_successfully + bool + +
+ +
true if the synchronizer is connected, false if the synchronizer is offline, exception on any other error
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ConnectedSynchronizer

+ +

2 fields

+ +
+ + +
+ +
+
+ physical_synchronizer_id + string + +
+ +
+ +
+
+ health + Health + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ConnectedSynchronizer.Health

+ +

3 values

+ +
+ + + +
    + +
  • HEALTH_UNSPECIFIED
    • + +
  • HEALTH_HEALTHY
    • + +
  • HEALTH_UNHEALTHY
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ContractState

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.CountInFlightRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ synchronizer_id + string + +
+ +
the synchronizer to query for pending submissions and in-flight transactions
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.CountInFlightResponse

+ +

2 fields

+ +
+ + +
+ +
+
+ pending_submissions + uint32 + +
+ +
+ +
+
+ pending_transactions + uint32 + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.CounterParticipantInfo

+ +

5 fields

+ +
+ + +
+ +
+
+ counter_participant_uid + string + +
+ +
+ +
+
+ synchronizer_id + string + +
+ +
+ +
+
+ intervals_behind + uint64 + +
+ +
MaxInt(2147483647) means that the counter-participant never sent a commitment
+ +
+ +
+
+ behind_since + Duration + +
+ +
how long time the corresponding intervals correlate to (Timestamp in the future means it has never sent a commitment) this is to help debugging, especially in the case where the reconciliation interval have been changed. for example, if we have a counter participant that is three intervals behind, and each interval is one minute. if the reconciliation interval is changed to 24 hours, then it might look like that counter-participant is three days behind (when it is actually only three minutes behind).
+ +
+ +
+
+ as_of_sequencing_timestamp + Timestamp + +
+ +
the "as of" sequencing timestamp at which this information was obtained
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.DarDescription

+ +

4 fields

+ +
+ + +
+ +
+
+ main + string + +
+ +
+ +
+
+ name + string + +
+ +
+ +
+
+ version + string + +
+ +
+ +
+
+ description + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.DisconnectAllSynchronizersRequest

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.DisconnectAllSynchronizersResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.DisconnectSynchronizerRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ synchronizer_alias + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.DisconnectSynchronizerResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ExportAcsOldRequest

+ +

5 fields

+ +
+ + +
+ +
+
+ parties + repeated string + +
+ +
The parties for which the ACS should be exported. If empty, the ACS of all parties will be exported. Optional
+ +
+ +
+
+ filter_synchronizer_id + string + +
+ +
The IDs of the synchronizers to filter the contracts by Optional, if set the contracts will be filtered by the exact match of the ID of the synchronizer to which it's assigned
+ +
+ +
+
+ timestamp + Timestamp + +
+ +
The timestamp at which the ACS should be valid. If provided, it will be checked that the ACS is available at the given timestamp (i.e. the timestamp is considered clean and the ACS has not been pruned). Optional, if missing the latest clean timestamp will be used
+ +
+ +
+
+ force + bool + +
+ +
If true, do not check whether the provided timestamp is clean (see `timestamp` field). NOT FOR PRODUCTION USE. For this option to yield a consistent snapshot, you need to wait at least confirmationResponseTimeout + mediatorReactionTimeout after the last submitted request. Recommended value is `false`
+ +
+ +
+
+ parties_offboarding + bool + +
+ +
true if the parties will be offboarded after the replication (party migration) Recommended value is `false`
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ExportAcsOldResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ chunk + bytes + +
+ +
The raw binary of the ACS snapshot to be imported This is meant to be streamed and every message should be a chunk of the snapshot Required
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ExportAcsRequest

+ +

5 fields

+ +
+ + +
+ +
+
+ party_ids + repeated string + +
+ +
The identifiers of the parties for which the Active Contract Set (ACS) will be exported. This field must contain at least one party ID. Required
+ +
+ +
+
+ synchronizer_id + string + +
+ +
The identifier of the synchronizer to filter contracts. Optional. If provided, only contracts assigned to a synchronizer with this exact ID will be included in the exported ACS. If not set (empty string), all contracts for the specified parties will be included.
+ +
+ +
+
+ ledger_offset + int64 + +
+ +
The ledger offset at which the ACS snapshot should be taken. This determines the point in the ledger history from which the active contracts will be retrieved. Required
+ +
+ +
+
+ contract_synchronizer_renames + repeated map + +
+ +
A mapping to modify the synchronizer assignment of contracts in the exported ACS. Note: This mapping is not a proper contract reassignment. That is no actual reassignment happens, and thus the reassignment counter is not increased. Optional. If not provided (empty map), the contracts in the exported ACS will retain their original synchronizer assignments.
+ +
+ +
+
+ excluded_stakeholder_ids + repeated string + +
+ +
A list of party IDs to exclude from the export. Any contract that has one or more of these parties as a stakeholder will be omitted from the ACS snapshot. Optional
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ExportAcsResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ chunk + bytes + +
+ +
A chunk of the Active Contract Set (ACS) snapshot. This response is streamed, with each message containing a portion of the complete ACS data. The raw binary data within each chunk consists of Ledger API active contract messages, specifically wrapped in `v30.active_contract.ActiveContract` messages. However, a single chunk does not necessarily contain exactly one complete message. This field will be populated in each streamed response. Required
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ExportAcsTargetSynchronizer

+ +

1 fields

+ +
+ + +
+ +
+
+ target_synchronizer_id + string + +
+ +
The identifier of the synchronizer to which contracts should be assigned upon exporting the Active Contract Set (ACS). Required.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ExportPartyAcsRequest

+ +

5 fields

+ +
+ +

Exports the ACS for a given party to facilitate its replication from a source to a target participant. This request uses the party's most recent activation on the target participant to determine the precise historical state of the ACS to export from the source participant. "Activation" on the target participant means the new hosting arrangement has been authorized by both the party itself and the target participant via party-to-participant topology transactions. This request will fail if the party has not yet been activated on the target participant.

+ + +
+ +
+
+ party_id + string + +
+ +
The identifier of the party being replicated. This party must already be active on the target participant for the ACS export to succeed. Required
+ +
+ +
+
+ synchronizer_id + string + +
+ +
The identifier of the synchronizer managing the contract to be exported. This scopes the ACS export to only contracts assigned to this synchronizer. Required
+ +
+ +
+
+ target_participant_uid + string + +
+ +
The unique identifier of the target participant where the party will be replicated. Required
+ +
+ +
+
+ begin_offset_exclusive + int64 + +
+ +
The exclusive ledger offset used as starting point to find the party's most recent activation on the target participant. Required
+ +
+ +
+
+ wait_for_activation_timeout + Duration + +
+ +
The maximum duration the service will wait to find the topology transaction that activates the party on the target participant. If not set, the service will use a default timeout. Optional
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ExportPartyAcsResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ chunk + bytes + +
+ +
A chunk of the ACS snapshot. This response is streamed, with each message containing a portion of the complete ACS data. The raw binary data within each chunk consists of Ledger API active contract messages, specifically wrapped in `v30.active_contract.ActiveContract` messages. However, a single chunk does not necessarily contain exactly one complete message. This field will be populated in each streamed response. Required
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ add_party_request_id + string + +
+ +
The add party request ID returned by AddPartyAsync Required
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusResponse

+ +

7 fields

+ +
+ + +
+ +
+
+ party_id + string + +
+ +
+ +
+
+ synchronizer_id + string + +
+ +
+ +
+
+ source_participant_uid + string + +
+ +
+ +
+
+ target_participant_uid + string + +
+ +
+ +
+
+ topology_serial + uint32 + +
+ +
+ +
+
+ participant_permission + ParticipantPermission + +
+ +
+ +
+
+ status + Status + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusResponse.Status

+ +

9 fields

+ +
+ + +
+ +
+
+ proposal_processed + ProposalProcessed + +
+ +
Party Replication Daml admin workflow proposal and agreement handling
+ +
+ +
+
+ agreement_accepted + AgreementAccepted + +
+ +
+ +
+
+ topology_authorized + TopologyAuthorized + +
+ +
Topology management
+ +
+ +
+
+ connection_established + ConnectionEstablished + +
+ +
Party Replication ACS replication
+ +
+ +
+
+ replicating_acs + ReplicatingAcs + +
+ +
+ +
+
+ fully_replicated_acs + FullyReplicatedAcs + +
+ +
+ +
+
+ completed + Completed + +
+ +
Completed indicating that party successfully has been added to target participant.
+ +
+ +
+
+ error + Error + +
+ +
Error indicating that party replication has failed.
+ +
+ +
+
+ disconnected + Disconnected + +
+ +
Conditions that party replication is attempting to recover from.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusResponse.Status.ProposalProcessed

+ +

0 fields

+ +
+ +

The add-party request has been submitted by the target participant, or accepted by the source participant.

+ + + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusResponse.Status.AgreementAccepted

+ +

1 fields

+ +
+ +

The add-party request has been observed as agreed to by all participants.

+ + +
+ +
+
+ sequencer_uid + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusResponse.Status.TopologyAuthorized

+ +

2 fields

+ +
+ +

The PartyToParticipant topology transaction has been authorized by all party and participant signers.

+ + +
+ +
+
+ sequencer_uid + string + +
+ +
+ +
+
+ timestamp + Timestamp + +
+ +
The timestamp at which the ACS snapshot for replication is taken.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusResponse.Status.ConnectionEstablished

+ +

2 fields

+ +
+ +

This participant has connected to the sequencer channel for ACS replication.

+ + +
+ +
+
+ sequencer_uid + string + +
+ +
+ +
+
+ timestamp + Timestamp + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusResponse.Status.ReplicatingAcs

+ +

3 fields

+ +
+ +

This participant is ready for ACS replication or has started replicating the ACS.

+ + +
+ +
+
+ sequencer_uid + string + +
+ +
+ +
+
+ timestamp + Timestamp + +
+ +
+ +
+
+ contracts_replicated + uint32 + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusResponse.Status.FullyReplicatedAcs

+ +

3 fields

+ +
+ +

This participant has completed its part of the ACS replication: In case of the source participant all contracts have been sent, and for the target participant all contracts have been received.

+ + +
+ +
+
+ sequencer_uid + string + +
+ +
+ +
+
+ timestamp + Timestamp + +
+ +
+ +
+
+ contracts_replicated + uint32 + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusResponse.Status.Completed

+ +

3 fields

+ +
+ +

The party has been added to the target participant.

+ + +
+ +
+
+ sequencer_uid + string + +
+ +
+ +
+
+ timestamp + Timestamp + +
+ +
+ +
+
+ contracts_replicated + uint32 + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusResponse.Status.Error

+ +

2 fields

+ +
+ +

The add-party request has failed after the specified last successful status.

+ + +
+ +
+
+ error_message + string + +
+ +
+ +
+
+ status_prior_to_error + Status + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusResponse.Status.Disconnected

+ +

2 fields

+ +
+ +

The participant has disconnected from the sequencer channel used for ACS replication.

+ + +
+ +
+
+ disconnect_message + string + +
+ +
+ +
+
+ status_prior_to_disconnect + Status + +
+ +
Prior status is one of ConnectionEstablished or ReplicatingAcs.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.GetConfigForSlowCounterParticipantsRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ synchronizer_ids + repeated string + +
+ +
filters by synchronizers
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.GetConfigForSlowCounterParticipantsResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ configs + repeated SlowCounterParticipantSynchronizerConfig + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.SlowCounterParticipantSynchronizerConfig

+ +

5 fields

+ +
+ +

The configuration concerns the following metrics, issued per synchronizer; threshold_distinguished & threshold_default are overwritten, distinguished_participant_uids & participant_uids_metrics is additive: - The maximum number of intervals that a distinguished participant falls behind - The maximum number of intervals that a participant in the "default" group falls behind - The number of participants in the distinguished group that are behind by at least `thresholdDistinguished` reconciliation intervals. - The number of participants in the "default" group that are behind by at least `thresholdDefault` reconciliation intervals. - Selected participants for which we publish independent metrics counting how many intervals they are behind

+ + +
+ +
+
+ synchronizer_ids + repeated string + +
+ +
the synchronizers for which we apply the settings below
+ +
+ +
+
+ distinguished_participant_uids + repeated string + +
+ +
all non-distinguished counter-participants are implicitly part of the group "default"
+ +
+ +
+
+ threshold_distinguished + uint64 + +
+ +
the number of reconciliation intervals for a distinguished counter-participant to be considered slow
+ +
+ +
+
+ threshold_default + uint64 + +
+ +
the number of reconciliation intervals for an "other" counter-participant to be considered slow
+ +
+ +
+
+ participant_uids_metrics + repeated string + +
+ +
participants for which we publish independent metrics counting how many intervals they are behind
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.GetDarContentsRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ main_package_id + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.GetDarContentsResponse

+ +

2 fields

+ +
+ + +
+ +
+
+ description + DarDescription + +
+ +
+ +
+
+ packages + repeated PackageDescription + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.PackageDescription

+ +

5 fields

+ +
+ + +
+ +
+
+ package_id + string + +
+ +
+ +
+
+ name + string + +
+ +
+ +
+
+ version + string + +
+ +
+ +
+
+ uploaded_at + Timestamp + +
+ +
+ +
+
+ size + uint32 + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.GetDarRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ main_package_id + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.GetDarResponse

+ +

2 fields

+ +
+ + +
+ +
+
+ payload + bytes + +
+ +
+ +
+
+ data + DarDescription + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.GetHighestOffsetByTimestampRequest

+ +

3 fields

+ +
+ +

Requests the highest ledger offset among all events belonging to the synchronizer (`synchronizer_id`) that have a record time before or at the given `timestamp`. This endpoint features a `force` message field. This is intended for disaster recovery scenarios only.

+ + +
+ +
+
+ synchronizer_id + string + +
+ +
The identifier of the synchronizer. Required
+ +
+ +
+
+ timestamp + Timestamp + +
+ +
The requested timestamp for which a ledger offset should be found. Required
+ +
+ +
+
+ force + bool + +
+ +
If true, return the highest known ledger offset with a record time before or at the specified `timestamp` even if higher offsets with a record time before or at `timestamp` can be created in the future. Required, defaults to false.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.GetHighestOffsetByTimestampResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ ledger_offset + int64 + +
+ +
The highest ledger offset among events that have their record time before or at the requested timestamp. An error when no such offset (yet) exists. Required
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.GetIntervalsBehindForCounterParticipantsRequest

+ +

3 fields

+ +
+ + +
+ +
+
+ counter_participant_ids + repeated string + +
+ +
if empty, all counter-participants are considered
+ +
+ +
+
+ synchronizer_ids + repeated string + +
+ +
if empty, all synchronizers are considered
+ +
+ +
+
+ threshold + uint64 + +
+ +
if set, only counter-participants that are behind by at least this number of intervals are returned
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.GetIntervalsBehindForCounterParticipantsResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ intervals_behind + repeated CounterParticipantInfo + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.GetPackageContentsRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ package_id + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.GetPackageContentsResponse

+ +

4 fields

+ +
+ + +
+ +
+
+ description + PackageDescription + +
+ +
+ +
+
+ modules + repeated ModuleDescription + +
+ +
+ +
+
+ is_utility_package + bool + +
+ +
+ +
+
+ language_version + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ModuleDescription

+ +

1 fields

+ +
+ + +
+ +
+
+ name + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.GetPackageReferencesRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ package_id + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.GetPackageReferencesResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ dars + repeated DarDescription + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.GetResourceLimitsRequest

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.GetResourceLimitsResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ current_limits + ResourceLimits + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ResourceLimits

+ +

3 fields

+ +
+ + +
+ +
+
+ max_inflight_validation_requests + uint32 + +
+ +
The maximum number of inflight validation requests. A negative value indicates that there is no limit.
+ +
+ +
+
+ max_submission_rate + uint32 + +
+ +
The maximum rate of command submissions through the ledger api. A negative value indicates that there is no limit.
+ +
+ +
+
+ max_submission_burst_factor + double + +
+ +
The maximum burst acceptable (factor > 0) before steady state throttling kicks in.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.GetSafePruningOffsetRequest

+ +

3 fields

+ +
+ + +
+ +
+
+ before_or_at + Timestamp + +
+ +
+ +
+
+ ledger_end + int64 + +
+ +
+ +
+
+ counter_participants_commitments_state + SafeToPruneCommitmentState + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.SafeToPruneCommitmentState

+ +

4 values

+ +
+ +

The states ensure that, once a timestamp is seen as safe to prune, it cannot later be seen as unsafe to prune. For this, we assume that the outstanding periods table ensures that a period's state can only be outstanding, mismatch, match: - Match supersedes all other states and cannot be changed - Mismatch can only change to match - Outstanding can change to any other state Therefore, in state SAFE_TO_PRUNE_COMMITMENT_STATE_NONE, we declare a state safe to prune because periods are a match, which can never change In state SAFE_TO_PRUNE_COMMITMENT_STATE_MATCH_MISMATCH, a state match cannot change later, and a mismatch can only change to a match, which is covered by the state. Therefore, an affirmative pruning decision for a timestamp cannot change later. A similar argument can be made for SAFE_TO_PRUNE_COMMITMENT_STATE_ALL.

+ + + +
    + +
  • SAFE_TO_PRUNE_COMMITMENT_STATE_UNSPECIFIED
    • + +
  • SAFE_TO_PRUNE_COMMITMENT_STATE_MATCH
    • + +
  • SAFE_TO_PRUNE_COMMITMENT_STATE_MATCH_MISMATCH
    • + +
  • SAFE_TO_PRUNE_COMMITMENT_STATE_ALL
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.GetSafePruningOffsetResponse

+ +

2 fields

+ +
+ + +
+ +
+
+ safe_pruning_offset + int64 + +
+ +
+ +
+
+ no_safe_pruning_offset + NoSafePruningOffset + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.GetSafePruningOffsetResponse.NoSafePruningOffset

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.GetSynchronizerIdRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ synchronizer_alias + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.GetSynchronizerIdResponse

+ +

2 fields

+ +
+ + +
+ +
+
+ synchronizer_id + string + +
+ +
+ +
+
+ physical_synchronizer_id + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.IgnoreEventsRequest

+ +

4 fields

+ +
+ + +
+ +
+
+ physical_synchronizer_id + string + +
+ +
+ +
+
+ from_inclusive + int64 + +
+ +
sequencer counter of the first event to ignore
+ +
+ +
+
+ to_inclusive + int64 + +
+ +
sequencer counter of the last event to ignore
+ +
+ +
+
+ force + bool + +
+ +
allow to proceed even if some clean events have sequencer counter greater or equal than `from_inclusive`
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.IgnoreEventsResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ImportAcsOldRequest

+ +

3 fields

+ +
+ + +
+ +
+
+ acs_snapshot + bytes + +
+ +
The raw binary of the ACS snapshot to be imported Required
+ +
+ +
+
+ workflow_id_prefix + string + +
+ +
The synchronizer id prefix to be used for the imported contracts Optional, if not provided the service will generate a prefix
+ +
+ +
+
+ allow_contract_id_suffix_recomputation + bool + +
+ +
If false, the service will fail if any contract ID suffix doesn't match the scheme associated to the synchronizer where the contract is being assigned as a result of the import. If true, any contract ID suffix will be recomputed to match the scheme associated to the synchronizer. Recommended value is `false`
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ImportAcsOldResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ contract_id_mapping + repeated map + +
+ +
Mapping from the old contract id to the new contract id
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ImportAcsRequest

+ +

5 fields

+ +
+ + +
+ +
+
+ acs_snapshot + bytes + +
+ +
The raw binary of the ACS snapshot to be imported The binary contents does not align on individual active contracts! It may contain bytes that are part of an active contract, or include several active contracts - depending on how much data fits into the configured gRPC message size. Required
+ +
+ +
+
+ workflow_id_prefix + string + +
+ +
Custom prefix for the workflow ID to easily identify all transactions generated by this import. Optional. If left empty, the service will generate a prefix such as `import-<random_UUID>`.
+ +
+ +
+
+ contract_import_mode + ContractImportMode + +
+ +
How imported contracts should be validated upon import NOTE: The representative package IDs assigned to imported contracts must ensure proper type-checking for those contracts. Importing contracts representative_package_id's that do not type-check may cause unexpected behavior, including INTERNAL errors on Ledger API read queries or incorrect Daml value representations. If unsure, perform the ACS import with ContractImportMode set to CONTRACT_IMPORT_MODE_VALIDATION to ensure that the assigned representative package IDs correctly validate the imported contracts. Required
+ +
+ +
+
+ excluded_stakeholder_ids + repeated string + +
+ +
A list of party IDs to exclude from the import. Any contract that has one or more of these parties as a stakeholder will be omitted during the import. Optional
+ +
+ +
+
+ representative_package_id_override + RepresentativePackageIdOverride + +
+ +
The representative package ID override rules to be applied during import. Optional
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ContractImportMode

+ +

4 values

+ +
+ + + +
    + +
  • CONTRACT_IMPORT_MODE_UNSPECIFIED
    • + +
  • CONTRACT_IMPORT_MODE_ACCEPT
    • + +
  • CONTRACT_IMPORT_MODE_VALIDATION
    • + +
  • CONTRACT_IMPORT_MODE_RECOMPUTATION
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.RepresentativePackageIdOverride

+ +

3 fields

+ +
+ +

Defines override mappings for assigning representative package IDs to contracts upon ACS import. The representative package ID is assigned to a contract upon ACS import based on the following precedence rules. 1. The associated override for the contract ID in RepresentativePackageIdOverride.contract_override, if specified and present in the package store 2. The associated override for the contract's original package ID in RepresentativePackageIdOverride.package_id_override, if specified and present in the package store 3. The contract's representative package ID from the ACS snapshot, if present in the package store 4. The contract's creation package ID, if present in the package store 5. The associated override for the contract's package name in RepresentativePackageIdOverride.package_name_override, if specified and present in the package store 6. The highest-versioned package in the participant's package store for the contract's package name If none of the above rules yield a representative package ID, the ACS import request will fail. See ``CreatedEvent.representative_package_id`` in ``event.proto`` for more details on the concept of representative package IDs.

+ + +
+ +
+
+ contract_override + repeated map + +
+ +
Mapping from contract ID to the target representative package ID. Only contracts with IDs matching the keys in this map are affected.
+ +
+ +
+
+ package_id_override + repeated map + +
+ +
Mapping from a contract's original package IDs (either the creation or the representative package ID) to the target representative package ID. Affects only contracts with creation or representative package IDs matching the keys in this map, except if they're not already affected by `contract_override`.
+ +
+ +
+
+ package_name_override + repeated map + +
+ +
Mapping from any contract's package name to the target representative package ID Affects only contracts with package names matching the keys in this map, except if they're already affected by `contract_override` or `package_id_override`.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ImportAcsResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ contract_id_mappings + repeated map + +
+ +
Maps old contract IDs to newly recomputed contract IDs iff the recomputation contract ID import mode has been selected, empty otherwise.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ImportPartyAcsRequest

+ +

4 fields

+ +
+ + +
+ +
+
+ acs_snapshot + bytes + +
+ +
The raw binary of the ACS snapshot to be imported The binary content does not align on individual active contracts! It may contain bytes that are part of an active contract, or include several active contracts - depending on how much data fits into the configured gRPC message size. Required
+ +
+ +
+
+ workflow_id_prefix + string + +
+ +
Custom prefix for the workflow ID to easily identify all transactions generated by this import. Optional. If left empty, the service will generate a prefix such as `import-<random_UUID>`.
+ +
+ +
+
+ contract_import_mode + ContractImportMode + +
+ +
How imported contracts should be validated upon import. NOTE: The representative package IDs assigned to imported contracts must ensure proper type-checking for those contracts. Importing contracts representative_package_id's that do not type-check may cause unexpected behavior, including INTERNAL errors on Ledger API read queries or incorrect Daml value representations. If unsure, perform the ACS import with ContractImportMode set to CONTRACT_IMPORT_MODE_VALIDATION to ensure that the assigned representative package IDs correctly validate the imported contracts. Required
+ +
+ +
+
+ representative_package_id_override + RepresentativePackageIdOverride + +
+ +
The representative package ID override rules to be applied during import. Optional
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ImportPartyAcsResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.InspectCommitmentContractsRequest

+ +

4 fields

+ +
+ +

The participant needs to be authorized to see the requested contracts, for example using JWT authorization

+ + +
+ +
+
+ cids + repeated bytes + +
+ +
the contracts whose state and payload we want to retrieve
+ +
+ +
+
+ expected_synchronizer_id + string + +
+ +
the synchronizer on which we expect the contracts to be active
+ +
+ +
+
+ timestamp + Timestamp + +
+ +
timestamp at which we retrieve the state of the contracts on the expected synchronizer
+ +
+ +
+
+ download_payload + bool + +
+ +
whether to retrieve the payload of the contracts
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.InspectCommitmentContractsResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ chunk + bytes + +
+ +
commitment contracts
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.Interval

+ +

2 fields

+ +
+ +

timestamps *do fall* on commitment period boundaries/ticks

+ + +
+ +
+
+ start_tick_exclusive + Timestamp + +
+ +
+ +
+
+ end_tick_inclusive + Timestamp + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ListConnectedSynchronizersRequest

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ListConnectedSynchronizersResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ connected_synchronizers + repeated Result + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ListConnectedSynchronizersResponse.Result

+ +

4 fields

+ +
+ + +
+ +
+
+ synchronizer_alias + string + +
+ +
+ +
+
+ synchronizer_id + string + +
+ +
+ +
+
+ physical_synchronizer_id + string + +
+ +
+ +
+
+ healthy + bool + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ListDarsRequest

+ +

2 fields

+ +
+ + +
+ +
+
+ limit + int32 + +
+ +
+ +
+
+ filter_name + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ListDarsResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ dars + repeated DarDescription + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ListPackagesRequest

+ +

2 fields

+ +
+ + +
+ +
+
+ limit + int32 + +
+ +
+ +
+
+ filter_name + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ListPackagesResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ package_descriptions + repeated PackageDescription + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ListRegisteredSynchronizersRequest

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ListRegisteredSynchronizersResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ListRegisteredSynchronizersResponse.Result

+ +

3 fields

+ +
+ + +
+ +
+
+ config + SynchronizerConnectionConfig + +
+ +
+ +
+
+ connected + bool + +
+ +
+ +
+
+ physical_synchronizer_id + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.LogoutRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ synchronizer_alias + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.LogoutResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.LookupOffsetByTimeRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ timestamp + Timestamp + +
+ +
the timestamp to look up the offset for
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.LookupOffsetByTimeResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ offset + int64 + +
+ +
if specified, the absolute offset as an integer corresponding to the specified timestamp. if absent, no such offset exists.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.LookupReceivedAcsCommitmentsRequest

+ +

4 fields

+ +
+ +

list the commitments received from counter-participants optional filtering by synchronizer, time ranges, counter participants, commitment state and verbosity

+ + +
+ +
+
+ time_ranges + repeated SynchronizerTimeRange + +
+ +
filter specific time ranges per synchronizer a synchronizer can appear multiple times with various time ranges, in which case we consider the union of the time ranges. return only the received commitments with an interval overlapping any of the given time ranges per synchronizer defaults: if empty, all synchronizers known to the participant are considered
+ +
+ +
+
+ counter_participant_ids + repeated string + +
+ +
retrieve commitments received from specific counter participants if a specified counter participant is not a counter-participant in some synchronizer, we do not return it in the response an empty set means we return commitments received from all counter participants on the synchronizers matching the synchronizer filter.
+ +
+ +
+
+ commitment_state + repeated ReceivedCommitmentState + +
+ +
filter by commitment state: only return commitments with the states below if no state is given, we return all commitments
+ +
+ +
+
+ verbose + bool + +
+ +
include the actual commitment in the response
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.SynchronizerTimeRange

+ +

2 fields

+ +
+ + +
+ +
+
+ synchronizer_id + string + +
+ +
+ +
+
+ interval + TimeRange + +
+ +
optional; if not given, the latest reconciliation period the participant knows of for that synchronizer is considered
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.TimeRange

+ +

2 fields

+ +
+ +

timestamps *do not* have to fall on commitment period boundaries/ticks

+ + +
+ +
+
+ from_exclusive + Timestamp + +
+ +
+ +
+
+ to_inclusive + Timestamp + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ReceivedCommitmentState

+ +

5 values

+ +
+ + + +
    + +
  • RECEIVED_COMMITMENT_STATE_UNSPECIFIED
    • + +
  • RECEIVED_COMMITMENT_STATE_MATCH
    • + +
  • RECEIVED_COMMITMENT_STATE_MISMATCH
    • + +
  • RECEIVED_COMMITMENT_STATE_BUFFERED
    • + +
  • RECEIVED_COMMITMENT_STATE_OUTSTANDING
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.LookupReceivedAcsCommitmentsResponse

+ +

1 fields

+ +
+ +

Returns a sequence of commitments for each synchronizer. Synchronizers should not repeat in the response, otherwise the caller considers the response invalid. If all commitments received on a synchronizer have been pruned, we return an error. No streaming, because a response with verbose mode on contains around 1kb to 3kb of data (depending on whether we ship the LtHash16 bytes directly or just a hash thereof). Therefore, 1000 commitments fit into a couple of MBs, and we can expect the gRPC admin API to handle messages of a couple of MBs. It is the application developer's job to find suitable filter ranges.

+ + +
+ +
+
+ received + repeated ReceivedAcsCommitmentPerSynchronizer + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ReceivedAcsCommitmentPerSynchronizer

+ +

2 fields

+ +
+ + +
+ +
+
+ synchronizer_id + string + +
+ +
+ +
+
+ received + repeated ReceivedAcsCommitment + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ReceivedAcsCommitment

+ +

5 fields

+ +
+ + +
+ +
+
+ interval + Interval + +
+ +
+ +
+
+ origin_counter_participant_uid + string + +
+ +
the counter participant that computed and sent the commitment, from whom the current participant received the commitment
+ +
+ +
+
+ received_commitment + bytes + +
+ +
the commitment received from the counter participant, unsigned because the admin trusts own participant's reply populated only if verbose mode is on
+ +
+ +
+
+ own_commitment + bytes + +
+ +
own commitment of participant that was compared with the received commitment, unsigned because the admin trusts own participant's reply populated only in case there is a mismatch and verbose mode is on might not correspond to the same interval as the received commitment, however, the matching timestamp is the end of the returned interval
+ +
+ +
+
+ state + ReceivedCommitmentState + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.LookupSentAcsCommitmentsRequest

+ +

4 fields

+ +
+ +

list the commitments computed and sent to counter-participants optional filtering by synchronizer, time ranges, counter participants, commitment state and verbosity

+ + +
+ +
+
+ time_ranges + repeated SynchronizerTimeRange + +
+ +
filter specific time ranges per synchronizer a synchronizer can appear multiple times with various time ranges, in which case we consider the union of the time ranges. return only the sent commitments with an interval overlapping any of the given time ranges per synchronizer defaults: if empty, all synchronizers known to the participant are considered
+ +
+ +
+
+ counter_participant_ids + repeated string + +
+ +
retrieve commitments sent to specific counter participants if a specified counter participant is not a counter-participant in some synchronizer, we do not return it in the response an empty set means we return commitments sent to all counter participants on the synchronizers matching the synchronizer filter.
+ +
+ +
+
+ commitment_state + repeated SentCommitmentState + +
+ +
filter by commitment state: only return commitments with the states below if no state is given, we return all commitments
+ +
+ +
+
+ verbose + bool + +
+ +
include the actual commitment in the response
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.SentCommitmentState

+ +

4 values

+ +
+ + + +
    + +
  • SENT_COMMITMENT_STATE_UNSPECIFIED
    • + +
  • SENT_COMMITMENT_STATE_MATCH
    • + +
  • SENT_COMMITMENT_STATE_MISMATCH
    • + +
  • SENT_COMMITMENT_STATE_NOT_COMPARED
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.LookupSentAcsCommitmentsResponse

+ +

1 fields

+ +
+ +

Returns a sequence of commitments for each synchronizer. Synchronizers should not repeat in the response, otherwise the caller considers the response invalid. If all commitments sent on a synchronizer have been pruned, we return an error. No streaming, because a response with verbose mode on contains around 1kb to 3kb of data (depending on whether we ship the LtHash16 bytes directly or just a hash thereof). Therefore, 1000 commitments fit into a couple of MBs, and we can expect the gRPC admin API to handle messages of a couple of MBs. It is the application developer's job to find suitable filter ranges.

+ + +
+ +
+
+ sent + repeated SentAcsCommitmentPerSynchronizer + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.SentAcsCommitmentPerSynchronizer

+ +

2 fields

+ +
+ + +
+ +
+
+ synchronizer_id + string + +
+ +
+ +
+
+ sent + repeated SentAcsCommitment + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.SentAcsCommitment

+ +

5 fields

+ +
+ + +
+ +
+
+ interval + Interval + +
+ +
+ +
+
+ dest_counter_participant_uid + string + +
+ +
the counter participant to whom we sent the commitment
+ +
+ +
+
+ own_commitment + bytes + +
+ +
own computed commitment sent to counter participant, unsigned because the admin trusts own participant's reply populated only if verbose mode is on
+ +
+ +
+
+ received_commitment + bytes + +
+ +
commitment of the counter participant that was compared with own commitment, unsigned because the admin trusts own participant's reply populated only in case there is a mismatch and verbose mode is on might not correspond to the same interval as the sent commitment, however, the mismatch timestamp is the end of the returned interval
+ +
+ +
+
+ state + SentCommitmentState + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.MigrateSynchronizerRequest

+ +

3 fields

+ +
+ + +
+ +
+
+ source_synchronizer_alias + string + +
+ +
Alias of the synchronizer to which the contracts are currently assigned Required
+ +
+ +
+
+ target_synchronizer_connection_config + SynchronizerConnectionConfig + +
+ +
Configuration to connect to the synchronizer on which the contracts will be assigned as a result of the migration Required
+ +
+ +
+
+ force + bool + +
+ +
Whether to force the migration in spite of risking a potential ledger fork Recommended value is `false`
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.MigrateSynchronizerResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ModifySynchronizerRequest

+ +

3 fields

+ +
+ + +
+ +
+
+ physical_synchronizer_id + string + +
+ +
If empty, the request will update the single active connection for the alias in `new_config`
+ +
+ +
+
+ new_config + SynchronizerConnectionConfig + +
+ +
+ +
+
+ sequencer_connection_validation + SequencerConnectionValidation + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ModifySynchronizerResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.OpenCommitmentRequest

+ +

4 fields

+ +
+ + +
+ +
+
+ commitment + bytes + +
+ +
the commitment to be opened
+ +
+ +
+
+ physical_synchronizer_id + string + +
+ +
+ +
+
+ computed_for_counter_participant_uid + string + +
+ +
the participant for whom the receiving participant computed the commitment
+ +
+ +
+
+ period_end_tick + Timestamp + +
+ +
interval end tick which the commitment corresponds to
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.OpenCommitmentResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ chunk + bytes + +
+ +
commitment contracts metadata
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ParticipantStatusRequest

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ParticipantStatusResponse

+ +

2 fields

+ +
+ + +
+ +
+
+ status + ParticipantStatusResponseStatus + +
+ +
+ +
+
+ not_initialized + NotInitialized + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ParticipantStatusResponse.ParticipantStatusResponseStatus

+ +

4 fields

+ +
+ + +
+ +
+
+ common_status + Status + +
+ +
+ +
+
+ connected_synchronizers + repeated ConnectedSynchronizer + +
+ +
+ +
+
+ active + bool + +
+ +
Indicate if the participant node is active True if the participant node is replicated and is the active replica, or true if not replicated
+ +
+ +
+
+ supported_protocol_versions + repeated int32 + +
+ +
Protocol versions which this node supports Take into account config parameters such as alpha/beta version support and minimum protocol version
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.health.v30.Status

+ +

7 fields

+ +
+ + +
+ +
+
+ uid + string + +
+ +
+ +
+
+ uptime + Duration + +
+ +
+ +
+
+ ports + repeated map + +
+ +
+ +
+
+ active + bool + +
+ +
Indicate if the node is active, usually true unless it's a replicated node that is passive
+ +
+ +
+
+ topology_queues + TopologyQueueStatus + +
+ +
indicates the state of the topology queues (manager / dispatcher only where they exist)
+ +
+ +
+
+ components + repeated ComponentStatus + +
+ +
Health state of component dependencies of the node
+ +
+ +
+
+ version + string + +
+ +
Version of the binary
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.health.v30.TopologyQueueStatus

+ +

3 fields

+ +
+ + +
+ +
+
+ manager + uint32 + +
+ +
how many topology changes are currently queued at the manager
+ +
+ +
+
+ dispatcher + uint32 + +
+ +
how many topology changes are currently queued at the dispatcher
+ +
+ +
+
+ clients + uint32 + +
+ +
how many topology changes are currently waiting to become effective (across all connected synchronizers in the case of participants)
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.health.v30.ComponentStatus

+ +

5 fields

+ +
+ + +
+ +
+
+ name + string + +
+ +
+ +
+
+ ok + StatusData + +
+ +
+ +
+
+ degraded + StatusData + +
+ +
+ +
+
+ failed + StatusData + +
+ +
+ +
+
+ fatal + StatusData + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.health.v30.ComponentStatus.StatusData

+ +

1 fields

+ +
+ + +
+ +
+
+ description + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.health.v30.NotInitialized

+ +

2 fields

+ +
+ + +
+ +
+
+ active + bool + +
+ +
Indicate if the node is active, usually true unless it's a replicated node that is passive
+ +
+ +
+
+ waiting_for_external_input + WaitingForExternalInput + +
+ +
Indicates whether the node is waiting for external input
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.health.v30.NotInitialized.WaitingForExternalInput

+ +

4 values

+ +
+ + + +
    + +
  • WAITING_FOR_EXTERNAL_INPUT_UNSPECIFIED
    • + +
  • WAITING_FOR_EXTERNAL_INPUT_ID
    • + +
  • WAITING_FOR_EXTERNAL_INPUT_NODE_TOPOLOGY
    • + +
  • WAITING_FOR_EXTERNAL_INPUT_INITIALIZATION
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.PingFailure

+ +

1 fields

+ +
+ + +
+ +
+
+ reason + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.PingRequest

+ +

7 fields

+ +
+ + +
+ +
+
+ target_parties + repeated string + +
+ +
+ +
+
+ validators + repeated string + +
+ +
+ +
+
+ timeout + Duration + +
+ +
+ +
+
+ levels + uint32 + +
+ +
+ +
+
+ synchronizer_id + string + +
+ +
optional
+ +
+ +
+
+ workflow_id + string + +
+ +
optional
+ +
+ +
+
+ id + string + +
+ +
optional UUID to be used for ping test
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.PingResponse

+ +

2 fields

+ +
+ + +
+ +
+
+ success + PingSuccess + +
+ +
+ +
+
+ failure + PingFailure + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.PingSuccess

+ +

2 fields

+ +
+ + +
+ +
+
+ ping_time + uint64 + +
+ +
+ +
+
+ responder + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.PruneRequest

+ +

2 fields

+ +
+ + +
+ +
+
+ prune_up_to + int64 + +
+ +
Inclusive offset up to which the ledger is to be pruned.
+ +
+ +
+
+ counter_participants_commitments_state + SafeToPruneCommitmentState + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.PruneResponse

+ +

0 fields

+ +
+ +

Empty for now, but may contain fields in the future

+ + + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.PurgeContractsRequest

+ +

3 fields

+ +
+ + +
+ +
+
+ synchronizer_alias + string + +
+ +
Alias of the synchronizer to which the contracts are currently assigned Required
+ +
+ +
+
+ contract_ids + repeated string + +
+ +
Contracts to be purged Required
+ +
+ +
+
+ ignore_already_purged + bool + +
+ +
If true, will ignore already purged contract; if false, will return an error if a contract is already purged Useful re-run the same request in case of failure in an idempotent fashion Recommended value is `true`
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.PurgeContractsResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.PurgeDeactivatedSynchronizerRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ synchronizer_alias + string + +
+ +
Alias of the deactivated synchronizer to purge data from
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.PurgeDeactivatedSynchronizerResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ReassignmentId

+ +

1 fields

+ +
+ + +
+ +
+
+ id + string + +
+ +
identifies the reassignment batch, built from a hash of source, target, contract ids, contract counters and timestamp.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ReconnectSynchronizerRequest

+ +

2 fields

+ +
+ + +
+ +
+
+ synchronizer_alias + string + +
+ +
+ +
+
+ retry + bool + +
+ +
if retry is set to true, we will keep on retrying if the synchronizer is unavailable
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ReconnectSynchronizerResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ connected_successfully + bool + +
+ +
true if the synchronizer is connected, false if the synchronizer is offline, exception on any other error
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ReconnectSynchronizersRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ ignore_failures + bool + +
+ +
if set to true, the connection attempt will succeed even if one of the connection attempts failed
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ReconnectSynchronizersResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.RegisterSynchronizerRequest

+ +

3 fields

+ +
+ +

* Register connection configuration of a new synchronizer

+ + +
+ +
+
+ config + SynchronizerConnectionConfig + +
+ +
+ +
+
+ synchronizer_connection + SynchronizerConnection + +
+ +
Whether requests to the synchronizer are made
+ +
+ +
+
+ sequencer_connection_validation + SequencerConnectionValidation + +
+ +
Determines how well the provided sequencer connections should be validated before they are persisted. The more paranoid the validation, the higher the chance of the command failing, as it will require the sequencer to be online and responsive.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.RegisterSynchronizerRequest.SynchronizerConnection

+ +

3 values

+ +
+ + + +
    + +
  • SYNCHRONIZER_CONNECTION_UNSPECIFIED
    • + +
  • SYNCHRONIZER_CONNECTION_NONE
    • + +
  • SYNCHRONIZER_CONNECTION_HANDSHAKE
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.RegisterSynchronizerResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.RemoveDarRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ main_package_id + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.RemoveDarResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.RemovePackageRequest

+ +

2 fields

+ +
+ + +
+ +
+
+ package_id + string + +
+ +
+ +
+
+ force + bool + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.RemovePackageResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ success + Empty + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.RepairCommitmentsStatus

+ +

3 fields

+ +
+ + +
+ +
+
+ synchronizer_id + string + +
+ +
+ +
+
+ error_message + string + +
+ +
+ +
+
+ completed_repair_timestamp + Timestamp + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.RepairCommitmentsUsingAcsRequest

+ +

4 fields

+ +
+ + +
+ +
+
+ synchronizer_ids + repeated string + +
+ +
The IDs of the synchronizers where to reinitialize commitments from ACS If empty, we reinitialize commitments for all synchronizers
+ +
+ +
+
+ counter_participant_ids + repeated string + +
+ +
Reinitialize commitments only for the given counter-participant If empty, we reinitialize commitments for all counter-participants
+ +
+ +
+
+ party_ids + repeated string + +
+ +
Reinitialize commitments only for the stakeholder groups containing the given parties If empty, we reinitialize commitments for all stakeholder groups
+ +
+ +
+
+ timeout_seconds + Duration + +
+ +
The timeout to wait for command to return success The success status can also be queried later using the `CommitmentsService`
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.RepairCommitmentsUsingAcsResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ statuses + repeated RepairCommitmentsStatus + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.RollbackUnassignmentRequest

+ +

3 fields

+ +
+ + +
+ +
+
+ reassignment_id + string + +
+ +
The ID of the unassignment. Must be a valid LedgerString (as described in ``value.proto``). Required
+ +
+ +
+
+ source_synchronizer_id + string + +
+ +
The ID of the source synchronizer Must be a valid synchronizer id Required
+ +
+ +
+
+ target_synchronizer_id + string + +
+ +
The ID of the target synchronizer Must be a valid synchronizer id Required
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.RollbackUnassignmentResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.SetConfigForSlowCounterParticipantsRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ configs + repeated SlowCounterParticipantSynchronizerConfig + +
+ +
we can specify multiple configurations, each being applied to one or more synchronizers if the synchronizer ids in the different configs overlap, the latest config in the order of the "configs" takes precedence
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.SetConfigForSlowCounterParticipantsResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.SetPassiveRequest

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.SetPassiveResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.SetResourceLimitsRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ new_limits + ResourceLimits + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.SetResourceLimitsResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.TrafficControlStateRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ synchronizer_id + string + +
+ +
Synchronizer id for which to retrieve the traffic state
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.TrafficControlStateResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ traffic_state + TrafficState + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.TrafficState

+ +

6 fields

+ +
+ +

Traffic state of a member at a given timestamp - This is a clone of the TrafficState message in sequencing.proto We have to duplicate it here because the admin API protos are self contained and do not depend on the sequencer API protos

+ + +
+ +
+
+ extra_traffic_purchased + int64 + +
+ +
Total amount of extra traffic purchased
+ +
+ +
+
+ extra_traffic_consumed + int64 + +
+ +
Total amount of extra traffic consumed
+ +
+ +
+
+ base_traffic_remainder + int64 + +
+ +
Amount of base traffic remaining
+ +
+ +
+
+ last_consumed_cost + uint64 + +
+ +
Cost deducted at `timestamp`, only present when traffic was consumed at `timestamp`, otherwise is set to 0
+ +
+ +
+
+ timestamp + int64 + +
+ +
Timestamp at which the state is valid
+ +
+ +
+
+ serial + uint32 + +
+ +
Optional serial of the balance update that updated the extra traffic limit
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.UnignoreEventsRequest

+ +

4 fields

+ +
+ + +
+ +
+
+ physical_synchronizer_id + string + +
+ +
+ +
+
+ from_inclusive + int64 + +
+ +
sequencer counter of the first event to unignore
+ +
+ +
+
+ to_inclusive + int64 + +
+ +
sequencer counter of the last event to unignore
+ +
+ +
+
+ force + bool + +
+ +
allow to proceed even if some clean events have sequencer counter greater or equal than `from_inclusive`
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.UnignoreEventsResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.UnvetDarRequest

+ +

2 fields

+ +
+ + +
+ +
+
+ main_package_id + string + +
+ +
+ +
+
+ synchronizer_id + string + +
+ +
the synchronizer on which to unvet the package. can be omitted if the participant is connected to only one synchronizer.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.UnvetDarResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.UploadDarRequest

+ +

4 fields

+ +
+ + +
+ +
+
+ dars + repeated UploadDarData + +
+ +
+ +
+
+ vet_all_packages + bool + +
+ +
If set to true (default), the node will register the vetting topology transactions on the specified synchronizer or autodetect the synchronizer if the participant is only connected to a single one. If multiple synchronizers are connected and no synchronizer is specified, the request returns a PACKAGE_SERVICE_CANNOT_AUTODETECT_SYNCHRONIZER error.
+ +
+ +
+
+ synchronize_vetting + bool + +
+ +
If set to true, we'll wait until the vetting transaction has been observed by this participant for the target synchronizer.
+ +
+ +
+
+ synchronizer_id + string + +
+ +
Used to specify the synchronizer to vet packages on when vet_all_packages is true.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.UploadDarRequest.UploadDarData

+ +

3 fields

+ +
+ + +
+ +
+
+ bytes + bytes + +
+ +
+ +
+
+ description + string + +
+ +
+ +
+
+ expected_main_package_id + string + +
+ +
optionally the expected package id of the main package
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.UploadDarResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ dar_ids + repeated string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ValidateDarRequest

+ +

3 fields

+ +
+ +

Performs the same checks that UploadDarRequest would perform, but doesn't upload the DAR.

+ + +
+ +
+
+ data + bytes + +
+ +
+ +
+
+ filename + string + +
+ +
+ +
+
+ synchronizer_id + string + +
+ +
Used to specify the synchronizer on which to validate that vetting is correct.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ValidateDarResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ main_package_id + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.VetDarRequest

+ +

3 fields

+ +
+ + +
+ +
+
+ main_package_id + string + +
+ +
+ +
+
+ synchronize + bool + +
+ +
if set to true, the API call waits until the vetting transaction has been observed by this participant on the specified synchronizer.
+ +
+ +
+
+ synchronizer_id + string + +
+ +
the synchronizer on which to vet the package. can be omitted if the participant is connected to only one synchronizer.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.VetDarResponse

+ +

0 fields

+ +
+ + + + +
diff --git a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-admin-pruning-v30.mdx b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-admin-pruning-v30.mdx index 4f91a13..3c57ec6 100644 --- a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-admin-pruning-v30.mdx +++ b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-admin-pruning-v30.mdx @@ -1,334 +1,795 @@ --- title: "com.digitalasset.canton.admin.pruning.v30" -description: "Descriptor-backed protobuf API history for package com.digitalasset.canton.admin.pruning.v30." +description: "Package-level overview for com.digitalasset.canton.admin.pruning.v30." --- -# Package `com.digitalasset.canton.admin.pruning.v30` +

Back to overview

+ +
+ +

Protobuf Package

+ + +

com.digitalasset.canton.admin.pruning.v30

+ + +

0 services, 0 endpoints, 28 messages

+ + +
+ + gRPC + +
+ + +
+ +
+
Files
+
1
+
+ +
+
Services
+
0
+
+ +
+
Endpoints
+
0
+
+ +
+
Messages
+
28
+
+ +
+
Enums
+
0
+
+ +
+ +
-[Back to Canton Protobuf History](../index) - -## Snapshot - -- Current files: `1` -- Current services: `0` -- Current endpoints: `0` -- Current messages: `28` -- Current enums: `0` -- Lifecycle endpoints tracked: `0` ## Source Files -| File | Services | Messages | Enums | Source | -| --- | --- | --- | --- | --- | -| community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto | `0` | `28` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto#L4) | - -## Type Reference - - -**Message `com.digitalasset.canton.admin.pruning.v30.ClearScheduleRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto#L42) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.pruning.v30.ClearScheduleResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto#L43) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.pruning.v30.FindPruningTimestampRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto#L60) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| index | `int32` | optional | the index to look up the offset for, needs to be 1 or larger
i.e. 1 for returning the first timestamp, 2 for the second timestamp etc | - - -**Message `com.digitalasset.canton.admin.pruning.v30.FindPruningTimestampResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto#L65) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| timestamp | `google.protobuf.Timestamp` | optional | optional, not set if less than `index` events exist | - - -**Message `com.digitalasset.canton.admin.pruning.v30.GetNoWaitCommitmentsFromRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto#L105) -- Fields: 2 - -Returns the state of no-wait-config at the time the request executes, with optional filtering on synchronizers and - counter participants - The response includes the status of the specified counter participants on the specified synchronizers, regardless of - whether these counter participants have shared contracts with the participant at the time the call executes. - If no counter participants / synchronizers are specified, the response includes all counter participants that are - known to the local participant at the time when the call executes, regardless of whether they have shared contracts - with the participant at the time the call executes. - Even if some participants may not be connected to some synchronizers at the time the query executes, the response still - includes them if they are known to the participant or specified in the arguments. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| synchronizer_ids | `string` | repeated | | -| participant_uids | `string` | repeated | | - - -**Message `com.digitalasset.canton.admin.pruning.v30.GetNoWaitCommitmentsFromResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto#L110) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| ignored_participants | [`com.digitalasset.canton.admin.pruning.v30.WaitCommitmentsSetup`](#type-com-digitalasset-canton-admin-pruning-v30-waitcommitmentssetup) | repeated | participants that are ignored | -| not_ignored_participants | [`com.digitalasset.canton.admin.pruning.v30.WaitCommitmentsSetup`](#type-com-digitalasset-canton-admin-pruning-v30-waitcommitmentssetup) | repeated | participants that are not ignored | - - -**Message `com.digitalasset.canton.admin.pruning.v30.GetParticipantScheduleRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto#L26) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.pruning.v30.GetParticipantScheduleResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto#L27) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| schedule | [`com.digitalasset.canton.admin.pruning.v30.ParticipantPruningSchedule`](#type-com-digitalasset-canton-admin-pruning-v30-participantpruningschedule) | optional | | - - -**Message `com.digitalasset.canton.admin.pruning.v30.GetScheduleRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto#L16) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.pruning.v30.GetScheduleResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto#L17) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| schedule | [`com.digitalasset.canton.admin.pruning.v30.PruningSchedule`](#type-com-digitalasset-canton-admin-pruning-v30-pruningschedule) | optional | | - - -**Message `com.digitalasset.canton.admin.pruning.v30.ParticipantPruningSchedule`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto#L37) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| schedule | [`com.digitalasset.canton.admin.pruning.v30.PruningSchedule`](#type-com-digitalasset-canton-admin-pruning-v30-pruningschedule) | optional | | -| prune_internally_only | `bool` | optional | | - - -**Message `com.digitalasset.canton.admin.pruning.v30.PruningSchedule`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto#L31) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| cron | `string` | optional | | -| max_duration | `google.protobuf.Duration` | optional | | -| retention | `google.protobuf.Duration` | optional | | - - -**Message `com.digitalasset.canton.admin.pruning.v30.ResetNoWaitCommitmentsFromRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto#L83) -- Fields: 2 - -deletes previous no-wait-configuration on the given synchronizers for the given counter participants - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| counter_participant_ids | `string` | repeated | an empty list has no effect | -| synchronizer_ids | `string` | repeated | an empty list has no effect | - - -**Message `com.digitalasset.canton.admin.pruning.v30.ResetNoWaitCommitmentsFromResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto#L90) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.pruning.v30.SetCronRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto#L45) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| cron | `string` | optional | | - - -**Message `com.digitalasset.canton.admin.pruning.v30.SetCronResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto#L48) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.pruning.v30.SetMaxDurationRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto#L50) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| max_duration | `google.protobuf.Duration` | optional | | - - -**Message `com.digitalasset.canton.admin.pruning.v30.SetMaxDurationResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto#L53) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.pruning.v30.SetNoWaitCommitmentsFromRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto#L72) -- Fields: 2 - -overwrites previous no-wait-configuration on the given synchronizers for the given counter participants - the request will fail if the counter_participant_ids or synchronizer_ids has an invalid format, or if duplicates are present in the repeated strings - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| counter_participant_ids | `string` | repeated | ignore the given participants; an empty list has no effect | -| synchronizer_ids | `string` | repeated | ignore the given participants on these synchronizers
an empty list has no effect | - - -**Message `com.digitalasset.canton.admin.pruning.v30.SetNoWaitCommitmentsFromResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto#L80) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.pruning.v30.SetParticipantScheduleRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto#L21) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| schedule | [`com.digitalasset.canton.admin.pruning.v30.ParticipantPruningSchedule`](#type-com-digitalasset-canton-admin-pruning-v30-participantpruningschedule) | optional | | - - -**Message `com.digitalasset.canton.admin.pruning.v30.SetParticipantScheduleResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto#L24) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.pruning.v30.SetRetentionRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto#L55) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| retention | `google.protobuf.Duration` | optional | | - - -**Message `com.digitalasset.canton.admin.pruning.v30.SetRetentionResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto#L58) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.pruning.v30.SetScheduleRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto#L11) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| schedule | [`com.digitalasset.canton.admin.pruning.v30.PruningSchedule`](#type-com-digitalasset-canton-admin-pruning-v30-pruningschedule) | optional | | - - -**Message `com.digitalasset.canton.admin.pruning.v30.SetScheduleResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto#L14) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.pruning.v30.Synchronizers`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto#L92) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| synchronizer_ids | `string` | repeated | | - - -**Message `com.digitalasset.canton.admin.pruning.v30.WaitCommitmentsSetup`** -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto#L117) -- Fields: 2 -_No description._ -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| counter_participant_uid | `string` | optional | | -| synchronizers | [`com.digitalasset.canton.admin.pruning.v30.Synchronizers`](#type-com-digitalasset-canton-admin-pruning-v30-synchronizers) | optional | | +
+ + +
+ +
+

community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
28
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/pruning/v30/pruning.proto
+
+ +
+ + +
+ + +
+ + + + + +## Type Inventory + + +These are the package-level message and enum shapes in the publish-version snapshot. + + + + +
+
+

com.digitalasset.canton.admin.pruning.v30.ClearScheduleRequest

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.admin.pruning.v30.ClearScheduleResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.admin.pruning.v30.FindPruningTimestampRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ index + int32 + +
+ +
the index to look up the offset for, needs to be 1 or larger i.e. 1 for returning the first timestamp, 2 for the second timestamp etc
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.pruning.v30.FindPruningTimestampResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ timestamp + Timestamp + +
+ +
optional, not set if less than `index` events exist
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.pruning.v30.GetNoWaitCommitmentsFromRequest

+ +

2 fields

+ +
+ +

Returns the state of no-wait-config at the time the request executes, with optional filtering on synchronizers and counter participants The response includes the status of the specified counter participants on the specified synchronizers, regardless of whether these counter participants have shared contracts with the participant at the time the call executes. If no counter participants / synchronizers are specified, the response includes all counter participants that are known to the local participant at the time when the call executes, regardless of whether they have shared contracts with the participant at the time the call executes. Even if some participants may not be connected to some synchronizers at the time the query executes, the response still includes them if they are known to the participant or specified in the arguments.

+ + +
+ +
+
+ synchronizer_ids + repeated string + +
+ +
+ +
+
+ participant_uids + repeated string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.pruning.v30.GetNoWaitCommitmentsFromResponse

+ +

2 fields

+ +
+ + +
+ +
+
+ ignored_participants + repeated WaitCommitmentsSetup + +
+ +
participants that are ignored
+ +
+ +
+
+ not_ignored_participants + repeated WaitCommitmentsSetup + +
+ +
participants that are not ignored
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.pruning.v30.WaitCommitmentsSetup

+ +

2 fields

+ +
+ + +
+ +
+
+ counter_participant_uid + string + +
+ +
+ +
+
+ synchronizers + Synchronizers + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.pruning.v30.Synchronizers

+ +

1 fields

+ +
+ + +
+ +
+
+ synchronizer_ids + repeated string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.pruning.v30.GetParticipantScheduleRequest

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.admin.pruning.v30.GetParticipantScheduleResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ schedule + ParticipantPruningSchedule + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.pruning.v30.ParticipantPruningSchedule

+ +

2 fields

+ +
+ + +
+ +
+
+ schedule + PruningSchedule + +
+ +
+ +
+
+ prune_internally_only + bool + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.pruning.v30.PruningSchedule

+ +

3 fields

+ +
+ + +
+ +
+
+ cron + string + +
+ +
+ +
+
+ max_duration + Duration + +
+ +
+ +
+
+ retention + Duration + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.pruning.v30.GetScheduleRequest

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.admin.pruning.v30.GetScheduleResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ schedule + PruningSchedule + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.pruning.v30.ResetNoWaitCommitmentsFromRequest

+ +

2 fields

+ +
+ +

deletes previous no-wait-configuration on the given synchronizers for the given counter participants

+ + +
+ +
+
+ counter_participant_ids + repeated string + +
+ +
an empty list has no effect
+ +
+ +
+
+ synchronizer_ids + repeated string + +
+ +
an empty list has no effect
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.pruning.v30.ResetNoWaitCommitmentsFromResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.admin.pruning.v30.SetCronRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ cron + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.pruning.v30.SetCronResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.admin.pruning.v30.SetMaxDurationRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ max_duration + Duration + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.pruning.v30.SetMaxDurationResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.admin.pruning.v30.SetNoWaitCommitmentsFromRequest

+ +

2 fields

+ +
+ +

overwrites previous no-wait-configuration on the given synchronizers for the given counter participants the request will fail if the counter_participant_ids or synchronizer_ids has an invalid format, or if duplicates are present in the repeated strings

+ + +
+ +
+
+ counter_participant_ids + repeated string + +
+ +
ignore the given participants; an empty list has no effect
+ +
+ +
+
+ synchronizer_ids + repeated string + +
+ +
ignore the given participants on these synchronizers an empty list has no effect
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.pruning.v30.SetNoWaitCommitmentsFromResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.admin.pruning.v30.SetParticipantScheduleRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ schedule + ParticipantPruningSchedule + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.pruning.v30.SetParticipantScheduleResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.admin.pruning.v30.SetRetentionRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ retention + Duration + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.pruning.v30.SetRetentionResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.admin.pruning.v30.SetScheduleRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ schedule + PruningSchedule + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.pruning.v30.SetScheduleResponse

+ +

0 fields

+ +
+ + + + +
diff --git a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-admin-sequencer-v30.mdx b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-admin-sequencer-v30.mdx index 8098bfd..d7994d9 100644 --- a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-admin-sequencer-v30.mdx +++ b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-admin-sequencer-v30.mdx @@ -1,250 +1,1057 @@ --- title: "com.digitalasset.canton.admin.sequencer.v30" -description: "Descriptor-backed protobuf API history for package com.digitalasset.canton.admin.sequencer.v30." +description: "Package-level overview for com.digitalasset.canton.admin.sequencer.v30." --- -# Package `com.digitalasset.canton.admin.sequencer.v30` +

Back to overview

+ +
+ +

Protobuf Package

+ + +

com.digitalasset.canton.admin.sequencer.v30

+ + +

1 services, 1 endpoints, 12 messages, 1 enums

+ + +
+ + gRPC + +
+ + +
+ +
+
Files
+
2
+
+ +
+
Services
+
1
+
+ +
+
Endpoints
+
1
+
+ +
+
Messages
+
12
+
+ +
+
Enums
+
1
+
+ +
+ +
-[Back to Canton Protobuf History](../index) - -## Snapshot - -- Current files: `2` -- Current services: `1` -- Current endpoints: `1` -- Current messages: `12` -- Current enums: `1` -- Lifecycle endpoints tracked: `1` ## Source Files -| File | Services | Messages | Enums | Source | -| --- | --- | --- | --- | --- | -| community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/sequencer/v30/sequencer_connection.proto | `0` | `4` | `1` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/sequencer/v30/sequencer_connection.proto#L4) | -| community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/sequencer/v30/sequencer_status_service.proto | `1` | `4` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/sequencer/v30/sequencer_status_service.proto#L4) | - -## Services - -| Service | Endpoints | Source | Description | -| --- | --- | --- | --- | -| [`SequencerStatusService`](#service-com-digitalasset-canton-admin-sequencer-v30-sequencerstatusservice) | `1` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/sequencer/v30/sequencer_status_service.proto#L10) | | - - -### Service `SequencerStatusService` - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/sequencer/v30/sequencer_status_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/sequencer/v30/sequencer_status_service.proto#L10) -- Endpoints tracked: `1` - -_No description._ - -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`SequencerStatus`](#endpoint-com-digitalasset-canton-admin-sequencer-v30-sequencerstatusservice-sequencerstatus) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.sequencer.v30.SequencerStatusRequest`](#type-com-digitalasset-canton-admin-sequencer-v30-sequencerstatusrequest) | [`com.digitalasset.canton.admin.sequencer.v30.SequencerStatusResponse`](#type-com-digitalasset-canton-admin-sequencer-v30-sequencerstatusresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/sequencer/v30/sequencer_status_service.proto#L11) | - - -**Endpoint `SequencerStatusService.SequencerStatus`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/sequencer/v30/sequencer_status_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/sequencer/v30/sequencer_status_service.proto#L11) - -**Signature** - -```protobuf -rpc SequencerStatusService.SequencerStatus(com.digitalasset.canton.admin.sequencer.v30.SequencerStatusRequest) returns (com.digitalasset.canton.admin.sequencer.v30.SequencerStatusResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.sequencer.v30.SequencerStatusRequest`](#type-com-digitalasset-canton-admin-sequencer-v30-sequencerstatusrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.sequencer.v30.SequencerStatusResponse`](#type-com-digitalasset-canton-admin-sequencer-v30-sequencerstatusresponse) - -## Type Reference - - -**Message `com.digitalasset.canton.admin.sequencer.v30.SequencerAdminStatus`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/sequencer/v30/sequencer_status_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/sequencer/v30/sequencer_status_service.proto#L54) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| accepts_admin_changes | `bool` | optional | Indicate if the sequencer node accepts administration changes, particularly relevant for HA sequencers
where admin change ability is determined via active-passive model | - - -**Message `com.digitalasset.canton.admin.sequencer.v30.SequencerConnection`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/sequencer/v30/sequencer_connection.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/sequencer/v30/sequencer_connection.proto#L11) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| grpc | [`com.digitalasset.canton.admin.sequencer.v30.SequencerConnection.Grpc`](#type-com-digitalasset-canton-admin-sequencer-v30-sequencerconnection-grpc) | optional | | -| alias | `string` | optional | | -| sequencer_id | `string` | optional | The id of the sequencer that serves the sequencer API.
If empty, the node sets it after the first connection.
If set, the node checks that the sequencer id reported by the sequencer
matches this id. | - - -**Message `com.digitalasset.canton.admin.sequencer.v30.SequencerConnection.Grpc`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/sequencer/v30/sequencer_connection.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/sequencer/v30/sequencer_connection.proto#L24) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| connections | `string` | repeated | connection information to sequencer (http[s]://<host>:<port>") | -| transport_security | `bool` | optional | Should the connection use TLS? | -| custom_trust_certificates | `bytes` | optional | | - - -**Message `com.digitalasset.canton.admin.sequencer.v30.SequencerConnectionPoolDelays`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/sequencer/v30/sequencer_connection.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/sequencer/v30/sequencer_connection.proto#L80) -- Fields: 4 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| min_restart_delay | `google.protobuf.Duration` | optional | Minimum duration after which a failed sequencer connection is restarted.
This value must be non-negative. | -| max_restart_delay | `google.protobuf.Duration` | optional | Maximum duration after which a failed sequencer connection is restarted.
This value must be non-negative. | -| subscription_request_delay | `google.protobuf.Duration` | optional | Delay between the attempts to obtain new sequencer connections for the sequencer subscription
pool, when the current number of subscriptions is below `trustThreshold` + `livenessMargin`.
This value must be non-negative. | -| warn_validation_delay | `google.protobuf.Duration` | optional | Duration after which a warning is issued if a started connection still fails validation.
This value must be non-negative. | - - -**Message `com.digitalasset.canton.admin.sequencer.v30.SequencerConnections`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/sequencer/v30/sequencer_connection.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/sequencer/v30/sequencer_connection.proto#L45) -- Fields: 5 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| sequencer_connections | [`com.digitalasset.canton.admin.sequencer.v30.SequencerConnection`](#type-com-digitalasset-canton-admin-sequencer-v30-sequencerconnection) | repeated | | -| sequencer_trust_threshold | `uint32` | optional | This field determines the minimum level of agreement, or consensus, required among the sequencers before a message
is considered reliable and accepted by the system.

This value must be positive. | -| submission_request_amplification | [`com.digitalasset.canton.admin.sequencer.v30.SubmissionRequestAmplification`](#type-com-digitalasset-canton-admin-sequencer-v30-submissionrequestamplification) | optional | | -| sequencer_liveness_margin | `uint32` | optional | This field determines the number of extra subscriptions to maintain beyond `sequencer_trust_threshold` in order
to ensure liveness. This is only used when the new connection pool is enabled, and is ignored otherwise.

This value must be non-negative. | -| sequencer_connection_pool_delays | [`com.digitalasset.canton.admin.sequencer.v30.SequencerConnectionPoolDelays`](#type-com-digitalasset-canton-admin-sequencer-v30-sequencerconnectionpooldelays) | optional | Configures the various delays used by the sequencer connection pool. | - - -**Message `com.digitalasset.canton.admin.sequencer.v30.SequencerHealthStatus`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/sequencer/v30/sequencer_status_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/sequencer/v30/sequencer_status_service.proto#L47) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| active | `bool` | optional | is the sequencer component active - can vary by implementation for what this means | -| details | `string` | optional | optionally set details on how sequencer is healthy/unhealthy | - - -**Message `com.digitalasset.canton.admin.sequencer.v30.SequencerStatusRequest`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/sequencer/v30/sequencer_status_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/sequencer/v30/sequencer_status_service.proto#L14) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.admin.sequencer.v30.SequencerStatusResponse`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/sequencer/v30/sequencer_status_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/sequencer/v30/sequencer_status_service.proto#L16) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| status | [`com.digitalasset.canton.admin.sequencer.v30.SequencerStatusResponse.SequencerStatusResponseStatus`](#type-com-digitalasset-canton-admin-sequencer-v30-sequencerstatusresponse-sequencerstatusresponsestatus) | optional | | -| not_initialized | [`com.digitalasset.canton.admin.health.v30.NotInitialized`](com-digitalasset-canton-admin-health-v30#type-com-digitalasset-canton-admin-health-v30-notinitialized) | optional | | - - -**Message `com.digitalasset.canton.admin.sequencer.v30.SequencerStatusResponse.ConnectedParticipant`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/sequencer/v30/sequencer_status_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/sequencer/v30/sequencer_status_service.proto#L22) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| uid | `string` | optional | | - - -**Message `com.digitalasset.canton.admin.sequencer.v30.SequencerStatusResponse.ConnectedMediator`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/sequencer/v30/sequencer_status_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/sequencer/v30/sequencer_status_service.proto#L26) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| uid | `string` | optional | | - - -**Message `com.digitalasset.canton.admin.sequencer.v30.SequencerStatusResponse.SequencerStatusResponseStatus`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/sequencer/v30/sequencer_status_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/sequencer/v30/sequencer_status_service.proto#L30) -- Fields: 7 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| common_status | [`com.digitalasset.canton.admin.health.v30.Status`](com-digitalasset-canton-admin-health-v30#type-com-digitalasset-canton-admin-health-v30-status) | optional | | -| connected_participants | [`com.digitalasset.canton.admin.sequencer.v30.SequencerStatusResponse.ConnectedParticipant`](#type-com-digitalasset-canton-admin-sequencer-v30-sequencerstatusresponse-connectedparticipant) | repeated | | -| connected_mediators | [`com.digitalasset.canton.admin.sequencer.v30.SequencerStatusResponse.ConnectedMediator`](#type-com-digitalasset-canton-admin-sequencer-v30-sequencerstatusresponse-connectedmediator) | repeated | | -| sequencer | [`com.digitalasset.canton.admin.sequencer.v30.SequencerHealthStatus`](#type-com-digitalasset-canton-admin-sequencer-v30-sequencerhealthstatus) | optional | required - status of the sequencer component it is running | -| physical_synchronizer_id | `string` | optional | | -| admin | [`com.digitalasset.canton.admin.sequencer.v30.SequencerAdminStatus`](#type-com-digitalasset-canton-admin-sequencer-v30-sequenceradminstatus) | optional | | -| protocol_version | `int32` | optional | | - - -**Message `com.digitalasset.canton.admin.sequencer.v30.SubmissionRequestAmplification`** - -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/sequencer/v30/sequencer_connection.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/sequencer/v30/sequencer_connection.proto#L68) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| factor | `uint32` | optional | Determines to how often the client should try to send a submission request that is eligible for deduplication.
A higher value increases the chance of a submission request being accepted by the system, but also increases the load on the sequencers
and thus the costs incurred by the client.
This value must be positive. | -| patience | `google.protobuf.Duration` | optional | Determines how long the sequencer client waits for observing the sequencing before it sends the submission request again.
This value must be non-negative. | - - -**Enum `com.digitalasset.canton.admin.sequencer.v30.SequencerConnectionValidation`** -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/sequencer/v30/sequencer_connection.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/sequencer/v30/sequencer_connection.proto#L33) -_No description._ -| Name | Number | -| --- | --- | -| SEQUENCER_CONNECTION_VALIDATION_UNSPECIFIED | `0` | -| SEQUENCER_CONNECTION_VALIDATION_DISABLED | `1` | -| SEQUENCER_CONNECTION_VALIDATION_ACTIVE | `2` | -| SEQUENCER_CONNECTION_VALIDATION_ALL | `3` | -| SEQUENCER_CONNECTION_VALIDATION_THRESHOLD_ACTIVE | `4` | +
+ + +
+ +
+

community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/sequencer/v30/sequencer_connection.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
4
+
+ +
+
Enums
+
1
+
+ +
+
Source
+
community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/sequencer/v30/sequencer_connection.proto
+
+ +
+ + +
+ + + +
+ +
+

community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/sequencer/v30/sequencer_status_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
4
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/sequencer/v30/sequencer_status_service.proto
+
+ +
+ + +
+ + +
+ + + + + +## SequencerStatusService + + + +
+ +
+
Source file
+
community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/sequencer/v30/sequencer_status_service.proto
+
+ +
+
Operations
+
1
+
+ +
+ + +
+ + + + +
+

SequencerStatusService.SequencerStatus

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc SequencerStatusService.SequencerStatus(com.digitalasset.canton.admin.sequencer.v30.SequencerStatusRequest) returns (com.digitalasset.canton.admin.sequencer.v30.SequencerStat...

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.sequencer.v30.SequencerStatusRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.sequencer.v30.SequencerStatusResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## Type Inventory + + +These are the package-level message and enum shapes in the publish-version snapshot. + + + + +
+
+

com.digitalasset.canton.admin.sequencer.v30.SequencerAdminStatus

+ +

1 fields

+ +
+ + +
+ +
+
+ accepts_admin_changes + bool + +
+ +
Indicate if the sequencer node accepts administration changes, particularly relevant for HA sequencers where admin change ability is determined via active-passive model
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.sequencer.v30.SequencerConnection

+ +

3 fields

+ +
+ + +
+ +
+
+ grpc + Grpc + +
+ +
+ +
+
+ alias + string + +
+ +
+ +
+
+ sequencer_id + string + +
+ +
The id of the sequencer that serves the sequencer API. If empty, the node sets it after the first connection. If set, the node checks that the sequencer id reported by the sequencer matches this id.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.sequencer.v30.SequencerConnection.Grpc

+ +

3 fields

+ +
+ + +
+ +
+
+ connections + repeated string + +
+ +
connection information to sequencer (http[s]://<host>:<port>")
+ +
+ +
+
+ transport_security + bool + +
+ +
Should the connection use TLS?
+ +
+ +
+
+ custom_trust_certificates + bytes + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.sequencer.v30.SequencerConnectionPoolDelays

+ +

4 fields

+ +
+ + +
+ +
+
+ min_restart_delay + Duration + +
+ +
Minimum duration after which a failed sequencer connection is restarted. This value must be non-negative.
+ +
+ +
+
+ max_restart_delay + Duration + +
+ +
Maximum duration after which a failed sequencer connection is restarted. This value must be non-negative.
+ +
+ +
+
+ subscription_request_delay + Duration + +
+ +
Delay between the attempts to obtain new sequencer connections for the sequencer subscription pool, when the current number of subscriptions is below `trustThreshold` + `livenessMargin`. This value must be non-negative.
+ +
+ +
+
+ warn_validation_delay + Duration + +
+ +
Duration after which a warning is issued if a started connection still fails validation. This value must be non-negative.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.sequencer.v30.SequencerConnections

+ +

5 fields

+ +
+ + +
+ +
+
+ sequencer_connections + repeated SequencerConnection + +
+ +
+ +
+
+ sequencer_trust_threshold + uint32 + +
+ +
This field determines the minimum level of agreement, or consensus, required among the sequencers before a message is considered reliable and accepted by the system. This value must be positive.
+ +
+ +
+
+ submission_request_amplification + SubmissionRequestAmplification + +
+ +
+ +
+
+ sequencer_liveness_margin + uint32 + +
+ +
This field determines the number of extra subscriptions to maintain beyond `sequencer_trust_threshold` in order to ensure liveness. This is only used when the new connection pool is enabled, and is ignored otherwise. This value must be non-negative.
+ +
+ +
+
+ sequencer_connection_pool_delays + SequencerConnectionPoolDelays + +
+ +
Configures the various delays used by the sequencer connection pool.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.sequencer.v30.SubmissionRequestAmplification

+ +

2 fields

+ +
+ + +
+ +
+
+ factor + uint32 + +
+ +
Determines to how often the client should try to send a submission request that is eligible for deduplication. A higher value increases the chance of a submission request being accepted by the system, but also increases the load on the sequencers and thus the costs incurred by the client. This value must be positive.
+ +
+ +
+
+ patience + Duration + +
+ +
Determines how long the sequencer client waits for observing the sequencing before it sends the submission request again. This value must be non-negative.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.sequencer.v30.SequencerHealthStatus

+ +

2 fields

+ +
+ + +
+ +
+
+ active + bool + +
+ +
is the sequencer component active - can vary by implementation for what this means
+ +
+ +
+
+ details + string + +
+ +
optionally set details on how sequencer is healthy/unhealthy
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.sequencer.v30.SequencerStatusRequest

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.admin.sequencer.v30.SequencerStatusResponse

+ +

2 fields

+ +
+ + +
+ +
+
+ status + SequencerStatusResponseStatus + +
+ +
+ +
+
+ not_initialized + NotInitialized + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.sequencer.v30.SequencerStatusResponse.ConnectedParticipant

+ +

1 fields

+ +
+ + +
+ +
+
+ uid + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.sequencer.v30.SequencerStatusResponse.ConnectedMediator

+ +

1 fields

+ +
+ + +
+ +
+
+ uid + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.sequencer.v30.SequencerStatusResponse.SequencerStatusResponseStatus

+ +

7 fields

+ +
+ + +
+ +
+
+ common_status + Status + +
+ +
+ +
+
+ connected_participants + repeated ConnectedParticipant + +
+ +
+ +
+
+ connected_mediators + repeated ConnectedMediator + +
+ +
+ +
+
+ sequencer + SequencerHealthStatus + +
+ +
required - status of the sequencer component it is running
+ +
+ +
+
+ physical_synchronizer_id + string + +
+ +
+ +
+
+ admin + SequencerAdminStatus + +
+ +
+ +
+
+ protocol_version + int32 + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.health.v30.Status

+ +

7 fields

+ +
+ + +
+ +
+
+ uid + string + +
+ +
+ +
+
+ uptime + Duration + +
+ +
+ +
+
+ ports + repeated map + +
+ +
+ +
+
+ active + bool + +
+ +
Indicate if the node is active, usually true unless it's a replicated node that is passive
+ +
+ +
+
+ topology_queues + TopologyQueueStatus + +
+ +
indicates the state of the topology queues (manager / dispatcher only where they exist)
+ +
+ +
+
+ components + repeated ComponentStatus + +
+ +
Health state of component dependencies of the node
+ +
+ +
+
+ version + string + +
+ +
Version of the binary
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.health.v30.TopologyQueueStatus

+ +

3 fields

+ +
+ + +
+ +
+
+ manager + uint32 + +
+ +
how many topology changes are currently queued at the manager
+ +
+ +
+
+ dispatcher + uint32 + +
+ +
how many topology changes are currently queued at the dispatcher
+ +
+ +
+
+ clients + uint32 + +
+ +
how many topology changes are currently waiting to become effective (across all connected synchronizers in the case of participants)
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.health.v30.ComponentStatus

+ +

5 fields

+ +
+ + +
+ +
+
+ name + string + +
+ +
+ +
+
+ ok + StatusData + +
+ +
+ +
+
+ degraded + StatusData + +
+ +
+ +
+
+ failed + StatusData + +
+ +
+ +
+
+ fatal + StatusData + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.health.v30.ComponentStatus.StatusData

+ +

1 fields

+ +
+ + +
+ +
+
+ description + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.health.v30.NotInitialized

+ +

2 fields

+ +
+ + +
+ +
+
+ active + bool + +
+ +
Indicate if the node is active, usually true unless it's a replicated node that is passive
+ +
+ +
+
+ waiting_for_external_input + WaitingForExternalInput + +
+ +
Indicates whether the node is waiting for external input
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.health.v30.NotInitialized.WaitingForExternalInput

+ +

4 values

+ +
+ + + +
    + +
  • WAITING_FOR_EXTERNAL_INPUT_UNSPECIFIED
    • + +
  • WAITING_FOR_EXTERNAL_INPUT_ID
    • + +
  • WAITING_FOR_EXTERNAL_INPUT_NODE_TOPOLOGY
    • + +
  • WAITING_FOR_EXTERNAL_INPUT_INITIALIZATION
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.admin.sequencer.v30.SequencerConnectionValidation

+ +

5 values

+ +
+ + + +
    + +
  • SEQUENCER_CONNECTION_VALIDATION_UNSPECIFIED
    • + +
  • SEQUENCER_CONNECTION_VALIDATION_DISABLED
    • + +
  • SEQUENCER_CONNECTION_VALIDATION_ACTIVE
    • + +
  • SEQUENCER_CONNECTION_VALIDATION_ALL
    • + +
  • SEQUENCER_CONNECTION_VALIDATION_THRESHOLD_ACTIVE
    • + +
+ + +
diff --git a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-admin-time-v30.mdx b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-admin-time-v30.mdx index 1e5d349..bbf79dc 100644 --- a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-admin-time-v30.mdx +++ b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-admin-time-v30.mdx @@ -1,57 +1,215 @@ --- title: "com.digitalasset.canton.admin.time.v30" -description: "Descriptor-backed protobuf API history for package com.digitalasset.canton.admin.time.v30." +description: "Package-level overview for com.digitalasset.canton.admin.time.v30." --- -# Package `com.digitalasset.canton.admin.time.v30` +

Back to overview

-[Back to Canton Protobuf History](../index) +
+ +

Protobuf Package

+ + +

com.digitalasset.canton.admin.time.v30

+ + +

0 services, 0 endpoints, 2 messages

+ + +
+ + gRPC + +
-## Snapshot + +
+ +
+
Files
+
1
+
+ +
+
Services
+
0
+
+ +
+
Endpoints
+
0
+
+ +
+
Messages
+
2
+
+ +
+
Enums
+
0
+
+ +
+ +
-- Current files: `1` -- Current services: `0` -- Current endpoints: `0` -- Current messages: `2` -- Current enums: `0` -- Lifecycle endpoints tracked: `0` ## Source Files -| File | Services | Messages | Enums | Source | -| --- | --- | --- | --- | --- | -| community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/time/v30/time_tracker_config.proto | `0` | `2` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/time/v30/time_tracker_config.proto#L4) | -## Type Reference - -**Message `com.digitalasset.canton.admin.time.v30.SynchronizerTimeTrackerConfig`** -- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/time/v30/time_tracker_config.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/time/v30/time_tracker_config.proto#L21) -- Fields: 4 +
+ + +
+ +
+

community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/time/v30/time_tracker_config.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
2
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/time/v30/time_tracker_config.proto
+
+ +
+ + +
+ + +
+ + + + + +## Type Inventory + + +These are the package-level message and enum shapes in the publish-version snapshot. + -_No description._ -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| observation_latency | `google.protobuf.Duration` | optional | | -| patience_duration | `google.protobuf.Duration` | optional | | -| min_observation_duration | `google.protobuf.Duration` | optional | | -| time_proof_request | [`com.digitalasset.canton.admin.time.v30.TimeProofRequestConfig`](#type-com-digitalasset-canton-admin-time-v30-timeproofrequestconfig) | optional | | - -**Message `com.digitalasset.canton.admin.time.v30.TimeProofRequestConfig`** +
+
+

com.digitalasset.canton.admin.time.v30.SynchronizerTimeTrackerConfig

+ +

4 fields

+ +
+ + +
+ +
+
+ observation_latency + Duration + +
+ +
+ +
+
+ patience_duration + Duration + +
+ +
+ +
+
+ min_observation_duration + Duration + +
+ +
+ +
+
+ time_proof_request + TimeProofRequestConfig + +
+ +
+ +
-- Source: [community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/time/v30/time_tracker_config.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/time/v30/time_tracker_config.proto#L15) -- Fields: 3 + + +
-these structures are only used for where the configuration can be adjusted - at runtime using the participant synchronizer connectivity commands and services. - however they are defined here in common to be sat alongside the scala definitions - themselves. +
+
+

com.digitalasset.canton.admin.time.v30.TimeProofRequestConfig

+ +

3 fields

+ +
+ +

these structures are only used for where the configuration can be adjusted at runtime using the participant synchronizer connectivity commands and services. however they are defined here in common to be sat alongside the scala definitions themselves.

+ + +
+ +
+
+ initial_retry_delay + Duration + +
+ +
+ +
+
+ max_retry_delay + Duration + +
+ +
+ +
+
+ max_sequencing_delay + Duration + +
+ +
+ +
-| Field | Type | Label | Description | -| --- | --- | --- | --- | -| initial_retry_delay | `google.protobuf.Duration` | optional | | -| max_retry_delay | `google.protobuf.Duration` | optional | | -| max_sequencing_delay | `google.protobuf.Duration` | optional | | + + +
diff --git a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-connection-v30.mdx b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-connection-v30.mdx index 43ca17b..ac609b0 100644 --- a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-connection-v30.mdx +++ b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-connection-v30.mdx @@ -1,95 +1,232 @@ --- title: "com.digitalasset.canton.connection.v30" -description: "Descriptor-backed protobuf API history for package com.digitalasset.canton.connection.v30." +description: "Package-level overview for com.digitalasset.canton.connection.v30." --- -# Package `com.digitalasset.canton.connection.v30` +

Back to overview

+ +
+ +

Protobuf Package

+ + +

com.digitalasset.canton.connection.v30

+ + +

1 services, 1 endpoints, 2 messages

+ + +
+ + gRPC + +
+ + +
+ +
+
Files
+
1
+
+ +
+
Services
+
1
+
+ +
+
Endpoints
+
1
+
+ +
+
Messages
+
2
+
+ +
+
Enums
+
0
+
+ +
+ +
-[Back to Canton Protobuf History](../index) - -## Snapshot - -- Current files: `1` -- Current services: `1` -- Current endpoints: `1` -- Current messages: `2` -- Current enums: `0` -- Lifecycle endpoints tracked: `1` ## Source Files -| File | Services | Messages | Enums | Source | -| --- | --- | --- | --- | --- | -| community/base/src/main/protobuf/com/digitalasset/canton/connection/v30/api_info.proto | `1` | `2` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/connection/v30/api_info.proto#L4) | -## Services -| Service | Endpoints | Source | Description | -| --- | --- | --- | --- | -| [`ApiInfoService`](#service-com-digitalasset-canton-connection-v30-apiinfoservice) | `1` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/connection/v30/api_info.proto#L10) | Provides basic information about the API, like if it is an admin api or public sequencer api. This is useful to detec... | - -### Service `ApiInfoService` +
+ + +
+ +
+

community/base/src/main/protobuf/com/digitalasset/canton/connection/v30/api_info.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
2
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/base/src/main/protobuf/com/digitalasset/canton/connection/v30/api_info.proto
+
+ +
+ + +
+ + +
+ + + + + +## ApiInfoService -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/connection/v30/api_info.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/connection/v30/api_info.proto#L10) -- Endpoints tracked: `1` Provides basic information about the API, like if it is an admin api or public sequencer api. This is useful to detect port misconfigurations and provide a user-friendly error message. -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`GetApiInfo`](#endpoint-com-digitalasset-canton-connection-v30-apiinfoservice-getapiinfo) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.connection.v30.GetApiInfoRequest`](#type-com-digitalasset-canton-connection-v30-getapiinforequest) | [`com.digitalasset.canton.connection.v30.GetApiInfoResponse`](#type-com-digitalasset-canton-connection-v30-getapiinforesponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/connection/v30/api_info.proto#L11) | - - -**Endpoint `ApiInfoService.GetApiInfo`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/connection/v30/api_info.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/connection/v30/api_info.proto#L11) - -**Signature** - -```protobuf -rpc ApiInfoService.GetApiInfo(com.digitalasset.canton.connection.v30.GetApiInfoRequest) returns (com.digitalasset.canton.connection.v30.GetApiInfoResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.connection.v30.GetApiInfoRequest`](#type-com-digitalasset-canton-connection-v30-getapiinforequest) - -**Response Type** - -- [`com.digitalasset.canton.connection.v30.GetApiInfoResponse`](#type-com-digitalasset-canton-connection-v30-getapiinforesponse) - -## Type Reference - - -**Message `com.digitalasset.canton.connection.v30.GetApiInfoRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/connection/v30/api_info.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/connection/v30/api_info.proto#L14) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.connection.v30.GetApiInfoResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/connection/v30/api_info.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/connection/v30/api_info.proto#L16) -- Fields: 1 - -_No description._ -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| name | `string` | optional | | +
+ +
+
Source file
+
community/base/src/main/protobuf/com/digitalasset/canton/connection/v30/api_info.proto
+
+ +
+
Operations
+
1
+
+ +
+ + +
+ + + + +
+

ApiInfoService.GetApiInfo

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc ApiInfoService.GetApiInfo(com.digitalasset.canton.connection.v30.GetApiInfoRequest) returns (com.digitalasset.canton.connection.v30.GetApiInfoResponse);

+ + +
+ +
+
Request
+
com.digitalasset.canton.connection.v30.GetApiInfoRequest
+
+ +
+
Response
+
com.digitalasset.canton.connection.v30.GetApiInfoResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## Type Inventory + + +These are the package-level message and enum shapes in the publish-version snapshot. + + + + +
+
+

com.digitalasset.canton.connection.v30.GetApiInfoRequest

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.connection.v30.GetApiInfoResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ name + string + +
+ +
+ +
+ + + +
diff --git a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-crypto-admin-v30.mdx b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-crypto-admin-v30.mdx index 9a9c340..f93753d 100644 --- a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-crypto-admin-v30.mdx +++ b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-crypto-admin-v30.mdx @@ -1,38 +1,114 @@ --- title: "com.digitalasset.canton.crypto.admin.v30" -description: "Descriptor-backed protobuf API history for package com.digitalasset.canton.crypto.admin.v30." +description: "Package-level overview for com.digitalasset.canton.crypto.admin.v30." --- -# Package `com.digitalasset.canton.crypto.admin.v30` +

Back to overview

+ +
+ +

Protobuf Package

+ + +

com.digitalasset.canton.crypto.admin.v30

+ + +

1 services, 12 endpoints, 33 messages

+ + +
+ + gRPC + +
+ + +
+ +
+
Files
+
1
+
+ +
+
Services
+
1
+
+ +
+
Endpoints
+
12
+
+ +
+
Messages
+
33
+
+ +
+
Enums
+
0
+
+ +
+ +
-[Back to Canton Protobuf History](../index) - -## Snapshot - -- Current files: `1` -- Current services: `1` -- Current endpoints: `12` -- Current messages: `33` -- Current enums: `0` -- Lifecycle endpoints tracked: `12` ## Source Files -| File | Services | Messages | Enums | Source | -| --- | --- | --- | --- | --- | -| community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto | `1` | `32` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L4) | -## Services -| Service | Endpoints | Source | Description | -| --- | --- | --- | --- | -| [`VaultService`](#service-com-digitalasset-canton-crypto-admin-v30-vaultservice) | `12` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L27) | * Vault service providing programmatic access to locally stored keys and certificates We have two key-stores: a priva... | - -### Service `VaultService` +
+ + +
+ +
+

community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
32
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto
+
+ +
+ + +
+ + +
+ + + + + +## VaultService -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L27) -- Endpoints tracked: `12` * Vault service providing programmatic access to locally stored keys and certificates @@ -51,817 +127,2015 @@ description: "Descriptor-backed protobuf API history for package com.digitalasse In addition, we also provide access to the locally stored certificates which are used either by the HTTP/1.1 sequencer client or for legal identity claims. -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`DeleteKeyPair`](#endpoint-com-digitalasset-canton-crypto-admin-v30-vaultservice-deletekeypair) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.crypto.admin.v30.DeleteKeyPairRequest`](#type-com-digitalasset-canton-crypto-admin-v30-deletekeypairrequest) | [`com.digitalasset.canton.crypto.admin.v30.DeleteKeyPairResponse`](#type-com-digitalasset-canton-crypto-admin-v30-deletekeypairresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L93) | -| [`ExportKeyPair`](#endpoint-com-digitalasset-canton-crypto-admin-v30-vaultservice-exportkeypair) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.crypto.admin.v30.ExportKeyPairRequest`](#type-com-digitalasset-canton-crypto-admin-v30-exportkeypairrequest) | [`com.digitalasset.canton.crypto.admin.v30.ExportKeyPairResponse`](#type-com-digitalasset-canton-crypto-admin-v30-exportkeypairresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L89) | -| [`GenerateEncryptionKey`](#endpoint-com-digitalasset-canton-crypto-admin-v30-vaultservice-generateencryptionkey) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.crypto.admin.v30.GenerateEncryptionKeyRequest`](#type-com-digitalasset-canton-crypto-admin-v30-generateencryptionkeyrequest) | [`com.digitalasset.canton.crypto.admin.v30.GenerateEncryptionKeyResponse`](#type-com-digitalasset-canton-crypto-admin-v30-generateencryptionkeyresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L50) | -| [`GenerateSigningKey`](#endpoint-com-digitalasset-canton-crypto-admin-v30-vaultservice-generatesigningkey) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.crypto.admin.v30.GenerateSigningKeyRequest`](#type-com-digitalasset-canton-crypto-admin-v30-generatesigningkeyrequest) | [`com.digitalasset.canton.crypto.admin.v30.GenerateSigningKeyResponse`](#type-com-digitalasset-canton-crypto-admin-v30-generatesigningkeyresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L43) | -| [`GetWrapperKeyId`](#endpoint-com-digitalasset-canton-crypto-admin-v30-vaultservice-getwrapperkeyid) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.crypto.admin.v30.GetWrapperKeyIdRequest`](#type-com-digitalasset-canton-crypto-admin-v30-getwrapperkeyidrequest) | [`com.digitalasset.canton.crypto.admin.v30.GetWrapperKeyIdResponse`](#type-com-digitalasset-canton-crypto-admin-v30-getwrapperkeyidresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L87) | -| [`ImportKeyPair`](#endpoint-com-digitalasset-canton-crypto-admin-v30-vaultservice-importkeypair) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.crypto.admin.v30.ImportKeyPairRequest`](#type-com-digitalasset-canton-crypto-admin-v30-importkeypairrequest) | [`com.digitalasset.canton.crypto.admin.v30.ImportKeyPairResponse`](#type-com-digitalasset-canton-crypto-admin-v30-importkeypairresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L91) | -| [`ImportPublicKey`](#endpoint-com-digitalasset-canton-crypto-admin-v30-vaultservice-importpublickey) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.crypto.admin.v30.ImportPublicKeyRequest`](#type-com-digitalasset-canton-crypto-admin-v30-importpublickeyrequest) | [`com.digitalasset.canton.crypto.admin.v30.ImportPublicKeyResponse`](#type-com-digitalasset-canton-crypto-admin-v30-importpublickeyresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L72) | -| [`ListMyKeys`](#endpoint-com-digitalasset-canton-crypto-admin-v30-vaultservice-listmykeys) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.crypto.admin.v30.ListMyKeysRequest`](#type-com-digitalasset-canton-crypto-admin-v30-listmykeysrequest) | [`com.digitalasset.canton.crypto.admin.v30.ListMyKeysResponse`](#type-com-digitalasset-canton-crypto-admin-v30-listmykeysresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L36) | -| [`ListPublicKeys`](#endpoint-com-digitalasset-canton-crypto-admin-v30-vaultservice-listpublickeys) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.crypto.admin.v30.ListPublicKeysRequest`](#type-com-digitalasset-canton-crypto-admin-v30-listpublickeysrequest) | [`com.digitalasset.canton.crypto.admin.v30.ListPublicKeysResponse`](#type-com-digitalasset-canton-crypto-admin-v30-listpublickeysresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L80) | -| [`RegisterKmsEncryptionKey`](#endpoint-com-digitalasset-canton-crypto-admin-v30-vaultservice-registerkmsencryptionkey) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.crypto.admin.v30.RegisterKmsEncryptionKeyRequest`](#type-com-digitalasset-canton-crypto-admin-v30-registerkmsencryptionkeyrequest) | [`com.digitalasset.canton.crypto.admin.v30.RegisterKmsEncryptionKeyResponse`](#type-com-digitalasset-canton-crypto-admin-v30-registerkmsencryptionkeyresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L57) | -| [`RegisterKmsSigningKey`](#endpoint-com-digitalasset-canton-crypto-admin-v30-vaultservice-registerkmssigningkey) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.crypto.admin.v30.RegisterKmsSigningKeyRequest`](#type-com-digitalasset-canton-crypto-admin-v30-registerkmssigningkeyrequest) | [`com.digitalasset.canton.crypto.admin.v30.RegisterKmsSigningKeyResponse`](#type-com-digitalasset-canton-crypto-admin-v30-registerkmssigningkeyresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L64) | -| [`RotateWrapperKey`](#endpoint-com-digitalasset-canton-crypto-admin-v30-vaultservice-rotatewrapperkey) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.crypto.admin.v30.RotateWrapperKeyRequest`](#type-com-digitalasset-canton-crypto-admin-v30-rotatewrapperkeyrequest) | [`com.digitalasset.canton.crypto.admin.v30.RotateWrapperKeyResponse`](#type-com-digitalasset-canton-crypto-admin-v30-rotatewrapperkeyresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L85) | - - -**Endpoint `VaultService.DeleteKeyPair`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L93) - -**Signature** - -```protobuf -rpc VaultService.DeleteKeyPair(com.digitalasset.canton.crypto.admin.v30.DeleteKeyPairRequest) returns (com.digitalasset.canton.crypto.admin.v30.DeleteKeyPairResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.crypto.admin.v30.DeleteKeyPairRequest`](#type-com-digitalasset-canton-crypto-admin-v30-deletekeypairrequest) - -**Response Type** - -- [`com.digitalasset.canton.crypto.admin.v30.DeleteKeyPairResponse`](#type-com-digitalasset-canton-crypto-admin-v30-deletekeypairresponse) - - -**Endpoint `VaultService.ExportKeyPair`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L89) - -**Signature** - -```protobuf -rpc VaultService.ExportKeyPair(com.digitalasset.canton.crypto.admin.v30.ExportKeyPairRequest) returns (com.digitalasset.canton.crypto.admin.v30.ExportKeyPairResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.crypto.admin.v30.ExportKeyPairRequest`](#type-com-digitalasset-canton-crypto-admin-v30-exportkeypairrequest) - -**Response Type** - -- [`com.digitalasset.canton.crypto.admin.v30.ExportKeyPairResponse`](#type-com-digitalasset-canton-crypto-admin-v30-exportkeypairresponse) - - -**Endpoint `VaultService.GenerateEncryptionKey`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L50) - -**Signature** - -```protobuf -rpc VaultService.GenerateEncryptionKey(com.digitalasset.canton.crypto.admin.v30.GenerateEncryptionKeyRequest) returns (com.digitalasset.canton.crypto.admin.v30.GenerateEncryptionKeyResponse); -``` - -* - Generates a new public / private key pair for hybrid encryption. - - Stores the private key in the vault, and returns the public key - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.crypto.admin.v30.GenerateEncryptionKeyRequest`](#type-com-digitalasset-canton-crypto-admin-v30-generateencryptionkeyrequest) - -**Response Type** - -- [`com.digitalasset.canton.crypto.admin.v30.GenerateEncryptionKeyResponse`](#type-com-digitalasset-canton-crypto-admin-v30-generateencryptionkeyresponse) - - -**Endpoint `VaultService.GenerateSigningKey`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L43) - -**Signature** - -```protobuf -rpc VaultService.GenerateSigningKey(com.digitalasset.canton.crypto.admin.v30.GenerateSigningKeyRequest) returns (com.digitalasset.canton.crypto.admin.v30.GenerateSigningKeyResponse); -``` - -* - Generates a new public / private key pair for signing. - - Stores the private key in the vault, and returns the public key - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.crypto.admin.v30.GenerateSigningKeyRequest`](#type-com-digitalasset-canton-crypto-admin-v30-generatesigningkeyrequest) - -**Response Type** - -- [`com.digitalasset.canton.crypto.admin.v30.GenerateSigningKeyResponse`](#type-com-digitalasset-canton-crypto-admin-v30-generatesigningkeyresponse) - - -**Endpoint `VaultService.GetWrapperKeyId`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L87) - -**Signature** - -```protobuf -rpc VaultService.GetWrapperKeyId(com.digitalasset.canton.crypto.admin.v30.GetWrapperKeyIdRequest) returns (com.digitalasset.canton.crypto.admin.v30.GetWrapperKeyIdResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.crypto.admin.v30.GetWrapperKeyIdRequest`](#type-com-digitalasset-canton-crypto-admin-v30-getwrapperkeyidrequest) - -**Response Type** - -- [`com.digitalasset.canton.crypto.admin.v30.GetWrapperKeyIdResponse`](#type-com-digitalasset-canton-crypto-admin-v30-getwrapperkeyidresponse) - - -**Endpoint `VaultService.ImportKeyPair`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L91) - -**Signature** - -```protobuf -rpc VaultService.ImportKeyPair(com.digitalasset.canton.crypto.admin.v30.ImportKeyPairRequest) returns (com.digitalasset.canton.crypto.admin.v30.ImportKeyPairResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.crypto.admin.v30.ImportKeyPairRequest`](#type-com-digitalasset-canton-crypto-admin-v30-importkeypairrequest) - -**Response Type** - -- [`com.digitalasset.canton.crypto.admin.v30.ImportKeyPairResponse`](#type-com-digitalasset-canton-crypto-admin-v30-importkeypairresponse) - - -**Endpoint `VaultService.ImportPublicKey`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L72) - -**Signature** - -```protobuf -rpc VaultService.ImportPublicKey(com.digitalasset.canton.crypto.admin.v30.ImportPublicKeyRequest) returns (com.digitalasset.canton.crypto.admin.v30.ImportPublicKeyResponse); -``` - -* - Import a public key into the registry in order to provide that Fingerprint -> PublicKey lookups - - @param: ImportPublicKeyRequest serialized public key to be imported - @return: fingerprint and serialized public key of imported public key - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.crypto.admin.v30.ImportPublicKeyRequest`](#type-com-digitalasset-canton-crypto-admin-v30-importpublickeyrequest) - -**Response Type** - -- [`com.digitalasset.canton.crypto.admin.v30.ImportPublicKeyResponse`](#type-com-digitalasset-canton-crypto-admin-v30-importpublickeyresponse) - - -**Endpoint `VaultService.ListMyKeys`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L36) - -**Signature** - -```protobuf -rpc VaultService.ListMyKeys(com.digitalasset.canton.crypto.admin.v30.ListMyKeysRequest) returns (com.digitalasset.canton.crypto.admin.v30.ListMyKeysResponse); -``` - -* - List public keys according to request filter for which we have a private key in our key vault. - - The request includes a filter for fingerprints which can be used for lookups. - - @param ListMyKeysRequest: request with optional fingerprint filter - @return: all serialized keys and metadata that have the fingerprint filter as a substring in their fingerprint - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.crypto.admin.v30.ListMyKeysRequest`](#type-com-digitalasset-canton-crypto-admin-v30-listmykeysrequest) - -**Response Type** - -- [`com.digitalasset.canton.crypto.admin.v30.ListMyKeysResponse`](#type-com-digitalasset-canton-crypto-admin-v30-listmykeysresponse) - - -**Endpoint `VaultService.ListPublicKeys`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L80) - -**Signature** - -```protobuf -rpc VaultService.ListPublicKeys(com.digitalasset.canton.crypto.admin.v30.ListPublicKeysRequest) returns (com.digitalasset.canton.crypto.admin.v30.ListPublicKeysResponse); -``` - -* - Lists all public keys matching the supplied filter which are internally cached - - Any public key returned here can be referenced in topology transaction building - by fingerprint. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.crypto.admin.v30.ListPublicKeysRequest`](#type-com-digitalasset-canton-crypto-admin-v30-listpublickeysrequest) - -**Response Type** - -- [`com.digitalasset.canton.crypto.admin.v30.ListPublicKeysResponse`](#type-com-digitalasset-canton-crypto-admin-v30-listpublickeysresponse) - - -**Endpoint `VaultService.RegisterKmsEncryptionKey`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L57) - -**Signature** - -```protobuf -rpc VaultService.RegisterKmsEncryptionKey(com.digitalasset.canton.crypto.admin.v30.RegisterKmsEncryptionKeyRequest) returns (com.digitalasset.canton.crypto.admin.v30.RegisterKmsEncryptionKeyResponse); -``` - -* - Registers a KMS key for asymmetric/hybrid encryption. - - Stores the corresponding public key in the vault, and returns it - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.crypto.admin.v30.RegisterKmsEncryptionKeyRequest`](#type-com-digitalasset-canton-crypto-admin-v30-registerkmsencryptionkeyrequest) - -**Response Type** - -- [`com.digitalasset.canton.crypto.admin.v30.RegisterKmsEncryptionKeyResponse`](#type-com-digitalasset-canton-crypto-admin-v30-registerkmsencryptionkeyresponse) - - -**Endpoint `VaultService.RegisterKmsSigningKey`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L64) - -**Signature** - -```protobuf -rpc VaultService.RegisterKmsSigningKey(com.digitalasset.canton.crypto.admin.v30.RegisterKmsSigningKeyRequest) returns (com.digitalasset.canton.crypto.admin.v30.RegisterKmsSigningKeyResponse); -``` - -* - Registers a KMS key for signing. - - Stores the corresponding public key in the vault, and returns it - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.crypto.admin.v30.RegisterKmsSigningKeyRequest`](#type-com-digitalasset-canton-crypto-admin-v30-registerkmssigningkeyrequest) - -**Response Type** - -- [`com.digitalasset.canton.crypto.admin.v30.RegisterKmsSigningKeyResponse`](#type-com-digitalasset-canton-crypto-admin-v30-registerkmssigningkeyresponse) - - -**Endpoint `VaultService.RotateWrapperKey`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L85) - -**Signature** - -```protobuf -rpc VaultService.RotateWrapperKey(com.digitalasset.canton.crypto.admin.v30.RotateWrapperKeyRequest) returns (com.digitalasset.canton.crypto.admin.v30.RotateWrapperKeyResponse); -``` - -* - Changes the wrapper key that is used to encrypt private keys when stored - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.crypto.admin.v30.RotateWrapperKeyRequest`](#type-com-digitalasset-canton-crypto-admin-v30-rotatewrapperkeyrequest) - -**Response Type** - -- [`com.digitalasset.canton.crypto.admin.v30.RotateWrapperKeyResponse`](#type-com-digitalasset-canton-crypto-admin-v30-rotatewrapperkeyresponse) - -## Type Reference - - -**Message `com.digitalasset.canton.crypto.admin.v30.DeleteKeyPairRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L271) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| fingerprint | `string` | optional | | - - -**Message `com.digitalasset.canton.crypto.admin.v30.DeleteKeyPairResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L275) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.crypto.admin.v30.ExportKeyPairRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L243) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| fingerprint | `string` | optional | The id of the keypair to export | -| protocol_version | `int32` | optional | The protocol version that defines the serialization of the keypair | -| password | `string` | optional | Optional password to use for encrypting the exported keypair
NOTE: The request should be made over a TLS connection to this service | - - -**Message `com.digitalasset.canton.crypto.admin.v30.ExportKeyPairResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L255) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| key_pair | `bytes` | optional | | - - -**Message `com.digitalasset.canton.crypto.admin.v30.GenerateCertificateRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L96) -- Fields: 4 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| unique_identifier | `string` | optional | unique identifier to be used for CN | -| certificate_key | `string` | optional | the private key fingerprint to use for this certificate | -| additional_subject | `string` | optional | optional additional X500 names | -| subject_alternative_names | `string` | repeated | the additional subject names to be added to this certificate | - - -**Message `com.digitalasset.canton.crypto.admin.v30.GenerateCertificateResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L107) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| x509_cert | `string` | optional | the certificate in PEM format | - - -**Message `com.digitalasset.canton.crypto.admin.v30.GenerateEncryptionKeyRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L195) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| key_spec | [`com.digitalasset.canton.crypto.v30.EncryptionKeySpec`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-encryptionkeyspec) | optional | | -| name | `string` | optional | optional descriptive name for the key | - - -**Message `com.digitalasset.canton.crypto.admin.v30.GenerateEncryptionKeyResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L202) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| public_key | [`com.digitalasset.canton.crypto.v30.EncryptionPublicKey`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-encryptionpublickey) | optional | | - - -**Message `com.digitalasset.canton.crypto.admin.v30.GenerateSigningKeyRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L181) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| key_spec | [`com.digitalasset.canton.crypto.v30.SigningKeySpec`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-signingkeyspec) | optional | | -| name | `string` | optional | optional descriptive name for the key | -| usage | [`com.digitalasset.canton.crypto.v30.SigningKeyUsage`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-signingkeyusage) | repeated | key can only be used for the specified usage | - - -**Message `com.digitalasset.canton.crypto.admin.v30.GenerateSigningKeyResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L191) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| public_key | [`com.digitalasset.canton.crypto.v30.SigningPublicKey`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-signingpublickey) | optional | | - - -**Message `com.digitalasset.canton.crypto.admin.v30.GetWrapperKeyIdRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L237) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.crypto.admin.v30.GetWrapperKeyIdResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L239) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| wrapper_key_id | `string` | optional | | - - -**Message `com.digitalasset.canton.crypto.admin.v30.ImportCertificateRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L123) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| x509_cert | `string` | optional | X509 certificate as PEM | - - -**Message `com.digitalasset.canton.crypto.admin.v30.ImportCertificateResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L128) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| certificate_id | `string` | optional | | - - -**Message `com.digitalasset.canton.crypto.admin.v30.ImportKeyPairRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L259) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| key_pair | `bytes` | optional | | -| name | `string` | optional | | -| password | `string` | optional | Optional password to use for decrypting the exported keypair
NOTE: The request should be made over a TLS connection to this service | - - -**Message `com.digitalasset.canton.crypto.admin.v30.ImportKeyPairResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L269) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.crypto.admin.v30.ImportPublicKeyRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L132) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| public_key | `bytes` | optional | import a crypto.PublicKey protobuf serialized key | -| name | `string` | optional | an optional name that should be stored along side the key | - - -**Message `com.digitalasset.canton.crypto.admin.v30.ImportPublicKeyResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L139) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| fingerprint | `string` | optional | fingerprint of imported key | - - -**Message `com.digitalasset.canton.crypto.admin.v30.ListCertificateRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L112) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| filter_uid | `string` | optional | | - - -**Message `com.digitalasset.canton.crypto.admin.v30.ListCertificateResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L116) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| results | [`com.digitalasset.canton.crypto.admin.v30.ListCertificateResponse.Result`](#type-com-digitalasset-canton-crypto-admin-v30-listcertificateresponse-result) | repeated | | - - -**Message `com.digitalasset.canton.crypto.admin.v30.ListCertificateResponse.Result`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L117) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| x509_cert | `string` | optional | | - - -**Message `com.digitalasset.canton.crypto.admin.v30.ListKeysFilters`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L144) -- Fields: 4 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| fingerprint | `string` | optional | the substring that needs to match a given fingerprint | -| name | `string` | optional | the substring to filter the name | -| purpose | [`com.digitalasset.canton.crypto.v30.KeyPurpose`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-keypurpose) | repeated | filter on public key purpose | -| usage | [`com.digitalasset.canton.crypto.v30.SigningKeyUsage`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-signingkeyusage) | repeated | filter on signing public key usage | - - -**Message `com.digitalasset.canton.crypto.admin.v30.ListMyKeysRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L155) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| filters | [`com.digitalasset.canton.crypto.admin.v30.ListKeysFilters`](#type-com-digitalasset-canton-crypto-admin-v30-listkeysfilters) | optional | | - - -**Message `com.digitalasset.canton.crypto.admin.v30.ListMyKeysResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L173) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| private_keys_metadata | [`com.digitalasset.canton.crypto.admin.v30.PrivateKeyMetadata`](#type-com-digitalasset-canton-crypto-admin-v30-privatekeymetadata) | repeated | | - - -**Message `com.digitalasset.canton.crypto.admin.v30.ListPublicKeysRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L159) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| filters | [`com.digitalasset.canton.crypto.admin.v30.ListKeysFilters`](#type-com-digitalasset-canton-crypto-admin-v30-listkeysfilters) | optional | | - - -**Message `com.digitalasset.canton.crypto.admin.v30.ListPublicKeysResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L177) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| public_keys | [`com.digitalasset.canton.crypto.v30.PublicKeyWithName`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-publickeywithname) | repeated | | - - -**Message `com.digitalasset.canton.crypto.admin.v30.PrivateKeyMetadata`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L163) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| public_key_with_name | [`com.digitalasset.canton.crypto.v30.PublicKeyWithName`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-publickeywithname) | optional | | -| wrapper_key_id | `string` | optional | If set the private key is stored encrypted by the wrapper key | -| kms_key_id | `string` | optional | Set if the private key is stored in a KMS | - - -**Message `com.digitalasset.canton.crypto.admin.v30.RegisterKmsEncryptionKeyRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L220) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| kms_key_id | `string` | optional | | -| name | `string` | optional | optional descriptive name for the key | - - -**Message `com.digitalasset.canton.crypto.admin.v30.RegisterKmsEncryptionKeyResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L227) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| public_key | [`com.digitalasset.canton.crypto.v30.EncryptionPublicKey`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-encryptionpublickey) | optional | | - - -**Message `com.digitalasset.canton.crypto.admin.v30.RegisterKmsSigningKeyRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L206) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| kms_key_id | `string` | optional | | -| name | `string` | optional | optional descriptive name for the key | -| usage | [`com.digitalasset.canton.crypto.v30.SigningKeyUsage`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-signingkeyusage) | repeated | key can only be used for the specified usage | - - -**Message `com.digitalasset.canton.crypto.admin.v30.RegisterKmsSigningKeyResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L216) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| public_key | [`com.digitalasset.canton.crypto.v30.SigningPublicKey`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-signingpublickey) | optional | | - - -**Message `com.digitalasset.canton.crypto.admin.v30.RotateWrapperKeyRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L231) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| new_wrapper_key_id | `string` | optional | | - - -**Message `com.digitalasset.canton.crypto.admin.v30.RotateWrapperKeyResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto#L235) -- Fields: 0 -_No description._ +
+ +
+
Source file
+
community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto
+
+ +
+
Operations
+
12
+
+ +
+ + +
+ + + + +
+

VaultService.DeleteKeyPair

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc VaultService.DeleteKeyPair(com.digitalasset.canton.crypto.admin.v30.DeleteKeyPairRequest) returns (com.digitalasset.canton.crypto.admin.v30.DeleteKeyPairResponse);

+ + +
+ +
+
Request
+
com.digitalasset.canton.crypto.admin.v30.DeleteKeyPairRequest
+
+ +
+
Response
+
com.digitalasset.canton.crypto.admin.v30.DeleteKeyPairResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

VaultService.ExportKeyPair

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc VaultService.ExportKeyPair(com.digitalasset.canton.crypto.admin.v30.ExportKeyPairRequest) returns (com.digitalasset.canton.crypto.admin.v30.ExportKeyPairResponse);

+ + +
+ +
+
Request
+
com.digitalasset.canton.crypto.admin.v30.ExportKeyPairRequest
+
+ +
+
Response
+
com.digitalasset.canton.crypto.admin.v30.ExportKeyPairResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

VaultService.GenerateEncryptionKey

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

* Generates a new public / private key pair for hybrid encryption. Stores the private key in the vault, and returns the public key

+ + +
+ +
+
Request
+
com.digitalasset.canton.crypto.admin.v30.GenerateEncryptionKeyRequest
+
+ +
+
Response
+
com.digitalasset.canton.crypto.admin.v30.GenerateEncryptionKeyResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

VaultService.GenerateSigningKey

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

* Generates a new public / private key pair for signing. Stores the private key in the vault, and returns the public key

+ + +
+ +
+
Request
+
com.digitalasset.canton.crypto.admin.v30.GenerateSigningKeyRequest
+
+ +
+
Response
+
com.digitalasset.canton.crypto.admin.v30.GenerateSigningKeyResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

VaultService.GetWrapperKeyId

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc VaultService.GetWrapperKeyId(com.digitalasset.canton.crypto.admin.v30.GetWrapperKeyIdRequest) returns (com.digitalasset.canton.crypto.admin.v30.GetWrapperKeyIdResponse);

+ + +
+ +
+
Request
+
com.digitalasset.canton.crypto.admin.v30.GetWrapperKeyIdRequest
+
+ +
+
Response
+
com.digitalasset.canton.crypto.admin.v30.GetWrapperKeyIdResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

VaultService.ImportKeyPair

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc VaultService.ImportKeyPair(com.digitalasset.canton.crypto.admin.v30.ImportKeyPairRequest) returns (com.digitalasset.canton.crypto.admin.v30.ImportKeyPairResponse);

+ + +
+ +
+
Request
+
com.digitalasset.canton.crypto.admin.v30.ImportKeyPairRequest
+
+ +
+
Response
+
com.digitalasset.canton.crypto.admin.v30.ImportKeyPairResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

VaultService.ImportPublicKey

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

* Import a public key into the registry in order to provide that Fingerprint -> PublicKey lookups @param: ImportPublicKeyRequest serialized public key to be imported @return: fi...

+ + +
+ +
+
Request
+
com.digitalasset.canton.crypto.admin.v30.ImportPublicKeyRequest
+
+ +
+
Response
+
com.digitalasset.canton.crypto.admin.v30.ImportPublicKeyResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

VaultService.ListMyKeys

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

* List public keys according to request filter for which we have a private key in our key vault. The request includes a filter for fingerprints which can be used for lookups. @p...

+ + +
+ +
+
Request
+
com.digitalasset.canton.crypto.admin.v30.ListMyKeysRequest
+
+ +
+
Response
+
com.digitalasset.canton.crypto.admin.v30.ListMyKeysResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

VaultService.ListPublicKeys

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

* Lists all public keys matching the supplied filter which are internally cached Any public key returned here can be referenced in topology transaction building by fingerprint.

+ + +
+ +
+
Request
+
com.digitalasset.canton.crypto.admin.v30.ListPublicKeysRequest
+
+ +
+
Response
+
com.digitalasset.canton.crypto.admin.v30.ListPublicKeysResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

VaultService.RegisterKmsEncryptionKey

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

* Registers a KMS key for asymmetric/hybrid encryption. Stores the corresponding public key in the vault, and returns it

+ + +
+ +
+
Request
+
com.digitalasset.canton.crypto.admin.v30.RegisterKmsEncryptionKeyRequest
+
+ +
+
Response
+
com.digitalasset.canton.crypto.admin.v30.RegisterKmsEncryptionKeyResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

VaultService.RegisterKmsSigningKey

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

* Registers a KMS key for signing. Stores the corresponding public key in the vault, and returns it

+ + +
+ +
+
Request
+
com.digitalasset.canton.crypto.admin.v30.RegisterKmsSigningKeyRequest
+
+ +
+
Response
+
com.digitalasset.canton.crypto.admin.v30.RegisterKmsSigningKeyResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

VaultService.RotateWrapperKey

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

* Changes the wrapper key that is used to encrypt private keys when stored

+ + +
+ +
+
Request
+
com.digitalasset.canton.crypto.admin.v30.RotateWrapperKeyRequest
+
+ +
+
Response
+
com.digitalasset.canton.crypto.admin.v30.RotateWrapperKeyResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## Type Inventory + + +These are the package-level message and enum shapes in the publish-version snapshot. + + + + +
+
+

com.digitalasset.canton.crypto.admin.v30.DeleteKeyPairRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ fingerprint + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.admin.v30.DeleteKeyPairResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.crypto.admin.v30.ExportKeyPairRequest

+ +

3 fields

+ +
+ + +
+ +
+
+ fingerprint + string + +
+ +
The id of the keypair to export
+ +
+ +
+
+ protocol_version + int32 + +
+ +
The protocol version that defines the serialization of the keypair
+ +
+ +
+
+ password + string + +
+ +
Optional password to use for encrypting the exported keypair NOTE: The request should be made over a TLS connection to this service
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.admin.v30.ExportKeyPairResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ key_pair + bytes + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.admin.v30.GenerateCertificateRequest

+ +

4 fields

+ +
+ + +
+ +
+
+ unique_identifier + string + +
+ +
unique identifier to be used for CN
+ +
+ +
+
+ certificate_key + string + +
+ +
the private key fingerprint to use for this certificate
+ +
+ +
+
+ additional_subject + string + +
+ +
optional additional X500 names
+ +
+ +
+
+ subject_alternative_names + repeated string + +
+ +
the additional subject names to be added to this certificate
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.admin.v30.GenerateCertificateResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ x509_cert + string + +
+ +
the certificate in PEM format
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.admin.v30.GenerateEncryptionKeyRequest

+ +

2 fields

+ +
+ + +
+ +
+
+ key_spec + EncryptionKeySpec + +
+ +
+ +
+
+ name + string + +
+ +
optional descriptive name for the key
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.EncryptionKeySpec

+ +

3 values

+ +
+ + + +
    + +
  • ENCRYPTION_KEY_SPEC_UNSPECIFIED
    • + +
  • ENCRYPTION_KEY_SPEC_EC_P256
    • + +
  • ENCRYPTION_KEY_SPEC_RSA_2048
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.admin.v30.GenerateEncryptionKeyResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ public_key + EncryptionPublicKey + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.EncryptionPublicKey

+ +

4 fields

+ +
+ + +
+ +
+
+ format + CryptoKeyFormat + +
+ +
+ +
+
+ public_key + bytes + +
+ +
Serialized public key in the format specified above
+ +
+ +
+
+ scheme + EncryptionKeyScheme + +
+ +
No longer used (only kept for backwards compatibility) stores both the crypto key scheme and algorithm.
+ +
+ +
+
+ key_spec + EncryptionKeySpec + +
+ +
The key specification that was used to generate the key pair
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.CryptoKeyFormat

+ +

6 values

+ +
+ +

Serialization format for crypto keys and signatures

+ + + +
    + +
  • CRYPTO_KEY_FORMAT_UNSPECIFIED
    • + +
  • CRYPTO_KEY_FORMAT_DER
    • + +
  • CRYPTO_KEY_FORMAT_RAW
    • + +
  • CRYPTO_KEY_FORMAT_DER_X509_SUBJECT_PUBLIC_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_DER_PKCS8_PRIVATE_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_SYMBOLIC
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.v30.EncryptionKeyScheme

+ +

4 values

+ +
+ +

@deprecated

+ + + +
    + +
  • ENCRYPTION_KEY_SCHEME_UNSPECIFIED
    • + +
  • ENCRYPTION_KEY_SCHEME_ECIES_P256_HKDF_HMAC_SHA256_AES128GCM
    • + +
  • ENCRYPTION_KEY_SCHEME_ECIES_P256_HMAC_SHA256A_ES128CBC
    • + +
  • ENCRYPTION_KEY_SCHEME_RSA2048_OAEP_SHA256
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.admin.v30.GenerateSigningKeyRequest

+ +

3 fields

+ +
+ + +
+ +
+
+ key_spec + SigningKeySpec + +
+ +
+ +
+
+ name + string + +
+ +
optional descriptive name for the key
+ +
+ +
+
+ usage + repeated SigningKeyUsage + +
+ +
key can only be used for the specified usage
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SigningKeySpec

+ +

5 values

+ +
+ +

[start-docs-entry: signing key spec proto]

+ + + +
    + +
  • SIGNING_KEY_SPEC_UNSPECIFIED
    • + +
  • SIGNING_KEY_SPEC_EC_CURVE25519
    • + +
  • SIGNING_KEY_SPEC_EC_P256
    • + +
  • SIGNING_KEY_SPEC_EC_P384
    • + +
  • SIGNING_KEY_SPEC_EC_SECP256K1
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SigningKeyUsage

+ +

6 values

+ +
+ + + +
    + +
  • SIGNING_KEY_USAGE_UNSPECIFIED
    • + +
  • SIGNING_KEY_USAGE_NAMESPACE
    • + +
  • SIGNING_KEY_USAGE_IDENTITY_DELEGATION
    • + +
  • SIGNING_KEY_USAGE_SEQUENCER_AUTHENTICATION
    • + +
  • SIGNING_KEY_USAGE_PROTOCOL
    • + +
  • SIGNING_KEY_USAGE_PROOF_OF_OWNERSHIP
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.admin.v30.GenerateSigningKeyResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ public_key + SigningPublicKey + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SigningPublicKey

+ +

5 fields

+ +
+ + +
+ +
+
+ format + CryptoKeyFormat + +
+ +
+ +
+
+ public_key + bytes + +
+ +
Serialized public key in the format specified above
+ +
+ +
+
+ scheme + SigningKeyScheme + +
+ +
No longer used (only kept for backwards compatibility) stores both the crypto key scheme and algorithm.
+ +
+ +
+
+ usage + repeated SigningKeyUsage + +
+ +
Explicitly state the key's intended use
+ +
+ +
+
+ key_spec + SigningKeySpec + +
+ +
The key specification that was used to generate the key pair
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SigningKeyScheme

+ +

4 values

+ +
+ +

@deprecated

+ + + +
    + +
  • SIGNING_KEY_SCHEME_UNSPECIFIED
    • + +
  • SIGNING_KEY_SCHEME_ED25519
    • + +
  • SIGNING_KEY_SCHEME_EC_DSA_P256
    • + +
  • SIGNING_KEY_SCHEME_EC_DSA_P384
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.admin.v30.GetWrapperKeyIdRequest

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.crypto.admin.v30.GetWrapperKeyIdResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ wrapper_key_id + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.admin.v30.ImportCertificateRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ x509_cert + string + +
+ +
X509 certificate as PEM
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.admin.v30.ImportCertificateResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ certificate_id + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.admin.v30.ImportKeyPairRequest

+ +

3 fields

+ +
+ + +
+ +
+
+ key_pair + bytes + +
+ +
+ +
+
+ name + string + +
+ +
+ +
+
+ password + string + +
+ +
Optional password to use for decrypting the exported keypair NOTE: The request should be made over a TLS connection to this service
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.admin.v30.ImportKeyPairResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.crypto.admin.v30.ImportPublicKeyRequest

+ +

2 fields

+ +
+ + +
+ +
+
+ public_key + bytes + +
+ +
import a crypto.PublicKey protobuf serialized key
+ +
+ +
+
+ name + string + +
+ +
an optional name that should be stored along side the key
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.admin.v30.ImportPublicKeyResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ fingerprint + string + +
+ +
fingerprint of imported key
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.admin.v30.ListCertificateRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ filter_uid + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.admin.v30.ListCertificateResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.admin.v30.ListCertificateResponse.Result

+ +

1 fields

+ +
+ + +
+ +
+
+ x509_cert + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.admin.v30.ListKeysFilters

+ +

4 fields

+ +
+ + +
+ +
+
+ fingerprint + string + +
+ +
the substring that needs to match a given fingerprint
+ +
+ +
+
+ name + string + +
+ +
the substring to filter the name
+ +
+ +
+
+ purpose + repeated KeyPurpose + +
+ +
filter on public key purpose
+ +
+ +
+
+ usage + repeated SigningKeyUsage + +
+ +
filter on signing public key usage
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.KeyPurpose

+ +

3 values

+ +
+ + + +
    + +
  • KEY_PURPOSE_UNSPECIFIED
    • + +
  • KEY_PURPOSE_SIGNING
    • + +
  • KEY_PURPOSE_ENCRYPTION
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.admin.v30.ListMyKeysRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ filters + ListKeysFilters + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.admin.v30.ListMyKeysResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ private_keys_metadata + repeated PrivateKeyMetadata + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.admin.v30.PrivateKeyMetadata

+ +

3 fields

+ +
+ + +
+ +
+
+ public_key_with_name + PublicKeyWithName + +
+ +
+ +
+
+ wrapper_key_id + string + +
+ +
If set the private key is stored encrypted by the wrapper key
+ +
+ +
+
+ kms_key_id + string + +
+ +
Set if the private key is stored in a KMS
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.PublicKeyWithName

+ +

2 fields

+ +
+ + +
+ +
+
+ public_key + PublicKey + +
+ +
+ +
+
+ name + string + +
+ +
Optional name of the public key
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.PublicKey

+ +

2 fields

+ +
+ + +
+ +
+
+ signing_public_key + SigningPublicKey + +
+ +
+ +
+
+ encryption_public_key + EncryptionPublicKey + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.admin.v30.ListPublicKeysRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ filters + ListKeysFilters + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.admin.v30.ListPublicKeysResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ public_keys + repeated PublicKeyWithName + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.admin.v30.RegisterKmsEncryptionKeyRequest

+ +

2 fields

+ +
+ + +
+ +
+
+ kms_key_id + string + +
+ +
+ +
+
+ name + string + +
+ +
optional descriptive name for the key
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.admin.v30.RegisterKmsEncryptionKeyResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ public_key + EncryptionPublicKey + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.admin.v30.RegisterKmsSigningKeyRequest

+ +

3 fields

+ +
+ + +
+ +
+
+ kms_key_id + string + +
+ +
+ +
+
+ name + string + +
+ +
optional descriptive name for the key
+ +
+ +
+
+ usage + repeated SigningKeyUsage + +
+ +
key can only be used for the specified usage
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.admin.v30.RegisterKmsSigningKeyResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ public_key + SigningPublicKey + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.admin.v30.RotateWrapperKeyRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ new_wrapper_key_id + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.admin.v30.RotateWrapperKeyResponse

+ +

0 fields

+ +
+ + + + +
diff --git a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-crypto-v30.mdx b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-crypto-v30.mdx index 7a73f03..57a4144 100644 --- a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-crypto-v30.mdx +++ b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-crypto-v30.mdx @@ -1,498 +1,1434 @@ --- title: "com.digitalasset.canton.crypto.v30" -description: "Descriptor-backed protobuf API history for package com.digitalasset.canton.crypto.v30." +description: "Package-level overview for com.digitalasset.canton.crypto.v30." --- -# Package `com.digitalasset.canton.crypto.v30` +

Back to overview

+ +
+ +

Protobuf Package

+ + +

com.digitalasset.canton.crypto.v30

+ + +

0 services, 0 endpoints, 20 messages, 14 enums

+ + +
+ + gRPC + +
+ + +
+ +
+
Files
+
1
+
+ +
+
Services
+
0
+
+ +
+
Endpoints
+
0
+
+ +
+
Messages
+
20
+
+ +
+
Enums
+
14
+
+ +
+ +
-[Back to Canton Protobuf History](../index) - -## Snapshot - -- Current files: `1` -- Current services: `0` -- Current endpoints: `0` -- Current messages: `20` -- Current enums: `14` -- Lifecycle endpoints tracked: `0` ## Source Files -| File | Services | Messages | Enums | Source | -| --- | --- | --- | --- | --- | -| community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto | `0` | `20` | `14` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto#L4) | - -## Type Reference - - -**Message `com.digitalasset.canton.crypto.v30.AsymmetricEncrypted`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto#L385) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| ciphertext | `bytes` | optional | Asymmetrically encrypted data | -| encryption_algorithm_spec | [`com.digitalasset.canton.crypto.v30.EncryptionAlgorithmSpec`](#type-com-digitalasset-canton-crypto-v30-encryptionalgorithmspec) | optional | The asymmetric encryption specification used for the encryption | -| fingerprint | `string` | optional | The fingerprint of the public key that was used for the encryption | - - -**Message `com.digitalasset.canton.crypto.v30.CryptoKeyPair`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto#L316) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| signing_key_pair | [`com.digitalasset.canton.crypto.v30.SigningKeyPair`](#type-com-digitalasset-canton-crypto-v30-signingkeypair) | optional | | -| encryption_key_pair | [`com.digitalasset.canton.crypto.v30.EncryptionKeyPair`](#type-com-digitalasset-canton-crypto-v30-encryptionkeypair) | optional | | - - -**Message `com.digitalasset.canton.crypto.v30.EncryptionKeyPair`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto#L278) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| private_key | [`com.digitalasset.canton.crypto.v30.EncryptionPrivateKey`](#type-com-digitalasset-canton-crypto-v30-encryptionprivatekey) | optional | | - - -**Message `com.digitalasset.canton.crypto.v30.EncryptionPrivateKey`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto#L263) -- Fields: 5 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| id | `string` | optional | | -| format | [`com.digitalasset.canton.crypto.v30.CryptoKeyFormat`](#type-com-digitalasset-canton-crypto-v30-cryptokeyformat) | optional | | -| private_key | `bytes` | optional | Serialized private key in the format specified above | -| scheme | [`com.digitalasset.canton.crypto.v30.EncryptionKeyScheme`](#type-com-digitalasset-canton-crypto-v30-encryptionkeyscheme) | optional | No longer used (only kept for backwards compatibility) stores both the crypto key scheme and algorithm. | -| key_spec | [`com.digitalasset.canton.crypto.v30.EncryptionKeySpec`](#type-com-digitalasset-canton-crypto-v30-encryptionkeyspec) | optional | The key specification that was used to generate the key pair | - - -**Message `com.digitalasset.canton.crypto.v30.EncryptionPublicKey`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto#L247) -- Fields: 4 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| format | [`com.digitalasset.canton.crypto.v30.CryptoKeyFormat`](#type-com-digitalasset-canton-crypto-v30-cryptokeyformat) | optional | | -| public_key | `bytes` | optional | Serialized public key in the format specified above | -| scheme | [`com.digitalasset.canton.crypto.v30.EncryptionKeyScheme`](#type-com-digitalasset-canton-crypto-v30-encryptionkeyscheme) | optional | No longer used (only kept for backwards compatibility) stores both the crypto key scheme and algorithm. | -| key_spec | [`com.digitalasset.canton.crypto.v30.EncryptionKeySpec`](#type-com-digitalasset-canton-crypto-v30-encryptionkeyspec) | optional | The key specification that was used to generate the key pair | - - -**Message `com.digitalasset.canton.crypto.v30.Hmac`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto#L20) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| algorithm | [`com.digitalasset.canton.crypto.v30.HmacAlgorithm`](#type-com-digitalasset-canton-crypto-v30-hmacalgorithm) | optional | | -| hmac | `bytes` | optional | | - - -**Message `com.digitalasset.canton.crypto.v30.PasswordBasedEncrypted`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto#L372) -- Fields: 4 - -A password-based encrypted message - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| ciphertext | `bytes` | optional | | -| symmetric_key_scheme | [`com.digitalasset.canton.crypto.v30.SymmetricKeyScheme`](#type-com-digitalasset-canton-crypto-v30-symmetrickeyscheme) | optional | The symmetric encryption scheme that was used to encrypt the plaintext | -| pbkdf_scheme | [`com.digitalasset.canton.crypto.v30.PbkdfScheme`](#type-com-digitalasset-canton-crypto-v30-pbkdfscheme) | optional | The password-based KDF that was used to derive the symmetric encryption key from the password | -| salt | `bytes` | optional | The random salt that was used to derive the symmetric encryption key from the password | - - -**Message `com.digitalasset.canton.crypto.v30.PrivateKey`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto#L145) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| signing_private_key | [`com.digitalasset.canton.crypto.v30.SigningPrivateKey`](#type-com-digitalasset-canton-crypto-v30-signingprivatekey) | optional | | -| encryption_private_key | [`com.digitalasset.canton.crypto.v30.EncryptionPrivateKey`](#type-com-digitalasset-canton-crypto-v30-encryptionprivatekey) | optional | | - - -**Message `com.digitalasset.canton.crypto.v30.PublicKey`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto#L131) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| signing_public_key | [`com.digitalasset.canton.crypto.v30.SigningPublicKey`](#type-com-digitalasset-canton-crypto-v30-signingpublickey) | optional | | -| encryption_public_key | [`com.digitalasset.canton.crypto.v30.EncryptionPublicKey`](#type-com-digitalasset-canton-crypto-v30-encryptionpublickey) | optional | | - - -**Message `com.digitalasset.canton.crypto.v30.PublicKeyWithName`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto#L138) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| public_key | [`com.digitalasset.canton.crypto.v30.PublicKey`](#type-com-digitalasset-canton-crypto-v30-publickey) | optional | | -| name | `string` | optional | Optional name of the public key | - - -**Message `com.digitalasset.canton.crypto.v30.RequiredEncryptionSpecs`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto#L311) -- Fields: 2 - -Used to announce the required encryption key and algorithm specifications in the static synchronizer parameters. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| algorithms | [`com.digitalasset.canton.crypto.v30.EncryptionAlgorithmSpec`](#type-com-digitalasset-canton-crypto-v30-encryptionalgorithmspec) | repeated | | -| keys | [`com.digitalasset.canton.crypto.v30.EncryptionKeySpec`](#type-com-digitalasset-canton-crypto-v30-encryptionkeyspec) | repeated | | - - -**Message `com.digitalasset.canton.crypto.v30.RequiredSigningSpecs`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto#L242) -- Fields: 2 - -Used to announce the required signing key and algorithm specifications in the static synchronizer parameters. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| algorithms | [`com.digitalasset.canton.crypto.v30.SigningAlgorithmSpec`](#type-com-digitalasset-canton-crypto-v30-signingalgorithmspec) | repeated | | -| keys | [`com.digitalasset.canton.crypto.v30.SigningKeySpec`](#type-com-digitalasset-canton-crypto-v30-signingkeyspec) | repeated | | - - -**Message `com.digitalasset.canton.crypto.v30.Salt`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto#L25) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| hmac | [`com.digitalasset.canton.crypto.v30.HmacAlgorithm`](#type-com-digitalasset-canton-crypto-v30-hmacalgorithm) | optional | | -| salt | `bytes` | optional | | - - -**Message `com.digitalasset.canton.crypto.v30.Signature`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto#L32) -- Fields: 5 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| format | [`com.digitalasset.canton.crypto.v30.SignatureFormat`](#type-com-digitalasset-canton-crypto-v30-signatureformat) | optional | | -| signature | `bytes` | optional | | -| signed_by | `string` | optional | The fingerprint/id of the keypair used to create this signature and needed to verify.
If a signature delegation is defined, this fingerprint/id is not used to produce the signature, and, instead
is used to sign the delegation. | -| signing_algorithm_spec | [`com.digitalasset.canton.crypto.v30.SigningAlgorithmSpec`](#type-com-digitalasset-canton-crypto-v30-signingalgorithmspec) | optional | The signing algorithm specification used to produce this signature | -| signature_delegation | [`com.digitalasset.canton.crypto.v30.SignatureDelegation`](#type-com-digitalasset-canton-crypto-v30-signaturedelegation) | optional | An optional signature delegation where a long-term signing key authorizes a session signing key to sign on its
behalf. | - - -**Message `com.digitalasset.canton.crypto.v30.SignatureDelegation`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto#L50) -- Fields: 7 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| session_key | `bytes` | optional | ASN.1 + DER-encoding of X.509 SubjectPublicKeyInfo structure of the session public key:
https://datatracker.ietf.org/doc/html/rfc5280#section-4.1. This key was used to produce the actual signature. | -| session_key_spec | [`com.digitalasset.canton.crypto.v30.SigningKeySpec`](#type-com-digitalasset-canton-crypto-v30-signingkeyspec) | optional | The signing key spec for the session key. | -| validity_period_from_inclusive | `int64` | optional | A timestamp in microseconds of UTC time since Unix epoch that indicates when the session key is
considered valid. | -| validity_period_duration_seconds | `uint32` | optional | Duration in seconds indicating how long the session key remains valid.
The validity period starts from `validity_period_from_inclusive` above. | -| format | [`com.digitalasset.canton.crypto.v30.SignatureFormat`](#type-com-digitalasset-canton-crypto-v30-signatureformat) | optional | The format of the signature | -| signature | `bytes` | optional | The signature of the combined hash of the session key fingerprint, validity period, and synchronizer id, by the
long-term key. This signature authorizes the session key to act on behalf of the long-term key. | -| signing_algorithm_spec | [`com.digitalasset.canton.crypto.v30.SigningAlgorithmSpec`](#type-com-digitalasset-canton-crypto-v30-signingalgorithmspec) | optional | The signing algorithm specification used to produce this signature | - - -**Message `com.digitalasset.canton.crypto.v30.SigningKeyPair`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto#L209) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| private_key | [`com.digitalasset.canton.crypto.v30.SigningPrivateKey`](#type-com-digitalasset-canton-crypto-v30-signingprivatekey) | optional | | - - -**Message `com.digitalasset.canton.crypto.v30.SigningKeysWithThreshold`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto#L396) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| keys | [`com.digitalasset.canton.crypto.v30.SigningPublicKey`](#type-com-digitalasset-canton-crypto-v30-signingpublickey) | repeated | the designated signing keys | -| threshold | `uint32` | optional | the authorization threshold | - - -**Message `com.digitalasset.canton.crypto.v30.SigningPrivateKey`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto#L191) -- Fields: 6 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| id | `string` | optional | | -| format | [`com.digitalasset.canton.crypto.v30.CryptoKeyFormat`](#type-com-digitalasset-canton-crypto-v30-cryptokeyformat) | optional | | -| private_key | `bytes` | optional | Serialized private key in the format specified above | -| scheme | [`com.digitalasset.canton.crypto.v30.SigningKeyScheme`](#type-com-digitalasset-canton-crypto-v30-signingkeyscheme) | optional | No longer used (only kept for backwards compatibility) stores both the crypto key scheme and algorithm. | -| usage | [`com.digitalasset.canton.crypto.v30.SigningKeyUsage`](#type-com-digitalasset-canton-crypto-v30-signingkeyusage) | repeated | Explicitly state the key's intended use | -| key_spec | [`com.digitalasset.canton.crypto.v30.SigningKeySpec`](#type-com-digitalasset-canton-crypto-v30-signingkeyspec) | optional | The key specification that was used to generate the key pair | - - -**Message `com.digitalasset.canton.crypto.v30.SigningPublicKey`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto#L172) -- Fields: 5 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| format | [`com.digitalasset.canton.crypto.v30.CryptoKeyFormat`](#type-com-digitalasset-canton-crypto-v30-cryptokeyformat) | optional | | -| public_key | `bytes` | optional | Serialized public key in the format specified above | -| scheme | [`com.digitalasset.canton.crypto.v30.SigningKeyScheme`](#type-com-digitalasset-canton-crypto-v30-signingkeyscheme) | optional | No longer used (only kept for backwards compatibility) stores both the crypto key scheme and algorithm. | -| usage | [`com.digitalasset.canton.crypto.v30.SigningKeyUsage`](#type-com-digitalasset-canton-crypto-v30-signingkeyusage) | repeated | Explicitly state the key's intended use | -| key_spec | [`com.digitalasset.canton.crypto.v30.SigningKeySpec`](#type-com-digitalasset-canton-crypto-v30-signingkeyspec) | optional | The key specification that was used to generate the key pair | - - -**Message `com.digitalasset.canton.crypto.v30.SymmetricKey`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto#L323) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| format | [`com.digitalasset.canton.crypto.v30.CryptoKeyFormat`](#type-com-digitalasset-canton-crypto-v30-cryptokeyformat) | optional | | -| key | `bytes` | optional | | -| scheme | [`com.digitalasset.canton.crypto.v30.SymmetricKeyScheme`](#type-com-digitalasset-canton-crypto-v30-symmetrickeyscheme) | optional | | - - -**Enum `com.digitalasset.canton.crypto.v30.CryptoKeyFormat`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto#L341) - -Serialization format for crypto keys and signatures - -| Name | Number | -| --- | --- | -| CRYPTO_KEY_FORMAT_UNSPECIFIED | `0` | -| CRYPTO_KEY_FORMAT_DER | `2` | -| CRYPTO_KEY_FORMAT_RAW | `3` | -| CRYPTO_KEY_FORMAT_DER_X509_SUBJECT_PUBLIC_KEY_INFO | `4` | -| CRYPTO_KEY_FORMAT_DER_PKCS8_PRIVATE_KEY_INFO | `5` | -| CRYPTO_KEY_FORMAT_SYMBOLIC | `10000` | - - -**Enum `com.digitalasset.canton.crypto.v30.EncryptionAlgorithmSpec`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto#L283) - -_No description._ - -| Name | Number | -| --- | --- | -| ENCRYPTION_ALGORITHM_SPEC_UNSPECIFIED | `0` | -| ENCRYPTION_ALGORITHM_SPEC_ECIES_HKDF_HMAC_SHA256_AES128CBC | `1` | -| ENCRYPTION_ALGORITHM_SPEC_RSA_OAEP_SHA256 | `2` | - - -**Enum `com.digitalasset.canton.crypto.v30.EncryptionKeyScheme`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto#L296) - -@deprecated - -| Name | Number | -| --- | --- | -| ENCRYPTION_KEY_SCHEME_UNSPECIFIED | `0` | -| ENCRYPTION_KEY_SCHEME_ECIES_P256_HKDF_HMAC_SHA256_AES128GCM | `1` | -| ENCRYPTION_KEY_SCHEME_ECIES_P256_HMAC_SHA256A_ES128CBC | `2` | -| ENCRYPTION_KEY_SCHEME_RSA2048_OAEP_SHA256 | `3` | - - -**Enum `com.digitalasset.canton.crypto.v30.EncryptionKeySpec`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto#L97) - -_No description._ - -| Name | Number | -| --- | --- | -| ENCRYPTION_KEY_SPEC_UNSPECIFIED | `0` | -| ENCRYPTION_KEY_SPEC_EC_P256 | `1` | -| ENCRYPTION_KEY_SPEC_RSA_2048 | `2` | - - -**Enum `com.digitalasset.canton.crypto.v30.HashAlgorithm`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto#L10) - -_No description._ - -| Name | Number | -| --- | --- | -| HASH_ALGORITHM_UNSPECIFIED | `0` | -| HASH_ALGORITHM_SHA256 | `1` | - - -**Enum `com.digitalasset.canton.crypto.v30.HmacAlgorithm`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto#L15) - -_No description._ - -| Name | Number | -| --- | --- | -| HMAC_ALGORITHM_UNSPECIFIED | `0` | -| HMAC_ALGORITHM_HMAC_SHA256 | `1` | - - -**Enum `com.digitalasset.canton.crypto.v30.KeyPurpose`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto#L152) - -_No description._ - -| Name | Number | -| --- | --- | -| KEY_PURPOSE_UNSPECIFIED | `0` | -| KEY_PURPOSE_SIGNING | `1` | -| KEY_PURPOSE_ENCRYPTION | `2` | - - -**Enum `com.digitalasset.canton.crypto.v30.PbkdfScheme`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto#L364) - -_No description._ - -| Name | Number | -| --- | --- | -| PBKDF_SCHEME_UNSPECIFIED | `0` | -| PBKDF_SCHEME_ARGON2ID_MODE1 | `1` | - - -**Enum `com.digitalasset.canton.crypto.v30.SignatureFormat`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto#L77) - -_No description._ - -| Name | Number | -| --- | --- | -| SIGNATURE_FORMAT_UNSPECIFIED | `0` | -| SIGNATURE_FORMAT_RAW | `1` | -| SIGNATURE_FORMAT_DER | `2` | -| SIGNATURE_FORMAT_CONCAT | `3` | -| SIGNATURE_FORMAT_SYMBOLIC | `10000` | - - -**Enum `com.digitalasset.canton.crypto.v30.SigningAlgorithmSpec`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto#L214) - -_No description._ - -| Name | Number | -| --- | --- | -| SIGNING_ALGORITHM_SPEC_UNSPECIFIED | `0` | -| SIGNING_ALGORITHM_SPEC_ED25519 | `1` | -| SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_256 | `2` | -| SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_384 | `3` | - - -**Enum `com.digitalasset.canton.crypto.v30.SigningKeyScheme`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto#L229) - -@deprecated - -| Name | Number | -| --- | --- | -| SIGNING_KEY_SCHEME_UNSPECIFIED | `0` | -| SIGNING_KEY_SCHEME_ED25519 | `1` | -| SIGNING_KEY_SCHEME_EC_DSA_P256 | `2` | -| SIGNING_KEY_SCHEME_EC_DSA_P384 | `3` | - - -**Enum `com.digitalasset.canton.crypto.v30.SigningKeySpec`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto#L109) - -[start-docs-entry: signing key spec proto] - -| Name | Number | -| --- | --- | -| SIGNING_KEY_SPEC_UNSPECIFIED | `0` | -| SIGNING_KEY_SPEC_EC_CURVE25519 | `1` | -| SIGNING_KEY_SPEC_EC_P256 | `2` | -| SIGNING_KEY_SPEC_EC_P384 | `3` | -| SIGNING_KEY_SPEC_EC_SECP256K1 | `4` | - - -**Enum `com.digitalasset.canton.crypto.v30.SigningKeyUsage`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto#L158) - -_No description._ - -| Name | Number | -| --- | --- | -| SIGNING_KEY_USAGE_UNSPECIFIED | `0` | -| SIGNING_KEY_USAGE_NAMESPACE | `1` | -| SIGNING_KEY_USAGE_IDENTITY_DELEGATION | `2` | -| SIGNING_KEY_USAGE_SEQUENCER_AUTHENTICATION | `3` | -| SIGNING_KEY_USAGE_PROTOCOL | `4` | -| SIGNING_KEY_USAGE_PROOF_OF_OWNERSHIP | `5` | - - -**Enum `com.digitalasset.canton.crypto.v30.SymmetricKeyScheme`** -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto#L333) -_No description._ -| Name | Number | -| --- | --- | -| SYMMETRIC_KEY_SCHEME_UNSPECIFIED | `0` | -| SYMMETRIC_KEY_SCHEME_AES128GCM | `1` | +
+ + +
+ +
+

community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
20
+
+ +
+
Enums
+
14
+
+ +
+
Source
+
community/base/src/main/protobuf/com/digitalasset/canton/crypto/v30/crypto.proto
+
+ +
+ + +
+ + +
+ + + + + +## Type Inventory + + +These are the package-level message and enum shapes in the publish-version snapshot. + + + + +
+
+

com.digitalasset.canton.crypto.v30.AsymmetricEncrypted

+ +

3 fields

+ +
+ + +
+ +
+
+ ciphertext + bytes + +
+ +
Asymmetrically encrypted data
+ +
+ +
+
+ encryption_algorithm_spec + EncryptionAlgorithmSpec + +
+ +
The asymmetric encryption specification used for the encryption
+ +
+ +
+
+ fingerprint + string + +
+ +
The fingerprint of the public key that was used for the encryption
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.EncryptionAlgorithmSpec

+ +

3 values

+ +
+ + + +
    + +
  • ENCRYPTION_ALGORITHM_SPEC_UNSPECIFIED
    • + +
  • ENCRYPTION_ALGORITHM_SPEC_ECIES_HKDF_HMAC_SHA256_AES128CBC
    • + +
  • ENCRYPTION_ALGORITHM_SPEC_RSA_OAEP_SHA256
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.v30.CryptoKeyPair

+ +

2 fields

+ +
+ + +
+ +
+
+ signing_key_pair + SigningKeyPair + +
+ +
+ +
+
+ encryption_key_pair + EncryptionKeyPair + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SigningKeyPair

+ +

1 fields

+ +
+ + +
+ +
+
+ private_key + SigningPrivateKey + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SigningPrivateKey

+ +

6 fields

+ +
+ + +
+ +
+
+ id + string + +
+ +
+ +
+
+ format + CryptoKeyFormat + +
+ +
+ +
+
+ private_key + bytes + +
+ +
Serialized private key in the format specified above
+ +
+ +
+
+ scheme + SigningKeyScheme + +
+ +
No longer used (only kept for backwards compatibility) stores both the crypto key scheme and algorithm.
+ +
+ +
+
+ usage + repeated SigningKeyUsage + +
+ +
Explicitly state the key's intended use
+ +
+ +
+
+ key_spec + SigningKeySpec + +
+ +
The key specification that was used to generate the key pair
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.CryptoKeyFormat

+ +

6 values

+ +
+ +

Serialization format for crypto keys and signatures

+ + + +
    + +
  • CRYPTO_KEY_FORMAT_UNSPECIFIED
    • + +
  • CRYPTO_KEY_FORMAT_DER
    • + +
  • CRYPTO_KEY_FORMAT_RAW
    • + +
  • CRYPTO_KEY_FORMAT_DER_X509_SUBJECT_PUBLIC_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_DER_PKCS8_PRIVATE_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_SYMBOLIC
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SigningKeyScheme

+ +

4 values

+ +
+ +

@deprecated

+ + + +
    + +
  • SIGNING_KEY_SCHEME_UNSPECIFIED
    • + +
  • SIGNING_KEY_SCHEME_ED25519
    • + +
  • SIGNING_KEY_SCHEME_EC_DSA_P256
    • + +
  • SIGNING_KEY_SCHEME_EC_DSA_P384
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SigningKeyUsage

+ +

6 values

+ +
+ + + +
    + +
  • SIGNING_KEY_USAGE_UNSPECIFIED
    • + +
  • SIGNING_KEY_USAGE_NAMESPACE
    • + +
  • SIGNING_KEY_USAGE_IDENTITY_DELEGATION
    • + +
  • SIGNING_KEY_USAGE_SEQUENCER_AUTHENTICATION
    • + +
  • SIGNING_KEY_USAGE_PROTOCOL
    • + +
  • SIGNING_KEY_USAGE_PROOF_OF_OWNERSHIP
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SigningKeySpec

+ +

5 values

+ +
+ +

[start-docs-entry: signing key spec proto]

+ + + +
    + +
  • SIGNING_KEY_SPEC_UNSPECIFIED
    • + +
  • SIGNING_KEY_SPEC_EC_CURVE25519
    • + +
  • SIGNING_KEY_SPEC_EC_P256
    • + +
  • SIGNING_KEY_SPEC_EC_P384
    • + +
  • SIGNING_KEY_SPEC_EC_SECP256K1
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.v30.EncryptionKeyPair

+ +

1 fields

+ +
+ + +
+ +
+
+ private_key + EncryptionPrivateKey + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.EncryptionPrivateKey

+ +

5 fields

+ +
+ + +
+ +
+
+ id + string + +
+ +
+ +
+
+ format + CryptoKeyFormat + +
+ +
+ +
+
+ private_key + bytes + +
+ +
Serialized private key in the format specified above
+ +
+ +
+
+ scheme + EncryptionKeyScheme + +
+ +
No longer used (only kept for backwards compatibility) stores both the crypto key scheme and algorithm.
+ +
+ +
+
+ key_spec + EncryptionKeySpec + +
+ +
The key specification that was used to generate the key pair
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.EncryptionKeyScheme

+ +

4 values

+ +
+ +

@deprecated

+ + + +
    + +
  • ENCRYPTION_KEY_SCHEME_UNSPECIFIED
    • + +
  • ENCRYPTION_KEY_SCHEME_ECIES_P256_HKDF_HMAC_SHA256_AES128GCM
    • + +
  • ENCRYPTION_KEY_SCHEME_ECIES_P256_HMAC_SHA256A_ES128CBC
    • + +
  • ENCRYPTION_KEY_SCHEME_RSA2048_OAEP_SHA256
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.v30.EncryptionKeySpec

+ +

3 values

+ +
+ + + +
    + +
  • ENCRYPTION_KEY_SPEC_UNSPECIFIED
    • + +
  • ENCRYPTION_KEY_SPEC_EC_P256
    • + +
  • ENCRYPTION_KEY_SPEC_RSA_2048
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.v30.EncryptionPublicKey

+ +

4 fields

+ +
+ + +
+ +
+
+ format + CryptoKeyFormat + +
+ +
+ +
+
+ public_key + bytes + +
+ +
Serialized public key in the format specified above
+ +
+ +
+
+ scheme + EncryptionKeyScheme + +
+ +
No longer used (only kept for backwards compatibility) stores both the crypto key scheme and algorithm.
+ +
+ +
+
+ key_spec + EncryptionKeySpec + +
+ +
The key specification that was used to generate the key pair
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.Hmac

+ +

2 fields

+ +
+ + +
+ +
+
+ algorithm + HmacAlgorithm + +
+ +
+ +
+
+ hmac + bytes + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.HmacAlgorithm

+ +

2 values

+ +
+ + + +
    + +
  • HMAC_ALGORITHM_UNSPECIFIED
    • + +
  • HMAC_ALGORITHM_HMAC_SHA256
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.v30.PasswordBasedEncrypted

+ +

4 fields

+ +
+ +

A password-based encrypted message

+ + +
+ +
+
+ ciphertext + bytes + +
+ +
+ +
+
+ symmetric_key_scheme + SymmetricKeyScheme + +
+ +
The symmetric encryption scheme that was used to encrypt the plaintext
+ +
+ +
+
+ pbkdf_scheme + PbkdfScheme + +
+ +
The password-based KDF that was used to derive the symmetric encryption key from the password
+ +
+ +
+
+ salt + bytes + +
+ +
The random salt that was used to derive the symmetric encryption key from the password
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SymmetricKeyScheme

+ +

2 values

+ +
+ + + +
    + +
  • SYMMETRIC_KEY_SCHEME_UNSPECIFIED
    • + +
  • SYMMETRIC_KEY_SCHEME_AES128GCM
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.v30.PbkdfScheme

+ +

2 values

+ +
+ + + +
    + +
  • PBKDF_SCHEME_UNSPECIFIED
    • + +
  • PBKDF_SCHEME_ARGON2ID_MODE1
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.v30.PrivateKey

+ +

2 fields

+ +
+ + +
+ +
+
+ signing_private_key + SigningPrivateKey + +
+ +
+ +
+
+ encryption_private_key + EncryptionPrivateKey + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.PublicKey

+ +

2 fields

+ +
+ + +
+ +
+
+ signing_public_key + SigningPublicKey + +
+ +
+ +
+
+ encryption_public_key + EncryptionPublicKey + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SigningPublicKey

+ +

5 fields

+ +
+ + +
+ +
+
+ format + CryptoKeyFormat + +
+ +
+ +
+
+ public_key + bytes + +
+ +
Serialized public key in the format specified above
+ +
+ +
+
+ scheme + SigningKeyScheme + +
+ +
No longer used (only kept for backwards compatibility) stores both the crypto key scheme and algorithm.
+ +
+ +
+
+ usage + repeated SigningKeyUsage + +
+ +
Explicitly state the key's intended use
+ +
+ +
+
+ key_spec + SigningKeySpec + +
+ +
The key specification that was used to generate the key pair
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.PublicKeyWithName

+ +

2 fields

+ +
+ + +
+ +
+
+ public_key + PublicKey + +
+ +
+ +
+
+ name + string + +
+ +
Optional name of the public key
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.RequiredEncryptionSpecs

+ +

2 fields

+ +
+ +

Used to announce the required encryption key and algorithm specifications in the static synchronizer parameters.

+ + +
+ +
+
+ algorithms + repeated EncryptionAlgorithmSpec + +
+ +
+ +
+
+ keys + repeated EncryptionKeySpec + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.RequiredSigningSpecs

+ +

2 fields

+ +
+ +

Used to announce the required signing key and algorithm specifications in the static synchronizer parameters.

+ + +
+ +
+
+ algorithms + repeated SigningAlgorithmSpec + +
+ +
+ +
+
+ keys + repeated SigningKeySpec + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SigningAlgorithmSpec

+ +

4 values

+ +
+ + + +
    + +
  • SIGNING_ALGORITHM_SPEC_UNSPECIFIED
    • + +
  • SIGNING_ALGORITHM_SPEC_ED25519
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_256
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_384
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.v30.Salt

+ +

2 fields

+ +
+ + +
+ +
+
+ hmac + HmacAlgorithm + +
+ +
+ +
+
+ salt + bytes + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.Signature

+ +

5 fields

+ +
+ + +
+ +
+
+ format + SignatureFormat + +
+ +
+ +
+
+ signature + bytes + +
+ +
+ +
+
+ signed_by + string + +
+ +
The fingerprint/id of the keypair used to create this signature and needed to verify. If a signature delegation is defined, this fingerprint/id is not used to produce the signature, and, instead is used to sign the delegation.
+ +
+ +
+
+ signing_algorithm_spec + SigningAlgorithmSpec + +
+ +
The signing algorithm specification used to produce this signature
+ +
+ +
+
+ signature_delegation + SignatureDelegation + +
+ +
An optional signature delegation where a long-term signing key authorizes a session signing key to sign on its behalf.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SignatureFormat

+ +

5 values

+ +
+ + + +
    + +
  • SIGNATURE_FORMAT_UNSPECIFIED
    • + +
  • SIGNATURE_FORMAT_RAW
    • + +
  • SIGNATURE_FORMAT_DER
    • + +
  • SIGNATURE_FORMAT_CONCAT
    • + +
  • SIGNATURE_FORMAT_SYMBOLIC
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SignatureDelegation

+ +

7 fields

+ +
+ + +
+ +
+
+ session_key + bytes + +
+ +
ASN.1 + DER-encoding of X.509 SubjectPublicKeyInfo structure of the session public key: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1. This key was used to produce the actual signature.
+ +
+ +
+
+ session_key_spec + SigningKeySpec + +
+ +
The signing key spec for the session key.
+ +
+ +
+
+ validity_period_from_inclusive + int64 + +
+ +
A timestamp in microseconds of UTC time since Unix epoch that indicates when the session key is considered valid.
+ +
+ +
+
+ validity_period_duration_seconds + uint32 + +
+ +
Duration in seconds indicating how long the session key remains valid. The validity period starts from `validity_period_from_inclusive` above.
+ +
+ +
+
+ format + SignatureFormat + +
+ +
The format of the signature
+ +
+ +
+
+ signature + bytes + +
+ +
The signature of the combined hash of the session key fingerprint, validity period, and synchronizer id, by the long-term key. This signature authorizes the session key to act on behalf of the long-term key.
+ +
+ +
+
+ signing_algorithm_spec + SigningAlgorithmSpec + +
+ +
The signing algorithm specification used to produce this signature
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SigningKeysWithThreshold

+ +

2 fields

+ +
+ + +
+ +
+
+ keys + repeated SigningPublicKey + +
+ +
the designated signing keys
+ +
+ +
+
+ threshold + uint32 + +
+ +
the authorization threshold
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SymmetricKey

+ +

3 fields

+ +
+ + +
+ +
+
+ format + CryptoKeyFormat + +
+ +
+ +
+
+ key + bytes + +
+ +
+ +
+
+ scheme + SymmetricKeyScheme + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.HashAlgorithm

+ +

2 values

+ +
+ + + +
    + +
  • HASH_ALGORITHM_UNSPECIFIED
    • + +
  • HASH_ALGORITHM_SHA256
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.v30.KeyPurpose

+ +

3 values

+ +
+ + + +
    + +
  • KEY_PURPOSE_UNSPECIFIED
    • + +
  • KEY_PURPOSE_SIGNING
    • + +
  • KEY_PURPOSE_ENCRYPTION
    • + +
+ + +
diff --git a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-mediator-admin-v30.mdx b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-mediator-admin-v30.mdx index d937142..761b99a 100644 --- a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-mediator-admin-v30.mdx +++ b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-mediator-admin-v30.mdx @@ -1,721 +1,1770 @@ --- title: "com.digitalasset.canton.mediator.admin.v30" -description: "Descriptor-backed protobuf API history for package com.digitalasset.canton.mediator.admin.v30." +description: "Package-level overview for com.digitalasset.canton.mediator.admin.v30." --- -# Package `com.digitalasset.canton.mediator.admin.v30` +

Back to overview

+ +
+ +

Protobuf Package

+ + +

com.digitalasset.canton.mediator.admin.v30

+ + +

4 services, 13 endpoints, 17 messages, 1 enums

+ + +
+ + gRPC + +
+ + +
+ +
+
Files
+
4
+
+ +
+
Services
+
4
+
+ +
+
Endpoints
+
13
+
+ +
+
Messages
+
17
+
+ +
+
Enums
+
1
+
+ +
+ +
-[Back to Canton Protobuf History](../index) - -## Snapshot - -- Current files: `4` -- Current services: `4` -- Current endpoints: `13` -- Current messages: `17` -- Current enums: `1` -- Lifecycle endpoints tracked: `13` ## Source Files -| File | Services | Messages | Enums | Source | -| --- | --- | --- | --- | --- | -| community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_administration_service.proto | `1` | `1` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_administration_service.proto#L4) | -| community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_initialization_service.proto | `1` | `2` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_initialization_service.proto#L4) | -| community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_inspection_service.proto | `1` | `6` | `1` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_inspection_service.proto#L4) | -| community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/sequencer_connection_service.proto | `1` | `6` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/sequencer_connection_service.proto#L4) | -## Services -| Service | Endpoints | Source | Description | -| --- | --- | --- | --- | -| [`MediatorAdministrationService`](#service-com-digitalasset-canton-mediator-admin-v30-mediatoradministrationservice) | `8` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_administration_service.proto#L12) | administration service for mediator instances | -| [`MediatorInitializationService`](#service-com-digitalasset-canton-mediator-admin-v30-mediatorinitializationservice) | `1` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_initialization_service.proto#L10) | | -| [`MediatorInspectionService`](#service-com-digitalasset-canton-mediator-admin-v30-mediatorinspectionservice) | `1` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_inspection_service.proto#L10) | | -| [`SequencerConnectionService`](#service-com-digitalasset-canton-mediator-admin-v30-sequencerconnectionservice) | `3` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/sequencer_connection_service.proto#L12) | service used by sequencer clients to manage connection to the sequencer used by the mediator | - -### Service `MediatorAdministrationService` +
+ + +
+ +
+

community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_administration_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
1
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_administration_service.proto
+
+ +
+ + +
+ + + +
+ +
+

community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_initialization_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
2
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_initialization_service.proto
+
+ +
+ + +
+ + + +
+ +
+

community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_inspection_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
6
+
+ +
+
Enums
+
1
+
+ +
+
Source
+
community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_inspection_service.proto
+
+ +
+ + +
+ + + +
+ +
+

community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/sequencer_connection_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
6
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/sequencer_connection_service.proto
+
+ +
+ + +
+ + +
+ + + + + +## MediatorAdministrationService -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_administration_service.proto#L12) -- Endpoints tracked: `8` administration service for mediator instances -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`ClearSchedule`](#endpoint-com-digitalasset-canton-mediator-admin-v30-mediatoradministrationservice-clearschedule) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.pruning.v30.ClearScheduleRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-clearschedulerequest) | [`com.digitalasset.canton.admin.pruning.v30.ClearScheduleResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-clearscheduleresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_administration_service.proto#L31) | -| [`FindPruningTimestamp`](#endpoint-com-digitalasset-canton-mediator-admin-v30-mediatoradministrationservice-findpruningtimestamp) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.pruning.v30.FindPruningTimestampRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-findpruningtimestamprequest) | [`com.digitalasset.canton.admin.pruning.v30.FindPruningTimestampResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-findpruningtimestampresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_administration_service.proto#L37) | -| [`GetSchedule`](#endpoint-com-digitalasset-canton-mediator-admin-v30-mediatoradministrationservice-getschedule) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.pruning.v30.GetScheduleRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-getschedulerequest) | [`com.digitalasset.canton.admin.pruning.v30.GetScheduleResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-getscheduleresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_administration_service.proto#L34) | -| [`Prune`](#endpoint-com-digitalasset-canton-mediator-admin-v30-mediatoradministrationservice-prune) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.mediator.admin.v30.MediatorPruning.PruneRequest`](#type-com-digitalasset-canton-mediator-admin-v30-mediatorpruning-prunerequest) | [`com.digitalasset.canton.mediator.admin.v30.MediatorPruning.PruneResponse`](#type-com-digitalasset-canton-mediator-admin-v30-mediatorpruning-pruneresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_administration_service.proto#L14) | -| [`SetCron`](#endpoint-com-digitalasset-canton-mediator-admin-v30-mediatoradministrationservice-setcron) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.pruning.v30.SetCronRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setcronrequest) | [`com.digitalasset.canton.admin.pruning.v30.SetCronResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setcronresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_administration_service.proto#L26) | -| [`SetMaxDuration`](#endpoint-com-digitalasset-canton-mediator-admin-v30-mediatoradministrationservice-setmaxduration) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.pruning.v30.SetMaxDurationRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setmaxdurationrequest) | [`com.digitalasset.canton.admin.pruning.v30.SetMaxDurationResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setmaxdurationresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_administration_service.proto#L27) | -| [`SetRetention`](#endpoint-com-digitalasset-canton-mediator-admin-v30-mediatoradministrationservice-setretention) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.pruning.v30.SetRetentionRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setretentionrequest) | [`com.digitalasset.canton.admin.pruning.v30.SetRetentionResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setretentionresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_administration_service.proto#L28) | -| [`SetSchedule`](#endpoint-com-digitalasset-canton-mediator-admin-v30-mediatoradministrationservice-setschedule) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.pruning.v30.SetScheduleRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setschedulerequest) | [`com.digitalasset.canton.admin.pruning.v30.SetScheduleResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setscheduleresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_administration_service.proto#L22) | - - -**Endpoint `MediatorAdministrationService.ClearSchedule`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_administration_service.proto#L31) - -**Signature** - -```protobuf -rpc MediatorAdministrationService.ClearSchedule(com.digitalasset.canton.admin.pruning.v30.ClearScheduleRequest) returns (com.digitalasset.canton.admin.pruning.v30.ClearScheduleResponse); -``` - -Disable automatic pruning and remove the persisted schedule configuration. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.pruning.v30.ClearScheduleRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-clearschedulerequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.pruning.v30.ClearScheduleResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-clearscheduleresponse) - - -**Endpoint `MediatorAdministrationService.FindPruningTimestamp`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_administration_service.proto#L37) - -**Signature** - -```protobuf -rpc MediatorAdministrationService.FindPruningTimestamp(com.digitalasset.canton.admin.pruning.v30.FindPruningTimestampRequest) returns (com.digitalasset.canton.admin.pruning.v30.FindPruningTimestampResponse); -``` - -Retrieve pruning timestamp at or near the "beginning" of events. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.pruning.v30.FindPruningTimestampRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-findpruningtimestamprequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.pruning.v30.FindPruningTimestampResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-findpruningtimestampresponse) - - -**Endpoint `MediatorAdministrationService.GetSchedule`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_administration_service.proto#L34) - -**Signature** - -```protobuf -rpc MediatorAdministrationService.GetSchedule(com.digitalasset.canton.admin.pruning.v30.GetScheduleRequest) returns (com.digitalasset.canton.admin.pruning.v30.GetScheduleResponse); -``` - -Retrieve the automatic pruning configuration. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.pruning.v30.GetScheduleRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-getschedulerequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.pruning.v30.GetScheduleResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-getscheduleresponse) - - -**Endpoint `MediatorAdministrationService.Prune`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_administration_service.proto#L14) - -**Signature** - -```protobuf -rpc MediatorAdministrationService.Prune(com.digitalasset.canton.mediator.admin.v30.MediatorPruning.PruneRequest) returns (com.digitalasset.canton.mediator.admin.v30.MediatorPruning.PruneResponse); -``` - -Remove unnecessary data from the Mediator - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.mediator.admin.v30.MediatorPruning.PruneRequest`](#type-com-digitalasset-canton-mediator-admin-v30-mediatorpruning-prunerequest) - -**Response Type** - -- [`com.digitalasset.canton.mediator.admin.v30.MediatorPruning.PruneResponse`](#type-com-digitalasset-canton-mediator-admin-v30-mediatorpruning-pruneresponse) - - -**Endpoint `MediatorAdministrationService.SetCron`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_administration_service.proto#L26) - -**Signature** - -```protobuf -rpc MediatorAdministrationService.SetCron(com.digitalasset.canton.admin.pruning.v30.SetCronRequest) returns (com.digitalasset.canton.admin.pruning.v30.SetCronResponse); -``` - -Modify individual pruning schedule parameters. - - ``INVALID_ARGUMENT``: if the payload is malformed or no schedule is configured - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.pruning.v30.SetCronRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setcronrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.pruning.v30.SetCronResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setcronresponse) - - -**Endpoint `MediatorAdministrationService.SetMaxDuration`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_administration_service.proto#L27) - -**Signature** - -```protobuf -rpc MediatorAdministrationService.SetMaxDuration(com.digitalasset.canton.admin.pruning.v30.SetMaxDurationRequest) returns (com.digitalasset.canton.admin.pruning.v30.SetMaxDurationResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.pruning.v30.SetMaxDurationRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setmaxdurationrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.pruning.v30.SetMaxDurationResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setmaxdurationresponse) - - -**Endpoint `MediatorAdministrationService.SetRetention`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_administration_service.proto#L28) - -**Signature** - -```protobuf -rpc MediatorAdministrationService.SetRetention(com.digitalasset.canton.admin.pruning.v30.SetRetentionRequest) returns (com.digitalasset.canton.admin.pruning.v30.SetRetentionResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.pruning.v30.SetRetentionRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setretentionrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.pruning.v30.SetRetentionResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setretentionresponse) - - -**Endpoint `MediatorAdministrationService.SetSchedule`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_administration_service.proto#L22) - -**Signature** - -```protobuf -rpc MediatorAdministrationService.SetSchedule(com.digitalasset.canton.admin.pruning.v30.SetScheduleRequest) returns (com.digitalasset.canton.admin.pruning.v30.SetScheduleResponse); -``` - -Enable automatic pruning using the specified schedule parameters - The following errors may occur on the SetSchedule or Update commands: - - ``INVALID_ARGUMENT``: if a parameter is missing or an invalid cron expression - or duration. - - ``FAILED_PRECONDITION``: if automatic background pruning has not been enabled - or if invoked on a participant running the Community Edition. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.pruning.v30.SetScheduleRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setschedulerequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.pruning.v30.SetScheduleResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setscheduleresponse) - - -### Service `MediatorInitializationService` - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_initialization_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_initialization_service.proto#L10) -- Endpoints tracked: `1` - -_No description._ - -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`InitializeMediator`](#endpoint-com-digitalasset-canton-mediator-admin-v30-mediatorinitializationservice-initializemediator) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.mediator.admin.v30.InitializeMediatorRequest`](#type-com-digitalasset-canton-mediator-admin-v30-initializemediatorrequest) | [`com.digitalasset.canton.mediator.admin.v30.InitializeMediatorResponse`](#type-com-digitalasset-canton-mediator-admin-v30-initializemediatorresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_initialization_service.proto#L15) | - - -**Endpoint `MediatorInitializationService.InitializeMediator`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_initialization_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_initialization_service.proto#L15) - -**Signature** - -```protobuf -rpc MediatorInitializationService.InitializeMediator(com.digitalasset.canton.mediator.admin.v30.InitializeMediatorRequest) returns (com.digitalasset.canton.mediator.admin.v30.InitializeMediatorResponse); -``` - -Initialize a Mediator service - If the Mediator is uninitialized it should initialize itself with the provided configuration - If the Mediator is already initialized then verify the request is for the synchronizer we're running against, - if correct then just return the current key otherwise fail. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.mediator.admin.v30.InitializeMediatorRequest`](#type-com-digitalasset-canton-mediator-admin-v30-initializemediatorrequest) - -**Response Type** - -- [`com.digitalasset.canton.mediator.admin.v30.InitializeMediatorResponse`](#type-com-digitalasset-canton-mediator-admin-v30-initializemediatorresponse) - - -### Service `MediatorInspectionService` - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_inspection_service.proto#L10) -- Endpoints tracked: `1` - -_No description._ - -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`Verdicts`](#endpoint-com-digitalasset-canton-mediator-admin-v30-mediatorinspectionservice-verdicts) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.mediator.admin.v30.VerdictsRequest`](#type-com-digitalasset-canton-mediator-admin-v30-verdictsrequest) | [`com.digitalasset.canton.mediator.admin.v30.VerdictsResponse`](#type-com-digitalasset-canton-mediator-admin-v30-verdictsresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_inspection_service.proto#L19) | - -**Endpoint `MediatorInspectionService.Verdicts`** +
+ +
+
Source file
+
community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_administration_service.proto
+
+ +
+
Operations
+
8
+
+ +
+ + +
+ + + + +
+

MediatorAdministrationService.ClearSchedule

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Disable automatic pruning and remove the persisted schedule configuration.

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.pruning.v30.ClearScheduleRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.pruning.v30.ClearScheduleResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

MediatorAdministrationService.FindPruningTimestamp

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Retrieve pruning timestamp at or near the "beginning" of events.

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.pruning.v30.FindPruningTimestampRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.pruning.v30.FindPruningTimestampResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

MediatorAdministrationService.GetSchedule

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Retrieve the automatic pruning configuration.

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.pruning.v30.GetScheduleRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.pruning.v30.GetScheduleResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

MediatorAdministrationService.Prune

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Remove unnecessary data from the Mediator

+ + +
+ +
+
Request
+
com.digitalasset.canton.mediator.admin.v30.MediatorPruning.PruneRequest
+
+ +
+
Response
+
com.digitalasset.canton.mediator.admin.v30.MediatorPruning.PruneResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

MediatorAdministrationService.SetCron

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Modify individual pruning schedule parameters. - ``INVALID_ARGUMENT``: if the payload is malformed or no schedule is configured

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.pruning.v30.SetCronRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.pruning.v30.SetCronResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

MediatorAdministrationService.SetMaxDuration

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc MediatorAdministrationService.SetMaxDuration(com.digitalasset.canton.admin.pruning.v30.SetMaxDurationRequest) returns (com.digitalasset.canton.admin.pruning.v30.SetMaxDurati...

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.pruning.v30.SetMaxDurationRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.pruning.v30.SetMaxDurationResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

MediatorAdministrationService.SetRetention

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc MediatorAdministrationService.SetRetention(com.digitalasset.canton.admin.pruning.v30.SetRetentionRequest) returns (com.digitalasset.canton.admin.pruning.v30.SetRetentionResp...

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.pruning.v30.SetRetentionRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.pruning.v30.SetRetentionResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

MediatorAdministrationService.SetSchedule

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Enable automatic pruning using the specified schedule parameters The following errors may occur on the SetSchedule or Update commands: - ``INVALID_ARGUMENT``: if a parameter is...

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.pruning.v30.SetScheduleRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.pruning.v30.SetScheduleResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## MediatorInitializationService + + + +
+ +
+
Source file
+
community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_initialization_service.proto
+
+ +
+
Operations
+
1
+
+ +
+ + +
+ + + + +
+

MediatorInitializationService.InitializeMediator

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Initialize a Mediator service If the Mediator is uninitialized it should initialize itself with the provided configuration If the Mediator is already initialized then verify the...

+ + +
+ +
+
Request
+
com.digitalasset.canton.mediator.admin.v30.InitializeMediatorRequest
+
+ +
+
Response
+
com.digitalasset.canton.mediator.admin.v30.InitializeMediatorResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## MediatorInspectionService + + + +
+ +
+
Source file
+
community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_inspection_service.proto
+
+ +
+
Operations
+
1
+
+ +
+ + +
+ + + + +
+

MediatorInspectionService.Verdicts

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Returns a stream of mediator verdicts ordered primarily by the finalization time of the mediator verdict, reflected by the field finalization_time, and secondarily by the record...

+ + +
+ +
+
Request
+
com.digitalasset.canton.mediator.admin.v30.VerdictsRequest
+
+ +
+
Response
+
com.digitalasset.canton.mediator.admin.v30.VerdictsResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + + +
+ + + + + +## SequencerConnectionService -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_inspection_service.proto#L19) - -**Signature** - -```protobuf -rpc MediatorInspectionService.Verdicts(com.digitalasset.canton.mediator.admin.v30.VerdictsRequest) returns (stream com.digitalasset.canton.mediator.admin.v30.VerdictsResponse); -``` - -Returns a stream of mediator verdicts ordered primarily by the finalization time - of the mediator verdict, reflected by the field - finalization_time, and secondarily by the record_time. - Limitation: - All non-finalized requests at the time of a mediator restart or crash will not be - contained as a response, as the mediator currently does not have crash recovery procedures - to restore the state necessary to process such responses after the restart. - Other mediators will report those verdicts though. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.mediator.admin.v30.VerdictsRequest`](#type-com-digitalasset-canton-mediator-admin-v30-verdictsrequest) - -**Response Type** - -- [`com.digitalasset.canton.mediator.admin.v30.VerdictsResponse`](#type-com-digitalasset-canton-mediator-admin-v30-verdictsresponse) - - -### Service `SequencerConnectionService` - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/sequencer_connection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/sequencer_connection_service.proto#L12) -- Endpoints tracked: `3` service used by sequencer clients to manage connection to the sequencer used by the mediator -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`GetConnection`](#endpoint-com-digitalasset-canton-mediator-admin-v30-sequencerconnectionservice-getconnection) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.mediator.admin.v30.GetConnectionRequest`](#type-com-digitalasset-canton-mediator-admin-v30-getconnectionrequest) | [`com.digitalasset.canton.mediator.admin.v30.GetConnectionResponse`](#type-com-digitalasset-canton-mediator-admin-v30-getconnectionresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/sequencer_connection_service.proto#L13) | -| [`Logout`](#endpoint-com-digitalasset-canton-mediator-admin-v30-sequencerconnectionservice-logout) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.mediator.admin.v30.LogoutRequest`](#type-com-digitalasset-canton-mediator-admin-v30-logoutrequest) | [`com.digitalasset.canton.mediator.admin.v30.LogoutResponse`](#type-com-digitalasset-canton-mediator-admin-v30-logoutresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/sequencer_connection_service.proto#L16) | -| [`SetConnection`](#endpoint-com-digitalasset-canton-mediator-admin-v30-sequencerconnectionservice-setconnection) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.mediator.admin.v30.SetConnectionRequest`](#type-com-digitalasset-canton-mediator-admin-v30-setconnectionrequest) | [`com.digitalasset.canton.mediator.admin.v30.SetConnectionResponse`](#type-com-digitalasset-canton-mediator-admin-v30-setconnectionresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/sequencer_connection_service.proto#L14) | - - -**Endpoint `SequencerConnectionService.GetConnection`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/sequencer_connection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/sequencer_connection_service.proto#L13) - -**Signature** - -```protobuf -rpc SequencerConnectionService.GetConnection(com.digitalasset.canton.mediator.admin.v30.GetConnectionRequest) returns (com.digitalasset.canton.mediator.admin.v30.GetConnectionResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.mediator.admin.v30.GetConnectionRequest`](#type-com-digitalasset-canton-mediator-admin-v30-getconnectionrequest) - -**Response Type** - -- [`com.digitalasset.canton.mediator.admin.v30.GetConnectionResponse`](#type-com-digitalasset-canton-mediator-admin-v30-getconnectionresponse) - - -**Endpoint `SequencerConnectionService.Logout`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/sequencer_connection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/sequencer_connection_service.proto#L16) - -**Signature** - -```protobuf -rpc SequencerConnectionService.Logout(com.digitalasset.canton.mediator.admin.v30.LogoutRequest) returns (com.digitalasset.canton.mediator.admin.v30.LogoutResponse); -``` - -Revoke the authentication tokens for all the sequencers on the synchronizer and disconnect the sequencer clients - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.mediator.admin.v30.LogoutRequest`](#type-com-digitalasset-canton-mediator-admin-v30-logoutrequest) - -**Response Type** - -- [`com.digitalasset.canton.mediator.admin.v30.LogoutResponse`](#type-com-digitalasset-canton-mediator-admin-v30-logoutresponse) - - -**Endpoint `SequencerConnectionService.SetConnection`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/sequencer_connection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/sequencer_connection_service.proto#L14) - -**Signature** - -```protobuf -rpc SequencerConnectionService.SetConnection(com.digitalasset.canton.mediator.admin.v30.SetConnectionRequest) returns (com.digitalasset.canton.mediator.admin.v30.SetConnectionResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.mediator.admin.v30.SetConnectionRequest`](#type-com-digitalasset-canton-mediator-admin-v30-setconnectionrequest) - -**Response Type** - -- [`com.digitalasset.canton.mediator.admin.v30.SetConnectionResponse`](#type-com-digitalasset-canton-mediator-admin-v30-setconnectionresponse) - -## Type Reference - - -**Message `com.digitalasset.canton.mediator.admin.v30.GetConnectionRequest`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/sequencer_connection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/sequencer_connection_service.proto#L19) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.mediator.admin.v30.GetConnectionResponse`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/sequencer_connection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/sequencer_connection_service.proto#L21) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| sequencer_connections | [`com.digitalasset.canton.admin.sequencer.v30.SequencerConnections`](com-digitalasset-canton-admin-sequencer-v30#type-com-digitalasset-canton-admin-sequencer-v30-sequencerconnections) | optional | optional | - - -**Message `com.digitalasset.canton.mediator.admin.v30.InitializeMediatorRequest`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_initialization_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_initialization_service.proto#L18) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| physical_synchronizer_id | `string` | optional | the synchronizer identifier | -| sequencer_connections | [`com.digitalasset.canton.admin.sequencer.v30.SequencerConnections`](com-digitalasset-canton-admin-sequencer-v30#type-com-digitalasset-canton-admin-sequencer-v30-sequencerconnections) | optional | how should the member connect to the synchronizer sequencer | -| sequencer_connection_validation | [`com.digitalasset.canton.admin.sequencer.v30.SequencerConnectionValidation`](com-digitalasset-canton-admin-sequencer-v30#type-com-digitalasset-canton-admin-sequencer-v30-sequencerconnectionvalidation) | optional | how strictly we should validate the connection to the sequencer | - - -**Message `com.digitalasset.canton.mediator.admin.v30.InitializeMediatorResponse`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_initialization_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_initialization_service.proto#L29) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.mediator.admin.v30.LogoutRequest`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/sequencer_connection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/sequencer_connection_service.proto#L32) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.mediator.admin.v30.LogoutResponse`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/sequencer_connection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/sequencer_connection_service.proto#L34) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.mediator.admin.v30.MediatorPruning`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_administration_service.proto#L40) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.mediator.admin.v30.MediatorPruning.PruneRequest`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_administration_service.proto#L41) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| timestamp | `google.protobuf.Timestamp` | optional | timestamp to prune for | - - -**Message `com.digitalasset.canton.mediator.admin.v30.MediatorPruning.PruneResponse`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_administration_service.proto#L46) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.mediator.admin.v30.Quorum`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_inspection_service.proto#L67) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| parties | `string` | repeated | | -| threshold | `int32` | optional | | - - -**Message `com.digitalasset.canton.mediator.admin.v30.SetConnectionRequest`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/sequencer_connection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/sequencer_connection_service.proto#L25) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| sequencer_connections | [`com.digitalasset.canton.admin.sequencer.v30.SequencerConnections`](com-digitalasset-canton-admin-sequencer-v30#type-com-digitalasset-canton-admin-sequencer-v30-sequencerconnections) | optional | required | -| sequencer_connection_validation | [`com.digitalasset.canton.admin.sequencer.v30.SequencerConnectionValidation`](com-digitalasset-canton-admin-sequencer-v30#type-com-digitalasset-canton-admin-sequencer-v30-sequencerconnectionvalidation) | optional | required | - - -**Message `com.digitalasset.canton.mediator.admin.v30.SetConnectionResponse`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/sequencer_connection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/sequencer_connection_service.proto#L30) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.mediator.admin.v30.TransactionView`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_inspection_service.proto#L61) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| informees | `string` | repeated | | -| confirming_parties | [`com.digitalasset.canton.mediator.admin.v30.Quorum`](#type-com-digitalasset-canton-mediator-admin-v30-quorum) | repeated | | -| sub_views | `int32` | repeated | | - - -**Message `com.digitalasset.canton.mediator.admin.v30.TransactionViews`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_inspection_service.proto#L56) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| views | `map` | repeated | | -| root_views | `int32` | repeated | | - - -**Message `com.digitalasset.canton.mediator.admin.v30.Verdict`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_inspection_service.proto#L37) -- Fields: 8 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| submitting_parties | `string` | repeated | | -| submitting_participant_uid | `string` | optional | | -| verdict | [`com.digitalasset.canton.mediator.admin.v30.VerdictResult`](#type-com-digitalasset-canton-mediator-admin-v30-verdictresult) | optional | | -| finalization_time | `google.protobuf.Timestamp` | optional | the time of the finalization of the verdict, i.e.:
- the nth response required to finalize the verdict
- the participant response deadline in case the request timed out | -| record_time | `google.protobuf.Timestamp` | optional | record time of the request | -| mediator_group | `uint32` | optional | the mediator group of the mediator | -| transaction_views | [`com.digitalasset.canton.mediator.admin.v30.TransactionViews`](#type-com-digitalasset-canton-mediator-admin-v30-transactionviews) | optional | | -| update_id | `string` | optional | | - - -**Message `com.digitalasset.canton.mediator.admin.v30.VerdictsRequest`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_inspection_service.proto#L27) -- Fields: 1 - -The request to either start a stream of verdicts from the beginning of the mediator's pruning window, - or to resume a stream based on a previously received event. Both timestamps must be - provided to correctly resume the stream. - The starting timestamps are interpreted as "exclusive", meaning the next verdict in the response is - the verdict with the lowest respective timestamps that are greater than the ones provided. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| most_recently_received_record_time | `google.protobuf.Timestamp` | optional | Optional: The record_time_of_request of the most recently received verdict.
If not provided, the mediator will return verdicts from the beginning. | - - -**Message `com.digitalasset.canton.mediator.admin.v30.VerdictsResponse`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_inspection_service.proto#L33) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| verdict | [`com.digitalasset.canton.mediator.admin.v30.Verdict`](#type-com-digitalasset-canton-mediator-admin-v30-verdict) | optional | | - - -**Enum `com.digitalasset.canton.mediator.admin.v30.VerdictResult`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_inspection_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/mediator_inspection_service.proto#L72) - -_No description._ -| Name | Number | -| --- | --- | -| VERDICT_RESULT_UNSPECIFIED | `0` | -| VERDICT_RESULT_ACCEPTED | `1` | -| VERDICT_RESULT_REJECTED | `2` | +
+ +
+
Source file
+
community/synchronizer/src/main/protobuf/com/digitalasset/canton/mediator/admin/v30/sequencer_connection_service.proto
+
+ +
+
Operations
+
3
+
+ +
+ + +
+ + + + +
+

SequencerConnectionService.GetConnection

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc SequencerConnectionService.GetConnection(com.digitalasset.canton.mediator.admin.v30.GetConnectionRequest) returns (com.digitalasset.canton.mediator.admin.v30.GetConnectionRe...

+ + +
+ +
+
Request
+
com.digitalasset.canton.mediator.admin.v30.GetConnectionRequest
+
+ +
+
Response
+
com.digitalasset.canton.mediator.admin.v30.GetConnectionResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SequencerConnectionService.Logout

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Revoke the authentication tokens for all the sequencers on the synchronizer and disconnect the sequencer clients

+ + +
+ +
+
Request
+
com.digitalasset.canton.mediator.admin.v30.LogoutRequest
+
+ +
+
Response
+
com.digitalasset.canton.mediator.admin.v30.LogoutResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SequencerConnectionService.SetConnection

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc SequencerConnectionService.SetConnection(com.digitalasset.canton.mediator.admin.v30.SetConnectionRequest) returns (com.digitalasset.canton.mediator.admin.v30.SetConnectionRe...

+ + +
+ +
+
Request
+
com.digitalasset.canton.mediator.admin.v30.SetConnectionRequest
+
+ +
+
Response
+
com.digitalasset.canton.mediator.admin.v30.SetConnectionResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## Type Inventory + + +These are the package-level message and enum shapes in the publish-version snapshot. + + + + +
+
+

com.digitalasset.canton.mediator.admin.v30.GetConnectionRequest

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.mediator.admin.v30.GetConnectionResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ sequencer_connections + SequencerConnections + +
+ +
optional
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.sequencer.v30.SequencerConnections

+ +

5 fields

+ +
+ + +
+ +
+
+ sequencer_connections + repeated SequencerConnection + +
+ +
+ +
+
+ sequencer_trust_threshold + uint32 + +
+ +
This field determines the minimum level of agreement, or consensus, required among the sequencers before a message is considered reliable and accepted by the system. This value must be positive.
+ +
+ +
+
+ submission_request_amplification + SubmissionRequestAmplification + +
+ +
+ +
+
+ sequencer_liveness_margin + uint32 + +
+ +
This field determines the number of extra subscriptions to maintain beyond `sequencer_trust_threshold` in order to ensure liveness. This is only used when the new connection pool is enabled, and is ignored otherwise. This value must be non-negative.
+ +
+ +
+
+ sequencer_connection_pool_delays + SequencerConnectionPoolDelays + +
+ +
Configures the various delays used by the sequencer connection pool.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.sequencer.v30.SequencerConnection

+ +

3 fields

+ +
+ + +
+ +
+
+ grpc + Grpc + +
+ +
+ +
+
+ alias + string + +
+ +
+ +
+
+ sequencer_id + string + +
+ +
The id of the sequencer that serves the sequencer API. If empty, the node sets it after the first connection. If set, the node checks that the sequencer id reported by the sequencer matches this id.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.sequencer.v30.SequencerConnection.Grpc

+ +

3 fields

+ +
+ + +
+ +
+
+ connections + repeated string + +
+ +
connection information to sequencer (http[s]://<host>:<port>")
+ +
+ +
+
+ transport_security + bool + +
+ +
Should the connection use TLS?
+ +
+ +
+
+ custom_trust_certificates + bytes + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.sequencer.v30.SubmissionRequestAmplification

+ +

2 fields

+ +
+ + +
+ +
+
+ factor + uint32 + +
+ +
Determines to how often the client should try to send a submission request that is eligible for deduplication. A higher value increases the chance of a submission request being accepted by the system, but also increases the load on the sequencers and thus the costs incurred by the client. This value must be positive.
+ +
+ +
+
+ patience + Duration + +
+ +
Determines how long the sequencer client waits for observing the sequencing before it sends the submission request again. This value must be non-negative.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.sequencer.v30.SequencerConnectionPoolDelays

+ +

4 fields

+ +
+ + +
+ +
+
+ min_restart_delay + Duration + +
+ +
Minimum duration after which a failed sequencer connection is restarted. This value must be non-negative.
+ +
+ +
+
+ max_restart_delay + Duration + +
+ +
Maximum duration after which a failed sequencer connection is restarted. This value must be non-negative.
+ +
+ +
+
+ subscription_request_delay + Duration + +
+ +
Delay between the attempts to obtain new sequencer connections for the sequencer subscription pool, when the current number of subscriptions is below `trustThreshold` + `livenessMargin`. This value must be non-negative.
+ +
+ +
+
+ warn_validation_delay + Duration + +
+ +
Duration after which a warning is issued if a started connection still fails validation. This value must be non-negative.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.mediator.admin.v30.InitializeMediatorRequest

+ +

3 fields

+ +
+ + +
+ +
+
+ physical_synchronizer_id + string + +
+ +
the synchronizer identifier
+ +
+ +
+
+ sequencer_connections + SequencerConnections + +
+ +
how should the member connect to the synchronizer sequencer
+ +
+ +
+
+ sequencer_connection_validation + SequencerConnectionValidation + +
+ +
how strictly we should validate the connection to the sequencer
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.sequencer.v30.SequencerConnectionValidation

+ +

5 values

+ +
+ + + +
    + +
  • SEQUENCER_CONNECTION_VALIDATION_UNSPECIFIED
    • + +
  • SEQUENCER_CONNECTION_VALIDATION_DISABLED
    • + +
  • SEQUENCER_CONNECTION_VALIDATION_ACTIVE
    • + +
  • SEQUENCER_CONNECTION_VALIDATION_ALL
    • + +
  • SEQUENCER_CONNECTION_VALIDATION_THRESHOLD_ACTIVE
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.mediator.admin.v30.InitializeMediatorResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.mediator.admin.v30.LogoutRequest

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.mediator.admin.v30.LogoutResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.mediator.admin.v30.MediatorPruning

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.mediator.admin.v30.MediatorPruning.PruneRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ timestamp + Timestamp + +
+ +
timestamp to prune for
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.mediator.admin.v30.MediatorPruning.PruneResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.mediator.admin.v30.Quorum

+ +

2 fields

+ +
+ + +
+ +
+
+ parties + repeated string + +
+ +
+ +
+
+ threshold + int32 + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.mediator.admin.v30.SetConnectionRequest

+ +

2 fields

+ +
+ + +
+ +
+
+ sequencer_connections + SequencerConnections + +
+ +
required
+ +
+ +
+
+ sequencer_connection_validation + SequencerConnectionValidation + +
+ +
required
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.mediator.admin.v30.SetConnectionResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.mediator.admin.v30.TransactionView

+ +

3 fields

+ +
+ + +
+ +
+
+ informees + repeated string + +
+ +
+ +
+
+ confirming_parties + repeated Quorum + +
+ +
+ +
+
+ sub_views + repeated int32 + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.mediator.admin.v30.TransactionViews

+ +

2 fields

+ +
+ + +
+ +
+
+ views + repeated map + +
+ +
+ +
+
+ root_views + repeated int32 + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.mediator.admin.v30.Verdict

+ +

8 fields

+ +
+ + +
+ +
+
+ submitting_parties + repeated string + +
+ +
+ +
+
+ submitting_participant_uid + string + +
+ +
+ +
+
+ verdict + VerdictResult + +
+ +
+ +
+
+ finalization_time + Timestamp + +
+ +
the time of the finalization of the verdict, i.e.: - the nth response required to finalize the verdict - the participant response deadline in case the request timed out
+ +
+ +
+
+ record_time + Timestamp + +
+ +
record time of the request
+ +
+ +
+
+ mediator_group + uint32 + +
+ +
the mediator group of the mediator
+ +
+ +
+
+ transaction_views + TransactionViews + +
+ +
+ +
+
+ update_id + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.mediator.admin.v30.VerdictResult

+ +

3 values

+ +
+ + + +
    + +
  • VERDICT_RESULT_UNSPECIFIED
    • + +
  • VERDICT_RESULT_ACCEPTED
    • + +
  • VERDICT_RESULT_REJECTED
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.mediator.admin.v30.VerdictsRequest

+ +

1 fields

+ +
+ +

The request to either start a stream of verdicts from the beginning of the mediator's pruning window, or to resume a stream based on a previously received event. Both timestamps must be provided to correctly resume the stream. The starting timestamps are interpreted as "exclusive", meaning the next verdict in the response is the verdict with the lowest respective timestamps that are greater than the ones provided.

+ + +
+ +
+
+ most_recently_received_record_time + Timestamp + +
+ +
Optional: The record_time_of_request of the most recently received verdict. If not provided, the mediator will return verdicts from the beginning.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.mediator.admin.v30.VerdictsResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ verdict + Verdict + +
+ +
+ +
+ + + +
diff --git a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-participant-protocol-v30.mdx b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-participant-protocol-v30.mdx index a607702..0159b03 100644 --- a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-participant-protocol-v30.mdx +++ b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-participant-protocol-v30.mdx @@ -1,176 +1,796 @@ --- title: "com.digitalasset.canton.participant.protocol.v30" -description: "Descriptor-backed protobuf API history for package com.digitalasset.canton.participant.protocol.v30." +description: "Package-level overview for com.digitalasset.canton.participant.protocol.v30." --- -# Package `com.digitalasset.canton.participant.protocol.v30` +

Back to overview

+ +
+ +

Protobuf Package

+ + +

com.digitalasset.canton.participant.protocol.v30

+ + +

0 services, 0 endpoints, 12 messages

+ + +
+ + gRPC + +
+ + +
+ +
+
Files
+
2
+
+ +
+
Services
+
0
+
+ +
+
Endpoints
+
0
+
+ +
+
Messages
+
12
+
+ +
+
Enums
+
0
+
+ +
+ +
-[Back to Canton Protobuf History](../index) - -## Snapshot - -- Current files: `2` -- Current services: `0` -- Current endpoints: `0` -- Current messages: `12` -- Current enums: `0` -- Lifecycle endpoints tracked: `0` ## Source Files -| File | Services | Messages | Enums | Source | -| --- | --- | --- | --- | --- | -| community/participant/src/main/protobuf/com/digitalasset/canton/participant/protocol/v30/party_replication.proto | `0` | `2` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/participant/src/main/protobuf/com/digitalasset/canton/participant/protocol/v30/party_replication.proto#L4) | -| community/participant/src/main/protobuf/com/digitalasset/canton/participant/protocol/v30/submission_tracking.proto | `0` | `4` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/participant/src/main/protobuf/com/digitalasset/canton/participant/protocol/v30/submission_tracking.proto#L4) | - -## Type Reference - - -**Message `com.digitalasset.canton.participant.protocol.v30.CommandRejected`** - -- Source: [community/participant/src/main/protobuf/com/digitalasset/canton/participant/protocol/v30/submission_tracking.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/participant/src/main/protobuf/com/digitalasset/canton/participant/protocol/v30/submission_tracking.proto#L20) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.participant.protocol.v30.CommandRejected.GrpcRejectionReasonTemplate`** - -- Source: [community/participant/src/main/protobuf/com/digitalasset/canton/participant/protocol/v30/submission_tracking.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/participant/src/main/protobuf/com/digitalasset/canton/participant/protocol/v30/submission_tracking.proto#L22) -- Fields: 1 - -Is always a `com.daml.ledger.participant.state.v2.FinalReason` - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| status | `bytes` | optional | | - - -**Message `com.digitalasset.canton.participant.protocol.v30.CompletionInfo`** - -- Source: [community/participant/src/main/protobuf/com/digitalasset/canton/participant/protocol/v30/submission_tracking.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/participant/src/main/protobuf/com/digitalasset/canton/participant/protocol/v30/submission_tracking.proto#L12) -- Fields: 5 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| act_as | `string` | repeated | | -| user_id | `string` | optional | | -| command_id | `string` | optional | | -| opt_deduplication_period | [`com.digitalasset.canton.protocol.v30.DeduplicationPeriod`](com-digitalasset-canton-protocol-v30#type-com-digitalasset-canton-protocol-v30-deduplicationperiod) | optional | | -| submission_id | `string` | optional | | - - -**Message `com.digitalasset.canton.participant.protocol.v30.PartyReplicationSourceParticipantMessage`** - -- Source: [community/participant/src/main/protobuf/com/digitalasset/canton/participant/protocol/v30/party_replication.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/participant/src/main/protobuf/com/digitalasset/canton/participant/protocol/v30/party_replication.proto#L46) -- Fields: 2 - -* - Party replication protocol message sent by the source participant to the target participant. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| acs_batch | [`com.digitalasset.canton.participant.protocol.v30.PartyReplicationSourceParticipantMessage.AcsBatch`](#type-com-digitalasset-canton-participant-protocol-v30-partyreplicationsourceparticipantmessage-acsbatch) | optional | | -| end_of_acs | [`com.digitalasset.canton.participant.protocol.v30.PartyReplicationSourceParticipantMessage.EndOfACS`](#type-com-digitalasset-canton-participant-protocol-v30-partyreplicationsourceparticipantmessage-endofacs) | optional | | - - -**Message `com.digitalasset.canton.participant.protocol.v30.PartyReplicationSourceParticipantMessage.AcsBatch`** - -- Source: [community/participant/src/main/protobuf/com/digitalasset/canton/participant/protocol/v30/party_replication.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/participant/src/main/protobuf/com/digitalasset/canton/participant/protocol/v30/party_replication.proto#L50) -- Fields: 1 - -Batch of ACS contracts previously requested by the target participant. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| contracts | [`com.digitalasset.canton.admin.participant.v30.ActiveContractOld`](com-digitalasset-canton-admin-participant-v30#type-com-digitalasset-canton-admin-participant-v30-activecontractold) | repeated | The portion of the ACS in the batch expressed as nonempty list
TODO(#24326) - Use a Ledger API representation instead.
Required | - - -**Message `com.digitalasset.canton.participant.protocol.v30.PartyReplicationSourceParticipantMessage.EndOfACS`** - -- Source: [community/participant/src/main/protobuf/com/digitalasset/canton/participant/protocol/v30/party_replication.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/participant/src/main/protobuf/com/digitalasset/canton/participant/protocol/v30/party_replication.proto#L59) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.participant.protocol.v30.PartyReplicationTargetParticipantMessage`** - -- Source: [community/participant/src/main/protobuf/com/digitalasset/canton/participant/protocol/v30/party_replication.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/participant/src/main/protobuf/com/digitalasset/canton/participant/protocol/v30/party_replication.proto#L14) -- Fields: 2 - -* - Party replication protocol message sent by the target participant to the source participant. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| initialize | [`com.digitalasset.canton.participant.protocol.v30.PartyReplicationTargetParticipantMessage.Initialize`](#type-com-digitalasset-canton-participant-protocol-v30-partyreplicationtargetparticipantmessage-initialize) | optional | | -| send_acs_up_to | [`com.digitalasset.canton.participant.protocol.v30.PartyReplicationTargetParticipantMessage.SendAcsUpTo`](#type-com-digitalasset-canton-participant-protocol-v30-partyreplicationtargetparticipantmessage-sendacsupto) | optional | | - - -**Message `com.digitalasset.canton.participant.protocol.v30.PartyReplicationTargetParticipantMessage.Initialize`** - -- Source: [community/participant/src/main/protobuf/com/digitalasset/canton/participant/protocol/v30/party_replication.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/participant/src/main/protobuf/com/digitalasset/canton/participant/protocol/v30/party_replication.proto#L19) -- Fields: 1 - -The Initialize instruction must be the first message to the source participant - and must never be sent as the second or later message. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| initial_contract_ordinal_inclusive | `uint32` | optional | The ACS contract ordinal (0-based) to send as part of the first SendAcsUpTo instruction. | - - -**Message `com.digitalasset.canton.participant.protocol.v30.PartyReplicationTargetParticipantMessage.SendAcsUpTo`** - -- Source: [community/participant/src/main/protobuf/com/digitalasset/canton/participant/protocol/v30/party_replication.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/participant/src/main/protobuf/com/digitalasset/canton/participant/protocol/v30/party_replication.proto#L28) -- Fields: 1 - -SendAcsUpTo instructs the source participant to send ordered ACS contracts up to a specified - maximum ordinal. - This instruction lets the target participant flow-control the rate of ACS ingestion. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| max_contract_ordinal_inclusive | `uint32` | optional | ACS contract ordinal (0-based) deterministic on the source participant. This serves as a
watermark specifying up to which contract ordinal inclusively the source participant is expected
to send ACS contracts.
Required | - - -**Message `com.digitalasset.canton.participant.protocol.v30.SubmissionTrackingData`** - -- Source: [community/participant/src/main/protobuf/com/digitalasset/canton/participant/protocol/v30/submission_tracking.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/participant/src/main/protobuf/com/digitalasset/canton/participant/protocol/v30/submission_tracking.proto#L27) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| transaction | [`com.digitalasset.canton.participant.protocol.v30.TransactionSubmissionTrackingData`](#type-com-digitalasset-canton-participant-protocol-v30-transactionsubmissiontrackingdata) | optional | | - - -**Message `com.digitalasset.canton.participant.protocol.v30.TransactionSubmissionTrackingData`** - -- Source: [community/participant/src/main/protobuf/com/digitalasset/canton/participant/protocol/v30/submission_tracking.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/participant/src/main/protobuf/com/digitalasset/canton/participant/protocol/v30/submission_tracking.proto#L36) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| completion_info | [`com.digitalasset.canton.participant.protocol.v30.CompletionInfo`](#type-com-digitalasset-canton-participant-protocol-v30-completioninfo) | optional | | -| rejection_cause | [`com.digitalasset.canton.participant.protocol.v30.TransactionSubmissionTrackingData.RejectionCause`](#type-com-digitalasset-canton-participant-protocol-v30-transactionsubmissiontrackingdata-rejectioncause) | optional | | -| physical_synchronizer_id | `string` | optional | | - - -**Message `com.digitalasset.canton.participant.protocol.v30.TransactionSubmissionTrackingData.RejectionCause`** -- Source: [community/participant/src/main/protobuf/com/digitalasset/canton/participant/protocol/v30/submission_tracking.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/participant/src/main/protobuf/com/digitalasset/canton/participant/protocol/v30/submission_tracking.proto#L41) -- Fields: 2 -_No description._ -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| timeout | `google.protobuf.Empty` | optional | | -| rejection_reason_template | [`com.digitalasset.canton.participant.protocol.v30.CommandRejected.GrpcRejectionReasonTemplate`](#type-com-digitalasset-canton-participant-protocol-v30-commandrejected-grpcrejectionreasontemplate) | optional | | +
+ + +
+ +
+

community/participant/src/main/protobuf/com/digitalasset/canton/participant/protocol/v30/party_replication.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
2
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/participant/src/main/protobuf/com/digitalasset/canton/participant/protocol/v30/party_replication.proto
+
+ +
+ + +
+ + + +
+ +
+

community/participant/src/main/protobuf/com/digitalasset/canton/participant/protocol/v30/submission_tracking.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
4
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/participant/src/main/protobuf/com/digitalasset/canton/participant/protocol/v30/submission_tracking.proto
+
+ +
+ + +
+ + +
+ + + + + +## Type Inventory + + +These are the package-level message and enum shapes in the publish-version snapshot. + + + + +
+
+

com.digitalasset.canton.participant.protocol.v30.CommandRejected

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.participant.protocol.v30.CommandRejected.GrpcRejectionReasonTemplate

+ +

1 fields

+ +
+ +

Is always a `com.daml.ledger.participant.state.v2.FinalReason`

+ + +
+ +
+
+ status + bytes + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.participant.protocol.v30.CompletionInfo

+ +

5 fields

+ +
+ + +
+ +
+
+ act_as + repeated string + +
+ +
+ +
+
+ user_id + string + +
+ +
+ +
+
+ command_id + string + +
+ +
+ +
+
+ opt_deduplication_period + DeduplicationPeriod + +
+ +
+ +
+
+ submission_id + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.DeduplicationPeriod

+ +

2 fields

+ +
+ +

Messages sent by a participant as part of the transaction protocol

+ + +
+ +
+
+ duration + Duration + +
+ +
+ +
+
+ offset + int64 + +
+ +
if specified, it must be a valid absolute offset (positive integer) or zero (ledger begin offset)
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.participant.protocol.v30.PartyReplicationSourceParticipantMessage

+ +

2 fields

+ +
+ +

* Party replication protocol message sent by the source participant to the target participant.

+ + +
+ +
+
+ acs_batch + AcsBatch + +
+ +
+ +
+
+ end_of_acs + EndOfACS + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.participant.protocol.v30.PartyReplicationSourceParticipantMessage.AcsBatch

+ +

1 fields

+ +
+ +

Batch of ACS contracts previously requested by the target participant.

+ + +
+ +
+
+ contracts + repeated ActiveContractOld + +
+ +
The portion of the ACS in the batch expressed as nonempty list TODO(#24326) - Use a Ledger API representation instead. Required
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.ActiveContractOld

+ +

3 fields

+ +
+ +

TODO(#24610) – Remove; replaced by the new ActiveContract that uses LAPI active contract Schema definition for the exported ACS snapshot

+ + +
+ +
+
+ synchronizer_id + string + +
+ +
The ID of the synchronizer where the contract was assigned at the time of the export Required
+ +
+ +
+
+ contract + Contract + +
+ +
The contract and its associated metadata Required
+ +
+ +
+
+ reassignment_counter + int64 + +
+ +
The number of times the contract has been reassigned at the time of the export Required
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.Contract

+ +

5 fields

+ +
+ + +
+ +
+
+ contract_id + string + +
+ +
+ +
+
+ raw_contract_instance + bytes + +
+ +
+ +
+
+ metadata + Metadata + +
+ +
+ +
+
+ ledger_create_time + Timestamp + +
+ +
in microseconds of UTC time since Unix epoch
+ +
+ +
+
+ authentication_data + bytes + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.Contract.Metadata

+ +

4 fields

+ +
+ + +
+ +
+
+ non_maintainer_signatories + repeated string + +
+ +
+ +
+
+ non_signatory_stakeholders + repeated string + +
+ +
+ +
+
+ key + GlobalKey + +
+ +
optional: only set if contract has a key
+ +
+ +
+
+ maintainers + repeated string + +
+ +
optional; only set if contract has a key
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.participant.v30.Contract.GlobalKey

+ +

3 fields

+ +
+ + +
+ +
+
+ template_id + bytes + +
+ +
+ +
+
+ key + bytes + +
+ +
+ +
+
+ package_name + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.participant.protocol.v30.PartyReplicationSourceParticipantMessage.EndOfACS

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.participant.protocol.v30.PartyReplicationTargetParticipantMessage

+ +

2 fields

+ +
+ +

* Party replication protocol message sent by the target participant to the source participant.

+ + +
+ +
+
+ initialize + Initialize + +
+ +
+ +
+
+ send_acs_up_to + SendAcsUpTo + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.participant.protocol.v30.PartyReplicationTargetParticipantMessage.Initialize

+ +

1 fields

+ +
+ +

The Initialize instruction must be the first message to the source participant and must never be sent as the second or later message.

+ + +
+ +
+
+ initial_contract_ordinal_inclusive + uint32 + +
+ +
The ACS contract ordinal (0-based) to send as part of the first SendAcsUpTo instruction.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.participant.protocol.v30.PartyReplicationTargetParticipantMessage.SendAcsUpTo

+ +

1 fields

+ +
+ +

SendAcsUpTo instructs the source participant to send ordered ACS contracts up to a specified maximum ordinal. This instruction lets the target participant flow-control the rate of ACS ingestion.

+ + +
+ +
+
+ max_contract_ordinal_inclusive + uint32 + +
+ +
ACS contract ordinal (0-based) deterministic on the source participant. This serves as a watermark specifying up to which contract ordinal inclusively the source participant is expected to send ACS contracts. Required
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.participant.protocol.v30.SubmissionTrackingData

+ +

1 fields

+ +
+ + +
+ +
+
+ transaction + TransactionSubmissionTrackingData + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.participant.protocol.v30.TransactionSubmissionTrackingData

+ +

3 fields

+ +
+ + +
+ +
+
+ completion_info + CompletionInfo + +
+ +
+ +
+
+ rejection_cause + RejectionCause + +
+ +
+ +
+
+ physical_synchronizer_id + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.participant.protocol.v30.TransactionSubmissionTrackingData.RejectionCause

+ +

2 fields

+ +
+ + +
+ +
+
+ timeout + Empty + +
+ +
+ +
+
+ rejection_reason_template + GrpcRejectionReasonTemplate + +
+ +
+ +
+ + + +
diff --git a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-protocol-v30.mdx b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-protocol-v30.mdx index 81cc0ce..c9d1e36 100644 --- a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-protocol-v30.mdx +++ b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-protocol-v30.mdx @@ -1,1961 +1,7898 @@ --- title: "com.digitalasset.canton.protocol.v30" -description: "Descriptor-backed protobuf API history for package com.digitalasset.canton.protocol.v30." +description: "Package-level overview for com.digitalasset.canton.protocol.v30." --- -# Package `com.digitalasset.canton.protocol.v30` +

Back to overview

+ +
+ +

Protobuf Package

+ + +

com.digitalasset.canton.protocol.v30

+ + +

0 services, 0 endpoints, 120 messages, 9 enums

+ + +
+ + gRPC + +
+ + +
+ +
+
Files
+
19
+
+ +
+
Services
+
0
+
+ +
+
Endpoints
+
0
+
+ +
+
Messages
+
120
+
+ +
+
Enums
+
9
+
+ +
+ +
-[Back to Canton Protobuf History](../index) - -## Snapshot - -- Current files: `19` -- Current services: `0` -- Current endpoints: `0` -- Current messages: `120` -- Current enums: `9` -- Lifecycle endpoints tracked: `0` ## Source Files -| File | Services | Messages | Enums | Source | -| --- | --- | --- | --- | --- | -| community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/acs_commitments.proto | `0` | `1` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/acs_commitments.proto#L4) | -| community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/common.proto | `0` | `1` | `1` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/common.proto#L4) | -| community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/common_stable.proto | `0` | `4` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/common_stable.proto#L4) | -| community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/confirmation_response.proto | `0` | `5` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/confirmation_response.proto#L4) | -| community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/mediator.proto | `0` | `6` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/mediator.proto#L4) | -| community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/merkle.proto | `0` | `4` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/merkle.proto#L4) | -| community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/ordering_request.proto | `0` | `1` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/ordering_request.proto#L4) | -| community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_reassignment.proto | `0` | `11` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_reassignment.proto#L4) | -| community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto | `0` | `20` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto#L4) | -| community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/quorum.proto | `0` | `2` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/quorum.proto#L4) | -| community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/sequencing.proto | `0` | `11` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/sequencing.proto#L4) | -| community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/sequencing_parameters.proto | `0` | `1` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/sequencing_parameters.proto#L4) | -| community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/signed_content.proto | `0` | `1` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/signed_content.proto#L4) | -| community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/storage.proto | `0` | `1` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/storage.proto#L4) | -| community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/synchronization.proto | `0` | `3` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/synchronization.proto#L4) | -| community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/synchronizer_parameters.proto | `0` | `3` | `1` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/synchronizer_parameters.proto#L4) | -| community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto | `0` | `22` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto#L4) | -| community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/traffic_control_parameters.proto | `0` | `6` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/traffic_control_parameters.proto#L4) | -| community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/versioned_google_rpc_status.proto | `0` | `1` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/versioned_google_rpc_status.proto#L4) | - -## Type Reference - - -**Message `com.digitalasset.canton.protocol.v30.AcsCommitment`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/acs_commitments.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/acs_commitments.proto#L16) -- Fields: 6 - -A commitment to the active contract set (ACS) that is shared between two participants on a given synchronizer at a given time. - Given a commitment scheme to the ACS, the semantics are as follows: the sender declares that the shared ACS was - exactly the one committed to, at every commitment tick during the specified period and as determined by the period's - interval. The interval is assumed to be a round number of seconds. The ticks then start at the Java EPOCH time, and - are exactly `interval` apart. - All fields are mandatory. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| physical_synchronizer_id | `string` | optional | | -| sending_participant_uid | `string` | optional | | -| counter_participant_uid | `string` | optional | | -| from_exclusive | `int64` | optional | in microseconds of UTC time since Unix epoch | -| to_inclusive | `int64` | optional | in microseconds of UTC time since Unix epoch | -| commitment | `bytes` | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.AcsCommitmentsCatchUpConfig`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/synchronizer_parameters.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/synchronizer_parameters.proto#L13) -- Fields: 2 - -catch-up configuration parameters - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| catchup_interval_skip | `uint32` | optional | | -| nr_intervals_to_trigger_catchup | `uint32` | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.ActionDescription`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto#L156) -- Fields: 4 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| create | [`com.digitalasset.canton.protocol.v30.ActionDescription.CreateActionDescription`](#type-com-digitalasset-canton-protocol-v30-actiondescription-createactiondescription) | optional | | -| exercise | [`com.digitalasset.canton.protocol.v30.ActionDescription.ExerciseActionDescription`](#type-com-digitalasset-canton-protocol-v30-actiondescription-exerciseactiondescription) | optional | | -| fetch | [`com.digitalasset.canton.protocol.v30.ActionDescription.FetchActionDescription`](#type-com-digitalasset-canton-protocol-v30-actiondescription-fetchactiondescription) | optional | | -| lookup_by_key | [`com.digitalasset.canton.protocol.v30.ActionDescription.LookupByKeyActionDescription`](#type-com-digitalasset-canton-protocol-v30-actiondescription-lookupbykeyactiondescription) | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.ActionDescription.CreateActionDescription`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto#L166) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| contract_id | `string` | optional | | -| node_seed | `bytes` | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.ActionDescription.ExerciseActionDescription`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto#L171) -- Fields: 10 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| input_contract_id | `string` | optional | | -| choice | `string` | optional | | -| chosen_value | `bytes` | optional | | -| actors | `string` | repeated | | -| by_key | `bool` | optional | | -| node_seed | `bytes` | optional | | -| failed | `bool` | optional | | -| interface_id | `string` | optional | | -| template_id | `string` | optional | | -| package_preference | `string` | repeated | | - - -**Message `com.digitalasset.canton.protocol.v30.ActionDescription.FetchActionDescription`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto#L184) -- Fields: 5 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| input_contract_id | `string` | optional | | -| actors | `string` | repeated | | -| by_key | `bool` | optional | | -| template_id | `string` | optional | | -| interface_id | `string` | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.ActionDescription.LookupByKeyActionDescription`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto#L192) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| key | [`com.digitalasset.canton.protocol.v30.GlobalKey`](#type-com-digitalasset-canton-protocol-v30-globalkey) | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.ActiveContract`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_reassignment.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_reassignment.proto#L114) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| contract | `bytes` | optional | Encoded ContractInstance | -| reassignment_counter | `int64` | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.AggregationRule`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/common_stable.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/common_stable.proto#L31) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| eligible_members | `string` | repeated | Members who are allowed to send a request for the underlying aggregation.
Must contain SubmissionRequest.sender, otherwise the request is rejected.
Must have at least threshold many elements. | -| threshold | `int32` | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.AssignmentCommonData`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_reassignment.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_reassignment.proto#L58) -- Fields: 9 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| salt | [`com.digitalasset.canton.crypto.v30.Salt`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-salt) | optional | | -| source_physical_synchronizer_id | `string` | optional | | -| target_physical_synchronizer_id | `string` | optional | | -| unassignment_ts | `google.protobuf.Timestamp` | optional | | -| stakeholders | [`com.digitalasset.canton.protocol.v30.Stakeholders`](#type-com-digitalasset-canton-protocol-v30-stakeholders) | optional | stakeholders of the contract | -| uuid | `string` | optional | request uuid | -| target_mediator_group | `int32` | optional | | -| submitter_metadata | [`com.digitalasset.canton.protocol.v30.ReassignmentSubmitterMetadata`](#type-com-digitalasset-canton-protocol-v30-reassignmentsubmittermetadata) | optional | | -| reassigning_participant_uids | `string` | repeated | | - - -**Message `com.digitalasset.canton.protocol.v30.AssignmentMediatorMessage`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_reassignment.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_reassignment.proto#L44) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| tree | [`com.digitalasset.canton.protocol.v30.ReassignmentViewTree`](#type-com-digitalasset-canton-protocol-v30-reassignmentviewtree) | optional | | -| submitting_participant_signature | [`com.digitalasset.canton.crypto.v30.Signature`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-signature) | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.AssignmentView`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_reassignment.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_reassignment.proto#L106) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| salt | [`com.digitalasset.canton.crypto.v30.Salt`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-salt) | optional | | -| contracts | [`com.digitalasset.canton.protocol.v30.ActiveContract`](#type-com-digitalasset-canton-protocol-v30-activecontract) | repeated | | -| reassignment_id | [`com.digitalasset.canton.protocol.v30.ReassignmentId`](#type-com-digitalasset-canton-protocol-v30-reassignmentid) | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.Batch`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/sequencing.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/sequencing.proto#L88) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| envelopes | [`com.digitalasset.canton.protocol.v30.Envelope`](#type-com-digitalasset-canton-protocol-v30-envelope) | repeated | | - - -**Message `com.digitalasset.canton.protocol.v30.BlindableNode`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/merkle.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/merkle.proto#L19) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| unblinded | `bytes` | optional | | -| blinded_hash | `bytes` | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.CommonMetadata`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto#L116) -- Fields: 4 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| salt | [`com.digitalasset.canton.crypto.v30.Salt`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-salt) | optional | | -| physical_synchronizer_id | `string` | optional | | -| uuid | `string` | optional | | -| mediator_group | `int32` | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.CompressedBatch`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/sequencing.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/sequencing.proto#L94) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| algorithm | [`com.digitalasset.canton.protocol.v30.CompressedBatch.CompressionAlgorithm`](#type-com-digitalasset-canton-protocol-v30-compressedbatch-compressionalgorithm) | optional | | -| compressed_batch | `bytes` | optional | contains possibly compressed v30.Batch | - - -**Enum `com.digitalasset.canton.protocol.v30.CompressedBatch.CompressionAlgorithm`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/sequencing.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/sequencing.proto#L97) - -_No description._ - -| Name | Number | -| --- | --- | -| COMPRESSION_ALGORITHM_UNSPECIFIED | `0` | -| COMPRESSION_ALGORITHM_GZIP | `1` | - - -**Message `com.digitalasset.canton.protocol.v30.ConfirmationResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/confirmation_response.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/confirmation_response.proto#L28) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| local_verdict | [`com.digitalasset.canton.protocol.v30.LocalVerdict`](#type-com-digitalasset-canton-protocol-v30-localverdict) | optional | | -| confirming_parties | `string` | repeated | Empty iff the verdict is malformed. | -| view_position | [`com.digitalasset.canton.protocol.v30.ViewPosition`](#type-com-digitalasset-canton-protocol-v30-viewposition) | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.ConfirmationResponses`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/confirmation_response.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/confirmation_response.proto#L34) -- Fields: 5 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| request_id | `int64` | optional | in microseconds of UTC time since Unix epoch | -| root_hash | `bytes` | optional | required since DAML 3.0 | -| physical_synchronizer_id | `string` | optional | | -| sender | `string` | optional | | -| responses | [`com.digitalasset.canton.protocol.v30.ConfirmationResponse`](#type-com-digitalasset-canton-protocol-v30-confirmationresponse) | repeated | | - - -**Message `com.digitalasset.canton.protocol.v30.ConfirmationResultMessage`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/mediator.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/mediator.proto#L49) -- Fields: 5 - -This covers transactions and reassignments - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| physical_synchronizer_id | `string` | optional | | -| view_type | [`com.digitalasset.canton.protocol.v30.ViewType`](#type-com-digitalasset-canton-protocol-v30-viewtype) | optional | | -| request_id | `int64` | optional | | -| root_hash | `bytes` | optional | | -| verdict | [`com.digitalasset.canton.protocol.v30.Verdict`](#type-com-digitalasset-canton-protocol-v30-verdict) | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.ContractAuthenticationData`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/common.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/common.proto#L19) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| contract_salt | [`com.digitalasset.canton.crypto.v30.Salt`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-salt) | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.CreatedContract`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto#L105) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| contract | `bytes` | optional | Encoded ContractInstance | -| consumed_in_core | `bool` | optional | | -| rolled_back | `bool` | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.DecentralizedNamespaceDefinition`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto#L126) -- Fields: 3 - -a decentralized namespace definition that creates a new namespace supported by the - the original owners - authorization: the decentralized namespace definition with serial = 1 must be authorized by all the - owners of the namespace that form the decentralized namespace. - for definitions with serial > 1, we need the authorization of #threshold owners plus - all new owners - - any further transaction within the decentralized namespace other than decentralized namespace definitions needs - #threshold signatures of the owners - - UNIQUE(decentralized_namespace) - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| decentralized_namespace | `string` | optional | name of the decentralized namespace, computed from the hash of its initial owners | -| threshold | `int32` | optional | the threshold required for any subsequent update signing | -| owners | `string` | repeated | the namespaces of the owners | - - -**Message `com.digitalasset.canton.protocol.v30.DeduplicationPeriod`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto#L18) -- Fields: 2 - -Messages sent by a participant as part of the transaction protocol - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| duration | `google.protobuf.Duration` | optional | | -| offset | `int64` | optional | if specified, it must be a valid absolute offset (positive integer) or zero (ledger begin offset) | - - -**Message `com.digitalasset.canton.protocol.v30.DynamicSequencingParameters`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/sequencing_parameters.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/sequencing_parameters.proto#L10) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| payload | `bytes` | optional | Sequencing dynamic synchronizer parameters can only be interpreted by a sequencer implementation
and are opaque to the rest of the synchronizer. | - - -**Message `com.digitalasset.canton.protocol.v30.DynamicSequencingParametersState`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto#L314) -- Fields: 2 - -which sequencing dynamic parameters are supposed to be used on the given synchronizer; defaults are used when not set - authorization: whoever controls the synchronizer - UNIQUE(synchronizer_id) - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| synchronizer_id | `string` | optional | synchronizer affected by the new synchronizer parameters | -| sequencing_parameters | [`com.digitalasset.canton.protocol.v30.DynamicSequencingParameters`](#type-com-digitalasset-canton-protocol-v30-dynamicsequencingparameters) | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.DynamicSynchronizerParameters`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/synchronizer_parameters.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/synchronizer_parameters.proto#L46) -- Fields: 13 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| confirmation_response_timeout | `google.protobuf.Duration` | optional | | -| mediator_reaction_timeout | `google.protobuf.Duration` | optional | | -| assignment_exclusivity_timeout | `google.protobuf.Duration` | optional | | -| ledger_time_record_time_tolerance | `google.protobuf.Duration` | optional | | -| reconciliation_interval | `google.protobuf.Duration` | optional | | -| mediator_deduplication_timeout | `google.protobuf.Duration` | optional | | -| max_request_size | `uint32` | optional | | -| onboarding_restriction | [`com.digitalasset.canton.protocol.v30.OnboardingRestriction`](#type-com-digitalasset-canton-protocol-v30-onboardingrestriction) | optional | topology related validation parameters
permissioned synchronizer: if true, only participants which have been explicitly
put on the allow list can onboard to the synchronizer | -| participant_synchronizer_limits | [`com.digitalasset.canton.protocol.v30.ParticipantSynchronizerLimits`](#type-com-digitalasset-canton-protocol-v30-participantsynchronizerlimits) | optional | | -| sequencer_aggregate_submission_timeout | `google.protobuf.Duration` | optional | | -| traffic_control | [`com.digitalasset.canton.protocol.v30.TrafficControlParameters`](#type-com-digitalasset-canton-protocol-v30-trafficcontrolparameters) | optional | | -| acs_commitments_catchup | [`com.digitalasset.canton.protocol.v30.AcsCommitmentsCatchUpConfig`](#type-com-digitalasset-canton-protocol-v30-acscommitmentscatchupconfig) | optional | | -| preparation_time_record_time_tolerance | `google.protobuf.Duration` | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.EncryptedViewMessage`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto#L141) -- Fields: 7 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| view_tree | `bytes` | optional | | -| encryption_scheme | [`com.digitalasset.canton.crypto.v30.SymmetricKeyScheme`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-symmetrickeyscheme) | optional | The symmetric encryption scheme used to encrypt the view tree and the session key | -| submitting_participant_signature | [`com.digitalasset.canton.crypto.v30.Signature`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-signature) | optional | optional | -| view_hash | `bytes` | optional | | -| session_key_lookup | [`com.digitalasset.canton.crypto.v30.AsymmetricEncrypted`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-asymmetricencrypted) | repeated | | -| physical_synchronizer_id | `string` | optional | | -| view_type | [`com.digitalasset.canton.protocol.v30.ViewType`](#type-com-digitalasset-canton-protocol-v30-viewtype) | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.Enums`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto#L14) -- Fields: 0 - -_No description._ - - -**Enum `com.digitalasset.canton.protocol.v30.Enums.TopologyChangeOp`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto#L15) - -_No description._ - -| Name | Number | -| --- | --- | -| TOPOLOGY_CHANGE_OP_UNSPECIFIED | `0` | -| TOPOLOGY_CHANGE_OP_ADD_REPLACE | `1` | -| TOPOLOGY_CHANGE_OP_REMOVE | `2` | - - -**Enum `com.digitalasset.canton.protocol.v30.Enums.ParticipantPermission`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto#L27) - -enum indicating the participant permission level - Regardless of the ParticipantPermission level, all participants can submit a reassignment. - -| Name | Number | -| --- | --- | -| PARTICIPANT_PERMISSION_UNSPECIFIED | `0` | -| PARTICIPANT_PERMISSION_SUBMISSION | `1` | -| PARTICIPANT_PERMISSION_CONFIRMATION | `2` | -| PARTICIPANT_PERMISSION_OBSERVATION | `3` | - - -**Enum `com.digitalasset.canton.protocol.v30.Enums.TopologyMappingCode`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto#L40) - -_No description._ - -| Name | Number | -| --- | --- | -| TOPOLOGY_MAPPING_CODE_UNSPECIFIED | `0` | -| TOPOLOGY_MAPPING_CODE_NAMESPACE_DELEGATION | `1` | -| TOPOLOGY_MAPPING_CODE_DECENTRALIZED_NAMESPACE_DEFINITION | `3` | -| TOPOLOGY_MAPPING_CODE_OWNER_TO_KEY_MAPPING | `4` | -| TOPOLOGY_MAPPING_CODE_SYNCHRONIZER_TRUST_CERTIFICATE | `5` | -| TOPOLOGY_MAPPING_CODE_PARTICIPANT_PERMISSION | `6` | -| TOPOLOGY_MAPPING_CODE_PARTY_HOSTING_LIMITS | `7` | -| TOPOLOGY_MAPPING_CODE_VETTED_PACKAGES | `8` | -| TOPOLOGY_MAPPING_CODE_PARTY_TO_PARTICIPANT | `9` | -| TOPOLOGY_MAPPING_CODE_SYNCHRONIZER_PARAMETERS_STATE | `11` | -| TOPOLOGY_MAPPING_CODE_MEDIATOR_SYNCHRONIZER_STATE | `12` | -| TOPOLOGY_MAPPING_CODE_SEQUENCER_SYNCHRONIZER_STATE | `13` | -| TOPOLOGY_MAPPING_CODE_SEQUENCING_DYNAMIC_PARAMETERS_STATE | `17` | -| TOPOLOGY_MAPPING_CODE_PARTY_TO_KEY_MAPPING | `18` | -| TOPOLOGY_MAPPING_CODE_SYNCHRONIZER_MIGRATION_ANNOUNCEMENT | `19` | -| TOPOLOGY_MAPPING_CODE_SEQUENCER_CONNECTION_SUCCESSOR | `20` | - - -**Enum `com.digitalasset.canton.protocol.v30.Enums.ParticipantFeatureFlag`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto#L64) - -_No description._ - -| Name | Number | -| --- | --- | -| PARTICIPANT_FEATURE_FLAG_UNSPECIFIED | `0` | -| PARTICIPANT_FEATURE_FLAG_PV33_EXTERNAL_SIGNING_LOCAL_CONTRACT_IN_SUBVIEW | `1` | - - -**Message `com.digitalasset.canton.protocol.v30.Envelope`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/sequencing.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/sequencing.proto#L76) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| content | `bytes` | optional | Contains a v30.EnvelopeContent if signatures are empty and a v30.TypedSignedProtocolMessageContent otherwise | -| recipients | [`com.digitalasset.canton.protocol.v30.Recipients`](#type-com-digitalasset-canton-protocol-v30-recipients) | optional | | -| signatures | [`com.digitalasset.canton.crypto.v30.Signature`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-signature) | repeated | An honest sequencer rejects the request if it contains an envelope with an invalid signature.
As only honest sequencers verify signatures, clients should not trust a single sequencer node to verify signatures for them. | - - -**Message `com.digitalasset.canton.protocol.v30.EnvelopeContent`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/synchronization.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/synchronization.proto#L34) -- Fields: 6 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| informee_message | [`com.digitalasset.canton.protocol.v30.InformeeMessage`](#type-com-digitalasset-canton-protocol-v30-informeemessage) | optional | | -| encrypted_view_message | [`com.digitalasset.canton.protocol.v30.EncryptedViewMessage`](#type-com-digitalasset-canton-protocol-v30-encryptedviewmessage) | optional | | -| unassignment_mediator_message | [`com.digitalasset.canton.protocol.v30.UnassignmentMediatorMessage`](#type-com-digitalasset-canton-protocol-v30-unassignmentmediatormessage) | optional | | -| assignment_mediator_message | [`com.digitalasset.canton.protocol.v30.AssignmentMediatorMessage`](#type-com-digitalasset-canton-protocol-v30-assignmentmediatormessage) | optional | | -| root_hash_message | [`com.digitalasset.canton.protocol.v30.RootHashMessage`](#type-com-digitalasset-canton-protocol-v30-roothashmessage) | optional | | -| topology_transactions_broadcast | [`com.digitalasset.canton.protocol.v30.TopologyTransactionsBroadcast`](#type-com-digitalasset-canton-protocol-v30-topologytransactionsbroadcast) | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.ExternalAuthorization`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto#L238) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| authentications | [`com.digitalasset.canton.protocol.v30.ExternalPartyAuthorization`](#type-com-digitalasset-canton-protocol-v30-externalpartyauthorization) | repeated | | -| hashing_scheme_version | [`com.digitalasset.canton.protocol.v30.ExternalAuthorization.HashingSchemeVersion`](#type-com-digitalasset-canton-protocol-v30-externalauthorization-hashingschemeversion) | optional | | - - -**Enum `com.digitalasset.canton.protocol.v30.ExternalAuthorization.HashingSchemeVersion`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto#L242) - -The hashing scheme version used when building the hash - -| Name | Number | -| --- | --- | -| HASHING_SCHEME_VERSION_UNSPECIFIED | `0` | -| HASHING_SCHEME_VERSION_V2 | `2` | - - -**Message `com.digitalasset.canton.protocol.v30.ExternalPartyAuthorization`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto#L231) -- Fields: 2 - -Additional signatures provided by a single party - The purpose of these signatures is to allow parties to authorize transactions - by signing it with a private key not known to the network. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| party | `string` | optional | Submitting party | -| signatures | [`com.digitalasset.canton.crypto.v30.Signature`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-signature) | repeated | Signatures | - - -**Message `com.digitalasset.canton.protocol.v30.FullInformeeTree`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto#L99) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| tree | [`com.digitalasset.canton.protocol.v30.GenTransactionTree`](#type-com-digitalasset-canton-protocol-v30-gentransactiontree) | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.GenTransactionTree`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/merkle.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/merkle.proto#L12) -- Fields: 4 - -Messages related to Merkle trees (including GenTransactionTree) - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| submitter_metadata | [`com.digitalasset.canton.protocol.v30.BlindableNode`](#type-com-digitalasset-canton-protocol-v30-blindablenode) | optional | | -| common_metadata | [`com.digitalasset.canton.protocol.v30.BlindableNode`](#type-com-digitalasset-canton-protocol-v30-blindablenode) | optional | | -| participant_metadata | [`com.digitalasset.canton.protocol.v30.BlindableNode`](#type-com-digitalasset-canton-protocol-v30-blindablenode) | optional | | -| root_views | [`com.digitalasset.canton.protocol.v30.MerkleSeq`](#type-com-digitalasset-canton-protocol-v30-merkleseq) | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.GlobalKey`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/common_stable.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/common_stable.proto#L25) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| template_id | `bytes` | optional | | -| key | `bytes` | optional | | -| package_name | `string` | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.Informee`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto#L64) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| party | `string` | optional | | -| weight | `int32` | optional | optional: only set if party is confirming | - - -**Message `com.digitalasset.canton.protocol.v30.InformeeMessage`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto#L79) -- Fields: 2 - -InformeeMessage - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| full_informee_tree | [`com.digitalasset.canton.protocol.v30.FullInformeeTree`](#type-com-digitalasset-canton-protocol-v30-fullinformeetree) | optional | | -| submitting_participant_signature | [`com.digitalasset.canton.crypto.v30.Signature`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-signature) | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.InformeeTree`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/mediator.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/mediator.proto#L17) -- Fields: 1 - -Messages related to the transaction or reassignment protocol sent by a mediator - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| tree | [`com.digitalasset.canton.protocol.v30.GenTransactionTree`](#type-com-digitalasset-canton-protocol-v30-gentransactiontree) | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.InputContract`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto#L111) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| contract | `bytes` | optional | Encoded ContractInstance | -| consumed | `bool` | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.LightTransactionViewTree`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto#L86) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| tree | [`com.digitalasset.canton.protocol.v30.GenTransactionTree`](#type-com-digitalasset-canton-protocol-v30-gentransactiontree) | optional | | -| subview_hashes_and_keys | [`com.digitalasset.canton.protocol.v30.ViewHashAndKey`](#type-com-digitalasset-canton-protocol-v30-viewhashandkey) | repeated | | - - -**Message `com.digitalasset.canton.protocol.v30.LocalVerdict`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/confirmation_response.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/confirmation_response.proto#L13) -- Fields: 2 - -Definition of the ConfirmationResponse message which is shared between the transaction and reassignment protocol - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| code | [`com.digitalasset.canton.protocol.v30.LocalVerdict.VerdictCode`](#type-com-digitalasset-canton-protocol-v30-localverdict-verdictcode) | optional | | -| reason | `google.rpc.Status` | optional | ok iff code is approve | - - -**Enum `com.digitalasset.canton.protocol.v30.LocalVerdict.VerdictCode`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/confirmation_response.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/confirmation_response.proto#L19) - -_No description._ - -| Name | Number | -| --- | --- | -| VERDICT_CODE_UNSPECIFIED | `0` | -| VERDICT_CODE_LOCAL_APPROVE | `1` | -| VERDICT_CODE_LOCAL_REJECT | `2` | -| VERDICT_CODE_LOCAL_MALFORMED | `3` | -| VERDICT_CODE_LOCAL_ABSTAIN | `4` | - - -**Message `com.digitalasset.canton.protocol.v30.MediatorReject`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/mediator.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/mediator.proto#L33) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| reason | `google.rpc.Status` | optional | Must not be OK | -| is_malformed | `bool` | optional | True if the request has been recognized as malformed. | - - -**Message `com.digitalasset.canton.protocol.v30.MediatorSynchronizerState`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto#L324) -- Fields: 5 - -which mediators and mediator groups are active on the given synchronizer - authorization: whoever controls the synchronizer - UNIQUE(synchronizer_id, group) - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| synchronizer_id | `string` | optional | the synchronizer id of the mediator group | -| group | `uint32` | optional | the group-id used for sharding multiple mediator groups | -| threshold | `uint32` | optional | the signature threshold required to reach consensus among the mediators | -| active | `string` | repeated | the list of active mediators (uid) within the group | -| observers | `string` | repeated | the list of observing mediators (uid) within the group (read messages but don't respond) | - - -**Message `com.digitalasset.canton.protocol.v30.MerkleSeq`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/merkle.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/merkle.proto#L26) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| root_or_empty | [`com.digitalasset.canton.protocol.v30.BlindableNode`](#type-com-digitalasset-canton-protocol-v30-blindablenode) | optional | optional; absent if the sequence is empty | - - -**Message `com.digitalasset.canton.protocol.v30.MerkleSeqElement`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/merkle.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/merkle.proto#L32) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| first | [`com.digitalasset.canton.protocol.v30.BlindableNode`](#type-com-digitalasset-canton-protocol-v30-blindablenode) | optional | Fields mandatory for Branch | -| second | [`com.digitalasset.canton.protocol.v30.BlindableNode`](#type-com-digitalasset-canton-protocol-v30-blindablenode) | optional | | -| data | [`com.digitalasset.canton.protocol.v30.BlindableNode`](#type-com-digitalasset-canton-protocol-v30-blindablenode) | optional | Fields mandatory for Singleton | - - -**Message `com.digitalasset.canton.protocol.v30.MerkleSeqIndex`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/confirmation_response.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/confirmation_response.proto#L47) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| is_right | `bool` | repeated | | - - -**Message `com.digitalasset.canton.protocol.v30.MultiTransactionSignatures`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto#L449) -- Fields: 2 - -Used in SignedTopologyTransaction to bundle together multiple transaction hashes - Allows submitters to only sign a single combined hash to authorize multiple transactions at once - The combined hash is computed from the transaction hashes - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| transaction_hashes | `bytes` | repeated | List of topology transaction hashes.
Required | -| signatures | [`com.digitalasset.canton.crypto.v30.Signature`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-signature) | repeated | Signatures on the combined hash computed over the transaction_hashes
MUST contain at least one | - - -**Message `com.digitalasset.canton.protocol.v30.NamespaceDelegation`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto#L82) -- Fields: 6 - -[start NamespaceDelegation definition] - namespace delegation (equivalent to X509v3 CA root or intermediate CAs) - if is_root_delegation==false, the target key may sign all mappings requiring a signature - for the namespace except other NamespaceDelegation mappings. - authorization: a namespace delegation is either signed by the root key, or is signed by - a key for which there exists a series of properly authorized namespace delegations - that are ultimately signed by the root key - revocation: a revoked namespace delegation cannot be re-created. While the delegation itself is revoked, - valid transactions that have been signed using the authority of the delegation before its revocation stay valid. - UNIQUE(namespace, target_key) - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| namespace | `string` | optional | fingerprint of the root key defining the namespace | -| target_key | [`com.digitalasset.canton.crypto.v30.SigningPublicKey`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-signingpublickey) | optional | target key of getting full rights on the namespace (if target == namespace, it's a root CA) | -| is_root_delegation | `bool` | optional | flag indicating whether the given delegation is a root delegation or not
a root delegation is also allowed to issue other NamespaceDelegations. | -| can_sign_all_mappings | [`com.digitalasset.canton.protocol.v30.NamespaceDelegation.CanSignAllMappings`](#type-com-digitalasset-canton-protocol-v30-namespacedelegation-cansignallmappings) | optional | | -| can_sign_all_but_namespace_delegations | [`com.digitalasset.canton.protocol.v30.NamespaceDelegation.CanSignAllButNamespaceDelegations`](#type-com-digitalasset-canton-protocol-v30-namespacedelegation-cansignallbutnamespacedelegations) | optional | | -| can_sign_specific_mapings | [`com.digitalasset.canton.protocol.v30.NamespaceDelegation.CanSignSpecificMappings`](#type-com-digitalasset-canton-protocol-v30-namespacedelegation-cansignspecificmappings) | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.NamespaceDelegation.CanSignAllMappings`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto#L103) -- Fields: 0 - -[start-docs-entry: namespace delegation restrictions] - the key can sign all currently known mappings and all mappings that will be added in future releases - - -**Message `com.digitalasset.canton.protocol.v30.NamespaceDelegation.CanSignAllButNamespaceDelegations`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto#L106) -- Fields: 0 - -the key can sign all currently known mappings and all mappings that will be added in future releases, except for - namespace delegations - - -**Message `com.digitalasset.canton.protocol.v30.NamespaceDelegation.CanSignSpecificMappings`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto#L108) -- Fields: 1 - -the key can only sign the explicitly specified mappings - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| mappings | [`com.digitalasset.canton.protocol.v30.Enums.TopologyMappingCode`](#type-com-digitalasset-canton-protocol-v30-enums-topologymappingcode) | repeated | | - - -**Message `com.digitalasset.canton.protocol.v30.OrderingRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/ordering_request.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/ordering_request.proto#L10) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| sequencer_uid | `string` | optional | UID of the sequencer requesting ordering of the request | -| content | `bytes` | optional | Content of the request to be ordered | - - -**Message `com.digitalasset.canton.protocol.v30.OwnerToKeyMapping`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto#L140) -- Fields: 2 - -mapping a member (participant, mediator, sequencer) to a key - authorization: whoever controls the member uid - UNIQUE(member) - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| member | `string` | optional | the sequencing process member | -| public_keys | [`com.digitalasset.canton.crypto.v30.PublicKey`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-publickey) | repeated | the designated keys | - - -**Message `com.digitalasset.canton.protocol.v30.ParticipantMetadata`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto#L25) -- Fields: 4 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| salt | [`com.digitalasset.canton.crypto.v30.Salt`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-salt) | optional | | -| ledger_time | `int64` | optional | in microseconds of UTC time since Unix epoch | -| preparation_time | `int64` | optional | in microseconds of UTC time since Unix epoch | -| workflow_id | `string` | optional | optional | - - -**Message `com.digitalasset.canton.protocol.v30.ParticipantReject`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/mediator.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/mediator.proto#L23) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| reasons | [`com.digitalasset.canton.protocol.v30.RejectionReason`](#type-com-digitalasset-canton-protocol-v30-rejectionreason) | repeated | | - - -**Message `com.digitalasset.canton.protocol.v30.ParticipantSynchronizerLimits`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/synchronizer_parameters.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/synchronizer_parameters.proto#L19) -- Fields: 1 - -individual per participant limits - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| confirmation_requests_max_rate | `uint32` | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.ParticipantSynchronizerPermission`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto#L188) -- Fields: 5 - -the optional trust certificate of the synchronizer towards the participant - authorization: whoever controls the synchronizer id - UNIQUE(synchronizer_id,participant) - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| synchronizer_id | `string` | optional | | -| participant_uid | `string` | optional | | -| permission | [`com.digitalasset.canton.protocol.v30.Enums.ParticipantPermission`](#type-com-digitalasset-canton-protocol-v30-enums-participantpermission) | optional | the permission level of the participant on this synchronizer (usually submission) | -| limits | [`com.digitalasset.canton.protocol.v30.ParticipantSynchronizerLimits`](#type-com-digitalasset-canton-protocol-v30-participantsynchronizerlimits) | optional | optional individual limits for this participant | -| login_after | `int64` | optional | optional earliest time when participant can log in (again)
used to temporarily disable participants
In microseconds of UTC time since Unix epoch | - - -**Message `com.digitalasset.canton.protocol.v30.PartyHostingLimits`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto#L208) -- Fields: 2 - -the optional hosting limits for a party on a given synchronizer - these limits can be used to limit the number of participants that can host a given party - authorization: whoever controls the synchronizer id - UNIQUE(synchronizer_id,party) - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| synchronizer_id | `string` | optional | | -| party | `string` | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.PartyIndexAndWeight`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/quorum.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/quorum.proto#L19) -- Fields: 2 - -PartyIndexAndWeight - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| index | `int32` | optional | The index of the confirming party in the 'informees' field of the 'ViewCommonData' message. | -| weight | `int32` | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.PartyToKeyMapping`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto#L154) -- Fields: 3 - -[doc-entry-start: PartyToKeyMapping] - mapping a party to a key - authorization: whoever controls the party uid - UNIQUE(party) - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| party | `string` | optional | the party | -| threshold | `uint32` | optional | the authorization threshold | -| signing_keys | [`com.digitalasset.canton.crypto.v30.SigningPublicKey`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-signingpublickey) | repeated | the designated signing keys | - - -**Message `com.digitalasset.canton.protocol.v30.PartyToParticipant`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto#L263) -- Fields: 4 - -Mapping that maps a party to a participant - The PartyToParticipant mapping may also specify a list of signing keys for setting up an external party, in which - case the keys and the threshold take precedence over any PartyToKeyMapping for the same party. - Additionally, the list of signing keys may contain the public key of the party's namespace, which allows this - mapping to authorize itself without the need of a NamespaceDelegation root certificate (called self-signed). - authorization: the required authorization of the mapping is a union of the authorization for individual changes - - threshold change: party namespace - - adding a signing key: party namespace + all the new signing key - - removing a signing key: party namespace - - changing the signing key threshold: party namespace - - upgrading a participant permission or adding a new participant: namespaces from party and the participant namespace - - downgrading a participant permission or removing a participant: party namespace OR the participant namespace - - setting a participant's onboarding flag from false to true: party namespace - - setting a participant's onboarding flag from true to false: participant namespace - - the removal of a PTP must be authorized just by the party - revocation: Revoking a self-signed PTP does not prevent later re-creation of a PTP with the same partyId. - To prevent further usage of the key associated with the party's namespace, - revoke a NamespaceDelegation root certificate for that namespace. - UNIQUE(party) - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| party | `string` | optional | the party that is to be represented by the participants | -| threshold | `uint32` | optional | the signatory threshold required by the participants to be able to act on behalf of the party.
a mapping with threshold > 1 is considered a definition of a consortium party | -| participants | [`com.digitalasset.canton.protocol.v30.PartyToParticipant.HostingParticipant`](#type-com-digitalasset-canton-protocol-v30-partytoparticipant-hostingparticipant) | repeated | which participants will host the party.
if threshold > 1, must be Confirmation or Observation.
if all participants have Observation permission, the confirmation treshold is ignored, making the party
a purely observing party. | -| party_signing_keys | [`com.digitalasset.canton.crypto.v30.SigningKeysWithThreshold`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-signingkeyswiththreshold) | optional | Contains protocol signing keys for the party used to authorize externally signed Daml transactions,
along with a signing threshold.
The max number of keys is 20 | - - -**Message `com.digitalasset.canton.protocol.v30.PartyToParticipant.HostingParticipant`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto#L264) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| participant_uid | `string` | optional | the target participant that the party should be mapped to | -| permission | [`com.digitalasset.canton.protocol.v30.Enums.ParticipantPermission`](#type-com-digitalasset-canton-protocol-v30-enums-participantpermission) | optional | permission of the participant for this particular party (the actual
will be min of ParticipantSynchronizerPermission.ParticipantPermission and this setting) | -| onboarding | [`com.digitalasset.canton.protocol.v30.PartyToParticipant.HostingParticipant.Onboarding`](#type-com-digitalasset-canton-protocol-v30-partytoparticipant-hostingparticipant-onboarding) | optional | optional, present iff the party is being onboarded to the participant | - - -**Message `com.digitalasset.canton.protocol.v30.PartyToParticipant.HostingParticipant.Onboarding`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto#L265) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.protocol.v30.PossiblyIgnoredSequencedEvent`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/sequencing.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/sequencing.proto#L17) -- Fields: 5 - -Messages for sequencing - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| counter | `int64` | optional | | -| timestamp | `int64` | optional | in microseconds of UTC time since Unix epoch | -| trace_context | [`com.digitalasset.canton.v30.TraceContext`](com-digitalasset-canton-v30#type-com-digitalasset-canton-v30-tracecontext) | optional | | -| is_ignored | `bool` | optional | | -| underlying | `bytes` | optional | Serialized SignedContent[SequencedEvent]. Optional if is_ignored == true, required otherwise | - - -**Message `com.digitalasset.canton.protocol.v30.Quorum`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/quorum.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/quorum.proto#L10) -- Fields: 2 - -Quorum - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| party_index_and_weight | [`com.digitalasset.canton.protocol.v30.PartyIndexAndWeight`](#type-com-digitalasset-canton-protocol-v30-partyindexandweight) | repeated | The list of confirmers that constitute a quorum. Each confirmer is represented by their index in the
'informees' field of the 'ViewCommonData' message. | -| threshold | `int32` | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.ReassignmentId`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_reassignment.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_reassignment.proto#L16) -- Fields: 1 - -Messages sent by a participant as part of the reassignment protocol - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| id | `string` | optional | identifies the reassignment batch, built from a hash of source, target, contract ids, contract counters and timestamp. | - - -**Message `com.digitalasset.canton.protocol.v30.ReassignmentSubmitterMetadata`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_reassignment.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_reassignment.proto#L74) -- Fields: 6 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| submitter | `string` | optional | | -| submitting_participant_uid | `string` | optional | | -| command_id | `string` | optional | | -| submission_id | `string` | optional | optional | -| user_id | `string` | optional | | -| workflow_id | `string` | optional | optional | - - -**Message `com.digitalasset.canton.protocol.v30.ReassignmentViewTree`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_reassignment.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_reassignment.proto#L37) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| common_data | `bytes` | optional | | -| participant_data | [`com.digitalasset.canton.protocol.v30.BlindableNode`](#type-com-digitalasset-canton-protocol-v30-blindablenode) | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.Recipients`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/sequencing.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/sequencing.proto#L38) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| recipients_tree | [`com.digitalasset.canton.protocol.v30.RecipientsTree`](#type-com-digitalasset-canton-protocol-v30-recipientstree) | repeated | | - - -**Message `com.digitalasset.canton.protocol.v30.RecipientsTree`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/sequencing.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/sequencing.proto#L27) -- Fields: 2 - -Protobuf has a hard limit on the nesting depth of messages, so this message could potentially hit - the nesting depth limit. However this probably won't be an issue any time soon. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| recipients | `string` | repeated | Recipients of the request.
Must be non-empty.
A recipient is either a member (cf. MemberRecipient) or a set of members (cf. GroupRecipient such as AllMembersOfSynchronizer).
TARGET STATE: Each recipient must be authorized at the underlying synchronizer (cf. Recipient.isAuthorized).
CURRENT STATE: A recipient must be "known" to the sequencer.
A recipient in general remains "known" even after its topology transactions have been removed on the synchronizer. | -| children | [`com.digitalasset.canton.protocol.v30.RecipientsTree`](#type-com-digitalasset-canton-protocol-v30-recipientstree) | repeated | | - - -**Message `com.digitalasset.canton.protocol.v30.RejectionReason`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/mediator.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/mediator.proto#L27) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| parties | `string` | repeated | | -| reject | [`com.digitalasset.canton.protocol.v30.LocalVerdict`](#type-com-digitalasset-canton-protocol-v30-localverdict) | optional | | -| participant_id | `string` | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.RootHashMessage`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto#L36) -- Fields: 5 - -RootHashMessage - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| root_hash | `bytes` | optional | | -| physical_synchronizer_id | `string` | optional | | -| view_type | [`com.digitalasset.canton.protocol.v30.ViewType`](#type-com-digitalasset-canton-protocol-v30-viewtype) | optional | | -| submission_topology_time | `int64` | optional | in microseconds of UTC time since Unix epoch | -| payload | `bytes` | optional | optional | - - -**Message `com.digitalasset.canton.protocol.v30.SequencedEvent`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/sequencing.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/sequencing.proto#L107) -- Fields: 8 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| previous_timestamp | `int64` | optional | The timestamp of the previous event of the member's event sequence.
in microseconds of UTC time since Unix epoch
Optional, set to None if this is the first ever event of the member's event sequence. | -| timestamp | `int64` | optional | The timestamp of the event. Unique and monotonically increasing.
The same event has the same timestamp for all recipients.
in microseconds of UTC time since Unix epoch | -| physical_synchronizer_id | `string` | optional | The synchronizer on which the event has been sequenced. | -| message_id | `string` | optional | The message_id of the request.
Optional, but will be defined iff the request sender is the subscriber. | -| batch | [`com.digitalasset.canton.protocol.v30.CompressedBatch`](#type-com-digitalasset-canton-protocol-v30-compressedbatch) | optional | The payload of the event.
Optional, defined iff deliver_error_reason is undefined. | -| deliver_error_reason | `google.rpc.Status` | optional | Optional error, indicates why the underlying SubmissionRequest has been rejected. | -| topology_timestamp | `int64` | optional | Optional timestamp of the topology snapshot used for processing the underlying request
(e.g., validation, signing, resolving group addresses).
If undefined, timestamp is used instead. | -| traffic_receipt | [`com.digitalasset.canton.protocol.v30.TrafficReceipt`](#type-com-digitalasset-canton-protocol-v30-trafficreceipt) | optional | Traffic receipt with information about the traffic state after the cost for this event has been consumed
Optional - only set on deliver receipt sent back to the sender of the event when traffic control is enabled | - - -**Message `com.digitalasset.canton.protocol.v30.SequencerConnectionSuccessor`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto#L379) -- Fields: 3 - -a sequencer can announce its connections on the successor synchronizer - authorization: whoever controls the sequencer - UNIQUE(sequencer_id, synchronizer_id) - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| sequencer_id | `string` | optional | the sequencer id | -| synchronizer_id | `string` | optional | to synchronizer id | -| connection | [`com.digitalasset.canton.protocol.v30.SequencerConnectionSuccessor.SequencerConnection`](#type-com-digitalasset-canton-protocol-v30-sequencerconnectionsuccessor-sequencerconnection) | optional | the connection details with which members can connect to the sequencer on the successor synchronizer | - - -**Message `com.digitalasset.canton.protocol.v30.SequencerConnectionSuccessor.SequencerConnection`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto#L387) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| grpc | [`com.digitalasset.canton.protocol.v30.SequencerConnectionSuccessor.SequencerConnection.Grpc`](#type-com-digitalasset-canton-protocol-v30-sequencerconnectionsuccessor-sequencerconnection-grpc) | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.SequencerConnectionSuccessor.SequencerConnection.Grpc`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto#L392) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| endpoints | `string` | repeated | connection information to sequencer (http[s]://<host>:<port>")
all endpoints must agree on using HTTPS or HTTP | -| custom_trust_certificates | `bytes` | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.SequencerSynchronizerState`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto#L344) -- Fields: 4 - -which sequencers are active on the given synchronizer - authorization: whoever controls the synchronizer - UNIQUE(synchronizer_id) - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| synchronizer_id | `string` | optional | the synchronizer id of the sequencer group | -| threshold | `uint32` | optional | The system can tolerate up to min(threshold - 1, (activeWithSigningKey.size - 1)/3) malicious active sequencers,
where activeWithSigningKey is the set of sequencers from active that have an active OwnerToKeyMapping with a signing key.
In order to make the system resilient against f malicious active sequencers, you need to:
(1) configure threshold := f + 1,
(2) possibly add active sequencers such that f <= (activeWithSigningKey.size - 1)/3.
(3) possibly register signing keys for active sequencers, | -| active | `string` | repeated | the list of active sequencers
If a sequencer without an active signing key is added to this set, it has no effect on the topology state. | -| observers | `string` | repeated | the list of observing sequencers (uid) within the group (read messages but don't respond) | - - -**Message `com.digitalasset.canton.protocol.v30.SequencingSubmissionCost`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/sequencing.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/sequencing.proto#L50) -- Fields: 1 - -Messages used for synchronization between sequencer nodes - -Submission cost computed by the sender for a SubmissionRequest - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| cost | `int64` | optional | Computed cost | - - -**Message `com.digitalasset.canton.protocol.v30.SerializableContract`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/common_stable.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/common_stable.proto#L10) -- Fields: 5 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| contract_id | `string` | optional | | -| raw_contract_instance | `bytes` | optional | | -| metadata | [`com.digitalasset.canton.protocol.v30.SerializableContract.Metadata`](#type-com-digitalasset-canton-protocol-v30-serializablecontract-metadata) | optional | | -| ledger_create_time | `int64` | optional | in microseconds of UTC time since Unix epoch | -| authentication_data | `bytes` | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.SerializableContract.Metadata`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/common_stable.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/common_stable.proto#L11) -- Fields: 4 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| non_maintainer_signatories | `string` | repeated | | -| non_signatory_stakeholders | `string` | repeated | | -| key | [`com.digitalasset.canton.protocol.v30.GlobalKey`](#type-com-digitalasset-canton-protocol-v30-globalkey) | optional | optional: only set if contract has a key | -| maintainers | `string` | repeated | optional; only set if contract has a key | - - -**Message `com.digitalasset.canton.protocol.v30.ServiceAgreement`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/sequencing.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/sequencing.proto#L42) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| id | `string` | optional | A unique identifier of an agreement within a synchronizer, which must change when the legal text changes | -| legal_text | `string` | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.SetTrafficPurchasedMessage`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/traffic_control_parameters.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/traffic_control_parameters.proto#L99) -- Fields: 4 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| member | `string` | optional | Member to update the balance for | -| serial | `uint32` | optional | Serial number - must be unique and monotonically increasing for each new purchase update | -| total_traffic_purchased | `uint64` | optional | New total traffic purchased entry | -| physical_synchronizer_id | `string` | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.SignedContent`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/signed_content.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/signed_content.proto#L11) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| content | `bytes` | optional | | -| signatures | [`com.digitalasset.canton.crypto.v30.Signature`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-signature) | repeated | | -| timestamp_of_signing_key | `int64` | optional | in microseconds of UTC time since Unix epoch | - - -**Message `com.digitalasset.canton.protocol.v30.SignedProtocolMessage`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/synchronization.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/synchronization.proto#L27) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| signature | [`com.digitalasset.canton.crypto.v30.Signature`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-signature) | repeated | | -| typed_signed_protocol_message_content | `bytes` | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.SignedTopologyTransaction`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto#L458) -- Fields: 4 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| transaction | `bytes` | optional | serialized topology transaction (protobuf bytestring) | -| signatures | [`com.digitalasset.canton.crypto.v30.Signature`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-signature) | repeated | multiple signatures
Either this field OR the multi_transaction_signatures field MUST contain at least one signature | -| proposal | `bool` | optional | if true, this transaction is just a proposal. this means that every signature is valid,
but the signatures are insufficient to properly authorize the transaction.
proposals are distributed via the topology channel too. proposals will be pruned automatically
when the nodes are pruned
TODO(#14045) implement pruning | -| multi_transaction_signatures | [`com.digitalasset.canton.protocol.v30.MultiTransactionSignatures`](#type-com-digitalasset-canton-protocol-v30-multitransactionsignatures) | repeated | If set, the transaction may be authorized by signing a hash computed from multiple transaction hashes
This allows to effectively authorize multiple transactions with a single signature.
Each item MUST contain the hash of this transaction
Optional | - - -**Message `com.digitalasset.canton.protocol.v30.SignedTopologyTransactions`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto#L481) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| signed_transaction | `bytes` | repeated | serialized signed topology transaction (protobuf bytestring) | - - -**Message `com.digitalasset.canton.protocol.v30.Stakeholders`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/common_stable.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/common_stable.proto#L41) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| all | `string` | repeated | all stakeholders of the contract | -| signatories | `string` | repeated | signatories of the contract | - - -**Message `com.digitalasset.canton.protocol.v30.StaticSynchronizerParameters`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/sequencing.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/sequencing.proto#L56) -- Fields: 10 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| required_signing_specs | [`com.digitalasset.canton.crypto.v30.RequiredSigningSpecs`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-requiredsigningspecs) | optional | | -| required_encryption_specs | [`com.digitalasset.canton.crypto.v30.RequiredEncryptionSpecs`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-requiredencryptionspecs) | optional | | -| required_symmetric_key_schemes | [`com.digitalasset.canton.crypto.v30.SymmetricKeyScheme`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-symmetrickeyscheme) | repeated | | -| required_hash_algorithms | [`com.digitalasset.canton.crypto.v30.HashAlgorithm`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-hashalgorithm) | repeated | | -| required_crypto_key_formats | [`com.digitalasset.canton.crypto.v30.CryptoKeyFormat`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-cryptokeyformat) | repeated | | -| required_signature_formats | [`com.digitalasset.canton.crypto.v30.SignatureFormat`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-signatureformat) | repeated | | -| protocol_version | `int32` | optional | | -| serial | `int32` | optional | Serial of the synchronizer. Must be non-negative. | -| enable_transparency_checks | `bool` | optional | Flag to enable transparency checks. | -| topology_change_delay | `google.protobuf.Duration` | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.StoredParties`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/storage.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/storage.proto#L9) -- Fields: 1 - -Enables storing parties in the database as a blob - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| parties | `string` | repeated | | - - -**Message `com.digitalasset.canton.protocol.v30.SubmissionRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/sequencing.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/sequencing.proto#L147) -- Fields: 7 - -Messages used for synchronization between sequencer nodes - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| sender | `string` | optional | Sender of the request.
This request must be wrapped in a SignedContent and
the signature therein must validate under one of the sender's public keys.
The request metadata must contain a valid authentication token belonging to the sender.
(Details in SequencerAuthenticationServerInterceptor.)
TARGET STATE: The sender must be authorized (cf. TopologySnapshot.isMemberKnown)
CURRENT STATE: The sender authorization check might have a few gaps (e.g., see MemberAuthenticationService.isActive)
and/or may use the wrong snapshot. | -| message_id | `string` | optional | Will be included in the receipt of the request.
The sender should not reuse a message_id until max_sequencing_time,
because otherwise it will be unable to correlate receipts with requests. | -| batch | [`com.digitalasset.canton.protocol.v30.CompressedBatch`](#type-com-digitalasset-canton-protocol-v30-compressedbatch) | optional | The payload, mandatory
At most one recipient of an envelope may be (a) a mediator, (b) a mediator group, or (c) all synchronizer members. | -| max_sequencing_time | `int64` | optional | Maximum sequencing time for the request.
If the request can't be sequenced until the specified time, the sequencer will reject it.
After max_sequencing_time, no event corresponding to the request will be emitted.
in microseconds of UTC time since Unix epoch | -| topology_timestamp | `int64` | optional | Optional timestamp (in microseconds of UTC time since Unix epoch) of topology snapshot to be used for
processing the request (e.g., validation, signing, resolving group addresses).
If defined, it must meet the following conditions:
(1) it must be before or at the sequencing timestamp,
(2) it must be by at most DynamicSynchronizerParameters.sequencerTopologyTimestampTolerance before the sequencing timestamp,
where the DynamicSynchronizerParameters are taken from the topology state at topology_timestamp,
(3) the sequencer must have signing keys registered in the topology snapshot.
If defined and invalid, the request is rejected.
If undefined or invalid, the topology snapshot at sequencing time will be used instead. | -| aggregation_rule | [`com.digitalasset.canton.protocol.v30.AggregationRule`](#type-com-digitalasset-canton-protocol-v30-aggregationrule) | optional | Optional rule used to aggregate requests. | -| submission_cost | [`com.digitalasset.canton.protocol.v30.SequencingSubmissionCost`](#type-com-digitalasset-canton-protocol-v30-sequencingsubmissioncost) | optional | Optional submission cost computed by the sender. Must be provided if traffic control is enabled on the receiving synchronizer. | - - -**Message `com.digitalasset.canton.protocol.v30.SubmitterMetadata`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto#L127) -- Fields: 9 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| salt | [`com.digitalasset.canton.crypto.v30.Salt`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-salt) | optional | | -| act_as | `string` | repeated | | -| user_id | `string` | optional | | -| command_id | `string` | optional | | -| submitting_participant_uid | `string` | optional | | -| submission_id | `string` | optional | optional; absent if not specified by submitter | -| dedup_period | [`com.digitalasset.canton.protocol.v30.DeduplicationPeriod`](#type-com-digitalasset-canton-protocol-v30-deduplicationperiod) | optional | | -| max_sequencing_time | `int64` | optional | in microseconds of UTC time since Unix epoch | -| external_authorization | [`com.digitalasset.canton.protocol.v30.ExternalAuthorization`](#type-com-digitalasset-canton-protocol-v30-externalauthorization) | optional | optional | - - -**Message `com.digitalasset.canton.protocol.v30.SynchronizerParametersState`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto#L304) -- Fields: 2 - -which dynamic synchronizer parameters are supposed to be used on the given synchronizer - authorization: whoever controls the synchronizer - UNIQUE(synchronizer_id) - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| synchronizer_id | `string` | optional | synchronizer affected by the new synchronizer parameters | -| synchronizer_parameters | [`com.digitalasset.canton.protocol.v30.DynamicSynchronizerParameters`](#type-com-digitalasset-canton-protocol-v30-dynamicsynchronizerparameters) | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.SynchronizerTrustCertificate`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto#L170) -- Fields: 3 - -the trust certificate issued by the participant confirming that the participant - wishes to be present on the given synchronizer - authorization: whoever controls the participant uid - UNIQUE(participant,synchronizer_id) - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| participant_uid | `string` | optional | the uid of the participant | -| synchronizer_id | `string` | optional | the uid of the synchronizer that the participant trusts | -| feature_flags | [`com.digitalasset.canton.protocol.v30.Enums.ParticipantFeatureFlag`](#type-com-digitalasset-canton-protocol-v30-enums-participantfeatureflag) | repeated | Feature flags that this node declares to support on this synchronizer | - - -**Message `com.digitalasset.canton.protocol.v30.SynchronizerUpgradeAnnouncement`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto#L369) -- Fields: 2 - -indicates the beginning of a synchronizer upgrade and effectuates a topology freeze, - after which only synchronizer upgrade specific topology mappings are accepted. - removing this mapping unfreezes the topology state again. - authorization: whoever controls the synchronizer - UNIQUE(successor_physical_synchronizer_id.logical) - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| successor_physical_synchronizer_id | `string` | optional | the physical synchronizer id of the successor synchronizer | -| upgrade_time | `google.protobuf.Timestamp` | optional | when the upgrade happens | - - -**Message `com.digitalasset.canton.protocol.v30.TopologyMapping`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto#L402) -- Fields: 15 - -[docs-entry-start: topology mapping] - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| namespace_delegation | [`com.digitalasset.canton.protocol.v30.NamespaceDelegation`](#type-com-digitalasset-canton-protocol-v30-namespacedelegation) | optional | | -| decentralized_namespace_definition | [`com.digitalasset.canton.protocol.v30.DecentralizedNamespaceDefinition`](#type-com-digitalasset-canton-protocol-v30-decentralizednamespacedefinition) | optional | | -| owner_to_key_mapping | [`com.digitalasset.canton.protocol.v30.OwnerToKeyMapping`](#type-com-digitalasset-canton-protocol-v30-ownertokeymapping) | optional | | -| synchronizer_trust_certificate | [`com.digitalasset.canton.protocol.v30.SynchronizerTrustCertificate`](#type-com-digitalasset-canton-protocol-v30-synchronizertrustcertificate) | optional | | -| participant_permission | [`com.digitalasset.canton.protocol.v30.ParticipantSynchronizerPermission`](#type-com-digitalasset-canton-protocol-v30-participantsynchronizerpermission) | optional | | -| party_hosting_limits | [`com.digitalasset.canton.protocol.v30.PartyHostingLimits`](#type-com-digitalasset-canton-protocol-v30-partyhostinglimits) | optional | | -| vetted_packages | [`com.digitalasset.canton.protocol.v30.VettedPackages`](#type-com-digitalasset-canton-protocol-v30-vettedpackages) | optional | | -| party_to_participant | [`com.digitalasset.canton.protocol.v30.PartyToParticipant`](#type-com-digitalasset-canton-protocol-v30-partytoparticipant) | optional | | -| synchronizer_parameters_state | [`com.digitalasset.canton.protocol.v30.SynchronizerParametersState`](#type-com-digitalasset-canton-protocol-v30-synchronizerparametersstate) | optional | | -| mediator_synchronizer_state | [`com.digitalasset.canton.protocol.v30.MediatorSynchronizerState`](#type-com-digitalasset-canton-protocol-v30-mediatorsynchronizerstate) | optional | | -| sequencer_synchronizer_state | [`com.digitalasset.canton.protocol.v30.SequencerSynchronizerState`](#type-com-digitalasset-canton-protocol-v30-sequencersynchronizerstate) | optional | | -| sequencing_dynamic_parameters_state | [`com.digitalasset.canton.protocol.v30.DynamicSequencingParametersState`](#type-com-digitalasset-canton-protocol-v30-dynamicsequencingparametersstate) | optional | | -| party_to_key_mapping | [`com.digitalasset.canton.protocol.v30.PartyToKeyMapping`](#type-com-digitalasset-canton-protocol-v30-partytokeymapping) | optional | | -| synchronizer_upgrade_announcement | [`com.digitalasset.canton.protocol.v30.SynchronizerUpgradeAnnouncement`](#type-com-digitalasset-canton-protocol-v30-synchronizerupgradeannouncement) | optional | | -| sequencer_connection_successor | [`com.digitalasset.canton.protocol.v30.SequencerConnectionSuccessor`](#type-com-digitalasset-canton-protocol-v30-sequencerconnectionsuccessor) | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.TopologyTransaction`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto#L432) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| operation | [`com.digitalasset.canton.protocol.v30.Enums.TopologyChangeOp`](#type-com-digitalasset-canton-protocol-v30-enums-topologychangeop) | optional | | -| serial | `uint32` | optional | Serial identifier of this transaction used to prevent replay attacks.
A topology transaction is replacing the existing transaction with serial - 1
that has the same unique key. | -| mapping | [`com.digitalasset.canton.protocol.v30.TopologyMapping`](#type-com-digitalasset-canton-protocol-v30-topologymapping) | optional | the element of this topology transaction | - - -**Message `com.digitalasset.canton.protocol.v30.TopologyTransactionsBroadcast`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto#L494) -- Fields: 2 - -* Accepted topology transaction - - A member sends topology transactions to the topology transaction broadcast address. - The transactions are validated by all members individually against their respective synchronizer store, - including the member the submitted the broadcast. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| physical_synchronizer_id | `string` | optional | | -| signed_transactions | [`com.digitalasset.canton.protocol.v30.SignedTopologyTransactions`](#type-com-digitalasset-canton-protocol-v30-signedtopologytransactions) | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.TrafficConsumed`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/traffic_control_parameters.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/traffic_control_parameters.proto#L56) -- Fields: 5 - -Message representing traffic consumed by a member at a given point in time - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| member | `string` | optional | Member consuming the traffic | -| extra_traffic_consumed | `uint64` | optional | Total extra traffic consumed | -| base_traffic_remainder | `uint64` | optional | Remaining free base traffic | -| last_consumed_cost | `uint64` | optional | Cost deducted at `timestamp`, only present when traffic was consumed at `timestamp`, otherwise is set to 0 | -| sequencing_timestamp | `int64` | optional | Timestamp at which this state is valid - this timestamp is used to compute the base traffic remainder above | - - -**Message `com.digitalasset.canton.protocol.v30.TrafficControlParameters`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/traffic_control_parameters.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/traffic_control_parameters.proto#L11) -- Fields: 7 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| max_base_traffic_amount | `uint64` | optional | [doc-entry-start: TrafficControlParameters]
In bytes, the maximum amount of base traffic that can be accumulated | -| max_base_traffic_accumulation_duration | `google.protobuf.Duration` | optional | Maximum duration over which the base rate can be accumulated
Consequently, base_traffic_rate = max_base_traffic_amount / max_base_traffic_accumulation_duration | -| read_vs_write_scaling_factor | `uint32` | optional | Read scaling factor to compute the event cost. In parts per 10 000. | -| set_balance_request_submission_window_size | `google.protobuf.Duration` | optional | Window size used to compute the max sequencing time of a submission request
This impacts how quickly a submission is expected to be accepted before a retry should be attempted by the caller
Default is 5 minutes | -| enforce_rate_limiting | `bool` | optional | If true, submission requests without enough traffic credit will not be delivered | -| base_event_cost | `uint64` | optional | In bytes, base event cost added to all sequenced events.
Optional | -| free_confirmation_responses | `bool` | optional | Whether to charge for confirmation responses
Default: false | - - -**Message `com.digitalasset.canton.protocol.v30.TrafficPurchased`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/traffic_control_parameters.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/traffic_control_parameters.proto#L71) -- Fields: 4 - -Message representing a traffic purchase made on behalf of a member - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| member | `string` | optional | Member receiving the traffic | -| serial | `uint32` | optional | Serial of the update | -| extra_traffic_purchased | `uint64` | optional | New total extra traffic purchased | -| sequencing_timestamp | `int64` | optional | Timestamp at which this state is valid | - - -**Message `com.digitalasset.canton.protocol.v30.TrafficReceipt`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/traffic_control_parameters.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/traffic_control_parameters.proto#L45) -- Fields: 3 - -Message representing a traffic receipt included in SequencedEvent receipts to update sender about - the traffic consumed state after sequencing of the event - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| consumed_cost | `uint64` | optional | Cost effectively consumed by this specific event | -| extra_traffic_consumed | `uint64` | optional | Total amount of extra traffic consumed | -| base_traffic_remainder | `uint64` | optional | Remaining free base traffic | - - -**Message `com.digitalasset.canton.protocol.v30.TrafficState`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/traffic_control_parameters.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/traffic_control_parameters.proto#L84) -- Fields: 6 - -Traffic state of a member at a given timestamp - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| extra_traffic_purchased | `int64` | optional | Total amount of extra traffic purchased | -| extra_traffic_consumed | `int64` | optional | Total amount of extra traffic consumed | -| base_traffic_remainder | `int64` | optional | Amount of base traffic remaining | -| last_consumed_cost | `uint64` | optional | Cost deducted at `timestamp`, only present when traffic was consumed at `timestamp`, otherwise is set to 0 | -| timestamp | `int64` | optional | Timestamp at which the state is valid | -| serial | `uint32` | optional | Optional serial of the balance update that updated the extra traffic limit | - - -**Message `com.digitalasset.canton.protocol.v30.TypedSignedProtocolMessageContent`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/synchronization.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/synchronization.proto#L16) -- Fields: 4 - -Messages depending on both participant_transaction.proto and participant_reassignment.proto. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| confirmation_responses | `bytes` | optional | | -| confirmation_result | `bytes` | optional | | -| acs_commitment | `bytes` | optional | | -| set_traffic_purchased | `bytes` | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.UnassignmentCommonData`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_reassignment.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_reassignment.proto#L23) -- Fields: 7 - -Messages sent by a participant as part of the reassignment protocol - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| salt | [`com.digitalasset.canton.crypto.v30.Salt`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-salt) | optional | | -| source_physical_synchronizer_id | `string` | optional | | -| stakeholders | [`com.digitalasset.canton.protocol.v30.Stakeholders`](#type-com-digitalasset-canton-protocol-v30-stakeholders) | optional | | -| reassigning_participant_uids | `string` | repeated | | -| uuid | `string` | optional | | -| source_mediator_group | `int32` | optional | | -| submitter_metadata | [`com.digitalasset.canton.protocol.v30.ReassignmentSubmitterMetadata`](#type-com-digitalasset-canton-protocol-v30-reassignmentsubmittermetadata) | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.UnassignmentData`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_reassignment.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_reassignment.proto#L94) -- Fields: 7 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| submitter_metadata | [`com.digitalasset.canton.protocol.v30.ReassignmentSubmitterMetadata`](#type-com-digitalasset-canton-protocol-v30-reassignmentsubmittermetadata) | optional | | -| contracts | [`com.digitalasset.canton.protocol.v30.ActiveContract`](#type-com-digitalasset-canton-protocol-v30-activecontract) | repeated | | -| reassigning_participant_uids | `string` | repeated | | -| source_physical_synchronizer_id | `string` | optional | | -| target_physical_synchronizer_id | `string` | optional | | -| target_timestamp | `google.protobuf.Timestamp` | optional | | -| unassignment_ts | `google.protobuf.Timestamp` | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.UnassignmentMediatorMessage`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_reassignment.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_reassignment.proto#L51) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| tree | [`com.digitalasset.canton.protocol.v30.ReassignmentViewTree`](#type-com-digitalasset-canton-protocol-v30-reassignmentviewtree) | optional | | -| submitting_participant_signature | [`com.digitalasset.canton.crypto.v30.Signature`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-signature) | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.UnassignmentView`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_reassignment.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_reassignment.proto#L85) -- Fields: 4 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| salt | [`com.digitalasset.canton.crypto.v30.Salt`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-salt) | optional | | -| target_physical_synchronizer_id | `string` | optional | | -| target_timestamp | `int64` | optional | | -| contracts | [`com.digitalasset.canton.protocol.v30.ActiveContract`](#type-com-digitalasset-canton-protocol-v30-activecontract) | repeated | | - - -**Message `com.digitalasset.canton.protocol.v30.Verdict`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/mediator.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/mediator.proto#L38) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| approve | `google.protobuf.Empty` | optional | | -| participant_reject | [`com.digitalasset.canton.protocol.v30.ParticipantReject`](#type-com-digitalasset-canton-protocol-v30-participantreject) | optional | | -| mediator_reject | [`com.digitalasset.canton.protocol.v30.MediatorReject`](#type-com-digitalasset-canton-protocol-v30-mediatorreject) | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.VersionedStatus`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/versioned_google_rpc_status.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/versioned_google_rpc_status.proto#L12) -- Fields: 1 - -DA's wrapper around `google.rpc.Status` for the proper versioning and code-gen - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| status | `google.rpc.Status` | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.VettedPackages`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto#L217) -- Fields: 3 - -list of packages supported by this participant - authorization: whoever controls the participant uid - UNIQUE(participant) - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| participant_uid | `string` | optional | the participant vetting the packages | -| package_ids | `string` | repeated | DEPRECATED: no longer used, but kept for backwards compatibility.
the hashes of the vetted packages.
package hashes may only be listed in one of the two fields: package_ids or packages.
a package listed in package_ids is equivalent to a package listed in packages with unbounded validity. | -| packages | [`com.digitalasset.canton.protocol.v30.VettedPackages.VettedPackage`](#type-com-digitalasset-canton-protocol-v30-vettedpackages-vettedpackage) | repeated | the hashes of vetted packages with a validity period.
only one entry per package_id is permitted. | - - -**Message `com.digitalasset.canton.protocol.v30.VettedPackages.VettedPackage`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto#L218) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| package_id | `string` | optional | the hash of the vetted package | -| valid_from_inclusive | `google.protobuf.Timestamp` | optional | optional earliest ledger effective time (inclusive) as of which the package is considered valid.
must be less than or equal to valid_until if both are present. | -| valid_until_exclusive | `google.protobuf.Timestamp` | optional | optional latest ledger effective time (exclusive) until which the package is considered valid.
must be greater than or equal to valid_from if both are present. | - - -**Message `com.digitalasset.canton.protocol.v30.ViewCommonData`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto#L56) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| salt | [`com.digitalasset.canton.crypto.v30.Salt`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-salt) | optional | | -| informees | `string` | repeated | | -| quorums | [`com.digitalasset.canton.protocol.v30.Quorum`](#type-com-digitalasset-canton-protocol-v30-quorum) | repeated | | - - -**Message `com.digitalasset.canton.protocol.v30.ViewHashAndKey`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto#L93) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| view_hash | `bytes` | optional | | -| view_encryption_key_randomness | `bytes` | optional | The randomness used to derive the encryption key for the view | - - -**Message `com.digitalasset.canton.protocol.v30.ViewNode`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto#L48) -- Fields: 3 - -Messages sent by a participant as part of the transaction protocol - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| view_common_data | [`com.digitalasset.canton.protocol.v30.BlindableNode`](#type-com-digitalasset-canton-protocol-v30-blindablenode) | optional | | -| view_participant_data | [`com.digitalasset.canton.protocol.v30.BlindableNode`](#type-com-digitalasset-canton-protocol-v30-blindablenode) | optional | | -| subviews | [`com.digitalasset.canton.protocol.v30.MerkleSeq`](#type-com-digitalasset-canton-protocol-v30-merkleseq) | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.ViewParticipantData`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto#L199) -- Fields: 7 - -Messages sent by a participant as part of the transaction protocol - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| salt | [`com.digitalasset.canton.crypto.v30.Salt`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-salt) | optional | | -| core_inputs | [`com.digitalasset.canton.protocol.v30.InputContract`](#type-com-digitalasset-canton-protocol-v30-inputcontract) | repeated | | -| created_core | [`com.digitalasset.canton.protocol.v30.CreatedContract`](#type-com-digitalasset-canton-protocol-v30-createdcontract) | repeated | | -| created_in_subview_archived_in_core | `string` | repeated | ids of contracts created in a subview and archived in the core | -| resolved_keys | [`com.digitalasset.canton.protocol.v30.ViewParticipantData.ResolvedKey`](#type-com-digitalasset-canton-protocol-v30-viewparticipantdata-resolvedkey) | repeated | | -| action_description | [`com.digitalasset.canton.protocol.v30.ActionDescription`](#type-com-digitalasset-canton-protocol-v30-actiondescription) | optional | | -| rollback_context | [`com.digitalasset.canton.protocol.v30.ViewParticipantData.RollbackContext`](#type-com-digitalasset-canton-protocol-v30-viewparticipantdata-rollbackcontext) | optional | optional; defaults to the empty RollbackContext if omitted. | - - -**Message `com.digitalasset.canton.protocol.v30.ViewParticipantData.FreeKey`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto#L209) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| maintainers | `string` | repeated | | - - -**Message `com.digitalasset.canton.protocol.v30.ViewParticipantData.ResolvedKey`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto#L213) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| key | [`com.digitalasset.canton.protocol.v30.GlobalKey`](#type-com-digitalasset-canton-protocol-v30-globalkey) | optional | | -| contract_id | `string` | optional | the key resolves to a contract | -| free | [`com.digitalasset.canton.protocol.v30.ViewParticipantData.FreeKey`](#type-com-digitalasset-canton-protocol-v30-viewparticipantdata-freekey) | optional | the key is free and these are the maintainers | - - -**Message `com.digitalasset.canton.protocol.v30.ViewParticipantData.RollbackContext`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto#L221) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| rollback_scope | `int32` | repeated | | -| next_child | `int32` | optional | | - - -**Message `com.digitalasset.canton.protocol.v30.ViewParticipantMessage`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto#L73) -- Fields: 0 - -EncryptedViewMessage - - -**Message `com.digitalasset.canton.protocol.v30.ViewPosition`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/confirmation_response.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/confirmation_response.proto#L43) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| position | [`com.digitalasset.canton.protocol.v30.MerkleSeqIndex`](#type-com-digitalasset-canton-protocol-v30-merkleseqindex) | repeated | | - - -**Enum `com.digitalasset.canton.protocol.v30.OnboardingRestriction`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/synchronizer_parameters.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/synchronizer_parameters.proto#L30) - -Controls how participants can join the synchronizer - Note that currently, only transitions from restricted to unrestricted are supported, but not - the other way around. - -| Name | Number | -| --- | --- | -| ONBOARDING_RESTRICTION_UNSPECIFIED | `0` | -| ONBOARDING_RESTRICTION_UNRESTRICTED_OPEN | `1` | -| ONBOARDING_RESTRICTION_UNRESTRICTED_LOCKED | `2` | -| ONBOARDING_RESTRICTION_RESTRICTED_OPEN | `3` | -| ONBOARDING_RESTRICTION_RESTRICTED_LOCKED | `4` | - - -**Enum `com.digitalasset.canton.protocol.v30.ViewType`** -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/common.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/common.proto#L12) -Definitions shared by at least 2 out of mediator.proto, participant_transaction.proto and participant_reassignment.proto -| Name | Number | -| --- | --- | -| VIEW_TYPE_UNSPECIFIED | `0` | -| VIEW_TYPE_TRANSACTION | `1` | -| VIEW_TYPE_UNASSIGNMENT | `2` | -| VIEW_TYPE_ASSIGNMENT | `3` | +
+ + +
+ +
+

community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/acs_commitments.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
1
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/acs_commitments.proto
+
+ +
+ + +
+ + + +
+ +
+

community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/common.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
1
+
+ +
+
Enums
+
1
+
+ +
+
Source
+
community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/common.proto
+
+ +
+ + +
+ + + +
+ +
+

community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/common_stable.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
4
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/common_stable.proto
+
+ +
+ + +
+ + + +
+ +
+

community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/confirmation_response.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
5
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/confirmation_response.proto
+
+ +
+ + +
+ + + +
+ +
+

community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/mediator.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
6
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/mediator.proto
+
+ +
+ + +
+ + + +
+ +
+

community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/merkle.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
4
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/merkle.proto
+
+ +
+ + +
+ + + +
+ +
+

community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/ordering_request.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
1
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/ordering_request.proto
+
+ +
+ + +
+ + + +
+ +
+

community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_reassignment.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
11
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_reassignment.proto
+
+ +
+ + +
+ + + +
+ +
+

community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
20
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/participant_transaction.proto
+
+ +
+ + +
+ + + +
+ +
+

community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/quorum.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
2
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/quorum.proto
+
+ +
+ + +
+ + + +
+ +
+

community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/sequencing.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
11
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/sequencing.proto
+
+ +
+ + +
+ + + +
+ +
+

community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/sequencing_parameters.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
1
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/sequencing_parameters.proto
+
+ +
+ + +
+ + + +
+ +
+

community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/signed_content.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
1
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/signed_content.proto
+
+ +
+ + +
+ + + +
+ +
+

community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/storage.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
1
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/storage.proto
+
+ +
+ + +
+ + + +
+ +
+

community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/synchronization.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
3
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/synchronization.proto
+
+ +
+ + +
+ + + +
+ +
+

community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/synchronizer_parameters.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
3
+
+ +
+
Enums
+
1
+
+ +
+
Source
+
community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/synchronizer_parameters.proto
+
+ +
+ + +
+ + + +
+ +
+

community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
22
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto
+
+ +
+ + +
+ + + +
+ +
+

community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/traffic_control_parameters.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
6
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/traffic_control_parameters.proto
+
+ +
+ + +
+ + + +
+ +
+

community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/versioned_google_rpc_status.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
1
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/versioned_google_rpc_status.proto
+
+ +
+ + +
+ + +
+ + + + + +## Type Inventory + + +These are the package-level message and enum shapes in the publish-version snapshot. + + + + +
+
+

com.digitalasset.canton.protocol.v30.AcsCommitment

+ +

6 fields

+ +
+ +

A commitment to the active contract set (ACS) that is shared between two participants on a given synchronizer at a given time. Given a commitment scheme to the ACS, the semantics are as follows: the sender declares that the shared ACS was exactly the one committed to, at every commitment tick during the specified period and as determined by the period's interval. The interval is assumed to be a round number of seconds. The ticks then start at the Java EPOCH time, and are exactly `interval` apart. All fields are mandatory.

+ + +
+ +
+
+ physical_synchronizer_id + string + +
+ +
+ +
+
+ sending_participant_uid + string + +
+ +
+ +
+
+ counter_participant_uid + string + +
+ +
+ +
+
+ from_exclusive + int64 + +
+ +
in microseconds of UTC time since Unix epoch
+ +
+ +
+
+ to_inclusive + int64 + +
+ +
in microseconds of UTC time since Unix epoch
+ +
+ +
+
+ commitment + bytes + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.AcsCommitmentsCatchUpConfig

+ +

2 fields

+ +
+ +

catch-up configuration parameters

+ + +
+ +
+
+ catchup_interval_skip + uint32 + +
+ +
+ +
+
+ nr_intervals_to_trigger_catchup + uint32 + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.ActionDescription

+ +

4 fields

+ +
+ + +
+ +
+
+ create + CreateActionDescription + +
+ +
+ +
+
+ exercise + ExerciseActionDescription + +
+ +
+ +
+
+ fetch + FetchActionDescription + +
+ +
+ +
+
+ lookup_by_key + LookupByKeyActionDescription + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.ActionDescription.CreateActionDescription

+ +

2 fields

+ +
+ + +
+ +
+
+ contract_id + string + +
+ +
+ +
+
+ node_seed + bytes + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.ActionDescription.ExerciseActionDescription

+ +

10 fields

+ +
+ + +
+ +
+
+ input_contract_id + string + +
+ +
+ +
+
+ choice + string + +
+ +
+ +
+
+ chosen_value + bytes + +
+ +
+ +
+
+ actors + repeated string + +
+ +
+ +
+
+ by_key + bool + +
+ +
+ +
+
+ node_seed + bytes + +
+ +
+ +
+
+ failed + bool + +
+ +
+ +
+
+ interface_id + string + +
+ +
+ +
+
+ template_id + string + +
+ +
+ +
+
+ package_preference + repeated string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.ActionDescription.FetchActionDescription

+ +

5 fields

+ +
+ + +
+ +
+
+ input_contract_id + string + +
+ +
+ +
+
+ actors + repeated string + +
+ +
+ +
+
+ by_key + bool + +
+ +
+ +
+
+ template_id + string + +
+ +
+ +
+
+ interface_id + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.ActionDescription.LookupByKeyActionDescription

+ +

1 fields

+ +
+ + +
+ +
+
+ key + GlobalKey + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.GlobalKey

+ +

3 fields

+ +
+ + +
+ +
+
+ template_id + bytes + +
+ +
+ +
+
+ key + bytes + +
+ +
+ +
+
+ package_name + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.ActiveContract

+ +

2 fields

+ +
+ + +
+ +
+
+ contract + bytes + +
+ +
Encoded ContractInstance
+ +
+ +
+
+ reassignment_counter + int64 + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.AggregationRule

+ +

2 fields

+ +
+ + +
+ +
+
+ eligible_members + repeated string + +
+ +
Members who are allowed to send a request for the underlying aggregation. Must contain SubmissionRequest.sender, otherwise the request is rejected. Must have at least threshold many elements.
+ +
+ +
+
+ threshold + int32 + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.AssignmentCommonData

+ +

9 fields

+ +
+ + +
+ +
+
+ salt + Salt + +
+ +
+ +
+
+ source_physical_synchronizer_id + string + +
+ +
+ +
+
+ target_physical_synchronizer_id + string + +
+ +
+ +
+
+ unassignment_ts + Timestamp + +
+ +
+ +
+
+ stakeholders + Stakeholders + +
+ +
stakeholders of the contract
+ +
+ +
+
+ uuid + string + +
+ +
request uuid
+ +
+ +
+
+ target_mediator_group + int32 + +
+ +
+ +
+
+ submitter_metadata + ReassignmentSubmitterMetadata + +
+ +
+ +
+
+ reassigning_participant_uids + repeated string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.Salt

+ +

2 fields

+ +
+ + +
+ +
+
+ hmac + HmacAlgorithm + +
+ +
+ +
+
+ salt + bytes + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.HmacAlgorithm

+ +

2 values

+ +
+ + + +
    + +
  • HMAC_ALGORITHM_UNSPECIFIED
    • + +
  • HMAC_ALGORITHM_HMAC_SHA256
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.protocol.v30.Stakeholders

+ +

2 fields

+ +
+ + +
+ +
+
+ all + repeated string + +
+ +
all stakeholders of the contract
+ +
+ +
+
+ signatories + repeated string + +
+ +
signatories of the contract
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.ReassignmentSubmitterMetadata

+ +

6 fields

+ +
+ + +
+ +
+
+ submitter + string + +
+ +
+ +
+
+ submitting_participant_uid + string + +
+ +
+ +
+
+ command_id + string + +
+ +
+ +
+
+ submission_id + string + +
+ +
optional
+ +
+ +
+
+ user_id + string + +
+ +
+ +
+
+ workflow_id + string + +
+ +
optional
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.AssignmentMediatorMessage

+ +

2 fields

+ +
+ + +
+ +
+
+ tree + ReassignmentViewTree + +
+ +
+ +
+
+ submitting_participant_signature + Signature + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.ReassignmentViewTree

+ +

2 fields

+ +
+ + +
+ +
+
+ common_data + bytes + +
+ +
+ +
+
+ participant_data + BlindableNode + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.BlindableNode

+ +

2 fields

+ +
+ + +
+ +
+
+ unblinded + bytes + +
+ +
+ +
+
+ blinded_hash + bytes + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.Signature

+ +

5 fields

+ +
+ + +
+ +
+
+ format + SignatureFormat + +
+ +
+ +
+
+ signature + bytes + +
+ +
+ +
+
+ signed_by + string + +
+ +
The fingerprint/id of the keypair used to create this signature and needed to verify. If a signature delegation is defined, this fingerprint/id is not used to produce the signature, and, instead is used to sign the delegation.
+ +
+ +
+
+ signing_algorithm_spec + SigningAlgorithmSpec + +
+ +
The signing algorithm specification used to produce this signature
+ +
+ +
+
+ signature_delegation + SignatureDelegation + +
+ +
An optional signature delegation where a long-term signing key authorizes a session signing key to sign on its behalf.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SignatureFormat

+ +

5 values

+ +
+ + + +
    + +
  • SIGNATURE_FORMAT_UNSPECIFIED
    • + +
  • SIGNATURE_FORMAT_RAW
    • + +
  • SIGNATURE_FORMAT_DER
    • + +
  • SIGNATURE_FORMAT_CONCAT
    • + +
  • SIGNATURE_FORMAT_SYMBOLIC
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SigningAlgorithmSpec

+ +

4 values

+ +
+ + + +
    + +
  • SIGNING_ALGORITHM_SPEC_UNSPECIFIED
    • + +
  • SIGNING_ALGORITHM_SPEC_ED25519
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_256
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_384
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SignatureDelegation

+ +

7 fields

+ +
+ + +
+ +
+
+ session_key + bytes + +
+ +
ASN.1 + DER-encoding of X.509 SubjectPublicKeyInfo structure of the session public key: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1. This key was used to produce the actual signature.
+ +
+ +
+
+ session_key_spec + SigningKeySpec + +
+ +
The signing key spec for the session key.
+ +
+ +
+
+ validity_period_from_inclusive + int64 + +
+ +
A timestamp in microseconds of UTC time since Unix epoch that indicates when the session key is considered valid.
+ +
+ +
+
+ validity_period_duration_seconds + uint32 + +
+ +
Duration in seconds indicating how long the session key remains valid. The validity period starts from `validity_period_from_inclusive` above.
+ +
+ +
+
+ format + SignatureFormat + +
+ +
The format of the signature
+ +
+ +
+
+ signature + bytes + +
+ +
The signature of the combined hash of the session key fingerprint, validity period, and synchronizer id, by the long-term key. This signature authorizes the session key to act on behalf of the long-term key.
+ +
+ +
+
+ signing_algorithm_spec + SigningAlgorithmSpec + +
+ +
The signing algorithm specification used to produce this signature
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SigningKeySpec

+ +

5 values

+ +
+ +

[start-docs-entry: signing key spec proto]

+ + + +
    + +
  • SIGNING_KEY_SPEC_UNSPECIFIED
    • + +
  • SIGNING_KEY_SPEC_EC_CURVE25519
    • + +
  • SIGNING_KEY_SPEC_EC_P256
    • + +
  • SIGNING_KEY_SPEC_EC_P384
    • + +
  • SIGNING_KEY_SPEC_EC_SECP256K1
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.protocol.v30.AssignmentView

+ +

3 fields

+ +
+ + +
+ +
+
+ salt + Salt + +
+ +
+ +
+
+ contracts + repeated ActiveContract + +
+ +
+ +
+
+ reassignment_id + ReassignmentId + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.ReassignmentId

+ +

1 fields

+ +
+ +

Messages sent by a participant as part of the reassignment protocol

+ + +
+ +
+
+ id + string + +
+ +
identifies the reassignment batch, built from a hash of source, target, contract ids, contract counters and timestamp.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.Batch

+ +

1 fields

+ +
+ + +
+ +
+
+ envelopes + repeated Envelope + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.Envelope

+ +

3 fields

+ +
+ + +
+ +
+
+ content + bytes + +
+ +
Contains a v30.EnvelopeContent if signatures are empty and a v30.TypedSignedProtocolMessageContent otherwise
+ +
+ +
+
+ recipients + Recipients + +
+ +
+ +
+
+ signatures + repeated Signature + +
+ +
An honest sequencer rejects the request if it contains an envelope with an invalid signature. As only honest sequencers verify signatures, clients should not trust a single sequencer node to verify signatures for them.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.Recipients

+ +

1 fields

+ +
+ + +
+ +
+
+ recipients_tree + repeated RecipientsTree + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.RecipientsTree

+ +

2 fields

+ +
+ +

Protobuf has a hard limit on the nesting depth of messages, so this message could potentially hit the nesting depth limit. However this probably won't be an issue any time soon.

+ + +
+ +
+
+ recipients + repeated string + +
+ +
Recipients of the request. Must be non-empty. A recipient is either a member (cf. MemberRecipient) or a set of members (cf. GroupRecipient such as AllMembersOfSynchronizer). TARGET STATE: Each recipient must be authorized at the underlying synchronizer (cf. Recipient.isAuthorized). CURRENT STATE: A recipient must be "known" to the sequencer. A recipient in general remains "known" even after its topology transactions have been removed on the synchronizer.
+ +
+ +
+
+ children + repeated RecipientsTree + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.CommonMetadata

+ +

4 fields

+ +
+ + +
+ +
+
+ salt + Salt + +
+ +
+ +
+
+ physical_synchronizer_id + string + +
+ +
+ +
+
+ uuid + string + +
+ +
+ +
+
+ mediator_group + int32 + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.CompressedBatch

+ +

2 fields

+ +
+ + +
+ +
+
+ algorithm + CompressionAlgorithm + +
+ +
+ +
+
+ compressed_batch + bytes + +
+ +
contains possibly compressed v30.Batch
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.CompressedBatch.CompressionAlgorithm

+ +

2 values

+ +
+ + + +
    + +
  • COMPRESSION_ALGORITHM_UNSPECIFIED
    • + +
  • COMPRESSION_ALGORITHM_GZIP
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.protocol.v30.ConfirmationResponse

+ +

3 fields

+ +
+ + +
+ +
+
+ local_verdict + LocalVerdict + +
+ +
+ +
+
+ confirming_parties + repeated string + +
+ +
Empty iff the verdict is malformed.
+ +
+ +
+
+ view_position + ViewPosition + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.LocalVerdict

+ +

2 fields

+ +
+ +

Definition of the ConfirmationResponse message which is shared between the transaction and reassignment protocol

+ + +
+ +
+
+ code + VerdictCode + +
+ +
+ +
+
+ reason + Status + +
+ +
ok iff code is approve
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.LocalVerdict.VerdictCode

+ +

5 values

+ +
+ + + +
    + +
  • VERDICT_CODE_UNSPECIFIED
    • + +
  • VERDICT_CODE_LOCAL_APPROVE
    • + +
  • VERDICT_CODE_LOCAL_REJECT
    • + +
  • VERDICT_CODE_LOCAL_MALFORMED
    • + +
  • VERDICT_CODE_LOCAL_ABSTAIN
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.protocol.v30.ViewPosition

+ +

1 fields

+ +
+ + +
+ +
+
+ position + repeated MerkleSeqIndex + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.MerkleSeqIndex

+ +

1 fields

+ +
+ + +
+ +
+
+ is_right + repeated bool + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.ConfirmationResponses

+ +

5 fields

+ +
+ + +
+ +
+
+ request_id + int64 + +
+ +
in microseconds of UTC time since Unix epoch
+ +
+ +
+
+ root_hash + bytes + +
+ +
required since DAML 3.0
+ +
+ +
+
+ physical_synchronizer_id + string + +
+ +
+ +
+
+ sender + string + +
+ +
+ +
+
+ responses + repeated ConfirmationResponse + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.ConfirmationResultMessage

+ +

5 fields

+ +
+ +

This covers transactions and reassignments

+ + +
+ +
+
+ physical_synchronizer_id + string + +
+ +
+ +
+
+ view_type + ViewType + +
+ +
+ +
+
+ request_id + int64 + +
+ +
+ +
+
+ root_hash + bytes + +
+ +
+ +
+
+ verdict + Verdict + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.ViewType

+ +

4 values

+ +
+ +

Definitions shared by at least 2 out of mediator.proto, participant_transaction.proto and participant_reassignment.proto

+ + + +
    + +
  • VIEW_TYPE_UNSPECIFIED
    • + +
  • VIEW_TYPE_TRANSACTION
    • + +
  • VIEW_TYPE_UNASSIGNMENT
    • + +
  • VIEW_TYPE_ASSIGNMENT
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.protocol.v30.Verdict

+ +

3 fields

+ +
+ + +
+ +
+
+ approve + Empty + +
+ +
+ +
+
+ participant_reject + ParticipantReject + +
+ +
+ +
+
+ mediator_reject + MediatorReject + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.ParticipantReject

+ +

1 fields

+ +
+ + +
+ +
+
+ reasons + repeated RejectionReason + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.RejectionReason

+ +

3 fields

+ +
+ + +
+ +
+
+ parties + repeated string + +
+ +
+ +
+
+ reject + LocalVerdict + +
+ +
+ +
+
+ participant_id + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.MediatorReject

+ +

2 fields

+ +
+ + +
+ +
+
+ reason + Status + +
+ +
Must not be OK
+ +
+ +
+
+ is_malformed + bool + +
+ +
True if the request has been recognized as malformed.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.ContractAuthenticationData

+ +

1 fields

+ +
+ + +
+ +
+
+ contract_salt + Salt + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.CreatedContract

+ +

3 fields

+ +
+ + +
+ +
+
+ contract + bytes + +
+ +
Encoded ContractInstance
+ +
+ +
+
+ consumed_in_core + bool + +
+ +
+ +
+
+ rolled_back + bool + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.DecentralizedNamespaceDefinition

+ +

3 fields

+ +
+ +

a decentralized namespace definition that creates a new namespace supported by the the original owners authorization: the decentralized namespace definition with serial = 1 must be authorized by all the owners of the namespace that form the decentralized namespace. for definitions with serial > 1, we need the authorization of #threshold owners plus all new owners any further transaction within the decentralized namespace other than decentralized namespace definitions needs #threshold signatures of the owners UNIQUE(decentralized_namespace)

+ + +
+ +
+
+ decentralized_namespace + string + +
+ +
name of the decentralized namespace, computed from the hash of its initial owners
+ +
+ +
+
+ threshold + int32 + +
+ +
the threshold required for any subsequent update signing
+ +
+ +
+
+ owners + repeated string + +
+ +
the namespaces of the owners
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.DeduplicationPeriod

+ +

2 fields

+ +
+ +

Messages sent by a participant as part of the transaction protocol

+ + +
+ +
+
+ duration + Duration + +
+ +
+ +
+
+ offset + int64 + +
+ +
if specified, it must be a valid absolute offset (positive integer) or zero (ledger begin offset)
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.DynamicSequencingParameters

+ +

1 fields

+ +
+ + +
+ +
+
+ payload + bytes + +
+ +
Sequencing dynamic synchronizer parameters can only be interpreted by a sequencer implementation and are opaque to the rest of the synchronizer.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.DynamicSequencingParametersState

+ +

2 fields

+ +
+ +

which sequencing dynamic parameters are supposed to be used on the given synchronizer; defaults are used when not set authorization: whoever controls the synchronizer UNIQUE(synchronizer_id)

+ + +
+ +
+
+ synchronizer_id + string + +
+ +
synchronizer affected by the new synchronizer parameters
+ +
+ +
+
+ sequencing_parameters + DynamicSequencingParameters + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.DynamicSynchronizerParameters

+ +

13 fields

+ +
+ + +
+ +
+
+ confirmation_response_timeout + Duration + +
+ +
+ +
+
+ mediator_reaction_timeout + Duration + +
+ +
+ +
+
+ assignment_exclusivity_timeout + Duration + +
+ +
+ +
+
+ ledger_time_record_time_tolerance + Duration + +
+ +
+ +
+
+ reconciliation_interval + Duration + +
+ +
+ +
+
+ mediator_deduplication_timeout + Duration + +
+ +
+ +
+
+ max_request_size + uint32 + +
+ +
+ +
+
+ onboarding_restriction + OnboardingRestriction + +
+ +
topology related validation parameters permissioned synchronizer: if true, only participants which have been explicitly put on the allow list can onboard to the synchronizer
+ +
+ +
+
+ participant_synchronizer_limits + ParticipantSynchronizerLimits + +
+ +
+ +
+
+ sequencer_aggregate_submission_timeout + Duration + +
+ +
+ +
+
+ traffic_control + TrafficControlParameters + +
+ +
+ +
+
+ acs_commitments_catchup + AcsCommitmentsCatchUpConfig + +
+ +
+ +
+
+ preparation_time_record_time_tolerance + Duration + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.OnboardingRestriction

+ +

5 values

+ +
+ +

Controls how participants can join the synchronizer Note that currently, only transitions from restricted to unrestricted are supported, but not the other way around.

+ + + +
    + +
  • ONBOARDING_RESTRICTION_UNSPECIFIED
    • + +
  • ONBOARDING_RESTRICTION_UNRESTRICTED_OPEN
    • + +
  • ONBOARDING_RESTRICTION_UNRESTRICTED_LOCKED
    • + +
  • ONBOARDING_RESTRICTION_RESTRICTED_OPEN
    • + +
  • ONBOARDING_RESTRICTION_RESTRICTED_LOCKED
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.protocol.v30.ParticipantSynchronizerLimits

+ +

1 fields

+ +
+ +

individual per participant limits

+ + +
+ +
+
+ confirmation_requests_max_rate + uint32 + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.TrafficControlParameters

+ +

7 fields

+ +
+ + +
+ +
+
+ max_base_traffic_amount + uint64 + +
+ +
[doc-entry-start: TrafficControlParameters] In bytes, the maximum amount of base traffic that can be accumulated
+ +
+ +
+
+ max_base_traffic_accumulation_duration + Duration + +
+ +
Maximum duration over which the base rate can be accumulated Consequently, base_traffic_rate = max_base_traffic_amount / max_base_traffic_accumulation_duration
+ +
+ +
+
+ read_vs_write_scaling_factor + uint32 + +
+ +
Read scaling factor to compute the event cost. In parts per 10 000.
+ +
+ +
+
+ set_balance_request_submission_window_size + Duration + +
+ +
Window size used to compute the max sequencing time of a submission request This impacts how quickly a submission is expected to be accepted before a retry should be attempted by the caller Default is 5 minutes
+ +
+ +
+
+ enforce_rate_limiting + bool + +
+ +
If true, submission requests without enough traffic credit will not be delivered
+ +
+ +
+
+ base_event_cost + uint64 + +
+ +
In bytes, base event cost added to all sequenced events. Optional
+ +
+ +
+
+ free_confirmation_responses + bool + +
+ +
Whether to charge for confirmation responses Default: false
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.EncryptedViewMessage

+ +

7 fields

+ +
+ + +
+ +
+
+ view_tree + bytes + +
+ +
+ +
+
+ encryption_scheme + SymmetricKeyScheme + +
+ +
The symmetric encryption scheme used to encrypt the view tree and the session key
+ +
+ +
+
+ submitting_participant_signature + Signature + +
+ +
optional
+ +
+ +
+
+ view_hash + bytes + +
+ +
+ +
+
+ session_key_lookup + repeated AsymmetricEncrypted + +
+ +
+ +
+
+ physical_synchronizer_id + string + +
+ +
+ +
+
+ view_type + ViewType + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SymmetricKeyScheme

+ +

2 values

+ +
+ + + +
    + +
  • SYMMETRIC_KEY_SCHEME_UNSPECIFIED
    • + +
  • SYMMETRIC_KEY_SCHEME_AES128GCM
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.v30.AsymmetricEncrypted

+ +

3 fields

+ +
+ + +
+ +
+
+ ciphertext + bytes + +
+ +
Asymmetrically encrypted data
+ +
+ +
+
+ encryption_algorithm_spec + EncryptionAlgorithmSpec + +
+ +
The asymmetric encryption specification used for the encryption
+ +
+ +
+
+ fingerprint + string + +
+ +
The fingerprint of the public key that was used for the encryption
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.EncryptionAlgorithmSpec

+ +

3 values

+ +
+ + + +
    + +
  • ENCRYPTION_ALGORITHM_SPEC_UNSPECIFIED
    • + +
  • ENCRYPTION_ALGORITHM_SPEC_ECIES_HKDF_HMAC_SHA256_AES128CBC
    • + +
  • ENCRYPTION_ALGORITHM_SPEC_RSA_OAEP_SHA256
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.protocol.v30.Enums

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.Enums.TopologyChangeOp

+ +

3 values

+ +
+ + + +
    + +
  • TOPOLOGY_CHANGE_OP_UNSPECIFIED
    • + +
  • TOPOLOGY_CHANGE_OP_ADD_REPLACE
    • + +
  • TOPOLOGY_CHANGE_OP_REMOVE
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.protocol.v30.Enums.ParticipantPermission

+ +

4 values

+ +
+ +

enum indicating the participant permission level Regardless of the ParticipantPermission level, all participants can submit a reassignment.

+ + + +
    + +
  • PARTICIPANT_PERMISSION_UNSPECIFIED
    • + +
  • PARTICIPANT_PERMISSION_SUBMISSION
    • + +
  • PARTICIPANT_PERMISSION_CONFIRMATION
    • + +
  • PARTICIPANT_PERMISSION_OBSERVATION
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.protocol.v30.Enums.TopologyMappingCode

+ +

16 values

+ +
+ + + +
    + +
  • TOPOLOGY_MAPPING_CODE_UNSPECIFIED
    • + +
  • TOPOLOGY_MAPPING_CODE_NAMESPACE_DELEGATION
    • + +
  • TOPOLOGY_MAPPING_CODE_DECENTRALIZED_NAMESPACE_DEFINITION
    • + +
  • TOPOLOGY_MAPPING_CODE_OWNER_TO_KEY_MAPPING
    • + +
  • TOPOLOGY_MAPPING_CODE_SYNCHRONIZER_TRUST_CERTIFICATE
    • + +
  • TOPOLOGY_MAPPING_CODE_PARTICIPANT_PERMISSION
    • + +
  • TOPOLOGY_MAPPING_CODE_PARTY_HOSTING_LIMITS
    • + +
  • TOPOLOGY_MAPPING_CODE_VETTED_PACKAGES
    • + +
  • TOPOLOGY_MAPPING_CODE_PARTY_TO_PARTICIPANT
    • + +
  • TOPOLOGY_MAPPING_CODE_SYNCHRONIZER_PARAMETERS_STATE
    • + +
  • TOPOLOGY_MAPPING_CODE_MEDIATOR_SYNCHRONIZER_STATE
    • + +
  • TOPOLOGY_MAPPING_CODE_SEQUENCER_SYNCHRONIZER_STATE
    • + +
  • TOPOLOGY_MAPPING_CODE_SEQUENCING_DYNAMIC_PARAMETERS_STATE
    • + +
  • TOPOLOGY_MAPPING_CODE_PARTY_TO_KEY_MAPPING
    • + +
  • TOPOLOGY_MAPPING_CODE_SYNCHRONIZER_MIGRATION_ANNOUNCEMENT
    • + +
  • TOPOLOGY_MAPPING_CODE_SEQUENCER_CONNECTION_SUCCESSOR
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.protocol.v30.Enums.ParticipantFeatureFlag

+ +

2 values

+ +
+ + + +
    + +
  • PARTICIPANT_FEATURE_FLAG_UNSPECIFIED
    • + +
  • PARTICIPANT_FEATURE_FLAG_PV33_EXTERNAL_SIGNING_LOCAL_CONTRACT_IN_SUBVIEW
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.protocol.v30.EnvelopeContent

+ +

6 fields

+ +
+ + +
+ +
+
+ informee_message + InformeeMessage + +
+ +
+ +
+
+ encrypted_view_message + EncryptedViewMessage + +
+ +
+ +
+
+ unassignment_mediator_message + UnassignmentMediatorMessage + +
+ +
+ +
+
+ assignment_mediator_message + AssignmentMediatorMessage + +
+ +
+ +
+
+ root_hash_message + RootHashMessage + +
+ +
+ +
+
+ topology_transactions_broadcast + TopologyTransactionsBroadcast + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.InformeeMessage

+ +

2 fields

+ +
+ +

InformeeMessage

+ + +
+ +
+
+ full_informee_tree + FullInformeeTree + +
+ +
+ +
+
+ submitting_participant_signature + Signature + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.FullInformeeTree

+ +

1 fields

+ +
+ + +
+ +
+
+ tree + GenTransactionTree + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.GenTransactionTree

+ +

4 fields

+ +
+ +

Messages related to Merkle trees (including GenTransactionTree)

+ + +
+ +
+
+ submitter_metadata + BlindableNode + +
+ +
+ +
+
+ common_metadata + BlindableNode + +
+ +
+ +
+
+ participant_metadata + BlindableNode + +
+ +
+ +
+
+ root_views + MerkleSeq + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.MerkleSeq

+ +

1 fields

+ +
+ + +
+ +
+
+ root_or_empty + BlindableNode + +
+ +
optional; absent if the sequence is empty
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.UnassignmentMediatorMessage

+ +

2 fields

+ +
+ + +
+ +
+
+ tree + ReassignmentViewTree + +
+ +
+ +
+
+ submitting_participant_signature + Signature + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.RootHashMessage

+ +

5 fields

+ +
+ +

RootHashMessage

+ + +
+ +
+
+ root_hash + bytes + +
+ +
+ +
+
+ physical_synchronizer_id + string + +
+ +
+ +
+
+ view_type + ViewType + +
+ +
+ +
+
+ submission_topology_time + int64 + +
+ +
in microseconds of UTC time since Unix epoch
+ +
+ +
+
+ payload + bytes + +
+ +
optional
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.TopologyTransactionsBroadcast

+ +

2 fields

+ +
+ +

* Accepted topology transaction A member sends topology transactions to the topology transaction broadcast address. The transactions are validated by all members individually against their respective synchronizer store, including the member the submitted the broadcast.

+ + +
+ +
+
+ physical_synchronizer_id + string + +
+ +
+ +
+
+ signed_transactions + SignedTopologyTransactions + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.SignedTopologyTransactions

+ +

1 fields

+ +
+ + +
+ +
+
+ signed_transaction + repeated bytes + +
+ +
serialized signed topology transaction (protobuf bytestring)
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.ExternalAuthorization

+ +

2 fields

+ +
+ + +
+ +
+
+ authentications + repeated ExternalPartyAuthorization + +
+ +
+ +
+
+ hashing_scheme_version + HashingSchemeVersion + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.ExternalAuthorization.HashingSchemeVersion

+ +

2 values

+ +
+ +

The hashing scheme version used when building the hash

+ + + +
    + +
  • HASHING_SCHEME_VERSION_UNSPECIFIED
    • + +
  • HASHING_SCHEME_VERSION_V2
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.protocol.v30.ExternalPartyAuthorization

+ +

2 fields

+ +
+ +

Additional signatures provided by a single party The purpose of these signatures is to allow parties to authorize transactions by signing it with a private key not known to the network.

+ + +
+ +
+
+ party + string + +
+ +
Submitting party
+ +
+ +
+
+ signatures + repeated Signature + +
+ +
Signatures
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.Informee

+ +

2 fields

+ +
+ + +
+ +
+
+ party + string + +
+ +
+ +
+
+ weight + int32 + +
+ +
optional: only set if party is confirming
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.InformeeTree

+ +

1 fields

+ +
+ +

Messages related to the transaction or reassignment protocol sent by a mediator

+ + +
+ +
+
+ tree + GenTransactionTree + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.InputContract

+ +

2 fields

+ +
+ + +
+ +
+
+ contract + bytes + +
+ +
Encoded ContractInstance
+ +
+ +
+
+ consumed + bool + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.LightTransactionViewTree

+ +

2 fields

+ +
+ + +
+ +
+
+ tree + GenTransactionTree + +
+ +
+ +
+
+ subview_hashes_and_keys + repeated ViewHashAndKey + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.ViewHashAndKey

+ +

2 fields

+ +
+ + +
+ +
+
+ view_hash + bytes + +
+ +
+ +
+
+ view_encryption_key_randomness + bytes + +
+ +
The randomness used to derive the encryption key for the view
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.MediatorSynchronizerState

+ +

5 fields

+ +
+ +

which mediators and mediator groups are active on the given synchronizer authorization: whoever controls the synchronizer UNIQUE(synchronizer_id, group)

+ + +
+ +
+
+ synchronizer_id + string + +
+ +
the synchronizer id of the mediator group
+ +
+ +
+
+ group + uint32 + +
+ +
the group-id used for sharding multiple mediator groups
+ +
+ +
+
+ threshold + uint32 + +
+ +
the signature threshold required to reach consensus among the mediators
+ +
+ +
+
+ active + repeated string + +
+ +
the list of active mediators (uid) within the group
+ +
+ +
+
+ observers + repeated string + +
+ +
the list of observing mediators (uid) within the group (read messages but don't respond)
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.MerkleSeqElement

+ +

3 fields

+ +
+ + +
+ +
+
+ first + BlindableNode + +
+ +
Fields mandatory for Branch
+ +
+ +
+
+ second + BlindableNode + +
+ +
+ +
+
+ data + BlindableNode + +
+ +
Fields mandatory for Singleton
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.MultiTransactionSignatures

+ +

2 fields

+ +
+ +

Used in SignedTopologyTransaction to bundle together multiple transaction hashes Allows submitters to only sign a single combined hash to authorize multiple transactions at once The combined hash is computed from the transaction hashes

+ + +
+ +
+
+ transaction_hashes + repeated bytes + +
+ +
List of topology transaction hashes. Required
+ +
+ +
+
+ signatures + repeated Signature + +
+ +
Signatures on the combined hash computed over the transaction_hashes MUST contain at least one
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.NamespaceDelegation

+ +

6 fields

+ +
+ +

[start NamespaceDelegation definition] namespace delegation (equivalent to X509v3 CA root or intermediate CAs) if is_root_delegation==false, the target key may sign all mappings requiring a signature for the namespace except other NamespaceDelegation mappings. authorization: a namespace delegation is either signed by the root key, or is signed by a key for which there exists a series of properly authorized namespace delegations that are ultimately signed by the root key revocation: a revoked namespace delegation cannot be re-created. While the delegation itself is revoked, valid transactions that have been signed using the authority of the delegation before its revocation stay valid. UNIQUE(namespace, target_key)

+ + +
+ +
+
+ namespace + string + +
+ +
fingerprint of the root key defining the namespace
+ +
+ +
+
+ target_key + SigningPublicKey + +
+ +
target key of getting full rights on the namespace (if target == namespace, it's a root CA)
+ +
+ +
+
+ is_root_delegation + bool + +
+ +
flag indicating whether the given delegation is a root delegation or not a root delegation is also allowed to issue other NamespaceDelegations.
+ +
+ +
+
+ can_sign_all_mappings + CanSignAllMappings + +
+ +
+ +
+
+ can_sign_all_but_namespace_delegations + CanSignAllButNamespaceDelegations + +
+ +
+ +
+
+ can_sign_specific_mapings + CanSignSpecificMappings + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.NamespaceDelegation.CanSignAllMappings

+ +

0 fields

+ +
+ +

[start-docs-entry: namespace delegation restrictions] the key can sign all currently known mappings and all mappings that will be added in future releases

+ + + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.NamespaceDelegation.CanSignAllButNamespaceDelegations

+ +

0 fields

+ +
+ +

the key can sign all currently known mappings and all mappings that will be added in future releases, except for namespace delegations

+ + + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.NamespaceDelegation.CanSignSpecificMappings

+ +

1 fields

+ +
+ +

the key can only sign the explicitly specified mappings

+ + +
+ +
+
+ mappings + repeated TopologyMappingCode + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SigningPublicKey

+ +

5 fields

+ +
+ + +
+ +
+
+ format + CryptoKeyFormat + +
+ +
+ +
+
+ public_key + bytes + +
+ +
Serialized public key in the format specified above
+ +
+ +
+
+ scheme + SigningKeyScheme + +
+ +
No longer used (only kept for backwards compatibility) stores both the crypto key scheme and algorithm.
+ +
+ +
+
+ usage + repeated SigningKeyUsage + +
+ +
Explicitly state the key's intended use
+ +
+ +
+
+ key_spec + SigningKeySpec + +
+ +
The key specification that was used to generate the key pair
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.CryptoKeyFormat

+ +

6 values

+ +
+ +

Serialization format for crypto keys and signatures

+ + + +
    + +
  • CRYPTO_KEY_FORMAT_UNSPECIFIED
    • + +
  • CRYPTO_KEY_FORMAT_DER
    • + +
  • CRYPTO_KEY_FORMAT_RAW
    • + +
  • CRYPTO_KEY_FORMAT_DER_X509_SUBJECT_PUBLIC_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_DER_PKCS8_PRIVATE_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_SYMBOLIC
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SigningKeyScheme

+ +

4 values

+ +
+ +

@deprecated

+ + + +
    + +
  • SIGNING_KEY_SCHEME_UNSPECIFIED
    • + +
  • SIGNING_KEY_SCHEME_ED25519
    • + +
  • SIGNING_KEY_SCHEME_EC_DSA_P256
    • + +
  • SIGNING_KEY_SCHEME_EC_DSA_P384
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SigningKeyUsage

+ +

6 values

+ +
+ + + +
    + +
  • SIGNING_KEY_USAGE_UNSPECIFIED
    • + +
  • SIGNING_KEY_USAGE_NAMESPACE
    • + +
  • SIGNING_KEY_USAGE_IDENTITY_DELEGATION
    • + +
  • SIGNING_KEY_USAGE_SEQUENCER_AUTHENTICATION
    • + +
  • SIGNING_KEY_USAGE_PROTOCOL
    • + +
  • SIGNING_KEY_USAGE_PROOF_OF_OWNERSHIP
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.protocol.v30.OrderingRequest

+ +

2 fields

+ +
+ + +
+ +
+
+ sequencer_uid + string + +
+ +
UID of the sequencer requesting ordering of the request
+ +
+ +
+
+ content + bytes + +
+ +
Content of the request to be ordered
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.OwnerToKeyMapping

+ +

2 fields

+ +
+ +

mapping a member (participant, mediator, sequencer) to a key authorization: whoever controls the member uid UNIQUE(member)

+ + +
+ +
+
+ member + string + +
+ +
the sequencing process member
+ +
+ +
+
+ public_keys + repeated PublicKey + +
+ +
the designated keys
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.PublicKey

+ +

2 fields

+ +
+ + +
+ +
+
+ signing_public_key + SigningPublicKey + +
+ +
+ +
+
+ encryption_public_key + EncryptionPublicKey + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.EncryptionPublicKey

+ +

4 fields

+ +
+ + +
+ +
+
+ format + CryptoKeyFormat + +
+ +
+ +
+
+ public_key + bytes + +
+ +
Serialized public key in the format specified above
+ +
+ +
+
+ scheme + EncryptionKeyScheme + +
+ +
No longer used (only kept for backwards compatibility) stores both the crypto key scheme and algorithm.
+ +
+ +
+
+ key_spec + EncryptionKeySpec + +
+ +
The key specification that was used to generate the key pair
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.EncryptionKeyScheme

+ +

4 values

+ +
+ +

@deprecated

+ + + +
    + +
  • ENCRYPTION_KEY_SCHEME_UNSPECIFIED
    • + +
  • ENCRYPTION_KEY_SCHEME_ECIES_P256_HKDF_HMAC_SHA256_AES128GCM
    • + +
  • ENCRYPTION_KEY_SCHEME_ECIES_P256_HMAC_SHA256A_ES128CBC
    • + +
  • ENCRYPTION_KEY_SCHEME_RSA2048_OAEP_SHA256
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.v30.EncryptionKeySpec

+ +

3 values

+ +
+ + + +
    + +
  • ENCRYPTION_KEY_SPEC_UNSPECIFIED
    • + +
  • ENCRYPTION_KEY_SPEC_EC_P256
    • + +
  • ENCRYPTION_KEY_SPEC_RSA_2048
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.protocol.v30.ParticipantMetadata

+ +

4 fields

+ +
+ + +
+ +
+
+ salt + Salt + +
+ +
+ +
+
+ ledger_time + int64 + +
+ +
in microseconds of UTC time since Unix epoch
+ +
+ +
+
+ preparation_time + int64 + +
+ +
in microseconds of UTC time since Unix epoch
+ +
+ +
+
+ workflow_id + string + +
+ +
optional
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.ParticipantSynchronizerPermission

+ +

5 fields

+ +
+ +

the optional trust certificate of the synchronizer towards the participant authorization: whoever controls the synchronizer id UNIQUE(synchronizer_id,participant)

+ + +
+ +
+
+ synchronizer_id + string + +
+ +
+ +
+
+ participant_uid + string + +
+ +
+ +
+
+ permission + ParticipantPermission + +
+ +
the permission level of the participant on this synchronizer (usually submission)
+ +
+ +
+
+ limits + ParticipantSynchronizerLimits + +
+ +
optional individual limits for this participant
+ +
+ +
+
+ login_after + int64 + +
+ +
optional earliest time when participant can log in (again) used to temporarily disable participants In microseconds of UTC time since Unix epoch
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.PartyHostingLimits

+ +

2 fields

+ +
+ +

the optional hosting limits for a party on a given synchronizer these limits can be used to limit the number of participants that can host a given party authorization: whoever controls the synchronizer id UNIQUE(synchronizer_id,party)

+ + +
+ +
+
+ synchronizer_id + string + +
+ +
+ +
+
+ party + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.PartyIndexAndWeight

+ +

2 fields

+ +
+ +

PartyIndexAndWeight

+ + +
+ +
+
+ index + int32 + +
+ +
The index of the confirming party in the 'informees' field of the 'ViewCommonData' message.
+ +
+ +
+
+ weight + int32 + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.PartyToKeyMapping

+ +

3 fields

+ +
+ +

[doc-entry-start: PartyToKeyMapping] mapping a party to a key authorization: whoever controls the party uid UNIQUE(party)

+ + +
+ +
+
+ party + string + +
+ +
the party
+ +
+ +
+
+ threshold + uint32 + +
+ +
the authorization threshold
+ +
+ +
+
+ signing_keys + repeated SigningPublicKey + +
+ +
the designated signing keys
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.PartyToParticipant

+ +

4 fields

+ +
+ +

Mapping that maps a party to a participant The PartyToParticipant mapping may also specify a list of signing keys for setting up an external party, in which case the keys and the threshold take precedence over any PartyToKeyMapping for the same party. Additionally, the list of signing keys may contain the public key of the party's namespace, which allows this mapping to authorize itself without the need of a NamespaceDelegation root certificate (called self-signed). authorization: the required authorization of the mapping is a union of the authorization for individual changes - threshold change: party namespace - adding a signing key: party namespace + all the new signing key - removing a signing key: party namespace - changing the signing key threshold: party namespace - upgrading a participant permission or adding a new participant: namespaces from party and the participant namespace - downgrading a participant permission or removing a participant: party namespace OR the participant namespace - setting a participant's onboarding flag from false to true: party namespace - setting a participant's onboarding flag from true to false: participant namespace - the removal of a PTP must be authorized just by the party revocation: Revoking a self-signed PTP does not prevent later re-creation of a PTP with the same partyId. To prevent further usage of the key associated with the party's namespace, revoke a NamespaceDelegation root certificate for that namespace. UNIQUE(party)

+ + +
+ +
+
+ party + string + +
+ +
the party that is to be represented by the participants
+ +
+ +
+
+ threshold + uint32 + +
+ +
the signatory threshold required by the participants to be able to act on behalf of the party. a mapping with threshold > 1 is considered a definition of a consortium party
+ +
+ +
+
+ participants + repeated HostingParticipant + +
+ +
which participants will host the party. if threshold > 1, must be Confirmation or Observation. if all participants have Observation permission, the confirmation treshold is ignored, making the party a purely observing party.
+ +
+ +
+
+ party_signing_keys + SigningKeysWithThreshold + +
+ +
Contains protocol signing keys for the party used to authorize externally signed Daml transactions, along with a signing threshold. The max number of keys is 20
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.PartyToParticipant.HostingParticipant

+ +

3 fields

+ +
+ + +
+ +
+
+ participant_uid + string + +
+ +
the target participant that the party should be mapped to
+ +
+ +
+
+ permission + ParticipantPermission + +
+ +
permission of the participant for this particular party (the actual will be min of ParticipantSynchronizerPermission.ParticipantPermission and this setting)
+ +
+ +
+
+ onboarding + Onboarding + +
+ +
optional, present iff the party is being onboarded to the participant
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.PartyToParticipant.HostingParticipant.Onboarding

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SigningKeysWithThreshold

+ +

2 fields

+ +
+ + +
+ +
+
+ keys + repeated SigningPublicKey + +
+ +
the designated signing keys
+ +
+ +
+
+ threshold + uint32 + +
+ +
the authorization threshold
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.PossiblyIgnoredSequencedEvent

+ +

5 fields

+ +
+ +

Messages for sequencing

+ + +
+ +
+
+ counter + int64 + +
+ +
+ +
+
+ timestamp + int64 + +
+ +
in microseconds of UTC time since Unix epoch
+ +
+ +
+
+ trace_context + TraceContext + +
+ +
+ +
+
+ is_ignored + bool + +
+ +
+ +
+
+ underlying + bytes + +
+ +
Serialized SignedContent[SequencedEvent]. Optional if is_ignored == true, required otherwise
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.v30.TraceContext

+ +

2 fields

+ +
+ + +
+ +
+
+ traceparent + string + +
+ +
https://www.w3.org/TR/trace-context/
+ +
+ +
+
+ tracestate + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.Quorum

+ +

2 fields

+ +
+ +

Quorum

+ + +
+ +
+
+ party_index_and_weight + repeated PartyIndexAndWeight + +
+ +
The list of confirmers that constitute a quorum. Each confirmer is represented by their index in the 'informees' field of the 'ViewCommonData' message.
+ +
+ +
+
+ threshold + int32 + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.SequencedEvent

+ +

8 fields

+ +
+ + +
+ +
+
+ previous_timestamp + int64 + +
+ +
The timestamp of the previous event of the member's event sequence. in microseconds of UTC time since Unix epoch Optional, set to None if this is the first ever event of the member's event sequence.
+ +
+ +
+
+ timestamp + int64 + +
+ +
The timestamp of the event. Unique and monotonically increasing. The same event has the same timestamp for all recipients. in microseconds of UTC time since Unix epoch
+ +
+ +
+
+ physical_synchronizer_id + string + +
+ +
The synchronizer on which the event has been sequenced.
+ +
+ +
+
+ message_id + string + +
+ +
The message_id of the request. Optional, but will be defined iff the request sender is the subscriber.
+ +
+ +
+
+ batch + CompressedBatch + +
+ +
The payload of the event. Optional, defined iff deliver_error_reason is undefined.
+ +
+ +
+
+ deliver_error_reason + Status + +
+ +
Optional error, indicates why the underlying SubmissionRequest has been rejected.
+ +
+ +
+
+ topology_timestamp + int64 + +
+ +
Optional timestamp of the topology snapshot used for processing the underlying request (e.g., validation, signing, resolving group addresses). If undefined, timestamp is used instead.
+ +
+ +
+
+ traffic_receipt + TrafficReceipt + +
+ +
Traffic receipt with information about the traffic state after the cost for this event has been consumed Optional - only set on deliver receipt sent back to the sender of the event when traffic control is enabled
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.TrafficReceipt

+ +

3 fields

+ +
+ +

Message representing a traffic receipt included in SequencedEvent receipts to update sender about the traffic consumed state after sequencing of the event

+ + +
+ +
+
+ consumed_cost + uint64 + +
+ +
Cost effectively consumed by this specific event
+ +
+ +
+
+ extra_traffic_consumed + uint64 + +
+ +
Total amount of extra traffic consumed
+ +
+ +
+
+ base_traffic_remainder + uint64 + +
+ +
Remaining free base traffic
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.SequencerConnectionSuccessor

+ +

3 fields

+ +
+ +

a sequencer can announce its connections on the successor synchronizer authorization: whoever controls the sequencer UNIQUE(sequencer_id, synchronizer_id)

+ + +
+ +
+
+ sequencer_id + string + +
+ +
the sequencer id
+ +
+ +
+
+ synchronizer_id + string + +
+ +
to synchronizer id
+ +
+ +
+
+ connection + SequencerConnection + +
+ +
the connection details with which members can connect to the sequencer on the successor synchronizer
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.SequencerConnectionSuccessor.SequencerConnection

+ +

1 fields

+ +
+ + +
+ +
+
+ grpc + Grpc + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.SequencerConnectionSuccessor.SequencerConnection.Grpc

+ +

2 fields

+ +
+ + +
+ +
+
+ endpoints + repeated string + +
+ +
connection information to sequencer (http[s]://<host>:<port>") all endpoints must agree on using HTTPS or HTTP
+ +
+ +
+
+ custom_trust_certificates + bytes + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.SequencerSynchronizerState

+ +

4 fields

+ +
+ +

which sequencers are active on the given synchronizer authorization: whoever controls the synchronizer UNIQUE(synchronizer_id)

+ + +
+ +
+
+ synchronizer_id + string + +
+ +
the synchronizer id of the sequencer group
+ +
+ +
+
+ threshold + uint32 + +
+ +
The system can tolerate up to min(threshold - 1, (activeWithSigningKey.size - 1)/3) malicious active sequencers, where activeWithSigningKey is the set of sequencers from active that have an active OwnerToKeyMapping with a signing key. In order to make the system resilient against f malicious active sequencers, you need to: (1) configure threshold := f + 1, (2) possibly add active sequencers such that f <= (activeWithSigningKey.size - 1)/3. (3) possibly register signing keys for active sequencers,
+ +
+ +
+
+ active + repeated string + +
+ +
the list of active sequencers If a sequencer without an active signing key is added to this set, it has no effect on the topology state.
+ +
+ +
+
+ observers + repeated string + +
+ +
the list of observing sequencers (uid) within the group (read messages but don't respond)
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.SequencingSubmissionCost

+ +

1 fields

+ +
+ +

Messages used for synchronization between sequencer nodes Submission cost computed by the sender for a SubmissionRequest

+ + +
+ +
+
+ cost + int64 + +
+ +
Computed cost
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.SerializableContract

+ +

5 fields

+ +
+ + +
+ +
+
+ contract_id + string + +
+ +
+ +
+
+ raw_contract_instance + bytes + +
+ +
+ +
+
+ metadata + Metadata + +
+ +
+ +
+
+ ledger_create_time + int64 + +
+ +
in microseconds of UTC time since Unix epoch
+ +
+ +
+
+ authentication_data + bytes + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.SerializableContract.Metadata

+ +

4 fields

+ +
+ + +
+ +
+
+ non_maintainer_signatories + repeated string + +
+ +
+ +
+
+ non_signatory_stakeholders + repeated string + +
+ +
+ +
+
+ key + GlobalKey + +
+ +
optional: only set if contract has a key
+ +
+ +
+
+ maintainers + repeated string + +
+ +
optional; only set if contract has a key
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.ServiceAgreement

+ +

2 fields

+ +
+ + +
+ +
+
+ id + string + +
+ +
A unique identifier of an agreement within a synchronizer, which must change when the legal text changes
+ +
+ +
+
+ legal_text + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.SetTrafficPurchasedMessage

+ +

4 fields

+ +
+ + +
+ +
+
+ member + string + +
+ +
Member to update the balance for
+ +
+ +
+
+ serial + uint32 + +
+ +
Serial number - must be unique and monotonically increasing for each new purchase update
+ +
+ +
+
+ total_traffic_purchased + uint64 + +
+ +
New total traffic purchased entry
+ +
+ +
+
+ physical_synchronizer_id + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.SignedContent

+ +

3 fields

+ +
+ + +
+ +
+
+ content + bytes + +
+ +
+ +
+
+ signatures + repeated Signature + +
+ +
+ +
+
+ timestamp_of_signing_key + int64 + +
+ +
in microseconds of UTC time since Unix epoch
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.SignedProtocolMessage

+ +

2 fields

+ +
+ + +
+ +
+
+ signature + repeated Signature + +
+ +
+ +
+
+ typed_signed_protocol_message_content + bytes + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.SignedTopologyTransaction

+ +

4 fields

+ +
+ + +
+ +
+
+ transaction + bytes + +
+ +
serialized topology transaction (protobuf bytestring)
+ +
+ +
+
+ signatures + repeated Signature + +
+ +
multiple signatures Either this field OR the multi_transaction_signatures field MUST contain at least one signature
+ +
+ +
+
+ proposal + bool + +
+ +
if true, this transaction is just a proposal. this means that every signature is valid, but the signatures are insufficient to properly authorize the transaction. proposals are distributed via the topology channel too. proposals will be pruned automatically when the nodes are pruned TODO(#14045) implement pruning
+ +
+ +
+
+ multi_transaction_signatures + repeated MultiTransactionSignatures + +
+ +
If set, the transaction may be authorized by signing a hash computed from multiple transaction hashes This allows to effectively authorize multiple transactions with a single signature. Each item MUST contain the hash of this transaction Optional
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.StaticSynchronizerParameters

+ +

10 fields

+ +
+ + +
+ +
+
+ required_signing_specs + RequiredSigningSpecs + +
+ +
+ +
+
+ required_encryption_specs + RequiredEncryptionSpecs + +
+ +
+ +
+
+ required_symmetric_key_schemes + repeated SymmetricKeyScheme + +
+ +
+ +
+
+ required_hash_algorithms + repeated HashAlgorithm + +
+ +
+ +
+
+ required_crypto_key_formats + repeated CryptoKeyFormat + +
+ +
+ +
+
+ required_signature_formats + repeated SignatureFormat + +
+ +
+ +
+
+ protocol_version + int32 + +
+ +
+ +
+
+ serial + int32 + +
+ +
Serial of the synchronizer. Must be non-negative.
+ +
+ +
+
+ enable_transparency_checks + bool + +
+ +
Flag to enable transparency checks.
+ +
+ +
+
+ topology_change_delay + Duration + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.RequiredSigningSpecs

+ +

2 fields

+ +
+ +

Used to announce the required signing key and algorithm specifications in the static synchronizer parameters.

+ + +
+ +
+
+ algorithms + repeated SigningAlgorithmSpec + +
+ +
+ +
+
+ keys + repeated SigningKeySpec + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.RequiredEncryptionSpecs

+ +

2 fields

+ +
+ +

Used to announce the required encryption key and algorithm specifications in the static synchronizer parameters.

+ + +
+ +
+
+ algorithms + repeated EncryptionAlgorithmSpec + +
+ +
+ +
+
+ keys + repeated EncryptionKeySpec + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.HashAlgorithm

+ +

2 values

+ +
+ + + +
    + +
  • HASH_ALGORITHM_UNSPECIFIED
    • + +
  • HASH_ALGORITHM_SHA256
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.protocol.v30.StoredParties

+ +

1 fields

+ +
+ +

Enables storing parties in the database as a blob

+ + +
+ +
+
+ parties + repeated string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.SubmissionRequest

+ +

7 fields

+ +
+ +

Messages used for synchronization between sequencer nodes

+ + +
+ +
+
+ sender + string + +
+ +
Sender of the request. This request must be wrapped in a SignedContent and the signature therein must validate under one of the sender's public keys. The request metadata must contain a valid authentication token belonging to the sender. (Details in SequencerAuthenticationServerInterceptor.) TARGET STATE: The sender must be authorized (cf. TopologySnapshot.isMemberKnown) CURRENT STATE: The sender authorization check might have a few gaps (e.g., see MemberAuthenticationService.isActive) and/or may use the wrong snapshot.
+ +
+ +
+
+ message_id + string + +
+ +
Will be included in the receipt of the request. The sender should not reuse a message_id until max_sequencing_time, because otherwise it will be unable to correlate receipts with requests.
+ +
+ +
+
+ batch + CompressedBatch + +
+ +
The payload, mandatory At most one recipient of an envelope may be (a) a mediator, (b) a mediator group, or (c) all synchronizer members.
+ +
+ +
+
+ max_sequencing_time + int64 + +
+ +
Maximum sequencing time for the request. If the request can't be sequenced until the specified time, the sequencer will reject it. After max_sequencing_time, no event corresponding to the request will be emitted. in microseconds of UTC time since Unix epoch
+ +
+ +
+
+ topology_timestamp + int64 + +
+ +
Optional timestamp (in microseconds of UTC time since Unix epoch) of topology snapshot to be used for processing the request (e.g., validation, signing, resolving group addresses). If defined, it must meet the following conditions: (1) it must be before or at the sequencing timestamp, (2) it must be by at most DynamicSynchronizerParameters.sequencerTopologyTimestampTolerance before the sequencing timestamp, where the DynamicSynchronizerParameters are taken from the topology state at topology_timestamp, (3) the sequencer must have signing keys registered in the topology snapshot. If defined and invalid, the request is rejected. If undefined or invalid, the topology snapshot at sequencing time will be used instead.
+ +
+ +
+
+ aggregation_rule + AggregationRule + +
+ +
Optional rule used to aggregate requests.
+ +
+ +
+
+ submission_cost + SequencingSubmissionCost + +
+ +
Optional submission cost computed by the sender. Must be provided if traffic control is enabled on the receiving synchronizer.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.SubmitterMetadata

+ +

9 fields

+ +
+ + +
+ +
+
+ salt + Salt + +
+ +
+ +
+
+ act_as + repeated string + +
+ +
+ +
+
+ user_id + string + +
+ +
+ +
+
+ command_id + string + +
+ +
+ +
+
+ submitting_participant_uid + string + +
+ +
+ +
+
+ submission_id + string + +
+ +
optional; absent if not specified by submitter
+ +
+ +
+
+ dedup_period + DeduplicationPeriod + +
+ +
+ +
+
+ max_sequencing_time + int64 + +
+ +
in microseconds of UTC time since Unix epoch
+ +
+ +
+
+ external_authorization + ExternalAuthorization + +
+ +
optional
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.SynchronizerParametersState

+ +

2 fields

+ +
+ +

which dynamic synchronizer parameters are supposed to be used on the given synchronizer authorization: whoever controls the synchronizer UNIQUE(synchronizer_id)

+ + +
+ +
+
+ synchronizer_id + string + +
+ +
synchronizer affected by the new synchronizer parameters
+ +
+ +
+
+ synchronizer_parameters + DynamicSynchronizerParameters + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.SynchronizerTrustCertificate

+ +

3 fields

+ +
+ +

the trust certificate issued by the participant confirming that the participant wishes to be present on the given synchronizer authorization: whoever controls the participant uid UNIQUE(participant,synchronizer_id)

+ + +
+ +
+
+ participant_uid + string + +
+ +
the uid of the participant
+ +
+ +
+
+ synchronizer_id + string + +
+ +
the uid of the synchronizer that the participant trusts
+ +
+ +
+
+ feature_flags + repeated ParticipantFeatureFlag + +
+ +
Feature flags that this node declares to support on this synchronizer
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.SynchronizerUpgradeAnnouncement

+ +

2 fields

+ +
+ +

indicates the beginning of a synchronizer upgrade and effectuates a topology freeze, after which only synchronizer upgrade specific topology mappings are accepted. removing this mapping unfreezes the topology state again. authorization: whoever controls the synchronizer UNIQUE(successor_physical_synchronizer_id.logical)

+ + +
+ +
+
+ successor_physical_synchronizer_id + string + +
+ +
the physical synchronizer id of the successor synchronizer
+ +
+ +
+
+ upgrade_time + Timestamp + +
+ +
when the upgrade happens
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.TopologyMapping

+ +

15 fields

+ +
+ +

[docs-entry-start: topology mapping]

+ + +
+ +
+
+ namespace_delegation + NamespaceDelegation + +
+ +
+ +
+
+ decentralized_namespace_definition + DecentralizedNamespaceDefinition + +
+ +
+ +
+
+ owner_to_key_mapping + OwnerToKeyMapping + +
+ +
+ +
+
+ synchronizer_trust_certificate + SynchronizerTrustCertificate + +
+ +
+ +
+
+ participant_permission + ParticipantSynchronizerPermission + +
+ +
+ +
+
+ party_hosting_limits + PartyHostingLimits + +
+ +
+ +
+
+ vetted_packages + VettedPackages + +
+ +
+ +
+
+ party_to_participant + PartyToParticipant + +
+ +
+ +
+
+ synchronizer_parameters_state + SynchronizerParametersState + +
+ +
+ +
+
+ mediator_synchronizer_state + MediatorSynchronizerState + +
+ +
+ +
+
+ sequencer_synchronizer_state + SequencerSynchronizerState + +
+ +
+ +
+
+ sequencing_dynamic_parameters_state + DynamicSequencingParametersState + +
+ +
+ +
+
+ party_to_key_mapping + PartyToKeyMapping + +
+ +
+ +
+
+ synchronizer_upgrade_announcement + SynchronizerUpgradeAnnouncement + +
+ +
+ +
+
+ sequencer_connection_successor + SequencerConnectionSuccessor + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.VettedPackages

+ +

3 fields

+ +
+ +

list of packages supported by this participant authorization: whoever controls the participant uid UNIQUE(participant)

+ + +
+ +
+
+ participant_uid + string + +
+ +
the participant vetting the packages
+ +
+ +
+
+ package_ids + repeated string + +
+ +
DEPRECATED: no longer used, but kept for backwards compatibility. the hashes of the vetted packages. package hashes may only be listed in one of the two fields: package_ids or packages. a package listed in package_ids is equivalent to a package listed in packages with unbounded validity.
+ +
+ +
+
+ packages + repeated VettedPackage + +
+ +
the hashes of vetted packages with a validity period. only one entry per package_id is permitted.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.VettedPackages.VettedPackage

+ +

3 fields

+ +
+ + +
+ +
+
+ package_id + string + +
+ +
the hash of the vetted package
+ +
+ +
+
+ valid_from_inclusive + Timestamp + +
+ +
optional earliest ledger effective time (inclusive) as of which the package is considered valid. must be less than or equal to valid_until if both are present.
+ +
+ +
+
+ valid_until_exclusive + Timestamp + +
+ +
optional latest ledger effective time (exclusive) until which the package is considered valid. must be greater than or equal to valid_from if both are present.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.TopologyTransaction

+ +

3 fields

+ +
+ + +
+ +
+
+ operation + TopologyChangeOp + +
+ +
+ +
+
+ serial + uint32 + +
+ +
Serial identifier of this transaction used to prevent replay attacks. A topology transaction is replacing the existing transaction with serial - 1 that has the same unique key.
+ +
+ +
+
+ mapping + TopologyMapping + +
+ +
the element of this topology transaction
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.TrafficConsumed

+ +

5 fields

+ +
+ +

Message representing traffic consumed by a member at a given point in time

+ + +
+ +
+
+ member + string + +
+ +
Member consuming the traffic
+ +
+ +
+
+ extra_traffic_consumed + uint64 + +
+ +
Total extra traffic consumed
+ +
+ +
+
+ base_traffic_remainder + uint64 + +
+ +
Remaining free base traffic
+ +
+ +
+
+ last_consumed_cost + uint64 + +
+ +
Cost deducted at `timestamp`, only present when traffic was consumed at `timestamp`, otherwise is set to 0
+ +
+ +
+
+ sequencing_timestamp + int64 + +
+ +
Timestamp at which this state is valid - this timestamp is used to compute the base traffic remainder above
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.TrafficPurchased

+ +

4 fields

+ +
+ +

Message representing a traffic purchase made on behalf of a member

+ + +
+ +
+
+ member + string + +
+ +
Member receiving the traffic
+ +
+ +
+
+ serial + uint32 + +
+ +
Serial of the update
+ +
+ +
+
+ extra_traffic_purchased + uint64 + +
+ +
New total extra traffic purchased
+ +
+ +
+
+ sequencing_timestamp + int64 + +
+ +
Timestamp at which this state is valid
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.TrafficState

+ +

6 fields

+ +
+ +

Traffic state of a member at a given timestamp

+ + +
+ +
+
+ extra_traffic_purchased + int64 + +
+ +
Total amount of extra traffic purchased
+ +
+ +
+
+ extra_traffic_consumed + int64 + +
+ +
Total amount of extra traffic consumed
+ +
+ +
+
+ base_traffic_remainder + int64 + +
+ +
Amount of base traffic remaining
+ +
+ +
+
+ last_consumed_cost + uint64 + +
+ +
Cost deducted at `timestamp`, only present when traffic was consumed at `timestamp`, otherwise is set to 0
+ +
+ +
+
+ timestamp + int64 + +
+ +
Timestamp at which the state is valid
+ +
+ +
+
+ serial + uint32 + +
+ +
Optional serial of the balance update that updated the extra traffic limit
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.TypedSignedProtocolMessageContent

+ +

4 fields

+ +
+ +

Messages depending on both participant_transaction.proto and participant_reassignment.proto.

+ + +
+ +
+
+ confirmation_responses + bytes + +
+ +
+ +
+
+ confirmation_result + bytes + +
+ +
+ +
+
+ acs_commitment + bytes + +
+ +
+ +
+
+ set_traffic_purchased + bytes + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.UnassignmentCommonData

+ +

7 fields

+ +
+ +

Messages sent by a participant as part of the reassignment protocol

+ + +
+ +
+
+ salt + Salt + +
+ +
+ +
+
+ source_physical_synchronizer_id + string + +
+ +
+ +
+
+ stakeholders + Stakeholders + +
+ +
+ +
+
+ reassigning_participant_uids + repeated string + +
+ +
+ +
+
+ uuid + string + +
+ +
+ +
+
+ source_mediator_group + int32 + +
+ +
+ +
+
+ submitter_metadata + ReassignmentSubmitterMetadata + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.UnassignmentData

+ +

7 fields

+ +
+ + +
+ +
+
+ submitter_metadata + ReassignmentSubmitterMetadata + +
+ +
+ +
+
+ contracts + repeated ActiveContract + +
+ +
+ +
+
+ reassigning_participant_uids + repeated string + +
+ +
+ +
+
+ source_physical_synchronizer_id + string + +
+ +
+ +
+
+ target_physical_synchronizer_id + string + +
+ +
+ +
+
+ target_timestamp + Timestamp + +
+ +
+ +
+
+ unassignment_ts + Timestamp + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.UnassignmentView

+ +

4 fields

+ +
+ + +
+ +
+
+ salt + Salt + +
+ +
+ +
+
+ target_physical_synchronizer_id + string + +
+ +
+ +
+
+ target_timestamp + int64 + +
+ +
+ +
+
+ contracts + repeated ActiveContract + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.VersionedStatus

+ +

1 fields

+ +
+ +

DA's wrapper around `google.rpc.Status` for the proper versioning and code-gen

+ + +
+ +
+
+ status + Status + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.ViewCommonData

+ +

3 fields

+ +
+ + +
+ +
+
+ salt + Salt + +
+ +
+ +
+
+ informees + repeated string + +
+ +
+ +
+
+ quorums + repeated Quorum + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.ViewNode

+ +

3 fields

+ +
+ +

Messages sent by a participant as part of the transaction protocol

+ + +
+ +
+
+ view_common_data + BlindableNode + +
+ +
+ +
+
+ view_participant_data + BlindableNode + +
+ +
+ +
+
+ subviews + MerkleSeq + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.ViewParticipantData

+ +

7 fields

+ +
+ +

Messages sent by a participant as part of the transaction protocol

+ + +
+ +
+
+ salt + Salt + +
+ +
+ +
+
+ core_inputs + repeated InputContract + +
+ +
+ +
+
+ created_core + repeated CreatedContract + +
+ +
+ +
+
+ created_in_subview_archived_in_core + repeated string + +
+ +
ids of contracts created in a subview and archived in the core
+ +
+ +
+
+ resolved_keys + repeated ResolvedKey + +
+ +
+ +
+
+ action_description + ActionDescription + +
+ +
+ +
+
+ rollback_context + RollbackContext + +
+ +
optional; defaults to the empty RollbackContext if omitted.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.ViewParticipantData.FreeKey

+ +

1 fields

+ +
+ + +
+ +
+
+ maintainers + repeated string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.ViewParticipantData.ResolvedKey

+ +

3 fields

+ +
+ + +
+ +
+
+ key + GlobalKey + +
+ +
+ +
+
+ contract_id + string + +
+ +
the key resolves to a contract
+ +
+ +
+
+ free + FreeKey + +
+ +
the key is free and these are the maintainers
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.ViewParticipantData.RollbackContext

+ +

2 fields

+ +
+ + +
+ +
+
+ rollback_scope + repeated int32 + +
+ +
+ +
+
+ next_child + int32 + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.ViewParticipantMessage

+ +

0 fields

+ +
+ +

EncryptedViewMessage

+ + + + +
diff --git a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-protocol-v31.mdx b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-protocol-v31.mdx index ca76452..be1318f 100644 --- a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-protocol-v31.mdx +++ b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-protocol-v31.mdx @@ -1,39 +1,164 @@ --- title: "com.digitalasset.canton.protocol.v31" -description: "Descriptor-backed protobuf API history for package com.digitalasset.canton.protocol.v31." +description: "Package-level overview for com.digitalasset.canton.protocol.v31." --- -# Package `com.digitalasset.canton.protocol.v31` +

Back to overview

-[Back to Canton Protobuf History](../index) +
+ +

Protobuf Package

+ + +

com.digitalasset.canton.protocol.v31

+ + +

0 services, 0 endpoints, 1 messages

+ + +
+ + gRPC + +
-## Snapshot + +
+ +
+
Files
+
1
+
+ +
+
Services
+
0
+
+ +
+
Endpoints
+
0
+
+ +
+
Messages
+
1
+
+ +
+
Enums
+
0
+
+ +
+ +
-- Current files: `1` -- Current services: `0` -- Current endpoints: `0` -- Current messages: `1` -- Current enums: `0` -- Lifecycle endpoints tracked: `0` ## Source Files -| File | Services | Messages | Enums | Source | -| --- | --- | --- | --- | --- | -| community/base/src/main/protobuf/com/digitalasset/canton/protocol/v31/common.proto | `0` | `1` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v31/common.proto#L4) | -## Type Reference - -**Message `com.digitalasset.canton.protocol.v31.ContractAuthenticationData`** -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/protocol/v31/common.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v31/common.proto#L8) -- Fields: 3 +
+ + +
+ +
+

community/base/src/main/protobuf/com/digitalasset/canton/protocol/v31/common.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
1
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/base/src/main/protobuf/com/digitalasset/canton/protocol/v31/common.proto
+
+ +
+ + +
+ + +
+ + + + + +## Type Inventory + + +These are the package-level message and enum shapes in the publish-version snapshot. + + + -_No description._ +
+
+

com.digitalasset.canton.protocol.v31.ContractAuthenticationData

+ +

3 fields

+ +
+ + +
+ +
+
+ contract_salt + bytes + +
+ +
+ +
+
+ creating_transaction_id + bytes + +
+ +
Empty for relative contract IDs, required for absolute contract IDs
+ +
+ +
+
+ relative_argument_suffixes + repeated bytes + +
+ +
Contains the absolutization pre-images of all relative contract ID suffixes of the contract argument. Empty for relative contract IDs. Must be lexicographically sorted.
+ +
+ +
-| Field | Type | Label | Description | -| --- | --- | --- | --- | -| contract_salt | `bytes` | optional | | -| creating_transaction_id | `bytes` | optional | Empty for relative contract IDs, required for absolute contract IDs | -| relative_argument_suffixes | `bytes` | repeated | Contains the absolutization pre-images of all relative contract ID suffixes of the contract argument.
Empty for relative contract IDs. Must be lexicographically sorted. | + + +
diff --git a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-sequencer-admin-v30.mdx b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-sequencer-admin-v30.mdx index 2dfb6e0..2a13215 100644 --- a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-sequencer-admin-v30.mdx +++ b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-sequencer-admin-v30.mdx @@ -1,2301 +1,5757 @@ --- title: "com.digitalasset.canton.sequencer.admin.v30" -description: "Descriptor-backed protobuf API history for package com.digitalasset.canton.sequencer.admin.v30." +description: "Package-level overview for com.digitalasset.canton.sequencer.admin.v30." --- -# Package `com.digitalasset.canton.sequencer.admin.v30` +

Back to overview

+ +
+ +

Protobuf Package

+ + +

com.digitalasset.canton.sequencer.admin.v30

+ + +

5 services, 37 endpoints, 81 messages, 1 enums

+ + +
+ + gRPC + +
+ + +
+ +
+
Files
+
7
+
+ +
+
Services
+
5
+
+ +
+
Endpoints
+
37
+
+ +
+
Messages
+
81
+
+ +
+
Enums
+
1
+
+ +
+ +
-[Back to Canton Protobuf History](../index) - -## Snapshot - -- Current files: `7` -- Current services: `5` -- Current endpoints: `37` -- Current messages: `81` -- Current enums: `1` -- Lifecycle endpoints tracked: `37` ## Source Files -| File | Services | Messages | Enums | Source | -| --- | --- | --- | --- | --- | -| community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto | `1` | `18` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto#L4) | -| community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_additional_snapshot_info.proto | `0` | `2` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_additional_snapshot_info.proto#L4) | -| community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto | `1` | `20` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto#L4) | -| community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto | `1` | `11` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto#L4) | -| community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_service.proto | `1` | `10` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_service.proto#L4) | -| community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_snapshot.proto | `0` | `4` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_snapshot.proto#L4) | -| community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_pruning_administration_service.proto | `1` | `2` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_pruning_administration_service.proto#L4) | -## Services -| Service | Endpoints | Source | Description | -| --- | --- | --- | --- | -| [`SequencerAdministrationService`](#service-com-digitalasset-canton-sequencer-admin-v30-sequenceradministrationservice) | `8` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto#L17) | administration service for sequencer instances | -| [`SequencerBftAdministrationService`](#service-com-digitalasset-canton-sequencer-admin-v30-sequencerbftadministrationservice) | `5` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto#L8) | | -| [`SequencerBftPruningAdministrationService`](#service-com-digitalasset-canton-sequencer-admin-v30-sequencerbftpruningadministrationservice) | `11` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto#L12) | | -| [`SequencerInitializationService`](#service-com-digitalasset-canton-sequencer-admin-v30-sequencerinitializationservice) | `5` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_service.proto#L12) | Service allowing a sequencer node to initialize the sequencer instance. Should typically only be exposed to the seque... | -| [`SequencerPruningAdministrationService`](#service-com-digitalasset-canton-sequencer-admin-v30-sequencerpruningadministrationservice) | `8` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_pruning_administration_service.proto#L12) | administration service for enterprise feature supporting sequencer instances | - -### Service `SequencerAdministrationService` +
+ + +
+ +
+

community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
18
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto
+
+ +
+ + +
+ + + +
+ +
+

community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_additional_snapshot_info.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
2
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_additional_snapshot_info.proto
+
+ +
+ + +
+ + + +
+ +
+

community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
20
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto
+
+ +
+ + +
+ + + +
+ +
+

community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
11
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto
+
+ +
+ + +
+ + + +
+ +
+

community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
10
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_service.proto
+
+ +
+ + +
+ + + +
+ +
+

community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_snapshot.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
4
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_snapshot.proto
+
+ +
+ + +
+ + + +
+ +
+

community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_pruning_administration_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
2
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_pruning_administration_service.proto
+
+ +
+ + +
+ + +
+ + + + + +## SequencerAdministrationService -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto#L17) -- Endpoints tracked: `8` administration service for sequencer instances -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`DisableMember`](#endpoint-com-digitalasset-canton-sequencer-admin-v30-sequenceradministrationservice-disablemember) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.sequencer.admin.v30.DisableMemberRequest`](#type-com-digitalasset-canton-sequencer-admin-v30-disablememberrequest) | [`com.digitalasset.canton.sequencer.admin.v30.DisableMemberResponse`](#type-com-digitalasset-canton-sequencer-admin-v30-disablememberresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto#L43) | -| [`GenerateAuthenticationToken`](#endpoint-com-digitalasset-canton-sequencer-admin-v30-sequenceradministrationservice-generateauthenticationtoken) | `3.4.11` | `3.4.11` | `` | [`com.digitalasset.canton.sequencer.admin.v30.GenerateAuthenticationTokenRequest`](#type-com-digitalasset-canton-sequencer-admin-v30-generateauthenticationtokenrequest) | [`com.digitalasset.canton.sequencer.admin.v30.GenerateAuthenticationTokenResponse`](#type-com-digitalasset-canton-sequencer-admin-v30-generateauthenticationtokenresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto#L47) | -| [`OnboardingState`](#endpoint-com-digitalasset-canton-sequencer-admin-v30-sequenceradministrationservice-onboardingstate) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.sequencer.admin.v30.OnboardingStateRequest`](#type-com-digitalasset-canton-sequencer-admin-v30-onboardingstaterequest) | [`com.digitalasset.canton.sequencer.admin.v30.OnboardingStateResponse`](#type-com-digitalasset-canton-sequencer-admin-v30-onboardingstateresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto#L36) | -| [`OnboardingStateV2`](#endpoint-com-digitalasset-canton-sequencer-admin-v30-sequenceradministrationservice-onboardingstatev2) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.sequencer.admin.v30.OnboardingStateV2Request`](#type-com-digitalasset-canton-sequencer-admin-v30-onboardingstatev2request) | [`com.digitalasset.canton.sequencer.admin.v30.OnboardingStateV2Response`](#type-com-digitalasset-canton-sequencer-admin-v30-onboardingstatev2response) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto#L40) | -| [`PruningStatus`](#endpoint-com-digitalasset-canton-sequencer-admin-v30-sequenceradministrationservice-pruningstatus) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.sequencer.admin.v30.PruningStatusRequest`](#type-com-digitalasset-canton-sequencer-admin-v30-pruningstatusrequest) | [`com.digitalasset.canton.sequencer.admin.v30.PruningStatusResponse`](#type-com-digitalasset-canton-sequencer-admin-v30-pruningstatusresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto#L19) | -| [`SetTrafficPurchased`](#endpoint-com-digitalasset-canton-sequencer-admin-v30-sequenceradministrationservice-settrafficpurchased) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.sequencer.admin.v30.SetTrafficPurchasedRequest`](#type-com-digitalasset-canton-sequencer-admin-v30-settrafficpurchasedrequest) | [`com.digitalasset.canton.sequencer.admin.v30.SetTrafficPurchasedResponse`](#type-com-digitalasset-canton-sequencer-admin-v30-settrafficpurchasedresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto#L29) | -| [`Snapshot`](#endpoint-com-digitalasset-canton-sequencer-admin-v30-sequenceradministrationservice-snapshot) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.sequencer.admin.v30.SnapshotRequest`](#type-com-digitalasset-canton-sequencer-admin-v30-snapshotrequest) | [`com.digitalasset.canton.sequencer.admin.v30.SnapshotResponse`](#type-com-digitalasset-canton-sequencer-admin-v30-snapshotresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto#L32) | -| [`TrafficControlState`](#endpoint-com-digitalasset-canton-sequencer-admin-v30-sequenceradministrationservice-trafficcontrolstate) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.sequencer.admin.v30.TrafficControlStateRequest`](#type-com-digitalasset-canton-sequencer-admin-v30-trafficcontrolstaterequest) | [`com.digitalasset.canton.sequencer.admin.v30.TrafficControlStateResponse`](#type-com-digitalasset-canton-sequencer-admin-v30-trafficcontrolstateresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto#L25) | - - -**Endpoint `SequencerAdministrationService.DisableMember`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto#L43) - -**Signature** - -```protobuf -rpc SequencerAdministrationService.DisableMember(com.digitalasset.canton.sequencer.admin.v30.DisableMemberRequest) returns (com.digitalasset.canton.sequencer.admin.v30.DisableMemberResponse); -``` - -Disable members at the sequencer. Will prevent existing and new instances from connecting, and permit removing their data. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.DisableMemberRequest`](#type-com-digitalasset-canton-sequencer-admin-v30-disablememberrequest) - -**Response Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.DisableMemberResponse`](#type-com-digitalasset-canton-sequencer-admin-v30-disablememberresponse) - - -**Endpoint `SequencerAdministrationService.GenerateAuthenticationToken`** - -- Introduced in: `3.4.11` -- Last changed in: `3.4.11` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto#L47) - -**Signature** - -```protobuf -rpc SequencerAdministrationService.GenerateAuthenticationToken(com.digitalasset.canton.sequencer.admin.v30.GenerateAuthenticationTokenRequest) returns (com.digitalasset.canton.sequencer.admin.v30.GenerateAuthenticationTokenResponse); -``` - -Generate an authentication token for a member. - Only use for troubleshooting purposes. Requires canton.features.enable-testing-commands = yes - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.11` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.GenerateAuthenticationTokenRequest`](#type-com-digitalasset-canton-sequencer-admin-v30-generateauthenticationtokenrequest) - -**Response Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.GenerateAuthenticationTokenResponse`](#type-com-digitalasset-canton-sequencer-admin-v30-generateauthenticationtokenresponse) - - -**Endpoint `SequencerAdministrationService.OnboardingState`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto#L36) - -**Signature** - -```protobuf -rpc SequencerAdministrationService.OnboardingState(com.digitalasset.canton.sequencer.admin.v30.OnboardingStateRequest) returns (stream com.digitalasset.canton.sequencer.admin.v30.OnboardingStateResponse); -``` - -Fetch the onboarding state for a given sequencer. - the returned bytestring can be used directly to initialize the given sequencer later on - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.OnboardingStateRequest`](#type-com-digitalasset-canton-sequencer-admin-v30-onboardingstaterequest) - -**Response Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.OnboardingStateResponse`](#type-com-digitalasset-canton-sequencer-admin-v30-onboardingstateresponse) - - -**Endpoint `SequencerAdministrationService.OnboardingStateV2`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto#L40) - -**Signature** - -```protobuf -rpc SequencerAdministrationService.OnboardingStateV2(com.digitalasset.canton.sequencer.admin.v30.OnboardingStateV2Request) returns (stream com.digitalasset.canton.sequencer.admin.v30.OnboardingStateV2Response); -``` - -Fetch the onboarding state for a given sequencer. - the returned bytestring can be used directly to initialize the given sequencer later on - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.OnboardingStateV2Request`](#type-com-digitalasset-canton-sequencer-admin-v30-onboardingstatev2request) - -**Response Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.OnboardingStateV2Response`](#type-com-digitalasset-canton-sequencer-admin-v30-onboardingstatev2response) - - -**Endpoint `SequencerAdministrationService.PruningStatus`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto#L19) - -**Signature** - -```protobuf -rpc SequencerAdministrationService.PruningStatus(com.digitalasset.canton.sequencer.admin.v30.PruningStatusRequest) returns (com.digitalasset.canton.sequencer.admin.v30.PruningStatusResponse); -``` - -fetch the current status of the sequencer - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.PruningStatusRequest`](#type-com-digitalasset-canton-sequencer-admin-v30-pruningstatusrequest) - -**Response Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.PruningStatusResponse`](#type-com-digitalasset-canton-sequencer-admin-v30-pruningstatusresponse) - - -**Endpoint `SequencerAdministrationService.SetTrafficPurchased`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto#L29) - -**Signature** - -```protobuf -rpc SequencerAdministrationService.SetTrafficPurchased(com.digitalasset.canton.sequencer.admin.v30.SetTrafficPurchasedRequest) returns (com.digitalasset.canton.sequencer.admin.v30.SetTrafficPurchasedResponse); -``` - -Update the traffic purchased entry of a member - The new balance will only become valid once authorized by a quorum of sequencers of the synchronizer - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.SetTrafficPurchasedRequest`](#type-com-digitalasset-canton-sequencer-admin-v30-settrafficpurchasedrequest) - -**Response Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.SetTrafficPurchasedResponse`](#type-com-digitalasset-canton-sequencer-admin-v30-settrafficpurchasedresponse) - - -**Endpoint `SequencerAdministrationService.Snapshot`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto#L32) - -**Signature** - -```protobuf -rpc SequencerAdministrationService.Snapshot(com.digitalasset.canton.sequencer.admin.v30.SnapshotRequest) returns (com.digitalasset.canton.sequencer.admin.v30.SnapshotResponse); -``` - -fetch a snapshot of the sequencer state based on the given timestamp - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.SnapshotRequest`](#type-com-digitalasset-canton-sequencer-admin-v30-snapshotrequest) - -**Response Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.SnapshotResponse`](#type-com-digitalasset-canton-sequencer-admin-v30-snapshotresponse) - - -**Endpoint `SequencerAdministrationService.TrafficControlState`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto#L25) - -**Signature** - -```protobuf -rpc SequencerAdministrationService.TrafficControlState(com.digitalasset.canton.sequencer.admin.v30.TrafficControlStateRequest) returns (com.digitalasset.canton.sequencer.admin.v30.TrafficControlStateResponse); -``` - -Return the status of the specified members. If the list is empty, return the status of all members. - Requested members who are not registered or disabled in the Sequencer will not be in the response. - Registered members with no sent or received event will return an empty status. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.TrafficControlStateRequest`](#type-com-digitalasset-canton-sequencer-admin-v30-trafficcontrolstaterequest) - -**Response Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.TrafficControlStateResponse`](#type-com-digitalasset-canton-sequencer-admin-v30-trafficcontrolstateresponse) - - -### Service `SequencerBftAdministrationService` - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto#L8) -- Endpoints tracked: `5` - -_No description._ - -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`AddPeerEndpoint`](#endpoint-com-digitalasset-canton-sequencer-admin-v30-sequencerbftadministrationservice-addpeerendpoint) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.sequencer.admin.v30.AddPeerEndpointRequest`](#type-com-digitalasset-canton-sequencer-admin-v30-addpeerendpointrequest) | [`com.digitalasset.canton.sequencer.admin.v30.AddPeerEndpointResponse`](#type-com-digitalasset-canton-sequencer-admin-v30-addpeerendpointresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto#L9) | -| [`GetOrderingTopology`](#endpoint-com-digitalasset-canton-sequencer-admin-v30-sequencerbftadministrationservice-getorderingtopology) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.sequencer.admin.v30.GetOrderingTopologyRequest`](#type-com-digitalasset-canton-sequencer-admin-v30-getorderingtopologyrequest) | [`com.digitalasset.canton.sequencer.admin.v30.GetOrderingTopologyResponse`](#type-com-digitalasset-canton-sequencer-admin-v30-getorderingtopologyresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto#L12) | -| [`GetPeerNetworkStatus`](#endpoint-com-digitalasset-canton-sequencer-admin-v30-sequencerbftadministrationservice-getpeernetworkstatus) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.sequencer.admin.v30.GetPeerNetworkStatusRequest`](#type-com-digitalasset-canton-sequencer-admin-v30-getpeernetworkstatusrequest) | [`com.digitalasset.canton.sequencer.admin.v30.GetPeerNetworkStatusResponse`](#type-com-digitalasset-canton-sequencer-admin-v30-getpeernetworkstatusresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto#L11) | -| [`RemovePeerEndpoint`](#endpoint-com-digitalasset-canton-sequencer-admin-v30-sequencerbftadministrationservice-removepeerendpoint) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.sequencer.admin.v30.RemovePeerEndpointRequest`](#type-com-digitalasset-canton-sequencer-admin-v30-removepeerendpointrequest) | [`com.digitalasset.canton.sequencer.admin.v30.RemovePeerEndpointResponse`](#type-com-digitalasset-canton-sequencer-admin-v30-removepeerendpointresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto#L10) | -| [`SetPerformanceMetricsEnabled`](#endpoint-com-digitalasset-canton-sequencer-admin-v30-sequencerbftadministrationservice-setperformancemetricsenabled) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.sequencer.admin.v30.SetPerformanceMetricsEnabledRequest`](#type-com-digitalasset-canton-sequencer-admin-v30-setperformancemetricsenabledrequest) | [`com.digitalasset.canton.sequencer.admin.v30.SetPerformanceMetricsEnabledResponse`](#type-com-digitalasset-canton-sequencer-admin-v30-setperformancemetricsenabledresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto#L13) | - - -**Endpoint `SequencerBftAdministrationService.AddPeerEndpoint`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto#L9) - -**Signature** - -```protobuf -rpc SequencerBftAdministrationService.AddPeerEndpoint(com.digitalasset.canton.sequencer.admin.v30.AddPeerEndpointRequest) returns (com.digitalasset.canton.sequencer.admin.v30.AddPeerEndpointResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.AddPeerEndpointRequest`](#type-com-digitalasset-canton-sequencer-admin-v30-addpeerendpointrequest) - -**Response Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.AddPeerEndpointResponse`](#type-com-digitalasset-canton-sequencer-admin-v30-addpeerendpointresponse) - - -**Endpoint `SequencerBftAdministrationService.GetOrderingTopology`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto#L12) - -**Signature** - -```protobuf -rpc SequencerBftAdministrationService.GetOrderingTopology(com.digitalasset.canton.sequencer.admin.v30.GetOrderingTopologyRequest) returns (com.digitalasset.canton.sequencer.admin.v30.GetOrderingTopologyResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.GetOrderingTopologyRequest`](#type-com-digitalasset-canton-sequencer-admin-v30-getorderingtopologyrequest) - -**Response Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.GetOrderingTopologyResponse`](#type-com-digitalasset-canton-sequencer-admin-v30-getorderingtopologyresponse) - - -**Endpoint `SequencerBftAdministrationService.GetPeerNetworkStatus`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto#L11) - -**Signature** - -```protobuf -rpc SequencerBftAdministrationService.GetPeerNetworkStatus(com.digitalasset.canton.sequencer.admin.v30.GetPeerNetworkStatusRequest) returns (com.digitalasset.canton.sequencer.admin.v30.GetPeerNetworkStatusResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.GetPeerNetworkStatusRequest`](#type-com-digitalasset-canton-sequencer-admin-v30-getpeernetworkstatusrequest) - -**Response Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.GetPeerNetworkStatusResponse`](#type-com-digitalasset-canton-sequencer-admin-v30-getpeernetworkstatusresponse) - - -**Endpoint `SequencerBftAdministrationService.RemovePeerEndpoint`** -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto#L10) +
+ +
+
Source file
+
community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto
+
+ +
+
Operations
+
8
+
+ +
+ + +
+ + + + +
+

SequencerAdministrationService.DisableMember

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Disable members at the sequencer. Will prevent existing and new instances from connecting, and permit removing their data.

+ + +
+ +
+
Request
+
com.digitalasset.canton.sequencer.admin.v30.DisableMemberRequest
+
+ +
+
Response
+
com.digitalasset.canton.sequencer.admin.v30.DisableMemberResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SequencerAdministrationService.GenerateAuthenticationToken

+ +
+ + gRPC + + Since 3.4.11 + +
+ +
+ +

Generate an authentication token for a member. Only use for troubleshooting purposes. Requires canton.features.enable-testing-commands = yes

+ + +
+ +
+
Request
+
com.digitalasset.canton.sequencer.admin.v30.GenerateAuthenticationTokenRequest
+
+ +
+
Response
+
com.digitalasset.canton.sequencer.admin.v30.GenerateAuthenticationTokenResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SequencerAdministrationService.OnboardingState

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Fetch the onboarding state for a given sequencer. the returned bytestring can be used directly to initialize the given sequencer later on

+ + +
+ +
+
Request
+
com.digitalasset.canton.sequencer.admin.v30.OnboardingStateRequest
+
+ +
+
Response
+
com.digitalasset.canton.sequencer.admin.v30.OnboardingStateResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + + + + + +
+

SequencerAdministrationService.OnboardingStateV2

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Fetch the onboarding state for a given sequencer. the returned bytestring can be used directly to initialize the given sequencer later on

+ + +
+ +
+
Request
+
com.digitalasset.canton.sequencer.admin.v30.OnboardingStateV2Request
+
+ +
+
Response
+
com.digitalasset.canton.sequencer.admin.v30.OnboardingStateV2Response
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + + + + + +
+

SequencerAdministrationService.PruningStatus

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

fetch the current status of the sequencer

+ + +
+ +
+
Request
+
com.digitalasset.canton.sequencer.admin.v30.PruningStatusRequest
+
+ +
+
Response
+
com.digitalasset.canton.sequencer.admin.v30.PruningStatusResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SequencerAdministrationService.SetTrafficPurchased

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Update the traffic purchased entry of a member The new balance will only become valid once authorized by a quorum of sequencers of the synchronizer

+ + +
+ +
+
Request
+
com.digitalasset.canton.sequencer.admin.v30.SetTrafficPurchasedRequest
+
+ +
+
Response
+
com.digitalasset.canton.sequencer.admin.v30.SetTrafficPurchasedResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SequencerAdministrationService.Snapshot

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

fetch a snapshot of the sequencer state based on the given timestamp

+ + +
+ +
+
Request
+
com.digitalasset.canton.sequencer.admin.v30.SnapshotRequest
+
+ +
+
Response
+
com.digitalasset.canton.sequencer.admin.v30.SnapshotResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SequencerAdministrationService.TrafficControlState

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Return the status of the specified members. If the list is empty, return the status of all members. Requested members who are not registered or disabled in the Sequencer will no...

+ + +
+ +
+
Request
+
com.digitalasset.canton.sequencer.admin.v30.TrafficControlStateRequest
+
+ +
+
Response
+
com.digitalasset.canton.sequencer.admin.v30.TrafficControlStateResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## SequencerBftAdministrationService + + + +
+ +
+
Source file
+
community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto
+
+ +
+
Operations
+
5
+
+ +
+ + +
+ + + + +
+

SequencerBftAdministrationService.AddPeerEndpoint

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc SequencerBftAdministrationService.AddPeerEndpoint(com.digitalasset.canton.sequencer.admin.v30.AddPeerEndpointRequest) returns (com.digitalasset.canton.sequencer.admin.v30.Ad...

+ + +
+ +
+
Request
+
com.digitalasset.canton.sequencer.admin.v30.AddPeerEndpointRequest
+
+ +
+
Response
+
com.digitalasset.canton.sequencer.admin.v30.AddPeerEndpointResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SequencerBftAdministrationService.GetOrderingTopology

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc SequencerBftAdministrationService.GetOrderingTopology(com.digitalasset.canton.sequencer.admin.v30.GetOrderingTopologyRequest) returns (com.digitalasset.canton.sequencer.admi...

+ + +
+ +
+
Request
+
com.digitalasset.canton.sequencer.admin.v30.GetOrderingTopologyRequest
+
+ +
+
Response
+
com.digitalasset.canton.sequencer.admin.v30.GetOrderingTopologyResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SequencerBftAdministrationService.GetPeerNetworkStatus

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc SequencerBftAdministrationService.GetPeerNetworkStatus(com.digitalasset.canton.sequencer.admin.v30.GetPeerNetworkStatusRequest) returns (com.digitalasset.canton.sequencer.ad...

+ + +
+ +
+
Request
+
com.digitalasset.canton.sequencer.admin.v30.GetPeerNetworkStatusRequest
+
+ +
+
Response
+
com.digitalasset.canton.sequencer.admin.v30.GetPeerNetworkStatusResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SequencerBftAdministrationService.RemovePeerEndpoint

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc SequencerBftAdministrationService.RemovePeerEndpoint(com.digitalasset.canton.sequencer.admin.v30.RemovePeerEndpointRequest) returns (com.digitalasset.canton.sequencer.admin....

+ + +
+ +
+
Request
+
com.digitalasset.canton.sequencer.admin.v30.RemovePeerEndpointRequest
+
+ +
+
Response
+
com.digitalasset.canton.sequencer.admin.v30.RemovePeerEndpointResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SequencerBftAdministrationService.SetPerformanceMetricsEnabled

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc SequencerBftAdministrationService.SetPerformanceMetricsEnabled(com.digitalasset.canton.sequencer.admin.v30.SetPerformanceMetricsEnabledRequest) returns (com.digitalasset.can...

+ + +
+ +
+
Request
+
com.digitalasset.canton.sequencer.admin.v30.SetPerformanceMetricsEnabledRequest
+
+ +
+
Response
+
com.digitalasset.canton.sequencer.admin.v30.SetPerformanceMetricsEnabledResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## SequencerBftPruningAdministrationService + + + +
+ +
+
Source file
+
community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto
+
+ +
+
Operations
+
11
+
+ +
+ + +
+ + + + +
+

SequencerBftPruningAdministrationService.BftPrune

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc SequencerBftPruningAdministrationService.BftPrune(com.digitalasset.canton.sequencer.admin.v30.BftPruneRequest) returns (com.digitalasset.canton.sequencer.admin.v30.BftPruneR...

+ + +
+ +
+
Request
+
com.digitalasset.canton.sequencer.admin.v30.BftPruneRequest
+
+ +
+
Response
+
com.digitalasset.canton.sequencer.admin.v30.BftPruneResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SequencerBftPruningAdministrationService.BftPruningStatus

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc SequencerBftPruningAdministrationService.BftPruningStatus(com.digitalasset.canton.sequencer.admin.v30.BftPruningStatusRequest) returns (com.digitalasset.canton.sequencer.adm...

+ + +
+ +
+
Request
+
com.digitalasset.canton.sequencer.admin.v30.BftPruningStatusRequest
+
+ +
+
Response
+
com.digitalasset.canton.sequencer.admin.v30.BftPruningStatusResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SequencerBftPruningAdministrationService.ClearSchedule

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Disable automatic pruning and remove the persisted schedule configuration.

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.pruning.v30.ClearScheduleRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.pruning.v30.ClearScheduleResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SequencerBftPruningAdministrationService.GetBftSchedule

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Retrieve the automatic, bft-orderer-specific pruning configuration.

+ + +
+ +
+
Request
+
com.digitalasset.canton.sequencer.admin.v30.GetBftScheduleRequest
+
+ +
+
Response
+
com.digitalasset.canton.sequencer.admin.v30.GetBftScheduleResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SequencerBftPruningAdministrationService.GetSchedule

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Retrieve the automatic pruning configuration.

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.pruning.v30.GetScheduleRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.pruning.v30.GetScheduleResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SequencerBftPruningAdministrationService.SetBftSchedule

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Enable automatic pruning with bft-orderer-specific schedule parameters.

+ + +
+ +
+
Request
+
com.digitalasset.canton.sequencer.admin.v30.SetBftScheduleRequest
+
+ +
+
Response
+
com.digitalasset.canton.sequencer.admin.v30.SetBftScheduleResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SequencerBftPruningAdministrationService.SetCron

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Modify individual pruning schedule parameters. - ``INVALID_ARGUMENT``: if the payload is malformed or no schedule is configured

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.pruning.v30.SetCronRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.pruning.v30.SetCronResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SequencerBftPruningAdministrationService.SetMaxDuration

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc SequencerBftPruningAdministrationService.SetMaxDuration(com.digitalasset.canton.admin.pruning.v30.SetMaxDurationRequest) returns (com.digitalasset.canton.admin.pruning.v30.S...

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.pruning.v30.SetMaxDurationRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.pruning.v30.SetMaxDurationResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SequencerBftPruningAdministrationService.SetMinBlocksToKeep

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Min blocks to keep is a bft-orderer-specific pruning parameter.

+ + +
+ +
+
Request
+
com.digitalasset.canton.sequencer.admin.v30.SetMinBlocksToKeepRequest
+
+ +
+
Response
+
com.digitalasset.canton.sequencer.admin.v30.SetMinBlocksToKeepResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SequencerBftPruningAdministrationService.SetRetention

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc SequencerBftPruningAdministrationService.SetRetention(com.digitalasset.canton.admin.pruning.v30.SetRetentionRequest) returns (com.digitalasset.canton.admin.pruning.v30.SetRe...

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.pruning.v30.SetRetentionRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.pruning.v30.SetRetentionResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SequencerBftPruningAdministrationService.SetSchedule

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Enable automatic pruning using the specified schedule parameters The following errors may occur on the SetSchedule or Update commands: - ``INVALID_ARGUMENT``: if a parameter is...

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.pruning.v30.SetScheduleRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.pruning.v30.SetScheduleResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## SequencerInitializationService -**Signature** -```protobuf -rpc SequencerBftAdministrationService.RemovePeerEndpoint(com.digitalasset.canton.sequencer.admin.v30.RemovePeerEndpointRequest) returns (com.digitalasset.canton.sequencer.admin.v30.RemovePeerEndpointResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.RemovePeerEndpointRequest`](#type-com-digitalasset-canton-sequencer-admin-v30-removepeerendpointrequest) - -**Response Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.RemovePeerEndpointResponse`](#type-com-digitalasset-canton-sequencer-admin-v30-removepeerendpointresponse) - - -**Endpoint `SequencerBftAdministrationService.SetPerformanceMetricsEnabled`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto#L13) - -**Signature** - -```protobuf -rpc SequencerBftAdministrationService.SetPerformanceMetricsEnabled(com.digitalasset.canton.sequencer.admin.v30.SetPerformanceMetricsEnabledRequest) returns (com.digitalasset.canton.sequencer.admin.v30.SetPerformanceMetricsEnabledResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.SetPerformanceMetricsEnabledRequest`](#type-com-digitalasset-canton-sequencer-admin-v30-setperformancemetricsenabledrequest) - -**Response Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.SetPerformanceMetricsEnabledResponse`](#type-com-digitalasset-canton-sequencer-admin-v30-setperformancemetricsenabledresponse) - - -### Service `SequencerBftPruningAdministrationService` - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto#L12) -- Endpoints tracked: `11` - -_No description._ - -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`BftPrune`](#endpoint-com-digitalasset-canton-sequencer-admin-v30-sequencerbftpruningadministrationservice-bftprune) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.sequencer.admin.v30.BftPruneRequest`](#type-com-digitalasset-canton-sequencer-admin-v30-bftprunerequest) | [`com.digitalasset.canton.sequencer.admin.v30.BftPruneResponse`](#type-com-digitalasset-canton-sequencer-admin-v30-bftpruneresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto#L15) | -| [`BftPruningStatus`](#endpoint-com-digitalasset-canton-sequencer-admin-v30-sequencerbftpruningadministrationservice-bftpruningstatus) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.sequencer.admin.v30.BftPruningStatusRequest`](#type-com-digitalasset-canton-sequencer-admin-v30-bftpruningstatusrequest) | [`com.digitalasset.canton.sequencer.admin.v30.BftPruningStatusResponse`](#type-com-digitalasset-canton-sequencer-admin-v30-bftpruningstatusresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto#L13) | -| [`ClearSchedule`](#endpoint-com-digitalasset-canton-sequencer-admin-v30-sequencerbftpruningadministrationservice-clearschedule) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.pruning.v30.ClearScheduleRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-clearschedulerequest) | [`com.digitalasset.canton.admin.pruning.v30.ClearScheduleResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-clearscheduleresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto#L31) | -| [`GetBftSchedule`](#endpoint-com-digitalasset-canton-sequencer-admin-v30-sequencerbftpruningadministrationservice-getbftschedule) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.sequencer.admin.v30.GetBftScheduleRequest`](#type-com-digitalasset-canton-sequencer-admin-v30-getbftschedulerequest) | [`com.digitalasset.canton.sequencer.admin.v30.GetBftScheduleResponse`](#type-com-digitalasset-canton-sequencer-admin-v30-getbftscheduleresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto#L36) | -| [`GetSchedule`](#endpoint-com-digitalasset-canton-sequencer-admin-v30-sequencerbftpruningadministrationservice-getschedule) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.pruning.v30.GetScheduleRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-getschedulerequest) | [`com.digitalasset.canton.admin.pruning.v30.GetScheduleResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-getscheduleresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto#L33) | -| [`SetBftSchedule`](#endpoint-com-digitalasset-canton-sequencer-admin-v30-sequencerbftpruningadministrationservice-setbftschedule) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.sequencer.admin.v30.SetBftScheduleRequest`](#type-com-digitalasset-canton-sequencer-admin-v30-setbftschedulerequest) | [`com.digitalasset.canton.sequencer.admin.v30.SetBftScheduleResponse`](#type-com-digitalasset-canton-sequencer-admin-v30-setbftscheduleresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto#L23) | -| [`SetCron`](#endpoint-com-digitalasset-canton-sequencer-admin-v30-sequencerbftpruningadministrationservice-setcron) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.pruning.v30.SetCronRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setcronrequest) | [`com.digitalasset.canton.admin.pruning.v30.SetCronResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setcronresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto#L27) | -| [`SetMaxDuration`](#endpoint-com-digitalasset-canton-sequencer-admin-v30-sequencerbftpruningadministrationservice-setmaxduration) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.pruning.v30.SetMaxDurationRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setmaxdurationrequest) | [`com.digitalasset.canton.admin.pruning.v30.SetMaxDurationResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setmaxdurationresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto#L28) | -| [`SetMinBlocksToKeep`](#endpoint-com-digitalasset-canton-sequencer-admin-v30-sequencerbftpruningadministrationservice-setminblockstokeep) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.sequencer.admin.v30.SetMinBlocksToKeepRequest`](#type-com-digitalasset-canton-sequencer-admin-v30-setminblockstokeeprequest) | [`com.digitalasset.canton.sequencer.admin.v30.SetMinBlocksToKeepResponse`](#type-com-digitalasset-canton-sequencer-admin-v30-setminblockstokeepresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto#L39) | -| [`SetRetention`](#endpoint-com-digitalasset-canton-sequencer-admin-v30-sequencerbftpruningadministrationservice-setretention) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.pruning.v30.SetRetentionRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setretentionrequest) | [`com.digitalasset.canton.admin.pruning.v30.SetRetentionResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setretentionresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto#L29) | -| [`SetSchedule`](#endpoint-com-digitalasset-canton-sequencer-admin-v30-sequencerbftpruningadministrationservice-setschedule) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.pruning.v30.SetScheduleRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setschedulerequest) | [`com.digitalasset.canton.admin.pruning.v30.SetScheduleResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setscheduleresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto#L20) | - - -**Endpoint `SequencerBftPruningAdministrationService.BftPrune`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto#L15) - -**Signature** - -```protobuf -rpc SequencerBftPruningAdministrationService.BftPrune(com.digitalasset.canton.sequencer.admin.v30.BftPruneRequest) returns (com.digitalasset.canton.sequencer.admin.v30.BftPruneResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.BftPruneRequest`](#type-com-digitalasset-canton-sequencer-admin-v30-bftprunerequest) - -**Response Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.BftPruneResponse`](#type-com-digitalasset-canton-sequencer-admin-v30-bftpruneresponse) - - -**Endpoint `SequencerBftPruningAdministrationService.BftPruningStatus`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto#L13) - -**Signature** - -```protobuf -rpc SequencerBftPruningAdministrationService.BftPruningStatus(com.digitalasset.canton.sequencer.admin.v30.BftPruningStatusRequest) returns (com.digitalasset.canton.sequencer.admin.v30.BftPruningStatusResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.BftPruningStatusRequest`](#type-com-digitalasset-canton-sequencer-admin-v30-bftpruningstatusrequest) - -**Response Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.BftPruningStatusResponse`](#type-com-digitalasset-canton-sequencer-admin-v30-bftpruningstatusresponse) - - -**Endpoint `SequencerBftPruningAdministrationService.ClearSchedule`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto#L31) - -**Signature** - -```protobuf -rpc SequencerBftPruningAdministrationService.ClearSchedule(com.digitalasset.canton.admin.pruning.v30.ClearScheduleRequest) returns (com.digitalasset.canton.admin.pruning.v30.ClearScheduleResponse); -``` - -Disable automatic pruning and remove the persisted schedule configuration. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.pruning.v30.ClearScheduleRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-clearschedulerequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.pruning.v30.ClearScheduleResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-clearscheduleresponse) - - -**Endpoint `SequencerBftPruningAdministrationService.GetBftSchedule`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto#L36) - -**Signature** - -```protobuf -rpc SequencerBftPruningAdministrationService.GetBftSchedule(com.digitalasset.canton.sequencer.admin.v30.GetBftScheduleRequest) returns (com.digitalasset.canton.sequencer.admin.v30.GetBftScheduleResponse); -``` - -Retrieve the automatic, bft-orderer-specific pruning configuration. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.GetBftScheduleRequest`](#type-com-digitalasset-canton-sequencer-admin-v30-getbftschedulerequest) - -**Response Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.GetBftScheduleResponse`](#type-com-digitalasset-canton-sequencer-admin-v30-getbftscheduleresponse) - - -**Endpoint `SequencerBftPruningAdministrationService.GetSchedule`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto#L33) - -**Signature** - -```protobuf -rpc SequencerBftPruningAdministrationService.GetSchedule(com.digitalasset.canton.admin.pruning.v30.GetScheduleRequest) returns (com.digitalasset.canton.admin.pruning.v30.GetScheduleResponse); -``` - -Retrieve the automatic pruning configuration. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.pruning.v30.GetScheduleRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-getschedulerequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.pruning.v30.GetScheduleResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-getscheduleresponse) - - -**Endpoint `SequencerBftPruningAdministrationService.SetBftSchedule`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto#L23) - -**Signature** - -```protobuf -rpc SequencerBftPruningAdministrationService.SetBftSchedule(com.digitalasset.canton.sequencer.admin.v30.SetBftScheduleRequest) returns (com.digitalasset.canton.sequencer.admin.v30.SetBftScheduleResponse); -``` - -Enable automatic pruning with bft-orderer-specific schedule parameters. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.SetBftScheduleRequest`](#type-com-digitalasset-canton-sequencer-admin-v30-setbftschedulerequest) - -**Response Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.SetBftScheduleResponse`](#type-com-digitalasset-canton-sequencer-admin-v30-setbftscheduleresponse) - - -**Endpoint `SequencerBftPruningAdministrationService.SetCron`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto#L27) - -**Signature** - -```protobuf -rpc SequencerBftPruningAdministrationService.SetCron(com.digitalasset.canton.admin.pruning.v30.SetCronRequest) returns (com.digitalasset.canton.admin.pruning.v30.SetCronResponse); -``` - -Modify individual pruning schedule parameters. - - ``INVALID_ARGUMENT``: if the payload is malformed or no schedule is configured - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.pruning.v30.SetCronRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setcronrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.pruning.v30.SetCronResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setcronresponse) - - -**Endpoint `SequencerBftPruningAdministrationService.SetMaxDuration`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto#L28) - -**Signature** - -```protobuf -rpc SequencerBftPruningAdministrationService.SetMaxDuration(com.digitalasset.canton.admin.pruning.v30.SetMaxDurationRequest) returns (com.digitalasset.canton.admin.pruning.v30.SetMaxDurationResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.pruning.v30.SetMaxDurationRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setmaxdurationrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.pruning.v30.SetMaxDurationResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setmaxdurationresponse) - - -**Endpoint `SequencerBftPruningAdministrationService.SetMinBlocksToKeep`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto#L39) - -**Signature** - -```protobuf -rpc SequencerBftPruningAdministrationService.SetMinBlocksToKeep(com.digitalasset.canton.sequencer.admin.v30.SetMinBlocksToKeepRequest) returns (com.digitalasset.canton.sequencer.admin.v30.SetMinBlocksToKeepResponse); -``` - -Min blocks to keep is a bft-orderer-specific pruning parameter. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.SetMinBlocksToKeepRequest`](#type-com-digitalasset-canton-sequencer-admin-v30-setminblockstokeeprequest) - -**Response Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.SetMinBlocksToKeepResponse`](#type-com-digitalasset-canton-sequencer-admin-v30-setminblockstokeepresponse) - - -**Endpoint `SequencerBftPruningAdministrationService.SetRetention`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto#L29) - -**Signature** - -```protobuf -rpc SequencerBftPruningAdministrationService.SetRetention(com.digitalasset.canton.admin.pruning.v30.SetRetentionRequest) returns (com.digitalasset.canton.admin.pruning.v30.SetRetentionResponse); -``` - -_No description._ +Service allowing a sequencer node to initialize the sequencer instance. + Should typically only be exposed to the sequencer node and not all clients -**History** -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | +
+ +
+
Source file
+
community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_service.proto
+
+ +
+
Operations
+
5
+
+ +
+ + +
+ + + + +
+

SequencerInitializationService.InitializeSequencerFromGenesisState

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Initialize the Sequencer If the sequencer has not been previously initialized the request must either fail or start the sequencer and return successfully. The synchronizer will...

+ + +
+ +
+
Request
+
com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromGenesisStateRequest
+
+ +
+
Response
+
com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromGenesisStateResponse
+
+ +
+
Client stream
+
Yes
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SequencerInitializationService.InitializeSequencerFromGenesisStateV2

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc SequencerInitializationService.InitializeSequencerFromGenesisStateV2(stream com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromGenesisStateV2Request) returns...

+ + +
+ +
+
Request
+
com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromGenesisStateV2Request
+
+ +
+
Response
+
com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromGenesisStateV2Response
+
+ +
+
Client stream
+
Yes
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SequencerInitializationService.InitializeSequencerFromOnboardingState

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc SequencerInitializationService.InitializeSequencerFromOnboardingState(stream com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromOnboardingStateRequest) retur...

+ + +
+ +
+
Request
+
com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromOnboardingStateRequest
+
+ +
+
Response
+
com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromOnboardingStateResponse
+
+ +
+
Client stream
+
Yes
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SequencerInitializationService.InitializeSequencerFromOnboardingStateV2

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc SequencerInitializationService.InitializeSequencerFromOnboardingStateV2(stream com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromOnboardingStateV2Request) r...

+ + +
+ +
+
Request
+
com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromOnboardingStateV2Request
+
+ +
+
Response
+
com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromOnboardingStateV2Response
+
+ +
+
Client stream
+
Yes
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SequencerInitializationService.InitializeSequencerFromPredecessor

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc SequencerInitializationService.InitializeSequencerFromPredecessor(stream com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromPredecessorRequest) returns (com....

+ + +
+ +
+
Request
+
com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromPredecessorRequest
+
+ +
+
Response
+
com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromPredecessorResponse
+
+ +
+
Client stream
+
Yes
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## SequencerPruningAdministrationService -**Request Type** - -- [`com.digitalasset.canton.admin.pruning.v30.SetRetentionRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setretentionrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.pruning.v30.SetRetentionResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setretentionresponse) - - -**Endpoint `SequencerBftPruningAdministrationService.SetSchedule`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto#L20) - -**Signature** - -```protobuf -rpc SequencerBftPruningAdministrationService.SetSchedule(com.digitalasset.canton.admin.pruning.v30.SetScheduleRequest) returns (com.digitalasset.canton.admin.pruning.v30.SetScheduleResponse); -``` - -Enable automatic pruning using the specified schedule parameters - The following errors may occur on the SetSchedule or Update commands: - - ``INVALID_ARGUMENT``: if a parameter is missing or an invalid cron expression or duration is passed. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.pruning.v30.SetScheduleRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setschedulerequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.pruning.v30.SetScheduleResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setscheduleresponse) - - -### Service `SequencerInitializationService` - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_service.proto#L12) -- Endpoints tracked: `5` - -Service allowing a sequencer node to initialize the sequencer instance. - Should typically only be exposed to the sequencer node and not all clients - -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`InitializeSequencerFromGenesisState`](#endpoint-com-digitalasset-canton-sequencer-admin-v30-sequencerinitializationservice-initializesequencerfromgenesisstate) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromGenesisStateRequest`](#type-com-digitalasset-canton-sequencer-admin-v30-initializesequencerfromgenesisstaterequest) | [`com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromGenesisStateResponse`](#type-com-digitalasset-canton-sequencer-admin-v30-initializesequencerfromgenesisstateresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_service.proto#L19) | -| [`InitializeSequencerFromGenesisStateV2`](#endpoint-com-digitalasset-canton-sequencer-admin-v30-sequencerinitializationservice-initializesequencerfromgenesisstatev2) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromGenesisStateV2Request`](#type-com-digitalasset-canton-sequencer-admin-v30-initializesequencerfromgenesisstatev2request) | [`com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromGenesisStateV2Response`](#type-com-digitalasset-canton-sequencer-admin-v30-initializesequencerfromgenesisstatev2response) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_service.proto#L23) | -| [`InitializeSequencerFromOnboardingState`](#endpoint-com-digitalasset-canton-sequencer-admin-v30-sequencerinitializationservice-initializesequencerfromonboardingstate) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromOnboardingStateRequest`](#type-com-digitalasset-canton-sequencer-admin-v30-initializesequencerfromonboardingstaterequest) | [`com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromOnboardingStateResponse`](#type-com-digitalasset-canton-sequencer-admin-v30-initializesequencerfromonboardingstateresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_service.proto#L20) | -| [`InitializeSequencerFromOnboardingStateV2`](#endpoint-com-digitalasset-canton-sequencer-admin-v30-sequencerinitializationservice-initializesequencerfromonboardingstatev2) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromOnboardingStateV2Request`](#type-com-digitalasset-canton-sequencer-admin-v30-initializesequencerfromonboardingstatev2request) | [`com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromOnboardingStateV2Response`](#type-com-digitalasset-canton-sequencer-admin-v30-initializesequencerfromonboardingstatev2response) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_service.proto#L24) | -| [`InitializeSequencerFromPredecessor`](#endpoint-com-digitalasset-canton-sequencer-admin-v30-sequencerinitializationservice-initializesequencerfrompredecessor) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromPredecessorRequest`](#type-com-digitalasset-canton-sequencer-admin-v30-initializesequencerfrompredecessorrequest) | [`com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromPredecessorResponse`](#type-com-digitalasset-canton-sequencer-admin-v30-initializesequencerfrompredecessorresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_service.proto#L21) | - - -**Endpoint `SequencerInitializationService.InitializeSequencerFromGenesisState`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_service.proto#L19) - -**Signature** - -```protobuf -rpc SequencerInitializationService.InitializeSequencerFromGenesisState(stream com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromGenesisStateRequest) returns (com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromGenesisStateResponse); -``` - -Initialize the Sequencer - If the sequencer has not been previously initialized the request must either fail or start the sequencer and return successfully. - The synchronizer will expect the SequencerService to be fully available when it receives a successful response - and will immediately attempt to use it. - If the request is received after the sequencer has been successfully initialized it should return successfully - if the synchronizer_id matches the synchronizer that the sequencer has been initialized for, otherwise it should fail. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromGenesisStateRequest`](#type-com-digitalasset-canton-sequencer-admin-v30-initializesequencerfromgenesisstaterequest) - -**Response Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromGenesisStateResponse`](#type-com-digitalasset-canton-sequencer-admin-v30-initializesequencerfromgenesisstateresponse) - - -**Endpoint `SequencerInitializationService.InitializeSequencerFromGenesisStateV2`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_service.proto#L23) - -**Signature** - -```protobuf -rpc SequencerInitializationService.InitializeSequencerFromGenesisStateV2(stream com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromGenesisStateV2Request) returns (com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromGenesisStateV2Response); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromGenesisStateV2Request`](#type-com-digitalasset-canton-sequencer-admin-v30-initializesequencerfromgenesisstatev2request) - -**Response Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromGenesisStateV2Response`](#type-com-digitalasset-canton-sequencer-admin-v30-initializesequencerfromgenesisstatev2response) - - -**Endpoint `SequencerInitializationService.InitializeSequencerFromOnboardingState`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_service.proto#L20) - -**Signature** - -```protobuf -rpc SequencerInitializationService.InitializeSequencerFromOnboardingState(stream com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromOnboardingStateRequest) returns (com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromOnboardingStateResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromOnboardingStateRequest`](#type-com-digitalasset-canton-sequencer-admin-v30-initializesequencerfromonboardingstaterequest) - -**Response Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromOnboardingStateResponse`](#type-com-digitalasset-canton-sequencer-admin-v30-initializesequencerfromonboardingstateresponse) - - -**Endpoint `SequencerInitializationService.InitializeSequencerFromOnboardingStateV2`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_service.proto#L24) - -**Signature** - -```protobuf -rpc SequencerInitializationService.InitializeSequencerFromOnboardingStateV2(stream com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromOnboardingStateV2Request) returns (com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromOnboardingStateV2Response); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromOnboardingStateV2Request`](#type-com-digitalasset-canton-sequencer-admin-v30-initializesequencerfromonboardingstatev2request) - -**Response Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromOnboardingStateV2Response`](#type-com-digitalasset-canton-sequencer-admin-v30-initializesequencerfromonboardingstatev2response) - - -**Endpoint `SequencerInitializationService.InitializeSequencerFromPredecessor`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_service.proto#L21) - -**Signature** - -```protobuf -rpc SequencerInitializationService.InitializeSequencerFromPredecessor(stream com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromPredecessorRequest) returns (com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromPredecessorResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromPredecessorRequest`](#type-com-digitalasset-canton-sequencer-admin-v30-initializesequencerfrompredecessorrequest) - -**Response Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromPredecessorResponse`](#type-com-digitalasset-canton-sequencer-admin-v30-initializesequencerfrompredecessorresponse) - - -### Service `SequencerPruningAdministrationService` - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_pruning_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_pruning_administration_service.proto#L12) -- Endpoints tracked: `8` administration service for enterprise feature supporting sequencer instances -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`ClearSchedule`](#endpoint-com-digitalasset-canton-sequencer-admin-v30-sequencerpruningadministrationservice-clearschedule) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.pruning.v30.ClearScheduleRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-clearschedulerequest) | [`com.digitalasset.canton.admin.pruning.v30.ClearScheduleResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-clearscheduleresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_pruning_administration_service.proto#L31) | -| [`FindPruningTimestamp`](#endpoint-com-digitalasset-canton-sequencer-admin-v30-sequencerpruningadministrationservice-findpruningtimestamp) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.pruning.v30.FindPruningTimestampRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-findpruningtimestamprequest) | [`com.digitalasset.canton.admin.pruning.v30.FindPruningTimestampResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-findpruningtimestampresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_pruning_administration_service.proto#L37) | -| [`GetSchedule`](#endpoint-com-digitalasset-canton-sequencer-admin-v30-sequencerpruningadministrationservice-getschedule) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.pruning.v30.GetScheduleRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-getschedulerequest) | [`com.digitalasset.canton.admin.pruning.v30.GetScheduleResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-getscheduleresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_pruning_administration_service.proto#L34) | -| [`Prune`](#endpoint-com-digitalasset-canton-sequencer-admin-v30-sequencerpruningadministrationservice-prune) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.sequencer.admin.v30.PruneRequest`](#type-com-digitalasset-canton-sequencer-admin-v30-prunerequest) | [`com.digitalasset.canton.sequencer.admin.v30.PruneResponse`](#type-com-digitalasset-canton-sequencer-admin-v30-pruneresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_pruning_administration_service.proto#L14) | -| [`SetCron`](#endpoint-com-digitalasset-canton-sequencer-admin-v30-sequencerpruningadministrationservice-setcron) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.pruning.v30.SetCronRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setcronrequest) | [`com.digitalasset.canton.admin.pruning.v30.SetCronResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setcronresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_pruning_administration_service.proto#L26) | -| [`SetMaxDuration`](#endpoint-com-digitalasset-canton-sequencer-admin-v30-sequencerpruningadministrationservice-setmaxduration) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.pruning.v30.SetMaxDurationRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setmaxdurationrequest) | [`com.digitalasset.canton.admin.pruning.v30.SetMaxDurationResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setmaxdurationresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_pruning_administration_service.proto#L27) | -| [`SetRetention`](#endpoint-com-digitalasset-canton-sequencer-admin-v30-sequencerpruningadministrationservice-setretention) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.pruning.v30.SetRetentionRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setretentionrequest) | [`com.digitalasset.canton.admin.pruning.v30.SetRetentionResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setretentionresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_pruning_administration_service.proto#L28) | -| [`SetSchedule`](#endpoint-com-digitalasset-canton-sequencer-admin-v30-sequencerpruningadministrationservice-setschedule) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.admin.pruning.v30.SetScheduleRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setschedulerequest) | [`com.digitalasset.canton.admin.pruning.v30.SetScheduleResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setscheduleresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_pruning_administration_service.proto#L22) | - - -**Endpoint `SequencerPruningAdministrationService.ClearSchedule`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_pruning_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_pruning_administration_service.proto#L31) - -**Signature** - -```protobuf -rpc SequencerPruningAdministrationService.ClearSchedule(com.digitalasset.canton.admin.pruning.v30.ClearScheduleRequest) returns (com.digitalasset.canton.admin.pruning.v30.ClearScheduleResponse); -``` - -Disable automatic pruning and remove the persisted schedule configuration. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.pruning.v30.ClearScheduleRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-clearschedulerequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.pruning.v30.ClearScheduleResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-clearscheduleresponse) - - -**Endpoint `SequencerPruningAdministrationService.FindPruningTimestamp`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_pruning_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_pruning_administration_service.proto#L37) - -**Signature** - -```protobuf -rpc SequencerPruningAdministrationService.FindPruningTimestamp(com.digitalasset.canton.admin.pruning.v30.FindPruningTimestampRequest) returns (com.digitalasset.canton.admin.pruning.v30.FindPruningTimestampResponse); -``` - -Retrieve pruning timestamp at or near the "beginning" of events. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.pruning.v30.FindPruningTimestampRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-findpruningtimestamprequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.pruning.v30.FindPruningTimestampResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-findpruningtimestampresponse) - - -**Endpoint `SequencerPruningAdministrationService.GetSchedule`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_pruning_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_pruning_administration_service.proto#L34) - -**Signature** - -```protobuf -rpc SequencerPruningAdministrationService.GetSchedule(com.digitalasset.canton.admin.pruning.v30.GetScheduleRequest) returns (com.digitalasset.canton.admin.pruning.v30.GetScheduleResponse); -``` - -Retrieve the automatic pruning configuration. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.pruning.v30.GetScheduleRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-getschedulerequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.pruning.v30.GetScheduleResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-getscheduleresponse) - - -**Endpoint `SequencerPruningAdministrationService.Prune`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_pruning_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_pruning_administration_service.proto#L14) - -**Signature** - -```protobuf -rpc SequencerPruningAdministrationService.Prune(com.digitalasset.canton.sequencer.admin.v30.PruneRequest) returns (com.digitalasset.canton.sequencer.admin.v30.PruneResponse); -``` - -Remove data from the Sequencer - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.PruneRequest`](#type-com-digitalasset-canton-sequencer-admin-v30-prunerequest) - -**Response Type** - -- [`com.digitalasset.canton.sequencer.admin.v30.PruneResponse`](#type-com-digitalasset-canton-sequencer-admin-v30-pruneresponse) - - -**Endpoint `SequencerPruningAdministrationService.SetCron`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_pruning_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_pruning_administration_service.proto#L26) - -**Signature** - -```protobuf -rpc SequencerPruningAdministrationService.SetCron(com.digitalasset.canton.admin.pruning.v30.SetCronRequest) returns (com.digitalasset.canton.admin.pruning.v30.SetCronResponse); -``` - -Modify individual pruning schedule parameters. - - ``INVALID_ARGUMENT``: if the payload is malformed or no schedule is configured - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.pruning.v30.SetCronRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setcronrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.pruning.v30.SetCronResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setcronresponse) - - -**Endpoint `SequencerPruningAdministrationService.SetMaxDuration`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_pruning_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_pruning_administration_service.proto#L27) - -**Signature** - -```protobuf -rpc SequencerPruningAdministrationService.SetMaxDuration(com.digitalasset.canton.admin.pruning.v30.SetMaxDurationRequest) returns (com.digitalasset.canton.admin.pruning.v30.SetMaxDurationResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.pruning.v30.SetMaxDurationRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setmaxdurationrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.pruning.v30.SetMaxDurationResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setmaxdurationresponse) - - -**Endpoint `SequencerPruningAdministrationService.SetRetention`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_pruning_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_pruning_administration_service.proto#L28) - -**Signature** - -```protobuf -rpc SequencerPruningAdministrationService.SetRetention(com.digitalasset.canton.admin.pruning.v30.SetRetentionRequest) returns (com.digitalasset.canton.admin.pruning.v30.SetRetentionResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.pruning.v30.SetRetentionRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setretentionrequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.pruning.v30.SetRetentionResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setretentionresponse) - - -**Endpoint `SequencerPruningAdministrationService.SetSchedule`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_pruning_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_pruning_administration_service.proto#L22) - -**Signature** - -```protobuf -rpc SequencerPruningAdministrationService.SetSchedule(com.digitalasset.canton.admin.pruning.v30.SetScheduleRequest) returns (com.digitalasset.canton.admin.pruning.v30.SetScheduleResponse); -``` - -Enable automatic pruning using the specified schedule parameters - The following errors may occur on the SetSchedule or Update commands: - - ``INVALID_ARGUMENT``: if a parameter is missing or an invalid cron expression - or duration. - - ``FAILED_PRECONDITION``: if automatic background pruning has not been enabled - or if invoked on a participant running the Community Edition. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.admin.pruning.v30.SetScheduleRequest`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setschedulerequest) - -**Response Type** - -- [`com.digitalasset.canton.admin.pruning.v30.SetScheduleResponse`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-setscheduleresponse) - -## Type Reference - - -**Message `com.digitalasset.canton.sequencer.admin.v30.AddPeerEndpointRequest`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto#L16) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| endpoint | [`com.digitalasset.canton.sequencer.admin.v30.PeerEndpoint`](#type-com-digitalasset-canton-sequencer-admin-v30-peerendpoint) | optional | | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.AddPeerEndpointResponse`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto#L51) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| added | `bool` | optional | False if already present | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.Authenticated`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto#L60) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| sequencer_id | `string` | optional | | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.BftOrdererPruningSchedule`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto#L63) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| schedule | [`com.digitalasset.canton.admin.pruning.v30.PruningSchedule`](com-digitalasset-canton-admin-pruning-v30#type-com-digitalasset-canton-admin-pruning-v30-pruningschedule) | optional | | -| min_blocks_to_keep | `int32` | optional | | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.BftPruneRequest`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto#L42) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| retention | `google.protobuf.Duration` | optional | | -| min_blocks_to_keep | `int32` | optional | | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.BftPruneResponse`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto#L47) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| message | `string` | optional | | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.BftPruningStatusRequest`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto#L51) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.sequencer.admin.v30.BftPruningStatusResponse`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto#L52) -- Fields: 5 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| latest_block_epoch | `int64` | optional | | -| latest_block | `int64` | optional | | -| latest_block_timestamp | `google.protobuf.Timestamp` | optional | | -| lower_bound_epoch | `int64` | optional | | -| lower_bound_block | `int64` | optional | | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.BftSequencerSnapshotAdditionalInfo`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_additional_snapshot_info.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_additional_snapshot_info.proto#L10) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| sequencers_active_at | `map` | repeated | State transfer metadata for onboarding | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.BftSequencerSnapshotAdditionalInfo.SequencerActiveAt`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_additional_snapshot_info.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_additional_snapshot_info.proto#L14) -- Fields: 8 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| timestamp | `int64` | optional | Onboarding topology activation timestamp (in microseconds of UTC time since Unix epoch) | -| start_epoch_number | `int64` | optional | An epoch where the onboarding transaction became effective, used as state transfer start epoch | -| first_block_number_in_start_epoch | `int64` | optional | Needed to properly set the initial block in the Output module (due to transferring full epochs) | -| start_epoch_topology_query_timestamp | `int64` | optional | A topology query timestamp for the state transfer start epoch | -| start_epoch_could_alter_ordering_topology | `bool` | optional | Needed for emitting topology ticks consistently | -| previous_bft_time | `int64` | optional | BFT time of the last block in the previous epoch (in microseconds of UTC time since Unix epoch) | -| previous_epoch_topology_query_timestamp | `int64` | optional | A topology query timestamp for an epoch previous to the state transfer start epoch
Used for canonical commit set verification | -| leader_selection_policy_state | `bytes` | optional | Leader Selection Policy State at the start of epoch_number | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.BlacklistLeaderSelectionPolicyState`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_additional_snapshot_info.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_additional_snapshot_info.proto#L35) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| epoch_number | `int64` | optional | | -| start_block_number | `int64` | optional | | -| blacklist | `map` | repeated | | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.BlacklistLeaderSelectionPolicyState.BlacklistStatus`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_additional_snapshot_info.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_additional_snapshot_info.proto#L41) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| on_trial | [`com.digitalasset.canton.sequencer.admin.v30.BlacklistLeaderSelectionPolicyState.BlacklistStatus.OnTrial`](#type-com-digitalasset-canton-sequencer-admin-v30-blacklistleaderselectionpolicystate-blackliststatus-ontrial) | optional | | -| blacklisted | [`com.digitalasset.canton.sequencer.admin.v30.BlacklistLeaderSelectionPolicyState.BlacklistStatus.Blacklisted`](#type-com-digitalasset-canton-sequencer-admin-v30-blacklistleaderselectionpolicystate-blackliststatus-blacklisted) | optional | | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.BlacklistLeaderSelectionPolicyState.BlacklistStatus.OnTrial`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_additional_snapshot_info.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_additional_snapshot_info.proto#L47) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| failed_attempts_before_trial | `int64` | optional | | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.BlacklistLeaderSelectionPolicyState.BlacklistStatus.Blacklisted`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_additional_snapshot_info.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_additional_snapshot_info.proto#L51) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| failed_attempts_before | `int64` | optional | | -| epochs_left_until_new_trial | `int64` | optional | | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.DisableMemberRequest`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto#L181) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| member | `string` | optional | | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.DisableMemberResponse`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto#L185) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.sequencer.admin.v30.GenerateAuthenticationTokenRequest`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto#L50) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| member | `string` | optional | Member for which the token is valid | -| expires_in | `google.protobuf.Duration` | optional | Duration after which the token will expire.
If unset, the maxTokenExpirationInterval configured on the sequencer will be used | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.GenerateAuthenticationTokenResponse`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto#L58) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| token | `bytes` | optional | Auth token for the member | -| expires_at | `google.protobuf.Timestamp` | optional | Timestamp when the token expires | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.GetBftScheduleRequest`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto#L69) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.sequencer.admin.v30.GetBftScheduleResponse`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto#L70) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| schedule | [`com.digitalasset.canton.sequencer.admin.v30.BftOrdererPruningSchedule`](#type-com-digitalasset-canton-sequencer-admin-v30-bftordererpruningschedule) | optional | | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.GetOrderingTopologyRequest`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto#L104) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.sequencer.admin.v30.GetOrderingTopologyResponse`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto#L106) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| current_epoch | `int64` | optional | The current epoch, through which the topology is valid. | -| sequencer_ids | `string` | repeated | The sequencer IDs of the active BFT ordering nodes in the network. | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.GetPeerNetworkStatusRequest`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto#L95) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| endpoint_ids | [`com.digitalasset.canton.sequencer.admin.v30.PeerEndpointId`](#type-com-digitalasset-canton-sequencer-admin-v30-peerendpointid) | repeated | If empty, the status of all known endpoints will be returned | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.GetPeerNetworkStatusResponse`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto#L100) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| statuses | [`com.digitalasset.canton.sequencer.admin.v30.PeerConnectionStatus`](#type-com-digitalasset-canton-sequencer-admin-v30-peerconnectionstatus) | repeated | | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.ImplementationSpecificInfo`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_snapshot.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_snapshot.proto#L70) -- Fields: 2 - -additional sequencer implementation specific piece of data - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| implementation_name | `string` | optional | | -| info | `bytes` | optional | | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromGenesisStateRequest`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_service.proto#L29) -- Fields: 2 - -Includes sufficient detail for: - - topology and additional bootstrap information - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| topology_snapshot | `bytes` | optional | a topology snapshot up until (including) the point where this sequencer is becoming active on the synchronizer
the topology snapshot will be persisted in the synchronizer store of the sequencer | -| synchronizer_parameters | [`com.digitalasset.canton.protocol.v30.StaticSynchronizerParameters`](com-digitalasset-canton-protocol-v30#type-com-digitalasset-canton-protocol-v30-staticsynchronizerparameters) | optional | | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromGenesisStateResponse`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_service.proto#L37) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| replicated | `bool` | optional | Indicate if the initialized sequencer is replicated | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromGenesisStateV2Request`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_service.proto#L63) -- Fields: 2 - -Includes sufficient detail for: - - topology and additional bootstrap information - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| topology_snapshot | `bytes` | optional | a topology snapshot up until (including) the point where this sequencer is becoming active on the synchronizer
the topology snapshot will be persisted in the synchronizer store of the sequencer | -| synchronizer_parameters | [`com.digitalasset.canton.protocol.v30.StaticSynchronizerParameters`](com-digitalasset-canton-protocol-v30#type-com-digitalasset-canton-protocol-v30-staticsynchronizerparameters) | optional | | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromGenesisStateV2Response`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_service.proto#L71) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| replicated | `bool` | optional | Indicate if the initialized sequencer is replicated | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromOnboardingStateRequest`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_service.proto#L52) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| onboarding_state | `bytes` | optional | | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromOnboardingStateResponse`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_service.proto#L56) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| replicated | `bool` | optional | Indicate if the initialized sequencer is replicated | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromOnboardingStateV2Request`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_service.proto#L76) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| onboarding_state | `bytes` | optional | | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromOnboardingStateV2Response`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_service.proto#L80) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| replicated | `bool` | optional | Indicate if the initialized sequencer is replicated | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromPredecessorRequest`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_service.proto#L44) -- Fields: 2 - -Includes sufficient detail for: - - topology and additional bootstrap information - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| topology_snapshot | `bytes` | optional | | -| synchronizer_parameters | [`com.digitalasset.canton.protocol.v30.StaticSynchronizerParameters`](com-digitalasset-canton-protocol-v30#type-com-digitalasset-canton-protocol-v30-staticsynchronizerparameters) | optional | | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromPredecessorResponse`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_service.proto#L50) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.sequencer.admin.v30.OnboardingStateForSequencer`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto#L144) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| topology_snapshot | [`com.digitalasset.canton.topology.admin.v30.TopologyTransactions`](com-digitalasset-canton-topology-admin-v30#type-com-digitalasset-canton-topology-admin-v30-topologytransactions) | optional | | -| static_synchronizer_parameters | [`com.digitalasset.canton.protocol.v30.StaticSynchronizerParameters`](com-digitalasset-canton-protocol-v30#type-com-digitalasset-canton-protocol-v30-staticsynchronizerparameters) | optional | | -| sequencer_snapshot | [`com.digitalasset.canton.sequencer.admin.v30.SequencerSnapshot`](#type-com-digitalasset-canton-sequencer-admin-v30-sequencersnapshot) | optional | | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.OnboardingStateForSequencerV2`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto#L166) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| topology_transaction | `bytes` | optional | versioned com.digitalasset.canton.topology.admin.v30.TopologyTransactions.Item | -| static_synchronizer_parameters | `bytes` | optional | | -| sequencer_snapshot | [`com.digitalasset.canton.sequencer.admin.v30.SequencerSnapshot`](#type-com-digitalasset-canton-sequencer-admin-v30-sequencersnapshot) | optional | | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.OnboardingStateRequest`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto#L130) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| sequencer_uid | `string` | optional | The sequencer for which to fetch the onboarding state | -| timestamp | `google.protobuf.Timestamp` | optional | The effective time the should be "contained" in the sequencer snapshot | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.OnboardingStateResponse`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto#L139) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| onboarding_state_for_sequencer | `bytes` | optional | versioned OnboardingStateForSequencer | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.OnboardingStateV2Request`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto#L152) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| sequencer_uid | `string` | optional | The sequencer for which to fetch the onboarding state | -| timestamp | `google.protobuf.Timestamp` | optional | The effective time the should be "contained" in the sequencer snapshot | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.OnboardingStateV2Response`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto#L161) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| onboarding_state_for_sequencer | `bytes` | optional | versioned OnboardingStateForSequencerV2 | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.PeerConnectionStatus`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto#L88) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| peer_endpoint_status | [`com.digitalasset.canton.sequencer.admin.v30.PeerEndpointStatus`](#type-com-digitalasset-canton-sequencer-admin-v30-peerendpointstatus) | optional | | -| peer_incoming_connection | [`com.digitalasset.canton.sequencer.admin.v30.Authenticated`](#type-com-digitalasset-canton-sequencer-admin-v30-authenticated) | optional | | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.PeerEndpoint`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto#L24) -- Fields: 4 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| address | `string` | optional | | -| port | `uint32` | optional | | -| plain_text | [`com.digitalasset.canton.sequencer.admin.v30.PlainTextPeerEndpoint`](#type-com-digitalasset-canton-sequencer-admin-v30-plaintextpeerendpoint) | optional | | -| tls | [`com.digitalasset.canton.sequencer.admin.v30.TlsPeerEndpoint`](#type-com-digitalasset-canton-sequencer-admin-v30-tlspeerendpoint) | optional | | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.PeerEndpointHealth`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto#L77) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| status | [`com.digitalasset.canton.sequencer.admin.v30.PeerEndpointHealthStatus`](#type-com-digitalasset-canton-sequencer-admin-v30-peerendpointhealthstatus) | optional | | -| description | `string` | optional | | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.PeerEndpointHealthStatus`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto#L64) -- Fields: 4 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| unknown_endpoint | [`com.digitalasset.canton.sequencer.admin.v30.PeerEndpointHealthStatus.UnknownEndpoint`](#type-com-digitalasset-canton-sequencer-admin-v30-peerendpointhealthstatus-unknownendpoint) | optional | | -| disconnected | [`com.digitalasset.canton.sequencer.admin.v30.PeerEndpointHealthStatus.Disconnected`](#type-com-digitalasset-canton-sequencer-admin-v30-peerendpointhealthstatus-disconnected) | optional | | -| unauthenticated | [`com.digitalasset.canton.sequencer.admin.v30.PeerEndpointHealthStatus.Unauthenticated`](#type-com-digitalasset-canton-sequencer-admin-v30-peerendpointhealthstatus-unauthenticated) | optional | | -| authenticated | [`com.digitalasset.canton.sequencer.admin.v30.Authenticated`](#type-com-digitalasset-canton-sequencer-admin-v30-authenticated) | optional | | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.PeerEndpointHealthStatus.UnknownEndpoint`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto#L72) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.sequencer.admin.v30.PeerEndpointHealthStatus.Disconnected`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto#L73) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.sequencer.admin.v30.PeerEndpointHealthStatus.Unauthenticated`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto#L74) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.sequencer.admin.v30.PeerEndpointId`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto#L33) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| address | `string` | optional | | -| port | `uint32` | optional | | -| tls | `bool` | optional | | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.PeerEndpointStatus`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto#L82) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| endpoint_id | [`com.digitalasset.canton.sequencer.admin.v30.PeerEndpointId`](#type-com-digitalasset-canton-sequencer-admin-v30-peerendpointid) | optional | | -| is_outgoing_connection | `bool` | optional | | -| health | [`com.digitalasset.canton.sequencer.admin.v30.PeerEndpointHealth`](#type-com-digitalasset-canton-sequencer-admin-v30-peerendpointhealth) | optional | | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.PlainTextPeerEndpoint`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto#L39) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.sequencer.admin.v30.PruneRequest`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_pruning_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_pruning_administration_service.proto#L40) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| timestamp | `google.protobuf.Timestamp` | optional | | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.PruneResponse`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_pruning_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_pruning_administration_service.proto#L44) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| details | `string` | optional | description of what was removed | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.PruningStatusRequest`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto#L175) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.sequencer.admin.v30.PruningStatusResponse`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto#L177) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| pruning_status | [`com.digitalasset.canton.sequencer.admin.v30.SequencerPruningStatus`](#type-com-digitalasset-canton-sequencer-admin-v30-sequencerpruningstatus) | optional | | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.RemovePeerEndpointRequest`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto#L20) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| endpoint_id | [`com.digitalasset.canton.sequencer.admin.v30.PeerEndpointId`](#type-com-digitalasset-canton-sequencer-admin-v30-peerendpointid) | optional | | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.RemovePeerEndpointResponse`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto#L55) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| removed | `bool` | optional | False if not found | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.SequencerMemberStatus`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_snapshot.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_snapshot.proto#L53) -- Fields: 4 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| member | `string` | optional | | -| registered_at | `int64` | optional | in microseconds of UTC time since Unix epoch | -| last_acknowledged | `int64` | optional | in microseconds of UTC time since Unix epoch | -| enabled | `bool` | optional | | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.SequencerPruningStatus`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_snapshot.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_snapshot.proto#L60) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| now | `int64` | optional | current time according to the sequencer in microseconds of UTC time since Unix epoch | -| earliest_event_timestamp | `int64` | optional | the earliest event we are currently storing in microseconds of UTC time since Unix epoch | -| members | [`com.digitalasset.canton.sequencer.admin.v30.SequencerMemberStatus`](#type-com-digitalasset-canton-sequencer-admin-v30-sequencermemberstatus) | repeated | details of each member registered on the sequencer | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.SequencerSnapshot`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_snapshot.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_snapshot.proto#L13) -- Fields: 8 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| latest_timestamp | `int64` | optional | in microseconds of UTC time since Unix epoch | -| last_block_height | `uint64` | optional | | -| status | [`com.digitalasset.canton.sequencer.admin.v30.SequencerPruningStatus`](#type-com-digitalasset-canton-sequencer-admin-v30-sequencerpruningstatus) | optional | | -| additional | [`com.digitalasset.canton.sequencer.admin.v30.ImplementationSpecificInfo`](#type-com-digitalasset-canton-sequencer-admin-v30-implementationspecificinfo) | optional | | -| in_flight_aggregations | [`com.digitalasset.canton.sequencer.admin.v30.SequencerSnapshot.InFlightAggregationWithId`](#type-com-digitalasset-canton-sequencer-admin-v30-sequencersnapshot-inflightaggregationwithid) | repeated | | -| traffic_purchased | [`com.digitalasset.canton.protocol.v30.TrafficPurchased`](com-digitalasset-canton-protocol-v30#type-com-digitalasset-canton-protocol-v30-trafficpurchased) | repeated | | -| traffic_consumed | [`com.digitalasset.canton.protocol.v30.TrafficConsumed`](com-digitalasset-canton-protocol-v30#type-com-digitalasset-canton-protocol-v30-trafficconsumed) | repeated | | -| member_previous_timestamps | [`com.digitalasset.canton.sequencer.admin.v30.SequencerSnapshot.MemberPreviousTimestamp`](#type-com-digitalasset-canton-sequencer-admin-v30-sequencersnapshot-memberprevioustimestamp) | repeated | | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.SequencerSnapshot.MemberPreviousTimestamp`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_snapshot.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_snapshot.proto#L26) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| member | `string` | optional | | -| previous_timestamp | `int64` | optional | The value below must be:
- None if member doesn't have any events in its event stream <= SequencerSnapshot.latest_timestamp
- Set to the timestamp of the last event in the member's event stream <= SequencerSnapshot.latest_timestamp
in microseconds of UTC time since Unix epoch | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.SequencerSnapshot.InFlightAggregationWithId`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_snapshot.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_snapshot.proto#L35) -- Fields: 4 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| aggregation_id | `bytes` | optional | | -| aggregation_rule | [`com.digitalasset.canton.protocol.v30.AggregationRule`](com-digitalasset-canton-protocol-v30#type-com-digitalasset-canton-protocol-v30-aggregationrule) | optional | | -| max_sequencing_time | `int64` | optional | in microseconds of UTC time since Unix epoch | -| aggregated_senders | [`com.digitalasset.canton.sequencer.admin.v30.SequencerSnapshot.AggregationBySender`](#type-com-digitalasset-canton-sequencer-admin-v30-sequencersnapshot-aggregationbysender) | repeated | | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.SequencerSnapshot.AggregationBySender`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_snapshot.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_snapshot.proto#L42) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| sender | `string` | optional | | -| sequencing_timestamp | `int64` | optional | in microseconds of UTC time since Unix epoch | -| signatures_by_envelope | [`com.digitalasset.canton.sequencer.admin.v30.SequencerSnapshot.SignaturesForEnvelope`](#type-com-digitalasset-canton-sequencer-admin-v30-sequencersnapshot-signaturesforenvelope) | repeated | | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.SequencerSnapshot.SignaturesForEnvelope`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_snapshot.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_initialization_snapshot.proto#L48) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| signatures | [`com.digitalasset.canton.crypto.v30.Signature`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-signature) | repeated | | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.SetBftScheduleRequest`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto#L60) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| schedule | [`com.digitalasset.canton.sequencer.admin.v30.BftOrdererPruningSchedule`](#type-com-digitalasset-canton-sequencer-admin-v30-bftordererpruningschedule) | optional | | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.SetBftScheduleResponse`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto#L67) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.sequencer.admin.v30.SetMinBlocksToKeepRequest`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto#L74) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| min_blocks_to_keep | `int32` | optional | | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.SetMinBlocksToKeepResponse`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_pruning_administration_service.proto#L77) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.sequencer.admin.v30.SetPerformanceMetricsEnabledRequest`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto#L113) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| enabled | `bool` | optional | | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.SetPerformanceMetricsEnabledResponse`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto#L117) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.sequencer.admin.v30.SetTrafficPurchasedRequest`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto#L98) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| member | `string` | optional | Member to top up | -| serial | `uint32` | optional | Serial number of the request, will be used for idempotency | -| total_traffic_purchased | `int64` | optional | Amount of traffic to purchase | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.SetTrafficPurchasedResponse`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto#L104) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.sequencer.admin.v30.SnapshotRequest`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto#L106) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| timestamp | `google.protobuf.Timestamp` | optional | | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.SnapshotResponse`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto#L110) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| success | [`com.digitalasset.canton.sequencer.admin.v30.SnapshotResponse.Success`](#type-com-digitalasset-canton-sequencer-admin-v30-snapshotresponse-success) | optional | Used for sequencers running protocol versions up to v5 | -| failure | [`com.digitalasset.canton.sequencer.admin.v30.SnapshotResponse.Failure`](#type-com-digitalasset-canton-sequencer-admin-v30-snapshotresponse-failure) | optional | | -| versioned_success | [`com.digitalasset.canton.sequencer.admin.v30.SnapshotResponse.VersionedSuccess`](#type-com-digitalasset-canton-sequencer-admin-v30-snapshotresponse-versionedsuccess) | optional | Used for sequencers running protocol version CNTestNet or higher. | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.SnapshotResponse.Success`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto#L111) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| state | [`com.digitalasset.canton.sequencer.admin.v30.SequencerSnapshot`](#type-com-digitalasset-canton-sequencer-admin-v30-sequencersnapshot) | optional | | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.SnapshotResponse.Failure`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto#L114) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| reason | `string` | optional | | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.SnapshotResponse.VersionedSuccess`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto#L117) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| snapshot | `bytes` | optional | Contains a versioned SequencerSnapshot of version v1 or higher | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.TlsClientCertificate`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto#L46) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| certificate_chain | `bytes` | optional | | -| private_key_file | `string` | optional | | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.TlsPeerEndpoint`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_bft_administration_service.proto#L41) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| custom_server_trust_certificate | `bytes` | optional | | -| client_certificate | [`com.digitalasset.canton.sequencer.admin.v30.TlsClientCertificate`](#type-com-digitalasset-canton-sequencer-admin-v30-tlsclientcertificate) | optional | | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.TrafficControlStateRequest`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto#L65) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| members | `string` | repeated | Members for which to retrieve the traffic state | -| exact_timestamp | `uint64` | optional | Provide an exact timestamp at which traffic states must be returned | -| relative_timestamp | [`com.digitalasset.canton.sequencer.admin.v30.TrafficControlStateRequest.RelativeTimestamp`](#type-com-digitalasset-canton-sequencer-admin-v30-trafficcontrolstaterequest-relativetimestamp) | optional | A relative timestamp based on the sequencer's state at the time of the request, see above for details | - - -**Enum `com.digitalasset.canton.sequencer.admin.v30.TrafficControlStateRequest.RelativeTimestamp`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto#L68) - -_No description._ - -| Name | Number | -| --- | --- | -| RELATIVE_TIMESTAMP_LATEST_SAFE_UNSPECIFIED | `0` | -| RELATIVE_TIMESTAMP_LAST_UPDATE_PER_MEMBER | `1` | -| RELATIVE_TIMESTAMP_LATEST_APPROXIMATE | `2` | - - -**Message `com.digitalasset.canton.sequencer.admin.v30.TrafficControlStateResponse`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_administration_service.proto#L92) -- Fields: 1 - -_No description._ -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| traffic_states | `map` | repeated | The key is the serialized member value
The value is their currently known traffic state (the traffic state contains a timestamp at which it is valid) | +
+ +
+
Source file
+
community/synchronizer/src/main/protobuf/com/digitalasset/canton/sequencer/admin/v30/sequencer_pruning_administration_service.proto
+
+ +
+
Operations
+
8
+
+ +
+ + +
+ + + + +
+

SequencerPruningAdministrationService.ClearSchedule

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Disable automatic pruning and remove the persisted schedule configuration.

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.pruning.v30.ClearScheduleRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.pruning.v30.ClearScheduleResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SequencerPruningAdministrationService.FindPruningTimestamp

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Retrieve pruning timestamp at or near the "beginning" of events.

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.pruning.v30.FindPruningTimestampRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.pruning.v30.FindPruningTimestampResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SequencerPruningAdministrationService.GetSchedule

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Retrieve the automatic pruning configuration.

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.pruning.v30.GetScheduleRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.pruning.v30.GetScheduleResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SequencerPruningAdministrationService.Prune

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Remove data from the Sequencer

+ + +
+ +
+
Request
+
com.digitalasset.canton.sequencer.admin.v30.PruneRequest
+
+ +
+
Response
+
com.digitalasset.canton.sequencer.admin.v30.PruneResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SequencerPruningAdministrationService.SetCron

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Modify individual pruning schedule parameters. - ``INVALID_ARGUMENT``: if the payload is malformed or no schedule is configured

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.pruning.v30.SetCronRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.pruning.v30.SetCronResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SequencerPruningAdministrationService.SetMaxDuration

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc SequencerPruningAdministrationService.SetMaxDuration(com.digitalasset.canton.admin.pruning.v30.SetMaxDurationRequest) returns (com.digitalasset.canton.admin.pruning.v30.SetM...

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.pruning.v30.SetMaxDurationRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.pruning.v30.SetMaxDurationResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SequencerPruningAdministrationService.SetRetention

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc SequencerPruningAdministrationService.SetRetention(com.digitalasset.canton.admin.pruning.v30.SetRetentionRequest) returns (com.digitalasset.canton.admin.pruning.v30.SetReten...

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.pruning.v30.SetRetentionRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.pruning.v30.SetRetentionResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SequencerPruningAdministrationService.SetSchedule

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Enable automatic pruning using the specified schedule parameters The following errors may occur on the SetSchedule or Update commands: - ``INVALID_ARGUMENT``: if a parameter is...

+ + +
+ +
+
Request
+
com.digitalasset.canton.admin.pruning.v30.SetScheduleRequest
+
+ +
+
Response
+
com.digitalasset.canton.admin.pruning.v30.SetScheduleResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## Type Inventory + + +These are the package-level message and enum shapes in the publish-version snapshot. + + + + +
+
+

com.digitalasset.canton.sequencer.admin.v30.AddPeerEndpointRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ endpoint + PeerEndpoint + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.PeerEndpoint

+ +

4 fields

+ +
+ + +
+ +
+
+ address + string + +
+ +
+ +
+
+ port + uint32 + +
+ +
+ +
+
+ plain_text + PlainTextPeerEndpoint + +
+ +
+ +
+
+ tls + TlsPeerEndpoint + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.PlainTextPeerEndpoint

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.TlsPeerEndpoint

+ +

2 fields

+ +
+ + +
+ +
+
+ custom_server_trust_certificate + bytes + +
+ +
+ +
+
+ client_certificate + TlsClientCertificate + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.TlsClientCertificate

+ +

2 fields

+ +
+ + +
+ +
+
+ certificate_chain + bytes + +
+ +
+ +
+
+ private_key_file + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.AddPeerEndpointResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ added + bool + +
+ +
False if already present
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.Authenticated

+ +

1 fields

+ +
+ + +
+ +
+
+ sequencer_id + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.BftOrdererPruningSchedule

+ +

2 fields

+ +
+ + +
+ +
+
+ schedule + PruningSchedule + +
+ +
+ +
+
+ min_blocks_to_keep + int32 + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.admin.pruning.v30.PruningSchedule

+ +

3 fields

+ +
+ + +
+ +
+
+ cron + string + +
+ +
+ +
+
+ max_duration + Duration + +
+ +
+ +
+
+ retention + Duration + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.BftPruneRequest

+ +

2 fields

+ +
+ + +
+ +
+
+ retention + Duration + +
+ +
+ +
+
+ min_blocks_to_keep + int32 + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.BftPruneResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ message + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.BftPruningStatusRequest

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.BftPruningStatusResponse

+ +

5 fields

+ +
+ + +
+ +
+
+ latest_block_epoch + int64 + +
+ +
+ +
+
+ latest_block + int64 + +
+ +
+ +
+
+ latest_block_timestamp + Timestamp + +
+ +
+ +
+
+ lower_bound_epoch + int64 + +
+ +
+ +
+
+ lower_bound_block + int64 + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.BftSequencerSnapshotAdditionalInfo

+ +

1 fields

+ +
+ + +
+ +
+
+ sequencers_active_at + repeated map + +
+ +
State transfer metadata for onboarding
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.BftSequencerSnapshotAdditionalInfo.SequencerActiveAt

+ +

8 fields

+ +
+ + +
+ +
+
+ timestamp + int64 + +
+ +
Onboarding topology activation timestamp (in microseconds of UTC time since Unix epoch)
+ +
+ +
+
+ start_epoch_number + int64 + +
+ +
An epoch where the onboarding transaction became effective, used as state transfer start epoch
+ +
+ +
+
+ first_block_number_in_start_epoch + int64 + +
+ +
Needed to properly set the initial block in the Output module (due to transferring full epochs)
+ +
+ +
+
+ start_epoch_topology_query_timestamp + int64 + +
+ +
A topology query timestamp for the state transfer start epoch
+ +
+ +
+
+ start_epoch_could_alter_ordering_topology + bool + +
+ +
Needed for emitting topology ticks consistently
+ +
+ +
+
+ previous_bft_time + int64 + +
+ +
BFT time of the last block in the previous epoch (in microseconds of UTC time since Unix epoch)
+ +
+ +
+
+ previous_epoch_topology_query_timestamp + int64 + +
+ +
A topology query timestamp for an epoch previous to the state transfer start epoch Used for canonical commit set verification
+ +
+ +
+
+ leader_selection_policy_state + bytes + +
+ +
Leader Selection Policy State at the start of epoch_number
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.BlacklistLeaderSelectionPolicyState

+ +

3 fields

+ +
+ + +
+ +
+
+ epoch_number + int64 + +
+ +
+ +
+
+ start_block_number + int64 + +
+ +
+ +
+
+ blacklist + repeated map + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.BlacklistLeaderSelectionPolicyState.BlacklistStatus

+ +

2 fields

+ +
+ + +
+ +
+
+ on_trial + OnTrial + +
+ +
+ +
+
+ blacklisted + Blacklisted + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.BlacklistLeaderSelectionPolicyState.BlacklistStatus.OnTrial

+ +

1 fields

+ +
+ + +
+ +
+
+ failed_attempts_before_trial + int64 + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.BlacklistLeaderSelectionPolicyState.BlacklistStatus.Blacklisted

+ +

2 fields

+ +
+ + +
+ +
+
+ failed_attempts_before + int64 + +
+ +
+ +
+
+ epochs_left_until_new_trial + int64 + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.DisableMemberRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ member + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.DisableMemberResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.GenerateAuthenticationTokenRequest

+ +

2 fields

+ +
+ + +
+ +
+
+ member + string + +
+ +
Member for which the token is valid
+ +
+ +
+
+ expires_in + Duration + +
+ +
Duration after which the token will expire. If unset, the maxTokenExpirationInterval configured on the sequencer will be used
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.GenerateAuthenticationTokenResponse

+ +

2 fields

+ +
+ + +
+ +
+
+ token + bytes + +
+ +
Auth token for the member
+ +
+ +
+
+ expires_at + Timestamp + +
+ +
Timestamp when the token expires
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.GetBftScheduleRequest

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.GetBftScheduleResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ schedule + BftOrdererPruningSchedule + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.GetOrderingTopologyRequest

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.GetOrderingTopologyResponse

+ +

2 fields

+ +
+ + +
+ +
+
+ current_epoch + int64 + +
+ +
The current epoch, through which the topology is valid.
+ +
+ +
+
+ sequencer_ids + repeated string + +
+ +
The sequencer IDs of the active BFT ordering nodes in the network.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.GetPeerNetworkStatusRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ endpoint_ids + repeated PeerEndpointId + +
+ +
If empty, the status of all known endpoints will be returned
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.PeerEndpointId

+ +

3 fields

+ +
+ + +
+ +
+
+ address + string + +
+ +
+ +
+
+ port + uint32 + +
+ +
+ +
+
+ tls + bool + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.GetPeerNetworkStatusResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ statuses + repeated PeerConnectionStatus + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.PeerConnectionStatus

+ +

2 fields

+ +
+ + +
+ +
+
+ peer_endpoint_status + PeerEndpointStatus + +
+ +
+ +
+
+ peer_incoming_connection + Authenticated + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.PeerEndpointStatus

+ +

3 fields

+ +
+ + +
+ +
+
+ endpoint_id + PeerEndpointId + +
+ +
+ +
+
+ is_outgoing_connection + bool + +
+ +
+ +
+
+ health + PeerEndpointHealth + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.PeerEndpointHealth

+ +

2 fields

+ +
+ + +
+ +
+
+ status + PeerEndpointHealthStatus + +
+ +
+ +
+
+ description + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.PeerEndpointHealthStatus

+ +

4 fields

+ +
+ + +
+ +
+
+ unknown_endpoint + UnknownEndpoint + +
+ +
+ +
+
+ disconnected + Disconnected + +
+ +
+ +
+
+ unauthenticated + Unauthenticated + +
+ +
+ +
+
+ authenticated + Authenticated + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.PeerEndpointHealthStatus.UnknownEndpoint

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.PeerEndpointHealthStatus.Disconnected

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.PeerEndpointHealthStatus.Unauthenticated

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.ImplementationSpecificInfo

+ +

2 fields

+ +
+ +

additional sequencer implementation specific piece of data

+ + +
+ +
+
+ implementation_name + string + +
+ +
+ +
+
+ info + bytes + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromGenesisStateRequest

+ +

2 fields

+ +
+ +

Includes sufficient detail for: - topology and additional bootstrap information

+ + +
+ +
+
+ topology_snapshot + bytes + +
+ +
a topology snapshot up until (including) the point where this sequencer is becoming active on the synchronizer the topology snapshot will be persisted in the synchronizer store of the sequencer
+ +
+ +
+
+ synchronizer_parameters + StaticSynchronizerParameters + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.StaticSynchronizerParameters

+ +

10 fields

+ +
+ + +
+ +
+
+ required_signing_specs + RequiredSigningSpecs + +
+ +
+ +
+
+ required_encryption_specs + RequiredEncryptionSpecs + +
+ +
+ +
+
+ required_symmetric_key_schemes + repeated SymmetricKeyScheme + +
+ +
+ +
+
+ required_hash_algorithms + repeated HashAlgorithm + +
+ +
+ +
+
+ required_crypto_key_formats + repeated CryptoKeyFormat + +
+ +
+ +
+
+ required_signature_formats + repeated SignatureFormat + +
+ +
+ +
+
+ protocol_version + int32 + +
+ +
+ +
+
+ serial + int32 + +
+ +
Serial of the synchronizer. Must be non-negative.
+ +
+ +
+
+ enable_transparency_checks + bool + +
+ +
Flag to enable transparency checks.
+ +
+ +
+
+ topology_change_delay + Duration + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.RequiredSigningSpecs

+ +

2 fields

+ +
+ +

Used to announce the required signing key and algorithm specifications in the static synchronizer parameters.

+ + +
+ +
+
+ algorithms + repeated SigningAlgorithmSpec + +
+ +
+ +
+
+ keys + repeated SigningKeySpec + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SigningAlgorithmSpec

+ +

4 values

+ +
+ + + +
    + +
  • SIGNING_ALGORITHM_SPEC_UNSPECIFIED
    • + +
  • SIGNING_ALGORITHM_SPEC_ED25519
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_256
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_384
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SigningKeySpec

+ +

5 values

+ +
+ +

[start-docs-entry: signing key spec proto]

+ + + +
    + +
  • SIGNING_KEY_SPEC_UNSPECIFIED
    • + +
  • SIGNING_KEY_SPEC_EC_CURVE25519
    • + +
  • SIGNING_KEY_SPEC_EC_P256
    • + +
  • SIGNING_KEY_SPEC_EC_P384
    • + +
  • SIGNING_KEY_SPEC_EC_SECP256K1
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.v30.RequiredEncryptionSpecs

+ +

2 fields

+ +
+ +

Used to announce the required encryption key and algorithm specifications in the static synchronizer parameters.

+ + +
+ +
+
+ algorithms + repeated EncryptionAlgorithmSpec + +
+ +
+ +
+
+ keys + repeated EncryptionKeySpec + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.EncryptionAlgorithmSpec

+ +

3 values

+ +
+ + + +
    + +
  • ENCRYPTION_ALGORITHM_SPEC_UNSPECIFIED
    • + +
  • ENCRYPTION_ALGORITHM_SPEC_ECIES_HKDF_HMAC_SHA256_AES128CBC
    • + +
  • ENCRYPTION_ALGORITHM_SPEC_RSA_OAEP_SHA256
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.v30.EncryptionKeySpec

+ +

3 values

+ +
+ + + +
    + +
  • ENCRYPTION_KEY_SPEC_UNSPECIFIED
    • + +
  • ENCRYPTION_KEY_SPEC_EC_P256
    • + +
  • ENCRYPTION_KEY_SPEC_RSA_2048
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SymmetricKeyScheme

+ +

2 values

+ +
+ + + +
    + +
  • SYMMETRIC_KEY_SCHEME_UNSPECIFIED
    • + +
  • SYMMETRIC_KEY_SCHEME_AES128GCM
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.v30.HashAlgorithm

+ +

2 values

+ +
+ + + +
    + +
  • HASH_ALGORITHM_UNSPECIFIED
    • + +
  • HASH_ALGORITHM_SHA256
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.v30.CryptoKeyFormat

+ +

6 values

+ +
+ +

Serialization format for crypto keys and signatures

+ + + +
    + +
  • CRYPTO_KEY_FORMAT_UNSPECIFIED
    • + +
  • CRYPTO_KEY_FORMAT_DER
    • + +
  • CRYPTO_KEY_FORMAT_RAW
    • + +
  • CRYPTO_KEY_FORMAT_DER_X509_SUBJECT_PUBLIC_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_DER_PKCS8_PRIVATE_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_SYMBOLIC
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SignatureFormat

+ +

5 values

+ +
+ + + +
    + +
  • SIGNATURE_FORMAT_UNSPECIFIED
    • + +
  • SIGNATURE_FORMAT_RAW
    • + +
  • SIGNATURE_FORMAT_DER
    • + +
  • SIGNATURE_FORMAT_CONCAT
    • + +
  • SIGNATURE_FORMAT_SYMBOLIC
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromGenesisStateResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ replicated + bool + +
+ +
Indicate if the initialized sequencer is replicated
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromGenesisStateV2Request

+ +

2 fields

+ +
+ +

Includes sufficient detail for: - topology and additional bootstrap information

+ + +
+ +
+
+ topology_snapshot + bytes + +
+ +
a topology snapshot up until (including) the point where this sequencer is becoming active on the synchronizer the topology snapshot will be persisted in the synchronizer store of the sequencer
+ +
+ +
+
+ synchronizer_parameters + StaticSynchronizerParameters + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromGenesisStateV2Response

+ +

1 fields

+ +
+ + +
+ +
+
+ replicated + bool + +
+ +
Indicate if the initialized sequencer is replicated
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromOnboardingStateRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ onboarding_state + bytes + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromOnboardingStateResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ replicated + bool + +
+ +
Indicate if the initialized sequencer is replicated
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromOnboardingStateV2Request

+ +

1 fields

+ +
+ + +
+ +
+
+ onboarding_state + bytes + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromOnboardingStateV2Response

+ +

1 fields

+ +
+ + +
+ +
+
+ replicated + bool + +
+ +
Indicate if the initialized sequencer is replicated
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromPredecessorRequest

+ +

2 fields

+ +
+ +

Includes sufficient detail for: - topology and additional bootstrap information

+ + +
+ +
+
+ topology_snapshot + bytes + +
+ +
+ +
+
+ synchronizer_parameters + StaticSynchronizerParameters + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.InitializeSequencerFromPredecessorResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.OnboardingStateForSequencer

+ +

3 fields

+ +
+ + +
+ +
+
+ topology_snapshot + TopologyTransactions + +
+ +
+ +
+
+ static_synchronizer_parameters + StaticSynchronizerParameters + +
+ +
+ +
+
+ sequencer_snapshot + SequencerSnapshot + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.TopologyTransactions

+ +

1 fields

+ +
+ +

* Topology transaction collection used during bootstrapping of synchronizer nodes and on the admin API Please note that this message should not be in the protocol package, as it is not used on the protocol itself but on the admin apis. But as we can't rename the package name due to backwards compatibility guarantees, we've moved the file out of the protocol.proto file, but kept the package name.

+ + +
+ +
+
+ items + repeated Item + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.TopologyTransactions.Item

+ +

5 fields

+ +
+ + +
+ +
+
+ sequenced + Timestamp + +
+ +
+ +
+
+ valid_from + Timestamp + +
+ +
+ +
+
+ valid_until + Timestamp + +
+ +
+ +
+
+ transaction + bytes + +
+ +
* Versioned signed topology transactions serialized as byte-strings. Note that we use here the serialized version that contains the version number. Using the "Versioned" version directly here would create a circular dependency between the proto files. The only proper solution would be to move this into a third separate file with "cross version data files", which we might do at some point.
+ +
+ +
+
+ rejection_reason + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.SequencerSnapshot

+ +

8 fields

+ +
+ + +
+ +
+
+ latest_timestamp + int64 + +
+ +
in microseconds of UTC time since Unix epoch
+ +
+ +
+
+ last_block_height + uint64 + +
+ +
+ +
+
+ status + SequencerPruningStatus + +
+ +
+ +
+
+ additional + ImplementationSpecificInfo + +
+ +
+ +
+
+ in_flight_aggregations + repeated InFlightAggregationWithId + +
+ +
+ +
+
+ traffic_purchased + repeated TrafficPurchased + +
+ +
+ +
+
+ traffic_consumed + repeated TrafficConsumed + +
+ +
+ +
+
+ member_previous_timestamps + repeated MemberPreviousTimestamp + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.SequencerSnapshot.MemberPreviousTimestamp

+ +

2 fields

+ +
+ + +
+ +
+
+ member + string + +
+ +
+ +
+
+ previous_timestamp + int64 + +
+ +
The value below must be: - None if member doesn't have any events in its event stream <= SequencerSnapshot.latest_timestamp - Set to the timestamp of the last event in the member's event stream <= SequencerSnapshot.latest_timestamp in microseconds of UTC time since Unix epoch
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.SequencerSnapshot.InFlightAggregationWithId

+ +

4 fields

+ +
+ + +
+ +
+
+ aggregation_id + bytes + +
+ +
+ +
+
+ aggregation_rule + AggregationRule + +
+ +
+ +
+
+ max_sequencing_time + int64 + +
+ +
in microseconds of UTC time since Unix epoch
+ +
+ +
+
+ aggregated_senders + repeated AggregationBySender + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.AggregationRule

+ +

2 fields

+ +
+ + +
+ +
+
+ eligible_members + repeated string + +
+ +
Members who are allowed to send a request for the underlying aggregation. Must contain SubmissionRequest.sender, otherwise the request is rejected. Must have at least threshold many elements.
+ +
+ +
+
+ threshold + int32 + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.SequencerSnapshot.AggregationBySender

+ +

3 fields

+ +
+ + +
+ +
+
+ sender + string + +
+ +
+ +
+
+ sequencing_timestamp + int64 + +
+ +
in microseconds of UTC time since Unix epoch
+ +
+ +
+
+ signatures_by_envelope + repeated SignaturesForEnvelope + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.SequencerSnapshot.SignaturesForEnvelope

+ +

1 fields

+ +
+ + +
+ +
+
+ signatures + repeated Signature + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.Signature

+ +

5 fields

+ +
+ + +
+ +
+
+ format + SignatureFormat + +
+ +
+ +
+
+ signature + bytes + +
+ +
+ +
+
+ signed_by + string + +
+ +
The fingerprint/id of the keypair used to create this signature and needed to verify. If a signature delegation is defined, this fingerprint/id is not used to produce the signature, and, instead is used to sign the delegation.
+ +
+ +
+
+ signing_algorithm_spec + SigningAlgorithmSpec + +
+ +
The signing algorithm specification used to produce this signature
+ +
+ +
+
+ signature_delegation + SignatureDelegation + +
+ +
An optional signature delegation where a long-term signing key authorizes a session signing key to sign on its behalf.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SignatureDelegation

+ +

7 fields

+ +
+ + +
+ +
+
+ session_key + bytes + +
+ +
ASN.1 + DER-encoding of X.509 SubjectPublicKeyInfo structure of the session public key: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1. This key was used to produce the actual signature.
+ +
+ +
+
+ session_key_spec + SigningKeySpec + +
+ +
The signing key spec for the session key.
+ +
+ +
+
+ validity_period_from_inclusive + int64 + +
+ +
A timestamp in microseconds of UTC time since Unix epoch that indicates when the session key is considered valid.
+ +
+ +
+
+ validity_period_duration_seconds + uint32 + +
+ +
Duration in seconds indicating how long the session key remains valid. The validity period starts from `validity_period_from_inclusive` above.
+ +
+ +
+
+ format + SignatureFormat + +
+ +
The format of the signature
+ +
+ +
+
+ signature + bytes + +
+ +
The signature of the combined hash of the session key fingerprint, validity period, and synchronizer id, by the long-term key. This signature authorizes the session key to act on behalf of the long-term key.
+ +
+ +
+
+ signing_algorithm_spec + SigningAlgorithmSpec + +
+ +
The signing algorithm specification used to produce this signature
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.SequencerPruningStatus

+ +

3 fields

+ +
+ + +
+ +
+
+ now + int64 + +
+ +
current time according to the sequencer in microseconds of UTC time since Unix epoch
+ +
+ +
+
+ earliest_event_timestamp + int64 + +
+ +
the earliest event we are currently storing in microseconds of UTC time since Unix epoch
+ +
+ +
+
+ members + repeated SequencerMemberStatus + +
+ +
details of each member registered on the sequencer
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.SequencerMemberStatus

+ +

4 fields

+ +
+ + +
+ +
+
+ member + string + +
+ +
+ +
+
+ registered_at + int64 + +
+ +
in microseconds of UTC time since Unix epoch
+ +
+ +
+
+ last_acknowledged + int64 + +
+ +
in microseconds of UTC time since Unix epoch
+ +
+ +
+
+ enabled + bool + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.TrafficPurchased

+ +

4 fields

+ +
+ +

Message representing a traffic purchase made on behalf of a member

+ + +
+ +
+
+ member + string + +
+ +
Member receiving the traffic
+ +
+ +
+
+ serial + uint32 + +
+ +
Serial of the update
+ +
+ +
+
+ extra_traffic_purchased + uint64 + +
+ +
New total extra traffic purchased
+ +
+ +
+
+ sequencing_timestamp + int64 + +
+ +
Timestamp at which this state is valid
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.TrafficConsumed

+ +

5 fields

+ +
+ +

Message representing traffic consumed by a member at a given point in time

+ + +
+ +
+
+ member + string + +
+ +
Member consuming the traffic
+ +
+ +
+
+ extra_traffic_consumed + uint64 + +
+ +
Total extra traffic consumed
+ +
+ +
+
+ base_traffic_remainder + uint64 + +
+ +
Remaining free base traffic
+ +
+ +
+
+ last_consumed_cost + uint64 + +
+ +
Cost deducted at `timestamp`, only present when traffic was consumed at `timestamp`, otherwise is set to 0
+ +
+ +
+
+ sequencing_timestamp + int64 + +
+ +
Timestamp at which this state is valid - this timestamp is used to compute the base traffic remainder above
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.OnboardingStateForSequencerV2

+ +

3 fields

+ +
+ + +
+ +
+
+ topology_transaction + bytes + +
+ +
versioned com.digitalasset.canton.topology.admin.v30.TopologyTransactions.Item
+ +
+ +
+
+ static_synchronizer_parameters + bytes + +
+ +
+ +
+
+ sequencer_snapshot + SequencerSnapshot + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.OnboardingStateRequest

+ +

2 fields

+ +
+ + +
+ +
+
+ sequencer_uid + string + +
+ +
The sequencer for which to fetch the onboarding state
+ +
+ +
+
+ timestamp + Timestamp + +
+ +
The effective time the should be "contained" in the sequencer snapshot
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.OnboardingStateResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ onboarding_state_for_sequencer + bytes + +
+ +
versioned OnboardingStateForSequencer
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.OnboardingStateV2Request

+ +

2 fields

+ +
+ + +
+ +
+
+ sequencer_uid + string + +
+ +
The sequencer for which to fetch the onboarding state
+ +
+ +
+
+ timestamp + Timestamp + +
+ +
The effective time the should be "contained" in the sequencer snapshot
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.OnboardingStateV2Response

+ +

1 fields

+ +
+ + +
+ +
+
+ onboarding_state_for_sequencer + bytes + +
+ +
versioned OnboardingStateForSequencerV2
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.PruneRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ timestamp + Timestamp + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.PruneResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ details + string + +
+ +
description of what was removed
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.PruningStatusRequest

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.PruningStatusResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ pruning_status + SequencerPruningStatus + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.RemovePeerEndpointRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ endpoint_id + PeerEndpointId + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.RemovePeerEndpointResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ removed + bool + +
+ +
False if not found
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.SetBftScheduleRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ schedule + BftOrdererPruningSchedule + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.SetBftScheduleResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.SetMinBlocksToKeepRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ min_blocks_to_keep + int32 + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.SetMinBlocksToKeepResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.SetPerformanceMetricsEnabledRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ enabled + bool + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.SetPerformanceMetricsEnabledResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.SetTrafficPurchasedRequest

+ +

3 fields

+ +
+ + +
+ +
+
+ member + string + +
+ +
Member to top up
+ +
+ +
+
+ serial + uint32 + +
+ +
Serial number of the request, will be used for idempotency
+ +
+ +
+
+ total_traffic_purchased + int64 + +
+ +
Amount of traffic to purchase
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.SetTrafficPurchasedResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.SnapshotRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ timestamp + Timestamp + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.SnapshotResponse

+ +

3 fields

+ +
+ + +
+ +
+
+ success + Success + +
+ +
Used for sequencers running protocol versions up to v5
+ +
+ +
+
+ failure + Failure + +
+ +
+ +
+
+ versioned_success + VersionedSuccess + +
+ +
Used for sequencers running protocol version CNTestNet or higher.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.SnapshotResponse.Success

+ +

1 fields

+ +
+ + +
+ +
+
+ state + SequencerSnapshot + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.SnapshotResponse.Failure

+ +

1 fields

+ +
+ + +
+ +
+
+ reason + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.SnapshotResponse.VersionedSuccess

+ +

1 fields

+ +
+ + +
+ +
+
+ snapshot + bytes + +
+ +
Contains a versioned SequencerSnapshot of version v1 or higher
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.TrafficControlStateRequest

+ +

3 fields

+ +
+ + +
+ +
+
+ members + repeated string + +
+ +
Members for which to retrieve the traffic state
+ +
+ +
+
+ exact_timestamp + uint64 + +
+ +
Provide an exact timestamp at which traffic states must be returned
+ +
+ +
+
+ relative_timestamp + RelativeTimestamp + +
+ +
A relative timestamp based on the sequencer's state at the time of the request, see above for details
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.TrafficControlStateRequest.RelativeTimestamp

+ +

3 values

+ +
+ + + +
    + +
  • RELATIVE_TIMESTAMP_LATEST_SAFE_UNSPECIFIED
    • + +
  • RELATIVE_TIMESTAMP_LAST_UPDATE_PER_MEMBER
    • + +
  • RELATIVE_TIMESTAMP_LATEST_APPROXIMATE
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.sequencer.admin.v30.TrafficControlStateResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ traffic_states + repeated map + +
+ +
The key is the serialized member value The value is their currently known traffic state (the traffic state contains a timestamp at which it is valid)
+ +
+ +
+ + + +
diff --git a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-sequencer-api-v30.mdx b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-sequencer-api-v30.mdx index 02a1b60..612909f 100644 --- a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-sequencer-api-v30.mdx +++ b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-sequencer-api-v30.mdx @@ -1,1260 +1,3405 @@ --- title: "com.digitalasset.canton.sequencer.api.v30" -description: "Descriptor-backed protobuf API history for package com.digitalasset.canton.sequencer.api.v30." +description: "Package-level overview for com.digitalasset.canton.sequencer.api.v30." --- -# Package `com.digitalasset.canton.sequencer.api.v30` +

Back to overview

+ +
+ +

Protobuf Package

+ + +

com.digitalasset.canton.sequencer.api.v30

+ + +

4 services, 17 endpoints, 48 messages

+ + +
+ + gRPC + +
+ + +
+ +
+
Files
+
4
+
+ +
+
Services
+
4
+
+ +
+
Endpoints
+
17
+
+ +
+
Messages
+
48
+
+ +
+
Enums
+
0
+
+ +
+ +
-[Back to Canton Protobuf History](../index) - -## Snapshot - -- Current files: `4` -- Current services: `4` -- Current endpoints: `17` -- Current messages: `48` -- Current enums: `0` -- Lifecycle endpoints tracked: `17` ## Source Files -| File | Services | Messages | Enums | Source | -| --- | --- | --- | --- | --- | -| community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_authentication_service.proto | `1` | `1` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_authentication_service.proto#L4) | -| community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_channel_service.proto | `1` | `8` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_channel_service.proto#L4) | -| community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto | `1` | `1` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto#L4) | -| community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto | `1` | `17` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto#L4) | -## Services -| Service | Endpoints | Source | Description | -| --- | --- | --- | --- | -| [`SequencerAuthenticationService`](#service-com-digitalasset-canton-sequencer-api-v30-sequencerauthenticationservice) | `3` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_authentication_service.proto#L12) | Operations related to authentication tokens for calling sequencer operations | -| [`SequencerChannelService`](#service-com-digitalasset-canton-sequencer-api-v30-sequencerchannelservice) | `2` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_channel_service.proto#L13) | The service that a member can use to establish a bidirectional channel to another member via the sequencer | -| [`SequencerConnectService`](#service-com-digitalasset-canton-sequencer-api-v30-sequencerconnectservice) | `5` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto#L11) | | -| [`SequencerService`](#service-com-digitalasset-canton-sequencer-api-v30-sequencerservice) | `7` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto#L15) | The service that a member can use to send messages to the synchronizer and receive events from the synchronizer | - -### Service `SequencerAuthenticationService` +
+ + +
+ +
+

community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_authentication_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
1
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_authentication_service.proto
+
+ +
+ + +
+ + + +
+ +
+

community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_channel_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
8
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_channel_service.proto
+
+ +
+ + +
+ + + +
+ +
+

community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
1
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto
+
+ +
+ + +
+ + + +
+ +
+

community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
17
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto
+
+ +
+ + +
+ + +
+ + + + + +## SequencerAuthenticationService -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_authentication_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_authentication_service.proto#L12) -- Endpoints tracked: `3` Operations related to authentication tokens for calling sequencer operations -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`Authenticate`](#endpoint-com-digitalasset-canton-sequencer-api-v30-sequencerauthenticationservice-authenticate) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication.AuthenticateRequest`](#type-com-digitalasset-canton-sequencer-api-v30-sequencerauthentication-authenticaterequest) | [`com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication.AuthenticateResponse`](#type-com-digitalasset-canton-sequencer-api-v30-sequencerauthentication-authenticateresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_authentication_service.proto#L18) | -| [`Challenge`](#endpoint-com-digitalasset-canton-sequencer-api-v30-sequencerauthenticationservice-challenge) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication.ChallengeRequest`](#type-com-digitalasset-canton-sequencer-api-v30-sequencerauthentication-challengerequest) | [`com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication.ChallengeResponse`](#type-com-digitalasset-canton-sequencer-api-v30-sequencerauthentication-challengeresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_authentication_service.proto#L15) | -| [`Logout`](#endpoint-com-digitalasset-canton-sequencer-api-v30-sequencerauthenticationservice-logout) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication.LogoutRequest`](#type-com-digitalasset-canton-sequencer-api-v30-sequencerauthentication-logoutrequest) | [`com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication.LogoutResponse`](#type-com-digitalasset-canton-sequencer-api-v30-sequencerauthentication-logoutresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_authentication_service.proto#L20) | - - -**Endpoint `SequencerAuthenticationService.Authenticate`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_authentication_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_authentication_service.proto#L18) - -**Signature** - -```protobuf -rpc SequencerAuthenticationService.Authenticate(com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication.AuthenticateRequest) returns (com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication.AuthenticateResponse); -``` - -If provided with a correctly signed nonce, will return an authentication token - to be supplied to SequencerService operations - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication.AuthenticateRequest`](#type-com-digitalasset-canton-sequencer-api-v30-sequencerauthentication-authenticaterequest) - -**Response Type** - -- [`com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication.AuthenticateResponse`](#type-com-digitalasset-canton-sequencer-api-v30-sequencerauthentication-authenticateresponse) - - -**Endpoint `SequencerAuthenticationService.Challenge`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_authentication_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_authentication_service.proto#L15) - -**Signature** - -```protobuf -rpc SequencerAuthenticationService.Challenge(com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication.ChallengeRequest) returns (com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication.ChallengeResponse); -``` - -If provided with a supported protocol version, - will return a nonce and fingerprint of the expected key to sign this nonce - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication.ChallengeRequest`](#type-com-digitalasset-canton-sequencer-api-v30-sequencerauthentication-challengerequest) - -**Response Type** - -- [`com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication.ChallengeResponse`](#type-com-digitalasset-canton-sequencer-api-v30-sequencerauthentication-challengeresponse) - -**Endpoint `SequencerAuthenticationService.Logout`** +
+ +
+
Source file
+
community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_authentication_service.proto
+
+ +
+
Operations
+
3
+
+ +
+ + +
+ + + + +
+

SequencerAuthenticationService.Authenticate

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

If provided with a correctly signed nonce, will return an authentication token to be supplied to SequencerService operations

+ + +
+ +
+
Request
+
com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication.AuthenticateRequest
+
+ +
+
Response
+
com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication.AuthenticateResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SequencerAuthenticationService.Challenge

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

If provided with a supported protocol version, will return a nonce and fingerprint of the expected key to sign this nonce

+ + +
+ +
+
Request
+
com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication.ChallengeRequest
+
+ +
+
Response
+
com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication.ChallengeResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SequencerAuthenticationService.Logout

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Unconditionally revoke a member's authentication tokens and disconnect it

+ + +
+ +
+
Request
+
com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication.LogoutRequest
+
+ +
+
Response
+
com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication.LogoutResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## SequencerChannelService -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_authentication_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_authentication_service.proto#L20) - -**Signature** - -```protobuf -rpc SequencerAuthenticationService.Logout(com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication.LogoutRequest) returns (com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication.LogoutResponse); -``` - -Unconditionally revoke a member's authentication tokens and disconnect it - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication.LogoutRequest`](#type-com-digitalasset-canton-sequencer-api-v30-sequencerauthentication-logoutrequest) - -**Response Type** - -- [`com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication.LogoutResponse`](#type-com-digitalasset-canton-sequencer-api-v30-sequencerauthentication-logoutresponse) - - -### Service `SequencerChannelService` - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_channel_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_channel_service.proto#L13) -- Endpoints tracked: `2` The service that a member can use to establish a bidirectional channel to another member via the sequencer -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`ConnectToSequencerChannel`](#endpoint-com-digitalasset-canton-sequencer-api-v30-sequencerchannelservice-connecttosequencerchannel) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.sequencer.api.v30.ConnectToSequencerChannelRequest`](#type-com-digitalasset-canton-sequencer-api-v30-connecttosequencerchannelrequest) | [`com.digitalasset.canton.sequencer.api.v30.ConnectToSequencerChannelResponse`](#type-com-digitalasset-canton-sequencer-api-v30-connecttosequencerchannelresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_channel_service.proto#L17) | -| [`Ping`](#endpoint-com-digitalasset-canton-sequencer-api-v30-sequencerchannelservice-ping) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.sequencer.api.v30.PingRequest`](#type-com-digitalasset-canton-sequencer-api-v30-pingrequest) | [`com.digitalasset.canton.sequencer.api.v30.PingResponse`](#type-com-digitalasset-canton-sequencer-api-v30-pingresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_channel_service.proto#L20) | - - -**Endpoint `SequencerChannelService.ConnectToSequencerChannel`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_channel_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_channel_service.proto#L17) - -**Signature** - -```protobuf -rpc SequencerChannelService.ConnectToSequencerChannel(stream com.digitalasset.canton.sequencer.api.v30.ConnectToSequencerChannelRequest) returns (stream com.digitalasset.canton.sequencer.api.v30.ConnectToSequencerChannelResponse); -``` - -Request to connect to a channel and begin interacting with it via bidirectional streams mostly opaque to the - sequencer channel service (except for a handful of initialization messages). - The sequencer channel service forwards requests from one member as responses to another member. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.sequencer.api.v30.ConnectToSequencerChannelRequest`](#type-com-digitalasset-canton-sequencer-api-v30-connecttosequencerchannelrequest) - -**Response Type** - -- [`com.digitalasset.canton.sequencer.api.v30.ConnectToSequencerChannelResponse`](#type-com-digitalasset-canton-sequencer-api-v30-connecttosequencerchannelresponse) - - -**Endpoint `SequencerChannelService.Ping`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_channel_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_channel_service.proto#L20) - -**Signature** - -```protobuf -rpc SequencerChannelService.Ping(com.digitalasset.canton.sequencer.api.v30.PingRequest) returns (com.digitalasset.canton.sequencer.api.v30.PingResponse); -``` - -Ping to check if the sequencer supports and has enabled channels. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.sequencer.api.v30.PingRequest`](#type-com-digitalasset-canton-sequencer-api-v30-pingrequest) - -**Response Type** - -- [`com.digitalasset.canton.sequencer.api.v30.PingResponse`](#type-com-digitalasset-canton-sequencer-api-v30-pingresponse) - - -### Service `SequencerConnectService` - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto#L11) -- Endpoints tracked: `5` - -_No description._ - -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`GetSynchronizerId`](#endpoint-com-digitalasset-canton-sequencer-api-v30-sequencerconnectservice-getsynchronizerid) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.sequencer.api.v30.SequencerConnect.GetSynchronizerIdRequest`](#type-com-digitalasset-canton-sequencer-api-v30-sequencerconnect-getsynchronizeridrequest) | [`com.digitalasset.canton.sequencer.api.v30.SequencerConnect.GetSynchronizerIdResponse`](#type-com-digitalasset-canton-sequencer-api-v30-sequencerconnect-getsynchronizeridresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto#L13) | -| [`GetSynchronizerParameters`](#endpoint-com-digitalasset-canton-sequencer-api-v30-sequencerconnectservice-getsynchronizerparameters) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.sequencer.api.v30.SequencerConnect.GetSynchronizerParametersRequest`](#type-com-digitalasset-canton-sequencer-api-v30-sequencerconnect-getsynchronizerparametersrequest) | [`com.digitalasset.canton.sequencer.api.v30.SequencerConnect.GetSynchronizerParametersResponse`](#type-com-digitalasset-canton-sequencer-api-v30-sequencerconnect-getsynchronizerparametersresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto#L14) | -| [`Handshake`](#endpoint-com-digitalasset-canton-sequencer-api-v30-sequencerconnectservice-handshake) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.sequencer.api.v30.SequencerConnect.HandshakeRequest`](#type-com-digitalasset-canton-sequencer-api-v30-sequencerconnect-handshakerequest) | [`com.digitalasset.canton.sequencer.api.v30.SequencerConnect.HandshakeResponse`](#type-com-digitalasset-canton-sequencer-api-v30-sequencerconnect-handshakeresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto#L12) | -| [`RegisterOnboardingTopologyTransactions`](#endpoint-com-digitalasset-canton-sequencer-api-v30-sequencerconnectservice-registeronboardingtopologytransactions) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.sequencer.api.v30.SequencerConnect.RegisterOnboardingTopologyTransactionsRequest`](#type-com-digitalasset-canton-sequencer-api-v30-sequencerconnect-registeronboardingtopologytransactionsrequest) | [`com.digitalasset.canton.sequencer.api.v30.SequencerConnect.RegisterOnboardingTopologyTransactionsResponse`](#type-com-digitalasset-canton-sequencer-api-v30-sequencerconnect-registeronboardingtopologytransactionsresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto#L16) | -| [`VerifyActive`](#endpoint-com-digitalasset-canton-sequencer-api-v30-sequencerconnectservice-verifyactive) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.sequencer.api.v30.SequencerConnect.VerifyActiveRequest`](#type-com-digitalasset-canton-sequencer-api-v30-sequencerconnect-verifyactiverequest) | [`com.digitalasset.canton.sequencer.api.v30.SequencerConnect.VerifyActiveResponse`](#type-com-digitalasset-canton-sequencer-api-v30-sequencerconnect-verifyactiveresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto#L15) | - - -**Endpoint `SequencerConnectService.GetSynchronizerId`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto#L13) - -**Signature** - -```protobuf -rpc SequencerConnectService.GetSynchronizerId(com.digitalasset.canton.sequencer.api.v30.SequencerConnect.GetSynchronizerIdRequest) returns (com.digitalasset.canton.sequencer.api.v30.SequencerConnect.GetSynchronizerIdResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.sequencer.api.v30.SequencerConnect.GetSynchronizerIdRequest`](#type-com-digitalasset-canton-sequencer-api-v30-sequencerconnect-getsynchronizeridrequest) - -**Response Type** - -- [`com.digitalasset.canton.sequencer.api.v30.SequencerConnect.GetSynchronizerIdResponse`](#type-com-digitalasset-canton-sequencer-api-v30-sequencerconnect-getsynchronizeridresponse) - - -**Endpoint `SequencerConnectService.GetSynchronizerParameters`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto#L14) - -**Signature** - -```protobuf -rpc SequencerConnectService.GetSynchronizerParameters(com.digitalasset.canton.sequencer.api.v30.SequencerConnect.GetSynchronizerParametersRequest) returns (com.digitalasset.canton.sequencer.api.v30.SequencerConnect.GetSynchronizerParametersResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.sequencer.api.v30.SequencerConnect.GetSynchronizerParametersRequest`](#type-com-digitalasset-canton-sequencer-api-v30-sequencerconnect-getsynchronizerparametersrequest) - -**Response Type** - -- [`com.digitalasset.canton.sequencer.api.v30.SequencerConnect.GetSynchronizerParametersResponse`](#type-com-digitalasset-canton-sequencer-api-v30-sequencerconnect-getsynchronizerparametersresponse) - - -**Endpoint `SequencerConnectService.Handshake`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto#L12) - -**Signature** - -```protobuf -rpc SequencerConnectService.Handshake(com.digitalasset.canton.sequencer.api.v30.SequencerConnect.HandshakeRequest) returns (com.digitalasset.canton.sequencer.api.v30.SequencerConnect.HandshakeResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.sequencer.api.v30.SequencerConnect.HandshakeRequest`](#type-com-digitalasset-canton-sequencer-api-v30-sequencerconnect-handshakerequest) - -**Response Type** - -- [`com.digitalasset.canton.sequencer.api.v30.SequencerConnect.HandshakeResponse`](#type-com-digitalasset-canton-sequencer-api-v30-sequencerconnect-handshakeresponse) - - -**Endpoint `SequencerConnectService.RegisterOnboardingTopologyTransactions`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto#L16) -**Signature** +
+ +
+
Source file
+
community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_channel_service.proto
+
+ +
+
Operations
+
2
+
+ +
+ + +
+ + + + +
+

SequencerChannelService.ConnectToSequencerChannel

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Request to connect to a channel and begin interacting with it via bidirectional streams mostly opaque to the sequencer channel service (except for a handful of initialization me...

+ + +
+ +
+
Request
+
com.digitalasset.canton.sequencer.api.v30.ConnectToSequencerChannelRequest
+
+ +
+
Response
+
com.digitalasset.canton.sequencer.api.v30.ConnectToSequencerChannelResponse
+
+ +
+
Client stream
+
Yes
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + + + + + +
+

SequencerChannelService.Ping

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Ping to check if the sequencer supports and has enabled channels.

+ + +
+ +
+
Request
+
com.digitalasset.canton.sequencer.api.v30.PingRequest
+
+ +
+
Response
+
com.digitalasset.canton.sequencer.api.v30.PingResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## SequencerConnectService + + + +
+ +
+
Source file
+
community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto
+
+ +
+
Operations
+
5
+
+ +
+ + +
+ + + + +
+

SequencerConnectService.GetSynchronizerId

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc SequencerConnectService.GetSynchronizerId(com.digitalasset.canton.sequencer.api.v30.SequencerConnect.GetSynchronizerIdRequest) returns (com.digitalasset.canton.sequencer.api...

+ + +
+ +
+
Request
+
com.digitalasset.canton.sequencer.api.v30.SequencerConnect.GetSynchronizerIdRequest
+
+ +
+
Response
+
com.digitalasset.canton.sequencer.api.v30.SequencerConnect.GetSynchronizerIdResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SequencerConnectService.GetSynchronizerParameters

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc SequencerConnectService.GetSynchronizerParameters(com.digitalasset.canton.sequencer.api.v30.SequencerConnect.GetSynchronizerParametersRequest) returns (com.digitalasset.cant...

+ + +
+ +
+
Request
+
com.digitalasset.canton.sequencer.api.v30.SequencerConnect.GetSynchronizerParametersRequest
+
+ +
+
Response
+
com.digitalasset.canton.sequencer.api.v30.SequencerConnect.GetSynchronizerParametersResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SequencerConnectService.Handshake

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc SequencerConnectService.Handshake(com.digitalasset.canton.sequencer.api.v30.SequencerConnect.HandshakeRequest) returns (com.digitalasset.canton.sequencer.api.v30.SequencerCo...

+ + +
+ +
+
Request
+
com.digitalasset.canton.sequencer.api.v30.SequencerConnect.HandshakeRequest
+
+ +
+
Response
+
com.digitalasset.canton.sequencer.api.v30.SequencerConnect.HandshakeResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SequencerConnectService.RegisterOnboardingTopologyTransactions

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc SequencerConnectService.RegisterOnboardingTopologyTransactions(com.digitalasset.canton.sequencer.api.v30.SequencerConnect.RegisterOnboardingTopologyTransactionsRequest) retu...

+ + +
+ +
+
Request
+
com.digitalasset.canton.sequencer.api.v30.SequencerConnect.RegisterOnboardingTopologyTransactionsRequest
+
+ +
+
Response
+
com.digitalasset.canton.sequencer.api.v30.SequencerConnect.RegisterOnboardingTopologyTransactionsResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SequencerConnectService.VerifyActive

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc SequencerConnectService.VerifyActive(com.digitalasset.canton.sequencer.api.v30.SequencerConnect.VerifyActiveRequest) returns (com.digitalasset.canton.sequencer.api.v30.Seque...

+ + +
+ +
+
Request
+
com.digitalasset.canton.sequencer.api.v30.SequencerConnect.VerifyActiveRequest
+
+ +
+
Response
+
com.digitalasset.canton.sequencer.api.v30.SequencerConnect.VerifyActiveResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## SequencerService -```protobuf -rpc SequencerConnectService.RegisterOnboardingTopologyTransactions(com.digitalasset.canton.sequencer.api.v30.SequencerConnect.RegisterOnboardingTopologyTransactionsRequest) returns (com.digitalasset.canton.sequencer.api.v30.SequencerConnect.RegisterOnboardingTopologyTransactionsResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.sequencer.api.v30.SequencerConnect.RegisterOnboardingTopologyTransactionsRequest`](#type-com-digitalasset-canton-sequencer-api-v30-sequencerconnect-registeronboardingtopologytransactionsrequest) - -**Response Type** - -- [`com.digitalasset.canton.sequencer.api.v30.SequencerConnect.RegisterOnboardingTopologyTransactionsResponse`](#type-com-digitalasset-canton-sequencer-api-v30-sequencerconnect-registeronboardingtopologytransactionsresponse) - - -**Endpoint `SequencerConnectService.VerifyActive`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto#L15) - -**Signature** - -```protobuf -rpc SequencerConnectService.VerifyActive(com.digitalasset.canton.sequencer.api.v30.SequencerConnect.VerifyActiveRequest) returns (com.digitalasset.canton.sequencer.api.v30.SequencerConnect.VerifyActiveResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.sequencer.api.v30.SequencerConnect.VerifyActiveRequest`](#type-com-digitalasset-canton-sequencer-api-v30-sequencerconnect-verifyactiverequest) - -**Response Type** - -- [`com.digitalasset.canton.sequencer.api.v30.SequencerConnect.VerifyActiveResponse`](#type-com-digitalasset-canton-sequencer-api-v30-sequencerconnect-verifyactiveresponse) - - -### Service `SequencerService` - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto#L15) -- Endpoints tracked: `7` The service that a member can use to send messages to the synchronizer and receive events from the synchronizer -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`AcknowledgeSigned`](#endpoint-com-digitalasset-canton-sequencer-api-v30-sequencerservice-acknowledgesigned) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.sequencer.api.v30.AcknowledgeSignedRequest`](#type-com-digitalasset-canton-sequencer-api-v30-acknowledgesignedrequest) | [`com.digitalasset.canton.sequencer.api.v30.AcknowledgeSignedResponse`](#type-com-digitalasset-canton-sequencer-api-v30-acknowledgesignedresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto#L92) | -| [`DownloadTopologyStateForInit`](#endpoint-com-digitalasset-canton-sequencer-api-v30-sequencerservice-downloadtopologystateforinit) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.sequencer.api.v30.DownloadTopologyStateForInitRequest`](#type-com-digitalasset-canton-sequencer-api-v30-downloadtopologystateforinitrequest) | [`com.digitalasset.canton.sequencer.api.v30.DownloadTopologyStateForInitResponse`](#type-com-digitalasset-canton-sequencer-api-v30-downloadtopologystateforinitresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto#L96) | -| [`DownloadTopologyStateForInitHash`](#endpoint-com-digitalasset-canton-sequencer-api-v30-sequencerservice-downloadtopologystateforinithash) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.sequencer.api.v30.DownloadTopologyStateForInitHashRequest`](#type-com-digitalasset-canton-sequencer-api-v30-downloadtopologystateforinithashrequest) | [`com.digitalasset.canton.sequencer.api.v30.DownloadTopologyStateForInitHashResponse`](#type-com-digitalasset-canton-sequencer-api-v30-downloadtopologystateforinithashresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto#L100) | -| [`GetTime`](#endpoint-com-digitalasset-canton-sequencer-api-v30-sequencerservice-gettime) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.sequencer.api.v30.GetTimeRequest`](#type-com-digitalasset-canton-sequencer-api-v30-gettimerequest) | [`com.digitalasset.canton.sequencer.api.v30.GetTimeResponse`](#type-com-digitalasset-canton-sequencer-api-v30-gettimeresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto#L108) | -| [`GetTrafficStateForMember`](#endpoint-com-digitalasset-canton-sequencer-api-v30-sequencerservice-gettrafficstateformember) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.sequencer.api.v30.GetTrafficStateForMemberRequest`](#type-com-digitalasset-canton-sequencer-api-v30-gettrafficstateformemberrequest) | [`com.digitalasset.canton.sequencer.api.v30.GetTrafficStateForMemberResponse`](#type-com-digitalasset-canton-sequencer-api-v30-gettrafficstateformemberresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto#L103) | -| [`SendAsync`](#endpoint-com-digitalasset-canton-sequencer-api-v30-sequencerservice-sendasync) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.sequencer.api.v30.SendAsyncRequest`](#type-com-digitalasset-canton-sequencer-api-v30-sendasyncrequest) | [`com.digitalasset.canton.sequencer.api.v30.SendAsyncResponse`](#type-com-digitalasset-canton-sequencer-api-v30-sendasyncresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto#L75) | -| [`Subscribe`](#endpoint-com-digitalasset-canton-sequencer-api-v30-sequencerservice-subscribe) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.sequencer.api.v30.SubscriptionRequest`](#type-com-digitalasset-canton-sequencer-api-v30-subscriptionrequest) | [`com.digitalasset.canton.sequencer.api.v30.SubscriptionResponse`](#type-com-digitalasset-canton-sequencer-api-v30-subscriptionresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto#L84) | - - -**Endpoint `SequencerService.AcknowledgeSigned`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto#L92) - -**Signature** - -```protobuf -rpc SequencerService.AcknowledgeSigned(com.digitalasset.canton.sequencer.api.v30.AcknowledgeSignedRequest) returns (com.digitalasset.canton.sequencer.api.v30.AcknowledgeSignedResponse); -``` - -Allows a member to acknowledge that they have read all events up to and including the provided timestamp, - and that they will never re-read these events again. This information is currently only used for informational - purposes and to provide a watermark for which it is safe to prune earlier events from the sequencer data stores. - There is no requirement for every event to be individually acknowledged, and in fact callers are encouraged to - only periodically record acknowledgements (at an interval of minutes is expected to be more than sufficient for - pruning). - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.sequencer.api.v30.AcknowledgeSignedRequest`](#type-com-digitalasset-canton-sequencer-api-v30-acknowledgesignedrequest) - -**Response Type** - -- [`com.digitalasset.canton.sequencer.api.v30.AcknowledgeSignedResponse`](#type-com-digitalasset-canton-sequencer-api-v30-acknowledgesignedresponse) - - -**Endpoint `SequencerService.DownloadTopologyStateForInit`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto#L96) - -**Signature** - -```protobuf -rpc SequencerService.DownloadTopologyStateForInit(com.digitalasset.canton.sequencer.api.v30.DownloadTopologyStateForInitRequest) returns (stream com.digitalasset.canton.sequencer.api.v30.DownloadTopologyStateForInitResponse); -``` - -Download the topology state for a member up to including the topology transaction that made the member - known on the synchronizer. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.sequencer.api.v30.DownloadTopologyStateForInitRequest`](#type-com-digitalasset-canton-sequencer-api-v30-downloadtopologystateforinitrequest) - -**Response Type** - -- [`com.digitalasset.canton.sequencer.api.v30.DownloadTopologyStateForInitResponse`](#type-com-digitalasset-canton-sequencer-api-v30-downloadtopologystateforinitresponse) - - -**Endpoint `SequencerService.DownloadTopologyStateForInitHash`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto#L100) - -**Signature** - -```protobuf -rpc SequencerService.DownloadTopologyStateForInitHash(com.digitalasset.canton.sequencer.api.v30.DownloadTopologyStateForInitHashRequest) returns (com.digitalasset.canton.sequencer.api.v30.DownloadTopologyStateForInitHashResponse); -``` - -Returns a hash of a result equivalent to DownloadTopologyStateForInit call - for a BFT check without transferring the full state. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.sequencer.api.v30.DownloadTopologyStateForInitHashRequest`](#type-com-digitalasset-canton-sequencer-api-v30-downloadtopologystateforinithashrequest) - -**Response Type** - -- [`com.digitalasset.canton.sequencer.api.v30.DownloadTopologyStateForInitHashResponse`](#type-com-digitalasset-canton-sequencer-api-v30-downloadtopologystateforinithashresponse) - - -**Endpoint `SequencerService.GetTime`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto#L108) - -**Signature** - -```protobuf -rpc SequencerService.GetTime(com.digitalasset.canton.sequencer.api.v30.GetTimeRequest) returns (com.digitalasset.canton.sequencer.api.v30.GetTimeResponse); -``` - -Return a "current" sequencing time such that, when a `SendAsync` operation is - subsequently called, if sequenced, the sequencing time of the resulting event is guaranteed to - be later than the sequencing time previously returned by the `GetTime` call. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.sequencer.api.v30.GetTimeRequest`](#type-com-digitalasset-canton-sequencer-api-v30-gettimerequest) - -**Response Type** - -- [`com.digitalasset.canton.sequencer.api.v30.GetTimeResponse`](#type-com-digitalasset-canton-sequencer-api-v30-gettimeresponse) - - -**Endpoint `SequencerService.GetTrafficStateForMember`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto#L103) - -**Signature** - -```protobuf -rpc SequencerService.GetTrafficStateForMember(com.digitalasset.canton.sequencer.api.v30.GetTrafficStateForMemberRequest) returns (com.digitalasset.canton.sequencer.api.v30.GetTrafficStateForMemberResponse); -``` - -Return the currently known traffic state for a member. Callers must be authorized to request the traffic state. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.sequencer.api.v30.GetTrafficStateForMemberRequest`](#type-com-digitalasset-canton-sequencer-api-v30-gettrafficstateformemberrequest) - -**Response Type** - -- [`com.digitalasset.canton.sequencer.api.v30.GetTrafficStateForMemberResponse`](#type-com-digitalasset-canton-sequencer-api-v30-gettrafficstateformemberresponse) - - -**Endpoint `SequencerService.SendAsync`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto#L75) - -**Signature** - -```protobuf -rpc SequencerService.SendAsync(com.digitalasset.canton.sequencer.api.v30.SendAsyncRequest) returns (com.digitalasset.canton.sequencer.api.v30.SendAsyncResponse); -``` - -Submit a request to the sequencer. - - A request contains a batch, which is a sequence of envelopes. - Every envelope consists of its content and a set of recipients, arranged in a forest. - A synchronizer member is intended to receive those envelopes of a batch that contain the member as a recipient. - A synchronizer member is supposed to learn about those recipients of an envelope that are - (1) specified at a node that also specifies the member or - (2) at a descendant thereof. (I.e., a node further down in the recipient forest.) - - The sequencer may or may not accept a request. - If an incoming request is valid (i.e., it can be parsed and every field meets its documented validity conditions) - an honest sequencer will accept requests in a best effort manner, provided resource limits are met. - - For every accepted request, the sequencer assigns a unique sequencing timestamp to the request. - All honest sequencers of the synchronizer will deliver an event to the sender and - to those synchronizer members that are intended to receive at least one envelope. - - Honest sequencers may deliver to all sequencers of the synchronizer events that don't correspond to submitted requests. - Sequencer implementations may leverage this mechanism for internal purposes. - - An event for a synchronizer member contains only those envelopes of the batch of the request - that the member is intended to receive and - the recipients of an envelope contains only those that the member is supposed to learn about. - A member will receive the envelopes of the same request within a single event. - A member will receive events ordered by sequencing timestamp. - - If a request is accepted, the sender will receive a corresponding event, called "receipt"; - so that the sender is informed that the sequencer has accepted the request. - If the sender is not a recipient of the request, the receipt has an empty batch. - - If the request contains an aggregation rule, the sequencer will process requests in an aggregated fashion. - A set of requests belong to the same aggregation, if they have essentially the same contents (details specified at SubmissionRequest.aggregationId). - The sequencer validates and assigns sequencing timestamps to requests within an aggregation just as for requests without an aggregation rule. - The sequencer emits events and receipts for an accepted request within an aggregation as follows: - - As long as the number of accepted requests is strictly less than AggregationRule.threshold, - the sequencer only emits a receipt with an empty batch to the sender of the request. - It does not emit any other events. - - As soon as the number of accepted requests equals AggregationRule.threshold, the sequencer emits - events to the sender and the recipients of the request. - The sequencing timestamp of the events is the sequencing timestamp of the last accepted request. - - The sequencer will not accept more than AggregationRule.threshold requests. - The sequencer will reject any further request that could otherwise be accepted. - Consequently, events for the request are delivered only once even if the threshold is attained multiple times. - - If the request does not contain an aggregation rule, even honest sequencers may deliver events for the request - more than once (with different sequencing timestamps), as malicious sequencers may replay a request internally. - Clients need to implement appropriate deduplication, if at-most-once delivery is needed. - Once request.max_sequencing_time has elapsed (i.e. an event with an equal or higher timestamp has been emitted), - an honest sequencer will not emit events corresponding to request anymore. - - The sequencer may reject a request, e.g., because the request is invalid or the sequencer is overloaded. - The sequencer will indicate a rejection (independently of whether there is an aggregation rule) - in exactly one of the following ways: - (1) synchronously, by returning an error in the response of this method - (2) asynchronously, by emitting an error in the response to SubscribeVersioned to the sender and - possibly an empty batch to non-sender recipients - (3) by not emitting a receipt to the sender until request.max_sequencing_time - Note that only (2) and (3) can be trusted. A malicious sequencer may synchronously return an error and - still accept the request internally and therefore emit events later on. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.sequencer.api.v30.SendAsyncRequest`](#type-com-digitalasset-canton-sequencer-api-v30-sendasyncrequest) - -**Response Type** - -- [`com.digitalasset.canton.sequencer.api.v30.SendAsyncResponse`](#type-com-digitalasset-canton-sequencer-api-v30-sendasyncresponse) - - -**Endpoint `SequencerService.Subscribe`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto#L84) - -**Signature** - -```protobuf -rpc SequencerService.Subscribe(com.digitalasset.canton.sequencer.api.v30.SubscriptionRequest) returns (stream com.digitalasset.canton.sequencer.api.v30.SubscriptionResponse); -``` - -Establishes a stream with the server to receive sequenced events from the synchronizer after the given - counter. The delivered events will have a reference to the previous event (its timestamp) - and a strictly monotonically increasing timestamp. - - The call fails synchronously, if the request is invalid, i.e., some field violates a documented validity condition. - The call fails asynchronously, if the sequencer does not have a key to sign the event; this may occur if - event.topology_timestamp refers to a time before the sequencer has been onboarded. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.sequencer.api.v30.SubscriptionRequest`](#type-com-digitalasset-canton-sequencer-api-v30-subscriptionrequest) - -**Response Type** - -- [`com.digitalasset.canton.sequencer.api.v30.SubscriptionResponse`](#type-com-digitalasset-canton-sequencer-api-v30-subscriptionresponse) - -## Type Reference - - -**Message `com.digitalasset.canton.sequencer.api.v30.AcknowledgeRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto#L161) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| member | `string` | optional | Who is the acknowledgement being sent on behalf of | -| timestamp | `int64` | optional | The timestamp in sequencer time that they are acknowledging and will not re-read earlier events.
It is expected that the caller has a received an event with this timestamp but this is not validated.
In microseconds of UTC time since Unix epoch | - - -**Message `com.digitalasset.canton.sequencer.api.v30.AcknowledgeResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto#L173) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.sequencer.api.v30.AcknowledgeSignedRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto#L175) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| signed_acknowledge_request | `bytes` | optional | contains a versioned AcknowledgeRequest
TODO(i17383): Have exactly one signature instead of multiple signatures.
Serialized SignedContent[AcknowledgeRequest] | - - -**Message `com.digitalasset.canton.sequencer.api.v30.AcknowledgeSignedResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto#L182) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.sequencer.api.v30.ConnectToSequencerChannelRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_channel_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_channel_service.proto#L42) -- Fields: 5 - -The sequencer channel service protocol consists of several messages which are sent as a request or a response - (that is as a ConnectToSequencerChannelRequest or a ConnectToSequencerChannelResponse). - - The protocol transitions through several stages. - - To bootstrap the channel, initialization messages between the sequencer channel client and service need to be - exchanged, that are SequencerChannelMetadata and SequencerChannelConnectedToAllEndpoints messages. - - To secure the channel, sequencer channel client member endpoints setup a session key with the - SequencerChannelSessionKey and SequencerChannelSessionKeyAck messages. - - To transfer data through the channel, members use opaque (encrypted) payload messages which the sequencer channel - service forwards between channel member endpoints. - - Using payload messages channel client users can implement their own application protocol such as the - Online Party Replication. - - Note that both, request and response need to implement SequencerChannelSessionKey and SequencerChannelSessionKeyAck - messages because of the bidirectional gRPC streams. For example, when the sequencer channel service receives a - SequencerChannelSessionKeyAck request message from a sequencer channel client, it needs to forward it as a - SequencerChannelSessionKeyAck response message to the destination sequencer channel client. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| metadata | [`com.digitalasset.canton.sequencer.api.v30.SequencerChannelMetadata`](#type-com-digitalasset-canton-sequencer-api-v30-sequencerchannelmetadata) | optional | Exactly the first message of the channel request stream must be SequencerChannelMetadata
for use by the sequencer channel service to match channel endpoint members. | -| session_key | [`com.digitalasset.canton.sequencer.api.v30.SequencerChannelSessionKey`](#type-com-digitalasset-canton-sequencer-api-v30-sequencerchannelsessionkey) | optional | SequencerChannelSessionKey and SequencerChannelSessionKeyAck are used to send and acknowledge an asymmetrically
encrypted session key between the sequencer channel client endpoints. The SequencerChannelSessionKey is opaque to
sequencer channel service. | -| session_key_acknowledgement | [`com.digitalasset.canton.sequencer.api.v30.SequencerChannelSessionKeyAck`](#type-com-digitalasset-canton-sequencer-api-v30-sequencerchannelsessionkeyack) | optional | | -| payload | `bytes` | optional | Payload is opaque to the sequencer channel service and client. | -| trace_context | [`com.digitalasset.canton.v30.TraceContext`](com-digitalasset-canton-v30#type-com-digitalasset-canton-v30-tracecontext) | optional | Canton trace context
Required | - - -**Message `com.digitalasset.canton.sequencer.api.v30.ConnectToSequencerChannelResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_channel_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_channel_service.proto#L64) -- Fields: 5 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| connected | [`com.digitalasset.canton.sequencer.api.v30.SequencerChannelConnectedToAllEndpoints`](#type-com-digitalasset-canton-sequencer-api-v30-sequencerchannelconnectedtoallendpoints) | optional | Exactly the first message of the channel response stream must be SequencerChannelConnectedToAllEndpoints
for use by the sequencer channel client to notify the request initiator that the channel is ready for use. | -| session_key | [`com.digitalasset.canton.sequencer.api.v30.SequencerChannelSessionKey`](#type-com-digitalasset-canton-sequencer-api-v30-sequencerchannelsessionkey) | optional | SequencerChannelSessionKey and SequencerChannelSessionKeyAck are used to send and acknowledge an asymmetrically
encrypted session key between the sequencer channel client endpoints. The SequencerChannelSessionKey is opaque to
sequencer channel service. | -| session_key_acknowledgement | [`com.digitalasset.canton.sequencer.api.v30.SequencerChannelSessionKeyAck`](#type-com-digitalasset-canton-sequencer-api-v30-sequencerchannelsessionkeyack) | optional | | -| payload | `bytes` | optional | Payload is opaque to the sequencer channel service and client. | -| trace_context | [`com.digitalasset.canton.v30.TraceContext`](com-digitalasset-canton-v30#type-com-digitalasset-canton-v30-tracecontext) | optional | Canton trace context
Required | - - -**Message `com.digitalasset.canton.sequencer.api.v30.DownloadTopologyStateForInitHashRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto#L195) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| member | `string` | optional | Member for which to get the topology state hash | - - -**Message `com.digitalasset.canton.sequencer.api.v30.DownloadTopologyStateForInitHashResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto#L202) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| topology_state_hash | `bytes` | optional | Hash of contents of a call to DownloadTopologyStateForInit | - - -**Message `com.digitalasset.canton.sequencer.api.v30.DownloadTopologyStateForInitRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto#L184) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| member | `string` | optional | Member for which to get the topology state | - - -**Message `com.digitalasset.canton.sequencer.api.v30.DownloadTopologyStateForInitResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto#L191) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| topology_transactions | [`com.digitalasset.canton.topology.admin.v30.TopologyTransactions`](com-digitalasset-canton-topology-admin-v30#type-com-digitalasset-canton-topology-admin-v30-topologytransactions) | optional | | - - -**Message `com.digitalasset.canton.sequencer.api.v30.GetTimeRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto#L224) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.sequencer.api.v30.GetTimeResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto#L228) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| sequencing_timestamp | `int64` | optional | The result can be empty if the sequencer is still initializing. | - - -**Message `com.digitalasset.canton.sequencer.api.v30.GetTrafficStateForMemberRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto#L209) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| member | `string` | optional | Member for which to get the traffic state | -| timestamp | `int64` | optional | Timestamp at which to to get the traffic state | - - -**Message `com.digitalasset.canton.sequencer.api.v30.GetTrafficStateForMemberResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto#L218) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| traffic_state | [`com.digitalasset.canton.protocol.v30.TrafficState`](com-digitalasset-canton-protocol-v30#type-com-digitalasset-canton-protocol-v30-trafficstate) | optional | | - - -**Message `com.digitalasset.canton.sequencer.api.v30.PingRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_channel_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_channel_service.proto#L86) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.sequencer.api.v30.PingResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_channel_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_channel_service.proto#L90) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.sequencer.api.v30.SendAsyncRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto#L111) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| signed_submission_request | `bytes` | optional | Contains a versioned SignedContent which itself contains a versioned SubmissionRequest.
TODO(i17383): Have exactly one signature instead of multiple signatures. | - - -**Message `com.digitalasset.canton.sequencer.api.v30.SendAsyncResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto#L131) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_authentication_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_authentication_service.proto#L23) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication.ChallengeRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_authentication_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_authentication_service.proto#L24) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| member | `string` | optional | | -| member_protocol_versions | `int32` | repeated | | - - -**Message `com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication.ChallengeResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_authentication_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_authentication_service.proto#L29) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| nonce | `bytes` | optional | random nonce to be used for authentication | -| fingerprints | `string` | repeated | A hint containing fingerprints of keys that the sequencer considers valid
This is helpful, because the client does not necessarily have the current topology state before connecting. | - - -**Message `com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication.AuthenticateRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_authentication_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_authentication_service.proto#L37) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| member | `string` | optional | member sending request | -| signature | [`com.digitalasset.canton.crypto.v30.Signature`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-signature) | optional | signature of the handshake nonce
Any key that is valid at time of verification may be used | -| nonce | `bytes` | optional | nonce value that was signed is sent back to identify the challenge | - - -**Message `com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication.AuthenticateResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_authentication_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_authentication_service.proto#L47) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| token | `bytes` | optional | | -| expires_at | `google.protobuf.Timestamp` | optional | | - - -**Message `com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication.LogoutRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_authentication_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_authentication_service.proto#L52) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| token | `bytes` | optional | token to identify the member to invalidate | - - -**Message `com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication.LogoutResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_authentication_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_authentication_service.proto#L57) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.sequencer.api.v30.SequencerChannelConnectedToAllEndpoints`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_channel_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_channel_service.proto#L111) -- Fields: 0 - -Notification that a sequencer channel has been connected to the members specified in the SequencerChannelMetadata. - - -**Message `com.digitalasset.canton.sequencer.api.v30.SequencerChannelMetadata`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_channel_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_channel_service.proto#L95) -- Fields: 3 - -Metadata for a sequencer channel to be established between two members. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| channel_id | `string` | optional | Channel identifier
Required | -| initiating_member | `string` | optional | The member initiating the channel connect request
Required | -| receiving_member | `string` | optional | The member to connect to via the channel
Required | - - -**Message `com.digitalasset.canton.sequencer.api.v30.SequencerChannelSessionKey`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_channel_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_channel_service.proto#L116) -- Fields: 1 - -Public key encrypted session key to secure the communication between two members. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| encrypted_session_key | [`com.digitalasset.canton.crypto.v30.AsymmetricEncrypted`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-asymmetricencrypted) | optional | The public key is determined by the timestamp as agreed by the connecting members beforehand.
The timestamp is expected to originate from a recent topology transaction that has already taken effect;
meaning it's not a future timestamp.
Required | - - -**Message `com.digitalasset.canton.sequencer.api.v30.SequencerChannelSessionKeyAck`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_channel_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_channel_service.proto#L127) -- Fields: 0 - -Acknowledgement that the session key has been received - - -**Message `com.digitalasset.canton.sequencer.api.v30.SequencerConnect`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto#L19) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.sequencer.api.v30.SequencerConnect.HandshakeRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto#L24) -- Fields: 2 - -Messages for performing a version handshake with a sequencer service - Reused between sequencer services - IMPORTANT: changing the version handshakes can lead to issues with upgrading synchronizers - be very careful - when changing the handshake message format - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| client_protocol_versions | `int32` | repeated | | -| minimum_protocol_version | `int32` | optional | | - - -**Message `com.digitalasset.canton.sequencer.api.v30.SequencerConnect.HandshakeResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto#L29) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| server_protocol_version | `int32` | optional | | -| success | [`com.digitalasset.canton.sequencer.api.v30.SequencerConnect.HandshakeResponse.Success`](#type-com-digitalasset-canton-sequencer-api-v30-sequencerconnect-handshakeresponse-success) | optional | | -| failure | [`com.digitalasset.canton.sequencer.api.v30.SequencerConnect.HandshakeResponse.Failure`](#type-com-digitalasset-canton-sequencer-api-v30-sequencerconnect-handshakeresponse-failure) | optional | | - - -**Message `com.digitalasset.canton.sequencer.api.v30.SequencerConnect.HandshakeResponse.Success`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto#L36) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.sequencer.api.v30.SequencerConnect.HandshakeResponse.Failure`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto#L38) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| reason | `string` | optional | | - - -**Message `com.digitalasset.canton.sequencer.api.v30.SequencerConnect.GetSynchronizerIdRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto#L43) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.sequencer.api.v30.SequencerConnect.GetSynchronizerIdResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto#L45) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| physical_synchronizer_id | `string` | optional | | -| sequencer_uid | `string` | optional | | - - -**Message `com.digitalasset.canton.sequencer.api.v30.SequencerConnect.GetSynchronizerParametersRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto#L50) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.sequencer.api.v30.SequencerConnect.GetSynchronizerParametersResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto#L52) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| parameters_v1 | [`com.digitalasset.canton.protocol.v30.StaticSynchronizerParameters`](com-digitalasset-canton-protocol-v30#type-com-digitalasset-canton-protocol-v30-staticsynchronizerparameters) | optional | | - - -**Message `com.digitalasset.canton.sequencer.api.v30.SequencerConnect.VerifyActiveRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto#L58) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.sequencer.api.v30.SequencerConnect.VerifyActiveResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto#L60) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| success | [`com.digitalasset.canton.sequencer.api.v30.SequencerConnect.VerifyActiveResponse.Success`](#type-com-digitalasset-canton-sequencer-api-v30-sequencerconnect-verifyactiveresponse-success) | optional | | -| failure | [`com.digitalasset.canton.sequencer.api.v30.SequencerConnect.VerifyActiveResponse.Failure`](#type-com-digitalasset-canton-sequencer-api-v30-sequencerconnect-verifyactiveresponse-failure) | optional | | - - -**Message `com.digitalasset.canton.sequencer.api.v30.SequencerConnect.VerifyActiveResponse.Success`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto#L61) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| is_active | `bool` | optional | | - - -**Message `com.digitalasset.canton.sequencer.api.v30.SequencerConnect.VerifyActiveResponse.Failure`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto#L65) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| reason | `string` | optional | | - - -**Message `com.digitalasset.canton.sequencer.api.v30.SequencerConnect.RegisterOnboardingTopologyTransactionsRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto#L74) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| topology_transactions | [`com.digitalasset.canton.protocol.v30.SignedTopologyTransaction`](com-digitalasset-canton-protocol-v30#type-com-digitalasset-canton-protocol-v30-signedtopologytransaction) | repeated | | - - -**Message `com.digitalasset.canton.sequencer.api.v30.SequencerConnect.RegisterOnboardingTopologyTransactionsResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_connect_service.proto#L78) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.sequencer.api.v30.SubscriptionRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto#L133) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| member | `string` | optional | | -| timestamp | `int64` | optional | Timestamp to start the subscription from (inclusive).
Members can use the timestamp of the last event they have received to continue from there and compare the event,
or can subscribe from previous event timestamp's immediate successor to get the next event.
To subscribe from the beginning, set the optional to None.
If it refers to an event that has already been acknowledged, the sequencer may reject the request.
In microseconds of UTC time since Unix epoch | - - -**Message `com.digitalasset.canton.sequencer.api.v30.SubscriptionResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto#L147) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| signed_sequenced_event | `bytes` | optional | Contains a versioned SignedContent which itself contains a versioned SequencedEvent
Serialized SignedContent[SequencedEvent[ClosedEnvelope]] | -| trace_context | [`com.digitalasset.canton.v30.TraceContext`](com-digitalasset-canton-v30#type-com-digitalasset-canton-v30-tracecontext) | optional | optional, canton trace context

DO NOT RENAME this field, as the ApiRequestLogger uses reflection to read this field.

We typically use a header to transfer this information however streamed items do
not have per item/message headers, so we instead in this instance set it in the body. | - - -**Message `com.digitalasset.canton.sequencer.api.v30.TrafficControlErrorReason`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto#L117) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| error | [`com.digitalasset.canton.sequencer.api.v30.TrafficControlErrorReason.Error`](#type-com-digitalasset-canton-sequencer-api-v30-trafficcontrolerrorreason-error) | optional | Message containing details on the error | - - -**Message `com.digitalasset.canton.sequencer.api.v30.TrafficControlErrorReason.Error`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto#L121) -- Fields: 2 - -_No description._ -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| insufficient_traffic | `string` | optional | The sequencer determined that not enough traffic is available to sequence the submission | -| outdated_traffic_cost | `string` | optional | The sequencer determined that the submission cost included in the request is outdated according to current topology | +
+ +
+
Source file
+
community/base/src/main/protobuf/com/digitalasset/canton/sequencer/api/v30/sequencer_service.proto
+
+ +
+
Operations
+
7
+
+ +
+ + +
+ + + + +
+

SequencerService.AcknowledgeSigned

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Allows a member to acknowledge that they have read all events up to and including the provided timestamp, and that they will never re-read these events again. This information i...

+ + +
+ +
+
Request
+
com.digitalasset.canton.sequencer.api.v30.AcknowledgeSignedRequest
+
+ +
+
Response
+
com.digitalasset.canton.sequencer.api.v30.AcknowledgeSignedResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SequencerService.DownloadTopologyStateForInit

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Download the topology state for a member up to including the topology transaction that made the member known on the synchronizer.

+ + +
+ +
+
Request
+
com.digitalasset.canton.sequencer.api.v30.DownloadTopologyStateForInitRequest
+
+ +
+
Response
+
com.digitalasset.canton.sequencer.api.v30.DownloadTopologyStateForInitResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + + + + + +
+

SequencerService.DownloadTopologyStateForInitHash

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Returns a hash of a result equivalent to DownloadTopologyStateForInit call for a BFT check without transferring the full state.

+ + +
+ +
+
Request
+
com.digitalasset.canton.sequencer.api.v30.DownloadTopologyStateForInitHashRequest
+
+ +
+
Response
+
com.digitalasset.canton.sequencer.api.v30.DownloadTopologyStateForInitHashResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SequencerService.GetTime

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Return a "current" sequencing time such that, when a `SendAsync` operation is subsequently called, if sequenced, the sequencing time of the resulting event is guaranteed to be l...

+ + +
+ +
+
Request
+
com.digitalasset.canton.sequencer.api.v30.GetTimeRequest
+
+ +
+
Response
+
com.digitalasset.canton.sequencer.api.v30.GetTimeResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SequencerService.GetTrafficStateForMember

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Return the currently known traffic state for a member. Callers must be authorized to request the traffic state.

+ + +
+ +
+
Request
+
com.digitalasset.canton.sequencer.api.v30.GetTrafficStateForMemberRequest
+
+ +
+
Response
+
com.digitalasset.canton.sequencer.api.v30.GetTrafficStateForMemberResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SequencerService.SendAsync

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Submit a request to the sequencer. A request contains a batch, which is a sequence of envelopes. Every envelope consists of its content and a set of recipients, arranged in a fo...

+ + +
+ +
+
Request
+
com.digitalasset.canton.sequencer.api.v30.SendAsyncRequest
+
+ +
+
Response
+
com.digitalasset.canton.sequencer.api.v30.SendAsyncResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SequencerService.Subscribe

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Establishes a stream with the server to receive sequenced events from the synchronizer after the given counter. The delivered events will have a reference to the previous event...

+ + +
+ +
+
Request
+
com.digitalasset.canton.sequencer.api.v30.SubscriptionRequest
+
+ +
+
Response
+
com.digitalasset.canton.sequencer.api.v30.SubscriptionResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + + +
+ + + + + +## Type Inventory + + +These are the package-level message and enum shapes in the publish-version snapshot. + + + + +
+
+

com.digitalasset.canton.sequencer.api.v30.AcknowledgeRequest

+ +

2 fields

+ +
+ + +
+ +
+
+ member + string + +
+ +
Who is the acknowledgement being sent on behalf of
+ +
+ +
+
+ timestamp + int64 + +
+ +
The timestamp in sequencer time that they are acknowledging and will not re-read earlier events. It is expected that the caller has a received an event with this timestamp but this is not validated. In microseconds of UTC time since Unix epoch
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.AcknowledgeResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.AcknowledgeSignedRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ signed_acknowledge_request + bytes + +
+ +
contains a versioned AcknowledgeRequest TODO(i17383): Have exactly one signature instead of multiple signatures. Serialized SignedContent[AcknowledgeRequest]
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.AcknowledgeSignedResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.ConnectToSequencerChannelRequest

+ +

5 fields

+ +
+ +

The sequencer channel service protocol consists of several messages which are sent as a request or a response (that is as a ConnectToSequencerChannelRequest or a ConnectToSequencerChannelResponse). The protocol transitions through several stages. - To bootstrap the channel, initialization messages between the sequencer channel client and service need to be exchanged, that are SequencerChannelMetadata and SequencerChannelConnectedToAllEndpoints messages. - To secure the channel, sequencer channel client member endpoints setup a session key with the SequencerChannelSessionKey and SequencerChannelSessionKeyAck messages. - To transfer data through the channel, members use opaque (encrypted) payload messages which the sequencer channel service forwards between channel member endpoints. Using payload messages channel client users can implement their own application protocol such as the Online Party Replication. Note that both, request and response need to implement SequencerChannelSessionKey and SequencerChannelSessionKeyAck messages because of the bidirectional gRPC streams. For example, when the sequencer channel service receives a SequencerChannelSessionKeyAck request message from a sequencer channel client, it needs to forward it as a SequencerChannelSessionKeyAck response message to the destination sequencer channel client.

+ + +
+ +
+
+ metadata + SequencerChannelMetadata + +
+ +
Exactly the first message of the channel request stream must be SequencerChannelMetadata for use by the sequencer channel service to match channel endpoint members.
+ +
+ +
+
+ session_key + SequencerChannelSessionKey + +
+ +
SequencerChannelSessionKey and SequencerChannelSessionKeyAck are used to send and acknowledge an asymmetrically encrypted session key between the sequencer channel client endpoints. The SequencerChannelSessionKey is opaque to sequencer channel service.
+ +
+ +
+
+ session_key_acknowledgement + SequencerChannelSessionKeyAck + +
+ +
+ +
+
+ payload + bytes + +
+ +
Payload is opaque to the sequencer channel service and client.
+ +
+ +
+
+ trace_context + TraceContext + +
+ +
Canton trace context Required
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.SequencerChannelMetadata

+ +

3 fields

+ +
+ +

Metadata for a sequencer channel to be established between two members.

+ + +
+ +
+
+ channel_id + string + +
+ +
Channel identifier Required
+ +
+ +
+
+ initiating_member + string + +
+ +
The member initiating the channel connect request Required
+ +
+ +
+
+ receiving_member + string + +
+ +
The member to connect to via the channel Required
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.SequencerChannelSessionKey

+ +

1 fields

+ +
+ +

Public key encrypted session key to secure the communication between two members.

+ + +
+ +
+
+ encrypted_session_key + AsymmetricEncrypted + +
+ +
The public key is determined by the timestamp as agreed by the connecting members beforehand. The timestamp is expected to originate from a recent topology transaction that has already taken effect; meaning it's not a future timestamp. Required
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.AsymmetricEncrypted

+ +

3 fields

+ +
+ + +
+ +
+
+ ciphertext + bytes + +
+ +
Asymmetrically encrypted data
+ +
+ +
+
+ encryption_algorithm_spec + EncryptionAlgorithmSpec + +
+ +
The asymmetric encryption specification used for the encryption
+ +
+ +
+
+ fingerprint + string + +
+ +
The fingerprint of the public key that was used for the encryption
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.EncryptionAlgorithmSpec

+ +

3 values

+ +
+ + + +
    + +
  • ENCRYPTION_ALGORITHM_SPEC_UNSPECIFIED
    • + +
  • ENCRYPTION_ALGORITHM_SPEC_ECIES_HKDF_HMAC_SHA256_AES128CBC
    • + +
  • ENCRYPTION_ALGORITHM_SPEC_RSA_OAEP_SHA256
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.SequencerChannelSessionKeyAck

+ +

0 fields

+ +
+ +

Acknowledgement that the session key has been received

+ + + + +
+ +
+
+

com.digitalasset.canton.v30.TraceContext

+ +

2 fields

+ +
+ + +
+ +
+
+ traceparent + string + +
+ +
https://www.w3.org/TR/trace-context/
+ +
+ +
+
+ tracestate + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.ConnectToSequencerChannelResponse

+ +

5 fields

+ +
+ + +
+ +
+
+ connected + SequencerChannelConnectedToAllEndpoints + +
+ +
Exactly the first message of the channel response stream must be SequencerChannelConnectedToAllEndpoints for use by the sequencer channel client to notify the request initiator that the channel is ready for use.
+ +
+ +
+
+ session_key + SequencerChannelSessionKey + +
+ +
SequencerChannelSessionKey and SequencerChannelSessionKeyAck are used to send and acknowledge an asymmetrically encrypted session key between the sequencer channel client endpoints. The SequencerChannelSessionKey is opaque to sequencer channel service.
+ +
+ +
+
+ session_key_acknowledgement + SequencerChannelSessionKeyAck + +
+ +
+ +
+
+ payload + bytes + +
+ +
Payload is opaque to the sequencer channel service and client.
+ +
+ +
+
+ trace_context + TraceContext + +
+ +
Canton trace context Required
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.SequencerChannelConnectedToAllEndpoints

+ +

0 fields

+ +
+ +

Notification that a sequencer channel has been connected to the members specified in the SequencerChannelMetadata.

+ + + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.DownloadTopologyStateForInitHashRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ member + string + +
+ +
Member for which to get the topology state hash
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.DownloadTopologyStateForInitHashResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ topology_state_hash + bytes + +
+ +
Hash of contents of a call to DownloadTopologyStateForInit
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.DownloadTopologyStateForInitRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ member + string + +
+ +
Member for which to get the topology state
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.DownloadTopologyStateForInitResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ topology_transactions + TopologyTransactions + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.TopologyTransactions

+ +

1 fields

+ +
+ +

* Topology transaction collection used during bootstrapping of synchronizer nodes and on the admin API Please note that this message should not be in the protocol package, as it is not used on the protocol itself but on the admin apis. But as we can't rename the package name due to backwards compatibility guarantees, we've moved the file out of the protocol.proto file, but kept the package name.

+ + +
+ +
+
+ items + repeated Item + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.TopologyTransactions.Item

+ +

5 fields

+ +
+ + +
+ +
+
+ sequenced + Timestamp + +
+ +
+ +
+
+ valid_from + Timestamp + +
+ +
+ +
+
+ valid_until + Timestamp + +
+ +
+ +
+
+ transaction + bytes + +
+ +
* Versioned signed topology transactions serialized as byte-strings. Note that we use here the serialized version that contains the version number. Using the "Versioned" version directly here would create a circular dependency between the proto files. The only proper solution would be to move this into a third separate file with "cross version data files", which we might do at some point.
+ +
+ +
+
+ rejection_reason + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.GetTimeRequest

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.GetTimeResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ sequencing_timestamp + int64 + +
+ +
The result can be empty if the sequencer is still initializing.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.GetTrafficStateForMemberRequest

+ +

2 fields

+ +
+ + +
+ +
+
+ member + string + +
+ +
Member for which to get the traffic state
+ +
+ +
+
+ timestamp + int64 + +
+ +
Timestamp at which to to get the traffic state
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.GetTrafficStateForMemberResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ traffic_state + TrafficState + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.TrafficState

+ +

6 fields

+ +
+ +

Traffic state of a member at a given timestamp

+ + +
+ +
+
+ extra_traffic_purchased + int64 + +
+ +
Total amount of extra traffic purchased
+ +
+ +
+
+ extra_traffic_consumed + int64 + +
+ +
Total amount of extra traffic consumed
+ +
+ +
+
+ base_traffic_remainder + int64 + +
+ +
Amount of base traffic remaining
+ +
+ +
+
+ last_consumed_cost + uint64 + +
+ +
Cost deducted at `timestamp`, only present when traffic was consumed at `timestamp`, otherwise is set to 0
+ +
+ +
+
+ timestamp + int64 + +
+ +
Timestamp at which the state is valid
+ +
+ +
+
+ serial + uint32 + +
+ +
Optional serial of the balance update that updated the extra traffic limit
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.PingRequest

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.PingResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.SendAsyncRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ signed_submission_request + bytes + +
+ +
Contains a versioned SignedContent which itself contains a versioned SubmissionRequest. TODO(i17383): Have exactly one signature instead of multiple signatures.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.SendAsyncResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication.ChallengeRequest

+ +

2 fields

+ +
+ + +
+ +
+
+ member + string + +
+ +
+ +
+
+ member_protocol_versions + repeated int32 + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication.ChallengeResponse

+ +

2 fields

+ +
+ + +
+ +
+
+ nonce + bytes + +
+ +
random nonce to be used for authentication
+ +
+ +
+
+ fingerprints + repeated string + +
+ +
A hint containing fingerprints of keys that the sequencer considers valid This is helpful, because the client does not necessarily have the current topology state before connecting.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication.AuthenticateRequest

+ +

3 fields

+ +
+ + +
+ +
+
+ member + string + +
+ +
member sending request
+ +
+ +
+
+ signature + Signature + +
+ +
signature of the handshake nonce Any key that is valid at time of verification may be used
+ +
+ +
+
+ nonce + bytes + +
+ +
nonce value that was signed is sent back to identify the challenge
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.Signature

+ +

5 fields

+ +
+ + +
+ +
+
+ format + SignatureFormat + +
+ +
+ +
+
+ signature + bytes + +
+ +
+ +
+
+ signed_by + string + +
+ +
The fingerprint/id of the keypair used to create this signature and needed to verify. If a signature delegation is defined, this fingerprint/id is not used to produce the signature, and, instead is used to sign the delegation.
+ +
+ +
+
+ signing_algorithm_spec + SigningAlgorithmSpec + +
+ +
The signing algorithm specification used to produce this signature
+ +
+ +
+
+ signature_delegation + SignatureDelegation + +
+ +
An optional signature delegation where a long-term signing key authorizes a session signing key to sign on its behalf.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SignatureFormat

+ +

5 values

+ +
+ + + +
    + +
  • SIGNATURE_FORMAT_UNSPECIFIED
    • + +
  • SIGNATURE_FORMAT_RAW
    • + +
  • SIGNATURE_FORMAT_DER
    • + +
  • SIGNATURE_FORMAT_CONCAT
    • + +
  • SIGNATURE_FORMAT_SYMBOLIC
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SigningAlgorithmSpec

+ +

4 values

+ +
+ + + +
    + +
  • SIGNING_ALGORITHM_SPEC_UNSPECIFIED
    • + +
  • SIGNING_ALGORITHM_SPEC_ED25519
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_256
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_384
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SignatureDelegation

+ +

7 fields

+ +
+ + +
+ +
+
+ session_key + bytes + +
+ +
ASN.1 + DER-encoding of X.509 SubjectPublicKeyInfo structure of the session public key: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1. This key was used to produce the actual signature.
+ +
+ +
+
+ session_key_spec + SigningKeySpec + +
+ +
The signing key spec for the session key.
+ +
+ +
+
+ validity_period_from_inclusive + int64 + +
+ +
A timestamp in microseconds of UTC time since Unix epoch that indicates when the session key is considered valid.
+ +
+ +
+
+ validity_period_duration_seconds + uint32 + +
+ +
Duration in seconds indicating how long the session key remains valid. The validity period starts from `validity_period_from_inclusive` above.
+ +
+ +
+
+ format + SignatureFormat + +
+ +
The format of the signature
+ +
+ +
+
+ signature + bytes + +
+ +
The signature of the combined hash of the session key fingerprint, validity period, and synchronizer id, by the long-term key. This signature authorizes the session key to act on behalf of the long-term key.
+ +
+ +
+
+ signing_algorithm_spec + SigningAlgorithmSpec + +
+ +
The signing algorithm specification used to produce this signature
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SigningKeySpec

+ +

5 values

+ +
+ +

[start-docs-entry: signing key spec proto]

+ + + +
    + +
  • SIGNING_KEY_SPEC_UNSPECIFIED
    • + +
  • SIGNING_KEY_SPEC_EC_CURVE25519
    • + +
  • SIGNING_KEY_SPEC_EC_P256
    • + +
  • SIGNING_KEY_SPEC_EC_P384
    • + +
  • SIGNING_KEY_SPEC_EC_SECP256K1
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication.AuthenticateResponse

+ +

2 fields

+ +
+ + +
+ +
+
+ token + bytes + +
+ +
+ +
+
+ expires_at + Timestamp + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication.LogoutRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ token + bytes + +
+ +
token to identify the member to invalidate
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.SequencerAuthentication.LogoutResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.SequencerConnect

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.SequencerConnect.HandshakeRequest

+ +

2 fields

+ +
+ +

Messages for performing a version handshake with a sequencer service Reused between sequencer services IMPORTANT: changing the version handshakes can lead to issues with upgrading synchronizers - be very careful when changing the handshake message format

+ + +
+ +
+
+ client_protocol_versions + repeated int32 + +
+ +
+ +
+
+ minimum_protocol_version + int32 + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.SequencerConnect.HandshakeResponse

+ +

3 fields

+ +
+ + +
+ +
+
+ server_protocol_version + int32 + +
+ +
+ +
+
+ success + Success + +
+ +
+ +
+
+ failure + Failure + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.SequencerConnect.HandshakeResponse.Success

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.SequencerConnect.HandshakeResponse.Failure

+ +

1 fields

+ +
+ + +
+ +
+
+ reason + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.SequencerConnect.GetSynchronizerIdRequest

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.SequencerConnect.GetSynchronizerIdResponse

+ +

2 fields

+ +
+ + +
+ +
+
+ physical_synchronizer_id + string + +
+ +
+ +
+
+ sequencer_uid + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.SequencerConnect.GetSynchronizerParametersRequest

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.SequencerConnect.GetSynchronizerParametersResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ parameters_v1 + StaticSynchronizerParameters + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.StaticSynchronizerParameters

+ +

10 fields

+ +
+ + +
+ +
+
+ required_signing_specs + RequiredSigningSpecs + +
+ +
+ +
+
+ required_encryption_specs + RequiredEncryptionSpecs + +
+ +
+ +
+
+ required_symmetric_key_schemes + repeated SymmetricKeyScheme + +
+ +
+ +
+
+ required_hash_algorithms + repeated HashAlgorithm + +
+ +
+ +
+
+ required_crypto_key_formats + repeated CryptoKeyFormat + +
+ +
+ +
+
+ required_signature_formats + repeated SignatureFormat + +
+ +
+ +
+
+ protocol_version + int32 + +
+ +
+ +
+
+ serial + int32 + +
+ +
Serial of the synchronizer. Must be non-negative.
+ +
+ +
+
+ enable_transparency_checks + bool + +
+ +
Flag to enable transparency checks.
+ +
+ +
+
+ topology_change_delay + Duration + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.RequiredSigningSpecs

+ +

2 fields

+ +
+ +

Used to announce the required signing key and algorithm specifications in the static synchronizer parameters.

+ + +
+ +
+
+ algorithms + repeated SigningAlgorithmSpec + +
+ +
+ +
+
+ keys + repeated SigningKeySpec + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.RequiredEncryptionSpecs

+ +

2 fields

+ +
+ +

Used to announce the required encryption key and algorithm specifications in the static synchronizer parameters.

+ + +
+ +
+
+ algorithms + repeated EncryptionAlgorithmSpec + +
+ +
+ +
+
+ keys + repeated EncryptionKeySpec + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.EncryptionKeySpec

+ +

3 values

+ +
+ + + +
    + +
  • ENCRYPTION_KEY_SPEC_UNSPECIFIED
    • + +
  • ENCRYPTION_KEY_SPEC_EC_P256
    • + +
  • ENCRYPTION_KEY_SPEC_RSA_2048
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SymmetricKeyScheme

+ +

2 values

+ +
+ + + +
    + +
  • SYMMETRIC_KEY_SCHEME_UNSPECIFIED
    • + +
  • SYMMETRIC_KEY_SCHEME_AES128GCM
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.v30.HashAlgorithm

+ +

2 values

+ +
+ + + +
    + +
  • HASH_ALGORITHM_UNSPECIFIED
    • + +
  • HASH_ALGORITHM_SHA256
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.v30.CryptoKeyFormat

+ +

6 values

+ +
+ +

Serialization format for crypto keys and signatures

+ + + +
    + +
  • CRYPTO_KEY_FORMAT_UNSPECIFIED
    • + +
  • CRYPTO_KEY_FORMAT_DER
    • + +
  • CRYPTO_KEY_FORMAT_RAW
    • + +
  • CRYPTO_KEY_FORMAT_DER_X509_SUBJECT_PUBLIC_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_DER_PKCS8_PRIVATE_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_SYMBOLIC
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.SequencerConnect.VerifyActiveRequest

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.SequencerConnect.VerifyActiveResponse

+ +

2 fields

+ +
+ + +
+ +
+
+ success + Success + +
+ +
+ +
+
+ failure + Failure + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.SequencerConnect.VerifyActiveResponse.Success

+ +

1 fields

+ +
+ + +
+ +
+
+ is_active + bool + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.SequencerConnect.VerifyActiveResponse.Failure

+ +

1 fields

+ +
+ + +
+ +
+
+ reason + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.SequencerConnect.RegisterOnboardingTopologyTransactionsRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ topology_transactions + repeated SignedTopologyTransaction + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.SignedTopologyTransaction

+ +

4 fields

+ +
+ + +
+ +
+
+ transaction + bytes + +
+ +
serialized topology transaction (protobuf bytestring)
+ +
+ +
+
+ signatures + repeated Signature + +
+ +
multiple signatures Either this field OR the multi_transaction_signatures field MUST contain at least one signature
+ +
+ +
+
+ proposal + bool + +
+ +
if true, this transaction is just a proposal. this means that every signature is valid, but the signatures are insufficient to properly authorize the transaction. proposals are distributed via the topology channel too. proposals will be pruned automatically when the nodes are pruned TODO(#14045) implement pruning
+ +
+ +
+
+ multi_transaction_signatures + repeated MultiTransactionSignatures + +
+ +
If set, the transaction may be authorized by signing a hash computed from multiple transaction hashes This allows to effectively authorize multiple transactions with a single signature. Each item MUST contain the hash of this transaction Optional
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.MultiTransactionSignatures

+ +

2 fields

+ +
+ +

Used in SignedTopologyTransaction to bundle together multiple transaction hashes Allows submitters to only sign a single combined hash to authorize multiple transactions at once The combined hash is computed from the transaction hashes

+ + +
+ +
+
+ transaction_hashes + repeated bytes + +
+ +
List of topology transaction hashes. Required
+ +
+ +
+
+ signatures + repeated Signature + +
+ +
Signatures on the combined hash computed over the transaction_hashes MUST contain at least one
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.SequencerConnect.RegisterOnboardingTopologyTransactionsResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.SubscriptionRequest

+ +

2 fields

+ +
+ + +
+ +
+
+ member + string + +
+ +
+ +
+
+ timestamp + int64 + +
+ +
Timestamp to start the subscription from (inclusive). Members can use the timestamp of the last event they have received to continue from there and compare the event, or can subscribe from previous event timestamp's immediate successor to get the next event. To subscribe from the beginning, set the optional to None. If it refers to an event that has already been acknowledged, the sequencer may reject the request. In microseconds of UTC time since Unix epoch
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.SubscriptionResponse

+ +

2 fields

+ +
+ + +
+ +
+
+ signed_sequenced_event + bytes + +
+ +
Contains a versioned SignedContent which itself contains a versioned SequencedEvent Serialized SignedContent[SequencedEvent[ClosedEnvelope]]
+ +
+ +
+
+ trace_context + TraceContext + +
+ +
optional, canton trace context DO NOT RENAME this field, as the ApiRequestLogger uses reflection to read this field. We typically use a header to transfer this information however streamed items do not have per item/message headers, so we instead in this instance set it in the body.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.TrafficControlErrorReason

+ +

1 fields

+ +
+ + +
+ +
+
+ error + Error + +
+ +
Message containing details on the error
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.sequencer.api.v30.TrafficControlErrorReason.Error

+ +

2 fields

+ +
+ + +
+ +
+
+ insufficient_traffic + string + +
+ +
The sequencer determined that not enough traffic is available to sequence the submission
+ +
+ +
+
+ outdated_traffic_cost + string + +
+ +
The sequencer determined that the submission cost included in the request is outdated according to current topology
+ +
+ +
+ + + +
diff --git a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-synchronizer-protocol-v30.mdx b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-synchronizer-protocol-v30.mdx index eaa2d3a..9584dee 100644 --- a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-synchronizer-protocol-v30.mdx +++ b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-synchronizer-protocol-v30.mdx @@ -1,49 +1,411 @@ --- title: "com.digitalasset.canton.synchronizer.protocol.v30" -description: "Descriptor-backed protobuf API history for package com.digitalasset.canton.synchronizer.protocol.v30." +description: "Package-level overview for com.digitalasset.canton.synchronizer.protocol.v30." --- -# Package `com.digitalasset.canton.synchronizer.protocol.v30` +

Back to overview

-[Back to Canton Protobuf History](../index) +
+ +

Protobuf Package

+ + +

com.digitalasset.canton.synchronizer.protocol.v30

+ + +

0 services, 0 endpoints, 2 messages

+ + +
+ + gRPC + +
-## Snapshot + +
+ +
+
Files
+
1
+
+ +
+
Services
+
0
+
+ +
+
Endpoints
+
0
+
+ +
+
Messages
+
2
+
+ +
+
Enums
+
0
+
+ +
+ +
-- Current files: `1` -- Current services: `0` -- Current endpoints: `0` -- Current messages: `2` -- Current enums: `0` -- Lifecycle endpoints tracked: `0` ## Source Files -| File | Services | Messages | Enums | Source | -| --- | --- | --- | --- | --- | -| community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/protocol/v30/aggregation.proto | `0` | `1` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/protocol/v30/aggregation.proto#L4) | -## Type Reference - -**Message `com.digitalasset.canton.synchronizer.protocol.v30.AggregatedSignaturesOfSender`** -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/protocol/v30/aggregation.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/protocol/v30/aggregation.proto#L11) -- Fields: 1 +
+ + +
+ +
+

community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/protocol/v30/aggregation.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
1
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/protocol/v30/aggregation.proto
+
+ +
+ + +
+ + +
+ + + + + +## Type Inventory + + +These are the package-level message and enum shapes in the publish-version snapshot. + + + + +
+
+

com.digitalasset.canton.synchronizer.protocol.v30.AggregatedSignaturesOfSender

+ +

1 fields

+ +
+ + +
+ +
+
+ signatures_by_envelope + repeated SignaturesForEnvelope + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.synchronizer.protocol.v30.AggregatedSignaturesOfSender.SignaturesForEnvelope

+ +

1 fields

+ +
+ + +
+ +
+
+ signatures + repeated Signature + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.Signature

+ +

5 fields

+ +
+ + +
+ +
+
+ format + SignatureFormat + +
+ +
+ +
+
+ signature + bytes + +
+ +
+ +
+
+ signed_by + string + +
+ +
The fingerprint/id of the keypair used to create this signature and needed to verify. If a signature delegation is defined, this fingerprint/id is not used to produce the signature, and, instead is used to sign the delegation.
+ +
+ +
+
+ signing_algorithm_spec + SigningAlgorithmSpec + +
+ +
The signing algorithm specification used to produce this signature
+ +
+ +
+
+ signature_delegation + SignatureDelegation + +
+ +
An optional signature delegation where a long-term signing key authorizes a session signing key to sign on its behalf.
+ +
+ +
-_No description._ + + +
-| Field | Type | Label | Description | -| --- | --- | --- | --- | -| signatures_by_envelope | [`com.digitalasset.canton.synchronizer.protocol.v30.AggregatedSignaturesOfSender.SignaturesForEnvelope`](#type-com-digitalasset-canton-synchronizer-protocol-v30-aggregatedsignaturesofsender-signaturesforenvelope) | repeated | | +
+
+

com.digitalasset.canton.crypto.v30.SignatureFormat

+ +

5 values

+ +
+ + + +
    + +
  • SIGNATURE_FORMAT_UNSPECIFIED
    • + +
  • SIGNATURE_FORMAT_RAW
    • + +
  • SIGNATURE_FORMAT_DER
    • + +
  • SIGNATURE_FORMAT_CONCAT
    • + +
  • SIGNATURE_FORMAT_SYMBOLIC
    • + +
+ + +
- -**Message `com.digitalasset.canton.synchronizer.protocol.v30.AggregatedSignaturesOfSender.SignaturesForEnvelope`** +
+
+

com.digitalasset.canton.crypto.v30.SigningAlgorithmSpec

+ +

4 values

+ +
+ + + +
    + +
  • SIGNING_ALGORITHM_SPEC_UNSPECIFIED
    • + +
  • SIGNING_ALGORITHM_SPEC_ED25519
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_256
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_384
    • + +
+ + +
-- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/protocol/v30/aggregation.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/protocol/v30/aggregation.proto#L16) -- Fields: 1 +
+
+

com.digitalasset.canton.crypto.v30.SignatureDelegation

+ +

7 fields

+ +
+ + +
+ +
+
+ session_key + bytes + +
+ +
ASN.1 + DER-encoding of X.509 SubjectPublicKeyInfo structure of the session public key: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1. This key was used to produce the actual signature.
+ +
+ +
+
+ session_key_spec + SigningKeySpec + +
+ +
The signing key spec for the session key.
+ +
+ +
+
+ validity_period_from_inclusive + int64 + +
+ +
A timestamp in microseconds of UTC time since Unix epoch that indicates when the session key is considered valid.
+ +
+ +
+
+ validity_period_duration_seconds + uint32 + +
+ +
Duration in seconds indicating how long the session key remains valid. The validity period starts from `validity_period_from_inclusive` above.
+ +
+ +
+
+ format + SignatureFormat + +
+ +
The format of the signature
+ +
+ +
+
+ signature + bytes + +
+ +
The signature of the combined hash of the session key fingerprint, validity period, and synchronizer id, by the long-term key. This signature authorizes the session key to act on behalf of the long-term key.
+ +
+ +
+
+ signing_algorithm_spec + SigningAlgorithmSpec + +
+ +
The signing algorithm specification used to produce this signature
+ +
+ +
-_No description._ + + +
-| Field | Type | Label | Description | -| --- | --- | --- | --- | -| signatures | [`com.digitalasset.canton.crypto.v30.Signature`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-signature) | repeated | | +
+
+

com.digitalasset.canton.crypto.v30.SigningKeySpec

+ +

5 values

+ +
+ +

[start-docs-entry: signing key spec proto]

+ + + +
    + +
  • SIGNING_KEY_SPEC_UNSPECIFIED
    • + +
  • SIGNING_KEY_SPEC_EC_CURVE25519
    • + +
  • SIGNING_KEY_SPEC_EC_P256
    • + +
  • SIGNING_KEY_SPEC_EC_P384
    • + +
  • SIGNING_KEY_SPEC_EC_SECP256K1
    • + +
+ + +
diff --git a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-standalone-v1.mdx b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-standalone-v1.mdx index 5816ae1..ea20e47 100644 --- a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-standalone-v1.mdx +++ b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-standalone-v1.mdx @@ -1,169 +1,394 @@ --- title: "com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1" -description: "Descriptor-backed protobuf API history for package com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1." +description: "Package-level overview for com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1." --- -# Package `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1` +

Back to overview

+ +
+ +

Protobuf Package

+ + +

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1

+ + +

1 services, 2 endpoints, 5 messages

+ + +
+ + gRPC + +
+ + +
+ +
+
Files
+
1
+
+ +
+
Services
+
1
+
+ +
+
Endpoints
+
2
+
+ +
+
Messages
+
5
+
+ +
+
Enums
+
0
+
+ +
+ +
-[Back to Canton Protobuf History](../index) - -## Snapshot - -- Current files: `1` -- Current services: `1` -- Current endpoints: `2` -- Current messages: `5` -- Current enums: `0` -- Lifecycle endpoints tracked: `2` ## Source Files -| File | Services | Messages | Enums | Source | -| --- | --- | --- | --- | --- | -| community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/standalone/v1/standalone_bft_ordering_service.proto | `1` | `5` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/standalone/v1/standalone_bft_ordering_service.proto#L4) | - -## Services - -| Service | Endpoints | Source | Description | -| --- | --- | --- | --- | -| [`StandaloneBftOrderingService`](#service-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-standalone-v1-standalonebftorderingservice) | `2` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/standalone/v1/standalone_bft_ordering_service.proto#L8) | | - - -### Service `StandaloneBftOrderingService` - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/standalone/v1/standalone_bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/standalone/v1/standalone_bft_ordering_service.proto#L8) -- Endpoints tracked: `2` - -_No description._ - -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`ReadOrdered`](#endpoint-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-standalone-v1-standalonebftorderingservice-readordered) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1.ReadOrderedRequest`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-standalone-v1-readorderedrequest) | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1.ReadOrderedResponse`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-standalone-v1-readorderedresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/standalone/v1/standalone_bft_ordering_service.proto#L10) | -| [`Send`](#endpoint-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-standalone-v1-standalonebftorderingservice-send) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1.SendRequest`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-standalone-v1-sendrequest) | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1.SendResponse`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-standalone-v1-sendresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/standalone/v1/standalone_bft_ordering_service.proto#L9) | - - -**Endpoint `StandaloneBftOrderingService.ReadOrdered`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/standalone/v1/standalone_bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/standalone/v1/standalone_bft_ordering_service.proto#L10) - -**Signature** - -```protobuf -rpc StandaloneBftOrderingService.ReadOrdered(com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1.ReadOrderedRequest) returns (stream com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1.ReadOrderedResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1.ReadOrderedRequest`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-standalone-v1-readorderedrequest) - -**Response Type** - -- [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1.ReadOrderedResponse`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-standalone-v1-readorderedresponse) - - -**Endpoint `StandaloneBftOrderingService.Send`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/standalone/v1/standalone_bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/standalone/v1/standalone_bft_ordering_service.proto#L9) - -**Signature** - -```protobuf -rpc StandaloneBftOrderingService.Send(com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1.SendRequest) returns (com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1.SendResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1.SendRequest`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-standalone-v1-sendrequest) - -**Response Type** - -- [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1.SendResponse`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-standalone-v1-sendresponse) - -## Type Reference - - -**Message `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1.Ordered`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/standalone/v1/standalone_bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/standalone/v1/standalone_bft_ordering_service.proto#L31) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| tag | `string` | optional | | -| payload | `bytes` | optional | | - - -**Message `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1.ReadOrderedRequest`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/standalone/v1/standalone_bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/standalone/v1/standalone_bft_ordering_service.proto#L22) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| start_height | `int64` | optional | | - - -**Message `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1.ReadOrderedResponse`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/standalone/v1/standalone_bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/standalone/v1/standalone_bft_ordering_service.proto#L26) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| height | `int64` | optional | | -| block | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1.Ordered`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-standalone-v1-ordered) | repeated | | - - -**Message `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1.SendRequest`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/standalone/v1/standalone_bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/standalone/v1/standalone_bft_ordering_service.proto#L13) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| tag | `string` | optional | | -| payload | `bytes` | optional | | - - -**Message `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1.SendResponse`** -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/standalone/v1/standalone_bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/standalone/v1/standalone_bft_ordering_service.proto#L18) -- Fields: 1 -_No description._ -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| rejection_reason | `string` | optional | | +
+ + +
+ +
+

community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/standalone/v1/standalone_bft_ordering_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
5
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/standalone/v1/standalone_bft_ordering_service.proto
+
+ +
+ + +
+ + +
+ + + + + +## StandaloneBftOrderingService + + + +
+ +
+
Source file
+
community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/standalone/v1/standalone_bft_ordering_service.proto
+
+ +
+
Operations
+
2
+
+ +
+ + +
+ + + + +
+

StandaloneBftOrderingService.ReadOrdered

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc StandaloneBftOrderingService.ReadOrdered(com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1.ReadOrderedRequest) returns (stream com.digitala...

+ + +
+ +
+
Request
+
com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1.ReadOrderedRequest
+
+ +
+
Response
+
com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1.ReadOrderedResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + + + + + +
+

StandaloneBftOrderingService.Send

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc StandaloneBftOrderingService.Send(com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1.SendRequest) returns (com.digitalasset.canton.synchroni...

+ + +
+ +
+
Request
+
com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1.SendRequest
+
+ +
+
Response
+
com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1.SendResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## Type Inventory + + +These are the package-level message and enum shapes in the publish-version snapshot. + + + + +
+
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1.Ordered

+ +

2 fields

+ +
+ + +
+ +
+
+ tag + string + +
+ +
+ +
+
+ payload + bytes + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1.ReadOrderedRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ start_height + int64 + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1.ReadOrderedResponse

+ +

2 fields

+ +
+ + +
+ +
+
+ height + int64 + +
+ +
+ +
+
+ block + repeated Ordered + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1.SendRequest

+ +

2 fields

+ +
+ + +
+ +
+
+ tag + string + +
+ +
+ +
+
+ payload + bytes + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1.SendResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ rejection_reason + string + +
+ +
+ +
+ + + +
diff --git a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30.mdx b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30.mdx index 44ee2b8..d691461 100644 --- a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30.mdx +++ b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30.mdx @@ -1,575 +1,1894 @@ --- title: "com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30" -description: "Descriptor-backed protobuf API history for package com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30." +description: "Package-level overview for com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30." --- -# Package `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30` +

Back to overview

+ +
+ +

Protobuf Package

+ + +

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30

+ + +

1 services, 1 endpoints, 37 messages

+ + +
+ + gRPC + +
+ + +
+ +
+
Files
+
2
+
+ +
+
Services
+
1
+
+ +
+
Endpoints
+
1
+
+ +
+
Messages
+
37
+
+ +
+
Enums
+
0
+
+ +
+ +
-[Back to Canton Protobuf History](../index) - -## Snapshot - -- Current files: `2` -- Current services: `1` -- Current endpoints: `1` -- Current messages: `37` -- Current enums: `0` -- Lifecycle endpoints tracked: `1` ## Source Files -| File | Services | Messages | Enums | Source | -| --- | --- | --- | --- | --- | -| community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto | `1` | `36` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto#L4) | -| community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/dynamic_sequencing_parameters.proto | `0` | `1` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/dynamic_sequencing_parameters.proto#L4) | -## Services -| Service | Endpoints | Source | Description | -| --- | --- | --- | --- | -| [`BftOrderingService`](#service-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-bftorderingservice) | `1` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto#L16) | Signed integer types are used, even though they are always non-negative in network-sent data, to match the Java gRPC... | - -### Service `BftOrderingService` +
+ + +
+ +
+

community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
36
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto
+
+ +
+ + +
+ + + +
+ +
+

community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/dynamic_sequencing_parameters.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
1
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/dynamic_sequencing_parameters.proto
+
+ +
+ + +
+ + +
+ + + + + +## BftOrderingService -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto#L16) -- Endpoints tracked: `1` Signed integer types are used, even though they are always non-negative in network-sent data, to match the Java gRPC implementation, which uses signed integers because the JVM doesn't support unsigned integers. -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`Receive`](#endpoint-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-bftorderingservice-receive) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.BftOrderingMessage`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-bftorderingmessage) | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.BftOrderingMessage`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-bftorderingmessage) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto#L17) | - - -**Endpoint `BftOrderingService.Receive`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto#L17) - -**Signature** - -```protobuf -rpc BftOrderingService.Receive(stream com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.BftOrderingMessage) returns (stream com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.BftOrderingMessage); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.BftOrderingMessage`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-bftorderingmessage) - -**Response Type** - -- [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.BftOrderingMessage`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-bftorderingmessage) - -## Type Reference - - -**Message `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.AvailabilityAck`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto#L103) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| from | `string` | optional | | -| signature | [`com.digitalasset.canton.crypto.v30.Signature`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-signature) | optional | | - - -**Message `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.AvailabilityMessage`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto#L45) -- Fields: 5 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| ping | `google.protobuf.Empty` | optional | | -| store_request | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.StoreRequest`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-storerequest) | optional | | -| store_response | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.StoreResponse`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-storeresponse) | optional | | -| batch_request | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.BatchRequest`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-batchrequest) | optional | | -| batch_response | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.BatchResponse`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-batchresponse) | optional | | - - -**Message `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.Batch`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto#L62) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| ordering_requests | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.OrderingRequest`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-orderingrequest) | repeated | | -| epoch_number | `int64` | optional | epoch number assigned to batch at the time of creation corresponding to last know epoch number at the availability module.
it is used for inferring the expiration of the batch. | - - -**Message `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.BatchRequest`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto#L84) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| batch_id | `bytes` | optional | | - - -**Message `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.BatchResponse`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto#L88) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| batch_id | `bytes` | optional | | -| batch | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.Batch`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-batch) | optional | | - - -**Message `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.BftOrderingMessage`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto#L20) -- Fields: 4 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| trace_context | `string` | optional | | -| body | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.BftOrderingMessageBody`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-bftorderingmessagebody) | optional | | -| sent_by | `string` | optional | | -| sent_at | `google.protobuf.Timestamp` | optional | | - - -**Message `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.BftOrderingMessageBody`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto#L27) -- Fields: 5 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| availability_message | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.SignedMessage`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-signedmessage) | optional | | -| consensus_message | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.SignedMessage`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-signedmessage) | optional | | -| state_transfer_message | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.SignedMessage`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-signedmessage) | optional | | -| retransmission_message | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.RetransmissionMessage`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-retransmissionmessage) | optional | | -| connection_opened | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.ConnectionOpened`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-connectionopened) | optional | | - - -**Message `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.BlockInProgress`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto#L233) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| pre_prepared | `bool` | optional | | -| prepares_present | `bool` | repeated | | -| commits_present | `bool` | repeated | | - - -**Message `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.BlockMetadata`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto#L123) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| epoch_number | `int64` | optional | | -| block_number | `int64` | optional | | - - -**Message `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.BlockStatus`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto#L227) -- Fields: 2 - -Node's status of consensus of a specific block in a segment, which is identified by its order inside of the SegmentInProgress - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| complete | `google.protobuf.Empty` | optional | | -| in_progress | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.BlockInProgress`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-blockinprogress) | optional | | - - -**Message `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.BlockTransferRequest`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto#L248) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| epoch | `int64` | optional | | - - -**Message `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.BlockTransferResponse`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto#L256) -- Fields: 1 - -A thin wrapper for a commit certificate. - As long as it merely contains a commit certificate (that in turn includes signed and verified data), its signature - verification can be safely skipped. As a result, any node can help with state transfer (even when sending responses - signed with a new/rotated key). - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| commit_certificate | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.CommitCertificate`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-commitcertificate) | optional | Avoid adding more data that would require signing to allow skipping the outer message's signature verification! | - - -**Message `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.CanonicalCommitSet`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto#L161) -- Fields: 1 - -A canonical (fixed) set of (usually 2f+1) Commit messages that completed the recent stable block. - Check the BFT time design for more details. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| canonical_commits | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.SignedMessage`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-signedmessage) | repeated | | - - -**Message `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.Commit`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto#L141) -- Fields: 2 - -A `Commit` means that a node have received a quorum of `Prepare` - Upon receiving a quorum of `Commit`, a node considers the round complete - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| block_hash | `bytes` | optional | | -| local_timestamp | `int64` | optional | creation time, in microseconds of UTC time since Unix epoch | - - -**Message `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.CommitCertificate`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto#L181) -- Fields: 2 - -A self-contained, cryptographically-verifiable set of one PrePrepare and quorum-1 Commits that - prove a particular value (payload) was committed for a particular (epoch, block, view)-tuple - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| pre_prepare | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.SignedMessage`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-signedmessage) | optional | | -| commits | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.SignedMessage`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-signedmessage) | repeated | | - - -**Message `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.ConnectionOpened`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto#L43) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.ConsensusCertificate`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto#L165) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| prepare_certificate | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.PrepareCertificate`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-preparecertificate) | optional | | -| commit_certificate | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.CommitCertificate`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-commitcertificate) | optional | | - - -**Message `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.ConsensusMessage`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto#L108) -- Fields: 8 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| block_metadata | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.BlockMetadata`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-blockmetadata) | optional | | -| view_number | `int64` | optional | | -| from | `string` | optional | | -| pre_prepare | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.PrePrepare`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-preprepare) | optional | | -| prepare | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.Prepare`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-prepare) | optional | | -| commit | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.Commit`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-commit) | optional | | -| view_change | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.ViewChange`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-viewchange) | optional | | -| new_view | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.NewView`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-newview) | optional | | - - -**Message `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.DynamicSequencingParametersPayload`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/dynamic_sequencing_parameters.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/dynamic_sequencing_parameters.proto#L10) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| pbft_view_change_timeout | `google.protobuf.Duration` | optional | | - - -**Message `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.EpochStatus`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto#L201) -- Fields: 2 - -Node's status of consensus for the whole epoch. Acts as a retransmission request - where receiving node will compute what they can retransmit based on what the requesting - node is lacking from looking at this status message. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| epoch_number | `int64` | optional | | -| segments | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.SegmentStatus`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-segmentstatus) | repeated | | - - -**Message `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.NewView`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto#L154) -- Fields: 2 - -A `NewView` message is sent by the next node taking over leader responsibilities - of a PBFT instance at the end of a view change - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| view_changes | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.SignedMessage`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-signedmessage) | repeated | | -| pre_prepares | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.SignedMessage`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-signedmessage) | repeated | | - - -**Message `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.OrderingBlock`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto#L93) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| proofs | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.ProofOfAvailability`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-proofofavailability) | repeated | | - - -**Message `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.OrderingRequest`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto#L70) -- Fields: 4 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| trace_context | `string` | optional | | -| tag | `string` | optional | | -| payload | `bytes` | optional | | -| ordering_start_instant | `google.protobuf.Timestamp` | optional | The following field is only used for metrics. | - - -**Message `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.PrePrepare`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto#L129) -- Fields: 2 - -A `PrePrepare` message is the proposal sent by the leader in a round - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| block | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.OrderingBlock`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-orderingblock) | optional | | -| bft_time_canonical_commit_set | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.CanonicalCommitSet`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-canonicalcommitset) | optional | | - - -**Message `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.Prepare`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto#L135) -- Fields: 1 - -A `Prepare` is an acknowledgement that a node received the `PrePrepare` - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| block_hash | `bytes` | optional | | - - -**Message `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.PrepareCertificate`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto#L174) -- Fields: 2 - -A self-contained, cryptographically-verifiable set of one PrePrepare and quorum-1 Prepares that - prove a particular value (payload) was prepared for a particular (epoch, block, view)-tuple - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| pre_prepare | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.SignedMessage`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-signedmessage) | optional | | -| prepares | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.SignedMessage`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-signedmessage) | repeated | | - - -**Message `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.ProofOfAvailability`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto#L97) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| batch_id | `bytes` | optional | | -| acks | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.AvailabilityAck`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-availabilityack) | repeated | | -| epoch_number | `int64` | optional | | - - -**Message `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.RetransmissionMessage`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto#L187) -- Fields: 2 - -Retransmissions - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| retransmission_request | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.SignedMessage`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-signedmessage) | optional | | -| retransmission_response | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.RetransmissionResponse`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-retransmissionresponse) | optional | | - - -**Message `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.RetransmissionResponse`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto#L194) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| commit_certificates | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.CommitCertificate`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-commitcertificate) | repeated | | - - -**Message `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.SegmentInProgress`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto#L221) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| view_number | `int64` | optional | | -| block_statuses | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.BlockStatus`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-blockstatus) | repeated | | - - -**Message `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.SegmentInViewChange`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto#L216) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| view_number | `int64` | optional | | -| view_change_messages_present | `bool` | repeated | | -| are_blocks_complete | `bool` | repeated | | - - -**Message `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.SegmentStatus`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto#L209) -- Fields: 3 - -Node's status of consensus for a specific segment, which is identified by its order inside of the EpochStatus - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| complete | `google.protobuf.Empty` | optional | | -| in_view_change | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.SegmentInViewChange`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-segmentinviewchange) | optional | | -| in_progress | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.SegmentInProgress`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-segmentinprogress) | optional | | - - -**Message `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.SignedMessage`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto#L37) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| message | `bytes` | optional | | -| from | `string` | optional | | -| signature | [`com.digitalasset.canton.crypto.v30.Signature`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-signature) | optional | | - - -**Message `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.StateTransferMessage`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto#L240) -- Fields: 2 - -State transfer - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| block_request | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.BlockTransferRequest`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-blocktransferrequest) | optional | | -| block_response | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.BlockTransferResponse`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-blocktransferresponse) | optional | | - - -**Message `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.StoreRequest`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto#L57) -- Fields: 2 - -A `StoreRequest` is requesting another availability node to store - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| batch_id | `bytes` | optional | | -| batch | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.Batch`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-batch) | optional | | - - -**Message `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.StoreResponse`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto#L79) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| batch_id | `bytes` | optional | | -| signature | [`com.digitalasset.canton.crypto.v30.Signature`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-signature) | optional | | - - -**Message `com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.ViewChange`** - -- Source: [community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto#L148) -- Fields: 1 - -A `ViewChange` message is sent when an instance of PBFT fails to make progress - before a timeout triggers. -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| consensus_certs | [`com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.ConsensusCertificate`](#type-com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30-consensuscertificate) | repeated | | +
+ +
+
Source file
+
community/synchronizer/src/main/protobuf/com/digitalasset/canton/synchronizer/sequencing/sequencer/bftordering/v30/bft_ordering_service.proto
+
+ +
+
Operations
+
1
+
+ +
+ + +
+ + + + +
+

BftOrderingService.Receive

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc BftOrderingService.Receive(stream com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.BftOrderingMessage) returns (stream com.digitalasset.canton.synch...

+ + +
+ +
+
Request
+
com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.BftOrderingMessage
+
+ +
+
Response
+
com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.BftOrderingMessage
+
+ +
+
Client stream
+
Yes
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + + +
+ + + + + +## Type Inventory + + +These are the package-level message and enum shapes in the publish-version snapshot. + + + + +
+
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.AvailabilityAck

+ +

2 fields

+ +
+ + +
+ +
+
+ from + string + +
+ +
+ +
+
+ signature + Signature + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.Signature

+ +

5 fields

+ +
+ + +
+ +
+
+ format + SignatureFormat + +
+ +
+ +
+
+ signature + bytes + +
+ +
+ +
+
+ signed_by + string + +
+ +
The fingerprint/id of the keypair used to create this signature and needed to verify. If a signature delegation is defined, this fingerprint/id is not used to produce the signature, and, instead is used to sign the delegation.
+ +
+ +
+
+ signing_algorithm_spec + SigningAlgorithmSpec + +
+ +
The signing algorithm specification used to produce this signature
+ +
+ +
+
+ signature_delegation + SignatureDelegation + +
+ +
An optional signature delegation where a long-term signing key authorizes a session signing key to sign on its behalf.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SignatureFormat

+ +

5 values

+ +
+ + + +
    + +
  • SIGNATURE_FORMAT_UNSPECIFIED
    • + +
  • SIGNATURE_FORMAT_RAW
    • + +
  • SIGNATURE_FORMAT_DER
    • + +
  • SIGNATURE_FORMAT_CONCAT
    • + +
  • SIGNATURE_FORMAT_SYMBOLIC
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SigningAlgorithmSpec

+ +

4 values

+ +
+ + + +
    + +
  • SIGNING_ALGORITHM_SPEC_UNSPECIFIED
    • + +
  • SIGNING_ALGORITHM_SPEC_ED25519
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_256
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_384
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SignatureDelegation

+ +

7 fields

+ +
+ + +
+ +
+
+ session_key + bytes + +
+ +
ASN.1 + DER-encoding of X.509 SubjectPublicKeyInfo structure of the session public key: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1. This key was used to produce the actual signature.
+ +
+ +
+
+ session_key_spec + SigningKeySpec + +
+ +
The signing key spec for the session key.
+ +
+ +
+
+ validity_period_from_inclusive + int64 + +
+ +
A timestamp in microseconds of UTC time since Unix epoch that indicates when the session key is considered valid.
+ +
+ +
+
+ validity_period_duration_seconds + uint32 + +
+ +
Duration in seconds indicating how long the session key remains valid. The validity period starts from `validity_period_from_inclusive` above.
+ +
+ +
+
+ format + SignatureFormat + +
+ +
The format of the signature
+ +
+ +
+
+ signature + bytes + +
+ +
The signature of the combined hash of the session key fingerprint, validity period, and synchronizer id, by the long-term key. This signature authorizes the session key to act on behalf of the long-term key.
+ +
+ +
+
+ signing_algorithm_spec + SigningAlgorithmSpec + +
+ +
The signing algorithm specification used to produce this signature
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SigningKeySpec

+ +

5 values

+ +
+ +

[start-docs-entry: signing key spec proto]

+ + + +
    + +
  • SIGNING_KEY_SPEC_UNSPECIFIED
    • + +
  • SIGNING_KEY_SPEC_EC_CURVE25519
    • + +
  • SIGNING_KEY_SPEC_EC_P256
    • + +
  • SIGNING_KEY_SPEC_EC_P384
    • + +
  • SIGNING_KEY_SPEC_EC_SECP256K1
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.AvailabilityMessage

+ +

5 fields

+ +
+ + +
+ +
+
+ ping + Empty + +
+ +
+ +
+
+ store_request + StoreRequest + +
+ +
+ +
+
+ store_response + StoreResponse + +
+ +
+ +
+
+ batch_request + BatchRequest + +
+ +
+ +
+
+ batch_response + BatchResponse + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.StoreRequest

+ +

2 fields

+ +
+ +

A `StoreRequest` is requesting another availability node to store

+ + +
+ +
+
+ batch_id + bytes + +
+ +
+ +
+
+ batch + Batch + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.Batch

+ +

2 fields

+ +
+ + +
+ +
+
+ ordering_requests + repeated OrderingRequest + +
+ +
+ +
+
+ epoch_number + int64 + +
+ +
epoch number assigned to batch at the time of creation corresponding to last know epoch number at the availability module. it is used for inferring the expiration of the batch.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.OrderingRequest

+ +

4 fields

+ +
+ + +
+ +
+
+ trace_context + string + +
+ +
+ +
+
+ tag + string + +
+ +
+ +
+
+ payload + bytes + +
+ +
+ +
+
+ ordering_start_instant + Timestamp + +
+ +
The following field is only used for metrics.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.StoreResponse

+ +

2 fields

+ +
+ + +
+ +
+
+ batch_id + bytes + +
+ +
+ +
+
+ signature + Signature + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.BatchRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ batch_id + bytes + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.BatchResponse

+ +

2 fields

+ +
+ + +
+ +
+
+ batch_id + bytes + +
+ +
+ +
+
+ batch + Batch + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.BftOrderingMessage

+ +

4 fields

+ +
+ + +
+ +
+
+ trace_context + string + +
+ +
+ +
+
+ body + BftOrderingMessageBody + +
+ +
+ +
+
+ sent_by + string + +
+ +
+ +
+
+ sent_at + Timestamp + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.BftOrderingMessageBody

+ +

5 fields

+ +
+ + +
+ +
+
+ availability_message + SignedMessage + +
+ +
+ +
+
+ consensus_message + SignedMessage + +
+ +
+ +
+
+ state_transfer_message + SignedMessage + +
+ +
+ +
+
+ retransmission_message + RetransmissionMessage + +
+ +
+ +
+
+ connection_opened + ConnectionOpened + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.SignedMessage

+ +

3 fields

+ +
+ + +
+ +
+
+ message + bytes + +
+ +
+ +
+
+ from + string + +
+ +
+ +
+
+ signature + Signature + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.RetransmissionMessage

+ +

2 fields

+ +
+ +

Retransmissions

+ + +
+ +
+
+ retransmission_request + SignedMessage + +
+ +
+ +
+
+ retransmission_response + RetransmissionResponse + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.RetransmissionResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ commit_certificates + repeated CommitCertificate + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.CommitCertificate

+ +

2 fields

+ +
+ +

A self-contained, cryptographically-verifiable set of one PrePrepare and quorum-1 Commits that prove a particular value (payload) was committed for a particular (epoch, block, view)-tuple

+ + +
+ +
+
+ pre_prepare + SignedMessage + +
+ +
+ +
+
+ commits + repeated SignedMessage + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.ConnectionOpened

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.BlockInProgress

+ +

3 fields

+ +
+ + +
+ +
+
+ pre_prepared + bool + +
+ +
+ +
+
+ prepares_present + repeated bool + +
+ +
+ +
+
+ commits_present + repeated bool + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.BlockMetadata

+ +

2 fields

+ +
+ + +
+ +
+
+ epoch_number + int64 + +
+ +
+ +
+
+ block_number + int64 + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.BlockStatus

+ +

2 fields

+ +
+ +

Node's status of consensus of a specific block in a segment, which is identified by its order inside of the SegmentInProgress

+ + +
+ +
+
+ complete + Empty + +
+ +
+ +
+
+ in_progress + BlockInProgress + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.BlockTransferRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ epoch + int64 + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.BlockTransferResponse

+ +

1 fields

+ +
+ +

A thin wrapper for a commit certificate. As long as it merely contains a commit certificate (that in turn includes signed and verified data), its signature verification can be safely skipped. As a result, any node can help with state transfer (even when sending responses signed with a new/rotated key).

+ + +
+ +
+
+ commit_certificate + CommitCertificate + +
+ +
Avoid adding more data that would require signing to allow skipping the outer message's signature verification!
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.CanonicalCommitSet

+ +

1 fields

+ +
+ +

A canonical (fixed) set of (usually 2f+1) Commit messages that completed the recent stable block. Check the BFT time design for more details.

+ + +
+ +
+
+ canonical_commits + repeated SignedMessage + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.Commit

+ +

2 fields

+ +
+ +

A `Commit` means that a node have received a quorum of `Prepare` Upon receiving a quorum of `Commit`, a node considers the round complete

+ + +
+ +
+
+ block_hash + bytes + +
+ +
+ +
+
+ local_timestamp + int64 + +
+ +
creation time, in microseconds of UTC time since Unix epoch
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.ConsensusCertificate

+ +

2 fields

+ +
+ + +
+ +
+
+ prepare_certificate + PrepareCertificate + +
+ +
+ +
+
+ commit_certificate + CommitCertificate + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.PrepareCertificate

+ +

2 fields

+ +
+ +

A self-contained, cryptographically-verifiable set of one PrePrepare and quorum-1 Prepares that prove a particular value (payload) was prepared for a particular (epoch, block, view)-tuple

+ + +
+ +
+
+ pre_prepare + SignedMessage + +
+ +
+ +
+
+ prepares + repeated SignedMessage + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.ConsensusMessage

+ +

8 fields

+ +
+ + +
+ +
+
+ block_metadata + BlockMetadata + +
+ +
+ +
+
+ view_number + int64 + +
+ +
+ +
+
+ from + string + +
+ +
+ +
+
+ pre_prepare + PrePrepare + +
+ +
+ +
+
+ prepare + Prepare + +
+ +
+ +
+
+ commit + Commit + +
+ +
+ +
+
+ view_change + ViewChange + +
+ +
+ +
+
+ new_view + NewView + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.PrePrepare

+ +

2 fields

+ +
+ +

A `PrePrepare` message is the proposal sent by the leader in a round

+ + +
+ +
+
+ block + OrderingBlock + +
+ +
+ +
+
+ bft_time_canonical_commit_set + CanonicalCommitSet + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.OrderingBlock

+ +

1 fields

+ +
+ + +
+ +
+
+ proofs + repeated ProofOfAvailability + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.ProofOfAvailability

+ +

3 fields

+ +
+ + +
+ +
+
+ batch_id + bytes + +
+ +
+ +
+
+ acks + repeated AvailabilityAck + +
+ +
+ +
+
+ epoch_number + int64 + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.Prepare

+ +

1 fields

+ +
+ +

A `Prepare` is an acknowledgement that a node received the `PrePrepare`

+ + +
+ +
+
+ block_hash + bytes + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.ViewChange

+ +

1 fields

+ +
+ +

A `ViewChange` message is sent when an instance of PBFT fails to make progress before a timeout triggers.

+ + +
+ +
+
+ consensus_certs + repeated ConsensusCertificate + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.NewView

+ +

2 fields

+ +
+ +

A `NewView` message is sent by the next node taking over leader responsibilities of a PBFT instance at the end of a view change

+ + +
+ +
+
+ view_changes + repeated SignedMessage + +
+ +
+ +
+
+ pre_prepares + repeated SignedMessage + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.DynamicSequencingParametersPayload

+ +

1 fields

+ +
+ + +
+ +
+
+ pbft_view_change_timeout + Duration + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.EpochStatus

+ +

2 fields

+ +
+ +

Node's status of consensus for the whole epoch. Acts as a retransmission request where receiving node will compute what they can retransmit based on what the requesting node is lacking from looking at this status message.

+ + +
+ +
+
+ epoch_number + int64 + +
+ +
+ +
+
+ segments + repeated SegmentStatus + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.SegmentStatus

+ +

3 fields

+ +
+ +

Node's status of consensus for a specific segment, which is identified by its order inside of the EpochStatus

+ + +
+ +
+
+ complete + Empty + +
+ +
+ +
+
+ in_view_change + SegmentInViewChange + +
+ +
+ +
+
+ in_progress + SegmentInProgress + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.SegmentInViewChange

+ +

3 fields

+ +
+ + +
+ +
+
+ view_number + int64 + +
+ +
+ +
+
+ view_change_messages_present + repeated bool + +
+ +
+ +
+
+ are_blocks_complete + repeated bool + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.SegmentInProgress

+ +

2 fields

+ +
+ + +
+ +
+
+ view_number + int64 + +
+ +
+ +
+
+ block_statuses + repeated BlockStatus + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.StateTransferMessage

+ +

2 fields

+ +
+ +

State transfer

+ + +
+ +
+
+ block_request + BlockTransferRequest + +
+ +
+ +
+
+ block_response + BlockTransferResponse + +
+ +
+ +
+ + + +
diff --git a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-synchronizer-v30.mdx b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-synchronizer-v30.mdx index 180e4cd..2e25b56 100644 --- a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-synchronizer-v30.mdx +++ b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-synchronizer-v30.mdx @@ -1,38 +1,155 @@ --- title: "com.digitalasset.canton.synchronizer.v30" -description: "Descriptor-backed protobuf API history for package com.digitalasset.canton.synchronizer.v30." +description: "Package-level overview for com.digitalasset.canton.synchronizer.v30." --- -# Package `com.digitalasset.canton.synchronizer.v30` +

Back to overview

-[Back to Canton Protobuf History](../index) +
+ +

Protobuf Package

+ + +

com.digitalasset.canton.synchronizer.v30

+ + +

0 services, 0 endpoints, 1 messages

+ + +
+ + gRPC + +
-## Snapshot + +
+ +
+
Files
+
1
+
+ +
+
Services
+
0
+
+ +
+
Endpoints
+
0
+
+ +
+
Messages
+
1
+
+ +
+
Enums
+
0
+
+ +
+ +
-- Current files: `1` -- Current services: `0` -- Current endpoints: `0` -- Current messages: `1` -- Current enums: `0` -- Lifecycle endpoints tracked: `0` ## Source Files -| File | Services | Messages | Enums | Source | -| --- | --- | --- | --- | --- | -| community/base/src/main/protobuf/com/digitalasset/canton/synchronizer/v30/synchronizer.proto | `0` | `1` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/synchronizer/v30/synchronizer.proto#L4) | -## Type Reference - -**Message `com.digitalasset.canton.synchronizer.v30.SynchronizerPredecessor`** -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/synchronizer/v30/synchronizer.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/synchronizer/v30/synchronizer.proto#L10) -- Fields: 2 +
+ + +
+ +
+

community/base/src/main/protobuf/com/digitalasset/canton/synchronizer/v30/synchronizer.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
1
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/base/src/main/protobuf/com/digitalasset/canton/synchronizer/v30/synchronizer.proto
+
+ +
+ + +
+ + +
+ + + + + +## Type Inventory + + +These are the package-level message and enum shapes in the publish-version snapshot. + + + -_No description._ +
+
+

com.digitalasset.canton.synchronizer.v30.SynchronizerPredecessor

+ +

2 fields

+ +
+ + +
+ +
+
+ predecessor_physical_id + string + +
+ +
Id of the predecessor.
+ +
+ +
+
+ upgrade_time + Timestamp + +
+ +
When the upgrade happened/is supposed to happen.
+ +
+ +
-| Field | Type | Label | Description | -| --- | --- | --- | --- | -| predecessor_physical_id | `string` | optional | Id of the predecessor. | -| upgrade_time | `google.protobuf.Timestamp` | optional | When the upgrade happened/is supposed to happen. | + + +
diff --git a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-time-admin-v30.mdx b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-time-admin-v30.mdx index 9127d00..3d68f6a 100644 --- a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-time-admin-v30.mdx +++ b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-time-admin-v30.mdx @@ -1,152 +1,387 @@ --- title: "com.digitalasset.canton.time.admin.v30" -description: "Descriptor-backed protobuf API history for package com.digitalasset.canton.time.admin.v30." +description: "Package-level overview for com.digitalasset.canton.time.admin.v30." --- -# Package `com.digitalasset.canton.time.admin.v30` +

Back to overview

+ +
+ +

Protobuf Package

+ + +

com.digitalasset.canton.time.admin.v30

+ + +

1 services, 2 endpoints, 4 messages

+ + +
+ + gRPC + +
+ + +
+ +
+
Files
+
1
+
+ +
+
Services
+
1
+
+ +
+
Endpoints
+
2
+
+ +
+
Messages
+
4
+
+ +
+
Enums
+
0
+
+ +
+ +
-[Back to Canton Protobuf History](../index) - -## Snapshot - -- Current files: `1` -- Current services: `1` -- Current endpoints: `2` -- Current messages: `4` -- Current enums: `0` -- Lifecycle endpoints tracked: `2` ## Source Files -| File | Services | Messages | Enums | Source | -| --- | --- | --- | --- | --- | -| community/base/src/main/protobuf/com/digitalasset/canton/time/admin/v30/synchronizer_time_service.proto | `1` | `4` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/time/admin/v30/synchronizer_time_service.proto#L4) | - -## Services - -| Service | Endpoints | Source | Description | -| --- | --- | --- | --- | -| [`SynchronizerTimeService`](#service-com-digitalasset-canton-time-admin-v30-synchronizertimeservice) | `2` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/time/admin/v30/synchronizer_time_service.proto#L12) | | - - -### Service `SynchronizerTimeService` - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/time/admin/v30/synchronizer_time_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/time/admin/v30/synchronizer_time_service.proto#L12) -- Endpoints tracked: `2` - -_No description._ - -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`AwaitTime`](#endpoint-com-digitalasset-canton-time-admin-v30-synchronizertimeservice-awaittime) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.time.admin.v30.AwaitTimeRequest`](#type-com-digitalasset-canton-time-admin-v30-awaittimerequest) | [`com.digitalasset.canton.time.admin.v30.AwaitTimeResponse`](#type-com-digitalasset-canton-time-admin-v30-awaittimeresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/time/admin/v30/synchronizer_time_service.proto#L16) | -| [`FetchTime`](#endpoint-com-digitalasset-canton-time-admin-v30-synchronizertimeservice-fetchtime) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.time.admin.v30.FetchTimeRequest`](#type-com-digitalasset-canton-time-admin-v30-fetchtimerequest) | [`com.digitalasset.canton.time.admin.v30.FetchTimeResponse`](#type-com-digitalasset-canton-time-admin-v30-fetchtimeresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/time/admin/v30/synchronizer_time_service.proto#L14) | - - -**Endpoint `SynchronizerTimeService.AwaitTime`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/time/admin/v30/synchronizer_time_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/time/admin/v30/synchronizer_time_service.proto#L16) - -**Signature** - -```protobuf -rpc SynchronizerTimeService.AwaitTime(com.digitalasset.canton.time.admin.v30.AwaitTimeRequest) returns (com.digitalasset.canton.time.admin.v30.AwaitTimeResponse); -``` - -await for the supplied time to be reached on the target synchronizer - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.time.admin.v30.AwaitTimeRequest`](#type-com-digitalasset-canton-time-admin-v30-awaittimerequest) - -**Response Type** - -- [`com.digitalasset.canton.time.admin.v30.AwaitTimeResponse`](#type-com-digitalasset-canton-time-admin-v30-awaittimeresponse) - - -**Endpoint `SynchronizerTimeService.FetchTime`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/time/admin/v30/synchronizer_time_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/time/admin/v30/synchronizer_time_service.proto#L14) - -**Signature** - -```protobuf -rpc SynchronizerTimeService.FetchTime(com.digitalasset.canton.time.admin.v30.FetchTimeRequest) returns (com.digitalasset.canton.time.admin.v30.FetchTimeResponse); -``` - -fetch the synchronizer time which has been received within a supplied freshness bound defined by the local clock - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.time.admin.v30.FetchTimeRequest`](#type-com-digitalasset-canton-time-admin-v30-fetchtimerequest) - -**Response Type** - -- [`com.digitalasset.canton.time.admin.v30.FetchTimeResponse`](#type-com-digitalasset-canton-time-admin-v30-fetchtimeresponse) - -## Type Reference - - -**Message `com.digitalasset.canton.time.admin.v30.AwaitTimeRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/time/admin/v30/synchronizer_time_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/time/admin/v30/synchronizer_time_service.proto#L29) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| synchronizer | [`com.digitalasset.canton.topology.admin.v30.Synchronizer`](com-digitalasset-canton-topology-admin-v30#type-com-digitalasset-canton-topology-admin-v30-synchronizer) | optional | optional - must be specified for participants but can be defaulted for synchronizer entities as they only have one possible synchronizer | -| timestamp | `google.protobuf.Timestamp` | optional | the synchronizer time to wait for | - - -**Message `com.digitalasset.canton.time.admin.v30.AwaitTimeResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/time/admin/v30/synchronizer_time_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/time/admin/v30/synchronizer_time_service.proto#L36) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.time.admin.v30.FetchTimeRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/time/admin/v30/synchronizer_time_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/time/admin/v30/synchronizer_time_service.proto#L19) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| synchronizer | [`com.digitalasset.canton.topology.admin.v30.Synchronizer`](com-digitalasset-canton-topology-admin-v30#type-com-digitalasset-canton-topology-admin-v30-synchronizer) | optional | optional - must be specified for participants but can be defaulted for synchronizer entities as they only have one possible synchronizer | -| freshness_bound | `google.protobuf.Duration` | optional | | - - -**Message `com.digitalasset.canton.time.admin.v30.FetchTimeResponse`** -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/time/admin/v30/synchronizer_time_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/time/admin/v30/synchronizer_time_service.proto#L25) -- Fields: 1 -_No description._ -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| timestamp | `google.protobuf.Timestamp` | optional | | +
+ + +
+ +
+

community/base/src/main/protobuf/com/digitalasset/canton/time/admin/v30/synchronizer_time_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
4
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/base/src/main/protobuf/com/digitalasset/canton/time/admin/v30/synchronizer_time_service.proto
+
+ +
+ + +
+ + +
+ + + + + +## SynchronizerTimeService + + + +
+ +
+
Source file
+
community/base/src/main/protobuf/com/digitalasset/canton/time/admin/v30/synchronizer_time_service.proto
+
+ +
+
Operations
+
2
+
+ +
+ + +
+ + + + +
+

SynchronizerTimeService.AwaitTime

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

await for the supplied time to be reached on the target synchronizer

+ + +
+ +
+
Request
+
com.digitalasset.canton.time.admin.v30.AwaitTimeRequest
+
+ +
+
Response
+
com.digitalasset.canton.time.admin.v30.AwaitTimeResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

SynchronizerTimeService.FetchTime

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

fetch the synchronizer time which has been received within a supplied freshness bound defined by the local clock

+ + +
+ +
+
Request
+
com.digitalasset.canton.time.admin.v30.FetchTimeRequest
+
+ +
+
Response
+
com.digitalasset.canton.time.admin.v30.FetchTimeResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## Type Inventory + + +These are the package-level message and enum shapes in the publish-version snapshot. + + + + +
+
+

com.digitalasset.canton.time.admin.v30.AwaitTimeRequest

+ +

2 fields

+ +
+ + +
+ +
+
+ synchronizer + Synchronizer + +
+ +
optional - must be specified for participants but can be defaulted for synchronizer entities as they only have one possible synchronizer
+ +
+ +
+
+ timestamp + Timestamp + +
+ +
the synchronizer time to wait for
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.Synchronizer

+ +

2 fields

+ +
+ + +
+ +
+
+ id + string + +
+ +
+ +
+
+ physical_id + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.time.admin.v30.AwaitTimeResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.time.admin.v30.FetchTimeRequest

+ +

2 fields

+ +
+ + +
+ +
+
+ synchronizer + Synchronizer + +
+ +
optional - must be specified for participants but can be defaulted for synchronizer entities as they only have one possible synchronizer
+ +
+ +
+
+ freshness_bound + Duration + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.time.admin.v30.FetchTimeResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ timestamp + Timestamp + +
+ +
+ +
+ + + +
diff --git a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-topology-admin-v30.mdx b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-topology-admin-v30.mdx index 9a2f216..3ec0a98 100644 --- a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-topology-admin-v30.mdx +++ b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-topology-admin-v30.mdx @@ -1,162 +1,441 @@ --- title: "com.digitalasset.canton.topology.admin.v30" -description: "Descriptor-backed protobuf API history for package com.digitalasset.canton.topology.admin.v30." +description: "Package-level overview for com.digitalasset.canton.topology.admin.v30." --- -# Package `com.digitalasset.canton.topology.admin.v30` +

Back to overview

+ +
+ +

Protobuf Package

+ + +

com.digitalasset.canton.topology.admin.v30

+ + +

4 services, 34 endpoints, 100 messages, 1 enums

+ + +
+ + gRPC + +
+ + +
+ +
+
Files
+
5
+
+ +
+
Services
+
4
+
+ +
+
Endpoints
+
34
+
+ +
+
Messages
+
100
+
+ +
+
Enums
+
1
+
+ +
+ +
-[Back to Canton Protobuf History](../index) - -## Snapshot - -- Current files: `5` -- Current services: `4` -- Current endpoints: `34` -- Current messages: `100` -- Current enums: `1` -- Lifecycle endpoints tracked: `34` ## Source Files -| File | Services | Messages | Enums | Source | -| --- | --- | --- | --- | --- | -| community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/common.proto | `0` | `3` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/common.proto#L4) | -| community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/initialization_service.proto | `1` | `8` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/initialization_service.proto#L4) | -| community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_aggregation_service.proto | `1` | `4` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_aggregation_service.proto#L4) | -| community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto | `1` | `44` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L4) | -| community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto | `1` | `16` | `1` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto#L4) | -## Services -| Service | Endpoints | Source | Description | -| --- | --- | --- | --- | -| [`IdentityInitializationService`](#service-com-digitalasset-canton-topology-admin-v30-identityinitializationservice) | `3` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/initialization_service.proto#L14) | * The node identity initialization service | -| [`TopologyAggregationService`](#service-com-digitalasset-canton-topology-admin-v30-topologyaggregationservice) | `2` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_aggregation_service.proto#L20) | * Topology information aggregation service This service allows deep inspection into the aggregated topology state. Th... | -| [`TopologyManagerReadService`](#service-com-digitalasset-canton-topology-admin-v30-topologymanagerreadservice) | `21` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L14) | | -| [`TopologyManagerWriteService`](#service-com-digitalasset-canton-topology-admin-v30-topologymanagerwriteservice) | `8` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto#L17) | * Write operations on the local topology manager. Participants, mediators, and sequencers run a local topology manage... | - -### Service `IdentityInitializationService` +
+ + +
+ +
+

community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/common.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
3
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/common.proto
+
+ +
+ + +
+ + + +
+ +
+

community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/initialization_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
8
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/initialization_service.proto
+
+ +
+ + +
+ + + +
+ +
+

community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_aggregation_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
4
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_aggregation_service.proto
+
+ +
+ + +
+ + + +
+ +
+

community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
44
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto
+
+ +
+ + +
+ + + +
+ +
+

community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
1
+
+ +
+
Messages
+
16
+
+ +
+
Enums
+
1
+
+ +
+
Source
+
community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto
+
+ +
+ + +
+ + +
+ + + + + +## IdentityInitializationService -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/initialization_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/initialization_service.proto#L14) -- Endpoints tracked: `3` * The node identity initialization service -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`CurrentTime`](#endpoint-com-digitalasset-canton-topology-admin-v30-identityinitializationservice-currenttime) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.topology.admin.v30.CurrentTimeRequest`](#type-com-digitalasset-canton-topology-admin-v30-currenttimerequest) | [`com.digitalasset.canton.topology.admin.v30.CurrentTimeResponse`](#type-com-digitalasset-canton-topology-admin-v30-currenttimeresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/initialization_service.proto#L34) | -| [`GetId`](#endpoint-com-digitalasset-canton-topology-admin-v30-identityinitializationservice-getid) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.topology.admin.v30.GetIdRequest`](#type-com-digitalasset-canton-topology-admin-v30-getidrequest) | [`com.digitalasset.canton.topology.admin.v30.GetIdResponse`](#type-com-digitalasset-canton-topology-admin-v30-getidresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/initialization_service.proto#L29) | -| [`InitId`](#endpoint-com-digitalasset-canton-topology-admin-v30-identityinitializationservice-initid) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.topology.admin.v30.InitIdRequest`](#type-com-digitalasset-canton-topology-admin-v30-initidrequest) | [`com.digitalasset.canton.topology.admin.v30.InitIdResponse`](#type-com-digitalasset-canton-topology-admin-v30-initidresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/initialization_service.proto#L24) | - - -**Endpoint `IdentityInitializationService.CurrentTime`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/initialization_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/initialization_service.proto#L34) - -**Signature** - -```protobuf -rpc IdentityInitializationService.CurrentTime(com.digitalasset.canton.topology.admin.v30.CurrentTimeRequest) returns (com.digitalasset.canton.topology.admin.v30.CurrentTimeResponse); -``` - -* - Returns the current time of the node (used for testing with static time) - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.topology.admin.v30.CurrentTimeRequest`](#type-com-digitalasset-canton-topology-admin-v30-currenttimerequest) - -**Response Type** - -- [`com.digitalasset.canton.topology.admin.v30.CurrentTimeResponse`](#type-com-digitalasset-canton-topology-admin-v30-currenttimeresponse) - - -**Endpoint `IdentityInitializationService.GetId`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/initialization_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/initialization_service.proto#L29) - -**Signature** - -```protobuf -rpc IdentityInitializationService.GetId(com.digitalasset.canton.topology.admin.v30.GetIdRequest) returns (com.digitalasset.canton.topology.admin.v30.GetIdResponse); -``` - -* - Returns the id of the node (or empty if not initialized) - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.topology.admin.v30.GetIdRequest`](#type-com-digitalasset-canton-topology-admin-v30-getidrequest) - -**Response Type** - -- [`com.digitalasset.canton.topology.admin.v30.GetIdResponse`](#type-com-digitalasset-canton-topology-admin-v30-getidresponse) - - -**Endpoint `IdentityInitializationService.InitId`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/initialization_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/initialization_service.proto#L24) - -**Signature** - -```protobuf -rpc IdentityInitializationService.InitId(com.digitalasset.canton.topology.admin.v30.InitIdRequest) returns (com.digitalasset.canton.topology.admin.v30.InitIdResponse); -``` - -* - Initialize the node with the unique identifier (can and must be done once) - - When a node starts for the first time, we need to bind it - to a globally unique stable identifier before we can continue with the - initialization procedure. - - This method is only used once during initialization. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.topology.admin.v30.InitIdRequest`](#type-com-digitalasset-canton-topology-admin-v30-initidrequest) - -**Response Type** - -- [`com.digitalasset.canton.topology.admin.v30.InitIdResponse`](#type-com-digitalasset-canton-topology-admin-v30-initidresponse) - -### Service `TopologyAggregationService` +
+ +
+
Source file
+
community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/initialization_service.proto
+
+ +
+
Operations
+
3
+
+ +
+ + +
+ + + + +
+

IdentityInitializationService.CurrentTime

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

* Returns the current time of the node (used for testing with static time)

+ + +
+ +
+
Request
+
com.digitalasset.canton.topology.admin.v30.CurrentTimeRequest
+
+ +
+
Response
+
com.digitalasset.canton.topology.admin.v30.CurrentTimeResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

IdentityInitializationService.GetId

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

* Returns the id of the node (or empty if not initialized)

+ + +
+ +
+
Request
+
com.digitalasset.canton.topology.admin.v30.GetIdRequest
+
+ +
+
Response
+
com.digitalasset.canton.topology.admin.v30.GetIdResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

IdentityInitializationService.InitId

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

* Initialize the node with the unique identifier (can and must be done once) When a node starts for the first time, we need to bind it to a globally unique stable identifier bef...

+ + +
+ +
+
Request
+
com.digitalasset.canton.topology.admin.v30.InitIdRequest
+
+ +
+
Response
+
com.digitalasset.canton.topology.admin.v30.InitIdResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## TopologyAggregationService -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_aggregation_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_aggregation_service.proto#L20) -- Endpoints tracked: `2` * Topology information aggregation service @@ -166,2341 +445,7430 @@ rpc IdentityInitializationService.InitId(com.digitalasset.canton.topology.admin. data. The service provides GRPC access to the information aggregated by the identity providing service client. -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`ListKeyOwners`](#endpoint-com-digitalasset-canton-topology-admin-v30-topologyaggregationservice-listkeyowners) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.topology.admin.v30.ListKeyOwnersRequest`](#type-com-digitalasset-canton-topology-admin-v30-listkeyownersrequest) | [`com.digitalasset.canton.topology.admin.v30.ListKeyOwnersResponse`](#type-com-digitalasset-canton-topology-admin-v30-listkeyownersresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_aggregation_service.proto#L52) | -| [`ListParties`](#endpoint-com-digitalasset-canton-topology-admin-v30-topologyaggregationservice-listparties) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.topology.admin.v30.ListPartiesRequest`](#type-com-digitalasset-canton-topology-admin-v30-listpartiesrequest) | [`com.digitalasset.canton.topology.admin.v30.ListPartiesResponse`](#type-com-digitalasset-canton-topology-admin-v30-listpartiesresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_aggregation_service.proto#L34) | - - -**Endpoint `TopologyAggregationService.ListKeyOwners`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_aggregation_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_aggregation_service.proto#L52) - -**Signature** - -```protobuf -rpc TopologyAggregationService.ListKeyOwners(com.digitalasset.canton.topology.admin.v30.ListKeyOwnersRequest) returns (com.digitalasset.canton.topology.admin.v30.ListKeyOwnersResponse); -``` - -* - Obtain key owner information matching a given filter criterion. - - Key owners in the system are different types of entities: Participant, Mediator, and - Sequencer. The present method allows to define a filter to search for a key owner - using filters on (asOf, synchronizer_id, ownerType, owner) - - The response is a sequence of (synchronizer_id, ownerType, owner, keys) where keys is a sequence of - (fingerprint, bytes, key purpose). As such, we can use this method to export currently used signing or encryption - public keys. - This method is quite general, as depending on the arguments, very different results can be obtained. +
+ +
+
Source file
+
community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_aggregation_service.proto
+
+ +
+
Operations
+
2
+
+ +
+ + +
+ + + + +
+

TopologyAggregationService.ListKeyOwners

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

* Obtain key owner information matching a given filter criterion. Key owners in the system are different types of entities: Participant, Mediator, and Sequencer. The present met...

+ + +
+ +
+
Request
+
com.digitalasset.canton.topology.admin.v30.ListKeyOwnersRequest
+
+ +
+
Response
+
com.digitalasset.canton.topology.admin.v30.ListKeyOwnersResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

TopologyAggregationService.ListParties

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

* Obtain information about a certain set of active parties matching a given filter criterion. The request allows to filter per (synchronizer, party, asOf) where the party argume...

+ + +
+ +
+
Request
+
com.digitalasset.canton.topology.admin.v30.ListPartiesRequest
+
+ +
+
Response
+
com.digitalasset.canton.topology.admin.v30.ListPartiesResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## TopologyManagerReadService + + + +
+ +
+
Source file
+
community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto
+
+ +
+
Operations
+
21
+
+ +
+ + +
+ + + + +
+

TopologyManagerReadService.ExportTopologySnapshot

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc TopologyManagerReadService.ExportTopologySnapshot(com.digitalasset.canton.topology.admin.v30.ExportTopologySnapshotRequest) returns (stream com.digitalasset.canton.topology....

+ + +
+ +
+
Request
+
com.digitalasset.canton.topology.admin.v30.ExportTopologySnapshotRequest
+
+ +
+
Response
+
com.digitalasset.canton.topology.admin.v30.ExportTopologySnapshotResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + + + + + +
+

TopologyManagerReadService.ExportTopologySnapshotV2

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc TopologyManagerReadService.ExportTopologySnapshotV2(com.digitalasset.canton.topology.admin.v30.ExportTopologySnapshotV2Request) returns (stream com.digitalasset.canton.topol...

+ + +
+ +
+
Request
+
com.digitalasset.canton.topology.admin.v30.ExportTopologySnapshotV2Request
+
+ +
+
Response
+
com.digitalasset.canton.topology.admin.v30.ExportTopologySnapshotV2Response
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + + + + + +
+

TopologyManagerReadService.GenesisState

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Fetch the genesis topology state. The returned bytestring can be used directly to initialize a sequencer.

+ + +
+ +
+
Request
+
com.digitalasset.canton.topology.admin.v30.GenesisStateRequest
+
+ +
+
Response
+
com.digitalasset.canton.topology.admin.v30.GenesisStateResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + + + + + +
+

TopologyManagerReadService.GenesisStateV2

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc TopologyManagerReadService.GenesisStateV2(com.digitalasset.canton.topology.admin.v30.GenesisStateV2Request) returns (stream com.digitalasset.canton.topology.admin.v30.Genesi...

+ + +
+ +
+
Request
+
com.digitalasset.canton.topology.admin.v30.GenesisStateV2Request
+
+ +
+
Response
+
com.digitalasset.canton.topology.admin.v30.GenesisStateV2Response
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + + + + + +
+

TopologyManagerReadService.ListAll

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc TopologyManagerReadService.ListAll(com.digitalasset.canton.topology.admin.v30.ListAllRequest) returns (com.digitalasset.canton.topology.admin.v30.ListAllResponse);

+ + +
+ +
+
Request
+
com.digitalasset.canton.topology.admin.v30.ListAllRequest
+
+ +
+
Response
+
com.digitalasset.canton.topology.admin.v30.ListAllResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

TopologyManagerReadService.ListAvailableStores

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc TopologyManagerReadService.ListAvailableStores(com.digitalasset.canton.topology.admin.v30.ListAvailableStoresRequest) returns (com.digitalasset.canton.topology.admin.v30.Lis...

+ + +
+ +
+
Request
+
com.digitalasset.canton.topology.admin.v30.ListAvailableStoresRequest
+
+ +
+
Response
+
com.digitalasset.canton.topology.admin.v30.ListAvailableStoresResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

TopologyManagerReadService.ListDecentralizedNamespaceDefinition

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc TopologyManagerReadService.ListDecentralizedNamespaceDefinition(com.digitalasset.canton.topology.admin.v30.ListDecentralizedNamespaceDefinitionRequest) returns (com.digitala...

+ + +
+ +
+
Request
+
com.digitalasset.canton.topology.admin.v30.ListDecentralizedNamespaceDefinitionRequest
+
+ +
+
Response
+
com.digitalasset.canton.topology.admin.v30.ListDecentralizedNamespaceDefinitionResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

TopologyManagerReadService.ListMediatorSynchronizerState

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc TopologyManagerReadService.ListMediatorSynchronizerState(com.digitalasset.canton.topology.admin.v30.ListMediatorSynchronizerStateRequest) returns (com.digitalasset.canton.to...

+ + +
+ +
+
Request
+
com.digitalasset.canton.topology.admin.v30.ListMediatorSynchronizerStateRequest
+
+ +
+
Response
+
com.digitalasset.canton.topology.admin.v30.ListMediatorSynchronizerStateResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

TopologyManagerReadService.ListNamespaceDelegation

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc TopologyManagerReadService.ListNamespaceDelegation(com.digitalasset.canton.topology.admin.v30.ListNamespaceDelegationRequest) returns (com.digitalasset.canton.topology.admin...

+ + +
+ +
+
Request
+
com.digitalasset.canton.topology.admin.v30.ListNamespaceDelegationRequest
+
+ +
+
Response
+
com.digitalasset.canton.topology.admin.v30.ListNamespaceDelegationResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

TopologyManagerReadService.ListOwnerToKeyMapping

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc TopologyManagerReadService.ListOwnerToKeyMapping(com.digitalasset.canton.topology.admin.v30.ListOwnerToKeyMappingRequest) returns (com.digitalasset.canton.topology.admin.v30...

+ + +
+ +
+
Request
+
com.digitalasset.canton.topology.admin.v30.ListOwnerToKeyMappingRequest
+
+ +
+
Response
+
com.digitalasset.canton.topology.admin.v30.ListOwnerToKeyMappingResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

TopologyManagerReadService.ListParticipantSynchronizerPermission

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc TopologyManagerReadService.ListParticipantSynchronizerPermission(com.digitalasset.canton.topology.admin.v30.ListParticipantSynchronizerPermissionRequest) returns (com.digita...

+ + +
+ +
+
Request
+
com.digitalasset.canton.topology.admin.v30.ListParticipantSynchronizerPermissionRequest
+
+ +
+
Response
+
com.digitalasset.canton.topology.admin.v30.ListParticipantSynchronizerPermissionResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

TopologyManagerReadService.ListPartyHostingLimits

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc TopologyManagerReadService.ListPartyHostingLimits(com.digitalasset.canton.topology.admin.v30.ListPartyHostingLimitsRequest) returns (com.digitalasset.canton.topology.admin.v...

+ + +
+ +
+
Request
+
com.digitalasset.canton.topology.admin.v30.ListPartyHostingLimitsRequest
+
+ +
+
Response
+
com.digitalasset.canton.topology.admin.v30.ListPartyHostingLimitsResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

TopologyManagerReadService.ListPartyToKeyMapping

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc TopologyManagerReadService.ListPartyToKeyMapping(com.digitalasset.canton.topology.admin.v30.ListPartyToKeyMappingRequest) returns (com.digitalasset.canton.topology.admin.v30...

+ + +
+ +
+
Request
+
com.digitalasset.canton.topology.admin.v30.ListPartyToKeyMappingRequest
+
+ +
+
Response
+
com.digitalasset.canton.topology.admin.v30.ListPartyToKeyMappingResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

TopologyManagerReadService.ListPartyToParticipant

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc TopologyManagerReadService.ListPartyToParticipant(com.digitalasset.canton.topology.admin.v30.ListPartyToParticipantRequest) returns (com.digitalasset.canton.topology.admin.v...

+ + +
+ +
+
Request
+
com.digitalasset.canton.topology.admin.v30.ListPartyToParticipantRequest
+
+ +
+
Response
+
com.digitalasset.canton.topology.admin.v30.ListPartyToParticipantResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

TopologyManagerReadService.ListSequencerConnectionSuccessor

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc TopologyManagerReadService.ListSequencerConnectionSuccessor(com.digitalasset.canton.topology.admin.v30.ListSequencerConnectionSuccessorRequest) returns (com.digitalasset.can...

+ + +
+ +
+
Request
+
com.digitalasset.canton.topology.admin.v30.ListSequencerConnectionSuccessorRequest
+
+ +
+
Response
+
com.digitalasset.canton.topology.admin.v30.ListSequencerConnectionSuccessorResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

TopologyManagerReadService.ListSequencerSynchronizerState

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc TopologyManagerReadService.ListSequencerSynchronizerState(com.digitalasset.canton.topology.admin.v30.ListSequencerSynchronizerStateRequest) returns (com.digitalasset.canton....

+ + +
+ +
+
Request
+
com.digitalasset.canton.topology.admin.v30.ListSequencerSynchronizerStateRequest
+
+ +
+
Response
+
com.digitalasset.canton.topology.admin.v30.ListSequencerSynchronizerStateResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

TopologyManagerReadService.ListSynchronizerParametersState

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc TopologyManagerReadService.ListSynchronizerParametersState(com.digitalasset.canton.topology.admin.v30.ListSynchronizerParametersStateRequest) returns (com.digitalasset.canto...

+ + +
+ +
+
Request
+
com.digitalasset.canton.topology.admin.v30.ListSynchronizerParametersStateRequest
+
+ +
+
Response
+
com.digitalasset.canton.topology.admin.v30.ListSynchronizerParametersStateResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

TopologyManagerReadService.ListSynchronizerTrustCertificate

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc TopologyManagerReadService.ListSynchronizerTrustCertificate(com.digitalasset.canton.topology.admin.v30.ListSynchronizerTrustCertificateRequest) returns (com.digitalasset.can...

+ + +
+ +
+
Request
+
com.digitalasset.canton.topology.admin.v30.ListSynchronizerTrustCertificateRequest
+
+ +
+
Response
+
com.digitalasset.canton.topology.admin.v30.ListSynchronizerTrustCertificateResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

TopologyManagerReadService.ListSynchronizerUpgradeAnnouncement

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc TopologyManagerReadService.ListSynchronizerUpgradeAnnouncement(com.digitalasset.canton.topology.admin.v30.ListSynchronizerUpgradeAnnouncementRequest) returns (com.digitalass...

+ + +
+ +
+
Request
+
com.digitalasset.canton.topology.admin.v30.ListSynchronizerUpgradeAnnouncementRequest
+
+ +
+
Response
+
com.digitalasset.canton.topology.admin.v30.ListSynchronizerUpgradeAnnouncementResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

TopologyManagerReadService.ListVettedPackages

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc TopologyManagerReadService.ListVettedPackages(com.digitalasset.canton.topology.admin.v30.ListVettedPackagesRequest) returns (com.digitalasset.canton.topology.admin.v30.ListV...

+ + +
+ +
+
Request
+
com.digitalasset.canton.topology.admin.v30.ListVettedPackagesRequest
+
+ +
+
Response
+
com.digitalasset.canton.topology.admin.v30.ListVettedPackagesResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

TopologyManagerReadService.LogicalUpgradeState

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

Fetch the topology state The returned bytestring can be used directly to initialize a successor sequencer

+ + +
+ +
+
Request
+
com.digitalasset.canton.topology.admin.v30.LogicalUpgradeStateRequest
+
+ +
+
Response
+
com.digitalasset.canton.topology.admin.v30.LogicalUpgradeStateResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + + +
+ + + + + +## TopologyManagerWriteService - Using OwnerType = 'Participant' allows to query for all participants. - Using OwnerType = 'Sequencer' allows to query for all sequencers defined. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.topology.admin.v30.ListKeyOwnersRequest`](#type-com-digitalasset-canton-topology-admin-v30-listkeyownersrequest) - -**Response Type** - -- [`com.digitalasset.canton.topology.admin.v30.ListKeyOwnersResponse`](#type-com-digitalasset-canton-topology-admin-v30-listkeyownersresponse) - - -**Endpoint `TopologyAggregationService.ListParties`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_aggregation_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_aggregation_service.proto#L34) - -**Signature** - -```protobuf -rpc TopologyAggregationService.ListParties(com.digitalasset.canton.topology.admin.v30.ListPartiesRequest) returns (com.digitalasset.canton.topology.admin.v30.ListPartiesResponse); -``` * - Obtain information about a certain set of active parties matching a given filter criterion. - - The request allows to filter per (synchronizer, party, asOf) where the party argument is - used in order to filter the result list using the `startsWith` method on the respective resulting string. - - As such, if you just need to do a lookup, then define a precise filter. Given the uniqueness of the - identifiers (and the fact that the identifiers contain key fingerprints), we should only ever get a single - result back if we are doing a precise lookup. - - The response is a sequence of tuples (party, synchronizer, participant, privilege, trust-level). - The response is restricted to active parties and their active participants. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.topology.admin.v30.ListPartiesRequest`](#type-com-digitalasset-canton-topology-admin-v30-listpartiesrequest) - -**Response Type** - -- [`com.digitalasset.canton.topology.admin.v30.ListPartiesResponse`](#type-com-digitalasset-canton-topology-admin-v30-listpartiesresponse) - - -### Service `TopologyManagerReadService` - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L14) -- Endpoints tracked: `21` - -_No description._ - -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`ExportTopologySnapshot`](#endpoint-com-digitalasset-canton-topology-admin-v30-topologymanagerreadservice-exporttopologysnapshot) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.topology.admin.v30.ExportTopologySnapshotRequest`](#type-com-digitalasset-canton-topology-admin-v30-exporttopologysnapshotrequest) | [`com.digitalasset.canton.topology.admin.v30.ExportTopologySnapshotResponse`](#type-com-digitalasset-canton-topology-admin-v30-exporttopologysnapshotresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L37) | -| [`ExportTopologySnapshotV2`](#endpoint-com-digitalasset-canton-topology-admin-v30-topologymanagerreadservice-exporttopologysnapshotv2) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.topology.admin.v30.ExportTopologySnapshotV2Request`](#type-com-digitalasset-canton-topology-admin-v30-exporttopologysnapshotv2request) | [`com.digitalasset.canton.topology.admin.v30.ExportTopologySnapshotV2Response`](#type-com-digitalasset-canton-topology-admin-v30-exporttopologysnapshotv2response) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L38) | -| [`GenesisState`](#endpoint-com-digitalasset-canton-topology-admin-v30-topologymanagerreadservice-genesisstate) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.topology.admin.v30.GenesisStateRequest`](#type-com-digitalasset-canton-topology-admin-v30-genesisstaterequest) | [`com.digitalasset.canton.topology.admin.v30.GenesisStateResponse`](#type-com-digitalasset-canton-topology-admin-v30-genesisstateresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L42) | -| [`GenesisStateV2`](#endpoint-com-digitalasset-canton-topology-admin-v30-topologymanagerreadservice-genesisstatev2) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.topology.admin.v30.GenesisStateV2Request`](#type-com-digitalasset-canton-topology-admin-v30-genesisstatev2request) | [`com.digitalasset.canton.topology.admin.v30.GenesisStateV2Response`](#type-com-digitalasset-canton-topology-admin-v30-genesisstatev2response) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L43) | -| [`ListAll`](#endpoint-com-digitalasset-canton-topology-admin-v30-topologymanagerreadservice-listall) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.topology.admin.v30.ListAllRequest`](#type-com-digitalasset-canton-topology-admin-v30-listallrequest) | [`com.digitalasset.canton.topology.admin.v30.ListAllResponse`](#type-com-digitalasset-canton-topology-admin-v30-listallresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L36) | -| [`ListAvailableStores`](#endpoint-com-digitalasset-canton-topology-admin-v30-topologymanagerreadservice-listavailablestores) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.topology.admin.v30.ListAvailableStoresRequest`](#type-com-digitalasset-canton-topology-admin-v30-listavailablestoresrequest) | [`com.digitalasset.canton.topology.admin.v30.ListAvailableStoresResponse`](#type-com-digitalasset-canton-topology-admin-v30-listavailablestoresresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L35) | -| [`ListDecentralizedNamespaceDefinition`](#endpoint-com-digitalasset-canton-topology-admin-v30-topologymanagerreadservice-listdecentralizednamespacedefinition) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.topology.admin.v30.ListDecentralizedNamespaceDefinitionRequest`](#type-com-digitalasset-canton-topology-admin-v30-listdecentralizednamespacedefinitionrequest) | [`com.digitalasset.canton.topology.admin.v30.ListDecentralizedNamespaceDefinitionResponse`](#type-com-digitalasset-canton-topology-admin-v30-listdecentralizednamespacedefinitionresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L16) | -| [`ListMediatorSynchronizerState`](#endpoint-com-digitalasset-canton-topology-admin-v30-topologymanagerreadservice-listmediatorsynchronizerstate) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.topology.admin.v30.ListMediatorSynchronizerStateRequest`](#type-com-digitalasset-canton-topology-admin-v30-listmediatorsynchronizerstaterequest) | [`com.digitalasset.canton.topology.admin.v30.ListMediatorSynchronizerStateResponse`](#type-com-digitalasset-canton-topology-admin-v30-listmediatorsynchronizerstateresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L29) | -| [`ListNamespaceDelegation`](#endpoint-com-digitalasset-canton-topology-admin-v30-topologymanagerreadservice-listnamespacedelegation) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.topology.admin.v30.ListNamespaceDelegationRequest`](#type-com-digitalasset-canton-topology-admin-v30-listnamespacedelegationrequest) | [`com.digitalasset.canton.topology.admin.v30.ListNamespaceDelegationResponse`](#type-com-digitalasset-canton-topology-admin-v30-listnamespacedelegationresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L15) | -| [`ListOwnerToKeyMapping`](#endpoint-com-digitalasset-canton-topology-admin-v30-topologymanagerreadservice-listownertokeymapping) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.topology.admin.v30.ListOwnerToKeyMappingRequest`](#type-com-digitalasset-canton-topology-admin-v30-listownertokeymappingrequest) | [`com.digitalasset.canton.topology.admin.v30.ListOwnerToKeyMappingResponse`](#type-com-digitalasset-canton-topology-admin-v30-listownertokeymappingresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L18) | -| [`ListParticipantSynchronizerPermission`](#endpoint-com-digitalasset-canton-topology-admin-v30-topologymanagerreadservice-listparticipantsynchronizerpermission) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.topology.admin.v30.ListParticipantSynchronizerPermissionRequest`](#type-com-digitalasset-canton-topology-admin-v30-listparticipantsynchronizerpermissionrequest) | [`com.digitalasset.canton.topology.admin.v30.ListParticipantSynchronizerPermissionResponse`](#type-com-digitalasset-canton-topology-admin-v30-listparticipantsynchronizerpermissionresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L22) | -| [`ListPartyHostingLimits`](#endpoint-com-digitalasset-canton-topology-admin-v30-topologymanagerreadservice-listpartyhostinglimits) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.topology.admin.v30.ListPartyHostingLimitsRequest`](#type-com-digitalasset-canton-topology-admin-v30-listpartyhostinglimitsrequest) | [`com.digitalasset.canton.topology.admin.v30.ListPartyHostingLimitsResponse`](#type-com-digitalasset-canton-topology-admin-v30-listpartyhostinglimitsresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L23) | -| [`ListPartyToKeyMapping`](#endpoint-com-digitalasset-canton-topology-admin-v30-topologymanagerreadservice-listpartytokeymapping) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.topology.admin.v30.ListPartyToKeyMappingRequest`](#type-com-digitalasset-canton-topology-admin-v30-listpartytokeymappingrequest) | [`com.digitalasset.canton.topology.admin.v30.ListPartyToKeyMappingResponse`](#type-com-digitalasset-canton-topology-admin-v30-listpartytokeymappingresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L19) | -| [`ListPartyToParticipant`](#endpoint-com-digitalasset-canton-topology-admin-v30-topologymanagerreadservice-listpartytoparticipant) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.topology.admin.v30.ListPartyToParticipantRequest`](#type-com-digitalasset-canton-topology-admin-v30-listpartytoparticipantrequest) | [`com.digitalasset.canton.topology.admin.v30.ListPartyToParticipantResponse`](#type-com-digitalasset-canton-topology-admin-v30-listpartytoparticipantresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L26) | -| [`ListSequencerConnectionSuccessor`](#endpoint-com-digitalasset-canton-topology-admin-v30-topologymanagerreadservice-listsequencerconnectionsuccessor) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.topology.admin.v30.ListSequencerConnectionSuccessorRequest`](#type-com-digitalasset-canton-topology-admin-v30-listsequencerconnectionsuccessorrequest) | [`com.digitalasset.canton.topology.admin.v30.ListSequencerConnectionSuccessorResponse`](#type-com-digitalasset-canton-topology-admin-v30-listsequencerconnectionsuccessorresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L33) | -| [`ListSequencerSynchronizerState`](#endpoint-com-digitalasset-canton-topology-admin-v30-topologymanagerreadservice-listsequencersynchronizerstate) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.topology.admin.v30.ListSequencerSynchronizerStateRequest`](#type-com-digitalasset-canton-topology-admin-v30-listsequencersynchronizerstaterequest) | [`com.digitalasset.canton.topology.admin.v30.ListSequencerSynchronizerStateResponse`](#type-com-digitalasset-canton-topology-admin-v30-listsequencersynchronizerstateresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L30) | -| [`ListSynchronizerParametersState`](#endpoint-com-digitalasset-canton-topology-admin-v30-topologymanagerreadservice-listsynchronizerparametersstate) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.topology.admin.v30.ListSynchronizerParametersStateRequest`](#type-com-digitalasset-canton-topology-admin-v30-listsynchronizerparametersstaterequest) | [`com.digitalasset.canton.topology.admin.v30.ListSynchronizerParametersStateResponse`](#type-com-digitalasset-canton-topology-admin-v30-listsynchronizerparametersstateresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L28) | -| [`ListSynchronizerTrustCertificate`](#endpoint-com-digitalasset-canton-topology-admin-v30-topologymanagerreadservice-listsynchronizertrustcertificate) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.topology.admin.v30.ListSynchronizerTrustCertificateRequest`](#type-com-digitalasset-canton-topology-admin-v30-listsynchronizertrustcertificaterequest) | [`com.digitalasset.canton.topology.admin.v30.ListSynchronizerTrustCertificateResponse`](#type-com-digitalasset-canton-topology-admin-v30-listsynchronizertrustcertificateresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L21) | -| [`ListSynchronizerUpgradeAnnouncement`](#endpoint-com-digitalasset-canton-topology-admin-v30-topologymanagerreadservice-listsynchronizerupgradeannouncement) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.topology.admin.v30.ListSynchronizerUpgradeAnnouncementRequest`](#type-com-digitalasset-canton-topology-admin-v30-listsynchronizerupgradeannouncementrequest) | [`com.digitalasset.canton.topology.admin.v30.ListSynchronizerUpgradeAnnouncementResponse`](#type-com-digitalasset-canton-topology-admin-v30-listsynchronizerupgradeannouncementresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L32) | -| [`ListVettedPackages`](#endpoint-com-digitalasset-canton-topology-admin-v30-topologymanagerreadservice-listvettedpackages) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.topology.admin.v30.ListVettedPackagesRequest`](#type-com-digitalasset-canton-topology-admin-v30-listvettedpackagesrequest) | [`com.digitalasset.canton.topology.admin.v30.ListVettedPackagesResponse`](#type-com-digitalasset-canton-topology-admin-v30-listvettedpackagesresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L24) | -| [`LogicalUpgradeState`](#endpoint-com-digitalasset-canton-topology-admin-v30-topologymanagerreadservice-logicalupgradestate) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.topology.admin.v30.LogicalUpgradeStateRequest`](#type-com-digitalasset-canton-topology-admin-v30-logicalupgradestaterequest) | [`com.digitalasset.canton.topology.admin.v30.LogicalUpgradeStateResponse`](#type-com-digitalasset-canton-topology-admin-v30-logicalupgradestateresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L47) | - - -**Endpoint `TopologyManagerReadService.ExportTopologySnapshot`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L37) - -**Signature** - -```protobuf -rpc TopologyManagerReadService.ExportTopologySnapshot(com.digitalasset.canton.topology.admin.v30.ExportTopologySnapshotRequest) returns (stream com.digitalasset.canton.topology.admin.v30.ExportTopologySnapshotResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.topology.admin.v30.ExportTopologySnapshotRequest`](#type-com-digitalasset-canton-topology-admin-v30-exporttopologysnapshotrequest) - -**Response Type** - -- [`com.digitalasset.canton.topology.admin.v30.ExportTopologySnapshotResponse`](#type-com-digitalasset-canton-topology-admin-v30-exporttopologysnapshotresponse) - - -**Endpoint `TopologyManagerReadService.ExportTopologySnapshotV2`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L38) - -**Signature** - -```protobuf -rpc TopologyManagerReadService.ExportTopologySnapshotV2(com.digitalasset.canton.topology.admin.v30.ExportTopologySnapshotV2Request) returns (stream com.digitalasset.canton.topology.admin.v30.ExportTopologySnapshotV2Response); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.topology.admin.v30.ExportTopologySnapshotV2Request`](#type-com-digitalasset-canton-topology-admin-v30-exporttopologysnapshotv2request) - -**Response Type** - -- [`com.digitalasset.canton.topology.admin.v30.ExportTopologySnapshotV2Response`](#type-com-digitalasset-canton-topology-admin-v30-exporttopologysnapshotv2response) - - -**Endpoint `TopologyManagerReadService.GenesisState`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L42) - -**Signature** - -```protobuf -rpc TopologyManagerReadService.GenesisState(com.digitalasset.canton.topology.admin.v30.GenesisStateRequest) returns (stream com.digitalasset.canton.topology.admin.v30.GenesisStateResponse); -``` - -Fetch the genesis topology state. - The returned bytestring can be used directly to initialize a sequencer. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.topology.admin.v30.GenesisStateRequest`](#type-com-digitalasset-canton-topology-admin-v30-genesisstaterequest) - -**Response Type** - -- [`com.digitalasset.canton.topology.admin.v30.GenesisStateResponse`](#type-com-digitalasset-canton-topology-admin-v30-genesisstateresponse) - - -**Endpoint `TopologyManagerReadService.GenesisStateV2`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L43) - -**Signature** - -```protobuf -rpc TopologyManagerReadService.GenesisStateV2(com.digitalasset.canton.topology.admin.v30.GenesisStateV2Request) returns (stream com.digitalasset.canton.topology.admin.v30.GenesisStateV2Response); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.topology.admin.v30.GenesisStateV2Request`](#type-com-digitalasset-canton-topology-admin-v30-genesisstatev2request) - -**Response Type** - -- [`com.digitalasset.canton.topology.admin.v30.GenesisStateV2Response`](#type-com-digitalasset-canton-topology-admin-v30-genesisstatev2response) - - -**Endpoint `TopologyManagerReadService.ListAll`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L36) - -**Signature** - -```protobuf -rpc TopologyManagerReadService.ListAll(com.digitalasset.canton.topology.admin.v30.ListAllRequest) returns (com.digitalasset.canton.topology.admin.v30.ListAllResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.topology.admin.v30.ListAllRequest`](#type-com-digitalasset-canton-topology-admin-v30-listallrequest) - -**Response Type** - -- [`com.digitalasset.canton.topology.admin.v30.ListAllResponse`](#type-com-digitalasset-canton-topology-admin-v30-listallresponse) - - -**Endpoint `TopologyManagerReadService.ListAvailableStores`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L35) - -**Signature** - -```protobuf -rpc TopologyManagerReadService.ListAvailableStores(com.digitalasset.canton.topology.admin.v30.ListAvailableStoresRequest) returns (com.digitalasset.canton.topology.admin.v30.ListAvailableStoresResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.topology.admin.v30.ListAvailableStoresRequest`](#type-com-digitalasset-canton-topology-admin-v30-listavailablestoresrequest) - -**Response Type** - -- [`com.digitalasset.canton.topology.admin.v30.ListAvailableStoresResponse`](#type-com-digitalasset-canton-topology-admin-v30-listavailablestoresresponse) - - -**Endpoint `TopologyManagerReadService.ListDecentralizedNamespaceDefinition`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L16) - -**Signature** - -```protobuf -rpc TopologyManagerReadService.ListDecentralizedNamespaceDefinition(com.digitalasset.canton.topology.admin.v30.ListDecentralizedNamespaceDefinitionRequest) returns (com.digitalasset.canton.topology.admin.v30.ListDecentralizedNamespaceDefinitionResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.topology.admin.v30.ListDecentralizedNamespaceDefinitionRequest`](#type-com-digitalasset-canton-topology-admin-v30-listdecentralizednamespacedefinitionrequest) - -**Response Type** - -- [`com.digitalasset.canton.topology.admin.v30.ListDecentralizedNamespaceDefinitionResponse`](#type-com-digitalasset-canton-topology-admin-v30-listdecentralizednamespacedefinitionresponse) - - -**Endpoint `TopologyManagerReadService.ListMediatorSynchronizerState`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L29) - -**Signature** - -```protobuf -rpc TopologyManagerReadService.ListMediatorSynchronizerState(com.digitalasset.canton.topology.admin.v30.ListMediatorSynchronizerStateRequest) returns (com.digitalasset.canton.topology.admin.v30.ListMediatorSynchronizerStateResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.topology.admin.v30.ListMediatorSynchronizerStateRequest`](#type-com-digitalasset-canton-topology-admin-v30-listmediatorsynchronizerstaterequest) - -**Response Type** - -- [`com.digitalasset.canton.topology.admin.v30.ListMediatorSynchronizerStateResponse`](#type-com-digitalasset-canton-topology-admin-v30-listmediatorsynchronizerstateresponse) - - -**Endpoint `TopologyManagerReadService.ListNamespaceDelegation`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L15) - -**Signature** - -```protobuf -rpc TopologyManagerReadService.ListNamespaceDelegation(com.digitalasset.canton.topology.admin.v30.ListNamespaceDelegationRequest) returns (com.digitalasset.canton.topology.admin.v30.ListNamespaceDelegationResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.topology.admin.v30.ListNamespaceDelegationRequest`](#type-com-digitalasset-canton-topology-admin-v30-listnamespacedelegationrequest) - -**Response Type** - -- [`com.digitalasset.canton.topology.admin.v30.ListNamespaceDelegationResponse`](#type-com-digitalasset-canton-topology-admin-v30-listnamespacedelegationresponse) - - -**Endpoint `TopologyManagerReadService.ListOwnerToKeyMapping`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L18) - -**Signature** - -```protobuf -rpc TopologyManagerReadService.ListOwnerToKeyMapping(com.digitalasset.canton.topology.admin.v30.ListOwnerToKeyMappingRequest) returns (com.digitalasset.canton.topology.admin.v30.ListOwnerToKeyMappingResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.topology.admin.v30.ListOwnerToKeyMappingRequest`](#type-com-digitalasset-canton-topology-admin-v30-listownertokeymappingrequest) - -**Response Type** - -- [`com.digitalasset.canton.topology.admin.v30.ListOwnerToKeyMappingResponse`](#type-com-digitalasset-canton-topology-admin-v30-listownertokeymappingresponse) - - -**Endpoint `TopologyManagerReadService.ListParticipantSynchronizerPermission`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L22) - -**Signature** - -```protobuf -rpc TopologyManagerReadService.ListParticipantSynchronizerPermission(com.digitalasset.canton.topology.admin.v30.ListParticipantSynchronizerPermissionRequest) returns (com.digitalasset.canton.topology.admin.v30.ListParticipantSynchronizerPermissionResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.topology.admin.v30.ListParticipantSynchronizerPermissionRequest`](#type-com-digitalasset-canton-topology-admin-v30-listparticipantsynchronizerpermissionrequest) - -**Response Type** - -- [`com.digitalasset.canton.topology.admin.v30.ListParticipantSynchronizerPermissionResponse`](#type-com-digitalasset-canton-topology-admin-v30-listparticipantsynchronizerpermissionresponse) - - -**Endpoint `TopologyManagerReadService.ListPartyHostingLimits`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L23) - -**Signature** - -```protobuf -rpc TopologyManagerReadService.ListPartyHostingLimits(com.digitalasset.canton.topology.admin.v30.ListPartyHostingLimitsRequest) returns (com.digitalasset.canton.topology.admin.v30.ListPartyHostingLimitsResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.topology.admin.v30.ListPartyHostingLimitsRequest`](#type-com-digitalasset-canton-topology-admin-v30-listpartyhostinglimitsrequest) - -**Response Type** - -- [`com.digitalasset.canton.topology.admin.v30.ListPartyHostingLimitsResponse`](#type-com-digitalasset-canton-topology-admin-v30-listpartyhostinglimitsresponse) - - -**Endpoint `TopologyManagerReadService.ListPartyToKeyMapping`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L19) - -**Signature** - -```protobuf -rpc TopologyManagerReadService.ListPartyToKeyMapping(com.digitalasset.canton.topology.admin.v30.ListPartyToKeyMappingRequest) returns (com.digitalasset.canton.topology.admin.v30.ListPartyToKeyMappingResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.topology.admin.v30.ListPartyToKeyMappingRequest`](#type-com-digitalasset-canton-topology-admin-v30-listpartytokeymappingrequest) - -**Response Type** - -- [`com.digitalasset.canton.topology.admin.v30.ListPartyToKeyMappingResponse`](#type-com-digitalasset-canton-topology-admin-v30-listpartytokeymappingresponse) - - -**Endpoint `TopologyManagerReadService.ListPartyToParticipant`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L26) - -**Signature** - -```protobuf -rpc TopologyManagerReadService.ListPartyToParticipant(com.digitalasset.canton.topology.admin.v30.ListPartyToParticipantRequest) returns (com.digitalasset.canton.topology.admin.v30.ListPartyToParticipantResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.topology.admin.v30.ListPartyToParticipantRequest`](#type-com-digitalasset-canton-topology-admin-v30-listpartytoparticipantrequest) - -**Response Type** - -- [`com.digitalasset.canton.topology.admin.v30.ListPartyToParticipantResponse`](#type-com-digitalasset-canton-topology-admin-v30-listpartytoparticipantresponse) - - -**Endpoint `TopologyManagerReadService.ListSequencerConnectionSuccessor`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L33) - -**Signature** - -```protobuf -rpc TopologyManagerReadService.ListSequencerConnectionSuccessor(com.digitalasset.canton.topology.admin.v30.ListSequencerConnectionSuccessorRequest) returns (com.digitalasset.canton.topology.admin.v30.ListSequencerConnectionSuccessorResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.topology.admin.v30.ListSequencerConnectionSuccessorRequest`](#type-com-digitalasset-canton-topology-admin-v30-listsequencerconnectionsuccessorrequest) - -**Response Type** - -- [`com.digitalasset.canton.topology.admin.v30.ListSequencerConnectionSuccessorResponse`](#type-com-digitalasset-canton-topology-admin-v30-listsequencerconnectionsuccessorresponse) - - -**Endpoint `TopologyManagerReadService.ListSequencerSynchronizerState`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L30) - -**Signature** - -```protobuf -rpc TopologyManagerReadService.ListSequencerSynchronizerState(com.digitalasset.canton.topology.admin.v30.ListSequencerSynchronizerStateRequest) returns (com.digitalasset.canton.topology.admin.v30.ListSequencerSynchronizerStateResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.topology.admin.v30.ListSequencerSynchronizerStateRequest`](#type-com-digitalasset-canton-topology-admin-v30-listsequencersynchronizerstaterequest) - -**Response Type** - -- [`com.digitalasset.canton.topology.admin.v30.ListSequencerSynchronizerStateResponse`](#type-com-digitalasset-canton-topology-admin-v30-listsequencersynchronizerstateresponse) - - -**Endpoint `TopologyManagerReadService.ListSynchronizerParametersState`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L28) - -**Signature** - -```protobuf -rpc TopologyManagerReadService.ListSynchronizerParametersState(com.digitalasset.canton.topology.admin.v30.ListSynchronizerParametersStateRequest) returns (com.digitalasset.canton.topology.admin.v30.ListSynchronizerParametersStateResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.topology.admin.v30.ListSynchronizerParametersStateRequest`](#type-com-digitalasset-canton-topology-admin-v30-listsynchronizerparametersstaterequest) - -**Response Type** - -- [`com.digitalasset.canton.topology.admin.v30.ListSynchronizerParametersStateResponse`](#type-com-digitalasset-canton-topology-admin-v30-listsynchronizerparametersstateresponse) - - -**Endpoint `TopologyManagerReadService.ListSynchronizerTrustCertificate`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L21) - -**Signature** - -```protobuf -rpc TopologyManagerReadService.ListSynchronizerTrustCertificate(com.digitalasset.canton.topology.admin.v30.ListSynchronizerTrustCertificateRequest) returns (com.digitalasset.canton.topology.admin.v30.ListSynchronizerTrustCertificateResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.topology.admin.v30.ListSynchronizerTrustCertificateRequest`](#type-com-digitalasset-canton-topology-admin-v30-listsynchronizertrustcertificaterequest) - -**Response Type** - -- [`com.digitalasset.canton.topology.admin.v30.ListSynchronizerTrustCertificateResponse`](#type-com-digitalasset-canton-topology-admin-v30-listsynchronizertrustcertificateresponse) - - -**Endpoint `TopologyManagerReadService.ListSynchronizerUpgradeAnnouncement`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L32) - -**Signature** - -```protobuf -rpc TopologyManagerReadService.ListSynchronizerUpgradeAnnouncement(com.digitalasset.canton.topology.admin.v30.ListSynchronizerUpgradeAnnouncementRequest) returns (com.digitalasset.canton.topology.admin.v30.ListSynchronizerUpgradeAnnouncementResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.topology.admin.v30.ListSynchronizerUpgradeAnnouncementRequest`](#type-com-digitalasset-canton-topology-admin-v30-listsynchronizerupgradeannouncementrequest) - -**Response Type** - -- [`com.digitalasset.canton.topology.admin.v30.ListSynchronizerUpgradeAnnouncementResponse`](#type-com-digitalasset-canton-topology-admin-v30-listsynchronizerupgradeannouncementresponse) - - -**Endpoint `TopologyManagerReadService.ListVettedPackages`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L24) - -**Signature** - -```protobuf -rpc TopologyManagerReadService.ListVettedPackages(com.digitalasset.canton.topology.admin.v30.ListVettedPackagesRequest) returns (com.digitalasset.canton.topology.admin.v30.ListVettedPackagesResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.topology.admin.v30.ListVettedPackagesRequest`](#type-com-digitalasset-canton-topology-admin-v30-listvettedpackagesrequest) - -**Response Type** - -- [`com.digitalasset.canton.topology.admin.v30.ListVettedPackagesResponse`](#type-com-digitalasset-canton-topology-admin-v30-listvettedpackagesresponse) - - -**Endpoint `TopologyManagerReadService.LogicalUpgradeState`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L47) - -**Signature** - -```protobuf -rpc TopologyManagerReadService.LogicalUpgradeState(com.digitalasset.canton.topology.admin.v30.LogicalUpgradeStateRequest) returns (stream com.digitalasset.canton.topology.admin.v30.LogicalUpgradeStateResponse); -``` - -Fetch the topology state - The returned bytestring can be used directly to initialize a successor sequencer - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.topology.admin.v30.LogicalUpgradeStateRequest`](#type-com-digitalasset-canton-topology-admin-v30-logicalupgradestaterequest) - -**Response Type** - -- [`com.digitalasset.canton.topology.admin.v30.LogicalUpgradeStateResponse`](#type-com-digitalasset-canton-topology-admin-v30-logicalupgradestateresponse) - - -### Service `TopologyManagerWriteService` - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto#L17) -- Endpoints tracked: `8` - -* - Write operations on the local topology manager. + Write operations on the local topology manager. Participants, mediators, and sequencers run a local topology manager exposing the same write interface. -| Endpoint | Introduced | Last Changed | Removed | Request | Response | Source | -| --- | --- | --- | --- | --- | --- | --- | -| [`AddTransactions`](#endpoint-com-digitalasset-canton-topology-admin-v30-topologymanagerwriteservice-addtransactions) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.topology.admin.v30.AddTransactionsRequest`](#type-com-digitalasset-canton-topology-admin-v30-addtransactionsrequest) | [`com.digitalasset.canton.topology.admin.v30.AddTransactionsResponse`](#type-com-digitalasset-canton-topology-admin-v30-addtransactionsresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto#L20) | -| [`Authorize`](#endpoint-com-digitalasset-canton-topology-admin-v30-topologymanagerwriteservice-authorize) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.topology.admin.v30.AuthorizeRequest`](#type-com-digitalasset-canton-topology-admin-v30-authorizerequest) | [`com.digitalasset.canton.topology.admin.v30.AuthorizeResponse`](#type-com-digitalasset-canton-topology-admin-v30-authorizeresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto#L18) | -| [`CreateTemporaryTopologyStore`](#endpoint-com-digitalasset-canton-topology-admin-v30-topologymanagerwriteservice-createtemporarytopologystore) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.topology.admin.v30.CreateTemporaryTopologyStoreRequest`](#type-com-digitalasset-canton-topology-admin-v30-createtemporarytopologystorerequest) | [`com.digitalasset.canton.topology.admin.v30.CreateTemporaryTopologyStoreResponse`](#type-com-digitalasset-canton-topology-admin-v30-createtemporarytopologystoreresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto#L33) | -| [`DropTemporaryTopologyStore`](#endpoint-com-digitalasset-canton-topology-admin-v30-topologymanagerwriteservice-droptemporarytopologystore) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.topology.admin.v30.DropTemporaryTopologyStoreRequest`](#type-com-digitalasset-canton-topology-admin-v30-droptemporarytopologystorerequest) | [`com.digitalasset.canton.topology.admin.v30.DropTemporaryTopologyStoreResponse`](#type-com-digitalasset-canton-topology-admin-v30-droptemporarytopologystoreresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto#L38) | -| [`GenerateTransactions`](#endpoint-com-digitalasset-canton-topology-admin-v30-topologymanagerwriteservice-generatetransactions) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.topology.admin.v30.GenerateTransactionsRequest`](#type-com-digitalasset-canton-topology-admin-v30-generatetransactionsrequest) | [`com.digitalasset.canton.topology.admin.v30.GenerateTransactionsResponse`](#type-com-digitalasset-canton-topology-admin-v30-generatetransactionsresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto#L28) | -| [`ImportTopologySnapshot`](#endpoint-com-digitalasset-canton-topology-admin-v30-topologymanagerwriteservice-importtopologysnapshot) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.topology.admin.v30.ImportTopologySnapshotRequest`](#type-com-digitalasset-canton-topology-admin-v30-importtopologysnapshotrequest) | [`com.digitalasset.canton.topology.admin.v30.ImportTopologySnapshotResponse`](#type-com-digitalasset-canton-topology-admin-v30-importtopologysnapshotresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto#L22) | -| [`ImportTopologySnapshotV2`](#endpoint-com-digitalasset-canton-topology-admin-v30-topologymanagerwriteservice-importtopologysnapshotv2) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.topology.admin.v30.ImportTopologySnapshotV2Request`](#type-com-digitalasset-canton-topology-admin-v30-importtopologysnapshotv2request) | [`com.digitalasset.canton.topology.admin.v30.ImportTopologySnapshotV2Response`](#type-com-digitalasset-canton-topology-admin-v30-importtopologysnapshotv2response) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto#L23) | -| [`SignTransactions`](#endpoint-com-digitalasset-canton-topology-admin-v30-topologymanagerwriteservice-signtransactions) | `3.4.0` | `3.4.0` | `` | [`com.digitalasset.canton.topology.admin.v30.SignTransactionsRequest`](#type-com-digitalasset-canton-topology-admin-v30-signtransactionsrequest) | [`com.digitalasset.canton.topology.admin.v30.SignTransactionsResponse`](#type-com-digitalasset-canton-topology-admin-v30-signtransactionsresponse) | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto#L25) | - - -**Endpoint `TopologyManagerWriteService.AddTransactions`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto#L20) - -**Signature** - -```protobuf -rpc TopologyManagerWriteService.AddTransactions(com.digitalasset.canton.topology.admin.v30.AddTransactionsRequest) returns (com.digitalasset.canton.topology.admin.v30.AddTransactionsResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.topology.admin.v30.AddTransactionsRequest`](#type-com-digitalasset-canton-topology-admin-v30-addtransactionsrequest) - -**Response Type** - -- [`com.digitalasset.canton.topology.admin.v30.AddTransactionsResponse`](#type-com-digitalasset-canton-topology-admin-v30-addtransactionsresponse) - - -**Endpoint `TopologyManagerWriteService.Authorize`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto#L18) - -**Signature** - -```protobuf -rpc TopologyManagerWriteService.Authorize(com.digitalasset.canton.topology.admin.v30.AuthorizeRequest) returns (com.digitalasset.canton.topology.admin.v30.AuthorizeResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.topology.admin.v30.AuthorizeRequest`](#type-com-digitalasset-canton-topology-admin-v30-authorizerequest) - -**Response Type** - -- [`com.digitalasset.canton.topology.admin.v30.AuthorizeResponse`](#type-com-digitalasset-canton-topology-admin-v30-authorizeresponse) - - -**Endpoint `TopologyManagerWriteService.CreateTemporaryTopologyStore`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto#L33) - -**Signature** - -```protobuf -rpc TopologyManagerWriteService.CreateTemporaryTopologyStore(com.digitalasset.canton.topology.admin.v30.CreateTemporaryTopologyStoreRequest) returns (com.digitalasset.canton.topology.admin.v30.CreateTemporaryTopologyStoreResponse); -``` - -* Creates a temporary topology store. - Trying to create a store with the same name results in an error. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.topology.admin.v30.CreateTemporaryTopologyStoreRequest`](#type-com-digitalasset-canton-topology-admin-v30-createtemporarytopologystorerequest) - -**Response Type** - -- [`com.digitalasset.canton.topology.admin.v30.CreateTemporaryTopologyStoreResponse`](#type-com-digitalasset-canton-topology-admin-v30-createtemporarytopologystoreresponse) - - -**Endpoint `TopologyManagerWriteService.DropTemporaryTopologyStore`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto#L38) - -**Signature** - -```protobuf -rpc TopologyManagerWriteService.DropTemporaryTopologyStore(com.digitalasset.canton.topology.admin.v30.DropTemporaryTopologyStoreRequest) returns (com.digitalasset.canton.topology.admin.v30.DropTemporaryTopologyStoreResponse); -``` - -* Drops a temporary topology store. - Trying to drop a temporary store that does not exist results in an error. - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.topology.admin.v30.DropTemporaryTopologyStoreRequest`](#type-com-digitalasset-canton-topology-admin-v30-droptemporarytopologystorerequest) - -**Response Type** - -- [`com.digitalasset.canton.topology.admin.v30.DropTemporaryTopologyStoreResponse`](#type-com-digitalasset-canton-topology-admin-v30-droptemporarytopologystoreresponse) - - -**Endpoint `TopologyManagerWriteService.GenerateTransactions`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto#L28) - -**Signature** - -```protobuf -rpc TopologyManagerWriteService.GenerateTransactions(com.digitalasset.canton.topology.admin.v30.GenerateTransactionsRequest) returns (com.digitalasset.canton.topology.admin.v30.GenerateTransactionsResponse); -``` - -* RPC to generate topology transactions that can be signed - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.topology.admin.v30.GenerateTransactionsRequest`](#type-com-digitalasset-canton-topology-admin-v30-generatetransactionsrequest) - -**Response Type** - -- [`com.digitalasset.canton.topology.admin.v30.GenerateTransactionsResponse`](#type-com-digitalasset-canton-topology-admin-v30-generatetransactionsresponse) - - -**Endpoint `TopologyManagerWriteService.ImportTopologySnapshot`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto#L22) - -**Signature** - -```protobuf -rpc TopologyManagerWriteService.ImportTopologySnapshot(stream com.digitalasset.canton.topology.admin.v30.ImportTopologySnapshotRequest) returns (com.digitalasset.canton.topology.admin.v30.ImportTopologySnapshotResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.topology.admin.v30.ImportTopologySnapshotRequest`](#type-com-digitalasset-canton-topology-admin-v30-importtopologysnapshotrequest) - -**Response Type** - -- [`com.digitalasset.canton.topology.admin.v30.ImportTopologySnapshotResponse`](#type-com-digitalasset-canton-topology-admin-v30-importtopologysnapshotresponse) - - -**Endpoint `TopologyManagerWriteService.ImportTopologySnapshotV2`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto#L23) - -**Signature** - -```protobuf -rpc TopologyManagerWriteService.ImportTopologySnapshotV2(stream com.digitalasset.canton.topology.admin.v30.ImportTopologySnapshotV2Request) returns (com.digitalasset.canton.topology.admin.v30.ImportTopologySnapshotV2Response); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.topology.admin.v30.ImportTopologySnapshotV2Request`](#type-com-digitalasset-canton-topology-admin-v30-importtopologysnapshotv2request) - -**Response Type** - -- [`com.digitalasset.canton.topology.admin.v30.ImportTopologySnapshotV2Response`](#type-com-digitalasset-canton-topology-admin-v30-importtopologysnapshotv2response) - - -**Endpoint `TopologyManagerWriteService.SignTransactions`** - -- Introduced in: `3.4.0` -- Last changed in: `3.4.0` -- Removed in: `-` -- Status: `current` -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto#L25) - -**Signature** - -```protobuf -rpc TopologyManagerWriteService.SignTransactions(com.digitalasset.canton.topology.admin.v30.SignTransactionsRequest) returns (com.digitalasset.canton.topology.admin.v30.SignTransactionsResponse); -``` - -_No description._ - -**History** - -| Version | Kind | Details | -| --- | --- | --- | -| `3.4.0` | `introduced` | | - -**Request Type** - -- [`com.digitalasset.canton.topology.admin.v30.SignTransactionsRequest`](#type-com-digitalasset-canton-topology-admin-v30-signtransactionsrequest) - -**Response Type** - -- [`com.digitalasset.canton.topology.admin.v30.SignTransactionsResponse`](#type-com-digitalasset-canton-topology-admin-v30-signtransactionsresponse) - -## Type Reference - - -**Message `com.digitalasset.canton.topology.admin.v30.AddTransactionsRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto#L139) -- Fields: 4 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| transactions | [`com.digitalasset.canton.protocol.v30.SignedTopologyTransaction`](com-digitalasset-canton-protocol-v30#type-com-digitalasset-canton-protocol-v30-signedtopologytransaction) | repeated | *
The transactions that should be added to the target store as indicated by the parameter `store`. | -| force_changes | [`com.digitalasset.canton.topology.admin.v30.ForceFlag`](#type-com-digitalasset-canton-topology-admin-v30-forceflag) | repeated | * Force specific changes even if dangerous | -| store | [`com.digitalasset.canton.topology.admin.v30.StoreId`](#type-com-digitalasset-canton-topology-admin-v30-storeid) | optional | *
The store that is used as the underlying source for executing this request.
If `store` is a synchronizers store, the resulting topology transaction will only be available on the respective synchronizers.
If `store` is the authorized store, the resulting topology transaction may or may not be synchronized automatically
to all synchronizers that the node is currently connected to or will be connected to in the future.

Selecting a specific synchronizers store might be necessary, if the transaction to authorize by hash or the previous
generation of the submitted proposal is only available on the synchronizers store and not in the authorized store. | -| wait_to_become_effective | `google.protobuf.Duration` | optional | * Optional timeout to wait for the transaction to become effective in the store. | - - -**Message `com.digitalasset.canton.topology.admin.v30.AddTransactionsResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto#L162) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.topology.admin.v30.AuthorizeRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto#L74) -- Fields: 7 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| proposal | [`com.digitalasset.canton.topology.admin.v30.AuthorizeRequest.Proposal`](#type-com-digitalasset-canton-topology-admin-v30-authorizerequest-proposal) | optional | *
Propose a transaction and distribute it.
If authorize if the node has enough signing keys | -| transaction_hash | `string` | optional | *
Authorize a transaction, meaning the node needs to be able to fully sign it locally.
Hash is in hexadecimal format. | -| must_fully_authorize | `bool` | optional | *
If true: the transaction is only signed if the new signatures will result in the transaction being fully
authorized. Otherwise returns as an error.
If false: the transaction is signed and the signature distributed. The transaction may still not be fully
authorized and remain as a proposal. | -| force_changes | [`com.digitalasset.canton.topology.admin.v30.ForceFlag`](#type-com-digitalasset-canton-topology-admin-v30-forceflag) | repeated | * Force specific changes even if dangerous | -| signed_by | `string` | repeated | *
Fingerprint of the keys signing the authorization

The signing key is used to identify a particular `NamespaceDelegation` certificate,
which is used to justify the given authorization.
Optional, if empty, suitable signing keys available known to the node are automatically selected. | -| store | [`com.digitalasset.canton.topology.admin.v30.StoreId`](#type-com-digitalasset-canton-topology-admin-v30-storeid) | optional | *
The store that is used as the underlying source for executing this request.
If `store` is a synchronizer store, the resulting topology transaction will only be available on the respective synchronizer.
If `store` is the authorized store, the resulting topology transaction may or may not be synchronized automatically
to all synchronizers that the node is currently connected to or will be connected to in the future.

Selecting a specific synchronizers store might be necessary, if the transaction to authorize by hash or the previous
generation of the submitted proposal is only available on the synchronizers store and not in the authorized store. | -| wait_to_become_effective | `google.protobuf.Duration` | optional | * Optional timeout to wait for the transaction to become effective in the store. | - - -**Message `com.digitalasset.canton.topology.admin.v30.AuthorizeRequest.Proposal`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto#L75) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| change | [`com.digitalasset.canton.protocol.v30.Enums.TopologyChangeOp`](com-digitalasset-canton-protocol-v30#type-com-digitalasset-canton-protocol-v30-enums-topologychangeop) | optional | * Replace / Remove | -| serial | `uint32` | optional | * Optionally, the serial number of this request (auto-determined if omitted) | -| mapping | [`com.digitalasset.canton.protocol.v30.TopologyMapping`](com-digitalasset-canton-protocol-v30#type-com-digitalasset-canton-protocol-v30-topologymapping) | optional | * The mapping to be authorized | - - -**Message `com.digitalasset.canton.topology.admin.v30.AuthorizeResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto#L134) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| transaction | [`com.digitalasset.canton.protocol.v30.SignedTopologyTransaction`](com-digitalasset-canton-protocol-v30#type-com-digitalasset-canton-protocol-v30-signedtopologytransaction) | optional | * the generated signed topology transaction | - - -**Message `com.digitalasset.canton.topology.admin.v30.BaseQuery`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L50) -- Fields: 8 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| store | [`com.digitalasset.canton.topology.admin.v30.StoreId`](#type-com-digitalasset-canton-topology-admin-v30-storeid) | optional | | -| proposals | `bool` | optional | whether to query only for proposals instead of approved topology mappings | -| operation | [`com.digitalasset.canton.protocol.v30.Enums.TopologyChangeOp`](com-digitalasset-canton-protocol-v30#type-com-digitalasset-canton-protocol-v30-enums-topologychangeop) | optional | | -| snapshot | `google.protobuf.Timestamp` | optional | | -| head_state | `google.protobuf.Empty` | optional | | -| range | [`com.digitalasset.canton.topology.admin.v30.BaseQuery.TimeRange`](#type-com-digitalasset-canton-topology-admin-v30-basequery-timerange) | optional | | -| filter_signed_key | `string` | optional | | -| protocol_version | `int32` | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.BaseQuery.TimeRange`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L60) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| from | `google.protobuf.Timestamp` | optional | | -| until | `google.protobuf.Timestamp` | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.BaseResult`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L74) -- Fields: 8 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| store | [`com.digitalasset.canton.topology.admin.v30.StoreId`](#type-com-digitalasset-canton-topology-admin-v30-storeid) | optional | | -| sequenced | `google.protobuf.Timestamp` | optional | | -| valid_from | `google.protobuf.Timestamp` | optional | | -| valid_until | `google.protobuf.Timestamp` | optional | | -| operation | [`com.digitalasset.canton.protocol.v30.Enums.TopologyChangeOp`](com-digitalasset-canton-protocol-v30#type-com-digitalasset-canton-protocol-v30-enums-topologychangeop) | optional | | -| transaction_hash | `bytes` | optional | | -| serial | `int32` | optional | | -| signed_by_fingerprints | `string` | repeated | | - - -**Message `com.digitalasset.canton.topology.admin.v30.CreateTemporaryTopologyStoreRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto#L210) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| name | `string` | optional | * The name of the topology store | -| protocol_version | `uint32` | optional | * The protocol version that should be used by the store | - - -**Message `com.digitalasset.canton.topology.admin.v30.CreateTemporaryTopologyStoreResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto#L217) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| store_id | [`com.digitalasset.canton.topology.admin.v30.StoreId.Temporary`](#type-com-digitalasset-canton-topology-admin-v30-storeid-temporary) | optional | * The identifier of the topology store that should be used as a store filter string | - - -**Message `com.digitalasset.canton.topology.admin.v30.CurrentTimeRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/initialization_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/initialization_service.proto#L63) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.topology.admin.v30.CurrentTimeResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/initialization_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/initialization_service.proto#L65) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| current_time | `int64` | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.DropTemporaryTopologyStoreRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto#L222) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| store_id | [`com.digitalasset.canton.topology.admin.v30.StoreId.Temporary`](#type-com-digitalasset-canton-topology-admin-v30-storeid-temporary) | optional | * The identifier of the topology store that should be dropped | - - -**Message `com.digitalasset.canton.topology.admin.v30.DropTemporaryTopologyStoreResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto#L227) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.topology.admin.v30.ExportTopologySnapshotRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L286) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| base_query | [`com.digitalasset.canton.topology.admin.v30.BaseQuery`](#type-com-digitalasset-canton-topology-admin-v30-basequery) | optional | | -| exclude_mappings | `string` | repeated | | -| filter_namespace | `string` | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ExportTopologySnapshotResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L292) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| chunk | `bytes` | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ExportTopologySnapshotV2Request`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L296) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| base_query | [`com.digitalasset.canton.topology.admin.v30.BaseQuery`](#type-com-digitalasset-canton-topology-admin-v30-basequery) | optional | | -| exclude_mappings | `string` | repeated | | -| filter_namespace | `string` | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ExportTopologySnapshotV2Response`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L302) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| chunk | `bytes` | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.GenerateTransactionsRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto#L41) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| proposals | [`com.digitalasset.canton.topology.admin.v30.GenerateTransactionsRequest.Proposal`](#type-com-digitalasset-canton-topology-admin-v30-generatetransactionsrequest-proposal) | repeated | transaction proposals for which to generate topology transactions | - - -**Message `com.digitalasset.canton.topology.admin.v30.GenerateTransactionsRequest.Proposal`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto#L42) -- Fields: 4 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| operation | [`com.digitalasset.canton.protocol.v30.Enums.TopologyChangeOp`](com-digitalasset-canton-protocol-v30#type-com-digitalasset-canton-protocol-v30-enums-topologychangeop) | optional | * Replace / Remove | -| serial | `uint32` | optional | * Optionally, the serial number of this request (auto-determined if omitted)
NOTE: omitting the serial MAY end up overwriting previous mappings processed concurrently.
To avoid such cases, First read the state using the TopologyManagerReadService and update the mappings
accordingly, incrementing the serial by one and setting it here explicitly. | -| mapping | [`com.digitalasset.canton.protocol.v30.TopologyMapping`](com-digitalasset-canton-protocol-v30#type-com-digitalasset-canton-protocol-v30-topologymapping) | optional | * The mapping to be authorized | -| store | [`com.digitalasset.canton.topology.admin.v30.StoreId`](#type-com-digitalasset-canton-topology-admin-v30-storeid) | optional | Target store | - - -**Message `com.digitalasset.canton.topology.admin.v30.GenerateTransactionsResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto#L63) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| generated_transactions | [`com.digitalasset.canton.topology.admin.v30.GenerateTransactionsResponse.GeneratedTransaction`](#type-com-digitalasset-canton-topology-admin-v30-generatetransactionsresponse-generatedtransaction) | repeated | Generated transactions, in the same order as the mappings provided in the request | - - -**Message `com.digitalasset.canton.topology.admin.v30.GenerateTransactionsResponse.GeneratedTransaction`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto#L64) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| serialized_transaction | `bytes` | optional | Serialized com.digitalasset.canton.protocol.v30.TopologyTransaction | -| transaction_hash | `bytes` | optional | Hash of the transaction - this should be signed by the submitter to authorize the transaction | - - -**Message `com.digitalasset.canton.topology.admin.v30.GenesisStateRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L306) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| synchronizer_store | [`com.digitalasset.canton.topology.admin.v30.StoreId`](#type-com-digitalasset-canton-topology-admin-v30-storeid) | optional | Must be specified if the genesis state is requested from a participant node. | -| timestamp | `google.protobuf.Timestamp` | optional | Optional - the effective time used to fetch the topology transactions. If not provided the effective time of the last topology transaction is used. | - - -**Message `com.digitalasset.canton.topology.admin.v30.GenesisStateResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L313) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| chunk | `bytes` | optional | versioned stored topology transactions | - - -**Message `com.digitalasset.canton.topology.admin.v30.GenesisStateV2Request`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L318) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| synchronizer_store | [`com.digitalasset.canton.topology.admin.v30.StoreId`](#type-com-digitalasset-canton-topology-admin-v30-storeid) | optional | Must be specified if the genesis state is requested from a participant node. | -| timestamp | `google.protobuf.Timestamp` | optional | Optional - the effective time used to fetch the topology transactions. If not provided the effective time of the last topology transaction is used. | - - -**Message `com.digitalasset.canton.topology.admin.v30.GenesisStateV2Response`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L325) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| chunk | `bytes` | optional | versioned stored topology transactions | - - -**Message `com.digitalasset.canton.topology.admin.v30.GetIdRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/initialization_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/initialization_service.proto#L61) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.topology.admin.v30.GetIdResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/initialization_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/initialization_service.proto#L50) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| initialized | `bool` | optional | | -| unique_identifier | `string` | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.GetOnboardingTransactionsRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/initialization_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/initialization_service.proto#L55) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.topology.admin.v30.GetOnboardingTransactionsResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/initialization_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/initialization_service.proto#L57) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| transactions | [`com.digitalasset.canton.topology.admin.v30.TopologyTransactions`](#type-com-digitalasset-canton-topology-admin-v30-topologytransactions) | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ImportTopologySnapshotRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto#L167) -- Fields: 3 - -* - Same message as AddTransactionsRequest, except that transactions are encoded in a byte string - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| topology_snapshot | `bytes` | optional | | -| store | [`com.digitalasset.canton.topology.admin.v30.StoreId`](#type-com-digitalasset-canton-topology-admin-v30-storeid) | optional | | -| wait_to_become_effective | `google.protobuf.Duration` | optional | * Optional timeout to wait for the transaction to become effective in the store. | - - -**Message `com.digitalasset.canton.topology.admin.v30.ImportTopologySnapshotResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto#L173) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.topology.admin.v30.ImportTopologySnapshotV2Request`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto#L178) -- Fields: 3 - -* - Same message as AddTransactionsRequest, except that transactions are encoded in a byte string - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| topology_snapshot | `bytes` | optional | | -| store | [`com.digitalasset.canton.topology.admin.v30.StoreId`](#type-com-digitalasset-canton-topology-admin-v30-storeid) | optional | | -| wait_to_become_effective | `google.protobuf.Duration` | optional | * Optional timeout to wait for the transaction to become effective in the store. | - - -**Message `com.digitalasset.canton.topology.admin.v30.ImportTopologySnapshotV2Response`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto#L184) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.topology.admin.v30.InitIdRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/initialization_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/initialization_service.proto#L37) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| identifier | `string` | optional | The identifier of this node | -| namespace | `string` | optional | The namespace of this node
If empty, then we use the namespace of the first certificate. If both are set, then we assert
that the namespace matches the namespace of the first certificate. | -| namespace_delegations | [`com.digitalasset.canton.protocol.v30.SignedTopologyTransaction`](com-digitalasset-canton-protocol-v30#type-com-digitalasset-canton-protocol-v30-signedtopologytransaction) | repeated | Optional set of namespace_delegations for this node (in case we are using external root keys) | - - -**Message `com.digitalasset.canton.topology.admin.v30.InitIdResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/initialization_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/initialization_service.proto#L48) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.topology.admin.v30.ListAllRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L275) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| base_query | [`com.digitalasset.canton.topology.admin.v30.BaseQuery`](#type-com-digitalasset-canton-topology-admin-v30-basequery) | optional | | -| exclude_mappings | `string` | repeated | * The list of topology mappings to exclude from the result. | -| filter_namespace | `string` | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListAllResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L282) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| result | [`com.digitalasset.canton.topology.admin.v30.TopologyTransactions`](#type-com-digitalasset-canton-topology-admin-v30-topologytransactions) | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListAvailableStoresRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L269) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.topology.admin.v30.ListAvailableStoresResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L271) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| store_ids | [`com.digitalasset.canton.topology.admin.v30.StoreId`](#type-com-digitalasset-canton-topology-admin-v30-storeid) | repeated | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListDecentralizedNamespaceDefinitionRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L99) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| base_query | [`com.digitalasset.canton.topology.admin.v30.BaseQuery`](#type-com-digitalasset-canton-topology-admin-v30-basequery) | optional | | -| filter_namespace | `string` | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListDecentralizedNamespaceDefinitionResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L104) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| results | [`com.digitalasset.canton.topology.admin.v30.ListDecentralizedNamespaceDefinitionResponse.Result`](#type-com-digitalasset-canton-topology-admin-v30-listdecentralizednamespacedefinitionresponse-result) | repeated | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListDecentralizedNamespaceDefinitionResponse.Result`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L105) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| context | [`com.digitalasset.canton.topology.admin.v30.BaseResult`](#type-com-digitalasset-canton-topology-admin-v30-baseresult) | optional | | -| item | [`com.digitalasset.canton.protocol.v30.DecentralizedNamespaceDefinition`](com-digitalasset-canton-protocol-v30#type-com-digitalasset-canton-protocol-v30-decentralizednamespacedefinition) | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListKeyOwnersRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_aggregation_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_aggregation_service.proto#L90) -- Fields: 5 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| as_of | `google.protobuf.Timestamp` | optional | | -| limit | `int32` | optional | | -| synchronizer_ids | `string` | repeated | | -| filter_key_owner_type | `string` | optional | | -| filter_key_owner_uid | `string` | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListKeyOwnersResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_aggregation_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_aggregation_service.proto#L98) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| results | [`com.digitalasset.canton.topology.admin.v30.ListKeyOwnersResponse.Result`](#type-com-digitalasset-canton-topology-admin-v30-listkeyownersresponse-result) | repeated | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListKeyOwnersResponse.Result`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_aggregation_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_aggregation_service.proto#L99) -- Fields: 5 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| synchronizer_id | `string` | optional | | -| key_owner | `string` | optional | | -| signing_keys | [`com.digitalasset.canton.crypto.v30.SigningPublicKey`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-signingpublickey) | repeated | | -| encryption_keys | [`com.digitalasset.canton.crypto.v30.EncryptionPublicKey`](com-digitalasset-canton-crypto-v30#type-com-digitalasset-canton-crypto-v30-encryptionpublickey) | repeated | | -| physical_synchronizer_id | `string` | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListMediatorSynchronizerStateRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L217) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| base_query | [`com.digitalasset.canton.topology.admin.v30.BaseQuery`](#type-com-digitalasset-canton-topology-admin-v30-basequery) | optional | | -| filter_synchronizer_id | `string` | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListMediatorSynchronizerStateResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L222) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| results | [`com.digitalasset.canton.topology.admin.v30.ListMediatorSynchronizerStateResponse.Result`](#type-com-digitalasset-canton-topology-admin-v30-listmediatorsynchronizerstateresponse-result) | repeated | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListMediatorSynchronizerStateResponse.Result`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L223) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| context | [`com.digitalasset.canton.topology.admin.v30.BaseResult`](#type-com-digitalasset-canton-topology-admin-v30-baseresult) | optional | | -| item | [`com.digitalasset.canton.protocol.v30.MediatorSynchronizerState`](com-digitalasset-canton-protocol-v30#type-com-digitalasset-canton-protocol-v30-mediatorsynchronizerstate) | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListNamespaceDelegationRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L85) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| base_query | [`com.digitalasset.canton.topology.admin.v30.BaseQuery`](#type-com-digitalasset-canton-topology-admin-v30-basequery) | optional | | -| filter_namespace | `string` | optional | | -| filter_target_key_fingerprint | `string` | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListNamespaceDelegationResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L91) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| results | [`com.digitalasset.canton.topology.admin.v30.ListNamespaceDelegationResponse.Result`](#type-com-digitalasset-canton-topology-admin-v30-listnamespacedelegationresponse-result) | repeated | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListNamespaceDelegationResponse.Result`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L92) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| context | [`com.digitalasset.canton.topology.admin.v30.BaseResult`](#type-com-digitalasset-canton-topology-admin-v30-baseresult) | optional | | -| item | [`com.digitalasset.canton.protocol.v30.NamespaceDelegation`](com-digitalasset-canton-protocol-v30#type-com-digitalasset-canton-protocol-v30-namespacedelegation) | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListOwnerToKeyMappingRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L112) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| base_query | [`com.digitalasset.canton.topology.admin.v30.BaseQuery`](#type-com-digitalasset-canton-topology-admin-v30-basequery) | optional | | -| filter_key_owner_type | `string` | optional | | -| filter_key_owner_uid | `string` | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListOwnerToKeyMappingResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L118) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| results | [`com.digitalasset.canton.topology.admin.v30.ListOwnerToKeyMappingResponse.Result`](#type-com-digitalasset-canton-topology-admin-v30-listownertokeymappingresponse-result) | repeated | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListOwnerToKeyMappingResponse.Result`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L119) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| context | [`com.digitalasset.canton.topology.admin.v30.BaseResult`](#type-com-digitalasset-canton-topology-admin-v30-baseresult) | optional | | -| item | [`com.digitalasset.canton.protocol.v30.OwnerToKeyMapping`](com-digitalasset-canton-protocol-v30#type-com-digitalasset-canton-protocol-v30-ownertokeymapping) | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListParticipantSynchronizerPermissionRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L152) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| base_query | [`com.digitalasset.canton.topology.admin.v30.BaseQuery`](#type-com-digitalasset-canton-topology-admin-v30-basequery) | optional | | -| filter_uid | `string` | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListParticipantSynchronizerPermissionResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L157) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| results | [`com.digitalasset.canton.topology.admin.v30.ListParticipantSynchronizerPermissionResponse.Result`](#type-com-digitalasset-canton-topology-admin-v30-listparticipantsynchronizerpermissionresponse-result) | repeated | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListParticipantSynchronizerPermissionResponse.Result`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L158) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| context | [`com.digitalasset.canton.topology.admin.v30.BaseResult`](#type-com-digitalasset-canton-topology-admin-v30-baseresult) | optional | | -| item | [`com.digitalasset.canton.protocol.v30.ParticipantSynchronizerPermission`](com-digitalasset-canton-protocol-v30#type-com-digitalasset-canton-protocol-v30-participantsynchronizerpermission) | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListPartiesRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_aggregation_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_aggregation_service.proto#L55) -- Fields: 5 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| as_of | `google.protobuf.Timestamp` | optional | | -| limit | `int32` | optional | | -| synchronizer_ids | `string` | repeated | | -| filter_party | `string` | optional | | -| filter_participant | `string` | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListPartiesResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_aggregation_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_aggregation_service.proto#L63) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| results | [`com.digitalasset.canton.topology.admin.v30.ListPartiesResponse.Result`](#type-com-digitalasset-canton-topology-admin-v30-listpartiesresponse-result) | repeated | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListPartiesResponse.Result`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_aggregation_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_aggregation_service.proto#L64) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| party | `string` | optional | | -| participants | [`com.digitalasset.canton.topology.admin.v30.ListPartiesResponse.Result.ParticipantSynchronizers`](#type-com-digitalasset-canton-topology-admin-v30-listpartiesresponse-result-participantsynchronizers) | repeated | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListPartiesResponse.Result.ParticipantSynchronizers`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_aggregation_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_aggregation_service.proto#L67) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| participant_uid | `string` | optional | | -| synchronizers | [`com.digitalasset.canton.topology.admin.v30.ListPartiesResponse.Result.ParticipantSynchronizers.SynchronizerPermissions`](#type-com-digitalasset-canton-topology-admin-v30-listpartiesresponse-result-participantsynchronizers-synchronizerpermissions) | repeated | *
permissions of this participant for this party on a per synchronizer basis

for records that only exist in the authorized store, this list will be empty. | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListPartiesResponse.Result.ParticipantSynchronizers.SynchronizerPermissions`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_aggregation_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_aggregation_service.proto#L68) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| synchronizer_id | `string` | optional | | -| permission | [`com.digitalasset.canton.protocol.v30.Enums.ParticipantPermission`](com-digitalasset-canton-protocol-v30#type-com-digitalasset-canton-protocol-v30-enums-participantpermission) | optional | | -| physical_synchronizer_id | `string` | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListPartyHostingLimitsRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L165) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| base_query | [`com.digitalasset.canton.topology.admin.v30.BaseQuery`](#type-com-digitalasset-canton-topology-admin-v30-basequery) | optional | | -| filter_uid | `string` | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListPartyHostingLimitsResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L170) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| results | [`com.digitalasset.canton.topology.admin.v30.ListPartyHostingLimitsResponse.Result`](#type-com-digitalasset-canton-topology-admin-v30-listpartyhostinglimitsresponse-result) | repeated | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListPartyHostingLimitsResponse.Result`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L171) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| context | [`com.digitalasset.canton.topology.admin.v30.BaseResult`](#type-com-digitalasset-canton-topology-admin-v30-baseresult) | optional | | -| item | [`com.digitalasset.canton.protocol.v30.PartyHostingLimits`](com-digitalasset-canton-protocol-v30#type-com-digitalasset-canton-protocol-v30-partyhostinglimits) | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListPartyToKeyMappingRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L126) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| base_query | [`com.digitalasset.canton.topology.admin.v30.BaseQuery`](#type-com-digitalasset-canton-topology-admin-v30-basequery) | optional | | -| filter_party | `string` | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListPartyToKeyMappingResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L131) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| results | [`com.digitalasset.canton.topology.admin.v30.ListPartyToKeyMappingResponse.Result`](#type-com-digitalasset-canton-topology-admin-v30-listpartytokeymappingresponse-result) | repeated | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListPartyToKeyMappingResponse.Result`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L132) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| context | [`com.digitalasset.canton.topology.admin.v30.BaseResult`](#type-com-digitalasset-canton-topology-admin-v30-baseresult) | optional | | -| item | [`com.digitalasset.canton.protocol.v30.PartyToKeyMapping`](com-digitalasset-canton-protocol-v30#type-com-digitalasset-canton-protocol-v30-partytokeymapping) | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListPartyToParticipantRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L190) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| base_query | [`com.digitalasset.canton.topology.admin.v30.BaseQuery`](#type-com-digitalasset-canton-topology-admin-v30-basequery) | optional | | -| filter_party | `string` | optional | | -| filter_participant | `string` | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListPartyToParticipantResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L196) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| results | [`com.digitalasset.canton.topology.admin.v30.ListPartyToParticipantResponse.Result`](#type-com-digitalasset-canton-topology-admin-v30-listpartytoparticipantresponse-result) | repeated | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListPartyToParticipantResponse.Result`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L197) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| context | [`com.digitalasset.canton.topology.admin.v30.BaseResult`](#type-com-digitalasset-canton-topology-admin-v30-baseresult) | optional | | -| item | [`com.digitalasset.canton.protocol.v30.PartyToParticipant`](com-digitalasset-canton-protocol-v30#type-com-digitalasset-canton-protocol-v30-partytoparticipant) | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListSequencerConnectionSuccessorRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L256) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| base_query | [`com.digitalasset.canton.topology.admin.v30.BaseQuery`](#type-com-digitalasset-canton-topology-admin-v30-basequery) | optional | | -| filter_sequencer_id | `string` | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListSequencerConnectionSuccessorResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L261) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| results | [`com.digitalasset.canton.topology.admin.v30.ListSequencerConnectionSuccessorResponse.Result`](#type-com-digitalasset-canton-topology-admin-v30-listsequencerconnectionsuccessorresponse-result) | repeated | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListSequencerConnectionSuccessorResponse.Result`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L262) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| context | [`com.digitalasset.canton.topology.admin.v30.BaseResult`](#type-com-digitalasset-canton-topology-admin-v30-baseresult) | optional | | -| item | [`com.digitalasset.canton.protocol.v30.SequencerConnectionSuccessor`](com-digitalasset-canton-protocol-v30#type-com-digitalasset-canton-protocol-v30-sequencerconnectionsuccessor) | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListSequencerSynchronizerStateRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L230) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| base_query | [`com.digitalasset.canton.topology.admin.v30.BaseQuery`](#type-com-digitalasset-canton-topology-admin-v30-basequery) | optional | | -| filter_synchronizer_id | `string` | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListSequencerSynchronizerStateResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L235) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| results | [`com.digitalasset.canton.topology.admin.v30.ListSequencerSynchronizerStateResponse.Result`](#type-com-digitalasset-canton-topology-admin-v30-listsequencersynchronizerstateresponse-result) | repeated | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListSequencerSynchronizerStateResponse.Result`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L236) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| context | [`com.digitalasset.canton.topology.admin.v30.BaseResult`](#type-com-digitalasset-canton-topology-admin-v30-baseresult) | optional | | -| item | [`com.digitalasset.canton.protocol.v30.SequencerSynchronizerState`](com-digitalasset-canton-protocol-v30#type-com-digitalasset-canton-protocol-v30-sequencersynchronizerstate) | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListSynchronizerParametersStateRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L204) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| base_query | [`com.digitalasset.canton.topology.admin.v30.BaseQuery`](#type-com-digitalasset-canton-topology-admin-v30-basequery) | optional | | -| filter_synchronizer_id | `string` | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListSynchronizerParametersStateResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L209) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| results | [`com.digitalasset.canton.topology.admin.v30.ListSynchronizerParametersStateResponse.Result`](#type-com-digitalasset-canton-topology-admin-v30-listsynchronizerparametersstateresponse-result) | repeated | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListSynchronizerParametersStateResponse.Result`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L210) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| context | [`com.digitalasset.canton.topology.admin.v30.BaseResult`](#type-com-digitalasset-canton-topology-admin-v30-baseresult) | optional | | -| item | [`com.digitalasset.canton.protocol.v30.DynamicSynchronizerParameters`](com-digitalasset-canton-protocol-v30#type-com-digitalasset-canton-protocol-v30-dynamicsynchronizerparameters) | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListSynchronizerTrustCertificateRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L139) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| base_query | [`com.digitalasset.canton.topology.admin.v30.BaseQuery`](#type-com-digitalasset-canton-topology-admin-v30-basequery) | optional | | -| filter_uid | `string` | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListSynchronizerTrustCertificateResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L144) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| results | [`com.digitalasset.canton.topology.admin.v30.ListSynchronizerTrustCertificateResponse.Result`](#type-com-digitalasset-canton-topology-admin-v30-listsynchronizertrustcertificateresponse-result) | repeated | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListSynchronizerTrustCertificateResponse.Result`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L145) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| context | [`com.digitalasset.canton.topology.admin.v30.BaseResult`](#type-com-digitalasset-canton-topology-admin-v30-baseresult) | optional | | -| item | [`com.digitalasset.canton.protocol.v30.SynchronizerTrustCertificate`](com-digitalasset-canton-protocol-v30#type-com-digitalasset-canton-protocol-v30-synchronizertrustcertificate) | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListSynchronizerUpgradeAnnouncementRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L243) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| base_query | [`com.digitalasset.canton.topology.admin.v30.BaseQuery`](#type-com-digitalasset-canton-topology-admin-v30-basequery) | optional | | -| filter_synchronizer_id | `string` | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListSynchronizerUpgradeAnnouncementResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L248) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| results | [`com.digitalasset.canton.topology.admin.v30.ListSynchronizerUpgradeAnnouncementResponse.Result`](#type-com-digitalasset-canton-topology-admin-v30-listsynchronizerupgradeannouncementresponse-result) | repeated | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListSynchronizerUpgradeAnnouncementResponse.Result`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L249) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| context | [`com.digitalasset.canton.topology.admin.v30.BaseResult`](#type-com-digitalasset-canton-topology-admin-v30-baseresult) | optional | | -| item | [`com.digitalasset.canton.protocol.v30.SynchronizerUpgradeAnnouncement`](com-digitalasset-canton-protocol-v30#type-com-digitalasset-canton-protocol-v30-synchronizerupgradeannouncement) | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListVettedPackagesRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L178) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| base_query | [`com.digitalasset.canton.topology.admin.v30.BaseQuery`](#type-com-digitalasset-canton-topology-admin-v30-basequery) | optional | | -| filter_participant | `string` | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListVettedPackagesResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L183) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| results | [`com.digitalasset.canton.topology.admin.v30.ListVettedPackagesResponse.Result`](#type-com-digitalasset-canton-topology-admin-v30-listvettedpackagesresponse-result) | repeated | | - - -**Message `com.digitalasset.canton.topology.admin.v30.ListVettedPackagesResponse.Result`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L184) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| context | [`com.digitalasset.canton.topology.admin.v30.BaseResult`](#type-com-digitalasset-canton-topology-admin-v30-baseresult) | optional | | -| item | [`com.digitalasset.canton.protocol.v30.VettedPackages`](com-digitalasset-canton-protocol-v30#type-com-digitalasset-canton-protocol-v30-vettedpackages) | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.LogicalUpgradeStateRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L330) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.topology.admin.v30.LogicalUpgradeStateResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_read_service.proto#L332) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| chunk | `bytes` | optional | versioned stored topology transactions | - - -**Message `com.digitalasset.canton.topology.admin.v30.SignTransactionsRequest`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto#L186) -- Fields: 4 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| transactions | [`com.digitalasset.canton.protocol.v30.SignedTopologyTransaction`](com-digitalasset-canton-protocol-v30#type-com-digitalasset-canton-protocol-v30-signedtopologytransaction) | repeated | * The transactions to be signed, but will not be stored in the authorized store | -| signed_by | `string` | repeated | *
Fingerprint of the keys signing the authorization

The signing key is used to identify a particular `NamespaceDelegation` certificate,
which is used to justify the given authorization.
Optional, if empty, suitable signing keys available known to the node are automatically selected. | -| store | [`com.digitalasset.canton.topology.admin.v30.StoreId`](#type-com-digitalasset-canton-topology-admin-v30-storeid) | optional | Target store | -| force_flags | [`com.digitalasset.canton.topology.admin.v30.ForceFlag`](#type-com-digitalasset-canton-topology-admin-v30-forceflag) | repeated | * Force specific changes even if dangerous | - - -**Message `com.digitalasset.canton.topology.admin.v30.SignTransactionsResponse`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto#L205) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| transactions | [`com.digitalasset.canton.protocol.v30.SignedTopologyTransaction`](com-digitalasset-canton-protocol-v30#type-com-digitalasset-canton-protocol-v30-signedtopologytransaction) | repeated | * The transactions with the additional signatures from this node. | - - -**Message `com.digitalasset.canton.topology.admin.v30.StoreId`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/common.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/common.proto#L41) -- Fields: 3 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| authorized | [`com.digitalasset.canton.topology.admin.v30.StoreId.Authorized`](#type-com-digitalasset-canton-topology-admin-v30-storeid-authorized) | optional | | -| synchronizer | [`com.digitalasset.canton.topology.admin.v30.Synchronizer`](#type-com-digitalasset-canton-topology-admin-v30-synchronizer) | optional | | -| temporary | [`com.digitalasset.canton.topology.admin.v30.StoreId.Temporary`](#type-com-digitalasset-canton-topology-admin-v30-storeid-temporary) | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.StoreId.Authorized`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/common.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/common.proto#L42) -- Fields: 0 - -_No description._ - - -**Message `com.digitalasset.canton.topology.admin.v30.StoreId.Temporary`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/common.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/common.proto#L44) -- Fields: 1 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| name | `string` | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.Synchronizer`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/common.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/common.proto#L34) -- Fields: 2 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| id | `string` | optional | | -| physical_id | `string` | optional | | - - -**Message `com.digitalasset.canton.topology.admin.v30.TopologyTransactions`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/common.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/common.proto#L16) -- Fields: 1 - -* Topology transaction collection used during bootstrapping of synchronizer nodes and on the admin API - - Please note that this message should not be in the protocol package, as it is not used on the protocol - itself but on the admin apis. But as we can't rename the package name due to backwards compatibility - guarantees, we've moved the file out of the protocol.proto file, but kept the package name. - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| items | [`com.digitalasset.canton.topology.admin.v30.TopologyTransactions.Item`](#type-com-digitalasset-canton-topology-admin-v30-topologytransactions-item) | repeated | | - - -**Message `com.digitalasset.canton.topology.admin.v30.TopologyTransactions.Item`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/common.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/common.proto#L17) -- Fields: 5 - -_No description._ - -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| sequenced | `google.protobuf.Timestamp` | optional | | -| valid_from | `google.protobuf.Timestamp` | optional | | -| valid_until | `google.protobuf.Timestamp` | optional | | -| transaction | `bytes` | optional | * Versioned signed topology transactions serialized as byte-strings. Note that we use here the serialized
version that contains the version number. Using the "Versioned" version directly here would create a circular
dependency between the proto files. The only proper solution would be to move this into a third separate file
with "cross version data files", which we might do at some point. | -| rejection_reason | `string` | optional | | - - -**Enum `com.digitalasset.canton.topology.admin.v30.ForceFlag`** - -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto#L229) - -_No description._ -| Name | Number | -| --- | --- | -| FORCE_FLAG_UNSPECIFIED | `0` | -| FORCE_FLAG_ALIEN_MEMBER | `1` | -| FORCE_FLAG_LEDGER_TIME_RECORD_TIME_TOLERANCE_INCREASE | `2` | -| FORCE_FLAG_ALLOW_UNKNOWN_PACKAGE | `4` | -| FORCE_FLAG_ALLOW_UNVETTED_DEPENDENCIES | `5` | -| FORCE_FLAG_DISABLE_PARTY_WITH_ACTIVE_CONTRACTS | `6` | -| FORCE_FLAG_ALLOW_UNVALIDATED_SIGNING_KEYS | `7` | -| FORCE_FLAG_PREPARATION_TIME_RECORD_TIME_TOLERANCE_INCREASE | `9` | -| FORCE_FLAG_ALLOW_INSUFFICIENT_PARTICIPANT_PERMISSION_FOR_SIGNATORY_PARTY | `10` | -| FORCE_FLAG_ALLOW_INSUFFICIENT_SIGNATORY_ASSIGNING_PARTICIPANTS_FOR_PARTY | `11` | -| FORCE_FLAG_ALLOW_VET_INCOMPATIBLE_UPGRADES | `12` | -| FORCE_FLAG_ALLOW_OUT_OF_BOUNDS_VALUE | `13` | -| FORCE_FLAG_ALLOW_CONFIRMING_THRESHOLD_CANNOT_BE_MET | `14` | +
+ +
+
Source file
+
community/base/src/main/protobuf/com/digitalasset/canton/topology/admin/v30/topology_manager_write_service.proto
+
+ +
+
Operations
+
8
+
+ +
+ + +
+ + + + +
+

TopologyManagerWriteService.AddTransactions

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc TopologyManagerWriteService.AddTransactions(com.digitalasset.canton.topology.admin.v30.AddTransactionsRequest) returns (com.digitalasset.canton.topology.admin.v30.AddTransac...

+ + +
+ +
+
Request
+
com.digitalasset.canton.topology.admin.v30.AddTransactionsRequest
+
+ +
+
Response
+
com.digitalasset.canton.topology.admin.v30.AddTransactionsResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

TopologyManagerWriteService.Authorize

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc TopologyManagerWriteService.Authorize(com.digitalasset.canton.topology.admin.v30.AuthorizeRequest) returns (com.digitalasset.canton.topology.admin.v30.AuthorizeResponse);

+ + +
+ +
+
Request
+
com.digitalasset.canton.topology.admin.v30.AuthorizeRequest
+
+ +
+
Response
+
com.digitalasset.canton.topology.admin.v30.AuthorizeResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

TopologyManagerWriteService.CreateTemporaryTopologyStore

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

* Creates a temporary topology store. Trying to create a store with the same name results in an error.

+ + +
+ +
+
Request
+
com.digitalasset.canton.topology.admin.v30.CreateTemporaryTopologyStoreRequest
+
+ +
+
Response
+
com.digitalasset.canton.topology.admin.v30.CreateTemporaryTopologyStoreResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

TopologyManagerWriteService.DropTemporaryTopologyStore

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

* Drops a temporary topology store. Trying to drop a temporary store that does not exist results in an error.

+ + +
+ +
+
Request
+
com.digitalasset.canton.topology.admin.v30.DropTemporaryTopologyStoreRequest
+
+ +
+
Response
+
com.digitalasset.canton.topology.admin.v30.DropTemporaryTopologyStoreResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

TopologyManagerWriteService.GenerateTransactions

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

* RPC to generate topology transactions that can be signed

+ + +
+ +
+
Request
+
com.digitalasset.canton.topology.admin.v30.GenerateTransactionsRequest
+
+ +
+
Response
+
com.digitalasset.canton.topology.admin.v30.GenerateTransactionsResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

TopologyManagerWriteService.ImportTopologySnapshot

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc TopologyManagerWriteService.ImportTopologySnapshot(stream com.digitalasset.canton.topology.admin.v30.ImportTopologySnapshotRequest) returns (com.digitalasset.canton.topology...

+ + +
+ +
+
Request
+
com.digitalasset.canton.topology.admin.v30.ImportTopologySnapshotRequest
+
+ +
+
Response
+
com.digitalasset.canton.topology.admin.v30.ImportTopologySnapshotResponse
+
+ +
+
Client stream
+
Yes
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

TopologyManagerWriteService.ImportTopologySnapshotV2

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc TopologyManagerWriteService.ImportTopologySnapshotV2(stream com.digitalasset.canton.topology.admin.v30.ImportTopologySnapshotV2Request) returns (com.digitalasset.canton.topo...

+ + +
+ +
+
Request
+
com.digitalasset.canton.topology.admin.v30.ImportTopologySnapshotV2Request
+
+ +
+
Response
+
com.digitalasset.canton.topology.admin.v30.ImportTopologySnapshotV2Response
+
+ +
+
Client stream
+
Yes
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + + + + +
+

TopologyManagerWriteService.SignTransactions

+ +
+ + gRPC + + Since 3.4.0 + +
+ +
+ +

rpc TopologyManagerWriteService.SignTransactions(com.digitalasset.canton.topology.admin.v30.SignTransactionsRequest) returns (com.digitalasset.canton.topology.admin.v30.SignTran...

+ + +
+ +
+
Request
+
com.digitalasset.canton.topology.admin.v30.SignTransactionsRequest
+
+ +
+
Response
+
com.digitalasset.canton.topology.admin.v30.SignTransactionsResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
No
+
+ +
+ + + + + +
+ + + + + +## Type Inventory + + +These are the package-level message and enum shapes in the publish-version snapshot. + + + + +
+
+

com.digitalasset.canton.topology.admin.v30.AddTransactionsRequest

+ +

4 fields

+ +
+ + +
+ +
+
+ transactions + repeated SignedTopologyTransaction + +
+ +
* The transactions that should be added to the target store as indicated by the parameter `store`.
+ +
+ +
+
+ force_changes + repeated ForceFlag + +
+ +
* Force specific changes even if dangerous
+ +
+ +
+
+ store + StoreId + +
+ +
* The store that is used as the underlying source for executing this request. If `store` is a synchronizers store, the resulting topology transaction will only be available on the respective synchronizers. If `store` is the authorized store, the resulting topology transaction may or may not be synchronized automatically to all synchronizers that the node is currently connected to or will be connected to in the future. Selecting a specific synchronizers store might be necessary, if the transaction to authorize by hash or the previous generation of the submitted proposal is only available on the synchronizers store and not in the authorized store.
+ +
+ +
+
+ wait_to_become_effective + Duration + +
+ +
* Optional timeout to wait for the transaction to become effective in the store.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.SignedTopologyTransaction

+ +

4 fields

+ +
+ + +
+ +
+
+ transaction + bytes + +
+ +
serialized topology transaction (protobuf bytestring)
+ +
+ +
+
+ signatures + repeated Signature + +
+ +
multiple signatures Either this field OR the multi_transaction_signatures field MUST contain at least one signature
+ +
+ +
+
+ proposal + bool + +
+ +
if true, this transaction is just a proposal. this means that every signature is valid, but the signatures are insufficient to properly authorize the transaction. proposals are distributed via the topology channel too. proposals will be pruned automatically when the nodes are pruned TODO(#14045) implement pruning
+ +
+ +
+
+ multi_transaction_signatures + repeated MultiTransactionSignatures + +
+ +
If set, the transaction may be authorized by signing a hash computed from multiple transaction hashes This allows to effectively authorize multiple transactions with a single signature. Each item MUST contain the hash of this transaction Optional
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.Signature

+ +

5 fields

+ +
+ + +
+ +
+
+ format + SignatureFormat + +
+ +
+ +
+
+ signature + bytes + +
+ +
+ +
+
+ signed_by + string + +
+ +
The fingerprint/id of the keypair used to create this signature and needed to verify. If a signature delegation is defined, this fingerprint/id is not used to produce the signature, and, instead is used to sign the delegation.
+ +
+ +
+
+ signing_algorithm_spec + SigningAlgorithmSpec + +
+ +
The signing algorithm specification used to produce this signature
+ +
+ +
+
+ signature_delegation + SignatureDelegation + +
+ +
An optional signature delegation where a long-term signing key authorizes a session signing key to sign on its behalf.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SignatureFormat

+ +

5 values

+ +
+ + + +
    + +
  • SIGNATURE_FORMAT_UNSPECIFIED
    • + +
  • SIGNATURE_FORMAT_RAW
    • + +
  • SIGNATURE_FORMAT_DER
    • + +
  • SIGNATURE_FORMAT_CONCAT
    • + +
  • SIGNATURE_FORMAT_SYMBOLIC
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SigningAlgorithmSpec

+ +

4 values

+ +
+ + + +
    + +
  • SIGNING_ALGORITHM_SPEC_UNSPECIFIED
    • + +
  • SIGNING_ALGORITHM_SPEC_ED25519
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_256
    • + +
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_384
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SignatureDelegation

+ +

7 fields

+ +
+ + +
+ +
+
+ session_key + bytes + +
+ +
ASN.1 + DER-encoding of X.509 SubjectPublicKeyInfo structure of the session public key: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1. This key was used to produce the actual signature.
+ +
+ +
+
+ session_key_spec + SigningKeySpec + +
+ +
The signing key spec for the session key.
+ +
+ +
+
+ validity_period_from_inclusive + int64 + +
+ +
A timestamp in microseconds of UTC time since Unix epoch that indicates when the session key is considered valid.
+ +
+ +
+
+ validity_period_duration_seconds + uint32 + +
+ +
Duration in seconds indicating how long the session key remains valid. The validity period starts from `validity_period_from_inclusive` above.
+ +
+ +
+
+ format + SignatureFormat + +
+ +
The format of the signature
+ +
+ +
+
+ signature + bytes + +
+ +
The signature of the combined hash of the session key fingerprint, validity period, and synchronizer id, by the long-term key. This signature authorizes the session key to act on behalf of the long-term key.
+ +
+ +
+
+ signing_algorithm_spec + SigningAlgorithmSpec + +
+ +
The signing algorithm specification used to produce this signature
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SigningKeySpec

+ +

5 values

+ +
+ +

[start-docs-entry: signing key spec proto]

+ + + +
    + +
  • SIGNING_KEY_SPEC_UNSPECIFIED
    • + +
  • SIGNING_KEY_SPEC_EC_CURVE25519
    • + +
  • SIGNING_KEY_SPEC_EC_P256
    • + +
  • SIGNING_KEY_SPEC_EC_P384
    • + +
  • SIGNING_KEY_SPEC_EC_SECP256K1
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.protocol.v30.MultiTransactionSignatures

+ +

2 fields

+ +
+ +

Used in SignedTopologyTransaction to bundle together multiple transaction hashes Allows submitters to only sign a single combined hash to authorize multiple transactions at once The combined hash is computed from the transaction hashes

+ + +
+ +
+
+ transaction_hashes + repeated bytes + +
+ +
List of topology transaction hashes. Required
+ +
+ +
+
+ signatures + repeated Signature + +
+ +
Signatures on the combined hash computed over the transaction_hashes MUST contain at least one
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ForceFlag

+ +

13 values

+ +
+ + + +
    + +
  • FORCE_FLAG_UNSPECIFIED
    • + +
  • FORCE_FLAG_ALIEN_MEMBER
    • + +
  • FORCE_FLAG_LEDGER_TIME_RECORD_TIME_TOLERANCE_INCREASE
    • + +
  • FORCE_FLAG_ALLOW_UNKNOWN_PACKAGE
    • + +
  • FORCE_FLAG_ALLOW_UNVETTED_DEPENDENCIES
    • + +
  • FORCE_FLAG_DISABLE_PARTY_WITH_ACTIVE_CONTRACTS
    • + +
  • FORCE_FLAG_ALLOW_UNVALIDATED_SIGNING_KEYS
    • + +
  • FORCE_FLAG_PREPARATION_TIME_RECORD_TIME_TOLERANCE_INCREASE
    • + +
  • FORCE_FLAG_ALLOW_INSUFFICIENT_PARTICIPANT_PERMISSION_FOR_SIGNATORY_PARTY
    • + +
  • FORCE_FLAG_ALLOW_INSUFFICIENT_SIGNATORY_ASSIGNING_PARTICIPANTS_FOR_PARTY
    • + +
  • FORCE_FLAG_ALLOW_VET_INCOMPATIBLE_UPGRADES
    • + +
  • FORCE_FLAG_ALLOW_OUT_OF_BOUNDS_VALUE
    • + +
  • FORCE_FLAG_ALLOW_CONFIRMING_THRESHOLD_CANNOT_BE_MET
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.StoreId

+ +

3 fields

+ +
+ + +
+ +
+
+ authorized + Authorized + +
+ +
+ +
+
+ synchronizer + Synchronizer + +
+ +
+ +
+
+ temporary + Temporary + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.StoreId.Authorized

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.StoreId.Temporary

+ +

1 fields

+ +
+ + +
+ +
+
+ name + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.Synchronizer

+ +

2 fields

+ +
+ + +
+ +
+
+ id + string + +
+ +
+ +
+
+ physical_id + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.AddTransactionsResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.AuthorizeRequest

+ +

7 fields

+ +
+ + +
+ +
+
+ proposal + Proposal + +
+ +
* Propose a transaction and distribute it. If authorize if the node has enough signing keys
+ +
+ +
+
+ transaction_hash + string + +
+ +
* Authorize a transaction, meaning the node needs to be able to fully sign it locally. Hash is in hexadecimal format.
+ +
+ +
+
+ must_fully_authorize + bool + +
+ +
* If true: the transaction is only signed if the new signatures will result in the transaction being fully authorized. Otherwise returns as an error. If false: the transaction is signed and the signature distributed. The transaction may still not be fully authorized and remain as a proposal.
+ +
+ +
+
+ force_changes + repeated ForceFlag + +
+ +
* Force specific changes even if dangerous
+ +
+ +
+
+ signed_by + repeated string + +
+ +
* Fingerprint of the keys signing the authorization The signing key is used to identify a particular `NamespaceDelegation` certificate, which is used to justify the given authorization. Optional, if empty, suitable signing keys available known to the node are automatically selected.
+ +
+ +
+
+ store + StoreId + +
+ +
* The store that is used as the underlying source for executing this request. If `store` is a synchronizer store, the resulting topology transaction will only be available on the respective synchronizer. If `store` is the authorized store, the resulting topology transaction may or may not be synchronized automatically to all synchronizers that the node is currently connected to or will be connected to in the future. Selecting a specific synchronizers store might be necessary, if the transaction to authorize by hash or the previous generation of the submitted proposal is only available on the synchronizers store and not in the authorized store.
+ +
+ +
+
+ wait_to_become_effective + Duration + +
+ +
* Optional timeout to wait for the transaction to become effective in the store.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.AuthorizeRequest.Proposal

+ +

3 fields

+ +
+ + +
+ +
+
+ change + TopologyChangeOp + +
+ +
* Replace / Remove
+ +
+ +
+
+ serial + uint32 + +
+ +
* Optionally, the serial number of this request (auto-determined if omitted)
+ +
+ +
+
+ mapping + TopologyMapping + +
+ +
* The mapping to be authorized
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.Enums.TopologyChangeOp

+ +

3 values

+ +
+ + + +
    + +
  • TOPOLOGY_CHANGE_OP_UNSPECIFIED
    • + +
  • TOPOLOGY_CHANGE_OP_ADD_REPLACE
    • + +
  • TOPOLOGY_CHANGE_OP_REMOVE
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.protocol.v30.TopologyMapping

+ +

15 fields

+ +
+ +

[docs-entry-start: topology mapping]

+ + +
+ +
+
+ namespace_delegation + NamespaceDelegation + +
+ +
+ +
+
+ decentralized_namespace_definition + DecentralizedNamespaceDefinition + +
+ +
+ +
+
+ owner_to_key_mapping + OwnerToKeyMapping + +
+ +
+ +
+
+ synchronizer_trust_certificate + SynchronizerTrustCertificate + +
+ +
+ +
+
+ participant_permission + ParticipantSynchronizerPermission + +
+ +
+ +
+
+ party_hosting_limits + PartyHostingLimits + +
+ +
+ +
+
+ vetted_packages + VettedPackages + +
+ +
+ +
+
+ party_to_participant + PartyToParticipant + +
+ +
+ +
+
+ synchronizer_parameters_state + SynchronizerParametersState + +
+ +
+ +
+
+ mediator_synchronizer_state + MediatorSynchronizerState + +
+ +
+ +
+
+ sequencer_synchronizer_state + SequencerSynchronizerState + +
+ +
+ +
+
+ sequencing_dynamic_parameters_state + DynamicSequencingParametersState + +
+ +
+ +
+
+ party_to_key_mapping + PartyToKeyMapping + +
+ +
+ +
+
+ synchronizer_upgrade_announcement + SynchronizerUpgradeAnnouncement + +
+ +
+ +
+
+ sequencer_connection_successor + SequencerConnectionSuccessor + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.NamespaceDelegation

+ +

6 fields

+ +
+ +

[start NamespaceDelegation definition] namespace delegation (equivalent to X509v3 CA root or intermediate CAs) if is_root_delegation==false, the target key may sign all mappings requiring a signature for the namespace except other NamespaceDelegation mappings. authorization: a namespace delegation is either signed by the root key, or is signed by a key for which there exists a series of properly authorized namespace delegations that are ultimately signed by the root key revocation: a revoked namespace delegation cannot be re-created. While the delegation itself is revoked, valid transactions that have been signed using the authority of the delegation before its revocation stay valid. UNIQUE(namespace, target_key)

+ + +
+ +
+
+ namespace + string + +
+ +
fingerprint of the root key defining the namespace
+ +
+ +
+
+ target_key + SigningPublicKey + +
+ +
target key of getting full rights on the namespace (if target == namespace, it's a root CA)
+ +
+ +
+
+ is_root_delegation + bool + +
+ +
flag indicating whether the given delegation is a root delegation or not a root delegation is also allowed to issue other NamespaceDelegations.
+ +
+ +
+
+ can_sign_all_mappings + CanSignAllMappings + +
+ +
+ +
+
+ can_sign_all_but_namespace_delegations + CanSignAllButNamespaceDelegations + +
+ +
+ +
+
+ can_sign_specific_mapings + CanSignSpecificMappings + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.NamespaceDelegation.CanSignAllMappings

+ +

0 fields

+ +
+ +

[start-docs-entry: namespace delegation restrictions] the key can sign all currently known mappings and all mappings that will be added in future releases

+ + + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.NamespaceDelegation.CanSignAllButNamespaceDelegations

+ +

0 fields

+ +
+ +

the key can sign all currently known mappings and all mappings that will be added in future releases, except for namespace delegations

+ + + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.NamespaceDelegation.CanSignSpecificMappings

+ +

1 fields

+ +
+ +

the key can only sign the explicitly specified mappings

+ + +
+ +
+
+ mappings + repeated TopologyMappingCode + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.Enums.TopologyMappingCode

+ +

16 values

+ +
+ + + +
    + +
  • TOPOLOGY_MAPPING_CODE_UNSPECIFIED
    • + +
  • TOPOLOGY_MAPPING_CODE_NAMESPACE_DELEGATION
    • + +
  • TOPOLOGY_MAPPING_CODE_DECENTRALIZED_NAMESPACE_DEFINITION
    • + +
  • TOPOLOGY_MAPPING_CODE_OWNER_TO_KEY_MAPPING
    • + +
  • TOPOLOGY_MAPPING_CODE_SYNCHRONIZER_TRUST_CERTIFICATE
    • + +
  • TOPOLOGY_MAPPING_CODE_PARTICIPANT_PERMISSION
    • + +
  • TOPOLOGY_MAPPING_CODE_PARTY_HOSTING_LIMITS
    • + +
  • TOPOLOGY_MAPPING_CODE_VETTED_PACKAGES
    • + +
  • TOPOLOGY_MAPPING_CODE_PARTY_TO_PARTICIPANT
    • + +
  • TOPOLOGY_MAPPING_CODE_SYNCHRONIZER_PARAMETERS_STATE
    • + +
  • TOPOLOGY_MAPPING_CODE_MEDIATOR_SYNCHRONIZER_STATE
    • + +
  • TOPOLOGY_MAPPING_CODE_SEQUENCER_SYNCHRONIZER_STATE
    • + +
  • TOPOLOGY_MAPPING_CODE_SEQUENCING_DYNAMIC_PARAMETERS_STATE
    • + +
  • TOPOLOGY_MAPPING_CODE_PARTY_TO_KEY_MAPPING
    • + +
  • TOPOLOGY_MAPPING_CODE_SYNCHRONIZER_MIGRATION_ANNOUNCEMENT
    • + +
  • TOPOLOGY_MAPPING_CODE_SEQUENCER_CONNECTION_SUCCESSOR
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SigningPublicKey

+ +

5 fields

+ +
+ + +
+ +
+
+ format + CryptoKeyFormat + +
+ +
+ +
+
+ public_key + bytes + +
+ +
Serialized public key in the format specified above
+ +
+ +
+
+ scheme + SigningKeyScheme + +
+ +
No longer used (only kept for backwards compatibility) stores both the crypto key scheme and algorithm.
+ +
+ +
+
+ usage + repeated SigningKeyUsage + +
+ +
Explicitly state the key's intended use
+ +
+ +
+
+ key_spec + SigningKeySpec + +
+ +
The key specification that was used to generate the key pair
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.CryptoKeyFormat

+ +

6 values

+ +
+ +

Serialization format for crypto keys and signatures

+ + + +
    + +
  • CRYPTO_KEY_FORMAT_UNSPECIFIED
    • + +
  • CRYPTO_KEY_FORMAT_DER
    • + +
  • CRYPTO_KEY_FORMAT_RAW
    • + +
  • CRYPTO_KEY_FORMAT_DER_X509_SUBJECT_PUBLIC_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_DER_PKCS8_PRIVATE_KEY_INFO
    • + +
  • CRYPTO_KEY_FORMAT_SYMBOLIC
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SigningKeyScheme

+ +

4 values

+ +
+ +

@deprecated

+ + + +
    + +
  • SIGNING_KEY_SCHEME_UNSPECIFIED
    • + +
  • SIGNING_KEY_SCHEME_ED25519
    • + +
  • SIGNING_KEY_SCHEME_EC_DSA_P256
    • + +
  • SIGNING_KEY_SCHEME_EC_DSA_P384
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SigningKeyUsage

+ +

6 values

+ +
+ + + +
    + +
  • SIGNING_KEY_USAGE_UNSPECIFIED
    • + +
  • SIGNING_KEY_USAGE_NAMESPACE
    • + +
  • SIGNING_KEY_USAGE_IDENTITY_DELEGATION
    • + +
  • SIGNING_KEY_USAGE_SEQUENCER_AUTHENTICATION
    • + +
  • SIGNING_KEY_USAGE_PROTOCOL
    • + +
  • SIGNING_KEY_USAGE_PROOF_OF_OWNERSHIP
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.protocol.v30.DecentralizedNamespaceDefinition

+ +

3 fields

+ +
+ +

a decentralized namespace definition that creates a new namespace supported by the the original owners authorization: the decentralized namespace definition with serial = 1 must be authorized by all the owners of the namespace that form the decentralized namespace. for definitions with serial > 1, we need the authorization of #threshold owners plus all new owners any further transaction within the decentralized namespace other than decentralized namespace definitions needs #threshold signatures of the owners UNIQUE(decentralized_namespace)

+ + +
+ +
+
+ decentralized_namespace + string + +
+ +
name of the decentralized namespace, computed from the hash of its initial owners
+ +
+ +
+
+ threshold + int32 + +
+ +
the threshold required for any subsequent update signing
+ +
+ +
+
+ owners + repeated string + +
+ +
the namespaces of the owners
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.OwnerToKeyMapping

+ +

2 fields

+ +
+ +

mapping a member (participant, mediator, sequencer) to a key authorization: whoever controls the member uid UNIQUE(member)

+ + +
+ +
+
+ member + string + +
+ +
the sequencing process member
+ +
+ +
+
+ public_keys + repeated PublicKey + +
+ +
the designated keys
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.PublicKey

+ +

2 fields

+ +
+ + +
+ +
+
+ signing_public_key + SigningPublicKey + +
+ +
+ +
+
+ encryption_public_key + EncryptionPublicKey + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.EncryptionPublicKey

+ +

4 fields

+ +
+ + +
+ +
+
+ format + CryptoKeyFormat + +
+ +
+ +
+
+ public_key + bytes + +
+ +
Serialized public key in the format specified above
+ +
+ +
+
+ scheme + EncryptionKeyScheme + +
+ +
No longer used (only kept for backwards compatibility) stores both the crypto key scheme and algorithm.
+ +
+ +
+
+ key_spec + EncryptionKeySpec + +
+ +
The key specification that was used to generate the key pair
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.EncryptionKeyScheme

+ +

4 values

+ +
+ +

@deprecated

+ + + +
    + +
  • ENCRYPTION_KEY_SCHEME_UNSPECIFIED
    • + +
  • ENCRYPTION_KEY_SCHEME_ECIES_P256_HKDF_HMAC_SHA256_AES128GCM
    • + +
  • ENCRYPTION_KEY_SCHEME_ECIES_P256_HMAC_SHA256A_ES128CBC
    • + +
  • ENCRYPTION_KEY_SCHEME_RSA2048_OAEP_SHA256
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.crypto.v30.EncryptionKeySpec

+ +

3 values

+ +
+ + + +
    + +
  • ENCRYPTION_KEY_SPEC_UNSPECIFIED
    • + +
  • ENCRYPTION_KEY_SPEC_EC_P256
    • + +
  • ENCRYPTION_KEY_SPEC_RSA_2048
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.protocol.v30.SynchronizerTrustCertificate

+ +

3 fields

+ +
+ +

the trust certificate issued by the participant confirming that the participant wishes to be present on the given synchronizer authorization: whoever controls the participant uid UNIQUE(participant,synchronizer_id)

+ + +
+ +
+
+ participant_uid + string + +
+ +
the uid of the participant
+ +
+ +
+
+ synchronizer_id + string + +
+ +
the uid of the synchronizer that the participant trusts
+ +
+ +
+
+ feature_flags + repeated ParticipantFeatureFlag + +
+ +
Feature flags that this node declares to support on this synchronizer
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.Enums.ParticipantFeatureFlag

+ +

2 values

+ +
+ + + +
    + +
  • PARTICIPANT_FEATURE_FLAG_UNSPECIFIED
    • + +
  • PARTICIPANT_FEATURE_FLAG_PV33_EXTERNAL_SIGNING_LOCAL_CONTRACT_IN_SUBVIEW
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.protocol.v30.ParticipantSynchronizerPermission

+ +

5 fields

+ +
+ +

the optional trust certificate of the synchronizer towards the participant authorization: whoever controls the synchronizer id UNIQUE(synchronizer_id,participant)

+ + +
+ +
+
+ synchronizer_id + string + +
+ +
+ +
+
+ participant_uid + string + +
+ +
+ +
+
+ permission + ParticipantPermission + +
+ +
the permission level of the participant on this synchronizer (usually submission)
+ +
+ +
+
+ limits + ParticipantSynchronizerLimits + +
+ +
optional individual limits for this participant
+ +
+ +
+
+ login_after + int64 + +
+ +
optional earliest time when participant can log in (again) used to temporarily disable participants In microseconds of UTC time since Unix epoch
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.Enums.ParticipantPermission

+ +

4 values

+ +
+ +

enum indicating the participant permission level Regardless of the ParticipantPermission level, all participants can submit a reassignment.

+ + + +
    + +
  • PARTICIPANT_PERMISSION_UNSPECIFIED
    • + +
  • PARTICIPANT_PERMISSION_SUBMISSION
    • + +
  • PARTICIPANT_PERMISSION_CONFIRMATION
    • + +
  • PARTICIPANT_PERMISSION_OBSERVATION
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.protocol.v30.ParticipantSynchronizerLimits

+ +

1 fields

+ +
+ +

individual per participant limits

+ + +
+ +
+
+ confirmation_requests_max_rate + uint32 + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.PartyHostingLimits

+ +

2 fields

+ +
+ +

the optional hosting limits for a party on a given synchronizer these limits can be used to limit the number of participants that can host a given party authorization: whoever controls the synchronizer id UNIQUE(synchronizer_id,party)

+ + +
+ +
+
+ synchronizer_id + string + +
+ +
+ +
+
+ party + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.VettedPackages

+ +

3 fields

+ +
+ +

list of packages supported by this participant authorization: whoever controls the participant uid UNIQUE(participant)

+ + +
+ +
+
+ participant_uid + string + +
+ +
the participant vetting the packages
+ +
+ +
+
+ package_ids + repeated string + +
+ +
DEPRECATED: no longer used, but kept for backwards compatibility. the hashes of the vetted packages. package hashes may only be listed in one of the two fields: package_ids or packages. a package listed in package_ids is equivalent to a package listed in packages with unbounded validity.
+ +
+ +
+
+ packages + repeated VettedPackage + +
+ +
the hashes of vetted packages with a validity period. only one entry per package_id is permitted.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.VettedPackages.VettedPackage

+ +

3 fields

+ +
+ + +
+ +
+
+ package_id + string + +
+ +
the hash of the vetted package
+ +
+ +
+
+ valid_from_inclusive + Timestamp + +
+ +
optional earliest ledger effective time (inclusive) as of which the package is considered valid. must be less than or equal to valid_until if both are present.
+ +
+ +
+
+ valid_until_exclusive + Timestamp + +
+ +
optional latest ledger effective time (exclusive) until which the package is considered valid. must be greater than or equal to valid_from if both are present.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.PartyToParticipant

+ +

4 fields

+ +
+ +

Mapping that maps a party to a participant The PartyToParticipant mapping may also specify a list of signing keys for setting up an external party, in which case the keys and the threshold take precedence over any PartyToKeyMapping for the same party. Additionally, the list of signing keys may contain the public key of the party's namespace, which allows this mapping to authorize itself without the need of a NamespaceDelegation root certificate (called self-signed). authorization: the required authorization of the mapping is a union of the authorization for individual changes - threshold change: party namespace - adding a signing key: party namespace + all the new signing key - removing a signing key: party namespace - changing the signing key threshold: party namespace - upgrading a participant permission or adding a new participant: namespaces from party and the participant namespace - downgrading a participant permission or removing a participant: party namespace OR the participant namespace - setting a participant's onboarding flag from false to true: party namespace - setting a participant's onboarding flag from true to false: participant namespace - the removal of a PTP must be authorized just by the party revocation: Revoking a self-signed PTP does not prevent later re-creation of a PTP with the same partyId. To prevent further usage of the key associated with the party's namespace, revoke a NamespaceDelegation root certificate for that namespace. UNIQUE(party)

+ + +
+ +
+
+ party + string + +
+ +
the party that is to be represented by the participants
+ +
+ +
+
+ threshold + uint32 + +
+ +
the signatory threshold required by the participants to be able to act on behalf of the party. a mapping with threshold > 1 is considered a definition of a consortium party
+ +
+ +
+
+ participants + repeated HostingParticipant + +
+ +
which participants will host the party. if threshold > 1, must be Confirmation or Observation. if all participants have Observation permission, the confirmation treshold is ignored, making the party a purely observing party.
+ +
+ +
+
+ party_signing_keys + SigningKeysWithThreshold + +
+ +
Contains protocol signing keys for the party used to authorize externally signed Daml transactions, along with a signing threshold. The max number of keys is 20
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.PartyToParticipant.HostingParticipant

+ +

3 fields

+ +
+ + +
+ +
+
+ participant_uid + string + +
+ +
the target participant that the party should be mapped to
+ +
+ +
+
+ permission + ParticipantPermission + +
+ +
permission of the participant for this particular party (the actual will be min of ParticipantSynchronizerPermission.ParticipantPermission and this setting)
+ +
+ +
+
+ onboarding + Onboarding + +
+ +
optional, present iff the party is being onboarded to the participant
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.PartyToParticipant.HostingParticipant.Onboarding

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.crypto.v30.SigningKeysWithThreshold

+ +

2 fields

+ +
+ + +
+ +
+
+ keys + repeated SigningPublicKey + +
+ +
the designated signing keys
+ +
+ +
+
+ threshold + uint32 + +
+ +
the authorization threshold
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.SynchronizerParametersState

+ +

2 fields

+ +
+ +

which dynamic synchronizer parameters are supposed to be used on the given synchronizer authorization: whoever controls the synchronizer UNIQUE(synchronizer_id)

+ + +
+ +
+
+ synchronizer_id + string + +
+ +
synchronizer affected by the new synchronizer parameters
+ +
+ +
+
+ synchronizer_parameters + DynamicSynchronizerParameters + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.DynamicSynchronizerParameters

+ +

13 fields

+ +
+ + +
+ +
+
+ confirmation_response_timeout + Duration + +
+ +
+ +
+
+ mediator_reaction_timeout + Duration + +
+ +
+ +
+
+ assignment_exclusivity_timeout + Duration + +
+ +
+ +
+
+ ledger_time_record_time_tolerance + Duration + +
+ +
+ +
+
+ reconciliation_interval + Duration + +
+ +
+ +
+
+ mediator_deduplication_timeout + Duration + +
+ +
+ +
+
+ max_request_size + uint32 + +
+ +
+ +
+
+ onboarding_restriction + OnboardingRestriction + +
+ +
topology related validation parameters permissioned synchronizer: if true, only participants which have been explicitly put on the allow list can onboard to the synchronizer
+ +
+ +
+
+ participant_synchronizer_limits + ParticipantSynchronizerLimits + +
+ +
+ +
+
+ sequencer_aggregate_submission_timeout + Duration + +
+ +
+ +
+
+ traffic_control + TrafficControlParameters + +
+ +
+ +
+
+ acs_commitments_catchup + AcsCommitmentsCatchUpConfig + +
+ +
+ +
+
+ preparation_time_record_time_tolerance + Duration + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.OnboardingRestriction

+ +

5 values

+ +
+ +

Controls how participants can join the synchronizer Note that currently, only transitions from restricted to unrestricted are supported, but not the other way around.

+ + + +
    + +
  • ONBOARDING_RESTRICTION_UNSPECIFIED
    • + +
  • ONBOARDING_RESTRICTION_UNRESTRICTED_OPEN
    • + +
  • ONBOARDING_RESTRICTION_UNRESTRICTED_LOCKED
    • + +
  • ONBOARDING_RESTRICTION_RESTRICTED_OPEN
    • + +
  • ONBOARDING_RESTRICTION_RESTRICTED_LOCKED
    • + +
+ + +
+ +
+
+

com.digitalasset.canton.protocol.v30.TrafficControlParameters

+ +

7 fields

+ +
+ + +
+ +
+
+ max_base_traffic_amount + uint64 + +
+ +
[doc-entry-start: TrafficControlParameters] In bytes, the maximum amount of base traffic that can be accumulated
+ +
+ +
+
+ max_base_traffic_accumulation_duration + Duration + +
+ +
Maximum duration over which the base rate can be accumulated Consequently, base_traffic_rate = max_base_traffic_amount / max_base_traffic_accumulation_duration
+ +
+ +
+
+ read_vs_write_scaling_factor + uint32 + +
+ +
Read scaling factor to compute the event cost. In parts per 10 000.
+ +
+ +
+
+ set_balance_request_submission_window_size + Duration + +
+ +
Window size used to compute the max sequencing time of a submission request This impacts how quickly a submission is expected to be accepted before a retry should be attempted by the caller Default is 5 minutes
+ +
+ +
+
+ enforce_rate_limiting + bool + +
+ +
If true, submission requests without enough traffic credit will not be delivered
+ +
+ +
+
+ base_event_cost + uint64 + +
+ +
In bytes, base event cost added to all sequenced events. Optional
+ +
+ +
+
+ free_confirmation_responses + bool + +
+ +
Whether to charge for confirmation responses Default: false
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.AcsCommitmentsCatchUpConfig

+ +

2 fields

+ +
+ +

catch-up configuration parameters

+ + +
+ +
+
+ catchup_interval_skip + uint32 + +
+ +
+ +
+
+ nr_intervals_to_trigger_catchup + uint32 + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.MediatorSynchronizerState

+ +

5 fields

+ +
+ +

which mediators and mediator groups are active on the given synchronizer authorization: whoever controls the synchronizer UNIQUE(synchronizer_id, group)

+ + +
+ +
+
+ synchronizer_id + string + +
+ +
the synchronizer id of the mediator group
+ +
+ +
+
+ group + uint32 + +
+ +
the group-id used for sharding multiple mediator groups
+ +
+ +
+
+ threshold + uint32 + +
+ +
the signature threshold required to reach consensus among the mediators
+ +
+ +
+
+ active + repeated string + +
+ +
the list of active mediators (uid) within the group
+ +
+ +
+
+ observers + repeated string + +
+ +
the list of observing mediators (uid) within the group (read messages but don't respond)
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.SequencerSynchronizerState

+ +

4 fields

+ +
+ +

which sequencers are active on the given synchronizer authorization: whoever controls the synchronizer UNIQUE(synchronizer_id)

+ + +
+ +
+
+ synchronizer_id + string + +
+ +
the synchronizer id of the sequencer group
+ +
+ +
+
+ threshold + uint32 + +
+ +
The system can tolerate up to min(threshold - 1, (activeWithSigningKey.size - 1)/3) malicious active sequencers, where activeWithSigningKey is the set of sequencers from active that have an active OwnerToKeyMapping with a signing key. In order to make the system resilient against f malicious active sequencers, you need to: (1) configure threshold := f + 1, (2) possibly add active sequencers such that f <= (activeWithSigningKey.size - 1)/3. (3) possibly register signing keys for active sequencers,
+ +
+ +
+
+ active + repeated string + +
+ +
the list of active sequencers If a sequencer without an active signing key is added to this set, it has no effect on the topology state.
+ +
+ +
+
+ observers + repeated string + +
+ +
the list of observing sequencers (uid) within the group (read messages but don't respond)
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.DynamicSequencingParametersState

+ +

2 fields

+ +
+ +

which sequencing dynamic parameters are supposed to be used on the given synchronizer; defaults are used when not set authorization: whoever controls the synchronizer UNIQUE(synchronizer_id)

+ + +
+ +
+
+ synchronizer_id + string + +
+ +
synchronizer affected by the new synchronizer parameters
+ +
+ +
+
+ sequencing_parameters + DynamicSequencingParameters + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.DynamicSequencingParameters

+ +

1 fields

+ +
+ + +
+ +
+
+ payload + bytes + +
+ +
Sequencing dynamic synchronizer parameters can only be interpreted by a sequencer implementation and are opaque to the rest of the synchronizer.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.PartyToKeyMapping

+ +

3 fields

+ +
+ +

[doc-entry-start: PartyToKeyMapping] mapping a party to a key authorization: whoever controls the party uid UNIQUE(party)

+ + +
+ +
+
+ party + string + +
+ +
the party
+ +
+ +
+
+ threshold + uint32 + +
+ +
the authorization threshold
+ +
+ +
+
+ signing_keys + repeated SigningPublicKey + +
+ +
the designated signing keys
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.SynchronizerUpgradeAnnouncement

+ +

2 fields

+ +
+ +

indicates the beginning of a synchronizer upgrade and effectuates a topology freeze, after which only synchronizer upgrade specific topology mappings are accepted. removing this mapping unfreezes the topology state again. authorization: whoever controls the synchronizer UNIQUE(successor_physical_synchronizer_id.logical)

+ + +
+ +
+
+ successor_physical_synchronizer_id + string + +
+ +
the physical synchronizer id of the successor synchronizer
+ +
+ +
+
+ upgrade_time + Timestamp + +
+ +
when the upgrade happens
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.SequencerConnectionSuccessor

+ +

3 fields

+ +
+ +

a sequencer can announce its connections on the successor synchronizer authorization: whoever controls the sequencer UNIQUE(sequencer_id, synchronizer_id)

+ + +
+ +
+
+ sequencer_id + string + +
+ +
the sequencer id
+ +
+ +
+
+ synchronizer_id + string + +
+ +
to synchronizer id
+ +
+ +
+
+ connection + SequencerConnection + +
+ +
the connection details with which members can connect to the sequencer on the successor synchronizer
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.SequencerConnectionSuccessor.SequencerConnection

+ +

1 fields

+ +
+ + +
+ +
+
+ grpc + Grpc + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.protocol.v30.SequencerConnectionSuccessor.SequencerConnection.Grpc

+ +

2 fields

+ +
+ + +
+ +
+
+ endpoints + repeated string + +
+ +
connection information to sequencer (http[s]://<host>:<port>") all endpoints must agree on using HTTPS or HTTP
+ +
+ +
+
+ custom_trust_certificates + bytes + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.AuthorizeResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ transaction + SignedTopologyTransaction + +
+ +
* the generated signed topology transaction
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.BaseQuery

+ +

8 fields

+ +
+ + +
+ +
+
+ store + StoreId + +
+ +
+ +
+
+ proposals + bool + +
+ +
whether to query only for proposals instead of approved topology mappings
+ +
+ +
+
+ operation + TopologyChangeOp + +
+ +
+ +
+
+ snapshot + Timestamp + +
+ +
+ +
+
+ head_state + Empty + +
+ +
+ +
+
+ range + TimeRange + +
+ +
+ +
+
+ filter_signed_key + string + +
+ +
+ +
+
+ protocol_version + int32 + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.BaseQuery.TimeRange

+ +

2 fields

+ +
+ + +
+ +
+
+ from + Timestamp + +
+ +
+ +
+
+ until + Timestamp + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.BaseResult

+ +

8 fields

+ +
+ + +
+ +
+
+ store + StoreId + +
+ +
+ +
+
+ sequenced + Timestamp + +
+ +
+ +
+
+ valid_from + Timestamp + +
+ +
+ +
+
+ valid_until + Timestamp + +
+ +
+ +
+
+ operation + TopologyChangeOp + +
+ +
+ +
+
+ transaction_hash + bytes + +
+ +
+ +
+
+ serial + int32 + +
+ +
+ +
+
+ signed_by_fingerprints + repeated string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.CreateTemporaryTopologyStoreRequest

+ +

2 fields

+ +
+ + +
+ +
+
+ name + string + +
+ +
* The name of the topology store
+ +
+ +
+
+ protocol_version + uint32 + +
+ +
* The protocol version that should be used by the store
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.CreateTemporaryTopologyStoreResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ store_id + Temporary + +
+ +
* The identifier of the topology store that should be used as a store filter string
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.CurrentTimeRequest

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.CurrentTimeResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ current_time + int64 + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.DropTemporaryTopologyStoreRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ store_id + Temporary + +
+ +
* The identifier of the topology store that should be dropped
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.DropTemporaryTopologyStoreResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ExportTopologySnapshotRequest

+ +

3 fields

+ +
+ + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ exclude_mappings + repeated string + +
+ +
+ +
+
+ filter_namespace + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ExportTopologySnapshotResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ chunk + bytes + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ExportTopologySnapshotV2Request

+ +

3 fields

+ +
+ + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ exclude_mappings + repeated string + +
+ +
+ +
+
+ filter_namespace + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ExportTopologySnapshotV2Response

+ +

1 fields

+ +
+ + +
+ +
+
+ chunk + bytes + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.GenerateTransactionsRequest

+ +

1 fields

+ +
+ + +
+ +
+
+ proposals + repeated Proposal + +
+ +
transaction proposals for which to generate topology transactions
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.GenerateTransactionsRequest.Proposal

+ +

4 fields

+ +
+ + +
+ +
+
+ operation + TopologyChangeOp + +
+ +
* Replace / Remove
+ +
+ +
+
+ serial + uint32 + +
+ +
* Optionally, the serial number of this request (auto-determined if omitted) NOTE: omitting the serial MAY end up overwriting previous mappings processed concurrently. To avoid such cases, First read the state using the TopologyManagerReadService and update the mappings accordingly, incrementing the serial by one and setting it here explicitly.
+ +
+ +
+
+ mapping + TopologyMapping + +
+ +
* The mapping to be authorized
+ +
+ +
+
+ store + StoreId + +
+ +
Target store
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.GenerateTransactionsResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ generated_transactions + repeated GeneratedTransaction + +
+ +
Generated transactions, in the same order as the mappings provided in the request
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.GenerateTransactionsResponse.GeneratedTransaction

+ +

2 fields

+ +
+ + +
+ +
+
+ serialized_transaction + bytes + +
+ +
Serialized com.digitalasset.canton.protocol.v30.TopologyTransaction
+ +
+ +
+
+ transaction_hash + bytes + +
+ +
Hash of the transaction - this should be signed by the submitter to authorize the transaction
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.GenesisStateRequest

+ +

2 fields

+ +
+ + +
+ +
+
+ synchronizer_store + StoreId + +
+ +
Must be specified if the genesis state is requested from a participant node.
+ +
+ +
+
+ timestamp + Timestamp + +
+ +
Optional - the effective time used to fetch the topology transactions. If not provided the effective time of the last topology transaction is used.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.GenesisStateResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ chunk + bytes + +
+ +
versioned stored topology transactions
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.GenesisStateV2Request

+ +

2 fields

+ +
+ + +
+ +
+
+ synchronizer_store + StoreId + +
+ +
Must be specified if the genesis state is requested from a participant node.
+ +
+ +
+
+ timestamp + Timestamp + +
+ +
Optional - the effective time used to fetch the topology transactions. If not provided the effective time of the last topology transaction is used.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.GenesisStateV2Response

+ +

1 fields

+ +
+ + +
+ +
+
+ chunk + bytes + +
+ +
versioned stored topology transactions
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.GetIdRequest

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.GetIdResponse

+ +

2 fields

+ +
+ + +
+ +
+
+ initialized + bool + +
+ +
+ +
+
+ unique_identifier + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.GetOnboardingTransactionsRequest

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.GetOnboardingTransactionsResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ transactions + TopologyTransactions + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.TopologyTransactions

+ +

1 fields

+ +
+ +

* Topology transaction collection used during bootstrapping of synchronizer nodes and on the admin API Please note that this message should not be in the protocol package, as it is not used on the protocol itself but on the admin apis. But as we can't rename the package name due to backwards compatibility guarantees, we've moved the file out of the protocol.proto file, but kept the package name.

+ + +
+ +
+
+ items + repeated Item + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.TopologyTransactions.Item

+ +

5 fields

+ +
+ + +
+ +
+
+ sequenced + Timestamp + +
+ +
+ +
+
+ valid_from + Timestamp + +
+ +
+ +
+
+ valid_until + Timestamp + +
+ +
+ +
+
+ transaction + bytes + +
+ +
* Versioned signed topology transactions serialized as byte-strings. Note that we use here the serialized version that contains the version number. Using the "Versioned" version directly here would create a circular dependency between the proto files. The only proper solution would be to move this into a third separate file with "cross version data files", which we might do at some point.
+ +
+ +
+
+ rejection_reason + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ImportTopologySnapshotRequest

+ +

3 fields

+ +
+ +

* Same message as AddTransactionsRequest, except that transactions are encoded in a byte string

+ + +
+ +
+
+ topology_snapshot + bytes + +
+ +
+ +
+
+ store + StoreId + +
+ +
+ +
+
+ wait_to_become_effective + Duration + +
+ +
* Optional timeout to wait for the transaction to become effective in the store.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ImportTopologySnapshotResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ImportTopologySnapshotV2Request

+ +

3 fields

+ +
+ +

* Same message as AddTransactionsRequest, except that transactions are encoded in a byte string

+ + +
+ +
+
+ topology_snapshot + bytes + +
+ +
+ +
+
+ store + StoreId + +
+ +
+ +
+
+ wait_to_become_effective + Duration + +
+ +
* Optional timeout to wait for the transaction to become effective in the store.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ImportTopologySnapshotV2Response

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.InitIdRequest

+ +

3 fields

+ +
+ + +
+ +
+
+ identifier + string + +
+ +
The identifier of this node
+ +
+ +
+
+ namespace + string + +
+ +
The namespace of this node If empty, then we use the namespace of the first certificate. If both are set, then we assert that the namespace matches the namespace of the first certificate.
+ +
+ +
+
+ namespace_delegations + repeated SignedTopologyTransaction + +
+ +
Optional set of namespace_delegations for this node (in case we are using external root keys)
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.InitIdResponse

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListAllRequest

+ +

3 fields

+ +
+ + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ exclude_mappings + repeated string + +
+ +
* The list of topology mappings to exclude from the result.
+ +
+ +
+
+ filter_namespace + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListAllResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ result + TopologyTransactions + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListAvailableStoresRequest

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListAvailableStoresResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ store_ids + repeated StoreId + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListDecentralizedNamespaceDefinitionRequest

+ +

2 fields

+ +
+ + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ filter_namespace + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListDecentralizedNamespaceDefinitionResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListDecentralizedNamespaceDefinitionResponse.Result

+ +

2 fields

+ +
+ + +
+ +
+
+ context + BaseResult + +
+ +
+ +
+
+ item + DecentralizedNamespaceDefinition + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListKeyOwnersRequest

+ +

5 fields

+ +
+ + +
+ +
+
+ as_of + Timestamp + +
+ +
+ +
+
+ limit + int32 + +
+ +
+ +
+
+ synchronizer_ids + repeated string + +
+ +
+ +
+
+ filter_key_owner_type + string + +
+ +
+ +
+
+ filter_key_owner_uid + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListKeyOwnersResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListKeyOwnersResponse.Result

+ +

5 fields

+ +
+ + +
+ +
+
+ synchronizer_id + string + +
+ +
+ +
+
+ key_owner + string + +
+ +
+ +
+
+ signing_keys + repeated SigningPublicKey + +
+ +
+ +
+
+ encryption_keys + repeated EncryptionPublicKey + +
+ +
+ +
+
+ physical_synchronizer_id + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListMediatorSynchronizerStateRequest

+ +

2 fields

+ +
+ + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ filter_synchronizer_id + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListMediatorSynchronizerStateResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListMediatorSynchronizerStateResponse.Result

+ +

2 fields

+ +
+ + +
+ +
+
+ context + BaseResult + +
+ +
+ +
+
+ item + MediatorSynchronizerState + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListNamespaceDelegationRequest

+ +

3 fields

+ +
+ + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ filter_namespace + string + +
+ +
+ +
+
+ filter_target_key_fingerprint + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListNamespaceDelegationResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListNamespaceDelegationResponse.Result

+ +

2 fields

+ +
+ + +
+ +
+
+ context + BaseResult + +
+ +
+ +
+
+ item + NamespaceDelegation + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListOwnerToKeyMappingRequest

+ +

3 fields

+ +
+ + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ filter_key_owner_type + string + +
+ +
+ +
+
+ filter_key_owner_uid + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListOwnerToKeyMappingResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListOwnerToKeyMappingResponse.Result

+ +

2 fields

+ +
+ + +
+ +
+
+ context + BaseResult + +
+ +
+ +
+
+ item + OwnerToKeyMapping + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListParticipantSynchronizerPermissionRequest

+ +

2 fields

+ +
+ + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ filter_uid + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListParticipantSynchronizerPermissionResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListParticipantSynchronizerPermissionResponse.Result

+ +

2 fields

+ +
+ + +
+ +
+
+ context + BaseResult + +
+ +
+ +
+
+ item + ParticipantSynchronizerPermission + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListPartiesRequest

+ +

5 fields

+ +
+ + +
+ +
+
+ as_of + Timestamp + +
+ +
+ +
+
+ limit + int32 + +
+ +
+ +
+
+ synchronizer_ids + repeated string + +
+ +
+ +
+
+ filter_party + string + +
+ +
+ +
+
+ filter_participant + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListPartiesResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListPartiesResponse.Result

+ +

2 fields

+ +
+ + +
+ +
+
+ party + string + +
+ +
+ +
+
+ participants + repeated ParticipantSynchronizers + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListPartiesResponse.Result.ParticipantSynchronizers

+ +

2 fields

+ +
+ + +
+ +
+
+ participant_uid + string + +
+ +
+ +
+
+ synchronizers + repeated SynchronizerPermissions + +
+ +
* permissions of this participant for this party on a per synchronizer basis for records that only exist in the authorized store, this list will be empty.
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListPartiesResponse.Result.ParticipantSynchronizers.SynchronizerPermissions

+ +

3 fields

+ +
+ + +
+ +
+
+ synchronizer_id + string + +
+ +
+ +
+
+ permission + ParticipantPermission + +
+ +
+ +
+
+ physical_synchronizer_id + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListPartyHostingLimitsRequest

+ +

2 fields

+ +
+ + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ filter_uid + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListPartyHostingLimitsResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListPartyHostingLimitsResponse.Result

+ +

2 fields

+ +
+ + +
+ +
+
+ context + BaseResult + +
+ +
+ +
+
+ item + PartyHostingLimits + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListPartyToKeyMappingRequest

+ +

2 fields

+ +
+ + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ filter_party + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListPartyToKeyMappingResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListPartyToKeyMappingResponse.Result

+ +

2 fields

+ +
+ + +
+ +
+
+ context + BaseResult + +
+ +
+ +
+
+ item + PartyToKeyMapping + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListPartyToParticipantRequest

+ +

3 fields

+ +
+ + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ filter_party + string + +
+ +
+ +
+
+ filter_participant + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListPartyToParticipantResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListPartyToParticipantResponse.Result

+ +

2 fields

+ +
+ + +
+ +
+
+ context + BaseResult + +
+ +
+ +
+
+ item + PartyToParticipant + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListSequencerConnectionSuccessorRequest

+ +

2 fields

+ +
+ + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ filter_sequencer_id + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListSequencerConnectionSuccessorResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListSequencerConnectionSuccessorResponse.Result

+ +

2 fields

+ +
+ + +
+ +
+
+ context + BaseResult + +
+ +
+ +
+
+ item + SequencerConnectionSuccessor + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListSequencerSynchronizerStateRequest

+ +

2 fields

+ +
+ + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ filter_synchronizer_id + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListSequencerSynchronizerStateResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListSequencerSynchronizerStateResponse.Result

+ +

2 fields

+ +
+ + +
+ +
+
+ context + BaseResult + +
+ +
+ +
+
+ item + SequencerSynchronizerState + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListSynchronizerParametersStateRequest

+ +

2 fields

+ +
+ + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ filter_synchronizer_id + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListSynchronizerParametersStateResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListSynchronizerParametersStateResponse.Result

+ +

2 fields

+ +
+ + +
+ +
+
+ context + BaseResult + +
+ +
+ +
+
+ item + DynamicSynchronizerParameters + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListSynchronizerTrustCertificateRequest

+ +

2 fields

+ +
+ + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ filter_uid + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListSynchronizerTrustCertificateResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListSynchronizerTrustCertificateResponse.Result

+ +

2 fields

+ +
+ + +
+ +
+
+ context + BaseResult + +
+ +
+ +
+
+ item + SynchronizerTrustCertificate + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListSynchronizerUpgradeAnnouncementRequest

+ +

2 fields

+ +
+ + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ filter_synchronizer_id + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListSynchronizerUpgradeAnnouncementResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListSynchronizerUpgradeAnnouncementResponse.Result

+ +

2 fields

+ +
+ + +
+ +
+
+ context + BaseResult + +
+ +
+ +
+
+ item + SynchronizerUpgradeAnnouncement + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListVettedPackagesRequest

+ +

2 fields

+ +
+ + +
+ +
+
+ base_query + BaseQuery + +
+ +
+ +
+
+ filter_participant + string + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListVettedPackagesResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ results + repeated Result + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.ListVettedPackagesResponse.Result

+ +

2 fields

+ +
+ + +
+ +
+
+ context + BaseResult + +
+ +
+ +
+
+ item + VettedPackages + +
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.LogicalUpgradeStateRequest

+ +

0 fields

+ +
+ + + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.LogicalUpgradeStateResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ chunk + bytes + +
+ +
versioned stored topology transactions
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.SignTransactionsRequest

+ +

4 fields

+ +
+ + +
+ +
+
+ transactions + repeated SignedTopologyTransaction + +
+ +
* The transactions to be signed, but will not be stored in the authorized store
+ +
+ +
+
+ signed_by + repeated string + +
+ +
* Fingerprint of the keys signing the authorization The signing key is used to identify a particular `NamespaceDelegation` certificate, which is used to justify the given authorization. Optional, if empty, suitable signing keys available known to the node are automatically selected.
+ +
+ +
+
+ store + StoreId + +
+ +
Target store
+ +
+ +
+
+ force_flags + repeated ForceFlag + +
+ +
* Force specific changes even if dangerous
+ +
+ +
+ + + +
+ +
+
+

com.digitalasset.canton.topology.admin.v30.SignTransactionsResponse

+ +

1 fields

+ +
+ + +
+ +
+
+ transactions + repeated SignedTopologyTransaction + +
+ +
* The transactions with the additional signatures from this node.
+ +
+ +
+ + + +
diff --git a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-v30.mdx b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-v30.mdx index 2dc8089..c53bf26 100644 --- a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-v30.mdx +++ b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-v30.mdx @@ -1,38 +1,153 @@ --- title: "com.digitalasset.canton.v30" -description: "Descriptor-backed protobuf API history for package com.digitalasset.canton.v30." +description: "Package-level overview for com.digitalasset.canton.v30." --- -# Package `com.digitalasset.canton.v30` +

Back to overview

-[Back to Canton Protobuf History](../index) +
+ +

Protobuf Package

+ + +

com.digitalasset.canton.v30

+ + +

0 services, 0 endpoints, 1 messages

+ + +
+ + gRPC + +
-## Snapshot + +
+ +
+
Files
+
1
+
+ +
+
Services
+
0
+
+ +
+
Endpoints
+
0
+
+ +
+
Messages
+
1
+
+ +
+
Enums
+
0
+
+ +
+ +
-- Current files: `1` -- Current services: `0` -- Current endpoints: `0` -- Current messages: `1` -- Current enums: `0` -- Lifecycle endpoints tracked: `0` ## Source Files -| File | Services | Messages | Enums | Source | -| --- | --- | --- | --- | --- | -| community/base/src/main/protobuf/com/digitalasset/canton/v30/trace_context.proto | `0` | `1` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/v30/trace_context.proto#L4) | -## Type Reference - -**Message `com.digitalasset.canton.v30.TraceContext`** -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/v30/trace_context.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/v30/trace_context.proto#L8) -- Fields: 2 +
+ + +
+ +
+

community/base/src/main/protobuf/com/digitalasset/canton/v30/trace_context.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
1
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/base/src/main/protobuf/com/digitalasset/canton/v30/trace_context.proto
+
+ +
+ + +
+ + +
+ + + + + +## Type Inventory + + +These are the package-level message and enum shapes in the publish-version snapshot. + + + -_No description._ +
+
+

com.digitalasset.canton.v30.TraceContext

+ +

2 fields

+ +
+ + +
+ +
+
+ traceparent + string + +
+ +
https://www.w3.org/TR/trace-context/
+ +
+ +
+
+ tracestate + string + +
+ +
+ +
-| Field | Type | Label | Description | -| --- | --- | --- | --- | -| traceparent | `string` | optional | https://www.w3.org/TR/trace-context/ | -| tracestate | `string` | optional | | + + +
diff --git a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-version-v1.mdx b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-version-v1.mdx index 89c84db..ca2072b 100644 --- a/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-version-v1.mdx +++ b/tests/fixtures/characterization/protobuf/expected/packages/com-digitalasset-canton-version-v1.mdx @@ -1,50 +1,153 @@ --- title: "com.digitalasset.canton.version.v1" -description: "Descriptor-backed protobuf API history for package com.digitalasset.canton.version.v1." +description: "Package-level overview for com.digitalasset.canton.version.v1." --- -# Package `com.digitalasset.canton.version.v1` +

Back to overview

-[Back to Canton Protobuf History](../index) +
+ +

Protobuf Package

+ + +

com.digitalasset.canton.version.v1

+ + +

0 services, 0 endpoints, 1 messages

+ + +
+ + gRPC + +
-## Snapshot + +
+ +
+
Files
+
1
+
+ +
+
Services
+
0
+
+ +
+
Endpoints
+
0
+
+ +
+
Messages
+
1
+
+ +
+
Enums
+
0
+
+ +
+ +
-- Current files: `1` -- Current services: `0` -- Current endpoints: `0` -- Current messages: `1` -- Current enums: `0` -- Lifecycle endpoints tracked: `0` ## Source Files -| File | Services | Messages | Enums | Source | -| --- | --- | --- | --- | --- | -| community/base/src/main/protobuf/com/digitalasset/canton/version/v1/untyped_versioned_message.proto | `0` | `1` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/version/v1/untyped_versioned_message.proto#L4) | -## Type Reference - -**Message `com.digitalasset.canton.version.v1.UntypedVersionedMessage`** -- Source: [community/base/src/main/protobuf/com/digitalasset/canton/version/v1/untyped_versioned_message.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/base/src/main/protobuf/com/digitalasset/canton/version/v1/untyped_versioned_message.proto#L23) -- Fields: 2 +
+ + +
+ +
+

community/base/src/main/protobuf/com/digitalasset/canton/version/v1/untyped_versioned_message.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
1
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/base/src/main/protobuf/com/digitalasset/canton/version/v1/untyped_versioned_message.proto
+
+ +
+ + +
+ + +
+ + + + + +## Type Inventory + + +These are the package-level message and enum shapes in the publish-version snapshot. -`UntypedVersionedMessage` is the generic wrapper for versioned messages - The version is included in the `version` integer and the serialized - message is contained in `data`. - Internally, we use the typed alias `VersionedMessage[ValueClass]` to avoid - the risk of confusion between different proto versioned messaged (see, e.g., - the return type of the `HasVersionedWrapper.toProtoVersioned` method). - The `oneof` prevents the serialized message to be empty if `data` is empty - and `version` is 0 (the default value for an integer). Such an empty message - cannot be deserialized using previous version of our parsing method. -[start UntypedVersionedMessage] +
+
+

com.digitalasset.canton.version.v1.UntypedVersionedMessage

+ +

2 fields

+ +
+ +

`UntypedVersionedMessage` is the generic wrapper for versioned messages The version is included in the `version` integer and the serialized message is contained in `data`. Internally, we use the typed alias `VersionedMessage[ValueClass]` to avoid the risk of confusion between different proto versioned messaged (see, e.g., the return type of the `HasVersionedWrapper.toProtoVersioned` method). The `oneof` prevents the serialized message to be empty if `data` is empty and `version` is 0 (the default value for an integer). Such an empty message cannot be deserialized using previous version of our parsing method. [start UntypedVersionedMessage]

+ + +
+ +
+
+ data + bytes + +
+ +
+ +
+
+ version + int32 + +
+ +
+ +
-| Field | Type | Label | Description | -| --- | --- | --- | --- | -| data | `bytes` | optional | | -| version | `int32` | optional | | + + +
diff --git a/tests/fixtures/characterization/protobuf/expected/packages/daml-platform-v1.mdx b/tests/fixtures/characterization/protobuf/expected/packages/daml-platform-v1.mdx index 348529e..425f543 100644 --- a/tests/fixtures/characterization/protobuf/expected/packages/daml-platform-v1.mdx +++ b/tests/fixtures/characterization/protobuf/expected/packages/daml-platform-v1.mdx @@ -1,79 +1,282 @@ --- title: "daml.platform.v1" -description: "Descriptor-backed protobuf API history for package daml.platform.v1." +description: "Package-level overview for daml.platform.v1." --- -# Package `daml.platform.v1` +

Back to overview

-[Back to Canton Protobuf History](../index) +
+ +

Protobuf Package

+ + +

daml.platform.v1

+ + +

0 services, 0 endpoints, 4 messages

+ + +
+ + gRPC + +
-## Snapshot + +
+ +
+
Files
+
2
+
+ +
+
Services
+
0
+
+ +
+
Endpoints
+
0
+
+ +
+
Messages
+
4
+
+ +
+
Enums
+
0
+
+ +
+ +
-- Current files: `2` -- Current services: `0` -- Current endpoints: `0` -- Current messages: `4` -- Current enums: `0` -- Lifecycle endpoints tracked: `0` ## Source Files -| File | Services | Messages | Enums | Source | -| --- | --- | --- | --- | --- | -| community/ledger/ledger-api-core/src/main/protobuf/daml/platform/v1/index.proto | `0` | `1` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger/ledger-api-core/src/main/protobuf/daml/platform/v1/index.proto#L10) | -| community/ledger/ledger-api-core/src/main/protobuf/daml/platform/v1/page_tokens.proto | `0` | `3` | `0` | [file](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger/ledger-api-core/src/main/protobuf/daml/platform/v1/page_tokens.proto#L4) | -## Type Reference - -**Message `daml.platform.v1.ListPartiesPageTokenPayload`** -- Source: [community/ledger/ledger-api-core/src/main/protobuf/daml/platform/v1/page_tokens.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger/ledger-api-core/src/main/protobuf/daml/platform/v1/page_tokens.proto#L19) -- Fields: 1 +
+ + +
+ +
+

community/ledger/ledger-api-core/src/main/protobuf/daml/platform/v1/index.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
1
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/ledger/ledger-api-core/src/main/protobuf/daml/platform/v1/index.proto
+
+ +
+ + +
+ + + +
+ +
+

community/ledger/ledger-api-core/src/main/protobuf/daml/platform/v1/page_tokens.proto

+ +
+ +

Current source file in the latest published descriptor snapshot.

+ + +
+ +
+
Services
+
0
+
+ +
+
Messages
+
3
+
+ +
+
Enums
+
0
+
+ +
+
Source
+
community/ledger/ledger-api-core/src/main/protobuf/daml/platform/v1/page_tokens.proto
+
+ +
+ + +
+ + +
+ + + + -Describes the payload of a page token for listing parties. - Not intended to be handled directly by clients and should be presented to them as an opaque string. +## Type Inventory -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| party_id_lower_bound_excl | `string` | optional | Parties are ordered by ``party_id``, and the next page starts with parties whose ``party_id`` is larger than ``party_id_lower_bound_excl``. | - -**Message `daml.platform.v1.ListUsersPageTokenPayload`** +These are the package-level message and enum shapes in the publish-version snapshot. -- Source: [community/ledger/ledger-api-core/src/main/protobuf/daml/platform/v1/page_tokens.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger/ledger-api-core/src/main/protobuf/daml/platform/v1/page_tokens.proto#L12) -- Fields: 1 -Describes the payload of a page token for listing users. - Not intended to be handled directly by clients and should be presented to them as an opaque string. -| Field | Type | Label | Description | -| --- | --- | --- | --- | -| user_id_lower_bound_excl | `string` | optional | Users are ordered by ``user_id``, and the next page starts with users whose ``user_id`` is larger than ``user_id_lower_bound_excl``. | - -**Message `daml.platform.v1.ListVettedPackagesPageTokenPayload`** +
+
+

daml.platform.v1.ListPartiesPageTokenPayload

+ +

1 fields

+ +
+ +

Describes the payload of a page token for listing parties. Not intended to be handled directly by clients and should be presented to them as an opaque string.

+ + +
+ +
+
+ party_id_lower_bound_excl + string + +
+ +
Parties are ordered by ``party_id``, and the next page starts with parties whose ``party_id`` is larger than ``party_id_lower_bound_excl``.
+ +
+ +
-- Source: [community/ledger/ledger-api-core/src/main/protobuf/daml/platform/v1/page_tokens.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger/ledger-api-core/src/main/protobuf/daml/platform/v1/page_tokens.proto#L26) -- Fields: 2 + + +
-Describes the payload of a page token for listing vetted packages. - Not intended to be handled directly by clients and should be presented to them as an opaque string. +
+
+

daml.platform.v1.ListUsersPageTokenPayload

+ +

1 fields

+ +
+ +

Describes the payload of a page token for listing users. Not intended to be handled directly by clients and should be presented to them as an opaque string.

+ + +
+ +
+
+ user_id_lower_bound_excl + string + +
+ +
Users are ordered by ``user_id``, and the next page starts with users whose ``user_id`` is larger than ``user_id_lower_bound_excl``.
+ +
+ +
-| Field | Type | Label | Description | -| --- | --- | --- | --- | -| synchronizer_id | `string` | optional | VettedPackages are ordered by ``synchronizer_id`` and then
``participant_id``. The next page starts with VettedPackages messages whose
synchronizer ID is strictly larger ``synchronizer_id``, or whose
synchronizer ID is equal to ``synchronizer_id`` and whose participant ID is
strictly larger than ``participant_id``. | -| participant_id | `string` | optional | | + + +
- -**Message `daml.platform.v1.StatusDetails`** +
+
+

daml.platform.v1.ListVettedPackagesPageTokenPayload

+ +

2 fields

+ +
+ +

Describes the payload of a page token for listing vetted packages. Not intended to be handled directly by clients and should be presented to them as an opaque string.

+ + +
+ +
+
+ synchronizer_id + string + +
+ +
VettedPackages are ordered by ``synchronizer_id`` and then ``participant_id``. The next page starts with VettedPackages messages whose synchronizer ID is strictly larger ``synchronizer_id``, or whose synchronizer ID is equal to ``synchronizer_id`` and whose participant ID is strictly larger than ``participant_id``.
+ +
+ +
+
+ participant_id + string + +
+ +
+ +
-- Source: [community/ledger/ledger-api-core/src/main/protobuf/daml/platform/v1/index.proto](https://github.com/DACH-NY/canton/blob/v3.4.11/community/ledger/ledger-api-core/src/main/protobuf/daml/platform/v1/index.proto#L20) -- Fields: 1 + + +
-Serialized status details, conveyed from the driver `ReadService` to the ledger API client. - To be combined with a status code and message. +
+
+

daml.platform.v1.StatusDetails

+ +

1 fields

+ +
+ +

Serialized status details, conveyed from the driver `ReadService` to the ledger API client. To be combined with a status code and message.

+ + +
+ +
+
+ details + repeated Any + +
+ +
+ +
-| Field | Type | Label | Description | -| --- | --- | --- | --- | -| details | `google.protobuf.Any` | repeated | | + + +
diff --git a/tests/test_asyncapi.py b/tests/test_asyncapi.py index 70a7cad..35321f4 100644 --- a/tests/test_asyncapi.py +++ b/tests/test_asyncapi.py @@ -10,6 +10,7 @@ from x2mdx.asyncapi.lifecycle import build_asyncapi_report_from_sources, parse_asyncapi from x2mdx.asyncapi.models import AsyncApiSourceSnapshot +from x2mdx.asyncapi.render import build_action_operation from x2mdx.cli import main as cli_main @@ -321,7 +322,7 @@ def test_build_report_tracks_channel_changes_and_removals(self) -> None: self.assertEqual(report.per_version_deltas["1.1.0"]["changed_count"], 1) self.assertEqual(report.per_version_deltas["1.1.0"]["removed_count"], 1) - def test_cli_builds_asyncapi_page_and_updates_docs_json(self) -> None: + def test_cli_builds_single_file_asyncapi_page_and_updates_docs_json(self) -> None: manifest_path = self._write_manifest() output_file = self.root / "docs" / "reference" / "asyncapi.mdx" docs_json = self.root / "docs" / "docs.json" @@ -367,11 +368,125 @@ def test_cli_builds_asyncapi_page_and_updates_docs_json(self) -> None: text = output_file.read_text(encoding="utf-8") docs = json.loads(docs_json.read_text(encoding="utf-8")) - self.assertIn("Table of Contents", text) - self.assertIn("Version Change Summary", text) + self.assertIn("### Publish stream", text) + self.assertIn("#### Protocol Details", text) self.assertIn("publish required fields added: `offset`", text) - self.assertIn("**Message Example**", text) + self.assertIn("wscat", text) + self.assertIn("message", text) self.assertEqual( docs["navigation"]["dropdowns"][0]["groups"], [{"group": "JSON Ledger API", "pages": ["reference/asyncapi"]}], ) + + def test_cli_builds_multipage_asyncapi_pages_and_updates_docs_json(self) -> None: + manifest_path = self._write_manifest() + output_dir = self.root / "docs" / "reference" / "asyncapi" + docs_json = self.root / "docs" / "docs.json" + docs_json.parent.mkdir(parents=True, exist_ok=True) + docs_json.write_text( + json.dumps( + { + "navigation": { + "dropdowns": [ + { + "dropdown": "Reference", + "pages": [], + } + ] + } + }, + indent=2, + ) + + "\n", + encoding="utf-8", + ) + + exit_code = cli_main( + [ + "asyncapi", + "build-api-pages-from-manifest", + "--manifest", + str(manifest_path), + "--output-dir", + str(output_dir), + "--overview-name", + "index.mdx", + "--docs-json", + str(docs_json), + "--nav-dropdown", + "Reference", + "--nav-group", + "JSON Ledger API", + ] + ) + + self.assertEqual(exit_code, 0) + overview = (output_dir / "index.mdx").read_text(encoding="utf-8") + channel = (output_dir / "channels" / "stream.mdx").read_text(encoding="utf-8") + action = (output_dir / "operations" / "stream" / "subscribe.mdx").read_text(encoding="utf-8") + docs = json.loads(docs_json.read_text(encoding="utf-8")) + + self.assertIn("## Channels", overview) + self.assertIn("## Actions", channel) + self.assertIn("## Outputs", action) + self.assertIn("wscat", action) + self.assertIn("x2mdx-ref-right-rail", action) + self.assertIn("x2mdx-ref-rail-panel", action) + self.assertIn("```bash wscat", action) + self.assertIn("x2mdx-ref-operation-bar", action) + self.assertIn("/stream", action) + self.assertNotIn("## Overview", action) + self.assertIn("x2mdx-ref-breadcrumbs", action) + self.assertIn('

Subscribe stream

', action) + self.assertNotIn("x2mdx-ref-summary", action) + self.assertNotIn("## Examples", action) + self.assertIn("## Related Schemas", action) + self.assertEqual(action.count('class="x2mdx-ref-schema"'), 1) + self.assertEqual( + docs["navigation"]["dropdowns"][0]["groups"], + [{"group": "JSON Ledger API", "pages": ["reference/asyncapi/index"]}], + ) + + def test_action_adapter_builds_operation_page_context(self) -> None: + channel = build_asyncapi_report_from_sources( + [ + self._snapshot( + "1.1.0", + "published/1.1.0/asyncapi.yaml", + """ + asyncapi: 2.6.0 + info: + title: Sample WebSocket API + version: 1.1.0 + channels: + /updates: + subscribe: + operationId: onUpdates + bindings: + ws: + method: GET + message: + contentType: application/json + payload: + type: object + required: [id] + properties: + id: + type: string + """, + ) + ], + source_name="unit test fixtures", + version_filter="unit test versions", + publish_version="1.1.0", + ).channels[0] + + operation = build_action_operation(channel, channel.latest["actions"][0], output_dir=None) + + self.assertEqual(operation.anchor, "operation-updates-subscribe") + self.assertEqual(operation.operation_method, "SUBSCRIBE") + self.assertEqual(operation.operation_target, "/updates") + self.assertEqual(operation.related_schemas[0].name, "-") + self.assertEqual(operation.outputs[0].schema.name, "-") + self.assertEqual(operation.examples[0].title, "wscat") + self.assertIn("npx wscat -c ", operation.examples[0].body) diff --git a/tests/test_characterization_preview.py b/tests/test_characterization_preview.py index 252cb7e..88d0e24 100644 --- a/tests/test_characterization_preview.py +++ b/tests/test_characterization_preview.py @@ -77,7 +77,7 @@ def test_build_preview_site_writes_docs_json_and_expected_pages(self) -> None: openrpc_alt_spec = ( output_root / "reference" / "wallet-gateway-json-rpc-alt" / "rpc-specs" / "user-api.mdx" ).read_text(encoding="utf-8") - self.assertIn("[Back to overview](/reference/wallet-gateway-json-rpc-alt)", openrpc_alt_spec) + self.assertIn('href="/reference/wallet-gateway-json-rpc-alt/wallet-gateway-overview"', openrpc_alt_spec) if __name__ == "__main__": diff --git a/tests/test_openrpc.py b/tests/test_openrpc.py index e6bf580..e8efcc5 100644 --- a/tests/test_openrpc.py +++ b/tests/test_openrpc.py @@ -11,6 +11,7 @@ from x2mdx.cli import main as cli_main from x2mdx.openrpc.lifecycle import build_openrpc_report_from_sources, parse_openrpc from x2mdx.openrpc.models import OpenRpcSourceSnapshot +from x2mdx.openrpc.render import build_method_page def write_text(path: Path, contents: str) -> None: @@ -365,13 +366,27 @@ def test_cli_builds_openrpc_pages(self) -> None: self.assertEqual(exit_code, 0, stdout.getvalue()) overview = (output_dir / "index.mdx").read_text(encoding="utf-8") dapp_page = (output_dir / "specs" / "dapp-api.mdx").read_text(encoding="utf-8") - remote_page = (output_dir / "specs" / "remote-dapp-api.mdx").read_text(encoding="utf-8") + status_page = (output_dir / "operations" / "dapp-api" / "status.mdx").read_text(encoding="utf-8") + remote_page = (output_dir / "operations" / "remote-dapp-api" / "status.mdx").read_text(encoding="utf-8") self.assertIn("Wallet Gateway OpenRPC", overview) - self.assertIn("Table of Contents", overview) - self.assertIn("## Version Change Timeline", dapp_page) + self.assertIn('class="x2mdx-ref-card"', overview) + self.assertIn("## Specs", overview) self.assertIn("## Methods", dapp_page) - self.assertIn("Result Example", dapp_page) + self.assertIn("Method pages are the primary reference surface", dapp_page) + self.assertIn("## Protocol Details", status_page) + self.assertIn("## Inputs", status_page) + self.assertIn("## Outputs", status_page) + self.assertIn("x2mdx-ref-breadcrumbs", status_page) + self.assertIn('

status

', status_page) + self.assertNotIn("x2mdx-ref-summary", status_page) + self.assertIn("x2mdx-ref-operation-bar", status_page) + self.assertIn("JSON-RPC", status_page) + self.assertNotIn("## Overview", status_page) + self.assertIn("curl", status_page) + self.assertIn("", status_page) + self.assertIn("## Related Schemas", status_page) + self.assertEqual(status_page.count('class="x2mdx-ref-schema"'), 1) self.assertIn("required fields", remote_page) def test_cli_uses_root_relative_link_prefix_for_overview_and_spec_links(self) -> None: @@ -396,6 +411,55 @@ def test_cli_uses_root_relative_link_prefix_for_overview_and_spec_links(self) -> self.assertEqual(exit_code, 0) overview = (output_dir / "index.mdx").read_text(encoding="utf-8") spec_page = (output_dir / "specs" / "dapp-api.mdx").read_text(encoding="utf-8") + operation_page = (output_dir / "operations" / "dapp-api" / "status.mdx").read_text(encoding="utf-8") - self.assertIn("[`Dapp API`](/reference/wallet-gateway-json-rpc/specs/dapp-api)", overview) - self.assertIn("[Back to overview](/reference/wallet-gateway-json-rpc)", spec_page) + self.assertIn('href="/reference/wallet-gateway-json-rpc/specs/dapp-api"', overview) + self.assertIn('href="/reference/wallet-gateway-json-rpc/index"', spec_page) + self.assertIn('href="/reference/wallet-gateway-json-rpc/specs/dapp-api"', operation_page) + self.assertIn("x2mdx-ref-right-rail", operation_page) + self.assertIn("x2mdx-ref-rail-panel", operation_page) + self.assertIn("```bash cURL", operation_page) + self.assertNotIn("## Examples", operation_page) + + def test_method_adapter_builds_operation_page_context(self) -> None: + method = self._snapshot( + version="1.1.0", + spec_id="dapp-api", + display_name="Dapp API", + source_path="api-specs/openrpc-dapp-api.json", + contents=""" + { + "openrpc": "1.2.6", + "info": {"title": "Dapp API", "version": "1.1.0"}, + "methods": [ + { + "name": "status", + "description": "Return wallet provider status.", + "params": [], + "result": { + "name": "result", + "schema": {"type": "object", "required": ["connected"], "properties": {"connected": {"type": "boolean"}}} + } + } + ] + } + """, + ) + report = build_openrpc_report_from_sources( + [method], + source_name="unit test snapshots", + version_filter="unit test versions", + publish_version="1.1.0", + ) + spec = report.specs[0] + page = build_method_page(spec, spec.methods[0], output_dir=self.root / "out", spec_dir_name="specs") + + self.assertEqual(page.path, "operations/dapp-api/status.mdx") + self.assertEqual(page.badges[0].label, "JSON-RPC") + self.assertEqual(page.operation_method, "POST") + self.assertEqual(page.operation_target, "JSON-RPC status") + self.assertEqual(page.related_schemas[0].name, "result") + self.assertEqual(page.outputs[0].schema.name, "result") + self.assertEqual(page.examples[0].title, "cURL") + self.assertIn('"method": "status"', page.examples[0].body) + self.assertEqual(page.examples[1].title, "Result") diff --git a/tests/test_protobuf.py b/tests/test_protobuf.py index 5c101e2..b84ff5b 100644 --- a/tests/test_protobuf.py +++ b/tests/test_protobuf.py @@ -10,6 +10,7 @@ from x2mdx.cli import main as cli_main from x2mdx.protobuf.lifecycle import build_protobuf_history_report_from_sources +from x2mdx.protobuf.render import build_operation_page from x2mdx.protobuf.snapshots import load_protobuf_sources @@ -175,16 +176,94 @@ def test_cli_builds_overview_and_package_pages(self) -> None: / "packages" / "com-example-v1.mdx" ).read_text(encoding="utf-8") + operation_text = ( + output_dir + / "operations" + / "com-example-v1" + / "exampleservice" + / "getfoo.mdx" + ).read_text(encoding="utf-8") - self.assertIn("Canton Protobuf History", overview_text) - self.assertIn("Table of Contents", overview_text) - self.assertIn("Release Summary", overview_text) - self.assertIn("## Reference", overview_text) + self.assertIn("Canton Protobuf Reference", overview_text) + self.assertIn("## Release Summary", overview_text) self.assertIn("com.example.v1", overview_text) - self.assertIn("(protobuf-history/packages/com-example-v1)", overview_text) - self.assertIn("### Service `ExampleService`", package_text) - self.assertIn("**Endpoint `ExampleService.GetFoo`**", package_text) - self.assertIn("rpc ExampleService.GetFoo", package_text) - self.assertIn("## Type Reference", package_text) - self.assertIn("**Message `com.example.v1.FooResponseV2`**", package_text) + self.assertIn('href="packages/com-example-v1"', overview_text) + self.assertIn("## ExampleService", package_text) + self.assertIn("ExampleService.GetFoo", package_text) + self.assertIn("## Protocol Details", operation_text) + self.assertIn("
Service
", operation_text) + self.assertIn("
ExampleService
", operation_text) + self.assertIn("x2mdx-ref-right-rail", operation_text) + self.assertIn("x2mdx-ref-rail-panel", operation_text) + self.assertIn("```bash grpcurl", operation_text) + self.assertIn("x2mdx-ref-breadcrumbs", operation_text) + self.assertIn('

GetFoo

', operation_text) + self.assertNotIn("x2mdx-ref-summary", operation_text) + self.assertIn("x2mdx-ref-operation-bar", operation_text) + self.assertIn("/com.example.v1.ExampleService/GetFoo", operation_text) + self.assertNotIn("## Overview", operation_text) + self.assertIn("grpcurl", operation_text) + self.assertIn("```json OK", operation_text) + self.assertIn("x2mdx-ref-response-label", operation_text) + self.assertIn("", operation_text) + self.assertIn("## Related Schemas", operation_text) + self.assertIn("", operation_text) + self.assertIn("com.example.v1.FooResponseV2", operation_text) + self.assertEqual(operation_text.count('class="x2mdx-ref-schema"'), 2) self.assertFalse(stale_endpoint_file.exists()) + + def test_operation_adapter_collects_request_and_response_schemas(self) -> None: + ctx = { + "messages": { + "com.example.v1.FooRequest": { + "id": "com.example.v1.FooRequest", + "description": "", + "fieldIds": ["request:id"], + "enumIds": [], + "nestedMessageIds": [], + }, + "com.example.v1.FooResponse": { + "id": "com.example.v1.FooResponse", + "description": "", + "fieldIds": ["response:name"], + "enumIds": [], + "nestedMessageIds": [], + }, + }, + "fields": { + "request:id": {"name": "id", "type": "string", "label": "optional", "description": ""}, + "response:name": {"name": "name", "type": "string", "label": "optional", "description": ""}, + }, + "enums": {}, + "enumValues": {}, + } + endpoint = { + "service": "ExampleService", + "name": "GetFoo", + "requestType": "com.example.v1.FooRequest", + "responseType": "com.example.v1.FooResponse", + "clientStreaming": False, + "serverStreaming": False, + "description": "Fetch a foo.", + "file": "com/example/service.proto", + "sourceUrl": None, + } + lifecycle = { + "introducedIn": "1.0.0", + "removedIn": None, + "history": [{"version": "1.0.0", "changeTypes": ["added"], "kind": "added"}], + } + + page = build_operation_page("com.example.v1", endpoint, lifecycle, output_dir=self.root / "out", ctx=ctx) + + self.assertEqual(page.path, "operations/com-example-v1/exampleservice/getfoo.mdx") + self.assertEqual(page.title, "GetFoo") + self.assertEqual(page.operation_method, "RPC") + self.assertEqual(page.operation_target, "/com.example.v1.ExampleService/GetFoo") + self.assertEqual([schema.name for schema in page.related_schemas], ["com.example.v1.FooRequest", "com.example.v1.FooResponse"]) + self.assertEqual(page.examples[0].title, "grpcurl") + self.assertEqual(page.examples[1].title, "OK") + self.assertEqual(page.examples[1].kind, "response") + self.assertIn("com.example.v1.ExampleService/GetFoo", page.examples[0].body) + self.assertIn('"id": "string"', page.examples[0].body) + self.assertIn('"name": "string"', page.examples[1].body) From 09dcf2487f2758e830767f2c2b6891610a116371 Mon Sep 17 00:00:00 2001 From: danielporterda Date: Mon, 27 Apr 2026 15:26:01 -0400 Subject: [PATCH 2/3] Render operation examples in right rail shell --- src/x2mdx/templates/reference/operation.md.j2 | 9 +- .../operations/dapp-api/accountschanged.mdx | 118 ++++---- .../expected/operations/dapp-api/connect.mdx | 102 ++++--- .../operations/dapp-api/disconnect.mdx | 96 +++--- .../operations/dapp-api/getactivenetwork.mdx | 100 ++++--- .../operations/dapp-api/getprimaryaccount.mdx | 114 ++++---- .../operations/dapp-api/ledgerapi.mdx | 112 +++---- .../operations/dapp-api/listaccounts.mdx | 118 ++++---- .../operations/dapp-api/prepareexecute.mdx | 106 +++---- .../dapp-api/prepareexecuteandwait.mdx | 124 ++++---- .../operations/dapp-api/signmessage.mdx | 110 +++---- .../expected/operations/dapp-api/status.mdx | 112 +++---- .../operations/dapp-api/txchanged.mdx | 102 ++++--- .../dapp-remote-api/accountschanged.mdx | 118 ++++---- .../operations/dapp-remote-api/connect.mdx | 102 ++++--- .../operations/dapp-remote-api/connected.mdx | 112 +++---- .../operations/dapp-remote-api/disconnect.mdx | 96 +++--- .../dapp-remote-api/getactivenetwork.mdx | 100 ++++--- .../dapp-remote-api/getprimaryaccount.mdx | 114 ++++---- .../operations/dapp-remote-api/ledgerapi.mdx | 112 +++---- .../dapp-remote-api/listaccounts.mdx | 118 ++++---- .../dapp-remote-api/onstatuschanged.mdx | 112 +++---- .../dapp-remote-api/prepareexecute.mdx | 110 +++---- .../dapp-remote-api/signmessage.mdx | 110 +++---- .../operations/dapp-remote-api/status.mdx | 112 +++---- .../operations/dapp-remote-api/txchanged.mdx | 102 ++++--- .../operations/signing-api/createkey.mdx | 112 +++---- .../signing-api/getconfiguration.mdx | 96 +++--- .../operations/signing-api/getkeys.mdx | 102 ++++--- .../operations/signing-api/gettransaction.mdx | 112 +++---- .../signing-api/gettransactions.mdx | 122 ++++---- .../signing-api/setconfiguration.mdx | 102 ++++--- .../signing-api/signtransaction.mdx | 120 ++++---- .../signing-api/subscribetransactions.mdx | 116 ++++---- .../expected/operations/user-api/addidp.mdx | 114 ++++---- .../operations/user-api/addnetwork.mdx | 130 +++++---- .../operations/user-api/addsession.mdx | 150 +++++----- .../user-api/allocatepartyforwallet.mdx | 128 ++++---- .../operations/user-api/createwallet.mdx | 130 +++++---- .../operations/user-api/deletetransaction.mdx | 106 +++---- .../expected/operations/user-api/execute.mdx | 112 +++---- .../operations/user-api/gettransaction.mdx | 116 ++++---- .../expected/operations/user-api/getuser.mdx | 102 ++++--- .../user-api/iswalletsyncneeded.mdx | 100 ++++--- .../expected/operations/user-api/listidps.mdx | 112 +++---- .../operations/user-api/listnetworks.mdx | 128 ++++---- .../operations/user-api/listsessions.mdx | 138 ++++----- .../operations/user-api/listtransactions.mdx | 114 ++++---- .../operations/user-api/listwallets.mdx | 142 ++++----- .../operations/user-api/removeidp.mdx | 106 +++---- .../operations/user-api/removenetwork.mdx | 106 +++---- .../operations/user-api/removesession.mdx | 96 +++--- .../operations/user-api/removewallet.mdx | 106 +++---- .../operations/user-api/setprimarywallet.mdx | 106 +++---- .../expected/operations/user-api/sign.mdx | 120 ++++---- .../operations/user-api/syncwallets.mdx | 170 ++++++----- .../operations/dapp-api/accountschanged.mdx | 118 ++++---- .../operations/dapp-api/connect.mdx | 102 ++++--- .../operations/dapp-api/disconnect.mdx | 96 +++--- .../operations/dapp-api/getactivenetwork.mdx | 100 ++++--- .../operations/dapp-api/getprimaryaccount.mdx | 114 ++++---- .../operations/dapp-api/ledgerapi.mdx | 112 +++---- .../operations/dapp-api/listaccounts.mdx | 118 ++++---- .../operations/dapp-api/prepareexecute.mdx | 106 +++---- .../dapp-api/prepareexecuteandwait.mdx | 124 ++++---- .../operations/dapp-api/signmessage.mdx | 110 +++---- .../operations/dapp-api/status.mdx | 112 +++---- .../operations/dapp-api/txchanged.mdx | 102 ++++--- .../dapp-remote-api/accountschanged.mdx | 118 ++++---- .../operations/dapp-remote-api/connect.mdx | 102 ++++--- .../operations/dapp-remote-api/connected.mdx | 112 +++---- .../operations/dapp-remote-api/disconnect.mdx | 96 +++--- .../dapp-remote-api/getactivenetwork.mdx | 100 ++++--- .../dapp-remote-api/getprimaryaccount.mdx | 114 ++++---- .../operations/dapp-remote-api/ledgerapi.mdx | 112 +++---- .../dapp-remote-api/listaccounts.mdx | 118 ++++---- .../dapp-remote-api/onstatuschanged.mdx | 112 +++---- .../dapp-remote-api/prepareexecute.mdx | 110 +++---- .../dapp-remote-api/signmessage.mdx | 110 +++---- .../operations/dapp-remote-api/status.mdx | 112 +++---- .../operations/dapp-remote-api/txchanged.mdx | 102 ++++--- .../operations/signing-api/createkey.mdx | 112 +++---- .../signing-api/getconfiguration.mdx | 96 +++--- .../operations/signing-api/getkeys.mdx | 102 ++++--- .../operations/signing-api/gettransaction.mdx | 112 +++---- .../signing-api/gettransactions.mdx | 122 ++++---- .../signing-api/setconfiguration.mdx | 102 ++++--- .../signing-api/signtransaction.mdx | 120 ++++---- .../signing-api/subscribetransactions.mdx | 116 ++++---- .../operations/user-api/addidp.mdx | 114 ++++---- .../operations/user-api/addnetwork.mdx | 130 +++++---- .../operations/user-api/addsession.mdx | 150 +++++----- .../user-api/allocatepartyforwallet.mdx | 128 ++++---- .../operations/user-api/createwallet.mdx | 130 +++++---- .../operations/user-api/deletetransaction.mdx | 106 +++---- .../operations/user-api/execute.mdx | 112 +++---- .../operations/user-api/gettransaction.mdx | 116 ++++---- .../operations/user-api/getuser.mdx | 102 ++++--- .../user-api/iswalletsyncneeded.mdx | 100 ++++--- .../operations/user-api/listidps.mdx | 112 +++---- .../operations/user-api/listnetworks.mdx | 128 ++++---- .../operations/user-api/listsessions.mdx | 138 ++++----- .../operations/user-api/listtransactions.mdx | 114 ++++---- .../operations/user-api/listwallets.mdx | 142 ++++----- .../operations/user-api/removeidp.mdx | 106 +++---- .../operations/user-api/removenetwork.mdx | 106 +++---- .../operations/user-api/removesession.mdx | 96 +++--- .../operations/user-api/removewallet.mdx | 106 +++---- .../operations/user-api/setprimarywallet.mdx | 106 +++---- .../operations/user-api/sign.mdx | 120 ++++---- .../operations/user-api/syncwallets.mdx | 170 ++++++----- .../getcommandstatus.mdx | 200 +++++++------ .../createidentityproviderconfig.mdx | 122 ++++---- .../deleteidentityproviderconfig.mdx | 94 +++--- .../getidentityproviderconfig.mdx | 110 +++---- .../listidentityproviderconfigs.mdx | 110 +++---- .../updateidentityproviderconfig.mdx | 124 ++++---- .../listknownpackages.mdx | 110 +++---- .../updatevettedpackages.mdx | 196 +++++++------ .../uploaddarfile.mdx | 100 ++++--- .../validatedarfile.mdx | 98 ++++--- .../participantpruningservice/prune.mdx | 98 ++++--- .../allocateexternalparty.mdx | 142 ++++----- .../partymanagementservice/allocateparty.mdx | 144 ++++----- .../generateexternalpartytopology.mdx | 136 +++++---- .../getparticipantid.mdx | 94 +++--- .../partymanagementservice/getparties.mdx | 132 +++++---- .../listknownparties.mdx | 134 +++++---- .../updatepartydetails.mdx | 148 +++++----- .../updatepartyidentityproviderid.mdx | 98 ++++--- .../usermanagementservice/createuser.mdx | 160 +++++----- .../usermanagementservice/deleteuser.mdx | 96 +++--- .../usermanagementservice/getuser.mdx | 126 ++++---- .../usermanagementservice/grantuserrights.mdx | 118 ++++---- .../usermanagementservice/listuserrights.mdx | 108 +++---- .../usermanagementservice/listusers.mdx | 134 +++++---- .../revokeuserrights.mdx | 118 ++++---- .../usermanagementservice/updateuser.mdx | 152 +++++----- .../updateuseridentityproviderid.mdx | 98 ++++--- .../executesubmission.mdx | 218 +++++++------- .../executesubmissionandwait.mdx | 224 +++++++------- ...executesubmissionandwaitfortransaction.mdx | 276 +++++++++--------- .../getpreferredpackages.mdx | 130 +++++---- .../getpreferredpackageversion.mdx | 122 ++++---- .../preparesubmission.mdx | 250 ++++++++-------- .../completionstream.mdx | 128 ++++---- .../commandservice/submitandwait.mdx | 130 +++++---- .../submitandwaitforreassignment.mdx | 220 +++++++------- .../submitandwaitfortransaction.mdx | 222 +++++++------- .../commandsubmissionservice/submit.mdx | 124 ++++---- .../submitreassignment.mdx | 124 ++++---- .../contractservice/getcontract.mdx | 134 +++++---- .../geteventsbycontractid.mdx | 208 ++++++------- .../packageservice/getpackage.mdx | 102 ++++--- .../packageservice/getpackagestatus.mdx | 98 ++++--- .../packageservice/listpackages.mdx | 98 ++++--- .../packageservice/listvettedpackages.mdx | 164 ++++++----- .../stateservice/getactivecontracts.mdx | 182 ++++++------ .../getconnectedsynchronizers.mdx | 114 ++++---- .../stateservice/getlatestprunedoffsets.mdx | 96 +++--- .../stateservice/getledgerend.mdx | 94 +++--- .../updateservice/getupdatebyid.mdx | 228 ++++++++------- .../updateservice/getupdatebyoffset.mdx | 228 ++++++++------- .../updateservice/getupdates.mdx | 232 ++++++++------- .../versionservice/getledgerapiversion.mdx | 142 ++++----- .../statusservice/getlasterrors.mdx | 104 ++++--- .../statusservice/getlasterrortrace.mdx | 102 ++++--- .../statusservice/healthdump.mdx | 100 ++++--- .../statusservice/setloglevel.mdx | 94 +++--- .../mediatorstatusservice/mediatorstatus.mdx | 144 ++++----- .../setpassive.mdx | 90 +++--- .../packageservice/getdar.mdx | 110 +++---- .../packageservice/getdarcontents.mdx | 126 ++++---- .../packageservice/getpackagecontents.mdx | 124 ++++---- .../packageservice/getpackagereferences.mdx | 112 +++---- .../packageservice/listdars.mdx | 114 ++++---- .../packageservice/listpackages.mdx | 116 ++++---- .../packageservice/removedar.mdx | 94 +++--- .../packageservice/removepackage.mdx | 100 ++++--- .../packageservice/unvetdar.mdx | 96 +++--- .../packageservice/uploaddar.mdx | 120 ++++---- .../packageservice/validatedar.mdx | 102 ++++--- .../packageservice/vetdar.mdx | 98 ++++--- .../countinflight.mdx | 100 ++++--- .../getconfigforslowcounterparticipants.mdx | 130 +++++---- ...tintervalsbehindforcounterparticipants.mdx | 126 ++++---- .../inspectcommitmentcontracts.mdx | 110 +++---- .../lookupoffsetbytime.mdx | 98 ++++--- .../lookupreceivedacscommitments.mdx | 160 +++++----- .../lookupsentacscommitments.mdx | 160 +++++----- .../opencommitment.mdx | 106 +++---- .../setconfigforslowcounterparticipants.mdx | 122 ++++---- .../changeassignation.mdx | 110 +++---- .../participantrepairservice/exportacs.mdx | 128 ++++---- .../participantrepairservice/exportacsold.mdx | 112 +++---- .../participantrepairservice/ignoreevents.mdx | 100 ++++--- .../participantrepairservice/importacs.mdx | 152 +++++----- .../participantrepairservice/importacsold.mdx | 112 +++---- .../migratesynchronizer.mdx | 174 +++++------ .../purgecontracts.mdx | 102 ++++--- .../purgedeactivatedsynchronizer.mdx | 94 +++--- .../repaircommitmentsusingacs.mdx | 126 ++++---- .../rollbackunassignment.mdx | 98 ++++--- .../unignoreevents.mdx | 100 ++++--- .../participantstatus.mdx | 160 +++++----- .../partymanagementservice/addpartyasync.mdx | 106 +++---- .../clearpartyonboardingflag.mdx | 106 +++---- .../partymanagementservice/exportpartyacs.mdx | 108 +++---- .../getaddpartystatus.mdx | 114 ++++---- .../gethighestoffsetbytimestamp.mdx | 102 ++++--- .../partymanagementservice/importpartyacs.mdx | 134 +++++---- .../pingservice/ping.mdx | 124 ++++---- .../pruningservice/clearschedule.mdx | 90 +++--- .../getnowaitcommitmentsfrom.mdx | 146 ++++----- .../pruningservice/getparticipantschedule.mdx | 108 +++---- .../pruningservice/getsafepruningoffset.mdx | 102 ++++--- .../pruningservice/getschedule.mdx | 102 ++++--- .../pruningservice/prune.mdx | 96 +++--- .../resetnowaitcommitmentsfrom.mdx | 104 ++++--- .../pruningservice/setcron.mdx | 94 +++--- .../pruningservice/setmaxduration.mdx | 94 +++--- .../setnowaitcommitmentsfrom.mdx | 104 ++++--- .../pruningservice/setparticipantschedule.mdx | 108 +++---- .../pruningservice/setretention.mdx | 94 +++--- .../pruningservice/setschedule.mdx | 102 ++++--- .../getresourcelimits.mdx | 102 ++++--- .../setresourcelimits.mdx | 102 ++++--- .../connectsynchronizer.mdx | 176 +++++------ .../disconnectallsynchronizers.mdx | 90 +++--- .../disconnectsynchronizer.mdx | 94 +++--- .../getsynchronizerid.mdx | 100 ++++--- .../listconnectedsynchronizers.mdx | 108 +++---- .../listregisteredsynchronizers.mdx | 150 +++++----- .../logout.mdx | 94 +++--- .../modifysynchronizer.mdx | 174 +++++------ .../reconnectsynchronizer.mdx | 100 ++++--- .../reconnectsynchronizers.mdx | 94 +++--- .../registersynchronizer.mdx | 174 +++++------ .../trafficcontrolstate.mdx | 112 +++---- .../sequencerstatus.mdx | 178 +++++------ .../apiinfoservice/getapiinfo.mdx | 94 +++--- .../vaultservice/deletekeypair.mdx | 94 +++--- .../vaultservice/exportkeypair.mdx | 102 ++++--- .../vaultservice/generateencryptionkey.mdx | 110 +++---- .../vaultservice/generatesigningkey.mdx | 122 ++++---- .../vaultservice/getwrapperkeyid.mdx | 94 +++--- .../vaultservice/importkeypair.mdx | 98 ++++--- .../vaultservice/importpublickey.mdx | 100 ++++--- .../vaultservice/listmykeys.mdx | 138 ++++----- .../vaultservice/listpublickeys.mdx | 146 ++++----- .../vaultservice/registerkmsencryptionkey.mdx | 110 +++---- .../vaultservice/registerkmssigningkey.mdx | 122 ++++---- .../vaultservice/rotatewrapperkey.mdx | 94 +++--- .../clearschedule.mdx | 90 +++--- .../findpruningtimestamp.mdx | 98 ++++--- .../getschedule.mdx | 102 ++++--- .../mediatoradministrationservice/prune.mdx | 94 +++--- .../mediatoradministrationservice/setcron.mdx | 94 +++--- .../setmaxduration.mdx | 94 +++--- .../setretention.mdx | 94 +++--- .../setschedule.mdx | 102 ++++--- .../initializemediator.mdx | 150 +++++----- .../mediatorinspectionservice/verdicts.mdx | 160 +++++----- .../getconnection.mdx | 146 ++++----- .../sequencerconnectionservice/logout.mdx | 90 +++--- .../setconnection.mdx | 148 +++++----- .../disablemember.mdx | 94 +++--- .../generateauthenticationtoken.mdx | 102 ++++--- .../onboardingstate.mdx | 100 ++++--- .../onboardingstatev2.mdx | 100 ++++--- .../pruningstatus.mdx | 116 ++++---- .../settrafficpurchased.mdx | 98 ++++--- .../snapshot.mdx | 196 +++++++------ .../trafficcontrolstate.mdx | 126 ++++---- .../addpeerendpoint.mdx | 106 +++---- .../getorderingtopology.mdx | 100 ++++--- .../getpeernetworkstatus.mdx | 140 ++++----- .../removepeerendpoint.mdx | 106 +++---- .../setperformancemetricsenabled.mdx | 94 +++--- .../bftprune.mdx | 100 ++++--- .../bftpruningstatus.mdx | 102 ++++--- .../clearschedule.mdx | 90 +++--- .../getbftschedule.mdx | 108 +++---- .../getschedule.mdx | 102 ++++--- .../setbftschedule.mdx | 108 +++---- .../setcron.mdx | 94 +++--- .../setmaxduration.mdx | 94 +++--- .../setminblockstokeep.mdx | 94 +++--- .../setretention.mdx | 94 +++--- .../setschedule.mdx | 102 ++++--- .../initializesequencerfromgenesisstate.mdx | 164 ++++++----- .../initializesequencerfromgenesisstatev2.mdx | 164 ++++++----- ...initializesequencerfromonboardingstate.mdx | 100 ++++--- ...itializesequencerfromonboardingstatev2.mdx | 100 ++++--- .../initializesequencerfrompredecessor.mdx | 160 +++++----- .../clearschedule.mdx | 90 +++--- .../findpruningtimestamp.mdx | 98 ++++--- .../getschedule.mdx | 102 ++++--- .../prune.mdx | 98 ++++--- .../setcron.mdx | 94 +++--- .../setmaxduration.mdx | 94 +++--- .../setretention.mdx | 94 +++--- .../setschedule.mdx | 102 ++++--- .../authenticate.mdx | 132 +++++---- .../challenge.mdx | 110 +++---- .../sequencerauthenticationservice/logout.mdx | 94 +++--- .../connecttosequencerchannel.mdx | 124 ++++---- .../sequencerchannelservice/ping.mdx | 90 +++--- .../getsynchronizerid.mdx | 96 +++--- .../getsynchronizerparameters.mdx | 156 +++++----- .../sequencerconnectservice/handshake.mdx | 106 +++---- ...registeronboardingtopologytransactions.mdx | 170 ++++++----- .../sequencerconnectservice/verifyactive.mdx | 98 ++++--- .../sequencerservice/acknowledgesigned.mdx | 94 +++--- .../downloadtopologystateforinit.mdx | 120 ++++---- .../downloadtopologystateforinithash.mdx | 98 ++++--- .../sequencerservice/gettime.mdx | 94 +++--- .../gettrafficstateformember.mdx | 114 ++++---- .../sequencerservice/sendasync.mdx | 94 +++--- .../sequencerservice/subscribe.mdx | 110 +++---- .../readordered.mdx | 112 +++---- .../standalonebftorderingservice/send.mdx | 100 ++++--- .../bftorderingservice/receive.mdx | 160 +++++----- .../synchronizertimeservice/awaittime.mdx | 100 ++++--- .../synchronizertimeservice/fetchtime.mdx | 104 ++++--- .../currenttime.mdx | 94 +++--- .../identityinitializationservice/getid.mdx | 96 +++--- .../identityinitializationservice/initid.mdx | 174 +++++------ .../listkeyowners.mdx | 160 +++++----- .../listparties.mdx | 142 ++++----- .../exporttopologysnapshot.mdx | 126 ++++---- .../exporttopologysnapshotv2.mdx | 126 ++++---- .../genesisstate.mdx | 106 +++---- .../genesisstatev2.mdx | 106 +++---- .../topologymanagerreadservice/listall.mdx | 144 ++++----- .../listavailablestores.mdx | 102 ++++--- .../listdecentralizednamespacedefinition.mdx | 166 ++++++----- .../listmediatorsynchronizerstate.mdx | 174 +++++------ .../listnamespacedelegation.mdx | 182 ++++++------ .../listownertokeymapping.mdx | 170 ++++++----- .../listparticipantsynchronizerpermission.mdx | 170 ++++++----- .../listpartyhostinglimits.mdx | 160 +++++----- .../listpartytokeymapping.mdx | 182 ++++++------ .../listpartytoparticipant.mdx | 188 ++++++------ .../listsequencerconnectionsuccessor.mdx | 166 ++++++----- .../listsequencersynchronizerstate.mdx | 172 +++++------ .../listsynchronizerparametersstate.mdx | 172 +++++------ .../listsynchronizertrustcertificate.mdx | 166 ++++++----- .../listsynchronizerupgradeannouncement.mdx | 160 +++++----- .../listvettedpackages.mdx | 178 +++++------ .../logicalupgradestate.mdx | 96 +++--- .../addtransactions.mdx | 184 ++++++------ .../topologymanagerwriteservice/authorize.mdx | 214 +++++++------- .../createtemporarytopologystore.mdx | 104 ++++--- .../droptemporarytopologystore.mdx | 98 ++++--- .../generatetransactions.mdx | 140 ++++----- .../importtopologysnapshot.mdx | 104 ++++--- .../importtopologysnapshotv2.mdx | 104 ++++--- .../signtransactions.mdx | 268 ++++++++--------- 359 files changed, 23127 insertions(+), 20256 deletions(-) diff --git a/src/x2mdx/templates/reference/operation.md.j2 b/src/x2mdx/templates/reference/operation.md.j2 index cba3716..75a3a81 100644 --- a/src/x2mdx/templates/reference/operation.md.j2 +++ b/src/x2mdx/templates/reference/operation.md.j2 @@ -1,7 +1,14 @@ {% import "shared/reference_macros.md.j2" as ref %}
+ +
+
+ {{ ref.breadcrumbs(page.breadcrumbs) }} {{ ref.header(page.eyebrow, page.title, page.summary, None, None, page.badges, [], render_title=True, render_summary=False) }} {{ ref.operation_bar(page) }} -{{ ref.operation_right_rail(page) }} {{ ref.operation_sections(page, include_examples=False) }} + +
+{{ ref.operation_right_rail(page) }} +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/accountschanged.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/accountschanged.mdx index d417d11..cf82da0 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/accountschanged.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/accountschanged.mdx @@ -4,6 +4,10 @@ title: "accountsChanged"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "accountsChanged" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -[ - { - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" - } -] -``` - -
-
- -
- ## Protocol Details @@ -232,3 +181,62 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "accountsChanged" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +[ + { + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" + } +] +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/connect.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/connect.mdx index e7d94f0..01a027e 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/connect.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/connect.mdx @@ -4,6 +4,10 @@ title: "connect"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "connect" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "isConnected": "", - "isNetworkConnected": "" -} -``` - -
-
- -
- ## Protocol Details @@ -251,3 +208,54 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "connect" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "isConnected": "", + "isNetworkConnected": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/disconnect.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/disconnect.mdx index 1caf74e..1b2918e 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/disconnect.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/disconnect.mdx @@ -4,6 +4,10 @@ title: "disconnect"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "disconnect" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -"" -``` - -
-
- -
- ## Protocol Details @@ -191,3 +151,51 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "disconnect" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +"" +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/getactivenetwork.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/getactivenetwork.mdx index a54e024..1cd312d 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/getactivenetwork.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/getactivenetwork.mdx @@ -4,6 +4,10 @@ title: "getActiveNetwork"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getActiveNetwork" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "networkId": "" -} -``` - -
-
- -
- ## Protocol Details @@ -228,3 +186,53 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "getActiveNetwork" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "networkId": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/getprimaryaccount.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/getprimaryaccount.mdx index da12ec3..c5602ec 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/getprimaryaccount.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/getprimaryaccount.mdx @@ -4,6 +4,10 @@ title: "getPrimaryAccount"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getPrimaryAccount" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" -} -``` - -
-
- -
- ## Protocol Details @@ -389,3 +340,60 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "getPrimaryAccount" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/ledgerapi.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/ledgerapi.mdx index 8770e51..555a77b 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/ledgerapi.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/ledgerapi.mdx @@ -4,6 +4,10 @@ title: "ledgerApi"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "ledgerApi", - "params": { - "params": { - "requestMethod": "", - "resource": "" - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "response": "" -} -``` - -
-
- -
- ## Protocol Details @@ -331,3 +283,59 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "ledgerApi", + "params": { + "params": { + "requestMethod": "", + "resource": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "response": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/listaccounts.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/listaccounts.mdx index 7487e9a..a2380f2 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/listaccounts.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/listaccounts.mdx @@ -4,6 +4,10 @@ title: "listAccounts"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "listAccounts" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -[ - { - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" - } -] -``` - -
-
- -
- ## Protocol Details @@ -232,3 +181,62 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "listAccounts" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +[ + { + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" + } +] +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/prepareexecute.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/prepareexecute.mdx index 8cd8d00..50ba0d0 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/prepareexecute.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/prepareexecute.mdx @@ -4,6 +4,10 @@ title: "prepareExecute"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "prepareExecute", - "params": { - "params": { - "commands": {} - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -"" -``` - -
-
- -
- ## Protocol Details @@ -271,3 +226,56 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "prepareExecute", + "params": { + "params": { + "commands": {} + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +"" +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/prepareexecuteandwait.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/prepareexecuteandwait.mdx index 910f75a..c9c3b72 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/prepareexecuteandwait.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/prepareexecuteandwait.mdx @@ -4,6 +4,10 @@ title: "prepareExecuteAndWait"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "prepareExecuteAndWait", - "params": { - "params": { - "commands": {} - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "tx": { - "status": "", - "commandId": "", - "payload": { - "updateId": "", - "completionOffset": "" - } - } -} -``` - -
-
- -
- ## Protocol Details @@ -310,3 +256,65 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "prepareExecuteAndWait", + "params": { + "params": { + "commands": {} + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "tx": { + "status": "", + "commandId": "", + "payload": { + "updateId": "", + "completionOffset": "" + } + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/signmessage.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/signmessage.mdx index 3fcd7c5..8fe55c8 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/signmessage.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/signmessage.mdx @@ -4,6 +4,10 @@ title: "signMessage"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "signMessage", - "params": { - "params": { - "message": "" - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "signature": "" -} -``` - -
-
- -
- ## Protocol Details @@ -308,3 +261,58 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "signMessage", + "params": { + "params": { + "message": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "signature": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/status.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/status.mdx index c19b3e8..7b5b2a7 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/status.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/status.mdx @@ -4,6 +4,10 @@ title: "status"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "status" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "provider": { - "id": "" - }, - "connection": { - "isConnected": "", - "isNetworkConnected": "" - } -} -``` - -
-
- -
- ## Protocol Details @@ -256,3 +208,59 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "status" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "provider": { + "id": "" + }, + "connection": { + "isConnected": "", + "isNetworkConnected": "" + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/txchanged.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/txchanged.mdx index 5c83799..d4f9821 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/txchanged.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/txchanged.mdx @@ -4,6 +4,10 @@ title: "txChanged"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "txChanged" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "status": "", - "commandId": "" -} -``` - -
-
- -
- ## Protocol Details @@ -238,3 +195,54 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "txChanged" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "status": "", + "commandId": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/accountschanged.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/accountschanged.mdx index 1c45473..ac307be 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/accountschanged.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/accountschanged.mdx @@ -4,6 +4,10 @@ title: "accountsChanged"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "accountsChanged" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -[ - { - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" - } -] -``` - -
-
- -
- ## Protocol Details @@ -232,3 +181,62 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "accountsChanged" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +[ + { + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" + } +] +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/connect.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/connect.mdx index 2041195..cf09b0a 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/connect.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/connect.mdx @@ -4,6 +4,10 @@ title: "connect"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "connect" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "isConnected": "", - "isNetworkConnected": "" -} -``` - -
-
- -
- ## Protocol Details @@ -251,3 +208,54 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "connect" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "isConnected": "", + "isNetworkConnected": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/connected.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/connected.mdx index fcfe507..af5a224 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/connected.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/connected.mdx @@ -4,6 +4,10 @@ title: "connected"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "connected" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "provider": { - "id": "" - }, - "connection": { - "isConnected": "", - "isNetworkConnected": "" - } -} -``` - -
-
- -
- ## Protocol Details @@ -256,3 +208,59 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "connected" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "provider": { + "id": "" + }, + "connection": { + "isConnected": "", + "isNetworkConnected": "" + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/disconnect.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/disconnect.mdx index 2003cce..f25a4a4 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/disconnect.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/disconnect.mdx @@ -4,6 +4,10 @@ title: "disconnect"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "disconnect" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -"" -``` - -
-
- -
- ## Protocol Details @@ -191,3 +151,51 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "disconnect" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +"" +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/getactivenetwork.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/getactivenetwork.mdx index 3f8f40f..ddb26e3 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/getactivenetwork.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/getactivenetwork.mdx @@ -4,6 +4,10 @@ title: "getActiveNetwork"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getActiveNetwork" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "networkId": "" -} -``` - -
-
- -
- ## Protocol Details @@ -228,3 +186,53 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "getActiveNetwork" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "networkId": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/getprimaryaccount.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/getprimaryaccount.mdx index 29ba582..80b08e2 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/getprimaryaccount.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/getprimaryaccount.mdx @@ -4,6 +4,10 @@ title: "getPrimaryAccount"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getPrimaryAccount" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" -} -``` - -
-
- -
- ## Protocol Details @@ -389,3 +340,60 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "getPrimaryAccount" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/ledgerapi.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/ledgerapi.mdx index e048427..259884b 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/ledgerapi.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/ledgerapi.mdx @@ -4,6 +4,10 @@ title: "ledgerApi"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "ledgerApi", - "params": { - "params": { - "requestMethod": "", - "resource": "" - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "response": "" -} -``` - -
-
- -
- ## Protocol Details @@ -331,3 +283,59 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "ledgerApi", + "params": { + "params": { + "requestMethod": "", + "resource": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "response": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/listaccounts.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/listaccounts.mdx index 7a67395..f934779 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/listaccounts.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/listaccounts.mdx @@ -4,6 +4,10 @@ title: "listAccounts"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "listAccounts" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -[ - { - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" - } -] -``` - -
-
- -
- ## Protocol Details @@ -232,3 +181,62 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "listAccounts" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +[ + { + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" + } +] +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/onstatuschanged.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/onstatuschanged.mdx index 3081318..55b7b07 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/onstatuschanged.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/onstatuschanged.mdx @@ -4,6 +4,10 @@ title: "onStatusChanged"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "onStatusChanged" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "provider": { - "id": "" - }, - "connection": { - "isConnected": "", - "isNetworkConnected": "" - } -} -``` - -
-
- -
- ## Protocol Details @@ -256,3 +208,59 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "onStatusChanged" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "provider": { + "id": "" + }, + "connection": { + "isConnected": "", + "isNetworkConnected": "" + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/prepareexecute.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/prepareexecute.mdx index f0d8b12..8a73876 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/prepareexecute.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/prepareexecute.mdx @@ -4,6 +4,10 @@ title: "prepareExecute"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "prepareExecute", - "params": { - "params": { - "commands": {} - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "userUrl": "" -} -``` - -
-
- -
- ## Protocol Details @@ -303,3 +256,58 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "prepareExecute", + "params": { + "params": { + "commands": {} + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "userUrl": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/signmessage.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/signmessage.mdx index 3e05958..3da532a 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/signmessage.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/signmessage.mdx @@ -4,6 +4,10 @@ title: "signMessage"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "signMessage", - "params": { - "params": { - "message": "" - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "signature": "" -} -``` - -
-
- -
- ## Protocol Details @@ -308,3 +261,58 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "signMessage", + "params": { + "params": { + "message": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "signature": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/status.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/status.mdx index e080c48..b331388 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/status.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/status.mdx @@ -4,6 +4,10 @@ title: "status"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "status" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "provider": { - "id": "" - }, - "connection": { - "isConnected": "", - "isNetworkConnected": "" - } -} -``` - -
-
- -
- ## Protocol Details @@ -256,3 +208,59 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "status" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "provider": { + "id": "" + }, + "connection": { + "isConnected": "", + "isNetworkConnected": "" + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/txchanged.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/txchanged.mdx index 920fd0f..beed3e4 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/txchanged.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/txchanged.mdx @@ -4,6 +4,10 @@ title: "txChanged"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "txChanged" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "status": "", - "commandId": "" -} -``` - -
-
- -
- ## Protocol Details @@ -238,3 +195,54 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "txChanged" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "status": "", + "commandId": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/signing-api/createkey.mdx b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/createkey.mdx index e50e4b2..60b123f 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/signing-api/createkey.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/createkey.mdx @@ -4,6 +4,10 @@ title: "createKey"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "createKey", - "params": { - "params": { - "name": "" - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "error": "", - "error_description": "" -} -``` - -
-
- -
- ## Protocol Details @@ -308,3 +260,59 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "createKey", + "params": { + "params": { + "name": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "error": "", + "error_description": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/signing-api/getconfiguration.mdx b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/getconfiguration.mdx index a509b2c..6fc7ae0 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/signing-api/getconfiguration.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/getconfiguration.mdx @@ -4,6 +4,10 @@ title: "getConfiguration"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getConfiguration" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{} -``` - -
-
- -
- ## Protocol Details @@ -186,3 +146,51 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "getConfiguration" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/signing-api/getkeys.mdx b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/getkeys.mdx index ab1c7a0..4936180 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/signing-api/getkeys.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/getkeys.mdx @@ -4,6 +4,10 @@ title: "getKeys"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getKeys" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "error": "", - "error_description": "" -} -``` - -
-
- -
- ## Protocol Details @@ -233,3 +190,54 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "getKeys" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "error": "", + "error_description": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/signing-api/gettransaction.mdx b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/gettransaction.mdx index 267a709..e13ebb6 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/signing-api/gettransaction.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/gettransaction.mdx @@ -4,6 +4,10 @@ title: "getTransaction"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getTransaction", - "params": { - "params": { - "txId": "" - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "error": "", - "error_description": "" -} -``` - -
-
- -
- ## Protocol Details @@ -308,3 +260,59 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "getTransaction", + "params": { + "params": { + "txId": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "error": "", + "error_description": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/signing-api/gettransactions.mdx b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/gettransactions.mdx index 46981fe..3d00725 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/signing-api/gettransactions.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/gettransactions.mdx @@ -4,6 +4,10 @@ title: "getTransactions"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getTransactions", - "params": { - "params": { - "txIds": [ - "" - ], - "publicKeys": [ - "" - ] - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "error": "", - "error_description": "" -} -``` - -
-
- -
- ## Protocol Details @@ -322,3 +269,64 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "getTransactions", + "params": { + "params": { + "txIds": [ + "" + ], + "publicKeys": [ + "" + ] + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "error": "", + "error_description": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/signing-api/setconfiguration.mdx b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/setconfiguration.mdx index 5d6aad8..13b4130 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/signing-api/setconfiguration.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/setconfiguration.mdx @@ -4,6 +4,10 @@ title: "setConfiguration"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "setConfiguration", - "params": { - "params": {} - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{} -``` - -
-
- -
- ## Protocol Details @@ -224,3 +181,54 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "setConfiguration", + "params": { + "params": {} + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/signing-api/signtransaction.mdx b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/signtransaction.mdx index b3a6636..1177872 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/signing-api/signtransaction.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/signtransaction.mdx @@ -4,6 +4,10 @@ title: "signTransaction"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "signTransaction", - "params": { - "params": { - "tx": "", - "txHash": "", - "keyIdentifier": { - "publicKey": "" - } - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "error": "", - "error_description": "" -} -``` - -
-
- -
- ## Protocol Details @@ -356,3 +304,63 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "signTransaction", + "params": { + "params": { + "tx": "", + "txHash": "", + "keyIdentifier": { + "publicKey": "" + } + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "error": "", + "error_description": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/signing-api/subscribetransactions.mdx b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/subscribetransactions.mdx index 9a3b807..51a99a2 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/signing-api/subscribetransactions.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/subscribetransactions.mdx @@ -4,6 +4,10 @@ title: "subscribeTransactions"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "subscribeTransactions", - "params": { - "params": { - "txIds": [ - "" - ] - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "txId": "", - "status": "" -} -``` - -
-
- -
- ## Protocol Details @@ -328,3 +278,61 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "subscribeTransactions", + "params": { + "params": { + "txIds": [ + "" + ] + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "txId": "", + "status": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/addidp.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/addidp.mdx index 051df48..3ceee4b 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/addidp.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/addidp.mdx @@ -4,6 +4,10 @@ title: "addIdp"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "addIdp", - "params": { - "params": { - "idp": { - "id": "", - "type": "", - "issuer": "" - } - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -"" -``` - -
-
- -
- ## Protocol Details @@ -270,3 +221,60 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "addIdp", + "params": { + "params": { + "idp": { + "id": "", + "type": "", + "issuer": "" + } + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +"" +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/addnetwork.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/addnetwork.mdx index c462244..6ccf3b8 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/addnetwork.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/addnetwork.mdx @@ -4,6 +4,10 @@ title: "addNetwork"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "addNetwork", - "params": { - "params": { - "network": { - "id": "", - "name": "", - "description": "", - "identityProviderId": "", - "auth": { - "method": "", - "scope": "", - "clientId": "", - "audience": "" - }, - "ledgerApi": "" - } - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -"" -``` - -
-
- -
- ## Protocol Details @@ -278,3 +221,68 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "addNetwork", + "params": { + "params": { + "network": { + "id": "", + "name": "", + "description": "", + "identityProviderId": "", + "auth": { + "method": "", + "scope": "", + "clientId": "", + "audience": "" + }, + "ledgerApi": "" + } + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +"" +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/addsession.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/addsession.mdx index d29c364..1e1007a 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/addsession.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/addsession.mdx @@ -4,6 +4,10 @@ title: "addSession"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "addSession", - "params": { - "params": { - "networkId": "" - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "id": "", - "network": { - "id": "", - "name": "", - "description": "", - "identityProviderId": "", - "auth": { - "method": "", - "scope": "", - "clientId": "", - "audience": "" - }, - "ledgerApi": "" - }, - "idp": { - "id": "", - "type": "", - "issuer": "" - }, - "accessToken": "", - "status": "" -} -``` - -
-
- -
- ## Protocol Details @@ -411,3 +344,78 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "addSession", + "params": { + "params": { + "networkId": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "id": "", + "network": { + "id": "", + "name": "", + "description": "", + "identityProviderId": "", + "auth": { + "method": "", + "scope": "", + "clientId": "", + "audience": "" + }, + "ledgerApi": "" + }, + "idp": { + "id": "", + "type": "", + "issuer": "" + }, + "accessToken": "", + "status": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/allocatepartyforwallet.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/allocatepartyforwallet.mdx index 05ff786..8917e9f 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/allocatepartyforwallet.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/allocatepartyforwallet.mdx @@ -4,6 +4,10 @@ title: "allocatePartyForWallet"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "allocatePartyForWallet", - "params": { - "params": { - "partyId": "" - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "wallet": { - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" - } -} -``` - -
-
- -
- ## Protocol Details @@ -307,3 +251,67 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "allocatePartyForWallet", + "params": { + "params": { + "partyId": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "wallet": { + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/createwallet.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/createwallet.mdx index 9500d4d..f6534e0 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/createwallet.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/createwallet.mdx @@ -4,6 +4,10 @@ title: "createWallet"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "createWallet", - "params": { - "params": { - "partyHint": "", - "signingProviderId": "" - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "wallet": { - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" - } -} -``` - -
-
- -
- ## Protocol Details @@ -343,3 +286,68 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "createWallet", + "params": { + "params": { + "partyHint": "", + "signingProviderId": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "wallet": { + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/deletetransaction.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/deletetransaction.mdx index 55b8bab..2417fde 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/deletetransaction.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/deletetransaction.mdx @@ -4,6 +4,10 @@ title: "deleteTransaction"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "deleteTransaction", - "params": { - "params": { - "commandId": "" - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -"" -``` - -
-
- -
- ## Protocol Details @@ -266,3 +221,56 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "deleteTransaction", + "params": { + "params": { + "commandId": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +"" +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/execute.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/execute.mdx index 54150fe..285e84b 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/execute.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/execute.mdx @@ -4,6 +4,10 @@ title: "execute"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "execute", - "params": { - "params": { - "signature": "", - "partyId": "", - "commandId": "", - "signedBy": "" - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{} -``` - -
-
- -
- ## Protocol Details @@ -330,3 +282,59 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "execute", + "params": { + "params": { + "signature": "", + "partyId": "", + "commandId": "", + "signedBy": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/gettransaction.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/gettransaction.mdx index a837d89..473c92c 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/gettransaction.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/gettransaction.mdx @@ -4,6 +4,10 @@ title: "getTransaction"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getTransaction", - "params": { - "params": { - "commandId": "" - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "commandId": "", - "status": "", - "preparedTransaction": "", - "preparedTransactionHash": "" -} -``` - -
-
- -
- ## Protocol Details @@ -372,3 +322,61 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "getTransaction", + "params": { + "params": { + "commandId": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "commandId": "", + "status": "", + "preparedTransaction": "", + "preparedTransactionHash": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/getuser.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/getuser.mdx index 631b319..aa62d85 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/getuser.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/getuser.mdx @@ -4,6 +4,10 @@ title: "getUser"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getUser" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "userId": "", - "isAdmin": "" -} -``` - -
-
- -
- ## Protocol Details @@ -246,3 +203,54 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "getUser" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "userId": "", + "isAdmin": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/iswalletsyncneeded.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/iswalletsyncneeded.mdx index 3303f12..c471da3 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/iswalletsyncneeded.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/iswalletsyncneeded.mdx @@ -4,6 +4,10 @@ title: "isWalletSyncNeeded"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "isWalletSyncNeeded" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "walletSyncNeeded": "" -} -``` - -
-
- -
- ## Protocol Details @@ -223,3 +181,53 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "isWalletSyncNeeded" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "walletSyncNeeded": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/listidps.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/listidps.mdx index 013e399..c91c59f 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/listidps.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/listidps.mdx @@ -4,6 +4,10 @@ title: "listIdps"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "listIdps" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "idps": [ - { - "id": "", - "type": "", - "issuer": "" - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -229,3 +181,59 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "listIdps" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "idps": [ + { + "id": "", + "type": "", + "issuer": "" + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/listnetworks.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/listnetworks.mdx index 4de1454..05e8461 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/listnetworks.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/listnetworks.mdx @@ -4,6 +4,10 @@ title: "listNetworks"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "listNetworks" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "networks": [ - { - "id": "", - "name": "", - "description": "", - "identityProviderId": "", - "auth": { - "method": "", - "scope": "", - "clientId": "", - "audience": "" - }, - "ledgerApi": "" - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -237,3 +181,67 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "listNetworks" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "networks": [ + { + "id": "", + "name": "", + "description": "", + "identityProviderId": "", + "auth": { + "method": "", + "scope": "", + "clientId": "", + "audience": "" + }, + "ledgerApi": "" + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/listsessions.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/listsessions.mdx index 0d523b9..a190164 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/listsessions.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/listsessions.mdx @@ -4,6 +4,10 @@ title: "listSessions"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "listSessions" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "sessions": [ - { - "id": "", - "network": { - "id": "", - "name": "", - "description": "", - "identityProviderId": "", - "auth": "", - "ledgerApi": "" - }, - "idp": { - "id": "", - "type": "", - "issuer": "" - }, - "accessToken": "", - "status": "" - } - ] -} -``` - - - - - - ## Protocol Details @@ -242,3 +181,72 @@ EOF + + + + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "listSessions" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "sessions": [ + { + "id": "", + "network": { + "id": "", + "name": "", + "description": "", + "identityProviderId": "", + "auth": "", + "ledgerApi": "" + }, + "idp": { + "id": "", + "type": "", + "issuer": "" + }, + "accessToken": "", + "status": "" + } + ] +} +``` + + + + + + + diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/listtransactions.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/listtransactions.mdx index 52b4f59..0e5cf52 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/listtransactions.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/listtransactions.mdx @@ -4,6 +4,10 @@ title: "listTransactions"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "listTransactions" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "transactions": [ - { - "commandId": "", - "status": "", - "preparedTransaction": "", - "preparedTransactionHash": "" - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -230,3 +181,60 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "listTransactions" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "transactions": [ + { + "commandId": "", + "status": "", + "preparedTransaction": "", + "preparedTransactionHash": "" + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/listwallets.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/listwallets.mdx index 8a168ef..c76044c 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/listwallets.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/listwallets.mdx @@ -4,6 +4,10 @@ title: "listWallets"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "listWallets", - "params": { - "params": { - "filter": { - "networkIds": [ - "" - ], - "signingProviderIds": [ - "" - ] - } - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -[ - { - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" - } -] -``` - -
-
- -
- ## Protocol Details @@ -300,3 +237,74 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "listWallets", + "params": { + "params": { + "filter": { + "networkIds": [ + "" + ], + "signingProviderIds": [ + "" + ] + } + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +[ + { + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" + } +] +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/removeidp.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/removeidp.mdx index dbd8be8..afc81cd 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/removeidp.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/removeidp.mdx @@ -4,6 +4,10 @@ title: "removeIdp"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "removeIdp", - "params": { - "params": { - "identityProviderId": "" - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -"" -``` - -
-
- -
- ## Protocol Details @@ -266,3 +221,56 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "removeIdp", + "params": { + "params": { + "identityProviderId": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +"" +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/removenetwork.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/removenetwork.mdx index f41e2aa..f863053 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/removenetwork.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/removenetwork.mdx @@ -4,6 +4,10 @@ title: "removeNetwork"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "removeNetwork", - "params": { - "params": { - "networkName": "" - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -"" -``` - -
-
- -
- ## Protocol Details @@ -266,3 +221,56 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "removeNetwork", + "params": { + "params": { + "networkName": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +"" +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/removesession.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/removesession.mdx index 4d00f3e..7438623 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/removesession.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/removesession.mdx @@ -4,6 +4,10 @@ title: "removeSession"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "removeSession" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -"" -``` - -
-
- -
- ## Protocol Details @@ -191,3 +151,51 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "removeSession" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +"" +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/removewallet.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/removewallet.mdx index f06b0c4..cd452d2 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/removewallet.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/removewallet.mdx @@ -4,6 +4,10 @@ title: "removeWallet"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "removeWallet", - "params": { - "params": { - "partyId": "" - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{} -``` - -
-
- -
- ## Protocol Details @@ -261,3 +216,56 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "removeWallet", + "params": { + "params": { + "partyId": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/setprimarywallet.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/setprimarywallet.mdx index e7fddd5..598a3d4 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/setprimarywallet.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/setprimarywallet.mdx @@ -4,6 +4,10 @@ title: "setPrimaryWallet"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "setPrimaryWallet", - "params": { - "params": { - "partyId": "" - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -"" -``` - -
-
- -
- ## Protocol Details @@ -266,3 +221,56 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "setPrimaryWallet", + "params": { + "params": { + "partyId": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +"" +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/sign.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/sign.mdx index c5232a7..152e80e 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/sign.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/sign.mdx @@ -4,6 +4,10 @@ title: "sign"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "sign", - "params": { - "params": { - "preparedTransaction": "", - "preparedTransactionHash": "", - "commandId": "", - "partyId": "" - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "signature": "", - "partyId": "", - "signedBy": "" -} -``` - -
-
- -
- ## Protocol Details @@ -413,3 +361,63 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "sign", + "params": { + "params": { + "preparedTransaction": "", + "preparedTransactionHash": "", + "commandId": "", + "partyId": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "signature": "", + "partyId": "", + "signedBy": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/syncwallets.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/syncwallets.mdx index 68fc24e..67e9ffd 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/syncwallets.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/syncwallets.mdx @@ -4,6 +4,10 @@ title: "syncWallets"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "syncWallets" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "added": [ - { - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" - } - ], - "updated": [ - { - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" - } - ], - "disabled": [ - { - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -315,3 +238,88 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "syncWallets" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "added": [ + { + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" + } + ], + "updated": [ + { + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" + } + ], + "disabled": [ + { + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/accountschanged.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/accountschanged.mdx index 3d25425..b1ec923 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/accountschanged.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/accountschanged.mdx @@ -4,6 +4,10 @@ title: "accountsChanged"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "accountsChanged" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -[ - { - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" - } -] -``` - -
-
- -
- ## Protocol Details @@ -232,3 +181,62 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "accountsChanged" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +[ + { + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" + } +] +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/connect.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/connect.mdx index b733bf2..7450b79 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/connect.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/connect.mdx @@ -4,6 +4,10 @@ title: "connect"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "connect" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "isConnected": "", - "isNetworkConnected": "" -} -``` - -
-
- -
- ## Protocol Details @@ -251,3 +208,54 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "connect" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "isConnected": "", + "isNetworkConnected": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/disconnect.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/disconnect.mdx index edfcf5e..48b50cd 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/disconnect.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/disconnect.mdx @@ -4,6 +4,10 @@ title: "disconnect"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "disconnect" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -"" -``` - -
-
- -
- ## Protocol Details @@ -191,3 +151,51 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "disconnect" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +"" +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/getactivenetwork.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/getactivenetwork.mdx index 22bdfcd..d294bd0 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/getactivenetwork.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/getactivenetwork.mdx @@ -4,6 +4,10 @@ title: "getActiveNetwork"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getActiveNetwork" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "networkId": "" -} -``` - -
-
- -
- ## Protocol Details @@ -228,3 +186,53 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "getActiveNetwork" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "networkId": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/getprimaryaccount.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/getprimaryaccount.mdx index 2a980bd..df1e154 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/getprimaryaccount.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/getprimaryaccount.mdx @@ -4,6 +4,10 @@ title: "getPrimaryAccount"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getPrimaryAccount" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" -} -``` - -
-
- -
- ## Protocol Details @@ -389,3 +340,60 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "getPrimaryAccount" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/ledgerapi.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/ledgerapi.mdx index 39b9004..f11ab47 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/ledgerapi.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/ledgerapi.mdx @@ -4,6 +4,10 @@ title: "ledgerApi"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "ledgerApi", - "params": { - "params": { - "requestMethod": "", - "resource": "" - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "response": "" -} -``` - -
-
- -
- ## Protocol Details @@ -331,3 +283,59 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "ledgerApi", + "params": { + "params": { + "requestMethod": "", + "resource": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "response": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/listaccounts.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/listaccounts.mdx index 5312f2f..b3762be 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/listaccounts.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/listaccounts.mdx @@ -4,6 +4,10 @@ title: "listAccounts"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "listAccounts" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -[ - { - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" - } -] -``` - -
-
- -
- ## Protocol Details @@ -232,3 +181,62 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "listAccounts" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +[ + { + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" + } +] +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/prepareexecute.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/prepareexecute.mdx index 7fab0f0..c1e93b5 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/prepareexecute.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/prepareexecute.mdx @@ -4,6 +4,10 @@ title: "prepareExecute"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "prepareExecute", - "params": { - "params": { - "commands": {} - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -"" -``` - -
-
- -
- ## Protocol Details @@ -271,3 +226,56 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "prepareExecute", + "params": { + "params": { + "commands": {} + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +"" +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/prepareexecuteandwait.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/prepareexecuteandwait.mdx index 6466630..536ae10 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/prepareexecuteandwait.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/prepareexecuteandwait.mdx @@ -4,6 +4,10 @@ title: "prepareExecuteAndWait"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "prepareExecuteAndWait", - "params": { - "params": { - "commands": {} - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "tx": { - "status": "", - "commandId": "", - "payload": { - "updateId": "", - "completionOffset": "" - } - } -} -``` - -
-
- -
- ## Protocol Details @@ -310,3 +256,65 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "prepareExecuteAndWait", + "params": { + "params": { + "commands": {} + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "tx": { + "status": "", + "commandId": "", + "payload": { + "updateId": "", + "completionOffset": "" + } + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/signmessage.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/signmessage.mdx index 78bbbc2..1decece 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/signmessage.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/signmessage.mdx @@ -4,6 +4,10 @@ title: "signMessage"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "signMessage", - "params": { - "params": { - "message": "" - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "signature": "" -} -``` - -
-
- -
- ## Protocol Details @@ -308,3 +261,58 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "signMessage", + "params": { + "params": { + "message": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "signature": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/status.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/status.mdx index 91481c9..14f57b0 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/status.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/status.mdx @@ -4,6 +4,10 @@ title: "status"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "status" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "provider": { - "id": "" - }, - "connection": { - "isConnected": "", - "isNetworkConnected": "" - } -} -``` - -
-
- -
- ## Protocol Details @@ -256,3 +208,59 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "status" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "provider": { + "id": "" + }, + "connection": { + "isConnected": "", + "isNetworkConnected": "" + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/txchanged.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/txchanged.mdx index a4a7992..03cc79c 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/txchanged.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/txchanged.mdx @@ -4,6 +4,10 @@ title: "txChanged"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "txChanged" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "status": "", - "commandId": "" -} -``` - -
-
- -
- ## Protocol Details @@ -238,3 +195,54 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "txChanged" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "status": "", + "commandId": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/accountschanged.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/accountschanged.mdx index 6d07b30..79a38f1 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/accountschanged.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/accountschanged.mdx @@ -4,6 +4,10 @@ title: "accountsChanged"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "accountsChanged" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -[ - { - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" - } -] -``` - -
-
- -
- ## Protocol Details @@ -232,3 +181,62 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "accountsChanged" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +[ + { + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" + } +] +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/connect.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/connect.mdx index 25260a4..ba5862e 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/connect.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/connect.mdx @@ -4,6 +4,10 @@ title: "connect"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "connect" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "isConnected": "", - "isNetworkConnected": "" -} -``` - -
-
- -
- ## Protocol Details @@ -251,3 +208,54 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "connect" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "isConnected": "", + "isNetworkConnected": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/connected.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/connected.mdx index 656e583..b7b243f 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/connected.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/connected.mdx @@ -4,6 +4,10 @@ title: "connected"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "connected" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "provider": { - "id": "" - }, - "connection": { - "isConnected": "", - "isNetworkConnected": "" - } -} -``` - -
-
- -
- ## Protocol Details @@ -256,3 +208,59 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "connected" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "provider": { + "id": "" + }, + "connection": { + "isConnected": "", + "isNetworkConnected": "" + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/disconnect.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/disconnect.mdx index b639050..ee9cba6 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/disconnect.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/disconnect.mdx @@ -4,6 +4,10 @@ title: "disconnect"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "disconnect" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -"" -``` - -
-
- -
- ## Protocol Details @@ -191,3 +151,51 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "disconnect" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +"" +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/getactivenetwork.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/getactivenetwork.mdx index 9957117..7835b5b 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/getactivenetwork.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/getactivenetwork.mdx @@ -4,6 +4,10 @@ title: "getActiveNetwork"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getActiveNetwork" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "networkId": "" -} -``` - -
-
- -
- ## Protocol Details @@ -228,3 +186,53 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "getActiveNetwork" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "networkId": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/getprimaryaccount.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/getprimaryaccount.mdx index 6ee7dd0..68d2e85 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/getprimaryaccount.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/getprimaryaccount.mdx @@ -4,6 +4,10 @@ title: "getPrimaryAccount"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getPrimaryAccount" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" -} -``` - -
-
- -
- ## Protocol Details @@ -389,3 +340,60 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "getPrimaryAccount" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/ledgerapi.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/ledgerapi.mdx index fbc725f..326533e 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/ledgerapi.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/ledgerapi.mdx @@ -4,6 +4,10 @@ title: "ledgerApi"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "ledgerApi", - "params": { - "params": { - "requestMethod": "", - "resource": "" - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "response": "" -} -``` - -
-
- -
- ## Protocol Details @@ -331,3 +283,59 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "ledgerApi", + "params": { + "params": { + "requestMethod": "", + "resource": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "response": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/listaccounts.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/listaccounts.mdx index 68787eb..4edc415 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/listaccounts.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/listaccounts.mdx @@ -4,6 +4,10 @@ title: "listAccounts"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "listAccounts" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -[ - { - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" - } -] -``` - -
-
- -
- ## Protocol Details @@ -232,3 +181,62 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "listAccounts" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +[ + { + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" + } +] +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/onstatuschanged.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/onstatuschanged.mdx index e30e778..29135d9 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/onstatuschanged.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/onstatuschanged.mdx @@ -4,6 +4,10 @@ title: "onStatusChanged"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "onStatusChanged" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "provider": { - "id": "" - }, - "connection": { - "isConnected": "", - "isNetworkConnected": "" - } -} -``` - -
-
- -
- ## Protocol Details @@ -256,3 +208,59 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "onStatusChanged" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "provider": { + "id": "" + }, + "connection": { + "isConnected": "", + "isNetworkConnected": "" + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/prepareexecute.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/prepareexecute.mdx index b5673dd..4c9f464 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/prepareexecute.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/prepareexecute.mdx @@ -4,6 +4,10 @@ title: "prepareExecute"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "prepareExecute", - "params": { - "params": { - "commands": {} - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "userUrl": "" -} -``` - -
-
- -
- ## Protocol Details @@ -303,3 +256,58 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "prepareExecute", + "params": { + "params": { + "commands": {} + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "userUrl": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/signmessage.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/signmessage.mdx index 392a6d9..9597c0c 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/signmessage.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/signmessage.mdx @@ -4,6 +4,10 @@ title: "signMessage"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "signMessage", - "params": { - "params": { - "message": "" - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "signature": "" -} -``` - -
-
- -
- ## Protocol Details @@ -308,3 +261,58 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "signMessage", + "params": { + "params": { + "message": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "signature": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/status.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/status.mdx index fceff47..973ed22 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/status.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/status.mdx @@ -4,6 +4,10 @@ title: "status"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "status" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "provider": { - "id": "" - }, - "connection": { - "isConnected": "", - "isNetworkConnected": "" - } -} -``` - -
-
- -
- ## Protocol Details @@ -256,3 +208,59 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "status" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "provider": { + "id": "" + }, + "connection": { + "isConnected": "", + "isNetworkConnected": "" + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/txchanged.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/txchanged.mdx index b22e286..0d29c2e 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/txchanged.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/txchanged.mdx @@ -4,6 +4,10 @@ title: "txChanged"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "txChanged" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "status": "", - "commandId": "" -} -``` - -
-
- -
- ## Protocol Details @@ -238,3 +195,54 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "txChanged" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "status": "", + "commandId": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/createkey.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/createkey.mdx index b616e87..9ef2b11 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/createkey.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/createkey.mdx @@ -4,6 +4,10 @@ title: "createKey"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "createKey", - "params": { - "params": { - "name": "" - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "error": "", - "error_description": "" -} -``` - -
-
- -
- ## Protocol Details @@ -308,3 +260,59 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "createKey", + "params": { + "params": { + "name": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "error": "", + "error_description": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/getconfiguration.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/getconfiguration.mdx index 23fc689..78bfd52 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/getconfiguration.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/getconfiguration.mdx @@ -4,6 +4,10 @@ title: "getConfiguration"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getConfiguration" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{} -``` - -
-
- -
- ## Protocol Details @@ -186,3 +146,51 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "getConfiguration" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/getkeys.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/getkeys.mdx index 940f4de..864ca12 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/getkeys.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/getkeys.mdx @@ -4,6 +4,10 @@ title: "getKeys"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getKeys" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "error": "", - "error_description": "" -} -``` - -
-
- -
- ## Protocol Details @@ -233,3 +190,54 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "getKeys" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "error": "", + "error_description": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/gettransaction.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/gettransaction.mdx index a42e899..666fc9d 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/gettransaction.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/gettransaction.mdx @@ -4,6 +4,10 @@ title: "getTransaction"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getTransaction", - "params": { - "params": { - "txId": "" - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "error": "", - "error_description": "" -} -``` - -
-
- -
- ## Protocol Details @@ -308,3 +260,59 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "getTransaction", + "params": { + "params": { + "txId": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "error": "", + "error_description": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/gettransactions.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/gettransactions.mdx index 92c78bc..f91ac6e 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/gettransactions.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/gettransactions.mdx @@ -4,6 +4,10 @@ title: "getTransactions"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getTransactions", - "params": { - "params": { - "txIds": [ - "" - ], - "publicKeys": [ - "" - ] - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "error": "", - "error_description": "" -} -``` - -
-
- -
- ## Protocol Details @@ -322,3 +269,64 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "getTransactions", + "params": { + "params": { + "txIds": [ + "" + ], + "publicKeys": [ + "" + ] + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "error": "", + "error_description": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/setconfiguration.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/setconfiguration.mdx index c1ede74..1003554 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/setconfiguration.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/setconfiguration.mdx @@ -4,6 +4,10 @@ title: "setConfiguration"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "setConfiguration", - "params": { - "params": {} - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{} -``` - -
-
- -
- ## Protocol Details @@ -224,3 +181,54 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "setConfiguration", + "params": { + "params": {} + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/signtransaction.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/signtransaction.mdx index ebef6bc..64922d8 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/signtransaction.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/signtransaction.mdx @@ -4,6 +4,10 @@ title: "signTransaction"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "signTransaction", - "params": { - "params": { - "tx": "", - "txHash": "", - "keyIdentifier": { - "publicKey": "" - } - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "error": "", - "error_description": "" -} -``` - -
-
- -
- ## Protocol Details @@ -356,3 +304,63 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "signTransaction", + "params": { + "params": { + "tx": "", + "txHash": "", + "keyIdentifier": { + "publicKey": "" + } + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "error": "", + "error_description": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/subscribetransactions.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/subscribetransactions.mdx index d563f7f..0af0f84 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/subscribetransactions.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/subscribetransactions.mdx @@ -4,6 +4,10 @@ title: "subscribeTransactions"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "subscribeTransactions", - "params": { - "params": { - "txIds": [ - "" - ] - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "txId": "", - "status": "" -} -``` - -
-
- -
- ## Protocol Details @@ -328,3 +278,61 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "subscribeTransactions", + "params": { + "params": { + "txIds": [ + "" + ] + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "txId": "", + "status": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/addidp.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/addidp.mdx index 9f0cc33..7cf50dd 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/addidp.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/addidp.mdx @@ -4,6 +4,10 @@ title: "addIdp"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "addIdp", - "params": { - "params": { - "idp": { - "id": "", - "type": "", - "issuer": "" - } - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -"" -``` - -
-
- -
- ## Protocol Details @@ -270,3 +221,60 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "addIdp", + "params": { + "params": { + "idp": { + "id": "", + "type": "", + "issuer": "" + } + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +"" +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/addnetwork.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/addnetwork.mdx index d54aa5c..9caa25d 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/addnetwork.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/addnetwork.mdx @@ -4,6 +4,10 @@ title: "addNetwork"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "addNetwork", - "params": { - "params": { - "network": { - "id": "", - "name": "", - "description": "", - "identityProviderId": "", - "auth": { - "method": "", - "scope": "", - "clientId": "", - "audience": "" - }, - "ledgerApi": "" - } - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -"" -``` - -
-
- -
- ## Protocol Details @@ -278,3 +221,68 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "addNetwork", + "params": { + "params": { + "network": { + "id": "", + "name": "", + "description": "", + "identityProviderId": "", + "auth": { + "method": "", + "scope": "", + "clientId": "", + "audience": "" + }, + "ledgerApi": "" + } + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +"" +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/addsession.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/addsession.mdx index f3a09d6..e9dac01 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/addsession.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/addsession.mdx @@ -4,6 +4,10 @@ title: "addSession"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "addSession", - "params": { - "params": { - "networkId": "" - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "id": "", - "network": { - "id": "", - "name": "", - "description": "", - "identityProviderId": "", - "auth": { - "method": "", - "scope": "", - "clientId": "", - "audience": "" - }, - "ledgerApi": "" - }, - "idp": { - "id": "", - "type": "", - "issuer": "" - }, - "accessToken": "", - "status": "" -} -``` - -
-
- -
- ## Protocol Details @@ -411,3 +344,78 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "addSession", + "params": { + "params": { + "networkId": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "id": "", + "network": { + "id": "", + "name": "", + "description": "", + "identityProviderId": "", + "auth": { + "method": "", + "scope": "", + "clientId": "", + "audience": "" + }, + "ledgerApi": "" + }, + "idp": { + "id": "", + "type": "", + "issuer": "" + }, + "accessToken": "", + "status": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/allocatepartyforwallet.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/allocatepartyforwallet.mdx index 669a2b0..2ea90b8 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/allocatepartyforwallet.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/allocatepartyforwallet.mdx @@ -4,6 +4,10 @@ title: "allocatePartyForWallet"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "allocatePartyForWallet", - "params": { - "params": { - "partyId": "" - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "wallet": { - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" - } -} -``` - -
-
- -
- ## Protocol Details @@ -307,3 +251,67 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "allocatePartyForWallet", + "params": { + "params": { + "partyId": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "wallet": { + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/createwallet.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/createwallet.mdx index 2cdfdfc..d64fb6e 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/createwallet.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/createwallet.mdx @@ -4,6 +4,10 @@ title: "createWallet"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "createWallet", - "params": { - "params": { - "partyHint": "", - "signingProviderId": "" - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "wallet": { - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" - } -} -``` - -
-
- -
- ## Protocol Details @@ -343,3 +286,68 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "createWallet", + "params": { + "params": { + "partyHint": "", + "signingProviderId": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "wallet": { + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/deletetransaction.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/deletetransaction.mdx index ac33203..2f21696 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/deletetransaction.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/deletetransaction.mdx @@ -4,6 +4,10 @@ title: "deleteTransaction"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "deleteTransaction", - "params": { - "params": { - "commandId": "" - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -"" -``` - -
-
- -
- ## Protocol Details @@ -266,3 +221,56 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "deleteTransaction", + "params": { + "params": { + "commandId": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +"" +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/execute.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/execute.mdx index 5a42aed..2bcb10a 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/execute.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/execute.mdx @@ -4,6 +4,10 @@ title: "execute"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "execute", - "params": { - "params": { - "signature": "", - "partyId": "", - "commandId": "", - "signedBy": "" - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{} -``` - -
-
- -
- ## Protocol Details @@ -330,3 +282,59 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "execute", + "params": { + "params": { + "signature": "", + "partyId": "", + "commandId": "", + "signedBy": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/gettransaction.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/gettransaction.mdx index a85fd64..976b069 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/gettransaction.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/gettransaction.mdx @@ -4,6 +4,10 @@ title: "getTransaction"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getTransaction", - "params": { - "params": { - "commandId": "" - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "commandId": "", - "status": "", - "preparedTransaction": "", - "preparedTransactionHash": "" -} -``` - -
-
- -
- ## Protocol Details @@ -372,3 +322,61 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "getTransaction", + "params": { + "params": { + "commandId": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "commandId": "", + "status": "", + "preparedTransaction": "", + "preparedTransactionHash": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/getuser.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/getuser.mdx index dd9723f..ef71020 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/getuser.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/getuser.mdx @@ -4,6 +4,10 @@ title: "getUser"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getUser" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "userId": "", - "isAdmin": "" -} -``` - -
-
- -
- ## Protocol Details @@ -246,3 +203,54 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "getUser" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "userId": "", + "isAdmin": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/iswalletsyncneeded.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/iswalletsyncneeded.mdx index 8880e41..05e59af 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/iswalletsyncneeded.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/iswalletsyncneeded.mdx @@ -4,6 +4,10 @@ title: "isWalletSyncNeeded"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "isWalletSyncNeeded" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "walletSyncNeeded": "" -} -``` - -
-
- -
- ## Protocol Details @@ -223,3 +181,53 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "isWalletSyncNeeded" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "walletSyncNeeded": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listidps.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listidps.mdx index 33bb917..4deaa0d 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listidps.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listidps.mdx @@ -4,6 +4,10 @@ title: "listIdps"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "listIdps" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "idps": [ - { - "id": "", - "type": "", - "issuer": "" - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -229,3 +181,59 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "listIdps" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "idps": [ + { + "id": "", + "type": "", + "issuer": "" + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listnetworks.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listnetworks.mdx index df1ec8e..64b15b8 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listnetworks.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listnetworks.mdx @@ -4,6 +4,10 @@ title: "listNetworks"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "listNetworks" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "networks": [ - { - "id": "", - "name": "", - "description": "", - "identityProviderId": "", - "auth": { - "method": "", - "scope": "", - "clientId": "", - "audience": "" - }, - "ledgerApi": "" - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -237,3 +181,67 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "listNetworks" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "networks": [ + { + "id": "", + "name": "", + "description": "", + "identityProviderId": "", + "auth": { + "method": "", + "scope": "", + "clientId": "", + "audience": "" + }, + "ledgerApi": "" + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listsessions.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listsessions.mdx index 238f737..d039141 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listsessions.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listsessions.mdx @@ -4,6 +4,10 @@ title: "listSessions"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "listSessions" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "sessions": [ - { - "id": "", - "network": { - "id": "", - "name": "", - "description": "", - "identityProviderId": "", - "auth": "", - "ledgerApi": "" - }, - "idp": { - "id": "", - "type": "", - "issuer": "" - }, - "accessToken": "", - "status": "" - } - ] -} -``` - - - - - - ## Protocol Details @@ -242,3 +181,72 @@ EOF + + + + +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "listSessions" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "sessions": [ + { + "id": "", + "network": { + "id": "", + "name": "", + "description": "", + "identityProviderId": "", + "auth": "", + "ledgerApi": "" + }, + "idp": { + "id": "", + "type": "", + "issuer": "" + }, + "accessToken": "", + "status": "" + } + ] +} +``` + + + + + + + diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listtransactions.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listtransactions.mdx index e88332c..87f7f15 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listtransactions.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listtransactions.mdx @@ -4,6 +4,10 @@ title: "listTransactions"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "listTransactions" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "transactions": [ - { - "commandId": "", - "status": "", - "preparedTransaction": "", - "preparedTransactionHash": "" - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -230,3 +181,60 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "listTransactions" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "transactions": [ + { + "commandId": "", + "status": "", + "preparedTransaction": "", + "preparedTransactionHash": "" + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listwallets.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listwallets.mdx index 4fb543b..30481a3 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listwallets.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listwallets.mdx @@ -4,6 +4,10 @@ title: "listWallets"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "listWallets", - "params": { - "params": { - "filter": { - "networkIds": [ - "" - ], - "signingProviderIds": [ - "" - ] - } - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -[ - { - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" - } -] -``` - -
-
- -
- ## Protocol Details @@ -300,3 +237,74 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "listWallets", + "params": { + "params": { + "filter": { + "networkIds": [ + "" + ], + "signingProviderIds": [ + "" + ] + } + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +[ + { + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" + } +] +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removeidp.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removeidp.mdx index 36fb4a7..280c8ff 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removeidp.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removeidp.mdx @@ -4,6 +4,10 @@ title: "removeIdp"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "removeIdp", - "params": { - "params": { - "identityProviderId": "" - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -"" -``` - -
-
- -
- ## Protocol Details @@ -266,3 +221,56 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "removeIdp", + "params": { + "params": { + "identityProviderId": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +"" +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removenetwork.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removenetwork.mdx index a98fb07..f570d7b 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removenetwork.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removenetwork.mdx @@ -4,6 +4,10 @@ title: "removeNetwork"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "removeNetwork", - "params": { - "params": { - "networkName": "" - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -"" -``` - -
-
- -
- ## Protocol Details @@ -266,3 +221,56 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "removeNetwork", + "params": { + "params": { + "networkName": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +"" +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removesession.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removesession.mdx index 670fc77..19339d2 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removesession.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removesession.mdx @@ -4,6 +4,10 @@ title: "removeSession"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "removeSession" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -"" -``` - -
-
- -
- ## Protocol Details @@ -191,3 +151,51 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "removeSession" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +"" +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removewallet.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removewallet.mdx index e94e83f..e87254c 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removewallet.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removewallet.mdx @@ -4,6 +4,10 @@ title: "removeWallet"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "removeWallet", - "params": { - "params": { - "partyId": "" - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{} -``` - -
-
- -
- ## Protocol Details @@ -261,3 +216,56 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "removeWallet", + "params": { + "params": { + "partyId": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/setprimarywallet.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/setprimarywallet.mdx index 1ff37c4..b3338c0 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/setprimarywallet.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/setprimarywallet.mdx @@ -4,6 +4,10 @@ title: "setPrimaryWallet"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "setPrimaryWallet", - "params": { - "params": { - "partyId": "" - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -"" -``` - -
-
- -
- ## Protocol Details @@ -266,3 +221,56 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "setPrimaryWallet", + "params": { + "params": { + "partyId": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +"" +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/sign.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/sign.mdx index f031eaa..683f2e1 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/sign.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/sign.mdx @@ -4,6 +4,10 @@ title: "sign"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "sign", - "params": { - "params": { - "preparedTransaction": "", - "preparedTransactionHash": "", - "commandId": "", - "partyId": "" - } - } -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "signature": "", - "partyId": "", - "signedBy": "" -} -``` - -
-
- -
- ## Protocol Details @@ -413,3 +361,63 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "sign", + "params": { + "params": { + "preparedTransaction": "", + "preparedTransactionHash": "", + "commandId": "", + "partyId": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "signature": "", + "partyId": "", + "signedBy": "" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/syncwallets.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/syncwallets.mdx index ccf835f..b1ee07f 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/syncwallets.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/syncwallets.mdx @@ -4,6 +4,10 @@ title: "syncWallets"
+
+
+ + - -
- -
-
-
- cURL - -
- -```bash cURL -curl \ - \ - -H 'content-type: application/json' \ - --data @- <<'EOF' -{ - "jsonrpc": "2.0", - "id": 1, - "method": "syncWallets" -} -EOF -``` - -
-
- -
-
-
- Result - - application/json - -
- -```json Result -{ - "added": [ - { - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" - } - ], - "updated": [ - { - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" - } - ], - "disabled": [ - { - "primary": "", - "partyId": "", - "status": "", - "hint": "", - "publicKey": "", - "namespace": "", - "networkId": "", - "signingProviderId": "" - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -315,3 +238,88 @@ EOF + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "syncWallets" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "added": [ + { + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" + } + ], + "updated": [ + { + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" + } + ], + "disabled": [ + { + "primary": "", + "partyId": "", + "status": "", + "hint": "", + "publicKey": "", + "namespace": "", + "networkId": "", + "signingProviderId": "" + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/commandinspectionservice/getcommandstatus.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/commandinspectionservice/getcommandstatus.mdx index edf34a0..824cfbd 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/commandinspectionservice/getcommandstatus.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/commandinspectionservice/getcommandstatus.mdx @@ -4,6 +4,10 @@ title: "GetCommandStatus"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.admin.CommandInspectionService/GetCommandStatus <<'EOF' -{ - "commandIdPrefix": "string", - "state": "COMMAND_STATE_UNSPECIFIED", - "limit": 0 -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "commandStatus": [ - { - "started": "string", - "completed": "string", - "completion": { - "commandId": "string", - "status": "string", - "updateId": "string", - "userId": "string", - "actAs": [ - "string" - ], - "submissionId": "string", - "deduplicationOffset": "0" - }, - "state": "COMMAND_STATE_UNSPECIFIED", - "commands": [ - { - "create": { - "templateId": "string", - "createArguments": "string" - } - } - ], - "requestStatistics": { - "envelopes": 0, - "requestSize": 0, - "recipients": 0 - }, - "updates": { - "created": [ - { - "templateId": "string", - "contractId": "string", - "contractKey": "string" - } - ], - "archived": [ - { - "templateId": "string", - "contractId": "string", - "contractKey": "string" - } - ], - "exercised": 0, - "fetched": 0, - "lookedUpByKey": 0 - } - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -1099,3 +1007,103 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.CommandInspectionService/GetCommandStatus <<'EOF' +{ + "commandIdPrefix": "string", + "state": "COMMAND_STATE_UNSPECIFIED", + "limit": 0 +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "commandStatus": [ + { + "started": "string", + "completed": "string", + "completion": { + "commandId": "string", + "status": "string", + "updateId": "string", + "userId": "string", + "actAs": [ + "string" + ], + "submissionId": "string", + "deduplicationOffset": "0" + }, + "state": "COMMAND_STATE_UNSPECIFIED", + "commands": [ + { + "create": { + "templateId": "string", + "createArguments": "string" + } + } + ], + "requestStatistics": { + "envelopes": 0, + "requestSize": 0, + "recipients": 0 + }, + "updates": { + "created": [ + { + "templateId": "string", + "contractId": "string", + "contractKey": "string" + } + ], + "archived": [ + { + "templateId": "string", + "contractId": "string", + "contractKey": "string" + } + ], + "exercised": 0, + "fetched": 0, + "lookedUpByKey": 0 + } + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/createidentityproviderconfig.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/createidentityproviderconfig.mdx index 998f4a7..1496d6e 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/createidentityproviderconfig.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/createidentityproviderconfig.mdx @@ -4,6 +4,10 @@ title: "CreateIdentityProviderConfig"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.admin.IdentityProviderConfigService/CreateIdentityProviderConfig <<'EOF' -{ - "identityProviderConfig": { - "identityProviderId": "string", - "isDeactivated": true, - "issuer": "string", - "jwksUrl": "string", - "audience": "string" - } -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "identityProviderConfig": { - "identityProviderId": "string", - "isDeactivated": true, - "issuer": "string", - "jwksUrl": "string", - "audience": "string" - } -} -``` - -
-
- -
- ## Protocol Details @@ -386,3 +333,64 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.IdentityProviderConfigService/CreateIdentityProviderConfig <<'EOF' +{ + "identityProviderConfig": { + "identityProviderId": "string", + "isDeactivated": true, + "issuer": "string", + "jwksUrl": "string", + "audience": "string" + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "identityProviderConfig": { + "identityProviderId": "string", + "isDeactivated": true, + "issuer": "string", + "jwksUrl": "string", + "audience": "string" + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/deleteidentityproviderconfig.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/deleteidentityproviderconfig.mdx index aa97c25..9eb272a 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/deleteidentityproviderconfig.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/deleteidentityproviderconfig.mdx @@ -4,6 +4,10 @@ title: "DeleteIdentityProviderConfig"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.admin.IdentityProviderConfigService/DeleteIdentityProviderConfig <<'EOF' -{ - "identityProviderId": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -278,3 +239,50 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.IdentityProviderConfigService/DeleteIdentityProviderConfig <<'EOF' +{ + "identityProviderId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/getidentityproviderconfig.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/getidentityproviderconfig.mdx index d6f239a..9682f2f 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/getidentityproviderconfig.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/getidentityproviderconfig.mdx @@ -4,6 +4,10 @@ title: "GetIdentityProviderConfig"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.admin.IdentityProviderConfigService/GetIdentityProviderConfig <<'EOF' -{ - "identityProviderId": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "identityProviderConfig": { - "identityProviderId": "string", - "isDeactivated": true, - "issuer": "string", - "jwksUrl": "string", - "audience": "string" - } -} -``` - -
-
- -
- ## Protocol Details @@ -380,3 +333,58 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.IdentityProviderConfigService/GetIdentityProviderConfig <<'EOF' +{ + "identityProviderId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "identityProviderConfig": { + "identityProviderId": "string", + "isDeactivated": true, + "issuer": "string", + "jwksUrl": "string", + "audience": "string" + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/listidentityproviderconfigs.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/listidentityproviderconfigs.mdx index fc22b51..d77a466 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/listidentityproviderconfigs.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/listidentityproviderconfigs.mdx @@ -4,6 +4,10 @@ title: "ListIdentityProviderConfigs"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.admin.IdentityProviderConfigService/ListIdentityProviderConfigs <<'EOF' -{} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "identityProviderConfigs": [ - { - "identityProviderId": "string", - "isDeactivated": true, - "issuer": "string", - "jwksUrl": "string", - "audience": "string" - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -350,3 +303,58 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.IdentityProviderConfigService/ListIdentityProviderConfigs <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "identityProviderConfigs": [ + { + "identityProviderId": "string", + "isDeactivated": true, + "issuer": "string", + "jwksUrl": "string", + "audience": "string" + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/updateidentityproviderconfig.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/updateidentityproviderconfig.mdx index 1be2d17..0c774c4 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/updateidentityproviderconfig.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/updateidentityproviderconfig.mdx @@ -4,6 +4,10 @@ title: "UpdateIdentityProviderConfig"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.admin.IdentityProviderConfigService/UpdateIdentityProviderConfig <<'EOF' -{ - "identityProviderConfig": { - "identityProviderId": "string", - "isDeactivated": true, - "issuer": "string", - "jwksUrl": "string", - "audience": "string" - }, - "updateMask": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "identityProviderConfig": { - "identityProviderId": "string", - "isDeactivated": true, - "issuer": "string", - "jwksUrl": "string", - "audience": "string" - } -} -``` - -
-
- -
- ## Protocol Details @@ -413,3 +359,65 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.IdentityProviderConfigService/UpdateIdentityProviderConfig <<'EOF' +{ + "identityProviderConfig": { + "identityProviderId": "string", + "isDeactivated": true, + "issuer": "string", + "jwksUrl": "string", + "audience": "string" + }, + "updateMask": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "identityProviderConfig": { + "identityProviderId": "string", + "isDeactivated": true, + "issuer": "string", + "jwksUrl": "string", + "audience": "string" + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/listknownpackages.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/listknownpackages.mdx index 910c422..64a43b5 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/listknownpackages.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/listknownpackages.mdx @@ -4,6 +4,10 @@ title: "ListKnownPackages"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.admin.PackageManagementService/ListKnownPackages <<'EOF' -{} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "packageDetails": [ - { - "packageId": "string", - "packageSize": "0", - "knownSince": "string", - "name": "string", - "version": "string" - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -354,3 +307,58 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.PackageManagementService/ListKnownPackages <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "packageDetails": [ + { + "packageId": "string", + "packageSize": "0", + "knownSince": "string", + "name": "string", + "version": "string" + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/updatevettedpackages.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/updatevettedpackages.mdx index 1588388..676f7fa 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/updatevettedpackages.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/updatevettedpackages.mdx @@ -4,6 +4,10 @@ title: "UpdateVettedPackages"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.admin.PackageManagementService/UpdateVettedPackages <<'EOF' -{ - "changes": [ - { - "vet": { - "packages": [ - { - "packageId": "string", - "packageName": "string", - "packageVersion": "string" - } - ], - "newValidFromInclusive": "string", - "newValidUntilExclusive": "string" - } - } - ], - "dryRun": true, - "synchronizerId": "string", - "expectedTopologySerial": { - "prior": 0 - }, - "updateVettedPackagesForceFlags": [ - "UPDATE_VETTED_PACKAGES_FORCE_FLAG_UNSPECIFIED" - ] -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "pastVettedPackages": { - "packages": [ - { - "packageId": "string", - "validFromInclusive": "string", - "validUntilExclusive": "string", - "packageName": "string", - "packageVersion": "string" - } - ], - "participantId": "string", - "synchronizerId": "string", - "topologySerial": 0 - }, - "newVettedPackages": { - "packages": [ - { - "packageId": "string", - "validFromInclusive": "string", - "validUntilExclusive": "string", - "packageName": "string", - "packageVersion": "string" - } - ], - "participantId": "string", - "synchronizerId": "string", - "topologySerial": 0 - } -} -``` - -
-
- -
- ## Protocol Details @@ -799,3 +709,101 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.PackageManagementService/UpdateVettedPackages <<'EOF' +{ + "changes": [ + { + "vet": { + "packages": [ + { + "packageId": "string", + "packageName": "string", + "packageVersion": "string" + } + ], + "newValidFromInclusive": "string", + "newValidUntilExclusive": "string" + } + } + ], + "dryRun": true, + "synchronizerId": "string", + "expectedTopologySerial": { + "prior": 0 + }, + "updateVettedPackagesForceFlags": [ + "UPDATE_VETTED_PACKAGES_FORCE_FLAG_UNSPECIFIED" + ] +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "pastVettedPackages": { + "packages": [ + { + "packageId": "string", + "validFromInclusive": "string", + "validUntilExclusive": "string", + "packageName": "string", + "packageVersion": "string" + } + ], + "participantId": "string", + "synchronizerId": "string", + "topologySerial": 0 + }, + "newVettedPackages": { + "packages": [ + { + "packageId": "string", + "validFromInclusive": "string", + "validUntilExclusive": "string", + "packageName": "string", + "packageVersion": "string" + } + ], + "participantId": "string", + "synchronizerId": "string", + "topologySerial": 0 + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/uploaddarfile.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/uploaddarfile.mdx index 5c33e1a..165d1ed 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/uploaddarfile.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/uploaddarfile.mdx @@ -4,6 +4,10 @@ title: "UploadDarFile"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.admin.PackageManagementService/UploadDarFile <<'EOF' -{ - "darFile": "BASE64_ENCODED_BYTES", - "submissionId": "string", - "vettingChange": "VETTING_CHANGE_UNSPECIFIED", - "synchronizerId": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -366,3 +324,53 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.PackageManagementService/UploadDarFile <<'EOF' +{ + "darFile": "BASE64_ENCODED_BYTES", + "submissionId": "string", + "vettingChange": "VETTING_CHANGE_UNSPECIFIED", + "synchronizerId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/validatedarfile.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/validatedarfile.mdx index 4f421d4..8c300fd 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/validatedarfile.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/validatedarfile.mdx @@ -4,6 +4,10 @@ title: "ValidateDarFile"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.admin.PackageManagementService/ValidateDarFile <<'EOF' -{ - "darFile": "BASE64_ENCODED_BYTES", - "submissionId": "string", - "synchronizerId": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -324,3 +283,52 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.PackageManagementService/ValidateDarFile <<'EOF' +{ + "darFile": "BASE64_ENCODED_BYTES", + "submissionId": "string", + "synchronizerId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/participantpruningservice/prune.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/participantpruningservice/prune.mdx index fb1c7cc..7ee54f6 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/participantpruningservice/prune.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/participantpruningservice/prune.mdx @@ -4,6 +4,10 @@ title: "Prune"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.admin.ParticipantPruningService/Prune <<'EOF' -{ - "pruneUpTo": "0", - "submissionId": "string", - "pruneAllDivulgedContracts": true -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -324,3 +283,52 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.ParticipantPruningService/Prune <<'EOF' +{ + "pruneUpTo": "0", + "submissionId": "string", + "pruneAllDivulgedContracts": true +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/allocateexternalparty.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/allocateexternalparty.mdx index e3eb312..83da951 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/allocateexternalparty.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/allocateexternalparty.mdx @@ -4,6 +4,10 @@ title: "AllocateExternalParty"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.admin.PartyManagementService/AllocateExternalParty <<'EOF' -{ - "synchronizer": "string", - "onboardingTransactions": [ - { - "transaction": "BASE64_ENCODED_BYTES", - "signatures": [ - { - "format": "SIGNATURE_FORMAT_UNSPECIFIED", - "signature": "BASE64_ENCODED_BYTES", - "signedBy": "string", - "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" - } - ] - } - ], - "multiHashSignatures": [ - { - "format": "SIGNATURE_FORMAT_UNSPECIFIED", - "signature": "BASE64_ENCODED_BYTES", - "signedBy": "string", - "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" - } - ], - "identityProviderId": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "partyId": "string" -} -``` - -
-
- -
- ## Protocol Details @@ -526,3 +463,74 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.PartyManagementService/AllocateExternalParty <<'EOF' +{ + "synchronizer": "string", + "onboardingTransactions": [ + { + "transaction": "BASE64_ENCODED_BYTES", + "signatures": [ + { + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signedBy": "string", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" + } + ] + } + ], + "multiHashSignatures": [ + { + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signedBy": "string", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" + } + ], + "identityProviderId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "partyId": "string" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/allocateparty.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/allocateparty.mdx index c688208..b64323b 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/allocateparty.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/allocateparty.mdx @@ -4,6 +4,10 @@ title: "AllocateParty"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.admin.PartyManagementService/AllocateParty <<'EOF' -{ - "partyIdHint": "string", - "localMetadata": { - "resourceVersion": "string", - "annotations": [ - { - "key": "string" - } - ] - }, - "identityProviderId": "string", - "synchronizerId": "string", - "userId": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "partyDetails": { - "party": "string", - "isLocal": true, - "localMetadata": { - "resourceVersion": "string", - "annotations": [ - { - "key": "string" - } - ] - }, - "identityProviderId": "string" - } -} -``` - -
-
- -
- ## Protocol Details @@ -509,3 +445,75 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.PartyManagementService/AllocateParty <<'EOF' +{ + "partyIdHint": "string", + "localMetadata": { + "resourceVersion": "string", + "annotations": [ + { + "key": "string" + } + ] + }, + "identityProviderId": "string", + "synchronizerId": "string", + "userId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "partyDetails": { + "party": "string", + "isLocal": true, + "localMetadata": { + "resourceVersion": "string", + "annotations": [ + { + "key": "string" + } + ] + }, + "identityProviderId": "string" + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/generateexternalpartytopology.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/generateexternalpartytopology.mdx index 63f65d4..05c00cf 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/generateexternalpartytopology.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/generateexternalpartytopology.mdx @@ -4,6 +4,10 @@ title: "GenerateExternalPartyTopology"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.admin.PartyManagementService/GenerateExternalPartyTopology <<'EOF' -{ - "synchronizer": "string", - "partyHint": "string", - "publicKey": { - "format": "CRYPTO_KEY_FORMAT_UNSPECIFIED", - "keyData": "BASE64_ENCODED_BYTES", - "keySpec": "SIGNING_KEY_SPEC_UNSPECIFIED" - }, - "localParticipantObservationOnly": true, - "otherConfirmingParticipantUids": [ - "string" - ], - "confirmationThreshold": 0, - "observingParticipantUids": [ - "string" - ] -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "partyId": "string", - "publicKeyFingerprint": "string", - "topologyTransactions": [ - "BASE64_ENCODED_BYTES" - ], - "multiHash": "BASE64_ENCODED_BYTES" -} -``` - -
-
- -
- ## Protocol Details @@ -617,3 +557,71 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.PartyManagementService/GenerateExternalPartyTopology <<'EOF' +{ + "synchronizer": "string", + "partyHint": "string", + "publicKey": { + "format": "CRYPTO_KEY_FORMAT_UNSPECIFIED", + "keyData": "BASE64_ENCODED_BYTES", + "keySpec": "SIGNING_KEY_SPEC_UNSPECIFIED" + }, + "localParticipantObservationOnly": true, + "otherConfirmingParticipantUids": [ + "string" + ], + "confirmationThreshold": 0, + "observingParticipantUids": [ + "string" + ] +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "partyId": "string", + "publicKeyFingerprint": "string", + "topologyTransactions": [ + "BASE64_ENCODED_BYTES" + ], + "multiHash": "BASE64_ENCODED_BYTES" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/getparticipantid.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/getparticipantid.mdx index 5cf16b8..4753026 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/getparticipantid.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/getparticipantid.mdx @@ -4,6 +4,10 @@ title: "GetParticipantId"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.admin.PartyManagementService/GetParticipantId <<'EOF' -{} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "participantId": "string" -} -``` - -
-
- -
- ## Protocol Details @@ -278,3 +239,50 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.PartyManagementService/GetParticipantId <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "participantId": "string" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/getparties.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/getparties.mdx index c4405e4..4311005 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/getparties.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/getparties.mdx @@ -4,6 +4,10 @@ title: "GetParties"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.admin.PartyManagementService/GetParties <<'EOF' -{ - "parties": [ - "string" - ], - "identityProviderId": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "partyDetails": [ - { - "party": "string", - "isLocal": true, - "localMetadata": { - "resourceVersion": "string", - "annotations": [ - { - "key": "string" - } - ] - }, - "identityProviderId": "string" - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -441,3 +383,69 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.PartyManagementService/GetParties <<'EOF' +{ + "parties": [ + "string" + ], + "identityProviderId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "partyDetails": [ + { + "party": "string", + "isLocal": true, + "localMetadata": { + "resourceVersion": "string", + "annotations": [ + { + "key": "string" + } + ] + }, + "identityProviderId": "string" + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/listknownparties.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/listknownparties.mdx index b9b4594..dc2ea18 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/listknownparties.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/listknownparties.mdx @@ -4,6 +4,10 @@ title: "ListKnownParties"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.admin.PartyManagementService/ListKnownParties <<'EOF' -{ - "pageToken": "string", - "pageSize": 0, - "identityProviderId": "string", - "filterParty": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "partyDetails": [ - { - "party": "string", - "isLocal": true, - "localMetadata": { - "resourceVersion": "string", - "annotations": [ - { - "key": "string" - } - ] - }, - "identityProviderId": "string" - } - ], - "nextPageToken": "string" -} -``` - -
-
- -
- ## Protocol Details @@ -508,3 +449,70 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.PartyManagementService/ListKnownParties <<'EOF' +{ + "pageToken": "string", + "pageSize": 0, + "identityProviderId": "string", + "filterParty": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "partyDetails": [ + { + "party": "string", + "isLocal": true, + "localMetadata": { + "resourceVersion": "string", + "annotations": [ + { + "key": "string" + } + ] + }, + "identityProviderId": "string" + } + ], + "nextPageToken": "string" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/updatepartydetails.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/updatepartydetails.mdx index 92f00dd..a5cacf1 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/updatepartydetails.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/updatepartydetails.mdx @@ -4,6 +4,10 @@ title: "UpdatePartyDetails"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.admin.PartyManagementService/UpdatePartyDetails <<'EOF' -{ - "partyDetails": { - "party": "string", - "isLocal": true, - "localMetadata": { - "resourceVersion": "string", - "annotations": [ - { - "key": "string" - } - ] - }, - "identityProviderId": "string" - }, - "updateMask": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "partyDetails": { - "party": "string", - "isLocal": true, - "localMetadata": { - "resourceVersion": "string", - "annotations": [ - { - "key": "string" - } - ] - }, - "identityProviderId": "string" - } -} -``` - -
-
- -
- ## Protocol Details @@ -449,3 +383,77 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.PartyManagementService/UpdatePartyDetails <<'EOF' +{ + "partyDetails": { + "party": "string", + "isLocal": true, + "localMetadata": { + "resourceVersion": "string", + "annotations": [ + { + "key": "string" + } + ] + }, + "identityProviderId": "string" + }, + "updateMask": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "partyDetails": { + "party": "string", + "isLocal": true, + "localMetadata": { + "resourceVersion": "string", + "annotations": [ + { + "key": "string" + } + ] + }, + "identityProviderId": "string" + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/updatepartyidentityproviderid.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/updatepartyidentityproviderid.mdx index 13596df..dbabe89 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/updatepartyidentityproviderid.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/updatepartyidentityproviderid.mdx @@ -4,6 +4,10 @@ title: "UpdatePartyIdentityProviderId"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.admin.PartyManagementService/UpdatePartyIdentityProviderId <<'EOF' -{ - "party": "string", - "sourceIdentityProviderId": "string", - "targetIdentityProviderId": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -324,3 +283,52 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.PartyManagementService/UpdatePartyIdentityProviderId <<'EOF' +{ + "party": "string", + "sourceIdentityProviderId": "string", + "targetIdentityProviderId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/createuser.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/createuser.mdx index 5a1436e..09aaf8e 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/createuser.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/createuser.mdx @@ -4,6 +4,10 @@ title: "CreateUser"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.admin.UserManagementService/CreateUser <<'EOF' -{ - "user": { - "id": "string", - "primaryParty": "string", - "isDeactivated": true, - "metadata": { - "resourceVersion": "string", - "annotations": [ - { - "key": "string" - } - ] - }, - "identityProviderId": "string" - }, - "rights": [ - { - "participantAdmin": {} - } - ] -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "user": { - "id": "string", - "primaryParty": "string", - "isDeactivated": true, - "metadata": { - "resourceVersion": "string", - "annotations": [ - { - "key": "string" - } - ] - }, - "identityProviderId": "string" - } -} -``` - -
-
- -
- ## Protocol Details @@ -664,3 +592,83 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.UserManagementService/CreateUser <<'EOF' +{ + "user": { + "id": "string", + "primaryParty": "string", + "isDeactivated": true, + "metadata": { + "resourceVersion": "string", + "annotations": [ + { + "key": "string" + } + ] + }, + "identityProviderId": "string" + }, + "rights": [ + { + "participantAdmin": {} + } + ] +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "user": { + "id": "string", + "primaryParty": "string", + "isDeactivated": true, + "metadata": { + "resourceVersion": "string", + "annotations": [ + { + "key": "string" + } + ] + }, + "identityProviderId": "string" + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/deleteuser.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/deleteuser.mdx index 7caaa1a..a582496 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/deleteuser.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/deleteuser.mdx @@ -4,6 +4,10 @@ title: "DeleteUser"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.admin.UserManagementService/DeleteUser <<'EOF' -{ - "userId": "string", - "identityProviderId": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -301,3 +261,51 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.UserManagementService/DeleteUser <<'EOF' +{ + "userId": "string", + "identityProviderId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/getuser.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/getuser.mdx index 31f34f8..4e95fac 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/getuser.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/getuser.mdx @@ -4,6 +4,10 @@ title: "GetUser"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.admin.UserManagementService/GetUser <<'EOF' -{ - "userId": "string", - "identityProviderId": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "user": { - "id": "string", - "primaryParty": "string", - "isDeactivated": true, - "metadata": { - "resourceVersion": "string", - "annotations": [ - { - "key": "string" - } - ] - }, - "identityProviderId": "string" - } -} -``` - -
-
- -
- ## Protocol Details @@ -449,3 +394,66 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.UserManagementService/GetUser <<'EOF' +{ + "userId": "string", + "identityProviderId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "user": { + "id": "string", + "primaryParty": "string", + "isDeactivated": true, + "metadata": { + "resourceVersion": "string", + "annotations": [ + { + "key": "string" + } + ] + }, + "identityProviderId": "string" + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/grantuserrights.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/grantuserrights.mdx index 5c92a83..1adb351 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/grantuserrights.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/grantuserrights.mdx @@ -4,6 +4,10 @@ title: "GrantUserRights"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.admin.UserManagementService/GrantUserRights <<'EOF' -{ - "userId": "string", - "rights": [ - { - "participantAdmin": {} - } - ], - "identityProviderId": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "newlyGrantedRights": [ - { - "participantAdmin": {} - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -562,3 +511,62 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.UserManagementService/GrantUserRights <<'EOF' +{ + "userId": "string", + "rights": [ + { + "participantAdmin": {} + } + ], + "identityProviderId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "newlyGrantedRights": [ + { + "participantAdmin": {} + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/listuserrights.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/listuserrights.mdx index 2a30351..5056d8c 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/listuserrights.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/listuserrights.mdx @@ -4,6 +4,10 @@ title: "ListUserRights"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.admin.UserManagementService/ListUserRights <<'EOF' -{ - "userId": "string", - "identityProviderId": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "rights": [ - { - "participantAdmin": {} - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -535,3 +489,57 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.UserManagementService/ListUserRights <<'EOF' +{ + "userId": "string", + "identityProviderId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "rights": [ + { + "participantAdmin": {} + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/listusers.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/listusers.mdx index 88f0d96..5dc1638 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/listusers.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/listusers.mdx @@ -4,6 +4,10 @@ title: "ListUsers"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.admin.UserManagementService/ListUsers <<'EOF' -{ - "pageToken": "string", - "pageSize": 0, - "identityProviderId": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "users": [ - { - "id": "string", - "primaryParty": "string", - "isDeactivated": true, - "metadata": { - "resourceVersion": "string", - "annotations": [ - { - "key": "string" - } - ] - }, - "identityProviderId": "string" - } - ], - "nextPageToken": "string" -} -``` - -
-
- -
- ## Protocol Details @@ -497,3 +438,70 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.UserManagementService/ListUsers <<'EOF' +{ + "pageToken": "string", + "pageSize": 0, + "identityProviderId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "users": [ + { + "id": "string", + "primaryParty": "string", + "isDeactivated": true, + "metadata": { + "resourceVersion": "string", + "annotations": [ + { + "key": "string" + } + ] + }, + "identityProviderId": "string" + } + ], + "nextPageToken": "string" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/revokeuserrights.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/revokeuserrights.mdx index 6670ba5..91f4e48 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/revokeuserrights.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/revokeuserrights.mdx @@ -4,6 +4,10 @@ title: "RevokeUserRights"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.admin.UserManagementService/RevokeUserRights <<'EOF' -{ - "userId": "string", - "rights": [ - { - "participantAdmin": {} - } - ], - "identityProviderId": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "newlyRevokedRights": [ - { - "participantAdmin": {} - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -562,3 +511,62 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.UserManagementService/RevokeUserRights <<'EOF' +{ + "userId": "string", + "rights": [ + { + "participantAdmin": {} + } + ], + "identityProviderId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "newlyRevokedRights": [ + { + "participantAdmin": {} + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/updateuser.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/updateuser.mdx index 5338e2f..e10e6f1 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/updateuser.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/updateuser.mdx @@ -4,6 +4,10 @@ title: "UpdateUser"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.admin.UserManagementService/UpdateUser <<'EOF' -{ - "user": { - "id": "string", - "primaryParty": "string", - "isDeactivated": true, - "metadata": { - "resourceVersion": "string", - "annotations": [ - { - "key": "string" - } - ] - }, - "identityProviderId": "string" - }, - "updateMask": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "user": { - "id": "string", - "primaryParty": "string", - "isDeactivated": true, - "metadata": { - "resourceVersion": "string", - "annotations": [ - { - "key": "string" - } - ] - }, - "identityProviderId": "string" - } -} -``` - -
-
- -
- ## Protocol Details @@ -462,3 +394,79 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.UserManagementService/UpdateUser <<'EOF' +{ + "user": { + "id": "string", + "primaryParty": "string", + "isDeactivated": true, + "metadata": { + "resourceVersion": "string", + "annotations": [ + { + "key": "string" + } + ] + }, + "identityProviderId": "string" + }, + "updateMask": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "user": { + "id": "string", + "primaryParty": "string", + "isDeactivated": true, + "metadata": { + "resourceVersion": "string", + "annotations": [ + { + "key": "string" + } + ] + }, + "identityProviderId": "string" + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/updateuseridentityproviderid.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/updateuseridentityproviderid.mdx index 63bec43..d8de10e 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/updateuseridentityproviderid.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/updateuseridentityproviderid.mdx @@ -4,6 +4,10 @@ title: "UpdateUserIdentityProviderId"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.admin.UserManagementService/UpdateUserIdentityProviderId <<'EOF' -{ - "userId": "string", - "sourceIdentityProviderId": "string", - "targetIdentityProviderId": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -324,3 +283,52 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.admin.UserManagementService/UpdateUserIdentityProviderId <<'EOF' +{ + "userId": "string", + "sourceIdentityProviderId": "string", + "targetIdentityProviderId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/executesubmission.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/executesubmission.mdx index 55f4aa7..6d12563 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/executesubmission.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/executesubmission.mdx @@ -4,6 +4,10 @@ title: "ExecuteSubmission"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.interactive.InteractiveSubmissionService/ExecuteSubmission <<'EOF' -{ - "preparedTransaction": { - "transaction": { - "version": "string", - "roots": [ - "string" - ], - "nodes": [ - { - "nodeId": "string", - "v1": {} - } - ], - "nodeSeeds": [ - { - "nodeId": 0, - "seed": "BASE64_ENCODED_BYTES" - } - ] - }, - "metadata": { - "submitterInfo": { - "actAs": [ - "string" - ], - "commandId": "string" - }, - "synchronizerId": "string", - "mediatorGroup": 0, - "transactionUuid": "string", - "preparationTime": "0", - "inputContracts": [ - { - "v1": {}, - "createdAt": "0", - "eventBlob": "BASE64_ENCODED_BYTES" - } - ], - "minLedgerEffectiveTime": "0", - "maxLedgerEffectiveTime": "0" - } - }, - "partySignatures": { - "signatures": [ - { - "party": "string", - "signatures": [ - { - "format": "SIGNATURE_FORMAT_UNSPECIFIED", - "signature": "BASE64_ENCODED_BYTES", - "signedBy": "string", - "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" - } - ] - } - ] - }, - "deduplicationDuration": "string", - "submissionId": "string", - "userId": "string", - "hashingSchemeVersion": "HASHING_SCHEME_VERSION_UNSPECIFIED", - "minLedgerTime": { - "minLedgerTimeAbs": "string" - } -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -1509,3 +1408,112 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.interactive.InteractiveSubmissionService/ExecuteSubmission <<'EOF' +{ + "preparedTransaction": { + "transaction": { + "version": "string", + "roots": [ + "string" + ], + "nodes": [ + { + "nodeId": "string", + "v1": {} + } + ], + "nodeSeeds": [ + { + "nodeId": 0, + "seed": "BASE64_ENCODED_BYTES" + } + ] + }, + "metadata": { + "submitterInfo": { + "actAs": [ + "string" + ], + "commandId": "string" + }, + "synchronizerId": "string", + "mediatorGroup": 0, + "transactionUuid": "string", + "preparationTime": "0", + "inputContracts": [ + { + "v1": {}, + "createdAt": "0", + "eventBlob": "BASE64_ENCODED_BYTES" + } + ], + "minLedgerEffectiveTime": "0", + "maxLedgerEffectiveTime": "0" + } + }, + "partySignatures": { + "signatures": [ + { + "party": "string", + "signatures": [ + { + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signedBy": "string", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" + } + ] + } + ] + }, + "deduplicationDuration": "string", + "submissionId": "string", + "userId": "string", + "hashingSchemeVersion": "HASHING_SCHEME_VERSION_UNSPECIFIED", + "minLedgerTime": { + "minLedgerTimeAbs": "string" + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/executesubmissionandwait.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/executesubmissionandwait.mdx index 8a56e9f..fed33a2 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/executesubmissionandwait.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/executesubmissionandwait.mdx @@ -4,6 +4,10 @@ title: "ExecuteSubmissionAndWait"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.interactive.InteractiveSubmissionService/ExecuteSubmissionAndWait <<'EOF' -{ - "preparedTransaction": { - "transaction": { - "version": "string", - "roots": [ - "string" - ], - "nodes": [ - { - "nodeId": "string", - "v1": {} - } - ], - "nodeSeeds": [ - { - "nodeId": 0, - "seed": "BASE64_ENCODED_BYTES" - } - ] - }, - "metadata": { - "submitterInfo": { - "actAs": [ - "string" - ], - "commandId": "string" - }, - "synchronizerId": "string", - "mediatorGroup": 0, - "transactionUuid": "string", - "preparationTime": "0", - "inputContracts": [ - { - "v1": {}, - "createdAt": "0", - "eventBlob": "BASE64_ENCODED_BYTES" - } - ], - "minLedgerEffectiveTime": "0", - "maxLedgerEffectiveTime": "0" - } - }, - "partySignatures": { - "signatures": [ - { - "party": "string", - "signatures": [ - { - "format": "SIGNATURE_FORMAT_UNSPECIFIED", - "signature": "BASE64_ENCODED_BYTES", - "signedBy": "string", - "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" - } - ] - } - ] - }, - "deduplicationDuration": "string", - "submissionId": "string", - "userId": "string", - "hashingSchemeVersion": "HASHING_SCHEME_VERSION_UNSPECIFIED", - "minLedgerTime": { - "minLedgerTimeAbs": "string" - } -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "updateId": "string", - "completionOffset": "0" -} -``` - -
-
- -
- ## Protocol Details @@ -1564,3 +1460,115 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.interactive.InteractiveSubmissionService/ExecuteSubmissionAndWait <<'EOF' +{ + "preparedTransaction": { + "transaction": { + "version": "string", + "roots": [ + "string" + ], + "nodes": [ + { + "nodeId": "string", + "v1": {} + } + ], + "nodeSeeds": [ + { + "nodeId": 0, + "seed": "BASE64_ENCODED_BYTES" + } + ] + }, + "metadata": { + "submitterInfo": { + "actAs": [ + "string" + ], + "commandId": "string" + }, + "synchronizerId": "string", + "mediatorGroup": 0, + "transactionUuid": "string", + "preparationTime": "0", + "inputContracts": [ + { + "v1": {}, + "createdAt": "0", + "eventBlob": "BASE64_ENCODED_BYTES" + } + ], + "minLedgerEffectiveTime": "0", + "maxLedgerEffectiveTime": "0" + } + }, + "partySignatures": { + "signatures": [ + { + "party": "string", + "signatures": [ + { + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signedBy": "string", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" + } + ] + } + ] + }, + "deduplicationDuration": "string", + "submissionId": "string", + "userId": "string", + "hashingSchemeVersion": "HASHING_SCHEME_VERSION_UNSPECIFIED", + "minLedgerTime": { + "minLedgerTimeAbs": "string" + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "updateId": "string", + "completionOffset": "0" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/executesubmissionandwaitfortransaction.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/executesubmissionandwaitfortransaction.mdx index 3da97b5..30900f9 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/executesubmissionandwaitfortransaction.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/executesubmissionandwaitfortransaction.mdx @@ -4,6 +4,10 @@ title: "ExecuteSubmissionAndWaitForTransaction"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.interactive.InteractiveSubmissionService/ExecuteSubmissionAndWaitForTransaction <<'EOF' -{ - "preparedTransaction": { - "transaction": { - "version": "string", - "roots": [ - "string" - ], - "nodes": [ - { - "nodeId": "string", - "v1": {} - } - ], - "nodeSeeds": [ - { - "nodeId": 0, - "seed": "BASE64_ENCODED_BYTES" - } - ] - }, - "metadata": { - "submitterInfo": { - "actAs": [ - "string" - ], - "commandId": "string" - }, - "synchronizerId": "string", - "mediatorGroup": 0, - "transactionUuid": "string", - "preparationTime": "0", - "inputContracts": [ - { - "v1": {}, - "createdAt": "0", - "eventBlob": "BASE64_ENCODED_BYTES" - } - ], - "minLedgerEffectiveTime": "0", - "maxLedgerEffectiveTime": "0" - } - }, - "partySignatures": { - "signatures": [ - { - "party": "string", - "signatures": [ - { - "format": "SIGNATURE_FORMAT_UNSPECIFIED", - "signature": "BASE64_ENCODED_BYTES", - "signedBy": "string", - "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" - } - ] - } - ] - }, - "deduplicationDuration": "string", - "submissionId": "string", - "userId": "string", - "hashingSchemeVersion": "HASHING_SCHEME_VERSION_UNSPECIFIED", - "minLedgerTime": { - "minLedgerTimeAbs": "string" - } -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "transaction": { - "updateId": "string", - "commandId": "string", - "workflowId": "string", - "effectiveAt": "string", - "events": [ - { - "created": { - "offset": "0", - "nodeId": 0, - "contractId": "string", - "templateId": "string", - "contractKey": "string", - "createArguments": "string", - "createdEventBlob": "BASE64_ENCODED_BYTES", - "interfaceViews": [ - {} - ] - } - } - ], - "offset": "0", - "synchronizerId": "string", - "traceContext": { - "traceparent": "string", - "tracestate": "string" - } - } -} -``` - -
-
- -
- ## Protocol Details @@ -2555,3 +2425,141 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.interactive.InteractiveSubmissionService/ExecuteSubmissionAndWaitForTransaction <<'EOF' +{ + "preparedTransaction": { + "transaction": { + "version": "string", + "roots": [ + "string" + ], + "nodes": [ + { + "nodeId": "string", + "v1": {} + } + ], + "nodeSeeds": [ + { + "nodeId": 0, + "seed": "BASE64_ENCODED_BYTES" + } + ] + }, + "metadata": { + "submitterInfo": { + "actAs": [ + "string" + ], + "commandId": "string" + }, + "synchronizerId": "string", + "mediatorGroup": 0, + "transactionUuid": "string", + "preparationTime": "0", + "inputContracts": [ + { + "v1": {}, + "createdAt": "0", + "eventBlob": "BASE64_ENCODED_BYTES" + } + ], + "minLedgerEffectiveTime": "0", + "maxLedgerEffectiveTime": "0" + } + }, + "partySignatures": { + "signatures": [ + { + "party": "string", + "signatures": [ + { + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signedBy": "string", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" + } + ] + } + ] + }, + "deduplicationDuration": "string", + "submissionId": "string", + "userId": "string", + "hashingSchemeVersion": "HASHING_SCHEME_VERSION_UNSPECIFIED", + "minLedgerTime": { + "minLedgerTimeAbs": "string" + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "transaction": { + "updateId": "string", + "commandId": "string", + "workflowId": "string", + "effectiveAt": "string", + "events": [ + { + "created": { + "offset": "0", + "nodeId": 0, + "contractId": "string", + "templateId": "string", + "contractKey": "string", + "createArguments": "string", + "createdEventBlob": "BASE64_ENCODED_BYTES", + "interfaceViews": [ + {} + ] + } + } + ], + "offset": "0", + "synchronizerId": "string", + "traceContext": { + "traceparent": "string", + "tracestate": "string" + } + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/getpreferredpackages.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/getpreferredpackages.mdx index a381627..fee480b 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/getpreferredpackages.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/getpreferredpackages.mdx @@ -4,6 +4,10 @@ title: "GetPreferredPackages"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.interactive.InteractiveSubmissionService/GetPreferredPackages <<'EOF' -{ - "packageVettingRequirements": [ - { - "parties": [ - "string" - ], - "packageName": "string" - } - ], - "synchronizerId": "string", - "vettingValidAt": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "packageReferences": [ - { - "packageId": "string", - "packageName": "string", - "packageVersion": "string" - } - ], - "synchronizerId": "string" -} -``` - -
-
- -
- ## Protocol Details @@ -473,3 +416,68 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.interactive.InteractiveSubmissionService/GetPreferredPackages <<'EOF' +{ + "packageVettingRequirements": [ + { + "parties": [ + "string" + ], + "packageName": "string" + } + ], + "synchronizerId": "string", + "vettingValidAt": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "packageReferences": [ + { + "packageId": "string", + "packageName": "string", + "packageVersion": "string" + } + ], + "synchronizerId": "string" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/getpreferredpackageversion.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/getpreferredpackageversion.mdx index b9a7e82..e35b15c 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/getpreferredpackageversion.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/getpreferredpackageversion.mdx @@ -4,6 +4,10 @@ title: "GetPreferredPackageVersion"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.interactive.InteractiveSubmissionService/GetPreferredPackageVersion <<'EOF' -{ - "parties": [ - "string" - ], - "packageName": "string", - "synchronizerId": "string", - "vettingValidAt": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "packagePreference": { - "packageReference": { - "packageId": "string", - "packageName": "string", - "packageVersion": "string" - }, - "synchronizerId": "string" - } -} -``` - -
-
- -
- ## Protocol Details @@ -469,3 +416,64 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.interactive.InteractiveSubmissionService/GetPreferredPackageVersion <<'EOF' +{ + "parties": [ + "string" + ], + "packageName": "string", + "synchronizerId": "string", + "vettingValidAt": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "packagePreference": { + "packageReference": { + "packageId": "string", + "packageName": "string", + "packageVersion": "string" + }, + "synchronizerId": "string" + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/preparesubmission.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/preparesubmission.mdx index dac04f2..bb36516 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/preparesubmission.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/preparesubmission.mdx @@ -4,6 +4,10 @@ title: "PrepareSubmission"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.interactive.InteractiveSubmissionService/PrepareSubmission <<'EOF' -{ - "userId": "string", - "commandId": "string", - "commands": [ - { - "create": { - "templateId": "string", - "createArguments": "string" - } - } - ], - "minLedgerTime": { - "minLedgerTimeAbs": "string" - }, - "maxRecordTime": "string", - "actAs": [ - "string" - ], - "readAs": [ - "string" - ], - "disclosedContracts": [ - { - "templateId": "string", - "contractId": "string", - "createdEventBlob": "BASE64_ENCODED_BYTES", - "synchronizerId": "string" - } - ] -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "preparedTransaction": { - "transaction": { - "version": "string", - "roots": [ - "string" - ], - "nodes": [ - { - "nodeId": "string", - "v1": {} - } - ], - "nodeSeeds": [ - { - "nodeId": 0, - "seed": "BASE64_ENCODED_BYTES" - } - ] - }, - "metadata": { - "submitterInfo": { - "actAs": [ - "string" - ], - "commandId": "string" - }, - "synchronizerId": "string", - "mediatorGroup": 0, - "transactionUuid": "string", - "preparationTime": "0", - "inputContracts": [ - { - "v1": {}, - "createdAt": "0", - "eventBlob": "BASE64_ENCODED_BYTES" - } - ], - "minLedgerEffectiveTime": "0", - "maxLedgerEffectiveTime": "0" - } - }, - "preparedTransactionHash": "BASE64_ENCODED_BYTES", - "hashingSchemeVersion": "HASHING_SCHEME_VERSION_UNSPECIFIED", - "hashingDetails": "string", - "costEstimation": { - "estimationTimestamp": "string", - "confirmationRequestTrafficCostEstimation": "0", - "confirmationResponseTrafficCostEstimation": "0", - "totalTrafficCostEstimation": "0" - } -} -``` - -
-
- -
- ## Protocol Details @@ -2057,3 +1940,128 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.interactive.InteractiveSubmissionService/PrepareSubmission <<'EOF' +{ + "userId": "string", + "commandId": "string", + "commands": [ + { + "create": { + "templateId": "string", + "createArguments": "string" + } + } + ], + "minLedgerTime": { + "minLedgerTimeAbs": "string" + }, + "maxRecordTime": "string", + "actAs": [ + "string" + ], + "readAs": [ + "string" + ], + "disclosedContracts": [ + { + "templateId": "string", + "contractId": "string", + "createdEventBlob": "BASE64_ENCODED_BYTES", + "synchronizerId": "string" + } + ] +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "preparedTransaction": { + "transaction": { + "version": "string", + "roots": [ + "string" + ], + "nodes": [ + { + "nodeId": "string", + "v1": {} + } + ], + "nodeSeeds": [ + { + "nodeId": 0, + "seed": "BASE64_ENCODED_BYTES" + } + ] + }, + "metadata": { + "submitterInfo": { + "actAs": [ + "string" + ], + "commandId": "string" + }, + "synchronizerId": "string", + "mediatorGroup": 0, + "transactionUuid": "string", + "preparationTime": "0", + "inputContracts": [ + { + "v1": {}, + "createdAt": "0", + "eventBlob": "BASE64_ENCODED_BYTES" + } + ], + "minLedgerEffectiveTime": "0", + "maxLedgerEffectiveTime": "0" + } + }, + "preparedTransactionHash": "BASE64_ENCODED_BYTES", + "hashingSchemeVersion": "HASHING_SCHEME_VERSION_UNSPECIFIED", + "hashingDetails": "string", + "costEstimation": { + "estimationTimestamp": "string", + "confirmationRequestTrafficCostEstimation": "0", + "confirmationResponseTrafficCostEstimation": "0", + "totalTrafficCostEstimation": "0" + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandcompletionservice/completionstream.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandcompletionservice/completionstream.mdx index 14b5489..54d49b1 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandcompletionservice/completionstream.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandcompletionservice/completionstream.mdx @@ -4,6 +4,10 @@ title: "CompletionStream"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.CommandCompletionService/CompletionStream <<'EOF' -{ - "userId": "string", - "parties": [ - "string" - ], - "beginExclusive": "0" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "completion": { - "commandId": "string", - "status": "string", - "updateId": "string", - "userId": "string", - "actAs": [ - "string" - ], - "submissionId": "string", - "deduplicationOffset": "0" - } -} -``` - -
-
- -
- ## Protocol Details @@ -618,3 +562,67 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.CommandCompletionService/CompletionStream <<'EOF' +{ + "userId": "string", + "parties": [ + "string" + ], + "beginExclusive": "0" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "completion": { + "commandId": "string", + "status": "string", + "updateId": "string", + "userId": "string", + "actAs": [ + "string" + ], + "submissionId": "string", + "deduplicationOffset": "0" + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandservice/submitandwait.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandservice/submitandwait.mdx index e120f3e..2668d6d 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandservice/submitandwait.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandservice/submitandwait.mdx @@ -4,6 +4,10 @@ title: "SubmitAndWait"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.CommandService/SubmitAndWait <<'EOF' -{ - "commands": { - "workflowId": "string", - "userId": "string", - "commandId": "string", - "commands": [ - { - "create": { - "templateId": "string", - "createArguments": "string" - } - } - ], - "deduplicationDuration": "string", - "minLedgerTimeAbs": "string", - "minLedgerTimeRel": "string" - } -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "updateId": "string", - "completionOffset": "0" -} -``` - -
-
- -
- ## Protocol Details @@ -873,3 +816,68 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.CommandService/SubmitAndWait <<'EOF' +{ + "commands": { + "workflowId": "string", + "userId": "string", + "commandId": "string", + "commands": [ + { + "create": { + "templateId": "string", + "createArguments": "string" + } + } + ], + "deduplicationDuration": "string", + "minLedgerTimeAbs": "string", + "minLedgerTimeRel": "string" + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "updateId": "string", + "completionOffset": "0" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandservice/submitandwaitforreassignment.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandservice/submitandwaitforreassignment.mdx index 79085b5..a252d25 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandservice/submitandwaitforreassignment.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandservice/submitandwaitforreassignment.mdx @@ -4,6 +4,10 @@ title: "SubmitAndWaitForReassignment"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.CommandService/SubmitAndWaitForReassignment <<'EOF' -{ - "reassignmentCommands": { - "workflowId": "string", - "userId": "string", - "commandId": "string", - "submitter": "string", - "submissionId": "string", - "commands": [ - { - "unassignCommand": { - "contractId": "string", - "source": "string", - "target": "string" - } - } - ] - }, - "eventFormat": { - "filtersByParty": [ - { - "key": { - "cumulative": [ - { - "wildcardFilter": {} - } - ] - } - } - ], - "filtersForAnyParty": { - "cumulative": [ - { - "wildcardFilter": {} - } - ] - }, - "verbose": true - } -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "reassignment": { - "updateId": "string", - "commandId": "string", - "workflowId": "string", - "offset": "0", - "events": [ - { - "unassigned": { - "reassignmentId": "string", - "contractId": "string", - "templateId": "string", - "source": "string", - "target": "string", - "submitter": "string", - "reassignmentCounter": "0", - "assignmentExclusivity": "string" - } - } - ], - "traceContext": { - "traceparent": "string", - "tracestate": "string" - }, - "recordTime": "string", - "synchronizerId": "string" - } -} -``` - -
-
- -
- ## Protocol Details @@ -1429,3 +1327,113 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.CommandService/SubmitAndWaitForReassignment <<'EOF' +{ + "reassignmentCommands": { + "workflowId": "string", + "userId": "string", + "commandId": "string", + "submitter": "string", + "submissionId": "string", + "commands": [ + { + "unassignCommand": { + "contractId": "string", + "source": "string", + "target": "string" + } + } + ] + }, + "eventFormat": { + "filtersByParty": [ + { + "key": { + "cumulative": [ + { + "wildcardFilter": {} + } + ] + } + } + ], + "filtersForAnyParty": { + "cumulative": [ + { + "wildcardFilter": {} + } + ] + }, + "verbose": true + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "reassignment": { + "updateId": "string", + "commandId": "string", + "workflowId": "string", + "offset": "0", + "events": [ + { + "unassigned": { + "reassignmentId": "string", + "contractId": "string", + "templateId": "string", + "source": "string", + "target": "string", + "submitter": "string", + "reassignmentCounter": "0", + "assignmentExclusivity": "string" + } + } + ], + "traceContext": { + "traceparent": "string", + "tracestate": "string" + }, + "recordTime": "string", + "synchronizerId": "string" + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandservice/submitandwaitfortransaction.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandservice/submitandwaitfortransaction.mdx index f027cdb..d8b683b 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandservice/submitandwaitfortransaction.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandservice/submitandwaitfortransaction.mdx @@ -4,6 +4,10 @@ title: "SubmitAndWaitForTransaction"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.CommandService/SubmitAndWaitForTransaction <<'EOF' -{ - "commands": { - "workflowId": "string", - "userId": "string", - "commandId": "string", - "commands": [ - { - "create": { - "templateId": "string", - "createArguments": "string" - } - } - ], - "deduplicationDuration": "string", - "minLedgerTimeAbs": "string", - "minLedgerTimeRel": "string" - }, - "transactionFormat": { - "eventFormat": { - "filtersByParty": [ - { - "key": { - "cumulative": [ - {} - ] - } - } - ], - "filtersForAnyParty": { - "cumulative": [ - {} - ] - }, - "verbose": true - }, - "transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED" - } -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "transaction": { - "updateId": "string", - "commandId": "string", - "workflowId": "string", - "effectiveAt": "string", - "events": [ - { - "created": { - "offset": "0", - "nodeId": 0, - "contractId": "string", - "templateId": "string", - "contractKey": "string", - "createArguments": "string", - "createdEventBlob": "BASE64_ENCODED_BYTES", - "interfaceViews": [ - {} - ] - } - } - ], - "offset": "0", - "synchronizerId": "string", - "traceContext": { - "traceparent": "string", - "tracestate": "string" - } - } -} -``` - -
-
- -
- ## Protocol Details @@ -1884,3 +1781,114 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.CommandService/SubmitAndWaitForTransaction <<'EOF' +{ + "commands": { + "workflowId": "string", + "userId": "string", + "commandId": "string", + "commands": [ + { + "create": { + "templateId": "string", + "createArguments": "string" + } + } + ], + "deduplicationDuration": "string", + "minLedgerTimeAbs": "string", + "minLedgerTimeRel": "string" + }, + "transactionFormat": { + "eventFormat": { + "filtersByParty": [ + { + "key": { + "cumulative": [ + {} + ] + } + } + ], + "filtersForAnyParty": { + "cumulative": [ + {} + ] + }, + "verbose": true + }, + "transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED" + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "transaction": { + "updateId": "string", + "commandId": "string", + "workflowId": "string", + "effectiveAt": "string", + "events": [ + { + "created": { + "offset": "0", + "nodeId": 0, + "contractId": "string", + "templateId": "string", + "contractKey": "string", + "createArguments": "string", + "createdEventBlob": "BASE64_ENCODED_BYTES", + "interfaceViews": [ + {} + ] + } + } + ], + "offset": "0", + "synchronizerId": "string", + "traceContext": { + "traceparent": "string", + "tracestate": "string" + } + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandsubmissionservice/submit.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandsubmissionservice/submit.mdx index a316478..411416b 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandsubmissionservice/submit.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandsubmissionservice/submit.mdx @@ -4,6 +4,10 @@ title: "Submit"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.CommandSubmissionService/Submit <<'EOF' -{ - "commands": { - "workflowId": "string", - "userId": "string", - "commandId": "string", - "commands": [ - { - "create": { - "templateId": "string", - "createArguments": "string" - } - } - ], - "deduplicationDuration": "string", - "minLedgerTimeAbs": "string", - "minLedgerTimeRel": "string" - } -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -818,3 +764,65 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.CommandSubmissionService/Submit <<'EOF' +{ + "commands": { + "workflowId": "string", + "userId": "string", + "commandId": "string", + "commands": [ + { + "create": { + "templateId": "string", + "createArguments": "string" + } + } + ], + "deduplicationDuration": "string", + "minLedgerTimeAbs": "string", + "minLedgerTimeRel": "string" + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandsubmissionservice/submitreassignment.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandsubmissionservice/submitreassignment.mdx index fb91d06..dbef0c2 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandsubmissionservice/submitreassignment.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandsubmissionservice/submitreassignment.mdx @@ -4,6 +4,10 @@ title: "SubmitReassignment"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.CommandSubmissionService/SubmitReassignment <<'EOF' -{ - "reassignmentCommands": { - "workflowId": "string", - "userId": "string", - "commandId": "string", - "submitter": "string", - "submissionId": "string", - "commands": [ - { - "unassignCommand": { - "contractId": "string", - "source": "string", - "target": "string" - } - } - ] - } -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -495,3 +441,65 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.CommandSubmissionService/SubmitReassignment <<'EOF' +{ + "reassignmentCommands": { + "workflowId": "string", + "userId": "string", + "commandId": "string", + "submitter": "string", + "submissionId": "string", + "commands": [ + { + "unassignCommand": { + "contractId": "string", + "source": "string", + "target": "string" + } + } + ] + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/contractservice/getcontract.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/contractservice/getcontract.mdx index cc6d970..468de72 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/contractservice/getcontract.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/contractservice/getcontract.mdx @@ -4,6 +4,10 @@ title: "GetContract"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.ContractService/GetContract <<'EOF' -{ - "contractId": "string", - "queryingParties": [ - "string" - ] -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "createdEvent": { - "offset": "0", - "nodeId": 0, - "contractId": "string", - "templateId": "string", - "contractKey": "string", - "createArguments": "string", - "createdEventBlob": "BASE64_ENCODED_BYTES", - "interfaceViews": [ - { - "interfaceId": "string", - "viewStatus": "string", - "viewValue": "string" - } - ] - } -} -``` - -
-
- -
- ## Protocol Details @@ -574,3 +515,70 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.ContractService/GetContract <<'EOF' +{ + "contractId": "string", + "queryingParties": [ + "string" + ] +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "createdEvent": { + "offset": "0", + "nodeId": 0, + "contractId": "string", + "templateId": "string", + "contractKey": "string", + "createArguments": "string", + "createdEventBlob": "BASE64_ENCODED_BYTES", + "interfaceViews": [ + { + "interfaceId": "string", + "viewStatus": "string", + "viewValue": "string" + } + ] + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/eventqueryservice/geteventsbycontractid.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/eventqueryservice/geteventsbycontractid.mdx index e6e9d04..86c3352 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/eventqueryservice/geteventsbycontractid.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/eventqueryservice/geteventsbycontractid.mdx @@ -4,6 +4,10 @@ title: "GetEventsByContractId"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.EventQueryService/GetEventsByContractId <<'EOF' -{ - "contractId": "string", - "eventFormat": { - "filtersByParty": [ - { - "key": { - "cumulative": [ - { - "wildcardFilter": {} - } - ] - } - } - ], - "filtersForAnyParty": { - "cumulative": [ - { - "wildcardFilter": {} - } - ] - }, - "verbose": true - } -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "created": { - "createdEvent": { - "offset": "0", - "nodeId": 0, - "contractId": "string", - "templateId": "string", - "contractKey": "string", - "createArguments": "string", - "createdEventBlob": "BASE64_ENCODED_BYTES", - "interfaceViews": [ - { - "interfaceId": "string", - "viewStatus": "string", - "viewValue": "string" - } - ] - }, - "synchronizerId": "string" - }, - "archived": { - "archivedEvent": { - "offset": "0", - "nodeId": 0, - "contractId": "string", - "templateId": "string", - "witnessParties": [ - "string" - ], - "packageName": "string", - "implementedInterfaces": [ - "string" - ] - }, - "synchronizerId": "string" - } -} -``` - -
-
- -
- ## Protocol Details @@ -1014,3 +918,107 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.EventQueryService/GetEventsByContractId <<'EOF' +{ + "contractId": "string", + "eventFormat": { + "filtersByParty": [ + { + "key": { + "cumulative": [ + { + "wildcardFilter": {} + } + ] + } + } + ], + "filtersForAnyParty": { + "cumulative": [ + { + "wildcardFilter": {} + } + ] + }, + "verbose": true + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "created": { + "createdEvent": { + "offset": "0", + "nodeId": 0, + "contractId": "string", + "templateId": "string", + "contractKey": "string", + "createArguments": "string", + "createdEventBlob": "BASE64_ENCODED_BYTES", + "interfaceViews": [ + { + "interfaceId": "string", + "viewStatus": "string", + "viewValue": "string" + } + ] + }, + "synchronizerId": "string" + }, + "archived": { + "archivedEvent": { + "offset": "0", + "nodeId": 0, + "contractId": "string", + "templateId": "string", + "witnessParties": [ + "string" + ], + "packageName": "string", + "implementedInterfaces": [ + "string" + ] + }, + "synchronizerId": "string" + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/getpackage.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/getpackage.mdx index 0370e15..ab637a6 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/getpackage.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/getpackage.mdx @@ -4,6 +4,10 @@ title: "GetPackage"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.PackageService/GetPackage <<'EOF' -{ - "packageId": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "hashFunction": "HASH_FUNCTION_SHA256", - "archivePayload": "BASE64_ENCODED_BYTES", - "hash": "string" -} -``` - -
-
- -
- ## Protocol Details @@ -371,3 +328,54 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.PackageService/GetPackage <<'EOF' +{ + "packageId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "hashFunction": "HASH_FUNCTION_SHA256", + "archivePayload": "BASE64_ENCODED_BYTES", + "hash": "string" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/getpackagestatus.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/getpackagestatus.mdx index a284e24..070d7dd 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/getpackagestatus.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/getpackagestatus.mdx @@ -4,6 +4,10 @@ title: "GetPackageStatus"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.PackageService/GetPackageStatus <<'EOF' -{ - "packageId": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "packageStatus": "PACKAGE_STATUS_UNSPECIFIED" -} -``` - -
-
- -
- ## Protocol Details @@ -327,3 +286,52 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.PackageService/GetPackageStatus <<'EOF' +{ + "packageId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "packageStatus": "PACKAGE_STATUS_UNSPECIFIED" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/listpackages.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/listpackages.mdx index a6eda10..307a58a 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/listpackages.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/listpackages.mdx @@ -4,6 +4,10 @@ title: "ListPackages"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.PackageService/ListPackages <<'EOF' -{} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "packageIds": [ - "string" - ] -} -``` - -
-
- -
- ## Protocol Details @@ -280,3 +239,52 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.PackageService/ListPackages <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "packageIds": [ + "string" + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/listvettedpackages.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/listvettedpackages.mdx index 964ac8f..c3e6e02 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/listvettedpackages.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/listvettedpackages.mdx @@ -4,6 +4,10 @@ title: "ListVettedPackages"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.PackageService/ListVettedPackages <<'EOF' -{ - "packageMetadataFilter": { - "packageIds": [ - "string" - ], - "packageNamePrefixes": [ - "string" - ] - }, - "topologyStateFilter": { - "participantIds": [ - "string" - ], - "synchronizerIds": [ - "string" - ] - }, - "pageToken": "string", - "pageSize": 0 -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "vettedPackages": [ - { - "packages": [ - { - "packageId": "string", - "validFromInclusive": "string", - "validUntilExclusive": "string", - "packageName": "string", - "packageVersion": "string" - } - ], - "participantId": "string", - "synchronizerId": "string", - "topologySerial": 0 - } - ], - "nextPageToken": "string" -} -``` - -
-
- -
- ## Protocol Details @@ -626,3 +552,85 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.PackageService/ListVettedPackages <<'EOF' +{ + "packageMetadataFilter": { + "packageIds": [ + "string" + ], + "packageNamePrefixes": [ + "string" + ] + }, + "topologyStateFilter": { + "participantIds": [ + "string" + ], + "synchronizerIds": [ + "string" + ] + }, + "pageToken": "string", + "pageSize": 0 +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "vettedPackages": [ + { + "packages": [ + { + "packageId": "string", + "validFromInclusive": "string", + "validUntilExclusive": "string", + "packageName": "string", + "packageVersion": "string" + } + ], + "participantId": "string", + "synchronizerId": "string", + "topologySerial": 0 + } + ], + "nextPageToken": "string" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getactivecontracts.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getactivecontracts.mdx index cd6ff0f..f79fe61 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getactivecontracts.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getactivecontracts.mdx @@ -4,6 +4,10 @@ title: "GetActiveContracts"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.StateService/GetActiveContracts <<'EOF' -{ - "activeAtOffset": "0", - "eventFormat": { - "filtersByParty": [ - { - "key": { - "cumulative": [ - { - "wildcardFilter": {} - } - ] - } - } - ], - "filtersForAnyParty": { - "cumulative": [ - { - "wildcardFilter": {} - } - ] - }, - "verbose": true - } -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "workflowId": "string", - "activeContract": { - "createdEvent": { - "offset": "0", - "nodeId": 0, - "contractId": "string", - "templateId": "string", - "contractKey": "string", - "createArguments": "string", - "createdEventBlob": "BASE64_ENCODED_BYTES", - "interfaceViews": [ - { - "interfaceId": "string", - "viewStatus": "string", - "viewValue": "string" - } - ] - }, - "synchronizerId": "string", - "reassignmentCounter": "0" - } -} -``` - -
-
- -
- ## Protocol Details @@ -1214,3 +1131,94 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.StateService/GetActiveContracts <<'EOF' +{ + "activeAtOffset": "0", + "eventFormat": { + "filtersByParty": [ + { + "key": { + "cumulative": [ + { + "wildcardFilter": {} + } + ] + } + } + ], + "filtersForAnyParty": { + "cumulative": [ + { + "wildcardFilter": {} + } + ] + }, + "verbose": true + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "workflowId": "string", + "activeContract": { + "createdEvent": { + "offset": "0", + "nodeId": 0, + "contractId": "string", + "templateId": "string", + "contractKey": "string", + "createArguments": "string", + "createdEventBlob": "BASE64_ENCODED_BYTES", + "interfaceViews": [ + { + "interfaceId": "string", + "viewStatus": "string", + "viewValue": "string" + } + ] + }, + "synchronizerId": "string", + "reassignmentCounter": "0" + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getconnectedsynchronizers.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getconnectedsynchronizers.mdx index a01fa71..2094a28 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getconnectedsynchronizers.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getconnectedsynchronizers.mdx @@ -4,6 +4,10 @@ title: "GetConnectedSynchronizers"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.StateService/GetConnectedSynchronizers <<'EOF' -{ - "party": "string", - "participantId": "string", - "identityProviderId": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "connectedSynchronizers": [ - { - "synchronizerAlias": "string", - "synchronizerId": "string", - "permission": "PARTICIPANT_PERMISSION_UNSPECIFIED" - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -425,3 +376,60 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.StateService/GetConnectedSynchronizers <<'EOF' +{ + "party": "string", + "participantId": "string", + "identityProviderId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "connectedSynchronizers": [ + { + "synchronizerAlias": "string", + "synchronizerId": "string", + "permission": "PARTICIPANT_PERMISSION_UNSPECIFIED" + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getlatestprunedoffsets.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getlatestprunedoffsets.mdx index 1bde9ef..38afc80 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getlatestprunedoffsets.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getlatestprunedoffsets.mdx @@ -4,6 +4,10 @@ title: "GetLatestPrunedOffsets"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.StateService/GetLatestPrunedOffsets <<'EOF' -{} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "participantPrunedUpToInclusive": "0", - "allDivulgedContractsPrunedUpToInclusive": "0" -} -``` - -
-
- -
- ## Protocol Details @@ -301,3 +261,51 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.StateService/GetLatestPrunedOffsets <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "participantPrunedUpToInclusive": "0", + "allDivulgedContractsPrunedUpToInclusive": "0" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getledgerend.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getledgerend.mdx index c7516ea..ab74cff 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getledgerend.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getledgerend.mdx @@ -4,6 +4,10 @@ title: "GetLedgerEnd"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.StateService/GetLedgerEnd <<'EOF' -{} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "offset": "0" -} -``` - -
-
- -
- ## Protocol Details @@ -278,3 +239,50 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.StateService/GetLedgerEnd <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "offset": "0" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/updateservice/getupdatebyid.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/updateservice/getupdatebyid.mdx index 1555986..0c93ee9 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/updateservice/getupdatebyid.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/updateservice/getupdatebyid.mdx @@ -4,6 +4,10 @@ title: "GetUpdateById"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.UpdateService/GetUpdateById <<'EOF' -{ - "updateId": "string", - "updateFormat": { - "includeTransactions": { - "eventFormat": { - "filtersByParty": [ - { - "key": {} - } - ], - "filtersForAnyParty": {}, - "verbose": true - }, - "transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED" - }, - "includeReassignments": { - "filtersByParty": [ - { - "key": { - "cumulative": [ - {} - ] - } - } - ], - "filtersForAnyParty": { - "cumulative": [ - {} - ] - }, - "verbose": true - }, - "includeTopologyEvents": { - "includeParticipantAuthorizationEvents": { - "parties": [ - "string" - ] - } - } - } -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "transaction": { - "updateId": "string", - "commandId": "string", - "workflowId": "string", - "effectiveAt": "string", - "events": [ - { - "created": { - "offset": "0", - "nodeId": 0, - "contractId": "string", - "templateId": "string", - "contractKey": "string", - "createArguments": "string", - "createdEventBlob": "BASE64_ENCODED_BYTES", - "interfaceViews": [ - {} - ] - } - } - ], - "offset": "0", - "synchronizerId": "string", - "traceContext": { - "traceparent": "string", - "tracestate": "string" - } - } -} -``` - -
-
- -
- ## Protocol Details @@ -2111,3 +2005,117 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.UpdateService/GetUpdateById <<'EOF' +{ + "updateId": "string", + "updateFormat": { + "includeTransactions": { + "eventFormat": { + "filtersByParty": [ + { + "key": {} + } + ], + "filtersForAnyParty": {}, + "verbose": true + }, + "transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED" + }, + "includeReassignments": { + "filtersByParty": [ + { + "key": { + "cumulative": [ + {} + ] + } + } + ], + "filtersForAnyParty": { + "cumulative": [ + {} + ] + }, + "verbose": true + }, + "includeTopologyEvents": { + "includeParticipantAuthorizationEvents": { + "parties": [ + "string" + ] + } + } + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "transaction": { + "updateId": "string", + "commandId": "string", + "workflowId": "string", + "effectiveAt": "string", + "events": [ + { + "created": { + "offset": "0", + "nodeId": 0, + "contractId": "string", + "templateId": "string", + "contractKey": "string", + "createArguments": "string", + "createdEventBlob": "BASE64_ENCODED_BYTES", + "interfaceViews": [ + {} + ] + } + } + ], + "offset": "0", + "synchronizerId": "string", + "traceContext": { + "traceparent": "string", + "tracestate": "string" + } + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/updateservice/getupdatebyoffset.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/updateservice/getupdatebyoffset.mdx index a3335fd..f856ead 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/updateservice/getupdatebyoffset.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/updateservice/getupdatebyoffset.mdx @@ -4,6 +4,10 @@ title: "GetUpdateByOffset"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.UpdateService/GetUpdateByOffset <<'EOF' -{ - "offset": "0", - "updateFormat": { - "includeTransactions": { - "eventFormat": { - "filtersByParty": [ - { - "key": {} - } - ], - "filtersForAnyParty": {}, - "verbose": true - }, - "transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED" - }, - "includeReassignments": { - "filtersByParty": [ - { - "key": { - "cumulative": [ - {} - ] - } - } - ], - "filtersForAnyParty": { - "cumulative": [ - {} - ] - }, - "verbose": true - }, - "includeTopologyEvents": { - "includeParticipantAuthorizationEvents": { - "parties": [ - "string" - ] - } - } - } -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "transaction": { - "updateId": "string", - "commandId": "string", - "workflowId": "string", - "effectiveAt": "string", - "events": [ - { - "created": { - "offset": "0", - "nodeId": 0, - "contractId": "string", - "templateId": "string", - "contractKey": "string", - "createArguments": "string", - "createdEventBlob": "BASE64_ENCODED_BYTES", - "interfaceViews": [ - {} - ] - } - } - ], - "offset": "0", - "synchronizerId": "string", - "traceContext": { - "traceparent": "string", - "tracestate": "string" - } - } -} -``` - -
-
- -
- ## Protocol Details @@ -2111,3 +2005,117 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.UpdateService/GetUpdateByOffset <<'EOF' +{ + "offset": "0", + "updateFormat": { + "includeTransactions": { + "eventFormat": { + "filtersByParty": [ + { + "key": {} + } + ], + "filtersForAnyParty": {}, + "verbose": true + }, + "transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED" + }, + "includeReassignments": { + "filtersByParty": [ + { + "key": { + "cumulative": [ + {} + ] + } + } + ], + "filtersForAnyParty": { + "cumulative": [ + {} + ] + }, + "verbose": true + }, + "includeTopologyEvents": { + "includeParticipantAuthorizationEvents": { + "parties": [ + "string" + ] + } + } + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "transaction": { + "updateId": "string", + "commandId": "string", + "workflowId": "string", + "effectiveAt": "string", + "events": [ + { + "created": { + "offset": "0", + "nodeId": 0, + "contractId": "string", + "templateId": "string", + "contractKey": "string", + "createArguments": "string", + "createdEventBlob": "BASE64_ENCODED_BYTES", + "interfaceViews": [ + {} + ] + } + } + ], + "offset": "0", + "synchronizerId": "string", + "traceContext": { + "traceparent": "string", + "tracestate": "string" + } + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/updateservice/getupdates.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/updateservice/getupdates.mdx index c7bbd81..2a759c8 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/updateservice/getupdates.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/updateservice/getupdates.mdx @@ -4,6 +4,10 @@ title: "GetUpdates"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.UpdateService/GetUpdates <<'EOF' -{ - "beginExclusive": "0", - "endInclusive": "0", - "updateFormat": { - "includeTransactions": { - "eventFormat": { - "filtersByParty": [ - { - "key": {} - } - ], - "filtersForAnyParty": {}, - "verbose": true - }, - "transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED" - }, - "includeReassignments": { - "filtersByParty": [ - { - "key": { - "cumulative": [ - {} - ] - } - } - ], - "filtersForAnyParty": { - "cumulative": [ - {} - ] - }, - "verbose": true - }, - "includeTopologyEvents": { - "includeParticipantAuthorizationEvents": { - "parties": [ - "string" - ] - } - } - } -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "transaction": { - "updateId": "string", - "commandId": "string", - "workflowId": "string", - "effectiveAt": "string", - "events": [ - { - "created": { - "offset": "0", - "nodeId": 0, - "contractId": "string", - "templateId": "string", - "contractKey": "string", - "createArguments": "string", - "createdEventBlob": "BASE64_ENCODED_BYTES", - "interfaceViews": [ - {} - ] - } - } - ], - "offset": "0", - "synchronizerId": "string", - "traceContext": { - "traceparent": "string", - "tracestate": "string" - } - } -} -``` - -
-
- -
- ## Protocol Details @@ -2221,3 +2113,119 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.UpdateService/GetUpdates <<'EOF' +{ + "beginExclusive": "0", + "endInclusive": "0", + "updateFormat": { + "includeTransactions": { + "eventFormat": { + "filtersByParty": [ + { + "key": {} + } + ], + "filtersForAnyParty": {}, + "verbose": true + }, + "transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED" + }, + "includeReassignments": { + "filtersByParty": [ + { + "key": { + "cumulative": [ + {} + ] + } + } + ], + "filtersForAnyParty": { + "cumulative": [ + {} + ] + }, + "verbose": true + }, + "includeTopologyEvents": { + "includeParticipantAuthorizationEvents": { + "parties": [ + "string" + ] + } + } + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "transaction": { + "updateId": "string", + "commandId": "string", + "workflowId": "string", + "effectiveAt": "string", + "events": [ + { + "created": { + "offset": "0", + "nodeId": 0, + "contractId": "string", + "templateId": "string", + "contractKey": "string", + "createArguments": "string", + "createdEventBlob": "BASE64_ENCODED_BYTES", + "interfaceViews": [ + {} + ] + } + } + ], + "offset": "0", + "synchronizerId": "string", + "traceContext": { + "traceparent": "string", + "tracestate": "string" + } + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/versionservice/getledgerapiversion.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/versionservice/getledgerapiversion.mdx index d5607b4..50d3396 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/versionservice/getledgerapiversion.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/versionservice/getledgerapiversion.mdx @@ -4,6 +4,10 @@ title: "GetLedgerApiVersion"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.daml.ledger.api.v2.VersionService/GetLedgerApiVersion <<'EOF' -{} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "version": "string", - "features": { - "experimental": { - "staticTime": { - "supported": true - }, - "commandInspectionService": { - "supported": true - } - }, - "userManagement": { - "supported": true, - "maxRightsPerUser": 0, - "maxUsersPageSize": 0 - }, - "partyManagement": { - "maxPartiesPageSize": 0 - }, - "offsetCheckpoint": { - "maxOffsetCheckpointEmissionDelay": "string" - }, - "packageFeature": { - "maxVettedPackagesPageSize": 0 - } - } -} -``` - -
-
- -
- ## Protocol Details @@ -585,3 +522,74 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.VersionService/GetLedgerApiVersion <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "version": "string", + "features": { + "experimental": { + "staticTime": { + "supported": true + }, + "commandInspectionService": { + "supported": true + } + }, + "userManagement": { + "supported": true, + "maxRightsPerUser": 0, + "maxUsersPageSize": 0 + }, + "partyManagement": { + "maxPartiesPageSize": 0 + }, + "offsetCheckpoint": { + "maxOffsetCheckpointEmissionDelay": "string" + }, + "packageFeature": { + "maxVettedPackagesPageSize": 0 + } + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/getlasterrors.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/getlasterrors.mdx index 2d837fd..339ec32 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/getlasterrors.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/getlasterrors.mdx @@ -4,6 +4,10 @@ title: "GetLastErrors"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.health.v30.StatusService/GetLastErrors <<'EOF' -{} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "errors": [ - { - "traceId": "string", - "message": "string" - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -310,3 +266,55 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.health.v30.StatusService/GetLastErrors <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "errors": [ + { + "traceId": "string", + "message": "string" + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/getlasterrortrace.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/getlasterrortrace.mdx index 1b85169..43cfba6 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/getlasterrortrace.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/getlasterrortrace.mdx @@ -4,6 +4,10 @@ title: "GetLastErrorTrace"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.health.v30.StatusService/GetLastErrorTrace <<'EOF' -{ - "traceId": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "messages": [ - "string" - ] -} -``` - -
-
- -
- ## Protocol Details @@ -308,3 +265,54 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.health.v30.StatusService/GetLastErrorTrace <<'EOF' +{ + "traceId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "messages": [ + "string" + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/healthdump.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/healthdump.mdx index aa631a4..db92f1d 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/healthdump.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/healthdump.mdx @@ -4,6 +4,10 @@ title: "HealthDump"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.health.v30.StatusService/HealthDump <<'EOF' -{ - "chunkSize": 0 -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "chunk": "BASE64_ENCODED_BYTES" -} -``` - -
-
- -
- ## Protocol Details @@ -311,3 +269,53 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.health.v30.StatusService/HealthDump <<'EOF' +{ + "chunkSize": 0 +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "chunk": "BASE64_ENCODED_BYTES" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/setloglevel.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/setloglevel.mdx index 64e6333..ddac348 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/setloglevel.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/setloglevel.mdx @@ -4,6 +4,10 @@ title: "SetLogLevel"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.health.v30.StatusService/SetLogLevel <<'EOF' -{ - "level": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -278,3 +239,50 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.health.v30.StatusService/SetLogLevel <<'EOF' +{ + "level": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-mediator-v30/mediatorstatusservice/mediatorstatus.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-mediator-v30/mediatorstatusservice/mediatorstatus.mdx index f1543ae..4a38a66 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-mediator-v30/mediatorstatusservice/mediatorstatus.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-mediator-v30/mediatorstatusservice/mediatorstatus.mdx @@ -4,6 +4,10 @@ title: "MediatorStatus"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.mediator.v30.MediatorStatusService/MediatorStatus <<'EOF' -{} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "status": { - "commonStatus": { - "uid": "string", - "uptime": "string", - "ports": [ - { - "key": 0 - } - ], - "active": true, - "topologyQueues": { - "manager": 0, - "dispatcher": 0, - "clients": 0 - }, - "components": [ - { - "name": "string", - "ok": {} - } - ], - "version": "string" - }, - "physicalSynchronizerId": "string", - "protocolVersion": 0 - } -} -``` - -
-
- -
- ## Protocol Details @@ -623,3 +559,75 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.mediator.v30.MediatorStatusService/MediatorStatus <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "status": { + "commonStatus": { + "uid": "string", + "uptime": "string", + "ports": [ + { + "key": 0 + } + ], + "active": true, + "topologyQueues": { + "manager": 0, + "dispatcher": 0, + "clients": 0 + }, + "components": [ + { + "name": "string", + "ok": {} + } + ], + "version": "string" + }, + "physicalSynchronizerId": "string", + "protocolVersion": 0 + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/enterpriseparticipantreplicationservice/setpassive.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/enterpriseparticipantreplicationservice/setpassive.mdx index b675d96..5142e6a 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/enterpriseparticipantreplicationservice/setpassive.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/enterpriseparticipantreplicationservice/setpassive.mdx @@ -4,6 +4,10 @@ title: "SetPassive"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.EnterpriseParticipantReplicationService/SetPassive <<'EOF' -{} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -246,3 +209,48 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.EnterpriseParticipantReplicationService/SetPassive <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getdar.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getdar.mdx index ee45abe..ed97f88 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getdar.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getdar.mdx @@ -4,6 +4,10 @@ title: "GetDar"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.PackageService/GetDar <<'EOF' -{ - "mainPackageId": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "payload": "BASE64_ENCODED_BYTES", - "data": { - "main": "string", - "name": "string", - "version": "string", - "description": "string" - } -} -``` - -
-
- -
- ## Protocol Details @@ -375,3 +328,58 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PackageService/GetDar <<'EOF' +{ + "mainPackageId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "payload": "BASE64_ENCODED_BYTES", + "data": { + "main": "string", + "name": "string", + "version": "string", + "description": "string" + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getdarcontents.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getdarcontents.mdx index 5204489..8d0dfc7 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getdarcontents.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getdarcontents.mdx @@ -4,6 +4,10 @@ title: "GetDarContents"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.PackageService/GetDarContents <<'EOF' -{ - "mainPackageId": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "description": { - "main": "string", - "name": "string", - "version": "string", - "description": "string" - }, - "packages": [ - { - "packageId": "string", - "name": "string", - "version": "string", - "uploadedAt": "string", - "size": 0 - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -441,3 +386,66 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PackageService/GetDarContents <<'EOF' +{ + "mainPackageId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "description": { + "main": "string", + "name": "string", + "version": "string", + "description": "string" + }, + "packages": [ + { + "packageId": "string", + "name": "string", + "version": "string", + "uploadedAt": "string", + "size": 0 + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getpackagecontents.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getpackagecontents.mdx index 6774e14..8b09d76 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getpackagecontents.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getpackagecontents.mdx @@ -4,6 +4,10 @@ title: "GetPackageContents"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.PackageService/GetPackageContents <<'EOF' -{ - "packageId": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "description": { - "packageId": "string", - "name": "string", - "version": "string", - "uploadedAt": "string", - "size": 0 - }, - "modules": [ - { - "name": "string" - } - ], - "isUtilityPackage": true, - "languageVersion": "string" -} -``` - -
-
- -
- ## Protocol Details @@ -449,3 +395,65 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PackageService/GetPackageContents <<'EOF' +{ + "packageId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "description": { + "packageId": "string", + "name": "string", + "version": "string", + "uploadedAt": "string", + "size": 0 + }, + "modules": [ + { + "name": "string" + } + ], + "isUtilityPackage": true, + "languageVersion": "string" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getpackagereferences.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getpackagereferences.mdx index 4f3561f..6995a18 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getpackagereferences.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getpackagereferences.mdx @@ -4,6 +4,10 @@ title: "GetPackageReferences"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.PackageService/GetPackageReferences <<'EOF' -{ - "packageId": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "dars": [ - { - "main": "string", - "name": "string", - "version": "string", - "description": "string" - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -358,3 +310,59 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PackageService/GetPackageReferences <<'EOF' +{ + "packageId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "dars": [ + { + "main": "string", + "name": "string", + "version": "string", + "description": "string" + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/listdars.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/listdars.mdx index c62cd11..b94c2bd 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/listdars.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/listdars.mdx @@ -4,6 +4,10 @@ title: "ListDars"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.PackageService/ListDars <<'EOF' -{ - "limit": 0, - "filterName": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "dars": [ - { - "main": "string", - "name": "string", - "version": "string", - "description": "string" - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -377,3 +328,60 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PackageService/ListDars <<'EOF' +{ + "limit": 0, + "filterName": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "dars": [ + { + "main": "string", + "name": "string", + "version": "string", + "description": "string" + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/listpackages.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/listpackages.mdx index 9697957..e10853e 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/listpackages.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/listpackages.mdx @@ -4,6 +4,10 @@ title: "ListPackages"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.PackageService/ListPackages <<'EOF' -{ - "limit": 0, - "filterName": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "packageDescriptions": [ - { - "packageId": "string", - "name": "string", - "version": "string", - "uploadedAt": "string", - "size": 0 - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -387,3 +337,61 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PackageService/ListPackages <<'EOF' +{ + "limit": 0, + "filterName": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "packageDescriptions": [ + { + "packageId": "string", + "name": "string", + "version": "string", + "uploadedAt": "string", + "size": 0 + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/removedar.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/removedar.mdx index f8796ee..0491808 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/removedar.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/removedar.mdx @@ -4,6 +4,10 @@ title: "RemoveDar"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.PackageService/RemoveDar <<'EOF' -{ - "mainPackageId": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -274,3 +235,50 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PackageService/RemoveDar <<'EOF' +{ + "mainPackageId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/removepackage.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/removepackage.mdx index 10c953c..e853dbb 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/removepackage.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/removepackage.mdx @@ -4,6 +4,10 @@ title: "RemovePackage"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.PackageService/RemovePackage <<'EOF' -{ - "packageId": "string", - "force": true -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "success": "string" -} -``` - -
-
- -
- ## Protocol Details @@ -321,3 +279,53 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PackageService/RemovePackage <<'EOF' +{ + "packageId": "string", + "force": true +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "success": "string" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/unvetdar.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/unvetdar.mdx index 3912f3e..cc624ed 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/unvetdar.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/unvetdar.mdx @@ -4,6 +4,10 @@ title: "UnvetDar"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.PackageService/UnvetDar <<'EOF' -{ - "mainPackageId": "string", - "synchronizerId": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -297,3 +257,51 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PackageService/UnvetDar <<'EOF' +{ + "mainPackageId": "string", + "synchronizerId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/uploaddar.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/uploaddar.mdx index b6ee2be..4ccf2c4 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/uploaddar.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/uploaddar.mdx @@ -4,6 +4,10 @@ title: "UploadDar"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.PackageService/UploadDar <<'EOF' -{ - "dars": [ - { - "bytes": "BASE64_ENCODED_BYTES", - "description": "string", - "expectedMainPackageId": "string" - } - ], - "vetAllPackages": true, - "synchronizeVetting": true, - "synchronizerId": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "darIds": [ - "string" - ] -} -``` - -
-
- -
- ## Protocol Details @@ -421,3 +369,63 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PackageService/UploadDar <<'EOF' +{ + "dars": [ + { + "bytes": "BASE64_ENCODED_BYTES", + "description": "string", + "expectedMainPackageId": "string" + } + ], + "vetAllPackages": true, + "synchronizeVetting": true, + "synchronizerId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "darIds": [ + "string" + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/validatedar.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/validatedar.mdx index 578f4b6..e960033 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/validatedar.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/validatedar.mdx @@ -4,6 +4,10 @@ title: "ValidateDar"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.PackageService/ValidateDar <<'EOF' -{ - "data": "BASE64_ENCODED_BYTES", - "filename": "string", - "synchronizerId": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "mainPackageId": "string" -} -``` - -
-
- -
- ## Protocol Details @@ -344,3 +301,54 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PackageService/ValidateDar <<'EOF' +{ + "data": "BASE64_ENCODED_BYTES", + "filename": "string", + "synchronizerId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "mainPackageId": "string" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/vetdar.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/vetdar.mdx index baa1433..083ee3d 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/vetdar.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/vetdar.mdx @@ -4,6 +4,10 @@ title: "VetDar"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.PackageService/VetDar <<'EOF' -{ - "mainPackageId": "string", - "synchronize": true, - "synchronizerId": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -320,3 +279,52 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PackageService/VetDar <<'EOF' +{ + "mainPackageId": "string", + "synchronize": true, + "synchronizerId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/countinflight.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/countinflight.mdx index ca6704d..d7f3692 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/countinflight.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/countinflight.mdx @@ -4,6 +4,10 @@ title: "CountInFlight"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/CountInFlight <<'EOF' -{ - "synchronizerId": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "pendingSubmissions": 0, - "pendingTransactions": 0 -} -``` - -
-
- -
- ## Protocol Details @@ -325,3 +283,53 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/CountInFlight <<'EOF' +{ + "synchronizerId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "pendingSubmissions": 0, + "pendingTransactions": 0 +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/getconfigforslowcounterparticipants.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/getconfigforslowcounterparticipants.mdx index 1e7d6ad..0e2a268 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/getconfigforslowcounterparticipants.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/getconfigforslowcounterparticipants.mdx @@ -4,6 +4,10 @@ title: "GetConfigForSlowCounterParticipants"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/GetConfigForSlowCounterParticipants <<'EOF' -{ - "synchronizerIds": [ - "string" - ] -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "configs": [ - { - "synchronizerIds": [ - "string" - ], - "distinguishedParticipantUids": [ - "string" - ], - "thresholdDistinguished": "0", - "thresholdDefault": "0", - "participantUidsMetrics": [ - "string" - ] - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -390,3 +333,68 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/GetConfigForSlowCounterParticipants <<'EOF' +{ + "synchronizerIds": [ + "string" + ] +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "configs": [ + { + "synchronizerIds": [ + "string" + ], + "distinguishedParticipantUids": [ + "string" + ], + "thresholdDistinguished": "0", + "thresholdDefault": "0", + "participantUidsMetrics": [ + "string" + ] + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/getintervalsbehindforcounterparticipants.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/getintervalsbehindforcounterparticipants.mdx index ad58b2f..67df874 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/getintervalsbehindforcounterparticipants.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/getintervalsbehindforcounterparticipants.mdx @@ -4,6 +4,10 @@ title: "GetIntervalsBehindForCounterParticipants"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/GetIntervalsBehindForCounterParticipants <<'EOF' -{ - "counterParticipantIds": [ - "string" - ], - "synchronizerIds": [ - "string" - ], - "threshold": "0" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "intervalsBehind": [ - { - "counterParticipantUid": "string", - "synchronizerId": "string", - "intervalsBehind": "0", - "behindSince": "string", - "asOfSequencingTimestamp": "string" - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -428,3 +373,66 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/GetIntervalsBehindForCounterParticipants <<'EOF' +{ + "counterParticipantIds": [ + "string" + ], + "synchronizerIds": [ + "string" + ], + "threshold": "0" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "intervalsBehind": [ + { + "counterParticipantUid": "string", + "synchronizerId": "string", + "intervalsBehind": "0", + "behindSince": "string", + "asOfSequencingTimestamp": "string" + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/inspectcommitmentcontracts.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/inspectcommitmentcontracts.mdx index 1cff791..e71d622 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/inspectcommitmentcontracts.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/inspectcommitmentcontracts.mdx @@ -4,6 +4,10 @@ title: "InspectCommitmentContracts"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/InspectCommitmentContracts <<'EOF' -{ - "cids": [ - "BASE64_ENCODED_BYTES" - ], - "expectedSynchronizerId": "string", - "timestamp": "string", - "downloadPayload": true -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "chunk": "BASE64_ENCODED_BYTES" -} -``` - -
-
- -
- ## Protocol Details @@ -382,3 +335,58 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/InspectCommitmentContracts <<'EOF' +{ + "cids": [ + "BASE64_ENCODED_BYTES" + ], + "expectedSynchronizerId": "string", + "timestamp": "string", + "downloadPayload": true +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "chunk": "BASE64_ENCODED_BYTES" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/lookupoffsetbytime.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/lookupoffsetbytime.mdx index d03fcda..d29d839 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/lookupoffsetbytime.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/lookupoffsetbytime.mdx @@ -4,6 +4,10 @@ title: "LookupOffsetByTime"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/LookupOffsetByTime <<'EOF' -{ - "timestamp": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "offset": "0" -} -``` - -
-
- -
- ## Protocol Details @@ -310,3 +269,52 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/LookupOffsetByTime <<'EOF' +{ + "timestamp": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "offset": "0" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/lookupreceivedacscommitments.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/lookupreceivedacscommitments.mdx index edf4faa..623b7d4 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/lookupreceivedacscommitments.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/lookupreceivedacscommitments.mdx @@ -4,6 +4,10 @@ title: "LookupReceivedAcsCommitments"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/LookupReceivedAcsCommitments <<'EOF' -{ - "timeRanges": [ - { - "synchronizerId": "string", - "interval": { - "fromExclusive": "string", - "toInclusive": "string" - } - } - ], - "counterParticipantIds": [ - "string" - ], - "commitmentState": [ - "RECEIVED_COMMITMENT_STATE_UNSPECIFIED" - ], - "verbose": true -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "received": [ - { - "synchronizerId": "string", - "received": [ - { - "interval": { - "startTickExclusive": "string", - "endTickInclusive": "string" - }, - "originCounterParticipantUid": "string", - "receivedCommitment": "BASE64_ENCODED_BYTES", - "ownCommitment": "BASE64_ENCODED_BYTES", - "state": "RECEIVED_COMMITMENT_STATE_UNSPECIFIED" - } - ] - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -616,3 +544,83 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/LookupReceivedAcsCommitments <<'EOF' +{ + "timeRanges": [ + { + "synchronizerId": "string", + "interval": { + "fromExclusive": "string", + "toInclusive": "string" + } + } + ], + "counterParticipantIds": [ + "string" + ], + "commitmentState": [ + "RECEIVED_COMMITMENT_STATE_UNSPECIFIED" + ], + "verbose": true +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "received": [ + { + "synchronizerId": "string", + "received": [ + { + "interval": { + "startTickExclusive": "string", + "endTickInclusive": "string" + }, + "originCounterParticipantUid": "string", + "receivedCommitment": "BASE64_ENCODED_BYTES", + "ownCommitment": "BASE64_ENCODED_BYTES", + "state": "RECEIVED_COMMITMENT_STATE_UNSPECIFIED" + } + ] + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/lookupsentacscommitments.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/lookupsentacscommitments.mdx index 76e3d00..3d1e2da 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/lookupsentacscommitments.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/lookupsentacscommitments.mdx @@ -4,6 +4,10 @@ title: "LookupSentAcsCommitments"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/LookupSentAcsCommitments <<'EOF' -{ - "timeRanges": [ - { - "synchronizerId": "string", - "interval": { - "fromExclusive": "string", - "toInclusive": "string" - } - } - ], - "counterParticipantIds": [ - "string" - ], - "commitmentState": [ - "SENT_COMMITMENT_STATE_UNSPECIFIED" - ], - "verbose": true -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "sent": [ - { - "synchronizerId": "string", - "sent": [ - { - "interval": { - "startTickExclusive": "string", - "endTickInclusive": "string" - }, - "destCounterParticipantUid": "string", - "ownCommitment": "BASE64_ENCODED_BYTES", - "receivedCommitment": "BASE64_ENCODED_BYTES", - "state": "SENT_COMMITMENT_STATE_UNSPECIFIED" - } - ] - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -614,3 +542,83 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/LookupSentAcsCommitments <<'EOF' +{ + "timeRanges": [ + { + "synchronizerId": "string", + "interval": { + "fromExclusive": "string", + "toInclusive": "string" + } + } + ], + "counterParticipantIds": [ + "string" + ], + "commitmentState": [ + "SENT_COMMITMENT_STATE_UNSPECIFIED" + ], + "verbose": true +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "sent": [ + { + "synchronizerId": "string", + "sent": [ + { + "interval": { + "startTickExclusive": "string", + "endTickInclusive": "string" + }, + "destCounterParticipantUid": "string", + "ownCommitment": "BASE64_ENCODED_BYTES", + "receivedCommitment": "BASE64_ENCODED_BYTES", + "state": "SENT_COMMITMENT_STATE_UNSPECIFIED" + } + ] + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/opencommitment.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/opencommitment.mdx index 7ceabf5..234f344 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/opencommitment.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/opencommitment.mdx @@ -4,6 +4,10 @@ title: "OpenCommitment"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/OpenCommitment <<'EOF' -{ - "commitment": "BASE64_ENCODED_BYTES", - "physicalSynchronizerId": "string", - "computedForCounterParticipantUid": "string", - "periodEndTick": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "chunk": "BASE64_ENCODED_BYTES" -} -``` - -
-
- -
- ## Protocol Details @@ -376,3 +331,56 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/OpenCommitment <<'EOF' +{ + "commitment": "BASE64_ENCODED_BYTES", + "physicalSynchronizerId": "string", + "computedForCounterParticipantUid": "string", + "periodEndTick": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "chunk": "BASE64_ENCODED_BYTES" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/setconfigforslowcounterparticipants.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/setconfigforslowcounterparticipants.mdx index 2adb88a..0f5cb1d 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/setconfigforslowcounterparticipants.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/setconfigforslowcounterparticipants.mdx @@ -4,6 +4,10 @@ title: "SetConfigForSlowCounterParticipants"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/SetConfigForSlowCounterParticipants <<'EOF' -{ - "configs": [ - { - "synchronizerIds": [ - "string" - ], - "distinguishedParticipantUids": [ - "string" - ], - "thresholdDistinguished": "0", - "thresholdDefault": "0", - "participantUidsMetrics": [ - "string" - ] - } - ] -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -360,3 +307,64 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/SetConfigForSlowCounterParticipants <<'EOF' +{ + "configs": [ + { + "synchronizerIds": [ + "string" + ], + "distinguishedParticipantUids": [ + "string" + ], + "thresholdDistinguished": "0", + "thresholdDefault": "0", + "participantUidsMetrics": [ + "string" + ] + } + ] +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/changeassignation.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/changeassignation.mdx index 9597308..5f1b46a 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/changeassignation.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/changeassignation.mdx @@ -4,6 +4,10 @@ title: "ChangeAssignation"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/ChangeAssignation <<'EOF' -{ - "sourceSynchronizerAlias": "string", - "targetSynchronizerAlias": "string", - "skipInactive": true, - "contracts": [ - { - "id": "string", - "reassignmentCounterOverride": "0" - } - ] -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -381,3 +334,58 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/ChangeAssignation <<'EOF' +{ + "sourceSynchronizerAlias": "string", + "targetSynchronizerAlias": "string", + "skipInactive": true, + "contracts": [ + { + "id": "string", + "reassignmentCounterOverride": "0" + } + ] +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/exportacs.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/exportacs.mdx index cf6f150..81c5254 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/exportacs.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/exportacs.mdx @@ -4,6 +4,10 @@ title: "ExportAcs"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/ExportAcs <<'EOF' -{ - "partyIds": [ - "string" - ], - "synchronizerId": "string", - "ledgerOffset": "0", - "contractSynchronizerRenames": [ - { - "key": { - "targetSynchronizerId": "string" - } - } - ], - "excludedStakeholderIds": [ - "string" - ] -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "chunk": "BASE64_ENCODED_BYTES" -} -``` - -
-
- -
- ## Protocol Details @@ -413,3 +357,67 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/ExportAcs <<'EOF' +{ + "partyIds": [ + "string" + ], + "synchronizerId": "string", + "ledgerOffset": "0", + "contractSynchronizerRenames": [ + { + "key": { + "targetSynchronizerId": "string" + } + } + ], + "excludedStakeholderIds": [ + "string" + ] +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "chunk": "BASE64_ENCODED_BYTES" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/exportacsold.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/exportacsold.mdx index 17cd99f..5b68753 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/exportacsold.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/exportacsold.mdx @@ -4,6 +4,10 @@ title: "ExportAcsOld"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/ExportAcsOld <<'EOF' -{ - "parties": [ - "string" - ], - "filterSynchronizerId": "string", - "timestamp": "string", - "force": true, - "partiesOffboarding": true -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "chunk": "BASE64_ENCODED_BYTES" -} -``` - -
-
- -
- ## Protocol Details @@ -405,3 +357,59 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/ExportAcsOld <<'EOF' +{ + "parties": [ + "string" + ], + "filterSynchronizerId": "string", + "timestamp": "string", + "force": true, + "partiesOffboarding": true +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "chunk": "BASE64_ENCODED_BYTES" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/ignoreevents.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/ignoreevents.mdx index 1708da3..d241727 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/ignoreevents.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/ignoreevents.mdx @@ -4,6 +4,10 @@ title: "IgnoreEvents"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/IgnoreEvents <<'EOF' -{ - "physicalSynchronizerId": "string", - "fromInclusive": "0", - "toInclusive": "0", - "force": true -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -343,3 +301,53 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/IgnoreEvents <<'EOF' +{ + "physicalSynchronizerId": "string", + "fromInclusive": "0", + "toInclusive": "0", + "force": true +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/importacs.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/importacs.mdx index a7884ab..85a7b1a 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/importacs.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/importacs.mdx @@ -4,6 +4,10 @@ title: "ImportAcs"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/ImportAcs <<'EOF' -{ - "acsSnapshot": "BASE64_ENCODED_BYTES", - "workflowIdPrefix": "string", - "contractImportMode": "CONTRACT_IMPORT_MODE_UNSPECIFIED", - "excludedStakeholderIds": [ - "string" - ], - "representativePackageIdOverride": { - "contractOverride": [ - { - "key": "string" - } - ], - "packageIdOverride": [ - { - "key": "string" - } - ], - "packageNameOverride": [ - { - "key": "string" - } - ] - } -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "contractIdMappings": [ - { - "key": "string" - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -492,3 +424,79 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/ImportAcs <<'EOF' +{ + "acsSnapshot": "BASE64_ENCODED_BYTES", + "workflowIdPrefix": "string", + "contractImportMode": "CONTRACT_IMPORT_MODE_UNSPECIFIED", + "excludedStakeholderIds": [ + "string" + ], + "representativePackageIdOverride": { + "contractOverride": [ + { + "key": "string" + } + ], + "packageIdOverride": [ + { + "key": "string" + } + ], + "packageNameOverride": [ + { + "key": "string" + } + ] + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "contractIdMappings": [ + { + "key": "string" + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/importacsold.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/importacsold.mdx index 27808c3..5e1387e 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/importacsold.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/importacsold.mdx @@ -4,6 +4,10 @@ title: "ImportAcsOld"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/ImportAcsOld <<'EOF' -{ - "acsSnapshot": "BASE64_ENCODED_BYTES", - "workflowIdPrefix": "string", - "allowContractIdSuffixRecomputation": true -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "contractIdMapping": [ - { - "key": "string" - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -361,3 +313,59 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/ImportAcsOld <<'EOF' +{ + "acsSnapshot": "BASE64_ENCODED_BYTES", + "workflowIdPrefix": "string", + "allowContractIdSuffixRecomputation": true +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "contractIdMapping": [ + { + "key": "string" + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/migratesynchronizer.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/migratesynchronizer.mdx index da9761f..8eb4e63 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/migratesynchronizer.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/migratesynchronizer.mdx @@ -4,6 +4,10 @@ title: "MigrateSynchronizer"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/MigrateSynchronizer <<'EOF' -{ - "sourceSynchronizerAlias": "string", - "targetSynchronizerConnectionConfig": { - "synchronizerAlias": "string", - "sequencerConnections": { - "sequencerConnections": [ - { - "grpc": {}, - "alias": "string", - "sequencerId": "string" - } - ], - "sequencerTrustThreshold": 0, - "submissionRequestAmplification": { - "factor": 0, - "patience": "string" - }, - "sequencerLivenessMargin": 0, - "sequencerConnectionPoolDelays": { - "minRestartDelay": "string", - "maxRestartDelay": "string", - "subscriptionRequestDelay": "string", - "warnValidationDelay": "string" - } - }, - "manualConnect": true, - "physicalSynchronizerId": "string", - "priority": 0, - "initialRetryDelay": "string", - "maxRetryDelay": "string", - "timeTracker": { - "observationLatency": "string", - "patienceDuration": "string", - "minObservationDuration": "string", - "timeProofRequest": { - "initialRetryDelay": "string", - "maxRetryDelay": "string", - "maxSequencingDelay": "string" - } - } - }, - "force": true -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -805,3 +726,90 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/MigrateSynchronizer <<'EOF' +{ + "sourceSynchronizerAlias": "string", + "targetSynchronizerConnectionConfig": { + "synchronizerAlias": "string", + "sequencerConnections": { + "sequencerConnections": [ + { + "grpc": {}, + "alias": "string", + "sequencerId": "string" + } + ], + "sequencerTrustThreshold": 0, + "submissionRequestAmplification": { + "factor": 0, + "patience": "string" + }, + "sequencerLivenessMargin": 0, + "sequencerConnectionPoolDelays": { + "minRestartDelay": "string", + "maxRestartDelay": "string", + "subscriptionRequestDelay": "string", + "warnValidationDelay": "string" + } + }, + "manualConnect": true, + "physicalSynchronizerId": "string", + "priority": 0, + "initialRetryDelay": "string", + "maxRetryDelay": "string", + "timeTracker": { + "observationLatency": "string", + "patienceDuration": "string", + "minObservationDuration": "string", + "timeProofRequest": { + "initialRetryDelay": "string", + "maxRetryDelay": "string", + "maxSequencingDelay": "string" + } + } + }, + "force": true +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/purgecontracts.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/purgecontracts.mdx index 9f3ca10..d10d071 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/purgecontracts.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/purgecontracts.mdx @@ -4,6 +4,10 @@ title: "PurgeContracts"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/PurgeContracts <<'EOF' -{ - "synchronizerAlias": "string", - "contractIds": [ - "string" - ], - "ignoreAlreadyPurged": true -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -326,3 +283,54 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/PurgeContracts <<'EOF' +{ + "synchronizerAlias": "string", + "contractIds": [ + "string" + ], + "ignoreAlreadyPurged": true +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/purgedeactivatedsynchronizer.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/purgedeactivatedsynchronizer.mdx index 1519277..c423a42 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/purgedeactivatedsynchronizer.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/purgedeactivatedsynchronizer.mdx @@ -4,6 +4,10 @@ title: "PurgeDeactivatedSynchronizer"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/PurgeDeactivatedSynchronizer <<'EOF' -{ - "synchronizerAlias": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -278,3 +239,50 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/PurgeDeactivatedSynchronizer <<'EOF' +{ + "synchronizerAlias": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/repaircommitmentsusingacs.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/repaircommitmentsusingacs.mdx index 71b4ee9..acdad9c 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/repaircommitmentsusingacs.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/repaircommitmentsusingacs.mdx @@ -4,6 +4,10 @@ title: "RepairCommitmentsUsingAcs"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/RepairCommitmentsUsingAcs <<'EOF' -{ - "synchronizerIds": [ - "string" - ], - "counterParticipantIds": [ - "string" - ], - "partyIds": [ - "string" - ], - "timeoutSeconds": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "statuses": [ - { - "synchronizerId": "string", - "errorMessage": "string" - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -426,3 +371,66 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/RepairCommitmentsUsingAcs <<'EOF' +{ + "synchronizerIds": [ + "string" + ], + "counterParticipantIds": [ + "string" + ], + "partyIds": [ + "string" + ], + "timeoutSeconds": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "statuses": [ + { + "synchronizerId": "string", + "errorMessage": "string" + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/rollbackunassignment.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/rollbackunassignment.mdx index 38c50f3..2094694 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/rollbackunassignment.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/rollbackunassignment.mdx @@ -4,6 +4,10 @@ title: "RollbackUnassignment"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/RollbackUnassignment <<'EOF' -{ - "reassignmentId": "string", - "sourceSynchronizerId": "string", - "targetSynchronizerId": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -324,3 +283,52 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/RollbackUnassignment <<'EOF' +{ + "reassignmentId": "string", + "sourceSynchronizerId": "string", + "targetSynchronizerId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/unignoreevents.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/unignoreevents.mdx index 625834e..bd13dc9 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/unignoreevents.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/unignoreevents.mdx @@ -4,6 +4,10 @@ title: "UnignoreEvents"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/UnignoreEvents <<'EOF' -{ - "physicalSynchronizerId": "string", - "fromInclusive": "0", - "toInclusive": "0", - "force": true -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -343,3 +301,53 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/UnignoreEvents <<'EOF' +{ + "physicalSynchronizerId": "string", + "fromInclusive": "0", + "toInclusive": "0", + "force": true +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantstatusservice/participantstatus.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantstatusservice/participantstatus.mdx index f938ae7..90df27b 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantstatusservice/participantstatus.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantstatusservice/participantstatus.mdx @@ -4,6 +4,10 @@ title: "ParticipantStatus"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.ParticipantStatusService/ParticipantStatus <<'EOF' -{} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "status": { - "commonStatus": { - "uid": "string", - "uptime": "string", - "ports": [ - { - "key": 0 - } - ], - "active": true, - "topologyQueues": { - "manager": 0, - "dispatcher": 0, - "clients": 0 - }, - "components": [ - { - "name": "string", - "ok": {} - } - ], - "version": "string" - }, - "connectedSynchronizers": [ - { - "physicalSynchronizerId": "string", - "health": "HEALTH_UNSPECIFIED" - } - ], - "active": true, - "supportedProtocolVersions": [ - 0 - ] - } -} -``` - -
-
- -
- ## Protocol Details @@ -694,3 +622,83 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ParticipantStatusService/ParticipantStatus <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "status": { + "commonStatus": { + "uid": "string", + "uptime": "string", + "ports": [ + { + "key": 0 + } + ], + "active": true, + "topologyQueues": { + "manager": 0, + "dispatcher": 0, + "clients": 0 + }, + "components": [ + { + "name": "string", + "ok": {} + } + ], + "version": "string" + }, + "connectedSynchronizers": [ + { + "physicalSynchronizerId": "string", + "health": "HEALTH_UNSPECIFIED" + } + ], + "active": true, + "supportedProtocolVersions": [ + 0 + ] + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/addpartyasync.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/addpartyasync.mdx index 7efbe4c..9dbb3cf 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/addpartyasync.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/addpartyasync.mdx @@ -4,6 +4,10 @@ title: "AddPartyAsync"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.PartyManagementService/AddPartyAsync <<'EOF' -{ - "partyId": "string", - "synchronizerId": "string", - "sourceParticipantUid": "string", - "topologySerial": 0, - "participantPermission": "PARTICIPANT_PERMISSION_UNSPECIFIED" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "addPartyRequestId": "string" -} -``` - -
-
- -
- ## Protocol Details @@ -423,3 +378,56 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PartyManagementService/AddPartyAsync <<'EOF' +{ + "partyId": "string", + "synchronizerId": "string", + "sourceParticipantUid": "string", + "topologySerial": 0, + "participantPermission": "PARTICIPANT_PERMISSION_UNSPECIFIED" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "addPartyRequestId": "string" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/clearpartyonboardingflag.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/clearpartyonboardingflag.mdx index f7bbcc6..17aa282 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/clearpartyonboardingflag.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/clearpartyonboardingflag.mdx @@ -4,6 +4,10 @@ title: "ClearPartyOnboardingFlag"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.PartyManagementService/ClearPartyOnboardingFlag <<'EOF' -{ - "partyId": "string", - "synchronizerId": "string", - "beginOffsetExclusive": "0", - "waitForActivationTimeout": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "onboarded": true, - "earliestRetryTimestamp": "string" -} -``` - -
-
- -
- ## Protocol Details @@ -402,3 +357,56 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PartyManagementService/ClearPartyOnboardingFlag <<'EOF' +{ + "partyId": "string", + "synchronizerId": "string", + "beginOffsetExclusive": "0", + "waitForActivationTimeout": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "onboarded": true, + "earliestRetryTimestamp": "string" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/exportpartyacs.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/exportpartyacs.mdx index 86fe6a1..cacb8ec 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/exportpartyacs.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/exportpartyacs.mdx @@ -4,6 +4,10 @@ title: "ExportPartyAcs"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.PartyManagementService/ExportPartyAcs <<'EOF' -{ - "partyId": "string", - "synchronizerId": "string", - "targetParticipantUid": "string", - "beginOffsetExclusive": "0", - "waitForActivationTimeout": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "chunk": "BASE64_ENCODED_BYTES" -} -``` - -
-
- -
- ## Protocol Details @@ -403,3 +357,57 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PartyManagementService/ExportPartyAcs <<'EOF' +{ + "partyId": "string", + "synchronizerId": "string", + "targetParticipantUid": "string", + "beginOffsetExclusive": "0", + "waitForActivationTimeout": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "chunk": "BASE64_ENCODED_BYTES" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/getaddpartystatus.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/getaddpartystatus.mdx index c4fd5a5..096627f 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/getaddpartystatus.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/getaddpartystatus.mdx @@ -4,6 +4,10 @@ title: "GetAddPartyStatus"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.PartyManagementService/GetAddPartyStatus <<'EOF' -{ - "addPartyRequestId": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "partyId": "string", - "synchronizerId": "string", - "sourceParticipantUid": "string", - "targetParticipantUid": "string", - "topologySerial": 0, - "participantPermission": "PARTICIPANT_PERMISSION_UNSPECIFIED", - "status": { - "proposalProcessed": {} - } -} -``` - -
-
- -
- ## Protocol Details @@ -828,3 +779,60 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PartyManagementService/GetAddPartyStatus <<'EOF' +{ + "addPartyRequestId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "partyId": "string", + "synchronizerId": "string", + "sourceParticipantUid": "string", + "targetParticipantUid": "string", + "topologySerial": 0, + "participantPermission": "PARTICIPANT_PERMISSION_UNSPECIFIED", + "status": { + "proposalProcessed": {} + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/gethighestoffsetbytimestamp.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/gethighestoffsetbytimestamp.mdx index ffc33a2..5abe69c 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/gethighestoffsetbytimestamp.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/gethighestoffsetbytimestamp.mdx @@ -4,6 +4,10 @@ title: "GetHighestOffsetByTimestamp"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.PartyManagementService/GetHighestOffsetByTimestamp <<'EOF' -{ - "synchronizerId": "string", - "timestamp": "string", - "force": true -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "ledgerOffset": "0" -} -``` - -
-
- -
- ## Protocol Details @@ -356,3 +313,54 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PartyManagementService/GetHighestOffsetByTimestamp <<'EOF' +{ + "synchronizerId": "string", + "timestamp": "string", + "force": true +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "ledgerOffset": "0" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/importpartyacs.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/importpartyacs.mdx index a50d59e..428f581 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/importpartyacs.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/importpartyacs.mdx @@ -4,6 +4,10 @@ title: "ImportPartyAcs"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.PartyManagementService/ImportPartyAcs <<'EOF' -{ - "acsSnapshot": "BASE64_ENCODED_BYTES", - "workflowIdPrefix": "string", - "contractImportMode": "CONTRACT_IMPORT_MODE_UNSPECIFIED", - "representativePackageIdOverride": { - "contractOverride": [ - { - "key": "string" - } - ], - "packageIdOverride": [ - { - "key": "string" - } - ], - "packageNameOverride": [ - { - "key": "string" - } - ] - } -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -431,3 +372,70 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PartyManagementService/ImportPartyAcs <<'EOF' +{ + "acsSnapshot": "BASE64_ENCODED_BYTES", + "workflowIdPrefix": "string", + "contractImportMode": "CONTRACT_IMPORT_MODE_UNSPECIFIED", + "representativePackageIdOverride": { + "contractOverride": [ + { + "key": "string" + } + ], + "packageIdOverride": [ + { + "key": "string" + } + ], + "packageNameOverride": [ + { + "key": "string" + } + ] + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pingservice/ping.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pingservice/ping.mdx index 4796848..79f1ba8 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pingservice/ping.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pingservice/ping.mdx @@ -4,6 +4,10 @@ title: "Ping"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.PingService/Ping <<'EOF' -{ - "targetParties": [ - "string" - ], - "validators": [ - "string" - ], - "timeout": "string", - "levels": 0, - "synchronizerId": "string", - "workflowId": "string", - "id": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "success": { - "pingTime": "0", - "responder": "string" - } -} -``` - -
-
- -
- ## Protocol Details @@ -506,3 +452,65 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PingService/Ping <<'EOF' +{ + "targetParties": [ + "string" + ], + "validators": [ + "string" + ], + "timeout": "string", + "levels": 0, + "synchronizerId": "string", + "workflowId": "string", + "id": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "success": { + "pingTime": "0", + "responder": "string" + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/clearschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/clearschedule.mdx index 508c09b..6299a27 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/clearschedule.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/clearschedule.mdx @@ -4,6 +4,10 @@ title: "ClearSchedule"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.PruningService/ClearSchedule <<'EOF' -{} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -246,3 +209,48 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PruningService/ClearSchedule <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getnowaitcommitmentsfrom.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getnowaitcommitmentsfrom.mdx index c7d23e3..222400c 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getnowaitcommitmentsfrom.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getnowaitcommitmentsfrom.mdx @@ -4,6 +4,10 @@ title: "GetNoWaitCommitmentsFrom"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.PruningService/GetNoWaitCommitmentsFrom <<'EOF' -{ - "synchronizerIds": [ - "string" - ], - "participantUids": [ - "string" - ] -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "ignoredParticipants": [ - { - "counterParticipantUid": "string", - "synchronizers": { - "synchronizerIds": [ - "string" - ] - } - } - ], - "notIgnoredParticipants": [ - { - "counterParticipantUid": "string", - "synchronizers": { - "synchronizerIds": [ - "string" - ] - } - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -423,3 +358,76 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PruningService/GetNoWaitCommitmentsFrom <<'EOF' +{ + "synchronizerIds": [ + "string" + ], + "participantUids": [ + "string" + ] +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "ignoredParticipants": [ + { + "counterParticipantUid": "string", + "synchronizers": { + "synchronizerIds": [ + "string" + ] + } + } + ], + "notIgnoredParticipants": [ + { + "counterParticipantUid": "string", + "synchronizers": { + "synchronizerIds": [ + "string" + ] + } + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getparticipantschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getparticipantschedule.mdx index dae71da..d250d18 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getparticipantschedule.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getparticipantschedule.mdx @@ -4,6 +4,10 @@ title: "GetParticipantSchedule"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.PruningService/GetParticipantSchedule <<'EOF' -{} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "schedule": { - "schedule": { - "cron": "string", - "maxDuration": "string", - "retention": "string" - }, - "pruneInternallyOnly": true - } -} -``` - -
-
- -
- ## Protocol Details @@ -352,3 +306,57 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PruningService/GetParticipantSchedule <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "schedule": { + "schedule": { + "cron": "string", + "maxDuration": "string", + "retention": "string" + }, + "pruneInternallyOnly": true + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getsafepruningoffset.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getsafepruningoffset.mdx index a51248a..d4dc9a5 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getsafepruningoffset.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getsafepruningoffset.mdx @@ -4,6 +4,10 @@ title: "GetSafePruningOffset"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.PruningService/GetSafePruningOffset <<'EOF' -{ - "beforeOrAt": "string", - "ledgerEnd": "0", - "counterParticipantsCommitmentsState": "SAFE_TO_PRUNE_COMMITMENT_STATE_UNSPECIFIED" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "safePruningOffset": "0" -} -``` - -
-
- -
- ## Protocol Details @@ -388,3 +345,54 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PruningService/GetSafePruningOffset <<'EOF' +{ + "beforeOrAt": "string", + "ledgerEnd": "0", + "counterParticipantsCommitmentsState": "SAFE_TO_PRUNE_COMMITMENT_STATE_UNSPECIFIED" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "safePruningOffset": "0" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getschedule.mdx index fd4a24d..e2218eb 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getschedule.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getschedule.mdx @@ -4,6 +4,10 @@ title: "GetSchedule"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.PruningService/GetSchedule <<'EOF' -{} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "schedule": { - "cron": "string", - "maxDuration": "string", - "retention": "string" - } -} -``` - -
-
- -
- ## Protocol Details @@ -318,3 +275,54 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PruningService/GetSchedule <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "schedule": { + "cron": "string", + "maxDuration": "string", + "retention": "string" + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/prune.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/prune.mdx index 251e0a9..a1fa753 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/prune.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/prune.mdx @@ -4,6 +4,10 @@ title: "Prune"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.PruningService/Prune <<'EOF' -{ - "pruneUpTo": "0", - "counterParticipantsCommitmentsState": "SAFE_TO_PRUNE_COMMITMENT_STATE_UNSPECIFIED" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -318,3 +278,51 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PruningService/Prune <<'EOF' +{ + "pruneUpTo": "0", + "counterParticipantsCommitmentsState": "SAFE_TO_PRUNE_COMMITMENT_STATE_UNSPECIFIED" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/resetnowaitcommitmentsfrom.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/resetnowaitcommitmentsfrom.mdx index 895270f..da542c4 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/resetnowaitcommitmentsfrom.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/resetnowaitcommitmentsfrom.mdx @@ -4,6 +4,10 @@ title: "ResetNoWaitCommitmentsFrom"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.PruningService/ResetNoWaitCommitmentsFrom <<'EOF' -{ - "counterParticipantIds": [ - "string" - ], - "synchronizerIds": [ - "string" - ] -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -305,3 +261,55 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PruningService/ResetNoWaitCommitmentsFrom <<'EOF' +{ + "counterParticipantIds": [ + "string" + ], + "synchronizerIds": [ + "string" + ] +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setcron.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setcron.mdx index 08271a2..8a0c1e2 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setcron.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setcron.mdx @@ -4,6 +4,10 @@ title: "SetCron"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.PruningService/SetCron <<'EOF' -{ - "cron": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -274,3 +235,50 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PruningService/SetCron <<'EOF' +{ + "cron": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setmaxduration.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setmaxduration.mdx index 054cdb4..2ce9983 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setmaxduration.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setmaxduration.mdx @@ -4,6 +4,10 @@ title: "SetMaxDuration"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.PruningService/SetMaxDuration <<'EOF' -{ - "maxDuration": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -274,3 +235,50 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PruningService/SetMaxDuration <<'EOF' +{ + "maxDuration": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setnowaitcommitmentsfrom.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setnowaitcommitmentsfrom.mdx index dc73aaf..ba9068a 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setnowaitcommitmentsfrom.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setnowaitcommitmentsfrom.mdx @@ -4,6 +4,10 @@ title: "SetNoWaitCommitmentsFrom"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.PruningService/SetNoWaitCommitmentsFrom <<'EOF' -{ - "counterParticipantIds": [ - "string" - ], - "synchronizerIds": [ - "string" - ] -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -305,3 +261,55 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PruningService/SetNoWaitCommitmentsFrom <<'EOF' +{ + "counterParticipantIds": [ + "string" + ], + "synchronizerIds": [ + "string" + ] +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setparticipantschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setparticipantschedule.mdx index dd09ded..303c5f6 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setparticipantschedule.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setparticipantschedule.mdx @@ -4,6 +4,10 @@ title: "SetParticipantSchedule"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.PruningService/SetParticipantSchedule <<'EOF' -{ - "schedule": { - "schedule": { - "cron": "string", - "maxDuration": "string", - "retention": "string" - }, - "pruneInternallyOnly": true - } -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -352,3 +306,57 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PruningService/SetParticipantSchedule <<'EOF' +{ + "schedule": { + "schedule": { + "cron": "string", + "maxDuration": "string", + "retention": "string" + }, + "pruneInternallyOnly": true + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setretention.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setretention.mdx index 0f4a599..92f0658 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setretention.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setretention.mdx @@ -4,6 +4,10 @@ title: "SetRetention"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.PruningService/SetRetention <<'EOF' -{ - "retention": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -274,3 +235,50 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PruningService/SetRetention <<'EOF' +{ + "retention": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setschedule.mdx index b68b38e..a20963b 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setschedule.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setschedule.mdx @@ -4,6 +4,10 @@ title: "SetSchedule"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.PruningService/SetSchedule <<'EOF' -{ - "schedule": { - "cron": "string", - "maxDuration": "string", - "retention": "string" - } -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -318,3 +275,54 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.PruningService/SetSchedule <<'EOF' +{ + "schedule": { + "cron": "string", + "maxDuration": "string", + "retention": "string" + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/resourcemanagementservice/getresourcelimits.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/resourcemanagementservice/getresourcelimits.mdx index 703428e..35357ca 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/resourcemanagementservice/getresourcelimits.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/resourcemanagementservice/getresourcelimits.mdx @@ -4,6 +4,10 @@ title: "GetResourceLimits"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.ResourceManagementService/GetResourceLimits <<'EOF' -{} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "currentLimits": { - "maxInflightValidationRequests": 0, - "maxSubmissionRate": 0, - "maxSubmissionBurstFactor": 0.0 - } -} -``` - -
-
- -
- ## Protocol Details @@ -324,3 +281,54 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ResourceManagementService/GetResourceLimits <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "currentLimits": { + "maxInflightValidationRequests": 0, + "maxSubmissionRate": 0, + "maxSubmissionBurstFactor": 0.0 + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/resourcemanagementservice/setresourcelimits.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/resourcemanagementservice/setresourcelimits.mdx index b120b01..cee3bab 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/resourcemanagementservice/setresourcelimits.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/resourcemanagementservice/setresourcelimits.mdx @@ -4,6 +4,10 @@ title: "SetResourceLimits"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.ResourceManagementService/SetResourceLimits <<'EOF' -{ - "newLimits": { - "maxInflightValidationRequests": 0, - "maxSubmissionRate": 0, - "maxSubmissionBurstFactor": 0.0 - } -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -324,3 +281,54 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.ResourceManagementService/SetResourceLimits <<'EOF' +{ + "newLimits": { + "maxInflightValidationRequests": 0, + "maxSubmissionRate": 0, + "maxSubmissionBurstFactor": 0.0 + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/connectsynchronizer.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/connectsynchronizer.mdx index b28c4a7..0b9002d 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/connectsynchronizer.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/connectsynchronizer.mdx @@ -4,6 +4,10 @@ title: "ConnectSynchronizer"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/ConnectSynchronizer <<'EOF' -{ - "config": { - "synchronizerAlias": "string", - "sequencerConnections": { - "sequencerConnections": [ - { - "grpc": {}, - "alias": "string", - "sequencerId": "string" - } - ], - "sequencerTrustThreshold": 0, - "submissionRequestAmplification": { - "factor": 0, - "patience": "string" - }, - "sequencerLivenessMargin": 0, - "sequencerConnectionPoolDelays": { - "minRestartDelay": "string", - "maxRestartDelay": "string", - "subscriptionRequestDelay": "string", - "warnValidationDelay": "string" - } - }, - "manualConnect": true, - "physicalSynchronizerId": "string", - "priority": 0, - "initialRetryDelay": "string", - "maxRetryDelay": "string", - "timeTracker": { - "observationLatency": "string", - "patienceDuration": "string", - "minObservationDuration": "string", - "timeProofRequest": { - "initialRetryDelay": "string", - "maxRetryDelay": "string", - "maxSequencingDelay": "string" - } - } - }, - "sequencerConnectionValidation": "SEQUENCER_CONNECTION_VALIDATION_UNSPECIFIED" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "connectedSuccessfully": true -} -``` - -
-
- -
- ## Protocol Details @@ -833,3 +753,91 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/ConnectSynchronizer <<'EOF' +{ + "config": { + "synchronizerAlias": "string", + "sequencerConnections": { + "sequencerConnections": [ + { + "grpc": {}, + "alias": "string", + "sequencerId": "string" + } + ], + "sequencerTrustThreshold": 0, + "submissionRequestAmplification": { + "factor": 0, + "patience": "string" + }, + "sequencerLivenessMargin": 0, + "sequencerConnectionPoolDelays": { + "minRestartDelay": "string", + "maxRestartDelay": "string", + "subscriptionRequestDelay": "string", + "warnValidationDelay": "string" + } + }, + "manualConnect": true, + "physicalSynchronizerId": "string", + "priority": 0, + "initialRetryDelay": "string", + "maxRetryDelay": "string", + "timeTracker": { + "observationLatency": "string", + "patienceDuration": "string", + "minObservationDuration": "string", + "timeProofRequest": { + "initialRetryDelay": "string", + "maxRetryDelay": "string", + "maxSequencingDelay": "string" + } + } + }, + "sequencerConnectionValidation": "SEQUENCER_CONNECTION_VALIDATION_UNSPECIFIED" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "connectedSuccessfully": true +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/disconnectallsynchronizers.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/disconnectallsynchronizers.mdx index 2954f78..868a433 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/disconnectallsynchronizers.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/disconnectallsynchronizers.mdx @@ -4,6 +4,10 @@ title: "DisconnectAllSynchronizers"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/DisconnectAllSynchronizers <<'EOF' -{} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -246,3 +209,48 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/DisconnectAllSynchronizers <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/disconnectsynchronizer.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/disconnectsynchronizer.mdx index a2d34cd..be61f37 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/disconnectsynchronizer.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/disconnectsynchronizer.mdx @@ -4,6 +4,10 @@ title: "DisconnectSynchronizer"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/DisconnectSynchronizer <<'EOF' -{ - "synchronizerAlias": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -274,3 +235,50 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/DisconnectSynchronizer <<'EOF' +{ + "synchronizerAlias": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/getsynchronizerid.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/getsynchronizerid.mdx index 3a76b9d..d197cdf 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/getsynchronizerid.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/getsynchronizerid.mdx @@ -4,6 +4,10 @@ title: "GetSynchronizerId"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/GetSynchronizerId <<'EOF' -{ - "synchronizerAlias": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "synchronizerId": "string", - "physicalSynchronizerId": "string" -} -``` - -
-
- -
- ## Protocol Details @@ -321,3 +279,53 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/GetSynchronizerId <<'EOF' +{ + "synchronizerAlias": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "synchronizerId": "string", + "physicalSynchronizerId": "string" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/listconnectedsynchronizers.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/listconnectedsynchronizers.mdx index 1d31c8a..726252b 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/listconnectedsynchronizers.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/listconnectedsynchronizers.mdx @@ -4,6 +4,10 @@ title: "ListConnectedSynchronizers"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/ListConnectedSynchronizers <<'EOF' -{} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "connectedSynchronizers": [ - { - "synchronizerAlias": "string", - "synchronizerId": "string", - "physicalSynchronizerId": "string", - "healthy": true - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -330,3 +284,57 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/ListConnectedSynchronizers <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "connectedSynchronizers": [ + { + "synchronizerAlias": "string", + "synchronizerId": "string", + "physicalSynchronizerId": "string", + "healthy": true + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/listregisteredsynchronizers.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/listregisteredsynchronizers.mdx index f76cd46..e4e841a 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/listregisteredsynchronizers.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/listregisteredsynchronizers.mdx @@ -4,6 +4,10 @@ title: "ListRegisteredSynchronizers"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/ListRegisteredSynchronizers <<'EOF' -{} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "results": [ - { - "config": { - "synchronizerAlias": "string", - "sequencerConnections": { - "sequencerConnections": [ - {} - ], - "sequencerTrustThreshold": 0, - "submissionRequestAmplification": {}, - "sequencerLivenessMargin": 0, - "sequencerConnectionPoolDelays": {} - }, - "manualConnect": true, - "physicalSynchronizerId": "string", - "priority": 0, - "initialRetryDelay": "string", - "maxRetryDelay": "string", - "timeTracker": { - "observationLatency": "string", - "patienceDuration": "string", - "minObservationDuration": "string", - "timeProofRequest": {} - } - }, - "connected": true, - "physicalSynchronizerId": "string" - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -785,3 +718,78 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/ListRegisteredSynchronizers <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "results": [ + { + "config": { + "synchronizerAlias": "string", + "sequencerConnections": { + "sequencerConnections": [ + {} + ], + "sequencerTrustThreshold": 0, + "submissionRequestAmplification": {}, + "sequencerLivenessMargin": 0, + "sequencerConnectionPoolDelays": {} + }, + "manualConnect": true, + "physicalSynchronizerId": "string", + "priority": 0, + "initialRetryDelay": "string", + "maxRetryDelay": "string", + "timeTracker": { + "observationLatency": "string", + "patienceDuration": "string", + "minObservationDuration": "string", + "timeProofRequest": {} + } + }, + "connected": true, + "physicalSynchronizerId": "string" + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/logout.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/logout.mdx index 4f057cc..cf436be 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/logout.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/logout.mdx @@ -4,6 +4,10 @@ title: "Logout"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/Logout <<'EOF' -{ - "synchronizerAlias": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -274,3 +235,50 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/Logout <<'EOF' +{ + "synchronizerAlias": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/modifysynchronizer.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/modifysynchronizer.mdx index f9886db..c794361 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/modifysynchronizer.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/modifysynchronizer.mdx @@ -4,6 +4,10 @@ title: "ModifySynchronizer"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/ModifySynchronizer <<'EOF' -{ - "physicalSynchronizerId": "string", - "newConfig": { - "synchronizerAlias": "string", - "sequencerConnections": { - "sequencerConnections": [ - { - "grpc": {}, - "alias": "string", - "sequencerId": "string" - } - ], - "sequencerTrustThreshold": 0, - "submissionRequestAmplification": { - "factor": 0, - "patience": "string" - }, - "sequencerLivenessMargin": 0, - "sequencerConnectionPoolDelays": { - "minRestartDelay": "string", - "maxRestartDelay": "string", - "subscriptionRequestDelay": "string", - "warnValidationDelay": "string" - } - }, - "manualConnect": true, - "physicalSynchronizerId": "string", - "priority": 0, - "initialRetryDelay": "string", - "maxRetryDelay": "string", - "timeTracker": { - "observationLatency": "string", - "patienceDuration": "string", - "minObservationDuration": "string", - "timeProofRequest": { - "initialRetryDelay": "string", - "maxRetryDelay": "string", - "maxSequencingDelay": "string" - } - } - }, - "sequencerConnectionValidation": "SEQUENCER_CONNECTION_VALIDATION_UNSPECIFIED" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -820,3 +741,90 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/ModifySynchronizer <<'EOF' +{ + "physicalSynchronizerId": "string", + "newConfig": { + "synchronizerAlias": "string", + "sequencerConnections": { + "sequencerConnections": [ + { + "grpc": {}, + "alias": "string", + "sequencerId": "string" + } + ], + "sequencerTrustThreshold": 0, + "submissionRequestAmplification": { + "factor": 0, + "patience": "string" + }, + "sequencerLivenessMargin": 0, + "sequencerConnectionPoolDelays": { + "minRestartDelay": "string", + "maxRestartDelay": "string", + "subscriptionRequestDelay": "string", + "warnValidationDelay": "string" + } + }, + "manualConnect": true, + "physicalSynchronizerId": "string", + "priority": 0, + "initialRetryDelay": "string", + "maxRetryDelay": "string", + "timeTracker": { + "observationLatency": "string", + "patienceDuration": "string", + "minObservationDuration": "string", + "timeProofRequest": { + "initialRetryDelay": "string", + "maxRetryDelay": "string", + "maxSequencingDelay": "string" + } + } + }, + "sequencerConnectionValidation": "SEQUENCER_CONNECTION_VALIDATION_UNSPECIFIED" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/reconnectsynchronizer.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/reconnectsynchronizer.mdx index baae820..3a26588 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/reconnectsynchronizer.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/reconnectsynchronizer.mdx @@ -4,6 +4,10 @@ title: "ReconnectSynchronizer"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/ReconnectSynchronizer <<'EOF' -{ - "synchronizerAlias": "string", - "retry": true -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "connectedSuccessfully": true -} -``` - -
-
- -
- ## Protocol Details @@ -329,3 +287,53 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/ReconnectSynchronizer <<'EOF' +{ + "synchronizerAlias": "string", + "retry": true +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "connectedSuccessfully": true +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/reconnectsynchronizers.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/reconnectsynchronizers.mdx index b0ed3d9..0583b1f 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/reconnectsynchronizers.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/reconnectsynchronizers.mdx @@ -4,6 +4,10 @@ title: "ReconnectSynchronizers"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/ReconnectSynchronizers <<'EOF' -{ - "ignoreFailures": true -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -278,3 +239,50 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/ReconnectSynchronizers <<'EOF' +{ + "ignoreFailures": true +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/registersynchronizer.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/registersynchronizer.mdx index aeb4544..f2b89ef 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/registersynchronizer.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/registersynchronizer.mdx @@ -4,6 +4,10 @@ title: "RegisterSynchronizer"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/RegisterSynchronizer <<'EOF' -{ - "config": { - "synchronizerAlias": "string", - "sequencerConnections": { - "sequencerConnections": [ - { - "grpc": {}, - "alias": "string", - "sequencerId": "string" - } - ], - "sequencerTrustThreshold": 0, - "submissionRequestAmplification": { - "factor": 0, - "patience": "string" - }, - "sequencerLivenessMargin": 0, - "sequencerConnectionPoolDelays": { - "minRestartDelay": "string", - "maxRestartDelay": "string", - "subscriptionRequestDelay": "string", - "warnValidationDelay": "string" - } - }, - "manualConnect": true, - "physicalSynchronizerId": "string", - "priority": 0, - "initialRetryDelay": "string", - "maxRetryDelay": "string", - "timeTracker": { - "observationLatency": "string", - "patienceDuration": "string", - "minObservationDuration": "string", - "timeProofRequest": { - "initialRetryDelay": "string", - "maxRetryDelay": "string", - "maxSequencingDelay": "string" - } - } - }, - "synchronizerConnection": "SYNCHRONIZER_CONNECTION_UNSPECIFIED", - "sequencerConnectionValidation": "SEQUENCER_CONNECTION_VALIDATION_UNSPECIFIED" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -843,3 +764,90 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/RegisterSynchronizer <<'EOF' +{ + "config": { + "synchronizerAlias": "string", + "sequencerConnections": { + "sequencerConnections": [ + { + "grpc": {}, + "alias": "string", + "sequencerId": "string" + } + ], + "sequencerTrustThreshold": 0, + "submissionRequestAmplification": { + "factor": 0, + "patience": "string" + }, + "sequencerLivenessMargin": 0, + "sequencerConnectionPoolDelays": { + "minRestartDelay": "string", + "maxRestartDelay": "string", + "subscriptionRequestDelay": "string", + "warnValidationDelay": "string" + } + }, + "manualConnect": true, + "physicalSynchronizerId": "string", + "priority": 0, + "initialRetryDelay": "string", + "maxRetryDelay": "string", + "timeTracker": { + "observationLatency": "string", + "patienceDuration": "string", + "minObservationDuration": "string", + "timeProofRequest": { + "initialRetryDelay": "string", + "maxRetryDelay": "string", + "maxSequencingDelay": "string" + } + } + }, + "synchronizerConnection": "SYNCHRONIZER_CONNECTION_UNSPECIFIED", + "sequencerConnectionValidation": "SEQUENCER_CONNECTION_VALIDATION_UNSPECIFIED" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/trafficcontrolservice/trafficcontrolstate.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/trafficcontrolservice/trafficcontrolstate.mdx index 255e39e..94aa805 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/trafficcontrolservice/trafficcontrolstate.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/trafficcontrolservice/trafficcontrolstate.mdx @@ -4,6 +4,10 @@ title: "TrafficControlState"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.participant.v30.TrafficControlService/TrafficControlState <<'EOF' -{ - "synchronizerId": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "trafficState": { - "extraTrafficPurchased": "0", - "extraTrafficConsumed": "0", - "baseTrafficRemainder": "0", - "lastConsumedCost": "0", - "timestamp": "0", - "serial": 0 - } -} -``` - -
-
- -
- ## Protocol Details @@ -392,3 +344,59 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.participant.v30.TrafficControlService/TrafficControlState <<'EOF' +{ + "synchronizerId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "trafficState": { + "extraTrafficPurchased": "0", + "extraTrafficConsumed": "0", + "baseTrafficRemainder": "0", + "lastConsumedCost": "0", + "timestamp": "0", + "serial": 0 + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-sequencer-v30/sequencerstatusservice/sequencerstatus.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-sequencer-v30/sequencerstatusservice/sequencerstatus.mdx index 414547e..b7f3326 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-sequencer-v30/sequencerstatusservice/sequencerstatus.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-sequencer-v30/sequencerstatusservice/sequencerstatus.mdx @@ -4,6 +4,10 @@ title: "SequencerStatus"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.admin.sequencer.v30.SequencerStatusService/SequencerStatus <<'EOF' -{} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "status": { - "commonStatus": { - "uid": "string", - "uptime": "string", - "ports": [ - { - "key": 0 - } - ], - "active": true, - "topologyQueues": { - "manager": 0, - "dispatcher": 0, - "clients": 0 - }, - "components": [ - { - "name": "string", - "ok": {} - } - ], - "version": "string" - }, - "connectedParticipants": [ - { - "uid": "string" - } - ], - "connectedMediators": [ - { - "uid": "string" - } - ], - "sequencer": { - "active": true, - "details": "string" - }, - "physicalSynchronizerId": "string", - "admin": { - "acceptsAdminChanges": true - }, - "protocolVersion": 0 - } -} -``` - -
-
- -
- ## Protocol Details @@ -781,3 +700,92 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.admin.sequencer.v30.SequencerStatusService/SequencerStatus <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "status": { + "commonStatus": { + "uid": "string", + "uptime": "string", + "ports": [ + { + "key": 0 + } + ], + "active": true, + "topologyQueues": { + "manager": 0, + "dispatcher": 0, + "clients": 0 + }, + "components": [ + { + "name": "string", + "ok": {} + } + ], + "version": "string" + }, + "connectedParticipants": [ + { + "uid": "string" + } + ], + "connectedMediators": [ + { + "uid": "string" + } + ], + "sequencer": { + "active": true, + "details": "string" + }, + "physicalSynchronizerId": "string", + "admin": { + "acceptsAdminChanges": true + }, + "protocolVersion": 0 + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-connection-v30/apiinfoservice/getapiinfo.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-connection-v30/apiinfoservice/getapiinfo.mdx index 35c5375..2db3a1a 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-connection-v30/apiinfoservice/getapiinfo.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-connection-v30/apiinfoservice/getapiinfo.mdx @@ -4,6 +4,10 @@ title: "GetApiInfo"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.connection.v30.ApiInfoService/GetApiInfo <<'EOF' -{} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "name": "string" -} -``` - -
-
- -
- ## Protocol Details @@ -274,3 +235,50 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.connection.v30.ApiInfoService/GetApiInfo <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "name": "string" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/deletekeypair.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/deletekeypair.mdx index c3ae143..f1f77ce 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/deletekeypair.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/deletekeypair.mdx @@ -4,6 +4,10 @@ title: "DeleteKeyPair"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.crypto.admin.v30.VaultService/DeleteKeyPair <<'EOF' -{ - "fingerprint": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -274,3 +235,50 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.crypto.admin.v30.VaultService/DeleteKeyPair <<'EOF' +{ + "fingerprint": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/exportkeypair.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/exportkeypair.mdx index e1a7a38..1636164 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/exportkeypair.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/exportkeypair.mdx @@ -4,6 +4,10 @@ title: "ExportKeyPair"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.crypto.admin.v30.VaultService/ExportKeyPair <<'EOF' -{ - "fingerprint": "string", - "protocolVersion": 0, - "password": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "keyPair": "BASE64_ENCODED_BYTES" -} -``` - -
-
- -
- ## Protocol Details @@ -352,3 +309,54 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.crypto.admin.v30.VaultService/ExportKeyPair <<'EOF' +{ + "fingerprint": "string", + "protocolVersion": 0, + "password": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "keyPair": "BASE64_ENCODED_BYTES" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/generateencryptionkey.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/generateencryptionkey.mdx index 2bad0c0..dddddbf 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/generateencryptionkey.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/generateencryptionkey.mdx @@ -4,6 +4,10 @@ title: "GenerateEncryptionKey"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.crypto.admin.v30.VaultService/GenerateEncryptionKey <<'EOF' -{ - "keySpec": "ENCRYPTION_KEY_SPEC_UNSPECIFIED", - "name": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "publicKey": { - "format": "CRYPTO_KEY_FORMAT_UNSPECIFIED", - "publicKey": "BASE64_ENCODED_BYTES", - "scheme": "ENCRYPTION_KEY_SCHEME_UNSPECIFIED", - "keySpec": "ENCRYPTION_KEY_SPEC_UNSPECIFIED" - } -} -``` - -
-
- -
- ## Protocol Details @@ -450,3 +403,58 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.crypto.admin.v30.VaultService/GenerateEncryptionKey <<'EOF' +{ + "keySpec": "ENCRYPTION_KEY_SPEC_UNSPECIFIED", + "name": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "publicKey": { + "format": "CRYPTO_KEY_FORMAT_UNSPECIFIED", + "publicKey": "BASE64_ENCODED_BYTES", + "scheme": "ENCRYPTION_KEY_SCHEME_UNSPECIFIED", + "keySpec": "ENCRYPTION_KEY_SPEC_UNSPECIFIED" + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/generatesigningkey.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/generatesigningkey.mdx index 762d990..ec8249d 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/generatesigningkey.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/generatesigningkey.mdx @@ -4,6 +4,10 @@ title: "GenerateSigningKey"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.crypto.admin.v30.VaultService/GenerateSigningKey <<'EOF' -{ - "keySpec": "SIGNING_KEY_SPEC_UNSPECIFIED", - "name": "string", - "usage": [ - "SIGNING_KEY_USAGE_UNSPECIFIED" - ] -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "publicKey": { - "format": "CRYPTO_KEY_FORMAT_UNSPECIFIED", - "publicKey": "BASE64_ENCODED_BYTES", - "scheme": "SIGNING_KEY_SCHEME_UNSPECIFIED", - "usage": [ - "SIGNING_KEY_USAGE_UNSPECIFIED" - ], - "keySpec": "SIGNING_KEY_SPEC_UNSPECIFIED" - } -} -``` - -
-
- -
- ## Protocol Details @@ -518,3 +465,64 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.crypto.admin.v30.VaultService/GenerateSigningKey <<'EOF' +{ + "keySpec": "SIGNING_KEY_SPEC_UNSPECIFIED", + "name": "string", + "usage": [ + "SIGNING_KEY_USAGE_UNSPECIFIED" + ] +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "publicKey": { + "format": "CRYPTO_KEY_FORMAT_UNSPECIFIED", + "publicKey": "BASE64_ENCODED_BYTES", + "scheme": "SIGNING_KEY_SCHEME_UNSPECIFIED", + "usage": [ + "SIGNING_KEY_USAGE_UNSPECIFIED" + ], + "keySpec": "SIGNING_KEY_SPEC_UNSPECIFIED" + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/getwrapperkeyid.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/getwrapperkeyid.mdx index 0025027..e0e9df5 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/getwrapperkeyid.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/getwrapperkeyid.mdx @@ -4,6 +4,10 @@ title: "GetWrapperKeyId"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.crypto.admin.v30.VaultService/GetWrapperKeyId <<'EOF' -{} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "wrapperKeyId": "string" -} -``` - -
-
- -
- ## Protocol Details @@ -274,3 +235,50 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.crypto.admin.v30.VaultService/GetWrapperKeyId <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "wrapperKeyId": "string" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/importkeypair.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/importkeypair.mdx index 3a547b9..75c8e8a 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/importkeypair.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/importkeypair.mdx @@ -4,6 +4,10 @@ title: "ImportKeyPair"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.crypto.admin.v30.VaultService/ImportKeyPair <<'EOF' -{ - "keyPair": "BASE64_ENCODED_BYTES", - "name": "string", - "password": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -316,3 +275,52 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.crypto.admin.v30.VaultService/ImportKeyPair <<'EOF' +{ + "keyPair": "BASE64_ENCODED_BYTES", + "name": "string", + "password": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/importpublickey.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/importpublickey.mdx index e4066da..72c5901 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/importpublickey.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/importpublickey.mdx @@ -4,6 +4,10 @@ title: "ImportPublicKey"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.crypto.admin.v30.VaultService/ImportPublicKey <<'EOF' -{ - "publicKey": "BASE64_ENCODED_BYTES", - "name": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "fingerprint": "string" -} -``` - -
-
- -
- ## Protocol Details @@ -333,3 +291,53 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.crypto.admin.v30.VaultService/ImportPublicKey <<'EOF' +{ + "publicKey": "BASE64_ENCODED_BYTES", + "name": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "fingerprint": "string" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/listmykeys.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/listmykeys.mdx index e1f210e..ea1ebc6 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/listmykeys.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/listmykeys.mdx @@ -4,6 +4,10 @@ title: "ListMyKeys"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.crypto.admin.v30.VaultService/ListMyKeys <<'EOF' -{ - "filters": { - "fingerprint": "string", - "name": "string", - "purpose": [ - "KEY_PURPOSE_UNSPECIFIED" - ], - "usage": [ - "SIGNING_KEY_USAGE_UNSPECIFIED" - ] - } -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "privateKeysMetadata": [ - { - "publicKeyWithName": { - "publicKey": { - "signingPublicKey": {} - }, - "name": "string" - }, - "wrapperKeyId": "string", - "kmsKeyId": "string" - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -761,3 +700,72 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.crypto.admin.v30.VaultService/ListMyKeys <<'EOF' +{ + "filters": { + "fingerprint": "string", + "name": "string", + "purpose": [ + "KEY_PURPOSE_UNSPECIFIED" + ], + "usage": [ + "SIGNING_KEY_USAGE_UNSPECIFIED" + ] + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "privateKeysMetadata": [ + { + "publicKeyWithName": { + "publicKey": { + "signingPublicKey": {} + }, + "name": "string" + }, + "wrapperKeyId": "string", + "kmsKeyId": "string" + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/listpublickeys.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/listpublickeys.mdx index 952027d..9371a99 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/listpublickeys.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/listpublickeys.mdx @@ -4,6 +4,10 @@ title: "ListPublicKeys"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.crypto.admin.v30.VaultService/ListPublicKeys <<'EOF' -{ - "filters": { - "fingerprint": "string", - "name": "string", - "purpose": [ - "KEY_PURPOSE_UNSPECIFIED" - ], - "usage": [ - "SIGNING_KEY_USAGE_UNSPECIFIED" - ] - } -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "publicKeys": [ - { - "publicKey": { - "signingPublicKey": { - "format": "CRYPTO_KEY_FORMAT_UNSPECIFIED", - "publicKey": "BASE64_ENCODED_BYTES", - "scheme": "SIGNING_KEY_SCHEME_UNSPECIFIED", - "usage": [ - "SIGNING_KEY_USAGE_UNSPECIFIED" - ], - "keySpec": "SIGNING_KEY_SPEC_UNSPECIFIED" - } - }, - "name": "string" - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -721,3 +656,76 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.crypto.admin.v30.VaultService/ListPublicKeys <<'EOF' +{ + "filters": { + "fingerprint": "string", + "name": "string", + "purpose": [ + "KEY_PURPOSE_UNSPECIFIED" + ], + "usage": [ + "SIGNING_KEY_USAGE_UNSPECIFIED" + ] + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "publicKeys": [ + { + "publicKey": { + "signingPublicKey": { + "format": "CRYPTO_KEY_FORMAT_UNSPECIFIED", + "publicKey": "BASE64_ENCODED_BYTES", + "scheme": "SIGNING_KEY_SCHEME_UNSPECIFIED", + "usage": [ + "SIGNING_KEY_USAGE_UNSPECIFIED" + ], + "keySpec": "SIGNING_KEY_SPEC_UNSPECIFIED" + } + }, + "name": "string" + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/registerkmsencryptionkey.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/registerkmsencryptionkey.mdx index 1894408..e6f090b 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/registerkmsencryptionkey.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/registerkmsencryptionkey.mdx @@ -4,6 +4,10 @@ title: "RegisterKmsEncryptionKey"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.crypto.admin.v30.VaultService/RegisterKmsEncryptionKey <<'EOF' -{ - "kmsKeyId": "string", - "name": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "publicKey": { - "format": "CRYPTO_KEY_FORMAT_UNSPECIFIED", - "publicKey": "BASE64_ENCODED_BYTES", - "scheme": "ENCRYPTION_KEY_SCHEME_UNSPECIFIED", - "keySpec": "ENCRYPTION_KEY_SPEC_UNSPECIFIED" - } -} -``` - -
-
- -
- ## Protocol Details @@ -450,3 +403,58 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.crypto.admin.v30.VaultService/RegisterKmsEncryptionKey <<'EOF' +{ + "kmsKeyId": "string", + "name": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "publicKey": { + "format": "CRYPTO_KEY_FORMAT_UNSPECIFIED", + "publicKey": "BASE64_ENCODED_BYTES", + "scheme": "ENCRYPTION_KEY_SCHEME_UNSPECIFIED", + "keySpec": "ENCRYPTION_KEY_SPEC_UNSPECIFIED" + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/registerkmssigningkey.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/registerkmssigningkey.mdx index 047b225..496c424 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/registerkmssigningkey.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/registerkmssigningkey.mdx @@ -4,6 +4,10 @@ title: "RegisterKmsSigningKey"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.crypto.admin.v30.VaultService/RegisterKmsSigningKey <<'EOF' -{ - "kmsKeyId": "string", - "name": "string", - "usage": [ - "SIGNING_KEY_USAGE_UNSPECIFIED" - ] -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "publicKey": { - "format": "CRYPTO_KEY_FORMAT_UNSPECIFIED", - "publicKey": "BASE64_ENCODED_BYTES", - "scheme": "SIGNING_KEY_SCHEME_UNSPECIFIED", - "usage": [ - "SIGNING_KEY_USAGE_UNSPECIFIED" - ], - "keySpec": "SIGNING_KEY_SPEC_UNSPECIFIED" - } -} -``` - -
-
- -
- ## Protocol Details @@ -518,3 +465,64 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.crypto.admin.v30.VaultService/RegisterKmsSigningKey <<'EOF' +{ + "kmsKeyId": "string", + "name": "string", + "usage": [ + "SIGNING_KEY_USAGE_UNSPECIFIED" + ] +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "publicKey": { + "format": "CRYPTO_KEY_FORMAT_UNSPECIFIED", + "publicKey": "BASE64_ENCODED_BYTES", + "scheme": "SIGNING_KEY_SCHEME_UNSPECIFIED", + "usage": [ + "SIGNING_KEY_USAGE_UNSPECIFIED" + ], + "keySpec": "SIGNING_KEY_SPEC_UNSPECIFIED" + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/rotatewrapperkey.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/rotatewrapperkey.mdx index 17bac49..13d1641 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/rotatewrapperkey.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/rotatewrapperkey.mdx @@ -4,6 +4,10 @@ title: "RotateWrapperKey"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.crypto.admin.v30.VaultService/RotateWrapperKey <<'EOF' -{ - "newWrapperKeyId": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -274,3 +235,50 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.crypto.admin.v30.VaultService/RotateWrapperKey <<'EOF' +{ + "newWrapperKeyId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/clearschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/clearschedule.mdx index 37cf265..bfae5d4 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/clearschedule.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/clearschedule.mdx @@ -4,6 +4,10 @@ title: "ClearSchedule"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.mediator.admin.v30.MediatorAdministrationService/ClearSchedule <<'EOF' -{} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -246,3 +209,48 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.mediator.admin.v30.MediatorAdministrationService/ClearSchedule <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/findpruningtimestamp.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/findpruningtimestamp.mdx index bd766e2..d5aa456 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/findpruningtimestamp.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/findpruningtimestamp.mdx @@ -4,6 +4,10 @@ title: "FindPruningTimestamp"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.mediator.admin.v30.MediatorAdministrationService/FindPruningTimestamp <<'EOF' -{ - "index": 0 -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "timestamp": "string" -} -``` - -
-
- -
- ## Protocol Details @@ -310,3 +269,52 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.mediator.admin.v30.MediatorAdministrationService/FindPruningTimestamp <<'EOF' +{ + "index": 0 +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "timestamp": "string" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/getschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/getschedule.mdx index 9bcbb1d..f98ab8b 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/getschedule.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/getschedule.mdx @@ -4,6 +4,10 @@ title: "GetSchedule"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.mediator.admin.v30.MediatorAdministrationService/GetSchedule <<'EOF' -{} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "schedule": { - "cron": "string", - "maxDuration": "string", - "retention": "string" - } -} -``` - -
-
- -
- ## Protocol Details @@ -318,3 +275,54 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.mediator.admin.v30.MediatorAdministrationService/GetSchedule <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "schedule": { + "cron": "string", + "maxDuration": "string", + "retention": "string" + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/prune.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/prune.mdx index 7c79ea3..5082161 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/prune.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/prune.mdx @@ -4,6 +4,10 @@ title: "Prune"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.mediator.admin.v30.MediatorAdministrationService/Prune <<'EOF' -{ - "timestamp": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -278,3 +239,50 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.mediator.admin.v30.MediatorAdministrationService/Prune <<'EOF' +{ + "timestamp": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setcron.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setcron.mdx index 9f0e069..c09f0da 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setcron.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setcron.mdx @@ -4,6 +4,10 @@ title: "SetCron"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.mediator.admin.v30.MediatorAdministrationService/SetCron <<'EOF' -{ - "cron": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -274,3 +235,50 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.mediator.admin.v30.MediatorAdministrationService/SetCron <<'EOF' +{ + "cron": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setmaxduration.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setmaxduration.mdx index 8626b7e..805bc5c 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setmaxduration.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setmaxduration.mdx @@ -4,6 +4,10 @@ title: "SetMaxDuration"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.mediator.admin.v30.MediatorAdministrationService/SetMaxDuration <<'EOF' -{ - "maxDuration": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -274,3 +235,50 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.mediator.admin.v30.MediatorAdministrationService/SetMaxDuration <<'EOF' +{ + "maxDuration": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setretention.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setretention.mdx index ca6f3cd..2c9b56a 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setretention.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setretention.mdx @@ -4,6 +4,10 @@ title: "SetRetention"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.mediator.admin.v30.MediatorAdministrationService/SetRetention <<'EOF' -{ - "retention": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -274,3 +235,50 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.mediator.admin.v30.MediatorAdministrationService/SetRetention <<'EOF' +{ + "retention": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setschedule.mdx index 250c539..a3da10e 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setschedule.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setschedule.mdx @@ -4,6 +4,10 @@ title: "SetSchedule"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.mediator.admin.v30.MediatorAdministrationService/SetSchedule <<'EOF' -{ - "schedule": { - "cron": "string", - "maxDuration": "string", - "retention": "string" - } -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -318,3 +275,54 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.mediator.admin.v30.MediatorAdministrationService/SetSchedule <<'EOF' +{ + "schedule": { + "cron": "string", + "maxDuration": "string", + "retention": "string" + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatorinitializationservice/initializemediator.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatorinitializationservice/initializemediator.mdx index 8d8e410..5a0062f 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatorinitializationservice/initializemediator.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatorinitializationservice/initializemediator.mdx @@ -4,6 +4,10 @@ title: "InitializeMediator"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.mediator.admin.v30.MediatorInitializationService/InitializeMediator <<'EOF' -{ - "physicalSynchronizerId": "string", - "sequencerConnections": { - "sequencerConnections": [ - { - "grpc": { - "connections": [ - "string" - ], - "transportSecurity": true, - "customTrustCertificates": "BASE64_ENCODED_BYTES" - }, - "alias": "string", - "sequencerId": "string" - } - ], - "sequencerTrustThreshold": 0, - "submissionRequestAmplification": { - "factor": 0, - "patience": "string" - }, - "sequencerLivenessMargin": 0, - "sequencerConnectionPoolDelays": { - "minRestartDelay": "string", - "maxRestartDelay": "string", - "subscriptionRequestDelay": "string", - "warnValidationDelay": "string" - } - }, - "sequencerConnectionValidation": "SEQUENCER_CONNECTION_VALIDATION_UNSPECIFIED" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -615,3 +548,78 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.mediator.admin.v30.MediatorInitializationService/InitializeMediator <<'EOF' +{ + "physicalSynchronizerId": "string", + "sequencerConnections": { + "sequencerConnections": [ + { + "grpc": { + "connections": [ + "string" + ], + "transportSecurity": true, + "customTrustCertificates": "BASE64_ENCODED_BYTES" + }, + "alias": "string", + "sequencerId": "string" + } + ], + "sequencerTrustThreshold": 0, + "submissionRequestAmplification": { + "factor": 0, + "patience": "string" + }, + "sequencerLivenessMargin": 0, + "sequencerConnectionPoolDelays": { + "minRestartDelay": "string", + "maxRestartDelay": "string", + "subscriptionRequestDelay": "string", + "warnValidationDelay": "string" + } + }, + "sequencerConnectionValidation": "SEQUENCER_CONNECTION_VALIDATION_UNSPECIFIED" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatorinspectionservice/verdicts.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatorinspectionservice/verdicts.mdx index 2046512..a514c34 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatorinspectionservice/verdicts.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatorinspectionservice/verdicts.mdx @@ -4,6 +4,10 @@ title: "Verdicts"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.mediator.admin.v30.MediatorInspectionService/Verdicts <<'EOF' -{ - "mostRecentlyReceivedRecordTime": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "verdict": { - "submittingParties": [ - "string" - ], - "submittingParticipantUid": "string", - "verdict": "VERDICT_RESULT_UNSPECIFIED", - "finalizationTime": "string", - "recordTime": "string", - "mediatorGroup": 0, - "transactionViews": { - "views": [ - { - "key": { - "informees": [ - "string" - ], - "confirmingParties": [ - {} - ], - "subViews": [ - 0 - ] - } - } - ], - "rootViews": [ - 0 - ] - }, - "updateId": "string" - } -} -``` - -
-
- -
- ## Protocol Details @@ -478,3 +406,83 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.mediator.admin.v30.MediatorInspectionService/Verdicts <<'EOF' +{ + "mostRecentlyReceivedRecordTime": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "verdict": { + "submittingParties": [ + "string" + ], + "submittingParticipantUid": "string", + "verdict": "VERDICT_RESULT_UNSPECIFIED", + "finalizationTime": "string", + "recordTime": "string", + "mediatorGroup": 0, + "transactionViews": { + "views": [ + { + "key": { + "informees": [ + "string" + ], + "confirmingParties": [ + {} + ], + "subViews": [ + 0 + ] + } + } + ], + "rootViews": [ + 0 + ] + }, + "updateId": "string" + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/sequencerconnectionservice/getconnection.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/sequencerconnectionservice/getconnection.mdx index 8682017..b14b460 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/sequencerconnectionservice/getconnection.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/sequencerconnectionservice/getconnection.mdx @@ -4,6 +4,10 @@ title: "GetConnection"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.mediator.admin.v30.SequencerConnectionService/GetConnection <<'EOF' -{} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "sequencerConnections": { - "sequencerConnections": [ - { - "grpc": { - "connections": [ - "string" - ], - "transportSecurity": true, - "customTrustCertificates": "BASE64_ENCODED_BYTES" - }, - "alias": "string", - "sequencerId": "string" - } - ], - "sequencerTrustThreshold": 0, - "submissionRequestAmplification": { - "factor": 0, - "patience": "string" - }, - "sequencerLivenessMargin": 0, - "sequencerConnectionPoolDelays": { - "minRestartDelay": "string", - "maxRestartDelay": "string", - "subscriptionRequestDelay": "string", - "warnValidationDelay": "string" - } - } -} -``` - -
-
- -
- ## Protocol Details @@ -546,3 +481,76 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.mediator.admin.v30.SequencerConnectionService/GetConnection <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "sequencerConnections": { + "sequencerConnections": [ + { + "grpc": { + "connections": [ + "string" + ], + "transportSecurity": true, + "customTrustCertificates": "BASE64_ENCODED_BYTES" + }, + "alias": "string", + "sequencerId": "string" + } + ], + "sequencerTrustThreshold": 0, + "submissionRequestAmplification": { + "factor": 0, + "patience": "string" + }, + "sequencerLivenessMargin": 0, + "sequencerConnectionPoolDelays": { + "minRestartDelay": "string", + "maxRestartDelay": "string", + "subscriptionRequestDelay": "string", + "warnValidationDelay": "string" + } + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/sequencerconnectionservice/logout.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/sequencerconnectionservice/logout.mdx index 9eeb54b..6f70de7 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/sequencerconnectionservice/logout.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/sequencerconnectionservice/logout.mdx @@ -4,6 +4,10 @@ title: "Logout"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.mediator.admin.v30.SequencerConnectionService/Logout <<'EOF' -{} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -246,3 +209,48 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.mediator.admin.v30.SequencerConnectionService/Logout <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/sequencerconnectionservice/setconnection.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/sequencerconnectionservice/setconnection.mdx index 724a1cb..37425ce 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/sequencerconnectionservice/setconnection.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/sequencerconnectionservice/setconnection.mdx @@ -4,6 +4,10 @@ title: "SetConnection"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.mediator.admin.v30.SequencerConnectionService/SetConnection <<'EOF' -{ - "sequencerConnections": { - "sequencerConnections": [ - { - "grpc": { - "connections": [ - "string" - ], - "transportSecurity": true, - "customTrustCertificates": "BASE64_ENCODED_BYTES" - }, - "alias": "string", - "sequencerId": "string" - } - ], - "sequencerTrustThreshold": 0, - "submissionRequestAmplification": { - "factor": 0, - "patience": "string" - }, - "sequencerLivenessMargin": 0, - "sequencerConnectionPoolDelays": { - "minRestartDelay": "string", - "maxRestartDelay": "string", - "subscriptionRequestDelay": "string", - "warnValidationDelay": "string" - } - }, - "sequencerConnectionValidation": "SEQUENCER_CONNECTION_VALIDATION_UNSPECIFIED" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -592,3 +526,77 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.mediator.admin.v30.SequencerConnectionService/SetConnection <<'EOF' +{ + "sequencerConnections": { + "sequencerConnections": [ + { + "grpc": { + "connections": [ + "string" + ], + "transportSecurity": true, + "customTrustCertificates": "BASE64_ENCODED_BYTES" + }, + "alias": "string", + "sequencerId": "string" + } + ], + "sequencerTrustThreshold": 0, + "submissionRequestAmplification": { + "factor": 0, + "patience": "string" + }, + "sequencerLivenessMargin": 0, + "sequencerConnectionPoolDelays": { + "minRestartDelay": "string", + "maxRestartDelay": "string", + "subscriptionRequestDelay": "string", + "warnValidationDelay": "string" + } + }, + "sequencerConnectionValidation": "SEQUENCER_CONNECTION_VALIDATION_UNSPECIFIED" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/disablemember.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/disablemember.mdx index 5d0b833..f6bd182 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/disablemember.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/disablemember.mdx @@ -4,6 +4,10 @@ title: "DisableMember"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.admin.v30.SequencerAdministrationService/DisableMember <<'EOF' -{ - "member": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -274,3 +235,50 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerAdministrationService/DisableMember <<'EOF' +{ + "member": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/generateauthenticationtoken.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/generateauthenticationtoken.mdx index 756ed69..e2fe6ca 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/generateauthenticationtoken.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/generateauthenticationtoken.mdx @@ -4,6 +4,10 @@ title: "GenerateAuthenticationToken"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.admin.v30.SequencerAdministrationService/GenerateAuthenticationToken <<'EOF' -{ - "member": "string", - "expiresIn": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "token": "BASE64_ENCODED_BYTES", - "expiresAt": "string" -} -``` - -
-
- -
- ## Protocol Details @@ -356,3 +313,54 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerAdministrationService/GenerateAuthenticationToken <<'EOF' +{ + "member": "string", + "expiresIn": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "token": "BASE64_ENCODED_BYTES", + "expiresAt": "string" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/onboardingstate.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/onboardingstate.mdx index 178a442..2f8435e 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/onboardingstate.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/onboardingstate.mdx @@ -4,6 +4,10 @@ title: "OnboardingState"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.admin.v30.SequencerAdministrationService/OnboardingState <<'EOF' -{ - "sequencerUid": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "onboardingStateForSequencer": "BASE64_ENCODED_BYTES" -} -``` - -
-
- -
- ## Protocol Details @@ -333,3 +291,53 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerAdministrationService/OnboardingState <<'EOF' +{ + "sequencerUid": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "onboardingStateForSequencer": "BASE64_ENCODED_BYTES" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/onboardingstatev2.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/onboardingstatev2.mdx index 1c4343e..cc66267 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/onboardingstatev2.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/onboardingstatev2.mdx @@ -4,6 +4,10 @@ title: "OnboardingStateV2"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.admin.v30.SequencerAdministrationService/OnboardingStateV2 <<'EOF' -{ - "sequencerUid": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "onboardingStateForSequencer": "BASE64_ENCODED_BYTES" -} -``` - -
-
- -
- ## Protocol Details @@ -333,3 +291,53 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerAdministrationService/OnboardingStateV2 <<'EOF' +{ + "sequencerUid": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "onboardingStateForSequencer": "BASE64_ENCODED_BYTES" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/pruningstatus.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/pruningstatus.mdx index 071976f..f376c99 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/pruningstatus.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/pruningstatus.mdx @@ -4,6 +4,10 @@ title: "PruningStatus"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.admin.v30.SequencerAdministrationService/PruningStatus <<'EOF' -{} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "pruningStatus": { - "now": "0", - "earliestEventTimestamp": "0", - "members": [ - { - "member": "string", - "registeredAt": "0", - "lastAcknowledged": "0", - "enabled": true - } - ] - } -} -``` - -
-
- -
- ## Protocol Details @@ -384,3 +334,61 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerAdministrationService/PruningStatus <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "pruningStatus": { + "now": "0", + "earliestEventTimestamp": "0", + "members": [ + { + "member": "string", + "registeredAt": "0", + "lastAcknowledged": "0", + "enabled": true + } + ] + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/settrafficpurchased.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/settrafficpurchased.mdx index 3de89c2..b6ae692 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/settrafficpurchased.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/settrafficpurchased.mdx @@ -4,6 +4,10 @@ title: "SetTrafficPurchased"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.admin.v30.SequencerAdministrationService/SetTrafficPurchased <<'EOF' -{ - "member": "string", - "serial": 0, - "totalTrafficPurchased": "0" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -324,3 +283,52 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerAdministrationService/SetTrafficPurchased <<'EOF' +{ + "member": "string", + "serial": 0, + "totalTrafficPurchased": "0" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/snapshot.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/snapshot.mdx index af40935..50d2eb7 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/snapshot.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/snapshot.mdx @@ -4,6 +4,10 @@ title: "Snapshot"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.admin.v30.SequencerAdministrationService/Snapshot <<'EOF' -{ - "timestamp": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "success": { - "state": { - "latestTimestamp": "0", - "lastBlockHeight": "0", - "status": { - "now": "0", - "earliestEventTimestamp": "0", - "members": [ - {} - ] - }, - "additional": { - "implementationName": "string", - "info": "BASE64_ENCODED_BYTES" - }, - "inFlightAggregations": [ - { - "aggregationId": "BASE64_ENCODED_BYTES", - "aggregationRule": {}, - "maxSequencingTime": "0", - "aggregatedSenders": [ - {} - ] - } - ], - "trafficPurchased": [ - { - "member": "string", - "serial": 0, - "extraTrafficPurchased": "0", - "sequencingTimestamp": "0" - } - ], - "trafficConsumed": [ - { - "member": "string", - "extraTrafficConsumed": "0", - "baseTrafficRemainder": "0", - "lastConsumedCost": "0", - "sequencingTimestamp": "0" - } - ], - "memberPreviousTimestamps": [ - { - "member": "string", - "previousTimestamp": "0" - } - ] - } - } -} -``` - -
-
- -
- ## Protocol Details @@ -1207,3 +1117,101 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerAdministrationService/Snapshot <<'EOF' +{ + "timestamp": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "success": { + "state": { + "latestTimestamp": "0", + "lastBlockHeight": "0", + "status": { + "now": "0", + "earliestEventTimestamp": "0", + "members": [ + {} + ] + }, + "additional": { + "implementationName": "string", + "info": "BASE64_ENCODED_BYTES" + }, + "inFlightAggregations": [ + { + "aggregationId": "BASE64_ENCODED_BYTES", + "aggregationRule": {}, + "maxSequencingTime": "0", + "aggregatedSenders": [ + {} + ] + } + ], + "trafficPurchased": [ + { + "member": "string", + "serial": 0, + "extraTrafficPurchased": "0", + "sequencingTimestamp": "0" + } + ], + "trafficConsumed": [ + { + "member": "string", + "extraTrafficConsumed": "0", + "baseTrafficRemainder": "0", + "lastConsumedCost": "0", + "sequencingTimestamp": "0" + } + ], + "memberPreviousTimestamps": [ + { + "member": "string", + "previousTimestamp": "0" + } + ] + } + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/trafficcontrolstate.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/trafficcontrolstate.mdx index 9309283..e2427b6 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/trafficcontrolstate.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/trafficcontrolstate.mdx @@ -4,6 +4,10 @@ title: "TrafficControlState"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.admin.v30.SequencerAdministrationService/TrafficControlState <<'EOF' -{ - "members": [ - "string" - ], - "exactTimestamp": "0" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "trafficStates": [ - { - "key": { - "extraTrafficPurchased": "0", - "extraTrafficConsumed": "0", - "baseTrafficRemainder": "0", - "lastConsumedCost": "0", - "timestamp": "0", - "serial": 0 - } - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -387,3 +332,66 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerAdministrationService/TrafficControlState <<'EOF' +{ + "members": [ + "string" + ], + "exactTimestamp": "0" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "trafficStates": [ + { + "key": { + "extraTrafficPurchased": "0", + "extraTrafficConsumed": "0", + "baseTrafficRemainder": "0", + "lastConsumedCost": "0", + "timestamp": "0", + "serial": 0 + } + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/addpeerendpoint.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/addpeerendpoint.mdx index af8b401..c8a7c01 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/addpeerendpoint.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/addpeerendpoint.mdx @@ -4,6 +4,10 @@ title: "AddPeerEndpoint"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.admin.v30.SequencerBftAdministrationService/AddPeerEndpoint <<'EOF' -{ - "endpoint": { - "address": "string", - "port": 0, - "plainText": {} - } -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "added": true -} -``` - -
-
- -
- ## Protocol Details @@ -430,3 +385,56 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerBftAdministrationService/AddPeerEndpoint <<'EOF' +{ + "endpoint": { + "address": "string", + "port": 0, + "plainText": {} + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "added": true +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/getorderingtopology.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/getorderingtopology.mdx index e0511b2..6832c8a 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/getorderingtopology.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/getorderingtopology.mdx @@ -4,6 +4,10 @@ title: "GetOrderingTopology"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.admin.v30.SequencerBftAdministrationService/GetOrderingTopology <<'EOF' -{} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "currentEpoch": "0", - "sequencerIds": [ - "string" - ] -} -``` - -
-
- -
- ## Protocol Details @@ -303,3 +261,53 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerBftAdministrationService/GetOrderingTopology <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "currentEpoch": "0", + "sequencerIds": [ + "string" + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/getpeernetworkstatus.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/getpeernetworkstatus.mdx index b3a5194..6fb64a8 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/getpeernetworkstatus.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/getpeernetworkstatus.mdx @@ -4,6 +4,10 @@ title: "GetPeerNetworkStatus"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.admin.v30.SequencerBftAdministrationService/GetPeerNetworkStatus <<'EOF' -{ - "endpointIds": [ - { - "address": "string", - "port": 0, - "tls": true - } - ] -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "statuses": [ - { - "peerEndpointStatus": { - "endpointId": { - "address": "string", - "port": 0, - "tls": true - }, - "isOutgoingConnection": true, - "health": { - "status": {}, - "description": "string" - } - } - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -567,3 +505,73 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerBftAdministrationService/GetPeerNetworkStatus <<'EOF' +{ + "endpointIds": [ + { + "address": "string", + "port": 0, + "tls": true + } + ] +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "statuses": [ + { + "peerEndpointStatus": { + "endpointId": { + "address": "string", + "port": 0, + "tls": true + }, + "isOutgoingConnection": true, + "health": { + "status": {}, + "description": "string" + } + } + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/removepeerendpoint.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/removepeerendpoint.mdx index 49b90cf..bced6d9 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/removepeerendpoint.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/removepeerendpoint.mdx @@ -4,6 +4,10 @@ title: "RemovePeerEndpoint"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.admin.v30.SequencerBftAdministrationService/RemovePeerEndpoint <<'EOF' -{ - "endpointId": { - "address": "string", - "port": 0, - "tls": true - } -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "removed": true -} -``` - -
-
- -
- ## Protocol Details @@ -350,3 +305,56 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerBftAdministrationService/RemovePeerEndpoint <<'EOF' +{ + "endpointId": { + "address": "string", + "port": 0, + "tls": true + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "removed": true +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/setperformancemetricsenabled.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/setperformancemetricsenabled.mdx index 34eae96..ce6c8e9 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/setperformancemetricsenabled.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/setperformancemetricsenabled.mdx @@ -4,6 +4,10 @@ title: "SetPerformanceMetricsEnabled"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.admin.v30.SequencerBftAdministrationService/SetPerformanceMetricsEnabled <<'EOF' -{ - "enabled": true -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -274,3 +235,50 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerBftAdministrationService/SetPerformanceMetricsEnabled <<'EOF' +{ + "enabled": true +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/bftprune.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/bftprune.mdx index 4fe8ee5..1aabe60 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/bftprune.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/bftprune.mdx @@ -4,6 +4,10 @@ title: "BftPrune"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/BftPrune <<'EOF' -{ - "retention": "string", - "minBlocksToKeep": 0 -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "message": "string" -} -``` - -
-
- -
- ## Protocol Details @@ -321,3 +279,53 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/BftPrune <<'EOF' +{ + "retention": "string", + "minBlocksToKeep": 0 +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "message": "string" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/bftpruningstatus.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/bftpruningstatus.mdx index 8328f3b..55a1bce 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/bftpruningstatus.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/bftpruningstatus.mdx @@ -4,6 +4,10 @@ title: "BftPruningStatus"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/BftPruningStatus <<'EOF' -{} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "latestBlockEpoch": "0", - "latestBlock": "0", - "latestBlockTimestamp": "string", - "lowerBoundEpoch": "0", - "lowerBoundBlock": "0" -} -``` - -
-
- -
- ## Protocol Details @@ -350,3 +307,54 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/BftPruningStatus <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "latestBlockEpoch": "0", + "latestBlock": "0", + "latestBlockTimestamp": "string", + "lowerBoundEpoch": "0", + "lowerBoundBlock": "0" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/clearschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/clearschedule.mdx index 229665b..c142384 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/clearschedule.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/clearschedule.mdx @@ -4,6 +4,10 @@ title: "ClearSchedule"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/ClearSchedule <<'EOF' -{} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -246,3 +209,48 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/ClearSchedule <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/getbftschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/getbftschedule.mdx index cae3f81..c42a64b 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/getbftschedule.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/getbftschedule.mdx @@ -4,6 +4,10 @@ title: "GetBftSchedule"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/GetBftSchedule <<'EOF' -{} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "schedule": { - "schedule": { - "cron": "string", - "maxDuration": "string", - "retention": "string" - }, - "minBlocksToKeep": 0 - } -} -``` - -
-
- -
- ## Protocol Details @@ -352,3 +306,57 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/GetBftSchedule <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "schedule": { + "schedule": { + "cron": "string", + "maxDuration": "string", + "retention": "string" + }, + "minBlocksToKeep": 0 + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/getschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/getschedule.mdx index 66c7bfd..31f9b66 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/getschedule.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/getschedule.mdx @@ -4,6 +4,10 @@ title: "GetSchedule"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/GetSchedule <<'EOF' -{} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "schedule": { - "cron": "string", - "maxDuration": "string", - "retention": "string" - } -} -``` - -
-
- -
- ## Protocol Details @@ -318,3 +275,54 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/GetSchedule <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "schedule": { + "cron": "string", + "maxDuration": "string", + "retention": "string" + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setbftschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setbftschedule.mdx index 00a7c53..23ff909 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setbftschedule.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setbftschedule.mdx @@ -4,6 +4,10 @@ title: "SetBftSchedule"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/SetBftSchedule <<'EOF' -{ - "schedule": { - "schedule": { - "cron": "string", - "maxDuration": "string", - "retention": "string" - }, - "minBlocksToKeep": 0 - } -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -352,3 +306,57 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/SetBftSchedule <<'EOF' +{ + "schedule": { + "schedule": { + "cron": "string", + "maxDuration": "string", + "retention": "string" + }, + "minBlocksToKeep": 0 + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setcron.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setcron.mdx index d5b1ad0..3b93ae8 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setcron.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setcron.mdx @@ -4,6 +4,10 @@ title: "SetCron"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/SetCron <<'EOF' -{ - "cron": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -274,3 +235,50 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/SetCron <<'EOF' +{ + "cron": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setmaxduration.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setmaxduration.mdx index c45f079..c2c1842 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setmaxduration.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setmaxduration.mdx @@ -4,6 +4,10 @@ title: "SetMaxDuration"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/SetMaxDuration <<'EOF' -{ - "maxDuration": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -274,3 +235,50 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/SetMaxDuration <<'EOF' +{ + "maxDuration": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setminblockstokeep.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setminblockstokeep.mdx index 83d5caf..0799eac 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setminblockstokeep.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setminblockstokeep.mdx @@ -4,6 +4,10 @@ title: "SetMinBlocksToKeep"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/SetMinBlocksToKeep <<'EOF' -{ - "minBlocksToKeep": 0 -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -274,3 +235,50 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/SetMinBlocksToKeep <<'EOF' +{ + "minBlocksToKeep": 0 +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setretention.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setretention.mdx index 20f50eb..98f4f5b 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setretention.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setretention.mdx @@ -4,6 +4,10 @@ title: "SetRetention"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/SetRetention <<'EOF' -{ - "retention": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -274,3 +235,50 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/SetRetention <<'EOF' +{ + "retention": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setschedule.mdx index cdc1a6a..24b8883 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setschedule.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setschedule.mdx @@ -4,6 +4,10 @@ title: "SetSchedule"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/SetSchedule <<'EOF' -{ - "schedule": { - "cron": "string", - "maxDuration": "string", - "retention": "string" - } -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -318,3 +275,54 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/SetSchedule <<'EOF' +{ + "schedule": { + "cron": "string", + "maxDuration": "string", + "retention": "string" + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromgenesisstate.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromgenesisstate.mdx index 0a2d0fe..3bb04a9 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromgenesisstate.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromgenesisstate.mdx @@ -4,6 +4,10 @@ title: "InitializeSequencerFromGenesisState"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.admin.v30.SequencerInitializationService/InitializeSequencerFromGenesisState <<'EOF' -{ - "topologySnapshot": "BASE64_ENCODED_BYTES", - "synchronizerParameters": { - "requiredSigningSpecs": { - "algorithms": [ - "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" - ], - "keys": [ - "SIGNING_KEY_SPEC_UNSPECIFIED" - ] - }, - "requiredEncryptionSpecs": { - "algorithms": [ - "ENCRYPTION_ALGORITHM_SPEC_UNSPECIFIED" - ], - "keys": [ - "ENCRYPTION_KEY_SPEC_UNSPECIFIED" - ] - }, - "requiredSymmetricKeySchemes": [ - "SYMMETRIC_KEY_SCHEME_UNSPECIFIED" - ], - "requiredHashAlgorithms": [ - "HASH_ALGORITHM_UNSPECIFIED" - ], - "requiredCryptoKeyFormats": [ - "CRYPTO_KEY_FORMAT_UNSPECIFIED" - ], - "requiredSignatureFormats": [ - "SIGNATURE_FORMAT_UNSPECIFIED" - ], - "protocolVersion": 0, - "serial": 0 - } -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "replicated": true -} -``` - -
-
- -
- ## Protocol Details @@ -694,3 +620,85 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerInitializationService/InitializeSequencerFromGenesisState <<'EOF' +{ + "topologySnapshot": "BASE64_ENCODED_BYTES", + "synchronizerParameters": { + "requiredSigningSpecs": { + "algorithms": [ + "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" + ], + "keys": [ + "SIGNING_KEY_SPEC_UNSPECIFIED" + ] + }, + "requiredEncryptionSpecs": { + "algorithms": [ + "ENCRYPTION_ALGORITHM_SPEC_UNSPECIFIED" + ], + "keys": [ + "ENCRYPTION_KEY_SPEC_UNSPECIFIED" + ] + }, + "requiredSymmetricKeySchemes": [ + "SYMMETRIC_KEY_SCHEME_UNSPECIFIED" + ], + "requiredHashAlgorithms": [ + "HASH_ALGORITHM_UNSPECIFIED" + ], + "requiredCryptoKeyFormats": [ + "CRYPTO_KEY_FORMAT_UNSPECIFIED" + ], + "requiredSignatureFormats": [ + "SIGNATURE_FORMAT_UNSPECIFIED" + ], + "protocolVersion": 0, + "serial": 0 + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "replicated": true +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromgenesisstatev2.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromgenesisstatev2.mdx index 84f8d7b..e7a4d83 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromgenesisstatev2.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromgenesisstatev2.mdx @@ -4,6 +4,10 @@ title: "InitializeSequencerFromGenesisStateV2"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.admin.v30.SequencerInitializationService/InitializeSequencerFromGenesisStateV2 <<'EOF' -{ - "topologySnapshot": "BASE64_ENCODED_BYTES", - "synchronizerParameters": { - "requiredSigningSpecs": { - "algorithms": [ - "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" - ], - "keys": [ - "SIGNING_KEY_SPEC_UNSPECIFIED" - ] - }, - "requiredEncryptionSpecs": { - "algorithms": [ - "ENCRYPTION_ALGORITHM_SPEC_UNSPECIFIED" - ], - "keys": [ - "ENCRYPTION_KEY_SPEC_UNSPECIFIED" - ] - }, - "requiredSymmetricKeySchemes": [ - "SYMMETRIC_KEY_SCHEME_UNSPECIFIED" - ], - "requiredHashAlgorithms": [ - "HASH_ALGORITHM_UNSPECIFIED" - ], - "requiredCryptoKeyFormats": [ - "CRYPTO_KEY_FORMAT_UNSPECIFIED" - ], - "requiredSignatureFormats": [ - "SIGNATURE_FORMAT_UNSPECIFIED" - ], - "protocolVersion": 0, - "serial": 0 - } -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "replicated": true -} -``` - -
-
- -
- ## Protocol Details @@ -694,3 +620,85 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerInitializationService/InitializeSequencerFromGenesisStateV2 <<'EOF' +{ + "topologySnapshot": "BASE64_ENCODED_BYTES", + "synchronizerParameters": { + "requiredSigningSpecs": { + "algorithms": [ + "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" + ], + "keys": [ + "SIGNING_KEY_SPEC_UNSPECIFIED" + ] + }, + "requiredEncryptionSpecs": { + "algorithms": [ + "ENCRYPTION_ALGORITHM_SPEC_UNSPECIFIED" + ], + "keys": [ + "ENCRYPTION_KEY_SPEC_UNSPECIFIED" + ] + }, + "requiredSymmetricKeySchemes": [ + "SYMMETRIC_KEY_SCHEME_UNSPECIFIED" + ], + "requiredHashAlgorithms": [ + "HASH_ALGORITHM_UNSPECIFIED" + ], + "requiredCryptoKeyFormats": [ + "CRYPTO_KEY_FORMAT_UNSPECIFIED" + ], + "requiredSignatureFormats": [ + "SIGNATURE_FORMAT_UNSPECIFIED" + ], + "protocolVersion": 0, + "serial": 0 + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "replicated": true +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromonboardingstate.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromonboardingstate.mdx index 1f60e82..4d39f27 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromonboardingstate.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromonboardingstate.mdx @@ -4,6 +4,10 @@ title: "InitializeSequencerFromOnboardingState"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.admin.v30.SequencerInitializationService/InitializeSequencerFromOnboardingState <<'EOF' -{ - "onboardingState": "BASE64_ENCODED_BYTES" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "replicated": true -} -``` - -
-
- -
- ## Protocol Details @@ -307,3 +265,53 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerInitializationService/InitializeSequencerFromOnboardingState <<'EOF' +{ + "onboardingState": "BASE64_ENCODED_BYTES" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "replicated": true +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromonboardingstatev2.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromonboardingstatev2.mdx index 46d2e37..f02ad4b 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromonboardingstatev2.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromonboardingstatev2.mdx @@ -4,6 +4,10 @@ title: "InitializeSequencerFromOnboardingStateV2"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.admin.v30.SequencerInitializationService/InitializeSequencerFromOnboardingStateV2 <<'EOF' -{ - "onboardingState": "BASE64_ENCODED_BYTES" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "replicated": true -} -``` - -
-
- -
- ## Protocol Details @@ -307,3 +265,53 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerInitializationService/InitializeSequencerFromOnboardingStateV2 <<'EOF' +{ + "onboardingState": "BASE64_ENCODED_BYTES" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "replicated": true +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfrompredecessor.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfrompredecessor.mdx index f8d3bb6..7199b60 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfrompredecessor.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfrompredecessor.mdx @@ -4,6 +4,10 @@ title: "InitializeSequencerFromPredecessor"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.admin.v30.SequencerInitializationService/InitializeSequencerFromPredecessor <<'EOF' -{ - "topologySnapshot": "BASE64_ENCODED_BYTES", - "synchronizerParameters": { - "requiredSigningSpecs": { - "algorithms": [ - "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" - ], - "keys": [ - "SIGNING_KEY_SPEC_UNSPECIFIED" - ] - }, - "requiredEncryptionSpecs": { - "algorithms": [ - "ENCRYPTION_ALGORITHM_SPEC_UNSPECIFIED" - ], - "keys": [ - "ENCRYPTION_KEY_SPEC_UNSPECIFIED" - ] - }, - "requiredSymmetricKeySchemes": [ - "SYMMETRIC_KEY_SCHEME_UNSPECIFIED" - ], - "requiredHashAlgorithms": [ - "HASH_ALGORITHM_UNSPECIFIED" - ], - "requiredCryptoKeyFormats": [ - "CRYPTO_KEY_FORMAT_UNSPECIFIED" - ], - "requiredSignatureFormats": [ - "SIGNATURE_FORMAT_UNSPECIFIED" - ], - "protocolVersion": 0, - "serial": 0 - } -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -658,3 +586,83 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerInitializationService/InitializeSequencerFromPredecessor <<'EOF' +{ + "topologySnapshot": "BASE64_ENCODED_BYTES", + "synchronizerParameters": { + "requiredSigningSpecs": { + "algorithms": [ + "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" + ], + "keys": [ + "SIGNING_KEY_SPEC_UNSPECIFIED" + ] + }, + "requiredEncryptionSpecs": { + "algorithms": [ + "ENCRYPTION_ALGORITHM_SPEC_UNSPECIFIED" + ], + "keys": [ + "ENCRYPTION_KEY_SPEC_UNSPECIFIED" + ] + }, + "requiredSymmetricKeySchemes": [ + "SYMMETRIC_KEY_SCHEME_UNSPECIFIED" + ], + "requiredHashAlgorithms": [ + "HASH_ALGORITHM_UNSPECIFIED" + ], + "requiredCryptoKeyFormats": [ + "CRYPTO_KEY_FORMAT_UNSPECIFIED" + ], + "requiredSignatureFormats": [ + "SIGNATURE_FORMAT_UNSPECIFIED" + ], + "protocolVersion": 0, + "serial": 0 + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/clearschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/clearschedule.mdx index 68eace4..a7b44cb 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/clearschedule.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/clearschedule.mdx @@ -4,6 +4,10 @@ title: "ClearSchedule"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.admin.v30.SequencerPruningAdministrationService/ClearSchedule <<'EOF' -{} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -246,3 +209,48 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerPruningAdministrationService/ClearSchedule <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/findpruningtimestamp.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/findpruningtimestamp.mdx index fa7a38e..2d88570 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/findpruningtimestamp.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/findpruningtimestamp.mdx @@ -4,6 +4,10 @@ title: "FindPruningTimestamp"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.admin.v30.SequencerPruningAdministrationService/FindPruningTimestamp <<'EOF' -{ - "index": 0 -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "timestamp": "string" -} -``` - -
-
- -
- ## Protocol Details @@ -310,3 +269,52 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerPruningAdministrationService/FindPruningTimestamp <<'EOF' +{ + "index": 0 +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "timestamp": "string" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/getschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/getschedule.mdx index c4de4a1..e6b7d9c 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/getschedule.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/getschedule.mdx @@ -4,6 +4,10 @@ title: "GetSchedule"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.admin.v30.SequencerPruningAdministrationService/GetSchedule <<'EOF' -{} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "schedule": { - "cron": "string", - "maxDuration": "string", - "retention": "string" - } -} -``` - -
-
- -
- ## Protocol Details @@ -318,3 +275,54 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerPruningAdministrationService/GetSchedule <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "schedule": { + "cron": "string", + "maxDuration": "string", + "retention": "string" + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/prune.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/prune.mdx index ce151f4..b6ccc0c 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/prune.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/prune.mdx @@ -4,6 +4,10 @@ title: "Prune"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.admin.v30.SequencerPruningAdministrationService/Prune <<'EOF' -{ - "timestamp": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "details": "string" -} -``` - -
-
- -
- ## Protocol Details @@ -306,3 +265,52 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerPruningAdministrationService/Prune <<'EOF' +{ + "timestamp": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "details": "string" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setcron.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setcron.mdx index fb604ec..cdbe513 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setcron.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setcron.mdx @@ -4,6 +4,10 @@ title: "SetCron"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.admin.v30.SequencerPruningAdministrationService/SetCron <<'EOF' -{ - "cron": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -274,3 +235,50 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerPruningAdministrationService/SetCron <<'EOF' +{ + "cron": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setmaxduration.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setmaxduration.mdx index 0bb1331..2736037 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setmaxduration.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setmaxduration.mdx @@ -4,6 +4,10 @@ title: "SetMaxDuration"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.admin.v30.SequencerPruningAdministrationService/SetMaxDuration <<'EOF' -{ - "maxDuration": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -274,3 +235,50 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerPruningAdministrationService/SetMaxDuration <<'EOF' +{ + "maxDuration": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setretention.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setretention.mdx index 279f11a..7dd4f75 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setretention.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setretention.mdx @@ -4,6 +4,10 @@ title: "SetRetention"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.admin.v30.SequencerPruningAdministrationService/SetRetention <<'EOF' -{ - "retention": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -274,3 +235,50 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerPruningAdministrationService/SetRetention <<'EOF' +{ + "retention": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setschedule.mdx index 58f4ac7..08d779c 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setschedule.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setschedule.mdx @@ -4,6 +4,10 @@ title: "SetSchedule"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.admin.v30.SequencerPruningAdministrationService/SetSchedule <<'EOF' -{ - "schedule": { - "cron": "string", - "maxDuration": "string", - "retention": "string" - } -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -318,3 +275,54 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.admin.v30.SequencerPruningAdministrationService/SetSchedule <<'EOF' +{ + "schedule": { + "cron": "string", + "maxDuration": "string", + "retention": "string" + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerauthenticationservice/authenticate.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerauthenticationservice/authenticate.mdx index 66ba272..184539b 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerauthenticationservice/authenticate.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerauthenticationservice/authenticate.mdx @@ -4,6 +4,10 @@ title: "Authenticate"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.api.v30.SequencerAuthenticationService/Authenticate <<'EOF' -{ - "member": "string", - "signature": { - "format": "SIGNATURE_FORMAT_UNSPECIFIED", - "signature": "BASE64_ENCODED_BYTES", - "signedBy": "string", - "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", - "signatureDelegation": { - "sessionKey": "BASE64_ENCODED_BYTES", - "sessionKeySpec": "SIGNING_KEY_SPEC_UNSPECIFIED", - "validityPeriodFromInclusive": "0", - "validityPeriodDurationSeconds": 0, - "format": "SIGNATURE_FORMAT_UNSPECIFIED", - "signature": "BASE64_ENCODED_BYTES", - "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" - } - }, - "nonce": "BASE64_ENCODED_BYTES" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "token": "BASE64_ENCODED_BYTES", - "expiresAt": "string" -} -``` - -
-
- -
- ## Protocol Details @@ -606,3 +548,69 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.api.v30.SequencerAuthenticationService/Authenticate <<'EOF' +{ + "member": "string", + "signature": { + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signedBy": "string", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", + "signatureDelegation": { + "sessionKey": "BASE64_ENCODED_BYTES", + "sessionKeySpec": "SIGNING_KEY_SPEC_UNSPECIFIED", + "validityPeriodFromInclusive": "0", + "validityPeriodDurationSeconds": 0, + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" + } + }, + "nonce": "BASE64_ENCODED_BYTES" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "token": "BASE64_ENCODED_BYTES", + "expiresAt": "string" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerauthenticationservice/challenge.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerauthenticationservice/challenge.mdx index 6545e4f..92553c9 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerauthenticationservice/challenge.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerauthenticationservice/challenge.mdx @@ -4,6 +4,10 @@ title: "Challenge"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.api.v30.SequencerAuthenticationService/Challenge <<'EOF' -{ - "member": "string", - "memberProtocolVersions": [ - 0 - ] -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "nonce": "BASE64_ENCODED_BYTES", - "fingerprints": [ - "string" - ] -} -``` - -
-
- -
- ## Protocol Details @@ -352,3 +305,58 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.api.v30.SequencerAuthenticationService/Challenge <<'EOF' +{ + "member": "string", + "memberProtocolVersions": [ + 0 + ] +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "nonce": "BASE64_ENCODED_BYTES", + "fingerprints": [ + "string" + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerauthenticationservice/logout.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerauthenticationservice/logout.mdx index 18ce51f..ca15b29 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerauthenticationservice/logout.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerauthenticationservice/logout.mdx @@ -4,6 +4,10 @@ title: "Logout"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.api.v30.SequencerAuthenticationService/Logout <<'EOF' -{ - "token": "BASE64_ENCODED_BYTES" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -278,3 +239,50 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.api.v30.SequencerAuthenticationService/Logout <<'EOF' +{ + "token": "BASE64_ENCODED_BYTES" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerchannelservice/connecttosequencerchannel.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerchannelservice/connecttosequencerchannel.mdx index 9ffb6ba..69e5991 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerchannelservice/connecttosequencerchannel.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerchannelservice/connecttosequencerchannel.mdx @@ -4,6 +4,10 @@ title: "ConnectToSequencerChannel"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.api.v30.SequencerChannelService/ConnectToSequencerChannel <<'EOF' -{ - "metadata": { - "channelId": "string", - "initiatingMember": "string", - "receivingMember": "string" - }, - "traceContext": { - "traceparent": "string", - "tracestate": "string" - } -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "connected": {}, - "traceContext": { - "traceparent": "string", - "tracestate": "string" - } -} -``` - -
-
- -
- ## Protocol Details @@ -677,3 +623,65 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.api.v30.SequencerChannelService/ConnectToSequencerChannel <<'EOF' +{ + "metadata": { + "channelId": "string", + "initiatingMember": "string", + "receivingMember": "string" + }, + "traceContext": { + "traceparent": "string", + "tracestate": "string" + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "connected": {}, + "traceContext": { + "traceparent": "string", + "tracestate": "string" + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerchannelservice/ping.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerchannelservice/ping.mdx index 5938f4e..82e21e7 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerchannelservice/ping.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerchannelservice/ping.mdx @@ -4,6 +4,10 @@ title: "Ping"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.api.v30.SequencerChannelService/Ping <<'EOF' -{} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -246,3 +209,48 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.api.v30.SequencerChannelService/Ping <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/getsynchronizerid.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/getsynchronizerid.mdx index c76aea0..f5c14c5 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/getsynchronizerid.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/getsynchronizerid.mdx @@ -4,6 +4,10 @@ title: "GetSynchronizerId"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.api.v30.SequencerConnectService/GetSynchronizerId <<'EOF' -{} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "physicalSynchronizerId": "string", - "sequencerUid": "string" -} -``` - -
-
- -
- ## Protocol Details @@ -293,3 +253,51 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.api.v30.SequencerConnectService/GetSynchronizerId <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "physicalSynchronizerId": "string", + "sequencerUid": "string" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/getsynchronizerparameters.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/getsynchronizerparameters.mdx index 68fde1c..c1327bf 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/getsynchronizerparameters.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/getsynchronizerparameters.mdx @@ -4,6 +4,10 @@ title: "GetSynchronizerParameters"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.api.v30.SequencerConnectService/GetSynchronizerParameters <<'EOF' -{} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "parametersV1": { - "requiredSigningSpecs": { - "algorithms": [ - "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" - ], - "keys": [ - "SIGNING_KEY_SPEC_UNSPECIFIED" - ] - }, - "requiredEncryptionSpecs": { - "algorithms": [ - "ENCRYPTION_ALGORITHM_SPEC_UNSPECIFIED" - ], - "keys": [ - "ENCRYPTION_KEY_SPEC_UNSPECIFIED" - ] - }, - "requiredSymmetricKeySchemes": [ - "SYMMETRIC_KEY_SCHEME_UNSPECIFIED" - ], - "requiredHashAlgorithms": [ - "HASH_ALGORITHM_UNSPECIFIED" - ], - "requiredCryptoKeyFormats": [ - "CRYPTO_KEY_FORMAT_UNSPECIFIED" - ], - "requiredSignatureFormats": [ - "SIGNATURE_FORMAT_UNSPECIFIED" - ], - "protocolVersion": 0, - "serial": 0 - } -} -``` - -
-
- -
- ## Protocol Details @@ -638,3 +568,81 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.api.v30.SequencerConnectService/GetSynchronizerParameters <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "parametersV1": { + "requiredSigningSpecs": { + "algorithms": [ + "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" + ], + "keys": [ + "SIGNING_KEY_SPEC_UNSPECIFIED" + ] + }, + "requiredEncryptionSpecs": { + "algorithms": [ + "ENCRYPTION_ALGORITHM_SPEC_UNSPECIFIED" + ], + "keys": [ + "ENCRYPTION_KEY_SPEC_UNSPECIFIED" + ] + }, + "requiredSymmetricKeySchemes": [ + "SYMMETRIC_KEY_SCHEME_UNSPECIFIED" + ], + "requiredHashAlgorithms": [ + "HASH_ALGORITHM_UNSPECIFIED" + ], + "requiredCryptoKeyFormats": [ + "CRYPTO_KEY_FORMAT_UNSPECIFIED" + ], + "requiredSignatureFormats": [ + "SIGNATURE_FORMAT_UNSPECIFIED" + ], + "protocolVersion": 0, + "serial": 0 + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/handshake.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/handshake.mdx index 8df35c7..c0bde59 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/handshake.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/handshake.mdx @@ -4,6 +4,10 @@ title: "Handshake"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.api.v30.SequencerConnectService/Handshake <<'EOF' -{ - "clientProtocolVersions": [ - 0 - ], - "minimumProtocolVersion": 0 -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "serverProtocolVersion": 0, - "success": {} -} -``` - -
-
- -
- ## Protocol Details @@ -391,3 +346,56 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.api.v30.SequencerConnectService/Handshake <<'EOF' +{ + "clientProtocolVersions": [ + 0 + ], + "minimumProtocolVersion": 0 +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "serverProtocolVersion": 0, + "success": {} +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/registeronboardingtopologytransactions.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/registeronboardingtopologytransactions.mdx index c3371ca..e2dc161 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/registeronboardingtopologytransactions.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/registeronboardingtopologytransactions.mdx @@ -4,6 +4,10 @@ title: "RegisterOnboardingTopologyTransactions"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.api.v30.SequencerConnectService/RegisterOnboardingTopologyTransactions <<'EOF' -{ - "topologyTransactions": [ - { - "transaction": "BASE64_ENCODED_BYTES", - "signatures": [ - { - "format": "SIGNATURE_FORMAT_UNSPECIFIED", - "signature": "BASE64_ENCODED_BYTES", - "signedBy": "string", - "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", - "signatureDelegation": { - "sessionKey": "BASE64_ENCODED_BYTES", - "sessionKeySpec": "SIGNING_KEY_SPEC_UNSPECIFIED", - "validityPeriodFromInclusive": "0", - "validityPeriodDurationSeconds": 0, - "format": "SIGNATURE_FORMAT_UNSPECIFIED", - "signature": "BASE64_ENCODED_BYTES", - "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" - } - } - ], - "proposal": true, - "multiTransactionSignatures": [ - { - "transactionHashes": [ - "BASE64_ENCODED_BYTES" - ], - "signatures": [ - { - "format": "SIGNATURE_FORMAT_UNSPECIFIED", - "signature": "BASE64_ENCODED_BYTES", - "signedBy": "string", - "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", - "signatureDelegation": {} - } - ] - } - ] - } - ] -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -625,3 +548,88 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.api.v30.SequencerConnectService/RegisterOnboardingTopologyTransactions <<'EOF' +{ + "topologyTransactions": [ + { + "transaction": "BASE64_ENCODED_BYTES", + "signatures": [ + { + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signedBy": "string", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", + "signatureDelegation": { + "sessionKey": "BASE64_ENCODED_BYTES", + "sessionKeySpec": "SIGNING_KEY_SPEC_UNSPECIFIED", + "validityPeriodFromInclusive": "0", + "validityPeriodDurationSeconds": 0, + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" + } + } + ], + "proposal": true, + "multiTransactionSignatures": [ + { + "transactionHashes": [ + "BASE64_ENCODED_BYTES" + ], + "signatures": [ + { + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signedBy": "string", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", + "signatureDelegation": {} + } + ] + } + ] + } + ] +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/verifyactive.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/verifyactive.mdx index 9f6c962..5fc2d35 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/verifyactive.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/verifyactive.mdx @@ -4,6 +4,10 @@ title: "VerifyActive"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.api.v30.SequencerConnectService/VerifyActive <<'EOF' -{} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "success": { - "isActive": true - } -} -``` - -
-
- -
- ## Protocol Details @@ -338,3 +297,52 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.api.v30.SequencerConnectService/VerifyActive <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "success": { + "isActive": true + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/acknowledgesigned.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/acknowledgesigned.mdx index e6c9f4c..f57ab11 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/acknowledgesigned.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/acknowledgesigned.mdx @@ -4,6 +4,10 @@ title: "AcknowledgeSigned"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.api.v30.SequencerService/AcknowledgeSigned <<'EOF' -{ - "signedAcknowledgeRequest": "BASE64_ENCODED_BYTES" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -278,3 +239,50 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.api.v30.SequencerService/AcknowledgeSigned <<'EOF' +{ + "signedAcknowledgeRequest": "BASE64_ENCODED_BYTES" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/downloadtopologystateforinit.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/downloadtopologystateforinit.mdx index c1b0708..fa2ee61 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/downloadtopologystateforinit.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/downloadtopologystateforinit.mdx @@ -4,6 +4,10 @@ title: "DownloadTopologyStateForInit"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.api.v30.SequencerService/DownloadTopologyStateForInit <<'EOF' -{ - "member": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "topologyTransactions": { - "items": [ - { - "sequenced": "string", - "validFrom": "string", - "validUntil": "string", - "transaction": "BASE64_ENCODED_BYTES", - "rejectionReason": "string" - } - ] - } -} -``` - -
-
- -
- ## Protocol Details @@ -399,3 +347,63 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.api.v30.SequencerService/DownloadTopologyStateForInit <<'EOF' +{ + "member": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "topologyTransactions": { + "items": [ + { + "sequenced": "string", + "validFrom": "string", + "validUntil": "string", + "transaction": "BASE64_ENCODED_BYTES", + "rejectionReason": "string" + } + ] + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/downloadtopologystateforinithash.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/downloadtopologystateforinithash.mdx index 7821ddc..b9926d2 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/downloadtopologystateforinithash.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/downloadtopologystateforinithash.mdx @@ -4,6 +4,10 @@ title: "DownloadTopologyStateForInitHash"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.api.v30.SequencerService/DownloadTopologyStateForInitHash <<'EOF' -{ - "member": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "topologyStateHash": "BASE64_ENCODED_BYTES" -} -``` - -
-
- -
- ## Protocol Details @@ -310,3 +269,52 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.api.v30.SequencerService/DownloadTopologyStateForInitHash <<'EOF' +{ + "member": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "topologyStateHash": "BASE64_ENCODED_BYTES" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/gettime.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/gettime.mdx index 739c180..d999ea0 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/gettime.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/gettime.mdx @@ -4,6 +4,10 @@ title: "GetTime"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.api.v30.SequencerService/GetTime <<'EOF' -{} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "sequencingTimestamp": "0" -} -``` - -
-
- -
- ## Protocol Details @@ -278,3 +239,50 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.api.v30.SequencerService/GetTime <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "sequencingTimestamp": "0" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/gettrafficstateformember.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/gettrafficstateformember.mdx index d4a5a8d..c3c60e6 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/gettrafficstateformember.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/gettrafficstateformember.mdx @@ -4,6 +4,10 @@ title: "GetTrafficStateForMember"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.api.v30.SequencerService/GetTrafficStateForMember <<'EOF' -{ - "member": "string", - "timestamp": "0" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "trafficState": { - "extraTrafficPurchased": "0", - "extraTrafficConsumed": "0", - "baseTrafficRemainder": "0", - "lastConsumedCost": "0", - "timestamp": "0", - "serial": 0 - } -} -``` - -
-
- -
- ## Protocol Details @@ -415,3 +366,60 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.api.v30.SequencerService/GetTrafficStateForMember <<'EOF' +{ + "member": "string", + "timestamp": "0" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "trafficState": { + "extraTrafficPurchased": "0", + "extraTrafficConsumed": "0", + "baseTrafficRemainder": "0", + "lastConsumedCost": "0", + "timestamp": "0", + "serial": 0 + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/sendasync.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/sendasync.mdx index f99b426..d0c6cc8 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/sendasync.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/sendasync.mdx @@ -4,6 +4,10 @@ title: "SendAsync"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.api.v30.SequencerService/SendAsync <<'EOF' -{ - "signedSubmissionRequest": "BASE64_ENCODED_BYTES" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -278,3 +239,50 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.api.v30.SequencerService/SendAsync <<'EOF' +{ + "signedSubmissionRequest": "BASE64_ENCODED_BYTES" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/subscribe.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/subscribe.mdx index 1b10431..18507ec 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/subscribe.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/subscribe.mdx @@ -4,6 +4,10 @@ title: "Subscribe"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.sequencer.api.v30.SequencerService/Subscribe <<'EOF' -{ - "member": "string", - "timestamp": "0" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "signedSequencedEvent": "BASE64_ENCODED_BYTES", - "traceContext": { - "traceparent": "string", - "tracestate": "string" - } -} -``` - -
-
- -
- ## Protocol Details @@ -389,3 +342,58 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.sequencer.api.v30.SequencerService/Subscribe <<'EOF' +{ + "member": "string", + "timestamp": "0" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "signedSequencedEvent": "BASE64_ENCODED_BYTES", + "traceContext": { + "traceparent": "string", + "tracestate": "string" + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-standalone-v1/standalonebftorderingservice/readordered.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-standalone-v1/standalonebftorderingservice/readordered.mdx index f2aee2e..c292c49 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-standalone-v1/standalonebftorderingservice/readordered.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-standalone-v1/standalonebftorderingservice/readordered.mdx @@ -4,6 +4,10 @@ title: "ReadOrdered"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1.StandaloneBftOrderingService/ReadOrdered <<'EOF' -{ - "startHeight": "0" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "height": "0", - "block": [ - { - "tag": "string", - "payload": "BASE64_ENCODED_BYTES" - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -358,3 +310,59 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1.StandaloneBftOrderingService/ReadOrdered <<'EOF' +{ + "startHeight": "0" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "height": "0", + "block": [ + { + "tag": "string", + "payload": "BASE64_ENCODED_BYTES" + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-standalone-v1/standalonebftorderingservice/send.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-standalone-v1/standalonebftorderingservice/send.mdx index 6562d3b..24a8217 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-standalone-v1/standalonebftorderingservice/send.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-standalone-v1/standalonebftorderingservice/send.mdx @@ -4,6 +4,10 @@ title: "Send"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1.StandaloneBftOrderingService/Send <<'EOF' -{ - "tag": "string", - "payload": "BASE64_ENCODED_BYTES" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "rejectionReason": "string" -} -``` - -
-
- -
- ## Protocol Details @@ -321,3 +279,53 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1.StandaloneBftOrderingService/Send <<'EOF' +{ + "tag": "string", + "payload": "BASE64_ENCODED_BYTES" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "rejectionReason": "string" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30/bftorderingservice/receive.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30/bftorderingservice/receive.mdx index 3e400a8..a751c3d 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30/bftorderingservice/receive.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30/bftorderingservice/receive.mdx @@ -4,6 +4,10 @@ title: "Receive"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.BftOrderingService/Receive <<'EOF' -{ - "traceContext": "string", - "body": { - "availabilityMessage": { - "message": "BASE64_ENCODED_BYTES", - "from": "string", - "signature": { - "format": "SIGNATURE_FORMAT_UNSPECIFIED", - "signature": "BASE64_ENCODED_BYTES", - "signedBy": "string", - "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", - "signatureDelegation": {} - } - } - }, - "sentBy": "string", - "sentAt": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "traceContext": "string", - "body": { - "availabilityMessage": { - "message": "BASE64_ENCODED_BYTES", - "from": "string", - "signature": { - "format": "SIGNATURE_FORMAT_UNSPECIFIED", - "signature": "BASE64_ENCODED_BYTES", - "signedBy": "string", - "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", - "signatureDelegation": {} - } - } - }, - "sentBy": "string", - "sentAt": "string" -} -``` - -
-
- -
- ## Protocol Details @@ -804,3 +732,83 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.BftOrderingService/Receive <<'EOF' +{ + "traceContext": "string", + "body": { + "availabilityMessage": { + "message": "BASE64_ENCODED_BYTES", + "from": "string", + "signature": { + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signedBy": "string", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", + "signatureDelegation": {} + } + } + }, + "sentBy": "string", + "sentAt": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "traceContext": "string", + "body": { + "availabilityMessage": { + "message": "BASE64_ENCODED_BYTES", + "from": "string", + "signature": { + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signedBy": "string", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", + "signatureDelegation": {} + } + } + }, + "sentBy": "string", + "sentAt": "string" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-time-admin-v30/synchronizertimeservice/awaittime.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-time-admin-v30/synchronizertimeservice/awaittime.mdx index dd90e1e..b6cac5f 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-time-admin-v30/synchronizertimeservice/awaittime.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-time-admin-v30/synchronizertimeservice/awaittime.mdx @@ -4,6 +4,10 @@ title: "AwaitTime"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.time.admin.v30.SynchronizerTimeService/AwaitTime <<'EOF' -{ - "synchronizer": { - "id": "string" - }, - "timestamp": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -334,3 +292,53 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.time.admin.v30.SynchronizerTimeService/AwaitTime <<'EOF' +{ + "synchronizer": { + "id": "string" + }, + "timestamp": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-time-admin-v30/synchronizertimeservice/fetchtime.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-time-admin-v30/synchronizertimeservice/fetchtime.mdx index d3b97da..a872af2 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-time-admin-v30/synchronizertimeservice/fetchtime.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-time-admin-v30/synchronizertimeservice/fetchtime.mdx @@ -4,6 +4,10 @@ title: "FetchTime"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.time.admin.v30.SynchronizerTimeService/FetchTime <<'EOF' -{ - "synchronizer": { - "id": "string" - }, - "freshnessBound": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "timestamp": "string" -} -``` - -
-
- -
- ## Protocol Details @@ -358,3 +314,55 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.time.admin.v30.SynchronizerTimeService/FetchTime <<'EOF' +{ + "synchronizer": { + "id": "string" + }, + "freshnessBound": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "timestamp": "string" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/identityinitializationservice/currenttime.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/identityinitializationservice/currenttime.mdx index 3d557d0..b7b1d36 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/identityinitializationservice/currenttime.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/identityinitializationservice/currenttime.mdx @@ -4,6 +4,10 @@ title: "CurrentTime"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.topology.admin.v30.IdentityInitializationService/CurrentTime <<'EOF' -{} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "currentTime": "0" -} -``` - -
-
- -
- ## Protocol Details @@ -274,3 +235,50 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.IdentityInitializationService/CurrentTime <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "currentTime": "0" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/identityinitializationservice/getid.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/identityinitializationservice/getid.mdx index 6369df6..320b159 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/identityinitializationservice/getid.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/identityinitializationservice/getid.mdx @@ -4,6 +4,10 @@ title: "GetId"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.topology.admin.v30.IdentityInitializationService/GetId <<'EOF' -{} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "initialized": true, - "uniqueIdentifier": "string" -} -``` - -
-
- -
- ## Protocol Details @@ -293,3 +253,51 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.IdentityInitializationService/GetId <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "initialized": true, + "uniqueIdentifier": "string" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/identityinitializationservice/initid.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/identityinitializationservice/initid.mdx index aa27648..5b46326 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/identityinitializationservice/initid.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/identityinitializationservice/initid.mdx @@ -4,6 +4,10 @@ title: "InitId"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.topology.admin.v30.IdentityInitializationService/InitId <<'EOF' -{ - "identifier": "string", - "namespace": "string", - "namespaceDelegations": [ - { - "transaction": "BASE64_ENCODED_BYTES", - "signatures": [ - { - "format": "SIGNATURE_FORMAT_UNSPECIFIED", - "signature": "BASE64_ENCODED_BYTES", - "signedBy": "string", - "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", - "signatureDelegation": { - "sessionKey": "BASE64_ENCODED_BYTES", - "sessionKeySpec": "SIGNING_KEY_SPEC_UNSPECIFIED", - "validityPeriodFromInclusive": "0", - "validityPeriodDurationSeconds": 0, - "format": "SIGNATURE_FORMAT_UNSPECIFIED", - "signature": "BASE64_ENCODED_BYTES", - "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" - } - } - ], - "proposal": true, - "multiTransactionSignatures": [ - { - "transactionHashes": [ - "BASE64_ENCODED_BYTES" - ], - "signatures": [ - { - "format": "SIGNATURE_FORMAT_UNSPECIFIED", - "signature": "BASE64_ENCODED_BYTES", - "signedBy": "string", - "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", - "signatureDelegation": {} - } - ] - } - ] - } - ] -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -675,3 +596,90 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.IdentityInitializationService/InitId <<'EOF' +{ + "identifier": "string", + "namespace": "string", + "namespaceDelegations": [ + { + "transaction": "BASE64_ENCODED_BYTES", + "signatures": [ + { + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signedBy": "string", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", + "signatureDelegation": { + "sessionKey": "BASE64_ENCODED_BYTES", + "sessionKeySpec": "SIGNING_KEY_SPEC_UNSPECIFIED", + "validityPeriodFromInclusive": "0", + "validityPeriodDurationSeconds": 0, + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" + } + } + ], + "proposal": true, + "multiTransactionSignatures": [ + { + "transactionHashes": [ + "BASE64_ENCODED_BYTES" + ], + "signatures": [ + { + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signedBy": "string", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", + "signatureDelegation": {} + } + ] + } + ] + } + ] +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologyaggregationservice/listkeyowners.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologyaggregationservice/listkeyowners.mdx index 1cb55b4..e5b6830 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologyaggregationservice/listkeyowners.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologyaggregationservice/listkeyowners.mdx @@ -4,6 +4,10 @@ title: "ListKeyOwners"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.topology.admin.v30.TopologyAggregationService/ListKeyOwners <<'EOF' -{ - "asOf": "string", - "limit": 0, - "synchronizerIds": [ - "string" - ], - "filterKeyOwnerType": "string", - "filterKeyOwnerUid": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "results": [ - { - "synchronizerId": "string", - "keyOwner": "string", - "signingKeys": [ - { - "format": "CRYPTO_KEY_FORMAT_UNSPECIFIED", - "publicKey": "BASE64_ENCODED_BYTES", - "scheme": "SIGNING_KEY_SCHEME_UNSPECIFIED", - "usage": [ - "SIGNING_KEY_USAGE_UNSPECIFIED" - ], - "keySpec": "SIGNING_KEY_SPEC_UNSPECIFIED" - } - ], - "encryptionKeys": [ - { - "format": "CRYPTO_KEY_FORMAT_UNSPECIFIED", - "publicKey": "BASE64_ENCODED_BYTES", - "scheme": "ENCRYPTION_KEY_SCHEME_UNSPECIFIED", - "keySpec": "ENCRYPTION_KEY_SPEC_UNSPECIFIED" - } - ], - "physicalSynchronizerId": "string" - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -718,3 +646,83 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyAggregationService/ListKeyOwners <<'EOF' +{ + "asOf": "string", + "limit": 0, + "synchronizerIds": [ + "string" + ], + "filterKeyOwnerType": "string", + "filterKeyOwnerUid": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "results": [ + { + "synchronizerId": "string", + "keyOwner": "string", + "signingKeys": [ + { + "format": "CRYPTO_KEY_FORMAT_UNSPECIFIED", + "publicKey": "BASE64_ENCODED_BYTES", + "scheme": "SIGNING_KEY_SCHEME_UNSPECIFIED", + "usage": [ + "SIGNING_KEY_USAGE_UNSPECIFIED" + ], + "keySpec": "SIGNING_KEY_SPEC_UNSPECIFIED" + } + ], + "encryptionKeys": [ + { + "format": "CRYPTO_KEY_FORMAT_UNSPECIFIED", + "publicKey": "BASE64_ENCODED_BYTES", + "scheme": "ENCRYPTION_KEY_SCHEME_UNSPECIFIED", + "keySpec": "ENCRYPTION_KEY_SPEC_UNSPECIFIED" + } + ], + "physicalSynchronizerId": "string" + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologyaggregationservice/listparties.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologyaggregationservice/listparties.mdx index 7e7823a..d2b37ee 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologyaggregationservice/listparties.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologyaggregationservice/listparties.mdx @@ -4,6 +4,10 @@ title: "ListParties"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.topology.admin.v30.TopologyAggregationService/ListParties <<'EOF' -{ - "asOf": "string", - "limit": 0, - "synchronizerIds": [ - "string" - ], - "filterParty": "string", - "filterParticipant": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "results": [ - { - "party": "string", - "participants": [ - { - "participantUid": "string", - "synchronizers": [ - { - "synchronizerId": "string", - "permission": "PARTICIPANT_PERMISSION_UNSPECIFIED", - "physicalSynchronizerId": "string" - } - ] - } - ] - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -521,3 +458,74 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyAggregationService/ListParties <<'EOF' +{ + "asOf": "string", + "limit": 0, + "synchronizerIds": [ + "string" + ], + "filterParty": "string", + "filterParticipant": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "results": [ + { + "party": "string", + "participants": [ + { + "participantUid": "string", + "synchronizers": [ + { + "synchronizerId": "string", + "permission": "PARTICIPANT_PERMISSION_UNSPECIFIED", + "physicalSynchronizerId": "string" + } + ] + } + ] + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/exporttopologysnapshot.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/exporttopologysnapshot.mdx index f006c90..59b73b9 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/exporttopologysnapshot.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/exporttopologysnapshot.mdx @@ -4,6 +4,10 @@ title: "ExportTopologySnapshot"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ExportTopologySnapshot <<'EOF' -{ - "baseQuery": { - "store": { - "authorized": {} - }, - "proposals": true, - "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", - "snapshot": "string", - "filterSignedKey": "string", - "protocolVersion": 0 - }, - "excludeMappings": [ - "string" - ], - "filterNamespace": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "chunk": "BASE64_ENCODED_BYTES" -} -``` - -
-
- -
- ## Protocol Details @@ -591,3 +536,66 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ExportTopologySnapshot <<'EOF' +{ + "baseQuery": { + "store": { + "authorized": {} + }, + "proposals": true, + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "snapshot": "string", + "filterSignedKey": "string", + "protocolVersion": 0 + }, + "excludeMappings": [ + "string" + ], + "filterNamespace": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "chunk": "BASE64_ENCODED_BYTES" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/exporttopologysnapshotv2.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/exporttopologysnapshotv2.mdx index 2e971d3..6f57f1c 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/exporttopologysnapshotv2.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/exporttopologysnapshotv2.mdx @@ -4,6 +4,10 @@ title: "ExportTopologySnapshotV2"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ExportTopologySnapshotV2 <<'EOF' -{ - "baseQuery": { - "store": { - "authorized": {} - }, - "proposals": true, - "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", - "snapshot": "string", - "filterSignedKey": "string", - "protocolVersion": 0 - }, - "excludeMappings": [ - "string" - ], - "filterNamespace": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "chunk": "BASE64_ENCODED_BYTES" -} -``` - -
-
- -
- ## Protocol Details @@ -591,3 +536,66 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ExportTopologySnapshotV2 <<'EOF' +{ + "baseQuery": { + "store": { + "authorized": {} + }, + "proposals": true, + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "snapshot": "string", + "filterSignedKey": "string", + "protocolVersion": 0 + }, + "excludeMappings": [ + "string" + ], + "filterNamespace": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "chunk": "BASE64_ENCODED_BYTES" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/genesisstate.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/genesisstate.mdx index a286cb4..1b0087e 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/genesisstate.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/genesisstate.mdx @@ -4,6 +4,10 @@ title: "GenesisState"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/GenesisState <<'EOF' -{ - "synchronizerStore": { - "authorized": {} - }, - "timestamp": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "chunk": "BASE64_ENCODED_BYTES" -} -``` - -
-
- -
- ## Protocol Details @@ -438,3 +393,56 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/GenesisState <<'EOF' +{ + "synchronizerStore": { + "authorized": {} + }, + "timestamp": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "chunk": "BASE64_ENCODED_BYTES" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/genesisstatev2.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/genesisstatev2.mdx index 7c3e480..9729735 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/genesisstatev2.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/genesisstatev2.mdx @@ -4,6 +4,10 @@ title: "GenesisStateV2"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/GenesisStateV2 <<'EOF' -{ - "synchronizerStore": { - "authorized": {} - }, - "timestamp": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "chunk": "BASE64_ENCODED_BYTES" -} -``` - -
-
- -
- ## Protocol Details @@ -438,3 +393,56 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/GenesisStateV2 <<'EOF' +{ + "synchronizerStore": { + "authorized": {} + }, + "timestamp": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "chunk": "BASE64_ENCODED_BYTES" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listall.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listall.mdx index 2618a45..f574508 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listall.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listall.mdx @@ -4,6 +4,10 @@ title: "ListAll"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListAll <<'EOF' -{ - "baseQuery": { - "store": { - "authorized": {} - }, - "proposals": true, - "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", - "snapshot": "string", - "filterSignedKey": "string", - "protocolVersion": 0 - }, - "excludeMappings": [ - "string" - ], - "filterNamespace": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "result": { - "items": [ - { - "sequenced": "string", - "validFrom": "string", - "validUntil": "string", - "transaction": "BASE64_ENCODED_BYTES", - "rejectionReason": "string" - } - ] - } -} -``` - -
-
- -
- ## Protocol Details @@ -686,3 +622,75 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListAll <<'EOF' +{ + "baseQuery": { + "store": { + "authorized": {} + }, + "proposals": true, + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "snapshot": "string", + "filterSignedKey": "string", + "protocolVersion": 0 + }, + "excludeMappings": [ + "string" + ], + "filterNamespace": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "result": { + "items": [ + { + "sequenced": "string", + "validFrom": "string", + "validUntil": "string", + "transaction": "BASE64_ENCODED_BYTES", + "rejectionReason": "string" + } + ] + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listavailablestores.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listavailablestores.mdx index 7407efa..2d5a2b0 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listavailablestores.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listavailablestores.mdx @@ -4,6 +4,10 @@ title: "ListAvailableStores"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListAvailableStores <<'EOF' -{} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "storeIds": [ - { - "authorized": {} - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -380,3 +337,54 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListAvailableStores <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "storeIds": [ + { + "authorized": {} + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listdecentralizednamespacedefinition.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listdecentralizednamespacedefinition.mdx index 8188d42..662424e 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listdecentralizednamespacedefinition.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listdecentralizednamespacedefinition.mdx @@ -4,6 +4,10 @@ title: "ListDecentralizedNamespaceDefinition"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListDecentralizedNamespaceDefinition <<'EOF' -{ - "baseQuery": { - "store": { - "authorized": {} - }, - "proposals": true, - "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", - "snapshot": "string", - "filterSignedKey": "string", - "protocolVersion": 0 - }, - "filterNamespace": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "results": [ - { - "context": { - "store": { - "authorized": {} - }, - "sequenced": "string", - "validFrom": "string", - "validUntil": "string", - "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", - "transactionHash": "BASE64_ENCODED_BYTES", - "serial": 0, - "signedByFingerprints": [ - "string" - ] - }, - "item": { - "decentralizedNamespace": "string", - "threshold": 0, - "owners": [ - "string" - ] - } - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -755,3 +680,86 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListDecentralizedNamespaceDefinition <<'EOF' +{ + "baseQuery": { + "store": { + "authorized": {} + }, + "proposals": true, + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "snapshot": "string", + "filterSignedKey": "string", + "protocolVersion": 0 + }, + "filterNamespace": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "results": [ + { + "context": { + "store": { + "authorized": {} + }, + "sequenced": "string", + "validFrom": "string", + "validUntil": "string", + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "transactionHash": "BASE64_ENCODED_BYTES", + "serial": 0, + "signedByFingerprints": [ + "string" + ] + }, + "item": { + "decentralizedNamespace": "string", + "threshold": 0, + "owners": [ + "string" + ] + } + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listmediatorsynchronizerstate.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listmediatorsynchronizerstate.mdx index 2c92ab9..426b8d5 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listmediatorsynchronizerstate.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listmediatorsynchronizerstate.mdx @@ -4,6 +4,10 @@ title: "ListMediatorSynchronizerState"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListMediatorSynchronizerState <<'EOF' -{ - "baseQuery": { - "store": { - "authorized": {} - }, - "proposals": true, - "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", - "snapshot": "string", - "filterSignedKey": "string", - "protocolVersion": 0 - }, - "filterSynchronizerId": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "results": [ - { - "context": { - "store": { - "authorized": {} - }, - "sequenced": "string", - "validFrom": "string", - "validUntil": "string", - "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", - "transactionHash": "BASE64_ENCODED_BYTES", - "serial": 0, - "signedByFingerprints": [ - "string" - ] - }, - "item": { - "synchronizerId": "string", - "group": 0, - "threshold": 0, - "active": [ - "string" - ], - "observers": [ - "string" - ] - } - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -781,3 +702,90 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListMediatorSynchronizerState <<'EOF' +{ + "baseQuery": { + "store": { + "authorized": {} + }, + "proposals": true, + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "snapshot": "string", + "filterSignedKey": "string", + "protocolVersion": 0 + }, + "filterSynchronizerId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "results": [ + { + "context": { + "store": { + "authorized": {} + }, + "sequenced": "string", + "validFrom": "string", + "validUntil": "string", + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "transactionHash": "BASE64_ENCODED_BYTES", + "serial": 0, + "signedByFingerprints": [ + "string" + ] + }, + "item": { + "synchronizerId": "string", + "group": 0, + "threshold": 0, + "active": [ + "string" + ], + "observers": [ + "string" + ] + } + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listnamespacedelegation.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listnamespacedelegation.mdx index c98f55e..7322064 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listnamespacedelegation.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listnamespacedelegation.mdx @@ -4,6 +4,10 @@ title: "ListNamespaceDelegation"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListNamespaceDelegation <<'EOF' -{ - "baseQuery": { - "store": { - "authorized": {} - }, - "proposals": true, - "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", - "snapshot": "string", - "filterSignedKey": "string", - "protocolVersion": 0 - }, - "filterNamespace": "string", - "filterTargetKeyFingerprint": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "results": [ - { - "context": { - "store": { - "authorized": {} - }, - "sequenced": "string", - "validFrom": "string", - "validUntil": "string", - "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", - "transactionHash": "BASE64_ENCODED_BYTES", - "serial": 0, - "signedByFingerprints": [ - "string" - ] - }, - "item": { - "namespace": "string", - "targetKey": { - "format": "CRYPTO_KEY_FORMAT_UNSPECIFIED", - "publicKey": "BASE64_ENCODED_BYTES", - "scheme": "SIGNING_KEY_SCHEME_UNSPECIFIED", - "usage": [ - "SIGNING_KEY_USAGE_UNSPECIFIED" - ], - "keySpec": "SIGNING_KEY_SPEC_UNSPECIFIED" - }, - "isRootDelegation": true, - "canSignAllMappings": {} - } - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -1053,3 +970,94 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListNamespaceDelegation <<'EOF' +{ + "baseQuery": { + "store": { + "authorized": {} + }, + "proposals": true, + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "snapshot": "string", + "filterSignedKey": "string", + "protocolVersion": 0 + }, + "filterNamespace": "string", + "filterTargetKeyFingerprint": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "results": [ + { + "context": { + "store": { + "authorized": {} + }, + "sequenced": "string", + "validFrom": "string", + "validUntil": "string", + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "transactionHash": "BASE64_ENCODED_BYTES", + "serial": 0, + "signedByFingerprints": [ + "string" + ] + }, + "item": { + "namespace": "string", + "targetKey": { + "format": "CRYPTO_KEY_FORMAT_UNSPECIFIED", + "publicKey": "BASE64_ENCODED_BYTES", + "scheme": "SIGNING_KEY_SCHEME_UNSPECIFIED", + "usage": [ + "SIGNING_KEY_USAGE_UNSPECIFIED" + ], + "keySpec": "SIGNING_KEY_SPEC_UNSPECIFIED" + }, + "isRootDelegation": true, + "canSignAllMappings": {} + } + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listownertokeymapping.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listownertokeymapping.mdx index d12b76b..c34f370 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listownertokeymapping.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listownertokeymapping.mdx @@ -4,6 +4,10 @@ title: "ListOwnerToKeyMapping"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListOwnerToKeyMapping <<'EOF' -{ - "baseQuery": { - "store": { - "authorized": {} - }, - "proposals": true, - "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", - "snapshot": "string", - "filterSignedKey": "string", - "protocolVersion": 0 - }, - "filterKeyOwnerType": "string", - "filterKeyOwnerUid": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "results": [ - { - "context": { - "store": { - "authorized": {} - }, - "sequenced": "string", - "validFrom": "string", - "validUntil": "string", - "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", - "transactionHash": "BASE64_ENCODED_BYTES", - "serial": 0, - "signedByFingerprints": [ - "string" - ] - }, - "item": { - "member": "string", - "publicKeys": [ - { - "signingPublicKey": {} - } - ] - } - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -1050,3 +973,88 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListOwnerToKeyMapping <<'EOF' +{ + "baseQuery": { + "store": { + "authorized": {} + }, + "proposals": true, + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "snapshot": "string", + "filterSignedKey": "string", + "protocolVersion": 0 + }, + "filterKeyOwnerType": "string", + "filterKeyOwnerUid": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "results": [ + { + "context": { + "store": { + "authorized": {} + }, + "sequenced": "string", + "validFrom": "string", + "validUntil": "string", + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "transactionHash": "BASE64_ENCODED_BYTES", + "serial": 0, + "signedByFingerprints": [ + "string" + ] + }, + "item": { + "member": "string", + "publicKeys": [ + { + "signingPublicKey": {} + } + ] + } + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listparticipantsynchronizerpermission.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listparticipantsynchronizerpermission.mdx index b3ea19e..d27650e 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listparticipantsynchronizerpermission.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listparticipantsynchronizerpermission.mdx @@ -4,6 +4,10 @@ title: "ListParticipantSynchronizerPermission"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListParticipantSynchronizerPermission <<'EOF' -{ - "baseQuery": { - "store": { - "authorized": {} - }, - "proposals": true, - "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", - "snapshot": "string", - "filterSignedKey": "string", - "protocolVersion": 0 - }, - "filterUid": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "results": [ - { - "context": { - "store": { - "authorized": {} - }, - "sequenced": "string", - "validFrom": "string", - "validUntil": "string", - "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", - "transactionHash": "BASE64_ENCODED_BYTES", - "serial": 0, - "signedByFingerprints": [ - "string" - ] - }, - "item": { - "synchronizerId": "string", - "participantUid": "string", - "permission": "PARTICIPANT_PERMISSION_UNSPECIFIED", - "limits": { - "confirmationRequestsMaxRate": 0 - }, - "loginAfter": "0" - } - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -818,3 +741,88 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListParticipantSynchronizerPermission <<'EOF' +{ + "baseQuery": { + "store": { + "authorized": {} + }, + "proposals": true, + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "snapshot": "string", + "filterSignedKey": "string", + "protocolVersion": 0 + }, + "filterUid": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "results": [ + { + "context": { + "store": { + "authorized": {} + }, + "sequenced": "string", + "validFrom": "string", + "validUntil": "string", + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "transactionHash": "BASE64_ENCODED_BYTES", + "serial": 0, + "signedByFingerprints": [ + "string" + ] + }, + "item": { + "synchronizerId": "string", + "participantUid": "string", + "permission": "PARTICIPANT_PERMISSION_UNSPECIFIED", + "limits": { + "confirmationRequestsMaxRate": 0 + }, + "loginAfter": "0" + } + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listpartyhostinglimits.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listpartyhostinglimits.mdx index 0a07c90..450b373 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listpartyhostinglimits.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listpartyhostinglimits.mdx @@ -4,6 +4,10 @@ title: "ListPartyHostingLimits"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListPartyHostingLimits <<'EOF' -{ - "baseQuery": { - "store": { - "authorized": {} - }, - "proposals": true, - "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", - "snapshot": "string", - "filterSignedKey": "string", - "protocolVersion": 0 - }, - "filterUid": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "results": [ - { - "context": { - "store": { - "authorized": {} - }, - "sequenced": "string", - "validFrom": "string", - "validUntil": "string", - "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", - "transactionHash": "BASE64_ENCODED_BYTES", - "serial": 0, - "signedByFingerprints": [ - "string" - ] - }, - "item": { - "synchronizerId": "string", - "party": "string" - } - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -737,3 +665,83 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListPartyHostingLimits <<'EOF' +{ + "baseQuery": { + "store": { + "authorized": {} + }, + "proposals": true, + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "snapshot": "string", + "filterSignedKey": "string", + "protocolVersion": 0 + }, + "filterUid": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "results": [ + { + "context": { + "store": { + "authorized": {} + }, + "sequenced": "string", + "validFrom": "string", + "validUntil": "string", + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "transactionHash": "BASE64_ENCODED_BYTES", + "serial": 0, + "signedByFingerprints": [ + "string" + ] + }, + "item": { + "synchronizerId": "string", + "party": "string" + } + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listpartytokeymapping.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listpartytokeymapping.mdx index 2c5e537..3940997 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listpartytokeymapping.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listpartytokeymapping.mdx @@ -4,6 +4,10 @@ title: "ListPartyToKeyMapping"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListPartyToKeyMapping <<'EOF' -{ - "baseQuery": { - "store": { - "authorized": {} - }, - "proposals": true, - "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", - "snapshot": "string", - "filterSignedKey": "string", - "protocolVersion": 0 - }, - "filterParty": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "results": [ - { - "context": { - "store": { - "authorized": {} - }, - "sequenced": "string", - "validFrom": "string", - "validUntil": "string", - "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", - "transactionHash": "BASE64_ENCODED_BYTES", - "serial": 0, - "signedByFingerprints": [ - "string" - ] - }, - "item": { - "party": "string", - "threshold": 0, - "signingKeys": [ - { - "format": "CRYPTO_KEY_FORMAT_UNSPECIFIED", - "publicKey": "BASE64_ENCODED_BYTES", - "scheme": "SIGNING_KEY_SCHEME_UNSPECIFIED", - "usage": [ - "SIGNING_KEY_USAGE_UNSPECIFIED" - ], - "keySpec": "SIGNING_KEY_SPEC_UNSPECIFIED" - } - ] - } - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -923,3 +840,94 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListPartyToKeyMapping <<'EOF' +{ + "baseQuery": { + "store": { + "authorized": {} + }, + "proposals": true, + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "snapshot": "string", + "filterSignedKey": "string", + "protocolVersion": 0 + }, + "filterParty": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "results": [ + { + "context": { + "store": { + "authorized": {} + }, + "sequenced": "string", + "validFrom": "string", + "validUntil": "string", + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "transactionHash": "BASE64_ENCODED_BYTES", + "serial": 0, + "signedByFingerprints": [ + "string" + ] + }, + "item": { + "party": "string", + "threshold": 0, + "signingKeys": [ + { + "format": "CRYPTO_KEY_FORMAT_UNSPECIFIED", + "publicKey": "BASE64_ENCODED_BYTES", + "scheme": "SIGNING_KEY_SCHEME_UNSPECIFIED", + "usage": [ + "SIGNING_KEY_USAGE_UNSPECIFIED" + ], + "keySpec": "SIGNING_KEY_SPEC_UNSPECIFIED" + } + ] + } + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listpartytoparticipant.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listpartytoparticipant.mdx index bd9bc2b..bf6f979 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listpartytoparticipant.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listpartytoparticipant.mdx @@ -4,6 +4,10 @@ title: "ListPartyToParticipant"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListPartyToParticipant <<'EOF' -{ - "baseQuery": { - "store": { - "authorized": {} - }, - "proposals": true, - "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", - "snapshot": "string", - "filterSignedKey": "string", - "protocolVersion": 0 - }, - "filterParty": "string", - "filterParticipant": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "results": [ - { - "context": { - "store": { - "authorized": {} - }, - "sequenced": "string", - "validFrom": "string", - "validUntil": "string", - "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", - "transactionHash": "BASE64_ENCODED_BYTES", - "serial": 0, - "signedByFingerprints": [ - "string" - ] - }, - "item": { - "party": "string", - "threshold": 0, - "participants": [ - { - "participantUid": "string", - "permission": "PARTICIPANT_PERMISSION_UNSPECIFIED", - "onboarding": {} - } - ], - "partySigningKeys": { - "keys": [ - {} - ], - "threshold": 0 - } - } - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -1066,3 +980,97 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListPartyToParticipant <<'EOF' +{ + "baseQuery": { + "store": { + "authorized": {} + }, + "proposals": true, + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "snapshot": "string", + "filterSignedKey": "string", + "protocolVersion": 0 + }, + "filterParty": "string", + "filterParticipant": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "results": [ + { + "context": { + "store": { + "authorized": {} + }, + "sequenced": "string", + "validFrom": "string", + "validUntil": "string", + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "transactionHash": "BASE64_ENCODED_BYTES", + "serial": 0, + "signedByFingerprints": [ + "string" + ] + }, + "item": { + "party": "string", + "threshold": 0, + "participants": [ + { + "participantUid": "string", + "permission": "PARTICIPANT_PERMISSION_UNSPECIFIED", + "onboarding": {} + } + ], + "partySigningKeys": { + "keys": [ + {} + ], + "threshold": 0 + } + } + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsequencerconnectionsuccessor.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsequencerconnectionsuccessor.mdx index 12fc364..35116fb 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsequencerconnectionsuccessor.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsequencerconnectionsuccessor.mdx @@ -4,6 +4,10 @@ title: "ListSequencerConnectionSuccessor"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListSequencerConnectionSuccessor <<'EOF' -{ - "baseQuery": { - "store": { - "authorized": {} - }, - "proposals": true, - "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", - "snapshot": "string", - "filterSignedKey": "string", - "protocolVersion": 0 - }, - "filterSequencerId": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "results": [ - { - "context": { - "store": { - "authorized": {} - }, - "sequenced": "string", - "validFrom": "string", - "validUntil": "string", - "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", - "transactionHash": "BASE64_ENCODED_BYTES", - "serial": 0, - "signedByFingerprints": [ - "string" - ] - }, - "item": { - "sequencerId": "string", - "synchronizerId": "string", - "connection": { - "grpc": {} - } - } - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -810,3 +735,86 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListSequencerConnectionSuccessor <<'EOF' +{ + "baseQuery": { + "store": { + "authorized": {} + }, + "proposals": true, + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "snapshot": "string", + "filterSignedKey": "string", + "protocolVersion": 0 + }, + "filterSequencerId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "results": [ + { + "context": { + "store": { + "authorized": {} + }, + "sequenced": "string", + "validFrom": "string", + "validUntil": "string", + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "transactionHash": "BASE64_ENCODED_BYTES", + "serial": 0, + "signedByFingerprints": [ + "string" + ] + }, + "item": { + "sequencerId": "string", + "synchronizerId": "string", + "connection": { + "grpc": {} + } + } + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsequencersynchronizerstate.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsequencersynchronizerstate.mdx index 8cdb445..65020bc 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsequencersynchronizerstate.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsequencersynchronizerstate.mdx @@ -4,6 +4,10 @@ title: "ListSequencerSynchronizerState"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListSequencerSynchronizerState <<'EOF' -{ - "baseQuery": { - "store": { - "authorized": {} - }, - "proposals": true, - "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", - "snapshot": "string", - "filterSignedKey": "string", - "protocolVersion": 0 - }, - "filterSynchronizerId": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "results": [ - { - "context": { - "store": { - "authorized": {} - }, - "sequenced": "string", - "validFrom": "string", - "validUntil": "string", - "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", - "transactionHash": "BASE64_ENCODED_BYTES", - "serial": 0, - "signedByFingerprints": [ - "string" - ] - }, - "item": { - "synchronizerId": "string", - "threshold": 0, - "active": [ - "string" - ], - "observers": [ - "string" - ] - } - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -769,3 +691,89 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListSequencerSynchronizerState <<'EOF' +{ + "baseQuery": { + "store": { + "authorized": {} + }, + "proposals": true, + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "snapshot": "string", + "filterSignedKey": "string", + "protocolVersion": 0 + }, + "filterSynchronizerId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "results": [ + { + "context": { + "store": { + "authorized": {} + }, + "sequenced": "string", + "validFrom": "string", + "validUntil": "string", + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "transactionHash": "BASE64_ENCODED_BYTES", + "serial": 0, + "signedByFingerprints": [ + "string" + ] + }, + "item": { + "synchronizerId": "string", + "threshold": 0, + "active": [ + "string" + ], + "observers": [ + "string" + ] + } + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsynchronizerparametersstate.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsynchronizerparametersstate.mdx index 00af770..7fde308 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsynchronizerparametersstate.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsynchronizerparametersstate.mdx @@ -4,6 +4,10 @@ title: "ListSynchronizerParametersState"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListSynchronizerParametersState <<'EOF' -{ - "baseQuery": { - "store": { - "authorized": {} - }, - "proposals": true, - "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", - "snapshot": "string", - "filterSignedKey": "string", - "protocolVersion": 0 - }, - "filterSynchronizerId": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "results": [ - { - "context": { - "store": { - "authorized": {} - }, - "sequenced": "string", - "validFrom": "string", - "validUntil": "string", - "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", - "transactionHash": "BASE64_ENCODED_BYTES", - "serial": 0, - "signedByFingerprints": [ - "string" - ] - }, - "item": { - "confirmationResponseTimeout": "string", - "mediatorReactionTimeout": "string", - "assignmentExclusivityTimeout": "string", - "ledgerTimeRecordTimeTolerance": "string", - "reconciliationInterval": "string", - "mediatorDeduplicationTimeout": "string", - "maxRequestSize": 0, - "onboardingRestriction": "ONBOARDING_RESTRICTION_UNSPECIFIED" - } - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -1010,3 +932,89 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListSynchronizerParametersState <<'EOF' +{ + "baseQuery": { + "store": { + "authorized": {} + }, + "proposals": true, + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "snapshot": "string", + "filterSignedKey": "string", + "protocolVersion": 0 + }, + "filterSynchronizerId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "results": [ + { + "context": { + "store": { + "authorized": {} + }, + "sequenced": "string", + "validFrom": "string", + "validUntil": "string", + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "transactionHash": "BASE64_ENCODED_BYTES", + "serial": 0, + "signedByFingerprints": [ + "string" + ] + }, + "item": { + "confirmationResponseTimeout": "string", + "mediatorReactionTimeout": "string", + "assignmentExclusivityTimeout": "string", + "ledgerTimeRecordTimeTolerance": "string", + "reconciliationInterval": "string", + "mediatorDeduplicationTimeout": "string", + "maxRequestSize": 0, + "onboardingRestriction": "ONBOARDING_RESTRICTION_UNSPECIFIED" + } + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsynchronizertrustcertificate.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsynchronizertrustcertificate.mdx index 87a9c2f..2d77717 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsynchronizertrustcertificate.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsynchronizertrustcertificate.mdx @@ -4,6 +4,10 @@ title: "ListSynchronizerTrustCertificate"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListSynchronizerTrustCertificate <<'EOF' -{ - "baseQuery": { - "store": { - "authorized": {} - }, - "proposals": true, - "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", - "snapshot": "string", - "filterSignedKey": "string", - "protocolVersion": 0 - }, - "filterUid": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "results": [ - { - "context": { - "store": { - "authorized": {} - }, - "sequenced": "string", - "validFrom": "string", - "validUntil": "string", - "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", - "transactionHash": "BASE64_ENCODED_BYTES", - "serial": 0, - "signedByFingerprints": [ - "string" - ] - }, - "item": { - "participantUid": "string", - "synchronizerId": "string", - "featureFlags": [ - "PARTICIPANT_FEATURE_FLAG_UNSPECIFIED" - ] - } - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -772,3 +697,86 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListSynchronizerTrustCertificate <<'EOF' +{ + "baseQuery": { + "store": { + "authorized": {} + }, + "proposals": true, + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "snapshot": "string", + "filterSignedKey": "string", + "protocolVersion": 0 + }, + "filterUid": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "results": [ + { + "context": { + "store": { + "authorized": {} + }, + "sequenced": "string", + "validFrom": "string", + "validUntil": "string", + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "transactionHash": "BASE64_ENCODED_BYTES", + "serial": 0, + "signedByFingerprints": [ + "string" + ] + }, + "item": { + "participantUid": "string", + "synchronizerId": "string", + "featureFlags": [ + "PARTICIPANT_FEATURE_FLAG_UNSPECIFIED" + ] + } + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsynchronizerupgradeannouncement.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsynchronizerupgradeannouncement.mdx index 7d7fa60..88e38cd 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsynchronizerupgradeannouncement.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsynchronizerupgradeannouncement.mdx @@ -4,6 +4,10 @@ title: "ListSynchronizerUpgradeAnnouncement"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListSynchronizerUpgradeAnnouncement <<'EOF' -{ - "baseQuery": { - "store": { - "authorized": {} - }, - "proposals": true, - "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", - "snapshot": "string", - "filterSignedKey": "string", - "protocolVersion": 0 - }, - "filterSynchronizerId": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "results": [ - { - "context": { - "store": { - "authorized": {} - }, - "sequenced": "string", - "validFrom": "string", - "validUntil": "string", - "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", - "transactionHash": "BASE64_ENCODED_BYTES", - "serial": 0, - "signedByFingerprints": [ - "string" - ] - }, - "item": { - "successorPhysicalSynchronizerId": "string", - "upgradeTime": "string" - } - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -741,3 +669,83 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListSynchronizerUpgradeAnnouncement <<'EOF' +{ + "baseQuery": { + "store": { + "authorized": {} + }, + "proposals": true, + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "snapshot": "string", + "filterSignedKey": "string", + "protocolVersion": 0 + }, + "filterSynchronizerId": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "results": [ + { + "context": { + "store": { + "authorized": {} + }, + "sequenced": "string", + "validFrom": "string", + "validUntil": "string", + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "transactionHash": "BASE64_ENCODED_BYTES", + "serial": 0, + "signedByFingerprints": [ + "string" + ] + }, + "item": { + "successorPhysicalSynchronizerId": "string", + "upgradeTime": "string" + } + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listvettedpackages.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listvettedpackages.mdx index 0781cf5..df9cdd0 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listvettedpackages.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listvettedpackages.mdx @@ -4,6 +4,10 @@ title: "ListVettedPackages"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListVettedPackages <<'EOF' -{ - "baseQuery": { - "store": { - "authorized": {} - }, - "proposals": true, - "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", - "snapshot": "string", - "filterSignedKey": "string", - "protocolVersion": 0 - }, - "filterParticipant": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "results": [ - { - "context": { - "store": { - "authorized": {} - }, - "sequenced": "string", - "validFrom": "string", - "validUntil": "string", - "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", - "transactionHash": "BASE64_ENCODED_BYTES", - "serial": 0, - "signedByFingerprints": [ - "string" - ] - }, - "item": { - "participantUid": "string", - "packageIds": [ - "string" - ], - "packages": [ - { - "packageId": "string", - "validFromInclusive": "string", - "validUntilExclusive": "string" - } - ] - } - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -807,3 +726,92 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListVettedPackages <<'EOF' +{ + "baseQuery": { + "store": { + "authorized": {} + }, + "proposals": true, + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "snapshot": "string", + "filterSignedKey": "string", + "protocolVersion": 0 + }, + "filterParticipant": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "results": [ + { + "context": { + "store": { + "authorized": {} + }, + "sequenced": "string", + "validFrom": "string", + "validUntil": "string", + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "transactionHash": "BASE64_ENCODED_BYTES", + "serial": 0, + "signedByFingerprints": [ + "string" + ] + }, + "item": { + "participantUid": "string", + "packageIds": [ + "string" + ], + "packages": [ + { + "packageId": "string", + "validFromInclusive": "string", + "validUntilExclusive": "string" + } + ] + } + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/logicalupgradestate.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/logicalupgradestate.mdx index bc9c37f..a42499b 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/logicalupgradestate.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/logicalupgradestate.mdx @@ -4,6 +4,10 @@ title: "LogicalUpgradeState"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/LogicalUpgradeState <<'EOF' -{} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "chunk": "BASE64_ENCODED_BYTES" -} -``` - -
-
- -
- ## Protocol Details @@ -279,3 +239,51 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/LogicalUpgradeState <<'EOF' +{} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "chunk": "BASE64_ENCODED_BYTES" +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/addtransactions.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/addtransactions.mdx index 124ce77..5719d88 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/addtransactions.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/addtransactions.mdx @@ -4,6 +4,10 @@ title: "AddTransactions"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.topology.admin.v30.TopologyManagerWriteService/AddTransactions <<'EOF' -{ - "transactions": [ - { - "transaction": "BASE64_ENCODED_BYTES", - "signatures": [ - { - "format": "SIGNATURE_FORMAT_UNSPECIFIED", - "signature": "BASE64_ENCODED_BYTES", - "signedBy": "string", - "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", - "signatureDelegation": { - "sessionKey": "BASE64_ENCODED_BYTES", - "sessionKeySpec": "SIGNING_KEY_SPEC_UNSPECIFIED", - "validityPeriodFromInclusive": "0", - "validityPeriodDurationSeconds": 0, - "format": "SIGNATURE_FORMAT_UNSPECIFIED", - "signature": "BASE64_ENCODED_BYTES", - "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" - } - } - ], - "proposal": true, - "multiTransactionSignatures": [ - { - "transactionHashes": [ - "BASE64_ENCODED_BYTES" - ], - "signatures": [ - { - "format": "SIGNATURE_FORMAT_UNSPECIFIED", - "signature": "BASE64_ENCODED_BYTES", - "signedBy": "string", - "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", - "signatureDelegation": {} - } - ] - } - ] - } - ], - "forceChanges": [ - "FORCE_FLAG_UNSPECIFIED" - ], - "store": { - "authorized": {} - }, - "waitToBecomeEffective": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -843,3 +759,95 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerWriteService/AddTransactions <<'EOF' +{ + "transactions": [ + { + "transaction": "BASE64_ENCODED_BYTES", + "signatures": [ + { + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signedBy": "string", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", + "signatureDelegation": { + "sessionKey": "BASE64_ENCODED_BYTES", + "sessionKeySpec": "SIGNING_KEY_SPEC_UNSPECIFIED", + "validityPeriodFromInclusive": "0", + "validityPeriodDurationSeconds": 0, + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" + } + } + ], + "proposal": true, + "multiTransactionSignatures": [ + { + "transactionHashes": [ + "BASE64_ENCODED_BYTES" + ], + "signatures": [ + { + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signedBy": "string", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", + "signatureDelegation": {} + } + ] + } + ] + } + ], + "forceChanges": [ + "FORCE_FLAG_UNSPECIFIED" + ], + "store": { + "authorized": {} + }, + "waitToBecomeEffective": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/authorize.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/authorize.mdx index 3d3d362..d61f051 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/authorize.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/authorize.mdx @@ -4,6 +4,10 @@ title: "Authorize"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.topology.admin.v30.TopologyManagerWriteService/Authorize <<'EOF' -{ - "proposal": { - "change": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", - "serial": 0, - "mapping": { - "namespaceDelegation": { - "namespace": "string", - "targetKey": {}, - "isRootDelegation": true, - "canSignAllMappings": {} - } - } - }, - "mustFullyAuthorize": true, - "forceChanges": [ - "FORCE_FLAG_UNSPECIFIED" - ], - "signedBy": [ - "string" - ], - "store": { - "authorized": {} - }, - "waitToBecomeEffective": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "transaction": { - "transaction": "BASE64_ENCODED_BYTES", - "signatures": [ - { - "format": "SIGNATURE_FORMAT_UNSPECIFIED", - "signature": "BASE64_ENCODED_BYTES", - "signedBy": "string", - "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", - "signatureDelegation": { - "sessionKey": "BASE64_ENCODED_BYTES", - "sessionKeySpec": "SIGNING_KEY_SPEC_UNSPECIFIED", - "validityPeriodFromInclusive": "0", - "validityPeriodDurationSeconds": 0, - "format": "SIGNATURE_FORMAT_UNSPECIFIED", - "signature": "BASE64_ENCODED_BYTES", - "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" - } - } - ], - "proposal": true, - "multiTransactionSignatures": [ - { - "transactionHashes": [ - "BASE64_ENCODED_BYTES" - ], - "signatures": [ - { - "format": "SIGNATURE_FORMAT_UNSPECIFIED", - "signature": "BASE64_ENCODED_BYTES", - "signedBy": "string", - "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", - "signatureDelegation": {} - } - ] - } - ] - } -} -``` - -
-
- -
- ## Protocol Details @@ -2782,3 +2683,110 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerWriteService/Authorize <<'EOF' +{ + "proposal": { + "change": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "serial": 0, + "mapping": { + "namespaceDelegation": { + "namespace": "string", + "targetKey": {}, + "isRootDelegation": true, + "canSignAllMappings": {} + } + } + }, + "mustFullyAuthorize": true, + "forceChanges": [ + "FORCE_FLAG_UNSPECIFIED" + ], + "signedBy": [ + "string" + ], + "store": { + "authorized": {} + }, + "waitToBecomeEffective": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "transaction": { + "transaction": "BASE64_ENCODED_BYTES", + "signatures": [ + { + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signedBy": "string", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", + "signatureDelegation": { + "sessionKey": "BASE64_ENCODED_BYTES", + "sessionKeySpec": "SIGNING_KEY_SPEC_UNSPECIFIED", + "validityPeriodFromInclusive": "0", + "validityPeriodDurationSeconds": 0, + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" + } + } + ], + "proposal": true, + "multiTransactionSignatures": [ + { + "transactionHashes": [ + "BASE64_ENCODED_BYTES" + ], + "signatures": [ + { + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signedBy": "string", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", + "signatureDelegation": {} + } + ] + } + ] + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/createtemporarytopologystore.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/createtemporarytopologystore.mdx index f23d5b7..373b10c 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/createtemporarytopologystore.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/createtemporarytopologystore.mdx @@ -4,6 +4,10 @@ title: "CreateTemporaryTopologyStore"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.topology.admin.v30.TopologyManagerWriteService/CreateTemporaryTopologyStore <<'EOF' -{ - "name": "string", - "protocolVersion": 0 -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "storeId": { - "name": "string" - } -} -``` - -
-
- -
- ## Protocol Details @@ -357,3 +313,55 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerWriteService/CreateTemporaryTopologyStore <<'EOF' +{ + "name": "string", + "protocolVersion": 0 +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "storeId": { + "name": "string" + } +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/droptemporarytopologystore.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/droptemporarytopologystore.mdx index 4d93527..e9cbd2f 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/droptemporarytopologystore.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/droptemporarytopologystore.mdx @@ -4,6 +4,10 @@ title: "DropTemporaryTopologyStore"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.topology.admin.v30.TopologyManagerWriteService/DropTemporaryTopologyStore <<'EOF' -{ - "storeId": { - "name": "string" - } -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -302,3 +261,52 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerWriteService/DropTemporaryTopologyStore <<'EOF' +{ + "storeId": { + "name": "string" + } +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/generatetransactions.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/generatetransactions.mdx index 9b090ef..45a7a6b 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/generatetransactions.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/generatetransactions.mdx @@ -4,6 +4,10 @@ title: "GenerateTransactions"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.topology.admin.v30.TopologyManagerWriteService/GenerateTransactions <<'EOF' -{ - "proposals": [ - { - "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", - "serial": 0, - "mapping": { - "namespaceDelegation": { - "namespace": "string", - "targetKey": {}, - "isRootDelegation": true, - "canSignAllMappings": {} - } - }, - "store": { - "authorized": {} - } - } - ] -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "generatedTransactions": [ - { - "serializedTransaction": "BASE64_ENCODED_BYTES", - "transactionHash": "BASE64_ENCODED_BYTES" - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -2330,3 +2268,73 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerWriteService/GenerateTransactions <<'EOF' +{ + "proposals": [ + { + "operation": "TOPOLOGY_CHANGE_OP_UNSPECIFIED", + "serial": 0, + "mapping": { + "namespaceDelegation": { + "namespace": "string", + "targetKey": {}, + "isRootDelegation": true, + "canSignAllMappings": {} + } + }, + "store": { + "authorized": {} + } + } + ] +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "generatedTransactions": [ + { + "serializedTransaction": "BASE64_ENCODED_BYTES", + "transactionHash": "BASE64_ENCODED_BYTES" + } + ] +} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/importtopologysnapshot.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/importtopologysnapshot.mdx index ae19e4b..f8b9b0f 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/importtopologysnapshot.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/importtopologysnapshot.mdx @@ -4,6 +4,10 @@ title: "ImportTopologySnapshot"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.topology.admin.v30.TopologyManagerWriteService/ImportTopologySnapshot <<'EOF' -{ - "topologySnapshot": "BASE64_ENCODED_BYTES", - "store": { - "authorized": {} - }, - "waitToBecomeEffective": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -421,3 +377,55 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerWriteService/ImportTopologySnapshot <<'EOF' +{ + "topologySnapshot": "BASE64_ENCODED_BYTES", + "store": { + "authorized": {} + }, + "waitToBecomeEffective": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/importtopologysnapshotv2.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/importtopologysnapshotv2.mdx index f0048c0..faea589 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/importtopologysnapshotv2.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/importtopologysnapshotv2.mdx @@ -4,6 +4,10 @@ title: "ImportTopologySnapshotV2"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.topology.admin.v30.TopologyManagerWriteService/ImportTopologySnapshotV2 <<'EOF' -{ - "topologySnapshot": "BASE64_ENCODED_BYTES", - "store": { - "authorized": {} - }, - "waitToBecomeEffective": "string" -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{} -``` - -
-
- -
- ## Protocol Details @@ -421,3 +377,55 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerWriteService/ImportTopologySnapshotV2 <<'EOF' +{ + "topologySnapshot": "BASE64_ENCODED_BYTES", + "store": { + "authorized": {} + }, + "waitToBecomeEffective": "string" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{} +``` + +
+
+ +
+ +
diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/signtransactions.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/signtransactions.mdx index 84d193c..fa30a1f 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/signtransactions.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/signtransactions.mdx @@ -4,6 +4,10 @@ title: "SignTransactions"
+
+
+ + - -
- -
-
-
- grpcurl - -
- -```bash grpcurl -# Add -plaintext if the server is not using TLS. -grpcurl \ - -d @ \ - \ - com.digitalasset.canton.topology.admin.v30.TopologyManagerWriteService/SignTransactions <<'EOF' -{ - "transactions": [ - { - "transaction": "BASE64_ENCODED_BYTES", - "signatures": [ - { - "format": "SIGNATURE_FORMAT_UNSPECIFIED", - "signature": "BASE64_ENCODED_BYTES", - "signedBy": "string", - "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", - "signatureDelegation": { - "sessionKey": "BASE64_ENCODED_BYTES", - "sessionKeySpec": "SIGNING_KEY_SPEC_UNSPECIFIED", - "validityPeriodFromInclusive": "0", - "validityPeriodDurationSeconds": 0, - "format": "SIGNATURE_FORMAT_UNSPECIFIED", - "signature": "BASE64_ENCODED_BYTES", - "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" - } - } - ], - "proposal": true, - "multiTransactionSignatures": [ - { - "transactionHashes": [ - "BASE64_ENCODED_BYTES" - ], - "signatures": [ - { - "format": "SIGNATURE_FORMAT_UNSPECIFIED", - "signature": "BASE64_ENCODED_BYTES", - "signedBy": "string", - "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", - "signatureDelegation": {} - } - ] - } - ] - } - ], - "signedBy": [ - "string" - ], - "store": { - "authorized": {} - }, - "forceFlags": [ - "FORCE_FLAG_UNSPECIFIED" - ] -} -EOF -``` - -
-
- -
-
-
- OK - - application/json - -
- -```json OK -{ - "transactions": [ - { - "transaction": "BASE64_ENCODED_BYTES", - "signatures": [ - { - "format": "SIGNATURE_FORMAT_UNSPECIFIED", - "signature": "BASE64_ENCODED_BYTES", - "signedBy": "string", - "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", - "signatureDelegation": { - "sessionKey": "BASE64_ENCODED_BYTES", - "sessionKeySpec": "SIGNING_KEY_SPEC_UNSPECIFIED", - "validityPeriodFromInclusive": "0", - "validityPeriodDurationSeconds": 0, - "format": "SIGNATURE_FORMAT_UNSPECIFIED", - "signature": "BASE64_ENCODED_BYTES", - "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" - } - } - ], - "proposal": true, - "multiTransactionSignatures": [ - { - "transactionHashes": [ - "BASE64_ENCODED_BYTES" - ], - "signatures": [ - { - "format": "SIGNATURE_FORMAT_UNSPECIFIED", - "signature": "BASE64_ENCODED_BYTES", - "signedBy": "string", - "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", - "signatureDelegation": {} - } - ] - } - ] - } - ] -} -``` - -
-
- -
- ## Protocol Details @@ -915,3 +789,137 @@ EOF + + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +grpcurl \ + -d @ \ + \ + com.digitalasset.canton.topology.admin.v30.TopologyManagerWriteService/SignTransactions <<'EOF' +{ + "transactions": [ + { + "transaction": "BASE64_ENCODED_BYTES", + "signatures": [ + { + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signedBy": "string", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", + "signatureDelegation": { + "sessionKey": "BASE64_ENCODED_BYTES", + "sessionKeySpec": "SIGNING_KEY_SPEC_UNSPECIFIED", + "validityPeriodFromInclusive": "0", + "validityPeriodDurationSeconds": 0, + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" + } + } + ], + "proposal": true, + "multiTransactionSignatures": [ + { + "transactionHashes": [ + "BASE64_ENCODED_BYTES" + ], + "signatures": [ + { + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signedBy": "string", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", + "signatureDelegation": {} + } + ] + } + ] + } + ], + "signedBy": [ + "string" + ], + "store": { + "authorized": {} + }, + "forceFlags": [ + "FORCE_FLAG_UNSPECIFIED" + ] +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "transactions": [ + { + "transaction": "BASE64_ENCODED_BYTES", + "signatures": [ + { + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signedBy": "string", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", + "signatureDelegation": { + "sessionKey": "BASE64_ENCODED_BYTES", + "sessionKeySpec": "SIGNING_KEY_SPEC_UNSPECIFIED", + "validityPeriodFromInclusive": "0", + "validityPeriodDurationSeconds": 0, + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED" + } + } + ], + "proposal": true, + "multiTransactionSignatures": [ + { + "transactionHashes": [ + "BASE64_ENCODED_BYTES" + ], + "signatures": [ + { + "format": "SIGNATURE_FORMAT_UNSPECIFIED", + "signature": "BASE64_ENCODED_BYTES", + "signedBy": "string", + "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED", + "signatureDelegation": {} + } + ] + } + ] + } + ] +} +``` + +
+
+ +
+ +
From 3c7b8a59ba026c25374ddb6712972c11d72ae19b Mon Sep 17 00:00:00 2001 From: danielporterda Date: Mon, 27 Apr 2026 16:27:29 -0400 Subject: [PATCH 3/3] Remove generated operation try buttons --- src/x2mdx/templates/shared/reference_macros.md.j2 | 1 - .../openrpc/expected/operations/dapp-api/accountschanged.mdx | 1 - .../openrpc/expected/operations/dapp-api/connect.mdx | 1 - .../openrpc/expected/operations/dapp-api/disconnect.mdx | 1 - .../openrpc/expected/operations/dapp-api/getactivenetwork.mdx | 1 - .../openrpc/expected/operations/dapp-api/getprimaryaccount.mdx | 1 - .../openrpc/expected/operations/dapp-api/ledgerapi.mdx | 1 - .../openrpc/expected/operations/dapp-api/listaccounts.mdx | 1 - .../openrpc/expected/operations/dapp-api/prepareexecute.mdx | 1 - .../expected/operations/dapp-api/prepareexecuteandwait.mdx | 1 - .../openrpc/expected/operations/dapp-api/signmessage.mdx | 1 - .../openrpc/expected/operations/dapp-api/status.mdx | 1 - .../openrpc/expected/operations/dapp-api/txchanged.mdx | 1 - .../expected/operations/dapp-remote-api/accountschanged.mdx | 1 - .../openrpc/expected/operations/dapp-remote-api/connect.mdx | 1 - .../openrpc/expected/operations/dapp-remote-api/connected.mdx | 1 - .../openrpc/expected/operations/dapp-remote-api/disconnect.mdx | 1 - .../expected/operations/dapp-remote-api/getactivenetwork.mdx | 1 - .../expected/operations/dapp-remote-api/getprimaryaccount.mdx | 1 - .../openrpc/expected/operations/dapp-remote-api/ledgerapi.mdx | 1 - .../openrpc/expected/operations/dapp-remote-api/listaccounts.mdx | 1 - .../expected/operations/dapp-remote-api/onstatuschanged.mdx | 1 - .../expected/operations/dapp-remote-api/prepareexecute.mdx | 1 - .../openrpc/expected/operations/dapp-remote-api/signmessage.mdx | 1 - .../openrpc/expected/operations/dapp-remote-api/status.mdx | 1 - .../openrpc/expected/operations/dapp-remote-api/txchanged.mdx | 1 - .../openrpc/expected/operations/signing-api/createkey.mdx | 1 - .../openrpc/expected/operations/signing-api/getconfiguration.mdx | 1 - .../openrpc/expected/operations/signing-api/getkeys.mdx | 1 - .../openrpc/expected/operations/signing-api/gettransaction.mdx | 1 - .../openrpc/expected/operations/signing-api/gettransactions.mdx | 1 - .../openrpc/expected/operations/signing-api/setconfiguration.mdx | 1 - .../openrpc/expected/operations/signing-api/signtransaction.mdx | 1 - .../expected/operations/signing-api/subscribetransactions.mdx | 1 - .../openrpc/expected/operations/user-api/addidp.mdx | 1 - .../openrpc/expected/operations/user-api/addnetwork.mdx | 1 - .../openrpc/expected/operations/user-api/addsession.mdx | 1 - .../expected/operations/user-api/allocatepartyforwallet.mdx | 1 - .../openrpc/expected/operations/user-api/createwallet.mdx | 1 - .../openrpc/expected/operations/user-api/deletetransaction.mdx | 1 - .../openrpc/expected/operations/user-api/execute.mdx | 1 - .../openrpc/expected/operations/user-api/gettransaction.mdx | 1 - .../openrpc/expected/operations/user-api/getuser.mdx | 1 - .../openrpc/expected/operations/user-api/iswalletsyncneeded.mdx | 1 - .../openrpc/expected/operations/user-api/listidps.mdx | 1 - .../openrpc/expected/operations/user-api/listnetworks.mdx | 1 - .../openrpc/expected/operations/user-api/listsessions.mdx | 1 - .../openrpc/expected/operations/user-api/listtransactions.mdx | 1 - .../openrpc/expected/operations/user-api/listwallets.mdx | 1 - .../openrpc/expected/operations/user-api/removeidp.mdx | 1 - .../openrpc/expected/operations/user-api/removenetwork.mdx | 1 - .../openrpc/expected/operations/user-api/removesession.mdx | 1 - .../openrpc/expected/operations/user-api/removewallet.mdx | 1 - .../openrpc/expected/operations/user-api/setprimarywallet.mdx | 1 - .../openrpc/expected/operations/user-api/sign.mdx | 1 - .../openrpc/expected/operations/user-api/syncwallets.mdx | 1 - .../expected_alt_layout/operations/dapp-api/accountschanged.mdx | 1 - .../openrpc/expected_alt_layout/operations/dapp-api/connect.mdx | 1 - .../expected_alt_layout/operations/dapp-api/disconnect.mdx | 1 - .../expected_alt_layout/operations/dapp-api/getactivenetwork.mdx | 1 - .../operations/dapp-api/getprimaryaccount.mdx | 1 - .../expected_alt_layout/operations/dapp-api/ledgerapi.mdx | 1 - .../expected_alt_layout/operations/dapp-api/listaccounts.mdx | 1 - .../expected_alt_layout/operations/dapp-api/prepareexecute.mdx | 1 - .../operations/dapp-api/prepareexecuteandwait.mdx | 1 - .../expected_alt_layout/operations/dapp-api/signmessage.mdx | 1 - .../openrpc/expected_alt_layout/operations/dapp-api/status.mdx | 1 - .../expected_alt_layout/operations/dapp-api/txchanged.mdx | 1 - .../operations/dapp-remote-api/accountschanged.mdx | 1 - .../expected_alt_layout/operations/dapp-remote-api/connect.mdx | 1 - .../expected_alt_layout/operations/dapp-remote-api/connected.mdx | 1 - .../operations/dapp-remote-api/disconnect.mdx | 1 - .../operations/dapp-remote-api/getactivenetwork.mdx | 1 - .../operations/dapp-remote-api/getprimaryaccount.mdx | 1 - .../expected_alt_layout/operations/dapp-remote-api/ledgerapi.mdx | 1 - .../operations/dapp-remote-api/listaccounts.mdx | 1 - .../operations/dapp-remote-api/onstatuschanged.mdx | 1 - .../operations/dapp-remote-api/prepareexecute.mdx | 1 - .../operations/dapp-remote-api/signmessage.mdx | 1 - .../expected_alt_layout/operations/dapp-remote-api/status.mdx | 1 - .../expected_alt_layout/operations/dapp-remote-api/txchanged.mdx | 1 - .../expected_alt_layout/operations/signing-api/createkey.mdx | 1 - .../operations/signing-api/getconfiguration.mdx | 1 - .../expected_alt_layout/operations/signing-api/getkeys.mdx | 1 - .../operations/signing-api/gettransaction.mdx | 1 - .../operations/signing-api/gettransactions.mdx | 1 - .../operations/signing-api/setconfiguration.mdx | 1 - .../operations/signing-api/signtransaction.mdx | 1 - .../operations/signing-api/subscribetransactions.mdx | 1 - .../openrpc/expected_alt_layout/operations/user-api/addidp.mdx | 1 - .../expected_alt_layout/operations/user-api/addnetwork.mdx | 1 - .../expected_alt_layout/operations/user-api/addsession.mdx | 1 - .../operations/user-api/allocatepartyforwallet.mdx | 1 - .../expected_alt_layout/operations/user-api/createwallet.mdx | 1 - .../operations/user-api/deletetransaction.mdx | 1 - .../openrpc/expected_alt_layout/operations/user-api/execute.mdx | 1 - .../expected_alt_layout/operations/user-api/gettransaction.mdx | 1 - .../openrpc/expected_alt_layout/operations/user-api/getuser.mdx | 1 - .../operations/user-api/iswalletsyncneeded.mdx | 1 - .../openrpc/expected_alt_layout/operations/user-api/listidps.mdx | 1 - .../expected_alt_layout/operations/user-api/listnetworks.mdx | 1 - .../expected_alt_layout/operations/user-api/listsessions.mdx | 1 - .../expected_alt_layout/operations/user-api/listtransactions.mdx | 1 - .../expected_alt_layout/operations/user-api/listwallets.mdx | 1 - .../expected_alt_layout/operations/user-api/removeidp.mdx | 1 - .../expected_alt_layout/operations/user-api/removenetwork.mdx | 1 - .../expected_alt_layout/operations/user-api/removesession.mdx | 1 - .../expected_alt_layout/operations/user-api/removewallet.mdx | 1 - .../expected_alt_layout/operations/user-api/setprimarywallet.mdx | 1 - .../openrpc/expected_alt_layout/operations/user-api/sign.mdx | 1 - .../expected_alt_layout/operations/user-api/syncwallets.mdx | 1 - .../commandinspectionservice/getcommandstatus.mdx | 1 - .../createidentityproviderconfig.mdx | 1 - .../deleteidentityproviderconfig.mdx | 1 - .../identityproviderconfigservice/getidentityproviderconfig.mdx | 1 - .../listidentityproviderconfigs.mdx | 1 - .../updateidentityproviderconfig.mdx | 1 - .../packagemanagementservice/listknownpackages.mdx | 1 - .../packagemanagementservice/updatevettedpackages.mdx | 1 - .../packagemanagementservice/uploaddarfile.mdx | 1 - .../packagemanagementservice/validatedarfile.mdx | 1 - .../participantpruningservice/prune.mdx | 1 - .../partymanagementservice/allocateexternalparty.mdx | 1 - .../partymanagementservice/allocateparty.mdx | 1 - .../partymanagementservice/generateexternalpartytopology.mdx | 1 - .../partymanagementservice/getparticipantid.mdx | 1 - .../partymanagementservice/getparties.mdx | 1 - .../partymanagementservice/listknownparties.mdx | 1 - .../partymanagementservice/updatepartydetails.mdx | 1 - .../partymanagementservice/updatepartyidentityproviderid.mdx | 1 - .../usermanagementservice/createuser.mdx | 1 - .../usermanagementservice/deleteuser.mdx | 1 - .../usermanagementservice/getuser.mdx | 1 - .../usermanagementservice/grantuserrights.mdx | 1 - .../usermanagementservice/listuserrights.mdx | 1 - .../usermanagementservice/listusers.mdx | 1 - .../usermanagementservice/revokeuserrights.mdx | 1 - .../usermanagementservice/updateuser.mdx | 1 - .../usermanagementservice/updateuseridentityproviderid.mdx | 1 - .../interactivesubmissionservice/executesubmission.mdx | 1 - .../interactivesubmissionservice/executesubmissionandwait.mdx | 1 - .../executesubmissionandwaitfortransaction.mdx | 1 - .../interactivesubmissionservice/getpreferredpackages.mdx | 1 - .../interactivesubmissionservice/getpreferredpackageversion.mdx | 1 - .../interactivesubmissionservice/preparesubmission.mdx | 1 - .../commandcompletionservice/completionstream.mdx | 1 - .../com-daml-ledger-api-v2/commandservice/submitandwait.mdx | 1 - .../commandservice/submitandwaitforreassignment.mdx | 1 - .../commandservice/submitandwaitfortransaction.mdx | 1 - .../com-daml-ledger-api-v2/commandsubmissionservice/submit.mdx | 1 - .../commandsubmissionservice/submitreassignment.mdx | 1 - .../com-daml-ledger-api-v2/contractservice/getcontract.mdx | 1 - .../eventqueryservice/geteventsbycontractid.mdx | 1 - .../com-daml-ledger-api-v2/packageservice/getpackage.mdx | 1 - .../com-daml-ledger-api-v2/packageservice/getpackagestatus.mdx | 1 - .../com-daml-ledger-api-v2/packageservice/listpackages.mdx | 1 - .../com-daml-ledger-api-v2/packageservice/listvettedpackages.mdx | 1 - .../com-daml-ledger-api-v2/stateservice/getactivecontracts.mdx | 1 - .../stateservice/getconnectedsynchronizers.mdx | 1 - .../stateservice/getlatestprunedoffsets.mdx | 1 - .../com-daml-ledger-api-v2/stateservice/getledgerend.mdx | 1 - .../com-daml-ledger-api-v2/updateservice/getupdatebyid.mdx | 1 - .../com-daml-ledger-api-v2/updateservice/getupdatebyoffset.mdx | 1 - .../com-daml-ledger-api-v2/updateservice/getupdates.mdx | 1 - .../versionservice/getledgerapiversion.mdx | 1 - .../statusservice/getlasterrors.mdx | 1 - .../statusservice/getlasterrortrace.mdx | 1 - .../statusservice/healthdump.mdx | 1 - .../statusservice/setloglevel.mdx | 1 - .../mediatorstatusservice/mediatorstatus.mdx | 1 - .../enterpriseparticipantreplicationservice/setpassive.mdx | 1 - .../packageservice/getdar.mdx | 1 - .../packageservice/getdarcontents.mdx | 1 - .../packageservice/getpackagecontents.mdx | 1 - .../packageservice/getpackagereferences.mdx | 1 - .../packageservice/listdars.mdx | 1 - .../packageservice/listpackages.mdx | 1 - .../packageservice/removedar.mdx | 1 - .../packageservice/removepackage.mdx | 1 - .../packageservice/unvetdar.mdx | 1 - .../packageservice/uploaddar.mdx | 1 - .../packageservice/validatedar.mdx | 1 - .../packageservice/vetdar.mdx | 1 - .../participantinspectionservice/countinflight.mdx | 1 - .../getconfigforslowcounterparticipants.mdx | 1 - .../getintervalsbehindforcounterparticipants.mdx | 1 - .../participantinspectionservice/inspectcommitmentcontracts.mdx | 1 - .../participantinspectionservice/lookupoffsetbytime.mdx | 1 - .../lookupreceivedacscommitments.mdx | 1 - .../participantinspectionservice/lookupsentacscommitments.mdx | 1 - .../participantinspectionservice/opencommitment.mdx | 1 - .../setconfigforslowcounterparticipants.mdx | 1 - .../participantrepairservice/changeassignation.mdx | 1 - .../participantrepairservice/exportacs.mdx | 1 - .../participantrepairservice/exportacsold.mdx | 1 - .../participantrepairservice/ignoreevents.mdx | 1 - .../participantrepairservice/importacs.mdx | 1 - .../participantrepairservice/importacsold.mdx | 1 - .../participantrepairservice/migratesynchronizer.mdx | 1 - .../participantrepairservice/purgecontracts.mdx | 1 - .../participantrepairservice/purgedeactivatedsynchronizer.mdx | 1 - .../participantrepairservice/repaircommitmentsusingacs.mdx | 1 - .../participantrepairservice/rollbackunassignment.mdx | 1 - .../participantrepairservice/unignoreevents.mdx | 1 - .../participantstatusservice/participantstatus.mdx | 1 - .../partymanagementservice/addpartyasync.mdx | 1 - .../partymanagementservice/clearpartyonboardingflag.mdx | 1 - .../partymanagementservice/exportpartyacs.mdx | 1 - .../partymanagementservice/getaddpartystatus.mdx | 1 - .../partymanagementservice/gethighestoffsetbytimestamp.mdx | 1 - .../partymanagementservice/importpartyacs.mdx | 1 - .../pingservice/ping.mdx | 1 - .../pruningservice/clearschedule.mdx | 1 - .../pruningservice/getnowaitcommitmentsfrom.mdx | 1 - .../pruningservice/getparticipantschedule.mdx | 1 - .../pruningservice/getsafepruningoffset.mdx | 1 - .../pruningservice/getschedule.mdx | 1 - .../pruningservice/prune.mdx | 1 - .../pruningservice/resetnowaitcommitmentsfrom.mdx | 1 - .../pruningservice/setcron.mdx | 1 - .../pruningservice/setmaxduration.mdx | 1 - .../pruningservice/setnowaitcommitmentsfrom.mdx | 1 - .../pruningservice/setparticipantschedule.mdx | 1 - .../pruningservice/setretention.mdx | 1 - .../pruningservice/setschedule.mdx | 1 - .../resourcemanagementservice/getresourcelimits.mdx | 1 - .../resourcemanagementservice/setresourcelimits.mdx | 1 - .../synchronizerconnectivityservice/connectsynchronizer.mdx | 1 - .../disconnectallsynchronizers.mdx | 1 - .../synchronizerconnectivityservice/disconnectsynchronizer.mdx | 1 - .../synchronizerconnectivityservice/getsynchronizerid.mdx | 1 - .../listconnectedsynchronizers.mdx | 1 - .../listregisteredsynchronizers.mdx | 1 - .../synchronizerconnectivityservice/logout.mdx | 1 - .../synchronizerconnectivityservice/modifysynchronizer.mdx | 1 - .../synchronizerconnectivityservice/reconnectsynchronizer.mdx | 1 - .../synchronizerconnectivityservice/reconnectsynchronizers.mdx | 1 - .../synchronizerconnectivityservice/registersynchronizer.mdx | 1 - .../trafficcontrolservice/trafficcontrolstate.mdx | 1 - .../sequencerstatusservice/sequencerstatus.mdx | 1 - .../apiinfoservice/getapiinfo.mdx | 1 - .../vaultservice/deletekeypair.mdx | 1 - .../vaultservice/exportkeypair.mdx | 1 - .../vaultservice/generateencryptionkey.mdx | 1 - .../vaultservice/generatesigningkey.mdx | 1 - .../vaultservice/getwrapperkeyid.mdx | 1 - .../vaultservice/importkeypair.mdx | 1 - .../vaultservice/importpublickey.mdx | 1 - .../vaultservice/listmykeys.mdx | 1 - .../vaultservice/listpublickeys.mdx | 1 - .../vaultservice/registerkmsencryptionkey.mdx | 1 - .../vaultservice/registerkmssigningkey.mdx | 1 - .../vaultservice/rotatewrapperkey.mdx | 1 - .../mediatoradministrationservice/clearschedule.mdx | 1 - .../mediatoradministrationservice/findpruningtimestamp.mdx | 1 - .../mediatoradministrationservice/getschedule.mdx | 1 - .../mediatoradministrationservice/prune.mdx | 1 - .../mediatoradministrationservice/setcron.mdx | 1 - .../mediatoradministrationservice/setmaxduration.mdx | 1 - .../mediatoradministrationservice/setretention.mdx | 1 - .../mediatoradministrationservice/setschedule.mdx | 1 - .../mediatorinitializationservice/initializemediator.mdx | 1 - .../mediatorinspectionservice/verdicts.mdx | 1 - .../sequencerconnectionservice/getconnection.mdx | 1 - .../sequencerconnectionservice/logout.mdx | 1 - .../sequencerconnectionservice/setconnection.mdx | 1 - .../sequenceradministrationservice/disablemember.mdx | 1 - .../generateauthenticationtoken.mdx | 1 - .../sequenceradministrationservice/onboardingstate.mdx | 1 - .../sequenceradministrationservice/onboardingstatev2.mdx | 1 - .../sequenceradministrationservice/pruningstatus.mdx | 1 - .../sequenceradministrationservice/settrafficpurchased.mdx | 1 - .../sequenceradministrationservice/snapshot.mdx | 1 - .../sequenceradministrationservice/trafficcontrolstate.mdx | 1 - .../sequencerbftadministrationservice/addpeerendpoint.mdx | 1 - .../sequencerbftadministrationservice/getorderingtopology.mdx | 1 - .../sequencerbftadministrationservice/getpeernetworkstatus.mdx | 1 - .../sequencerbftadministrationservice/removepeerendpoint.mdx | 1 - .../setperformancemetricsenabled.mdx | 1 - .../sequencerbftpruningadministrationservice/bftprune.mdx | 1 - .../bftpruningstatus.mdx | 1 - .../sequencerbftpruningadministrationservice/clearschedule.mdx | 1 - .../sequencerbftpruningadministrationservice/getbftschedule.mdx | 1 - .../sequencerbftpruningadministrationservice/getschedule.mdx | 1 - .../sequencerbftpruningadministrationservice/setbftschedule.mdx | 1 - .../sequencerbftpruningadministrationservice/setcron.mdx | 1 - .../sequencerbftpruningadministrationservice/setmaxduration.mdx | 1 - .../setminblockstokeep.mdx | 1 - .../sequencerbftpruningadministrationservice/setretention.mdx | 1 - .../sequencerbftpruningadministrationservice/setschedule.mdx | 1 - .../initializesequencerfromgenesisstate.mdx | 1 - .../initializesequencerfromgenesisstatev2.mdx | 1 - .../initializesequencerfromonboardingstate.mdx | 1 - .../initializesequencerfromonboardingstatev2.mdx | 1 - .../initializesequencerfrompredecessor.mdx | 1 - .../sequencerpruningadministrationservice/clearschedule.mdx | 1 - .../findpruningtimestamp.mdx | 1 - .../sequencerpruningadministrationservice/getschedule.mdx | 1 - .../sequencerpruningadministrationservice/prune.mdx | 1 - .../sequencerpruningadministrationservice/setcron.mdx | 1 - .../sequencerpruningadministrationservice/setmaxduration.mdx | 1 - .../sequencerpruningadministrationservice/setretention.mdx | 1 - .../sequencerpruningadministrationservice/setschedule.mdx | 1 - .../sequencerauthenticationservice/authenticate.mdx | 1 - .../sequencerauthenticationservice/challenge.mdx | 1 - .../sequencerauthenticationservice/logout.mdx | 1 - .../sequencerchannelservice/connecttosequencerchannel.mdx | 1 - .../sequencerchannelservice/ping.mdx | 1 - .../sequencerconnectservice/getsynchronizerid.mdx | 1 - .../sequencerconnectservice/getsynchronizerparameters.mdx | 1 - .../sequencerconnectservice/handshake.mdx | 1 - .../registeronboardingtopologytransactions.mdx | 1 - .../sequencerconnectservice/verifyactive.mdx | 1 - .../sequencerservice/acknowledgesigned.mdx | 1 - .../sequencerservice/downloadtopologystateforinit.mdx | 1 - .../sequencerservice/downloadtopologystateforinithash.mdx | 1 - .../sequencerservice/gettime.mdx | 1 - .../sequencerservice/gettrafficstateformember.mdx | 1 - .../sequencerservice/sendasync.mdx | 1 - .../sequencerservice/subscribe.mdx | 1 - .../standalonebftorderingservice/readordered.mdx | 1 - .../standalonebftorderingservice/send.mdx | 1 - .../bftorderingservice/receive.mdx | 1 - .../synchronizertimeservice/awaittime.mdx | 1 - .../synchronizertimeservice/fetchtime.mdx | 1 - .../identityinitializationservice/currenttime.mdx | 1 - .../identityinitializationservice/getid.mdx | 1 - .../identityinitializationservice/initid.mdx | 1 - .../topologyaggregationservice/listkeyowners.mdx | 1 - .../topologyaggregationservice/listparties.mdx | 1 - .../topologymanagerreadservice/exporttopologysnapshot.mdx | 1 - .../topologymanagerreadservice/exporttopologysnapshotv2.mdx | 1 - .../topologymanagerreadservice/genesisstate.mdx | 1 - .../topologymanagerreadservice/genesisstatev2.mdx | 1 - .../topologymanagerreadservice/listall.mdx | 1 - .../topologymanagerreadservice/listavailablestores.mdx | 1 - .../listdecentralizednamespacedefinition.mdx | 1 - .../topologymanagerreadservice/listmediatorsynchronizerstate.mdx | 1 - .../topologymanagerreadservice/listnamespacedelegation.mdx | 1 - .../topologymanagerreadservice/listownertokeymapping.mdx | 1 - .../listparticipantsynchronizerpermission.mdx | 1 - .../topologymanagerreadservice/listpartyhostinglimits.mdx | 1 - .../topologymanagerreadservice/listpartytokeymapping.mdx | 1 - .../topologymanagerreadservice/listpartytoparticipant.mdx | 1 - .../listsequencerconnectionsuccessor.mdx | 1 - .../listsequencersynchronizerstate.mdx | 1 - .../listsynchronizerparametersstate.mdx | 1 - .../listsynchronizertrustcertificate.mdx | 1 - .../listsynchronizerupgradeannouncement.mdx | 1 - .../topologymanagerreadservice/listvettedpackages.mdx | 1 - .../topologymanagerreadservice/logicalupgradestate.mdx | 1 - .../topologymanagerwriteservice/addtransactions.mdx | 1 - .../topologymanagerwriteservice/authorize.mdx | 1 - .../topologymanagerwriteservice/createtemporarytopologystore.mdx | 1 - .../topologymanagerwriteservice/droptemporarytopologystore.mdx | 1 - .../topologymanagerwriteservice/generatetransactions.mdx | 1 - .../topologymanagerwriteservice/importtopologysnapshot.mdx | 1 - .../topologymanagerwriteservice/importtopologysnapshotv2.mdx | 1 - .../topologymanagerwriteservice/signtransactions.mdx | 1 - 359 files changed, 359 deletions(-) diff --git a/src/x2mdx/templates/shared/reference_macros.md.j2 b/src/x2mdx/templates/shared/reference_macros.md.j2 index cf5f707..77d9526 100644 --- a/src/x2mdx/templates/shared/reference_macros.md.j2 +++ b/src/x2mdx/templates/shared/reference_macros.md.j2 @@ -198,7 +198,6 @@ {{ escape_html(inline_text(operation.operation_method)) }} {% endif %} {{ escape_html(inline_text(operation.operation_target)) }} - Try it {% endif %} {%- endmacro %} diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/accountschanged.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/accountschanged.mdx index cf82da0..f9944e7 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/accountschanged.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/accountschanged.mdx @@ -57,7 +57,6 @@ title: "accountsChanged" POST JSON-RPC accountsChanged - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/connect.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/connect.mdx index 01a027e..fca57c0 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/connect.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/connect.mdx @@ -57,7 +57,6 @@ title: "connect" POST JSON-RPC connect - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/disconnect.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/disconnect.mdx index 1b2918e..1dc6d23 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/disconnect.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/disconnect.mdx @@ -57,7 +57,6 @@ title: "disconnect" POST JSON-RPC disconnect - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/getactivenetwork.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/getactivenetwork.mdx index 1cd312d..8478d0c 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/getactivenetwork.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/getactivenetwork.mdx @@ -57,7 +57,6 @@ title: "getActiveNetwork" POST JSON-RPC getActiveNetwork - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/getprimaryaccount.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/getprimaryaccount.mdx index c5602ec..a0d62ac 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/getprimaryaccount.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/getprimaryaccount.mdx @@ -57,7 +57,6 @@ title: "getPrimaryAccount" POST JSON-RPC getPrimaryAccount - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/ledgerapi.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/ledgerapi.mdx index 555a77b..57b5c9e 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/ledgerapi.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/ledgerapi.mdx @@ -57,7 +57,6 @@ title: "ledgerApi" POST JSON-RPC ledgerApi - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/listaccounts.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/listaccounts.mdx index a2380f2..5fccca2 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/listaccounts.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/listaccounts.mdx @@ -57,7 +57,6 @@ title: "listAccounts" POST JSON-RPC listAccounts - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/prepareexecute.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/prepareexecute.mdx index 50ba0d0..0047770 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/prepareexecute.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/prepareexecute.mdx @@ -57,7 +57,6 @@ title: "prepareExecute" POST JSON-RPC prepareExecute - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/prepareexecuteandwait.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/prepareexecuteandwait.mdx index c9c3b72..5ada64e 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/prepareexecuteandwait.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/prepareexecuteandwait.mdx @@ -57,7 +57,6 @@ title: "prepareExecuteAndWait" POST JSON-RPC prepareExecuteAndWait - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/signmessage.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/signmessage.mdx index 8fe55c8..2787839 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/signmessage.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/signmessage.mdx @@ -57,7 +57,6 @@ title: "signMessage" POST JSON-RPC signMessage - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/status.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/status.mdx index 7b5b2a7..b9ad690 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/status.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/status.mdx @@ -57,7 +57,6 @@ title: "status" POST JSON-RPC status - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/txchanged.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/txchanged.mdx index d4f9821..fc816cf 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/txchanged.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-api/txchanged.mdx @@ -57,7 +57,6 @@ title: "txChanged" POST JSON-RPC txChanged - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/accountschanged.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/accountschanged.mdx index ac307be..487d8af 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/accountschanged.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/accountschanged.mdx @@ -57,7 +57,6 @@ title: "accountsChanged" POST JSON-RPC accountsChanged - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/connect.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/connect.mdx index cf09b0a..0b3c536 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/connect.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/connect.mdx @@ -57,7 +57,6 @@ title: "connect" POST JSON-RPC connect - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/connected.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/connected.mdx index af5a224..1f5366c 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/connected.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/connected.mdx @@ -57,7 +57,6 @@ title: "connected" POST JSON-RPC connected - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/disconnect.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/disconnect.mdx index f25a4a4..772532d 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/disconnect.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/disconnect.mdx @@ -57,7 +57,6 @@ title: "disconnect" POST JSON-RPC disconnect - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/getactivenetwork.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/getactivenetwork.mdx index ddb26e3..409e478 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/getactivenetwork.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/getactivenetwork.mdx @@ -57,7 +57,6 @@ title: "getActiveNetwork" POST JSON-RPC getActiveNetwork - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/getprimaryaccount.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/getprimaryaccount.mdx index 80b08e2..c387cbe 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/getprimaryaccount.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/getprimaryaccount.mdx @@ -57,7 +57,6 @@ title: "getPrimaryAccount" POST JSON-RPC getPrimaryAccount - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/ledgerapi.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/ledgerapi.mdx index 259884b..d204628 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/ledgerapi.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/ledgerapi.mdx @@ -57,7 +57,6 @@ title: "ledgerApi" POST JSON-RPC ledgerApi - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/listaccounts.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/listaccounts.mdx index f934779..d781d90 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/listaccounts.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/listaccounts.mdx @@ -57,7 +57,6 @@ title: "listAccounts" POST JSON-RPC listAccounts - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/onstatuschanged.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/onstatuschanged.mdx index 55b7b07..ea17e2f 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/onstatuschanged.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/onstatuschanged.mdx @@ -57,7 +57,6 @@ title: "onStatusChanged" POST JSON-RPC onStatusChanged - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/prepareexecute.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/prepareexecute.mdx index 8a73876..5c9cd37 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/prepareexecute.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/prepareexecute.mdx @@ -57,7 +57,6 @@ title: "prepareExecute" POST JSON-RPC prepareExecute - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/signmessage.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/signmessage.mdx index 3da532a..08a26d4 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/signmessage.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/signmessage.mdx @@ -57,7 +57,6 @@ title: "signMessage" POST JSON-RPC signMessage - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/status.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/status.mdx index b331388..7249d59 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/status.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/status.mdx @@ -57,7 +57,6 @@ title: "status" POST JSON-RPC status - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/txchanged.mdx b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/txchanged.mdx index beed3e4..137f6ae 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/txchanged.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/dapp-remote-api/txchanged.mdx @@ -57,7 +57,6 @@ title: "txChanged" POST JSON-RPC txChanged - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/signing-api/createkey.mdx b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/createkey.mdx index 60b123f..bf3f735 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/signing-api/createkey.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/createkey.mdx @@ -57,7 +57,6 @@ title: "createKey" POST JSON-RPC createKey - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/signing-api/getconfiguration.mdx b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/getconfiguration.mdx index 6fc7ae0..37692fd 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/signing-api/getconfiguration.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/getconfiguration.mdx @@ -57,7 +57,6 @@ title: "getConfiguration" POST JSON-RPC getConfiguration - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/signing-api/getkeys.mdx b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/getkeys.mdx index 4936180..d3124ff 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/signing-api/getkeys.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/getkeys.mdx @@ -57,7 +57,6 @@ title: "getKeys" POST JSON-RPC getKeys - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/signing-api/gettransaction.mdx b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/gettransaction.mdx index e13ebb6..8af6b33 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/signing-api/gettransaction.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/gettransaction.mdx @@ -57,7 +57,6 @@ title: "getTransaction" POST JSON-RPC getTransaction - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/signing-api/gettransactions.mdx b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/gettransactions.mdx index 3d00725..ce029b5 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/signing-api/gettransactions.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/gettransactions.mdx @@ -57,7 +57,6 @@ title: "getTransactions" POST JSON-RPC getTransactions - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/signing-api/setconfiguration.mdx b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/setconfiguration.mdx index 13b4130..ed282da 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/signing-api/setconfiguration.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/setconfiguration.mdx @@ -57,7 +57,6 @@ title: "setConfiguration" POST JSON-RPC setConfiguration - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/signing-api/signtransaction.mdx b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/signtransaction.mdx index 1177872..07bcb44 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/signing-api/signtransaction.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/signtransaction.mdx @@ -57,7 +57,6 @@ title: "signTransaction" POST JSON-RPC signTransaction - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/signing-api/subscribetransactions.mdx b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/subscribetransactions.mdx index 51a99a2..0f9fcaf 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/signing-api/subscribetransactions.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/signing-api/subscribetransactions.mdx @@ -57,7 +57,6 @@ title: "subscribeTransactions" POST JSON-RPC subscribeTransactions - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/addidp.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/addidp.mdx index 3ceee4b..cf879d7 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/addidp.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/addidp.mdx @@ -57,7 +57,6 @@ title: "addIdp" POST JSON-RPC addIdp - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/addnetwork.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/addnetwork.mdx index 6ccf3b8..41af149 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/addnetwork.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/addnetwork.mdx @@ -57,7 +57,6 @@ title: "addNetwork" POST JSON-RPC addNetwork - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/addsession.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/addsession.mdx index 1e1007a..14747d2 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/addsession.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/addsession.mdx @@ -57,7 +57,6 @@ title: "addSession" POST JSON-RPC addSession - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/allocatepartyforwallet.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/allocatepartyforwallet.mdx index 8917e9f..3b70771 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/allocatepartyforwallet.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/allocatepartyforwallet.mdx @@ -57,7 +57,6 @@ title: "allocatePartyForWallet" POST JSON-RPC allocatePartyForWallet - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/createwallet.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/createwallet.mdx index f6534e0..011d4ed 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/createwallet.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/createwallet.mdx @@ -59,7 +59,6 @@ title: "createWallet" POST JSON-RPC createWallet - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/deletetransaction.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/deletetransaction.mdx index 2417fde..be7ccef 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/deletetransaction.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/deletetransaction.mdx @@ -57,7 +57,6 @@ title: "deleteTransaction" POST JSON-RPC deleteTransaction - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/execute.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/execute.mdx index 285e84b..67da361 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/execute.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/execute.mdx @@ -57,7 +57,6 @@ title: "execute" POST JSON-RPC execute - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/gettransaction.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/gettransaction.mdx index 473c92c..8daa1d0 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/gettransaction.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/gettransaction.mdx @@ -57,7 +57,6 @@ title: "getTransaction" POST JSON-RPC getTransaction - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/getuser.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/getuser.mdx index aa62d85..97208dd 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/getuser.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/getuser.mdx @@ -57,7 +57,6 @@ title: "getUser" POST JSON-RPC getUser - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/iswalletsyncneeded.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/iswalletsyncneeded.mdx index c471da3..8e87b3f 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/iswalletsyncneeded.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/iswalletsyncneeded.mdx @@ -57,7 +57,6 @@ title: "isWalletSyncNeeded" POST JSON-RPC isWalletSyncNeeded - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/listidps.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/listidps.mdx index c91c59f..f7434d8 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/listidps.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/listidps.mdx @@ -57,7 +57,6 @@ title: "listIdps" POST JSON-RPC listIdps - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/listnetworks.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/listnetworks.mdx index 05e8461..f58a4e5 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/listnetworks.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/listnetworks.mdx @@ -57,7 +57,6 @@ title: "listNetworks" POST JSON-RPC listNetworks - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/listsessions.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/listsessions.mdx index a190164..fe454b7 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/listsessions.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/listsessions.mdx @@ -57,7 +57,6 @@ title: "listSessions" POST JSON-RPC listSessions - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/listtransactions.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/listtransactions.mdx index 0e5cf52..1415906 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/listtransactions.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/listtransactions.mdx @@ -57,7 +57,6 @@ title: "listTransactions" POST JSON-RPC listTransactions - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/listwallets.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/listwallets.mdx index c76044c..60c7f39 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/listwallets.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/listwallets.mdx @@ -57,7 +57,6 @@ title: "listWallets" POST JSON-RPC listWallets - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/removeidp.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/removeidp.mdx index afc81cd..14b3379 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/removeidp.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/removeidp.mdx @@ -57,7 +57,6 @@ title: "removeIdp" POST JSON-RPC removeIdp - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/removenetwork.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/removenetwork.mdx index f863053..763f5f9 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/removenetwork.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/removenetwork.mdx @@ -57,7 +57,6 @@ title: "removeNetwork" POST JSON-RPC removeNetwork - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/removesession.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/removesession.mdx index 7438623..c8d4b7e 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/removesession.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/removesession.mdx @@ -57,7 +57,6 @@ title: "removeSession" POST JSON-RPC removeSession - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/removewallet.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/removewallet.mdx index cd452d2..9a6cada 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/removewallet.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/removewallet.mdx @@ -57,7 +57,6 @@ title: "removeWallet" POST JSON-RPC removeWallet - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/setprimarywallet.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/setprimarywallet.mdx index 598a3d4..88052bc 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/setprimarywallet.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/setprimarywallet.mdx @@ -57,7 +57,6 @@ title: "setPrimaryWallet" POST JSON-RPC setPrimaryWallet - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/sign.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/sign.mdx index 152e80e..c4a9c2b 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/sign.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/sign.mdx @@ -57,7 +57,6 @@ title: "sign" POST JSON-RPC sign - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected/operations/user-api/syncwallets.mdx b/tests/fixtures/characterization/openrpc/expected/operations/user-api/syncwallets.mdx index 67e9ffd..71ed90a 100644 --- a/tests/fixtures/characterization/openrpc/expected/operations/user-api/syncwallets.mdx +++ b/tests/fixtures/characterization/openrpc/expected/operations/user-api/syncwallets.mdx @@ -59,7 +59,6 @@ title: "syncWallets" POST JSON-RPC syncWallets - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/accountschanged.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/accountschanged.mdx index b1ec923..3d1ab49 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/accountschanged.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/accountschanged.mdx @@ -57,7 +57,6 @@ title: "accountsChanged" POST JSON-RPC accountsChanged - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/connect.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/connect.mdx index 7450b79..9527111 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/connect.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/connect.mdx @@ -57,7 +57,6 @@ title: "connect" POST JSON-RPC connect - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/disconnect.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/disconnect.mdx index 48b50cd..e87269a 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/disconnect.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/disconnect.mdx @@ -57,7 +57,6 @@ title: "disconnect" POST JSON-RPC disconnect - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/getactivenetwork.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/getactivenetwork.mdx index d294bd0..d46c489 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/getactivenetwork.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/getactivenetwork.mdx @@ -57,7 +57,6 @@ title: "getActiveNetwork" POST JSON-RPC getActiveNetwork - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/getprimaryaccount.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/getprimaryaccount.mdx index df1e154..c18808a 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/getprimaryaccount.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/getprimaryaccount.mdx @@ -57,7 +57,6 @@ title: "getPrimaryAccount" POST JSON-RPC getPrimaryAccount - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/ledgerapi.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/ledgerapi.mdx index f11ab47..e14fa9c 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/ledgerapi.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/ledgerapi.mdx @@ -57,7 +57,6 @@ title: "ledgerApi" POST JSON-RPC ledgerApi - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/listaccounts.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/listaccounts.mdx index b3762be..9d6db84 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/listaccounts.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/listaccounts.mdx @@ -57,7 +57,6 @@ title: "listAccounts" POST JSON-RPC listAccounts - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/prepareexecute.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/prepareexecute.mdx index c1e93b5..d670692 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/prepareexecute.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/prepareexecute.mdx @@ -57,7 +57,6 @@ title: "prepareExecute" POST JSON-RPC prepareExecute - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/prepareexecuteandwait.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/prepareexecuteandwait.mdx index 536ae10..61beef6 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/prepareexecuteandwait.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/prepareexecuteandwait.mdx @@ -57,7 +57,6 @@ title: "prepareExecuteAndWait" POST JSON-RPC prepareExecuteAndWait - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/signmessage.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/signmessage.mdx index 1decece..4291b1b 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/signmessage.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/signmessage.mdx @@ -57,7 +57,6 @@ title: "signMessage" POST JSON-RPC signMessage - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/status.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/status.mdx index 14f57b0..7452b54 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/status.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/status.mdx @@ -57,7 +57,6 @@ title: "status" POST JSON-RPC status - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/txchanged.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/txchanged.mdx index 03cc79c..8236a9a 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/txchanged.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-api/txchanged.mdx @@ -57,7 +57,6 @@ title: "txChanged" POST JSON-RPC txChanged - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/accountschanged.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/accountschanged.mdx index 79a38f1..d5f7c4d 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/accountschanged.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/accountschanged.mdx @@ -57,7 +57,6 @@ title: "accountsChanged" POST JSON-RPC accountsChanged - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/connect.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/connect.mdx index ba5862e..902aa92 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/connect.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/connect.mdx @@ -57,7 +57,6 @@ title: "connect" POST JSON-RPC connect - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/connected.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/connected.mdx index b7b243f..86d4312 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/connected.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/connected.mdx @@ -57,7 +57,6 @@ title: "connected" POST JSON-RPC connected - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/disconnect.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/disconnect.mdx index ee9cba6..030ae17 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/disconnect.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/disconnect.mdx @@ -57,7 +57,6 @@ title: "disconnect" POST JSON-RPC disconnect - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/getactivenetwork.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/getactivenetwork.mdx index 7835b5b..f2d19ce 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/getactivenetwork.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/getactivenetwork.mdx @@ -57,7 +57,6 @@ title: "getActiveNetwork" POST JSON-RPC getActiveNetwork - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/getprimaryaccount.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/getprimaryaccount.mdx index 68d2e85..61dcabc 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/getprimaryaccount.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/getprimaryaccount.mdx @@ -57,7 +57,6 @@ title: "getPrimaryAccount" POST JSON-RPC getPrimaryAccount - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/ledgerapi.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/ledgerapi.mdx index 326533e..8a6406e 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/ledgerapi.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/ledgerapi.mdx @@ -57,7 +57,6 @@ title: "ledgerApi" POST JSON-RPC ledgerApi - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/listaccounts.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/listaccounts.mdx index 4edc415..8720a4f 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/listaccounts.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/listaccounts.mdx @@ -57,7 +57,6 @@ title: "listAccounts" POST JSON-RPC listAccounts - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/onstatuschanged.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/onstatuschanged.mdx index 29135d9..de5b66c 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/onstatuschanged.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/onstatuschanged.mdx @@ -57,7 +57,6 @@ title: "onStatusChanged" POST JSON-RPC onStatusChanged - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/prepareexecute.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/prepareexecute.mdx index 4c9f464..d0e2ffe 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/prepareexecute.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/prepareexecute.mdx @@ -57,7 +57,6 @@ title: "prepareExecute" POST JSON-RPC prepareExecute - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/signmessage.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/signmessage.mdx index 9597c0c..6b71048 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/signmessage.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/signmessage.mdx @@ -57,7 +57,6 @@ title: "signMessage" POST JSON-RPC signMessage - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/status.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/status.mdx index 973ed22..d01549e 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/status.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/status.mdx @@ -57,7 +57,6 @@ title: "status" POST JSON-RPC status - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/txchanged.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/txchanged.mdx index 0d29c2e..ca74c0d 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/txchanged.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/dapp-remote-api/txchanged.mdx @@ -57,7 +57,6 @@ title: "txChanged" POST JSON-RPC txChanged - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/createkey.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/createkey.mdx index 9ef2b11..d9b08a1 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/createkey.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/createkey.mdx @@ -57,7 +57,6 @@ title: "createKey" POST JSON-RPC createKey - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/getconfiguration.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/getconfiguration.mdx index 78bfd52..113f355 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/getconfiguration.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/getconfiguration.mdx @@ -57,7 +57,6 @@ title: "getConfiguration" POST JSON-RPC getConfiguration - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/getkeys.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/getkeys.mdx index 864ca12..fb87b5a 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/getkeys.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/getkeys.mdx @@ -57,7 +57,6 @@ title: "getKeys" POST JSON-RPC getKeys - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/gettransaction.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/gettransaction.mdx index 666fc9d..0650ebe 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/gettransaction.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/gettransaction.mdx @@ -57,7 +57,6 @@ title: "getTransaction" POST JSON-RPC getTransaction - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/gettransactions.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/gettransactions.mdx index f91ac6e..976695b 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/gettransactions.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/gettransactions.mdx @@ -57,7 +57,6 @@ title: "getTransactions" POST JSON-RPC getTransactions - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/setconfiguration.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/setconfiguration.mdx index 1003554..99622f4 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/setconfiguration.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/setconfiguration.mdx @@ -57,7 +57,6 @@ title: "setConfiguration" POST JSON-RPC setConfiguration - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/signtransaction.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/signtransaction.mdx index 64922d8..fd44132 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/signtransaction.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/signtransaction.mdx @@ -57,7 +57,6 @@ title: "signTransaction" POST JSON-RPC signTransaction - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/subscribetransactions.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/subscribetransactions.mdx index 0af0f84..976712c 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/subscribetransactions.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/signing-api/subscribetransactions.mdx @@ -57,7 +57,6 @@ title: "subscribeTransactions" POST JSON-RPC subscribeTransactions - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/addidp.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/addidp.mdx index 7cf50dd..1f95788 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/addidp.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/addidp.mdx @@ -57,7 +57,6 @@ title: "addIdp" POST JSON-RPC addIdp - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/addnetwork.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/addnetwork.mdx index 9caa25d..5e59cef 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/addnetwork.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/addnetwork.mdx @@ -57,7 +57,6 @@ title: "addNetwork" POST JSON-RPC addNetwork - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/addsession.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/addsession.mdx index e9dac01..fe14839 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/addsession.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/addsession.mdx @@ -57,7 +57,6 @@ title: "addSession" POST JSON-RPC addSession - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/allocatepartyforwallet.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/allocatepartyforwallet.mdx index 2ea90b8..2a9fccd 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/allocatepartyforwallet.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/allocatepartyforwallet.mdx @@ -57,7 +57,6 @@ title: "allocatePartyForWallet" POST JSON-RPC allocatePartyForWallet - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/createwallet.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/createwallet.mdx index d64fb6e..0b2ec54 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/createwallet.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/createwallet.mdx @@ -59,7 +59,6 @@ title: "createWallet" POST JSON-RPC createWallet - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/deletetransaction.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/deletetransaction.mdx index 2f21696..0810b3d 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/deletetransaction.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/deletetransaction.mdx @@ -57,7 +57,6 @@ title: "deleteTransaction" POST JSON-RPC deleteTransaction - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/execute.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/execute.mdx index 2bcb10a..49e9998 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/execute.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/execute.mdx @@ -57,7 +57,6 @@ title: "execute" POST JSON-RPC execute - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/gettransaction.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/gettransaction.mdx index 976b069..5812009 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/gettransaction.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/gettransaction.mdx @@ -57,7 +57,6 @@ title: "getTransaction" POST JSON-RPC getTransaction - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/getuser.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/getuser.mdx index ef71020..786a60b 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/getuser.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/getuser.mdx @@ -57,7 +57,6 @@ title: "getUser" POST JSON-RPC getUser - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/iswalletsyncneeded.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/iswalletsyncneeded.mdx index 05e59af..313b88e 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/iswalletsyncneeded.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/iswalletsyncneeded.mdx @@ -57,7 +57,6 @@ title: "isWalletSyncNeeded" POST JSON-RPC isWalletSyncNeeded - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listidps.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listidps.mdx index 4deaa0d..7e89525 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listidps.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listidps.mdx @@ -57,7 +57,6 @@ title: "listIdps" POST JSON-RPC listIdps - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listnetworks.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listnetworks.mdx index 64b15b8..35939e3 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listnetworks.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listnetworks.mdx @@ -57,7 +57,6 @@ title: "listNetworks" POST JSON-RPC listNetworks - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listsessions.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listsessions.mdx index d039141..5322a4c 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listsessions.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listsessions.mdx @@ -57,7 +57,6 @@ title: "listSessions" POST JSON-RPC listSessions - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listtransactions.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listtransactions.mdx index 87f7f15..ccd405c 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listtransactions.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listtransactions.mdx @@ -57,7 +57,6 @@ title: "listTransactions" POST JSON-RPC listTransactions - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listwallets.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listwallets.mdx index 30481a3..d7ec234 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listwallets.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/listwallets.mdx @@ -57,7 +57,6 @@ title: "listWallets" POST JSON-RPC listWallets - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removeidp.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removeidp.mdx index 280c8ff..dc3d823 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removeidp.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removeidp.mdx @@ -57,7 +57,6 @@ title: "removeIdp" POST JSON-RPC removeIdp - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removenetwork.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removenetwork.mdx index f570d7b..f736b7d 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removenetwork.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removenetwork.mdx @@ -57,7 +57,6 @@ title: "removeNetwork" POST JSON-RPC removeNetwork - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removesession.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removesession.mdx index 19339d2..9f0998d 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removesession.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removesession.mdx @@ -57,7 +57,6 @@ title: "removeSession" POST JSON-RPC removeSession - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removewallet.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removewallet.mdx index e87254c..4798e12 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removewallet.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/removewallet.mdx @@ -57,7 +57,6 @@ title: "removeWallet" POST JSON-RPC removeWallet - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/setprimarywallet.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/setprimarywallet.mdx index b3338c0..34a500a 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/setprimarywallet.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/setprimarywallet.mdx @@ -57,7 +57,6 @@ title: "setPrimaryWallet" POST JSON-RPC setPrimaryWallet - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/sign.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/sign.mdx index 683f2e1..1d58bda 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/sign.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/sign.mdx @@ -57,7 +57,6 @@ title: "sign" POST JSON-RPC sign - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/syncwallets.mdx b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/syncwallets.mdx index b1ee07f..6c01ed4 100644 --- a/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/syncwallets.mdx +++ b/tests/fixtures/characterization/openrpc/expected_alt_layout/operations/user-api/syncwallets.mdx @@ -59,7 +59,6 @@ title: "syncWallets" POST JSON-RPC syncWallets - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/commandinspectionservice/getcommandstatus.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/commandinspectionservice/getcommandstatus.mdx index 824cfbd..8415703 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/commandinspectionservice/getcommandstatus.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/commandinspectionservice/getcommandstatus.mdx @@ -64,7 +64,6 @@ title: "GetCommandStatus" RPC /com.daml.ledger.api.v2.admin.CommandInspectionService/GetCommandStatus - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/createidentityproviderconfig.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/createidentityproviderconfig.mdx index 1496d6e..7cdca95 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/createidentityproviderconfig.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/createidentityproviderconfig.mdx @@ -64,7 +64,6 @@ title: "CreateIdentityProviderConfig" RPC /com.daml.ledger.api.v2.admin.IdentityProviderConfigService/CreateIdentityProviderConfig - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/deleteidentityproviderconfig.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/deleteidentityproviderconfig.mdx index 9eb272a..a9cd62b 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/deleteidentityproviderconfig.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/deleteidentityproviderconfig.mdx @@ -64,7 +64,6 @@ title: "DeleteIdentityProviderConfig" RPC /com.daml.ledger.api.v2.admin.IdentityProviderConfigService/DeleteIdentityProviderConfig - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/getidentityproviderconfig.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/getidentityproviderconfig.mdx index 9682f2f..d5c4133 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/getidentityproviderconfig.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/getidentityproviderconfig.mdx @@ -64,7 +64,6 @@ title: "GetIdentityProviderConfig" RPC /com.daml.ledger.api.v2.admin.IdentityProviderConfigService/GetIdentityProviderConfig - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/listidentityproviderconfigs.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/listidentityproviderconfigs.mdx index d77a466..bcc72c8 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/listidentityproviderconfigs.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/listidentityproviderconfigs.mdx @@ -64,7 +64,6 @@ title: "ListIdentityProviderConfigs" RPC /com.daml.ledger.api.v2.admin.IdentityProviderConfigService/ListIdentityProviderConfigs - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/updateidentityproviderconfig.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/updateidentityproviderconfig.mdx index 0c774c4..0d8721c 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/updateidentityproviderconfig.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/identityproviderconfigservice/updateidentityproviderconfig.mdx @@ -64,7 +64,6 @@ title: "UpdateIdentityProviderConfig" RPC /com.daml.ledger.api.v2.admin.IdentityProviderConfigService/UpdateIdentityProviderConfig - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/listknownpackages.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/listknownpackages.mdx index 64a43b5..1ce1e64 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/listknownpackages.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/listknownpackages.mdx @@ -64,7 +64,6 @@ title: "ListKnownPackages" RPC /com.daml.ledger.api.v2.admin.PackageManagementService/ListKnownPackages - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/updatevettedpackages.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/updatevettedpackages.mdx index 676f7fa..4b22705 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/updatevettedpackages.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/updatevettedpackages.mdx @@ -64,7 +64,6 @@ title: "UpdateVettedPackages" RPC /com.daml.ledger.api.v2.admin.PackageManagementService/UpdateVettedPackages - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/uploaddarfile.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/uploaddarfile.mdx index 165d1ed..210f99a 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/uploaddarfile.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/uploaddarfile.mdx @@ -64,7 +64,6 @@ title: "UploadDarFile" RPC /com.daml.ledger.api.v2.admin.PackageManagementService/UploadDarFile - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/validatedarfile.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/validatedarfile.mdx index 8c300fd..118f31e 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/validatedarfile.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/packagemanagementservice/validatedarfile.mdx @@ -64,7 +64,6 @@ title: "ValidateDarFile" RPC /com.daml.ledger.api.v2.admin.PackageManagementService/ValidateDarFile - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/participantpruningservice/prune.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/participantpruningservice/prune.mdx index 7ee54f6..44fc5a0 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/participantpruningservice/prune.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/participantpruningservice/prune.mdx @@ -64,7 +64,6 @@ title: "Prune" RPC /com.daml.ledger.api.v2.admin.ParticipantPruningService/Prune - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/allocateexternalparty.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/allocateexternalparty.mdx index 83da951..b0e2024 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/allocateexternalparty.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/allocateexternalparty.mdx @@ -64,7 +64,6 @@ title: "AllocateExternalParty" RPC /com.daml.ledger.api.v2.admin.PartyManagementService/AllocateExternalParty - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/allocateparty.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/allocateparty.mdx index b64323b..1f4658c 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/allocateparty.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/allocateparty.mdx @@ -64,7 +64,6 @@ title: "AllocateParty" RPC /com.daml.ledger.api.v2.admin.PartyManagementService/AllocateParty - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/generateexternalpartytopology.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/generateexternalpartytopology.mdx index 05c00cf..3c6f502 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/generateexternalpartytopology.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/generateexternalpartytopology.mdx @@ -64,7 +64,6 @@ title: "GenerateExternalPartyTopology" RPC /com.daml.ledger.api.v2.admin.PartyManagementService/GenerateExternalPartyTopology - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/getparticipantid.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/getparticipantid.mdx index 4753026..ffaa27f 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/getparticipantid.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/getparticipantid.mdx @@ -64,7 +64,6 @@ title: "GetParticipantId" RPC /com.daml.ledger.api.v2.admin.PartyManagementService/GetParticipantId - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/getparties.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/getparties.mdx index 4311005..b79c136 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/getparties.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/getparties.mdx @@ -64,7 +64,6 @@ title: "GetParties" RPC /com.daml.ledger.api.v2.admin.PartyManagementService/GetParties - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/listknownparties.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/listknownparties.mdx index dc2ea18..2cf53f5 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/listknownparties.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/listknownparties.mdx @@ -64,7 +64,6 @@ title: "ListKnownParties" RPC /com.daml.ledger.api.v2.admin.PartyManagementService/ListKnownParties - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/updatepartydetails.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/updatepartydetails.mdx index a5cacf1..bc1438b 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/updatepartydetails.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/updatepartydetails.mdx @@ -64,7 +64,6 @@ title: "UpdatePartyDetails" RPC /com.daml.ledger.api.v2.admin.PartyManagementService/UpdatePartyDetails - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/updatepartyidentityproviderid.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/updatepartyidentityproviderid.mdx index dbabe89..7f8ebbb 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/updatepartyidentityproviderid.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/partymanagementservice/updatepartyidentityproviderid.mdx @@ -64,7 +64,6 @@ title: "UpdatePartyIdentityProviderId" RPC /com.daml.ledger.api.v2.admin.PartyManagementService/UpdatePartyIdentityProviderId - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/createuser.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/createuser.mdx index 09aaf8e..7defc92 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/createuser.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/createuser.mdx @@ -64,7 +64,6 @@ title: "CreateUser" RPC /com.daml.ledger.api.v2.admin.UserManagementService/CreateUser - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/deleteuser.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/deleteuser.mdx index a582496..19373d8 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/deleteuser.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/deleteuser.mdx @@ -64,7 +64,6 @@ title: "DeleteUser" RPC /com.daml.ledger.api.v2.admin.UserManagementService/DeleteUser - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/getuser.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/getuser.mdx index 4e95fac..240319e 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/getuser.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/getuser.mdx @@ -64,7 +64,6 @@ title: "GetUser" RPC /com.daml.ledger.api.v2.admin.UserManagementService/GetUser - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/grantuserrights.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/grantuserrights.mdx index 1adb351..11e140a 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/grantuserrights.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/grantuserrights.mdx @@ -64,7 +64,6 @@ title: "GrantUserRights" RPC /com.daml.ledger.api.v2.admin.UserManagementService/GrantUserRights - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/listuserrights.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/listuserrights.mdx index 5056d8c..f44c498 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/listuserrights.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/listuserrights.mdx @@ -64,7 +64,6 @@ title: "ListUserRights" RPC /com.daml.ledger.api.v2.admin.UserManagementService/ListUserRights - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/listusers.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/listusers.mdx index 5dc1638..c3b4fb2 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/listusers.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/listusers.mdx @@ -64,7 +64,6 @@ title: "ListUsers" RPC /com.daml.ledger.api.v2.admin.UserManagementService/ListUsers - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/revokeuserrights.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/revokeuserrights.mdx index 91f4e48..a7796e4 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/revokeuserrights.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/revokeuserrights.mdx @@ -64,7 +64,6 @@ title: "RevokeUserRights" RPC /com.daml.ledger.api.v2.admin.UserManagementService/RevokeUserRights - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/updateuser.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/updateuser.mdx index e10e6f1..1835469 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/updateuser.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/updateuser.mdx @@ -64,7 +64,6 @@ title: "UpdateUser" RPC /com.daml.ledger.api.v2.admin.UserManagementService/UpdateUser - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/updateuseridentityproviderid.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/updateuseridentityproviderid.mdx index d8de10e..73a04d5 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/updateuseridentityproviderid.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-admin/usermanagementservice/updateuseridentityproviderid.mdx @@ -64,7 +64,6 @@ title: "UpdateUserIdentityProviderId" RPC /com.daml.ledger.api.v2.admin.UserManagementService/UpdateUserIdentityProviderId - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/executesubmission.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/executesubmission.mdx index 6d12563..3584b1e 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/executesubmission.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/executesubmission.mdx @@ -64,7 +64,6 @@ title: "ExecuteSubmission" RPC /com.daml.ledger.api.v2.interactive.InteractiveSubmissionService/ExecuteSubmission - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/executesubmissionandwait.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/executesubmissionandwait.mdx index fed33a2..b1a75c4 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/executesubmissionandwait.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/executesubmissionandwait.mdx @@ -64,7 +64,6 @@ title: "ExecuteSubmissionAndWait" RPC /com.daml.ledger.api.v2.interactive.InteractiveSubmissionService/ExecuteSubmissionAndWait - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/executesubmissionandwaitfortransaction.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/executesubmissionandwaitfortransaction.mdx index 30900f9..5ab2608 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/executesubmissionandwaitfortransaction.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/executesubmissionandwaitfortransaction.mdx @@ -64,7 +64,6 @@ title: "ExecuteSubmissionAndWaitForTransaction" RPC /com.daml.ledger.api.v2.interactive.InteractiveSubmissionService/ExecuteSubmissionAndWaitForTransaction - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/getpreferredpackages.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/getpreferredpackages.mdx index fee480b..cd216c9 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/getpreferredpackages.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/getpreferredpackages.mdx @@ -64,7 +64,6 @@ title: "GetPreferredPackages" RPC /com.daml.ledger.api.v2.interactive.InteractiveSubmissionService/GetPreferredPackages - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/getpreferredpackageversion.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/getpreferredpackageversion.mdx index e35b15c..8a67f4e 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/getpreferredpackageversion.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/getpreferredpackageversion.mdx @@ -64,7 +64,6 @@ title: "GetPreferredPackageVersion" RPC /com.daml.ledger.api.v2.interactive.InteractiveSubmissionService/GetPreferredPackageVersion - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/preparesubmission.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/preparesubmission.mdx index bb36516..51b350d 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/preparesubmission.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2-interactive/interactivesubmissionservice/preparesubmission.mdx @@ -64,7 +64,6 @@ title: "PrepareSubmission" RPC /com.daml.ledger.api.v2.interactive.InteractiveSubmissionService/PrepareSubmission - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandcompletionservice/completionstream.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandcompletionservice/completionstream.mdx index 54d49b1..f0a41aa 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandcompletionservice/completionstream.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandcompletionservice/completionstream.mdx @@ -64,7 +64,6 @@ title: "CompletionStream" RPC /com.daml.ledger.api.v2.CommandCompletionService/CompletionStream - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandservice/submitandwait.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandservice/submitandwait.mdx index 2668d6d..0dda1c1 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandservice/submitandwait.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandservice/submitandwait.mdx @@ -64,7 +64,6 @@ title: "SubmitAndWait" RPC /com.daml.ledger.api.v2.CommandService/SubmitAndWait - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandservice/submitandwaitforreassignment.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandservice/submitandwaitforreassignment.mdx index a252d25..cb84a09 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandservice/submitandwaitforreassignment.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandservice/submitandwaitforreassignment.mdx @@ -64,7 +64,6 @@ title: "SubmitAndWaitForReassignment" RPC /com.daml.ledger.api.v2.CommandService/SubmitAndWaitForReassignment - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandservice/submitandwaitfortransaction.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandservice/submitandwaitfortransaction.mdx index d8b683b..cc73b0b 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandservice/submitandwaitfortransaction.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandservice/submitandwaitfortransaction.mdx @@ -64,7 +64,6 @@ title: "SubmitAndWaitForTransaction" RPC /com.daml.ledger.api.v2.CommandService/SubmitAndWaitForTransaction - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandsubmissionservice/submit.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandsubmissionservice/submit.mdx index 411416b..4b20b18 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandsubmissionservice/submit.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandsubmissionservice/submit.mdx @@ -64,7 +64,6 @@ title: "Submit" RPC /com.daml.ledger.api.v2.CommandSubmissionService/Submit - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandsubmissionservice/submitreassignment.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandsubmissionservice/submitreassignment.mdx index dbef0c2..efcdf71 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandsubmissionservice/submitreassignment.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/commandsubmissionservice/submitreassignment.mdx @@ -64,7 +64,6 @@ title: "SubmitReassignment" RPC /com.daml.ledger.api.v2.CommandSubmissionService/SubmitReassignment - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/contractservice/getcontract.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/contractservice/getcontract.mdx index 468de72..e4ceb5f 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/contractservice/getcontract.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/contractservice/getcontract.mdx @@ -64,7 +64,6 @@ title: "GetContract" RPC /com.daml.ledger.api.v2.ContractService/GetContract - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/eventqueryservice/geteventsbycontractid.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/eventqueryservice/geteventsbycontractid.mdx index 86c3352..4b6fe8c 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/eventqueryservice/geteventsbycontractid.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/eventqueryservice/geteventsbycontractid.mdx @@ -64,7 +64,6 @@ title: "GetEventsByContractId" RPC /com.daml.ledger.api.v2.EventQueryService/GetEventsByContractId - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/getpackage.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/getpackage.mdx index ab637a6..6bcc71b 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/getpackage.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/getpackage.mdx @@ -64,7 +64,6 @@ title: "GetPackage" RPC /com.daml.ledger.api.v2.PackageService/GetPackage - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/getpackagestatus.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/getpackagestatus.mdx index 070d7dd..d00388b 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/getpackagestatus.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/getpackagestatus.mdx @@ -64,7 +64,6 @@ title: "GetPackageStatus" RPC /com.daml.ledger.api.v2.PackageService/GetPackageStatus - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/listpackages.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/listpackages.mdx index 307a58a..5d1a2c9 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/listpackages.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/listpackages.mdx @@ -64,7 +64,6 @@ title: "ListPackages" RPC /com.daml.ledger.api.v2.PackageService/ListPackages - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/listvettedpackages.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/listvettedpackages.mdx index c3e6e02..c00e6e2 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/listvettedpackages.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/packageservice/listvettedpackages.mdx @@ -64,7 +64,6 @@ title: "ListVettedPackages" RPC /com.daml.ledger.api.v2.PackageService/ListVettedPackages - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getactivecontracts.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getactivecontracts.mdx index f79fe61..0809ccb 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getactivecontracts.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getactivecontracts.mdx @@ -64,7 +64,6 @@ title: "GetActiveContracts" RPC /com.daml.ledger.api.v2.StateService/GetActiveContracts - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getconnectedsynchronizers.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getconnectedsynchronizers.mdx index 2094a28..904e3f6 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getconnectedsynchronizers.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getconnectedsynchronizers.mdx @@ -64,7 +64,6 @@ title: "GetConnectedSynchronizers" RPC /com.daml.ledger.api.v2.StateService/GetConnectedSynchronizers - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getlatestprunedoffsets.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getlatestprunedoffsets.mdx index 38afc80..007d04f 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getlatestprunedoffsets.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getlatestprunedoffsets.mdx @@ -64,7 +64,6 @@ title: "GetLatestPrunedOffsets" RPC /com.daml.ledger.api.v2.StateService/GetLatestPrunedOffsets - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getledgerend.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getledgerend.mdx index ab74cff..de62e9f 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getledgerend.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/stateservice/getledgerend.mdx @@ -64,7 +64,6 @@ title: "GetLedgerEnd" RPC /com.daml.ledger.api.v2.StateService/GetLedgerEnd - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/updateservice/getupdatebyid.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/updateservice/getupdatebyid.mdx index 0c93ee9..4ba458b 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/updateservice/getupdatebyid.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/updateservice/getupdatebyid.mdx @@ -64,7 +64,6 @@ title: "GetUpdateById" RPC /com.daml.ledger.api.v2.UpdateService/GetUpdateById - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/updateservice/getupdatebyoffset.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/updateservice/getupdatebyoffset.mdx index f856ead..9757c60 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/updateservice/getupdatebyoffset.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/updateservice/getupdatebyoffset.mdx @@ -64,7 +64,6 @@ title: "GetUpdateByOffset" RPC /com.daml.ledger.api.v2.UpdateService/GetUpdateByOffset - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/updateservice/getupdates.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/updateservice/getupdates.mdx index 2a759c8..42f9e15 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/updateservice/getupdates.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/updateservice/getupdates.mdx @@ -64,7 +64,6 @@ title: "GetUpdates" RPC /com.daml.ledger.api.v2.UpdateService/GetUpdates - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/versionservice/getledgerapiversion.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/versionservice/getledgerapiversion.mdx index 50d3396..c05d3f5 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/versionservice/getledgerapiversion.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-daml-ledger-api-v2/versionservice/getledgerapiversion.mdx @@ -64,7 +64,6 @@ title: "GetLedgerApiVersion" RPC /com.daml.ledger.api.v2.VersionService/GetLedgerApiVersion - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/getlasterrors.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/getlasterrors.mdx index 339ec32..60d9a64 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/getlasterrors.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/getlasterrors.mdx @@ -64,7 +64,6 @@ title: "GetLastErrors" RPC /com.digitalasset.canton.admin.health.v30.StatusService/GetLastErrors - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/getlasterrortrace.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/getlasterrortrace.mdx index 43cfba6..79d0525 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/getlasterrortrace.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/getlasterrortrace.mdx @@ -64,7 +64,6 @@ title: "GetLastErrorTrace" RPC /com.digitalasset.canton.admin.health.v30.StatusService/GetLastErrorTrace - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/healthdump.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/healthdump.mdx index db92f1d..4acdaf0 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/healthdump.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/healthdump.mdx @@ -64,7 +64,6 @@ title: "HealthDump" RPC /com.digitalasset.canton.admin.health.v30.StatusService/HealthDump - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/setloglevel.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/setloglevel.mdx index ddac348..aa24280 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/setloglevel.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-health-v30/statusservice/setloglevel.mdx @@ -64,7 +64,6 @@ title: "SetLogLevel" RPC /com.digitalasset.canton.admin.health.v30.StatusService/SetLogLevel - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-mediator-v30/mediatorstatusservice/mediatorstatus.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-mediator-v30/mediatorstatusservice/mediatorstatus.mdx index 4a38a66..c4c8c7d 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-mediator-v30/mediatorstatusservice/mediatorstatus.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-mediator-v30/mediatorstatusservice/mediatorstatus.mdx @@ -64,7 +64,6 @@ title: "MediatorStatus" RPC /com.digitalasset.canton.admin.mediator.v30.MediatorStatusService/MediatorStatus - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/enterpriseparticipantreplicationservice/setpassive.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/enterpriseparticipantreplicationservice/setpassive.mdx index 5142e6a..ed00117 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/enterpriseparticipantreplicationservice/setpassive.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/enterpriseparticipantreplicationservice/setpassive.mdx @@ -64,7 +64,6 @@ title: "SetPassive" RPC /com.digitalasset.canton.admin.participant.v30.EnterpriseParticipantReplicationService/SetPassive - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getdar.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getdar.mdx index ed97f88..a3d14d0 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getdar.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getdar.mdx @@ -64,7 +64,6 @@ title: "GetDar" RPC /com.digitalasset.canton.admin.participant.v30.PackageService/GetDar - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getdarcontents.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getdarcontents.mdx index 8d0dfc7..da8e15b 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getdarcontents.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getdarcontents.mdx @@ -64,7 +64,6 @@ title: "GetDarContents" RPC /com.digitalasset.canton.admin.participant.v30.PackageService/GetDarContents - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getpackagecontents.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getpackagecontents.mdx index 8b09d76..b410649 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getpackagecontents.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getpackagecontents.mdx @@ -64,7 +64,6 @@ title: "GetPackageContents" RPC /com.digitalasset.canton.admin.participant.v30.PackageService/GetPackageContents - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getpackagereferences.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getpackagereferences.mdx index 6995a18..a681408 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getpackagereferences.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/getpackagereferences.mdx @@ -64,7 +64,6 @@ title: "GetPackageReferences" RPC /com.digitalasset.canton.admin.participant.v30.PackageService/GetPackageReferences - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/listdars.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/listdars.mdx index b94c2bd..c8fa0c0 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/listdars.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/listdars.mdx @@ -64,7 +64,6 @@ title: "ListDars" RPC /com.digitalasset.canton.admin.participant.v30.PackageService/ListDars - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/listpackages.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/listpackages.mdx index e10853e..881815c 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/listpackages.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/listpackages.mdx @@ -64,7 +64,6 @@ title: "ListPackages" RPC /com.digitalasset.canton.admin.participant.v30.PackageService/ListPackages - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/removedar.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/removedar.mdx index 0491808..a387e13 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/removedar.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/removedar.mdx @@ -64,7 +64,6 @@ title: "RemoveDar" RPC /com.digitalasset.canton.admin.participant.v30.PackageService/RemoveDar - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/removepackage.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/removepackage.mdx index e853dbb..c20cf9f 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/removepackage.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/removepackage.mdx @@ -64,7 +64,6 @@ title: "RemovePackage" RPC /com.digitalasset.canton.admin.participant.v30.PackageService/RemovePackage - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/unvetdar.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/unvetdar.mdx index cc624ed..9c1defc 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/unvetdar.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/unvetdar.mdx @@ -64,7 +64,6 @@ title: "UnvetDar" RPC /com.digitalasset.canton.admin.participant.v30.PackageService/UnvetDar - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/uploaddar.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/uploaddar.mdx index 4ccf2c4..57fa3f3 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/uploaddar.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/uploaddar.mdx @@ -64,7 +64,6 @@ title: "UploadDar" RPC /com.digitalasset.canton.admin.participant.v30.PackageService/UploadDar - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/validatedar.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/validatedar.mdx index e960033..2edca01 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/validatedar.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/validatedar.mdx @@ -64,7 +64,6 @@ title: "ValidateDar" RPC /com.digitalasset.canton.admin.participant.v30.PackageService/ValidateDar - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/vetdar.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/vetdar.mdx index 083ee3d..67595c2 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/vetdar.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/packageservice/vetdar.mdx @@ -64,7 +64,6 @@ title: "VetDar" RPC /com.digitalasset.canton.admin.participant.v30.PackageService/VetDar - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/countinflight.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/countinflight.mdx index d7f3692..ec1f53e 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/countinflight.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/countinflight.mdx @@ -64,7 +64,6 @@ title: "CountInFlight" RPC /com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/CountInFlight - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/getconfigforslowcounterparticipants.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/getconfigforslowcounterparticipants.mdx index 0e2a268..86a987d 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/getconfigforslowcounterparticipants.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/getconfigforslowcounterparticipants.mdx @@ -64,7 +64,6 @@ title: "GetConfigForSlowCounterParticipants" RPC /com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/GetConfigForSlowCounterParticipants - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/getintervalsbehindforcounterparticipants.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/getintervalsbehindforcounterparticipants.mdx index 67df874..48315c6 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/getintervalsbehindforcounterparticipants.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/getintervalsbehindforcounterparticipants.mdx @@ -64,7 +64,6 @@ title: "GetIntervalsBehindForCounterParticipants" RPC /com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/GetIntervalsBehindForCounterParticipants - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/inspectcommitmentcontracts.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/inspectcommitmentcontracts.mdx index e71d622..a5365f8 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/inspectcommitmentcontracts.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/inspectcommitmentcontracts.mdx @@ -64,7 +64,6 @@ title: "InspectCommitmentContracts" RPC /com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/InspectCommitmentContracts - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/lookupoffsetbytime.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/lookupoffsetbytime.mdx index d29d839..2116c4b 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/lookupoffsetbytime.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/lookupoffsetbytime.mdx @@ -64,7 +64,6 @@ title: "LookupOffsetByTime" RPC /com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/LookupOffsetByTime - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/lookupreceivedacscommitments.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/lookupreceivedacscommitments.mdx index 623b7d4..cfac008 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/lookupreceivedacscommitments.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/lookupreceivedacscommitments.mdx @@ -64,7 +64,6 @@ title: "LookupReceivedAcsCommitments" RPC /com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/LookupReceivedAcsCommitments - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/lookupsentacscommitments.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/lookupsentacscommitments.mdx index 3d1e2da..cfcb122 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/lookupsentacscommitments.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/lookupsentacscommitments.mdx @@ -64,7 +64,6 @@ title: "LookupSentAcsCommitments" RPC /com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/LookupSentAcsCommitments - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/opencommitment.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/opencommitment.mdx index 234f344..e7f4128 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/opencommitment.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/opencommitment.mdx @@ -64,7 +64,6 @@ title: "OpenCommitment" RPC /com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/OpenCommitment - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/setconfigforslowcounterparticipants.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/setconfigforslowcounterparticipants.mdx index 0f5cb1d..48a7fb6 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/setconfigforslowcounterparticipants.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantinspectionservice/setconfigforslowcounterparticipants.mdx @@ -64,7 +64,6 @@ title: "SetConfigForSlowCounterParticipants" RPC /com.digitalasset.canton.admin.participant.v30.ParticipantInspectionService/SetConfigForSlowCounterParticipants - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/changeassignation.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/changeassignation.mdx index 5f1b46a..d574d10 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/changeassignation.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/changeassignation.mdx @@ -64,7 +64,6 @@ title: "ChangeAssignation" RPC /com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/ChangeAssignation - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/exportacs.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/exportacs.mdx index 81c5254..10f6d7d 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/exportacs.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/exportacs.mdx @@ -64,7 +64,6 @@ title: "ExportAcs" RPC /com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/ExportAcs - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/exportacsold.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/exportacsold.mdx index 5b68753..e29228a 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/exportacsold.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/exportacsold.mdx @@ -64,7 +64,6 @@ title: "ExportAcsOld" RPC /com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/ExportAcsOld - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/ignoreevents.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/ignoreevents.mdx index d241727..6240df2 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/ignoreevents.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/ignoreevents.mdx @@ -64,7 +64,6 @@ title: "IgnoreEvents" RPC /com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/IgnoreEvents - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/importacs.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/importacs.mdx index 85a7b1a..424c8be 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/importacs.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/importacs.mdx @@ -64,7 +64,6 @@ title: "ImportAcs" RPC /com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/ImportAcs - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/importacsold.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/importacsold.mdx index 5e1387e..dd4278a 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/importacsold.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/importacsold.mdx @@ -64,7 +64,6 @@ title: "ImportAcsOld" RPC /com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/ImportAcsOld - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/migratesynchronizer.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/migratesynchronizer.mdx index 8eb4e63..f1ba2f8 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/migratesynchronizer.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/migratesynchronizer.mdx @@ -64,7 +64,6 @@ title: "MigrateSynchronizer" RPC /com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/MigrateSynchronizer - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/purgecontracts.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/purgecontracts.mdx index d10d071..b1e5b37 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/purgecontracts.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/purgecontracts.mdx @@ -64,7 +64,6 @@ title: "PurgeContracts" RPC /com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/PurgeContracts - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/purgedeactivatedsynchronizer.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/purgedeactivatedsynchronizer.mdx index c423a42..fb881fe 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/purgedeactivatedsynchronizer.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/purgedeactivatedsynchronizer.mdx @@ -64,7 +64,6 @@ title: "PurgeDeactivatedSynchronizer" RPC /com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/PurgeDeactivatedSynchronizer - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/repaircommitmentsusingacs.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/repaircommitmentsusingacs.mdx index acdad9c..db078a8 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/repaircommitmentsusingacs.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/repaircommitmentsusingacs.mdx @@ -64,7 +64,6 @@ title: "RepairCommitmentsUsingAcs" RPC /com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/RepairCommitmentsUsingAcs - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/rollbackunassignment.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/rollbackunassignment.mdx index 2094694..95192f7 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/rollbackunassignment.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/rollbackunassignment.mdx @@ -64,7 +64,6 @@ title: "RollbackUnassignment" RPC /com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/RollbackUnassignment - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/unignoreevents.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/unignoreevents.mdx index bd13dc9..a485c47 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/unignoreevents.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantrepairservice/unignoreevents.mdx @@ -64,7 +64,6 @@ title: "UnignoreEvents" RPC /com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/UnignoreEvents - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantstatusservice/participantstatus.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantstatusservice/participantstatus.mdx index 90df27b..2d814f3 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantstatusservice/participantstatus.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/participantstatusservice/participantstatus.mdx @@ -64,7 +64,6 @@ title: "ParticipantStatus" RPC /com.digitalasset.canton.admin.participant.v30.ParticipantStatusService/ParticipantStatus - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/addpartyasync.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/addpartyasync.mdx index 9dbb3cf..1d45126 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/addpartyasync.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/addpartyasync.mdx @@ -64,7 +64,6 @@ title: "AddPartyAsync" RPC /com.digitalasset.canton.admin.participant.v30.PartyManagementService/AddPartyAsync - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/clearpartyonboardingflag.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/clearpartyonboardingflag.mdx index 17aa282..4ce6160 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/clearpartyonboardingflag.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/clearpartyonboardingflag.mdx @@ -64,7 +64,6 @@ title: "ClearPartyOnboardingFlag" RPC /com.digitalasset.canton.admin.participant.v30.PartyManagementService/ClearPartyOnboardingFlag - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/exportpartyacs.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/exportpartyacs.mdx index cacb8ec..77b1b96 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/exportpartyacs.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/exportpartyacs.mdx @@ -64,7 +64,6 @@ title: "ExportPartyAcs" RPC /com.digitalasset.canton.admin.participant.v30.PartyManagementService/ExportPartyAcs - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/getaddpartystatus.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/getaddpartystatus.mdx index 096627f..ef78dca 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/getaddpartystatus.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/getaddpartystatus.mdx @@ -64,7 +64,6 @@ title: "GetAddPartyStatus" RPC /com.digitalasset.canton.admin.participant.v30.PartyManagementService/GetAddPartyStatus - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/gethighestoffsetbytimestamp.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/gethighestoffsetbytimestamp.mdx index 5abe69c..2462197 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/gethighestoffsetbytimestamp.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/gethighestoffsetbytimestamp.mdx @@ -64,7 +64,6 @@ title: "GetHighestOffsetByTimestamp" RPC /com.digitalasset.canton.admin.participant.v30.PartyManagementService/GetHighestOffsetByTimestamp - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/importpartyacs.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/importpartyacs.mdx index 428f581..f257af0 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/importpartyacs.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/partymanagementservice/importpartyacs.mdx @@ -64,7 +64,6 @@ title: "ImportPartyAcs" RPC /com.digitalasset.canton.admin.participant.v30.PartyManagementService/ImportPartyAcs - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pingservice/ping.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pingservice/ping.mdx index 79f1ba8..a98a87f 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pingservice/ping.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pingservice/ping.mdx @@ -64,7 +64,6 @@ title: "Ping" RPC /com.digitalasset.canton.admin.participant.v30.PingService/Ping - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/clearschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/clearschedule.mdx index 6299a27..37268be 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/clearschedule.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/clearschedule.mdx @@ -64,7 +64,6 @@ title: "ClearSchedule" RPC /com.digitalasset.canton.admin.participant.v30.PruningService/ClearSchedule - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getnowaitcommitmentsfrom.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getnowaitcommitmentsfrom.mdx index 222400c..30bd4bd 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getnowaitcommitmentsfrom.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getnowaitcommitmentsfrom.mdx @@ -64,7 +64,6 @@ title: "GetNoWaitCommitmentsFrom" RPC /com.digitalasset.canton.admin.participant.v30.PruningService/GetNoWaitCommitmentsFrom - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getparticipantschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getparticipantschedule.mdx index d250d18..1f7ae16 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getparticipantschedule.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getparticipantschedule.mdx @@ -64,7 +64,6 @@ title: "GetParticipantSchedule" RPC /com.digitalasset.canton.admin.participant.v30.PruningService/GetParticipantSchedule - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getsafepruningoffset.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getsafepruningoffset.mdx index d4dc9a5..a3b4cc8 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getsafepruningoffset.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getsafepruningoffset.mdx @@ -64,7 +64,6 @@ title: "GetSafePruningOffset" RPC /com.digitalasset.canton.admin.participant.v30.PruningService/GetSafePruningOffset - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getschedule.mdx index e2218eb..67bef5f 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getschedule.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/getschedule.mdx @@ -64,7 +64,6 @@ title: "GetSchedule" RPC /com.digitalasset.canton.admin.participant.v30.PruningService/GetSchedule - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/prune.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/prune.mdx index a1fa753..26cd6a3 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/prune.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/prune.mdx @@ -64,7 +64,6 @@ title: "Prune" RPC /com.digitalasset.canton.admin.participant.v30.PruningService/Prune - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/resetnowaitcommitmentsfrom.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/resetnowaitcommitmentsfrom.mdx index da542c4..1154556 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/resetnowaitcommitmentsfrom.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/resetnowaitcommitmentsfrom.mdx @@ -64,7 +64,6 @@ title: "ResetNoWaitCommitmentsFrom" RPC /com.digitalasset.canton.admin.participant.v30.PruningService/ResetNoWaitCommitmentsFrom - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setcron.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setcron.mdx index 8a0c1e2..cc49bf5 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setcron.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setcron.mdx @@ -64,7 +64,6 @@ title: "SetCron" RPC /com.digitalasset.canton.admin.participant.v30.PruningService/SetCron - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setmaxduration.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setmaxduration.mdx index 2ce9983..f59257d 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setmaxduration.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setmaxduration.mdx @@ -64,7 +64,6 @@ title: "SetMaxDuration" RPC /com.digitalasset.canton.admin.participant.v30.PruningService/SetMaxDuration - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setnowaitcommitmentsfrom.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setnowaitcommitmentsfrom.mdx index ba9068a..537f9ed 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setnowaitcommitmentsfrom.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setnowaitcommitmentsfrom.mdx @@ -64,7 +64,6 @@ title: "SetNoWaitCommitmentsFrom" RPC /com.digitalasset.canton.admin.participant.v30.PruningService/SetNoWaitCommitmentsFrom - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setparticipantschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setparticipantschedule.mdx index 303c5f6..8e976ce 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setparticipantschedule.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setparticipantschedule.mdx @@ -64,7 +64,6 @@ title: "SetParticipantSchedule" RPC /com.digitalasset.canton.admin.participant.v30.PruningService/SetParticipantSchedule - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setretention.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setretention.mdx index 92f0658..0a6deba 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setretention.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setretention.mdx @@ -64,7 +64,6 @@ title: "SetRetention" RPC /com.digitalasset.canton.admin.participant.v30.PruningService/SetRetention - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setschedule.mdx index a20963b..4e099b2 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setschedule.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/pruningservice/setschedule.mdx @@ -64,7 +64,6 @@ title: "SetSchedule" RPC /com.digitalasset.canton.admin.participant.v30.PruningService/SetSchedule - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/resourcemanagementservice/getresourcelimits.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/resourcemanagementservice/getresourcelimits.mdx index 35357ca..44d2b31 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/resourcemanagementservice/getresourcelimits.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/resourcemanagementservice/getresourcelimits.mdx @@ -64,7 +64,6 @@ title: "GetResourceLimits" RPC /com.digitalasset.canton.admin.participant.v30.ResourceManagementService/GetResourceLimits - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/resourcemanagementservice/setresourcelimits.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/resourcemanagementservice/setresourcelimits.mdx index cee3bab..ff2916a 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/resourcemanagementservice/setresourcelimits.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/resourcemanagementservice/setresourcelimits.mdx @@ -64,7 +64,6 @@ title: "SetResourceLimits" RPC /com.digitalasset.canton.admin.participant.v30.ResourceManagementService/SetResourceLimits - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/connectsynchronizer.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/connectsynchronizer.mdx index 0b9002d..d982bf1 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/connectsynchronizer.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/connectsynchronizer.mdx @@ -64,7 +64,6 @@ title: "ConnectSynchronizer" RPC /com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/ConnectSynchronizer - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/disconnectallsynchronizers.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/disconnectallsynchronizers.mdx index 868a433..40fe684 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/disconnectallsynchronizers.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/disconnectallsynchronizers.mdx @@ -64,7 +64,6 @@ title: "DisconnectAllSynchronizers" RPC /com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/DisconnectAllSynchronizers - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/disconnectsynchronizer.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/disconnectsynchronizer.mdx index be61f37..108ba04 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/disconnectsynchronizer.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/disconnectsynchronizer.mdx @@ -64,7 +64,6 @@ title: "DisconnectSynchronizer" RPC /com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/DisconnectSynchronizer - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/getsynchronizerid.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/getsynchronizerid.mdx index d197cdf..d9dd05a 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/getsynchronizerid.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/getsynchronizerid.mdx @@ -64,7 +64,6 @@ title: "GetSynchronizerId" RPC /com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/GetSynchronizerId - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/listconnectedsynchronizers.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/listconnectedsynchronizers.mdx index 726252b..50ecc55 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/listconnectedsynchronizers.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/listconnectedsynchronizers.mdx @@ -64,7 +64,6 @@ title: "ListConnectedSynchronizers" RPC /com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/ListConnectedSynchronizers - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/listregisteredsynchronizers.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/listregisteredsynchronizers.mdx index e4e841a..82c54af 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/listregisteredsynchronizers.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/listregisteredsynchronizers.mdx @@ -64,7 +64,6 @@ title: "ListRegisteredSynchronizers" RPC /com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/ListRegisteredSynchronizers - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/logout.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/logout.mdx index cf436be..efefaa9 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/logout.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/logout.mdx @@ -64,7 +64,6 @@ title: "Logout" RPC /com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/Logout - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/modifysynchronizer.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/modifysynchronizer.mdx index c794361..810076d 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/modifysynchronizer.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/modifysynchronizer.mdx @@ -64,7 +64,6 @@ title: "ModifySynchronizer" RPC /com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/ModifySynchronizer - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/reconnectsynchronizer.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/reconnectsynchronizer.mdx index 3a26588..93f77ad 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/reconnectsynchronizer.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/reconnectsynchronizer.mdx @@ -64,7 +64,6 @@ title: "ReconnectSynchronizer" RPC /com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/ReconnectSynchronizer - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/reconnectsynchronizers.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/reconnectsynchronizers.mdx index 0583b1f..42e0f04 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/reconnectsynchronizers.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/reconnectsynchronizers.mdx @@ -64,7 +64,6 @@ title: "ReconnectSynchronizers" RPC /com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/ReconnectSynchronizers - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/registersynchronizer.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/registersynchronizer.mdx index f2b89ef..af415b1 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/registersynchronizer.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/synchronizerconnectivityservice/registersynchronizer.mdx @@ -64,7 +64,6 @@ title: "RegisterSynchronizer" RPC /com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/RegisterSynchronizer - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/trafficcontrolservice/trafficcontrolstate.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/trafficcontrolservice/trafficcontrolstate.mdx index 94aa805..b9c7d15 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/trafficcontrolservice/trafficcontrolstate.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-participant-v30/trafficcontrolservice/trafficcontrolstate.mdx @@ -64,7 +64,6 @@ title: "TrafficControlState" RPC /com.digitalasset.canton.admin.participant.v30.TrafficControlService/TrafficControlState - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-sequencer-v30/sequencerstatusservice/sequencerstatus.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-sequencer-v30/sequencerstatusservice/sequencerstatus.mdx index b7f3326..cc69ccb 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-sequencer-v30/sequencerstatusservice/sequencerstatus.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-admin-sequencer-v30/sequencerstatusservice/sequencerstatus.mdx @@ -64,7 +64,6 @@ title: "SequencerStatus" RPC /com.digitalasset.canton.admin.sequencer.v30.SequencerStatusService/SequencerStatus - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-connection-v30/apiinfoservice/getapiinfo.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-connection-v30/apiinfoservice/getapiinfo.mdx index 2db3a1a..4835492 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-connection-v30/apiinfoservice/getapiinfo.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-connection-v30/apiinfoservice/getapiinfo.mdx @@ -64,7 +64,6 @@ title: "GetApiInfo" RPC /com.digitalasset.canton.connection.v30.ApiInfoService/GetApiInfo - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/deletekeypair.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/deletekeypair.mdx index f1f77ce..e0fc224 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/deletekeypair.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/deletekeypair.mdx @@ -64,7 +64,6 @@ title: "DeleteKeyPair" RPC /com.digitalasset.canton.crypto.admin.v30.VaultService/DeleteKeyPair - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/exportkeypair.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/exportkeypair.mdx index 1636164..91c3683 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/exportkeypair.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/exportkeypair.mdx @@ -64,7 +64,6 @@ title: "ExportKeyPair" RPC /com.digitalasset.canton.crypto.admin.v30.VaultService/ExportKeyPair - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/generateencryptionkey.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/generateencryptionkey.mdx index dddddbf..3fe935d 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/generateencryptionkey.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/generateencryptionkey.mdx @@ -64,7 +64,6 @@ title: "GenerateEncryptionKey" RPC /com.digitalasset.canton.crypto.admin.v30.VaultService/GenerateEncryptionKey - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/generatesigningkey.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/generatesigningkey.mdx index ec8249d..0b8d348 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/generatesigningkey.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/generatesigningkey.mdx @@ -64,7 +64,6 @@ title: "GenerateSigningKey" RPC /com.digitalasset.canton.crypto.admin.v30.VaultService/GenerateSigningKey - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/getwrapperkeyid.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/getwrapperkeyid.mdx index e0e9df5..e4febfa 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/getwrapperkeyid.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/getwrapperkeyid.mdx @@ -64,7 +64,6 @@ title: "GetWrapperKeyId" RPC /com.digitalasset.canton.crypto.admin.v30.VaultService/GetWrapperKeyId - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/importkeypair.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/importkeypair.mdx index 75c8e8a..62ed670 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/importkeypair.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/importkeypair.mdx @@ -64,7 +64,6 @@ title: "ImportKeyPair" RPC /com.digitalasset.canton.crypto.admin.v30.VaultService/ImportKeyPair - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/importpublickey.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/importpublickey.mdx index 72c5901..97e34f5 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/importpublickey.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/importpublickey.mdx @@ -64,7 +64,6 @@ title: "ImportPublicKey" RPC /com.digitalasset.canton.crypto.admin.v30.VaultService/ImportPublicKey - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/listmykeys.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/listmykeys.mdx index ea1ebc6..a797a03 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/listmykeys.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/listmykeys.mdx @@ -64,7 +64,6 @@ title: "ListMyKeys" RPC /com.digitalasset.canton.crypto.admin.v30.VaultService/ListMyKeys - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/listpublickeys.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/listpublickeys.mdx index 9371a99..5c08149 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/listpublickeys.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/listpublickeys.mdx @@ -64,7 +64,6 @@ title: "ListPublicKeys" RPC /com.digitalasset.canton.crypto.admin.v30.VaultService/ListPublicKeys - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/registerkmsencryptionkey.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/registerkmsencryptionkey.mdx index e6f090b..526328f 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/registerkmsencryptionkey.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/registerkmsencryptionkey.mdx @@ -64,7 +64,6 @@ title: "RegisterKmsEncryptionKey" RPC /com.digitalasset.canton.crypto.admin.v30.VaultService/RegisterKmsEncryptionKey - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/registerkmssigningkey.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/registerkmssigningkey.mdx index 496c424..8ae8463 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/registerkmssigningkey.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/registerkmssigningkey.mdx @@ -64,7 +64,6 @@ title: "RegisterKmsSigningKey" RPC /com.digitalasset.canton.crypto.admin.v30.VaultService/RegisterKmsSigningKey - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/rotatewrapperkey.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/rotatewrapperkey.mdx index 13d1641..f42e51b 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/rotatewrapperkey.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-crypto-admin-v30/vaultservice/rotatewrapperkey.mdx @@ -64,7 +64,6 @@ title: "RotateWrapperKey" RPC /com.digitalasset.canton.crypto.admin.v30.VaultService/RotateWrapperKey - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/clearschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/clearschedule.mdx index bfae5d4..14a56e7 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/clearschedule.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/clearschedule.mdx @@ -64,7 +64,6 @@ title: "ClearSchedule" RPC /com.digitalasset.canton.mediator.admin.v30.MediatorAdministrationService/ClearSchedule - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/findpruningtimestamp.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/findpruningtimestamp.mdx index d5aa456..8289d0b 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/findpruningtimestamp.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/findpruningtimestamp.mdx @@ -64,7 +64,6 @@ title: "FindPruningTimestamp" RPC /com.digitalasset.canton.mediator.admin.v30.MediatorAdministrationService/FindPruningTimestamp - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/getschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/getschedule.mdx index f98ab8b..97fe149 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/getschedule.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/getschedule.mdx @@ -64,7 +64,6 @@ title: "GetSchedule" RPC /com.digitalasset.canton.mediator.admin.v30.MediatorAdministrationService/GetSchedule - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/prune.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/prune.mdx index 5082161..a5cbc1a 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/prune.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/prune.mdx @@ -64,7 +64,6 @@ title: "Prune" RPC /com.digitalasset.canton.mediator.admin.v30.MediatorAdministrationService/Prune - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setcron.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setcron.mdx index c09f0da..7371228 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setcron.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setcron.mdx @@ -64,7 +64,6 @@ title: "SetCron" RPC /com.digitalasset.canton.mediator.admin.v30.MediatorAdministrationService/SetCron - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setmaxduration.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setmaxduration.mdx index 805bc5c..4bd3f0b 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setmaxduration.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setmaxduration.mdx @@ -64,7 +64,6 @@ title: "SetMaxDuration" RPC /com.digitalasset.canton.mediator.admin.v30.MediatorAdministrationService/SetMaxDuration - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setretention.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setretention.mdx index 2c9b56a..9da18b4 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setretention.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setretention.mdx @@ -64,7 +64,6 @@ title: "SetRetention" RPC /com.digitalasset.canton.mediator.admin.v30.MediatorAdministrationService/SetRetention - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setschedule.mdx index a3da10e..23c1671 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setschedule.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatoradministrationservice/setschedule.mdx @@ -64,7 +64,6 @@ title: "SetSchedule" RPC /com.digitalasset.canton.mediator.admin.v30.MediatorAdministrationService/SetSchedule - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatorinitializationservice/initializemediator.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatorinitializationservice/initializemediator.mdx index 5a0062f..7f51ade 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatorinitializationservice/initializemediator.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatorinitializationservice/initializemediator.mdx @@ -64,7 +64,6 @@ title: "InitializeMediator" RPC /com.digitalasset.canton.mediator.admin.v30.MediatorInitializationService/InitializeMediator - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatorinspectionservice/verdicts.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatorinspectionservice/verdicts.mdx index a514c34..c157f7d 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatorinspectionservice/verdicts.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/mediatorinspectionservice/verdicts.mdx @@ -64,7 +64,6 @@ title: "Verdicts" RPC /com.digitalasset.canton.mediator.admin.v30.MediatorInspectionService/Verdicts - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/sequencerconnectionservice/getconnection.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/sequencerconnectionservice/getconnection.mdx index b14b460..a16e7ce 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/sequencerconnectionservice/getconnection.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/sequencerconnectionservice/getconnection.mdx @@ -64,7 +64,6 @@ title: "GetConnection" RPC /com.digitalasset.canton.mediator.admin.v30.SequencerConnectionService/GetConnection - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/sequencerconnectionservice/logout.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/sequencerconnectionservice/logout.mdx index 6f70de7..f8c1c1d 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/sequencerconnectionservice/logout.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/sequencerconnectionservice/logout.mdx @@ -64,7 +64,6 @@ title: "Logout" RPC /com.digitalasset.canton.mediator.admin.v30.SequencerConnectionService/Logout - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/sequencerconnectionservice/setconnection.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/sequencerconnectionservice/setconnection.mdx index 37425ce..ec545ab 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/sequencerconnectionservice/setconnection.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-mediator-admin-v30/sequencerconnectionservice/setconnection.mdx @@ -64,7 +64,6 @@ title: "SetConnection" RPC /com.digitalasset.canton.mediator.admin.v30.SequencerConnectionService/SetConnection - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/disablemember.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/disablemember.mdx index f6bd182..8a37d4b 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/disablemember.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/disablemember.mdx @@ -64,7 +64,6 @@ title: "DisableMember" RPC /com.digitalasset.canton.sequencer.admin.v30.SequencerAdministrationService/DisableMember - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/generateauthenticationtoken.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/generateauthenticationtoken.mdx index e2fe6ca..a98e264 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/generateauthenticationtoken.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/generateauthenticationtoken.mdx @@ -64,7 +64,6 @@ title: "GenerateAuthenticationToken" RPC /com.digitalasset.canton.sequencer.admin.v30.SequencerAdministrationService/GenerateAuthenticationToken - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/onboardingstate.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/onboardingstate.mdx index 2f8435e..7935844 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/onboardingstate.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/onboardingstate.mdx @@ -64,7 +64,6 @@ title: "OnboardingState" RPC /com.digitalasset.canton.sequencer.admin.v30.SequencerAdministrationService/OnboardingState - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/onboardingstatev2.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/onboardingstatev2.mdx index cc66267..5eff10e 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/onboardingstatev2.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/onboardingstatev2.mdx @@ -64,7 +64,6 @@ title: "OnboardingStateV2" RPC /com.digitalasset.canton.sequencer.admin.v30.SequencerAdministrationService/OnboardingStateV2 - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/pruningstatus.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/pruningstatus.mdx index f376c99..abdf16f 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/pruningstatus.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/pruningstatus.mdx @@ -64,7 +64,6 @@ title: "PruningStatus" RPC /com.digitalasset.canton.sequencer.admin.v30.SequencerAdministrationService/PruningStatus - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/settrafficpurchased.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/settrafficpurchased.mdx index b6ae692..8af8856 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/settrafficpurchased.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/settrafficpurchased.mdx @@ -64,7 +64,6 @@ title: "SetTrafficPurchased" RPC /com.digitalasset.canton.sequencer.admin.v30.SequencerAdministrationService/SetTrafficPurchased - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/snapshot.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/snapshot.mdx index 50d2eb7..6108f43 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/snapshot.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/snapshot.mdx @@ -64,7 +64,6 @@ title: "Snapshot" RPC /com.digitalasset.canton.sequencer.admin.v30.SequencerAdministrationService/Snapshot - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/trafficcontrolstate.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/trafficcontrolstate.mdx index e2427b6..10935af 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/trafficcontrolstate.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequenceradministrationservice/trafficcontrolstate.mdx @@ -64,7 +64,6 @@ title: "TrafficControlState" RPC /com.digitalasset.canton.sequencer.admin.v30.SequencerAdministrationService/TrafficControlState - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/addpeerendpoint.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/addpeerendpoint.mdx index c8a7c01..c27742e 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/addpeerendpoint.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/addpeerendpoint.mdx @@ -64,7 +64,6 @@ title: "AddPeerEndpoint" RPC /com.digitalasset.canton.sequencer.admin.v30.SequencerBftAdministrationService/AddPeerEndpoint - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/getorderingtopology.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/getorderingtopology.mdx index 6832c8a..d99f636 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/getorderingtopology.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/getorderingtopology.mdx @@ -64,7 +64,6 @@ title: "GetOrderingTopology" RPC /com.digitalasset.canton.sequencer.admin.v30.SequencerBftAdministrationService/GetOrderingTopology - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/getpeernetworkstatus.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/getpeernetworkstatus.mdx index 6fb64a8..01fdfcd 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/getpeernetworkstatus.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/getpeernetworkstatus.mdx @@ -64,7 +64,6 @@ title: "GetPeerNetworkStatus" RPC /com.digitalasset.canton.sequencer.admin.v30.SequencerBftAdministrationService/GetPeerNetworkStatus - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/removepeerendpoint.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/removepeerendpoint.mdx index bced6d9..b6d65a7 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/removepeerendpoint.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/removepeerendpoint.mdx @@ -64,7 +64,6 @@ title: "RemovePeerEndpoint" RPC /com.digitalasset.canton.sequencer.admin.v30.SequencerBftAdministrationService/RemovePeerEndpoint - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/setperformancemetricsenabled.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/setperformancemetricsenabled.mdx index ce6c8e9..6fe3bd4 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/setperformancemetricsenabled.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftadministrationservice/setperformancemetricsenabled.mdx @@ -64,7 +64,6 @@ title: "SetPerformanceMetricsEnabled" RPC /com.digitalasset.canton.sequencer.admin.v30.SequencerBftAdministrationService/SetPerformanceMetricsEnabled - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/bftprune.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/bftprune.mdx index 1aabe60..8ac60aa 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/bftprune.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/bftprune.mdx @@ -64,7 +64,6 @@ title: "BftPrune" RPC /com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/BftPrune - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/bftpruningstatus.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/bftpruningstatus.mdx index 55a1bce..73bc826 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/bftpruningstatus.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/bftpruningstatus.mdx @@ -64,7 +64,6 @@ title: "BftPruningStatus" RPC /com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/BftPruningStatus - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/clearschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/clearschedule.mdx index c142384..2e3dbac 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/clearschedule.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/clearschedule.mdx @@ -64,7 +64,6 @@ title: "ClearSchedule" RPC /com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/ClearSchedule - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/getbftschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/getbftschedule.mdx index c42a64b..b381133 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/getbftschedule.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/getbftschedule.mdx @@ -64,7 +64,6 @@ title: "GetBftSchedule" RPC /com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/GetBftSchedule - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/getschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/getschedule.mdx index 31f9b66..ef21f37 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/getschedule.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/getschedule.mdx @@ -64,7 +64,6 @@ title: "GetSchedule" RPC /com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/GetSchedule - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setbftschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setbftschedule.mdx index 23ff909..08d86e3 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setbftschedule.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setbftschedule.mdx @@ -64,7 +64,6 @@ title: "SetBftSchedule" RPC /com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/SetBftSchedule - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setcron.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setcron.mdx index 3b93ae8..8d01c73 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setcron.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setcron.mdx @@ -64,7 +64,6 @@ title: "SetCron" RPC /com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/SetCron - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setmaxduration.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setmaxduration.mdx index c2c1842..2e7bf24 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setmaxduration.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setmaxduration.mdx @@ -64,7 +64,6 @@ title: "SetMaxDuration" RPC /com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/SetMaxDuration - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setminblockstokeep.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setminblockstokeep.mdx index 0799eac..9da7570 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setminblockstokeep.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setminblockstokeep.mdx @@ -64,7 +64,6 @@ title: "SetMinBlocksToKeep" RPC /com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/SetMinBlocksToKeep - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setretention.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setretention.mdx index 98f4f5b..da1d1dc 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setretention.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setretention.mdx @@ -64,7 +64,6 @@ title: "SetRetention" RPC /com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/SetRetention - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setschedule.mdx index 24b8883..4c81f60 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setschedule.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerbftpruningadministrationservice/setschedule.mdx @@ -64,7 +64,6 @@ title: "SetSchedule" RPC /com.digitalasset.canton.sequencer.admin.v30.SequencerBftPruningAdministrationService/SetSchedule - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromgenesisstate.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromgenesisstate.mdx index 3bb04a9..1ddb77a 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromgenesisstate.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromgenesisstate.mdx @@ -64,7 +64,6 @@ title: "InitializeSequencerFromGenesisState" RPC /com.digitalasset.canton.sequencer.admin.v30.SequencerInitializationService/InitializeSequencerFromGenesisState - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromgenesisstatev2.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromgenesisstatev2.mdx index e7a4d83..120b0e9 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromgenesisstatev2.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromgenesisstatev2.mdx @@ -64,7 +64,6 @@ title: "InitializeSequencerFromGenesisStateV2" RPC /com.digitalasset.canton.sequencer.admin.v30.SequencerInitializationService/InitializeSequencerFromGenesisStateV2 - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromonboardingstate.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromonboardingstate.mdx index 4d39f27..8467b4a 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromonboardingstate.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromonboardingstate.mdx @@ -64,7 +64,6 @@ title: "InitializeSequencerFromOnboardingState" RPC /com.digitalasset.canton.sequencer.admin.v30.SequencerInitializationService/InitializeSequencerFromOnboardingState - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromonboardingstatev2.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromonboardingstatev2.mdx index f02ad4b..5872113 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromonboardingstatev2.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfromonboardingstatev2.mdx @@ -64,7 +64,6 @@ title: "InitializeSequencerFromOnboardingStateV2" RPC /com.digitalasset.canton.sequencer.admin.v30.SequencerInitializationService/InitializeSequencerFromOnboardingStateV2 - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfrompredecessor.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfrompredecessor.mdx index 7199b60..25f08ec 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfrompredecessor.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerinitializationservice/initializesequencerfrompredecessor.mdx @@ -64,7 +64,6 @@ title: "InitializeSequencerFromPredecessor" RPC /com.digitalasset.canton.sequencer.admin.v30.SequencerInitializationService/InitializeSequencerFromPredecessor - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/clearschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/clearschedule.mdx index a7b44cb..6291cfe 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/clearschedule.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/clearschedule.mdx @@ -64,7 +64,6 @@ title: "ClearSchedule" RPC /com.digitalasset.canton.sequencer.admin.v30.SequencerPruningAdministrationService/ClearSchedule - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/findpruningtimestamp.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/findpruningtimestamp.mdx index 2d88570..84c4ef9 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/findpruningtimestamp.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/findpruningtimestamp.mdx @@ -64,7 +64,6 @@ title: "FindPruningTimestamp" RPC /com.digitalasset.canton.sequencer.admin.v30.SequencerPruningAdministrationService/FindPruningTimestamp - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/getschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/getschedule.mdx index e6b7d9c..90c04f6 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/getschedule.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/getschedule.mdx @@ -64,7 +64,6 @@ title: "GetSchedule" RPC /com.digitalasset.canton.sequencer.admin.v30.SequencerPruningAdministrationService/GetSchedule - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/prune.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/prune.mdx index b6ccc0c..122e384 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/prune.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/prune.mdx @@ -64,7 +64,6 @@ title: "Prune" RPC /com.digitalasset.canton.sequencer.admin.v30.SequencerPruningAdministrationService/Prune - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setcron.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setcron.mdx index cdbe513..6ad649f 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setcron.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setcron.mdx @@ -64,7 +64,6 @@ title: "SetCron" RPC /com.digitalasset.canton.sequencer.admin.v30.SequencerPruningAdministrationService/SetCron - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setmaxduration.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setmaxduration.mdx index 2736037..f179e9c 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setmaxduration.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setmaxduration.mdx @@ -64,7 +64,6 @@ title: "SetMaxDuration" RPC /com.digitalasset.canton.sequencer.admin.v30.SequencerPruningAdministrationService/SetMaxDuration - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setretention.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setretention.mdx index 7dd4f75..3161ba0 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setretention.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setretention.mdx @@ -64,7 +64,6 @@ title: "SetRetention" RPC /com.digitalasset.canton.sequencer.admin.v30.SequencerPruningAdministrationService/SetRetention - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setschedule.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setschedule.mdx index 08d779c..982b8e9 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setschedule.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-admin-v30/sequencerpruningadministrationservice/setschedule.mdx @@ -64,7 +64,6 @@ title: "SetSchedule" RPC /com.digitalasset.canton.sequencer.admin.v30.SequencerPruningAdministrationService/SetSchedule - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerauthenticationservice/authenticate.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerauthenticationservice/authenticate.mdx index 184539b..fc6a5fc 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerauthenticationservice/authenticate.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerauthenticationservice/authenticate.mdx @@ -64,7 +64,6 @@ title: "Authenticate" RPC /com.digitalasset.canton.sequencer.api.v30.SequencerAuthenticationService/Authenticate - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerauthenticationservice/challenge.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerauthenticationservice/challenge.mdx index 92553c9..92fcd63 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerauthenticationservice/challenge.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerauthenticationservice/challenge.mdx @@ -64,7 +64,6 @@ title: "Challenge" RPC /com.digitalasset.canton.sequencer.api.v30.SequencerAuthenticationService/Challenge - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerauthenticationservice/logout.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerauthenticationservice/logout.mdx index ca15b29..9a0e885 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerauthenticationservice/logout.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerauthenticationservice/logout.mdx @@ -64,7 +64,6 @@ title: "Logout" RPC /com.digitalasset.canton.sequencer.api.v30.SequencerAuthenticationService/Logout - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerchannelservice/connecttosequencerchannel.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerchannelservice/connecttosequencerchannel.mdx index 69e5991..e87e4ec 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerchannelservice/connecttosequencerchannel.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerchannelservice/connecttosequencerchannel.mdx @@ -64,7 +64,6 @@ title: "ConnectToSequencerChannel" RPC /com.digitalasset.canton.sequencer.api.v30.SequencerChannelService/ConnectToSequencerChannel - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerchannelservice/ping.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerchannelservice/ping.mdx index 82e21e7..77b7cda 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerchannelservice/ping.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerchannelservice/ping.mdx @@ -64,7 +64,6 @@ title: "Ping" RPC /com.digitalasset.canton.sequencer.api.v30.SequencerChannelService/Ping - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/getsynchronizerid.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/getsynchronizerid.mdx index f5c14c5..3d7a8a8 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/getsynchronizerid.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/getsynchronizerid.mdx @@ -64,7 +64,6 @@ title: "GetSynchronizerId" RPC /com.digitalasset.canton.sequencer.api.v30.SequencerConnectService/GetSynchronizerId - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/getsynchronizerparameters.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/getsynchronizerparameters.mdx index c1327bf..ad7b052 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/getsynchronizerparameters.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/getsynchronizerparameters.mdx @@ -64,7 +64,6 @@ title: "GetSynchronizerParameters" RPC /com.digitalasset.canton.sequencer.api.v30.SequencerConnectService/GetSynchronizerParameters - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/handshake.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/handshake.mdx index c0bde59..cdcbbd8 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/handshake.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/handshake.mdx @@ -64,7 +64,6 @@ title: "Handshake" RPC /com.digitalasset.canton.sequencer.api.v30.SequencerConnectService/Handshake - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/registeronboardingtopologytransactions.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/registeronboardingtopologytransactions.mdx index e2dc161..900de00 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/registeronboardingtopologytransactions.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/registeronboardingtopologytransactions.mdx @@ -64,7 +64,6 @@ title: "RegisterOnboardingTopologyTransactions" RPC /com.digitalasset.canton.sequencer.api.v30.SequencerConnectService/RegisterOnboardingTopologyTransactions - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/verifyactive.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/verifyactive.mdx index 5fc2d35..e534a0c 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/verifyactive.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerconnectservice/verifyactive.mdx @@ -64,7 +64,6 @@ title: "VerifyActive" RPC /com.digitalasset.canton.sequencer.api.v30.SequencerConnectService/VerifyActive - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/acknowledgesigned.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/acknowledgesigned.mdx index f57ab11..51c5fa9 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/acknowledgesigned.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/acknowledgesigned.mdx @@ -64,7 +64,6 @@ title: "AcknowledgeSigned" RPC /com.digitalasset.canton.sequencer.api.v30.SequencerService/AcknowledgeSigned - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/downloadtopologystateforinit.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/downloadtopologystateforinit.mdx index fa2ee61..8434b16 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/downloadtopologystateforinit.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/downloadtopologystateforinit.mdx @@ -64,7 +64,6 @@ title: "DownloadTopologyStateForInit" RPC /com.digitalasset.canton.sequencer.api.v30.SequencerService/DownloadTopologyStateForInit - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/downloadtopologystateforinithash.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/downloadtopologystateforinithash.mdx index b9926d2..dbf18ed 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/downloadtopologystateforinithash.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/downloadtopologystateforinithash.mdx @@ -64,7 +64,6 @@ title: "DownloadTopologyStateForInitHash" RPC /com.digitalasset.canton.sequencer.api.v30.SequencerService/DownloadTopologyStateForInitHash - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/gettime.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/gettime.mdx index d999ea0..e793d8d 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/gettime.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/gettime.mdx @@ -64,7 +64,6 @@ title: "GetTime" RPC /com.digitalasset.canton.sequencer.api.v30.SequencerService/GetTime - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/gettrafficstateformember.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/gettrafficstateformember.mdx index c3c60e6..57ffe79 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/gettrafficstateformember.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/gettrafficstateformember.mdx @@ -64,7 +64,6 @@ title: "GetTrafficStateForMember" RPC /com.digitalasset.canton.sequencer.api.v30.SequencerService/GetTrafficStateForMember - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/sendasync.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/sendasync.mdx index d0c6cc8..ba434e4 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/sendasync.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/sendasync.mdx @@ -64,7 +64,6 @@ title: "SendAsync" RPC /com.digitalasset.canton.sequencer.api.v30.SequencerService/SendAsync - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/subscribe.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/subscribe.mdx index 18507ec..a8a9ad0 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/subscribe.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-sequencer-api-v30/sequencerservice/subscribe.mdx @@ -64,7 +64,6 @@ title: "Subscribe" RPC /com.digitalasset.canton.sequencer.api.v30.SequencerService/Subscribe - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-standalone-v1/standalonebftorderingservice/readordered.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-standalone-v1/standalonebftorderingservice/readordered.mdx index c292c49..4ac6e48 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-standalone-v1/standalonebftorderingservice/readordered.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-standalone-v1/standalonebftorderingservice/readordered.mdx @@ -64,7 +64,6 @@ title: "ReadOrdered" RPC /com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1.StandaloneBftOrderingService/ReadOrdered - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-standalone-v1/standalonebftorderingservice/send.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-standalone-v1/standalonebftorderingservice/send.mdx index 24a8217..b20125e 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-standalone-v1/standalonebftorderingservice/send.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-standalone-v1/standalonebftorderingservice/send.mdx @@ -64,7 +64,6 @@ title: "Send" RPC /com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.standalone.v1.StandaloneBftOrderingService/Send - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30/bftorderingservice/receive.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30/bftorderingservice/receive.mdx index a751c3d..e460ddd 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30/bftorderingservice/receive.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-synchronizer-sequencing-sequencer-bftordering-v30/bftorderingservice/receive.mdx @@ -64,7 +64,6 @@ title: "Receive" RPC /com.digitalasset.canton.synchronizer.sequencing.sequencer.bftordering.v30.BftOrderingService/Receive - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-time-admin-v30/synchronizertimeservice/awaittime.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-time-admin-v30/synchronizertimeservice/awaittime.mdx index b6cac5f..575f8da 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-time-admin-v30/synchronizertimeservice/awaittime.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-time-admin-v30/synchronizertimeservice/awaittime.mdx @@ -64,7 +64,6 @@ title: "AwaitTime" RPC /com.digitalasset.canton.time.admin.v30.SynchronizerTimeService/AwaitTime - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-time-admin-v30/synchronizertimeservice/fetchtime.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-time-admin-v30/synchronizertimeservice/fetchtime.mdx index a872af2..b7f1990 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-time-admin-v30/synchronizertimeservice/fetchtime.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-time-admin-v30/synchronizertimeservice/fetchtime.mdx @@ -64,7 +64,6 @@ title: "FetchTime" RPC /com.digitalasset.canton.time.admin.v30.SynchronizerTimeService/FetchTime - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/identityinitializationservice/currenttime.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/identityinitializationservice/currenttime.mdx index b7b1d36..aeab760 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/identityinitializationservice/currenttime.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/identityinitializationservice/currenttime.mdx @@ -64,7 +64,6 @@ title: "CurrentTime" RPC /com.digitalasset.canton.topology.admin.v30.IdentityInitializationService/CurrentTime - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/identityinitializationservice/getid.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/identityinitializationservice/getid.mdx index 320b159..5ee825e 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/identityinitializationservice/getid.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/identityinitializationservice/getid.mdx @@ -64,7 +64,6 @@ title: "GetId" RPC /com.digitalasset.canton.topology.admin.v30.IdentityInitializationService/GetId - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/identityinitializationservice/initid.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/identityinitializationservice/initid.mdx index 5b46326..ee49ade 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/identityinitializationservice/initid.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/identityinitializationservice/initid.mdx @@ -64,7 +64,6 @@ title: "InitId" RPC /com.digitalasset.canton.topology.admin.v30.IdentityInitializationService/InitId - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologyaggregationservice/listkeyowners.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologyaggregationservice/listkeyowners.mdx index e5b6830..a849936 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologyaggregationservice/listkeyowners.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologyaggregationservice/listkeyowners.mdx @@ -64,7 +64,6 @@ title: "ListKeyOwners" RPC /com.digitalasset.canton.topology.admin.v30.TopologyAggregationService/ListKeyOwners - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologyaggregationservice/listparties.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologyaggregationservice/listparties.mdx index d2b37ee..46d8685 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologyaggregationservice/listparties.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologyaggregationservice/listparties.mdx @@ -64,7 +64,6 @@ title: "ListParties" RPC /com.digitalasset.canton.topology.admin.v30.TopologyAggregationService/ListParties - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/exporttopologysnapshot.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/exporttopologysnapshot.mdx index 59b73b9..e4a5ce7 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/exporttopologysnapshot.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/exporttopologysnapshot.mdx @@ -64,7 +64,6 @@ title: "ExportTopologySnapshot" RPC /com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ExportTopologySnapshot - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/exporttopologysnapshotv2.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/exporttopologysnapshotv2.mdx index 6f57f1c..237e25a 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/exporttopologysnapshotv2.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/exporttopologysnapshotv2.mdx @@ -64,7 +64,6 @@ title: "ExportTopologySnapshotV2" RPC /com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ExportTopologySnapshotV2 - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/genesisstate.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/genesisstate.mdx index 1b0087e..c3b5e33 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/genesisstate.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/genesisstate.mdx @@ -64,7 +64,6 @@ title: "GenesisState" RPC /com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/GenesisState - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/genesisstatev2.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/genesisstatev2.mdx index 9729735..8d9de0b 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/genesisstatev2.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/genesisstatev2.mdx @@ -64,7 +64,6 @@ title: "GenesisStateV2" RPC /com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/GenesisStateV2 - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listall.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listall.mdx index f574508..0c3a640 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listall.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listall.mdx @@ -64,7 +64,6 @@ title: "ListAll" RPC /com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListAll - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listavailablestores.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listavailablestores.mdx index 2d5a2b0..ea55721 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listavailablestores.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listavailablestores.mdx @@ -64,7 +64,6 @@ title: "ListAvailableStores" RPC /com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListAvailableStores - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listdecentralizednamespacedefinition.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listdecentralizednamespacedefinition.mdx index 662424e..419cff4 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listdecentralizednamespacedefinition.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listdecentralizednamespacedefinition.mdx @@ -64,7 +64,6 @@ title: "ListDecentralizedNamespaceDefinition" RPC /com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListDecentralizedNamespaceDefinition - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listmediatorsynchronizerstate.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listmediatorsynchronizerstate.mdx index 426b8d5..5cc43d5 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listmediatorsynchronizerstate.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listmediatorsynchronizerstate.mdx @@ -64,7 +64,6 @@ title: "ListMediatorSynchronizerState" RPC /com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListMediatorSynchronizerState - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listnamespacedelegation.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listnamespacedelegation.mdx index 7322064..0b959aa 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listnamespacedelegation.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listnamespacedelegation.mdx @@ -64,7 +64,6 @@ title: "ListNamespaceDelegation" RPC /com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListNamespaceDelegation - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listownertokeymapping.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listownertokeymapping.mdx index c34f370..fa29733 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listownertokeymapping.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listownertokeymapping.mdx @@ -64,7 +64,6 @@ title: "ListOwnerToKeyMapping" RPC /com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListOwnerToKeyMapping - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listparticipantsynchronizerpermission.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listparticipantsynchronizerpermission.mdx index d27650e..0b1fd47 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listparticipantsynchronizerpermission.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listparticipantsynchronizerpermission.mdx @@ -64,7 +64,6 @@ title: "ListParticipantSynchronizerPermission" RPC /com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListParticipantSynchronizerPermission - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listpartyhostinglimits.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listpartyhostinglimits.mdx index 450b373..8f3fcb0 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listpartyhostinglimits.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listpartyhostinglimits.mdx @@ -64,7 +64,6 @@ title: "ListPartyHostingLimits" RPC /com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListPartyHostingLimits - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listpartytokeymapping.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listpartytokeymapping.mdx index 3940997..568582e 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listpartytokeymapping.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listpartytokeymapping.mdx @@ -64,7 +64,6 @@ title: "ListPartyToKeyMapping" RPC /com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListPartyToKeyMapping - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listpartytoparticipant.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listpartytoparticipant.mdx index bf6f979..e0f7ac5 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listpartytoparticipant.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listpartytoparticipant.mdx @@ -64,7 +64,6 @@ title: "ListPartyToParticipant" RPC /com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListPartyToParticipant - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsequencerconnectionsuccessor.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsequencerconnectionsuccessor.mdx index 35116fb..35d3480 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsequencerconnectionsuccessor.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsequencerconnectionsuccessor.mdx @@ -64,7 +64,6 @@ title: "ListSequencerConnectionSuccessor" RPC /com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListSequencerConnectionSuccessor - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsequencersynchronizerstate.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsequencersynchronizerstate.mdx index 65020bc..6139654 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsequencersynchronizerstate.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsequencersynchronizerstate.mdx @@ -64,7 +64,6 @@ title: "ListSequencerSynchronizerState" RPC /com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListSequencerSynchronizerState - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsynchronizerparametersstate.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsynchronizerparametersstate.mdx index 7fde308..8612864 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsynchronizerparametersstate.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsynchronizerparametersstate.mdx @@ -64,7 +64,6 @@ title: "ListSynchronizerParametersState" RPC /com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListSynchronizerParametersState - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsynchronizertrustcertificate.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsynchronizertrustcertificate.mdx index 2d77717..cc939fe 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsynchronizertrustcertificate.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsynchronizertrustcertificate.mdx @@ -64,7 +64,6 @@ title: "ListSynchronizerTrustCertificate" RPC /com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListSynchronizerTrustCertificate - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsynchronizerupgradeannouncement.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsynchronizerupgradeannouncement.mdx index 88e38cd..eee11cf 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsynchronizerupgradeannouncement.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listsynchronizerupgradeannouncement.mdx @@ -64,7 +64,6 @@ title: "ListSynchronizerUpgradeAnnouncement" RPC /com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListSynchronizerUpgradeAnnouncement - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listvettedpackages.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listvettedpackages.mdx index df9cdd0..cb4efa8 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listvettedpackages.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/listvettedpackages.mdx @@ -64,7 +64,6 @@ title: "ListVettedPackages" RPC /com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListVettedPackages - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/logicalupgradestate.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/logicalupgradestate.mdx index a42499b..9208f18 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/logicalupgradestate.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerreadservice/logicalupgradestate.mdx @@ -64,7 +64,6 @@ title: "LogicalUpgradeState" RPC /com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/LogicalUpgradeState - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/addtransactions.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/addtransactions.mdx index 5719d88..64c31b9 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/addtransactions.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/addtransactions.mdx @@ -64,7 +64,6 @@ title: "AddTransactions" RPC /com.digitalasset.canton.topology.admin.v30.TopologyManagerWriteService/AddTransactions - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/authorize.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/authorize.mdx index d61f051..ecd0eeb 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/authorize.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/authorize.mdx @@ -64,7 +64,6 @@ title: "Authorize" RPC /com.digitalasset.canton.topology.admin.v30.TopologyManagerWriteService/Authorize - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/createtemporarytopologystore.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/createtemporarytopologystore.mdx index 373b10c..c98e7e9 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/createtemporarytopologystore.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/createtemporarytopologystore.mdx @@ -64,7 +64,6 @@ title: "CreateTemporaryTopologyStore" RPC /com.digitalasset.canton.topology.admin.v30.TopologyManagerWriteService/CreateTemporaryTopologyStore - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/droptemporarytopologystore.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/droptemporarytopologystore.mdx index e9cbd2f..abab77e 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/droptemporarytopologystore.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/droptemporarytopologystore.mdx @@ -64,7 +64,6 @@ title: "DropTemporaryTopologyStore" RPC /com.digitalasset.canton.topology.admin.v30.TopologyManagerWriteService/DropTemporaryTopologyStore - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/generatetransactions.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/generatetransactions.mdx index 45a7a6b..7502e6b 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/generatetransactions.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/generatetransactions.mdx @@ -64,7 +64,6 @@ title: "GenerateTransactions" RPC /com.digitalasset.canton.topology.admin.v30.TopologyManagerWriteService/GenerateTransactions - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/importtopologysnapshot.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/importtopologysnapshot.mdx index f8b9b0f..25e93a0 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/importtopologysnapshot.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/importtopologysnapshot.mdx @@ -64,7 +64,6 @@ title: "ImportTopologySnapshot" RPC /com.digitalasset.canton.topology.admin.v30.TopologyManagerWriteService/ImportTopologySnapshot - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/importtopologysnapshotv2.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/importtopologysnapshotv2.mdx index faea589..d490969 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/importtopologysnapshotv2.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/importtopologysnapshotv2.mdx @@ -64,7 +64,6 @@ title: "ImportTopologySnapshotV2" RPC /com.digitalasset.canton.topology.admin.v30.TopologyManagerWriteService/ImportTopologySnapshotV2 - Try it ## Protocol Details diff --git a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/signtransactions.mdx b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/signtransactions.mdx index fa30a1f..f8aa95e 100644 --- a/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/signtransactions.mdx +++ b/tests/fixtures/characterization/protobuf/expected/operations/com-digitalasset-canton-topology-admin-v30/topologymanagerwriteservice/signtransactions.mdx @@ -64,7 +64,6 @@ title: "SignTransactions" RPC /com.digitalasset.canton.topology.admin.v30.TopologyManagerWriteService/SignTransactions - Try it ## Protocol Details