feat: migrate the libtm repo to tm2/pkg/libtm

tm2/pkg/libtm/.gitignore

@@ -0,0 +1,9 @@
+# MacOS Leftovers
+.DS_Store
+
+# Editor Leftovers
+.vscode
+.idea
+
+# Log files
+*.log

tm2/pkg/libtm/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

tm2/pkg/libtm/Makefile

@@ -0,0 +1,19 @@
+.PHONY: lint
+lint:
+	golangci-lint run --config golangci.yaml
+
+.PHONY: gofumpt
+gofumpt:
+	go install mvdan.cc/gofumpt@latest
+	gofumpt -l -w .
+
+.PHONY: fixalign
+fixalign:
+	go install golang.org/x/tools/go/analysis/passes/fieldalignment/cmd/fieldalignment@latest
+	fieldalignment -fix $(filter-out $@,$(MAKECMDGOALS)) # the full package name (not path!)
+
+.PHONY: protoc
+protoc:
+	# Make sure the following prerequisites are installed before running these commands:
+	# https://grpc.io/docs/languages/go/quickstart/#prerequisites
+	protoc --go_out=./ ./messages/types/proto/*.proto

tm2/pkg/libtm/README.md

@@ -0,0 +1,160 @@
+## Overview
+
+`libtm` is a simple, minimal and compact Go library that implements the Tendermint consensus engine.
+
+The implementation is based on Algorithm 1, of
+the [Tendermint consensus whitepaper](https://arxiv.org/pdf/1807.04938.pdf) and
+(more broadly) the [official Tendermint wiki](https://github.com/tendermint/tendermint/wiki).
+
+There are some implementation design decisions taken by the package authors:
+
+- it doesn't manage validator sets internally
+- it doesn't implement a networking layer, or any kind of broadcast communication
+- it doesn't assume, or implement, any kind of signature manipulation logic
+
+All of these responsibilities are left to the calling context, in the form of interface implementations.
+The reason for these choices is simple - _to keep the library minimal_.
+
+> [!NOTE]
+> We aim to make [libtm](https://github.com/gnolang/libtm) an independent project, both in terms of repository and
+> governance. This will be pursued once we have successfully integrated `libtm` with `tm2` and demonstrated that the
+> codebase and its API are stable and reliable for broader use. Until this integration is complete and stability is
+> confirmed, `libtm` will continue to be improved upon within the current structure, in the gno monorepo.
+
+### What this library is
+
+This library is meant to be used as a consensus engine base for any distributed system that needs such functionality.
+It is not exclusively made for the blockchain context -- you will find no mention or assumptions of blockchains in the
+source code.
+
+### What this library is not
+
+This library is _not_ meant to replace your entire consensus setup.
+
+As mentioned before, certain design decisions have been taken to keep the source code minimal, which results in the
+calling context being a bit more involved in orchestration.
+
+Please, before deciding to utilize this library in your project, understand the different moving parts and their
+requirements.
+
+## Installation
+
+To get up and running with the `libtm` package, you can add it to your project using:
+
+```shell
+go get -u github.com/gnolang/libtm
+```
+
+Currently, the minimum required go version is `go 1.21`.
+
+## Usage Examples
+
+```go
+package main
+
+import (
+	"context"
+
+	"github.com/gnolang/libtm/core"
+	"github.com/gnolang/libtm/messages/types"
+)
+
+// Verifier implements the libtm Verifier interface.
+// Verifier is an abstraction over the outer consensus calling context
+// that has access to validator set information
+type Verifier struct {
+	// ...
+}
+
+// Node implements the libtm Node interface.
+// The Node interface is an abstraction over a single entity (current process) that runs
+// the consensus algorithm
+type Node struct {
+	// ...
+}
+
+// Broadcast implements the libtm Broadcast interface.
+// Broadcast is an abstraction over the networking / message sharing interface
+// that enables message passing between validators
+type Broadcast struct {
+	// ...
+}
+
+// Signer implements the libtm Signer interface.
+// Signer is an abstraction over the signature manipulation process
+type Signer struct {
+	// ...
+}
+
+// ...
+
+func main() {
+	// verifier, node, broadcast, signer, opts
+	var (
+		verifier  = NewVerifier()
+		node      = NewNode()
+		broadcast = NewBroadcast()
+		signer    = NewSigner()
+	)
+
+	tm := core.NewTendermint(
+		verifier,
+		node,
+		broadcast,
+		signer,
+	)
+
+	height := uint64(1)
+	ctx, cancelFn := context.WithCancel(context.Background())
+
+	go func() {
+		// Run the consensus sequence for the given height.
+		// When the method returns the finalized proposal, that means that
+		// consensus was reached within the given height (in any round)
+		finalizedProposal := tm.RunSequence(ctx, height)
+
+		// Use the finalized proposal
+		// ...
+	}()
+
+	go func() {
+		// Pipe messages into the consensus engine
+		var proposalMessage *types.ProposalMessage
+
+		if err := tm.AddProposalMessage(proposalMessage); err != nil {
+			// ...
+		}
+
+		// ...
+
+		var prevoteMessage *types.PrevoteMessage
+
+		if err := tm.AddPrevoteMessage(prevoteMessage); err != nil {
+			// ...
+		}
+
+		// ...
+
+		var precommitMessage *types.PrecommitMessage
+
+		if err := tm.AddPrecommitMessage(precommitMessage); err != nil {
+			// ...
+		}
+	}()
+
+	// ...
+
+	// Stop the sequence at any time by cancelling the context
+	cancelFn()
+}
+
+```
+
+### Additional Options
+
+You can utilize additional options when creating the `Tendermint` consensus engine instance:
+
+- `WithLogger` - specifies the logger for the Tendermint consensus engine (slog)
+- `WithProposeTimeout` specifies the propose state timeout
+- `WithPrevoteTimeout` specifies the prevote state timeout
+- `WithPrecommitTimeout` specifies the precommit state timeout