@dynamic-labs/wallet-book 0.0.0-exp20240808.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Dynamic Labs, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,142 @@
+# Wallet Book
+
+## Updating Wallet Book
+
+- [Wallet Book](#wallet-book)
+  - [Updating Wallet Book](#updating-wallet-book)
+    - [Adding First Party Wallet](#adding-first-party-wallet)
+    - [Adding injected (browser extension) wallets](#adding-injected-browser-extension-wallets)
+      - [If you need to override any of the following functions: signMessage, getAddress, getSigner, isInstalledOnBrowser, etc...](#if-you-need-to-override-any-of-the-following-functions-signmessage-fetchpublicaddress-getsigner-isinstalledonbrowser-etc)
+      - [Things to remember when adding a new wallet](#things-to-remember-when-adding-a-new-wallet)
+      - [**Checklist before submitting the PR**:](#checklist-before-submitting-the-pr)
+    - [Updating Wallet Connect Data](#updating-wallet-connect-data)
+    - [Adding overrides to WalletConnect](#adding-overrides-to-walletconnect)
+    - [Compile \& Publish](#compile--publish)
+
+### Adding First Party Wallet
+
+Simply add an entry to `firstPartyWalletsData` in `packages/wallet-book/src/build/sources/firstParty/index.ts` and [Compile & Publish](#compile--publish)
+
+For example:
+
+```
+  argentx: {
+    brand: {
+      alt: 'Argent Wallet',
+      primaryColor: '#FF875B',
+      spriteId: 'argentx',
+    },
+    desktop: {
+      chromeId: 'dlcobpjiigpikoobohmabehhmhfoodbb',
+      firefoxId: 'argent-x',
+    },
+    name: 'Argent X',
+    injectedConfig: [
+      {
+        chain: 'EVM',
+        extensionLocators:
+      }
+    ]
+  },
+```
+
+Required fields:
+
+- `brand`
+  - `alt`
+  - `primaryColor`
+  - `spriteId` - The id used in the iconic svg
+  - `name`
+
+Refer to `WalletRecordsSchema` for more schema options
+
+### Adding injected (browser extension) wallets
+
+Similar to [adding first party wallets](#adding-first-party-wallet), we add another key, `injectedConfig` to the wallet object.
+
+```
+...
+injectedConfig: [
+  {
+    chain: 'EVM',
+    extensionLocators: [
+      { flag: 'isOkxWallet', value: true },
+      { flag: 'isOkexWallet', value: true }
+    ],
+    windowLocations: ['okxwallet']
+  }
+],
+name: 'OKX'
+```
+
+#### If you need to override any of the following functions: signMessage, getAddress, getSigner, isInstalledOnBrowser, etc...
+
+1. Create a file in the respective `ethereum/src/injected/` or `solana/src/injected/`. The basic file should follow this form:
+
+```ts
+export class <NameOfConnector> extends InjectedWalletBase {
+  override name = '<Name Here>';
+  override walletConnectorFallback = true; // only specified on evm wallet connectors
+
+  constructor(props: EthWalletConnectorOpts) {
+    super(props);
+
+    this.wallet = findWalletBookWallet(this.walletBook, this.key);
+  }
+
+  // override the methods you need below
+  override async getAddress() {
+    ...
+  }
+}
+```
+
+2. Open `fetchInjectedWalletConnectors.ts` for the respective network package (`etherem/solana/...`) and add the new InjectedWalletBase class to `injectedWalletOverrides` and the key (normalized name) to the `filterInjectedWalletKeyOverrides`
+
+#### Things to remember when adding a new wallet
+
+- `IF the new wallet is also in wallletconnect.json`: make sure that the key used in `firstParty/index.ts` is the `same` as the value from `walletconnect.json` as to inherit the properties from that wallet definition.
+- The value(s) in `windowLocations` map to `window.<value from windowLocations>`. i.e. `okxwallet` means `window.okxwallet`. The values can be a nested path that is dot delimited. If the wallet lives under `window.ethereum` or `window.ethereum.providers`, those window locations are imported by default.
+- For every extension locator you add for the new wallet, add the negation `[{ flag: 'isOkxWallet', value: false }, ...]` to the extensionLocators under the `metamask` key in firstParty.
+- If the new wallet is wallet connect enabled (exists in `walletconnect.json`), make sure to add: `filterFromWalletConnect: true` as a sibling to `injectedConfig` which will filter the wallet from the wallet connect connectors list and use wallet connect as fallback.
+
+#### **Checklist before submitting the PR**:
+
+[ ]: If this change adds a new file to the injected folder, add the wallet key to the `walletBookFallbackList` in `packages/wallet-book/src/build/index.ts`
+
+[ ]: If the name is changing in walletbook, make sure that if there is no new file in the `injected/` folder, you make sure at least the `shortName` normalizes down to the wallet key
+
+```
+myawesomenewwallet: {
+  ...
+  injectedConfig: { ... },
+  shortName: 'My Awesome New Wallet', // maps down to the key if you lowercase and remove special characters and spaces
+  name: 'Awesome Wallet' // this will be displayed in the wallet list and can be changed as long as the `shortName` normalizes to the key
+}
+```
+
+**NOTE:**
+
+Refer to `injectedConfigSchema` for the schema options
+
+### Updating Wallet Connect Data
+
+- Download the data from : https://explorer-api.walletconnect.com/v3/wallets?projectId=XXXX replace
+- Replace packages/wallet-book/src/build/sources/walletConnect/walletconnect.json
+- [Compile & Publish](#compile--publish)
+
+### Adding overrides to WalletConnect
+
+- modify packages/wallet-book/src/build/sources/walletConnectOverrides/index.ts
+- [Compile & Publish](#compile--publish)
+
+### Compile & Publish
+
+The compiled json is stored in `packages/wallet-book/wallet-book.json`. When the file is updated
+and merged to main it will be published to S3 automatically.
+
+Simply, make any changes that you need and:
+
+- run `npx nx compile wallet-book`
+- commit `wallet-book.json`
+- Open PR with changes and merge

package/_virtual/_tslib.cjs

@@ -0,0 +1,49 @@
+'use client'
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+
+function __rest(s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+}
+
+function __awaiter(thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+}
+
+typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
+    var e = new Error(message);
+    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
+};
+
+exports.__awaiter = __awaiter;
+exports.__rest = __rest;

package/_virtual/_tslib.js

@@ -0,0 +1,44 @@
+'use client'
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+
+function __rest(s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+}
+
+function __awaiter(thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+}
+
+typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
+    var e = new Error(message);
+    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
+};
+
+export { __awaiter, __rest };

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@dynamic-labs/wallet-book",
+  "version": "0.0.0-exp20240808.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dynamic-labs/dynamic-auth.git",
+    "directory": "packages/wallet-book"
+  },
+  "bugs": {
+    "url": "https://github.com/dynamic-labs/DynamicAuth/issues"
+  },
+  "homepage": "https://github.com/dynamic-labs/DynamicAuth#readme",
+  "author": "Dynamic Labs, Inc.",
+  "license": "MIT",
+  "main": "./src/index.cjs",
+  "module": "./src/index.js",
+  "types": "./src/index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./src/index.d.ts",
+      "import": "./src/index.js",
+      "require": "./src/index.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "dependencies": {
+    "zod": "3.22.4",
+    "@dynamic-labs/iconic": "0.0.0-exp20240808.0",
+    "@dynamic-labs/logger": "0.0.0-exp20240808.0",
+    "@dynamic-labs/utils": "0.0.0-exp20240808.0",
+    "util": "0.12.5"
+  },
+  "peerDependencies": {
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0"
+  }
+}

package/src/build/index.d.ts

@@ -0,0 +1,76 @@
+import { WalletRecordsSchema } from '../schemas';
+/**
+ * Create a fallback wallet book with only the wallets that are in the fallback list.
+ * They must exist in the main wallet book
+ * @param wallets
+ * @returns
+ */
+export declare const generateWalletFallbacks: (wallets: WalletRecordsSchema) => Record<string, {
+    name: string;
+    brand?: {
+        alt?: string | undefined;
+        primaryColor?: string | undefined;
+        spriteId?: string | undefined;
+    } | undefined;
+    chainGroup?: string | undefined;
+    chains?: string[] | undefined;
+    desktop?: {
+        chromeId?: string | undefined;
+        edgeId?: string | undefined;
+        firefoxId?: string | undefined;
+        native?: string | undefined;
+        operaId?: string | undefined;
+        safariId?: string | undefined;
+        universal?: string | undefined;
+    } | undefined;
+    eip6963Config?: {
+        rdns: string;
+    } | undefined;
+    filterFromWalletConnect?: boolean | undefined;
+    group?: string | undefined;
+    hardwareWallets?: string[] | undefined;
+    injectedConfig?: {
+        chain: string;
+        extensionLocators: {
+            value: boolean;
+            flag: string;
+        }[];
+        providerInterface?: string | undefined;
+        walletStandard?: {
+            name: string;
+            features: string[];
+        } | undefined;
+        walletStandardLocators?: {
+            name: string;
+            locator: string;
+        }[] | undefined;
+        windowLocations?: string[] | undefined;
+    }[] | undefined;
+    mobile?: {
+        android?: string | null | undefined;
+        androidId?: string | undefined;
+        inAppBrowser?: string | null | undefined;
+        ios?: string | null | undefined;
+        iosId?: string | undefined;
+        native?: string | undefined;
+        universal?: string | undefined;
+    } | undefined;
+    mobileExperience?: "in-app-browser" | "redirect" | undefined;
+    shortName?: string | undefined;
+    showOnlyIfInstalled?: boolean | undefined;
+    switchNetworkOnlyFromWallet?: boolean | undefined;
+    walletConnect?: {
+        sdks?: string[] | undefined;
+    } | undefined;
+    walletGroup?: string | undefined;
+    walletLimitations?: {
+        browserExtension?: {
+            unsupportedEvents?: string[] | undefined;
+            unsupportedMethods?: string[] | undefined;
+        } | undefined;
+        mobile?: {
+            unsupportedEvents?: string[] | undefined;
+            unsupportedMethods?: string[] | undefined;
+        } | undefined;
+    } | undefined;
+}>;

package/src/build/sources/firstParty/index.d.ts

@@ -0,0 +1,2 @@
+import { WalletRecordsSchema } from '../../../schemas';
+export declare const firstPartyWalletsData: WalletRecordsSchema;

package/src/build/sources/index.d.ts

@@ -0,0 +1,4 @@
+export * from './firstParty';
+export * from './walletConnect';
+export * from './walletConnectOverrides';
+export * from './walletGroups';

package/src/build/sources/walletConnect/index.d.ts

@@ -0,0 +1,128 @@
+export declare const walletConnectSourceData: Record<string, {
+    id: string;
+    metadata: {
+        shortName: string | null;
+        colors: {
+            primary: string | null;
+            secondary: string | null;
+        };
+    };
+    name: string;
+    chains: string[];
+    desktop: {
+        native: string | null;
+        universal: string | null;
+    };
+    rdns: string | null;
+    mobile: {
+        native: string | null;
+        universal: string | null;
+    };
+    sdks: string[];
+    app: {
+        android: string | null;
+        ios: string | null;
+        opera: string | null;
+        browser: string | null;
+        chrome: string | null;
+        edge: string | null;
+        firefox: string | null;
+        linux: string | null;
+        mac: string | null;
+        safari: string | null;
+        windows: string | null;
+    };
+    app_type: string;
+    category: string | null;
+    description: string | null;
+    homepage: string;
+    image_id: string;
+    image_url: {
+        lg: string;
+        md: string;
+        sm: string;
+    };
+    injected: {
+        injected_id: string;
+        namespace: string;
+    }[] | null;
+    slug: string;
+    updatedAt: string;
+    versions: string[];
+    supported_standards?: {
+        id: string;
+        title: string;
+        url: string;
+        standard_id: number;
+        standard_prefix: string;
+    }[] | undefined;
+}>;
+export declare const walletConnectTransformedData: Promise<Record<string, {
+    name: string;
+    brand?: {
+        alt?: string | undefined;
+        primaryColor?: string | undefined;
+        spriteId?: string | undefined;
+    } | undefined;
+    chainGroup?: string | undefined;
+    chains?: string[] | undefined;
+    desktop?: {
+        chromeId?: string | undefined;
+        edgeId?: string | undefined;
+        firefoxId?: string | undefined;
+        native?: string | undefined;
+        operaId?: string | undefined;
+        safariId?: string | undefined;
+        universal?: string | undefined;
+    } | undefined;
+    eip6963Config?: {
+        rdns: string;
+    } | undefined;
+    filterFromWalletConnect?: boolean | undefined;
+    group?: string | undefined;
+    hardwareWallets?: string[] | undefined;
+    injectedConfig?: {
+        chain: string;
+        extensionLocators: {
+            value: boolean;
+            flag: string;
+        }[];
+        providerInterface?: string | undefined;
+        walletStandard?: {
+            name: string;
+            features: string[];
+        } | undefined;
+        walletStandardLocators?: {
+            name: string;
+            locator: string;
+        }[] | undefined;
+        windowLocations?: string[] | undefined;
+    }[] | undefined;
+    mobile?: {
+        android?: string | null | undefined;
+        androidId?: string | undefined;
+        inAppBrowser?: string | null | undefined;
+        ios?: string | null | undefined;
+        iosId?: string | undefined;
+        native?: string | undefined;
+        universal?: string | undefined;
+    } | undefined;
+    mobileExperience?: "in-app-browser" | "redirect" | undefined;
+    shortName?: string | undefined;
+    showOnlyIfInstalled?: boolean | undefined;
+    switchNetworkOnlyFromWallet?: boolean | undefined;
+    walletConnect?: {
+        sdks?: string[] | undefined;
+    } | undefined;
+    walletGroup?: string | undefined;
+    walletLimitations?: {
+        browserExtension?: {
+            unsupportedEvents?: string[] | undefined;
+            unsupportedMethods?: string[] | undefined;
+        } | undefined;
+        mobile?: {
+            unsupportedEvents?: string[] | undefined;
+            unsupportedMethods?: string[] | undefined;
+        } | undefined;
+    } | undefined;
+}>>;

package/src/build/sources/walletConnect/preprocessors.d.ts

@@ -0,0 +1,14 @@
+export declare const preprocessFilterWCWallets: (sourceData: any) => void;
+export declare const preprocessBrand: (sourceData: any) => void;
+export declare const preprocessDesktop: (sourceData: any) => void;
+export declare const preprocessMobile: (sourceData: any) => void;
+export declare const preprocessSdks: (sourceData: any) => void;
+export declare const preprocessRdns: (sourceData: any) => void;
+export declare const preprocessUniversal: (data: any) => Promise<void>;
+export declare const preprocessNative: (data: any) => void;
+/**
+ * 1. Convert the name to lowercase
+ * 2. Replace all spaces with empty string
+ * 3. Use the new name as the key
+ */
+export declare const preprocessRenameKey: (sourceData: any) => void;