From 6b971bf4636bbc658530e8447c52866054db2aec Mon Sep 17 00:00:00 2001 From: brad-dow <162852233+brad-dow@users.noreply.github.com> Date: Fri, 18 Oct 2024 10:13:35 -0500 Subject: [PATCH] docs: added new backend environment variable (#3039) * Added new backend environment variable Added MAX_OUTGOING_PAYMENT_RETRY_ATTEMPTS, default value, and description to the docs * prettier ran prettier --- .../src/content/docs/admin/admin-user-guide.mdx | 3 ++- .../src/content/docs/integration/playground/overview.mdx | 5 +---- .../content/docs/integration/requirements/exchange-rates.mdx | 2 +- .../docs/integration/requirements/wallet-addresses.mdx | 3 ++- .../src/content/docs/resources/webhook-event-types.mdx | 2 +- packages/documentation/src/partials/backend-variables.mdx | 1 + 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/packages/documentation/src/content/docs/admin/admin-user-guide.mdx b/packages/documentation/src/content/docs/admin/admin-user-guide.mdx index 49dda0827d..cc9fe587ce 100644 --- a/packages/documentation/src/content/docs/admin/admin-user-guide.mdx +++ b/packages/documentation/src/content/docs/admin/admin-user-guide.mdx @@ -249,9 +249,10 @@ Fill out the following fields to create a new wallet address: | | Asset | Select an asset to associate with this wallet. | :::note[Wallet address requirements] + - At least one asset has to be created prior to creating a new wallet address. Refer to [Create asset](#create-asset) for more information. - Wallet address URLs are treated as case-insensitive, meaning that both lowercase and uppercase variations of the same address will be recognized as identical. -::: + ::: After completing this section, select **Create** to add the new wallet address. diff --git a/packages/documentation/src/content/docs/integration/playground/overview.mdx b/packages/documentation/src/content/docs/integration/playground/overview.mdx index 0a66edb1b2..59c7d41c25 100644 --- a/packages/documentation/src/content/docs/integration/playground/overview.mdx +++ b/packages/documentation/src/content/docs/integration/playground/overview.mdx @@ -83,10 +83,7 @@ The secondary Happy Life Bank docker-compose file (`./happy-life-bank/docker-com The following components are made available via the Local Playground: - + #### Mock account servicing entity 1 - Cloud Nine Wallet diff --git a/packages/documentation/src/content/docs/integration/requirements/exchange-rates.mdx b/packages/documentation/src/content/docs/integration/requirements/exchange-rates.mdx index fa36104107..702448c80c 100644 --- a/packages/documentation/src/content/docs/integration/requirements/exchange-rates.mdx +++ b/packages/documentation/src/content/docs/integration/requirements/exchange-rates.mdx @@ -110,4 +110,4 @@ export function loader({ request }: LoaderFunctionArgs) { | `EXCHANGE_RATES_LIFETIME` | `backend` | The amount of time Rafiki caches exchange rates, in ms | Y | | `SLIPPAGE` | `backend` | The variance allowed between a quote and the actual amount required when a payment is initiated | Y | - \ No newline at end of file + diff --git a/packages/documentation/src/content/docs/integration/requirements/wallet-addresses.mdx b/packages/documentation/src/content/docs/integration/requirements/wallet-addresses.mdx index d62b53e7ea..47cd4b7cac 100644 --- a/packages/documentation/src/content/docs/integration/requirements/wallet-addresses.mdx +++ b/packages/documentation/src/content/docs/integration/requirements/wallet-addresses.mdx @@ -8,9 +8,10 @@ import { CodeBlock } from '@interledger/docs-design-system' Each payment account belonging to your users (e.g., customers) must have at least one associated wallet address for the account to be able to send and receive payments over Interledger and Open Payments. A wallet address serves as a publicly shareable standardized ID for a payment account. :::note[Wallet address requirements] + - Your Rafiki instance must be set up for at least one asset before wallet addresses can be created as each wallet address must have an asset assigned to it. - Wallet address URLs are treated as case-insensitive, meaning that both lowercase and uppercase variations of the same address will be recognized as identical. -::: + ::: ## Create wallet addresses diff --git a/packages/documentation/src/content/docs/resources/webhook-event-types.mdx b/packages/documentation/src/content/docs/resources/webhook-event-types.mdx index 20d28aaf72..0bad323af4 100644 --- a/packages/documentation/src/content/docs/resources/webhook-event-types.mdx +++ b/packages/documentation/src/content/docs/resources/webhook-event-types.mdx @@ -21,4 +21,4 @@ The following is an enumeration of all of Rafiki's [webhook event](/integration/ | [`asset.liquidity_low`](/integration/requirements/webhook-events/#asset-liquidity-low) | Asset liquidity has dropped below defined threshold. | | [`peer.liquidity_low`](/integration/requirements/webhook-events/#peer-liquidity-low) | Peer liquidity has dropped below defined threshold. | - \ No newline at end of file + diff --git a/packages/documentation/src/partials/backend-variables.mdx b/packages/documentation/src/partials/backend-variables.mdx index 5f4d4d41ae..08ae12bf44 100644 --- a/packages/documentation/src/partials/backend-variables.mdx +++ b/packages/documentation/src/partials/backend-variables.mdx @@ -24,6 +24,7 @@ import { LinkOut } from '@interledger/docs-design-system' | `INSTANCE_NAME` | | `undefined` | this Rafiki instance's name used to communicate for [auto-peering](/integration/playground/autopeering/) | | `KEY_ID` | backend.key.id | `undefined` | this Rafiki instance's client key id | | `LOG_LEVEL` | backend.logLevel | `info` | [Pino Log Level](https://getpino.io/#/docs/api?id=levels) | +| `MAX_OUTGOING_PAYMENT_RETRY_ATTEMPTS` | | `5` | Maximum number of retry attempts for an outgoing payment before it is considered failed | | `NODE_ENV` | backend.nodeEnv | `development` | node environment, `development`, `test`, or `production` | | `OPEN_PAYMENTS_PORT` | backend.port.openPayments | `3003` | port of the Open Payments resource server port | | `OPEN_PAYMENTS_URL` | backend.serviceUrls.OPEN_PAYMENTS_URL | `undefined` | public endpoint of this Open Payments Resource Server |