v0.12 refactoring wip

RGB-WG · Nov 2, 2024 · 0d5fe9a · 0d5fe9a
1 parent 71f6719
commit 0d5fe9a
Show file tree

Hide file tree

Showing 53 changed files with 2,445 additions and 8,337 deletions.
diff --git a/.rustfmt.toml b/.rustfmt.toml
@@ -1,12 +1,13 @@
 edition = "2021"
 style_edition = "2021"
 
-max_width = 100
-array_width = 100
-attr_fn_like_width = 100
+max_width = 120
+array_width = 120
+attr_fn_like_width = 120
 comment_width = 100
-fn_call_width = 100
-single_line_if_else_max_width = 100
+chain_width = 60
+fn_call_width = 120
+single_line_if_else_max_width = 120
 
 fn_single_line = true
 format_code_in_doc_comments = true

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,34 +1,53 @@
 Change Log
 ==========
 
+v0.12.0
+-------
+
+- Unify state types
+- Distinguish verifiable and non-verifiable state
+- Make RGB STARKy
+- Remove bitcoin dependencies
+- Remove schema verification
+- Remove anchors
+- Remove secret seals, make types generic over seals
+- Remove transition bundles
+- Remove valencies and redeems, extension graphs
+- Require state transitions to have at least 1 input
+- Make schema part of genesis data
+- Refactor consensus ordering into v2 (RCP-241101A)
+
 v0.7.0
 ------
+
 - Taproot-based OP_RETURN commitments
-- New LNPBP-4 multi-protocol commitments based on merkle trees (support for 
+- New LNPBP-4 multi-protocol commitments based on merkle trees (support for
   using RGB alongside other client-side-validation protocols)
 - State transition bundling for multi-participant transactions (required for LN,
   pay/coinjoin)
 - Data containers (binary data for NFTs etc)
-- Support for arbitrary rich data in contract state with a new schema for 
+- Support for arbitrary rich data in contract state with a new schema for
   representing hierarchies of such data structures.
 
 v0.5.0
 ------
+
 - Separation of specific schemata into independent libraries
 - Introduction of AluVM virtual machine
 - Bulletproofs data removed from client-side commitments
 - Refactored schema type system
 
 v0.4.x patches
 --------------
+
 - 0.4.3: Fixing seal_definition old-way of sorting seals before they were
-         held in Vec (and BTreeSet was used instead). This allows to validate
-         multi-output transition history
+  held in Vec (and BTreeSet was used instead). This allows to validate
+  multi-output transition history
 - 0.4.4: Fixing broken upstream dependency breaking change in `zeroize` crate
-
 
 v0.4.0
 ------
+
 - Disclosures
 - Improved concealment procedures; fixed node id mutability issue
 - Reveal-merge procedure
@@ -41,12 +60,14 @@ v0.4.0
 
 v0.3.1
 ------
+
 - Lightning encoding for RGB types used in lightning messages
 - Added missed StrictEncoding derives
 - Consignment ids & bech32 representation
 
 v0.3.0
 ------
+
 - RGB Core Library is extracted and externalized from LNP/BP Core Library
 - Serde encoding fixes (proper use of `serde_as` for wrapped types)
 - BIP32 & descriptor enhancements
@@ -55,35 +76,41 @@ v0.3.0
 
 v0.2.2
 ------
+
 - Fixed PSBT key serialization issue during commitment procedure
 
 v0.2.1
 ------
+
 - Fixing serde to use Bech32 encoding for ContractId and SchemaId types
 
 v0.2.0
 ------
 No changes since RC2
 
 ### Changes since v0.1
+
 - Epic: refactoring of LNP protocols and services crate
 - Epic: initial implementation of generalized lightning network
 - Epic: lightning network specific encodings and derives
 - CI covering different mobile & desktop targets
 
 v0.2.0-rc.2
 -----------
+
 - New tagged hash implementation defaulting to Bech32 encoding for ContractId
 - Using amplify and amplify_derive v2.4
 
 v0.2.0-rc.1
 -----------
+
 - Fix for the broken tokio upstream dependency breaking issue
 - Fix for zero-balance overflow in case of empty arguments
 - Eq implementation for Schema object
 
 v0.2.0-beta.3
 -------------
+
 - Multiple BIP-32 improvements on top of rust-bitcoin functionality
 - Better CI
 - Android/iOS/Windows/MacOs build fixes
@@ -95,6 +122,7 @@ v0.2.0-beta.2
 -------------
 
 ### LNP module
+
 - Noise handshake
 - Abstract state channels
 - Payment channels
@@ -103,31 +131,35 @@ v0.2.0-beta.2
 - Additional LN peer messages supporting RGB
 
 ### BP module
+
 - Lexicographic orderings (BIP96) for transactions, PSBTs, inputs and outputs
 
 v0.2.0-beta.1
 -------------
 
 ### LNP/BP Core Library
+
 - LN messaging & LNPWP: Lightning network peer wire protocol (BOLT-1pt2, BOLT-2)
 - BOLT-8 noise encryptor and handshake implementation
 - Improvements to LN-specific data types
 - LNP socket and node addressing large-scale refactoring
-- More serde and strict encoding implementations for data types across the 
+- More serde and strict encoding implementations for data types across the
   library
 
 ### LNP/BP Derivation Library
+
 - Implementation of strict derive macros for enums
 
 ### LNP/BP Services Library
+
 - Debugging and display logging improvements with LNP/BP Services library
 - ESB functionality improvements in LNP/BP Services libraru
 
 v0.2.0-alpha.3
 --------------
 
 - Improvements to the ESB and RPC service architectures
-- Improvements to debug logging and displaying of LN messages and service 
+- Improvements to debug logging and displaying of LN messages and service
   information
 
 v0.2.0-alpha.2
@@ -141,87 +173,91 @@ v0.2.0-alpha.2
 v0.2.0-alpha.1
 --------------
 
-This is alpha release with some major refactoring in LNP mod adding support for 
+This is alpha release with some major refactoring in LNP mod adding support for
 LN and Internet2 protocols.
 
 - Refactoring of LNP protocol stack; introduction of Internet2 architacture
-- Services crate implementing common client/server and other node architecture 
+- Services crate implementing common client/server and other node architecture
   patterns
 - Basic implementation of core Lightning network data structures
 
 v0.1.0
 ------
 
 ### Library overview
+
 - **Paradigms**: generic APIs for L1/L3 best practices
-  * **Client-side validation**
-  * **Single-use-seals**
-  * **Strict encoding**
+    * **Client-side validation**
+    * **Single-use-seals**
+    * **Strict encoding**
 - **Bitcoin protocol**: extensions to `bitcoin` crate and L2/L3 APIs
-  * **Deterministic bitcoin commitments** (DBC) based on LNPBP1-4 standard
-  * **Tagged hashes**: additional procedures for working with Tapproot-style
-    tagged hashes
-  * **Short bitcoin identifiers** based on LNPBP-4 standard
-  * **Resolver API** for requesting transaction graph using providers (like
-    Bitcoin Core RPC, Electrum Server API etc)
-  * **Chains**, chain parameters and universal asset identifiers
-  * **Script types** for differentiating script cycle through different
-    transaction parts
-  * **Transaction-output-based single-use-seals**: bitcoin-specific 
-    implementation of single-use-seals
+    * **Deterministic bitcoin commitments** (DBC) based on LNPBP1-4 standard
+    * **Tagged hashes**: additional procedures for working with Tapproot-style
+      tagged hashes
+    * **Short bitcoin identifiers** based on LNPBP-4 standard
+    * **Resolver API** for requesting transaction graph using providers (like
+      Bitcoin Core RPC, Electrum Server API etc)
+    * **Chains**, chain parameters and universal asset identifiers
+    * **Script types** for differentiating script cycle through different
+      transaction parts
+    * **Transaction-output-based single-use-seals**: bitcoin-specific
+      implementation of single-use-seals
 - **RGB**: confidential smart-contract system for Bitcoin & Lightning Network
   based on client-side validation paradigm (LNPBP11-13 standards)
-  * **Schema**: structure defining contract creation and evolution rules and
-    restrictions
-  * **Contracts**: data types for contract lifecycle
-  * **Scripting** with embedded procedures for fungible assets  
-  *The library implements RGB Core v1 release candidate set of standards*
+    * **Schema**: structure defining contract creation and evolution rules and
+      restrictions
+    * **Contracts**: data types for contract lifecycle
+    * **Scripting** with embedded procedures for fungible assets  
+      *The library implements RGB Core v1 release candidate set of standards*
 - **Lightning networking protocol**: generalized P2P and RPC networking APIs
   based on the original Lightning standard; early preview
-  * Universal P2P node ids supporting IPv4, IPv6, Onion v2 and v3 addresses and
-    public keys
-  * Feature vectors for defining and workinf with set of feature bits
-  * LNP networking with ZMQ sockets for RPC interfaces
+    * Universal P2P node ids supporting IPv4, IPv6, Onion v2 and v3 addresses and
+      public keys
+    * Feature vectors for defining and workinf with set of feature bits
+    * LNP networking with ZMQ sockets for RPC interfaces
 
 ### Major changes since RC2
+
 - Support for Rust stable and MSRV reduction to 1.41.1
 - Custom forks for upstream bitcoin-related dependencies are changed onto the
   latest publicly-released versions
 
 ### Breaking changes since RC2
+
 - Updated taproot-based hashed tag system (BIP-340) according to the most
   recent specs.
 - RGB `Amount` renamed into `AtomicValue`
 - RGB `amount` mod renamed into `value`
-- RGB seal definitions and related structures are now `Copy` and returned by 
+- RGB seal definitions and related structures are now `Copy` and returned by
   value
 
-
 v0.1.0-rc.2
 -----------
 
 ### Breaking changes:
+
 - Changed embedded procedure names for RGB VM
-- Removed requirement for PSBT to contain fee key in RGB anchor creation (it 
-  needs to be a properly constructed PSBT with `witness_utxo`/`non_witness_utxo` 
+- Removed requirement for PSBT to contain fee key in RGB anchor creation (it
+  needs to be a properly constructed PSBT with `witness_utxo`/`non_witness_utxo`
   data)
 
 ### Other changes:
+
 - More embedded procedures for RGB VM
 - Schema serde serialization (YAML, JSON etc)
 - Serde serialization for all RGB contract structures
 - Strict encoding and decoding of Curve25519 public keys and Ed25519 signatures
-- Implementation of Curve25519 public keys and Ed25519 signatures as RGB state 
+- Implementation of Curve25519 public keys and Ed25519 signatures as RGB state
   and metadata
 - Bech types for Pedersen commitments, Bulletproofs, Curve25519 data
 - Tweaking factor is added into PSBT information during anchor creation
 - Added bitcoin protocol resolvers API
 
-
 v0.1.0-rc.1
 -----------
 
 ### Breaking changes:
+
 - RGB protocol & schema versioning with feature bits
 - Consignment versioning
 - Changed Bech32 encodings of RGB data structures; added deflation encoding
@@ -233,63 +269,67 @@ v0.1.0-rc.1
 - Introduced Chain and ChainParam types instead of old network versioning
 
 ### Other changes:
+
 - Test coverage >70%
 - Code docs >50%
 
-
 v0.1.0-beta.4
 -------------
 
 ### Breaking changes:
-- Updated upstream crates (bitcoin, bitcoin_hashes, secp256k1, 
+
+- Updated upstream crates (bitcoin, bitcoin_hashes, secp256k1,
   grin_secp256k1zpk, miniscript, lightning) with many PRs merged
-- EmbedCommitVerify now can mutate container data (used for returning tweaking 
+- EmbedCommitVerify now can mutate container data (used for returning tweaking
   factors)
-- Upgrading `rand` version to the most recent one (blocked previously by 
+- Upgrading `rand` version to the most recent one (blocked previously by
   grin_secp256k1zpk dependency)
 - Changied txout seals to use u32 vouts instead of u16
 - Changed txout blinding factor to be u64 instead of u32
 
 ### Other changes:
+
 - Test coverage >50% (zero-knowledge functionality & RGB contracts structures)
 - Returning tweaking factors
 - Minimal support for Tor V2 addresses; improved internet address parsing
 
-
 v0.1.0-beta.3
 -------------
 
 ### Breaking changes
+
 - Single-use-seals blinding factor changed from 32-bit to 64-bit of entropy
-- Transaction output indexes in single-use-seal definitions are now 32-bit, as 
+- Transaction output indexes in single-use-seal definitions are now 32-bit, as
   in Bitcoin Core / rust-bitcoin (previously were 16-bit)
 
 ### New features
+
 - Initial Tor V2 address support
 - Test cases for BP mod strict encoding
 
-
 v0.1.0-beta.2
 -------------
 
 ### Features overview
+
 - Complete validation workflow with new Validator object
 - Virtual machines for RGB contracts (interface + embedded VM)
-- `Consignment` now has a version field, so in the future more space-saving 
-  variants can be created (like removing txid from anchors and using short 
+- `Consignment` now has a version field, so in the future more space-saving
+  variants can be created (like removing txid from anchors and using short
   universal bitcoin IDs when BP node adoption will increase)
-- Anchor contains txid field; so validation can be performed with just Bitcoin 
-  Core (no Electrum or BP node is required). This also speeded up validation 
+- Anchor contains txid field; so validation can be performed with just Bitcoin
+  Core (no Electrum or BP node is required). This also speeded up validation
   performance significantly.
 
 ### Breaking changes
-- Change of `TransitionId` hash tag value (previously-generated transition ids 
+
+- Change of `TransitionId` hash tag value (previously-generated transition ids
   will be invalid)
-- Change of `GenesisId`  hash tag value (previously-generated contract/assets 
+- Change of `GenesisId`  hash tag value (previously-generated contract/assets
   ids will be invalid)
 - `TransitionId` type is replaced with `NodeId`
-- `NodeId` and `ContractId` are now equal by value; `ContractId` is `NodeId` 
+- `NodeId` and `ContractId` are now equal by value; `ContractId` is `NodeId`
   wrapper
-- `ancestors()` method moved from `Transition` to `Node` trait; genesis returns 
+- `ancestors()` method moved from `Transition` to `Node` trait; genesis returns
   an empty array
 - Consignment endpoints contain `NodeId` information