@paimaexample/wallets 0.3.117

package/script/wallets/src/midnight/wrapper.d.ts

@@ -0,0 +1,7 @@
+import type { Result } from "../../../utils/src/mod.js";
+import type { IProvider } from "../IProvider.js";
+import type { WalletMode, ApiForMode } from "../utils.js";
+import { type LoginInfoMap } from "../wallet-modes.js";
+export declare function checkMidnightWalletStatus(): Promise<Result<string>>;
+export declare function midnightLoginWrapper(loginInfo: LoginInfoMap[WalletMode.Midnight]): Promise<Result<IProvider<ApiForMode<WalletMode.Midnight>>>>;
+//# sourceMappingURL=wrapper.d.ts.map

package/script/wallets/src/midnight/wrapper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wrapper.d.ts","sourceRoot":"","sources":["../../../../src/wallets/src/midnight/wrapper.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAC1D,OAAO,EAAE,KAAK,YAAY,EAAmB,MAAM,oBAAoB,CAAC;AAGxE,wBAAsB,yBAAyB,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAUzE;AAED,wBAAsB,oBAAoB,CACxC,SAAS,EAAE,YAAY,CAAC,UAAU,CAAC,QAAQ,CAAC,GAC3C,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAa7D"}

package/script/wallets/src/midnight/wrapper.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkMidnightWalletStatus = checkMidnightWalletStatus;
+exports.midnightLoginWrapper = midnightLoginWrapper;
+const wallet_modes_js_1 = require("../wallet-modes.js");
+const midnight_js_1 = require("./midnight.js");
+async function checkMidnightWalletStatus() {
+    const provider = midnight_js_1.MidnightConnector.instance().getProvider();
+    if (provider == null) {
+        return {
+            success: false,
+            errorMessage: "No Midnight wallet found",
+        };
+    }
+    return { success: true, result: "OK" };
+}
+async function midnightLoginWrapper(loginInfo) {
+    const loginResult = await (0, wallet_modes_js_1.connectInjected)("midnightLoginWrapper", loginInfo, midnight_js_1.MidnightConnector.instance());
+    if (loginResult.success === false) {
+        return loginResult;
+    }
+    return {
+        success: true,
+        result: loginResult.result,
+    };
+}

package/script/wallets/src/mina/mina.d.ts

@@ -0,0 +1,28 @@
+import * as AuroMinaApi from "@aurowallet/mina-provider";
+import { type IConnector, type IInjectedConnector, type ConnectionOption, type IProvider, type ActiveConnection, type AddressAndType, type UserSignature } from "../IProvider.js";
+export type MinaApi = AuroMinaApi.default;
+type MinaAddress = any;
+export declare class MinaConnector implements IConnector<MinaApi>, IInjectedConnector<MinaApi> {
+    private provider;
+    private static INSTANCE;
+    static getWalletOptions(): ConnectionOption<MinaApi>[];
+    static instance(): MinaConnector;
+    connectSimple(): Promise<IProvider<any>>;
+    connectNamed(name: string): Promise<IProvider<any>>;
+    connectExternal: (conn: ActiveConnection<MinaApi>) => Promise<MinaProvider>;
+    getProvider: () => undefined | MinaProvider;
+    getOrThrowProvider: () => MinaProvider;
+    isConnected: () => boolean;
+}
+export declare class MinaProvider implements IProvider<MinaApi> {
+    private readonly conn;
+    readonly address: MinaAddress;
+    constructor(conn: ActiveConnection<MinaApi>, address: MinaAddress);
+    static init: (conn: ActiveConnection<MinaApi>) => Promise<MinaProvider>;
+    getConnection: () => ActiveConnection<MinaApi>;
+    getAddress: () => AddressAndType;
+    signMessage: (message: string) => Promise<UserSignature>;
+    static fetchAddress: (conn: ActiveConnection<MinaApi>) => Promise<string>;
+}
+export {};
+//# sourceMappingURL=mina.d.ts.map

package/script/wallets/src/mina/mina.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mina.d.ts","sourceRoot":"","sources":["../../../../src/wallets/src/mina/mina.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,WAAW,MAAM,2BAA2B,CAAC;AAEzD,OAAO,EACL,KAAK,UAAU,EACf,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,SAAS,EAEd,KAAK,gBAAgB,EACrB,KAAK,cAAc,EACnB,KAAK,aAAa,EACnB,MAAM,iBAAiB,CAAC;AAGzB,MAAM,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC;AAE1C,KAAK,WAAW,GAAG,GAAG,CAAC;AASvB,qBAAa,aACX,YAAW,UAAU,CAAC,OAAO,CAAC,EAAE,kBAAkB,CAAC,OAAO,CAAC;IAE3D,OAAO,CAAC,QAAQ,CAA2B;IAC3C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAwC;IAE/D,MAAM,CAAC,gBAAgB,IAAI,gBAAgB,CAAC,OAAO,CAAC,EAAE;IAiBtD,MAAM,CAAC,QAAQ,IAAI,aAAa;IAQ1B,aAAa,IAAI,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IAcxC,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IAazD,eAAe,GACb,MAAM,gBAAgB,CAAC,OAAO,CAAC,KAC9B,OAAO,CAAC,YAAY,CAAC,CActB;IACF,WAAW,QAAO,SAAS,GAAG,YAAY,CAExC;IACF,kBAAkB,QAAO,YAAY,CAKnC;IACF,WAAW,QAAO,OAAO,CAEvB;CACH;AAED,qBAAa,YAAa,YAAW,SAAS,CAAC,OAAO,CAAC;IAEnD,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,QAAQ,CAAC,OAAO,EAAE,WAAW;gBADZ,IAAI,EAAE,gBAAgB,CAAC,OAAO,CAAC,EACvC,OAAO,EAAE,WAAW;IAG/B,MAAM,CAAC,IAAI,GACT,MAAM,gBAAgB,CAAC,OAAO,CAAC,KAC9B,OAAO,CAAC,YAAY,CAAC,CAItB;IACF,aAAa,QAAO,gBAAgB,CAAC,OAAO,CAAC,CAE3C;IACF,UAAU,QAAO,cAAc,CAK7B;IACF,WAAW,GAAU,SAAS,MAAM,KAAG,OAAO,CAAC,aAAa,CAAC,CAoB3D;IAEF,MAAM,CAAC,YAAY,GACjB,MAAM,gBAAgB,CAAC,OAAO,CAAC,KAC9B,OAAO,CAAC,MAAM,CAAC,CAahB;CACH"}

package/script/wallets/src/mina/mina.js

@@ -0,0 +1,138 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MinaProvider = exports.MinaConnector = void 0;
+const mod_js_1 = require("../../../utils/src/mod.js");
+const IProvider_js_1 = require("../IProvider.js");
+const windows_js_1 = require("../windows.js");
+// JSR Error: modifying global types is not allowed
+// declare global {
+//   interface Window {
+//     mina?: Record<string, { name?: string; enable?: () => Promise<MinaApi> }>;
+//   }
+// }
+class MinaConnector {
+    provider;
+    static INSTANCE = undefined;
+    static getWalletOptions() {
+        const minaApi = (0, windows_js_1.getWindow)()?.mina;
+        if (minaApi == null || !minaApi.isAuro)
+            return [];
+        return [
+            {
+                metadata: {
+                    name: "auro",
+                    displayName: "Auro Wallet",
+                },
+                api: async () => {
+                    return minaApi;
+                },
+            },
+        ];
+    }
+    static instance() {
+        if (MinaConnector.INSTANCE == null) {
+            const newInstance = new MinaConnector();
+            MinaConnector.INSTANCE = newInstance;
+        }
+        return MinaConnector.INSTANCE;
+    }
+    async connectSimple() {
+        if (this.provider != null) {
+            return this.provider;
+        }
+        const options = MinaConnector.getWalletOptions();
+        if (options.length === 0) {
+            throw new Error(`No Mina wallet found`);
+        }
+        return await this.connectExternal(await (0, IProvider_js_1.optionToActive)(options[0]));
+    }
+    async connectNamed(name) {
+        if (this.provider?.getConnection().metadata?.name === name) {
+            return this.provider;
+        }
+        const provider = MinaConnector.getWalletOptions().find((entry) => entry.metadata.name === name);
+        if (provider == null) {
+            throw new Error(`MinaProvider: unsupported connection type ${name}`);
+        }
+        return await this.connectExternal(await (0, IProvider_js_1.optionToActive)(provider));
+    }
+    connectExternal = async (conn) => {
+        if (this.provider?.getConnection().metadata?.name === conn.metadata.name) {
+            return this.provider;
+        }
+        this.provider = await MinaProvider.init(conn);
+        conn.api.on("accountsChanged", (accounts) => {
+            if (!accounts || !accounts[0] || accounts[0] !== this.provider?.address) {
+                this.provider = undefined;
+            }
+        });
+        return this.provider;
+    };
+    getProvider = () => {
+        return this.provider;
+    };
+    getOrThrowProvider = () => {
+        if (this.provider == null) {
+            throw new Error(`MinaConnector provider isn't initialized yet`);
+        }
+        return this.provider;
+    };
+    isConnected = () => {
+        return this.provider != null;
+    };
+}
+exports.MinaConnector = MinaConnector;
+class MinaProvider {
+    conn;
+    address;
+    constructor(conn, address) {
+        this.conn = conn;
+        this.address = address;
+    }
+    static init = async (conn) => {
+        const address = await MinaProvider.fetchAddress(conn);
+        return new MinaProvider(conn, address);
+    };
+    getConnection = () => {
+        return this.conn;
+    };
+    getAddress = () => {
+        return {
+            type: mod_js_1.AddressType.MINA,
+            address: this.address,
+        };
+    };
+    signMessage = async (message) => {
+        // There is no way of choosing the signing account here. At most we could
+        // monitor the changed events and erroring out if it changed.
+        const signed = await this.conn.api.signMessage({ message: message });
+        if ("signature" in signed) {
+            const { signature } = signed;
+            const networkKind = await this.conn.api.requestNetwork();
+            // only these two options are used
+            // https://github.com/aurowallet/auro-wallet-browser-extension/blob/624de322dd99baaa09617bbad4a4a838f0a88edc/src/background/lib/index.js#L17
+            // this is part of the hashed message
+            const network = networkKind.networkID === "mainnet" ? "mainnet" : "testnet";
+            return `${signature.field};${signature.scalar};${network}`;
+        }
+        else {
+            throw new Error("Failed to sign message");
+        }
+    };
+    static fetchAddress = async (conn) => {
+        try {
+            const addresses = await conn.api.requestAccounts();
+            if ("length" in addresses && addresses.length > 0) {
+                return addresses[0];
+            }
+            else {
+                throw new Error("requestAccounts request failed");
+            }
+        }
+        catch (err) {
+            console.log("[pickMinaAddress] error calling requestAccounts:", err);
+        }
+        throw new Error("[pickMinaAddress] no used or unused addresses");
+    };
+}
+exports.MinaProvider = MinaProvider;

package/script/wallets/src/mina/wrapper.d.ts

@@ -0,0 +1,6 @@
+import type { Result } from "../../../utils/src/mod.js";
+import type { IProvider } from "../IProvider.js";
+import type { WalletMode, ApiForMode } from "../utils.js";
+import { type LoginInfoMap } from "../wallet-modes.js";
+export declare function minaLoginWrapper(loginInfo: LoginInfoMap[WalletMode.Mina]): Promise<Result<IProvider<ApiForMode<WalletMode.Mina>>>>;
+//# sourceMappingURL=wrapper.d.ts.map

package/script/wallets/src/mina/wrapper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wrapper.d.ts","sourceRoot":"","sources":["../../../../src/wallets/src/mina/wrapper.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAC1D,OAAO,EAAE,KAAK,YAAY,EAAmB,MAAM,oBAAoB,CAAC;AAGxE,wBAAsB,gBAAgB,CACpC,SAAS,EAAE,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,GACvC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAazD"}

package/script/wallets/src/mina/wrapper.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.minaLoginWrapper = minaLoginWrapper;
+const wallet_modes_js_1 = require("../wallet-modes.js");
+const mina_js_1 = require("./mina.js");
+async function minaLoginWrapper(loginInfo) {
+    const loginResult = await (0, wallet_modes_js_1.connectInjected)("minaLoginWrapper", loginInfo, mina_js_1.MinaConnector.instance());
+    if (loginResult.success === false) {
+        return loginResult;
+    }
+    return {
+        success: true,
+        result: loginResult.result,
+    };
+}

package/script/wallets/src/mod.d.ts

@@ -0,0 +1,8 @@
+export type { IProvider, AddressAndType, UserSignature, WalletOption } from "./IProvider.js";
+export type { Wallet } from "./types.js";
+export type { WalletAddress } from "../../utils/src/mod.js";
+export { WalletMode, WalletNameMap } from "./utils.js";
+export { walletLogin } from "./wallets.js";
+export { allInjectedWallets } from "./utils.js";
+export * from "./paima.js";
+//# sourceMappingURL=mod.d.ts.map

package/script/wallets/src/mod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../../src/wallets/src/mod.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,SAAS,EAAE,cAAc,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC7F,YAAY,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AACzC,YAAY,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAEvD,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAChD,cAAc,YAAY,CAAC"}

package/script/wallets/src/mod.js

@@ -0,0 +1,26 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.allInjectedWallets = exports.walletLogin = exports.WalletNameMap = exports.WalletMode = void 0;
+var utils_js_1 = require("./utils.js");
+Object.defineProperty(exports, "WalletMode", { enumerable: true, get: function () { return utils_js_1.WalletMode; } });
+Object.defineProperty(exports, "WalletNameMap", { enumerable: true, get: function () { return utils_js_1.WalletNameMap; } });
+// Main entry point
+var wallets_js_1 = require("./wallets.js");
+Object.defineProperty(exports, "walletLogin", { enumerable: true, get: function () { return wallets_js_1.walletLogin; } });
+var utils_js_2 = require("./utils.js");
+Object.defineProperty(exports, "allInjectedWallets", { enumerable: true, get: function () { return utils_js_2.allInjectedWallets; } });
+__exportStar(require("./paima.js"), exports);

package/script/wallets/src/paima.d.ts

@@ -0,0 +1,104 @@
+import { type EvmAddress } from "../../utils/src/mod.js";
+import type { Wallet } from "./types.js";
+import { type Chain } from "viem";
+import type { AbiItem } from "web3-utils";
+import { type TransactionReceipt, Web3 } from "web3";
+/**
+ * This is main class used for setting up the Paima Engine
+ * communication. It sets up the location of the Paima L2 Contact.
+ */
+export declare class PaimaEngineConfig {
+    appName: string;
+    paimaL2SyncProtocolName: string;
+    paimaL2ContractAddress: EvmAddress;
+    paimaL2Abi: AbiItem[];
+    paimaL2Chain: Chain;
+    paimaL2CurrentFee: bigint;
+    web3: Web3 | undefined;
+    batcherURL: string | undefined;
+    preferBatchedMode: boolean;
+    constructor(appName: string | undefined, paimaL2SyncProtocolName: string, paimaL2ContractAddress: EvmAddress, paimaL2Chain: Chain, paimaL2Abi: AbiItem[] | undefined, batcherURL: string | undefined, preferBatchedMode?: boolean);
+    /** Return a Web3 client for the PaimaL2 chain. */
+    getWeb3Client(): Promise<Web3>;
+    /** Return a Paima L2 Contract Instance for the PaimaL2. */
+    getPaimaL2Contract(): Promise<import("web3").Contract<import("web3").AbiFragment[]>>;
+    private fallbackABI;
+}
+/**
+ * Paima Wallet Interface - Sign a message with a wallet.
+ * @param wallet - The wallet to sign the message with.
+ * @param message - The message to sign.
+ * @returns
+ */
+export declare function signMessage(wallet: Wallet, message: string): Promise<string>;
+/**
+ * Main function to send a transaction to a Paima L2 contract.
+ * It will decide whether to use the batcher or the self-sequenced transaction based on the preferBatchedMode flag.
+ *
+ * @param wallet - The wallet to send the transaction with.
+ * @param conciseData - The concise data to send.
+ * @param paimaEngineConfig - The Paima Engine configuration.
+ * @param waitForConfirmation - The confirmation mode to use:
+ *   no-wait: Do not wait for any confirmation.
+ *   wait-receipt: Wait only for the chain transaction receipt.
+ *   wait-effectstream-processed: Wait for the transaction to be processed by the Paima Engine.
+ * @returns
+ */
+export declare function sendTransaction(wallet: Wallet, conciseData: any[], paimaEngineConfig: PaimaEngineConfig, waitForConfirmation?: "wait-effectstream-processed" | "wait-receipt" | "no-wait", batcherTarget?: string | undefined): Promise<ReturnType<typeof sendBatcherTransaction> | ReturnType<typeof sendSelfSequencedTransaction>>;
+/**
+ * Paima Wallet Interface - Send a transaction to a Paima L2 contract with a wallet.
+ * The concise data must match the grammar; if not the input will be rejected by Paima Engine.
+ * @param wallet - The wallet to send the transaction with.
+ * @param conciseData - The concise data to send.
+ * @param paimaEngineConfig - The Paima Engine configuration.
+ * @param waitForConfirmation - The confirmation mode to use:
+ *   no-wait: Do not wait for any confirmation.
+ *   wait-receipt: Wait only for the chain transaction receipt.
+ *   wait-effectstream-processed: Wait for the transaction to be processed by the Paima Engine.
+ ** @returns
+ */
+export declare function sendSelfSequencedTransaction(wallet: Wallet, conciseData: any[], paimaEngineConfig: PaimaEngineConfig, waitForConfirmation?: "wait-effectstream-processed" | "wait-receipt" | "no-wait"): Promise<{
+    success: boolean;
+    type: "self-sequenced";
+} & ({
+    wait: "wait-effectstream-processed";
+    hash: string;
+    receipt: TransactionReceipt;
+    rollup: number;
+} | {
+    wait: "wait-receipt" | "no-wait";
+    hash: string;
+})>;
+/**
+ * Wait for specific block number to be processed by the Paima Engine.
+ * This guarantees that the block number is processed by the Paima Engine.
+ * @param blockNumber - The block number to wait for.
+ * @param paimaEngineConfig - The Paima Engine configuration.
+ * @param timeout (optional) - The timeout in milliseconds.
+ * @returns
+ */
+export declare function waitForPaimaEngineBlockProcessed(blockNumber: number, paimaEngineConfig: PaimaEngineConfig, timeout?: number): Promise<{
+    latestBlock: number;
+    rollup: number;
+} | void>;
+/**
+ * Paima Wallet Interface - Standard batcher communication for a Paima L2 contract.
+ * This is only a default implementation, your own batcher might have different requirements.
+ * @param wallet - The wallet to send the batched transaction with.
+ * @param paimaL2Address - The address of the Paima L2 contract.
+ * @param conciseData - The concise data to send.
+ * @param waitForConfirmation - The confirmation mode to use:
+ *   no-wait: Do not wait for any confirmation.
+ *   wait-receipt: Wait only for the chain transaction receipt.
+ *   wait-effectstream-processed: Wait for the transaction to be processed by the Paima Engine.
+ * @returns
+ */
+export declare function sendBatcherTransaction(wallet: Wallet, conciseData: any[], paimaEngineConfig: PaimaEngineConfig, waitForConfirmation?: "wait-effectstream-processed" | "wait-receipt" | "no-wait", batcherTarget?: string | undefined): Promise<{
+    success: boolean;
+    type: "batcher";
+    message: string;
+    blockNumber: number;
+    blockHash: string;
+    rollup: number;
+}>;
+//# sourceMappingURL=paima.d.ts.map

package/script/wallets/src/paima.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"paima.d.ts","sourceRoot":"","sources":["../../../src/wallets/src/paima.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,KAAK,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACtE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEzC,OAAO,EAAE,KAAK,KAAK,EAAe,MAAM,MAAM,CAAC;AAI/C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAE,KAAK,kBAAkB,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAIrD;;;GAGG;AACH,qBAAa,iBAAiB;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,uBAAuB,EAAE,MAAM,CAAC;IAChC,sBAAsB,EAAE,UAAU,CAAC;IACnC,UAAU,EAAE,OAAO,EAAE,CAAC;IACtB,YAAY,EAAE,KAAK,CAAC;IACpB,iBAAiB,EAAE,MAAM,CAAM;IAC/B,IAAI,EAAE,IAAI,GAAG,SAAS,CAAa;IACnC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAa;IAC3C,iBAAiB,EAAE,OAAO,CAAS;gBAGxC,OAAO,EAAE,MAAM,GAAG,SAAS,EAC3B,uBAAuB,EAAE,MAAM,EAC/B,sBAAsB,EAAE,UAAU,EAClC,YAAY,EAAE,KAAK,EACnB,UAAU,EAAE,OAAO,EAAE,GAAG,SAAS,EACjC,UAAU,EAAE,MAAM,GAAG,SAAS,EAC9B,iBAAiB,GAAE,OAAe;IAgBpC,kDAAkD;IACrC,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IAS3C,2DAA2D;IAC9C,kBAAkB;IAK/B,OAAO,CAAC,WAAW;CAWpB;AAED;;;;;GAKG;AACH,wBAAsB,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,mBAGhE;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,eAAe,CACnC,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,GAAG,EAAE,EAClB,iBAAiB,EAAE,iBAAiB,EACpC,mBAAmB,GAAE,6BAA6B,GAAG,cAAc,GAAG,SACvC,EAC/B,aAAa,GAAE,MAAM,GAAG,SAAqB,GAC5C,OAAO,CACN,UAAU,CAAC,OAAO,sBAAsB,CAAC,GACzC,UAAU,CAAC,OAAO,4BAA4B,CAAC,CAClD,CAgBA;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,4BAA4B,CAChD,MAAM,EAAE,MAAM,EAEd,WAAW,EAAE,GAAG,EAAE,EAClB,iBAAiB,EAAE,iBAAiB,EACpC,mBAAmB,GAAE,6BAA6B,GAAG,cAAc,GAAG,SACvC,GAC9B,OAAO,CACN;IACA,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,gBAAgB,CAAC;CACxB,GACC,CACE;IACA,IAAI,EAAE,6BAA6B,CAAC;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,kBAAkB,CAAC;IAC5B,MAAM,EAAE,MAAM,CAAC;CAChB,GACC;IACA,IAAI,EAAE,cAAc,GAAG,SAAS,CAAC;IACjC,IAAI,EAAE,MAAM,CAAC;CACd,CACF,CACF,CA4DA;AAqBD;;;;;;;GAOG;AACH,wBAAgB,gCAAgC,CAC9C,WAAW,EAAE,MAAM,EACnB,iBAAiB,EAAE,iBAAiB,EACpC,OAAO,GAAE,MAAc,GACtB,OAAO,CAAC;IAAE,WAAW,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAAC,CAyCzD;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,sBAAsB,CAC1C,MAAM,EAAE,MAAM,EAEd,WAAW,EAAE,GAAG,EAAE,EAClB,iBAAiB,EAAE,iBAAiB,EACpC,mBAAmB,GAAE,6BAA6B,GAAG,cAAc,GAAG,SACvC,EAC/B,aAAa,GAAE,MAAM,GAAG,SAAqB,GAC5C,OAAO,CAAC;IACT,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,SAAS,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC,CAmDD"}

package/script/wallets/src/paima.js

@@ -0,0 +1,253 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PaimaEngineConfig = void 0;
+exports.signMessage = signMessage;
+exports.sendTransaction = sendTransaction;
+exports.sendSelfSequencedTransaction = sendSelfSequencedTransaction;
+exports.waitForPaimaEngineBlockProcessed = waitForPaimaEngineBlockProcessed;
+exports.sendBatcherTransaction = sendBatcherTransaction;
+const mod_js_1 = require("../../utils/src/mod.js");
+const viem_1 = require("viem");
+const web3_utils_1 = require("web3-utils");
+const web3_1 = require("web3");
+const mod_js_2 = require("../../concise/src/mod.js");
+const mod_js_3 = require("../../events/src/mod.js");
+/**
+ * This is main class used for setting up the Paima Engine
+ * communication. It sets up the location of the Paima L2 Contact.
+ */
+class PaimaEngineConfig {
+    appName;
+    paimaL2SyncProtocolName;
+    paimaL2ContractAddress;
+    paimaL2Abi;
+    paimaL2Chain;
+    paimaL2CurrentFee = 0n;
+    web3 = undefined;
+    batcherURL = undefined;
+    preferBatchedMode = false;
+    constructor(appName, paimaL2SyncProtocolName, paimaL2ContractAddress, paimaL2Chain, paimaL2Abi, batcherURL, preferBatchedMode = false) {
+        this.appName = appName ?? "";
+        this.paimaL2SyncProtocolName = paimaL2SyncProtocolName;
+        this.paimaL2ContractAddress = paimaL2ContractAddress;
+        this.paimaL2Abi = paimaL2Abi ?? this.fallbackABI();
+        this.paimaL2Chain = paimaL2Chain;
+        this.batcherURL = batcherURL;
+        if (!this.batcherURL && preferBatchedMode) {
+            throw new Error("To enable batcher, you need to set the batcher URL.");
+        }
+        this.preferBatchedMode = preferBatchedMode;
+    }
+    /** Return a Web3 client for the PaimaL2 chain. */
+    async getWeb3Client() {
+        if (this.web3) {
+            return this.web3;
+        }
+        this.web3 = new web3_1.Web3(this.paimaL2Chain.rpcUrls.default.http[0]);
+        await this.web3.eth.getNodeInfo();
+        return this.web3;
+    }
+    /** Return a Paima L2 Contract Instance for the PaimaL2. */
+    async getPaimaL2Contract() {
+        const web3 = await this.getWeb3Client();
+        return new web3.eth.Contract(this.paimaL2Abi, this.paimaL2ContractAddress);
+    }
+    fallbackABI() {
+        return [
+            {
+                inputs: [{ name: "data", type: "bytes" }],
+                name: "paimaSubmitGameInput",
+                outputs: [],
+                stateMutability: "payable",
+                type: "function",
+            },
+        ];
+    }
+}
+exports.PaimaEngineConfig = PaimaEngineConfig;
+/**
+ * Paima Wallet Interface - Sign a message with a wallet.
+ * @param wallet - The wallet to sign the message with.
+ * @param message - The message to sign.
+ * @returns
+ */
+async function signMessage(wallet, message) {
+    const signature = await wallet.provider.signMessage(message);
+    return signature;
+}
+/**
+ * Main function to send a transaction to a Paima L2 contract.
+ * It will decide whether to use the batcher or the self-sequenced transaction based on the preferBatchedMode flag.
+ *
+ * @param wallet - The wallet to send the transaction with.
+ * @param conciseData - The concise data to send.
+ * @param paimaEngineConfig - The Paima Engine configuration.
+ * @param waitForConfirmation - The confirmation mode to use:
+ *   no-wait: Do not wait for any confirmation.
+ *   wait-receipt: Wait only for the chain transaction receipt.
+ *   wait-effectstream-processed: Wait for the transaction to be processed by the Paima Engine.
+ * @returns
+ */
+async function sendTransaction(wallet, conciseData, paimaEngineConfig, waitForConfirmation = "wait-effectstream-processed", batcherTarget = undefined) {
+    if (paimaEngineConfig.preferBatchedMode) {
+        return await sendBatcherTransaction(wallet, conciseData, paimaEngineConfig, waitForConfirmation, batcherTarget);
+    }
+    return await sendSelfSequencedTransaction(wallet, conciseData, paimaEngineConfig, waitForConfirmation);
+}
+/**
+ * Paima Wallet Interface - Send a transaction to a Paima L2 contract with a wallet.
+ * The concise data must match the grammar; if not the input will be rejected by Paima Engine.
+ * @param wallet - The wallet to send the transaction with.
+ * @param conciseData - The concise data to send.
+ * @param paimaEngineConfig - The Paima Engine configuration.
+ * @param waitForConfirmation - The confirmation mode to use:
+ *   no-wait: Do not wait for any confirmation.
+ *   wait-receipt: Wait only for the chain transaction receipt.
+ *   wait-effectstream-processed: Wait for the transaction to be processed by the Paima Engine.
+ ** @returns
+ */
+async function sendSelfSequencedTransaction(wallet, 
+// TODO this should be any type of grammar.
+conciseData, paimaEngineConfig, waitForConfirmation = "wait-effectstream-processed") {
+    // TODO: Where to get this value from?
+    const DEFAULT_GAS_PRICE = BigInt("61000000000");
+    const provider = wallet.provider;
+    const addressAndType = provider.getAddress();
+    // NOTE: If the Paima L2 contract interface is implemented in other chains,
+    //       we need to add support for them here. Paima L2 is EVM only for now.
+    if (addressAndType.type !== mod_js_1.AddressType.EVM) {
+        throw new Error("Paima L2 is EVM contract.");
+    }
+    const evmProvider = wallet.provider;
+    const hexData = (0, web3_utils_1.utf8ToHex)(JSON.stringify(conciseData));
+    const paimaL2Contract = await paimaEngineConfig.getPaimaL2Contract();
+    const txData = paimaL2Contract.methods["paimaSubmitGameInput"](hexData)
+        .encodeABI();
+    const tx = {
+        from: addressAndType.address,
+        data: txData,
+        to: paimaEngineConfig.paimaL2ContractAddress,
+        gasPrice: (0, viem_1.numberToHex)(DEFAULT_GAS_PRICE),
+        value: (0, viem_1.numberToHex)(paimaEngineConfig.paimaL2CurrentFee),
+    };
+    const tx_result = await evmProvider.sendTransaction(tx);
+    if (waitForConfirmation === "no-wait" || waitForConfirmation === "wait-receipt") {
+        return {
+            success: true,
+            type: "self-sequenced",
+            wait: waitForConfirmation,
+            hash: tx_result.txHash,
+        };
+    }
+    // Wait for paima engine to process the transaction
+    const receipt = await getTxReceipt(tx_result.txHash, paimaEngineConfig);
+    const response = await waitForPaimaEngineBlockProcessed(Number(receipt.blockNumber), paimaEngineConfig);
+    const rollup = response ? response.rollup : 0;
+    return {
+        success: true,
+        type: "self-sequenced",
+        hash: tx_result.txHash,
+        wait: waitForConfirmation,
+        receipt: serializeBigInts(receipt),
+        rollup,
+    };
+}
+// We return a json version of object for the frontend.
+function serializeBigInts(value) {
+    return JSON.parse(JSON.stringify(value, (_, v) => typeof v === "bigint" ? v.toString() : v));
+}
+// Wait for the transaction receipt for a given transaction hash.
+async function getTxReceipt(txHash, paimaEngineConfig) {
+    const web3 = await paimaEngineConfig.getWeb3Client();
+    return await web3.eth.getTransactionReceipt(txHash);
+}
+/**
+ * Wait for specific block number to be processed by the Paima Engine.
+ * This guarantees that the block number is processed by the Paima Engine.
+ * @param blockNumber - The block number to wait for.
+ * @param paimaEngineConfig - The Paima Engine configuration.
+ * @param timeout (optional) - The timeout in milliseconds.
+ * @returns
+ */
+function waitForPaimaEngineBlockProcessed(blockNumber, paimaEngineConfig, timeout = 60000) {
+    let subscriptionReference = undefined;
+    let latestBlock = 0;
+    let timer = undefined; // node & deno differ in type of timer
+    return Promise.race([
+        new Promise((_, reject) => {
+            timer = setTimeout(() => reject(new Error("Timeout")), timeout);
+        }),
+        new Promise((resolve, reject) => {
+            if (!paimaEngineConfig.paimaL2SyncProtocolName) {
+                reject(new Error("Paima L2 Sync Protocol Name is not set"));
+                return;
+            }
+            mod_js_3.PaimaEventManager.Instance.subscribe({
+                topic: mod_js_3.BuiltinEvents.SyncChains,
+                filter: {
+                    chain: paimaEngineConfig.paimaL2SyncProtocolName,
+                    block: undefined,
+                },
+            }, (event) => {
+                latestBlock = Math.max(event.block, latestBlock);
+                if (latestBlock > blockNumber) {
+                    resolve({ latestBlock, rollup: event.rollup });
+                }
+            })
+                .then((subscription) => subscriptionReference = subscription)
+                .catch(reject);
+        }),
+    ]).finally(() => {
+        if (subscriptionReference) {
+            mod_js_3.PaimaEventManager.Instance.unsubscribe(subscriptionReference);
+        }
+        if (timer) {
+            clearTimeout(timer);
+        }
+    });
+}
+/**
+ * Paima Wallet Interface - Standard batcher communication for a Paima L2 contract.
+ * This is only a default implementation, your own batcher might have different requirements.
+ * @param wallet - The wallet to send the batched transaction with.
+ * @param paimaL2Address - The address of the Paima L2 contract.
+ * @param conciseData - The concise data to send.
+ * @param waitForConfirmation - The confirmation mode to use:
+ *   no-wait: Do not wait for any confirmation.
+ *   wait-receipt: Wait only for the chain transaction receipt.
+ *   wait-effectstream-processed: Wait for the transaction to be processed by the Paima Engine.
+ * @returns
+ */
+async function sendBatcherTransaction(wallet, 
+// TODO we need to pass the batcher address here.
+conciseData, paimaEngineConfig, waitForConfirmation = "wait-effectstream-processed", batcherTarget = undefined) {
+    if (!paimaEngineConfig.batcherURL) {
+        throw new Error("Batcher URL is not set");
+    }
+    const conciseDataStr = JSON.stringify(conciseData);
+    // Send a batched message.
+    const timestamp = Date.now().toString();
+    const signature = await wallet.provider.signMessage((0, mod_js_2.createMessageForBatcher)(paimaEngineConfig.appName, timestamp, wallet.provider.getAddress().address, wallet.provider.getAddress().type, conciseDataStr, batcherTarget));
+    const response = await fetch(`${paimaEngineConfig.batcherURL}/send-input`, {
+        method: "POST",
+        headers: {
+            "Content-Type": "application/json",
+        },
+        body: JSON.stringify({
+            data: {
+                target: batcherTarget,
+                addressType: wallet.provider.getAddress().type,
+                address: wallet.provider.getAddress().address,
+                signature,
+                input: conciseDataStr,
+                timestamp,
+            },
+            confirmationLevel: waitForConfirmation,
+        }),
+    });
+    return await {
+        ...(await response.json()),
+        type: "batcher",
+        success: response.ok,
+    };
+}