Types and Utilities

function createCrossmintWalletSigner(wallet: Wallet<Chain>): EmbeddedOfframpPayer

import { createCrossmintWalletSigner, useWallet } from "@crossmint/client-sdk-react-ui";

export function useOfframpPayer() {
    const { wallet } = useWallet();
    return wallet != null ? createCrossmintWalletSigner(wallet) : null;
}

class OfframpSignatureRejectedError extends Error

import { OfframpSignatureRejectedError, type EmbeddedOfframpPayer } from "@crossmint/client-sdk-react-ui";

// Your wallet code: sign and broadcast the transaction, and resolve with its transaction ID.
declare function sendWithYourWallet(tx: { serializedTransaction: string; chain: string; payerAddress: string }): Promise<string>;
// Your wallet code: true when the user declined the request in their wallet.
declare function isUserRejection(error: unknown): boolean;

export const payer: EmbeddedOfframpPayer = {
    async signAndSendTransaction(tx) {
        try {
            return await sendWithYourWallet(tx);
        } catch (error) {
            if (isUserRejection(error)) {
                throw new OfframpSignatureRejectedError("The user declined the transaction");
            }
            throw error;
        }
    },
};

type OfframpStatus =
    | "loading"
    | "entering-amount"
    | "selecting-bank"
    | "adding-bank"
    | "verifying-identity"
    | "identity-in-review"
    | "reviewing"
    | "awaiting-signature"
    | "confirming-deposit"
    | "completed"
    | "payout-completed"
    | "payout-failed"
    | "failed"

type OfframpErrorReason =
    | "invalid-credentials"
    | "invalid-configuration"
    | "session-spent"
    | "identity-verification-required"
    | "identity-verification-failed"
    | "wallet-ownership-required"
    | "bank-not-supported"
    | "bank-not-verified"
    | "bank-holder-mismatch"
    | "amount-too-low"
    | "amount-too-high"
    | "exact-payout-unsupported"
    | "insufficient-funds"
    | "wallet-rejected"
    | "payout-failed"
    | "provider-error"
    | "unknown"