kokio-sdk 2.1.0 → 3.0.1

package/README.md

@@ -39,7 +39,8 @@ is ever held in the app.
 
 You will need:
 
-- a viem `WalletClient` connected to the target chain,
+- a viem `WalletClient` connected to the target chain, carrying an `account`
+  and an explicit RPC URL (see the note under the example),
 - the passkey `credentialId` and `rpId` registered for the device,
 - a Pimlico API key and a gas policy id (used by the bundler and paymaster).
 
@@ -48,7 +49,11 @@ import { Kokio } from "kokio-sdk";
 import { createWalletClient, http } from "viem";
 import { baseSepolia } from "viem/chains";
 
-const walletClient = createWalletClient({ chain: baseSepolia, transport: http() });
+const walletClient = createWalletClient({
+  account: knownAddress,
+  chain: baseSepolia,
+  transport: http(rpcUrl),
+});
 
 const kokio = new Kokio(
   walletClient,
@@ -80,15 +85,26 @@ const session = new Kokio(
 );
 
 // 4. Send a user operation. The passkey signs it on the device.
-const hash = await session.deviceWallet!.toggleAccessToETH(eSIMWalletAddress, true);
-await smartAccountClient.waitForUserOperationTransaction({ hash });
+const hash = await session.deviceWallet!.toggleAccessToFunds(eSIMWalletAddress, true);
+const receipt = await smartAccountClient.waitForUserOperationReceipt({ hash });
+if (!receipt.success) throw new Error("operation reverted");
 ```
 
+Two things about the wallet client. It has to carry an `account`:
+`getSmartWallet` refuses a client without one, though it never asks it for a
+signature, since the passkey signs everything. And give `http()` a real RPC
+URL, because the SDK reads `client.transport.url` to build the public client
+it uses for contract reads.
+
+Check `receipt.success`. An operation whose calls revert is still mined and
+still returns a receipt, so the await resolving is not on its own proof the
+write landed. `receipt.receipt.transactionHash` is the onchain transaction.
+
 The contract surfaces (`deviceWallet`, `eSIMWallet`, `deviceWalletFactory`,
-`eSIMWalletFactory`, `registry`, `P256Verifier`) are only present once a
-`smartAccountClient` is supplied, which is why the example constructs `Kokio`
-twice. Instance surfaces (`deviceWallet`, `eSIMWallet`) also need their contract
-address. They stay `undefined` until you pass it.
+`eSIMWalletFactory`, `registry`, `paymentAdapter`, `P256Verifier`) are only
+present once a `smartAccountClient` is supplied, which is why the example
+constructs `Kokio` twice. Instance surfaces (`deviceWallet`, `eSIMWallet`) also
+need their contract address. They stay `undefined` until you pass it.
 
 A device wallet often holds more than one eSIM wallet, and the app needs to
 switch which one it is acting on without resolving the smart account again.
@@ -97,7 +113,15 @@ reference:
 
 ```ts
 session.setESIMWalletAddress(anotherESIMWalletAddress);
-const hash = await session.eSIMWallet!.buyDataBundle({ dataBundleID, dataBundlePrice });
+const asset = "0x5553444300000000000000000000000000000000000000000000000000000000"; // "USDC"
+const priceUSDCents = 500n; // $5.00
+const maxAmountIn = await session.paymentAdapter!.quote(asset, priceUSDCents);
+const hash = await session.eSIMWallet!.buyDataBundleWithToken(
+  { id: bundleId, priceUSDCents, settlement: Settlement.DeviceWallet },
+  asset,
+  maxAmountIn,
+  paymentReference, // from the backend
+);
 ```
 
 `setDeviceWalletAddress` and `setESIMWalletAddress` each mutate the instance
@@ -151,7 +175,13 @@ admin.setDeviceWalletAddress(deviceWalletAddress);
 await admin.deviceWallet!.deployESIMWallet(salt);
 
 admin.setESIMWalletAddress(eSIMWalletAddress);
-await admin.eSIMWallet!.buyDataBundle({ dataBundleID, dataBundlePrice });
+const maxAmountIn = await admin.paymentAdapter.quote(asset, priceUSDCents);
+await admin.eSIMWallet!.buyDataBundleWithToken(
+  { id: bundleId, priceUSDCents, settlement: 0 }, // 0 = DeviceWallet pays
+  asset,
+  maxAmountIn,
+  paymentReference,
+);
 ```
 
 `setDeviceWalletAddress`, `setESIMWalletAddress`, and `setWalletClient` each mutate

package/dist/esm/abis/DeviceWallet.js

@@ -20,7 +20,7 @@ const DeviceWallet = [
                 "internalType": "address"
             },
             {
-                "name": "_hasAccessToETH",
+                "name": "_hasAccessToFunds",
                 "type": "bool",
                 "internalType": "bool"
             }
@@ -30,7 +30,7 @@ const DeviceWallet = [
     },
     {
         "type": "function",
-        "name": "canPullETH",
+        "name": "canPullFunds",
         "inputs": [
             {
                 "name": "eSIMWalletAddress",
@@ -40,7 +40,7 @@ const DeviceWallet = [
         ],
         "outputs": [
             {
-                "name": "isAllowedToPullETH",
+                "name": "isAllowedToPullFunds",
                 "type": "bool",
                 "internalType": "bool"
             }
@@ -52,7 +52,7 @@ const DeviceWallet = [
         "name": "deployESIMWallet",
         "inputs": [
             {
-                "name": "_hasAccessToETH",
+                "name": "_hasAccessToFunds",
                 "type": "bool",
                 "internalType": "bool"
             },
@@ -400,8 +400,13 @@ const DeviceWallet = [
     },
     {
         "type": "function",
-        "name": "pullETH",
+        "name": "pullToken",
         "inputs": [
+            {
+                "name": "_token",
+                "type": "address",
+                "internalType": "address"
+            },
             {
                 "name": "_amount",
                 "type": "uint256",
@@ -469,7 +474,7 @@ const DeviceWallet = [
     },
     {
         "type": "function",
-        "name": "toggleAccessToETH",
+        "name": "toggleAccessToFunds",
         "inputs": [
             {
                 "name": "_eSIMWalletAddress",
@@ -477,7 +482,7 @@ const DeviceWallet = [
                 "internalType": "address"
             },
             {
-                "name": "_hasAccessToETH",
+                "name": "_hasAccessToFunds",
                 "type": "bool",
                 "internalType": "bool"
             }
@@ -654,7 +659,7 @@ const DeviceWallet = [
                 "internalType": "address"
             },
             {
-                "name": "_hasAccessToETH",
+                "name": "_hasAccessToFunds",
                 "type": "bool",
                 "indexed": false,
                 "internalType": "bool"
@@ -693,25 +698,6 @@ const DeviceWallet = [
         ],
         "anonymous": false
     },
-    {
-        "type": "event",
-        "name": "ETHAccessUpdated",
-        "inputs": [
-            {
-                "name": "_eSIMWalletAddress",
-                "type": "address",
-                "indexed": true,
-                "internalType": "address"
-            },
-            {
-                "name": "_hasAccessToETH",
-                "type": "bool",
-                "indexed": false,
-                "internalType": "bool"
-            }
-        ],
-        "anonymous": false
-    },
     {
         "type": "event",
         "name": "ETHCalledBack",
@@ -727,7 +713,7 @@ const DeviceWallet = [
     },
     {
         "type": "event",
-        "name": "ETHSent",
+        "name": "FundsAccessUpdated",
         "inputs": [
             {
                 "name": "_eSIMWalletAddress",
@@ -736,10 +722,10 @@ const DeviceWallet = [
                 "internalType": "address"
             },
             {
-                "name": "_amount",
-                "type": "uint256",
+                "name": "_hasAccessToFunds",
+                "type": "bool",
                 "indexed": false,
-                "internalType": "uint256"
+                "internalType": "bool"
             }
         ],
         "anonymous": false
@@ -764,35 +750,33 @@ const DeviceWallet = [
         "anonymous": false
     },
     {
-        "type": "error",
-        "name": "ESIMWalletAlreadyAdded",
+        "type": "event",
+        "name": "TokenSent",
         "inputs": [
             {
-                "name": "eSIMWallet",
+                "name": "_token",
                 "type": "address",
+                "indexed": true,
                 "internalType": "address"
-            }
-        ]
-    },
-    {
-        "type": "error",
-        "name": "ESIMWalletNotOwnedByThisDeviceWallet",
-        "inputs": [
+            },
             {
-                "name": "eSIMWallet",
+                "name": "_eSIMWalletAddress",
                 "type": "address",
+                "indexed": true,
                 "internalType": "address"
             },
             {
-                "name": "eSIMWalletOwner",
-                "type": "address",
-                "internalType": "address"
+                "name": "_amount",
+                "type": "uint256",
+                "indexed": false,
+                "internalType": "uint256"
             }
-        ]
+        ],
+        "anonymous": false
     },
     {
         "type": "error",
-        "name": "ETHAccessNotGrantableAtBind",
+        "name": "ESIMWalletAlreadyAdded",
         "inputs": [
             {
                 "name": "eSIMWallet",
@@ -803,12 +787,17 @@ const DeviceWallet = [
     },
     {
         "type": "error",
-        "name": "ETHAccessRevoked",
+        "name": "ESIMWalletNotOwnedByThisDeviceWallet",
         "inputs": [
             {
                 "name": "eSIMWallet",
                 "type": "address",
                 "internalType": "address"
+            },
+            {
+                "name": "eSIMWalletOwner",
+                "type": "address",
+                "internalType": "address"
             }
         ]
     },
@@ -819,22 +808,23 @@ const DeviceWallet = [
     },
     {
         "type": "error",
-        "name": "FailedToTransfer",
-        "inputs": []
+        "name": "FundsAccessNotGrantableAtBind",
+        "inputs": [
+            {
+                "name": "eSIMWallet",
+                "type": "address",
+                "internalType": "address"
+            }
+        ]
     },
     {
         "type": "error",
-        "name": "InsufficientBalance",
+        "name": "FundsAccessRevoked",
         "inputs": [
             {
-                "name": "balance",
-                "type": "uint256",
-                "internalType": "uint256"
-            },
-            {
-                "name": "amount",
-                "type": "uint256",
-                "internalType": "uint256"
+                "name": "eSIMWallet",
+                "type": "address",
+                "internalType": "address"
             }
         ]
     },
@@ -893,6 +883,17 @@ const DeviceWallet = [
         "name": "ReentrancyGuardReentrantCall",
         "inputs": []
     },
+    {
+        "type": "error",
+        "name": "SafeERC20FailedOperation",
+        "inputs": [
+            {
+                "name": "token",
+                "type": "address",
+                "internalType": "address"
+            }
+        ]
+    },
     {
         "type": "error",
         "name": "UnknownESIMWallet",