From 29e98ec1560dff80b625a3b9eb9ed23df39b6606 Mon Sep 17 00:00:00 2001 From: Simon Warta Date: Sat, 25 Jul 2020 15:57:46 +0200 Subject: [PATCH] Rename CosmosSdkAccount to BaseAccount --- CHANGELOG.md | 1 + packages/sdk38/src/index.ts | 1 + packages/sdk38/src/lcdapi/auth.ts | 12 ++++++++++-- packages/sdk38/src/lcdapi/index.ts | 2 +- packages/sdk38/types/index.d.ts | 1 + packages/sdk38/types/lcdapi/auth.d.ts | 12 ++++++++++-- packages/sdk38/types/lcdapi/index.d.ts | 2 +- 7 files changed, 25 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1768da89..4b9a1daa 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -16,6 +16,7 @@ - @cosmjs/sdk38: Remove `Pen` type in favour of `OfflineSigner` and remove `Secp256k1Pen` class in favour of `Secp256k1Wallet` which takes an `OfflineSigner` instead of a `SigningCallback`. +- @cosmjs/sdk38: Rename `CosmosSdkAccount` to `BaseAccount` and export the type. - @cosmjs/math: Add missing integer check to `Uint64.fromNumber`. Before `Uint64.fromNumber(1.1)` produced some result. - @cosmjs/sdk38: Add `SigningCosmosClient.signAndPost` as a mid-level diff --git a/packages/sdk38/src/index.ts b/packages/sdk38/src/index.ts index 305cdbee..9d38062d 100644 --- a/packages/sdk38/src/index.ts +++ b/packages/sdk38/src/index.ts @@ -30,6 +30,7 @@ export { AuthExtension, BankBalancesResponse, BankExtension, + BaseAccount, BlockResponse, BroadcastMode, DistributionCommunityPoolResponse, diff --git a/packages/sdk38/src/lcdapi/auth.ts b/packages/sdk38/src/lcdapi/auth.ts index 942d117b..c882c557 100644 --- a/packages/sdk38/src/lcdapi/auth.ts +++ b/packages/sdk38/src/lcdapi/auth.ts @@ -2,7 +2,15 @@ import { Coin } from "../coins"; import { LcdClient } from "./lcdclient"; -export interface CosmosSdkAccount { +/** + * A Cosmos SDK base account. + * + * This type describes the base account representation as returned + * by the Cosmos SDK 0.37–0.39 LCD API. + * + * @see https://docs.cosmos.network/master/modules/auth/02_state.html#base-account + */ +export interface BaseAccount { /** Bech32 account address */ readonly address: string; readonly coins: readonly Coin[]; @@ -16,7 +24,7 @@ export interface AuthAccountsResponse { readonly height: string; readonly result: { readonly type: "cosmos-sdk/Account"; - readonly value: CosmosSdkAccount; + readonly value: BaseAccount; }; } diff --git a/packages/sdk38/src/lcdapi/index.ts b/packages/sdk38/src/lcdapi/index.ts index 767f3cd6..e305cf46 100644 --- a/packages/sdk38/src/lcdapi/index.ts +++ b/packages/sdk38/src/lcdapi/index.ts @@ -2,7 +2,7 @@ // Standard modules (see tracking issue https://github.com/CosmWasm/cosmjs/issues/276) // -export { AuthExtension, AuthAccountsResponse, setupAuthExtension } from "./auth"; +export { AuthExtension, AuthAccountsResponse, BaseAccount, setupAuthExtension } from "./auth"; export { BankBalancesResponse, BankExtension, setupBankExtension } from "./bank"; export { DistributionCommunityPoolResponse, diff --git a/packages/sdk38/types/index.d.ts b/packages/sdk38/types/index.d.ts index b375c43e..b6312441 100644 --- a/packages/sdk38/types/index.d.ts +++ b/packages/sdk38/types/index.d.ts @@ -28,6 +28,7 @@ export { AuthExtension, BankBalancesResponse, BankExtension, + BaseAccount, BlockResponse, BroadcastMode, DistributionCommunityPoolResponse, diff --git a/packages/sdk38/types/lcdapi/auth.d.ts b/packages/sdk38/types/lcdapi/auth.d.ts index 95f404d3..2166627e 100644 --- a/packages/sdk38/types/lcdapi/auth.d.ts +++ b/packages/sdk38/types/lcdapi/auth.d.ts @@ -1,6 +1,14 @@ import { Coin } from "../coins"; import { LcdClient } from "./lcdclient"; -export interface CosmosSdkAccount { +/** + * A Cosmos SDK base account. + * + * This type describes the base account representation as returned + * by the Cosmos SDK 0.37–0.39 LCD API. + * + * @see https://docs.cosmos.network/master/modules/auth/02_state.html#base-account + */ +export interface BaseAccount { /** Bech32 account address */ readonly address: string; readonly coins: readonly Coin[]; @@ -13,7 +21,7 @@ export interface AuthAccountsResponse { readonly height: string; readonly result: { readonly type: "cosmos-sdk/Account"; - readonly value: CosmosSdkAccount; + readonly value: BaseAccount; }; } export interface AuthExtension { diff --git a/packages/sdk38/types/lcdapi/index.d.ts b/packages/sdk38/types/lcdapi/index.d.ts index 38460f39..3d14ccf2 100644 --- a/packages/sdk38/types/lcdapi/index.d.ts +++ b/packages/sdk38/types/lcdapi/index.d.ts @@ -1,4 +1,4 @@ -export { AuthExtension, AuthAccountsResponse, setupAuthExtension } from "./auth"; +export { AuthExtension, AuthAccountsResponse, BaseAccount, setupAuthExtension } from "./auth"; export { BankBalancesResponse, BankExtension, setupBankExtension } from "./bank"; export { DistributionCommunityPoolResponse,