@velocity-exchange/sdk 0.2.5 → 0.4.0

package/lib/node/util/ed25519Utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ed25519Utils.d.ts","sourceRoot":"","sources":["../../../src/util/ed25519Utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AAqCzE;;;;;;;GAOG;AACH,wBAAgB,4BAA4B,CAC3C,sBAAsB,EAAE,MAAM,EAC9B,aAAa,EAAE,MAAM,EACrB,qBAAqB,EAAE,UAAU,EACjC,QAAQ,CAAC,EAAE,MAAM,GACf,sBAAsB,CAkCxB"}
+{"version":3,"file":"ed25519Utils.d.ts","sourceRoot":"","sources":["../../../src/util/ed25519Utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AAqCzE;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,4BAA4B,CAC3C,sBAAsB,EAAE,MAAM,EAC9B,aAAa,EAAE,MAAM,EACrB,qBAAqB,EAAE,UAAU,EACjC,QAAQ,CAAC,EAAE,MAAM,GACf,sBAAsB,CAkCxB"}

package/lib/node/util/ed25519Utils.js

@@ -46,12 +46,22 @@ const ED25519_INSTRUCTION_LAYOUT = BufferLayout.struct([
     BufferLayout.u16('messageInstructionIndex'),
 ]);
 /**
- * Constructs a minimal Ed25519 verification instruction that references the data
- * inside the velocity custom instruction (e.g. postPythLazerOracleUpdate, placeSignedMsgTakerOrder).
+ * Constructs a minimal Ed25519 verification instruction that, instead of embedding its own copy
+ * of the signature/pubkey/message, points its offsets at data already present inside another
+ * instruction in the same transaction (e.g. `postPythLazerOracleUpdate`, `placeSignedMsgTakerOrder`).
+ * This lets the native ed25519 program verify a signature the velocity program also needs to read,
+ * without duplicating the signed payload in the transaction (which would blow the size limit for
+ * larger payloads like Lazer updates). The Solana runtime requires this ed25519 verify instruction
+ * to be a sibling instruction (not a CPI) executed before the instruction that relies on it.
  *
  * @param customInstructionIndex The index of the custom instruction in the transaction (e.g. if tx contains compute budget limit, compute budget price, ed25519 verify, custom ix, this would be 3).
  * @param messageOffset The offset within the custom instruction data where the signed message begins.
  * @param customInstructionData The entire instruction data array for the custom instruction.
+ * @param magicLen Length, in bytes, of a "magic"/tag prefix between `messageOffset` and the
+ * start of the 64-byte signature; defaults to `MAGIC_LEN` (4) if omitted.
+ * @returns A `TransactionInstruction` targeting `Ed25519Program` with no accounts, whose data
+ * encodes offsets (not copies) of the signature/pubkey/message living inside the referenced
+ * custom instruction.
  */
 function createMinimalEd25519VerifyIx(customInstructionIndex, messageOffset, customInstructionData, magicLen) {
     const signatureOffset = messageOffset + (magicLen === undefined ? MAGIC_LEN : magicLen);

package/lib/node/util/promiseTimeout.d.ts

@@ -1,2 +1,11 @@
+/**
+ * Races `promise` against a timer, resolving to `null` instead of rejecting/hanging if `promise`
+ * doesn't settle within `timeoutMs`. `promise` itself is not cancelled — it keeps running in the
+ * background and its eventual result/rejection is discarded once the race is decided.
+ * @param promise - The promise to await.
+ * @param timeoutMs - Timeout in milliseconds.
+ * @returns `promise`'s resolved value, or `null` if it didn't settle before `timeoutMs` elapsed.
+ * Rejects if `promise` rejects before the timeout.
+ */
 export declare function promiseTimeout<T>(promise: Promise<T>, timeoutMs: number): Promise<T | null>;
 //# sourceMappingURL=promiseTimeout.d.ts.map

package/lib/node/util/promiseTimeout.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"promiseTimeout.d.ts","sourceRoot":"","sources":["../../../src/util/promiseTimeout.ts"],"names":[],"mappings":"AAAA,wBAAgB,cAAc,CAAC,CAAC,EAC/B,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,EACnB,SAAS,EAAE,MAAM,GACf,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAUnB"}
+{"version":3,"file":"promiseTimeout.d.ts","sourceRoot":"","sources":["../../../src/util/promiseTimeout.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAC/B,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,EACnB,SAAS,EAAE,MAAM,GACf,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAUnB"}

package/lib/node/util/promiseTimeout.js

@@ -1,6 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.promiseTimeout = void 0;
+/**
+ * Races `promise` against a timer, resolving to `null` instead of rejecting/hanging if `promise`
+ * doesn't settle within `timeoutMs`. `promise` itself is not cancelled — it keeps running in the
+ * background and its eventual result/rejection is discarded once the race is decided.
+ * @param promise - The promise to await.
+ * @param timeoutMs - Timeout in milliseconds.
+ * @returns `promise`'s resolved value, or `null` if it didn't settle before `timeoutMs` elapsed.
+ * Rejects if `promise` rejects before the timeout.
+ */
 function promiseTimeout(promise, timeoutMs) {
     let timeoutId;
     const timeoutPromise = new Promise((resolve) => {