@0xtrails/svm 1.0.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,175 @@
+# @0xtrails/svm
+
+Solana (SVM) adapter for the Trails SDK. Enables funding from a Solana wallet into any EVM chain via Relay edge payments.
+
+## Install
+
+```bash
+npm install 0xtrails @0xtrails/svm
+```
+
+## Quick start
+
+```tsx
+import { TrailsWidget, evmAdapter } from '0xtrails'
+import { svmAdapter } from '@0xtrails/svm'
+
+const adapters = [
+  evmAdapter({ wallets: [{ id: 'injected', name: 'MetaMask' }] }),
+  // Auto-detect Wallet Standard Solana wallets.
+  svmAdapter({ rpcUrls: ['https://api.mainnet-beta.solana.com'] }),
+]
+
+export function App() {
+  return (
+    <TrailsWidget
+      apiKey="YOUR_TRAILS_API_KEY"
+      adapters={adapters}
+      fundOptions={{ fundMethodsList: ['connected-wallet'] }}
+      renderInline
+    />
+  )
+}
+```
+
+## `svmAdapter`
+
+```ts
+import { svmAdapter } from '@0xtrails/svm'
+
+svmAdapter(options: SvmAdapterOptions): TrailsAdapterConfig
+```
+
+Returns a `TrailsAdapterConfig` for use in the `adapters` prop of `TrailsWidget` or `TrailsProvider`.
+
+### Options
+
+| Option | Type | Description |
+|--------|------|-------------|
+| `wallet` | Wallet Standard wallet, standard-compatible wallet-adapter value, Kit-style wallet session, or serialized signer wallet | Optional connected Solana wallet source. Omit to auto-detect Wallet Standard wallets. Pass `null` to disable auto-detection. |
+| `rpcUrls` | `readonly string[]` | Optional RPC endpoints for auto-detection / wallet connection fallback |
+| `preferredWalletId` | `string` | Optional auto-detected wallet id to prefer |
+| `silentReconnect` | `boolean` | Whether to silently reconnect previously trusted wallets. Defaults to `true`. |
+| `account` | Wallet Standard account | Optional explicit account |
+| `connection` | Solana RPC connection helpers | Optional RPC helpers |
+| `chain` | `string` | Optional Wallet Standard chain, e.g. `solana:mainnet` |
+
+### Serialized signer wallet
+
+For legacy wallet libraries that require app-level bridging, pass a wallet object with Wallet Standard-style serialized transaction signing:
+
+```ts
+interface SolanaWalletContextValue {
+  connected: boolean
+  publicKey?: { toBase58(): string } | null
+  signSerializedTransaction?: (transactionBytes: Uint8Array) => Promise<Uint8Array>
+  connection?: {
+    rpcEndpoint?: string
+    rpcUrls?: string[]          // fallback RPC endpoints
+    getLatestBlockhash?: (commitment?: string) => Promise<{ blockhash: string; lastValidBlockHeight: number }>
+    sendRawTransaction: (serializedTransaction: unknown, options?: unknown) => Promise<string>
+  } | null
+  walletId?: string
+  walletName?: string
+  walletIcon?: string
+  connect?: (() => Promise<void> | void) | null
+  disconnect?: (() => Promise<void> | void) | null
+}
+```
+
+This shape can be passed as `svmAdapter({ wallet })`. It is also compatible with wallets that expose the Wallet Standard `solana:signTransaction` feature.
+
+## Enabling Solana funding
+
+Solana funding is available through the connected-wallet funding path when `svmAdapter` is configured:
+
+```tsx
+<TrailsWidget
+  apiKey={apiKey}
+  adapters={[svmAdapter({ rpcUrls: ['https://api.mainnet-beta.solana.com'] })]}
+  fundOptions={{
+    fundMethodsList: ['connected-wallet', 'crypto-transfer'],
+  }}
+  renderInline
+/>
+```
+
+Supported origin tokens: **SOL, USDC, USDT, PYUSD**.
+
+## With wagmi
+
+```tsx
+import { TrailsProvider } from '0xtrails'
+import { wagmiAdapter } from '@0xtrails/adapter-wagmi'
+import { svmAdapter } from '@0xtrails/svm'
+import { WagmiProvider } from 'wagmi'
+
+const adapters = [
+  wagmiAdapter({ wagmiConfig }),
+  svmAdapter({ wallet }),
+]
+
+export function App() {
+  return (
+    <WagmiProvider config={wagmiConfig}>
+      <TrailsProvider config={{ trailsApiKey: apiKey, adapters }}>
+        <YourRoutes />
+      </TrailsProvider>
+    </WagmiProvider>
+  )
+}
+```
+
+## Wallet inputs
+
+Usually pass the host wallet directly to `svmAdapter`:
+
+```ts
+svmAdapter({ wallet })
+```
+
+`wallet` may be a Wallet Standard wallet, standard-compatible wallet-adapter value, Kit-style wallet session such as the `wallet` returned by `@solana/react-hooks`' `useWalletConnection()`, or a serialized signer wallet.
+
+Use `createSolanaWallet` only when you need the adapted wallet shape yourself:
+
+```ts
+import { createSolanaWallet } from '@0xtrails/svm'
+
+const solanaWallet = createSolanaWallet({
+  wallet,
+  account, // optional if the wallet already exposes accounts
+  connection,
+  chain: 'solana:mainnet',
+})
+```
+
+For legacy `@solana/wallet-adapter-react` integrations, keep the `@solana/web3.js` bridge in your app and pass the resulting serialized signer as `wallet`:
+
+```ts
+const wallet = {
+  connected,
+  publicKey,
+  signSerializedTransaction: async (bytes: Uint8Array) => {
+    const tx = VersionedTransaction.deserialize(bytes)
+    const signed = await signTransaction(tx)
+    return signed.serialize()
+  },
+}
+
+const adapters = [svmAdapter({ wallet })]
+```
+
+See `apps/examples/solana-legacy-wallet-adapter` for the full bridge.
+
+For `@solana/react-hooks`, pass the connected session directly:
+
+```ts
+const { wallet } = useWalletConnection()
+const adapters = [svmAdapter({ wallet })]
+```
+
+Wallet Standard inputs must expose `solana:signTransaction`. Kit-style wallet sessions must expose `signTransaction`. No `@solana/web3.js` transaction classes are required by `@0xtrails/svm`; legacy apps can bridge them before passing `wallet`.
+
+## License
+
+Apache-2.0

package/dist/index.d.ts

@@ -0,0 +1,179 @@
+"use client";
+
+import { ReactNode } from "react";
+import { TrailsAdapterConfig } from "0xtrails";
+import { SolanaWalletContextValue } from "0xtrails/widget";
+
+//#region src/walletHelpers.d.ts
+type SolanaRpcConnection = NonNullable<SolanaWalletContextValue["connection"]>;
+type WalletStandardAccountLike = {
+  address: string;
+  chains?: readonly string[];
+};
+type WalletStandardSignTransactionFeature = {
+  signTransaction: (...inputs: Array<{
+    account: WalletStandardAccountLike;
+    transaction: Uint8Array;
+    chain?: string;
+  }>) => Promise<Array<{
+    signedTransaction: Uint8Array;
+  }>>;
+};
+type WalletStandardSolanaWalletLike = {
+  name?: string;
+  icon?: string;
+  accounts?: readonly WalletStandardAccountLike[];
+  features?: {
+    "solana:signTransaction"?: WalletStandardSignTransactionFeature;
+  } & Record<string, unknown>;
+};
+type WalletAdapterStandardLike = {
+  standard?: boolean;
+  connected?: boolean;
+  wallet?: WalletStandardSolanaWalletLike;
+};
+type WalletAdapterReactWalletLike = {
+  adapter?: WalletAdapterStandardLike;
+};
+type KitWalletSessionLike = {
+  account?: {
+    address?: {
+      toString(): string;
+    } | string;
+  };
+  connector?: {
+    icon?: string;
+    name?: string;
+  };
+  signTransaction?: (transaction: never) => Promise<unknown>;
+};
+type SerializedSolanaWalletLike = SolanaWalletContextValue;
+type CreateSolanaWalletInput = WalletStandardSolanaWalletLike | WalletAdapterStandardLike | WalletAdapterReactWalletLike | KitWalletSessionLike | SerializedSolanaWalletLike | null | undefined;
+type CreateSolanaWalletOptions = {
+  /** Wallet Standard wallet, standard-compatible wallet adapter, or Kit-style wallet session. */wallet: CreateSolanaWalletInput; /** Optional explicit Wallet Standard account. Defaults to the first Solana account exposed by the wallet. */
+  account?: WalletStandardAccountLike | null;
+  connection?: SolanaRpcConnection | null;
+  connected?: boolean;
+  chain?: string;
+};
+/**
+ * Creates a Trails Solana wallet from a Wallet Standard wallet,
+ * standard-compatible `@solana/wallet-adapter` adapter, or Kit-style wallet
+ * session such as `@solana/react-hooks`' connected `wallet` value.
+ *
+ * This helper signs serialized Solana transaction bytes without requiring
+ * `@solana/web3.js` transaction classes.
+ */
+declare function createSolanaWallet({
+  wallet: inputWallet,
+  account: inputAccount,
+  connection,
+  connected,
+  chain
+}: CreateSolanaWalletOptions): SolanaWalletContextValue | null;
+//#endregion
+//#region src/walletDetection/useDetectedSolanaWallet.d.ts
+interface SvmWalletDetectionOptions {
+  preferredWalletId?: string;
+  rpcUrls?: readonly string[];
+  silentReconnect?: boolean;
+}
+interface UseDetectedSolanaWalletOptions extends SvmWalletDetectionOptions {
+  enabled?: boolean;
+}
+declare function useDetectedSolanaWallet(options?: UseDetectedSolanaWalletOptions): SolanaWalletContextValue | null;
+//#endregion
+//#region src/walletDetection/disconnectPersistence.d.ts
+declare function readDisconnectedWalletIds(): Set<string>;
+/** Clear persisted disconnect state after an explicit reconnect. */
+declare function clearWalletDisconnected(walletId: string): void;
+/** Wrap disconnect so explicit widget disconnects survive page refresh. */
+declare function withPersistentSolanaDisconnect(wallet: SolanaWalletContextValue | null | undefined): SolanaWalletContextValue | null | undefined;
+//#endregion
+//#region src/plugin.d.ts
+interface SvmPluginProviderProps {
+  account?: CreateSolanaWalletOptions["account"];
+  chain?: string;
+  connected?: boolean;
+  connection?: CreateSolanaWalletOptions["connection"];
+  wallet?: CreateSolanaWalletInput;
+  /** RPC endpoints used by the built-in Wallet Standard auto-detection flow. */
+  rpcUrls?: SvmWalletDetectionOptions["rpcUrls"];
+  /** Preferred Wallet Standard wallet id to select/connect first. */
+  preferredWalletId?: SvmWalletDetectionOptions["preferredWalletId"];
+  /** Whether to silently reconnect previously trusted wallets. Defaults to true. */
+  silentReconnect?: SvmWalletDetectionOptions["silentReconnect"];
+  children: ReactNode;
+}
+/**
+ * Registers the SVM plugin and provides the Solana wallet context.
+ * Wrap your app (or TrailsWidget) with this provider to enable Solana edge payments.
+ * Composes with other EdgePlugin providers — each appends to the shared registry.
+ */
+declare function SvmPluginProvider({
+  account,
+  chain,
+  connected,
+  connection,
+  wallet,
+  rpcUrls,
+  preferredWalletId,
+  silentReconnect,
+  children
+}: SvmPluginProviderProps): import("react").JSX.Element;
+//#endregion
+//#region src/edge/executeRelaySolanaQuote.d.ts
+declare class ErrEVMStepInSolanaQuote extends Error {
+  constructor();
+}
+type RelaySolanaQuoteParams = {
+  rpcUrls: readonly string[];
+  signerPublicKeyBase58: string;
+  signSerializedTransaction: (transactionBytes: Uint8Array) => Promise<Uint8Array>;
+  providerQuote: unknown;
+  walletConnection?: {
+    getLatestBlockhash?: (commitment?: string) => Promise<{
+      blockhash: string;
+      lastValidBlockHeight: number;
+    }>;
+    sendRawTransaction: (serializedTransaction: unknown, options?: unknown) => Promise<string>;
+  } | null;
+};
+/**
+ * Signs and submits Solana txs from Relay edge.providerQuote.
+ * Uses Wallet Standard-style serialized transaction signing so the SVM package does not need web3.js transaction classes.
+ * Returns the submitted transaction signatures.
+ */
+declare function executeRelaySolanaQuote(params: RelaySolanaQuoteParams): Promise<string[]>;
+//#endregion
+//#region src/svmAdapter.d.ts
+interface SvmAdapterOptions {
+  account?: CreateSolanaWalletOptions["account"];
+  chain?: string;
+  connected?: boolean;
+  connection?: CreateSolanaWalletOptions["connection"];
+  wallet?: CreateSolanaWalletInput;
+  /** RPC endpoints used by the built-in Wallet Standard auto-detection flow. */
+  rpcUrls?: SvmWalletDetectionOptions["rpcUrls"];
+  /** Preferred Wallet Standard wallet id to select/connect first. */
+  preferredWalletId?: SvmWalletDetectionOptions["preferredWalletId"];
+  /** Whether to silently reconnect previously trusted wallets. Defaults to true. */
+  silentReconnect?: SvmWalletDetectionOptions["silentReconnect"];
+}
+/**
+ * Creates a Trails wallet adapter for Solana (SVM) edge payments.
+ *
+ * Provides the Solana wallet context and auto-registers the SVM edge plugin
+ * when passed to `TrailsWidget` or `TrailsProvider` via the `adapters` prop.
+ *
+ * @example
+ * ```tsx
+ * import { evmAdapter } from "0xtrails"
+ * import { svmAdapter } from "@0xtrails/svm"
+ *
+ * <TrailsWidget adapters={[evmAdapter({ wallets: [...] }), svmAdapter({ wallet })]} />
+ * ```
+ */
+declare function svmAdapter(options: SvmAdapterOptions): TrailsAdapterConfig;
+//#endregion
+export { type CreateSolanaWalletInput, type CreateSolanaWalletOptions, ErrEVMStepInSolanaQuote, type SerializedSolanaWalletLike, type SvmAdapterOptions, SvmPluginProvider, type SvmPluginProviderProps, type SvmWalletDetectionOptions, type WalletStandardAccountLike, type WalletStandardSolanaWalletLike, clearWalletDisconnected, createSolanaWallet, executeRelaySolanaQuote, readDisconnectedWalletIds, svmAdapter, useDetectedSolanaWallet, withPersistentSolanaDisconnect };