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

@audits/merkledrop

v1.0.0

Published

A smart contract for Merkle tree-based airdrops

Downloads

2

Readme

MerkleDrop

The MerkleDrop contract is a way for users to withdraw tokens from an on-chain contract, based on a Merkle tree constructed off-chain.

This has 3 primary benefits:

  • Prevents spamming the blockchain with many transactions
  • Saves gas on the part of the sending entity
  • Users who do not want tokens simply take no action

Users may sign up to receive tokens from an entity off-chain, and that entity will generate a Merkle tree once they have collected enough addresses (enough being an arbitrary number). That entity will then deploy the MerkleDrop contract with the Merkle root hash and fund the contract with the token.

Ideally, the entity creating the Merkle tree will provide the steps for users to validate the Merkle root hash stored on-chain if they should wish to do so.

Off-Chain

  • Store user addresses and the amount of tokens they should receive
  • Construct a Merkle tree with the leaves being the keccak256 hash of the user's address and the amount of tokens (see the generateLeaves method in the test file for an example)
  • Provide users with the proof associated to their leaf and the positions

On-Chain

  • Deploy the contract with the Merkle root hash and the address of the token which users should receive
  • Fund the MerkleDrop contract with the token via transfer
  • Users may provide their proof, positions, and the amount to receive. If their input validates, the amount specified will be transferred to their address