Skip to content

Commit

Permalink
Readme rewrites and node version bump (#480)
Browse files Browse the repository at this point in the history 
### Description

simplify and reduce number of examples. link to proper docs.

#### Other changes

try running tests on node 20


### Related issues

- Fixes #479

<!-- start pr-codex -->

---

## PR-Codex overview
This PR updates the `celocli` and `contractkit` packages to support
Node.js version 20, along with various improvements and clarifications
in the documentation.

### Detailed summary
- Updated `node` engine requirement in `package.json` to `>=18`.
- Changed CI workflow to use Node.js version 20.
- Revised `README.md` for `celocli` to reflect support for Node.js 20
and provide installation instructions.
- Updated `README.md` for `contractkit` with new installation
requirements and examples.
- Removed outdated warnings and documentation sections.

> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`

<!-- end pr-codex -->

---------

Co-authored-by: Leszek Stachowski <[email protected]>
  • Loading branch information
@aaronmgdr @shazarre
aaronmgdr and shazarre authored Dec 11, 2024
1 parent 1007890 commit b83d8c4
Show file tree
Hide file tree
Showing 6 changed files with 104 additions and 515 deletions.
6 changes: 6 additions & 0 deletions .changeset/orange-frogs-smile.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"@celo/celocli": patch
"@celo/contractkit": patch
---

Recommended node version is now node 20
4 changes: 2 additions & 2 deletions .github/workflows/ci.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,14 +52,14 @@ jobs:
steps:
- uses: actions/setup-node@v4
with:
node-version: '18'
node-version: '20'
- name: 'enable corepack for yarn'
run: sudo corepack enable yarn
- uses: actions/checkout@v4
# must call twice because of chicken and egg problem with yarn and node
- uses: actions/setup-node@v4
with:
node-version: '18'
node-version: '20'
cache: 'yarn'
- name: Restore node cache
uses: actions/cache@v4
Expand Down
279 changes: 27 additions & 252 deletions docs/sdk/contractkit/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,303 +6,78 @@ Celo's ContractKit is a library to help developers and validators to interact wi

ContractKit supports the following functionality:

- Connect to a node
- Access web3 object to interact with node's Json RPC API
- Interact with json RPC API
- Send Transaction with celo's extra fields: (feeCurrency)
- Simple interface to interact with CELO and cUSD
- Simple interface to interact with Celo Core contracts
- Utilities
- Build apps to interact with governance and staking

## User Guide

:::tip

You might not need the full ContractKit. Consider using `@celo/connect` which powers much of ContractKit such as building and sending Transactions, signing, etc, but does not give access to any celo Contract Wrappers. Or if a subset of Wrappers, setting the feeCurrency and account info is all your dapp needs consider replacing your imports of Contractkit with `@celo/contractkit/lib/mini-kit`

:::

## How we work

We are a GitHub-first team, which means we have a strong preference for communicating via GitHub.
Please use GitHub to:

🐞 [File a bug report](https://github.com/celo-org/developer-tooling/issues/new/choose)

💬 [Ask a question](https://github.com/celo-org/developer-tooling/discussions)

✨ [Suggest a feature](https://github.com/celo-org/developer-tooling/issues/new/choose)

🧑‍💻 [Contribute!](/CONTRIBUTING.md)

🚔 [Report a security vulnerability](https://github.com/celo-org/developer-tooling/issues/new/choose)

> [!TIP]
>
> Please avoid messaging us via Slack, Telegram, or email. We are more likely to respond to you on
> GitHub than if you message us anywhere else. We actively monitor GitHub, and will get back to you shortly 🌟
> You might not need the ContractKit. For new projects we recommened [viem](https://viem.sh/docs/chains/celo) or [web3](https://www.npmjs.com/package/web3) optionally with [our celo plugin](https://www.npmjs.com/package/@celo/web3-plugin-transaction-types).
### Getting Started

To install:
To install you will need Node.js v18.14.2. or greater. v20 reccomended.

```bash
npm install @celo/contractkit
// or
yarn add @celo/contractkit
```

You will need Node.js v18.14.2. or greater.
### Examples

To start working with contractkit you need a `kit` instance:

```ts
import { newKit } from '@celo/contractkit' // or import { newKit } from '@celo/contractkit/lib/mini-kit'
// Remotely connect to the Alfajores testnet
const kit = newKit('https://alfajores-forno.celo-testnet.org')
```

To access balances:

```ts
// returns an object with {lockedGold, pending, cUSD, cEUR, cREAL}

const balances = await kit.getTotalBalance()
const kit = newKit("https://alfajores-forno.celo-testnet.org")

// returns an object with {cUSD, cEUR, cREAL}
const balances = await miniKit.getTotalBalance()
```

If you don't need the balances of all tokens use the balanceOf method

```ts
const stableTokenWrapper = await kit.getStableToken(StableToken.cREAL)

const cRealBalance = stableTokenWrapper.balanceOf(accountAddress)
```

### Setting Default Tx Options

`kit` allows you to set default transaction options:
#### List Registered ValidatorGroups

```ts
import { newKit, CeloContract } from '@celo/contractkit/lib/mini-kit'

async function getKit(myAddress: string, privateKey: string) {
const kit = newKit('https://alfajores-forno.celo-testnet.org')
const validatorsContractWrapper = await kit.contracts.getValidators()
const validatorGroups = await validatorsContractWrapper.getRegisteredValidatorGroups()

// default from account
kit.defaultAccount = myAddress

// add the account private key for tx signing when connecting to a remote node
kit.connection.addAccount(privateKey)

// paid gas in celo dollars
await kit.setFeeCurrency('0x874069Fa1Eb16D44d622F2e0Ca25eeA172369bC1')

return kit
}
```

### Interacting with CELO & cUSD

Celo has two initial coins: CELO and cUSD (stableToken).
Both implement the ERC20 standard, and to interact with them is as simple as:
### Show locked Celo balance for account

```ts
// get the CELO contract
const celoToken = await kit.contracts.getGoldToken()
const lockedGoldContractWrapper = await kit.contracts.getLockedGold()

// get the cUSD contract
const stableToken = await kit.contracts.getStableToken()
const accountAddress = kit.defaultAccount
const summary = lockedGoldContractWrapper.getAccountSummary(accountAddress!)

const celoBalance = await celoToken.balanceOf(someAddress)
const cusdBalance = await stableToken.balanceOf(someAddress)
```

To send funds:

```ts
const oneGold = kit.connection.web3.utils.toWei('1', 'ether')
const tx = await goldToken.transfer(someAddress, oneGold).send({
from: myAddress,
})

const hash = await tx.getHash()
const receipt = await tx.waitReceipt()
```

If you would like to pay fees in cUSD, (or other cStables like cEUR, cUSD).

```ts
kit.setFeeCurrency('0x874069Fa1Eb16D44d622F2e0Ca25eeA172369bC1') // Default to paying fees in cUSD

const stableTokenContract = kit.contracts.getStableToken()

const tx = await stableTokenContract
.transfer(recipient, weiTransferAmount)
.send({ from: myAddress, gasPrice })

const hash = await tx.getHash()

const receipt = await tx.waitReceipt()
```

### Interacting with Core Contracts

There are many core contracts.

- AccountsWrapper
- AttestationsWrapper
- BlockchainParametersWrapper
- DoubleSigningSlasherWrapper
- DowntimeSlasherWrapper
- ElectionWrapper
- EpochRewardsWrapper
- Erc20Wrapper
- EscrowWrapper
- FreezerWrapper
- GasPriceMinimumWrapper
- GoldTokenWrapper
- GovernanceWrapper
- LockedGoldWrapper
- MultiSigWrapper
- ReserveWrapper
- SortedOraclesWrapper
- StableTokenWrapper
- ValidatorsWrapper

#### Wrappers Through Kit

When using the `kit` you can access core contracts like

`kit.contracts.get{ContractName}`

E.G. `kit.contracts.getAccounts()`, `kit.contracts.getValidators()`

#### Stand Alone Wrappers

You can also initialize contracts wrappers directly. They require a `Connection` and their contract:

```typescript
// MiniContractKit only gives access to a limited set of Contracts, so we import Multisig

import { newKit } from '@celo/contractkit/lib/mini-kit'
import { MultiSigWrapper } from '@celo/contractkit/lib/wrappers/MultiSig'
import { newMultiSig } from '@celo/abis/web3/MultiSig'

const miniKit = newKit('https://alfajores-forno.celo-testnet.org/')

// Alternatively import { Connection } from '@celo/connect'
// const connection = new Connection(web3)

const contract = newMultiSig(web3)

const multisigWrapper = new MultiSigWrapper(miniKit.connection, contract)
```

### Accessing web3 contract wrappers

`MiniContractKit` _does not provide access to the web3 contracts_

Some user might want to access web3 native contract wrappers.

To do so, you can:

```ts
const feeCurrencyWhitelist = await kit._web3Contracts.getContract(CeloContract.FeeCurrencyWhitelist)
```

We expose native wrappers for all Celo core contracts.

The complete list of Celo Core contracts is:

- Accounts
- Attestations
- BlockchainParameters
- DoubleSigningSlasher
- DowntimeSlasher
- Election
- EpochRewards
- ERC20
- Escrow
- FederatedAttestations
- FeeCurrencyWhitelist
- FeeHandler
- Freezer
- GasPriceMinimum
- GoldToken
- Governance
- LockedGold
- MentoFeeHandlerSeller
- UniswapFeeHandlerSeller
- MultiSig
- OdisPayments
- Random
- Registry
- Reserve
- SortedOracles
- StableToken
- StableTokenEUR
- StableTokenBRL
- Validators

This can also be found in `packages/sdk/contractkit/src/base.ts`

### A Note About Contract Addresses

Celo Core Contracts addresses, can be obtained by looking at the `Registry` contract.
That's how `kit` obtains them.

We expose the registry API, which can be accessed by:

```ts
const goldTokenAddress = await kit.registry.addressFor(CeloContract.GoldToken)
```

### Sending Custom Transactions

Celo transaction object is not the same as Ethereum's. There are three new fields present:

- feeCurrency (address of the ERC20 contract to use to pay for gas and the gateway fee)
- gatewayFeeRecipient (coinbase address of the full serving the light client's trasactions)
- gatewayFee (value paid to the gateway fee recipient, denominated in the fee currency)

:::note
The `gatewayFeeRecipient`, and `gatewayFee` fields are currently not used by the protocol.
:::
### More Information

This means that using `web3.eth.sendTransaction` or `myContract.methods.transfer().send()` should be avoided to take advantage of paying transaction fees in alternative currencies.
You can find more information about the ContractKit in the Celo docs at [https://docs.celo.org/developer-guide/contractkit](https://docs.celo.org/developer-guide/contractkit).

Instead, `kit` provides an utility method to send transaction in both scenarios. **If you use contract wrappers, there is no need to use this.**
## How we work

For a raw transaction:
We are a GitHub-first team, which means we have a strong preference for communicating via GitHub.
Please use GitHub to:

```ts
const tx = kit.sendTransaction({
from: myAddress,
to: someAddress,
value: oneGold,
})
const hash = await tx.getHash()
const receipt = await tx.waitReceipt()
```
🐞 [File a bug report](https://github.com/celo-org/developer-tooling/issues/new/choose)

When interacting with a web3 contract object:
💬 [Ask a question](https://github.com/celo-org/developer-tooling/discussions)

```ts
const celoNativeToken = await kit._web3Contracts.getGoldToken()
const oneGold = kit.connection.web3.utils.toWei('1', 'ether')
✨ [Suggest a feature](https://github.com/celo-org/developer-tooling/issues/new/choose)

const txo = await celoNativeToken.methods.transfer(someAddress, oneGold)
const tx = await kit.sendTransactionObject(txo, { from: myAddress })
const hash = await tx.getHash()
const receipt = await tx.waitReceipt()
```
🧑‍💻 [Contribute!](/CONTRIBUTING.md)

### More Information
🚔 [Report a security vulnerability](https://github.com/celo-org/developer-tooling/issues/new/choose)

You can find more information about the ContractKit in the Celo docs at [https://docs.celo.org/developer-guide/contractkit](https://docs.celo.org/developer-guide/contractkit).
> [!TIP]
>
> Please avoid messaging us via Slack, Telegram, or email. We are more likely to respond to you on
> GitHub than if you message us anywhere else. We actively monitor GitHub, and will get back to you shortly 🌟
### Debugging

Expand Down
Loading

0 comments on commit b83d8c4

Please sign in to comment.