descriptor: move descriptor module to lib directory

bcoin-org · Jun 3, 2023 · 1c28e9d · 1c28e9d
1 parent c0099d3
commit 1c28e9d
Show file tree

Hide file tree

Showing 20 changed files with 151 additions and 51 deletions.
diff --git a/lib/wallet/descriptor/common.js → lib/descriptor/common.js b/lib/wallet/descriptor/common.js → lib/descriptor/common.js
@@ -1,13 +1,13 @@
 /*!
  * common.js - common functions for descriptor
- * Copyright (c) 2015-2016, Christopher Jeffrey (MIT License).
+ * Copyright (c) 2023, the bcoin developers (MIT License).
  * https://github.com/bcoin-org/bcoin
  */
 
 'use strict';
 
 const assert = require('bsert');
-const {types} = require('../../script/common');
+const {types} = require('../script/common');
 const BN = require('bcrypto/lib/bn.js');
 const common = exports;
 

diff --git a/lib/wallet/descriptor/descriptor.js → lib/descriptor/descriptor.js b/lib/wallet/descriptor/descriptor.js → lib/descriptor/descriptor.js
@@ -1,6 +1,6 @@
 /*!
  * descriptor.js - descriptor object for bcoin
- * Copyright (c) 2015-2016, Christopher Jeffrey (MIT License).
+ * Copyright (c) 2023, the bcoin developers (MIT License).
  * https://github.com/bcoin-org/bcoin
  */
 
@@ -11,7 +11,8 @@ const {stringType, addChecksum} = require('./common');
 
 /**
  * Descriptor
- * Base class for descriptors
+ * Base class for descriptors.
+ * Represents an output script
  * @property {String} name
  * @property {PubkeyProvider[]} pubkeys
  * @property {Descriptor[]} subdescriptors

diff --git a/lib/descriptor/index.js b/lib/descriptor/index.js
@@ -0,0 +1,9 @@
+/*!
+ * descriptor/index.js - descriptor parser for bcoin
+ * Copyright (c) 2023, the bcoin developers (MIT License).
+ * https://github.com/bcoin-org/bcoin
+ */
+
+'use strict';
+
+module.exports  = require('./parser');
diff --git a/lib/wallet/descriptor/parser.js → lib/descriptor/parser.js b/lib/wallet/descriptor/parser.js → lib/descriptor/parser.js
@@ -1,27 +1,33 @@
+/*!
+ * parser.js -  descriptor parser for bcoin
+ * Copyright (c) 2023, the bcoin developers (MIT License).
+ * https://github.com/bcoin-org/bcoin
+ */
+
 'use strict';
 
 const assert = require('bsert');
-const HD = require('../../hd/hd');
-const {HARDENED} = require('../../hd/common');
+const HD = require('../hd/hd');
+const {HARDENED} = require('../hd/common');
 // const Descriptor = require('./descriptor');
-const KeyRing = require('../../primitives/keyring');
-const PKDescriptor = require('./pkdescriptor');
-const PKHDescriptor = require('./pkhdescriptor');
-const WPKHDescriptor = require('./wpkhdescriptor');
-const SHDescriptor = require('./shdescriptor');
-const WSHDescriptor = require('./wshdescriptor');
-const ComboDescriptor = require('./combodescriptor');
-const AddressDescriptor = require('./addressdescriptor');
-const MultisigDescriptor = require('./multisigdescriptor');
-const RawDescriptor = require('./rawdescriptor');
-const Network = require('../../protocol/network');
-const Address = require ('../../primitives/address');
-const Script = require('../../script/script');
-const {isCompressedEncoding} = require('../../script/common');
+const KeyRing = require('../primitives/keyring');
+const PKDescriptor = require('./type/pk');
+const PKHDescriptor = require('./type/pkh');
+const WPKHDescriptor = require('./type/wpkh');
+const SHDescriptor = require('./type/sh');
+const WSHDescriptor = require('./type/wsh');
+const ComboDescriptor = require('./type/combo');
+const AddressDescriptor = require('./type/addr');
+const MultisigDescriptor = require('./type/multisig');
+const RawDescriptor = require('./type/raw');
+const Network = require('../protocol/network');
+const Address = require ('../primitives/address');
+const Script = require('../script/script');
+const {isCompressedEncoding} = require('../script/common');
 const {
   MAX_SCRIPT_PUSH,
   MAX_MULTISIG_PUBKEYS
-} = require('../../protocol/consensus');
+} = require('../protocol/consensus');
 
 const {
   ConstPubkeyProvider,

diff --git a/lib/wallet/descriptor/pubkeyprovider.js → lib/descriptor/pubkeyprovider.js b/lib/wallet/descriptor/pubkeyprovider.js → lib/descriptor/pubkeyprovider.js
@@ -1,13 +1,13 @@
 /*!
  * pubkeyprovider.js - parsed public key object for descriptor in bcoin
- * Copyright (c) 2015-2016, Christopher Jeffrey (MIT License).
+ * Copyright (c) 2023, the bcoin developers (MIT License).
  * https://github.com/bcoin-org/bcoin
  */
 
 'use strict';
 
-const HD = require('../../hd');
-const {HARDENED} = require('../../hd/common');
+const HD = require('../hd');
+const {HARDENED} = require('../hd/common');
 const hash160 = require('bcrypto/lib/hash160');
 const {deriveType} = require('./common');
 

diff --git a/lib/wallet/descriptor/addressdescriptor.js → lib/descriptor/type/addr.js b/lib/wallet/descriptor/addressdescriptor.js → lib/descriptor/type/addr.js
@@ -1,6 +1,12 @@
+/*!
+ * addr.js - address descriptor object for bcoin
+ * Copyright (c) 2023, the bcoin developers (MIT License).
+ * https://github.com/bcoin-org/bcoin
+ */
+
 'use strict';
 
-const Descriptor = require('./descriptor');
+const Descriptor = require('../descriptor');
 
 class AddressDescriptor extends Descriptor {
   constructor(options) {

diff --git a/lib/wallet/descriptor/combodescriptor.js → lib/descriptor/type/combo.js b/lib/wallet/descriptor/combodescriptor.js → lib/descriptor/type/combo.js
@@ -1,6 +1,12 @@
+/*!
+ * combo.js - combo descriptor object for bcoin
+ * Copyright (c) 2023, the bcoin developers (MIT License).
+ * https://github.com/bcoin-org/bcoin
+ */
+
 'use strict';
 
-const Descriptor = require('./descriptor');
+const Descriptor = require('../descriptor');
 
 class ComboDescriptor extends Descriptor {
   constructor(options) {

diff --git a/lib/wallet/descriptor/multisigdescriptor.js → lib/descriptor/type/multisig.js b/lib/wallet/descriptor/multisigdescriptor.js → lib/descriptor/type/multisig.js
@@ -1,6 +1,12 @@
+/*!
+ * multisig.js - multisig descriptor object for bcoin
+ * Copyright (c) 2023, the bcoin developers (MIT License).
+ * https://github.com/bcoin-org/bcoin
+ */
+
 'use strict';
 
-const Descriptor = require('./descriptor');
+const Descriptor = require('../descriptor');
 
 class MultisigDescriptor extends Descriptor {
   constructor(options) {

diff --git a/lib/wallet/descriptor/pkdescriptor.js → lib/descriptor/type/pk.js b/lib/wallet/descriptor/pkdescriptor.js → lib/descriptor/type/pk.js
@@ -1,7 +1,13 @@
+/*!
+ * pk.js - public key descriptor object for bcoin
+ * Copyright (c) 2023, the bcoin developers (MIT License).
+ * https://github.com/bcoin-org/bcoin
+ */
+
 'use strict';
 
-const Descriptor = require('./descriptor');
-const {outputTypes} = require('./common');
+const Descriptor = require('../descriptor');
+const {outputTypes} = require('../common');
 
 class PKDescriptor extends Descriptor {
   constructor(options) {

diff --git a/lib/wallet/descriptor/pkhdescriptor.js → lib/descriptor/type/pkh.js b/lib/wallet/descriptor/pkhdescriptor.js → lib/descriptor/type/pkh.js
@@ -1,6 +1,13 @@
+/*!
+ * pkh.js - public key hash descriptor object for bcoin
+ * Copyright (c) 2023, the bcoin developers (MIT License).
+ * https://github.com/bcoin-org/bcoin
+ */
+
 'use strict';
-const Descriptor = require('./descriptor');
-const {outputTypes} = require('./common');
+
+const Descriptor = require('../descriptor');
+const {outputTypes} = require('../common');
 
 class PKHDescriptor extends Descriptor {
   constructor(options) {

diff --git a/lib/wallet/descriptor/rawdescriptor.js → lib/descriptor/type/raw.js b/lib/wallet/descriptor/rawdescriptor.js → lib/descriptor/type/raw.js
@@ -1,6 +1,12 @@
+/*!
+ * raw.js - raw descriptor object for bcoin
+ * Copyright (c) 2023, the bcoin developers (MIT License).
+ * https://github.com/bcoin-org/bcoin
+ */
+
 'use strict';
 
-const Descriptor = require('./descriptor');
+const Descriptor = require('../descriptor');
 const Address = require('../../primitives/address');
 
 class RawDescriptor extends Descriptor {

diff --git a/lib/wallet/descriptor/shdescriptor.js → lib/descriptor/type/sh.js b/lib/wallet/descriptor/shdescriptor.js → lib/descriptor/type/sh.js
@@ -1,5 +1,12 @@
+/*!
+ * sh.js - script hash descriptor object for bcoin
+ * Copyright (c) 2023, the bcoin developers (MIT License).
+ * https://github.com/bcoin-org/bcoin
+ */
+
 'use strict';
-const Descriptor = require('./descriptor');
+
+const Descriptor = require('../descriptor');
 
 class SHDescriptor extends Descriptor {
   constructor(options) {

diff --git a/lib/wallet/descriptor/wpkhdescriptor.js → lib/descriptor/type/wpkh.js b/lib/wallet/descriptor/wpkhdescriptor.js → lib/descriptor/type/wpkh.js
@@ -1,6 +1,13 @@
+/*!
+ * wpkh.js - witness script hash descriptor object for bcoin
+ * Copyright (c) 2023, the bcoin developers (MIT License).
+ * https://github.com/bcoin-org/bcoin
+ */
+
 'use strict';
-const Descriptor = require('./descriptor');
-const outputTypes = require('./common');
+
+const Descriptor = require('../descriptor');
+const outputTypes = require('../common');
 
 class WPKHDescriptor extends Descriptor {
   constructor(options) {

diff --git a/lib/wallet/descriptor/wshdescriptor.js → lib/descriptor/type/wsh.js b/lib/wallet/descriptor/wshdescriptor.js → lib/descriptor/type/wsh.js
@@ -1,6 +1,12 @@
+/*!
+ * wsh.js - witness script hash descriptor object for bcoin
+ * Copyright (c) 2023, the bcoin developers (MIT License).
+ * https://github.com/bcoin-org/bcoin
+ */
+
 'use strict';
 
-const Descriptor = require('./descriptor');
+const Descriptor = require('../descriptor');
 
 class WSHDescriptor extends Descriptor {
   constructor(options) {

diff --git a/lib/hd/keyorigin.js b/lib/hd/keyorigin.js
@@ -1,4 +1,9 @@
-/* eslint-disable max-len */
+/*!
+ * keyorigin.js - hd key path object for bcoin
+ * Copyright (c) 2023, the bcoin developers (MIT License).
+ * https://github.com/bcoin-org/bcoin
+ */
+
 'use strict';
 
 const assert = require('assert');

diff --git a/lib/wallet/descriptor/index.js b/lib/wallet/descriptor/index.js
diff --git a/lib/wallet/rpc.js b/lib/wallet/rpc.js
@@ -7,12 +7,12 @@
 'use strict';
 
 const assert = require('bsert');
-const { format } = require('util');
+const {format} = require('util');
 const bweb = require('bweb');
-const { Lock } = require('bmutex');
+const {Lock} = require('bmutex');
 const fs = require('bfile');
 const Validator = require('bval');
-const { BufferMap, BufferSet } = require('buffer-map');
+const {BufferMap, BufferSet} = require('buffer-map');
 const util = require('../utils/util');
 const messageUtil = require('../utils/message');
 const Amount = require('../btc/amount');
@@ -27,10 +27,11 @@ const TX = require('../primitives/tx');
 const consensus = require('../protocol/consensus');
 const pkg = require('../pkg');
 const common = require('./common');
-const { BlockMeta } = require('./records');
+const {BlockMeta} = require('./records');
 const RPCBase = bweb.RPC;
 const RPCError = bweb.RPCError;
-const Descriptor = require('./descriptor');
+const DescriptorParser = require('../descriptor/parser');
+const {createChecksum} = require('../descriptor/common');
 
 /*
  * Constants
@@ -479,7 +480,7 @@ class RPC extends RPCBase {
 
     const result = {
       descriptor: descriptor.toString(),
-      checksum: Descriptor.addChecksum(desc),
+      checksum: createChecksum(desc),
       isrange: descriptor.isRange(),
       issolvable: descriptor.isSolvable(),
       hasprivatekeys: descriptor.hasPrivateKeys()
@@ -1758,7 +1759,7 @@ function parseAddress(raw, network) {
 
 function parseDescriptor(raw, network) {
   try {
-    return Descriptor.fromString(raw, network);
+    return DescriptorParser.fromString(raw, network);
   } catch (e) {
     throw new RPCError(errs.INVALID_DESCRIPTOR,
       `Invalid descriptor: ${e.message}`

diff --git a/test/descriptor-test.js b/test/descriptor-test.js
@@ -1,12 +1,36 @@
 /* eslint-disable quotes */
 /* eslint-disable no-unused-vars */
+
 'use strict';
 
 const assert = require('bsert');
-const DescriptorParser = require('../lib/wallet/descriptor/parser');
-const {createChecksum} = require('../lib/wallet/descriptor/common');
+const DescriptorParser = require('../lib/descriptor/parser');
+const {createChecksum} = require('../lib/descriptor/common');
 
 const testcases = [
+  {
+    "input": `multi(1,xprvA2JDeKCSNNZky6uBCviVfJSKyQ1mDYahRjijr5idH2WwLsEd4Hsb2Tyh8RfQMuPh7f7RtyzTtdrbdqqsunu5Mm3wDvUAKRHSC34sJ7in334/*,L4rK1yDtCWekvXuE6oXD9jCYfFNV2cWRpVuPLBcCU2z8TrisoyY1)`,
+    "descriptor":`multi(1,xpub6FHa3pjLCk84BayeJxFW2SP4XRrFd1JYnxeLeU8EqN3vDfZmbqBqaGJAyiLjTAwm6ZLRQUMv1ZACTj37sR62cfN7fe5JnJ7dh8zL4fiyLHV/*,03a34b99f22c790c4e36b2b3c2c35a36db06226e41c692fc82b8b56ac1c540c5bd)#ds4nc7vf`,
+    "isrange":true,
+    "checksum":"aefpzjr7",
+    "issolvable":true,
+    "hasprivatekeys":true,
+    "network": "main"
+  },
+  {
+    "input":`tr(xprvA1RpRA33e1JQ7ifknakTFpgNXPmW2YvmhqLQYMmrj4xJXXWYpDPS3xz7iAxn8L39njGVyuoseXzU6rcxFLJ8HFsTjSyQbLYnMpCqE2VbFWc/0/*`,
+    "network": "main",
+    "error": "tr(xprvA1RpRA33e1JQ7ifknakTFpgNXPmW2YvmhqLQYMmrj4xJXXWYpDPS3xz7iAxn8L39njGVyuoseXzU6rcxFLJ8HFsTjSyQbLYnMpCqE2VbFWc/0/* is not a valid descriptor function"
+  },
+  {
+    "input": `combo(xprvA2JDeKCSNNZky6uBCviVfJSKyQ1mDYahRjijr5idH2WwLsEd4Hsb2Tyh8RfQMuPh7f7RtyzTtdrbdqqsunu5Mm3wDvUAKRHSC34sJ7in334/*)#f68555z5`,
+    "descriptor": `combo(xpub6FHa3pjLCk84BayeJxFW2SP4XRrFd1JYnxeLeU8EqN3vDfZmbqBqaGJAyiLjTAwm6ZLRQUMv1ZACTj37sR62cfN7fe5JnJ7dh8zL4fiyLHV/*)#3are946j`,
+    "checksum": "f68555z5",
+    "isrange": true,
+    "issolvable": true,
+    "hasprivatekeys": true,
+    "network": "main"
+  },
   {
     "input": `addr(2NBFNJTktNa7GZusGbDbGKRZTxdK9VVez3n)`,
     "descriptor": "addr(2NBFNJTktNa7GZusGbDbGKRZTxdK9VVez3n)#l98qe9z6",

diff --git a/test/hd-test.js b/test/hd-test.js
@@ -21,7 +21,7 @@ function base58Equal(a, b) {
   assert.bufferEqual(base58.decode(a), base58.decode(b));
 }
 
-describe('HD', function () {
+describe('HD', function() {
   it('should create a pbkdf2 seed', () => {
     const seed = pbkdf2.derive(sha512,
       Buffer.from(vectors.phrase),

diff --git a/test/keyring-test.js b/test/keyring-test.js
@@ -13,7 +13,7 @@ const uncompressed = KeyRing.fromSecret(
 const compressed = KeyRing.fromSecret(
   'L4rK1yDtCWekvXuE6oXD9jCYfFNV2cWRpVuPLBcCU2z8TrisoyY1', 'main');
 
-describe('KeyRing', function () {
+describe('KeyRing', function() {
   it('should get uncompressed public key', () => {
     assert.strictEqual(
       '04a34b99f22c790c4e36b2b3c2c35a36db06226e41c692fc82b8b56ac1c540c5bd5b'