Release v0.1.0 (#189)

* btc: add btc network configuration parameters (#184)

* add btc network configuration parameters

* gitignore: Add cpython generated files. (#182)

* gitignore: Add cpython generated files.

* Generalize ignores.

* Update decred version to v0.1.0

Co-authored-by: buck54321 <[email protected]>
Co-authored-by: JoeGruffins <[email protected]>

.gitignore

@@ -1,3 +1,4 @@
+build/
 decred/examples/wallets
 decred/dist/
 decred/poetry.lock

decred/decred/btc/nets/__init__.py

@@ -0,0 +1,46 @@
+"""
+Copyright (c) 2020, The Decred developers
+See LICENSE for details.
+"""
+
+from decred import DecredError
+
+from . import mainnet, regtest, simnet, testnet
+
+
+the_nets = {n.Name: n for n in (mainnet, testnet, simnet, regtest)}
+if "testnet3" in the_nets:
+    the_nets["testnet"] = the_nets["testnet3"]
+if "regtest" in the_nets:
+    the_nets["regnet"] = the_nets["regtest"]
+
+
+RPCPorts = {
+    mainnet.Name: "8332",
+    testnet.Name: "18332",
+    simnet.Name: "18554",
+    regtest.Name: "18443",
+}
+
+
+def parse(name):
+    """
+    Get the network parameters based on the network name.
+    """
+    try:
+        return the_nets[name]
+    except KeyError:
+        raise DecredError(f"unrecognized network name {name}")
+
+
+def normalizeName(netName):
+    """
+    Remove the numerals from testnet.
+
+    Args:
+        netName (string): The raw network name.
+
+    Returns:
+        string: The network name with numerals stripped.
+    """
+    return "testnet" if "testnet" in netName else netName

decred/decred/btc/nets/mainnet.py

@@ -0,0 +1,98 @@
+"""
+Copyright (c) 2020, The Decred developers
+See LICENSE for details.
+
+mainnet holds mainnet parameters. Any values should mirror exactly
+https://github.com/btcsuite/btcd/blob/master/chaincfg/params.go
+"""
+
+Name = "mainnet"
+DefaultPort = "8333"
+DNSSeeds = [
+    ("seed.bitcoin.sipa.be", True),
+    ("dnsseed.bluematt.me", True),
+    ("dnsseed.bitcoin.dashjr.org", False),
+    ("seed.bitcoinstats.com", True),
+    ("seed.bitnodes.io", False),
+    ("seed.bitcoin.jonasschnelli.ch", True),
+]
+
+# Chain parameters
+GenesisHash = "000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f"
+PowLimit = 2 ^ 224 - 1
+PowLimitBits = 0x1D00FFFF
+BIP0034Height = (
+    227931  # 000000000000024b89b42a942fe0d9fea3bb44ab7bd1b19115dd6a759c0808b8
+)
+BIP0065Height = (
+    388381  # 000000000000000004c2b624ed5d7756c508d90fd0da2c7c679febfa6c4735f0
+)
+BIP0066Height = (
+    363725  # 00000000000000000379eaa19dce8c9b722d46ae6a57c2f1a988119488b50931
+)
+CoinbaseMaturity = 100
+SubsidyReductionInterval = 210000
+TargetTimespan = 60 * 60 * 24 * 14  # 14 days
+TargetTimePerBlock = 60 * 10  # 10 minutes
+RetargetAdjustmentFactor = 4  # 25% less, 400% more
+ReduceMinDifficulty = False
+MinDiffReductionTime = 0
+GenerateSupported = False
+
+# Checkpoints ordered from oldest to newest.
+Checkpoints = [
+    (11111, "0000000069e244f73d78e8fd29ba2fd2ed618bd6fa2ee92559f542fdb26e7c1d"),
+    (33333, "000000002dd5588a74784eaa7ab0507a18ad16a236e7b1ce69f00d7ddfb5d0a6"),
+    (74000, "0000000000573993a3c9e41ce34471c079dcf5f52a0e824a81e7f953b8661a20"),
+    (105000, "00000000000291ce28027faea320c8d2b054b2e0fe44a773f3eefb151d6bdc97"),
+    (134444, "00000000000005b12ffd4cd315cd34ffd4a594f430ac814c91184a0d42d2b0fe"),
+    (168000, "000000000000099e61ea72015e79632f216fe6cb33d7899acb35b75c8303b763"),
+    (193000, "000000000000059f452a5f7340de6682a977387c17010ff6e6c3bd83ca8b1317"),
+    (210000, "000000000000048b95347e83192f69cf0366076336c639f9b7228e9ba171342e"),
+    (216116, "00000000000001b4f4b433e81ee46494af945cf96014816a4e2370f11b23df4e"),
+    (225430, "00000000000001c108384350f74090433e7fcf79a606b8e797f065b130575932"),
+    (250000, "000000000000003887df1f29024b06fc2200b55f8af8f35453d7be294df2d214"),
+    (267300, "000000000000000a83fbd660e918f218bf37edd92b748ad940483c7c116179ac"),
+    (279000, "0000000000000001ae8c72a0b0c301f67e3afca10e819efa9041e458e9bd7e40"),
+    (300255, "0000000000000000162804527c6e9b9f0563a280525f9d08c12041def0a0f3b2"),
+    (319400, "000000000000000021c6052e9becade189495d1c539aa37c58917305fd15f13b"),
+    (343185, "0000000000000000072b8bf361d01a6ba7d445dd024203fafc78768ed4368554"),
+    (352940, "000000000000000010755df42dba556bb72be6a32f3ce0b6941ce4430152c9ff"),
+    (382320, "00000000000000000a8dc6ed5b133d0eb2fd6af56203e4159789b092defd8ab2"),
+    (400000, "000000000000000004ec466ce4732fe6f1ed1cddc2ed4b328fff5224276e3f6f"),
+    (430000, "000000000000000001868b2bb3a285f3cc6b33ea234eb70facf4dcdf22186b87"),
+    (460000, "000000000000000000ef751bbce8e744ad303c47ece06c8d863e4d417efc258c"),
+    (490000, "000000000000000000de069137b17b8d5a3dfbd5b145b2dcfb203f15d0c4de90"),
+    (520000, "0000000000000000000d26984c0229c9f6962dc74db0a6d525f2f1640396f69c"),
+    (550000, "000000000000000000223b7a2298fb1c6c75fb0efc28a4c56853ff4112ec6bc9"),
+    (560000, "0000000000000000002c7b276daf6efb2b6aa68e2ce3be67ef925b3264ae7122"),
+]
+
+# Consensus rule change deployments.
+#
+# The miner confirmation window is defined as:
+#   target proof of work timespan / target proof of work spacing
+RuleChangeActivationThreshold = 1916  # 95% of MinerConfirmationWindow
+MinerConfirmationWindow = 2016
+
+# Mempool parameters
+RelayNonStdTxs = False
+
+# Human-readable part for Bech32 encoded segwit addresses, as defined in
+# BIP 173.
+Bech32HRPSegwit = "bc"  # always bc for main net
+
+# Address encoding magics
+PubKeyHashAddrID = 0x00  # starts with 1
+ScriptHashAddrID = 0x05  # starts with 3
+PrivateKeyID = 0x80  # starts with 5 (uncompressed) or K (compressed)
+WitnessPubKeyHashAddrID = 0x06  # starts with p2
+WitnessScriptHashAddrID = 0x0A  # starts with 7Xh
+
+# BIP32 hierarchical deterministic extended key magics
+HDPrivateKeyID = (0x0488ADE4).to_bytes(4, byteorder="big")  # starts with xprv
+HDPublicKeyID = (0x0488B21E).to_bytes(4, byteorder="big")  # starts with xpub
+
+# BIP44 coin type used in the hierarchical deterministic path for
+# address generation.
+HDCoinType = 0

decred/decred/btc/nets/regtest.py

@@ -0,0 +1,56 @@
+"""
+Copyright (c) 2020, The Decred developers
+See LICENSE for details.
+
+regtest holds regtest parameters. Any values should mirror exactly
+https://github.com/btcsuite/btcd/blob/master/chaincfg/params.go
+"""
+
+Name = "regtest"
+DefaultPort = "18444"
+DNSSeeds = []
+
+# Chain parameters
+GenesisHash = "0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206"
+PowLimit = 2 ^ 255 - 1
+PowLimitBits = 0x207FFFFF
+CoinbaseMaturity = 100
+BIP0034Height = 100000000  #  Not active - Permit ver 1 blocks
+BIP0065Height = 1351  #  Used by regression tests
+BIP0066Height = 1251  #  Used by regression tests
+SubsidyReductionInterval = 150  #  TargetTimespan: 14 days
+TargetTimePerBlock = 60 * 10  # 10 minutes
+RetargetAdjustmentFactor = 4  # 25% less, 400% more
+ReduceMinDifficulty = True
+MinDiffReductionTime = 60 * 20  # TargetTimePerBlock * 2
+GenerateSupported = True
+
+# Checkpoints ordered from oldest to newest.
+Checkpoints = []
+
+# Consensus rule change deployments.
+#
+# The miner confirmation window is defined as:
+#   target proof of work timespan / target proof of work spacing
+RuleChangeActivationThreshold = 108  # 75%  of MinerConfirmationWindow
+MinerConfirmationWindow = 144
+
+# Mempool parameters
+RelayNonStdTxs = True
+
+# Human-readable part for Bech32 encoded segwit addresses, as defined in
+# BIP 173.
+Bech32HRPSegwit = "bcrt"  # always bcrt for reg test net
+
+# Address encoding magics
+PubKeyHashAddrID = 0x6F  # starts with m or n
+ScriptHashAddrID = 0xC4  # starts with 2
+PrivateKeyID = 0xEF  # starts with 9 (uncompressed) or c (compressed)
+
+# BIP32 hierarchical deterministic extended key magics
+HDPrivateKeyID = (0x04358394).to_bytes(4, byteorder="big")  # starts with tprv
+HDPublicKeyID = (0x043587CF).to_bytes(4, byteorder="big")  # starts with tpub
+
+# BIP44 coin type used in the hierarchical deterministic path for
+# address generation.
+HDCoinType = 1

decred/decred/btc/nets/simnet.py

@@ -0,0 +1,59 @@
+"""
+Copyright (c) 2020, The Decred developers
+See LICENSE for details.
+
+simnet holds simnet parameters. Any values should mirror exactly
+https://github.com/btcsuite/btcd/blob/master/chaincfg/params.go
+"""
+
+Name = "simnet"
+DefaultPort = "18555"
+DNSSeeds = []  # NOTE: There must NOT be any seeds.
+
+# Chain parameters
+GenesisHash = "683e86bd5c6d110d91b94b97137ba6bfe02dbbdb8e3dff722a669b5d69d77af6"
+PowLimit = 2 ^ 255 - 1
+PowLimitBits = 0x207FFFFF
+BIP0034Height = 0  # Always active on simnet
+BIP0065Height = 0  # Always active on simnet
+BIP0066Height = 0  # Always active on simnet
+CoinbaseMaturity = 100
+SubsidyReductionInterval = 210000
+TargetTimespan = 60 * 60 * 24 * 14  # 14 days
+TargetTimePerBlock = 60 * 10  # 10 minutes
+RetargetAdjustmentFactor = 4  # 25% less, 400% more
+ReduceMinDifficulty = True
+MinDiffReductionTime = 60 * 20  # TargetTimePerBlock * 2
+GenerateSupported = True
+
+# Checkpoints ordered from oldest to newest.
+Checkpoints = []
+
+# Consensus rule change deployments.
+#
+# The miner confirmation window is defined as:
+#   target proof of work timespan / target proof of work spacing
+RuleChangeActivationThreshold = 75  # 75% of MinerConfirmationWindow
+MinerConfirmationWindow = 100
+
+# Mempool parameters
+RelayNonStdTxs = True
+
+# Human-readable part for Bech32 encoded segwit addresses, as defined in
+# BIP 173.
+Bech32HRPSegwit = "sb"  # always sb for sim net
+
+# Address encoding magics
+PubKeyHashAddrID = 0x3F  # starts with S
+ScriptHashAddrID = 0x7B  # starts with s
+PrivateKeyID = 0x64  # starts with 4 (uncompressed) or F (compressed)
+WitnessPubKeyHashAddrID = 0x19  # starts with Gg
+WitnessScriptHashAddrID = 0x28  # starts with ?
+
+# BIP32 hierarchical deterministic extended key magics
+HDPrivateKeyID = (0x0420B900).to_bytes(4, byteorder="big")  # starts with sprv
+HDPublicKeyID = (0x0420BD3A).to_bytes(4, byteorder="big")  # starts with spub
+
+# BIP44 coin type used in the hierarchical deterministic path for
+# address generation.
+HDCoinType = 115  # ASCII for s

decred/decred/btc/nets/testnet.py

@@ -0,0 +1,85 @@
+"""
+Copyright (c) 2020, The Decred developers
+See LICENSE for details.
+
+testnet holds testnet parameters. Any values should mirror exactly
+https://github.com/btcsuite/btcd/blob/master/chaincfg/params.go
+"""
+
+Name = "testnet3"
+DefaultPort = "18333"
+DNSSeeds = [
+    ("testnet-seed.bitcoin.jonasschnelli.ch", True),
+    ("testnet-seed.bitcoin.schildbach.de", False),
+    ("seed.tbtc.petertodd.org", True),
+    ("testnet-seed.bluematt.me", False),
+]
+
+# Chain parameters
+GenesisHash = "000000000933ea01ad0ee984209779baaec3ced90fa3f408719526f8d77f4943"
+PowLimit = 2 ^ 224 - 1
+PowLimitBits = 0x1D00FFFF
+BIP0034Height = (
+    21111  # 0000000023b3a96d3484e5abb3755c413e7d41500f8e2a5c3f0dd01299cd8ef8
+)
+BIP0065Height = (
+    581885  # 00000000007f6655f22f98e72ed80d8b06dc761d5da09df0fa1dc4be4f861eb6
+)
+BIP0066Height = (
+    330776  # 000000002104c8c45e99a8853285a3b592602a3ccde2b832481da85e9e4ba182
+)
+CoinbaseMaturity = 100
+SubsidyReductionInterval = 210000
+TargetTimespan = 60 * 60 * 24 * 14  # 14 days
+TargetTimePerBlock = 60 * 10  # 10 minutes
+RetargetAdjustmentFactor = 4  # 25% less, 400% more
+ReduceMinDifficulty = True
+MinDiffReductionTime = 60 * 20  # TargetTimePerBlock * 2
+GenerateSupported = False
+
+# Checkpoints ordered from oldest to newest.
+Checkpoints = [
+    (546, "000000002a936ca763904c3c35fce2f3556c559c0214345d31b1bcebf76acb70"),
+    (100000, "00000000009e2958c15ff9290d571bf9459e93b19765c6801ddeccadbb160a1e"),
+    (200000, "0000000000287bffd321963ef05feab753ebe274e1d78b2fd4e2bfe9ad3aa6f2"),
+    (300001, "0000000000004829474748f3d1bc8fcf893c88be255e6d7f571c548aff57abf4"),
+    (400002, "0000000005e2c73b8ecb82ae2dbc2e8274614ebad7172b53528aba7501f5a089"),
+    (500011, "00000000000929f63977fbac92ff570a9bd9e7715401ee96f2848f7b07750b02"),
+    (600002, "000000000001f471389afd6ee94dcace5ccc44adc18e8bff402443f034b07240"),
+    (700000, "000000000000406178b12a4dea3b27e13b3c4fe4510994fd667d7c1e6a3f4dc1"),
+    (800010, "000000000017ed35296433190b6829db01e657d80631d43f5983fa403bfdb4c1"),
+    (900000, "0000000000356f8d8924556e765b7a94aaebc6b5c8685dcfa2b1ee8b41acd89b"),
+    (1000007, "00000000001ccb893d8a1f25b70ad173ce955e5f50124261bbbc50379a612ddf"),
+    (1100007, "00000000000abc7b2cd18768ab3dee20857326a818d1946ed6796f42d66dd1e8"),
+    (1200007, "00000000000004f2dc41845771909db57e04191714ed8c963f7e56713a7b6cea"),
+    (1300007, "0000000072eab69d54df75107c052b26b0395b44f77578184293bf1bb1dbd9fa"),
+]
+
+# Consensus rule change deployments.
+#
+# The miner confirmation window is defined as:
+#   target proof of work timespan / target proof of work spacing
+RuleChangeActivationThreshold = 1512  # 75% of MinerConfirmationWindow
+MinerConfirmationWindow = 2016
+
+# Mempool parameters
+RelayNonStdTxs = True
+
+# Human-readable part for Bech32 encoded segwit addresses, as defined in
+# BIP 173.
+Bech32HRPSegwit = "tb"  # always tb for test net
+
+# Address encoding magics
+PubKeyHashAddrID = 0x6F  # starts with m or n
+ScriptHashAddrID = 0xC4  # starts with 2
+WitnessPubKeyHashAddrID = 0x03  # starts with QW
+WitnessScriptHashAddrID = 0x28  # starts with T7n
+PrivateKeyID = 0xEF  # starts with 9 (uncompressed) or c (compressed)
+
+# BIP32 hierarchical deterministic extended key magics
+HDPrivateKeyID = (0x04358394).to_bytes(4, byteorder="big")  # starts with tprv
+HDPublicKeyID = (0x043587CF).to_bytes(4, byteorder="big")  # starts with tpub
+
+# BIP44 coin type used in the hierarchical deterministic path for
+# address generation.
+HDCoinType = 1

decred/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "decred"
-version = "0.0.1"
+version = "0.1.0"
 description = "A Python 3 Decred toolkit."
 license = "ISC"
 homepage = "https://decred.org/"

decred/tests/unit/btc/test_nets_btc.py

@@ -0,0 +1,18 @@
+"""
+Copyright (c) 2019, the Decred developers
+See LICENSE for details
+"""
+
+import pytest
+
+from decred import DecredError
+from decred.btc import nets
+
+
+def test_nets():
+    assert nets.parse("mainnet") is nets.mainnet
+
+    assert nets.normalizeName("testnet3") == "testnet"
+
+    with pytest.raises(DecredError):
+        nets.parse("nonet")