npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

sun-mud

v0.0.1

Published

MUD is the fabric of autonomous worlds

Downloads

3

Readme

MUD

MUD is a framework for complex Ethereum applications.

It adds some conventions for organizing data and logic and abstracts away low-level complexities so you can focus on the features of your app.

It standardizes the way data is stored on-chain. With this standard data model, MUD can provide all network code to synchronize contract and client state. This includes synchronizing state directly from an RPC node or a general-purpose MUD indexer.

MUD is MIT-licensed, open source and free to use.

Features

MUD features

Today

  • State synchronization between contracts and clients without custom networking code
  • General purpose indexers (without custom indexing code)
  • Seamless contract upgrades (+ automatic contract upgrades during development)
  • Shared contract state
  • Optimistic updates
  • Automatic type generation for contracts and systems
  • Query language to interact with contract state
  • Data explorer to inspect and modify contract and local state
  • Bitpacking utilities

Soon

  • Local simulation of transactions (including optimistic state)
  • Built-in support for account abstraction
  • Contract package manager

Quickstart

pnpm create mud@canary my-project

More more information on how to get started, have a look at the MUD documentation.

Talks

Packages

MUD consists of several libraries. They can be used independently, but are best used together.

| Package | Version | | ----------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | | @latticexyz/recs TypeScript Reactive Entity Component System library | npm version | | @latticexyz/services Go services for indexer, faucet, message relay | npm version | | @latticexyz/cli Command line interface for types, testing, faucet, deployment and more | npm version | | @latticexyz/noise Solidity and AssemblyScript implementations of Perlin noise | npm version |

Contribute

We'd love your support in improving MUD! This monorepo includes all of MUD's source code, and pull requests are always welcome. To discuss new features or changes join our Discord.

Local development setup

!!! The following steps are only necessary if you want to contribute to MUD. To use MUD in your project, install the packages from npm or set up a new project with the MUD cli. !!!

  1. Install go (required to build packages/services): https://go.dev/doc/install

  2. Install protobuf (required to build packages/services): https://grpc.io/docs/protoc-installation/

  3. Install the foundry toolkit (required to build and test MUD solidity packages): https://getfoundry.sh/

  4. Install pnpm

npm install pnpm --global
  1. Clone the MUD monorepo
git clone https://github.com/latticexyz/mud
  1. Install MUD dependencies and setup local environment
cd mud && pnpm install

Pull requests

MUD follows the conventional commit specification for commit messages and PR titles. Please keep the scope of your PR small (rather open multiple small PRs than one huge PR) and follow the conventional commit spec.

Community support

Join our Discord to get support and connect with the community!

License

MUD is open-source software licensed as MIT.