Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix/644 improve docs for colony sdk examples #647

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix/644 improve docs for colony sdk examples #647

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7ca996d
sdk: docs improvement
0x74h51N Feb 5, 2025
e6a3d65
changeset for docs imrpvement
0x74h51N Feb 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/wise-dragons-poke.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@colony/sdk": major
---

Docs improvement for run
30 changes: 21 additions & 9 deletions packages/sdk/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ Colony SDK also includes a variety of examples to get you up and building with C
## Quickstart

```javascript
import { providers } from 'ethers';
import { ColonyNetwork, toEth } from '@colony/sdk';
import { providers } from "ethers";
import { ColonyNetwork, toEth } from "@colony/sdk";

// If MetaMask is installed there will be an `ethereum` object on the `window`
// NOTE: Make sure MetaMask is connected to ArbitrumOne chain (use https://app.colony.io/public-rpc or see https://chainlist.org/chain/42161)
Expand All @@ -26,15 +26,15 @@ const provider = new providers.Web3Provider(window.ethereum);
// Get the MetaColony's CLNY funding in the root team (id 1)
const start = async () => {
// This will try to connect the page to MetaMask
await provider.send('eth_requestAccounts', []);
await provider.send("eth_requestAccounts", []);
// Create a new connection to the Colony Network contracts using the MetaMask "wallet"
const colonyNetwork = new ColonyNetwork(provider.getSigner());
// Connect to the MetaColony (this could be replaced with your own colony using `colonyNetwork.getColony(COLONY_ADDRESS)`)
const metaColony = await colonyNetwork.getMetaColony();
// Get the CLNY funding for the MetaColony (CLNY is it's native token)
const funding = await metaColony.getBalance();
// The funding will be in wei (x * 10^18), so we format into a readable string using the `toEth` function
alert('MetaColony balance is ' + toEth(funding) + ' CLNY');
alert("MetaColony balance is " + toEth(funding) + " CLNY");
};

start();
Expand All @@ -48,22 +48,34 @@ start();

We are using the [pnpm](https://pnpm.io/installation) version manager for this project. Please make sure to have a current version of it installed on your system.

First, clone this repo:
First, clone this repo:

```bash
git clone https://github.com/JoinColony/colonyJS.git
```

Go to the `sdk` package directory:
Go to the `root` directory:

```bash
cd colonyJS/packages/sdk
cd colonyJS
```

Then install all the required dependencies (this will install [ethers.js](https://docs.ethers.io/v5/) and [colonyJS](https://github.com/JoinColony/colonyJS) as well as some required development dependencies):
Run the bootstrap command to install dependencies, build the contractor package, and ensure frozen lockfile integrity:

```bash
pnpm bootstrap
pnpm install
```

Build the Colony packages (this will build all packages and also install [ethers.js](https://docs.ethers.io/v5/) along with some required development dependencies):

```bash
pnpm build
```

Go to the `sdk` package directory:

```bash
cd packages/sdk
```

Then you can run the examples:
Expand Down