@keplr-wallet/types 0.12.131 → 0.12.133-rc.0

package/build/chain-info.d.ts

@@ -1,4 +1,4 @@
-import { Currency, AppCurrency, FeeCurrency } from "./currency";
+import { Currency, AppCurrency, FeeCurrency, ERC20Currency } from "./currency";
 import { BIP44 } from "./bip44";
 import { Bech32Config } from "./bech32";
 import { EVMInfo } from "./ethereum";
@@ -51,3 +51,22 @@ export type ChainInfoWithoutEndpoints = Omit<ChainInfo, "rest" | "rpc" | "nodePr
         readonly rpc: undefined;
     };
 };
+export interface StarknetChainInfo {
+    readonly chainId: string;
+    readonly rpc: string;
+    readonly currencies: ERC20Currency[];
+    readonly ethContractAddress: string;
+    readonly strkContractAddress: string;
+}
+export type ChainInfoModule = "cosmos" | "starknet";
+export type ModularChainInfo = {
+    readonly chainId: string;
+    readonly chainName: string;
+    readonly chainSymbolImageUrl?: string;
+    readonly cosmos: ChainInfo;
+} | {
+    readonly chainId: string;
+    readonly chainName: string;
+    readonly chainSymbolImageUrl?: string;
+    readonly starknet: StarknetChainInfo;
+};

package/build/wallet/eip6963.d.ts

@@ -1,4 +1,4 @@
-import { IEthereumProvider } from "./keplr";
+import { IEthereumProvider } from "./ethereum";
 export declare enum EIP6963EventNames {
     Announce = "eip6963:announceProvider",
     Request = "eip6963:requestProvider"

package/build/wallet/ethereum.d.ts

@@ -0,0 +1,17 @@
+/// <reference types="node" />
+import EventEmitter from "events";
+export interface IEthereumProvider extends EventEmitter {
+    readonly chainId: string | null;
+    readonly networkVersion: string | null;
+    readonly selectedAddress: string | null;
+    readonly isKeplr: boolean;
+    readonly isMetaMask: boolean;
+    isConnected(): boolean;
+    request<T = unknown>({ method, params, chainId, }: {
+        method: string;
+        params?: readonly unknown[] | Record<string, unknown>;
+        chainId?: string;
+    }): Promise<T>;
+    enable(): Promise<string[]>;
+    net_version(): Promise<string>;
+}

package/build/wallet/ethereum.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ethereum.js.map

package/build/wallet/ethereum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ethereum.js","sourceRoot":"","sources":["../../src/wallet/ethereum.ts"],"names":[],"mappings":""}

package/build/wallet/index.d.ts

@@ -1,2 +1,4 @@
 export * from "./keplr";
 export * from "./eip6963";
+export * from "./ethereum";
+export * from "./starknet";

package/build/wallet/index.js

@@ -16,4 +16,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./keplr"), exports);
 __exportStar(require("./eip6963"), exports);
+__exportStar(require("./ethereum"), exports);
+__exportStar(require("./starknet"), exports);
 //# sourceMappingURL=index.js.map

package/build/wallet/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/wallet/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAwB;AACxB,4CAA0B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/wallet/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAwB;AACxB,4CAA0B;AAC1B,6CAA2B;AAC3B,6CAA2B"}

package/build/wallet/keplr.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { ChainInfo, ChainInfoWithoutEndpoints } from "../chain-info";
 import { EthSignType } from "../ethereum";
 import { BroadcastMode, AminoSignResponse, StdSignDoc, OfflineAminoSigner, StdSignature, DirectSignResponse, OfflineDirectSigner } from "../cosmjs";
@@ -6,7 +5,9 @@ import { SecretUtils } from "../secretjs";
 import Long from "long";
 import { SettledResponses } from "../settled";
 import { DirectAuxSignResponse } from "../cosmjs-alt";
-import EventEmitter from "events";
+import { IEthereumProvider } from "./ethereum";
+import { IStarknetProvider } from "./starknet";
+import { Call, DeployAccountSignerDetails, InvocationsSignerDetails } from "starknet";
 export interface Key {
     readonly name: string;
     readonly algo: string;
@@ -130,20 +131,27 @@ export interface Keplr {
     }): Promise<string>;
     sendEthereumTx(chainId: string, tx: Uint8Array): Promise<string>;
     suggestERC20(chainId: string, contractAddress: string): Promise<void>;
+    getStarknetKey(chainId: string): Promise<{
+        name: string;
+        hexAddress: string;
+        pubKey: Uint8Array;
+        address: Uint8Array;
+    }>;
+    getStarknetKeysSettled(chainIds: string[]): Promise<SettledResponses<{
+        name: string;
+        hexAddress: string;
+        pubKey: Uint8Array;
+        address: Uint8Array;
+    }>>;
+    signStarknetDeployAccountTransaction(chainId: string, transaction: DeployAccountSignerDetails): Promise<{
+        transaction: DeployAccountSignerDetails;
+        signature: string[];
+    }>;
+    signStarknetTx(chainId: string, transactions: Call[], details: InvocationsSignerDetails): Promise<{
+        transactions: Call[];
+        details: InvocationsSignerDetails;
+        signature: string[];
+    }>;
     readonly ethereum: IEthereumProvider;
-}
-export interface IEthereumProvider extends EventEmitter {
-    readonly chainId: string | null;
-    readonly networkVersion: string | null;
-    readonly selectedAddress: string | null;
-    readonly isKeplr: boolean;
-    readonly isMetaMask: boolean;
-    isConnected(): boolean;
-    request<T = unknown>({ method, params, chainId, }: {
-        method: string;
-        params?: readonly unknown[] | Record<string, unknown>;
-        chainId?: string;
-    }): Promise<T>;
-    enable(): Promise<string[]>;
-    net_version(): Promise<string>;
+    readonly starknet: IStarknetProvider;
 }

package/build/wallet/starknet.d.ts

@@ -0,0 +1,59 @@
+import { AccountInterface, ProviderInterface } from "starknet";
+export type AccountChangeEventHandler = (accounts: string[]) => void;
+export type NetworkChangeEventHandler = (network?: string) => void;
+export type WalletEvents = {
+    type: "accountsChanged";
+    handler: AccountChangeEventHandler;
+} | {
+    type: "networkChanged";
+    handler: NetworkChangeEventHandler;
+};
+export interface WatchAssetParameters {
+    type: "ERC20";
+    options: {
+        address: string;
+        symbol?: string;
+        decimals?: number;
+        image?: string;
+        name?: string;
+    };
+}
+export interface AddStarknetChainParameters {
+    id: string;
+    chainId: string;
+    chainName: string;
+    baseUrl: string;
+    rpcUrls?: string[];
+    blockExplorerUrls?: string[];
+    nativeCurrency?: {
+        address: string;
+        name: string;
+        symbol: string;
+        decimals: number;
+    };
+    iconUrls?: string[];
+}
+export interface SwitchStarknetChainParameter {
+    chainId: string;
+}
+export interface IStarknetProvider {
+    id: string;
+    name: string;
+    version: string;
+    icon: string;
+    isConnected: boolean;
+    account?: AccountInterface;
+    provider?: ProviderInterface;
+    selectedAddress?: string;
+    chainId?: string;
+    request<T = unknown>({ type, params, }: {
+        type: string;
+        params?: any;
+    }): Promise<T>;
+    enable(options?: {
+        starknetVersion?: "v4" | "v5";
+    }): Promise<string[]>;
+    isPreauthorized(): Promise<boolean>;
+    on<E extends WalletEvents>(event: E["type"], handleEvent: E["handler"]): void;
+    off<E extends WalletEvents>(event: E["type"], handleEvent: E["handler"]): void;
+}

package/build/wallet/starknet.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=starknet.js.map

package/build/wallet/starknet.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"starknet.js","sourceRoot":"","sources":["../../src/wallet/starknet.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@keplr-wallet/types",
-  "version": "0.12.131",
+  "version": "0.12.133-rc.0",
   "main": "build/index.js",
   "author": "chainapsis",
   "license": "Apache-2.0",
@@ -18,5 +18,8 @@
   "dependencies": {
     "long": "^4.0.0"
   },
-  "gitHead": "e4058df9a26bb4a45e344d166d105e391e15e225"
+  "peerDependencies": {
+    "starknet": "^6"
+  },
+  "gitHead": "6496cf28fc619e718b4e2e9e347755730292745b"
 }

package/src/chain-info.ts

@@ -1,4 +1,4 @@
-import { Currency, AppCurrency, FeeCurrency } from "./currency";
+import { Currency, AppCurrency, FeeCurrency, ERC20Currency } from "./currency";
 import { BIP44 } from "./bip44";
 import { Bech32Config } from "./bech32";
 import { EVMInfo } from "./ethereum";
@@ -62,3 +62,27 @@ export type ChainInfoWithoutEndpoints = Omit<
     readonly rpc: undefined;
   };
 };
+
+export interface StarknetChainInfo {
+  readonly chainId: string;
+  readonly rpc: string;
+  readonly currencies: ERC20Currency[];
+  readonly ethContractAddress: string;
+  readonly strkContractAddress: string;
+}
+
+export type ChainInfoModule = "cosmos" | "starknet";
+
+export type ModularChainInfo =
+  | {
+      readonly chainId: string;
+      readonly chainName: string;
+      readonly chainSymbolImageUrl?: string;
+      readonly cosmos: ChainInfo;
+    }
+  | {
+      readonly chainId: string;
+      readonly chainName: string;
+      readonly chainSymbolImageUrl?: string;
+      readonly starknet: StarknetChainInfo;
+    };

package/src/wallet/eip6963.ts

@@ -1,4 +1,4 @@
-import { IEthereumProvider } from "./keplr";
+import { IEthereumProvider } from "./ethereum";
 
 export enum EIP6963EventNames {
   Announce = "eip6963:announceProvider",

package/src/wallet/ethereum.ts

@@ -0,0 +1,28 @@
+import EventEmitter from "events";
+
+export interface IEthereumProvider extends EventEmitter {
+  // It must be in the hexadecimal format used in EVM-based chains, not the format used in Tendermint nodes.
+  readonly chainId: string | null;
+  // It must be in the decimal format of chainId.
+  readonly networkVersion: string | null;
+
+  readonly selectedAddress: string | null;
+
+  readonly isKeplr: boolean;
+  readonly isMetaMask: boolean;
+
+  isConnected(): boolean;
+
+  request<T = unknown>({
+    method,
+    params,
+    chainId,
+  }: {
+    method: string;
+    params?: readonly unknown[] | Record<string, unknown>;
+    chainId?: string;
+  }): Promise<T>;
+
+  enable(): Promise<string[]>;
+  net_version(): Promise<string>;
+}

package/src/wallet/index.ts

@@ -1,2 +1,4 @@
 export * from "./keplr";
 export * from "./eip6963";
+export * from "./ethereum";
+export * from "./starknet";

package/src/wallet/keplr.ts

@@ -13,7 +13,13 @@ import { SecretUtils } from "../secretjs";
 import Long from "long";
 import { SettledResponses } from "../settled";
 import { DirectAuxSignResponse } from "../cosmjs-alt";
-import EventEmitter from "events";
+import { IEthereumProvider } from "./ethereum";
+import { IStarknetProvider } from "./starknet";
+import {
+  Call,
+  DeployAccountSignerDetails,
+  InvocationsSignerDetails,
+} from "starknet";
 
 export interface Key {
   // Name of the selected key store.
@@ -243,32 +249,38 @@ export interface Keplr {
 
   suggestERC20(chainId: string, contractAddress: string): Promise<void>;
 
-  readonly ethereum: IEthereumProvider;
-}
-
-export interface IEthereumProvider extends EventEmitter {
-  // It must be in the hexadecimal format used in EVM-based chains, not the format used in Tendermint nodes.
-  readonly chainId: string | null;
-  // It must be in the decimal format of chainId.
-  readonly networkVersion: string | null;
-
-  readonly selectedAddress: string | null;
-
-  readonly isKeplr: boolean;
-  readonly isMetaMask: boolean;
-
-  isConnected(): boolean;
+  getStarknetKey(chainId: string): Promise<{
+    name: string;
+    hexAddress: string;
+    pubKey: Uint8Array;
+    address: Uint8Array;
+  }>;
+  getStarknetKeysSettled(chainIds: string[]): Promise<
+    SettledResponses<{
+      name: string;
+      hexAddress: string;
+      pubKey: Uint8Array;
+      address: Uint8Array;
+    }>
+  >;
+  signStarknetDeployAccountTransaction(
+    chainId: string,
+    transaction: DeployAccountSignerDetails
+  ): Promise<{
+    transaction: DeployAccountSignerDetails;
+    signature: string[];
+  }>;
+  signStarknetTx(
+    chainId: string,
+    transactions: Call[],
+    details: InvocationsSignerDetails
+  ): Promise<{
+    transactions: Call[];
+    details: InvocationsSignerDetails;
+    signature: string[];
+  }>;
 
-  request<T = unknown>({
-    method,
-    params,
-    chainId,
-  }: {
-    method: string;
-    params?: readonly unknown[] | Record<string, unknown>;
-    chainId?: string;
-  }): Promise<T>;
+  readonly ethereum: IEthereumProvider;
 
-  enable(): Promise<string[]>;
-  net_version(): Promise<string>;
+  readonly starknet: IStarknetProvider;
 }

package/src/wallet/starknet.ts

@@ -0,0 +1,75 @@
+import { AccountInterface, ProviderInterface } from "starknet";
+
+export type AccountChangeEventHandler = (accounts: string[]) => void;
+
+export type NetworkChangeEventHandler = (network?: string) => void;
+
+export type WalletEvents =
+  | {
+      type: "accountsChanged";
+      handler: AccountChangeEventHandler;
+    }
+  | {
+      type: "networkChanged";
+      handler: NetworkChangeEventHandler;
+    };
+
+export interface WatchAssetParameters {
+  type: "ERC20";
+  options: {
+    address: string;
+    symbol?: string;
+    decimals?: number;
+    image?: string;
+    name?: string;
+  };
+}
+
+export interface AddStarknetChainParameters {
+  id: string;
+  chainId: string;
+  chainName: string;
+  baseUrl: string;
+  rpcUrls?: string[];
+  blockExplorerUrls?: string[];
+  nativeCurrency?: {
+    address: string;
+    name: string;
+    symbol: string;
+    decimals: number;
+  };
+  iconUrls?: string[];
+}
+
+export interface SwitchStarknetChainParameter {
+  chainId: string; // A 0x-prefixed hexadecimal string
+}
+
+export interface IStarknetProvider {
+  id: string;
+  name: string;
+  version: string;
+  icon: string;
+
+  isConnected: boolean;
+
+  account?: AccountInterface;
+  provider?: ProviderInterface;
+  selectedAddress?: string;
+  chainId?: string;
+
+  request<T = unknown>({
+    type,
+    params,
+  }: {
+    type: string;
+    params?: any;
+  }): Promise<T>;
+  enable(options?: { starknetVersion?: "v4" | "v5" }): Promise<string[]>;
+  isPreauthorized(): Promise<boolean>;
+  on<E extends WalletEvents>(event: E["type"], handleEvent: E["handler"]): void;
+  off<E extends WalletEvents>(
+    event: E["type"],
+    handleEvent: E["handler"]
+  ): void;
+}