@swapped/connect-sdk / core / SwappedConnectConfig

Type Alias: SwappedConnectConfig

SwappedConnectConfig = object

Defined in: src/config/config.types.ts:31

Configuration for createSwappedConnectClient.

Properties

apiBaseUrl?

optional apiBaseUrl?: string

Defined in: src/config/config.types.ts:40

Swapped API base domain URL. Overrides the environment default.

---

environment?

optional environment?: SwappedConnectEnvironment

Defined in: src/config/config.types.ts:38

Target Swapped environment. Applies default apiBaseUrl and widgetBaseUrl. Defaults to production. Pass staging for sessions created against the staging API. Explicit apiBaseUrl / widgetBaseUrl override the matching environment default.

---

modules?

optional modules?: readonly SwappedConnectModule[]

Defined in: src/config/config.types.ts:63

Payment modules to construct. Omit (or pass every module) to enable all. wallets and coinbase mount a hidden {widgetBaseUrl}/gateway iframe; exchangePay and cashApp do not. Accessing a module that was not listed throws MODULE_NOT_ENABLED. Payment method lists hide methods for modules that were left out.

---

remoteConfigUrl?

optional remoteConfigUrl?: string

Defined in: src/config/config.types.ts:53

Override the remote config JSON URL. Honored only when both the host page and the URL are localhost (localhost / 127.0.0.1 / [::1]). Anywhere else the value is ignored with a console warning and the environment CloudFront URL is used instead (production.config.json or staging.config.json).

---

sessionId?

optional sessionId?: string

Defined in: src/config/config.types.ts:55

Initial session ID to load.

---

wallets?

optional wallets?: SwappedConnectWalletsConfig

Defined in: src/config/config.types.ts:65

Wallet module options.

---

widgetBaseUrl?

optional widgetBaseUrl?: string

Defined in: src/config/config.types.ts:45

Gateway host base domain URL (serves /gateway). Overrides the environment default. Localhost is allowed for development.