# Configuration

This page covers all configuration options for the MoonPay fiat module.

## Prerequisites

Before using this module, you need:

1. A MoonPay developer account - [Create an account on MoonPay Dashboard](https://dashboard.moonpay.com/signup)
2. API credentials (API Key and Secret Key) from your dashboard

## Installation

```bash
npm install @tetherto/wdk-protocol-fiat-moonpay
```

## Basic Configuration

```typescript
import MoonPayProtocol from '@tetherto/wdk-protocol-fiat-moonpay';

const moonpay = new MoonPayProtocol(walletAccount, {
  apiKey: 'pk_live_xxxxx',      // Your MoonPay publishable API key
  secretKey: 'sk_live_xxxxx',   // Your MoonPay secret key
});
```

## Configuration Options

| Option      | Type   | Required | Default           | Description                                            |
| ----------- | ------ | -------- | ----------------- | ------------------------------------------------------ |
| `apiKey`    | string | Yes      | -                 | Your MoonPay publishable API key                       |
| `secretKey` | string | Yes      | -                 | Your MoonPay secret key                                |
| `cacheTime` | number | No       | `600000` (10 min) | Duration in milliseconds to cache supported currencies |

## Constructor Overloads

The `MoonPayProtocol` class supports three constructor patterns:

```typescript
// Without account (for public read operations like fetching supported currencies)
const moonpay = new MoonPayProtocol(undefined, config);

// With read-only account
const moonpay = new MoonPayProtocol(readOnlyAccount, config);

// With full wallet account (for buy/sell operations)
const moonpay = new MoonPayProtocol(walletAccount, config);
```

## Environment Configuration

### Sandbox (Testing)

Use test API keys for development and testing:

```typescript
const moonpay = new MoonPayProtocol(walletAccount, {
  apiKey: 'pk_test_xxxxx',
  secretKey: 'sk_test_xxxxx',
});
```

In sandbox mode:

* No real transactions are processed
* Use test card numbers provided by MoonPay
* KYC verification is simulated

### Production

For production deployments, use live API keys:

```typescript
const moonpay = new MoonPayProtocol(walletAccount, {
  apiKey: 'pk_live_xxxxx',
  secretKey: 'sk_live_xxxxx',
});
```

## Widget Customization

When calling `buy()` or `sell()`, you can customize the MoonPay widget appearance:

```typescript
const result = await moonpay.buy({
  cryptoAsset: 'eth',
  fiatCurrency: 'usd',
  fiatAmount: 10000n, // $100.00 in cents
  config: {
    colorCode: '#3B82F6',       // Your brand color (hex)
    theme: 'dark',              // 'dark' or 'light'
    language: 'en',             // ISO 639-1 language code
    redirectURL: 'https://yourapp.com/callback',
  },
});
```

### Available Buy Widget Options

| Option                         | Type                  | Description                                             |
| ------------------------------ | --------------------- | ------------------------------------------------------- |
| `colorCode`                    | string                | Hexadecimal color for widget accent                     |
| `theme`                        | `'dark'` \| `'light'` | Widget appearance theme                                 |
| `themeId`                      | string                | ID of a custom theme                                    |
| `language`                     | string                | ISO 639-1 language code                                 |
| `showAllCurrencies`            | boolean               | Show all supported cryptocurrencies                     |
| `showOnlyCurrencies`           | string                | Comma-separated currency codes to display               |
| `showWalletAddressForm`        | boolean               | Show wallet address input form                          |
| `redirectURL`                  | string                | URL to redirect after completion                        |
| `unsupportedRegionRedirectUrl` | string                | URL for unsupported regions                             |
| `skipUnsupportedRegionScreen`  | boolean               | Skip unsupported region screen                          |
| `defaultCurrencyCode`          | string                | Pre-selected cryptocurrency code                        |
| `walletAddress`                | string                | Pre-filled wallet address                               |
| `walletAddressTag`             | string                | Wallet address memo/tag (for EOS, XRP, etc.)            |
| `walletAddresses`              | string                | JSON string of wallet addresses for multiple currencies |
| `walletAddressTags`            | string                | JSON string of address tags for multiple currencies     |
| `contractAddress`              | string                | Token contract address (DeFi Buy only)                  |
| `networkCode`                  | string                | Network for the token contract (DeFi Buy only)          |
| `lockAmount`                   | boolean               | Prevent user from changing amount                       |
| `email`                        | string                | Pre-fill customer email                                 |
| `externalTransactionId`        | string                | Your transaction identifier                             |
| `externalCustomerId`           | string                | Your customer identifier                                |
| `paymentMethod`                | string                | Pre-select payment method                               |

### Available Sell Widget Options

For `sell()`, the widget config uses `MoonPaySellParams` with different options:

| Option                         | Type                  | Description                                 |
| ------------------------------ | --------------------- | ------------------------------------------- |
| `colorCode`                    | string                | Hexadecimal color for widget accent         |
| `theme`                        | `'dark'` \| `'light'` | Widget appearance theme                     |
| `themeId`                      | string                | ID of a custom theme                        |
| `language`                     | string                | ISO 639-1 language code                     |
| `showAllCurrencies`            | boolean               | Show all supported cryptocurrencies         |
| `showOnlyCurrencies`           | string                | Comma-separated currency codes to display   |
| `showWalletAddressForm`        | boolean               | Show wallet address input form              |
| `redirectURL`                  | string                | URL to redirect after completion            |
| `unsupportedRegionRedirectUrl` | string                | URL for unsupported regions                 |
| `skipUnsupportedRegionScreen`  | boolean               | Skip unsupported region screen              |
| `defaultBaseCurrencyCode`      | string                | Pre-selected cryptocurrency to sell         |
| `refundWalletAddresses`        | string                | JSON string of wallet addresses for refunds |
| `lockAmount`                   | boolean               | Prevent user from changing amount           |
| `email`                        | string                | Pre-fill customer email                     |
| `externalTransactionId`        | string                | Your transaction identifier                 |
| `externalCustomerId`           | string                | Your customer identifier                    |
| `paymentMethod`                | string                | Pre-select payout method                    |

## Next Steps

* [Usage Guide](https://docs.wdk.tether.io/sdk/fiat-modules/fiat-moonpay/usage) - Learn how to integrate MoonPay
* [API Reference](https://docs.wdk.tether.io/sdk/fiat-modules/fiat-moonpay/api-reference) - Complete API documentation