{"_id":"@axim-one/connect","_rev":"3-296d5dd88c3583bc985c9279dc1badde","name":"@axim-one/connect","dist-tags":{"latest":"0.1.1"},"versions":{"0.1.0-alpha.0":{"name":"@axim-one/connect","version":"0.1.0-alpha.0","keywords":["axim","walletconnect","wallet","eip-1193","kaia","web3"],"license":"MIT","_id":"@axim-one/connect@0.1.0-alpha.0","maintainers":[{"name":"axim-inc","email":"ryan@axim.one"}],"homepage":"https://github.com/Axim-one/axim-connect-sdk#readme","bugs":{"url":"https://github.com/Axim-one/axim-connect-sdk/issues"},"dist":{"shasum":"9d62ff3b965c31e8885ad4a880e7fbbd48deaa23","tarball":"https://registry.npmjs.org/@axim-one/connect/-/connect-0.1.0-alpha.0.tgz","fileCount":22,"integrity":"sha512-GaVK7SYgeEtSWb6OMEpofFVjPernTxu3vR7b1Q8CqY1TlOPHOmyZvTrom5q149Robg1S0wiKX44suyEsJRJjmQ==","signatures":[{"sig":"MEQCIFhVk0iyuGBtK76CKFbvv6wgqB/CnGGg5crbCjQp6zoTAiAdrgcwaA0QwS6w0E4996aKJ1AmwM0y1E9dQxGNQ7F1IA==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":49674},"main":"./dist/index.js","type":"module","types":"./dist/index.d.ts","module":"./dist/index.js","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"gitHead":"8672b875706d6f6fc521dd4b055beb6d22c93e5c","scripts":{"build":"tsc -p tsconfig.json"},"_npmUser":{"name":"axim-inc","email":"ryan@axim.one"},"repository":{"url":"git+https://github.com/Axim-one/axim-connect-sdk.git","type":"git","directory":"packages/connect"},"_npmVersion":"10.5.0","description":"Branded WalletConnect v2 connector + EIP-1193 provider for Axim Wallet.","directories":{},"sideEffects":false,"_nodeVersion":"21.7.3","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"peerDependencies":{"viem":">=2","wagmi":">=2","@rainbow-me/rainbowkit":">=2","@walletconnect/universal-provider":">=2"},"peerDependenciesMeta":{"wagmi":{"optional":true},"@rainbow-me/rainbowkit":{"optional":true}},"_npmOperationalInternal":{"tmp":"tmp/connect_0.1.0-alpha.0_1783531221174_0.9533509726915683","host":"s3://npm-registry-packages-npm-production"}},"0.1.0":{"name":"@axim-one/connect","version":"0.1.0","keywords":["axim","walletconnect","wallet","eip-1193","kaia","web3"],"license":"MIT","_id":"@axim-one/connect@0.1.0","maintainers":[{"name":"axim-inc","email":"ryan@axim.one"}],"homepage":"https://github.com/Axim-one/axim-connect-sdk#readme","bugs":{"url":"https://github.com/Axim-one/axim-connect-sdk/issues"},"dist":{"shasum":"21e7018d0bdc96a465b5f830d24a3a11f4b965a7","tarball":"https://registry.npmjs.org/@axim-one/connect/-/connect-0.1.0.tgz","fileCount":22,"integrity":"sha512-lQTg6d+knPf9TOX1x7SgzNhHnw24taqqYFe0759nSwdeM+IOJIWSkFAevS9wWASgiBe1Ignda6ZFz9QEm3i0xw==","signatures":[{"sig":"MEUCICOVNm6X4FvjsTPaX22NLewgqfRxTBFz7Vy5oNdRjaxKAiEAlkuq1wr0dVMSWj3sCTyJl11oV7J8ROgGxWMQCUak4Iw=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@axim-one%2fconnect@0.1.0","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":49666},"main":"./dist/index.js","type":"module","types":"./dist/index.d.ts","module":"./dist/index.js","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"gitHead":"6aea6973e62ed13a5b426b86259a6b5432fa5d56","scripts":{"build":"tsc -p tsconfig.json"},"_npmUser":{"name":"axim-inc","email":"ryan@axim.one"},"repository":{"url":"git+https://github.com/Axim-one/axim-connect-sdk.git","type":"git","directory":"packages/connect"},"_npmVersion":"10.8.2","description":"Branded WalletConnect v2 connector + EIP-1193 provider for Axim Wallet.","directories":{},"sideEffects":false,"_nodeVersion":"20.20.2","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"peerDependencies":{"viem":">=2","wagmi":">=2","@rainbow-me/rainbowkit":">=2","@walletconnect/universal-provider":">=2"},"peerDependenciesMeta":{"wagmi":{"optional":true},"@rainbow-me/rainbowkit":{"optional":true}},"_npmOperationalInternal":{"tmp":"tmp/connect_0.1.0_1784707782076_0.8650855224829344","host":"s3://npm-registry-packages-npm-production"}},"0.1.1":{"name":"@axim-one/connect","version":"0.1.1","description":"Branded WalletConnect v2 connector + EIP-1193 provider for Axim Wallet.","license":"MIT","type":"module","main":"./dist/index.js","module":"./dist/index.js","types":"./dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"sideEffects":false,"scripts":{"build":"tsc -p tsconfig.json"},"keywords":["axim","walletconnect","wallet","eip-1193","kaia","web3"],"publishConfig":{"access":"public"},"repository":{"type":"git","url":"git+https://github.com/Axim-one/axim-connect-sdk.git","directory":"packages/connect"},"homepage":"https://github.com/Axim-one/axim-connect-sdk#readme","bugs":{"url":"https://github.com/Axim-one/axim-connect-sdk/issues"},"peerDependencies":{"@rainbow-me/rainbowkit":">=2","@walletconnect/universal-provider":">=2","viem":">=2","wagmi":">=2"},"peerDependenciesMeta":{"@rainbow-me/rainbowkit":{"optional":true},"wagmi":{"optional":true}},"_id":"@axim-one/connect@0.1.1","gitHead":"190d6a6d8e9a539e4113eef34763efe83b614712","_nodeVersion":"20.20.2","_npmVersion":"10.8.2","dist":{"integrity":"sha512-v4uadmewYQUWmAgee/wUNJpUL1dAcAH8DsPWanICp/8BG8eZELD+Ez6jt9YqCQfGdbgG0AQ+YfzJlvACecfpgg==","shasum":"af4bbc498081c14417bc8ac1916385a271e95e2f","tarball":"https://registry.npmjs.org/@axim-one/connect/-/connect-0.1.1.tgz","fileCount":22,"unpackedSize":49722,"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@axim-one%2fconnect@0.1.1","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQDC90K1z+lptg5yFGYZ50N0PX1dWiDzvI5EByLObbnT8wIgXfFGD4Fj7HG1cndsiixSYU6Q04dthaFbaxutKVELPlM="}]},"_npmUser":{"name":"axim-inc","email":"ryan@axim.one"},"directories":{},"maintainers":[{"name":"axim-inc","email":"ryan@axim.one"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/connect_0.1.1_1784708172171_0.16163840684996678"},"_hasShrinkwrap":false}},"time":{"created":"2026-07-08T17:20:21.005Z","modified":"2026-07-22T08:16:12.668Z","0.1.0-alpha.0":"2026-07-08T17:20:21.436Z","0.1.0":"2026-07-22T08:09:42.217Z","0.1.1":"2026-07-22T08:16:12.308Z"},"bugs":{"url":"https://github.com/Axim-one/axim-connect-sdk/issues"},"license":"MIT","homepage":"https://github.com/Axim-one/axim-connect-sdk#readme","keywords":["axim","walletconnect","wallet","eip-1193","kaia","web3"],"repository":{"type":"git","url":"git+https://github.com/Axim-one/axim-connect-sdk.git","directory":"packages/connect"},"description":"Branded WalletConnect v2 connector + EIP-1193 provider for Axim Wallet.","maintainers":[{"name":"axim-inc","email":"ryan@axim.one"}],"readme":"# @axim-one/connect\n\nBranded WalletConnect v2 connector + EIP‑1193 provider for **Axim Wallet**. Venue‑agnostic core.\n\n```bash\nnpm install @axim-one/connect\n```\n\n`@axim-one/connect` wraps standard WalletConnect v2 (`@walletconnect/universal-provider`) and returns a standard EIP‑1193 provider. It adds a branded connection lifecycle, a RainbowKit custom‑wallet helper, `appId` attribution, and a typed error model. It takes **no hard dependency** on RainbowKit or wagmi.\n\n## Peer dependencies\n\n| Peer | Required when |\n|---|---|\n| `@walletconnect/universal-provider` | always (the transport) |\n| `@rainbow-me/rainbowkit` | only if you use `aximWallet` |\n| `wagmi`, `viem` | provided by your app as usual |\n\n## API\n\n### `createAximConnector(options): AximConnector`\n\nCreate a branded connector over WalletConnect v2.\n\n```ts\nimport { createAximConnector, kaia } from \"@axim-one/connect\";\n\nconst connector = createAximConnector({\n  projectId: WC_PROJECT_ID,  // the consuming dApp's Reown (WalletConnect Cloud) project id\n  appId: \"alphasec\",          // attribution, carried in the WC session (sessionProperties)\n  chains: [kaia],             // ChainConfig[] — optional, defaults to [kaia]\n  // relayUrl: \"wss://…\"      // optional relay override\n});\n```\n\n**`AximConnectorOptions`**\n\n| Field | Type | Notes |\n|---|---|---|\n| `projectId` | `string` | The consuming dApp's [Reown](https://cloud.reown.com) (formerly WalletConnect Cloud) project id (required). The Axim wallet app uses its own separate WalletKit project id. |\n| `appId` | `string` | Attribution id carried in WC `sessionProperties` |\n| `chains?` | `ChainConfig[]` | Scopes the session. Defaults to `[kaia]` |\n| `relayUrl?` | `string` | Override the WC relay URL |\n\n**`AximConnector`**\n\n| Member | Signature | Description |\n|---|---|---|\n| `connect` | `() => Promise<ConnectResult>` | Opens or **reuses** a persistent WC v2 session. Does not force a new pairing if one exists. |\n| `resume` | `() => Promise<ConnectResult \\| null>` | Restores a persisted session without pairing; `null` if none. \"Connect once, stay connected.\" |\n| `disconnect` | `() => Promise<void>` | Tears the session down. |\n| `getProvider` | `() => Eip1193Provider` | Standard EIP‑1193 provider. Throws `NOT_CONNECTED` before `connect()`. |\n| `getStatus` | `() => ConnectorStatus` | `\"disconnected\" \\| \"connecting\" \\| \"connected\"`. |\n| `on` / `off` | `(event, handler) => void` | Subscribe/unsubscribe to connector events. |\n\n**Events** (`AximConnectorEvents`): `connect: ConnectResult`, `disconnect: void`, `accountsChanged: Address[]`, `chainChanged: number`.\n\n```ts\nconnector.on(\"chainChanged\", (id) => console.log(\"chain →\", id));\nconst { address, chainId } = await connector.connect();\nconst provider = connector.getProvider();\n```\n\n### `aximWallet(options): AximWalletConfig`\n\nRainbowKit custom wallet (Path B — no public registry entry). You **inject** RainbowKit's `getWalletConnectConnector` so this package never imports RainbowKit/wagmi.\n\n```ts\nimport { aximWallet } from \"@axim-one/connect\";\nimport { connectorsForWallets, getWalletConnectConnector } from \"@rainbow-me/rainbowkit\";\n\nconst connectors = connectorsForWallets(\n  [{ groupName: \"Recommended\", wallets: [\n      () => aximWallet({ projectId: WC_PROJECT_ID, appId: \"alphasec\", getWalletConnectConnector }),\n  ] }],\n  { appName: \"AlphaSec\", projectId: WC_PROJECT_ID },\n);\n```\n\n**`AximWalletOptions`** = `AximConnectorOptions` plus:\n\n| Field | Type | Notes |\n|---|---|---|\n| `getWalletConnectConnector` | `(p: { projectId }) => unknown` | **Required.** RainbowKit's `getWalletConnectConnector`. |\n| `downloadUrls?` | `{ android?, ios?, chrome?, qrCode?, … }` | Store links surfaced in the RainbowKit UI. |\n\nThe returned wallet sets `mobile.getUri` to wrap the WC URI into the Axim deep link (`https://www.axim.one/wc?uri=…`) and `qrCode.getUri` to the raw URI for desktop QR pairing.\n\n> On the RainbowKit path the WC session is created by RainbowKit/wagmi's own WalletConnect connector, which owns `sessionProperties`; `appId` attribution there is handled by that connector. `createAximConnector` carries `appId` itself for the non‑RainbowKit path.\n\n### Chains\n\n```ts\nimport { kaia, kaiaKairos, KAIA_MAINNET_ID, KAIA_TESTNET_ID } from \"@axim-one/connect\";\n```\n\n`kaia` (id `8217`) and `kaiaKairos` (id `1001`, testnet) are provided as `ChainConfig` (a minimal viem‑compatible chain shape). Pass your own `ChainConfig[]` to scope the session differently.\n\n### Errors\n\nAll SDK errors are `AximError` with a stable `code`:\n\n```ts\nimport { AximError } from \"@axim-one/connect\";\n\ntry {\n  await connector.connect();\n} catch (e) {\n  if (e instanceof AximError && e.code === \"USER_REJECTED\") { /* … */ }\n}\n```\n\nCodes: `USER_REJECTED` · `TIMEOUT` · `DISCONNECTED` · `NOT_CONNECTED` · `CHAIN_NOT_SUPPORTED` · `REQUEST_FAILED` · `NOT_IMPLEMENTED`. Provider errors are mapped via `fromProviderError` (e.g. JSON‑RPC `4001` → `USER_REJECTED`).\n\n## Status\n\nEarly release, published on npm. Implemented and typecheck‑clean; **not yet runtime‑validated** against a live relay/E2E flow — treat as preview. See the repo [README](../../README.md) and [docs.axim.one](https://docs.axim.one).\n\n## License\n\n[MIT](../../LICENSE) © Axim\n","readmeFilename":"README.md"}