-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
29 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,32 @@ | ||
# CIVE | ||
Cive is an interface for the Conflux Core Space, built on Viem. | ||
|
||
⚠️ Note: cive is currently in heavy development and may be unstable. The API is subject to change without prior notice. | ||
|
||
## Install | ||
|
||
```bash | ||
pnpm add cive | ||
``` | ||
|
||
|
||
## Usage | ||
|
||
```ts | ||
// 1. Import modules | ||
import { createPublicClient, http } from "cive"; | ||
import { mainnet } from "cive/chains"; | ||
|
||
// 2. Set up client | ||
const publicClient = createPublicClient({ | ||
chain: mainnet, | ||
transport: http(), | ||
}); | ||
|
||
// 3. consume an action | ||
const block = await publicClient.getBlock(); | ||
|
||
``` | ||
|
||
## Docs | ||
|
||
[Head to the documentation](https://cive.zyx.ee/) to read and learn more about cive. |