Skip to main content

TinyCloud Web SDK

Welcome to the TinyCloud Web SDK documentation. This SDK provides all the tools you need to build decentralized web applications with TinyCloud.

Key Features​

  • Decentralized Storage - Store and retrieve data using the TinyCloud protocol
  • Web3 Authentication - Sign-in with Ethereum (SIWE) integration
  • Wallet Integration - Seamless connection with popular Ethereum wallets
  • Type Safety - Written in TypeScript with comprehensive type definitions
  • Easy to Use - Simple API for common decentralized application needs

Getting Started​

To get started with the TinyCloud Web SDK, first install the package:

npm install @tinycloudlabs/web-sdk
# or
bun add @tinycloudlabs/web-sdk

Then import and initialize the SDK in your application:

import { TinyCloudWeb } from '@tinycloudlabs/web-sdk';

const tc = new TinyCloudWeb({
  // Configuration options here
});

// Connect to the user's wallet
await tc.connect();

// Use storage
const storage = tc.storage;
await storage.put('myKey', { hello: 'world' });
const result = await storage.get('myKey');
console.log(result.data); // { hello: 'world' }

Documentation Sections​

  • Guides - Step-by-step tutorials and how-to guides
  • API Reference - Detailed reference documentation for all SDK components
  • Examples - Code examples for common use cases