Skip to content

Latest commit

 

History

History
149 lines (111 loc) · 4.24 KB

README.md

File metadata and controls

149 lines (111 loc) · 4.24 KB
Raw

Yttrium

Yttrium is a cross-platform library designed for working with smart accounts, currently focused on the Ethereum ecosystem.

Caution

This project is under heavy development and is currently in a pre-alpha state.

Overview

Yttrium simplifies the process of building applications that utilize account abstraction. It provides essential abstractions and primitives for Wallets and DApps to interact with and implement smart account functionality.

A primary goal of this project is to enable externally owned account (EOA) wallets to offer advanced features such as batch transactions and transaction sponsorship to their users.

While initially focused on Ethereum, Yttrium aims to be a cross-chain account abstraction library.

Architecture

The following diagram provides an overview of the Yttrium architecture:

graph TD;
    CoreRustLibrary[Core Rust Library] -->|Compiled to| NativeLibrary[Native Library]
    NativeLibrary --> |Is consumed by| SwiftWrapper[Swift Wrapper]
    NativeLibrary -.-> OtherNativePlatform["Other Native Platform"]
    CoreRustLibrary -->|Compiled to| WebAssemblyModule[WebAssembly Module]
    WebAssemblyModule --> |Is consumed by| TypeScriptWrapper[TypeScript Wrapper]
    WebAssemblyModule -.-> OtherWebAssemblyPlatform["Other WebAssembly Platform"]

	style CoreRustLibrary color:#fff,fill:#CE422B,stroke:#fff,stroke-width:2px
    style NativeLibrary fill:#0000FF,stroke:#fff,stroke-width:2px
    style SwiftWrapper color:#fff,fill:#F05138,stroke:#fff,stroke-width:2px
    style WebAssemblyModule fill:#654ff0,stroke:#fff,stroke-width:2px,color:#fff
    style TypeScriptWrapper color:#fff,fill:#3178c6,stroke:#fff,stroke-width:2px
    style OtherNativePlatform color:#333,fill:#ccc,stroke:#ccc,stroke-dasharray: 5,5
    style OtherWebAssemblyPlatform color:#333,fill:#ccc,stroke:#ccc,stroke-dasharray: 5,5
Loading

Standards

In the near future, Yttrium will implement the following standards:

  • ERC-4337 (in development)
  • ERC-7702 (in development)

Additional standards and features will be added as the project evolves.

Available APIs

Yttrium currently provides APIs for:

  • Swift
  • Rust

Planned future APIs include:

  • JavaScript/TypeScript (via WebAssembly)
  • Kotlin
  • Flutter
  • C#/Unity

Target Platforms

Currently supported platforms:

  • Apple platforms (iOS, macOS)
  • Linux

Planned future support includes:

  • WebAssembly
  • Android
  • Web
  • Windows

Installation and Setup

Development Dependencies

To contribute to this project, ensure you have the following dependencies installed:

  • just - cargo install just
  • rustup
  • Rust latest stable installed
  • swiftc and Xcode
  • make

Setup

After installing the above dependencies, you can run just ci to run the checks that CI does and initialize your repo.

You must run just infra to run a local anvil and a mock alto bundler which is required by some of these tests.

Devloop

During normal development you can use the just devloop command to test your code both during development and before comitting/pushing. This is handy as it runs as many checks as possible and fixes any issues (such as formatting) automatically.

This command does not require any configuration.

just devloop

TODO: make this setup anvil automatically

Specific tests

Some tests require some configuration (such as funds on Sepolia). For these, supply FAUCET_MNEMONIC and add some funds on the account.

Pimlico/Sepolia

just test-pimlico-api

Required environment variables:

FAUCET_MNEMONIC
PIMLICO_API_KEY
PIMLICO_BUNDLER_URL
PIMLICO_RPC_URL

Justfile targets

flowchart TD
    _pass --> p[PASS]
    check --> setup
    check --> lint
    check --> test
    devloop --> check
    devloop --> env-tests
    %% devloop --> _pass
    env-tests --> test-pimlico-api
    costly-tests --> test-blockchain-api
    lint --> fmt
    lint --> clippy
    _ci --> udeps
    _ci --> swift
    _ci --> kotlin
    ci --> check
    ci --> _ci
    %% ci --> _pass
    devloop-ci --> check
    devloop-ci --> env-tests
    devloop-ci --> _ci
    %% devloop-ci --> _pass
    devloop-ci-costly --> check
    devloop-ci-costly --> env-tests
    devloop-ci-costly --> _ci
    devloop-ci-costly --> costly-tests
    %% devloop-ci-costly --> _pass
    infra
Loading