@cartridge/controller 0.5.7 → 0.5.8

package/src/provider.ts

@@ -1,10 +1,13 @@
 import { WalletAccount } from "starknet";
 import {
   AddInvokeTransactionParameters,
+  AddStarknetChainParameters,
   Errors,
   Permission,
+  RequestAccountsParameters,
   RequestFn,
   StarknetWindowObject,
+  SwitchStarknetChainParameters,
   TypedData,
   WalletEventHandlers,
   WalletEventListener,
@@ -13,7 +16,6 @@ import {
 import manifest from "../package.json";
 
 import { icon } from "./icon";
-import { ProviderOptions } from "./types";
 
 export default abstract class BaseProvider implements StarknetWindowObject {
   public id = "controller";
@@ -21,16 +23,9 @@ export default abstract class BaseProvider implements StarknetWindowObject {
   public version = manifest.version;
   public icon = icon;
 
-  public rpc: URL;
   public account?: WalletAccount;
   public subscriptions: WalletEvents[] = [];
 
-  constructor(options: ProviderOptions) {
-    const { rpc } = options;
-
-    this.rpc = new URL(rpc);
-  }
-
   request: RequestFn = async (call) => {
     switch (call.type) {
       case "wallet_getPermissions":
@@ -47,8 +42,11 @@ export default abstract class BaseProvider implements StarknetWindowObject {
           return [this.account.address];
         }
 
+        const silentMode =
+          call.params && (call.params as RequestAccountsParameters).silent_mode;
+
         this.account = await this.probe();
-        if (!this.account) {
+        if (!this.account && !silentMode) {
           this.account = await this.connect();
         }
 
@@ -66,26 +64,22 @@ export default abstract class BaseProvider implements StarknetWindowObject {
           data: "wallet_watchAsset not implemented",
         } as Errors.UNEXPECTED_ERROR;
 
-      case "wallet_addStarknetChain":
-        throw {
-          code: 63,
-          message: "An unexpected error occurred",
-          data: "wallet_addStarknetChain not implemented",
-        } as Errors.UNEXPECTED_ERROR;
+      case "wallet_addStarknetChain": {
+        let params = call.params as AddStarknetChainParameters;
+        return this.addStarknetChain(params);
+      }
 
-      case "wallet_switchStarknetChain":
-        throw {
-          code: 63,
-          message: "An unexpected error occurred",
-          data: "wallet_switchStarknetChain not implemented",
-        } as Errors.UNEXPECTED_ERROR;
+      case "wallet_switchStarknetChain": {
+        let params = call.params as SwitchStarknetChainParameters;
+        return this.switchStarknetChain(params.chainId);
+      }
 
       case "wallet_requestChainId":
         if (!this.account) {
           throw {
             code: 63,
             message: "An unexpected error occurred",
-            data: "wallet_deploymentData not implemented",
+            data: "Account not initialized",
           } as Errors.UNEXPECTED_ERROR;
         }
 
@@ -103,7 +97,7 @@ export default abstract class BaseProvider implements StarknetWindowObject {
           throw {
             code: 63,
             message: "An unexpected error occurred",
-            data: "wallet_deploymentData not implemented",
+            data: "Account not initialized",
           } as Errors.UNEXPECTED_ERROR;
         }
 
@@ -173,6 +167,26 @@ export default abstract class BaseProvider implements StarknetWindowObject {
     }
   };
 
+  protected emitNetworkChanged(chainId: string) {
+    this.subscriptions
+      .filter((sub) => sub.type === "networkChanged")
+      .forEach((sub) => {
+        (sub.handler as WalletEventHandlers["networkChanged"])(chainId);
+      });
+  }
+
+  protected emitAccountsChanged(accounts: string[]) {
+    this.subscriptions
+      .filter((sub) => sub.type === "accountsChanged")
+      .forEach((sub) => {
+        (sub.handler as WalletEventHandlers["accountsChanged"])(accounts);
+      });
+  }
+
   abstract probe(): Promise<WalletAccount | undefined>;
   abstract connect(): Promise<WalletAccount | undefined>;
+  abstract switchStarknetChain(chainId: string): Promise<boolean>;
+  abstract addStarknetChain(
+    chain: AddStarknetChainParameters,
+  ): Promise<boolean>;
 }

package/src/session/provider.ts

@@ -5,6 +5,7 @@ import { KEYCHAIN_URL } from "../constants";
 import BaseProvider from "../provider";
 import { toWasmPolicies } from "../utils";
 import { SessionPolicies } from "@cartridge/presets";
+import { AddStarknetChainParameters } from "@starknet-io/types-js";
 
 interface SessionRegistration {
   username: string;
@@ -26,14 +27,15 @@ export default class SessionProvider extends BaseProvider {
   public name = "Controller Session";
 
   protected _chainId: string;
-
+  protected _rpcUrl: string;
   protected _username?: string;
   protected _redirectUrl: string;
   protected _policies: SessionPolicies;
 
   constructor({ rpc, chainId, policies, redirectUrl }: SessionOptions) {
-    super({ rpc });
+    super();
 
+    this._rpcUrl = rpc;
     this._chainId = chainId;
     this._redirectUrl = redirectUrl;
     this._policies = policies;
@@ -76,7 +78,7 @@ export default class SessionProvider extends BaseProvider {
       this._redirectUrl
     }&redirect_query_name=startapp&policies=${JSON.stringify(
       this._policies,
-    )}&rpc_url=${this.rpc}`;
+    )}&rpc_url=${this._rpcUrl}`;
 
     localStorage.setItem("lastUsedConnector", this.id);
     window.open(url, "_blank");
@@ -84,6 +86,14 @@ export default class SessionProvider extends BaseProvider {
     return;
   }
 
+  switchStarknetChain(_chainId: string): Promise<boolean> {
+    throw new Error("switchStarknetChain not implemented");
+  }
+
+  addStarknetChain(_chain: AddStarknetChainParameters): Promise<boolean> {
+    throw new Error("addStarknetChain not implemented");
+  }
+
   disconnect(): Promise<void> {
     localStorage.removeItem("sessionSigner");
     localStorage.removeItem("session");
@@ -127,7 +137,7 @@ export default class SessionProvider extends BaseProvider {
 
     this._username = sessionRegistration.username;
     this.account = new SessionAccount(this, {
-      rpcUrl: this.rpc.toString(),
+      rpcUrl: this._rpcUrl,
       privateKey: signer.privKey,
       address: sessionRegistration.address,
       ownerGuid: sessionRegistration.ownerGuid,

package/src/telegram/provider.ts

@@ -11,6 +11,7 @@ import SessionAccount from "../session/account";
 import BaseProvider from "../provider";
 import { toWasmPolicies } from "../utils";
 import { SessionPolicies } from "@cartridge/presets";
+import { AddStarknetChainParameters } from "@starknet-io/types-js";
 
 interface SessionRegistration {
   username: string;
@@ -25,6 +26,7 @@ export default class TelegramProvider extends BaseProvider {
   protected _chainId: string;
   protected _username?: string;
   protected _policies: SessionPolicies;
+  private _rpcUrl: string;
 
   constructor({
     rpc,
@@ -37,10 +39,9 @@ export default class TelegramProvider extends BaseProvider {
     policies: SessionPolicies;
     tmaUrl: string;
   }) {
-    super({
-      rpc,
-    });
+    super();
 
+    this._rpcUrl = rpc;
     this._tmaUrl = tmaUrl;
     this._chainId = chainId;
     this._policies = policies;
@@ -77,7 +78,7 @@ export default class TelegramProvider extends BaseProvider {
       this._tmaUrl
     }&redirect_query_name=startapp&policies=${JSON.stringify(
       this._policies,
-    )}&rpc_url=${this.rpc}`;
+    )}&rpc_url=${this._rpcUrl}`;
 
     localStorage.setItem("lastUsedConnector", this.id);
     openLink(url);
@@ -86,6 +87,14 @@ export default class TelegramProvider extends BaseProvider {
     return;
   }
 
+  switchStarknetChain(_chainId: string): Promise<boolean> {
+    throw new Error("switchStarknetChain not implemented");
+  }
+
+  addStarknetChain(_chain: AddStarknetChainParameters): Promise<boolean> {
+    throw new Error("addStarknetChain not implemented");
+  }
+
   disconnect(): Promise<void> {
     cloudStorage.deleteItem("sessionSigner");
     cloudStorage.deleteItem("session");
@@ -118,7 +127,7 @@ export default class TelegramProvider extends BaseProvider {
 
     this._username = sessionRegistration.username;
     this.account = new SessionAccount(this, {
-      rpcUrl: this.rpc.toString(),
+      rpcUrl: this._rpcUrl,
       privateKey: signer.privKey,
       address: sessionRegistration.address,
       ownerGuid: sessionRegistration.ownerGuid,

package/src/types.ts

@@ -7,16 +7,12 @@ import {
 } from "starknet";
 import {
   AddInvokeTransactionResult,
+  ChainId,
   Signature,
   TypedData,
 } from "@starknet-io/types-js";
 import { KeychainIFrame, ProfileIFrame } from "./iframe";
-import {
-  ColorMode,
-  Policies,
-  Policy,
-  SessionPolicies,
-} from "@cartridge/presets";
+import { ColorMode, Policy, SessionPolicies } from "@cartridge/presets";
 
 export type Session = {
   chainId: constants.StarknetChainId;
@@ -100,7 +96,7 @@ export type ControllerAccounts = Record<ContractAddress, CartridgeID>;
 export interface Keychain {
   probe(rpcUrl: string): Promise<ProbeReply | ConnectError>;
   connect(
-    policies: Policies,
+    policies: SessionPolicies,
     rpcUrl: string,
   ): Promise<ConnectReply | ConnectError>;
   disconnect(): void;
@@ -134,6 +130,7 @@ export interface Keychain {
   openPurchaseCredits(): void;
   openExecute(calls: Call[]): Promise<void>;
 }
+
 export interface Profile {
   navigate(path: string): void;
 }
@@ -161,13 +158,17 @@ export type IFrameOptions = {
   colorMode?: ColorMode;
 };
 
+export type Chain = {
+  rpcUrl: string;
+};
+
 export type ProviderOptions = {
-  /** The URL of the RPC */
-  rpc: string;
+  defaultChainId: ChainId;
+  chains: Chain[];
 };
 
 export type KeychainOptions = IFrameOptions & {
-  policies?: Policies;
+  policies?: SessionPolicies;
   /** The URL of keychain */
   url?: string;
   /** The origin of keychain */
@@ -193,8 +194,6 @@ export type ProfileContextTypeVariant =
   | "achievements"
   | "activity";
 
-export type Prefund = { address: string; min: string };
-
 export type Tokens = {
   erc20?: string[];
 };