tribo-kit-sdk 1.0.0

package/README.md

@@ -0,0 +1,68 @@
+# TriboKit SDK
+
+The official TypeScript SDK for building Mini Apps within the **Tribo Ecosystem**.
+
+## Installation
+
+```bash
+npm install tribo-kit-sdk
+```
+
+## Quick Start
+
+### 1. Connect User Account
+
+Before performing any action, you should request the user to connect their wallet.
+
+```typescript
+import { Tribo } from 'tribo-kit-sdk';
+
+const connect = async () => {
+  const result = await Tribo.connect();
+  if (result.success) {
+    console.log("Connected wallet:", result.address);
+    console.log("User FID:", result.fid);
+  } else {
+    console.error("Connection failed:", result.error);
+  }
+};
+```
+
+### 2. Request Payment
+
+Ask the user to pay for a service or item.
+
+```typescript
+const handlePay = async () => {
+  const result = await Tribo.pay({
+    amount: 0.5,
+    recipient: "0x123...", // Your recipient address
+    description: "Premium Access"
+  });
+
+  if (result.success) {
+    console.log("Transaction Hash:", result.txHash);
+  }
+};
+```
+
+### 3. Check Balance
+
+Get the balance of the connected user.
+
+```typescript
+const checkBal = async () => {
+    if (!Tribo.wallet) return;
+    
+    const res = await Tribo.getBalance(Tribo.wallet);
+    console.log("Balance:", res.balance);
+};
+```
+
+## Deployment
+
+To test your app, host it on a public URL and add it to the Tribo Ecosystem dashboard. Your app must be running inside the Tribo host to communicate with the SDK.
+
+---
+
+Built with ❤️ by [Tribo](https://tribovault.co)

package/dist/index.d.mts

@@ -0,0 +1,87 @@
+/**
+ * Tribo SDK
+ *
+ * Official SDK for Tribo Ecosystem Mini Apps.
+ * Allows apps to request payments and user connection when running inside the Tribo host.
+ */
+interface PayParams {
+    amount: number;
+    recipient: string;
+    tokenAddress?: string;
+    description?: string;
+}
+interface PaymentResponse {
+    success: boolean;
+    txHash?: string;
+    error?: string;
+}
+interface ConnectResponse {
+    success: boolean;
+    address?: string;
+    username?: string;
+    fid?: string;
+    pfpUrl?: string | null;
+    error?: string;
+}
+declare class TriboSDK {
+    private static instance;
+    private isConnected;
+    private userWallet;
+    private constructor();
+    static getInstance(): TriboSDK;
+    /**
+     * Check if we are running inside the Tribo Ecosystem bridge (iframe)
+     */
+    isInsideEcosystem(): boolean;
+    private setupResponseListener;
+    /**
+     * Internal: Send message to parent frame and wait for response
+     */
+    private sendToParent;
+    /**
+     * Request connection from the host.
+     * This will trigger the connection modal in the Tribo App.
+     */
+    connect(): Promise<ConnectResponse>;
+    /**
+     * Request a payment.
+     * This will trigger the transaction modal in the Tribo App.
+     */
+    pay(params: PayParams): Promise<PaymentResponse>;
+    /**
+     * Request a generic transaction (swap or specialized send).
+     */
+    sendTransaction(params: any): Promise<PaymentResponse>;
+    /**
+     * Get balance of a specific token for the connected user.
+     */
+    getBalance(address: string, tokenAddress?: string): Promise<{
+        success: boolean;
+        balance: string;
+        error?: string;
+    }>;
+    /**
+     * Request verification (Proof of Personhood/Orb).
+     */
+    verify(params: {
+        action: string;
+        signal: string;
+    }): Promise<{
+        success: boolean;
+        data?: any;
+        error?: string;
+    }>;
+    /**
+     * Request notification permissions.
+     */
+    requestNotifications(): Promise<{
+        success: boolean;
+        data?: any;
+        error?: string;
+    }>;
+    get wallet(): string | null;
+    get connected(): boolean;
+}
+declare const Tribo: TriboSDK;
+
+export { type ConnectResponse, type PayParams, type PaymentResponse, Tribo, Tribo as default };

package/dist/index.d.ts

@@ -0,0 +1,87 @@
+/**
+ * Tribo SDK
+ *
+ * Official SDK for Tribo Ecosystem Mini Apps.
+ * Allows apps to request payments and user connection when running inside the Tribo host.
+ */
+interface PayParams {
+    amount: number;
+    recipient: string;
+    tokenAddress?: string;
+    description?: string;
+}
+interface PaymentResponse {
+    success: boolean;
+    txHash?: string;
+    error?: string;
+}
+interface ConnectResponse {
+    success: boolean;
+    address?: string;
+    username?: string;
+    fid?: string;
+    pfpUrl?: string | null;
+    error?: string;
+}
+declare class TriboSDK {
+    private static instance;
+    private isConnected;
+    private userWallet;
+    private constructor();
+    static getInstance(): TriboSDK;
+    /**
+     * Check if we are running inside the Tribo Ecosystem bridge (iframe)
+     */
+    isInsideEcosystem(): boolean;
+    private setupResponseListener;
+    /**
+     * Internal: Send message to parent frame and wait for response
+     */
+    private sendToParent;
+    /**
+     * Request connection from the host.
+     * This will trigger the connection modal in the Tribo App.
+     */
+    connect(): Promise<ConnectResponse>;
+    /**
+     * Request a payment.
+     * This will trigger the transaction modal in the Tribo App.
+     */
+    pay(params: PayParams): Promise<PaymentResponse>;
+    /**
+     * Request a generic transaction (swap or specialized send).
+     */
+    sendTransaction(params: any): Promise<PaymentResponse>;
+    /**
+     * Get balance of a specific token for the connected user.
+     */
+    getBalance(address: string, tokenAddress?: string): Promise<{
+        success: boolean;
+        balance: string;
+        error?: string;
+    }>;
+    /**
+     * Request verification (Proof of Personhood/Orb).
+     */
+    verify(params: {
+        action: string;
+        signal: string;
+    }): Promise<{
+        success: boolean;
+        data?: any;
+        error?: string;
+    }>;
+    /**
+     * Request notification permissions.
+     */
+    requestNotifications(): Promise<{
+        success: boolean;
+        data?: any;
+        error?: string;
+    }>;
+    get wallet(): string | null;
+    get connected(): boolean;
+}
+declare const Tribo: TriboSDK;
+
+export { type ConnectResponse, type PayParams, type PaymentResponse, Tribo, Tribo as default };

package/dist/index.js

@@ -0,0 +1,133 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  Tribo: () => Tribo,
+  default: () => index_default
+});
+module.exports = __toCommonJS(index_exports);
+var TriboSDK = class _TriboSDK {
+  static instance;
+  isConnected = false;
+  userWallet = null;
+  constructor() {
+    if (typeof window !== "undefined") {
+      this.setupResponseListener();
+    }
+  }
+  static getInstance() {
+    if (!_TriboSDK.instance) {
+      _TriboSDK.instance = new _TriboSDK();
+    }
+    return _TriboSDK.instance;
+  }
+  /**
+   * Check if we are running inside the Tribo Ecosystem bridge (iframe)
+   */
+  isInsideEcosystem() {
+    if (typeof window === "undefined") return false;
+    return window.self !== window.top;
+  }
+  setupResponseListener() {
+  }
+  /**
+   * Internal: Send message to parent frame and wait for response
+   */
+  async sendToParent(command, params) {
+    return new Promise((resolve) => {
+      if (!this.isInsideEcosystem()) {
+        resolve({ success: false, error: "Not running inside Tribo Ecosystem" });
+        return;
+      }
+      const requestId = Math.random().toString(36).substring(7);
+      const handler = (event) => {
+        const { type, requestId: responseId } = event.data;
+        if (type === "TRIBO_RESPONSE" && responseId === requestId) {
+          window.removeEventListener("message", handler);
+          const { type: _, requestId: __, ...response } = event.data;
+          resolve(response);
+        }
+      };
+      window.addEventListener("message", handler);
+      window.parent.postMessage({ command, params, requestId }, "*");
+      setTimeout(() => {
+        window.removeEventListener("message", handler);
+        resolve({ success: false, error: "Request timed out" });
+      }, 6e4);
+    });
+  }
+  /**
+   * Request connection from the host.
+   * This will trigger the connection modal in the Tribo App.
+   */
+  async connect() {
+    const response = await this.sendToParent("CONNECT");
+    if (response.success && response.data) {
+      this.isConnected = true;
+      this.userWallet = response.data.address;
+      return { ...response.data, success: true };
+    }
+    return response;
+  }
+  /**
+   * Request a payment.
+   * This will trigger the transaction modal in the Tribo App.
+   */
+  async pay(params) {
+    return await this.sendToParent("PAY", params);
+  }
+  /**
+   * Request a generic transaction (swap or specialized send).
+   */
+  async sendTransaction(params) {
+    return await this.sendToParent("SEND_TRANSACTION", params);
+  }
+  /**
+   * Get balance of a specific token for the connected user.
+   */
+  async getBalance(address, tokenAddress) {
+    return await this.sendToParent("GET_BALANCE", { address, tokenAddress });
+  }
+  /**
+   * Request verification (Proof of Personhood/Orb).
+   */
+  async verify(params) {
+    return await this.sendToParent("VERIFY", params);
+  }
+  /**
+   * Request notification permissions.
+   */
+  async requestNotifications() {
+    return await this.sendToParent("REQUEST_NOTIFICATIONS");
+  }
+  get wallet() {
+    return this.userWallet;
+  }
+  get connected() {
+    return this.isConnected;
+  }
+};
+var Tribo = TriboSDK.getInstance();
+var index_default = Tribo;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Tribo
+});

package/dist/index.mjs

@@ -0,0 +1,108 @@
+// src/index.ts
+var TriboSDK = class _TriboSDK {
+  static instance;
+  isConnected = false;
+  userWallet = null;
+  constructor() {
+    if (typeof window !== "undefined") {
+      this.setupResponseListener();
+    }
+  }
+  static getInstance() {
+    if (!_TriboSDK.instance) {
+      _TriboSDK.instance = new _TriboSDK();
+    }
+    return _TriboSDK.instance;
+  }
+  /**
+   * Check if we are running inside the Tribo Ecosystem bridge (iframe)
+   */
+  isInsideEcosystem() {
+    if (typeof window === "undefined") return false;
+    return window.self !== window.top;
+  }
+  setupResponseListener() {
+  }
+  /**
+   * Internal: Send message to parent frame and wait for response
+   */
+  async sendToParent(command, params) {
+    return new Promise((resolve) => {
+      if (!this.isInsideEcosystem()) {
+        resolve({ success: false, error: "Not running inside Tribo Ecosystem" });
+        return;
+      }
+      const requestId = Math.random().toString(36).substring(7);
+      const handler = (event) => {
+        const { type, requestId: responseId } = event.data;
+        if (type === "TRIBO_RESPONSE" && responseId === requestId) {
+          window.removeEventListener("message", handler);
+          const { type: _, requestId: __, ...response } = event.data;
+          resolve(response);
+        }
+      };
+      window.addEventListener("message", handler);
+      window.parent.postMessage({ command, params, requestId }, "*");
+      setTimeout(() => {
+        window.removeEventListener("message", handler);
+        resolve({ success: false, error: "Request timed out" });
+      }, 6e4);
+    });
+  }
+  /**
+   * Request connection from the host.
+   * This will trigger the connection modal in the Tribo App.
+   */
+  async connect() {
+    const response = await this.sendToParent("CONNECT");
+    if (response.success && response.data) {
+      this.isConnected = true;
+      this.userWallet = response.data.address;
+      return { ...response.data, success: true };
+    }
+    return response;
+  }
+  /**
+   * Request a payment.
+   * This will trigger the transaction modal in the Tribo App.
+   */
+  async pay(params) {
+    return await this.sendToParent("PAY", params);
+  }
+  /**
+   * Request a generic transaction (swap or specialized send).
+   */
+  async sendTransaction(params) {
+    return await this.sendToParent("SEND_TRANSACTION", params);
+  }
+  /**
+   * Get balance of a specific token for the connected user.
+   */
+  async getBalance(address, tokenAddress) {
+    return await this.sendToParent("GET_BALANCE", { address, tokenAddress });
+  }
+  /**
+   * Request verification (Proof of Personhood/Orb).
+   */
+  async verify(params) {
+    return await this.sendToParent("VERIFY", params);
+  }
+  /**
+   * Request notification permissions.
+   */
+  async requestNotifications() {
+    return await this.sendToParent("REQUEST_NOTIFICATIONS");
+  }
+  get wallet() {
+    return this.userWallet;
+  }
+  get connected() {
+    return this.isConnected;
+  }
+};
+var Tribo = TriboSDK.getInstance();
+var index_default = Tribo;
+export {
+  Tribo,
+  index_default as default
+};

package/package.json

@@ -0,0 +1,30 @@
+{
+    "name": "tribo-kit-sdk",
+    "version": "1.0.0",
+    "description": "Official SDK for Tribo Ecosystem Mini Apps",
+    "main": "dist/index.js",
+    "module": "dist/index.mjs",
+    "types": "dist/index.d.ts",
+    "files": [
+        "dist"
+    ],
+    "scripts": {
+        "build": "tsup src/index.ts --format cjs,esm --dts --clean",
+        "dev": "tsup src/index.ts --format cjs,esm --watch --dts",
+        "lint": "tsc --noEmit"
+    },
+    "keywords": [
+        "tribo",
+        "ecosystem",
+        "farcaster",
+        "minikit",
+        "sdk",
+        "web3"
+    ],
+    "author": "Tribo",
+    "license": "MIT",
+    "devDependencies": {
+        "tsup": "^8.0.0",
+        "typescript": "^5.0.0"
+    }
+}