Skip to content
This repository was archived by the owner on Jan 5, 2026. It is now read-only.

fix(ts): adds deprecation notice to README #238

Merged
stalniy merged 1 commit into from
Oct 29, 2025
Merged

fix(ts): adds deprecation notice to README #238

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions ts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
[![License: Apache-2.0](https://img.shields.io/badge/License-apache2.0-yellow.svg)](https://opensource.org/license/apache-2-0)
[![semantic-release: conventionalcommits](https://img.shields.io/badge/semantic--release-conventionalcommits?logo=semantic-release)](https://github.com/semantic-release/semantic-release)

**DEPRECATED:** This package is no longer maintained and does not support Akash Network v1.
Please migrate to [chain-sdk](https://github.com/akash-network/chain-sdk/tree/main/ts), which provides a more developer-friendly API with full IDE autocomplete and TypeScript support.

This package provides TypeScript bindings for the Akash API, generated from protobuf definitions.

## Installation
Expand All @@ -24,7 +27,7 @@ import * as akashDiscoveryV1 from '@akashnetwork/akash-api/akash/discovery/v1';
```

### TypeScript 4.5 and above
If you're using TypeScript 4.5 or above, the package exports all the paths of the generated namespaces, so you can import them directly.
If you're using TypeScript 4.5 or above, the package exports all the paths of the generated namespaces, so you can import them directly.

### TypeScript below 4.5
If you're using a version of TypeScript below 4.5, the package provides a tsconfig.paths.json file that you can extend in your local TypeScript configuration to resolve the paths. Here's how you can do it: In your tsconfig.json file, add the following:
Expand Down Expand Up @@ -56,4 +59,4 @@ export * from '../../../../patch/cosmos/base/v1beta1/coin';
NOTE: Naming and paths are important to prevent the original file from being overwritten when the code is regenerated. See `script/preserve-ts-patches.sh` and `script/restore-ts-patches.sh` for more implementation details.

### License
This package is licensed under the Apache-2.0.
This package is licensed under the Apache-2.0.
Loading