Preparing release v0.4.0

CHANGELOG.md

@@ -2,170 +2,56 @@
 
 All notable changes to this project will be documented in this file.
 
-## [0.3.0] - 2023-11-03
+## [0.4.0] - 2023-11-24
 
 ### Bug Fixes
 
-- Update HOWTO.
+- do not redownload last event every index
 
+- Re-download record events after reindex
 
-### Features
-
-- Re-index command
-
-- Rescan command.
-
-- Now hex and npub keys works in the UI.
-
-
-### Other
-
-- Index statistic page.
-
-- List of reserved named without corroborating Nostr events.
-
-- Changelog update, update cargo.toml for v0.2.0.
-
-- Bold the message on the uncorroborated claims screen.
-
-- Clarifying language in the spec.
-
-- Handle edge case where a name is being indexed twice because it was posted with the same NSID twice.
-
-- CHANGELOG.mod
-
-- Updating SPEC to remove transfers and added an Appendix for changes and updates.
-
-- Removing transfers from version 0x00
-
-- Limiting names to 43 characters.
-
-- Use Primal.net for user links.
-
-- Index Stats was still using transfer_events table
-
-- Merge branch 'master' into develop
-- MSRV
-
-- Simple API to generate v1 create OP_RETURN data.
-
-- Development environment setup docs.
-
-- Simpler blockchain index table.
-
-- Added protocol version to blockchain_index
-
-- Basic working indexer.
-
-- API for create v0 op_returns
-
-- V0 -> v1 automatic upgrade
-
-- Properly notifies upgrades
-
-- SPEC update
-
-- Basic nomen-cli
+- Better relay handling
 
-- Refactoring CLI some more.
+- publis command should not use queue
 
-- Completely refactored into a multi-crate workspace.
 
-- Moving REFACTOR.md
-
-- Added transer_cache table for pending/incomplete transfers awaiting signatures.
-
-- Use transfer_cache + signatures to complete a transfer and remove the transfer from the cache.
-
-- Refactoring the commands.
-
-- Breaking into messages
-
-- Broke event loop down, using raw_blockchain now.
-
-- Updating REFACTOR.md
-
-- Updated from log crate to tracing and tracing_subscriber
-
-- Clippy pedantic fixes
-
-- Broke large method into many smaller methods for clippy's satisfaction.
-
-- Removed anyhow from nomen_core and using thiserror instead
-
-- Handle re-orgs.
-
-- Removing unused code, and moving things around.
-
-- Tests based on pre-defined test vectors!
-
-Tests based on pre-defined test vectors!
-
-- Moven nomen_core::util modules to nomen_core proper.
-
-- UI items are working
-
-- Fixed bug where it is continuously rescanning same blocks.
-
-- Refactor API module layout.
-
-- Refactored API and explorer modules, added API methods.
-
-- API docs.
-
-- Added CORS headers for API.
-
-- Setting version to 0.3.0-rc.1 for now
-
-- Removed uncorroborated claims completely.
-
-- Feedback now provided again when updating records.
-
-- Fixed Update Records link on the individual Name page.
-
-- Setting 100 expiration limit on transfer cache.
-
-- Creating a view for all unindex blocked.
+### Features
 
-- Add protocol version to name page.
+- Updated config file format for index publishing.
 
-- Return metadata from the Name api.
+- Validate config file on startup.
 
-- Return metadata from the Name api.
+- NOM-04 support, relay publishing + .well-known
 
-- Merge branch 'protocolv1' of https://github.com/ursuscamp/nomen into protocolv1
+- Version subcomand #18
 
-- New name now works a little bit more easily, by just asking for a tx input.
+- record v1 upgrade block info
 
-- Fixing code TODOs.
+- UI will now warn users when attempting a transfer on a name that doesn't exist or shouldn't be transferred
 
-- V0 Upgrade Support in UI
+- Added relays key to .well-known/nomen.json, per NOM-04 addition.
 
-- Do not show nameless v0 names on the explorer.
+- "rebroadcast" command will rebroadcast known record events
 
-- Update docs.
+- publish command to publish full relay index
 
-- Rename nsid to name in explorer.
 
-- Removing primary key index on old_transfer_cahce
+### Other
 
-- Basic transfer UI!
+- Preparing release v0.4.0
 
-- Bug fixes
+### Refactor
 
-- Added "Transfer Name" option to nav bar.
+- Refactor: Refactored db module to sub-modules (#25)
 
-- Fix two bugs: OP_RETURN length crashing bug, and database locking bug.
+- Refactor: Some tweaks to db submodule refactoring
 
-- New Name take/returns a PSBT again
+- Refactor: Additional factoring on the db module
 
-- PSBT is now optional for New Names. If PSBT is not provided, a plain OP_RETURN is generated instead.
 
-- Updating to pre.2
+### Testing
 
-- Transfers re-added. Transfers from UI now just output OP_RETURNs.
+- Test: Rewrote and refactored tests to base them on official test vectors (#24)
 
-- Bump prerelease version to 3.
 
 
-<!-- generated by git-cliff -->

RELEASE_NOTES.md

@@ -2,18 +2,18 @@
 
 ## Highlights
 
-Version 0.3.0 is a massive change. The banner feature of this new version is a protocol version bump to v1 which:
+Version 0.4.0 brings a few new features:
 
-- puts all ownership data on chain
-- backwards-compatible with v0
-- upgradeable from v0
-- enables transfer
-- long-term stable
+- [NOM-04](https://github.com/ursuscamp/noms/blob/master/nom-04.md) support: indexes are now publised to relays!
+- `rebroadcast` CLI command which rebroadcasts all known records events to relays (useful to keep indexer network healthy)
+- `publish` command will publish the full set of indexed names to relays
 
-See the changelog for a full list of changes.
+## Upgrading from 0.3
 
-## Upgrading from 0.2
-
-This version involves a full database schema revamp, so backup your `nomen.db` file, then delete it. Upgrading will require a full blockchain rescan!
-
-Checkout the new [example.nomen.toml](example.nomen.toml) file and adjust your configuration accordingly for the new version.
+1. Backup your `nomen.db` file prior to upgrading.
+2. Repalce your `nomen` executable.
+3. Update your `nomen.toml` config file with the following new keys under the `[nostr]` section (if you wish to publish your index):
+   1. `secret = "nsec..."` is the `nsec` encoded private key that your indexer will use to publish events
+   2. `publish = true` will tell your node to publish index events to your Nostr relays
+   3. `well-known = true` will make sure the indexer serves the `.well-known/nomen.json` file per the NOM-04 specification
+4. Run `nomen publish` to publish a full index (again, only if you wish to publish)

cliff.toml

@@ -30,7 +30,6 @@ body = """
 trim = true
 # changelog footer
 footer = """
-<!-- generated by git-cliff -->
 """
 # postprocessors
 postprocessors = [