types: update mempool entries and simple mining.

handshake-org · Oct 1, 2024 · 0ce3197 · 0ce3197
1 parent e13f180
commit 0ce3197
Show file tree

Hide file tree

Showing 11 changed files with 386 additions and 54 deletions.
diff --git a/lib/blockstore/abstract.js b/lib/blockstore/abstract.js
@@ -298,10 +298,9 @@ class AbstractBatch {
   }
 }
 
-AbstractBlockStore.AbstractBatch = AbstractBatch;
-
 /*
  * Expose
  */
 
+AbstractBlockStore.AbstractBatch = AbstractBatch;
 module.exports = AbstractBlockStore;
diff --git a/lib/covenants/view.js b/lib/covenants/view.js
@@ -5,11 +5,20 @@ const {BufferMap} = require('buffer-map');
 const NameState = require('./namestate');
 const NameUndo = require('./undo');
 
+/** @typedef {import('../types').Hash} Hash */
+
 class View {
   constructor() {
+    /** @type {BufferMap<NameState>} */
     this.names = new BufferMap();
   }
 
+  /**
+   * @param {Object} db
+   * @param {Hash} nameHash
+   * @returns {NameState}
+   */
+
   getNameStateSync(db, nameHash) {
     assert(db && typeof db.getNameState === 'function');
     assert(Buffer.isBuffer(nameHash));
@@ -19,6 +28,7 @@ class View {
     if (cache)
       return cache;
 
+    /** @type {NameState?} */
     const ns = db.getNameState(nameHash);
 
     if (!ns) {
@@ -33,6 +43,12 @@ class View {
     return ns;
   }
 
+  /**
+   * @param {Object} db
+   * @param {Hash} nameHash
+   * @returns {Promise<NameState>}
+   */
+
   async getNameState(db, nameHash) {
     assert(db && typeof db.getNameState === 'function');
     assert(Buffer.isBuffer(nameHash));
@@ -42,6 +58,7 @@ class View {
     if (cache)
       return cache;
 
+    /** @type {NameState?} */
     const ns = await db.getNameState(nameHash);
 
     if (!ns) {

diff --git a/lib/hd/common.js b/lib/hd/common.js
@@ -39,7 +39,7 @@ common.MAX_ENTROPY = 512;
 
 /**
  * LRU cache to avoid deriving keys twice.
- * @type {LRU<HDPublicKey|HDPrivateKey>}
+ * @type {LRU<String, HDPublicKey|HDPrivateKey>}
  */
 
 common.cache = new LRU(500);

diff --git a/lib/mempool/airdropentry.js b/lib/mempool/airdropentry.js
@@ -12,6 +12,11 @@ const policy = require('../protocol/policy');
 const util = require('../utils/util');
 const Address = require('../primitives/address');
 
+/** @typedef {import('../types').Amount} AmountValue */
+/** @typedef {import('../types').Rate} Rate */
+/** @typedef {import('../types').BufioWriter} BufioWriter */
+/** @typedef {import('../primitives/airdropproof')} AirdropProof */
+
 /*
  * Constants
  */
@@ -73,7 +78,6 @@ class AirdropEntry extends bio.Struct {
 
   /**
    * Inject properties from airdrop.
-   * @private
    * @param {AirdropProof} proof
    * @param {Number} height
    */
@@ -99,7 +103,6 @@ class AirdropEntry extends bio.Struct {
   /**
    * Create a mempool entry from an airdrop proof.
    * @param {AirdropProof} proof
-   * @param {Object} data
    * @param {Number} height - Entry height.
    * @returns {AirdropEntry}
    */
@@ -110,7 +113,7 @@ class AirdropEntry extends bio.Struct {
 
   /**
    * Get fee.
-   * @returns {Amount}
+   * @returns {AmountValue}
    */
 
   getFee() {
@@ -160,7 +163,8 @@ class AirdropEntry extends bio.Struct {
 
   /**
    * Serialize entry to a buffer.
-   * @returns {Buffer}
+   * @param {BufioWriter} bw
+   * @returns {BufioWriter}
    */
 
   write(bw) {
@@ -180,9 +184,8 @@ class AirdropEntry extends bio.Struct {
 
   /**
    * Inject properties from serialized data.
-   * @private
-   * @param {Buffer} data
-   * @returns {AirdropEntry}
+   * @param {bio.BufferReader} br
+   * @returns {this}
    */
 
   read(br) {

diff --git a/lib/mempool/claimentry.js b/lib/mempool/claimentry.js
@@ -13,6 +13,11 @@ const util = require('../utils/util');
 const Address = require('../primitives/address');
 const rules = require('../covenants/rules');
 
+/** @typedef {import('../primitives/claim')} Claim */
+/** @typedef {import('../types').Amount} AmountValue */
+/** @typedef {import('../types').Rate} Rate */
+/** @typedef {import('../types').BufioWriter} BufioWriter */
+
 /*
  * Constants
  */
@@ -58,7 +63,6 @@ class ClaimEntry extends bio.Struct {
 
   /**
    * Inject properties from options object.
-   * @private
    * @param {Object} options
    */
 
@@ -84,7 +88,6 @@ class ClaimEntry extends bio.Struct {
 
   /**
    * Inject properties from claim.
-   * @private
    * @param {Claim} claim
    * @param {Object} data
    * @param {Number} height
@@ -128,7 +131,7 @@ class ClaimEntry extends bio.Struct {
 
   /**
    * Get fee.
-   * @returns {Amount}
+   * @returns {AmountValue}
    */
 
   getFee() {
@@ -178,7 +181,8 @@ class ClaimEntry extends bio.Struct {
 
   /**
    * Serialize entry to a buffer.
-   * @returns {Buffer}
+   * @param {BufioWriter} bw
+   * @returns {BufioWriter}
    */
 
   write(bw) {
@@ -204,9 +208,8 @@ class ClaimEntry extends bio.Struct {
 
   /**
    * Inject properties from serialized data.
-   * @private
-   * @param {Buffer} data
-   * @returns {ClaimEntry}
+   * @param {bio.BufferReader} br
+   * @returns {this}
    */
 
   read(br) {