Class SCW

constructor

• new SCW(): SCW

• Returns SCW

account

addModule

• addModule(module): Promise<void>

• Parameters

  • module: `0x${string}`

    module address to be added

    W.I.P: 🤫 using simple enum for popular modules

  Returns Promise<void>

createSession

• createSession(config): Promise<void>

• Create a session for a specific address with rules Address could be a contract address or an EOA, rules detact the condition on function arguments

  Automatically adds the session to the session manager instance

  Parameters

  • config: CreateSessionParam

    Session Configuration Object

  Returns Promise<void>

doTx

• doTx(tx, param?): Promise<`0x${string}` | UserOpResponse>

• Send AA transaction using Biconomy Smart Account Client

  Parameters

  • tx: Transaction

    contains transaction object or array of transaction objects having properties like to, data, value
  • Optionalparam: TransactionOpts

    Optional parameters for transaction

    • session is for using Session Validation Module, can be passed as true (for auto selection of suitable session) or sessionID string itself
    • mode is for Paymaster Sponsership, transaction will be sponsored by paymaster subjected to availability

  Returns Promise<`0x${string}` | UserOpResponse>

  UserOpResponse having wait and waitForTxHash functions to wait for transaction to be mined

getActiveModules

• getActiveModules(): Promise<ModuleType[]>

• Get the active validation modules of the SCW

  Returns Promise<ModuleType[]>

  Array of active modules

getOwner

• getOwner(): Promise<string>

• Returns Promise<string>

getPaymasterBalance

• getPaymasterBalance(): Promise<BigInt>

• Returns Promise<BigInt>

getPaymasterData

• getPaymasterData(tx, param?): Promise<PaymasterAndDataResponse>

• Parameters

  • tx: any
  • param: PaymasterParam = ...

  Returns Promise<PaymasterAndDataResponse>

getSCWAddress

• getSCWAddress(): string

• Returns string

init

• init(params): Promise<void>

• Parameters

  • params: {
        arcana_key: string;
        gateway_url?: string;
        private_key?: string;
        provider?: {
            request: EIP1193RequestFn<[{
                Method: "web3_clientVersion";
                Parameters?: undefined;
                ReturnType: string;
            }, {
                Method: "web3_sha3";
                Parameters: [data: `0x${string}`];
                ReturnType: string;
            }, {
                Method: "net_listening";
                Parameters?: undefined;
                ReturnType: boolean;
            }, {
                Method: "net_peerCount";
                Parameters?: undefined;
                ReturnType: `0x${string}`;
            }, {
                Method: "net_version";
                Parameters?: undefined;
                ReturnType: `0x${string}`;
            }]>;
            on<TEvent>(event: TEvent, listener: EIP1193EventMap[TEvent]): void;
            removeListener<TEvent>(event: TEvent, listener: EIP1193EventMap[TEvent]): void;
        };
        rpc_url?: string;
        sessionStorageType?: StorageType;
    }

    • arcana_key: string

    • Optionalgateway_url?: string

    • Optionalprivate_key?: string

    • Optionalprovider?: {
          request: EIP1193RequestFn<[{
              Method: "web3_clientVersion";
              Parameters?: undefined;
              ReturnType: string;
          }, {
              Method: "web3_sha3";
              Parameters: [data: `0x${string}`];
              ReturnType: string;
          }, {
              Method: "net_listening";
              Parameters?: undefined;
              ReturnType: boolean;
          }, {
              Method: "net_peerCount";
              Parameters?: undefined;
              ReturnType: `0x${string}`;
          }, {
              Method: "net_version";
              Parameters?: undefined;
              ReturnType: `0x${string}`;
          }]>;
          on<TEvent>(event: TEvent, listener: EIP1193EventMap[TEvent]): void;
          removeListener<TEvent>(event: TEvent, listener: EIP1193EventMap[TEvent]): void;
      }

      • request: EIP1193RequestFn<[{
            Method: "web3_clientVersion";
            Parameters?: undefined;
            ReturnType: string;
        }, {
            Method: "web3_sha3";
            Parameters: [data: `0x${string}`];
            ReturnType: string;
        }, {
            Method: "net_listening";
            Parameters?: undefined;
            ReturnType: boolean;
        }, {
            Method: "net_peerCount";
            Parameters?: undefined;
            ReturnType: `0x${string}`;
        }, {
            Method: "net_version";
            Parameters?: undefined;
            ReturnType: `0x${string}`;
        }]>

      • on:function

        • on<TEvent>(event, listener): void

        • Type Parameters

          • TEvent extends keyof EIP1193EventMap

          Parameters

          • event: TEvent
          • listener: EIP1193EventMap[TEvent]

          Returns void

      • removeListener:function

        • removeListener<TEvent>(event, listener): void

        • Type Parameters

          • TEvent extends keyof EIP1193EventMap

          Parameters

          • event: TEvent
          • listener: EIP1193EventMap[TEvent]

          Returns void

    • Optionalrpc_url?: string

    • OptionalsessionStorageType?: StorageType

  Returns Promise<void>

initSession

• initSession(sessionStorageType): Promise<void>

• Initialize Session Manager

  Parameters

  • sessionStorageType: StorageType

    Storage Type for Session Manager

  Returns Promise<void>

  void, added session manager to the SCW class

  Throws

  Error if SCW wallet not initialized

removeModule

• removeModule(module): Promise<void>

• Remove module, Sibiling function to addModule,

  Parameters

  • module: `0x${string}`

    address of the module to be removed

  Returns Promise<void>