Skip to content

Latest commit

 

History

History
42 lines (30 loc) · 2.29 KB

README.md

File metadata and controls

42 lines (30 loc) · 2.29 KB
Raw

daml-wallet-ui

.env variables explanation

These environment variables in the .env file can be used to configure the frontend:

  1. REACT_APP_PARTIES_SBT_INSTRUMENT_DEPOSITORY: Party ID of the depository entity for SBT (Soulbound Token).
  2. REACT_APP_PARTIES_SBT_INSTRUMENT_ISSUER: Party ID of the issuer entity for SBT (Soulbound Token).
  3. REACT_APP_PARTIES_SBT_CUSTODIAN: Party ID of the custodian at which the SBTs are held.
  4. REACT_APP_PARTIES_WALLET_OPERATOR: Party ID of the wallet operator.
  5. REACT_APP_MODE: specifies the operational mode of the wallet app, serving either as an investor or issuer, adapting its functionalities accordingly.
  6. REACT_APP_STABLECOIN_INSTRUMENT_ID: Instrument ID of the stablecoin instrument.
  7. REACT_APP_PARTY_ATTRIBUTES_INSTRUMENT_ID: Instrument ID of the SBT used to identify ecosystem members.
  8. REACT_APP_PARTY_ATTRIBUTES_NAME: Name of the attribute on the metadata contracts for the REACT_APP_PARTY_ATTRIBUTES_INSTRUMENT_ID. The value of this attribute is the display name of the party.
  9. REACT_APP_POLL_DELAY: Delay in milliseconds to wait before each polling request the UI makes to the wallet views API if data requires refresh.*
  10. REACT_APP_POLL_MAX: Max number of polling attempts.
  11. REACT_APP_SETTLEMENT_FACTORY_CID: Contract ID of the settlement Factory which can be used to instruct settlements.
  12. REACT_APP_ROUTE_PROVIDER_CID: Contract ID of the settlement RouteProvider which can be used to determine the settlement route(s) (i.e. the appropriate custodian(s)) when settlement are instructed.
  • The wallet views API does not have any streaming capability yet, so polling is the only option available in order to refresh the UI state when the user interacts with the ledger.

Project Deployment Guide

This guide provides step-by-step instructions for building and deploying the frontend application. Please deploy the backend according to wallet view readme before deploying the frontend.

To build the project, execute the following command:

make build-wallet-ui

The UI can be started using:

make start-wallet-ui

Note: you may need to adjust the .env file (or export environment variables to override the values in the .env file).

Further work is needed to containerise both the frontend and backend.