You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+36-12Lines changed: 36 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,38 @@
1
-
# Valence Protocol TS Documentation
1
+
# Valence Protocol TS
2
2
3
-
This library was built to make it easier to build cross-domain applications in JS. It unites ecosystem-specific tooling, provides some helpful abstractions but gives you the flexibility to do anything more specific, and offers a configurable modal to manage connections across one or more domains you would like to support in your app.
3
+
Typescript libraries and multi-chain modal component created to simplify building cross-chain applications deployed with [Valence Protocol](https://github.com/timewave-computer/valence-protocol). These are the TS equivalent to [Valence Domain Clients](https://github.com/timewave-computer/valence-domain-clients) in Rust. The library supports Ethereum, Solana, and Cosmos.
4
4
5
-
Valence Protocol TS currently has support for these ecosystems:
5
+
Libraries are in their early stage. APIs subject to change.
6
6
7
-
1. Ethereum
8
-
2. Solana
9
-
3. Cosmos
7
+
For developer and deployment docs, see `docs` folder.
10
8
11
-
Libraries are in their early stage. APIs subject to change.
9
+
## Demo
10
+
11
+
12
+
13
+
Libraries are tree-shakeable, and can be configured to support only the chains and ecosystems the project needs.
14
+
15
+
Ecosystem-specific tooling is imported as a peer dependency, and `valence-protocol-ts` provides an optional, loose wrapper to abstract common operations. Signers and wallet info can be accessed with React hooks. Detailed explanation below.
@@ -49,7 +71,7 @@ With graz, you will also need to add a post-install script to generate chain inf
49
71
```
50
72
51
73
3. Define config.
52
-
Copy [these](https://github.com/timewave-computer/valence-protocol-ts/tree/next/apps/domain-clients-example/src/config/domainClientsConfig) config files as an example. Only include the domains you are interested in working with.
74
+
Use the [example app config files](https://github.com/timewave-computer/valence-protocol-ts/blob/main/apps/domain-clients-example/src/config/domainClientsConfig/domainClients.config.ts)as a template. Only include the domains and chains you would like to support in your project.
4. Wrap your app root in a `DomainModalProvider` and `ReactQueryProvider`and import css. For Next.js 14+, you will need to wrap the providers in a client component.
88
+
4. Wrap your app root in a `DomainModalProvider` and `ReactQueryProvider` For Next.js 14+, you will need to wrap the providers in a client component.
Copy file name to clipboardExpand all lines: docs/Development.md
+9-4Lines changed: 9 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,6 +25,15 @@ This repository is a [Turborepo](https://turbo.build/) monorepo managed with [pn
25
25
```
26
26
27
27
This will run the `build` pipeline for all packages and apps using Turborepo.
28
+
3.**Start project in Development mode:**
29
+
30
+
```sh
31
+
turbo dev
32
+
## or
33
+
turbo dev --filter @valence-protocol/domain-clients-example
34
+
```
35
+
36
+
This will start the main application in developer mode. If a package does not refresh, you can manually rebuild it with `turbo build --filter <PACKAGE_NAME>`
28
37
29
38
3.**Run linting:**
30
39
@@ -80,7 +89,3 @@ turbo dev
80
89
81
90
turbo dev --filter @valence-protocol/domain-clients-example
82
91
```
83
-
84
-
## Troubleshooting
85
-
86
-
Sometimes the dependencies get out of whack and you get errors that random config is missing or an import cant be found. `rm -rf node_modules && pnpm install && turbo dev` should resolve it.
0 commit comments