@xandeum/web3.js 1.3.0 → 1.3.2

package/src/getXandeumResult.ts

@@ -0,0 +1,67 @@
+
+import { Connection } from "@solana/web3.js"
+
+function sleep(ms: number) {
+    return new Promise(resolve => 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.
+ */
+export async function getXandeumResult(
+    connection: Connection,
+    signature: string
+  ): Promise<any> {
+    const url = connection.rpcEndpoint;
+    const maxAttempts = 3;
+    const delayMs = 5000;
+  
+    for (let attempt = 1; attempt <= maxAttempts; attempt++) {
+      // Wait before every attempt (including the first one)
+      await sleep(delayMs);
+  
+      const response = await fetch(url, {
+        method: "POST",
+        headers: { "Content-Type": "application/json" },
+        body: JSON.stringify({
+          jsonrpc: "2.0",
+          id: 1,
+          method: "getXandeumResult",
+          params: [signature],
+        }),
+      });
+  
+      if (!response.ok) {
+        const text = await response.text();
+        console.error(`Attempt ${attempt}/${maxAttempts} failed: ${response.status} ${text}`);
+        if (attempt === maxAttempts) {
+          return { result: null, error: `HTTP ${response.status}` };
+        }
+        continue;
+      }
+  
+      const data = await response.json();
+  
+      // Change this condition if Xandeum uses a different "not ready" value
+      if (data?.result != null && data.result !== "pending") {
+        console.log(`Got result on attempt ${attempt}`);
+        return data; // Success — return immediately
+      }
+  
+      console.log(`Attempt ${attempt}/${maxAttempts}: still pending...`);
+    }
+  
+    // All 3 attempts done, still no result
+    console.log("Max attempts reached — result still not available");
+    return { result: null, error: "Result not ready after 3 attempts" };
+  }

package/src/helpers.ts

@@ -0,0 +1,85 @@
+import { PublicKey } from '@solana/web3.js'
+import { programId } from './const'
+import BN from 'bn.js'
+
+/**
+ * Seed used for deriving the fee distributor PDA
+ */
+export const FEE_DISTRIBUTOR_SEED = 'fee_distributor'
+
+/**
+ * Duration of one pulse in seconds
+ */
+export const PULSE_DURATION_SECONDS = 15
+
+/**
+ * Number of pulses in one yuga
+ */
+export const PULSES_PER_YUGA = 16384
+
+/**
+ * Duration of one yuga in seconds (16384 * 15 = 245,760 seconds ≈ 2.84 days)
+ */
+export const YUGA_DURATION_SECONDS = PULSES_PER_YUGA * PULSE_DURATION_SECONDS
+
+/**
+ * Unix timestamp (in seconds) when the first yuga started
+ */
+export const YUGA_START_TIMESTAMP = 1768898445 
+
+/**
+ * Calculates the yuga number from a given unix timestamp.
+ * 
+ * @param unixTimestamp - Unix timestamp in seconds
+ * @returns The yuga number for the given timestamp
+ */
+export function getYugaFromTimestamp(unixTimestamp: number): number {
+  if (unixTimestamp < YUGA_START_TIMESTAMP) {
+    return 0
+  }
+  return Math.floor((unixTimestamp - YUGA_START_TIMESTAMP) / YUGA_DURATION_SECONDS)
+}
+
+/**
+ * Gets the current yuga value.
+ * Yuga represents an epoch or era in the Xandeum system.
+ * Each yuga lasts 245,760 seconds (approximately 2.84 days).
+ * 
+ * @returns The current yuga number
+ */
+export function getCurrentYuga(): number {
+  const currentTime = Math.floor(Date.now() / 1000)
+  return getYugaFromTimestamp(currentTime)
+}
+
+/**
+ * Derives the Program Derived Address (PDA) for the fee distributor account.
+ * 
+ * The PDA is derived using:
+ * - The fee distributor seed
+ * - The current yuga (epoch) as little-endian bytes
+ * 
+ * @returns An object containing the PDA public key and bump seed
+ * 
+ * @example
+ * ```typescript
+ * const { pda, bump } = getFeeDistributorPda()
+ * console.log('Fee Distributor PDA:', pda.toBase58())
+ * console.log('Bump seed:', bump)
+ * ```
+ */
+export function getFeeDistributorPda(): { pda: PublicKey; bump: number } {
+  const yuga = getCurrentYuga()
+  
+  const yugaBuffer = Buffer.from(new BN(yuga).toArray('le', 8))
+  
+  const [pda, bump] = PublicKey.findProgramAddressSync(
+    [
+      Buffer.from(FEE_DISTRIBUTOR_SEED, 'utf-8'),
+      yugaBuffer
+    ],
+    new PublicKey(programId)
+  )
+  
+  return { pda, bump }
+}

package/src/index.ts

@@ -9,7 +9,11 @@ export * from "./peek";
 export * from "./poke";
 export * from "./removeDirectory";
 export * from "./copyPath";
-
+export * from "./move";
+export * from "./getXandeumResult";
+export * from "./assignCoowner";
 export {exists } from "./exists";
 export {listDirectoryEntry} from "./listDirectoryEntery";
 export {getMetadata} from "./getMetadata";
+export {find} from "./find";
+export * from "./helpers";

package/src/listDirectoryEntery.ts

@@ -42,7 +42,8 @@ export async function listDirectoryEntry (
   })
 
   if (!response.ok) {
-    throw new Error(`HTTP error! Status: ${response.status}`)
+    const errorText = await response.text(); 
+    return Error(`error! status: ${response.status}, message: ${errorText}`);
   }
 
   const data = await response.json()

package/src/move.ts

@@ -0,0 +1,62 @@
+import { Transaction, TransactionInstruction, PublicKey } from '@solana/web3.js'
+import BN from 'bn.js'
+import { programId } from './const'
+import { sanitizePath } from './sanitizePath'
+import { getFeeDistributorPda } from './helpers'
+
+/**
+ * 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 async function move (
+  fsid: string,
+  srcPath: string,
+  destPath: string,
+  name: string,
+  wallet: PublicKey
+): Promise<Transaction> {
+  // Validate path: only letters, numbers, and /
+  sanitizePath(srcPath)
+
+  sanitizePath(destPath)
+  sanitizePath(name)
+
+
+  const rest = Buffer.from(`${srcPath}\0${destPath}\0${name}`, 'utf-8')
+
+  const instructionData = Buffer.concat([
+    Buffer.from(Int8Array.from([0]).buffer),
+    Buffer.from(Int8Array.from([13]).buffer),
+    Buffer.from(Uint8Array.of(...new BN(fsid).toArray('le', 8))),
+    rest
+  ])
+  let feeDistributorPda = getFeeDistributorPda()
+  const instruction = new TransactionInstruction({
+    keys: [
+      {
+        pubkey: wallet,
+        isSigner: true,
+        isWritable: true
+      },
+      {
+        pubkey: feeDistributorPda.pda,
+        isSigner: false,
+        isWritable: true
+      }
+    ],
+    programId: new PublicKey(programId),
+    data: instructionData
+  })
+
+  const tx = new Transaction().add(instruction)
+  return tx
+}

package/src/peek.ts

@@ -2,6 +2,7 @@ import { Transaction, TransactionInstruction, PublicKey } from '@solana/web3.js'
 import BN from 'bn.js'
 import { programId } from './const'
 import { sanitizePath } from './sanitizePath'
+import { getFeeDistributorPda } from './helpers'
 
 /**
  * Constructs a Solana transaction to perform a "peek" operation on a file within a file system.
@@ -28,19 +29,25 @@ export async function peek (
 
   const rest = Buffer.from(`${path}`, 'utf-8')
   const instructionData = Buffer.concat([
+    Buffer.from(Int8Array.from([0]).buffer),
     Buffer.from(Int8Array.from([3]).buffer),
     Buffer.from(Uint8Array.of(...new BN(fsid).toArray('le', 8))),
     Buffer.from(Uint8Array.of(...new BN(startPosition).toArray('le', 8))),
     Buffer.from(Uint8Array.of(...new BN(endPosition).toArray('le', 8))),
     rest
   ])
-
+  let feeDistributorPda = getFeeDistributorPda()
   const instruction = new TransactionInstruction({
     keys: [
       {
         pubkey: wallet,
         isSigner: true,
         isWritable: true
+      },
+      {
+        pubkey: feeDistributorPda.pda,
+        isSigner: false,
+        isWritable: true
       }
     ],
     programId: new PublicKey(programId),

package/src/poke.ts

@@ -2,6 +2,7 @@ import { Transaction, TransactionInstruction, PublicKey } from '@solana/web3.js'
 import BN from 'bn.js'
 import { programId } from './const'
 import { sanitizePath } from './sanitizePath'
+import { getFeeDistributorPda } from './helpers'
 
 /**
  * Constructs a Solana transaction to perform a poke\operation, which writes data
@@ -30,13 +31,14 @@ export async function poke (
   // Encode the path length as an 8-byte little-endian unsigned integer
   const pathLengthBuffer = Buffer.from(Uint8Array.of(...new BN(pathBuffer.length).toArray('le', 8)))
   const instructionData = Buffer.concat([
+    Buffer.from(Int8Array.from([0]).buffer),
     Buffer.from(Int8Array.from([4]).buffer),
     Buffer.from(Uint8Array.of(...new BN(fsid).toArray('le', 8))),
     Buffer.from(Uint8Array.of(...new BN(position).toArray('le', 8))),
     pathLengthBuffer,
     pathBuffer
   ])
-
+  let feeDistributorPda = getFeeDistributorPda()
   const instruction = new TransactionInstruction({
     keys: [
       {
@@ -48,6 +50,11 @@ export async function poke (
         pubkey: dataKey,
         isSigner: false,
         isWritable: false
+      },
+      {
+        pubkey: feeDistributorPda.pda,
+        isSigner: false,
+        isWritable: true
       }
     ],
     programId: new PublicKey(programId),

package/src/removeDirectory.ts

@@ -2,7 +2,7 @@ import { Transaction, TransactionInstruction, PublicKey } from '@solana/web3.js'
 import BN from 'bn.js'
 import { programId } from './const'
 import { sanitizePath } from './sanitizePath'
-
+import { getFeeDistributorPda } from './helpers'
 /**
  * Constructs a Solana transaction to perform a "remove directory" operation
  * in a  file system, identified by a file system ID (`fsid`).
@@ -21,17 +21,23 @@ export async function removeDirectory (
 ): Promise<Transaction> {
   sanitizePath(path)
   const instructionData = Buffer.concat([
+    Buffer.from(Int8Array.from([0]).buffer),
     Buffer.from(Int8Array.from([7]).buffer),
     Buffer.from(Uint8Array.of(...new BN(fsid).toArray('le', 8))),
     Buffer.from(`${path}`, 'utf-8')
   ])
-
+  let feeDistributorPda = getFeeDistributorPda()
   const instruction = new TransactionInstruction({
     keys: [
       {
         pubkey: wallet,
         isSigner: true,
         isWritable: true
+      },
+      {
+        pubkey: feeDistributorPda.pda,
+        isSigner: false,
+        isWritable: true
       }
     ],
     programId: new PublicKey(programId),

package/src/removeFile.ts

@@ -2,7 +2,7 @@ import { Transaction, TransactionInstruction, PublicKey } from '@solana/web3.js'
 import BN from 'bn.js'
 import { programId } from './const'
 import { sanitizePath } from './sanitizePath'
-
+import { getFeeDistributorPda } from './helpers'
 /**
  * Constructs a Solana transaction to remove a file from a  file system,
  * identified by a file system ID (`fsid`) and a UTF-8 encoded file path.
@@ -22,17 +22,23 @@ export async function removeFile (
   sanitizePath(path)
 
   const instructionData = Buffer.concat([
+    Buffer.from(Int8Array.from([0]).buffer),
     Buffer.from(Int8Array.from([5]).buffer),
     Buffer.from(Uint8Array.of(...new BN(fsid).toArray('le', 8))),
     Buffer.from(`${path}`, 'utf-8')
   ])
-
+  let feeDistributorPda = getFeeDistributorPda()
   const instruction = new TransactionInstruction({
     keys: [
       {
         pubkey: wallet,
         isSigner: true,
         isWritable: true
+      },
+      {
+        pubkey: feeDistributorPda.pda,
+        isSigner: false,
+        isWritable: true
       }
     ],
     programId: new PublicKey(programId),

package/src/renamePath.ts

@@ -2,7 +2,7 @@ import { Transaction, TransactionInstruction, PublicKey } from '@solana/web3.js'
 import BN from 'bn.js'
 import { programId } from './const'
 import { sanitizePath } from './sanitizePath'
-
+import { getFeeDistributorPda } from './helpers'
 /**
  * Constructs a Solana transaction to rename (or move) a file or directory
  * within a file system, based on a provided file system ID (`fsid`).
@@ -28,17 +28,23 @@ export async function renamePath (
   const rest = Buffer.from(`${oldPath}\0${name}`, 'utf-8')
 
   const instructionData = Buffer.concat([
+    Buffer.from(Int8Array.from([0]).buffer),
     Buffer.from(Int8Array.from([8]).buffer),
     Buffer.from(Uint8Array.of(...new BN(fsid).toArray('le', 8))),
     rest
   ])
-
+  let feeDistributorPda = getFeeDistributorPda()
   const instruction = new TransactionInstruction({
     keys: [
       {
         pubkey: wallet,
         isSigner: true,
         isWritable: true
+      },
+      {
+        pubkey: feeDistributorPda.pda,
+        isSigner: false,
+        isWritable: true
       }
     ],
     programId: new PublicKey(programId),

package/src/webSocket.ts

@@ -45,7 +45,14 @@ export function subscribeResult (
   onClose?: () => void
 ): void {
   let rpcEndpoint = connection.rpcEndpoint;
-  const ws = new WebSocket(rpcEndpoint.replace('http', 'ws'));
+  const url = new URL(rpcEndpoint);
+  // url.port = '8900'; // Set the port to 8900
+   if (url.port) {
+    url.port = '8900';
+  }
+  url.protocol = url.protocol.replace('http', 'ws'); 
+  const wsEndpoint = url.toString();
+  const ws = new WebSocket(wsEndpoint);
 
   ws.addEventListener('open', () => {
     const subscriptionMessage = {
@@ -88,14 +95,20 @@ export function subscribeResult (
  * using the `xandeumResultUnsubscribed` method (note: custom method, ensure server-side implementation matches).
  *
  * This function automatically closes the WebSocket connection after sending the unsubscribe request.
- *
- * @param subscriptionId - The ID of the active subscription you want to cancel.
+ * 
  * @param connection - The solana web3 connection with Xandeum-compatible JSON-RPC endpoint (e.g., `'https://api.devnet.solana.com'`).
+ * @param subscriptionId - The ID of the active subscription you want to cancel.
  */
 
 export function unsubscribeResult(connection: Connection,subscriptionId: string): void {
-    let rpcEndpoint = connection.rpcEndpoint;
-    const ws = new WebSocket(rpcEndpoint.replace('http', 'ws'));
+  let rpcEndpoint = connection.rpcEndpoint;
+  const url = new URL(rpcEndpoint);
+  if (url.port) {
+    url.port = '8900';
+  }
+  url.protocol = url.protocol.replace('http', 'ws'); 
+  const wsEndpoint = url.toString();
+  const ws = new WebSocket(wsEndpoint);
 
   ws.addEventListener('open', () => {
     const unsubscribeMessage = {

package/typedoc.json

@@ -1,8 +1,7 @@
 {
     "$schema": "https://typedoc.org/schema.json",
     "entryPoints": ["src/index.ts"],
-    "plugin": ["typedoc-plugin-markdown"],
-    "out": "docs/markdown",
+    "out": "docs/html",
     "tsconfig": "tsconfig.json",
     "name": "Xandeum Web3 Library",
     "readme": "README.md",
@@ -16,8 +15,8 @@
     "excludeInternal": true,
     "excludeNotDocumented": false,
     "gitRemote": "origin",
-    "gitRevision": "main",
-    "sourceLinkTemplate": "https://github.com/Xandeum/test_web3/blob/{gitRevision}/{path}#L{line}",
+    "gitRevision": "reinheim",
+    "sourceLinkTemplate": "https://github.com/Xandeum/xandeum-web3.js/blob/{gitRevision}/{path}#L{line}",
     "visibilityFilters": {
       "protected": false,
       "private": false,

package/docs/assets/highlight.css

@@ -1,22 +0,0 @@
-:root {
-    --light-code-background: #FFFFFF;
-    --dark-code-background: #1E1E1E;
-}
-
-@media (prefers-color-scheme: light) { :root {
-    --code-background: var(--light-code-background);
-} }
-
-@media (prefers-color-scheme: dark) { :root {
-    --code-background: var(--dark-code-background);
-} }
-
-:root[data-theme='light'] {
-    --code-background: var(--light-code-background);
-}
-
-:root[data-theme='dark'] {
-    --code-background: var(--dark-code-background);
-}
-
-pre, code { background: var(--code-background); }

package/docs/assets/navigation.js

@@ -1 +0,0 @@
-window.navigationData = "eJyNkj0PgjAQhv9LZ6OLcXBWNxPjahyucGIDtKQ9DMb434X4gcJxuN77Pk/Taw83RViRWirwOSQYx86qiSqAzvXsVNqIjLNh1qbTM+VZXUmNjdVyMb9PPgptEg024fhXJMCRK667BmPodybhHoFwZTxG5PyVtfxWRmUbk+Gwp0kFBVYmUODwZyKgCdIWCWIg4PivWJBk9SGfq64t8SvptwRlgZhykmYuYS5l19jMBcxj7i7yg3Yqo7KhB21TUWEhx6Ef2qaCIpQ6RN5o3GMoM+I8nYogK+0ful6pJzw+AFipZAk="

package/docs/assets/search.js

@@ -1 +0,0 @@
-window.searchData = "eJyVlk2P2jAQhv+LzxHL5Duc20o9VKp66AWhKiSGjcgHysd2V4j/3nECOMbDdrggxjPvYyl+x56TaJu/nVitT+JQ1LlYhb4j6rSSYiXStkr3Ms+bWjhiaEtc2g111hdN3b3o5OK1r0qsyMq06ySyhDg7BG5b7LdpvSdYlwwXlDXHj59p/0qQrik2qpVpL78Urcz6pv2giGbFc+BvRSkfMlWSi5PvRdd3BGpKcDF72f+QfZqnfUqwZlkusMTdb9/ma92Tn9Au4uKPUh4IoFpmI5oDdQRqmYtoZdW8fWqSu4rnwA9MopN8nPrzoDN0kovrhm2XtcVW/pLdUPYE866CCx7q/6OtGgq+cQSy5btYncSbbDtU4rq78BYJVu4KWebqapv2RWlTVbJWu+VNNox/N5ey3+PBqeKp+mUpnPXScb1FGMFm46yv4jExLlwZemUUAkZACcESgiF0MXIpoWsJXUPoYeRRQs8SeobQx8inhL4l9A1hgFFACQNLGBjCEKOQEoaWMDSEEUYRJYwsYWQIY4xiShhbwtgQooPWCSVMLGFiGkD5AUjvgG0euHPPaB/aP4SBTAeB8gWQHgLbRGC6CJQ3gPQR2EYC00mg/AGkl8A202Vp7F5s217m36cuxuabzxwn8efS3svr3XESS/w5n3UzYzTrZ5VTe91mDc0AzQAWQ80Sx/Ey1RBXQ1weZHzqc/12aJanWd4TrN34XGiMrzE+C3OdJTQi0IiAhcBJobrNEZoTak7I4qjJ4PZt5DQ+aFykcRELN40LGhBrQMwDjMOCBiQakLAA06NNHjfMTAw8F0+0+wOHuZN5Vp4e/3szw8zNwLPz7VFuLw/3jDbzM/AMPXvkCd7M2MBwNl4nx+Ioy6JGyXpzPv8DcZ0xZw==";

package/docs/functions/bigbang.html

@@ -1,4 +0,0 @@
-<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>bigbang | Xandeum Web3 Library - v9.0.0</title><meta name="description" content="Documentation for Xandeum Web3 Library"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Xandeum Web3 Library - v9.0.0</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">bigbang</a></li></ul><h1>Function bigbang</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="bigbang"><span class="tsd-kind-call-signature">bigbang</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">wallet</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Transaction</span><span class="tsd-signature-symbol">&gt;</span><a href="#bigbang" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Constructs a Solana transaction that triggers the &quot;bigbang&quot; instruction and create new file system.</p>
-</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">wallet</span>: <span class="tsd-signature-type">PublicKey</span></span><div class="tsd-comment tsd-typography"><p>The public key of the wallet that will sign and authorize the transaction.</p>
-</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Transaction</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A Promise that resolves to a Solana <code>Transaction</code> object containing the bigbang instruction.</p>
-<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Xandeum/test_web3/blob/main/src/bigbang.ts#L10">bigbang.ts:10</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Xandeum Web3 Library - v9.0.0</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

package/docs/functions/getMetadata.html

@@ -1,10 +0,0 @@
-<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>getMetadata | Xandeum Web3 Library - v9.0.0</title><meta name="description" content="Documentation for Xandeum Web3 Library"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Xandeum Web3 Library - v9.0.0</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">getMetadata</a></li></ul><h1>Function getMetadata</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getmetadata"><span class="tsd-kind-call-signature">getMetadata</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">url</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><a href="#getmetadata" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sends a JSON-RPC request to the Xandeum RPC endpoint to retrieve metadata
-about a file or directory at the given path.</p>
-<p>This function calls the custom RPC method <code>getMetadata</code>, which is implemented
-by the backend to return metadata such as type (file or directory), size,
-timestamps etc.</p>
-</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The filesystem path to query metadata for (e.g., <code>/documents/myfile.txt</code>).</p>
-</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">url</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The full URL of the Xandeum-compatible JSON-RPC endpoint (e.g., <code>'https://api.devnet.solana.com'</code>).</p>
-</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A <code>Promise&lt;any&gt;</code> resolving to the parsed JSON response from the RPC server,
-typically containing a <code>result</code> object with metadata fields.</p>
-<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Xandeum/test_web3/blob/main/src/getMetadata.ts#L24">getMetadata.ts:24</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Xandeum Web3 Library - v9.0.0</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

package/docs/functions/unsubscribeResult.html

@@ -1,6 +0,0 @@
-<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>unsubscribeResult | Xandeum Web3 Library - v9.0.0</title><meta name="description" content="Documentation for Xandeum Web3 Library"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Xandeum Web3 Library - v9.0.0</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">unsubscribeResult</a></li></ul><h1>Function unsubscribeResult</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="unsubscriberesult"><span class="tsd-kind-call-signature">unsubscribeResult</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">subscriptionId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">wsUrl</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#unsubscriberesult" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sends a WebSocket JSON-RPC message to unsubscribe from a previously subscribed transaction result
-using the <code>xandeumResultUnsubscribed</code> method (note: custom method, ensure server-side implementation matches).</p>
-<p>This function automatically closes the WebSocket connection after sending the unsubscribe request.</p>
-</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">subscriptionId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the active subscription you want to cancel.</p>
-</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">wsUrl</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The WebSocket endpoint (e.g., <code>wss://...</code>) to connect to for unsubscribing.</p>
-</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Xandeum/test_web3/blob/main/src/webSocket.ts#L86">webSocket.ts:86</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Xandeum Web3 Library - v9.0.0</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

package/docs/index.html

@@ -1,2 +0,0 @@
-<!DOCTYPE html><html class="default" lang="en" data-base="./"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Xandeum Web3 Library - v9.0.0</title><meta name="description" content="Documentation for Xandeum Web3 Library"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="index.html" class="title">Xandeum Web3 Library - v9.0.0</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h1>Xandeum Web3 Library - v9.0.0</h1></div><div class="tsd-panel tsd-typography"><p>#Xandeum Web3.js</p>
-</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html">Xandeum Web3 Library - v9.0.0</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>