feat: [BREAKING] remove adapter from Action class (#32)

* feat: [BREAKING] remove adapter from Action class

* fix: add missing adapter to isSupported

* chore: adjust comment

Author: fsher

examples/mini-blinks/src/App.tsx

@@ -16,7 +16,6 @@ function App() {
   );
   const { action, isLoading } = useAction({
     url: 'solana-action:https://dial.to/api/donate',
-    adapter,
   });
 
   return (
@@ -28,6 +27,7 @@ function App() {
             <span>Loading</span>
           ) : (
             <Miniblink
+              adapter={adapter}
               selector={(currentAction) =>
                 currentAction.actions.find((a) => a.label === 'Donate')!
               }

packages/blinks-core/src/BlinkContainer.tsx

@@ -8,6 +8,7 @@ import {
 import {
   AbstractActionComponent,
   Action,
+  type ActionAdapter,
   type ActionCallbacksConfig,
   type ActionContext,
   type ActionSupportability,
@@ -252,6 +253,7 @@ type NormalizedSecurityLevel = Record<Source, SecurityLevel>;
 
 export interface BlinkContainerProps {
   action: Action;
+  adapter: ActionAdapter;
   selector?: (currentAction: Action) => AbstractActionComponent | null;
   websiteUrl?: string | null;
   websiteText?: string | null;
@@ -263,6 +265,7 @@ export interface BlinkContainerProps {
 // overall flow: check-supportability -> idle/block -> executing -> success/error or chain
 export const BlinkContainer = ({
   action: initialAction,
+  adapter,
   websiteUrl,
   websiteText,
   callbacks,
@@ -387,7 +390,7 @@ export const BlinkContainer = ({
         return;
       }
       try {
-        const supportability = await action.isSupported();
+        const supportability = await action.isSupported(adapter);
         setSupportability(supportability);
       } finally {
         dispatch({
@@ -400,7 +403,13 @@ export const BlinkContainer = ({
     };
 
     checkSupportability(action);
-  }, [action, executionState.status, overallState, isPassingSecurityCheck]);
+  }, [
+    action,
+    adapter,
+    executionState.status,
+    overallState,
+    isPassingSecurityCheck,
+  ]);
 
   const execute = async (
     component: AbstractActionComponent,
@@ -454,7 +463,7 @@ export const BlinkContainer = ({
     };
 
     try {
-      const account = await action.adapter.connect(context);
+      const account = await adapter.connect(context);
       if (!account) {
         dispatch({ type: ExecutionType.RESET });
         return;
@@ -504,7 +513,7 @@ export const BlinkContainer = ({
       };
 
       if (response.type === 'transaction' || !response.type) {
-        const signResult = await action.adapter.signTransaction(
+        const signResult = await adapter.signTransaction(
           response.transaction,
           context,
         );
@@ -514,17 +523,14 @@ export const BlinkContainer = ({
           return;
         }
 
-        await action.adapter.confirmTransaction(signResult.signature, context);
+        await adapter.confirmTransaction(signResult.signature, context);
 
         await chain(signResult.signature);
         return;
       }
 
       if (response.type === 'message') {
-        const signResult = await action.adapter.signMessage(
-          response.data,
-          context,
-        );
+        const signResult = await adapter.signMessage(response.data, context);
 
         if (!signResult || isSignMessageError(signResult)) {
           dispatch({ type: ExecutionType.RESET });

packages/blinks-core/src/api/Action/Action.ts

@@ -61,7 +61,6 @@ export class Action {
     private readonly _data: NextAction,
     private readonly _metadata: ActionMetadata,
     private readonly _supportStrategy: ActionSupportStrategy,
-    private _adapter?: ActionAdapter,
     private readonly _chainMetadata: ActionChainMetadata = { isChained: false },
     private readonly _id?: string,
     private readonly _experimental?: ExperimentalFeatures,
@@ -162,30 +161,9 @@ export class Action {
     };
   }
 
-  public get adapterUnsafe() {
-    return this._adapter;
-  }
-
-  public get adapter() {
-    if (!this._adapter) {
-      throw new Error('No adapter provided');
-    }
-
-    return this._adapter;
-  }
-
-  /**
-   * Set the adapter for the action.
-   * Not recommended to use in react environments, consider using Action.update() instead that returns a new instance.
-   * @param adapter The adapter to set
-   */
-  public setAdapter(adapter: ActionAdapter) {
-    this._adapter = adapter;
-  }
-
-  public async isSupported() {
+  public async isSupported(adapter: ActionAdapter) {
     try {
-      return await this._supportStrategy(this);
+      return await this._supportStrategy(this, adapter);
     } catch (e) {
       console.error(
         `[@dialectlabs/blinks] Failed to check supportability for action ${this.url}`,
@@ -210,7 +188,6 @@ export class Action {
         next.action,
         this.metadata,
         this._supportStrategy,
-        this.adapter,
         {
           isChained: true,
           isInline: true,
@@ -257,7 +234,6 @@ export class Action {
       data,
       metadata,
       this._supportStrategy,
-      this.adapter,
       {
         isChained: true,
         isInline: false,
@@ -272,23 +248,20 @@ export class Action {
     data: NextAction,
     metadata: ActionMetadata,
     supportStrategy: ActionSupportStrategy,
-    adapter?: ActionAdapter,
   ) {
     const id = nanoid();
     return new Action(
       url,
       data,
       metadata,
       supportStrategy,
-      adapter,
       { isChained: false },
       id,
     );
   }
 
   private static async _fetch(
     apiUrl: string,
-    adapter?: ActionAdapter,
     supportStrategy: ActionSupportStrategy = defaultActionSupportStrategy,
     chainMetadata?: ActionChainMetadata,
     id?: string,
@@ -314,7 +287,6 @@ export class Action {
       { ...data, type: 'action' },
       metadata,
       supportStrategy,
-      adapter,
       chainMetadata,
       id,
       data.dialectExperimental,
@@ -323,13 +295,11 @@ export class Action {
 
   static async fetch(
     apiUrl: string,
-    adapter?: ActionAdapter,
     supportStrategy: ActionSupportStrategy = defaultActionSupportStrategy,
   ) {
     const id = nanoid();
     return Action._fetch(
       apiUrl,
-      adapter,
       supportStrategy,
       {
         isChained: false,
@@ -341,23 +311,18 @@ export class Action {
   refresh() {
     return Action._fetch(
       this.url,
-      this.adapter,
       this._supportStrategy,
       this._chainMetadata,
       this._id,
     );
   }
 
-  withUpdate(update: {
-    adapter?: ActionAdapter;
-    supportStrategy?: ActionSupportStrategy;
-  }) {
+  withUpdate(update: { supportStrategy?: ActionSupportStrategy }) {
     return new Action(
       this._url,
       this._data,
       this._metadata,
       update.supportStrategy ?? this._supportStrategy,
-      update.adapter ?? this._adapter,
       this._chainMetadata,
       this._id,
       this._experimental,

packages/blinks-core/src/api/Action/action-supportability.ts

@@ -1,5 +1,6 @@
 import { BlockchainIds, getShortBlockchainName } from '../../utils/caip-2.ts';
 import { ACTIONS_SPEC_VERSION } from '../../utils/dependency-versions.ts';
+import type { ActionAdapter } from '../ActionConfig.ts';
 import type { Action } from './Action.ts';
 
 /**
@@ -44,18 +45,21 @@ export type ActionSupportability =
 
 export type ActionSupportStrategy = (
   action: Action,
+  adapter: ActionAdapter,
 ) => Promise<ActionSupportability>;
 
 /**
  * Default implementation for checking if an action is supported.
  * Checks if the action version and the action blockchain IDs are supported by blink.
  * @param action Action.
+ * @param adapter Action adapter.
  *
  * @see {isVersionSupported}
  * @see {isBlockchainSupported}
  */
 export const defaultActionSupportStrategy: ActionSupportStrategy = async (
   action,
+  adapter,
 ) => {
   const { version: actionVersion, blockchainIds: actionBlockchainIds } =
     action.metadata;
@@ -74,9 +78,7 @@ export const defaultActionSupportStrategy: ActionSupportStrategy = async (
   }
 
   const supportedActionVersion = MAX_SUPPORTED_ACTION_VERSION;
-  const supportedBlockchainIds = !action.adapterUnsafe
-    ? actionBlockchainIds // Assuming action is supported if adapter absent for optimistic compatibility
-    : action.adapterUnsafe.metadata.supportedBlockchainIds;
+  const supportedBlockchainIds = adapter.metadata.supportedBlockchainIds;
 
   const versionSupported = isVersionSupported({
     actionVersion,

packages/blinks-core/src/hooks/useAction.ts

@@ -1,7 +1,6 @@
 import { useEffect, useState } from 'react';
 import {
   Action,
-  type ActionAdapter,
   type ActionSupportStrategy,
   defaultActionSupportStrategy,
 } from '../api';
@@ -10,7 +9,6 @@ import { useActionsRegistryInterval } from './useActionRegistryInterval.ts';
 
 interface UseActionOptions {
   url: string | URL;
-  adapter: ActionAdapter;
   securityRegistryRefreshInterval?: number;
   supportStrategy?: ActionSupportStrategy;
 }
@@ -46,7 +44,6 @@ function useActionApiUrl(url: string | URL) {
 
 export function useAction({
   url,
-  adapter,
   supportStrategy = defaultActionSupportStrategy,
 }: UseActionOptions) {
   const { isRegistryLoaded } = useActionsRegistryInterval();
@@ -63,7 +60,7 @@ export function useAction({
 
     let ignore = false;
     setHasFetched(false);
-    Action.fetch(actionApiUrl, undefined, supportStrategy)
+    Action.fetch(actionApiUrl, supportStrategy)
       .then((action) => {
         if (ignore) {
           return;
@@ -87,23 +84,22 @@ export function useAction({
     // eslint-disable-next-line react-hooks/exhaustive-deps -- only update if actionApiUrl changes
   }, [actionApiUrl, isRegistryLoaded]);
 
-  // this effect handles race conditions between fetching the action adapter change
+  // this effect handles race conditions between fetching the action support strategy changes
   // hasFetched dependency is used instead of action dependency to ensure there's no infinite loop
   useEffect(() => {
     if (!action || !hasFetched) {
       return;
     }
     try {
       const updated = action.withUpdate({
-        adapter,
         supportStrategy,
       });
       setAction(updated);
     } catch (e) {
       console.error('[@dialectlabs/blinks-core] Failed to update action', e);
     }
-    // eslint-disable-next-line react-hooks/exhaustive-deps -- only update if adapter or supportStrategy changes
-  }, [adapter, supportStrategy, hasFetched]);
+    // eslint-disable-next-line react-hooks/exhaustive-deps -- only update if supportStrategy changes
+  }, [supportStrategy, hasFetched]);
 
   return { action, isLoading };
 }

packages/blinks/src/ext/twitter.tsx

@@ -192,7 +192,6 @@ async function handleNewNode(
 
   const action = await Action.fetch(
     actionApiUrl,
-    config,
     options.supportStrategy,
   ).catch(noop);
 
@@ -201,6 +200,7 @@ async function handleNewNode(
   }
 
   const { container: actionContainer, reactRoot } = createAction({
+    config,
     originalUrl: actionUrl,
     action,
     callbacks,
@@ -230,12 +230,14 @@ function createAction({
   action,
   callbacks,
   options,
+  config,
 }: {
   originalUrl: URL;
   action: Action;
   callbacks: Partial<ActionCallbacksConfig>;
   options: NormalizedObserverOptions;
   isInterstitial: boolean;
+  config: ActionAdapter;
 }) {
   const container = document.createElement('div');
   container.className = 'dialect-action-root-container';
@@ -245,6 +247,7 @@ function createAction({
   actionRoot.render(
     <div onClick={(e) => e.stopPropagation()}>
       <Blink
+        adapter={config}
         stylePreset={resolveXStylePreset()}
         action={action}
         websiteUrl={originalUrl.toString()}