- Overview
- Setup
- Tutorials
- How Tos
- Reference
- DAR Versions
- API Reference
- Commercials API
- Credential API
- Registry API
- Utility.Registry
- Utility.Registry.V0.Configuration.AppReward
- Utility.Registry.V0.Configuration.Instrument
- Utility.Registry.V0.Holding.Allocation
- Utility.Registry.V0.Holding.Burn
- Utility.Registry.V0.Holding.Lock
- Utility.Registry.V0.Holding.Mint
- Utility.Registry.V0.Holding.Transfer
- Utility.Registry.V0.Holding.Unlock
- Utility.Registry.V0.Rule.Transfer
- Utility.Registry.V0.Types
- Utility.Registry.V0.Util
- Utility.Registry.App
- Utility.Holding
- Utility.Registry
- Settlement Utility API
- Collateral Utility API
- Operator Backend API
Prerequisites¶
Validator¶
Having a running and properly configured validator node is a pre-requisite for using the Utilities on the Network.
Follow the instructions provided by the the Global Synchronizer Foundation to setup a Validator Node
Participant Configuration¶
# required for the Utilities frontend
jsonApiServerPathPrefix: /api/json-api
# optional -- minimizes the amount of archived data in your Validator Node
participantPruningSchedule:
cron: 0 0 14 * * ?
maxDuration: 1h
retention: 30d
Utilities Auth Setup¶
Warning
The audience configured for your utilities app should match the audience you have configured for your validator.
Utilities User/Party¶
While the Utility could work with the Validator Operator party (created via Validator setup), we recommend creating a separate user/party for the Utility workflows because this user is also used to pay for traffic on behalf of all other parties hosted on the validator and receives liveliness rewards. Separating these concerns facilitates easier accounting and management.
Create a separate user for the Utilities in your IAM system
Log into the Wallet UI with this new user
Click Onboard yourself (this creates the party)
Create Client ID for Frontend and Auto-Topup¶
Follow the same steps for setting up an External OIDC Provider as you have done for your Validator.
Specifically, you need to create a new application similar to the Wallet/CNS named ‘Utility UI’.
Once this has been created, ensure you copy the Client ID and Client Secret as these will be needed later as you specify this configuration in your values.yaml (using a Helm chart for deployment to Kubernetes) or as environment variables (if you are deploying via Docker Compose).