Skip to content

Commit 097cd51

Browse files
authored
Merge pull request #24 from storacha/feat/modify-gateway-docs
refactor(w3up-client): move auth'd gateways to a config note
2 parents 3820778 + 5531401 commit 097cd51

File tree

3 files changed

+89
-38
lines changed

3 files changed

+89
-38
lines changed

src/pages/referral-terms.md

+46-4
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,50 @@
11
# User Referral Program Terms and Conditions
22

33
## 1. Program Overview
4+
45
1.1. This Referral Program ("Program") allows individuals ("Referrers") to earn rewards (“Rewards”) by referring new users ("Referred Users") to Storacha.
56

6-
1.2. This Program also allows Referred Users to participate in a free trial (“Free Trial”) on Storacha.
7+
1.2. This Program also allows Referred Users to participate in a free trial (“Free Trial”) on Storacha.
78

8-
1.3. By participating in the Program, both Referrers and Referred Users agree to be bound by these Terms and Conditions (“Terms”) and the [Terms of Service](https://docs.storacha.network/terms/).
9+
1.3. By participating in the Program, both Referrers and Referred Users agree to be bound by these Terms and Conditions (“Terms”) and the [Terms of Service](https://docs.storacha.network/terms/).
910

1011
## 2. Participation Eligibility
12+
1113
### 2.1. Referrers:
14+
1215
Do not have to be current users to refer new users, but must sign up to Storacha to receive their referral Rewards
1316
Must comply with all platform [Terms of Service](https://docs.storacha.network/terms/)
1417

1518
### 2.2. Referred Users:
19+
1620
- Must be new to the platform
1721
- Cannot have previously held an account with Storacha
1822
- Must comply with all platform [Terms of Service](https://docs.storacha.network/terms/)
1923

2024
## 3. Reward Eligibility & Structure
25+
2126
### 3.1 Types of Rewards:
27+
2228
Two types of Rewards can be earned by participating the Program:
23-
- Storage credits (“Credits”) that can be applied to Lite/Medium or Business/Extra Spicy subscriptions
29+
30+
- Storage credits (“Credits”) that can be applied to Lite/Medium or Business/Extra Spicy subscriptions
2431
- Loyalty points (“Racha Points”)
2532

2633
### 3.2 Referrer Reward Eligibility:
34+
2735
A Referrer is eligible to receive Rewards if a successful referral (“Successful Referral”) which requires that the following conditions are met:
36+
2837
- Their Referred User signs up to Storacha (Lite/Medium tier or Business/Extra Spicy tier) using the referral link or code they provided AND
2938
- If their Referred User signs up for Lite/Medium, this Referred User has paid for at least two months of storage beyond their Free Trial (“Successful Lite Referral”) OR
3039
- If their Referred User signed up for Business/Extra Spicy, this Referred User has paid for at least one month of storage beyond their free trial (“Successful Business Referral”)
3140

3241
### 3.3 Referrer Rewards from a Successful Referral:
42+
3343
- For a Successful Lite Referral, the Referrer will receive 20 Credits and 20 Racha Points, subject to the restrictions outlined in Section 3.4
3444
- For a Successful Business Referral, the Referrer will receive 100 Credits and 100 Racha Points, subject to the restrictions outlined in Section 3.4
3545

3646
### 3.4 Referrer Reward restrictions:
47+
3748
- Referrer will only receive Credits if they have a Lite/Medium or Business/Extra Spicy plan at the time or referral
3849
- Total referral reward limit: 460 Credits
3950
- Up to 160 Credits for Lite/Medium tier referrals
@@ -42,19 +53,24 @@ A Referrer is eligible to receive Rewards if a successful referral (“Successfu
4253
- All Credits expire 12 months from date of issue
4354

4455
### 3.5 Free Trial and Rewards for Referred Users
56+
4557
Referred Users who sign up through a referral link/code qualify for the following free trial periods:
58+
4659
- Lite/Medium tier: 2-month free trial from signup date
4760
- Business/Extra Spicy tier: 1-month free trial from signup date
4861

4962
Eligibility for Racha Points:
63+
5064
- Lite/Medium subscribers: 20 Racha Points after paying for 2 months after the end of their Free Trial
5165
- Business/Extra Spicy subscribers: 100 Racha Points after paying for 1 month after the end of their Free Trial
5266

5367
### 3.6 Referred User Reward restrictions:
68+
5469
- If a Referred User cancels their subscription during their Free Trial, they will forfeit the remaining time on the Free Trial.
5570
- A Referred User cannot change their free subscription choice after it has been confirmed.
5671

5772
## 4. No Cash Value of Rewards
73+
5874
- Credits and Racha Points have no monetary value and cannot be exchanged for cash
5975
- Rewards are non-transferable, non-assignable, and cannot be sold or traded
6076
- Credits and Racha Points:
@@ -67,6 +83,7 @@ Eligibility for Racha Points:
6783
## 5. Participant Relationship Status
6884

6985
### 5.1. Independent Participation
86+
7087
- Participation in the Referral Program is voluntary and independent
7188
- Neither Program participation nor reward receipt creates or implies any:
7289
- Employment relationship
@@ -78,6 +95,7 @@ Eligibility for Racha Points:
7895
- Legal representation authority
7996

8097
### 5.2. Prohibited Activities
98+
8199
- Participants must not:
82100
- Represent themselves as Storacha, Inc. (“Company”) employees or official representatives
83101
- Make promises or commitments on behalf of the Company
@@ -86,14 +104,17 @@ Eligibility for Racha Points:
86104
- Enter into agreements on the Company's behalf
87105

88106
### 5.3. Scope of Relationship
107+
89108
- Participants act solely as independent promoters
90109
- The relationship is limited to Program participation under these terms
91110
- Participants have no authority to bind or represent the Company
92111
- The Company exercises no control over participants' methods of promotion beyond Program requirements
93112
- All Program activities are conducted at participant's own expense and risk
94113

95114
## 6. Prohibited Activities
115+
96116
The following activities are strictly prohibited:
117+
97118
- Self-referrals or creating multiple accounts
98119
- Using automated systems to generate referrals
99120
- Spamming or unauthorized advertising
@@ -104,7 +125,9 @@ The following activities are strictly prohibited:
104125
- Any prohibited activity listed in the [Terms of Service](https://docs.storacha.network/terms/)
105126

106127
## 7. Company Rights and Remedies
128+
107129
### 7.1. The Company reserves the right to:
130+
108131
- Monitor all Program activity for compliance
109132
- Investigate suspicious or potentially fraudulent activity
110133
- Delay or withhold Rewards pending investigation
@@ -114,14 +137,17 @@ The following activities are strictly prohibited:
114137
- Interpret and apply these terms at its sole discretion
115138

116139
### 7.2. In cases of suspected abuse or violation, the Company may:
140+
117141
- Immediately suspend all pending Rewards
118142
- Reverse previously awarded credits
119143
- Terminate user accounts
120144
- Seek recovery of fraudulently obtained Rewards
121145
- Take legal action if necessary
122146

123147
## 8. Reward Withholding and Clawback
148+
124149
The Company may withhold or rescind Rewards if:
150+
125151
- Either party violates these terms or the terms outlined in [Terms of Service](https://docs.storacha.network/terms/)
126152
- Suspicious patterns of activity are detected
127153
- Referred User fails to meet qualifying criteria
@@ -131,7 +157,9 @@ The Company may withhold or rescind Rewards if:
131157
- Referral activity violates any platform policies
132158

133159
## 9. Program Modifications
160+
134161
The Company may at any time:
162+
135163
- Change reward amounts or structure
136164
- Modify eligibility requirements
137165
- Adjust qualifying criteria
@@ -140,34 +168,44 @@ The Company may at any time:
140168
- Terminate the Program
141169

142170
## 10. Limitation of Liability
171+
143172
The Company is not responsible for:
173+
144174
- Technical failures affecting referral tracking
145175
- Lost or delayed Rewards due to system errors
146176
- Unauthorized access to referral codes
147177
- Third-party misuse of referral information
148178
- Tax implications of reward payments
149179

150180
## 11. No Representations, Warranties, or Guarantees
181+
151182
### 11.1 Program Participation
183+
152184
- Participation in the Program is voluntary and does not create any legal right, claim, or entitlement to Rewards
153185
- No guarantee is made regarding the continuous availability or operation of the Program
154186
- The Company makes no representations about potential earnings or benefits from Program participation
187+
155188
### 11.2 Technical Operation
189+
156190
- The Program is provided "as is" and "as available"
157191
- No warranty is made regarding:
158192
- Accuracy of referral tracking
159193
- Uninterrupted Program access
160194
- Error-free operation
161195
- Availability of specific Rewards
196+
162197
### 11.3 Legal Rights
198+
163199
- Participants expressly acknowledge that Rewards are discretionary benefits, not legal entitlements
164200
- No legal partnership, agency, or similar relationship is created through Program participation
165201
- Participants waive any right to claim damages related to:
166202
- Program changes or termination
167203
- Technical limitations or failures
168204
- Reward distribution timing
169205
- Verification processes
206+
170207
### 11.4 Discretionary Authority
208+
171209
- Notwithstanding any other provisions in these terms, the Company maintains absolute and sole discretion to withhold, delay, or rescind any reward for any reason whatsoever, including but not limited to:
172210
- Technical errors or malfunctions
173211
- Clerical or administrative errors
@@ -180,25 +218,29 @@ The Company is not responsible for:
180218
- No participant shall have any vested right or entitlement to receive Rewards, regardless of whether all apparent qualifying conditions have been met
181219

182220
## 12. Local Law Compliance and Tax Obligations
221+
183222
- The Program may not be available in all jurisdictions and is void where prohibited by law
184223
- Participants are solely responsible for determining their eligibility and ensuring compliance with all applicable local laws, regulations, and tax obligations
185224
- The Company may limit or restrict Program participation based on jurisdictional requirements
186225
- Any tax liabilities arising from Program participation or reward receipt are the sole responsibility of participants
187226
- The Company may require tax documentation before distributing Rewards and may report reward values to tax authorities as required by law
188227

189228
## 13. Finality of Decisions
229+
190230
- All Company decisions regarding the Program, including eligibility, Rewards, investigations, and disputes, are final and binding
191231
- The Company maintains sole discretion in all Program matters
192232
- Participants agree to accept all Company decisions without right of appeal
193233

194234
## 14. No Waiver
235+
195236
- The Company’s failure, delay, or partial exercise of any right, power, or remedy under these Terms or applicable law shall not operate as a waiver of that right, power, or remedy, nor shall it preclude any other or further exercise thereof
196237
- Any waiver must be expressly made in a written instrument signed by an authorized representative of the Company
197238
- A waiver of any provision of these Terms on one occasion does not constitute a waiver of the same or any other provision on any future occasion
198239

199240
## 15. Contact
241+
200242
Questions about the Program or these terms should be directed to our support team at [email protected]
201243

202244
## 16. Acceptance
203-
Participation in the Program constitutes acceptance of these Terms and Conditions and the [Terms of Service](https://docs.storacha.network/terms/).
204245

246+
Participation in the Program constitutes acceptance of these Terms and Conditions and the [Terms of Service](https://docs.storacha.network/terms/).

src/pages/w3cli.mdx

-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,6 @@ The DID for the new space will be printed to the console. It should look somethi
5959
did:key:z6MkixXechJLc3TWibQj9RN6AiFx8VoMY9HNB3Y97WcwK3fm
6060
```
6161

62-
6362
You can now run `w3 space ls` to show a list of your spaces:
6463

6564
```bash

src/pages/w3up-client.md

+43-33
Original file line numberDiff line numberDiff line change
@@ -51,41 +51,10 @@ If your account doesn't have a payment plan yet, you'll be prompted to select on
5151
await account.plan.wait();
5252
```
5353

54-
Spaces can be created using the `createSpace` client method. When creating a space, you can specify which Gateways are authorized to serve the content you upload. To achieve this, you must first establish a connection with the desired Gateway. This connection enables the client to publish the necessary delegations that grant the Gateway permission to serve your content.
55-
56-
If no Gateways are specified (`authorizeGatewayServices`), or if the `skipGatewayAuthorization` flag is not set, the client will automatically grant access to the [Storacha Gateway](https://github.com/storacha/freeway) to serve the content you upload to your space.
57-
58-
To configure other Gateways to serve the content you upload to your new space, follow these steps:
54+
Spaces can be created using the `createSpace` client method.
5955

6056
```js
61-
import * as UcantoClient from '@ucanto/client'
62-
import { HTTP } from '@ucanto/transport'
63-
import * as CAR from '@ucanto/transport/car'
64-
65-
// Connects to Storacha Freeway Gateway
66-
const storachaGateway = UcantoClient.connect({
67-
id: id,
68-
codec: CAR.outbound,
69-
channel: HTTP.open({ url: new URL('https://freeway.dag.haus') }),
70-
});
71-
```
72-
73-
Once connected to the Gateway, you can create a space:
74-
75-
```js
76-
const space = await client.createSpace("my-awesome-space", {
77-
account,
78-
authorizeGatewayServices: [storachaGateway],
79-
});
80-
```
81-
82-
If you want to ensure that no Gateway is authorized to serve the content of your space, you can use the `skipGatewayAuthorization` flag:
83-
84-
```js
85-
const space = await client.createSpace("my-awesome-space", {
86-
account,
87-
skipGatewayAuthorization: true,
88-
});
57+
const space = await client.createSpace("my-awesome-space", { account });
8958
```
9059

9160
Alternatively, you can use the `w3cli` command [`w3 space create`](https://github.com/storacha/w3cli#w3-space-create-name) for a streamlined approach.
@@ -110,6 +79,47 @@ Alternatively, you can use the `w3cli` command [`w3 space create`](https://githu
11079
await client.setCurrentSpace(space.did());
11180
```
11281

82+
5. **Authorized Gateways**
83+
84+
When creating a space, you can specify which Gateways are authorized to serve the content you upload. By default, if no other flags are set the client will automatically grant access to the [Storacha Gateway](https://github.com/storacha/freeway) to serve the content you upload to your space.
85+
86+
However, you can authorize other Storacha compliant gateways to serve content instead.
87+
88+
To achieve this, you must first establish a connection with the desired Gateway. This connection enables the client to publish the necessary delegations that grant the Gateway permission to serve your content.
89+
90+
To configure other Gateways to serve the content you upload to your new space, follow these steps:
91+
92+
```js
93+
import * as UcantoClient from '@ucanto/client'
94+
import { HTTP } from '@ucanto/transport'
95+
import * as CAR from '@ucanto/transport/car'
96+
97+
// Connects to Storacha Freeway Gateway
98+
const storachaGateway = UcantoClient.connect({
99+
id: id,
100+
codec: CAR.outbound,
101+
channel: HTTP.open({ url: new URL('https://freeway.dag.haus') }),
102+
});
103+
```
104+
105+
Once connected to the Gateway, you can create a space and authorize serving content from that gateway:
106+
107+
```js
108+
const space = await client.createSpace("my-awesome-space", {
109+
account,
110+
authorizeGatewayServices: [storachaGateway],
111+
});
112+
```
113+
114+
If you want to ensure that no Gateway is authorized to serve the content of your space, you can use the `skipGatewayAuthorization` flag:
115+
116+
```js
117+
const space = await client.createSpace("my-awesome-space", {
118+
account,
119+
skipGatewayAuthorization: true,
120+
});
121+
```
122+
113123
## Upload files
114124

115125
Now that you've created and provisioned a space, you're ready to upload files to Storacha!

0 commit comments

Comments
 (0)