https://github.com/JoinColony/colonyJS

🎪 Colony TypeScript libraries
https://github.com/JoinColony/colonyJS

api blockchain colony dapp ethereum ethersjs web3

Last synced: 3 months ago
JSON representation

🎪 Colony TypeScript libraries

• Host: GitHub
• URL: https://github.com/JoinColony/colonyJS
• Owner: JoinColony
• License: gpl-3.0
• Created: 2017-11-28T03:43:42.000Z (almost 7 years ago)
• Default Branch: main
• Last Pushed: 2024-04-25T18:18:33.000Z (7 months ago)
• Last Synced: 2024-05-02T00:21:49.198Z (6 months ago)
• Topics: api, blockchain, colony, dapp, ethereum, ethersjs, web3
• Language: TypeScript
• Homepage:
• Size: 33.7 MB
• Stars: 91
• Watchers: 13
• Forks: 24
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• DeFi-Developer-Road-Map - ColonyJS - JavaScript client that provides an API for interacting with the Colony Network smart contracts. (Roadmap)

README

        
🎪 Colony TypeScript libraries

[![Discord](https://img.shields.io/discord/562263648173555742)](https://discord.gg/feVZWwysqM)

# The Colony TypeScript libraries

We are providing the following packages in this monorepo:

* [`@colony/sdk`](packages/sdk) - The development kit to build on top of Colony

* [`@colony/colony-js`](packages/colony-js) - The Colony TypeScript reference implementation

* [`@colony/core`](packages/core) - Shared utilities, types and constants for all Colony TypeScript libraries

* [`@colony/contractor`](packages/contractor) - A nifty tool that creates Colony Network TypeScript bindings

* [`@colony/events`](packages/events) - All Colony event types in one! Parse and serialize Colony event metadata

* [`@colony/tokens`](packages/tokens) - Pre-built Colony token contract bindings

## Developing

To start development on any of the included libraries, make sure you have Node v16.x and [`pnpm`](https://pnpm.io) v8.x installed.

Run `pnpm run bootstrap` first

To install all required dependencies run `pnpm run bootstrap` (this is important!) the first time, later you can just do `pnpm install --frozen-lockfile` in the root directory of the repository.

You can run `pnpm lint`, `pnpm typecheck`, `pnpm test` and `pnpm build` in the root directory (will build all packages) or in the individual package directories.

**Please make sure to include a [changeset](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md) when submitting a PR.**

## Creating a main release

colonyJS is using [changesets](https://github.com/changesets/changesets) to create releases. Here's the workflow:

1) Create a PR and add a [changeset](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md) within the PR

2) Have the PR reviewed and merged into `main`

3) `changesets` will create a release PR which collects all changes that have been merged since the last release

4) This PR can be merged at any point to then create a new main release

## Creating a snapshot (development) release

1) Push your desired changes to a new branch (**do not forget to add a changeset - see above**)

2) Use the "Release a snapshot" action under "Actions"

  ![image](https://github.com/JoinColony/colonyJS/assets/2174084/0961174c-fee0-417f-a0d8-8fc286e4fa2d)

4) Pick your branch that you would like to release a snapshot from

  ![image](https://github.com/JoinColony/colonyJS/assets/2174084/365ab525-3b36-472e-9f73-56557fc8812d)

5) The snapshot release will be available in npm under `0.0.0-next-TIMESTAMP` or `@snapshot`

## Contributing

All contributions are welcome. Please read the [Contributing Guidelines](CONTRIBUTING.md) and review our [Code of Conduct](CODE_OF_CONDUCT.md) before submitting a PR.

## License

GPL-3.0