pktd-v1.7.0

Added changelog entries for v1.6.2, v1.6.3, and added new release v1.7.0

pktd-v1.6.3

pktd-v1.6.3 adds a new feature to the PKT wallet --ignoremined. When upgrading to this version, you have a new capability to forbid mined transactions in your wallet by launching the wallet with the --ignoremined command line flag.

PKT mining can lead to many very small transactions which over time will fill up the wallet database and lead to poor performance, excessive disk, memory, and processor usage.

When this flag is passed, any transaction paying one of your wallet addresses which comes from a coinbase (i.e. mined coins) will be dropped and will not be stored in the wallet's database.

This flag is recommended for merchants, exchanges, and other PKT users who do not have legitimate reason to mine into their wallets.

If PKT was mined into your wallet while you were using the --ignoremined flag, you may recover said PKT at a later date by re-launching pktwallet without the flag, and then using the resync RPC to cause the wallet to re-scan the chain and find the PKT which it had previously ignored. You may also recover the coins by importing your wallet seed in another wallet and recreating the same addresses, then sending those mined coins to yourself, thus converting them into non-mined coins which will then be detected by your production wallet which runs --ignoremined.

pktd-v1.6.2

Allow creating a transaction without unlocking the wallet IF transact…

…ion is unsigned

pktd-v1.6.1

Fix error in computation of PcP serialize size

pktd-v1.6.0

Release version pktd-v1.6.0

July 5, 2022

Major changes

New RPC system in pld

New RPC system. The RPC system of LND is GRPC, the problem with GRPC is that it's
difficult to use and the software is not maintained as well as the developers at Google
would have you believe.

In one example, the Java GRPC client can trigger a crash (nil deref segfault) in the Golang
GRPC server by making a request. It's worth noting that a mature RPC library should be
impossible to crash, even intentionally with malicious requests. The fact that the Golang
GRPC server is crashable not just by a malformed request but in fact by a normal request
made by another GRPC library tells us that there's a total lack of quality assurance.

Secondly, the GRPC client has abysmal performance on Android, and the iOS AnodeVPN team
was not able to get it working in their React Native stack, at all.

But GRPC is not just buggy and difficult to integrate, the API is also "opinionated" in
that it requires the use of it's own internal HTTP/2 server rather than offering an API
by which request data can be passed in. This makes it impossible to integrate into an
existing server which also does other things, and makes it married to the HTTP/2 protocol
which is not always available, for example in a web browser based client without HTTPS
encryption, or in our case, in a React Native based app.

Finally, GRPC is not at all conducive to testing and debugging. It relies exclusively on
Protocol Buffers binary representation of data, which is nice for sending data around in
production, but you can't just make requests using a tool like curl.

So we replaced GRPC with a simple http REST server, it uses the same protobuf structures
but accepts both binary protobuf and also JSON using jsonpb to encode and decode it.

Major reduction of disk usage in neutrino db

The first version of neutrino db, the version from LND, used a combination of a database
and a couple of flat files. Unfortunately, synchronizing a db transaction with a flat file
write operation is incredibly difficult to do correctly, and the developers of LND
unfortunately did NOT do it correctly.

The result was data corruption when the wallet was hard stopped (by way of killing the
process or shutting off the device) and a lot of complex code for trying to manage
atomicity, without actually getting it right!

We deleted almost all of this code, switching to use of the neutrino.db database
completely which is based on bbolt database, a transactional key/value store inspired by
LMDB.

This solved the corruption problem, but the resulting database became quite large. The
neutrino db needs to be able to do a few things.

1. Get block header by block height OR block hash
2. Get filter header by block height OR block hash

The way we implemented all of these things was by creating a table of block header by hash,
filter header by hash, and hash by height. This worked but it used a lot of storage.
The hash was included three times as well as the block header and filter header.

In version 1.6.0 we replaced this schema with a new schema which stores block header and
filter header by height, and which stores height by 32 bit hash prefix. Because we only
store 32 bits of the hash, we accept that there may be a hash collision - i.e. multiple
block hashes which have the same first 32 bits. To resolve this, we store a list of
block heights for a given hash, and when doing a lookup, we check each one of the headers
and compute it's hash until we find the hash which matches. On average we will only have
a single entry in the list, but by being prepared for multiple entries we make the storage
size much smaller.

With these changes we were able to cut the neutrino.db file size roughly in half. But be
aware that when you update, the file will not get smaller because bboltdb is unable to
shrink the file, it can only create free space inside of the file. If you want the file
to be smaller, you will need to delete the neutrino.db file and allow pktwallet / pld to
re-create it.

Minor changes

1. pld: Feature: Add pktdir param to pld - so you can specify the folder where the wallet is - f39d8d0
2. pktd: Bug: Fixed occasional crash caused by misuse of locks - 15c277e
3. pld: Bug: If some necessary directories don't exist, create them rather than crashing. 2a39499 2a39499
4. all: Improvement: Add github build process - c475471
5. pld: Bug: Fix how password is specified - 3af1c05
6. pld: Bug: Private password must be verified when unlocking wallet or else there will be a crash later - 67e09e4
7. all: Improvement: Remove non-working DNS seed nodes - 7d77cf2
8. all: Improvement: Add seed nodes seed.pkt.ai and seed.pkt.pink - 281535f 35ac19d
9. pld: Improvement: Remove graceful shutdown so that the process will not try ot
10. pld: Feature: Added ability to generate a wallet seed without creating the wallet.

Stats

The pktd codebase unfortunately contains a fairly significant amount of generated code.
This exists because the tooling to generate it is too awkward to include in the build
scripts. I have separated the stats for generated code from the stats for hand-written
code.

Over this development period, a total of 215 files were changed, there were 82803 lines
of code altered or added. From these, 42 files and 46499 lines of generated code were
changed or added.

The size of the project increased by 5645 lines of written code, and 20373 lines of
generated code.

A total of 36304 lines, or 6.3% of the codebase, was manually altered.

pktd-v1.5.1 - 575425 lines of written code, 40319 lines of generated code
pktd-v1.6.0 - 581070 lines of written code, 60692 lines of generated code

Future goals

In coming releases, we will be seeking to:

• Debug and stabilize Lightning Network
• Improve scalability
• Improve test coverage
• Move code generation to build time
• Reduce total hand-written code

Thanks!

This release has received contributions from:

• Ivo Smits
• Aldebaran Perseke
• Dimitris Koukoulakis
• James P. Thomas
• Kyle Mason

pktd-v1.5.1

Added --ignoremined to pktwallet to optionally ignore coinbase txns to reduce load.

pktd-v1.4.1

Missing quote

pktd-v1.5.0

Improved input selection to avoid case of selecting a set of inputs w…

…hich is too small to pay the transaction including fee

pktd-v1.4.0

Inform when adding ban score for invalid filter header

pktd-v1.3.1

Merge pull request #263 from thierrymarianne/complete-github-actions-…

…workflow-for-windows

Add scripts to build zip archive containing binaries for windows