canton

Canton API client.

Open API specification files and documentation

Open API specification files for Splice and Ledger APIs

• Splice APIs (should paste all yaml files into the OpenApiSpecs folder)
• Ledger API (should paste the yaml content into the OpenApiSpecs/ledger.yaml file)
• Utilities API (should paste the yaml content into the OpenApiSpecs/utilities.yaml file)

Open API specification files for Ledger Webservice (a.k.a. AsyncAPI)

There is the Ledger API AsyncAPI documentation to consume the Ledger webservice. Since this code cannot be generated automatically, it is recommended to implement it manually when needed.

Relevant links

• Canton integration guide
• Canton utilities "How Tos"
• Canton ledger api
• Canton network applications development (splice apis)

How to regenerate C# API clients using Refitter

Please ensure you have refitter CLI tool installed globally. If not, run the command below:

dotnet tool install --global Refitter

Also ensure you have Python 3.* installed with pip package manager, since there are some python scripts used in the generation process.

Open the terminal in the root folder and run the command below:

sh scripts/generate-with-refitter.sh

AWS Parameters

In order to be able to run some integration tests, you should ensure that you have access to the AWS parameters starting in /CiCd. In order for the applications in this solution to run correctly on AWS, please ensure that variables starting in /[environment] are defined for all 3 environments ( Production, Staging, Development ) :

# REPOSITORY SECRETS
/[environment]/Trakx/Canton/ApiClient/AuthApplicationConfiguration/ClientId
/[environment]/Trakx/Canton/ApiClient/AuthApplicationConfiguration/ClientSecret
/[environment]/Trakx/Canton/ApiClient/CantonApiClientConfiguration/AuthAudience
/[environment]/Trakx/Canton/ApiClient/CantonApiClientConfiguration/AuthClientId
/[environment]/Trakx/Canton/ApiClient/CantonApiClientConfiguration/AuthClientSecret
/[environment]/Trakx/Canton/ApiClient/CantonApiClientConfiguration/AuthDomain
/[environment]/Trakx/Canton/ApiClient/CantonApiClientConfiguration/LedgerApiUrl
/[environment]/Trakx/Canton/ApiClient/CantonApiClientConfiguration/SpliceApisUrl
/[environment]/Trakx/Canton/ApiClient/CantonApiClientConfiguration/UtilitiesApiUrl
/[environment]/Trakx/Canton/ApiClient/RedisCacheConfiguration/ConnectionString

# GLOBAL SECRETS
# Instead of creating a specific repository secret, can use the global one with the same [Key]
/[environment]/Global/CantonApiClientConfiguration/AuthAudience
/[environment]/Global/CantonApiClientConfiguration/AuthDomain
/[environment]/Global/CantonApiClientConfiguration/LedgerApiUrl
/[environment]/Global/CantonApiClientConfiguration/SpliceApisUrl
/[environment]/Global/CantonApiClientConfiguration/UtilitiesApiUrl
/[environment]/Global/RedisCacheConfiguration/ConnectionString