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

@animoca/ethereum-contracts-assets

v3.0.1

Published

Base assets contracts

Downloads

36

Readme

Solidity Assets

Coverage Status

This project serves as a base dependency for Solidity-based assets contract projects by providing related base contracts, constants, and interfaces. The standards supported are ERC20, ERC721 and ERC1155. Different standard extensions are also available in order to easily build robust implementations.

Overview

Installation

Install as a module dependency in your host NodeJS project:

npm install --save-dev @animoca/ethereum-contracts-assets

or

yarn add -D @animoca/ethereum-contracts-assets

The peerDependencies from package.json also need to be installed and to follow the same naming convention.

Usage

Solidity Contracts

This project contains base implementations and mocks for assets standards such as ERC20 (Fungible Token), ERC721 (Non-Fungible Token) and ERC1155 (Multi Token). Some utility contracts such as the necessary for Polygon bridging or vouchers redemption mechanics are also provided.

Import dependency contracts into your Solidity contracts and derive as needed:

import "@animoca/ethereum-contracts-assets/contracts/{{Contract Group}}/{{Contract}}.sol"

Please refer to inline documentation of each contract to get a glimpse of its purpose. The mocks are examples of how to implement fully-featured contracts.

Javascript Modules

A set of Javascript modules are also provided.

Require the NodeJS module dependency in your test and migration scripts as needed:

const { constants, interfaces, abis, behaviors } = require("@animoca/ethereum-contracts-assets");
  • constants: project-specific constants.
  • interfaces: ERC165 interfaces for supported standards.
  • abis: the ABIs for the supported interfaces.
  • behaviors: re-usable behavior functions which can be used to test contracts with a full coverage. Refer to mock test files for a guideline on how to test asset contracts using these behaviors.