kokio-sdk 0.0.5 → 0.0.7

package/README.md

@@ -0,0 +1,3 @@
+# Kokio SDK
+
+This is an internal SDK that allows Koki'o mobile app to interact with the Smart contracts.  

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kokio-sdk",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "description": "",
   "type": "module",
   "main": "./dist/esm/config.js",

package/src/config.ts

@@ -16,6 +16,7 @@ export class Kokio {
     credentialId: string;
     rpId: string;
     organizationId: string;
+    pimlicoAPIKey: string;
     gasPolicyId: string;
 
     constants: ConstantsSubPackage;
@@ -34,6 +35,7 @@ export class Kokio {
         credentialId: string,
         rpId: string,
         organizationId: string,
+        pimlicoAPIKey: string,
         gasPolicyId: string,
         smartAccountClient?: SmartAccountClient,
         deviceWalletAddress?: Address,
@@ -44,11 +46,12 @@ export class Kokio {
         this.credentialId = credentialId;
         this.rpId = rpId;
         this.organizationId = organizationId;
+        this.pimlicoAPIKey = pimlicoAPIKey;
         this.gasPolicyId = gasPolicyId;
 
-        this.constants = new ConstantsSubPackage(this.viemWalletClient);
+        this.constants = new ConstantsSubPackage(this.viemWalletClient, this.pimlicoAPIKey);
 
-        this.smartAccount = new SmartAccountSubPackage(this.viemWalletClient, this.turnkeyClient, this.credentialId, this.rpId, this.organizationId, this.gasPolicyId);
+        this.smartAccount = new SmartAccountSubPackage(this.viemWalletClient, this.turnkeyClient, this.credentialId, this.rpId, this.organizationId, this.pimlicoAPIKey, this.gasPolicyId);
         this.deviceWalletFactory = smartAccountClient? new DeviceWalletFactorySubPackage(viemWalletClient, smartAccountClient): undefined;
         this.eSIMWalletFactory = smartAccountClient? new ESIMWalletFactorySubPackage(viemWalletClient, smartAccountClient): undefined;
         this.lazyWalletRegistry = smartAccountClient? new LazyWalletRegistrySubPackage(smartAccountClient): undefined;

package/src/interface/constantsClass.ts

@@ -21,11 +21,11 @@ export class ConstantsSubPackage {
             typeof arbitrumSepoliaFactoryAddresses;
     customErrors!: typeof customErrors;
 
-    constructor(client: WalletClient) {
+    constructor(client: WalletClient, pimlicoAPIKey: string) {
         (async () => {
           const chainID = await _extractChainID(client);
           const rpcURL = client.transport.url;
-          const values = _getChainSpecificConstants(chainID, rpcURL);
+          const values = _getChainSpecificConstants(chainID, rpcURL, pimlicoAPIKey);
     
           this.factoryAddresses = values?.factoryAddresses;
           this.customErrors = values?.customErrors;

package/src/interface/smartAccountClass.ts

@@ -10,15 +10,17 @@ export class SmartAccountSubPackage {
     turnkeyClient;
     credentialId;
     rpId;
-    organizationId; 
+    organizationId;
+    pimlicoAPIKey;
     gasPolicyId;
     
-    constructor(client: WalletClient, turnkeyClient: TurnkeyClient, credentialId: string, rpId: string, organiationId: string, gasPolicyId: string) {
+    constructor(client: WalletClient, turnkeyClient: TurnkeyClient, credentialId: string, rpId: string, organiationId: string, pimlicoAPIKey: string, gasPolicyId: string) {
         this.client = client;
         this.turnkeyClient = turnkeyClient;
         this.credentialId = credentialId;
         this.rpId = rpId;
         this.organizationId = organiationId;
+        this.pimlicoAPIKey = pimlicoAPIKey;
         this.gasPolicyId = gasPolicyId;
     }
 
@@ -27,6 +29,6 @@ export class SmartAccountSubPackage {
     }
 
     getSmartWalletClient (account: SmartContractAccount) {
-        return _getSmartWalletClient(this.client, this.gasPolicyId, account);
+        return _getSmartWalletClient(this.client, this.pimlicoAPIKey, this.gasPolicyId, account);
     }
 }

package/src/logic/account-kit/createSmartAccount.ts

@@ -266,17 +266,35 @@ export const _getSmartWallet = async (
 	});
 }
 
-export const _getSmartWalletClient = async (client: WalletClient, gasPolicyId: string, account: SmartContractAccount) => {
+export const _getSmartWalletClient = async (client: WalletClient, pimlicoAPIKey: string, gasPolicyId: string, account: SmartContractAccount) => {
 
 	const chainID = await client.getChainId();
 	const rpcURL = client.transport.url;
-	const values = _getChainSpecificConstants(chainID, rpcURL);
+	const values = _getChainSpecificConstants(chainID, rpcURL, pimlicoAPIKey);
+
+	const bundlerMethods = [
+			"eth_sendUserOperation",
+			"eth_estimateUserOperationGas",
+			"eth_getUserOperationReceipt",
+			"eth_getUserOperationByHash",
+			"eth_supportedEntryPoints",
+	];
 
+	// Uses Pimlico paymaster by default for above defined bundler methods and Alchemy as fallback
 	return createSmartAccountClient({
 		// created above
 		account: account,
 		chain: values.chain,
-		transport: http(values.rpcURL),
+		transport: split({
+			overrides: [
+				{
+					methods: bundlerMethods,
+					transport: http(`${values.pimlicoRpcURL}`),
+				},
+			],
+			fallback: http(values.rpcURL),
+		}),
+		// transport: http(values.rpcURL),
 		...alchemyGasManagerMiddleware(gasPolicyId)
 	});
 }

package/src/logic/constants.ts

@@ -5,7 +5,9 @@ import {
     optimism,
     optimismSepolia,
     arbitrum,
-    arbitrumSepolia
+    arbitrumSepolia,
+    base,
+    baseSepolia
 } from "viem/chains";
 
 export const ZERO = BigInt('0');
@@ -17,6 +19,8 @@ export enum CHAIN_ID  {
     SEPOLIA = 11155111,
     OPTIMISM_MAINNET = 10,
     OPTIMISM_SEPOLIA = 11155420,
+    BASE_MAINNET = 8453,
+    BASE_SEPOLIA = 84532,
     ARBITRUM_ONE = 42161,
     ARBITRUM_SEPOLIA = 421614,
 }
@@ -27,6 +31,8 @@ export interface chainSpecifcConstants {
         typeof mainnetFactoryAddresses |
         typeof optimismMainnetFactoryAddresses |
         typeof optimismSepoliaFactoryAddresses |
+        typeof baseMainnetFactoryAddresses |
+        typeof baseSepoliaFactoryAddresses |
         typeof arbitrumOneFactoryAddresses |
         typeof arbitrumSepoliaFactoryAddresses;
     chain: 
@@ -34,9 +40,12 @@ export interface chainSpecifcConstants {
         typeof sepolia |
         typeof optimism |
         typeof optimismSepolia |
+        typeof base |
+        typeof baseSepolia |
         typeof arbitrum |
         typeof arbitrumSepolia
-    rpcURL: string; 
+    rpcURL: string;
+    pimlicoRpcURL: string;
     customErrors: typeof customErrors;
 }
 
@@ -80,6 +89,26 @@ export const optimismSepoliaFactoryAddresses: Record<string, Address> = {
     P256VERIFIER: '0x3c15a78046838481788613A9F111F972B562623C'
 }
 
+export const baseMainnetFactoryAddresses: Record<string, Address> = {
+    DEVICE_WALLET_FACTORY: '0x',
+    ESIM_WALLET_FACTORY: '0x',
+    LAZY_WALLET_REGISTRY: '0x',
+    REGISTRY: '0x',
+    ENTRY_POINT: '0x',
+    SENDER_CREATOR: '0x',
+    P256VERIFIER: '0x'
+}
+
+export const baseSepoliaFactoryAddresses: Record<string, Address> = {
+    DEVICE_WALLET_FACTORY: '0xB4473979ff8cE4e09161B08f74EEb66BD7718076',
+    ESIM_WALLET_FACTORY: '0x63005d8214533fC7209678Aa39F7b9b0b51a7bcB',
+    LAZY_WALLET_REGISTRY: '0x8a1E53b903efcc6b252CE4bD3b255202318505Ef',
+    REGISTRY: '0xCa447f5C75C57f6C59027304A5Fb5A09F0E005c9',
+    ENTRY_POINT: '0x0000000071727De22E5E9d8BAf0edAc6f37da032',
+    SENDER_CREATOR: '0xefc2c1444ebcc4db75e7613d20c6a62ff67a167c',
+    P256VERIFIER: '0xF04f3b3935aD461D17d4a8a78E7ea21d4a61AEb1'
+}
+
 export const arbitrumOneFactoryAddresses: Record<string, Address> = {
     DEVICE_WALLET_FACTORY: '0x',
     ESIM_WALLET_FACTORY: '0x',
@@ -120,9 +149,12 @@ export const _getChainSpecificConstants = (
         CHAIN_ID.MAINNET | 
         CHAIN_ID.OPTIMISM_MAINNET | 
         CHAIN_ID.OPTIMISM_SEPOLIA |
+        CHAIN_ID.BASE_MAINNET | 
+        CHAIN_ID.BASE_SEPOLIA |
         CHAIN_ID.ARBITRUM_ONE |
         CHAIN_ID.ARBITRUM_SEPOLIA,
-    rpcURL: string
+    rpcURL: string,
+    pimlicoAPIKey?: string
     ): chainSpecifcConstants => {
 
     if (chainID == CHAIN_ID.SEPOLIA) {
@@ -130,6 +162,7 @@ export const _getChainSpecificConstants = (
             factoryAddresses: sepoliaFactoryAddresses,
             chain: sepolia,
             rpcURL: rpcURL,
+            pimlicoRpcURL: pimlicoAPIKey ? `https://api.pimlico.io/v2/${chainID}/rpc?apikey=${pimlicoAPIKey}` : "",
             customErrors: customErrors
         }
     }
@@ -138,6 +171,7 @@ export const _getChainSpecificConstants = (
             factoryAddresses: mainnetFactoryAddresses,
             chain: mainnet,
             rpcURL: rpcURL,
+            pimlicoRpcURL: pimlicoAPIKey ? `https://api.pimlico.io/v2/${chainID}/rpc?apikey=${pimlicoAPIKey}` : "",
             customErrors: customErrors
         }
     }
@@ -146,6 +180,7 @@ export const _getChainSpecificConstants = (
             factoryAddresses: optimismMainnetFactoryAddresses,
             chain: optimism,
             rpcURL: rpcURL,
+            pimlicoRpcURL: pimlicoAPIKey ? `https://api.pimlico.io/v2/${chainID}/rpc?apikey=${pimlicoAPIKey}` : "",
             customErrors: customErrors
         }
     }
@@ -154,6 +189,25 @@ export const _getChainSpecificConstants = (
             factoryAddresses: optimismSepoliaFactoryAddresses,
             chain: optimismSepolia,
             rpcURL: rpcURL,
+            pimlicoRpcURL: pimlicoAPIKey ? `https://api.pimlico.io/v2/${chainID}/rpc?apikey=${pimlicoAPIKey}` : "",
+            customErrors: customErrors
+        }
+    }
+    else if (chainID == CHAIN_ID.BASE_MAINNET) {
+        return {
+            factoryAddresses: optimismMainnetFactoryAddresses,
+            chain: optimism,
+            rpcURL: rpcURL,
+            pimlicoRpcURL: pimlicoAPIKey ? `https://api.pimlico.io/v2/${chainID}/rpc?apikey=${pimlicoAPIKey}` : "",
+            customErrors: customErrors
+        }
+    }
+    else if (chainID == CHAIN_ID.BASE_SEPOLIA) {
+        return {
+            factoryAddresses: optimismSepoliaFactoryAddresses,
+            chain: optimismSepolia,
+            rpcURL: rpcURL,
+            pimlicoRpcURL: pimlicoAPIKey ? `https://api.pimlico.io/v2/${chainID}/rpc?apikey=${pimlicoAPIKey}` : "",
             customErrors: customErrors
         }
     }
@@ -162,6 +216,7 @@ export const _getChainSpecificConstants = (
             factoryAddresses: arbitrumOneFactoryAddresses,
             chain: arbitrum,
             rpcURL: rpcURL,
+            pimlicoRpcURL: pimlicoAPIKey ? `https://api.pimlico.io/v2/${chainID}/rpc?apikey=${pimlicoAPIKey}` : "",
             customErrors: customErrors
         }
     }
@@ -170,6 +225,7 @@ export const _getChainSpecificConstants = (
             factoryAddresses: arbitrumSepoliaFactoryAddresses,
             chain: arbitrumSepolia,
             rpcURL: rpcURL,
+            pimlicoRpcURL: pimlicoAPIKey ? `https://api.pimlico.io/v2/${chainID}/rpc?apikey=${pimlicoAPIKey}` : "",
             customErrors: customErrors
         }
     }