Skip to main content

InitializeWaasOptions

@coinbase/waas-sdk-webAPI


Type alias: InitializeWaasOptions

InitializeWaasOptions: Object

Type declaration

collectAndReportMetrics?

optional collectAndReportMetrics: boolean

Whether to collect report performance metrics to Coinbase via Datadog.

This includes performance metrics on key user journeys, including a failure reason and total time taken. This helps us improve the product.

enableHostedBackups?

optional enableHostedBackups: boolean

If enabled, your wallets will be encrypted and sync'd, and subsequent calls to waas.wallets.restore(passcode) will trigger a restore of the wallet whose JWT you signed previously on the server (via issueAuthTokenForUser).

prod?

optional prod: boolean

Indicates that the SDK is being used with the production secure sandbox. This requires contacting Coinbase to specifically whitelist your domain, for heightened security, and should be done before you launch your product to production

projectId?

optional projectId: string

The Coinbase Developer Platform project ID that is associated with your application. This is required when using Coinbase hosted user authentication.

sandboxPath?

optional sandboxPath: string

This option provides additional security by sandboxing all MPC operations inside of an embedded iframe.

If unset, this will default to a CB-hosted sandbox. For production environments, the CB-hosted sandbox is not sufficient.

verbose?

optional verbose: boolean

Whether to enable verbose logging for the SDK.

waasUrl?

optional waasUrl: string

base server URL for waas.

If unset, this will default to the most sensible option (i.e production.)

Was this helpful?