@phantom/browser-injected-sdk 0.0.9

package/README.md

@@ -0,0 +1,161 @@
+# Phantom Browser Injected SDK
+
+The Phantom Browser Injected SDK allows you to interact with the Phantom wallet from your web application. (Browser Extension and Mobile)
+
+## Installation
+
+You can install the SDK using npm or yarn:
+
+**npm:**
+
+```bash
+npm install @phantom/browser-injected-sdk
+```
+
+**yarn:**
+
+```bash
+yarn add @phantom/browser-injected-sdk
+```
+
+## Usage
+
+Here's an example of how to import and use the SDK with the Solana plugin:
+
+```typescript
+import { createPhantom } from "@phantom/browser-injected-sdk";
+import { createSolanaPlugin } from "@phantom/browser-injected-sdk/solana"; // Import the solana plugin
+import { createEthereumPlugin } from "@phantom/browser-injected-sdk/ethereum";
+
+// Create a Phantom instance with the Solana plugin
+const phantom = createPhantom({
+  plugins: [createSolanaPlugin(), createEthereumPlugin()],
+});
+
+// Now you can use the Solana-specific methods
+async function connectAndSign() {
+  try {
+    // Attempt to connect to the wallet
+    const connectionResult = await phantom.solana.connect();
+    console.log("Connection Result:", connectionResult.address);
+
+    // Example: Sign in (if supported by the specific provider/plugin)
+    // Construct SolanaSignInData according to your needs
+    const signInData = { domain: window.location.host, statement: "Please sign in to access this dApp." };
+    const signInResult = await phantom.solana.signIn(signInData);
+    console.log("Sign In Result:", signInResult.address);
+
+    // Example: Sign a message
+    const message = new TextEncoder().encode("Hello from Phantom Browser SDK!");
+    const signedMessage = await phantom.solana.signMessage(message, "utf8");
+    console.log("Signed Message:", signedMessage);
+  } catch (error) {
+    console.error("Error interacting with Phantom:", error);
+  }
+}
+
+connectAndSign();
+```
+
+### Available Solana Methods
+
+Once the `phantom.solana` object is initialized, you can access the following methods:
+
+- `connect(opts?: { onlyIfTrusted?: boolean }): Promise<string>`
+  - Connects to the Phantom wallet. Optionally, `onlyIfTrusted` can be set to true to only connect if the dApp is already trusted.
+- `disconnect(): Promise<void>`
+  - Disconnects from the Phantom wallet.
+- `getAccount(): Promise<string | undefined>`
+  - Gets the current connected address
+- `signIn(): Promise<SignInResult>`
+  - Initiates a sign-in request to the wallet.
+- `signMessage(message: Uint8Array | string, display?: 'utf8' | 'hex'): Promise<SignedMessage>`
+  - Prompts the user to sign a given message.
+- `signAndSendTransaction(transaction: Transaction): Promise<{ signature: string; address?: string }>`
+  - Prompts the user to sign **and send** a Kit `Transaction` and returns the confirmed signature.
+
+### Event Handling
+
+The SDK also allows you to listen for `connect`, `disconnect`, and `accountChanged` events:
+
+- `addEventListener(event: PhantomEventType, callback: PhantomEventCallback): () => void`
+
+  - Registers a callback that will be invoked when the specified event occurs.
+  - For the `connect` event, the callback receives the public key (as a string) of the connected account.
+  - For the `disconnect` event, the callback receives no arguments.
+  - For the `accountChanged` event, the callback receives the new public key (as a string).
+  - Returns a function that, when called, will unregister the callback.
+  - Multiple callbacks can be registered for the same event.
+
+  **Example:**
+
+  ```typescript
+  const phantom = createPhantom({ plugins: [createSolanaPlugin()] });
+
+  const handleConnect = (address: string) => {
+    console.log(`Wallet connected with public key: ${address}`);
+  };
+
+  const clearConnectListener = phantom.solana.addEventListener("connect", handleConnect);
+
+  const handleAccountChanged = (newAddress: string) => {
+    console.log(`Account changed to: ${newAddress}`);
+  };
+
+  const clearAccountChangedListener = phantom.solana.addEventListener("accountChanged", handleAccountChanged);
+
+  // To stop listening for a specific event:
+  // clearConnectListener();
+  // clearAccountChangedListener();
+  ```
+
+- `removeEventListener(event: PhantomEventType, callback: PhantomEventCallback): void`
+
+  - Unregisters a previously registered callback for the specified event.
+
+  **Example:**
+
+  ```typescript
+  const phantom = createPhantom({ plugins: [createSolanaPlugin()] });
+
+  const handleDisconnect = () => {
+    console.log("Wallet disconnected");
+  };
+
+  phantom.solana.addEventListener("disconnect", handleDisconnect);
+
+  // To stop listening for this specific disconnect event:
+  // phantom.solana.removeEventListener("disconnect", handleDisconnect);
+  ```
+
+### Creating a transaction
+
+Phantom's SDK uses the `@solana/kit` library to create transactions. You can use the `createTransactionMessage` function to create a transaction message.
+
+```typescript
+import {
+  createSolanaRpc,
+  pipe,
+  createTransactionMessage,
+  setTransactionMessageFeePayer,
+  setTransactionMessageLifetimeUsingBlockhash,
+  address,
+  compileTransaction,
+} from "@solana/kit";
+
+// Example: Sign and send a transaction
+
+const rpc = createSolanaRpc("https://my-rpc-url.com"); // Replace with your own RPC URL
+
+const { value: latestBlockhash } = await rpc.getLatestBlockhash().send();
+
+const transactionMessage = pipe(
+  createTransactionMessage({ version: 0 }),
+  tx => setTransactionMessageFeePayer(address(userPublicKey as string), tx),
+  tx => setTransactionMessageLifetimeUsingBlockhash(latestBlockhash, tx),
+);
+
+const transaction = compileTransaction(transactionMessage);
+
+const { signature } = await phantomInstance.solana.signAndSendTransaction(transaction);
+```

package/dist/auto-confirm/index.d.ts

@@ -0,0 +1,37 @@
+import { P as Plugin } from '../index-2f448acb.js';
+
+type NetworkID = "bip122:000000000019d6689c085ae165831e93" | "bip122:000000000933ea01ad0ee984209779ba" | "solana:101" | "solana:102" | "solana:103" | "solana:localnet" | "eip155:1" | "eip155:11155111" | "eip155:137" | "eip155:80002" | "eip155:8453" | "eip155:84532" | "eip155:143" | "eip155:10143" | "eip155:41454" | "eip155:42161" | "eip155:421614" | "hypercore:mainnet" | "hypercore:testnet" | "sui:mainnet" | "sui:testnet";
+type AutoConfirmEnableParams = {
+    chains?: NetworkID[];
+};
+type AutoConfirmResult = {
+    enabled: boolean;
+    chains: NetworkID[];
+};
+type AutoConfirmSupportedChainsResult = {
+    chains: NetworkID[];
+};
+
+declare function autoConfirmEnable(params?: AutoConfirmEnableParams): Promise<AutoConfirmResult>;
+
+declare function autoConfirmDisable(): Promise<AutoConfirmResult>;
+
+declare function autoConfirmStatus(): Promise<AutoConfirmResult>;
+
+declare function autoConfirmSupportedChains(): Promise<AutoConfirmSupportedChainsResult>;
+
+type AutoConfirmPlugin = {
+    autoConfirmEnable: typeof autoConfirmEnable;
+    autoConfirmDisable: typeof autoConfirmDisable;
+    autoConfirmStatus: typeof autoConfirmStatus;
+    autoConfirmSupportedChains: typeof autoConfirmSupportedChains;
+};
+declare function createAutoConfirmPlugin(): Plugin<AutoConfirmPlugin>;
+
+declare module "../index" {
+    interface Phantom {
+        autoConfirm: AutoConfirmPlugin;
+    }
+}
+
+export { AutoConfirmEnableParams, AutoConfirmResult, AutoConfirmSupportedChainsResult, NetworkID, createAutoConfirmPlugin };

package/dist/auto-confirm/index.js

@@ -0,0 +1,107 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/auto-confirm/index.ts
+var auto_confirm_exports = {};
+__export(auto_confirm_exports, {
+  createAutoConfirmPlugin: () => createAutoConfirmPlugin
+});
+module.exports = __toCommonJS(auto_confirm_exports);
+
+// src/auto-confirm/getProvider.ts
+function getProvider() {
+  if (typeof window === "undefined") {
+    return null;
+  }
+  const provider = window.phantom?.app;
+  if (!provider) {
+    return null;
+  }
+  return provider;
+}
+
+// src/auto-confirm/autoConfirmEnable.ts
+async function autoConfirmEnable(params) {
+  const provider = await getProvider();
+  if (!provider) {
+    throw new Error("Provider not found.");
+  }
+  const result = await provider.request({
+    method: "phantom_auto_confirm_enable",
+    params: params || {}
+  });
+  return result;
+}
+
+// src/auto-confirm/autoConfirmDisable.ts
+async function autoConfirmDisable() {
+  const provider = await getProvider();
+  if (!provider) {
+    throw new Error("Provider not found.");
+  }
+  const result = await provider.request({
+    method: "phantom_auto_confirm_disable",
+    params: {}
+  });
+  return result;
+}
+
+// src/auto-confirm/autoConfirmStatus.ts
+async function autoConfirmStatus() {
+  const provider = await getProvider();
+  if (!provider) {
+    throw new Error("Provider not found.");
+  }
+  const result = await provider.request({
+    method: "phantom_auto_confirm_status",
+    params: {}
+  });
+  return result;
+}
+
+// src/auto-confirm/autoConfirmSupportedChains.ts
+async function autoConfirmSupportedChains() {
+  const provider = getProvider();
+  if (!provider) {
+    throw new Error("Provider not found.");
+  }
+  const result = await provider.request({
+    method: "phantom_auto_confirm_supported_chains",
+    params: {}
+  });
+  return result;
+}
+
+// src/auto-confirm/plugin.ts
+var autoConfirm = {
+  autoConfirmEnable,
+  autoConfirmDisable,
+  autoConfirmStatus,
+  autoConfirmSupportedChains
+};
+function createAutoConfirmPlugin() {
+  return {
+    name: "autoConfirm",
+    create: () => autoConfirm
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createAutoConfirmPlugin
+});

package/dist/auto-confirm/index.mjs

@@ -0,0 +1,82 @@
+import "../chunk-GV6AIHPN.mjs";
+
+// src/auto-confirm/getProvider.ts
+function getProvider() {
+  if (typeof window === "undefined") {
+    return null;
+  }
+  const provider = window.phantom?.app;
+  if (!provider) {
+    return null;
+  }
+  return provider;
+}
+
+// src/auto-confirm/autoConfirmEnable.ts
+async function autoConfirmEnable(params) {
+  const provider = await getProvider();
+  if (!provider) {
+    throw new Error("Provider not found.");
+  }
+  const result = await provider.request({
+    method: "phantom_auto_confirm_enable",
+    params: params || {}
+  });
+  return result;
+}
+
+// src/auto-confirm/autoConfirmDisable.ts
+async function autoConfirmDisable() {
+  const provider = await getProvider();
+  if (!provider) {
+    throw new Error("Provider not found.");
+  }
+  const result = await provider.request({
+    method: "phantom_auto_confirm_disable",
+    params: {}
+  });
+  return result;
+}
+
+// src/auto-confirm/autoConfirmStatus.ts
+async function autoConfirmStatus() {
+  const provider = await getProvider();
+  if (!provider) {
+    throw new Error("Provider not found.");
+  }
+  const result = await provider.request({
+    method: "phantom_auto_confirm_status",
+    params: {}
+  });
+  return result;
+}
+
+// src/auto-confirm/autoConfirmSupportedChains.ts
+async function autoConfirmSupportedChains() {
+  const provider = getProvider();
+  if (!provider) {
+    throw new Error("Provider not found.");
+  }
+  const result = await provider.request({
+    method: "phantom_auto_confirm_supported_chains",
+    params: {}
+  });
+  return result;
+}
+
+// src/auto-confirm/plugin.ts
+var autoConfirm = {
+  autoConfirmEnable,
+  autoConfirmDisable,
+  autoConfirmStatus,
+  autoConfirmSupportedChains
+};
+function createAutoConfirmPlugin() {
+  return {
+    name: "autoConfirm",
+    create: () => autoConfirm
+  };
+}
+export {
+  createAutoConfirmPlugin
+};

package/dist/chunk-GV6AIHPN.mjs

@@ -0,0 +1,18 @@
+var __accessCheck = (obj, member, msg) => {
+  if (!member.has(obj))
+    throw TypeError("Cannot " + msg);
+};
+var __privateAdd = (obj, member, value) => {
+  if (member.has(obj))
+    throw TypeError("Cannot add the same private member more than once");
+  member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
+};
+var __privateMethod = (obj, member, method) => {
+  __accessCheck(obj, member, "access private method");
+  return method;
+};
+
+export {
+  __privateAdd,
+  __privateMethod
+};