fix: update to latest get-starknet dev

src/wallet/connect.ts

@@ -12,7 +12,7 @@ import {
 } from './getst/main';
 
 /**
- * Request Permission for wallet account, return addresses that's allowed by user
+ * Request Permission for wallet account, return addresses that are allowed by user
  * @param silentMode false: request user interaction allowance. true: return only pre-allowed
  * @returns allowed accounts addresses
  */
@@ -51,7 +51,7 @@ export function watchAsset(swo: StarknetWindowObject, asset: WatchAssetParameter
  * @returns boolean
  */
 export function addStarknetChain(swo: StarknetWindowObject, chain: AddStarknetChainParameters) {
-  // Can this set custom RPC endpoint ?
+  // TODO: This should set custom RPC endpoint ?
   return swo.request({
     type: 'wallet_addStarknetChain',
     params: chain,

src/wallet/getst/StarknetWindowObject.d.ts → src/wallet/getst/StarknetWindowObject.ts

@@ -1,27 +1,24 @@
 import { RequestFn } from './rpcMessage';
 import { WalletEventHandlers } from './walletEvents';
 
-declare type WalletEventListener = <E extends keyof WalletEventHandlers>(
+type WalletEventListener = <E extends keyof WalletEventHandlers>(
   event: E,
   handleEvent: WalletEventHandlers[E]
 ) => void;
+
+// Implement the StarknetWindowObject interface with the improved request method
 export interface StarknetWindowObject {
   id: string;
   name: string;
   version: string;
-  icon:
-    | string
-    | {
-        dark: string;
-        light: string;
-      };
+  icon: string | { dark: string; light: string };
   request: RequestFn;
   on: WalletEventListener;
   off: WalletEventListener;
 }
+
 declare global {
   interface Window {
     [key: `starknet_${string}`]: StarknetWindowObject | undefined;
   }
 }
-export {};

src/wallet/getst/discovery.ts

@@ -0,0 +1,36 @@
+export type WalletProvider = {
+  id: string;
+  name: string;
+  icon: string;
+  downloads:
+    | { chrome?: `https://chrome.google.com/webstore/detail/${string}` }
+    | { firefox?: `https://addons.mozilla.org/en-US/firefox/addon/${string}` }
+    | { edge?: `https://microsoftedge.microsoft.com/addons/detail/${string}` };
+};
+
+const wallets: WalletProvider[] = [
+  {
+    id: 'argentX',
+    name: 'Argent X',
+    icon: 'data:image/svg+xml;base64,Cjxzdmcgd2lkdGg9IjQwIiBoZWlnaHQ9IjM2IiB2aWV3Qm94PSIwIDAgNDAgMzYiIGZpbGw9Im5vbmUiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyI+CjxwYXRoIGQ9Ik0yNC43NTgyIC0zLjk3MzY0ZS0wN0gxNC42MjM4QzE0LjI4NTEgLTMuOTczNjRlLTA3IDE0LjAxMzggMC4yODExNzggMTQuMDA2NCAwLjYzMDY4M0MxMy44MDE3IDEwLjQ1NDkgOC44MjIzNCAxOS43NzkyIDAuMjUxODkzIDI2LjM4MzdDLTAuMDIwMjA0NiAyNi41OTMzIC0wLjA4MjE5NDYgMjYuOTg3MiAwLjExNjczNCAyNy4yNzA5TDYuMDQ2MjMgMzUuNzM0QzYuMjQ3OTYgMzYuMDIyIDYuNjQwOTkgMzYuMDg3IDYuOTE3NjYgMzUuODc1NEMxMi4yNzY1IDMxLjc3MjggMTYuNTg2OSAyNi44MjM2IDE5LjY5MSAyMS4zMzhDMjIuNzk1MSAyNi44MjM2IDI3LjEwNTcgMzEuNzcyOCAzMi40NjQ2IDM1Ljg3NTRDMzIuNzQxIDM2LjA4NyAzMy4xMzQxIDM2LjAyMiAzMy4zMzYxIDM1LjczNEwzOS4yNjU2IDI3LjI3MDlDMzkuNDY0MiAyNi45ODcyIDM5LjQwMjIgMjYuNTkzMyAzOS4xMzA0IDI2LjM4MzdDMzAuNTU5NyAxOS43NzkyIDI1LjU4MDQgMTAuNDU0OSAyNS4zNzU5IDAuNjMwNjgzQzI1LjM2ODUgMC4yODExNzggMjUuMDk2OSAtMy45NzM2NGUtMDcgMjQuNzU4MiAtMy45NzM2NGUtMDdaIiBmaWxsPSIjRkY4NzVCIi8+Cjwvc3ZnPgo=',
+    downloads: {
+      chrome:
+        'https://chrome.google.com/webstore/detail/argent-x-starknet-wallet/dlcobpjiigpikoobohmabehhmhfoodbb',
+      firefox: 'https://addons.mozilla.org/en-US/firefox/addon/argent-x',
+      edge: 'https://microsoftedge.microsoft.com/addons/detail/argent-x/ajcicjlkibolbeaaagejfhnofogocgcj',
+    },
+  },
+  {
+    id: 'braavos',
+    name: 'Braavos',
+    icon: 'data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMTAwIiBoZWlnaHQ9IjEwMCIgdmlld0JveD0iMCAwIDEwMCAxMDAiIGZpbGw9Im5vbmUiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyI+CiAgICA8cGF0aAogICAgICAgIGQ9Ik02Mi43MDUgMTMuOTExNkM2Mi44MzU5IDE0LjEzMzMgNjIuNjYyMSAxNC40MDcgNjIuNDAzOSAxNC40MDdDNTcuMTgwNyAxNC40MDcgNTIuOTM0OCAxOC41NDI3IDUyLjgzNTEgMjMuNjgxN0M1MS4wNDY1IDIzLjM0NzcgNDkuMTkzMyAyMy4zMjI2IDQ3LjM2MjYgMjMuNjMxMUM0Ny4yMzYxIDE4LjUxNTYgNDMuMDAwOSAxNC40MDcgMzcuNzk0OCAxNC40MDdDMzcuNTM2NSAxNC40MDcgMzcuMzYyNSAxNC4xMzMxIDM3LjQ5MzUgMTMuOTExMkM0MC4wMjE3IDkuNjI4MDkgNDQuNzIwNCA2Ljc1IDUwLjA5OTEgNi43NUM1NS40NzgxIDYuNzUgNjAuMTc2OSA5LjYyODI2IDYyLjcwNSAxMy45MTE2WiIKICAgICAgICBmaWxsPSJ1cmwoI3BhaW50MF9saW5lYXJfMzcyXzQwMjU5KSIgLz4KICAgIDxwYXRoCiAgICAgICAgZD0iTTc4Ljc2MDYgNDUuODcxOEM4MC4yNzI1IDQ2LjMyOTcgODEuNzAyNSA0NS4wMDU1IDgxLjE3MTQgNDMuNTIyMkM3Ni40MTM3IDMwLjIzMzQgNjEuMzkxMSAyNC44MDM5IDUwLjAyNzcgMjQuODAzOUMzOC42NDQyIDI0LjgwMzkgMjMuMjg2OCAzMC40MDcgMTguODc1NCA0My41OTEyQzE4LjM4MjQgNDUuMDY0NSAxOS44MDgzIDQ2LjM0NDYgMjEuMjk3OCA0NS44ODgxTDQ4Ljg3MiAzNy40MzgxQzQ5LjUzMzEgMzcuMjM1NSA1MC4yMzk5IDM3LjIzNDQgNTAuOTAxNyAzNy40MzQ4TDc4Ljc2MDYgNDUuODcxOFoiCiAgICAgICAgZmlsbD0idXJsKCNwYWludDFfbGluZWFyXzM3Ml80MDI1OSkiIC8+CiAgICA8cGF0aAogICAgICAgIGQ9Ik0xOC44MTMyIDQ4LjE3MDdMNDguODkzNSAzOS4wNDcyQzQ5LjU1MDYgMzguODQ3OCA1MC4yNTI0IDM4Ljg0NzMgNTAuOTA5OCAzOS4wNDU2TDgxLjE3ODEgNDguMTc1MkM4My42OTEyIDQ4LjkzMzIgODUuNDExIDUxLjI0ODMgODUuNDExIDUzLjg3MzVWODEuMjIzM0M4NS4yOTQ0IDg3Ljg5OTEgNzkuMjk3NyA5My4yNSA3Mi42MjQ1IDkzLjI1SDYxLjU0MDZDNjAuNDQ0OSA5My4yNSA1OS41NTc3IDkyLjM2MzcgNTkuNTU3NyA5MS4yNjhWODEuNjc4OUM1OS41NTc3IDc3LjkwMzEgNjEuNzkyMSA3NC40ODU1IDY1LjI0OTggNzIuOTcyOUM2OS44ODQ5IDcwLjk0NTQgNzUuMzY4MSA2OC4yMDI4IDc2LjM5OTQgNjIuNjk5MkM3Ni43MzIzIDYwLjkyMjkgNzUuNTc0MSA1OS4yMDk0IDczLjgwMjQgNTguODU3M0M2OS4zMjI2IDU3Ljk2NjcgNjQuMzU2MiA1OC4zMTA3IDYwLjE1NjQgNjAuMTg5M0M1NS4zODg3IDYyLjMyMTkgNTQuMTQxNSA2NS44Njk0IDUzLjY3OTcgNzAuNjMzN0w1My4xMjAxIDc1Ljc2NjJDNTIuOTQ5MSA3Ny4zMzQ5IDUxLjQ3ODUgNzguNTM2NiA0OS45MDE0IDc4LjUzNjZDNDguMjY5OSA3OC41MzY2IDQ3LjA0NjUgNzcuMjk0IDQ2Ljg2OTYgNzUuNjcxMkw0Ni4zMjA0IDcwLjYzMzdDNDUuOTI0OSA2Ni41NTI5IDQ1LjIwNzkgNjIuNTg4NyA0MC45ODk1IDYwLjcwMThDMzYuMTc3NiA1OC41NDk0IDMxLjM0MTkgNTcuODM0NyAyNi4xOTc2IDU4Ljg1NzNDMjQuNDI2IDU5LjIwOTQgMjMuMjY3OCA2MC45MjI5IDIzLjYwMDcgNjIuNjk5MkMyNC42NDEgNjguMjUwNyAzMC4wODEyIDcwLjkzMDUgMzQuNzUwMyA3Mi45NzI5QzM4LjIwOCA3NC40ODU1IDQwLjQ0MjQgNzcuOTAzMSA0MC40NDI0IDgxLjY3ODlWOTEuMjY2M0M0MC40NDI0IDkyLjM2MiAzOS41NTU1IDkzLjI1IDM4LjQ1OTkgOTMuMjVIMjcuMzc1NkMyMC43MDI0IDkzLjI1IDE0LjcwNTcgODcuODk5MSAxNC41ODkxIDgxLjIyMzNWNTMuODY2M0MxNC41ODkxIDUxLjI0NDYgMTYuMzA0NSA0OC45MzE2IDE4LjgxMzIgNDguMTcwN1oiCiAgICAgICAgZmlsbD0idXJsKCNwYWludDJfbGluZWFyXzM3Ml80MDI1OSkiIC8+CiAgICA8ZGVmcz4KICAgICAgICA8bGluZWFyR3JhZGllbnQgaWQ9InBhaW50MF9saW5lYXJfMzcyXzQwMjU5IiB4MT0iNDkuMzA1NyIgeTE9IjIuMDc5IiB4Mj0iODAuMzYyNyIgeTI9IjkzLjY1OTciCiAgICAgICAgICAgIGdyYWRpZW50VW5pdHM9InVzZXJTcGFjZU9uVXNlIj4KICAgICAgICAgICAgPHN0b3Agc3RvcC1jb2xvcj0iI0Y1RDQ1RSIgLz4KICAgICAgICAgICAgPHN0b3Agb2Zmc2V0PSIxIiBzdG9wLWNvbG9yPSIjRkY5NjAwIiAvPgogICAgICAgIDwvbGluZWFyR3JhZGllbnQ+CiAgICAgICAgPGxpbmVhckdyYWRpZW50IGlkPSJwYWludDFfbGluZWFyXzM3Ml80MDI1OSIgeDE9IjQ5LjMwNTciIHkxPSIyLjA3OSIgeDI9IjgwLjM2MjciIHkyPSI5My42NTk3IgogICAgICAgICAgICBncmFkaWVudFVuaXRzPSJ1c2VyU3BhY2VPblVzZSI+CiAgICAgICAgICAgIDxzdG9wIHN0b3AtY29sb3I9IiNGNUQ0NUUiIC8+CiAgICAgICAgICAgIDxzdG9wIG9mZnNldD0iMSIgc3RvcC1jb2xvcj0iI0ZGOTYwMCIgLz4KICAgICAgICA8L2xpbmVhckdyYWRpZW50PgogICAgICAgIDxsaW5lYXJHcmFkaWVudCBpZD0icGFpbnQyX2xpbmVhcl8zNzJfNDAyNTkiIHgxPSI0OS4zMDU3IiB5MT0iMi4wNzkiIHgyPSI4MC4zNjI3IiB5Mj0iOTMuNjU5NyIKICAgICAgICAgICAgZ3JhZGllbnRVbml0cz0idXNlclNwYWNlT25Vc2UiPgogICAgICAgICAgICA8c3RvcCBzdG9wLWNvbG9yPSIjRjVENDVFIiAvPgogICAgICAgICAgICA8c3RvcCBvZmZzZXQ9IjEiIHN0b3AtY29sb3I9IiNGRjk2MDAiIC8+CiAgICAgICAgPC9saW5lYXJHcmFkaWVudD4KICAgIDwvZGVmcz4KPC9zdmc+',
+    downloads: {
+      chrome:
+        'https://chrome.google.com/webstore/detail/braavos-wallet/jnlgamecbpmbajjfhmmmlhejkemejdma',
+      firefox: 'https://addons.mozilla.org/en-US/firefox/addon/braavos-wallet',
+      edge: 'https://microsoftedge.microsoft.com/addons/detail/braavos-wallet/hkkpjehhcnhgefhbdcgfkeegglpjchdc',
+    },
+  },
+];
+
+export default wallets;

src/wallet/getst/localStorageStore.ts

@@ -0,0 +1,81 @@
+import { generateUID } from './utils';
+
+export interface IStorageWrapper {
+  set(value: string | null | undefined): boolean;
+  get(): string | null | undefined;
+  delete(): boolean;
+}
+
+export class LocalStorageWrapper implements IStorageWrapper {
+  #initialized = false;
+
+  #key: string | undefined = undefined;
+
+  #prefix: string;
+
+  value: string | null | undefined = undefined;
+
+  constructor(key: string) {
+    this.#prefix = key;
+
+    this.#init();
+  }
+
+  set(value: string | null | undefined) {
+    if (!this.#initialized && !this.#init()) {
+      return false;
+    }
+
+    this.delete(); // clear current key
+
+    this.value = value;
+    if (value) {
+      this.#key = `${this.#prefix}-${generateUID()}`;
+      localStorage.setItem(this.#key, value);
+    }
+
+    return true;
+  }
+
+  get() {
+    this.#validateValue();
+    return this.value;
+  }
+
+  delete() {
+    if (!this.#initialized && !this.#init()) {
+      return false;
+    }
+
+    this.value = null;
+    if (this.#key) localStorage.removeItem(this.#key);
+
+    return true;
+  }
+
+  #validateValue() {
+    if (this.value) {
+      this.set(this.value);
+    }
+  }
+
+  #init() {
+    try {
+      if (!this.#initialized && typeof window !== 'undefined') {
+        // init with prev key/value
+        this.#key = Object.keys(localStorage).find((sk) => sk.startsWith(this.#prefix));
+
+        // set initialized as soon as we managed to extract data
+        // from localStorage, so the `set` call below won't result
+        // in a endless-recursive loop
+        this.#initialized = true;
+        if (this.#key) {
+          this.set(localStorage.getItem(this.#key));
+        }
+      }
+    } catch (err) {
+      console.warn(err);
+    }
+    return this.#initialized;
+  }
+}

src/wallet/getst/main.ts

@@ -0,0 +1,131 @@
+/* eslint-disable @typescript-eslint/no-shadow */
+import { type StarknetWindowObject } from './StarknetWindowObject';
+import discovery, { type WalletProvider } from './discovery';
+import { LocalStorageWrapper } from './localStorageStore';
+import { Permission } from './rpcMessage';
+import type { GetStarknetOptions, GetStarknetResult } from './types';
+import { pipe } from './utils';
+import { filterBy, filterByAuthorized } from './wallet/filter';
+import { isWalletObj } from './wallet/isWalletObject';
+import { scanObjectForWallets } from './wallet/scan';
+import { sortBy } from './wallet/sort';
+
+export type { StarknetWindowObject } from './StarknetWindowObject';
+
+export type {
+  AddDeclareTransactionParameters,
+  AddDeclareTransactionResult,
+  AddDeployAccountTransactionParameters,
+  AddDeployAccountTransactionResult,
+  AddInvokeTransactionParameters,
+  AddInvokeTransactionResult,
+  AddStarknetChainParameters,
+  RequestAccountsParameters,
+  StarknetChainId,
+  SwitchStarknetChainParameters,
+  GetDeploymentDataResult,
+  WatchAssetParameters,
+  TypedData,
+  RequestFn,
+  RpcMessage,
+  IsParamsOptional,
+  RpcTypeToMessageMap,
+  RequestFnCall,
+} from './rpcMessage';
+
+export type {
+  WalletEvents,
+  AccountChangeEventHandler,
+  NetworkChangeEventHandler,
+  WalletEventHandlers,
+} from './walletEvents';
+
+export { Permission } from './rpcMessage';
+
+export type {
+  DisconnectOptions,
+  GetStarknetOptions,
+  GetStarknetResult,
+  GetWalletOptions,
+  WalletProvider,
+} from './types';
+
+const ssrSafeWindow = typeof window !== 'undefined' ? window : {};
+
+const defaultOptions: GetStarknetOptions = {
+  windowObject: ssrSafeWindow,
+  isWalletObject: isWalletObj,
+  storageFactoryImplementation: (name: string) => new LocalStorageWrapper(name),
+};
+
+export function getStarknet(options: Partial<GetStarknetOptions> = {}): GetStarknetResult {
+  const { storageFactoryImplementation, windowObject, isWalletObject } = {
+    ...defaultOptions,
+    ...options,
+  };
+  const lastConnectedStore = storageFactoryImplementation('gsw-last');
+
+  return {
+    getAvailableWallets: async (options = {}) => {
+      const availableWallets = scanObjectForWallets(windowObject, isWalletObject);
+      return pipe<StarknetWindowObject[]>(
+        (_) => filterBy(_, options),
+        (_) => sortBy(_, options.sort)
+      )(availableWallets);
+    },
+    getAuthorizedWallets: async (options = {}) => {
+      const availableWallets = scanObjectForWallets(windowObject, isWalletObject);
+      return pipe<StarknetWindowObject[]>(
+        (_) => filterByAuthorized(_),
+        (_) => filterBy(_, options),
+        (_) => sortBy(_, options.sort)
+      )(availableWallets);
+    },
+    getDiscoveryWallets: async (options = {}) => {
+      return pipe<WalletProvider[]>(
+        (_) => filterBy(_, options),
+        (_) => sortBy(_, options.sort)
+      )(discovery);
+    },
+    getLastConnectedWallet: async () => {
+      const lastConnectedWalletId = lastConnectedStore.get();
+      const allWallets = scanObjectForWallets(windowObject, isWalletObject);
+      const lastConnectedWallet = allWallets.find((w) => w.id === lastConnectedWalletId);
+      const [firstAuthorizedWallet] = await filterByAuthorized(
+        lastConnectedWallet ? [lastConnectedWallet] : []
+      );
+
+      if (!firstAuthorizedWallet) {
+        lastConnectedStore.delete();
+        return null;
+      }
+
+      return firstAuthorizedWallet;
+    },
+    enable: async (wallet, options) => {
+      await wallet.request({
+        type: 'wallet_requestAccounts',
+        params: {
+          silentMode: options?.silentMode,
+        },
+      });
+
+      // check for permissions
+      const permissions = await wallet.request({
+        type: 'wallet_getPermissions',
+      });
+      if (!permissions?.includes(Permission.Accounts)) {
+        throw new Error('Failed to connect to wallet');
+      }
+      lastConnectedStore.set(wallet.id);
+      return wallet;
+    },
+    disconnect: async ({ clearLastWallet } = {}) => {
+      if (clearLastWallet) {
+        lastConnectedStore.delete();
+      }
+    },
+  };
+}
+
+export default getStarknet();