diff --git a/platform/src/main/resources/config/anchor-config-default-values.yaml b/platform/src/main/resources/config/anchor-config-default-values.yaml index 3b1542b439..2b0daae8a6 100644 --- a/platform/src/main/resources/config/anchor-config-default-values.yaml +++ b/platform/src/main/resources/config/anchor-config-default-values.yaml @@ -145,27 +145,42 @@ event_processor: callback_api_request: enabled: true -# The list of clients for the Anchor server to safely communicate with the outside client domains. +# The list of clients for the Anchor server to safely communicate with the outside wallet servers or clients. # Each item in the list may contain the following fields: -# - domain: the domain of the client -# - type: the type of the client. The supported values are `custodial` and `non-custodial` -# - public_key: the public key of the client. This must match the public key of the TOML file of the client domain -# - url: the URL of the client's callback API endpoint +# - type: `custodial` or `noncustodial` +# +# If the type is `custodial`, +# - account: (required) the custodial account of the client. If the `account` of the transaction is the same as this +# account, the callback will be activated. +# - url: (required) the URL of the client's callback API endpoint +# +# If the type is `noncustodial`, +# - domain: (required) the domain of the client. If the `client_domain` field of the transaction is the same as this +# domain, the callback will be activated. +# - url: (required) the URL of the client's callback API endpoint +# - public_key: (optional) the public key of the client. If the public key is specified, the client domain's TOML +# file will be fetched and the `SIGNING_KEY` of the TOML file will be compared with the public key. +# If they don't match, a validation error will be thrown. # # Examples: -# - domain: lobstr.com -# public_key: GBI2IWJGR4UQPBIKPP6WG76X5PHSD2QTEBGIP6AZ3ZXWV46ZUSGNEGN2 -# callback_url: https://callback.lobstr.com/api/v1/anchor/callback -# - domain: mgi.com +# - type: custodial +# account: GBI2IWJGR4UQPBIKPP6WG76X5PHSD2QTEBGIP6AZ3ZXWV46ZUSGNEGN2 +# url: https://callback.circle.com/api/v1/anchor/callback +# - type: noncustodial +# domain: lobstr.co +# callback_url: https://callback.lobstr.co/api/v2/anchor/callback +# - type: noncustodial +# domain: vibrant.co +# callback_url: https://callback.vibrant.com/api/v2/anchor/callback # public_key: GA22WORKYRXB6AW7XR5GIOAOQUY4KKCENEAI34FN3KJNWHKDZTZSVLTU -# callback_url: https://callback.mgi.com/api/v2/anchor/callback clients: -# - domain: domain1.com -# public_key: -# callback_url: -# - domain: domain2.com +# - type: custodial +# account: +# url: +# - type: noncustodial +# domain: +# url: # public_key: -# callback_url: ## @param: languages ## @supported_values: en