Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

wallets discovery @ next: added mobile os store links support #265

Merged
merged 1 commit into from
Aug 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 30 additions & 4 deletions packages/core/src/discovery.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,37 @@
import { ssrSafeWindow } from "./utils"
import { metaMaskVirtualWallet } from "./wallet/virtualWallets/metaMaskVirtualWallet"

export type OperatingSystemStoreVersion = "ios" | "android"
export type BrowserStoreVersion = "chrome" | "firefox" | "edge" | "safari"

type DownloadsRecord<
SV extends OperatingSystemStoreVersion | BrowserStoreVersion,
DL extends string,
> = Record<SV, DL>

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}` }
| DownloadsRecord<
"chrome",
`https://chrome.google.com/webstore/detail/${string}`
>
| DownloadsRecord<
"firefox",
`https://addons.mozilla.org/en-US/firefox/addon/${string}`
>
| DownloadsRecord<
"edge",
`https://microsoftedge.microsoft.com/addons/detail/${string}`
>
| DownloadsRecord<"safari", `https://apps.apple.com/us/app/${string}`>
| DownloadsRecord<"ios", `https://apps.apple.com/us/app/${string}`>
| DownloadsRecord<
"android",
`https://play.google.com/store/apps/details?id=${string}`
>
}

const wallets: WalletProvider[] = [
Expand All @@ -31,7 +55,9 @@ const wallets: WalletProvider[] = [
"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",
},
ios: `https://link.braavos.app/dapp/${ssrSafeWindow?.location?.host}`,
android: `https://link.braavos.app/dapp/${ssrSafeWindow?.location?.host}`,
} as Record<BrowserStoreVersion | OperatingSystemStoreVersion, any>,
},
{
id: metaMaskVirtualWallet.id,
Expand Down
8 changes: 5 additions & 3 deletions packages/core/src/main.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import discovery, { type WalletProvider } from "./discovery"
import { LocalStorageWrapper } from "./localStorageStore"
import type { GetStarknetOptions, GetStarknetResult } from "./types"
import { pipe } from "./utils"
import { pipe, ssrSafeWindow } from "./utils"
import { filterBy, filterByAuthorized } from "./wallet/filter"
import {
isFullWallet,
Expand Down Expand Up @@ -43,17 +43,19 @@ export { scanObjectForWallets } from "./wallet/scan"
export { isWalletObject } from "./wallet/isWalletObject"

export type {
BrowserStoreVersion,
DisconnectOptions,
GetStarknetOptions,
GetStarknetResult,
GetWalletOptions,
OperatingSystemStoreVersion,
WalletProvider,
} from "./types"

const ssrSafeWindow = typeof window !== "undefined" ? window : {}
export { ssrSafeWindow } from "./utils"

const defaultOptions: GetStarknetOptions = {
windowObject: ssrSafeWindow,
windowObject: ssrSafeWindow ?? {},
isWalletObject,
storageFactoryImplementation: (name: string) => new LocalStorageWrapper(name),
}
Expand Down
6 changes: 5 additions & 1 deletion packages/core/src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,11 @@ import type {
StarknetWindowObject,
} from "@starknet-io/types-js"

export type { WalletProvider } from "./discovery"
export type {
BrowserStoreVersion,
OperatingSystemStoreVersion,
WalletProvider,
} from "./discovery"

export interface GetStarknetOptions {
windowObject: Record<string, any>
Expand Down
3 changes: 3 additions & 0 deletions packages/core/src/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,6 @@ export function ensureKeysArray<T extends object>(keysGuard: {
}) {
return Object.keys(keysGuard) as (keyof T)[]
}

export const ssrSafeWindow: Window | null =
typeof window !== "undefined" ? window : null
56 changes: 43 additions & 13 deletions packages/ui/src/main.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
import show, { type WalletProviderWithStoreVersion } from "./modal"
import sn, {
type BrowserStoreVersion,
type DisconnectOptions,
type GetWalletOptions,
type OperatingSystemStoreVersion,
type RequestAccountsParameters,
type StarknetWindowObject,
type WalletProvider,
} from "@starknet-io/get-starknet-core"
import Bowser from "bowser"

Expand All @@ -12,11 +15,9 @@ export type {
DisconnectOptions,
} from "@starknet-io/get-starknet-core"

type StoreVersion = "chrome" | "firefox" | "edge"

const ssrSafeWindow = typeof window !== "undefined" ? window : null

function getStoreVersionFromBrowser(): StoreVersion | null {
function getBrowserStoreVersionFromBrowser(): BrowserStoreVersion | null {
const browserName = Bowser.getParser(ssrSafeWindow?.navigator.userAgent)
.getBrowserName()
?.toLowerCase()
Expand All @@ -37,10 +38,25 @@ function getStoreVersionFromBrowser(): StoreVersion | null {
}
}

function getOperatingSystemStoreVersionFromBrowser(): OperatingSystemStoreVersion | null {
const os =
Bowser.getParser(ssrSafeWindow?.navigator.userAgent)
.getOS()
?.name?.toLowerCase() ?? null
switch (os) {
case "ios":
case "android":
return os
default:
return null
}
}

export interface ConnectOptions extends GetWalletOptions {
modalMode?: "alwaysAsk" | "canAsk" | "neverAsk"
modalTheme?: "light" | "dark" | "system"
storeVersion?: StoreVersion
storeVersion?: BrowserStoreVersion
osVersion?: OperatingSystemStoreVersion
}

const enableWithVersion = async (
Expand All @@ -55,7 +71,8 @@ const enableWithVersion = async (

export const connect = async ({
modalMode = "canAsk",
storeVersion = getStoreVersionFromBrowser(),
storeVersion = getBrowserStoreVersionFromBrowser(),
osVersion = getOperatingSystemStoreVersionFromBrowser(),
modalTheme,
...restOptions
}: ConnectOptions = {}): Promise<StarknetWindowObject | null> => {
Expand All @@ -71,7 +88,7 @@ export const connect = async ({

// return `wallet` even if it's null/undefined since we aren't allowed
// to show any "connect" related UI
return enableWithVersion(wallet, { silentMode: true })
return enableWithVersion(wallet, { silent_mode: true })
}

const installedWallets = await sn.getAvailableWallets(restOptions)
Expand All @@ -90,13 +107,26 @@ export const connect = async ({

const discoveryWallets = await sn.getDiscoveryWallets(restOptions)

const discoveryWalletsByStoreVersion: WalletProviderWithStoreVersion[] =
discoveryWallets
.filter((w) => Boolean(w.downloads[storeVersion]))
.map(({ downloads, ...w }) => ({
...w,
download: downloads[storeVersion],
}))
const discoveryWalletsByStoreVersion = discoveryWallets.reduce<
WalletProviderWithStoreVersion[]
>((results, w) => {
const download =
// prioritize OS url
w.downloads[osVersion] ||
// fallback to browser url
w.downloads[storeVersion]
if (download) {
const store = Object.keys(w.downloads).find(
(key) => w.downloads[key] === download,
) as keyof WalletProvider["downloads"]

const isMobileStore = store === "android" || store === "ios"
const name = isMobileStore ? `${w.name} Mobile` : `Install ${w.name}`

results.push({ ...w, name, download })
}
return results
}, [])

return show({
lastWallet,
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/src/modal/Modal.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@
cb(null)
}
}}>
Install {discoveryWallet.name}
{discoveryWallet.name}
<img
alt={discoveryWallet.name}
src={discoveryWallet.icon}
Expand Down