Skip to content

Aleph.im Documentation

Introduction

Aleph.im Documentation

Overview
Protocol
Protocol
- Chains
- Messages
- Permissions
- Object Types
  Object Types
  - Aggregates
  - Posts
  - Programs
  - Storage
Nodes
Nodes
- Compute
  Compute
  - Index
  - Installations
    Installations
    
    Configure Caddy
    
    Debian 11
    
    Debian 12
    
    Ubuntu 20.04
    
    Ubuntu 22.04
  - Troubleshooting
- Core
  Core
  - Index
  - Backups
- Reliability
  Reliability
  - Introduction
  - Monitoring
  - Metrics
  - Scores
  - Rewards
Tools
Tools
- Aleph Account
- Aleph Client
  Aleph Client
- Aleph Tooling
- Multichain Indexer
  Multichain Indexer
- IPFS Pinning
Libraries
Libraries
- Typescript SDK
  Typescript SDK
  - Introduction Introduction
    Table of contents
    
    Installation
    
    Usage
    
    Further links
  - Account
  - Aggregates
  - Instances
  - Posts
  - Troubleshooting
- Python SDK
  Python SDK
  - Introduction
  - Account
  - Forget
  - Errors
  - Posts
    Posts
    
    Create
    
    Query
  - Aggregates
    Aggregates
    
    Create
    
    Query
    
    Delegate
Computing
Computing
- Index
- Custom Domain
  Custom Domain
  - Add a Custom Domain
- Execute Your Code
  Execute Your Code
- Runtimes
  Runtimes
  - Index
  - Custom
  - Existing
- Volumes
  Volumes
  - Immutable
  - Persistent
Tutorials
Tutorials
- Testing microVMs
- Update a program
- Python
  Python
- Rust
  Rust
  - Rust microVMs

Introduction

Similar to the Python SDK, the TypeScript SDK provides a set of tools to interact with the Aleph.im network.

Since the release of the newly refactored Aleph TypeScript SDK, the original aleph-ts-sdk has been deprecated and split into smaller, more manageable packages.

These documentations refer to the v1.0.0-alpha1 release.

Installation

The Aleph.im TypeScript SDK is available on NPM, and can be installed using npm:

npm install @aleph-sdk/client

Usage

Further links