Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/weavedb/jots
Social Protocol powered by WeaveDB
https://github.com/weavedb/jots
ao arweave ethereum weavedb zkjson
Last synced: about 1 month ago
JSON representation
Social Protocol powered by WeaveDB
- Host: GitHub
- URL: https://github.com/weavedb/jots
- Owner: weavedb
- Created: 2024-05-28T23:33:04.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-06-04T22:21:17.000Z (7 months ago)
- Last Synced: 2024-06-05T00:02:35.527Z (7 months ago)
- Topics: ao, arweave, ethereum, weavedb, zkjson
- Language: JavaScript
- Homepage: https://jots.social
- Size: 2.86 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Jots Protocol
[Jots](https://jots.social) is a fully decentralized social protocol powered by [WeaveDB](https://github.com/weavedb/weavedb) on [AO](https://ao.arweave.dev).
## Setting Up Localnet
### 1. AO Localnet
```bash
git clone -b hotfix https://github.com/weavedb/ao-localnet.git
```
Make sure you have NodeJS v22 installed and generate Arweave wallets.
```bash
cd ao-localnet/wallets && ./generateAll.sh
```
Execute the following docker command to run [SCAR](https://github.com/MichaelBuhler/scar) (Arweave Explorer) too.
```bash
cd ../ && sudo docker compose --profile explorer up
```
Now you should have the following nodes running on your local computer.
- ArLocal - [localhost:4000](http://localhost:4000)
- AOS MU - [localhost:4002](http://localhost:4002)
- AOS SU - [localhost:4003](http://localhost:4003)
- AOS CU - [localhost:4004](http://localhost:4004)
- SCAR - [localhost:4006](http://localhost:4006)
In another terminal, go to the `seed` directory, and download a WASM binary.
```bash
cd ao-localnet/seed && ./download-aos-module.sh
```
Grant tokens to the generated wallets.
```bash
./seed-for-aos.sh
```
At this point, you could run `aos`, but it's not necessary unless interacting with WeaveDB from AOS.
```bash
cd ../aos && yarn && ./aos
```
### 2. WeaveDB / CosmWasm AO Units
Clone the `weavedb/cosmwasm-ao` repo, and install dependencies.
```bash
git clone https://github.com/weavedb/cosmwasm-ao.git
cd cosmwasm-ao && yarn
```
Create a `cwao.config.js` file,
```javascript
module.exports = {
ao:{
mu: "http://localhost:1992",
su: "http://localhost:1993",
cu: "http://localhost:1994",
cus: { "http://localhost:1993": "http://localhost:1994" },
arweave: { host: "localhost", port: 4000, protocol: "http" },
graphql: "http://localhost:4000/graphql",
type: "weavedb"
}
}
```
and `cwao.config.cosmwasm.js` file.
```javascript
module.exports = {
ao:{
mu: "http://localhost:1892",
su: "http://localhost:1893",
cu: "http://localhost:1894",
cus: { "http://localhost:1893": "http://localhost:1894" },
arweave: { host: "localhost", port: 4000, protocol: "http" },
graphql: "http://localhost:4000/graphql",
type: "cosmwasm"
}
}
```
Generate wallets.
```bash
yarn keygen admin -t ar && yarn addFund admin
yarn keygen scheduler -t ar && yarn addFund scheduler
yarn keygen scheduler_cwao -t ar && yarn addFund scheduler_cwao
yarn keygen bundler -t ar && yarn addFund bundler
yarn keygen rdk_admin
```
Start WeaveDB AO units.
```bash
yarn start admin
```
- WeaveDB MU - [localhost:1992](http://localhost:1992)
- WeaveDB SU - [localhost:1993](http://localhost:1993)
- WeaveDB CU - [localhost:1994](http://localhost:1994)
In another terminal, start CosmWasm AO units.
```bash
cd cosmwasm-ao && yarn start admin --config cwao.config.cosmwasm.js
```
- CosmWasm MU - [localhost:1892](http://localhost:1892)
- CosmWasm SU - [localhost:1893](http://localhost:1893)
- CosmWasm CU - [localhost:1894](http://localhost:1894)
In another terminal, add the WeaveDB module to AO.
```bash
yarn addModule admin
```
Add the CWAO20 module to AO.
```bash
yarn addModule admin --type cwao20 --config cwao.config.cosmwasm.js
```
Set up the schedulers.
```bash
yarn setScheduler scheduler --url "http://localhost:1993"
yarn setScheduler scheduler_cwao --url "http://localhost:1893"
```
Take notes of the `MODULE_ID` and the `SCHEDULER_ID` returned from these commands.
Deploy CWAO20 token.
```bash
yarn deployCWAO20 admin --config cwao.config.cosmwasm.js \
--module MODULE_ID --scheduler SCHEDULER_ID --mint 10000
```
### 3. WeaveDB Rollup Node
Clone the `weavedb/rdk` repo, and install dependencies.
```bash
git clone https://github.com/weavedb/rdk.git && cd rdk
```
Run Envoy to establish GRPC communications between the web browser and the local node.
```bash
yarn envoy
```
In another terminal prepare to run the WeaveDB node.
```bash
cd node/node-server && yarn
```
Create a `weavedb.config.js` file.
Copy the `privateKey` of `rdk_admin` at `cosmwasm-ao/.weavedb/accounts/evm/rdk_admin.json` from the previous step to the `admin` field.
Copy the entire JSON object of `bundler` at `cosmwasm-ao/.weavedb/accounts/ar/bundler.json` from the previous step to the `bundler` field.
```javascript
module.exports = {
dbname: "weavedb",
admin: "0x...",
bundler: { kty: "RSA", ... },
rollups: {},
ao:{
mu: "http://localhost:1992",
su: "http://localhost:1993",
cu: "http://localhost:1994",
arweave: { host: "localhost", port: 4000, protocol: "http" },
graphql: "http://localhost:4000/graphql",
}
}
```
Start the node.
```bash
node index.js
```
In another terminal, start the WeaveDB Explorer.
```bash
cd rdk/explorer && yarn && yarn dev --port 3001
```
Now the explorer is running at [localhost:3001/node/localhost](http://localhost:3001/node/localhost).
### 4. Setting up WeaveDB Instance
Clone the `weavedb/jots` repo, and install dependencies.
```bash
git clone https://github.com/weavedb/jots.git
cd jots/db && yarn
```
Create a `weavedb.config.js` file. Again, copy the `privateKey` from `rdk_admin`
```javascript
module.exports = {
db: {
app: "http://localhost:3000",
name: "Jots",
rollup: true,
plugins: { notifications: {} },
tick: 1000 * 60 * 5,
},
accounts: {
evm: {
admin: {
privateKey:
"0x...",
},
},
ar: {},
},
defaultNetwork: "localhost",
networks: {
localhost: { url: "localhost:8080", admin: "admin" },
},
}
```
Generate necessary EVM wallets.
```bash
yarn keygen owner_l1
yarn keygen owner_l2
yarn keygen relayer
```
Instantiate a WeaveDB instance for Jots.
`owner_l1` is for L1 admin queries, and `owner_l2` is for L2 admin queries. We need 2 owners to avoid nonce collisions between L1 and L2.
```bash
yarn deploy jots \
--module MODULE_ID --scheduler SCHEDULER_ID --owner_l1 owner_l1 --owner_l2 owner_l2
```
Set up the Jots DB instance.
```bash
yarn setup jots --owner_l2 owner_l2 --relayer relayer
yarn setup jots --owner_l2 owner_l2 --relayer relayer --plugin notifications
```
Initialize Jots with the genesis `user`.
The genesis user will have 100 invites, that can be sent via the frontend dapp.
```bash
yarn initialize jots --owner_l2 owner_l2 --user USER_EVM_ADDRESS
```
### 5. Start Frontend Jots Dapp
Install dependencies.
```bash
cd jots/app && yarn
```
Create a `.env.local` file.
```bash
NEXT_PUBLIC_EXPLORER="http://localhost:3001/node/localhost/db/jots"
NEXT_PUBLIC_RPC="http://localhost:8080"
NEXT_PUBLIC_MODE="open"
RPC="localhost:8080"
NEXT_PUBLIC_TXID=""
GCS_BUCKET="xyz.appspot.com"
GCS_PROJECT_ID="xyz"
GCS_EMAIL="[email protected]"
GCS_PRIVATE_KEY=""
RELAYER_PRIVATE_KEY="xyz"
```
Run the app.
```bash
yarn dev
```
Now `Jots` is running at [localhost3000](http://localhost:3000).
### 6. Deploy zkJSON Solidity Contract on Ethereum Testnet
coming soon...