openHallidayPayments
function opens the Halliday Payments widget and accepts the following configuration options:
Name | Type | Description |
---|---|---|
apiKey | string | Your API key for authorization. |
outputs | Asset[] | The output assets for the widget. |
sandbox | boolean | Whether the widget is in sandbox mode. Defaults to false . |
destinationAddress (optional) | string | The address of the destination of the widget. |
inputs (optional) | Asset[] | The input assets for the widget. |
onramps (optional) | string[] | The onramp providers to use. |
offramps (optional) | string[] | The offramp providers to use. |
customStyles (optional) | object (CustomStyles) | Custom styles for the widget. See customizing styles. |
targetElementId (optional) | string | The ID of the DOM element where the widget should be embedded. Required if windowType is “EMBED”. |
windowType (optional) | “POPUP” | “EMBED” | The desired display mode of the widget. Defaults to “POPUP”. |
owner (optional) | Owner | Owner wallet configuration with address and signing functions. |
funder (optional) | Funder | Funder wallet configuration with signing functions. |
statusCallback (optional) | function | Callback to receive status events. |
connectSigner
utility function to prepare your app’s signer (works with Ethers) for use with Halliday, which will return the necessary signing and transaction functions.
This offers an enhanced user experience for Web3 applications, since users do not need to re-connect their wallet using the Halliday external wallet modal. If the application does not already have a connected wallet, see using the wallet connector.
windowType
and targetElementId
.