Skip to content

Commit b2b2349

Browse files
readme: remove official integration section (#407)
* readme: remove official integration section Official integration is no longer offered. Replace with self-host focused "Getting Started" section. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * docs, ct_dashboard: remove official integration references Remove official integration mentions from docs_web and customer dashboard sign-in form since the program is discontinued. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * docs: update docs for self-hosting-only model - Remove all "official integration" and partnership references - Replace Google-only auth mentions with all 6 supported providers (Google, email, GitHub, X, Discord, Telegram) - Remove demo.oko.app hosted links, point to local demo_web - Add sdk_endpoint self-hosting configuration to all SDK guides - Remove API key setup section that assumed hosted dashboard - Update API reference auth docs to be provider-agnostic - Mark Telegram as supported (no longer "coming soon") Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * ct_dashboard: fix biome format error (trailing blank line) Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 21d7075 commit b2b2349

16 files changed

Lines changed: 70 additions & 135 deletions

README.md

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -25,18 +25,10 @@ Everything is fully open source and Apache-2.0 licensed:
2525
- Modular Architecture: Orchestrator, adaptors, MPC services, and signing logic
2626
are self-hostable and auditable.
2727

28-
## Integration and Support
28+
## Getting Started
2929

30-
- Official Integration: Access enterprise-grade key share infrastructure,
31-
dedicated monitoring and operational support, and comprehensive Dapp Dashboard
32-
and User Dashboard interfaces.
33-
34-
- Self-Host (Open Source): Utilize the Apache 2.0 components for complete
35-
architectural control and customization.
36-
37-
To accelerate Official Integration, submit
38-
[the form](https://form.typeform.com/to/MxrBGq9b) and you’ll receive the next
39-
step by email.
30+
All components are Apache 2.0 licensed and designed to be self-hosted, giving
31+
you complete architectural control and customization.
4032

4133
[Demo](https://demo.oko.app) | [Docs](https://docs.oko.app)
4234

apps/customer_dashboard/src/components/sign_in_form/sign_in_form.module.scss

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -67,25 +67,6 @@
6767
}
6868
}
6969

70-
.betaSection {
71-
background: var(--bg-secondary);
72-
border-radius: 16px;
73-
padding: 16px;
74-
margin-top: 20px;
75-
text-align: center;
76-
}
77-
78-
.betaText {
79-
margin: 0 0 12px 0;
80-
}
81-
82-
.earlyAccessLink {
83-
text-decoration: underline;
84-
85-
&:hover {
86-
text-decoration: none;
87-
}
88-
}
8970

9071
@media (max-width: 480px) {
9172
.topHeader {

apps/customer_dashboard/src/components/sign_in_form/sign_in_form.tsx

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -87,17 +87,6 @@ export const SignInForm: FC = () => {
8787
Forgot password?
8888
</Typography>
8989
</Link>
90-
91-
<div className={styles.betaSection}>
92-
<Typography
93-
size="sm"
94-
weight="medium"
95-
color="tertiary"
96-
className={styles.betaText}
97-
>
98-
Start your official integration to unlock all dashboard features!
99-
</Typography>
100-
</div>
10190
</Card>
10291
);
10392
};

apps/docs_web/docs/v0/api-reference/api-overview.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@ sidebar_position: 1
55

66
# API Overview
77

8-
These APIs allow your dApp to check user existence and handle sign-in via Google
9-
with Oko.
8+
These APIs allow your dApp to check user existence and handle sign-in with Oko.
109

1110
## Service Endpoints
1211

@@ -20,15 +19,15 @@ and transaction signing:
2019

2120
### `POST /tss/v1/user/signin`
2221

23-
Sign in a user via Google OAuth. This endpoint will return an authentication
22+
Sign in a user via a supported social login provider. This endpoint will return an authentication
2423
token and related metadata on success.
2524

2625
#### Request
2726

2827
- **Method**: `POST`
2928
- **Path**: `/tss/v1/user/signin`
30-
- **Headers**: `Authorization: Bearer <Google ID Token>` (The token should be
31-
issued via Google Sign-In)
29+
- **Headers**: `Authorization: Bearer <ID Token>` (The token should be
30+
issued by the chosen auth provider: Google, email, GitHub, X, Discord, or Telegram)
3231

3332
#### Response
3433

@@ -217,7 +216,7 @@ Update wallet key share nodes for resharing after unrecoverable data loss.
217216

218217
- **Method**: `POST`
219218
- **Path**: `/tss/v1/user/reshare`
220-
- **Headers**: `Authorization: Bearer <Google ID Token>`
219+
- **Headers**: `Authorization: Bearer <ID Token>`
221220
- **Body**:
222221

223222
```json
@@ -280,17 +279,17 @@ Examples of signing transactions:
280279

281280
## Authentication
282281

283-
### Google OAuth Flow
282+
### Social Login Flow
284283

285284
From `backend/tss_api/src/routes/user.ts`:
286285

287286
**Sign-in endpoint:**
288287

289288
```
290289
POST /tss/v1/user/signin
291-
- Initiates Google OAuth authentication
290+
- Initiates social login authentication
292291
- Returns JWT token and user information for subsequent API calls
293-
- Requires Google OAuth token in Authorization header
292+
- Requires ID token from the chosen auth provider in Authorization header
294293
```
295294

296295
**User verification:**
@@ -315,7 +314,7 @@ POST /tss/v1/user/signin_silently
315314
```
316315
POST /tss/v1/user/reshare
317316
- Updates wallet key share nodes after unrecoverable data loss
318-
- Requires Google OAuth token and reshared key shares
317+
- Requires auth provider ID token and reshared key shares
319318
```
320319

321320
### JWT Token Usage
@@ -342,7 +341,7 @@ From `backend/tss_api/src/routes/`:
342341
```
343342
POST /tss/v1/keygen
344343
Content-Type: application/json
345-
Headers: Authorization: Bearer <Google ID Token>
344+
Headers: Authorization: Bearer <ID Token>
346345
347346
Purpose: Create distributed key shares and wallet entities
348347
Implementation: Coordinates threshold key generation protocol
@@ -699,17 +698,17 @@ Example API testing commands:
699698
```bash
700699
# Test TSS authentication
701700
curl -X POST http://localhost:4200/tss/v1/user/signin \
702-
-H "Authorization: Bearer <google-oauth-token>"
701+
-H "Authorization: Bearer <id-token>"
703702

704703
# Test email check
705704
curl -X POST http://localhost:4200/tss/v1/user/check \
706705
-H "Content-Type: application/json" \
707706
-d '{"email": "user@example.com"}'
708707

709-
# Test key generation (requires Google OAuth token)
708+
# Test key generation (requires ID token from auth provider)
710709
curl -X POST http://localhost:4200/tss/v1/keygen \
711710
-H "Content-Type: application/json" \
712-
-H "Authorization: Bearer <google-oauth-token>" \
711+
-H "Authorization: Bearer <id-token>" \
713712
-d '{...}'
714713
```
715714

apps/docs_web/docs/v0/architecture.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ security, while eliminating the need to manage complex private keys themselves.
7676
### 🚀 Better User Experience
7777

7878
- **No browser extensions** - embedded directly in your application
79-
- **Google OAuth login** - familiar authentication flow for mainstream users
79+
- **Social login (Google, email, GitHub, X, Discord, Telegram)** - familiar authentication flow for mainstream users
8080
- **Cross-device compatibility** - works on mobile, desktop, any browser
8181
- **Seamless onboarding** - users don't need to learn about seed phrases or
8282
hardware wallets
@@ -189,7 +189,7 @@ console.log("Connected:", okoSvm.publicKey?.toBase58());
189189

190190
- Wallet UI runs in secure iframe context
191191
- Key shares stored in separate, encrypted databases
192-
- Authentication handled through Google OAuth
192+
- Authentication handled through social login providers (Google, email, GitHub, X, Discord, Telegram)
193193

194194
**Data Protection:**
195195

apps/docs_web/docs/v0/getting-started/integration-overview.md

Lines changed: 7 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -9,54 +9,23 @@ Oko can be used alongside existing wallet connection methods, including the
99
Keplr browser extension and mobile app.
1010

1111
Integration is simple. Just add social login to your onboarding flow and you're
12-
ready to go. We support Google, email, GitHub, X, and Discord login. Telegram support is coming soon.
13-
We also plan to allow users to connect wallets they already have installed, such
14-
as Keplr and MetaMask.
12+
ready to go. We support Google, email, GitHub, X, Discord, and Telegram login.
13+
## Getting Started
1514

16-
## Integration Options
15+
All Oko components are Apache 2.0 licensed and designed to be self-hosted,
16+
giving you complete architectural control and customization.
1717

18-
Oko can be adopted in two ways. Both paths are fully supported depending on the
19-
needs of your application.
20-
21-
### 1. Self Host (Open source)
22-
23-
Use Oko’s Apache 2.0 licensed components to deploy and operate your own wallet
18+
Use Oko's open source components to deploy and operate your own wallet
2419
infrastructure. This path is ideal for teams that want:
2520

2621
- Full architectural control
2722
- On-premise deployment
2823
- The ability to customize key management, signing, and login flows
2924

30-
If youre planning to run it yourself, check out our
25+
If you're planning to run it yourself, check out our
3126
[self hosting guide](../standalone/self-hosting-standalone.md) for a detailed
3227
walkthrough.
3328

34-
### 2. Official Integration
35-
36-
Teams seeking enterprise grade key share infrastructure and dedicated
37-
operational support can choose official integration. This option provides:
38-
39-
- Enterprise grade key share infrastructure
40-
- Monitoring and operational support
41-
- Access to the Oko Dapp Dashboard and User Dashboard
42-
43-
If you want to explore this option, submit
44-
[this form](https://form.typeform.com/to/MxrBGq9b). Next steps will be shared by
45-
email.
46-
47-
## Get Started with Official Integration
48-
49-
Once you submit [this form](https://form.typeform.com/to/MxrBGq9b), we will send
50-
you a temporary password via email to access
51-
the [Oko dApp Dashboard](https://dapp.oko.app). Use the email address you
52-
provided in the form as your login ID. When you sign in for the first time,
53-
you'll receive a verification code via email. Enter the code to proceed, and
54-
you'll be prompted to set a new password.
55-
56-
At the time of login, you should be able to see the API key that has already
57-
been issued to you. Detailed setup instructions are covered in
58-
the [Quick Start Guide](./quick-start.md).
59-
6029
## Why Choose Oko?
6130

6231
Most wallets rely on a **single private key** that can be stolen, lost, or
@@ -83,5 +52,4 @@ failure while providing a superior user experience.
8352

8453
Want to see threshold signatures in action? Experience the difference firsthand:
8554

86-
**[🚀 Try the Live Demo](https://demo.oko.app)** - Sign transactions without any
87-
wallet setup required
55+
**🚀 Try the Demo** - Run `demo_web` locally to sign transactions without any wallet setup

apps/docs_web/docs/v0/getting-started/quick-start.md

Lines changed: 3 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -34,25 +34,6 @@ npm install @oko-wallet/oko-sdk-core
3434
npm install @oko-wallet/oko-sdk-core-react-native
3535
```
3636

37-
## API Key Setup
38-
39-
Before using the SDK, you'll need your API key from the
40-
[Oko dApp Dashboard](https://dapp.oko.app):
41-
42-
```typescript
43-
// Set your API key (from the dApp Dashboard)
44-
const OKO_API_KEY = "your-api-key-here";
45-
46-
// Configure the SDK with your API key
47-
const config = {
48-
api_key: OKO_API_KEY,
49-
theme: "dark", // "light" | "dark" (optional)
50-
};
51-
```
52-
53-
> **📋 Note:** Get your API key from the dApp Dashboard after completing the
54-
> partnership process described in the
55-
> [Integration Overview](./integration-overview.md).
5637

5738
## Cosmos Integration
5839

@@ -168,7 +149,7 @@ const signature = await svmWallet.sendTransaction(transaction, connection);
168149

169150
**The power of Oko:** Use familiar APIs for Ethereum, Cosmos, and SVM chains,
170151
while giving users **one account** that works across **all ecosystems**. Same
171-
Google login, consistent experience.
152+
login, consistent experience.
172153

173154
```typescript
174155
import { OkoCosmosWallet } from "@oko-wallet/oko-sdk-cosmos";
@@ -197,7 +178,7 @@ const ethWallet = ethInitRes.data;
197178
const svmWallet = svmInitRes.data;
198179

199180
// Users can interact with all three ecosystems seamlessly
200-
// Same Google account, same user experience!
181+
// Same account, same user experience!
201182
```
202183

203184
## React Native
@@ -244,7 +225,7 @@ Understanding how Oko works will help you integrate it effectively:
244225
**User Experience:**
245226

246227
1. User clicks "Connect Wallet" in your dApp
247-
2. User signs in with Google (handled automatically by the SDK)
228+
2. User signs in with a supported method — Google, email, GitHub, X, Discord, or Telegram (handled automatically by the SDK)
248229
3. Cryptographic key shares are generated using threshold signatures
249230
4. User can now sign transactions - no browser extensions needed!
250231

apps/docs_web/docs/v0/index.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,7 @@ accessible by any single party.
2727

2828
Experience Oko in action:
2929

30-
- **[Demo Application](https://demo.oko.app)** - Explore the Oko experience in a
31-
live demo
30+
- **Demo Application** - Run `demo_web` locally to explore the Oko experience
3231

3332
## Why Oko
3433

@@ -54,9 +53,7 @@ model.
5453
**Oko** solves this by providing an embedded onboarding flow that still
5554
preserves the interoperability of a global wallet address. Developers keep full
5655
control of the integration because everything from client to server is open
57-
source under Apache 2.0. Teams can run Oko entirely on their own infrastructure
58-
or choose official integration to use enterprise grade key share nodes and
59-
dashboards.
56+
source under Apache 2.0. Teams can run Oko entirely on their own infrastructure.
6057

6158
### Key Advantages
6259

@@ -72,7 +69,7 @@ dashboards.
7269

7370
- **No browser extensions** - embedded directly in your application
7471
- **No recovery phrases** - users don't need to manage complex private keys
75-
- **Social login (e.g. Google OAuth)** - familiar authentication flow
72+
- **Social login** - Google, email, GitHub, X, Discord, and Telegram
7673
- **Cross-device compatibility** - works on mobile, desktop, any browser
7774
- **Cross-application interoperability** - same, global wallet address across
7875
multiple Web3 apps
@@ -120,7 +117,7 @@ dashboards.
120117
- GitHub
121118
- Discord
122119
- X (Twitter)
123-
- Telegram (coming soon)
120+
- Telegram
124121

125122
**Oko SDK**
126123

@@ -152,8 +149,7 @@ Ready to integrate Oko into your application?
152149

153150
### 📚 **API Reference**
154151

155-
- **[Authentication](api-reference/api-overview.md#authentication)** - Google
156-
OAuth and session management
152+
- **[Authentication](api-reference/api-overview.md#authentication)** - Social login and session management
157153
- **[Provider Methods](api-reference/api-overview.md)** - Complete API reference
158154

159155
---

apps/docs_web/docs/v0/lifecycle.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,17 +36,17 @@ if (!initRes.success) {
3636
const ethWallet = initRes.data;
3737
const provider = await ethWallet.getEthereumProvider();
3838

39-
// This triggers Google OAuth authentication
40-
// User sees: "Sign in with Google" popup
41-
// User completes Google OAuth flow
39+
// This triggers social login authentication
40+
// User sees: login provider selection or sign-in popup
41+
// User completes the chosen provider's auth flow
4242
// Returns: JWT token for subsequent API calls
4343
```
4444

4545
**API Call Behind the Scenes:**
4646

4747
```
4848
POST /tss/v1/user/signin
49-
Headers: Authorization: Bearer <Google ID Token>
49+
Headers: Authorization: Bearer <ID Token> (token issued by the chosen auth provider)
5050
Response: {
5151
"success": true,
5252
"data": {
@@ -544,7 +544,7 @@ if (ethWallet && ethWallet.okoWallet) {
544544
3. **Standard interface**: Uses familiar Web3 methods (`eth_sendTransaction`,
545545
etc.)
546546
4. **No private keys**: Users never see or manage cryptographic material
547-
5. **Google OAuth**: Familiar authentication flow
547+
5. **Social login**: Familiar authentication flow (Google, email, GitHub, X, Discord, Telegram)
548548
6. **Cross-application**: Same wallet works across different dApps
549549

550550
**Performance Characteristics:**

apps/docs_web/docs/v0/sdk-usage/cosmos-integration.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ import { OkoCosmosWallet } from "@oko-wallet/oko-sdk-cosmos";
2626
const initRes = OkoCosmosWallet.init({
2727
api_key: "your-api-key",
2828
theme: "dark",
29+
sdk_endpoint: "https://your-oko-attached.example.com", // your self-hosted oko_attached URL
2930
});
3031

3132
if (!initRes.success) {

0 commit comments

Comments
 (0)