From e65e506134470fe00a225ae4590c7fe8d2ff3323 Mon Sep 17 00:00:00 2001 From: Sergii Date: Tue, 28 Oct 2025 11:55:55 +0100 Subject: [PATCH] fix(ts): adds deprecation notice to README --- ts/README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/ts/README.md b/ts/README.md index e8c60adc..1551693e 100644 --- a/ts/README.md +++ b/ts/README.md @@ -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 @@ -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: @@ -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. \ No newline at end of file +This package is licensed under the Apache-2.0.