Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,9 @@ some tokens on the testnet for making the process simpler.
1. `ENABLE_ACCOUNT_TOPUP`: Enable/disable such functionality (`false` by default)
2. `FAUCET_URI`: Faucet service API endpoint (Default: `https://faucet-api.cheqd.network/credit`)
3. `TESTNET_MINIMUM_BALANCE`: Minimum balance on account before it is automatically topped up from the faucet. This value should be expressed as an integer in `CHEQ` tokens, which will then be converted in the background to `ncheq` denomination. Account balance check is carried out on every account creation/login. (Default: 10,000 CHEQ testnet tokens)
4. `FAUCET_API_KEY`: API key for faucet service authentication
5. `FAUCET_ACCESS_CLIENT_ID`: Cloudflare Access client ID for accessing the Testnet Faucet API
6. `FAUCET_ACCESS_CLIENT_SECRET`: Cloudflare Access client secret for accessing the Testnet Faucet API

#### Stripe integration

Expand Down
4 changes: 4 additions & 0 deletions docker/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,8 @@ ARG ENABLE_ACCOUNT_TOPUP=false
ARG FAUCET_URI=https://faucet-api.cheqd.network/credit
ARG FAUCET_API_KEY
ARG TESTNET_MINIMUM_BALANCE=1000
ARG FAUCET_ACCESS_CLIENT_ID
ARG FAUCET_ACCESS_CLIENT_SECRET

# Stripe
ARG STRIPE_ENABLED=false
Expand Down Expand Up @@ -139,6 +141,8 @@ ENV ENABLE_ACCOUNT_TOPUP=${ENABLE_ACCOUNT_TOPUP}
ENV FAUCET_URI=${FAUCET_URI}
ENV FAUCET_API_KEY=${FAUCET_API_KEY}
ENV TESTNET_MINIMUM_BALANCE=${TESTNET_MINIMUM_BALANCE}
ENV FAUCET_ACCESS_CLIENT_ID=${FAUCET_ACCESS_CLIENT_ID}
ENV FAUCET_ACCESS_CLIENT_SECRET=${FAUCET_ACCESS_CLIENT_SECRET}

# Environment variables: Verida connector
ENV ENABLE_VERIDA_CONNECTOR=${ENABLE_VERIDA_CONNECTOR}
Expand Down
11 changes: 10 additions & 1 deletion src/helpers/faucet.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
import type { ICommonErrorResponse } from '../types/authentication.js';
import { MINIMAL_DENOM, FAUCET_URI, FAUCET_AMOUNT, FAUCET_API_KEY } from '../types/constants.js';
import {
MINIMAL_DENOM,
FAUCET_URI,
FAUCET_AMOUNT,
FAUCET_API_KEY,
FAUCET_ACCESS_CLIENT_ID,
FAUCET_ACCESS_CLIENT_SECRET
} from '../types/constants.js';

export class FaucetHelper {
// ...
Expand All @@ -24,6 +31,8 @@ export class FaucetHelper {
headers: {
'Content-Type': 'application/json',
'X-API-Key': FAUCET_API_KEY,
'CF-Access-Client-Id': FAUCET_ACCESS_CLIENT_ID,
'CF-Access-Client-Secret': FAUCET_ACCESS_CLIENT_SECRET,
},
body: JSON.stringify(faucetBody),
method: 'POST',
Expand Down
2 changes: 2 additions & 0 deletions src/types/constants.ts
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,8 @@ export const FAUCET_API_KEY = process.env.FAUCET_API_KEY || 'default-api-key';
export const DEFAULT_DENOM_EXPONENT = 9;
export const TESTNET_MINIMUM_BALANCE = process.env.TESTNET_MINIMUM_BALANCE || 1000;
export const FAUCET_AMOUNT = process.env.FAUCET_AMOUNT || 100000000000000;
export const FAUCET_ACCESS_CLIENT_ID = process.env.FAUCET_ACCESS_CLIENT_ID || '';
export const FAUCET_ACCESS_CLIENT_SECRET = process.env.FAUCET_ACCESS_CLIENT_SECRET || '';

// Verifiable Credential constants
export const VC_CONTEXT = ['https://www.w3.org/2018/credentials/v1'];
Expand Down
Loading