kokio-sdk 0.0.1

package/src/abis/RegistryHelper.json

@@ -0,0 +1,382 @@
+[
+    {
+        "type": "function",
+        "name": "deployLazyWallet",
+        "inputs": [
+            {
+                "name": "_deviceWalletOwnerKey",
+                "type": "bytes32[2]",
+                "internalType": "bytes32[2]"
+            },
+            {
+                "name": "_deviceUniqueIdentifier",
+                "type": "string",
+                "internalType": "string"
+            },
+            {
+                "name": "_salt",
+                "type": "uint256",
+                "internalType": "uint256"
+            },
+            {
+                "name": "_eSIMUniqueIdentifiers",
+                "type": "string[]",
+                "internalType": "string[]"
+            },
+            {
+                "name": "_dataBundleDetails",
+                "type": "tuple[][]",
+                "internalType": "struct DataBundleDetails[][]",
+                "components": [
+                    {
+                        "name": "dataBundleID",
+                        "type": "string",
+                        "internalType": "string"
+                    },
+                    {
+                        "name": "dataBundlePrice",
+                        "type": "uint256",
+                        "internalType": "uint256"
+                    }
+                ]
+            },
+            {
+                "name": "_depositAmount",
+                "type": "uint256",
+                "internalType": "uint256"
+            }
+        ],
+        "outputs": [
+            {
+                "name": "",
+                "type": "address",
+                "internalType": "address"
+            },
+            {
+                "name": "",
+                "type": "address[]",
+                "internalType": "address[]"
+            }
+        ],
+        "stateMutability": "payable"
+    },
+    {
+        "type": "function",
+        "name": "deviceWalletFactory",
+        "inputs": [],
+        "outputs": [
+            {
+                "name": "",
+                "type": "address",
+                "internalType": "contract DeviceWalletFactory"
+            }
+        ],
+        "stateMutability": "view"
+    },
+    {
+        "type": "function",
+        "name": "deviceWalletToOwner",
+        "inputs": [
+            {
+                "name": "deviceWalletAddress",
+                "type": "address",
+                "internalType": "address"
+            },
+            {
+                "name": "",
+                "type": "uint256",
+                "internalType": "uint256"
+            }
+        ],
+        "outputs": [
+            {
+                "name": "ownerP256Keys",
+                "type": "bytes32",
+                "internalType": "bytes32"
+            }
+        ],
+        "stateMutability": "view"
+    },
+    {
+        "type": "function",
+        "name": "eSIMWalletFactory",
+        "inputs": [],
+        "outputs": [
+            {
+                "name": "",
+                "type": "address",
+                "internalType": "contract ESIMWalletFactory"
+            }
+        ],
+        "stateMutability": "view"
+    },
+    {
+        "type": "function",
+        "name": "isDeviceWalletValid",
+        "inputs": [
+            {
+                "name": "deviceWalletAddress",
+                "type": "address",
+                "internalType": "address"
+            }
+        ],
+        "outputs": [
+            {
+                "name": "valid",
+                "type": "bool",
+                "internalType": "bool"
+            }
+        ],
+        "stateMutability": "view"
+    },
+    {
+        "type": "function",
+        "name": "isESIMWalletOnStandby",
+        "inputs": [
+            {
+                "name": "eSIMWalletAddress",
+                "type": "address",
+                "internalType": "address"
+            }
+        ],
+        "outputs": [
+            {
+                "name": "isOnStandby",
+                "type": "bool",
+                "internalType": "bool"
+            }
+        ],
+        "stateMutability": "view"
+    },
+    {
+        "type": "function",
+        "name": "isESIMWalletValid",
+        "inputs": [
+            {
+                "name": "eSIMWalletAddress",
+                "type": "address",
+                "internalType": "address"
+            }
+        ],
+        "outputs": [
+            {
+                "name": "deviceWalletAddress",
+                "type": "address",
+                "internalType": "address"
+            }
+        ],
+        "stateMutability": "view"
+    },
+    {
+        "type": "function",
+        "name": "lazyWalletRegistry",
+        "inputs": [],
+        "outputs": [
+            {
+                "name": "",
+                "type": "address",
+                "internalType": "address"
+            }
+        ],
+        "stateMutability": "view"
+    },
+    {
+        "type": "function",
+        "name": "registeredP256Keys",
+        "inputs": [
+            {
+                "name": "hashOfOwnerP256Keys",
+                "type": "bytes32",
+                "internalType": "bytes32"
+            }
+        ],
+        "outputs": [
+            {
+                "name": "deviceWalletAddress",
+                "type": "address",
+                "internalType": "address"
+            }
+        ],
+        "stateMutability": "view"
+    },
+    {
+        "type": "function",
+        "name": "uniqueIdentifierToDeviceWallet",
+        "inputs": [
+            {
+                "name": "deviceIdentifier",
+                "type": "string",
+                "internalType": "string"
+            }
+        ],
+        "outputs": [
+            {
+                "name": "deviceWalletAddress",
+                "type": "address",
+                "internalType": "address"
+            }
+        ],
+        "stateMutability": "view"
+    },
+    {
+        "type": "event",
+        "name": "DeviceWalletInfoUpdated",
+        "inputs": [
+            {
+                "name": "_deviceWallet",
+                "type": "address",
+                "indexed": true,
+                "internalType": "address"
+            },
+            {
+                "name": "_deviceUniqueIdentifier",
+                "type": "string",
+                "indexed": false,
+                "internalType": "string"
+            },
+            {
+                "name": "_deviceWalletOwnerKey",
+                "type": "bytes32[2]",
+                "indexed": false,
+                "internalType": "bytes32[2]"
+            }
+        ],
+        "anonymous": false
+    },
+    {
+        "type": "event",
+        "name": "ESIMWalletSetOnStandby",
+        "inputs": [
+            {
+                "name": "_eSIMWalletAddress",
+                "type": "address",
+                "indexed": true,
+                "internalType": "address"
+            },
+            {
+                "name": "_isOnStandby",
+                "type": "bool",
+                "indexed": false,
+                "internalType": "bool"
+            },
+            {
+                "name": "_deviceWalletAddress",
+                "type": "address",
+                "indexed": true,
+                "internalType": "address"
+            }
+        ],
+        "anonymous": false
+    },
+    {
+        "type": "event",
+        "name": "LazyWalletDeployed",
+        "inputs": [
+            {
+                "name": "_deviceWallet",
+                "type": "address",
+                "indexed": true,
+                "internalType": "address"
+            },
+            {
+                "name": "_deviceUniqueIdentifier",
+                "type": "string",
+                "indexed": false,
+                "internalType": "string"
+            },
+            {
+                "name": "_eSIMWallet",
+                "type": "address",
+                "indexed": true,
+                "internalType": "address"
+            },
+            {
+                "name": "_eSIMUniqueIdentifier",
+                "type": "string",
+                "indexed": false,
+                "internalType": "string"
+            }
+        ],
+        "anonymous": false
+    },
+    {
+        "type": "event",
+        "name": "RegistryInitialized",
+        "inputs": [
+            {
+                "name": "_eSIMWalletAdmin",
+                "type": "address",
+                "indexed": false,
+                "internalType": "address"
+            },
+            {
+                "name": "_vault",
+                "type": "address",
+                "indexed": false,
+                "internalType": "address"
+            },
+            {
+                "name": "_upgradeManager",
+                "type": "address",
+                "indexed": true,
+                "internalType": "address"
+            },
+            {
+                "name": "_deviceWalletFactory",
+                "type": "address",
+                "indexed": true,
+                "internalType": "address"
+            },
+            {
+                "name": "_eSIMWalletFactory",
+                "type": "address",
+                "indexed": true,
+                "internalType": "address"
+            },
+            {
+                "name": "_verifier",
+                "type": "address",
+                "indexed": false,
+                "internalType": "address"
+            }
+        ],
+        "anonymous": false
+    },
+    {
+        "type": "event",
+        "name": "UpdatedDeviceWalletassociatedWithESIMWallet",
+        "inputs": [
+            {
+                "name": "_eSIMWalletAddress",
+                "type": "address",
+                "indexed": true,
+                "internalType": "address"
+            },
+            {
+                "name": "_deviceWalletAddress",
+                "type": "address",
+                "indexed": true,
+                "internalType": "address"
+            }
+        ],
+        "anonymous": false
+    },
+    {
+        "type": "event",
+        "name": "UpdatedLazyWalletRegistryAddress",
+        "inputs": [
+            {
+                "name": "_lazyWalletRegistry",
+                "type": "address",
+                "indexed": true,
+                "internalType": "address"
+            }
+        ],
+        "anonymous": false
+    },
+    {
+        "type": "error",
+        "name": "OnlyLazyWalletRegistry",
+        "inputs": []
+    }
+]

package/src/abis/index.ts

@@ -0,0 +1,21 @@
+import DeviceWallet from './DeviceWallet.json' assert { type: 'json' };
+import DeviceWalletFactory from './DeviceWalletFactory.json' assert { type: 'json' };
+import ESIMWallet from './ESIMWallet.json' assert { type: 'json' };
+import ESIMWalletFactory from './ESIMWalletFactory.json' assert { type: 'json' };
+import LazyWalletRegistry from './LazyWalletRegistry.json' assert { type: 'json' };
+import P256Verifier from './P256Verifier.json' assert { type: 'json' };
+import Registry from './Registry.json' assert { type: 'json' };
+import RegistryHelper from './RegistryHelper.json' assert { type: 'json' };
+import BeaconProxy from './BeaconProxy.json' assert { type: 'json' }
+
+export {
+    DeviceWallet,
+    DeviceWalletFactory,
+    ESIMWallet,
+    ESIMWalletFactory,
+    LazyWalletRegistry,
+    P256Verifier,
+    Registry,
+    RegistryHelper,
+    BeaconProxy
+}

package/src/config.ts

@@ -0,0 +1,46 @@
+import { Address, WalletClient } from "viem";
+import { ConstantsSubPackage } from "./interface/constantsClass.js";
+import { smartAccountSubPackage } from "./interface/smartAccountClass.js";
+import { deviceWalletFactorySubPackage } from "./interface/deviceWalletFactoryClass.js";
+import { P256VerifierSubPackage } from "./interface/P256VerifierClass.js";
+import { lazyWalletRegistrySubPackage } from "./interface/lazyWalletRegistryClass.js";
+import { deviceWalletSubPackage } from "./interface/deviceWalletClass.js";
+import { eSIMWalletSubPackage } from "./interface/eSIMWalletClass.js";
+import { eSIMWalletFactorySubPackage } from "./interface/eSIMWalletFactoryClass.js";
+import { SmartAccountClient } from "@aa-sdk/core";
+import { TurnkeyClient } from "@turnkey/http";
+
+export class Kokio {
+    viemWalletClient: WalletClient;
+    turnkeyClient: TurnkeyClient;
+    organizationId: string;
+    constants: ConstantsSubPackage;
+    smartAccount: smartAccountSubPackage;
+    deviceWalletFactory?: deviceWalletFactorySubPackage;
+    eSIMWalletFactory?: eSIMWalletFactorySubPackage;
+    lazyWalletRegistry?: lazyWalletRegistrySubPackage;
+    deviceWallet?: deviceWalletSubPackage;
+    eSIMWallet?: eSIMWalletSubPackage;
+    P256Verifier?: P256VerifierSubPackage;
+
+    constructor(
+        viemWalletClient: WalletClient,
+        turnkeyClient: TurnkeyClient,
+        organizationId: string,
+        smartAccountClient?: SmartAccountClient,
+        deviceWalletAddress?: Address,
+        eSIMWalletAddress?: Address
+    ) {
+        this.viemWalletClient = viemWalletClient;
+        this.turnkeyClient = turnkeyClient;
+        this.organizationId = organizationId;
+        this.constants = new ConstantsSubPackage(this.viemWalletClient);
+        this.smartAccount = new smartAccountSubPackage(this.viemWalletClient, this.turnkeyClient, this.organizationId);
+        this.deviceWalletFactory = smartAccountClient? new deviceWalletFactorySubPackage(viemWalletClient, smartAccountClient): undefined;
+        this.eSIMWalletFactory = smartAccountClient? new eSIMWalletFactorySubPackage(viemWalletClient, smartAccountClient): undefined;
+        this.lazyWalletRegistry = smartAccountClient? new lazyWalletRegistrySubPackage(smartAccountClient): undefined;
+        this.P256Verifier = smartAccountClient? new P256VerifierSubPackage(smartAccountClient): undefined;
+        this.deviceWallet = deviceWalletAddress && smartAccountClient? new deviceWalletSubPackage(viemWalletClient, smartAccountClient, deviceWalletAddress): undefined;
+        this.eSIMWallet = eSIMWalletAddress && smartAccountClient? new eSIMWalletSubPackage(smartAccountClient, eSIMWalletAddress): undefined;
+    }
+}

package/src/interface/P256VerifierClass.ts

@@ -0,0 +1,19 @@
+import { Address, WalletClient } from "viem";
+import {
+    _verifySignature
+} from "../logic/P256Verifier.js"
+import { WebAuthnSignature } from "../types";
+import { SmartAccountClient } from "@aa-sdk/core";
+
+export class P256VerifierSubPackage {
+
+    client;
+
+    constructor(client: SmartAccountClient) {
+        this.client = client;
+    }
+
+    verifySignature (message: string, requireMessageVerification: boolean, webAuthnSignature: WebAuthnSignature, x: bigint, y: bigint) {
+        return _verifySignature(this.client, message, requireMessageVerification, webAuthnSignature, x, y);
+    }
+}

package/src/interface/constantsClass.ts

@@ -0,0 +1,35 @@
+import { WalletClient } from "viem";
+import {
+    _extractChainID,
+    _getChainSpecificConstants,
+    mainnetFactoryAddresses,
+    sepoliaFactoryAddresses,
+    optimismMainnetFactoryAddresses,
+    optimismSepoliaFactoryAddresses,
+    arbitrumOneFactoryAddresses,
+    arbitrumSepoliaFactoryAddresses,
+    customErrors
+} from "../logic/constants.js"
+
+export class ConstantsSubPackage {
+    factoryAddresses!: 
+            typeof sepoliaFactoryAddresses |
+            typeof mainnetFactoryAddresses |
+            typeof optimismMainnetFactoryAddresses |
+            typeof optimismSepoliaFactoryAddresses |
+            typeof arbitrumOneFactoryAddresses |
+            typeof arbitrumSepoliaFactoryAddresses;
+    customErrors!: typeof customErrors;
+
+    constructor(client: WalletClient) {
+        (async () => {
+          const chainID = await _extractChainID(client);
+          const values = _getChainSpecificConstants(chainID);
+    
+          this.factoryAddresses = values?.factoryAddresses;
+          this.customErrors = values?.customErrors;
+    
+          return this;
+        })();
+    }
+}

package/src/interface/deviceWalletClass.ts

@@ -0,0 +1,62 @@
+import { Address, WalletClient } from "viem";
+import {
+    _addESIMWallet,
+    _deployESIMWallet,
+    _getOwner,
+    _getVaultAddress,
+    _payETHForDataBundles,
+    _pullETH,
+    _removeESIMWallet,
+    _setESIMUniqueIdentifierForAnESIMWallet,
+    _toggleAccessToETH
+} from "../logic/deviceWallet.js"
+import { SmartAccountClient } from "@aa-sdk/core";
+
+export class deviceWalletSubPackage {
+
+    smartAccountClient;
+    walletClient;
+    address;
+
+    constructor(walletClient: WalletClient, smartAccountClient: SmartAccountClient, address: Address) {
+        this.smartAccountClient = smartAccountClient;
+        this.walletClient = walletClient;
+        this.address = address;
+    }
+
+    addESIMWallet (eSIMWalletAddress: Address, hasAccessToETH: boolean) {
+        return _addESIMWallet(this.smartAccountClient, this.address, eSIMWalletAddress, hasAccessToETH);
+    }
+
+    deployESIMWallet (hasAccessToETH: boolean, salt: bigint) {
+        return _deployESIMWallet(this.smartAccountClient, this.address, hasAccessToETH, salt);
+    }
+
+    getVaultAddress () {
+        return _getVaultAddress(this.smartAccountClient, this.address);
+    }
+
+    payETHForDataBundles (amount: bigint) {
+        return _payETHForDataBundles(this.smartAccountClient, this.address, amount);
+    }
+
+    pullETH (amount: bigint) {
+        return _pullETH(this.smartAccountClient, this.address, amount);
+    }
+
+    removeESIMWallet (eSIMWalletAddress: Address, hasAccessToETH: boolean) {
+        return _removeESIMWallet(this.smartAccountClient, this.address, eSIMWalletAddress, hasAccessToETH);
+    }
+
+    setESIMUniqueIdentifierForAnESIMWallet (eSIMWalletAddress: Address, eSIMUniqueIdentifier: string) {
+        return _setESIMUniqueIdentifierForAnESIMWallet(this.smartAccountClient, this.address, eSIMWalletAddress, eSIMUniqueIdentifier);
+    }
+
+    toggleAccessToETH (eSIMWalletAddress: Address, hasAccessToETH: boolean) {
+        return _toggleAccessToETH(this.smartAccountClient, this.address, eSIMWalletAddress, hasAccessToETH);
+    }
+
+    getOwner () {
+        return _getOwner (this.walletClient, this.address);
+    }
+}

package/src/interface/deviceWalletFactoryClass.ts

@@ -0,0 +1,35 @@
+import { Address, WalletClient } from "viem";
+import {
+    _createAccountWithEOA,
+    _getAddress,
+    _getCurrentDeviceWalletImplementation
+} from "../logic/deviceWalletFactory.js"
+import { SmartAccountClient } from "@aa-sdk/core";
+
+export class deviceWalletFactorySubPackage {
+
+    smartAccountClient;
+    walletClient;
+
+    constructor(walletClient: WalletClient, smartAccountClient: SmartAccountClient) {
+        this.smartAccountClient = smartAccountClient;
+        this.walletClient = walletClient
+    }
+
+    createAccountWithEOA (
+        deviceUniqueIdentifier: string,
+        deviceWalletOwnerKey: string,
+        salt: bigint,
+        depositAmount: bigint
+    ) {
+        return _createAccountWithEOA(this.walletClient, deviceUniqueIdentifier, deviceWalletOwnerKey, salt, depositAmount);
+    }
+
+    getAddress (deviceUniqueIdentifier: string, deviceWalletOwnerKey: string, salt: bigint) {
+        return _getAddress(this.smartAccountClient, deviceUniqueIdentifier, deviceWalletOwnerKey, salt);
+    }
+
+    getCurrentDeviceWalletImplementation () {
+        return _getCurrentDeviceWalletImplementation(this.smartAccountClient);
+    }
+}

package/src/interface/eSIMWalletClass.ts

@@ -0,0 +1,55 @@
+import { Address, WalletClient } from "viem";
+import {
+    _acceptOwnershipTransfer,
+    _buyDataBundle,
+    _owner,
+    _populateHistory,
+    _requestTransferOwnership,
+    _sendETHToDeviceWallet,
+    _setESIMUniqueIdentifier,
+    _transferOwnership
+} from "../logic/eSIMWallet.js"
+import { DataBundleDetails } from "../types";
+import { SmartAccountClient } from "@aa-sdk/core";
+
+export class eSIMWalletSubPackage {
+
+    client;
+    address;
+
+    constructor(client: SmartAccountClient, address: Address) {
+        this.client = client;
+        this.address = address;
+    }
+
+    acceptOwnershipTransfer () {
+        return _acceptOwnershipTransfer(this.client, this.address);
+    }
+    
+    buyDataBundle (dataBundleDetails: DataBundleDetails) {
+        return _buyDataBundle(this.client, this.address, dataBundleDetails);
+    }
+
+    owner () {
+        return _owner(this.client, this.address);
+    }
+
+    populateHistory (dataBundleDetails: Array<DataBundleDetails>) {
+        return _populateHistory(this.client, this.address, dataBundleDetails);
+    }
+
+    requestTransferOwnership (newOwner: Address) {
+        return _requestTransferOwnership(this.client, this.address, newOwner);
+    }
+
+    sendETHToDeviceWallet (amount: bigint) {
+        return _sendETHToDeviceWallet(this.client, this.address, amount);
+    }
+    _setESIMUniqueIdentifier (eSIMUniqueIdentifier: string) {
+        return _setESIMUniqueIdentifier(this.client, this.address, eSIMUniqueIdentifier);
+    }
+
+    _transferOwnership (amount: bigint) {
+        return _transferOwnership(this.client, this.address, amount);
+    }
+}