Skip to content

Commit 8762f18

Browse files
committed
Update SDK and GPU container deployment documentation
1 parent 186bdd9 commit 8762f18

File tree

3 files changed

+53
-7
lines changed

3 files changed

+53
-7
lines changed

content/protocol-sdk/node-sdk-overview.mdx

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,14 @@ Install the Spheron SDK for Node.js using npm or yarn or bun:
3434
```
3535
</Tabs.Tab>
3636
</Tabs>
37+
38+
<Callout type="info">
39+
Note:
40+
- With the release of **v2.0.0**, the Spheron SDK now has **Mainnet support**. Upgrade if you're on an older version to deploy on Spheron Mainnet.
41+
- **Testnet usage is still available** for development, but requires running your own provider or Fizz Node.
42+
- **Coming soon:** the Spheron team will host public Testnet providers and Fizz Nodes for community use.
43+
</Callout>
44+
3745
## Usage
3846

3947
### Initializing the SDK
@@ -84,7 +92,9 @@ const sdk = new SpheronSDK({
8492
- `bundlerUrl`: URL for the bundler service
8593
- `paymasterUrl`: URL for the paymaster service
8694

87-
##### Using Gasless Transactions
95+
#### Using Gasless Transactions
96+
97+
We have implemented gasless transactions for the Spheron network. For now, we support coinbase and biconomy gasless transactions. You can create your own paymaster and bundler from coinbase or biconomy to do gasless transactions using the Spheron SDK.
8898

8999
If you're using gasless transactions (`gaslessOptions`), you need to:
90100

@@ -98,6 +108,24 @@ console.log('Smart Wallet Balance:', smartWalletDetails.balance);
98108

99109
2. Deposit funds into your smart wallet before making any deposits using `depositBalance`.
100110

111+
#### RPC Configuration
112+
113+
To ensure reliable Base Mainnet deployments, you should supply your own dedicated base mainnet RPC endpoint. Public base mainnet RPCs are rate-limited and can lead to failed or stalled deployments under load.
114+
115+
1. **Obtain a Custom RPC URL**
116+
117+
Choose any popular provider and create a free API key:
118+
- Alchemy: https://www.alchemy.com/base
119+
- Infura: https://docs.metamask.io/services/reference/base/
120+
- QuickNode: https://www.quicknode.com/docs
121+
122+
2. **What Happens If You Don't Provide One**
123+
124+
If no custom RPC is detected, we fall back to the public Base Mainnet RPC (https://mainnet.base.org).
125+
- **Risk:** Strict rate limits → HTTP 429 “Too Many Requests” or timeouts
126+
- **Impact:** Deployment failures or significant delays
127+
128+
**Best Practice:** Always configure a personal RPC endpoint to guarantee low latency, high throughput, and seamless deployments.
101129

102130
### Modules Overview
103131

content/rent-gpu/deploy-container/with-cli.mdx

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -89,16 +89,25 @@ sphnctl wallet balance --token uSPON
8989
**Note:** You can withdraw tokens from your unlocked balance at any time. However, if the tokens are in a locked state, you will not be able to withdraw them until you close your deployment. Upon closing, the locked tokens will be returned to the unlocked state after deducting provider charges and protocol fees.
9090
</Callout>
9191

92-
### Set the private Base Mainnet RPC WSS URL
92+
### Set the C Base Mainnet RPC WSS URL
9393

94-
Before deploying, you should set the private Base Mainnet RPC WSS URL by running the following command:
94+
To ensure reliable Base Mainnet deployments, you should supply your own dedicated base mainnet RPC endpoint. Public base mainnet RPCs are rate-limited and can lead to failed or stalled deployments under load.
95+
96+
1. **Obtain a Custom RPC URL**
97+
98+
Choose any popular provider and create a free API key:
99+
- Alchemy: https://www.alchemy.com/base
100+
- Infura: https://docs.metamask.io/services/reference/base/
101+
- QuickNode: https://www.quicknode.com/docs
102+
103+
2. **Set the Custom Base Mainnet RPC WSS URL**
104+
105+
Before deploying, you should set the Dedicated Base Mainnet RPC WSS URL by running the following command:
95106

96107
```sh
97108
sphnctl rpc set [private RPC URL]
98109
```
99110

100-
To get a RPC URL, you can create app on Alchemy or QuickNode or Infura or any other RPC provider and get the **Base Mainnet RPC URL** from there.
101-
102111
**Example:**
103112

104113
```sh

content/rent-gpu/protocol-cli.mdx

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -241,14 +241,23 @@ Token: uSPON, Precision: 6, TokenAddress: 0x24A05B480235Ccb450bf7Ce7e9F65072Ed73
241241

242242
## Setting Custom Base Mainnet RPC WSS URL
243243

244+
To ensure reliable Base Mainnet deployments, you should supply your own dedicated base mainnet RPC endpoint. Public base mainnet RPCs are rate-limited and can lead to failed or stalled deployments under load.
245+
246+
1. **Obtain a Custom RPC URL**
247+
248+
Choose any popular provider and create a free API key:
249+
- Alchemy: https://www.alchemy.com/base
250+
- Infura: https://docs.metamask.io/services/reference/base/
251+
- QuickNode: https://www.quicknode.com/docs
252+
253+
2. **Set the Custom Base Mainnet RPC WSS URL**
254+
244255
To set a custom Base Mainnet RPC WSS URL, you need to run this command:
245256

246257
```sh
247258
sphnctl rpc set wss://[RPC URL]
248259
```
249260

250-
To get a RPC URL, you can create app on Alchemy or QuickNode or Infura or any other RPC provider and get the **Base Mainnet RPC URL** from there.
251-
252261
**Example:**
253262

254263
```sh

0 commit comments

Comments
 (0)