`requestProvider`

Core

Wait for an injected Fiber provider, request permission, and return a typed provider instance ready for use.

Signature

function requestProvider(options?: RequestProviderOptions): Promise<CkbFiberProvider>

PERMISSION

Calls provider.enable() by default, so it may open a connection approval prompt.

Parameters

NameTypeDescription

options.timeoutMsnumber

Maximum time to wait for asynchronous provider injection. Defaults to 3000 ms.

options.enableboolean

Set to false to detect a provider without requesting permission.

Response

NameTypeDescription

providerrequiredCkbFiberProvider

A validated provider whose serialized errors are restored to Fiber WebLN runtime error classes.

Example

import { requestProvider } from "@fiber-webln/client";

const fiber = await requestProvider({ timeoutMs: 5_000 });
const info = await fiber.getInfo();

Provider behavior

WASM node

Finds window.ckbfiber injected by the WASM-node browser extension, then opens its origin approval UI.

Remote fnn

Finds the same window.ckbfiber contract injected by remote-fnn and runs the same approval flow.

Notes

Call from a user gesture when possible.
The helper listens for ckbfiber#initialized, so apps do not need to race extension injection.

Errors

MissingProviderError→UserRejectedError→InternalError→