DOCSEARCHbyAlgolia
Submit Docs

Union Documentation

repository·main·Indexed 13 days ago

https://github.com/unionlabs/union

A zero-knowledge infrastructure layer for efficient general message passing, asset transfers, NFTs, and DeFi. Union uses consensus verification to connect ecosystems like Cosmos and EVM without trusted third parties. Documentation includes guides for developing the Union App with Nix, implementing permissionless IBC protocols in Move for Aptos and Movement, and managing ZKGM package deployments.

Tokens
224.2K
Snippets
667
Records
1K
Agent score
99%

What's inside Union

  2. Overview of UCS03 - ZKGM Protocol

    main

    The ucs03-zkgm-0 protocol is a high-performance, gas-efficient protocol designed for message passing, asset transfers, intents, and storage proofs. It is the recommended protocol for most use cases due to its advanced features like open filling and deterministic execution.

    Key features include:

    • Open Filling: Allows arbitrary third parties (fillers) to fill orders, enabling transfers to be completed before source chain finality using preconfirmations.
    • Rate Limiting: Uses a token bucket mechanism with configurable capacity and refill rates to manage consumption.
    • Immutable Packets: Packets are constructed off-chain and remain unchanged during on-chain processing, enabling mempool inspection for near-instant intent filling.
    • Deterministic Multi-Chain Execution: Uses deterministic salt derivation to allow market makers to predict and validate entire execution paths across multiple chains.

  3. Overview of @unionlabs/effect-svelte

    main

    The @unionlabs/effect-svelte library provides integration between the Effect ecosystem and Svelte. It is currently experimental and subject to breaking changes.

    It consists of three main modules:

    • Runtime: Manages the Effect runtime within Svelte components and enables reactive rune-like Effect execution.
    • Snippets: Provides Svelte snippets for pattern matching on common Effect Algebraic Data Types (ADTs) such as Option, Either, and Exit.
    • SvelteConfigProvider: Integrates the Effect ConfigProvider with common SvelteKit environment patterns.

  4. Overview of the Beacon API client

    main

    The beacon-api library is a basic implementation of a client for the Ethereum Beacon API.

    Currently, the library is specialized and only provides the minimal interfaces necessary to fetch updates for the Union ethereum light client (located in cosmwasm/lightclient/ethereum/). It is not intended to be a full-featured Ethereum Beacon API client, but rather a targeted tool for light client synchronization.

  6. Overview of @unionlabs/sdk-evm

    main
    The @unionlabs/sdk-evm package is the Union TypeScript SDK tailored for interacting with EVM (Ethereum Virtual Machine) chains. It provides the necessary abstractions and tools to integrate Union's capabilities within EVM-based environments.

  7. What is Galoisd?

    main

    Galoisd (galoisd) is a gRPC service that provides consensus proof generation for CometBLS block headers. It is designed to work alongside services like IBC relayers, which send block data to galoisd for zero-knowledge proof (ZKP) generation.

    Warning: galoisd is not intended to be a public service. Because proving is computationally intensive, incorrect configuration can lead to denial-of-service (DoS) attacks.

  9. Overview of CW Escrow Vault

    main
    The CW Escrow Vault is a CosmWasm smart contract that functions as a solver within the UCS03 ZKGM protocol. Its primary purpose is to enable fungible cross-chain asset transfers between Cosmos and EVM chains by managing the escrow and release of native and CW20 tokens. It acts as the Cosmos-side counterparty to the UnionversalToken.sol contract on EVM chains, providing liquidity and maintaining the 1:1 backing between native and synthetic tokens.

  10. Overview of beacon-api-types

    main

    The beacon-api-types library provides TypeScript/Rust types corresponding to the Ethereum Consensus Specs. It includes implementations for canonical serializations in both SSZ (Simple Serialize) and JSON formats.

    Key features:

    • Modular Organization: Each type is organized into its own module and re-exported at the crate root.
    • Bounded Types: For types that have specific bounds defined in the SSZ specification, the library provides a TypeSsz variant that enforces these bounds. It also provides conversion utilities between bounded and non-bounded versions of the same type.

  12. Overview of the Union Network

    main

    Union is a zero-knowledge infrastructure layer designed for general message passing, asset transfers, NFTs, and DeFi. It provides a high-speed, secure inter-blockchain communication (IBC) protocol using advanced Zero-Knowledge Cryptography and BLS signatures.

    Key characteristics include:

    • Decentralization: No dependencies on trusted third parties, oracles, multi-signatures, or Multi-Party Computation (MPC).
    • Security: Abides by fork-choice rules to ensure reliability.
    • Performance: Fast generation and settlement of bridging transactions.
    • Developer Experience: Provides high-level APIs usable across various blockchain ecosystems.