From 62e7f9735989012e7da57ffc63666639a68fdd74 Mon Sep 17 00:00:00 2001 From: Christopher Jeffrey Date: Tue, 27 Jun 2017 08:11:24 -0700 Subject: [PATCH] refactor: module index. --- lib/bcoin-browser.js | 5 ++++- lib/bcoin.js | 24 ++++++++++++++++++++---- lib/bip70/index.js | 9 +++++---- lib/blockchain/index.js | 11 +++++++++-- lib/btc/index.js | 6 ++++++ lib/coins/index.js | 6 ++++++ lib/crypto/aes.js | 2 +- lib/crypto/chacha20.js | 2 +- lib/crypto/cleanse.js | 2 +- lib/crypto/digest.js | 2 +- lib/crypto/index.js | 2 +- lib/crypto/merkle.js | 2 +- lib/crypto/poly1305.js | 2 +- lib/crypto/scrypt.js | 2 +- lib/crypto/siphash.js | 2 +- lib/db/index.js | 7 +++++++ lib/hd/hd.js | 5 +++++ lib/http/index.js | 10 +++++----- lib/mempool/index.js | 11 +++++++++-- lib/mining/index.js | 8 +++++++- lib/{utils => }/native.js | 0 lib/net/index.js | 8 ++++++++ lib/node/index.js | 8 +++++++- lib/node/node.js | 2 +- lib/primitives/index.js | 6 ++++++ lib/protocol/index.js | 8 +++++++- lib/protocol/network.js | 1 - lib/script/index.js | 7 +++++++ lib/utils/base58.js | 2 +- lib/utils/bech32.js | 2 +- lib/utils/index.js | 13 +++++++++++-- lib/utils/murmur3.js | 2 +- lib/wallet/index.js | 10 +++++++++- lib/workers/index.js | 12 +++++++++++- package.json | 3 ++- 35 files changed, 164 insertions(+), 40 deletions(-) rename lib/{utils => }/native.js (100%) diff --git a/lib/bcoin-browser.js b/lib/bcoin-browser.js index 233c0410..e547f03e 100644 --- a/lib/bcoin-browser.js +++ b/lib/bcoin-browser.js @@ -175,7 +175,7 @@ bcoin.db = require('./db'); bcoin.ldb = require('./db/ldb'); // HD -bcoin.hd = require('./hd/hd'); +bcoin.hd = require('./hd'); // HTTP bcoin.http = require('./http'); @@ -269,6 +269,9 @@ bcoin.walletplugin = require('./wallet/plugin'); bcoin.workers = require('./workers'); bcoin.workerpool = require('./workers/workerpool'); +// Package Info +bcoin.pkg = require('./pkg'); + /* * Expose Globally */ diff --git a/lib/bcoin.js b/lib/bcoin.js index 43bda89f..fef837a3 100644 --- a/lib/bcoin.js +++ b/lib/bcoin.js @@ -155,11 +155,24 @@ bcoin.set = function set(network) { bcoin.cache = function cache() { bcoin.bip70; - bcoin.common; + bcoin.blockchain; + bcoin.btc; + bcoin.coins; bcoin.crypto; - bcoin.fullnode; + bcoin.db; + bcoin.hd; bcoin.http; - bcoin.spvnode; + bcoin.txmempool; + bcoin.mining; + bcoin.net; + bcoin.node; + bcoin.primitives; + bcoin.protocol; + bcoin.txscript; + bcoin.utils; + bcoin.wallet; + bcoin.workers; + bcoin.pkg; }; /* @@ -195,7 +208,7 @@ bcoin.define('db', './db'); bcoin.define('ldb', './db/ldb'); // HD -bcoin.define('hd', './hd/hd'); +bcoin.define('hd', './hd'); // HTTP bcoin.define('http', './http'); @@ -288,3 +301,6 @@ bcoin.define('walletplugin', './wallet/plugin'); // Workers bcoin.define('workers', './workers'); bcoin.define('workerpool', './workers/workerpool'); + +// Package Info +bcoin.define('pkg', './pkg'); diff --git a/lib/bip70/index.js b/lib/bip70/index.js index 02da3a64..64bd80f0 100644 --- a/lib/bip70/index.js +++ b/lib/bip70/index.js @@ -1,5 +1,5 @@ /*! - * bip70.js - bip70 for bcoin + * bip70/index.js - bip70 for bcoin * Copyright (c) 2016-2017, Christopher Jeffrey (MIT License). * https://github.com/bcoin-org/bcoin */ @@ -10,9 +10,10 @@ * @module bip70 */ -exports.PaymentRequest = require('./paymentrequest'); +exports.certs = require('./certs'); +exports.PaymentACK = require('./paymentack'); exports.PaymentDetails = require('./paymentdetails'); exports.Payment = require('./payment'); -exports.PaymentACK = require('./paymentack'); -exports.x509 = require('./x509'); +exports.PaymentRequest = require('./paymentrequest'); exports.pk = require('./pk'); +exports.x509 = require('./x509'); diff --git a/lib/blockchain/index.js b/lib/blockchain/index.js index c1211fd7..4176b582 100644 --- a/lib/blockchain/index.js +++ b/lib/blockchain/index.js @@ -1,10 +1,17 @@ +/*! + * blockchain/index.js - blockchain for bcoin + * Copyright (c) 2014-2017, Christopher Jeffrey (MIT License). + * https://github.com/bcoin-org/bcoin + */ + 'use strict'; /** * @module blockchain */ -exports.common = require('./common'); -exports.Chain = require('./chain'); exports.ChainDB = require('./chaindb'); exports.ChainEntry = require('./chainentry'); +exports.Chain = require('./chain'); +exports.common = require('./common'); +exports.layout = require('./layout'); diff --git a/lib/btc/index.js b/lib/btc/index.js index d222c858..7c717190 100644 --- a/lib/btc/index.js +++ b/lib/btc/index.js @@ -1,3 +1,9 @@ +/*! + * btc/index.js - high-level btc objects for bcoin + * Copyright (c) 2014-2017, Christopher Jeffrey (MIT License). + * https://github.com/bcoin-org/bcoin + */ + 'use strict'; /** diff --git a/lib/coins/index.js b/lib/coins/index.js index ef1d147a..f5f9643e 100644 --- a/lib/coins/index.js +++ b/lib/coins/index.js @@ -1,3 +1,9 @@ +/*! + * coins/index.js - utxo management for bcoin + * Copyright (c) 2016-2017, Christopher Jeffrey (MIT License). + * https://github.com/bcoin-org/bcoin + */ + 'use strict'; /** diff --git a/lib/crypto/aes.js b/lib/crypto/aes.js index 6bb5f3ab..0e2015ae 100644 --- a/lib/crypto/aes.js +++ b/lib/crypto/aes.js @@ -12,7 +12,7 @@ var crypto = require('crypto'); var util = require('../utils/util'); -var native = require('../utils/native').binding; +var native = require('../native').binding; /** * Encrypt data with aes 256 cbc. diff --git a/lib/crypto/chacha20.js b/lib/crypto/chacha20.js index d30e7158..063c4015 100644 --- a/lib/crypto/chacha20.js +++ b/lib/crypto/chacha20.js @@ -7,7 +7,7 @@ 'use strict'; var assert = require('assert'); -var native = require('../utils/native').binding; +var native = require('../native').binding; var BIG_ENDIAN = new Int8Array(new Int16Array([1]).buffer)[0] === 0; diff --git a/lib/crypto/cleanse.js b/lib/crypto/cleanse.js index a6b45dfe..7f4c3889 100644 --- a/lib/crypto/cleanse.js +++ b/lib/crypto/cleanse.js @@ -10,7 +10,7 @@ * @module crypto.cleanse */ -var native = require('../utils/native').binding; +var native = require('../native').binding; var counter = 0; /** diff --git a/lib/crypto/digest.js b/lib/crypto/digest.js index 730f4d4c..80728c98 100644 --- a/lib/crypto/digest.js +++ b/lib/crypto/digest.js @@ -11,7 +11,7 @@ */ var crypto = require('crypto'); -var native = require('../utils/native').binding; +var native = require('../native').binding; /** * Hash with chosen algorithm. diff --git a/lib/crypto/index.js b/lib/crypto/index.js index f7af5683..91a2f3f9 100644 --- a/lib/crypto/index.js +++ b/lib/crypto/index.js @@ -1,6 +1,6 @@ /*! * crypto/index.js - crypto for bcoin - * Copyright (c) 2014-2016, Christopher Jeffrey (MIT License). + * Copyright (c) 2014-2017, Christopher Jeffrey (MIT License). * https://github.com/bcoin-org/bcoin */ diff --git a/lib/crypto/merkle.js b/lib/crypto/merkle.js index a9a62751..a294192f 100644 --- a/lib/crypto/merkle.js +++ b/lib/crypto/merkle.js @@ -12,7 +12,7 @@ */ var digest = require('./digest'); -var native = require('../utils/native').binding; +var native = require('../native').binding; /** * Build a merkle tree from leaves. diff --git a/lib/crypto/poly1305.js b/lib/crypto/poly1305.js index 940f54d8..8506ff17 100644 --- a/lib/crypto/poly1305.js +++ b/lib/crypto/poly1305.js @@ -6,7 +6,7 @@ 'use strict'; -var native = require('../utils/native').binding; +var native = require('../native').binding; /** * Poly1305 (used for bip151) diff --git a/lib/crypto/scrypt.js b/lib/crypto/scrypt.js index e2112a2f..1264ee71 100644 --- a/lib/crypto/scrypt.js +++ b/lib/crypto/scrypt.js @@ -39,7 +39,7 @@ var co = require('../utils/co'); var pbkdf2 = require('./pbkdf2'); -var native = require('../utils/native').binding; +var native = require('../native').binding; /** * Javascript scrypt implementation. Scrypt is diff --git a/lib/crypto/siphash.js b/lib/crypto/siphash.js index 35afe6ce..8afaa2fc 100644 --- a/lib/crypto/siphash.js +++ b/lib/crypto/siphash.js @@ -13,7 +13,7 @@ * @module crypto/siphash */ -var native = require('../utils/native').binding; +var native = require('../native').binding; /** * Javascript siphash implementation. Used for compact block relay. diff --git a/lib/db/index.js b/lib/db/index.js index b9e99e26..492be96a 100644 --- a/lib/db/index.js +++ b/lib/db/index.js @@ -1,9 +1,16 @@ +/*! + * db/index.js - data management for bcoin + * Copyright (c) 2014-2017, Christopher Jeffrey (MIT License). + * https://github.com/bcoin-org/bcoin + */ + 'use strict'; /** * @module db */ +exports.backends = require('./backends'); exports.LDB = require('./ldb'); exports.LowlevelUp = require('./lowlevelup'); exports.MemDB = require('./memdb'); diff --git a/lib/hd/hd.js b/lib/hd/hd.js index aeca5a2c..97cf02bc 100644 --- a/lib/hd/hd.js +++ b/lib/hd/hd.js @@ -7,9 +7,11 @@ 'use strict'; var assert = require('assert'); +var common = require('./common'); var Mnemonic = require('./mnemonic'); var HDPrivateKey = require('./private'); var HDPublicKey = require('./public'); +var wordlist = require('./wordlist'); /** * @exports hd @@ -177,6 +179,9 @@ HD.isPublic = function isPublic(obj) { * Expose */ +HD.common = common; +HD.HD = HD; HD.Mnemonic = Mnemonic; HD.PrivateKey = HDPrivateKey; HD.PublicKey = HDPublicKey; +HD.wordlist = wordlist; diff --git a/lib/http/index.js b/lib/http/index.js index ae1e0899..99c6cdec 100644 --- a/lib/http/index.js +++ b/lib/http/index.js @@ -11,11 +11,11 @@ * @module http */ -exports.request = require('./request'); -exports.Client = require('./client'); -exports.RPCClient = require('./rpcclient'); -exports.Wallet = require('./wallet'); exports.Base = require('./base'); -exports.RPC = require('./rpc'); +exports.Client = require('./client'); +exports.request = require('./request'); exports.RPCBase = require('./rpcbase'); +exports.RPCClient = require('./rpcclient'); +exports.RPC = require('./rpc'); exports.Server = require('./server'); +exports.Wallet = require('./wallet'); diff --git a/lib/mempool/index.js b/lib/mempool/index.js index 48b3dbd3..a056e52f 100644 --- a/lib/mempool/index.js +++ b/lib/mempool/index.js @@ -1,9 +1,16 @@ +/*! + * mempool/index.js - mempool for bcoin + * Copyright (c) 2014-2017, Christopher Jeffrey (MIT License). + * https://github.com/bcoin-org/bcoin + */ + 'use strict'; /** * @module mempool */ -exports.Mempool = require('./mempool'); -exports.MempoolEntry = require('./mempoolentry'); exports.Fees = require('./fees'); +exports.layout = require('./layout'); +exports.MempoolEntry = require('./mempoolentry'); +exports.Mempool = require('./mempool'); diff --git a/lib/mining/index.js b/lib/mining/index.js index e56c54a4..3e32c5b9 100644 --- a/lib/mining/index.js +++ b/lib/mining/index.js @@ -1,11 +1,17 @@ +/*! + * mining/index.js - mining infrastructure for bcoin + * Copyright (c) 2014-2017, Christopher Jeffrey (MIT License). + * https://github.com/bcoin-org/bcoin + */ + 'use strict'; /** * @module mining */ -exports.BlockTemplate = require('./template'); exports.common = require('./common'); exports.CPUMiner = require('./cpuminer'); exports.mine = require('./mine'); exports.Miner = require('./miner'); +exports.BlockTemplate = require('./template'); diff --git a/lib/utils/native.js b/lib/native.js similarity index 100% rename from lib/utils/native.js rename to lib/native.js diff --git a/lib/net/index.js b/lib/net/index.js index a89dce7a..1396c6e7 100644 --- a/lib/net/index.js +++ b/lib/net/index.js @@ -1,3 +1,9 @@ +/*! + * net/index.js - p2p for bcoin + * Copyright (c) 2014-2017, Christopher Jeffrey (MIT License). + * https://github.com/bcoin-org/bcoin + */ + 'use strict'; /** @@ -16,4 +22,6 @@ exports.packets = require('./packets'); exports.Parser = require('./parser'); exports.Peer = require('./peer'); exports.Pool = require('./pool'); +exports.socks = require('./socks'); exports.tcp = require('./tcp'); +exports.UPNP = require('./upnp'); diff --git a/lib/node/index.js b/lib/node/index.js index 431114fa..32dd5b35 100644 --- a/lib/node/index.js +++ b/lib/node/index.js @@ -1,3 +1,9 @@ +/*! + * node/index.js - node for bcoin + * Copyright (c) 2014-2017, Christopher Jeffrey (MIT License). + * https://github.com/bcoin-org/bcoin + */ + 'use strict'; /** @@ -7,6 +13,6 @@ exports.Config = require('./config'); exports.FullNode = require('./fullnode'); exports.Logger = require('./logger'); -exports.Node = require('./node'); exports.NodeClient = require('./nodeclient'); +exports.Node = require('./node'); exports.SPVNode = require('./spvnode'); diff --git a/lib/node/node.js b/lib/node/node.js index c3552e88..bbfb8c97 100644 --- a/lib/node/node.js +++ b/lib/node/node.js @@ -14,7 +14,7 @@ var Network = require('../protocol/network'); var Logger = require('./logger'); var workerPool = require('../workers/workerpool').pool; var secp256k1 = require('../crypto/secp256k1'); -var native = require('../utils/native'); +var native = require('../native'); var Config = require('./config'); /** diff --git a/lib/primitives/index.js b/lib/primitives/index.js index 9e0c8685..b37920fb 100644 --- a/lib/primitives/index.js +++ b/lib/primitives/index.js @@ -1,3 +1,9 @@ +/*! + * primitives/index.js - bitcoin primitives for bcoin + * Copyright (c) 2014-2017, Christopher Jeffrey (MIT License). + * https://github.com/bcoin-org/bcoin + */ + 'use strict'; /** diff --git a/lib/protocol/index.js b/lib/protocol/index.js index 7ea3d2f6..1bcd4166 100644 --- a/lib/protocol/index.js +++ b/lib/protocol/index.js @@ -1,3 +1,9 @@ +/*! + * protocol/index.js - protocol constants for bcoin + * Copyright (c) 2014-2017, Christopher Jeffrey (MIT License). + * https://github.com/bcoin-org/bcoin + */ + 'use strict'; /** @@ -6,7 +12,7 @@ exports.consensus = require('./consensus'); exports.errors = require('./errors'); -exports.networks = require('./networks'); exports.Network = require('./network'); +exports.networks = require('./networks'); exports.policy = require('./policy'); exports.timedata = require('./timedata'); diff --git a/lib/protocol/network.js b/lib/protocol/network.js index ef230bd8..d987f53b 100644 --- a/lib/protocol/network.js +++ b/lib/protocol/network.js @@ -79,7 +79,6 @@ Network.type = null; Network.main = null; Network.testnet = null; Network.regtest = null; -Network.segnet3 = null; Network.segnet4 = null; Network.simnet = null; diff --git a/lib/script/index.js b/lib/script/index.js index 8921f008..4d83dc6e 100644 --- a/lib/script/index.js +++ b/lib/script/index.js @@ -1,3 +1,9 @@ +/*! + * script/index.js - bitcoin scripting for bcoin + * Copyright (c) 2014-2017, Christopher Jeffrey (MIT License). + * https://github.com/bcoin-org/bcoin + */ + 'use strict'; /** @@ -8,6 +14,7 @@ exports.common = require('./common'); exports.Opcode = require('./opcode'); exports.Program = require('./program'); exports.Script = require('./script'); +// exports.ScriptNum = require('./scriptnum'); exports.sigcache = require('./sigcache'); exports.Stack = require('./stack'); exports.Witness = require('./witness'); diff --git a/lib/utils/base58.js b/lib/utils/base58.js index 7e2c8789..afeb1a7d 100644 --- a/lib/utils/base58.js +++ b/lib/utils/base58.js @@ -11,7 +11,7 @@ * @module utils/base58 */ -var native = require('./native').binding; +var native = require('../native').binding; var assert = require('assert'); /* diff --git a/lib/utils/bech32.js b/lib/utils/bech32.js index 6aa2a705..e055b67a 100644 --- a/lib/utils/bech32.js +++ b/lib/utils/bech32.js @@ -29,7 +29,7 @@ 'use strict'; -var native = require('./native').binding; +var native = require('../native').binding; /** * @module utils/bech32 diff --git a/lib/utils/index.js b/lib/utils/index.js index 35defb8d..c9e99fbd 100644 --- a/lib/utils/index.js +++ b/lib/utils/index.js @@ -1,3 +1,9 @@ +/*! + * utils/index.js - utils for bcoin + * Copyright (c) 2014-2017, Christopher Jeffrey (MIT License). + * https://github.com/bcoin-org/bcoin + */ + 'use strict'; /** @@ -5,6 +11,7 @@ */ exports.ASN1 = require('./asn1'); +// exports.AsyncEmitter = require('./asyncemitter'); exports.AsyncObject = require('./asyncobject'); exports.base32 = require('./base32'); exports.base58 = require('./base58'); @@ -14,13 +21,15 @@ exports.RollingFilter = exports.Bloom.Rolling; exports.co = require('./co'); exports.encoding = require('./encoding'); exports.fs = require('./fs'); +exports.GCSFilter = require('./gcs'); exports.Heap = require('./heap'); exports.Int64 = require('./int64'); exports.IP = require('./ip'); +exports.List = require('./list'); exports.Lock = require('./lock'); exports.MappedLock = exports.Lock.Mapped; exports.LRU = require('./lru'); -exports.List = require('./list'); +exports.Map = require('./map'); exports.murmur3 = require('./murmur3'); exports.nfkd = require('./nfkd'); exports.PEM = require('./pem'); @@ -31,5 +40,5 @@ exports.RBT = require('./rbt'); exports.BufferReader = require('./reader'); exports.StaticWriter = require('./staticwriter'); exports.util = require('./util'); -exports.BufferWriter = require('./writer'); exports.Validator = require('./validator'); +exports.BufferWriter = require('./writer'); diff --git a/lib/utils/murmur3.js b/lib/utils/murmur3.js index c4df301d..3104d5be 100644 --- a/lib/utils/murmur3.js +++ b/lib/utils/murmur3.js @@ -7,7 +7,7 @@ 'use strict'; -var native = require('./native').binding; +var native = require('../native').binding; /** * Murmur3 hash. diff --git a/lib/wallet/index.js b/lib/wallet/index.js index 8fb8b957..cf8f7214 100644 --- a/lib/wallet/index.js +++ b/lib/wallet/index.js @@ -1,3 +1,9 @@ +/*! + * wallet/index.js - wallet for bcoin + * Copyright (c) 2014-2017, Christopher Jeffrey (MIT License). + * https://github.com/bcoin-org/bcoin + */ + 'use strict'; /** @@ -11,8 +17,10 @@ exports.HTTPServer = require('./http'); exports.layout = require('./layout'); exports.MasterKey = require('./masterkey'); exports.Path = require('./path'); -exports.RPC = require('./rpc'); +exports.plugin = require('./plugin'); exports.records = require('./records'); +exports.RPC = require('./rpc'); +exports.server = require('./server'); exports.TXDB = require('./txdb'); exports.WalletDB = require('./walletdb'); exports.Wallet = require('./wallet'); diff --git a/lib/workers/index.js b/lib/workers/index.js index 3a409404..98c0cc0a 100644 --- a/lib/workers/index.js +++ b/lib/workers/index.js @@ -1,11 +1,21 @@ +/*! + * workers/index.js - workers for bcoin + * Copyright (c) 2014-2017, Christopher Jeffrey (MIT License). + * https://github.com/bcoin-org/bcoin + */ + 'use strict'; /** * @module workers */ -exports.jobs = require('./jobs'); exports.Framer = require('./framer'); +exports.jobs = require('./jobs'); +// exports.Master = require('./master'); +exports.packets = require('./packets'); +exports.ParserClient = require('./parser-client'); exports.Parser = require('./parser'); +// exports.worker = require('./worker'); exports.Worker = require('./workerpool').Worker; exports.WorkerPool = require('./workerpool').WorkerPool; diff --git a/package.json b/package.json index 20b7f299..3cf32a41 100644 --- a/package.json +++ b/package.json @@ -93,12 +93,13 @@ "./lib/http/server": "./browser/empty.js", "./lib/http/wallet": "./browser/empty.js", "./lib/mempool/layout": "./lib/mempool/layout-browser.js", + "./lib/native": "./browser/empty.js", "./lib/net/dns": "./lib/net/dns-browser.js", "./lib/net/external": "./lib/net/external-browser.js", + "./lib/net/socks": "./browser/empty.js", "./lib/net/tcp": "./lib/net/tcp-browser.js", "./lib/net/upnp": "./lib/net/upnp-browser.js", "./lib/utils/fs": "./browser/empty.js", - "./lib/utils/native": "./browser/empty.js", "./lib/utils/nfkd": "./lib/utils/nfkd-browser.js", "./lib/wallet/http": "./browser/empty.js", "./lib/wallet/layout": "./lib/wallet/layout-browser.js",