project-serum#172 WIP decode jsdocs

gotjoshua · Sep 30, 2021 · a628aad · a628aad
1 parent 20a776e
commit a628aad
Showing 1 changed file with 11 additions and 2 deletions.
diff --git a/packages/serum/src/instructions.js b/packages/serum/src/instructions.js
@@ -104,8 +104,17 @@ export function encodeInstruction(instruction) {
   return b.slice(0, INSTRUCTION_LAYOUT.encode(instruction, b));
 }
 
-export function decodeInstruction(message) {
-  return INSTRUCTION_LAYOUT.decode(message);
+/**
+ * Accepts raw instruction data as a buffer of raw bytes
+ *    eg. from  [@solana/web3.js.TransactionInstruction.data](https://solana-labs.github.io/solana-web3.js/classes/TransactionInstruction.html)
+ *     or from  decoding the base58 data from [@solana/web3.js.PartiallyDecodedInstruction.data](https://solana-labs.github.io/solana-web3.js/modules.html#PartiallyDecodedInstruction)
+ * Returns an object that describes the instruction parameters
+ * 
+ * @param {Uint8Array} instructionData 
+ * @returns {Object} decoded Instruction Object
+ */
+export function decodeInstruction(instructionData) {
+  return INSTRUCTION_LAYOUT.decode(instructionData);
 }
 
 export class DexInstructions {