> ## Documentation Index
> Fetch the complete documentation index at: https://docs.chipipay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API reference

> ChipiConnector options, discoverability, and compatibility.

## Options

```ts theme={null}
new ChipiConnector({
  walletUrl: "https://wallet.chipipay.com", // hosted wallet base URL (default)
  id: "chipi",
  name: "Connect with Chipi",
  icon: "data:image/svg+xml;base64,...",
  register: true, // self-register on window for scanning dApps (default)
});
```

Instantiating the connector also **self-registers** the wallet on `window`
(`window.starknet_chipi` + `starknet:announceWallet`, the get-starknet /
Starknet-Wallet-Standard discovery path) so dApps that *scan* for wallets find
"Connect with Chipi" without importing this package — the same trick Cartridge
Controller uses. Pass `register: false` to opt out; it's a no-op during SSR.

The **browser extension** performs this exact same registration from a content
script, so it works even on dApps that never import
`@chipi-stack/starknet-connector` at all.

## Compatibility & limits

* `@starknet-react/core` **>= 3** (peer) · `starknet` **>= 8.1.2** (peer).
* **Starknet mainnet** — pass a mainnet `provider`.
* **Popup-based** (external dApps). An in-app-browser ("parent") mode is in the
  transport but not yet exposed.
* One approval at a time; a dApp that fires two prompts truly simultaneously has
  its second request rejected (most dApps serialize).

## Package

|            |                                                                                                                         |
| ---------- | ----------------------------------------------------------------------------------------------------------------------- |
| npm        | [`@chipi-stack/starknet-connector`](https://www.npmjs.com/package/@chipi-stack/starknet-connector)                      |
| Source     | [`chipi-pay/sdks/starknet-connector`](https://github.com/chipi-pay/sdks/tree/main/starknet-connector)                   |
| Example    | [`chipi-pay/sdks/examples/connect-with-chipi`](https://github.com/chipi-pay/sdks/tree/main/examples/connect-with-chipi) |
| Versioning | Independent — not part of the fixed `@chipi-stack/*` changeset group                                                    |