@multiplatform.one/web3 7.33.1 → 7.34.0

package/types/phantom/solana.d.ts

@@ -0,0 +1,113 @@
+import { type PhantomCluster, type PhantomMethod } from "./urls";
+/** The slice of the Web Storage API the session needs. */
+export interface PhantomStorage {
+    getItem(key: string): string | null;
+    setItem(key: string, value: string): void;
+    removeItem(key: string): void;
+}
+/** What is kept between the tap and the return. Base58 throughout. */
+export interface PhantomSessionRecord {
+    dappSecretKey: string;
+    cluster?: PhantomCluster;
+    phantomEncryptionPublicKey?: string;
+    session?: string;
+    publicKey?: string;
+    pending?: {
+        method: PhantomMethod;
+        at: number;
+    };
+}
+export interface PhantomDeeplinkConfig {
+    /** Stored in Phantom's session and checked against its blocklist. */
+    appUrl: string;
+    /**
+     * Where Phantom returns. Defaults to the current page without Phantom's
+     * parameters. An https link shows the app's name and icon in Phantom and
+     * returns to the phone's browser; a custom scheme returns to an app, which
+     * must hand the URL to `handleRedirect` in a page with the same storage.
+     */
+    redirectLink?: string;
+    cluster?: PhantomCluster;
+    /**
+     * Must outlive the trip to Phantom: on Android the return can land in a new
+     * browser tab. Defaults to localStorage.
+     */
+    storage?: PhantomStorage;
+    storageKey?: string;
+    /** Defaults to `location.assign`. Called synchronously inside the request method. */
+    navigate?: (url: string) => void;
+    /** Overrides https://phantom.com/ul. */
+    base?: string;
+    now?: () => number;
+}
+export type PhantomRedirectResult = {
+    ok: true;
+    method: "connect";
+    publicKey: string;
+    session: string;
+} | {
+    ok: true;
+    method: "signTransaction";
+    transaction: Uint8Array;
+} | {
+    ok: true;
+    method: "signAllTransactions";
+    transactions: Uint8Array[];
+} | {
+    ok: true;
+    method: "signAndSendTransaction";
+    signature: string;
+} | {
+    ok: true;
+    method: "signMessage";
+    signature: Uint8Array;
+} | {
+    ok: false;
+    method: PhantomMethod | undefined;
+    errorCode: string;
+    errorMessage: string;
+};
+export declare class PhantomNotConnectedError extends Error {
+    constructor();
+}
+export interface PhantomDeeplink {
+    /** The connected wallet's base58 address, once a connect has come back. */
+    readonly publicKey: string | undefined;
+    readonly connected: boolean;
+    /** The request still waiting for Phantom's answer, if any. */
+    readonly pending: PhantomSessionRecord["pending"];
+    /**
+     * Each request below builds its link from what is already stored and
+     * navigates before returning, with nothing awaited, so it runs inside the
+     * tap's user activation and the browser follows the link without asking.
+     * The link is returned too, for an `<a href>`.
+     */
+    connect(): string;
+    signTransaction(serializedTransaction: Uint8Array): string;
+    signAllTransactions(serializedTransactions: Uint8Array[]): string;
+    /** Deprecated by Phantom: prefer signTransaction and sendSolanaTransaction. */
+    signAndSendTransaction(serializedTransaction: Uint8Array, sendOptions?: Record<string, unknown>): string;
+    signMessage(message: Uint8Array | string, display?: "utf8" | "hex"): string;
+    /** Forgets the session here at once, then tells Phantom. */
+    disconnect(): string;
+    /**
+     * Reads Phantom's answer off the return URL (the current one by default)
+     * and updates the stored session. Undefined when the URL carries none.
+     * Throws PhantomDecryptError when the answer was not sealed for this
+     * session's key.
+     */
+    handleRedirect(href?: string): PhantomRedirectResult | undefined;
+    /** Drops the stored keypair and session without asking Phantom. */
+    forget(): void;
+}
+/** A Solana wallet in the Phantom app, reached from a phone's browser through Phantom's encrypted deeplinks. */
+export declare function phantomDeeplink(config: PhantomDeeplinkConfig): PhantomDeeplink;
+/**
+ * Broadcasts a transaction Phantom signed (signTransaction's answer) through
+ * a Solana JSON-RPC endpoint and returns its base58 signature.
+ */
+export declare function sendSolanaTransaction(rpcUrl: string, signedTransaction: Uint8Array, options?: {
+    skipPreflight?: boolean;
+    fetch?: typeof fetch;
+}): Promise<string>;
+//# sourceMappingURL=solana.d.ts.map

package/types/phantom/solana.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"solana.d.ts","sourceRoot":"","sources":["../../src/phantom/solana.ts"],"names":[],"mappings":"AAOA,OAAO,EAKL,KAAK,cAAc,EACnB,KAAK,aAAa,EACnB,MAAM,QAAQ,CAAC;AAEhB,0DAA0D;AAC1D,MAAM,WAAW,cAAc;IAC7B,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IACpC,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1C,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED,sEAAsE;AACtE,MAAM,WAAW,oBAAoB;IACnC,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,cAAc,CAAC;IACzB,0BAA0B,CAAC,EAAE,MAAM,CAAC;IACpC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE;QAAE,MAAM,EAAE,aAAa,CAAC;QAAC,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC;CACjD;AAED,MAAM,WAAW,qBAAqB;IACpC,qEAAqE;IACrE,MAAM,EAAE,MAAM,CAAC;IACf;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,cAAc,CAAC;IACzB;;;OAGG;IACH,OAAO,CAAC,EAAE,cAAc,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,qFAAqF;IACrF,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;IACjC,wCAAwC;IACxC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,MAAM,CAAC;CACpB;AAED,MAAM,MAAM,qBAAqB,GAC7B;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,MAAM,EAAE,SAAS,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GACnE;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,MAAM,EAAE,iBAAiB,CAAC;IAAC,WAAW,EAAE,UAAU,CAAA;CAAE,GAChE;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,MAAM,EAAE,qBAAqB,CAAC;IAAC,YAAY,EAAE,UAAU,EAAE,CAAA;CAAE,GACvE;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,MAAM,EAAE,wBAAwB,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,GACjE;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,MAAM,EAAE,aAAa,CAAC;IAAC,SAAS,EAAE,UAAU,CAAA;CAAE,GAC1D;IACE,EAAE,EAAE,KAAK,CAAC;IACV,MAAM,EAAE,aAAa,GAAG,SAAS,CAAC;IAClC,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAON,qBAAa,wBAAyB,SAAQ,KAAK;;CAKlD;AAED,MAAM,WAAW,eAAe;IAC9B,2EAA2E;IAC3E,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B,8DAA8D;IAC9D,QAAQ,CAAC,OAAO,EAAE,oBAAoB,CAAC,SAAS,CAAC,CAAC;IAClD;;;;;OAKG;IACH,OAAO,IAAI,MAAM,CAAC;IAClB,eAAe,CAAC,qBAAqB,EAAE,UAAU,GAAG,MAAM,CAAC;IAC3D,mBAAmB,CAAC,sBAAsB,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;IAClE,+EAA+E;IAC/E,sBAAsB,CACpB,qBAAqB,EAAE,UAAU,EACjC,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACpC,MAAM,CAAC;IACV,WAAW,CAAC,OAAO,EAAE,UAAU,GAAG,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,MAAM,CAAC;IAC5E,4DAA4D;IAC5D,UAAU,IAAI,MAAM,CAAC;IACrB;;;;;OAKG;IACH,cAAc,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,qBAAqB,GAAG,SAAS,CAAC;IACjE,mEAAmE;IACnE,MAAM,IAAI,IAAI,CAAC;CAChB;AAgBD,gHAAgH;AAChH,wBAAgB,eAAe,CAAC,MAAM,EAAE,qBAAqB,GAAG,eAAe,CAyM9E;AAQD;;;GAGG;AACH,wBAAsB,qBAAqB,CACzC,MAAM,EAAE,MAAM,EACd,iBAAiB,EAAE,UAAU,EAC7B,OAAO,GAAE;IAAE,aAAa,CAAC,EAAE,OAAO,CAAC;IAAC,KAAK,CAAC,EAAE,OAAO,KAAK,CAAA;CAAO,GAC9D,OAAO,CAAC,MAAM,CAAC,CAyBjB"}

package/types/phantom/urls.d.ts

@@ -1,11 +1,55 @@
 /** Phantom's universal-link host. `https://phantom.app/ul` still answers; Phantom asks new code to use this one. */
 export declare const phantomUniversalLinkBase = "https://phantom.com/ul";
+export type PhantomCluster = "mainnet-beta" | "testnet" | "devnet";
+/**
+ * Deeplink provider methods, all Solana-only. `signAndSendTransaction` is
+ * deprecated by Phantom in favour of `signTransaction` and a broadcast by the
+ * page, and is kept for wallets that still honour it.
+ */
+export type PhantomMethod = "connect" | "disconnect" | "signTransaction" | "signAllTransactions" | "signAndSendTransaction" | "signMessage";
 /**
  * Opens `url` inside Phantom's in-app browser, where Phantom injects
- * `window.phantom.ethereum`. Phantom's deeplinks carry no EVM methods, so
- * this is how a phone's browser reaches its EVM wallet.
+ * `window.phantom.ethereum` and `window.phantom.solana`. Phantom's deeplinks
+ * carry no EVM methods, so this is how a phone's browser reaches its EVM wallet.
  */
 export declare function phantomBrowseUrl(url: string, ref: string, options?: {
     base?: string;
 }): string;
+export interface PhantomConnectUrlParams {
+    appUrl: string;
+    dappEncryptionPublicKey: Uint8Array;
+    redirectLink: string;
+    cluster?: PhantomCluster;
+    base?: string;
+}
+export declare function phantomConnectUrl(params: PhantomConnectUrlParams): string;
+export interface PhantomMethodUrlParams {
+    method: Exclude<PhantomMethod, "connect">;
+    /** The fields the method's payload carries besides `session`. */
+    payload: Record<string, unknown>;
+    session: string;
+    dappEncryptionPublicKey: Uint8Array;
+    sharedSecret: Uint8Array;
+    redirectLink: string;
+    nonce?: Uint8Array;
+    base?: string;
+}
+/** A provider-method link: the payload, session included, sealed with the session's shared secret. */
+export declare function phantomMethodUrl(params: PhantomMethodUrlParams): string;
+/** What Phantom appends to `redirect_link`. */
+export interface PhantomRedirectParams {
+    phantomEncryptionPublicKey?: string;
+    nonce?: string;
+    data?: string;
+    errorCode?: string;
+    errorMessage?: string;
+}
+/**
+ * Reads Phantom's response off the return URL. Phantom appends with `?` even
+ * when the redirect link already has a query, so every `?` after the first is
+ * read as `&`. Returns undefined when the URL carries no response.
+ */
+export declare function parsePhantomRedirect(href: string): PhantomRedirectParams | undefined;
+/** `href` without Phantom's response parameters, for `history.replaceState` after handling it. */
+export declare function stripPhantomRedirect(href: string): string;
 //# sourceMappingURL=urls.d.ts.map

package/types/phantom/urls.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"urls.d.ts","sourceRoot":"","sources":["../../src/phantom/urls.ts"],"names":[],"mappings":"AAAA,oHAAoH;AACpH,eAAO,MAAM,wBAAwB,2BAA2B,CAAC;AAEjE;;;;GAIG;AACH,wBAAgB,gBAAgB,CAC9B,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,EACX,OAAO,GAAE;IAAE,IAAI,CAAC,EAAE,MAAM,CAAA;CAAO,GAC9B,MAAM,CAGR"}
+{"version":3,"file":"urls.d.ts","sourceRoot":"","sources":["../../src/phantom/urls.ts"],"names":[],"mappings":"AAGA,oHAAoH;AACpH,eAAO,MAAM,wBAAwB,2BAA2B,CAAC;AAEjE,MAAM,MAAM,cAAc,GAAG,cAAc,GAAG,SAAS,GAAG,QAAQ,CAAC;AAEnE;;;;GAIG;AACH,MAAM,MAAM,aAAa,GACrB,SAAS,GACT,YAAY,GACZ,iBAAiB,GACjB,qBAAqB,GACrB,wBAAwB,GACxB,aAAa,CAAC;AAIlB;;;;GAIG;AACH,wBAAgB,gBAAgB,CAC9B,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,EACX,OAAO,GAAE;IAAE,IAAI,CAAC,EAAE,MAAM,CAAA;CAAO,GAC9B,MAAM,CAER;AAED,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,MAAM,CAAC;IACf,uBAAuB,EAAE,UAAU,CAAC;IACpC,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,cAAc,CAAC;IACzB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,uBAAuB,GAAG,MAAM,CAQzE;AAED,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,OAAO,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;IAC1C,iEAAiE;IACjE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,uBAAuB,EAAE,UAAU,CAAC;IACpC,YAAY,EAAE,UAAU,CAAC;IACzB,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,sGAAsG;AACtG,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,sBAAsB,GAAG,MAAM,CAavE;AAED,+CAA+C;AAC/C,MAAM,WAAW,qBAAqB;IACpC,0BAA0B,CAAC,EAAE,MAAM,CAAC;IACpC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAUD;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB,GAAG,SAAS,CAapF;AAED,kGAAkG;AAClG,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAUzD"}