@frak-labs/core-sdk 0.0.7 → 0.0.9

package/dist/{interactions/index.d.cts → interactions.d.ts}

@@ -1,174 +1,182 @@
-import { Hex, Address } from 'viem';
-import { P as PreparedInteraction } from '../interaction-CTQ5-kqe.cjs';
-
-/**
- * Press interactions allow you to track user engagement with articles or other press content on your platform.
- * After setting up these interactions, you can create acquisition campaign based on the user engagement with your press content.
- *
- * :::info
- *   To properly handle press interactions, ensure that the "Press" product type is enabled in your Business dashboard.
- * :::
- *
- * @description Encode press related user interactions
- *
- * @group Interactions Encoder
- *
- * @see {@link PreparedInteraction} The prepared interaction object that can be sent
- * @see {@link !actions.sendInteraction | `sendInteraction()`} Action used to send the prepared interaction to the Frak Wallet
- */
-declare const PressInteractionEncoder: {
-    /**
-     * Encode an open article interaction
-     * @param args
-     * @param args.articleId - The id of the article the user opened (32 bytes), could be a `keccak256` hash of the article slug, or your internal id
-     */
-    openArticle({ articleId }: {
-        articleId: Hex;
-    }): PreparedInteraction;
-    /**
-     * Encode a read article interaction
-     * @param args
-     * @param args.articleId - The id of the article the user opened (32 bytes), could be a `keccak256` hash of the article slug, or your internal id
-     */
-    readArticle({ articleId }: {
-        articleId: Hex;
-    }): PreparedInteraction;
-};
-
-/**
- * Referral interactions allow you to track user sharing activities.
- * These interactions are essential for platforms looking to grow their user base through user-to-user referrals and reward systems.
- *
- * :::info
- *   To properly handle referral interactions, ensure that the "Referral" product type is enabled in your Business dashboard.
- * :::
- *
- * @description Encode referral related user interactions
- *
- * @group Interactions Encoder
- *
- * @see {@link PreparedInteraction} The prepared interaction object that can be sent
- * @see {@link !actions.sendInteraction | `sendInteraction()`} Action used to send the prepared interaction to the Frak Wallet
- */
-declare const ReferralInteractionEncoder: {
-    /**
-     * Records the event of a user creating a referral link. Note that this interaction doesn't actually create the link itself; it only sends an event to track that a link was created.
-     */
-    createLink(): PreparedInteraction;
-    /**
-     * Encode a referred interaction
-     * @param args
-     * @param args.referrer - The Ethereum address of the user who made the referral
-     */
-    referred({ referrer }: {
-        referrer: Address;
-    }): PreparedInteraction;
-};
-
-/**
- * Purchase interactions allow you to track user purchases on your platform.
- * After setting up these interactions, you can create acquisition campaign based on the user purchase  (starting a new one, completed, or even purchase dropped).
- *
- * :::info
- *   To properly handle purchase interactions, ensure that the "Purchase" product type is enabled in your Business dashboard, and that you have set up everything correctly in the `Purchasetracker` section.
- * :::
- *
- * :::note
- * The `purchaseId` is used on both interactions. It can be computed like this:
- *
- * ```ts
- * const purchaseId = keccak256(concatHex([productId, toHex(externalPurchaseId)]));
- * ```
- *
- * With:
- * - `productId`: The id of your product, you can find it in the product dashboard.
- * - `externalPurchaseId`: The id of the purchase in your system (e.g. the shopify `order_id`).
- * :::
- *
- * @description Encode purchase related user interactions
- *
- * @group Interactions Encoder
- *
- * @see {@link !actions.sendInteraction | `sendInteraction()`} Action used to send the prepared interaction to the Frak Wallet
- * @see {@link PreparedInteraction} The prepared interaction object that can be sent
- * @see {@link !actions.trackPurchaseStatus | `trackPurchaseStatus()`} Action that will automatically send the purchase upon completion
- * @see [Purchase Webhooks](/wallet-sdk/references-api/webhook) Webhooks to be implemented on your side to confirm a purchase
- * @see [Purchase Proof](/wallet-sdk/references-api/purchaseProof) Get a merklee proof for the purchase
- */
-declare const PurchaseInteractionEncoder: {
-    /**
-     * Encode a start purchase interaction
-     * @param args
-     * @param args.purchaseId - The id of the purchase that is being started.
-     */
-    startPurchase({ purchaseId }: {
-        purchaseId: Hex;
-    }): PreparedInteraction;
-    /**
-     * Encode a complete purchase interaction
-     * @param args
-     * @param args.purchaseId - The id of the purchase that is being completed.
-     * @param args.proof - The merkle proof that the user has completed the purchase (see [Purchase Webhooks](/wallet-sdk/references-api/webhook) for more details).
-     */
-    completedPurchase({ purchaseId, proof, }: {
-        purchaseId: Hex;
-        proof: Hex[];
-    }): PreparedInteraction;
-    /**
-     * Encode an unsafe complete purchase interaction (when we can't provide the proof)
-     * @param args
-     * @param args.purchaseId - The id of the purchase that is being completed.
-     */
-    unsafeCompletedPurchase({ purchaseId, }: {
-        purchaseId: Hex;
-    }): PreparedInteraction;
-};
-
-/**
- * Webshop interactions allow you to track user activities on your webshop.
- *
- * :::info
- *   To properly handle webshop interactions, ensure that the "WebShop" product type is enabled in your Business dashboard.
- * :::
- *
- * @description Encode webshop related user interactions
- *
- * @group Interactions Encoder
- *
- * @see {@link PreparedInteraction} The prepared interaction object that can be sent
- * @see {@link !actions.sendInteraction | `sendInteraction()`} Action used to send the prepared interaction to the Frak Wallet
- */
-declare const WebShopInteractionEncoder: {
-    /**
-     * Encode an open webshop interaction
-     */
-    open(): PreparedInteraction;
-};
-
-/**
- * Retail interactions allow you to track user activities on your retails products.
- *
- * :::info
- *   To properly handle retail interactions, ensure that the "Retail" product type is enabled in your Business dashboard.
- * :::
- *
- * @description Encode retail related user interactions
- *
- * @group Interactions Encoder
- *
- * @see {@link PreparedInteraction} The prepared interaction object that can be sent
- * @see {@link !actions.sendInteraction | `sendInteraction()`} Action used to send the prepared interaction to the Frak Wallet
- */
-declare const RetailInteractionEncoder: {
-    /**
-     * Encode a customer meeting retail interaction
-     * @param args
-     * @param args.agencyId - The id of the agency that the customer is meeting with
-     *
-     */
-    customerMeeting({ agencyId }: {
-        agencyId: Hex;
-    }): PreparedInteraction;
-};
-
-export { PressInteractionEncoder, PurchaseInteractionEncoder, ReferralInteractionEncoder, RetailInteractionEncoder, WebShopInteractionEncoder };
+import { Address } from 'viem';
+import { Hex } from 'viem';
+
+/**
+ * Represent a prepared user interaction, ready to be sent on-chain via the wallet
+ */
+declare type PreparedInteraction = {
+    handlerTypeDenominator: Hex;
+    interactionData: Hex;
+};
+
+/**
+ * Press interactions allow you to track user engagement with articles or other press content on your platform.
+ * After setting up these interactions, you can create acquisition campaign based on the user engagement with your press content.
+ *
+ * :::info
+ *   To properly handle press interactions, ensure that the "Press" product type is enabled in your Business dashboard.
+ * :::
+ *
+ * @description Encode press related user interactions
+ *
+ * @group Interactions Encoder
+ *
+ * @see {@link PreparedInteraction} The prepared interaction object that can be sent
+ * @see {@link !actions.sendInteraction | `sendInteraction()`} Action used to send the prepared interaction to the Frak Wallet
+ */
+export declare const PressInteractionEncoder: {
+    /**
+     * Encode an open article interaction
+     * @param args
+     * @param args.articleId - The id of the article the user opened (32 bytes), could be a `keccak256` hash of the article slug, or your internal id
+     */
+    openArticle({ articleId }: {
+        articleId: Hex;
+    }): PreparedInteraction;
+    /**
+     * Encode a read article interaction
+     * @param args
+     * @param args.articleId - The id of the article the user opened (32 bytes), could be a `keccak256` hash of the article slug, or your internal id
+     */
+    readArticle({ articleId }: {
+        articleId: Hex;
+    }): PreparedInteraction;
+};
+
+/**
+ * Purchase interactions allow you to track user purchases on your platform.
+ * After setting up these interactions, you can create acquisition campaign based on the user purchase  (starting a new one, completed, or even purchase dropped).
+ *
+ * :::info
+ *   To properly handle purchase interactions, ensure that the "Purchase" product type is enabled in your Business dashboard, and that you have set up everything correctly in the `Purchasetracker` section.
+ * :::
+ *
+ * :::note
+ * The `purchaseId` is used on both interactions. It can be computed like this:
+ *
+ * ```ts
+ * const purchaseId = keccak256(concatHex([productId, toHex(externalPurchaseId)]));
+ * ```
+ *
+ * With:
+ * - `productId`: The id of your product, you can find it in the product dashboard.
+ * - `externalPurchaseId`: The id of the purchase in your system (e.g. the shopify `order_id`).
+ * :::
+ *
+ * @description Encode purchase related user interactions
+ *
+ * @group Interactions Encoder
+ *
+ * @see {@link !actions.sendInteraction | `sendInteraction()`} Action used to send the prepared interaction to the Frak Wallet
+ * @see {@link PreparedInteraction} The prepared interaction object that can be sent
+ * @see {@link !actions.trackPurchaseStatus | `trackPurchaseStatus()`} Action that will automatically send the purchase upon completion
+ * @see [Purchase Webhooks](/wallet-sdk/references-api/webhook) Webhooks to be implemented on your side to confirm a purchase
+ * @see [Purchase Proof](/wallet-sdk/references-api/purchaseProof) Get a merklee proof for the purchase
+ */
+export declare const PurchaseInteractionEncoder: {
+    /**
+     * Encode a start purchase interaction
+     * @param args
+     * @param args.purchaseId - The id of the purchase that is being started.
+     */
+    startPurchase({ purchaseId }: {
+        purchaseId: Hex;
+    }): PreparedInteraction;
+    /**
+     * Encode a complete purchase interaction
+     * @param args
+     * @param args.purchaseId - The id of the purchase that is being completed.
+     * @param args.proof - The merkle proof that the user has completed the purchase (see [Purchase Webhooks](/wallet-sdk/references-api/webhook) for more details).
+     */
+    completedPurchase({ purchaseId, proof, }: {
+        purchaseId: Hex;
+        proof: Hex[];
+    }): PreparedInteraction;
+    /**
+     * Encode an unsafe complete purchase interaction (when we can't provide the proof)
+     * @param args
+     * @param args.purchaseId - The id of the purchase that is being completed.
+     */
+    unsafeCompletedPurchase({ purchaseId, }: {
+        purchaseId: Hex;
+    }): PreparedInteraction;
+};
+
+/**
+ * Referral interactions allow you to track user sharing activities.
+ * These interactions are essential for platforms looking to grow their user base through user-to-user referrals and reward systems.
+ *
+ * :::info
+ *   To properly handle referral interactions, ensure that the "Referral" product type is enabled in your Business dashboard.
+ * :::
+ *
+ * @description Encode referral related user interactions
+ *
+ * @group Interactions Encoder
+ *
+ * @see {@link PreparedInteraction} The prepared interaction object that can be sent
+ * @see {@link !actions.sendInteraction | `sendInteraction()`} Action used to send the prepared interaction to the Frak Wallet
+ */
+export declare const ReferralInteractionEncoder: {
+    /**
+     * Records the event of a user creating a referral link. Note that this interaction doesn't actually create the link itself; it only sends an event to track that a link was created.
+     */
+    createLink(): PreparedInteraction;
+    /**
+     * Encode a referred interaction
+     * @param args
+     * @param args.referrer - The Ethereum address of the user who made the referral
+     */
+    referred({ referrer }: {
+        referrer: Address;
+    }): PreparedInteraction;
+};
+
+/**
+ * Retail interactions allow you to track user activities on your retails products.
+ *
+ * :::info
+ *   To properly handle retail interactions, ensure that the "Retail" product type is enabled in your Business dashboard.
+ * :::
+ *
+ * @description Encode retail related user interactions
+ *
+ * @group Interactions Encoder
+ *
+ * @see {@link PreparedInteraction} The prepared interaction object that can be sent
+ * @see {@link !actions.sendInteraction | `sendInteraction()`} Action used to send the prepared interaction to the Frak Wallet
+ */
+export declare const RetailInteractionEncoder: {
+    /**
+     * Encode a customer meeting retail interaction
+     * @param args
+     * @param args.agencyId - The id of the agency that the customer is meeting with
+     *
+     */
+    customerMeeting({ agencyId }: {
+        agencyId: Hex;
+    }): PreparedInteraction;
+};
+
+/**
+ * Webshop interactions allow you to track user activities on your webshop.
+ *
+ * :::info
+ *   To properly handle webshop interactions, ensure that the "WebShop" product type is enabled in your Business dashboard.
+ * :::
+ *
+ * @description Encode webshop related user interactions
+ *
+ * @group Interactions Encoder
+ *
+ * @see {@link PreparedInteraction} The prepared interaction object that can be sent
+ * @see {@link !actions.sendInteraction | `sendInteraction()`} Action used to send the prepared interaction to the Frak Wallet
+ */
+export declare const WebShopInteractionEncoder: {
+    /**
+     * Encode an open webshop interaction
+     */
+    open(): PreparedInteraction;
+};
+
+export { }

package/dist/interactions.js

@@ -0,0 +1 @@
+import*as e from"viem";let r="0xc0a24ffb",t="0xd5bd0fbe",n="0xb311798f",a="0x010cc3b9",o="0xb2c0f17c",c="0xd87e90c3",i="0x8403aeb4",p="0x4d5b14e0",d="0x74489004",s={dapp:1,press:2,webshop:3,retail:4,referral:30,purchase:31};Object.entries(s).reduce((e,[r,t])=>(e[r]=BigInt(1)<<BigInt(t),e),{});let l={openArticle({articleId:t}){let n=(0,e.concatHex)([r,(0,e.pad)(t,{size:32})]);return{handlerTypeDenominator:(0,e.toHex)(s.press),interactionData:n}},readArticle({articleId:r}){let n=(0,e.concatHex)([t,(0,e.pad)(r,{size:32})]);return{handlerTypeDenominator:(0,e.toHex)(s.press),interactionData:n}}},x={createLink:()=>({handlerTypeDenominator:(0,e.toHex)(s.referral),interactionData:o}),referred({referrer:r}){let t=(0,e.concatHex)([a,(0,e.pad)(r,{size:32})]);return{handlerTypeDenominator:(0,e.toHex)(s.referral),interactionData:t}}},h={startPurchase({purchaseId:r}){let t=(0,e.concatHex)([c,(0,e.pad)(r,{size:32})]);return{handlerTypeDenominator:(0,e.toHex)(s.purchase),interactionData:t}},completedPurchase({purchaseId:r,proof:t}){let n=(0,e.encodeAbiParameters)([{type:"uint256"},{type:"bytes32[]"}],[BigInt(r),t]),a=(0,e.concatHex)([i,n]);return{handlerTypeDenominator:(0,e.toHex)(s.purchase),interactionData:a}},unsafeCompletedPurchase({purchaseId:r}){let t=(0,e.concatHex)([p,(0,e.pad)(r,{size:32})]);return{handlerTypeDenominator:(0,e.toHex)(s.purchase),interactionData:t}}},u={open:()=>({handlerTypeDenominator:(0,e.toHex)(s.webshop),interactionData:n})},m={customerMeeting({agencyId:r}){let t=(0,e.concatHex)([d,(0,e.pad)(r,{size:32})]);return{handlerTypeDenominator:(0,e.toHex)(s.retail),interactionData:t}}};export{l as PressInteractionEncoder,h as PurchaseInteractionEncoder,x as ReferralInteractionEncoder,m as RetailInteractionEncoder,u as WebShopInteractionEncoder};

package/package.json

@@ -11,7 +11,7 @@
       "url": "https://twitter.com/QNivelais"
     }
   ],
-  "version": "0.0.7",
+  "version": "0.0.9",
   "description": "Core SDK of the Frak wallet, low level library to interact directly with the frak ecosystem.",
   "repository": {
     "url": "https://github.com/frak-id/wallet",
@@ -50,22 +50,22 @@
     },
     "./actions": {
       "import": {
-        "types": "./dist/actions/index.d.ts",
-        "default": "./dist/actions/index.js"
+        "types": "./dist/actions.d.ts",
+        "default": "./dist/actions.js"
       },
       "require": {
-        "types": "./dist/actions/index.d.cts",
-        "default": "./dist/actions/index.cjs"
+        "types": "./dist/actions.d.cts",
+        "default": "./dist/actions.cjs"
       }
     },
     "./interactions": {
       "import": {
-        "types": "./dist/interactions/index.d.ts",
-        "default": "./dist/interactions/index.js"
+        "types": "./dist/interactions.d.ts",
+        "default": "./dist/interactions.js"
       },
       "require": {
-        "types": "./dist/interactions/index.d.cts",
-        "default": "./dist/interactions/index.cjs"
+        "types": "./dist/interactions.d.cts",
+        "default": "./dist/interactions.cjs"
       }
     }
   },
@@ -74,8 +74,8 @@
     "format:check": "biome check .",
     "format": "biome check --write .",
     "clean": "rimraf dist",
-    "build": "tsup && bun run check-exports",
-    "build:watch": "tsup --watch",
+    "build": "rslib build && bun run check-exports",
+    "build:watch": "rslib build --watch",
     "check-exports": "attw --pack --profile node16 .",
     "typecheck": "tsc --noEmit",
     "prepublish": "bun run lint && bun run build",
@@ -89,11 +89,11 @@
     "js-sha256": "^0.11.0"
   },
   "devDependencies": {
-    "@arethetypeswrong/cli": "^0.17.3",
+    "@arethetypeswrong/cli": "^0.17.4",
+    "@microsoft/api-extractor": "^7.52.1",
+    "@rslib/core": "^0.5.4",
     "@types/node": "^22",
-    "browserslist": "^4.24.4",
-    "browserslist-to-esbuild": "^2.1.1",
-    "tsup": "^8.3.6",
+    "ts-checker-rspack-plugin": "^1.1.1",
     "typescript": "^5"
   },
   "browserslist": [