feat: enable mdformat through treefmt-nix

.mdformat.toml

@@ -0,0 +1 @@
+number = true

CONTRIBUTING.md

@@ -12,7 +12,7 @@ For more complex conversations, use the [discussions](https://github.com/unionla
 
 We evaluate the need for a PR based on:
 
-1. Severity of the issue (bug or feature request).
+1. Severity of the issue (bug or feature request),
 2. Maintainability: will this become a burden for little gain, or add value?
 3. Can the core team understand the code additions being made, and maintain them, or will they rely on you in the future?
 

README.md

@@ -9,13 +9,13 @@
 </div>
 
 <br/>
-  
+
 <div align="center">
 
-  [![built with garnix](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fgarnix.io%2Fapi%2Fbadges%2Funionlabs%2Funion%3Fbranch%3Dmain)](https://garnix.io)
-  [![Docs](https://img.shields.io/badge/docs-main-blue)][docs]
-  [![Discord badge][]](https://discord.union.build)
-  [![Twitter handle][]][Twitter badge]
+[![built with garnix](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fgarnix.io%2Fapi%2Fbadges%2Funionlabs%2Funion%3Fbranch%3Dmain)](https://garnix.io)
+[![Docs](https://img.shields.io/badge/docs-main-blue)][docs]
+[![Discord badge]](https://discord.union.build)
+[![Twitter handle]][twitter badge]
 
 </div>
 
@@ -82,29 +82,29 @@ Check the `#developers` channel on [Union's discord](https://discord.union.build
 
 The official docs are hosted [here][docs]. Each individual component also has accompanying developer documentation for contributors, which you can find in each `README.md`.
 
-[docs]: https://docs.union.build "Official Union Docs"
-[IBC]: https://github.com/cosmos/ibc "cosmos/ibc"
-[Discord badge]: https://img.shields.io/discord/1158939416870522930?logo=discord
-[Twitter handle]: https://img.shields.io/twitter/follow/union_build.svg?style=social&label=Follow
-[Twitter badge]: https://twitter.com/intent/follow?screen_name=union_build
-[CosmWasm]: https://cosmwasm.com/
-[Arbitrum]: https://github.com/OffchainLabs/arbitrum
-[Ethereum]: https://ethereum.org
-[EVM]: https://ethereum.org/en/developers/docs/evm/
-[Rust]: https://www.rust-lang.org/
-[Solidity]: https://soliditylang.org/
-[Go]: https://go.dev/
-[TypeScript]: https://www.typescriptlang.org/
-[Svelte]: https://svelte.dev
-[Astro]: https://astro.build
-[`CometBLS`]: https://github.com/unionlabs/cometbls
-[Light Clients]: https://a16zcrypto.com/posts/article/an-introduction-to-light-clients/
-[Gnark]: https://github.com/ConsenSys/gnark
-[Nix]: https://zero-to-nix.com/
-[NixOS]: https://nixos.org
-[OrbStack]: https://orbstack.dev/
-[Consensus Verification]: https://union.build/docs/concepts/consensus-verification/
-[union.build]: https://union.build
 [app.union.build]: https://app.union.build
 [app.union.build/faucet]: https://app.union.build/faucet
-[Cosmos]: https://cosmos.network
+[arbitrum]: https://github.com/OffchainLabs/arbitrum
+[astro]: https://astro.build
+[consensus verification]: https://union.build/docs/concepts/consensus-verification/
+[cosmos]: https://cosmos.network
+[cosmwasm]: https://cosmwasm.com/
+[discord badge]: https://img.shields.io/discord/1158939416870522930?logo=discord
+[docs]: https://docs.union.build "Official Union Docs"
+[ethereum]: https://ethereum.org
+[evm]: https://ethereum.org/en/developers/docs/evm/
+[gnark]: https://github.com/ConsenSys/gnark
+[go]: https://go.dev/
+[ibc]: https://github.com/cosmos/ibc "cosmos/ibc"
+[light clients]: https://a16zcrypto.com/posts/article/an-introduction-to-light-clients/
+[nix]: https://zero-to-nix.com/
+[nixos]: https://nixos.org
+[orbstack]: https://orbstack.dev/
+[rust]: https://www.rust-lang.org/
+[solidity]: https://soliditylang.org/
+[svelte]: https://svelte.dev
+[twitter badge]: https://twitter.com/intent/follow?screen_name=union_build
+[twitter handle]: https://img.shields.io/twitter/follow/union_build.svg?style=social&label=Follow
+[typescript]: https://www.typescriptlang.org/
+[union.build]: https://union.build
+[`cometbls`]: https://github.com/unionlabs/cometbls

VERSIONING.md

@@ -31,6 +31,7 @@ The Union testnet will track the most recent release candidate. Release candidat
 The Union mono-repo is made up of many different components that are maintained and updated at different rates. We've opted to release components individually rather than in all encompassing versions. To do this, version tags are to now be made in the form of `<component>/v{X}.{Y}.{Z}` (`voyager-v0.2.1`). This will enable us to quickly update and distribute various components without creating monolithic releases.
 
 To create a release:
+
 - Checkout a new branch from main (or desired commit) with a name in the form of `release/<component>/v{X}.{Y}.{Z}`.
 - On this branch, create the first release candidate tag in the form `<component>/v{X}.{Y}.{Z}-rc1`.
 - Continue iterating release candidate tags until a viable release is generated

app/README.md

@@ -1,6 +1,6 @@
 # Union's Web App
 
-[app.union.build](https://app.union.build) is built to be user friendly, extremely reliable, and blazing fast. It achieves this through a stack of optimized tools that do most processing at compile time (before you even use the app), and by connecting to our optimized [hubble](../hubble) indexer. 
+[app.union.build](https://app.union.build) is built to be user friendly, extremely reliable, and blazing fast. It achieves this through a stack of optimized tools that do most processing at compile time (before you even use the app), and by connecting to our optimized [hubble](../hubble) indexer.
 
 ## Quickstart
 
@@ -18,18 +18,18 @@ nix run .#app-fetch-schema
 
 ## Architecture
 
-It's a [SvelteKit] app that compiles to a static site such that it can later be distributed using decentralized providers like [IPFS]. 
-Data is fetched from [graphql.union.build]. The [GraphQL] queries are defined in `./src/lib/graphql/documents`, and types for it are generated by [gql.tada]. We use [TanStack Query] to periodically fetch new data (both for [GraphQL] and REST).  
+It's a [SvelteKit] app that compiles to a static site such that it can later be distributed using decentralized providers like [IPFS].
+Data is fetched from [graphql.union.build]. The [GraphQL] queries are defined in `./src/lib/graphql/documents`, and types for it are generated by [gql.tada]. We use [TanStack Query] to periodically fetch new data (both for [GraphQL] and REST).
 
 For interacting with EVM chains, we use [Wagmi & Viem](https://wagmi.sh/core/getting-started). For interacting with Cosmos chains, we use [CosmJS].
 
 The basis for our components are generated by [shadcn-svelte](https://www.shadcn-svelte.com), and then modified to adhere to our brand guidelines. Styling is done using [Tailwind].
 
-[SvelteKit]: https://kit.svelte.dev/
-[GraphQL]: https://graphql.org
-[TanStack Query]: https://tanstack.com/query/latest/docs/framework/svelte/overview
-[graphql.union.build]: https://graphql.union.build
+[cosmjs]: https://github.com/cosmos/cosmjs
 [gql.tada]: https://github.com/0no-co/gql.tada
-[IPFS]: https://ipfs.tech
-[CosmJS]: https://github.com/cosmos/cosmjs
-[Tailwind]: https://tailwindcss.com
+[graphql]: https://graphql.org
+[graphql.union.build]: https://graphql.union.build
+[ipfs]: https://ipfs.tech
+[sveltekit]: https://kit.svelte.dev/
+[tailwind]: https://tailwindcss.com
+[tanstack query]: https://tanstack.com/query/latest/docs/framework/svelte/overview

dictionary.txt

@@ -785,6 +785,7 @@ maxdome
 maxp
 maxpeers
 mdast
+mdformat
 mdsvex
 merkle
 merkleize

docs/README.md

@@ -16,7 +16,7 @@ nix run .#docs-dev-server
 
 It's an [Astro] site, hosted on [Cloudflare Pages]. The docs are built using [Starlight]. Styling is done using [Tailwind].
 
-[Astro]: https://astro.build
-[Tailwind]: https://tailwindcss.com
-[Starlight]: https://starlight.astro.build
-[Cloudflare Pages]: https://pages.cloudflare.com
+[astro]: https://astro.build
+[cloudflare pages]: https://pages.cloudflare.com
+[starlight]: https://starlight.astro.build
+[tailwind]: https://tailwindcss.com

docs/src/content/docs/concepts/bls-signatures.md → docs/src/content/docs/concepts/bls-signatures.mdx

@@ -2,7 +2,10 @@
 title: BLS Signatures
 ---
 
-Boneh–Lynn–Shacham (BLS) signatures form the foundation of [CometBLS](/architecture/cometbls). They are cheaper to verify for both regular [IBC](/concepts/ibc) and zero-knowledge proof (ZKP) based IBC. With BLS signatures, we can aggregate the public keys and the signatures and verify the aggregated signature with the aggregated private key. BLS signature aggregation has a few advantages:
+Boneh–Lynn–Shacham (BLS) signatures form the foundation of [CometBLS](/architecture/cometbls).
+They are cheaper to verify for both regular [IBC](/concepts/ibc) and zero-knowledge proof (ZKP) based IBC.
+With BLS signatures, we can aggregate the public keys and the signatures and verify the aggregated signature with the aggregated private key.
+BLS signature aggregation has a few advantages:
 
 - Transaction size decreases compared to ECDSA verification. We do not need to transfer all signatures, just the aggregate.
 - On-chain computation cost decreases. Instead of verifying each signature, we verify the aggregate.

evm/README.md

@@ -53,6 +53,7 @@ Note that the addresses are different because we often redeploy without upgradin
 Production contracts will get solely upgraded through the proxy and have the same addresses accross networks.
 
 ### Sepolia
+
 - Deployer: [0x12cffF5aAd6Fc340BBE6F1fe674C5Aa78f0d1E0F](https://sepolia.etherscan.io/address/0x12cffF5aAd6Fc340BBE6F1fe674C5Aa78f0d1E0F)
 - Sender: [0x2c077908e1173ff1a6097ca9e2af547c1e5130c4](https://sepolia.etherscan.io/address/0x2c077908e1173ff1a6097ca9e2af547c1e5130c4)
 - IBCHandler: [0xa390514f803a3b318b93bf6cd4beeb9f8299a0eb](https://sepolia.etherscan.io/address/0xa390514f803a3b318b93bf6cd4beeb9f8299a0eb)
@@ -62,6 +63,7 @@ Production contracts will get solely upgraded through the proxy and have the sam
 - Multicall: [0x70BEDecc56C7104e410c1e4c25FcA0bcd29A0bA9](https://sepolia.etherscan.io/address/0x70bedecc56c7104e410c1e4c25fca0bcd29a0ba9)
 
 ### Berachain
+
 - Deployer: [0x17425b7d2d97E613dE2ADa01Dc472F76879E08Fe](https://bartio.beratrail.io/address/0x17425b7d2d97E613dE2ADa01Dc472F76879E08Fe)
 - Sender: [0x27156Eb671984304ae75Da49aD60C4479B490A06](https://bartio.beratrail.io/address/0x27156Eb671984304ae75Da49aD60C4479B490A06)
 - IBCHandler: [0x851c0EB711fe5C7c8fe6dD85d9A0254C8dd11aFD](https://bartio.beratrail.io/address/0x851c0EB711fe5C7c8fe6dD85d9A0254C8dd11aFD)
@@ -71,6 +73,7 @@ Production contracts will get solely upgraded through the proxy and have the sam
 - Multicall: [0x3147CA8f531070DDAC1b93700ef18E4Dd05b86ec](https://bartio.beratrail.io/address/0x3147CA8f531070DDAC1b93700ef18E4Dd05b86ec)
 
 ### Arbitrum
+
 - Deployer: [0x7d00b15A53B8b14a482BF761653532F07b7DcBdE](https://sepolia.arbiscan.io/address/0x7d00b15A53B8b14a482BF761653532F07b7DcBdE)
 - Sender: [0x50C9C35e0197e781e9aD7a3F6baDD8d01E45c377](https://sepolia.arbiscan.io/address/0x50C9C35e0197e781e9aD7a3F6baDD8d01E45c377)
 - IBCHandler: [0xb599bfcfb9D4fCaE9f8aB5D45d9A6F145E6b7573](https://sepolia.arbiscan.io/address/0xb599bfcfb9D4fCaE9f8aB5D45d9A6F145E6b7573)