@xandeum/web3.js 0.4.0

package/dist/getMetadata.js

@@ -0,0 +1,89 @@
+"use strict";
+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());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMetadata = getMetadata;
+/**
+ * Sends a JSON-RPC request to the Xandeum RPC endpoint to retrieve metadata
+ * about a file or directory at the given path.
+ *
+ * This function calls the custom RPC method `getMetadata`, which is implemented
+ * by the backend to return metadata such as type (file or directory), size,
+ * timestamps etc.
+ *
+ * @param connection - The solana web3 connection with Xandeum-compatible JSON-RPC endpoint (e.g., `'https://api.devnet.solana.com'`).
+ * @param path - The filesystem path to query metadata for (e.g., `/documents/myfile.txt`).
+ *
+ * @returns A `Promise<any>` resolving to the parsed JSON response from the RPC server,
+ *          typically containing a `result` object with metadata fields.
+ *
+ */
+function getMetadata(connection, path) {
+    return __awaiter(this, void 0, void 0, function () {
+        var url, requestBody, response, errorText, data;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    url = connection.rpcEndpoint;
+                    requestBody = {
+                        jsonrpc: '2.0',
+                        id: 1,
+                        method: 'getMetadata',
+                        params: [path]
+                    };
+                    return [4 /*yield*/, fetch(url, {
+                            method: 'POST',
+                            headers: {
+                                'Content-Type': 'application/json'
+                            },
+                            body: JSON.stringify(requestBody)
+                        })];
+                case 1:
+                    response = _a.sent();
+                    if (!!response.ok) return [3 /*break*/, 3];
+                    return [4 /*yield*/, response.text()];
+                case 2:
+                    errorText = _a.sent();
+                    return [2 /*return*/, Error("error! status: ".concat(response.status, ", message: ").concat(errorText))];
+                case 3: return [4 /*yield*/, response.json()];
+                case 4:
+                    data = _a.sent();
+                    return [2 /*return*/, data];
+            }
+        });
+    });
+}

package/dist/getXandeumResult.d.ts

@@ -0,0 +1,15 @@
+import { Connection } from "@solana/web3.js";
+/**
+ * Sends a JSON-RPC request to the Xandeum-compatible endpoint to retrieve
+ * the result of a transaction previously submitted with a specific signature.
+ *
+ * This function calls the custom RPC method `getXandeumResult`, which returns
+ * the result associated with the given transaction signature.
+ *
+ * @param connection - The Solana web3 connection object pointing to a Xandeum-compatible RPC endpoint.
+ * @param signature - The transaction signature string whose result should be queried.
+ *
+ * @returns A `Promise<any>` resolving to the parsed JSON response from the RPC server,
+ *          which includes the result of the transaction if available.
+ */
+export declare function getXandeumResult(connection: Connection, signature: string): Promise<any>;

package/dist/getXandeumResult.js

@@ -0,0 +1,95 @@
+"use strict";
+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());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getXandeumResult = getXandeumResult;
+function sleep(ms) {
+    return new Promise(function (resolve) { return setTimeout(resolve, ms); });
+}
+/**
+ * Sends a JSON-RPC request to the Xandeum-compatible endpoint to retrieve
+ * the result of a transaction previously submitted with a specific signature.
+ *
+ * This function calls the custom RPC method `getXandeumResult`, which returns
+ * the result associated with the given transaction signature.
+ *
+ * @param connection - The Solana web3 connection object pointing to a Xandeum-compatible RPC endpoint.
+ * @param signature - The transaction signature string whose result should be queried.
+ *
+ * @returns A `Promise<any>` resolving to the parsed JSON response from the RPC server,
+ *          which includes the result of the transaction if available.
+ */
+function getXandeumResult(connection, signature) {
+    return __awaiter(this, void 0, void 0, function () {
+        var url, requestBody, response, errorText, data;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    url = connection.rpcEndpoint;
+                    requestBody = {
+                        jsonrpc: '2.0',
+                        id: 1,
+                        method: 'getXandeumResult',
+                        params: [signature]
+                    };
+                    // sleeping To let the transaction process
+                    return [4 /*yield*/, sleep(5000)];
+                case 1:
+                    // sleeping To let the transaction process
+                    _a.sent();
+                    return [4 /*yield*/, fetch(url, {
+                            method: 'POST',
+                            headers: {
+                                'Content-Type': 'application/json'
+                            },
+                            body: JSON.stringify(requestBody)
+                        })];
+                case 2:
+                    response = _a.sent();
+                    if (!!response.ok) return [3 /*break*/, 4];
+                    return [4 /*yield*/, response.text()];
+                case 3:
+                    errorText = _a.sent();
+                    return [2 /*return*/, new Error("Error! status: ".concat(response.status, ", message: ").concat(errorText))];
+                case 4: return [4 /*yield*/, response.json()];
+                case 5:
+                    data = _a.sent();
+                    return [2 /*return*/, data];
+            }
+        });
+    });
+}

package/dist/index.d.ts

@@ -0,0 +1,16 @@
+export { bigbang } from "./bigbang";
+export * from './webSocket';
+export * from "./armageddon";
+export * from "./removeFile";
+export * from "./renamePath";
+export * from "./createFile";
+export * from "./createDirectory";
+export * from "./peek";
+export * from "./poke";
+export * from "./removeDirectory";
+export * from "./copyPath";
+export * from "./move";
+export * from "./getXandeumResult";
+export { exists } from "./exists";
+export { listDirectoryEntry } from "./listDirectoryEntery";
+export { getMetadata } from "./getMetadata";

package/dist/index.js

@@ -0,0 +1,37 @@
+"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.getMetadata = exports.listDirectoryEntry = exports.exists = exports.bigbang = void 0;
+var bigbang_1 = require("./bigbang");
+Object.defineProperty(exports, "bigbang", { enumerable: true, get: function () { return bigbang_1.bigbang; } });
+__exportStar(require("./webSocket"), exports);
+__exportStar(require("./armageddon"), exports);
+__exportStar(require("./removeFile"), exports);
+__exportStar(require("./renamePath"), exports);
+__exportStar(require("./createFile"), exports);
+__exportStar(require("./createDirectory"), exports);
+__exportStar(require("./peek"), exports);
+__exportStar(require("./poke"), exports);
+__exportStar(require("./removeDirectory"), exports);
+__exportStar(require("./copyPath"), exports);
+__exportStar(require("./move"), exports);
+__exportStar(require("./getXandeumResult"), exports);
+var exists_1 = require("./exists");
+Object.defineProperty(exports, "exists", { enumerable: true, get: function () { return exists_1.exists; } });
+var listDirectoryEntery_1 = require("./listDirectoryEntery");
+Object.defineProperty(exports, "listDirectoryEntry", { enumerable: true, get: function () { return listDirectoryEntery_1.listDirectoryEntry; } });
+var getMetadata_1 = require("./getMetadata");
+Object.defineProperty(exports, "getMetadata", { enumerable: true, get: function () { return getMetadata_1.getMetadata; } });

package/dist/listDirectoryEntery.d.ts

@@ -0,0 +1,21 @@
+import { Connection } from "@solana/web3.js";
+export interface RpcRequest {
+    jsonrpc: string;
+    id: number;
+    method: string;
+    params: any[];
+}
+/**
+ * Sends a JSON-RPC request to the Xandeum RPC endpoint to list all entries (files and subdirectories)
+ * within a specified path.
+ *
+ * This function calls the custom RPC method `listDirs`, which is  return an array of
+ * directory entry metadata — names, types etc.
+ *
+ * @param connection - The solana web3 connection with Xandeum-compatible JSON-RPC endpoint (e.g., `'https://api.devnet.solana.com'`).
+ * @param path - The  filesystem path representing the directory to list (e.g., `/documents`).
+ *
+ * @returns A `Promise<any>` resolving to the parsed JSON response from the RPC server,
+ *          typically including a `result` array containing directory entry objects.
+ */
+export declare function listDirectoryEntry(connection: Connection, path: string): Promise<any>;

package/dist/listDirectoryEntery.js

@@ -0,0 +1,87 @@
+"use strict";
+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());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.listDirectoryEntry = listDirectoryEntry;
+/**
+ * Sends a JSON-RPC request to the Xandeum RPC endpoint to list all entries (files and subdirectories)
+ * within a specified path.
+ *
+ * This function calls the custom RPC method `listDirs`, which is  return an array of
+ * directory entry metadata — names, types etc.
+ *
+ * @param connection - The solana web3 connection with Xandeum-compatible JSON-RPC endpoint (e.g., `'https://api.devnet.solana.com'`).
+ * @param path - The  filesystem path representing the directory to list (e.g., `/documents`).
+ *
+ * @returns A `Promise<any>` resolving to the parsed JSON response from the RPC server,
+ *          typically including a `result` array containing directory entry objects.
+ */
+function listDirectoryEntry(connection, path) {
+    return __awaiter(this, void 0, void 0, function () {
+        var url, requestBody, response, errorText, data;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    url = connection.rpcEndpoint;
+                    requestBody = {
+                        jsonrpc: '2.0',
+                        id: 1,
+                        method: 'listDirs',
+                        params: [path]
+                    };
+                    return [4 /*yield*/, fetch(url, {
+                            method: 'POST',
+                            headers: {
+                                'Content-Type': 'application/json'
+                            },
+                            body: JSON.stringify(requestBody)
+                        })];
+                case 1:
+                    response = _a.sent();
+                    if (!!response.ok) return [3 /*break*/, 3];
+                    return [4 /*yield*/, response.text()];
+                case 2:
+                    errorText = _a.sent();
+                    return [2 /*return*/, Error("error! status: ".concat(response.status, ", message: ").concat(errorText))];
+                case 3: return [4 /*yield*/, response.json()];
+                case 4:
+                    data = _a.sent();
+                    return [2 /*return*/, data];
+            }
+        });
+    });
+}

package/dist/move.d.ts

@@ -0,0 +1,14 @@
+import { Transaction, PublicKey } from '@solana/web3.js';
+/**
+ * Constructs a Solana transaction to copy a file or directory from one  path to another.
+ *
+ * @param fsid - The unique numeric identifier representing the target file system.
+ * @param srcPath - The source path to copy from (e.g., `/documents`).
+ * @param destPath - The destination path to copy to (e.g., `/archive`).
+ * @param name - The name of the new file or directory at the destination (e.g., `report.txt`).
+ * @param wallet - The wallet public key used to sign and authorize the transaction.
+ * @returns A Promise that resolves to a Solana `Transaction` object containing the copyPath instruction.
+ * @throws Will throw an error if `srcPath` or `destPath` contains invalid characters.
+ *
+ */
+export declare function move(fsid: string, srcPath: string, destPath: string, name: string, wallet: PublicKey): Promise<Transaction>;

package/dist/move.js

@@ -0,0 +1,88 @@
+"use strict";
+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());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.move = move;
+var web3_js_1 = require("@solana/web3.js");
+var bn_js_1 = __importDefault(require("bn.js"));
+var const_1 = require("./const");
+var sanitizePath_1 = require("./sanitizePath");
+/**
+ * Constructs a Solana transaction to copy a file or directory from one  path to another.
+ *
+ * @param fsid - The unique numeric identifier representing the target file system.
+ * @param srcPath - The source path to copy from (e.g., `/documents`).
+ * @param destPath - The destination path to copy to (e.g., `/archive`).
+ * @param name - The name of the new file or directory at the destination (e.g., `report.txt`).
+ * @param wallet - The wallet public key used to sign and authorize the transaction.
+ * @returns A Promise that resolves to a Solana `Transaction` object containing the copyPath instruction.
+ * @throws Will throw an error if `srcPath` or `destPath` contains invalid characters.
+ *
+ */
+function move(fsid, srcPath, destPath, name, wallet) {
+    return __awaiter(this, void 0, void 0, function () {
+        var rest, instructionData, instruction, tx;
+        return __generator(this, function (_a) {
+            // Validate path: only letters, numbers, and /
+            (0, sanitizePath_1.sanitizePath)(srcPath);
+            (0, sanitizePath_1.sanitizePath)(destPath);
+            (0, sanitizePath_1.sanitizePath)(name);
+            rest = Buffer.from("".concat(srcPath, "\0").concat(destPath, "\0").concat(name), 'utf-8');
+            instructionData = Buffer.concat([
+                Buffer.from(Int8Array.from([13]).buffer),
+                Buffer.from(Uint8Array.of.apply(Uint8Array, new bn_js_1.default(fsid).toArray('le', 8))),
+                rest
+            ]);
+            instruction = new web3_js_1.TransactionInstruction({
+                keys: [
+                    {
+                        pubkey: wallet,
+                        isSigner: true,
+                        isWritable: true
+                    }
+                ],
+                programId: new web3_js_1.PublicKey(const_1.programId),
+                data: instructionData
+            });
+            tx = new web3_js_1.Transaction().add(instruction);
+            return [2 /*return*/, tx];
+        });
+    });
+}

package/dist/peek.d.ts

@@ -0,0 +1,15 @@
+import { Transaction, PublicKey } from '@solana/web3.js';
+/**
+ * Constructs a Solana transaction to perform a "peek" operation on a file within a file system.
+ *
+ * The peek operation reads data between two byte offsets within a specified file path.
+ *
+ * @param fsid - A stringified integer representing the file system ID in which the file resides.
+ * @param path - The path to the file to be peeked.
+ * @param startPosition - The starting byte offset (inclusive) to begin reading from.
+ * @param endPosition - The ending byte offset (exclusive) to stop reading at.
+ * @param wallet - The public key of the wallet that will sign and authorize the transaction.
+ * @returns A Promise that resolves to a Solana `Transaction` object containing the peek instruction.
+ * @throws Will throw an error if the `path` contains invalid characters.
+ */
+export declare function peek(fsid: string, path: string, startPosition: number, endPosition: number, wallet: PublicKey): Promise<Transaction>;

package/dist/peek.js

@@ -0,0 +1,88 @@
+"use strict";
+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());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.peek = peek;
+var web3_js_1 = require("@solana/web3.js");
+var bn_js_1 = __importDefault(require("bn.js"));
+var const_1 = require("./const");
+var sanitizePath_1 = require("./sanitizePath");
+/**
+ * Constructs a Solana transaction to perform a "peek" operation on a file within a file system.
+ *
+ * The peek operation reads data between two byte offsets within a specified file path.
+ *
+ * @param fsid - A stringified integer representing the file system ID in which the file resides.
+ * @param path - The path to the file to be peeked.
+ * @param startPosition - The starting byte offset (inclusive) to begin reading from.
+ * @param endPosition - The ending byte offset (exclusive) to stop reading at.
+ * @param wallet - The public key of the wallet that will sign and authorize the transaction.
+ * @returns A Promise that resolves to a Solana `Transaction` object containing the peek instruction.
+ * @throws Will throw an error if the `path` contains invalid characters.
+ */
+function peek(fsid, path, startPosition, endPosition, wallet) {
+    return __awaiter(this, void 0, void 0, function () {
+        var rest, instructionData, instruction, tx;
+        return __generator(this, function (_a) {
+            (0, sanitizePath_1.sanitizePath)(path);
+            rest = Buffer.from("".concat(path), 'utf-8');
+            instructionData = Buffer.concat([
+                Buffer.from(Int8Array.from([3]).buffer),
+                Buffer.from(Uint8Array.of.apply(Uint8Array, new bn_js_1.default(fsid).toArray('le', 8))),
+                Buffer.from(Uint8Array.of.apply(Uint8Array, new bn_js_1.default(startPosition).toArray('le', 8))),
+                Buffer.from(Uint8Array.of.apply(Uint8Array, new bn_js_1.default(endPosition).toArray('le', 8))),
+                rest
+            ]);
+            instruction = new web3_js_1.TransactionInstruction({
+                keys: [
+                    {
+                        pubkey: wallet,
+                        isSigner: true,
+                        isWritable: true
+                    }
+                ],
+                programId: new web3_js_1.PublicKey(const_1.programId),
+                data: instructionData
+            });
+            tx = new web3_js_1.Transaction().add(instruction);
+            return [2 /*return*/, tx];
+        });
+    });
+}

package/dist/poke.d.ts

@@ -0,0 +1,14 @@
+import { Transaction, PublicKey } from '@solana/web3.js';
+/**
+ * Constructs a Solana transaction to perform a poke\operation, which writes data
+ * to a file at the specified path and byte position.
+ *
+ * @param fsid - A stringified integer representing the file system ID where the file resides.
+ * @param path - The path to the file to be written to.
+ * @param position - The byte offset in the file where data should be written.
+ * @param wallet - The public key of the wallet that signs and authorizes the transaction.
+ * @param dataKey - A public key of a data account that holds the content to be written to the file.
+ * @returns A Promise that resolves to a Solana `Transaction` object containing the poke instruction.
+ * @throws Will throw an error if the `path` contains invalid characters.
+ */
+export declare function poke(fsid: string, path: string, position: number, wallet: PublicKey, dataKey: PublicKey): Promise<Transaction>;