Skip to content

Latest commit

 

History

History
35 lines (23 loc) · 1.37 KB

README.md

File metadata and controls

35 lines (23 loc) · 1.37 KB
Raw

🪙 Colony token contract bindings

Discord

@colony/tokens

This package contains pre-compiled Colony token contract bindings. They can be used to take advantage of the extra functionality of the Colony Tokens (e.g. minting via the Colony or gasless transactions). The getTokenClient function will try to auto-detect the token type at the given address and instantiates the corresponding token class.

import { providers } from 'ethers';
import { getTokenClient } from '@colony/tokens';
import { Tokens } from '@colony/core';

const provider = new providers.JsonRpcProvider(ColonyRpcEndpoint.ArbitrumOne);

// Immediately executing async function
(async function() {
   // Pass in a Signer instead to do transactions
   const token = await getTokenClient(Tokens.ArbitrumOne.CLNY, provider);
   // Only tokens deployed with Colony have the `locked()` method
   const tokenIsLocked = await token.locked();
})();

Building

To build this package, run pnpm run build in this directory. See the general development instructions for more information.

Contributing

All contributions are welcome. Please read the Contributing Guidelines and review our Code of Conduct before submitting a PR.

License

GPL-3.0