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.

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

Add Stargaze Documentation #286

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
100 changes: 100 additions & 0 deletions docs/chains/stargaze-chain/stargaze-dev.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
---
slug: /stargaze-dev
title: Getting Stargaze RPC
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Getting Stargaze RPC


## [Gateway](https://gateway.lavanet.xyz/?utm_source=stargaze-dev&utm_medium=docs&utm_campaign=docs-to-gateway)

To learn more about using the Lava Gateway visit the [Getting Started guide](https://docs.lavanet.xyz/gateway-getting-started?utm_source=stargaze-dev&utm_medium=docs&utm_campaign=docs-to-docs)

## [SDK](https://github.com/lavanet/lava-sdk)

:::caution

Please observe the documentation on both [frontend](https://docs.lavanet.xyz/sdk-frontend?utm_source=getting-stargaze-rpc&utm_medium=docs&utm_campaign=docs-to-docs) and [backend](https://docs.lavanet.xyz/sdk-backend?utm_source=getting-stargaze-rpc&utm_medium=docs&utm_campaign=docs-to-docs) use before getting started.

:::

### Input 📥

<Tabs>

<TabItem value="backend" label="BackEnd">

```jsx
// Install lavaSDK with the following command:
// npm i @lavanet/lava-sdk
const { LavaSDK } = require("@lavanet/lava-sdk")

async function useStargaze() {

const stargaze = await LavaSDK.create({
privateKey: process.env.PRIVATE_KEY, //hide your private key in an environmental variable
chainIds: "STRGZ",
rpcInterface: "rest",
geolocation: "2"
});

const stargazeBlockResponse = await stargaze.sendRelay({
method: "GET",
url: "/node_info",
rpcInterface: "rest",
});


console.log(stargazeBlockResponse);
}

(async () => {
await useStargaze();
})();
```

</TabItem>
<TabItem value="frontend" label="FrontEnd">

```jsx
// Install lavaSDK with the following command:
// npm i @lavanet/lava-sdk
const { LavaSDK } = require("@lavanet/lava-sdk")

async function useStargaze() {

const stargaze = await LavaSDK.create({
badge: {
badgeServerAddress: "https://badges.lavanet.xyz", // Or your own Badge-Server URL
projectId: "enter_your_project_id_here"
},
chainIds: "STRGZ",
rpcInterface: "rest",
geolocation: "2"
});

const stargazeBlockResponse = await stargaze.sendRelay({
method: "GET",
url: "/node_info",
rpcInterface: "rest",
});


console.log(stargazeBlockResponse);
}

(async () => {
await useStargaze();
})();
```

</TabItem>

</Tabs>

To learn more about our SDK visit the [Getting Started guide](https://docs.lavanet.xyz/sdk-getting-started?utm_source=getting-stargaze-rpc&utm_medium=docs&utm_campaign=docs-to-docs)

<hr />
60 changes: 60 additions & 0 deletions docs/chains/stargaze-chain/stargaze-node.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
slug: /stargaze-node
title: Running a Stargaze RPC Node
---

# Running a Stargaze RPC Node

## Requirements 📄


### Hardware Requirements 💻


- 8 Cores (modern CPU)
- 16GB RAM
- 1TB of storage (SSD or NVME)


### Software Requirements 🔢

- Modern Linux and/or recent MacOS
- Go >= 1.20

## Install Dependencies 📦

### 📥 Install Preqrequisite packages

Some build tools may be needed for successful install. Update your OS and grab the essential build tools:

```bash
sudo apt-get update && sudo apt upgrade -y
sudo apt-get install make build-essential gcc git jq chrony -y
```

### 📥 Install Stargaze Client


Retrieve `<version-tag>` from [latest releases](https://github.com/public-awesome/stargaze/releases).

Run the following commands:

```bash
git clone https://github.com/public-awesome/stargaze
cd stargaze
git fetch
git checkout <version-tag>

make install
```

## Initialize and Configure the Node ⚙️

There are many steps required for setting up a node.

A detailed step-by-step guide is available in the official [Stargaze documentation](https://docs.stargaze.zone/nodes-and-validators/joining-mainnet).


## Setup your Provider on Lava Network 🌋

To set up your provider on the Lava Network, you can refer to the [provider setup documentation](https://docs.lavanet.xyz/provider-setup?utm_source=running-a-stargaze-rpc-node&utm_medium=docs&utm_campaign=stargaze-pre-grant) available elsewhere in our docs. This should provide you with the necessary information to configure and operate your provider process.
77 changes: 77 additions & 0 deletions docs/chains/stargaze-chain/stargaze.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
---
slug: /stargaze
title: Stargaze x Lava
---

import RoadmapItem from '@site/src/components/RoadmapItem'

<center>

![Filecoin Logo](/img/chains/stargaze_logo.svg)

</center>

[<RoadmapItem icon="⛏️" title="Get RPC" description="Get access to Lava's Web3 APIs and start building on the network with ease"/>](/stargaze-dev)

[<RoadmapItem icon="🚀" title="Run an RPC Node" description="Become a part of Lava's network by running your own RPC node and accessing Web3 APIs seamlessly"/>](/stargaze-node)

<hr />
<br />

<center>

## ⚙️ Supported APIs ⚙️

</center>

### Specification 📑

https://raw.githubusercontent.com/lavanet/lava/main/cookbook/specs/spec_add_stargaze.json


### Protocols 🔗

| Platform | gRPC | rest/http | tendermint/wss | tendermint | webgRPC |
| --------- |------|-----------|----------------|------------|---------|
| Gateway | ✅ | ✅ | ✅ | ✅ | ✅ |
| SDK | | ✅ | ✅ | ✅ | |



### Methods 🛠️
<details>
<summary> REST </summary>

- /stargaze/globalfee/v1/contract_authorization/{contract_address}
- /stargaze/globalfee/v1/code_authorization/{code_id}
- /stargaze/tokenfactory/v1/denoms_from_creator/{creator}
- /stargaze/tokenfactory/v1/denoms/{denom}/authority_metadata
- /stargaze/mint/v1beta1/params
- /stargaze/mint/v1beta1/annual_provisions
- /stargaze/cron/v1/list-privileged
- /stargaze/claim/v1beta1/total_claimable/{address}
- /stargaze/claim/v1beta1/params
- /stargaze/claim/v1beta1/module_account_balance
- /stargaze/claim/v1beta1/claimable_for_action/{address}/{action}
- /stargaze/claim/v1beta1/claim_record/{address}
- /stargaze/alloc/v1beta1/params

</details>

<details>
<summary> gRPC </summary>

- publicawesome.stargaze.globalfee.v1.Query/CodeAuthorization
- publicawesome.stargaze.mint.v1beta1.Query/AnnualProvisions
- publicawesome.stargaze.globalfee.v1.Query/Params
- publicawesome.stargaze.mint.v1beta1.Query/Params
- publicawesome.stargaze.cron.v1.Query/ListPrivileged
- publicawesome.stargaze.alloc.v1beta1.Query/Params
- osmosis.tokenfactory.v1beta1.Query/Params
- osmosis.tokenfactory.v1beta1.Query/DenomAuthorityMetadata
- publicawesome.stargaze.cron.v1.Query/Params
- osmosis.tokenfactory.v1beta1.Query/DenomsFromCreator
- publicawesome.stargaze.globalfee.v1.Query/ContractAuthorization
- publicawesome.stargaze.globalfee.v1.Query/Authorizations

</details>
15 changes: 15 additions & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -297,6 +297,21 @@ const sidebars = {
'chains/starknet-chain/starknet-dev',
'chains/starknet-chain/starknet-node'
]
},
{
type: 'category',
label: '🔗 Stargaze',
collapsible: true,
collapsed: true,
description: 'STRGZ, STRGZT',
link: {
type: 'doc',
id: 'chains/stargaze-chain/stargaze'
},
items: [
'chains/stargaze-chain/stargaze-dev',
'chains/stargaze-chain/stargaze-node'
]
}
]
},
Expand Down
16 changes: 16 additions & 0 deletions static/img/chains/stargaze_logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.