kokio-sdk 2.1.0 → 3.0.0

package/dist/esm/logic/paymentAdapter.js

@@ -0,0 +1,116 @@
+import { _getChainSpecificConstants } from "./constants.js";
+import { PaymentAdapter } from "../abis/index.js";
+// Every function here is a view. The adapter's only writes reachable from a
+// userOp are `settle` (`onlyESIMWallet`, called from inside
+// `eSIMWallet.buyDataBundleWithToken`, never directly) and
+// `consumePaymentReference` (`onlyRegistry`), so neither is exposed on this
+// surface. `registerAsset`/`updateAsset` are `onlyOwner`, reachable only through
+// `KokioAdmin.protocolAdmin`'s timelock payloads.
+/**
+ * The registry this adapter reads `vault()` and `isESIMWalletValid()` from.
+ */
+export const _registry = async (client) => {
+    const chainID = await client.getChainId();
+    const rpcURL = client.transport.url;
+    const values = _getChainSpecificConstants(chainID, rpcURL);
+    return client.readContract({
+        address: values.factoryAddresses.PAYMENT_ADAPTER,
+        abi: PaymentAdapter,
+        functionName: "registry",
+        args: []
+    });
+};
+/** The ERC-20 registered under the `USDC` symbol at configure time. */
+export const _settlementToken = async (client) => {
+    const chainID = await client.getChainId();
+    const rpcURL = client.transport.url;
+    const values = _getChainSpecificConstants(chainID, rpcURL);
+    return client.readContract({
+        address: values.factoryAddresses.PAYMENT_ADAPTER,
+        abi: PaymentAdapter,
+        functionName: "settlementToken",
+        args: []
+    });
+};
+/**
+ * The raw currency table entry for a symbol. `decimals` reads zero for a symbol
+ * never registered, which is how `resolveAsset` tells "not registered" apart
+ * from "registered but withdrawn" (`allowed: false`).
+ */
+export const _assets = async (client, symbol) => {
+    const chainID = await client.getChainId();
+    const rpcURL = client.transport.url;
+    const values = _getChainSpecificConstants(chainID, rpcURL);
+    const [allowed, isDollarUnit, decimals, token] = await client.readContract({
+        address: values.factoryAddresses.PAYMENT_ADAPTER,
+        abi: PaymentAdapter,
+        functionName: "assets",
+        args: [symbol]
+    });
+    return { allowed, isDollarUnit, decimals, token };
+};
+/**
+ * A currency's full entry, reverting if the symbol was never registered.
+ * `_asset` is not required for `buyDataBundleWithToken`, but is worth reading
+ * first: `token` being the zero address means the currency is fiat-only and the
+ * purchase will revert with `AssetNotTransferable`.
+ */
+export const _resolveAsset = async (client, symbol) => {
+    const chainID = await client.getChainId();
+    const rpcURL = client.transport.url;
+    const values = _getChainSpecificConstants(chainID, rpcURL);
+    return client.readContract({
+        address: values.factoryAddresses.PAYMENT_ADAPTER,
+        abi: PaymentAdapter,
+        functionName: "resolveAsset",
+        args: [symbol]
+    });
+};
+/**
+ * The amount of `symbol`, in its smallest unit, that a `priceUSDCents` charge
+ * currently costs. Read this before calling `buyDataBundleWithToken`, and pass
+ * the result (or a value at least this large) as `_maxAmountIn`: nothing today
+ * moves the price between the quote and the purchase, so the two always agree,
+ * but the contract will not assume that on the caller's behalf.
+ */
+export const _quote = async (client, symbol, priceUSDCents) => {
+    const chainID = await client.getChainId();
+    const rpcURL = client.transport.url;
+    const values = _getChainSpecificConstants(chainID, rpcURL);
+    return client.readContract({
+        address: values.factoryAddresses.PAYMENT_ADAPTER,
+        abi: PaymentAdapter,
+        functionName: "quote",
+        args: [symbol, priceUSDCents]
+    });
+};
+/**
+ * Whether a payment reference has already been spent here. Retired from the
+ * registry's live purchase paths (`PaymentAdapter.consumePaymentReference` is
+ * `onlyRegistry` but nothing calls it any more): replay protection now lives on
+ * `Registry.usedPaymentReferences`, scoped per eSIM wallet. Kept for whatever
+ * still reads the adapter's own record from before that move.
+ */
+export const _usedReferences = async (client, paymentReference) => {
+    const chainID = await client.getChainId();
+    const rpcURL = client.transport.url;
+    const values = _getChainSpecificConstants(chainID, rpcURL);
+    return client.readContract({
+        address: values.factoryAddresses.PAYMENT_ADAPTER,
+        abi: PaymentAdapter,
+        functionName: "usedReferences",
+        args: [paymentReference]
+    });
+};
+/** The address holding upgrade authority over this adapter (its owner). */
+export const _upgradeManager = async (client) => {
+    const chainID = await client.getChainId();
+    const rpcURL = client.transport.url;
+    const values = _getChainSpecificConstants(chainID, rpcURL);
+    return client.readContract({
+        address: values.factoryAddresses.PAYMENT_ADAPTER,
+        abi: PaymentAdapter,
+        functionName: "upgradeManager",
+        args: []
+    });
+};

package/dist/esm/logic/registry.js

@@ -87,8 +87,9 @@ export const _isDeviceIdentifierAlreadyUsed = async (client, deviceUniqueIdentif
     });
 };
 /**
- * Whether the protocol is paused. While true, every ETH-moving path on the device
- * wallets and eSIM wallets reverts, so check this before offering a purchase.
+ * Whether the protocol is paused. While true, the purchase and token-pull paths
+ * on the device wallets and eSIM wallets revert, so check this before offering a
+ * purchase.
  */
 export const _paused = async (client) => {
     const chainID = await client.getChainId();
@@ -205,18 +206,62 @@ export const _eSIMWalletForIdentifier = async (client, eSIMUniqueIdentifier) =>
         args: [eSIMUniqueIdentifier]
     });
 };
-/** The fallback price ceiling in wei for a wallet holding no cap of its own. */
-export const _defaultDataBundlePriceCap = async (client) => {
+/** The fallback price ceiling in USD cents for a wallet holding no cap of its own. */
+export const _defaultPriceCapUSDCents = async (client) => {
     const chainID = await client.getChainId();
     const rpcURL = client.transport.url;
     const values = _getChainSpecificConstants(chainID, rpcURL);
     return client.readContract({
         address: values.factoryAddresses.REGISTRY,
         abi: Registry,
-        functionName: "defaultDataBundlePriceCap",
+        functionName: "defaultPriceCapUSDCents",
         args: []
     });
 };
+/** The payment adapter this registry currently points at. */
+export const _paymentAdapter = async (client) => {
+    const chainID = await client.getChainId();
+    const rpcURL = client.transport.url;
+    const values = _getChainSpecificConstants(chainID, rpcURL);
+    return client.readContract({
+        address: values.factoryAddresses.REGISTRY,
+        abi: Registry,
+        functionName: "paymentAdapter",
+        args: []
+    });
+};
+/**
+ * Whether a payment reference has already been spent for an eSIM wallet.
+ * Scoped per wallet: pass the same `keccak256(abi.encode(eSIMWallet, paymentReference))`
+ * the contract keys `usedPaymentReferences` by, not the bare reference.
+ */
+export const _usedPaymentReferences = async (client, scopedReference) => {
+    const chainID = await client.getChainId();
+    const rpcURL = client.transport.url;
+    const values = _getChainSpecificConstants(chainID, rpcURL);
+    return client.readContract({
+        address: values.factoryAddresses.REGISTRY,
+        abi: Registry,
+        functionName: "usedPaymentReferences",
+        args: [scopedReference]
+    });
+};
+/**
+ * Throws if `eSIMWallet` still has lazy-deployment history waiting to be copied
+ * in. `buyDataBundleWithToken` checks this itself before writing a new entry, so
+ * calling it first only turns that revert into a typed error ahead of a userOp.
+ */
+export const _requireLazyHistoryCopied = async (client, eSIMWallet) => {
+    const chainID = await client.getChainId();
+    const rpcURL = client.transport.url;
+    const values = _getChainSpecificConstants(chainID, rpcURL);
+    await client.readContract({
+        address: values.factoryAddresses.REGISTRY,
+        abi: Registry,
+        functionName: "requireLazyHistoryCopied",
+        args: [eSIMWallet]
+    });
+};
 /**
  * Throws if a fiat user's eSIMs are already waiting on this device identifier.
  * Worth calling before a deployment: taking a reserved identifier strands the

package/dist/esm/types-export.js

@@ -1 +1 @@
-export {};
+export { Settlement } from './types';

package/dist/esm/types.js

@@ -1 +1,11 @@
-export {};
+/**
+ * Which contract, if any, saw the money for a data bundle move. Mirrors the
+ * on-chain `Settlement` enum (CustomStructs.sol) - viem decodes a Solidity enum
+ * as its `uint8` position, so the member order here must match exactly.
+ */
+export var Settlement;
+(function (Settlement) {
+    Settlement[Settlement["DeviceWallet"] = 0] = "DeviceWallet";
+    Settlement[Settlement["ExternalWallet"] = 1] = "ExternalWallet";
+    Settlement[Settlement["Fiat"] = 2] = "Fiat";
+})(Settlement || (Settlement = {}));

package/dist/types/abis/DeviceWallet.d.ts

@@ -15,7 +15,7 @@ declare const DeviceWallet: readonly [{
         readonly type: "address";
         readonly internalType: "address";
     }, {
-        readonly name: "_hasAccessToETH";
+        readonly name: "_hasAccessToFunds";
         readonly type: "bool";
         readonly internalType: "bool";
     }];
@@ -23,14 +23,14 @@ declare const DeviceWallet: readonly [{
     readonly stateMutability: "nonpayable";
 }, {
     readonly type: "function";
-    readonly name: "canPullETH";
+    readonly name: "canPullFunds";
     readonly inputs: readonly [{
         readonly name: "eSIMWalletAddress";
         readonly type: "address";
         readonly internalType: "address";
     }];
     readonly outputs: readonly [{
-        readonly name: "isAllowedToPullETH";
+        readonly name: "isAllowedToPullFunds";
         readonly type: "bool";
         readonly internalType: "bool";
     }];
@@ -39,7 +39,7 @@ declare const DeviceWallet: readonly [{
     readonly type: "function";
     readonly name: "deployESIMWallet";
     readonly inputs: readonly [{
-        readonly name: "_hasAccessToETH";
+        readonly name: "_hasAccessToFunds";
         readonly type: "bool";
         readonly internalType: "bool";
     }, {
@@ -305,8 +305,12 @@ declare const DeviceWallet: readonly [{
     readonly stateMutability: "view";
 }, {
     readonly type: "function";
-    readonly name: "pullETH";
+    readonly name: "pullToken";
     readonly inputs: readonly [{
+        readonly name: "_token";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
         readonly name: "_amount";
         readonly type: "uint256";
         readonly internalType: "uint256";
@@ -357,13 +361,13 @@ declare const DeviceWallet: readonly [{
     readonly stateMutability: "view";
 }, {
     readonly type: "function";
-    readonly name: "toggleAccessToETH";
+    readonly name: "toggleAccessToFunds";
     readonly inputs: readonly [{
         readonly name: "_eSIMWalletAddress";
         readonly type: "address";
         readonly internalType: "address";
     }, {
-        readonly name: "_hasAccessToETH";
+        readonly name: "_hasAccessToFunds";
         readonly type: "bool";
         readonly internalType: "bool";
     }];
@@ -500,7 +504,7 @@ declare const DeviceWallet: readonly [{
         readonly indexed: true;
         readonly internalType: "address";
     }, {
-        readonly name: "_hasAccessToETH";
+        readonly name: "_hasAccessToFunds";
         readonly type: "bool";
         readonly indexed: false;
         readonly internalType: "bool";
@@ -531,21 +535,6 @@ declare const DeviceWallet: readonly [{
         readonly internalType: "address";
     }];
     readonly anonymous: false;
-}, {
-    readonly type: "event";
-    readonly name: "ETHAccessUpdated";
-    readonly inputs: readonly [{
-        readonly name: "_eSIMWalletAddress";
-        readonly type: "address";
-        readonly indexed: true;
-        readonly internalType: "address";
-    }, {
-        readonly name: "_hasAccessToETH";
-        readonly type: "bool";
-        readonly indexed: false;
-        readonly internalType: "bool";
-    }];
-    readonly anonymous: false;
 }, {
     readonly type: "event";
     readonly name: "ETHCalledBack";
@@ -558,17 +547,17 @@ declare const DeviceWallet: readonly [{
     readonly anonymous: false;
 }, {
     readonly type: "event";
-    readonly name: "ETHSent";
+    readonly name: "FundsAccessUpdated";
     readonly inputs: readonly [{
         readonly name: "_eSIMWalletAddress";
         readonly type: "address";
         readonly indexed: true;
         readonly internalType: "address";
     }, {
-        readonly name: "_amount";
-        readonly type: "uint256";
+        readonly name: "_hasAccessToFunds";
+        readonly type: "bool";
         readonly indexed: false;
-        readonly internalType: "uint256";
+        readonly internalType: "bool";
     }];
     readonly anonymous: false;
 }, {
@@ -586,6 +575,26 @@ declare const DeviceWallet: readonly [{
     readonly name: "NoETHToCallback";
     readonly inputs: readonly [];
     readonly anonymous: false;
+}, {
+    readonly type: "event";
+    readonly name: "TokenSent";
+    readonly inputs: readonly [{
+        readonly name: "_token";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "_eSIMWalletAddress";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "_amount";
+        readonly type: "uint256";
+        readonly indexed: false;
+        readonly internalType: "uint256";
+    }];
+    readonly anonymous: false;
 }, {
     readonly type: "error";
     readonly name: "ESIMWalletAlreadyAdded";
@@ -608,7 +617,11 @@ declare const DeviceWallet: readonly [{
     }];
 }, {
     readonly type: "error";
-    readonly name: "ETHAccessNotGrantableAtBind";
+    readonly name: "EmptyDeviceIdentifier";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "FundsAccessNotGrantableAtBind";
     readonly inputs: readonly [{
         readonly name: "eSIMWallet";
         readonly type: "address";
@@ -616,32 +629,12 @@ declare const DeviceWallet: readonly [{
     }];
 }, {
     readonly type: "error";
-    readonly name: "ETHAccessRevoked";
+    readonly name: "FundsAccessRevoked";
     readonly inputs: readonly [{
         readonly name: "eSIMWallet";
         readonly type: "address";
         readonly internalType: "address";
     }];
-}, {
-    readonly type: "error";
-    readonly name: "EmptyDeviceIdentifier";
-    readonly inputs: readonly [];
-}, {
-    readonly type: "error";
-    readonly name: "FailedToTransfer";
-    readonly inputs: readonly [];
-}, {
-    readonly type: "error";
-    readonly name: "InsufficientBalance";
-    readonly inputs: readonly [{
-        readonly name: "balance";
-        readonly type: "uint256";
-        readonly internalType: "uint256";
-    }, {
-        readonly name: "amount";
-        readonly type: "uint256";
-        readonly internalType: "uint256";
-    }];
 }, {
     readonly type: "error";
     readonly name: "InvalidDeviceWalletOwnerKey";
@@ -686,6 +679,14 @@ declare const DeviceWallet: readonly [{
     readonly type: "error";
     readonly name: "ReentrancyGuardReentrantCall";
     readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "SafeERC20FailedOperation";
+    readonly inputs: readonly [{
+        readonly name: "token";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
 }, {
     readonly type: "error";
     readonly name: "UnknownESIMWallet";