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

@laborx/airdrop-contracts

v1.0.1

Published

Provides Ethereum smart contract that allows to perform token airdrop using merkle tree and merkle proof to record and check allowance for token withdrawals.

Downloads

4

Readme

Airdrop

Provides Ethereum smart contract that allows to perform token airdrop using merkle tree and merkle proof to record and check allowance for token withdrawals.

Using

Install package using npm or yarn package managers:

  • npm install @laborx/airdrop-contracts

or

  • yarn add @laborx/airdrop-contracts

Contracts

Import smart contract as you usually do with external libraries

import "@laborx/airdrop-contracts/contracts/Airdrop.sol";

contract ExtendedAirdrop is Airdrop {
	// ...
}

Airdrop smart contract

It allowes to:

  • provide basic token (ERC20 or ERC223 standards) that will be used for airdropping;
  • provide airdrop campaign name;
  • setting up merkle root of a Merkle tree that is based on list of records of allowed withdrawals
  • claiming tokens if you are allowed to do that; user needs to provide a merkle proof to finally withdraw tokens.

For managing Merkle trees for airdrops we use package @laborx/merkletree.

More information about Airdrop contract you can find in documentation;

ScopedAirdrop smart contract

  • introduces term of "program" that could be deposited by different (more than one at once) tokens;
  • allows to claim several tokens providing proof for each of them.

More information about ScopedAirdropInterface interface you can find in documentation;

Support

There are two main areas for support functionality:

  • deployment scripts
  • constants

Deployment scripts

Deployment of a contract could be run with truffle framework by providing deployment context from @truffle-types/deployment-context package.

const deployerAccount = "0x...";
const deploymentContext = new ContractDeploymentContext(
	web3,
	artifacts,
	undefined,
	"path to deployed-addresses.json file"
);
await AirdropDeployment.deployScopeAirdrop(
	deploymentContext,
	deployerAccount,
	{
		airdrop: "AirdropContractKey",
		airdropBackendProvider:
			"AirdropBackendProviderContractKey",
		airdropLib: "AirdropLibraryContractKey"
	},
	{
		airdrop: { redeploy: false, owners: [] },
		airdropBackendProvider: {
			redeploy: false,
			updateLib: false
		},
		airdropLib: { redeploy: false }
	}
);

Support constants

Provides the next constants:

  • revert reasons (AirdropRevertReasons, ScopedAirdropRevertReasons, BytesLibRevertReasons)
  • error codes (errorsLibrary)
  • names for deployed addresses file (ContractNames)