From eabcf0101e431dddd40729690f418e3eec4cd94b Mon Sep 17 00:00:00 2001 From: Oleksandr Diukarev Date: Fri, 31 Jan 2025 15:34:09 +0700 Subject: [PATCH] ikit docs Update the Customize the list of [sc-17111] and fix warning [sc-17113] --- docs/pages/getting-started/installation.mdx | 2 +- docs/pages/getting-started/signers-list.mdx | 47 ++++++++++++++++--- docs/pages/guides/authenticating-accounts.mdx | 2 +- docs/pages/index.mdx | 2 +- .../pages/miscellaneous/local-development.mdx | 2 +- docs/theme.config.tsx | 4 +- examples/react-dapp/src/app.tsx | 2 +- .../react-dapp/src/ui/molecules/header.tsx | 2 +- .../src/app-in-identitykit-provider.tsx | 2 +- .../react-demo/src/ui/molecules/header.tsx | 2 +- packages/identitykit/package.json | 2 +- .../connect-wallet/icons/copied.tsx | 4 +- .../components/context-providers/provider.tsx | 4 +- 13 files changed, 56 insertions(+), 21 deletions(-) diff --git a/docs/pages/getting-started/installation.mdx b/docs/pages/getting-started/installation.mdx index 7e05ac1d..2cb3b11b 100644 --- a/docs/pages/getting-started/installation.mdx +++ b/docs/pages/getting-started/installation.mdx @@ -159,6 +159,6 @@ Currently known support for the icrc34_delegation standard: | ----------------- | ------------------------- | | NFID Wallet | Yes | | Plug | Yes | -| Oisy | No | +| OISY | No | | Internet Identity | Yes | | Stoic | Yes | diff --git a/docs/pages/getting-started/signers-list.mdx b/docs/pages/getting-started/signers-list.mdx index ebcb1c9a..ba36b3f2 100644 --- a/docs/pages/getting-started/signers-list.mdx +++ b/docs/pages/getting-started/signers-list.mdx @@ -5,27 +5,62 @@ authors: - name: "Dan Ostrovsky" --- +import { Callout } from "nextra/components" + # Customizing the list of wallets you support By default, IdentityKit's `signers` is set to the order in which wallets adopted ICP wallet standards. +1. NFID Wallet +2. Plug Wallet +3. Internet Identity +4. OISY Wallet + +```jsx +import { IdentityKitProvider } from "@nfid/identitykit/react" + +export const App = () => ( + + + +) +``` + +To reorder your wallets list or to change default list, just add +`signers={[your_signers]}{:typescript}` as a prop in your IdentityKitProvider: + +```jsx +import { IdentityKitProvider } from "@nfid/identitykit/react" +import { NFIDW, Plug, InternetIdentity, Stoic, OISY } from "@nfid/identitykit" + +export const App = () => ( + + + +) +``` + - NFID Wallet (signerName: NFIDW) - Plug Wallet (signerName: Plug) - Internet Identity (signerName: InternetIdentity) -- PrimeVault (signerName: PrimeVault) - Stoic (signerName: Stoic) -- _Coming soon:_ Oisy Wallet (signerName: Oisy) +- OISY Wallet (signerName: OISY) + + + Note: By default, IdentityKit will automatically attempt to discover installed signer extensions + that have implemented the [ICRC-94 + standard](https://github.com/dfinity/wg-identity-authentication/blob/main/topics/icrc_94_multi_injected_provider_discovery.md) + and will add the detected ones to the signers list (for example, PrimeVault) + -To reorder your wallets list or to change default list, just add `signers={[your_signers]}{:jsx}` as -a prop in your IdentityKitProvider: +To disable automatic extension signers discovery set `discoverExtensionSigners` to `false:{jsx}`: ```jsx import { IdentityKitProvider } from "@nfid/identitykit/react" -import { NFIDW, Plug, InternetIdentity, Stoic } from "@nfid/identitykit" export const App = () => ( - + ) diff --git a/docs/pages/guides/authenticating-accounts.mdx b/docs/pages/guides/authenticating-accounts.mdx index 1ba6034a..e7c7dcfb 100644 --- a/docs/pages/guides/authenticating-accounts.mdx +++ b/docs/pages/guides/authenticating-accounts.mdx @@ -50,6 +50,6 @@ Currently known support for the icrc27_accounts standard: | ----------------- | ----------------------- | | NFID Wallet | Yes | | Plug | Yes | -| Oisy | Yes | +| OISY | Yes | | Internet Identity | No | | Stoic | No | diff --git a/docs/pages/index.mdx b/docs/pages/index.mdx index 300f9984..0a535af2 100644 --- a/docs/pages/index.mdx +++ b/docs/pages/index.mdx @@ -4,7 +4,7 @@ description: "The complete guide to NFID IdentityKit" ## Package status -![Static Badge](https://img.shields.io/badge/version-1.0.9-blue) +![Static Badge](https://img.shields.io/badge/version-1.0.10-blue) ![Static Badge](https://img.shields.io/badge/build-passing-brightgreen) diff --git a/docs/pages/miscellaneous/local-development.mdx b/docs/pages/miscellaneous/local-development.mdx index f1165d9f..ce4d62fa 100644 --- a/docs/pages/miscellaneous/local-development.mdx +++ b/docs/pages/miscellaneous/local-development.mdx @@ -16,7 +16,7 @@ authors: Because signatures generated from ICP mainnet do not work in local development, executing calls to locally running canisters requires wallet signatures to come from locally installed wallets. -One option is to install the NFID Wallet, Internet Identity, and Oisy canisters locally. Another +One option is to install the NFID Wallet, Internet Identity, and OISY canisters locally. Another option is to use a simple wallet for development purposes and toggle production wallets on when deploying to mainnet. diff --git a/docs/theme.config.tsx b/docs/theme.config.tsx index b4d89af9..a3b4e92b 100644 --- a/docs/theme.config.tsx +++ b/docs/theme.config.tsx @@ -48,10 +48,10 @@ const theme = { light: 38, }, banner: { - key: "1.0.9-release", + key: "1.0.10-release", content: ( - 🎉 @nfid/identitykit@1.0.9 is released. + 🎉 @nfid/identitykit@1.0.10 is released. ), }, diff --git a/examples/react-dapp/src/app.tsx b/examples/react-dapp/src/app.tsx index c5f4cd11..b32f2718 100644 --- a/examples/react-dapp/src/app.tsx +++ b/examples/react-dapp/src/app.tsx @@ -27,7 +27,7 @@ const environment = import.meta.env.VITE_ENVIRONMENT function App() { const { resolvedTheme } = useTheme() const nfidw: IdentityKitSignerConfig = { ...NFIDW, providerUrl: nfidSignerProviderUrl } - const signers = [nfidw, Plug, InternetIdentity, Stoic, OISY].concat( + const signers = [nfidw, Plug, InternetIdentity, OISY, Stoic].concat( environment === "dev" ? [ { diff --git a/examples/react-dapp/src/ui/molecules/header.tsx b/examples/react-dapp/src/ui/molecules/header.tsx index 7bcc35f4..68d54fc9 100644 --- a/examples/react-dapp/src/ui/molecules/header.tsx +++ b/examples/react-dapp/src/ui/molecules/header.tsx @@ -35,7 +35,7 @@ export const Header = () => { href="https://www.npmjs.com/package/@nfid/identitykit" className="absolute text-[10px] text-primary dark:text-teal-500 text-right right-0 bottom-0 mb-[-10px] me-[-10px]" > - v1.0.9 + v1.0.10
diff --git a/examples/react-demo/src/app-in-identitykit-provider.tsx b/examples/react-demo/src/app-in-identitykit-provider.tsx index 29ed4a28..c97140ff 100644 --- a/examples/react-demo/src/app-in-identitykit-provider.tsx +++ b/examples/react-demo/src/app-in-identitykit-provider.tsx @@ -28,7 +28,7 @@ const ConnectFailureError: Record = { } const nfidw: IdentityKitSignerConfig = { ...NFIDW, providerUrl: nfidSignerProviderUrl } -const signers = [nfidw, Plug, InternetIdentity, Stoic, OISY].concat( +const signers = [nfidw, Plug, InternetIdentity, OISY, Stoic].concat( environment === "dev" ? [ { diff --git a/examples/react-demo/src/ui/molecules/header.tsx b/examples/react-demo/src/ui/molecules/header.tsx index 3f348651..d3b5e591 100644 --- a/examples/react-demo/src/ui/molecules/header.tsx +++ b/examples/react-demo/src/ui/molecules/header.tsx @@ -32,7 +32,7 @@ export const Header = () => { href="https://www.npmjs.com/package/@nfid/identitykit" className="absolute text-[10px] text-primary dark:text-teal-500 text-right right-0 bottom-0 mb-[-10px] me-[-10px]" > - v1.0.9 + v1.0.10
diff --git a/packages/identitykit/package.json b/packages/identitykit/package.json index 32c83d28..92d09de5 100644 --- a/packages/identitykit/package.json +++ b/packages/identitykit/package.json @@ -1,6 +1,6 @@ { "name": "@nfid/identitykit", - "version": "1.0.9", + "version": "1.0.10", "description": "A React library for adding wallet connections to dApps.", "keywords": [ "ICP", diff --git a/packages/identitykit/src/libs/react/components/connect-wallet/icons/copied.tsx b/packages/identitykit/src/libs/react/components/connect-wallet/icons/copied.tsx index 534e2684..ff800670 100644 --- a/packages/identitykit/src/libs/react/components/connect-wallet/icons/copied.tsx +++ b/packages/identitykit/src/libs/react/components/connect-wallet/icons/copied.tsx @@ -23,8 +23,8 @@ export function Copied(props: React.SVGProps) { strokeLinecap="round" /> diff --git a/packages/identitykit/src/libs/react/components/context-providers/provider.tsx b/packages/identitykit/src/libs/react/components/context-providers/provider.tsx index 8af2ce53..5dad2194 100644 --- a/packages/identitykit/src/libs/react/components/context-providers/provider.tsx +++ b/packages/identitykit/src/libs/react/components/context-providers/provider.tsx @@ -6,7 +6,7 @@ import { NFIDW, Plug, InternetIdentity, - Stoic, + OISY, } from "../../../../lib" import { useCreateIdentityKit, useCreatePromise, useProceedSigner } from "../../hooks" import { validateUrl } from "../../utils" @@ -65,7 +65,7 @@ export const Provider = ({ const { signers, featuredSigner } = useMemo(() => { const signersList = !props.signers || !props.signers.length - ? [NFIDW, Plug, InternetIdentity, Stoic] + ? [NFIDW, Plug, InternetIdentity, OISY] : props.signers const selectedFeaturedSigner =