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

@govtechsg/oa-token

v1.15.0

Published

My node module

Downloads

67

Readme

Open-Attestation Token

This library facilitates ERC721 Token interactions using OpenAttestation wrapped documents as token identifiers. EthersJS is heavily used in this library and unless otherwise stated all Ethereum-related interfaces are expected to be derived from EthersJS.

Install

    $ npm install @govtechsg/oa-token or yarn @govtechsg/oa-token

Initialize

    import { ReadOnlyToken, WriteableToken } from "@govtechsg/oa-token";
    const tokenInstance = new ReadOnlyToken({document: wrappedDocument});

Save Web3 Provider or Wallet

    import { WriteableToken, setWeb3Provider, setWallet } from "@govtechsg/oa-token";

    setWeb3Provider(provider)
    setWallet(wallet)

    const token = new WriteableToken({document}) // Don't need to provider wallet or provider again here

Get the owner of the contract

    await tokenInstance.getOwner();

returns a promise for a class instance that allows interaction with the owner of the token.

Types of Owners

EthereumAccountOwner

EthereumAccountOwner are simply objects with a .address property. This owner class is instantiated when the owner of the Token is simply an externally owned Ethereum Account - i.e, not a smart contract.

TitleEscrowOwner

TitleEscrowOwner is instantiated when the owner of the Token is a TitleEscrow smart contract, which governs the transfer of ownership according to UN/MLETR.

It allows the reading of the properties, holder and beneficiary.

Usage:

const tokenInstance = new ReadOnlyToken({document: wrappedDocument});
const tokenOwner = tokenInstance.getOwner()

if (tokenOwner.isTitleEscrow()) {
   const beneficiary = tokenOwner.beneficiary();
   const holder = tokenOwner.holder();

   console.log(
     `Token ID: ${
       Token.tokenId
     } is owned by TitleEscrow at ${tokenOwner.address}. Has beneficiary ${beneficiary} and held by ${holder}`
   );
 } else {
   console.log(`Token ID: ${Token.tokenId}, owned by ${tokenOwner.address}`);
}

WriteableTitleEscrowOwner

WriteableTitleEscrowOwner is the writeable extension of TitleEscrowOwner, it allows for calling the smart contract functions which change the state of the system, in addition to everything TitleEscrowOwner has.

It has the additional methods changeHolder(newHolder: EthereumAddress), endorseTransfer(newBeneficiary: EthereumAddress) , transferTo(newBeneficiary: EthereumAddress), mint(to: EthereumAddress).

There are also additional helper methods to make a transfer or mint to a new TitleEscrow contract transferToNewEscrow(beneficiary: EthereumAddress, holder: EthereumAddress) and mintToEscrow(beneficiary: EthereumAddress, holder: EthereumAddress). These methods first deploy a TitleEscrow contract then executes the transfer or mint function to that TitleEscrow's address.

These methods all return a promise that resolves to the transaction hash when the transaction has been confirmed.

Usage:

const writeableTokenInstance = new WriteableToken({document: wrappedDocument, web3Provider, wallet})
const tokenOwner = writeableTokenInstance.getOwner()

const transactionHash = await tokenOwner.changeHolder(newHolder);

Transfer the token ownership

Writeable token instance initialisation requires an EthersJS type wallet that has write permissions for that token.

    const writeableTokenInstance = new WriteableToken({document: wrappedDocument, web3Provider, wallet})
    await token.transferOwnership("NEW_OWNER_ADDRESS");

returns a transaction hash after the transaction has been mined.

Development

Logging

Turn on debugging by using the DEBUG environment variable for Node.js and using localStorage.debug in the browser.

E.g:

DEBUG="PLACEHOLDER_PROJECT_NAME:*" npm run dev

Commit message format

This boiler plate uses the semantic-release package to manage versioning. Once it has been set up, version numbers and Github release changelogs will be automatically managed. semantic-release uses the commit messages to determine the type of changes in the codebase. Following formalized conventions for commit messages, semantic-release automatically determines the next semantic version number, generates a changelog and publishes the release.

Use npm run commit instead of git commit in order to invoke Commitizen commit helper that helps with writing properly formatted commit messages.

API

Table of Contents

License

MIT © Sumit Chaudhari