@domino-sdk/relay 1.5.2 → 1.6.0

package/dist/sign-in-options-FPKoZMfo.d.ts

@@ -0,0 +1,202 @@
+import { a as AuthProvider } from './submission-input-BzIWutQi.js';
+import { n as createRelayClient, g as RelayError } from './client-CQuTAjSs.js';
+import { C as CosmosChain, a as CosmosNetwork, f as WalletSigner, d as WalletSignInNetwork } from './wallet-YssWxGg8.js';
+
+/** An EIP-1193 provider, such as `window.ethereum` or an EIP-6963 announcement's provider. */
+type Eip1193Provider = {
+    request(args: {
+        method: string;
+        params?: unknown[] | object;
+    }): Promise<unknown>;
+};
+/** The legacy injected Solana shape Phantom, Solflare and Backpack expose. */
+type SolanaInjectedProvider = {
+    connect(): Promise<unknown>;
+    publicKey?: {
+        toBase58(): string;
+    } | null;
+    signMessage(message: Uint8Array, display?: "utf8"): Promise<{
+        signature: Uint8Array;
+    } | Uint8Array>;
+};
+/** The part of a Wallet Standard account Relay uses. */
+type StandardWalletAccount = {
+    readonly address: string;
+    readonly chains: readonly string[];
+};
+/** The part of a Wallet Standard wallet Relay uses; any conforming wallet object fits. */
+type StandardWallet = {
+    readonly name: string;
+    readonly icon?: string;
+    readonly chains: readonly string[];
+    readonly accounts: readonly StandardWalletAccount[];
+    readonly features: Readonly<Record<string, unknown>>;
+};
+/** Keplr's API, which Leap and Cosmostation also implement. */
+type KeplrLike = {
+    enable(chainId: string | string[]): Promise<void>;
+    getKey(chainId: string): Promise<{
+        bech32Address: string;
+    }>;
+    signArbitrary(chainId: string, signer: string, data: string): Promise<{
+        signature: string;
+        pub_key: {
+            type: string;
+            value: string;
+        };
+    }>;
+    /** Adds a chain the wallet does not know, after the user approves it. */
+    experimentalSuggestChain?(chainInfo: CosmosChain["chainInfo"]): Promise<void>;
+};
+/** A wallet found in the page, ready to pass to `relay.wallets.link`. */
+type DiscoveredWallet = {
+    id: string;
+    name: string;
+    icon?: string;
+    signer: WalletSigner;
+};
+/** Signs with an EIP-1193 provider through `personal_sign`. */
+declare function evmSigner(provider: Eip1193Provider, info?: {
+    name?: string;
+}): WalletSigner;
+/** Signs with a legacy injected Solana provider, such as `window.phantom.solana`. */
+declare function solanaSigner(provider: SolanaInjectedProvider, info?: {
+    name?: string;
+}): WalletSigner;
+/** Signs with a Wallet Standard wallet's `solana:signMessage` feature. */
+declare function walletStandardSolanaSigner(wallet: StandardWallet): WalletSigner;
+/**
+ * Signs an ADR-36 message with Keplr or a wallet that implements its API, on the app's chain:
+ * `{ chainId, chainInfo? }` or `"cosmos:<chain ID>"`. When the wallet does not know the chain and
+ * `chainInfo` is given, it suggests the chain to the wallet (`experimentalSuggestChain`) and tries
+ * again; without `chainInfo`, or with a wallet that cannot add chains, it throws an error that
+ * names the chain. Other failures, such as a rejected request, pass through.
+ */
+declare function cosmosSigner(provider: KeplrLike, chain: CosmosChain | CosmosNetwork, info?: {
+    name?: string;
+}): WalletSigner;
+/** EIP-6963 wallets, or `window.ethereum` when none announce themselves within `timeoutMs`. */
+declare function discoverEvmWallets(timeoutMs?: number): Promise<DiscoveredWallet[]>;
+/** Wallet Standard wallets that can sign Solana messages, then legacy injected providers. */
+declare function discoverSolanaWallets(): DiscoveredWallet[];
+/**
+ * Keplr, Leap and Cosmostation, each signing on the app's chain (see `cosmosSigner`). IDs end with
+ * the chain ID.
+ */
+declare function discoverCosmosWallets(chain: CosmosChain | CosmosNetwork): DiscoveredWallet[];
+/**
+ * The Cosmos SDK chains an app offers wallets on: one chain or several, each as
+ * `{ chainId, chainInfo? }` or `"cosmos:<chain ID>"`. Relay has no chain list of its own.
+ */
+type CosmosChains = CosmosChain | CosmosNetwork | readonly (CosmosChain | CosmosNetwork)[];
+/** The chains in `CosmosChains`, as a list. */
+declare function cosmosChainList(chains: CosmosChains | undefined): (CosmosChain | CosmosNetwork)[];
+/** An installed wallet that can sign in on one of the project's enabled wallet families. */
+type SignInWallet = DiscoveredWallet & {
+    network: WalletSignInNetwork;
+};
+/**
+ * The wallets installed in this browser that can sign in with `families`: EVM wallets first, then
+ * Solana wallets, then Cosmos wallets once per chain in `cosmos`. Without `cosmos` there are no
+ * Cosmos wallets. Empty during SSR.
+ */
+declare function discoverSignInWallets(families: readonly WalletSignInNetwork[], cosmos?: CosmosChains): Promise<SignInWallet[]>;
+
+type Auth = ReturnType<typeof createRelayClient>["auth"];
+/** The part of a Relay client sign-in options use. */
+type SignInClient = {
+    auth: Pick<Auth, "providers" | "start" | "emailStart" | "emailVerify"> & {
+        wallet: Pick<Auth["wallet"], "signIn">;
+    };
+};
+/** The sign-in methods a project takes: the platform's OAuth providers and email, and its wallet families. */
+type SignInMethods = {
+    providers: AuthProvider[];
+    email: boolean;
+    /** The wallet families this project enabled for sign-in in Console. */
+    wallets: WalletSignInNetwork[];
+    /**
+     * Set when the methods could not be read, such as when the network failed: they are then email
+     * alone, and the server has the final say when the participant uses it.
+     */
+    error?: RelayError;
+};
+/** Which icon to draw: an OAuth provider's logo, a mail icon, or a generic wallet icon. */
+type SignInIcon = AuthProvider | "email" | "wallet";
+type OAuthSignInOption = {
+    kind: "oauth";
+    /** The provider, such as `"google"`. */
+    id: AuthProvider;
+    /** The provider's name, such as "Google". */
+    label: string;
+    icon: AuthProvider;
+    /** Leaves the page for the provider's consent screen. See `SignInOption` for failures. */
+    start(): Promise<void>;
+};
+type EmailSignInOption = {
+    kind: "email";
+    id: "email";
+    label: string;
+    icon: "email";
+    /** Emails a one-time code to the address. */
+    sendCode(email: string): Promise<void>;
+    /** Signs in with the code sent last. */
+    verifyCode(code: string): Promise<void>;
+};
+type WalletSignInOption = {
+    kind: "wallet";
+    /** Unique among the options, such as `"wallet:eip155:io.metamask"`. */
+    id: string;
+    /** The wallet's name, with its family or chain when another installed wallet has the same name. */
+    label: string;
+    icon: "wallet";
+    /** The wallet's own icon, a data or HTTPS URL, when it announces one. */
+    iconUrl?: string;
+    /** The wallet family it signs in with. */
+    family: WalletSignInNetwork;
+    /** The signer, for `useWallets().link` or `relay.wallets.link`. */
+    signer: WalletSigner;
+    /** Asks the wallet to sign a message, then signs in, or signs up. See `SignInOption` for failures. */
+    start(): Promise<void>;
+};
+/**
+ * One way to sign in that this project takes and this browser can use. From `useSignInOptions()`
+ * its actions never reject: a failure lands in the hook's `error`. From `signInOptions()` they
+ * reject with the failure.
+ */
+type SignInOption = OAuthSignInOption | EmailSignInOption | WalletSignInOption;
+/**
+ * A sign-in method the project enabled that is not offered, and why:
+ * - `cosmos-chains-missing`: the project takes Cosmos wallets but the app named no Cosmos chains.
+ *   For the app's developer; pass `cosmos` to offer them.
+ * - `cosmos-chains-invalid`: the project takes Cosmos wallets but a chain in `cosmos` is not one,
+ *   such as `"cosmoshub-4"` without the `cosmos:` prefix. For the app's developer; `message` says
+ *   what is wrong.
+ * - `no-wallet-installed`: the project takes wallets but this browser has none for its families.
+ *   For the participant; `message` says which to install.
+ */
+type SignInUnavailable = {
+    reason: "cosmos-chains-missing" | "cosmos-chains-invalid" | "no-wallet-installed";
+    families: WalletSignInNetwork[];
+    message: string;
+};
+type SignInOptions = {
+    /** OAuth providers first, then installed wallets, then email. */
+    options: SignInOption[];
+    unavailable: SignInUnavailable[];
+    /** Why the project's methods could not be read; the options are then email alone. */
+    methodsError?: RelayError;
+};
+/**
+ * Every way a participant can sign in to this project from this browser, for apps without React:
+ * the OAuth providers and email the platform configured, and the installed wallets of the families
+ * the project enabled. Cosmos wallets need the app's chains in `cosmos`; without them, or when one
+ * is invalid, they are not offered and `unavailable` says so. Each option signs in with this
+ * client: OAuth leaves the page, email sends a code and then verifies it, a wallet signs a
+ * message. The actions reject when they fail.
+ */
+declare function signInOptions(relay: SignInClient, input?: {
+    cosmos?: CosmosChains;
+}): Promise<SignInOptions>;
+
+export { type CosmosChains as C, type DiscoveredWallet as D, type Eip1193Provider as E, type KeplrLike as K, type OAuthSignInOption as O, type SignInClient as S, type WalletSignInOption as W, type EmailSignInOption as a, type SignInIcon as b, type SignInMethods as c, type SignInOption as d, type SignInOptions as e, type SignInUnavailable as f, type SignInWallet as g, type SolanaInjectedProvider as h, type StandardWallet as i, type StandardWalletAccount as j, cosmosChainList as k, cosmosSigner as l, discoverCosmosWallets as m, discoverEvmWallets as n, discoverSignInWallets as o, discoverSolanaWallets as p, evmSigner as q, solanaSigner as r, signInOptions as s, walletStandardSolanaSigner as w };

package/dist/{submission-input-BZkm6ohU.d.ts → submission-input-BzIWutQi.d.ts}

@@ -1,6 +1,6 @@
 import { z } from 'zod';
-import { cH as LedgerReference, cG as QuestHandle } from './schema-DfJzH2ci.js';
-import { p as ProjectGroupReference } from './groups-Ck-OxzjD.js';
+import { cP as LedgerReference, cO as QuestHandle } from './schema-BPdHSCAc.js';
+import { p as ProjectGroupReference } from './groups-D08JtrZu.js';
 
 /** A Discord message as `ctx.discord.message()` reads it, from the project's Discord server. */
 declare const discordMessageSchema: z.ZodObject<{

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@domino-sdk/relay",
-  "version": "1.5.2",
+  "version": "1.6.0",
   "type": "module",
   "exports": {
     ".": {