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

registry-builder

v0.1.0

Published

Open source library for registry smart contracts

Downloads

1

Readme

registry-builder

*** DISCLAIMER: Current version contracts are not thoroughly tested or audited. Use at own risk ***

About

This library aims to be a readable and modular library for registries and TCR's. Ideally developers can use these contracts to deploy their TCR or use these contracts as an extension onto their personalized registry contract.

Setup

Install node modules:

$ npm install

Compile contracts:

$ npm run compile

Run tests:

$ npm run test

Using from ZeppelinOS

You can create a TCR instance using ZeppelinOS by linking to this EVM package. This will use the logic contracts already deployed to mainnet, kovan, ropsten, or rinkeby, reducing your gas deployment costs.

As an example, to create an instance of a registry using ZeppelinOS, run the following commands:

$ npm install -g zos
$ zos init YourProject
$ zos link registry-builder
$ zos push --network rinkeby
> Connecting to dependency registry-builder 0.1.0
$ zos create registry-builder/OwnedItemRegistry --network rinkeby --from $SENDER
> Instance created at ADDRESS

It is strongly suggested to use a non-default address (this is, not the first address in your node) as $SENDER.

Check out this example project for creating a more interesting full TCR instead of a basic owned item registry.

Contract Structure

Registry Interface

IRegistry.sol

interface IRegistry {
  function add(bytes32 data) public;
  function remove(bytes32 data) public;
  function exists(bytes32 data) public view returns (bool item);
}

Challenge Interface

IChallengeFactory.sol

interface IChallengeFactory {
  function create(address registry, address challenger, address applicant) returns (address challenge);
}

IChallenge.sol

interface IChallenge {
  // returns the address of the challenger
  function challenger() view returns (address);

  // returns true if the challenge has ended
  function close() public;

  // returns whether challenge has been officially closed
  function isClosed() public view returns (bool);

  // returns true if the challenge has passed
  // reverts if challenge has not been closed
  function passed() public view returns (bool);

  // @notice returns the amount of tokens the challenge must
  // obtain to carry out functionality
  function fundsRequired() public view returns (uint);

  // @dev returns amount to be rewarded to challenge winner
  function winnerReward() public view returns (uint);
}

Code Review

  • Notes on current state of this repository: https://docs.google.com/document/d/1vjaWW7izisc2QNlZEpti4BPh8yJTOGo3Wu9GNgaRI1A/
  • Feel free to create an Issue with review, questions, or concerns.