LaconicNetwork/cosmjs-util
7
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Merge branch 'main' into nabla/improve-sign_dx

Browse Source
This commit is contained in:
Davide Segullo
2023-05-24 19:06:49 +02:00
committed by GitHub
parent 134ecc216f f7dd3efbcf
commit e6f5f670be
173 changed files with 5863 additions and 2186 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/stargate/package.json
+4 -4
View File
@@ -46,7 +46,7 @@
"@cosmjs/stream": "workspace:^",
"@cosmjs/tendermint-rpc": "workspace:^",
"@cosmjs/utils": "workspace:^",
"cosmjs-types": "^0.7.1",
"cosmjs-types": "^0.8.0",
"long": "^4.0.0",
"protobufjs": "~6.11.3",
"xstream": "^11.14.0"
@@ -60,7 +60,7 @@
"@types/karma-jasmine": "^4",
"@types/karma-jasmine-html-reporter": "^1",
"@types/long": "^4.0.1",
"@types/node": "^15.0.1",
"@types/node": "^18",
"@typescript-eslint/eslint-plugin": "^5.54.0",
"@typescript-eslint/parser": "^5.54.0",
"eslint": "^7.5",
@@ -84,8 +84,8 @@
"ses": "^0.11.0",
"source-map-support": "^0.5.19",
"ts-node": "^8",
"typedoc": "^0.22",
"typescript": "~4.6",
"typedoc": "^0.23",
"typescript": "~4.9",
"webpack": "^5.76.0",
"webpack-cli": "^4.6.0"
}
packages/stargate/src/index.ts
+1 -10
View File
@@ -112,16 +112,7 @@ export {
QueryClient,
QueryStoreResponse,
} from "./queryclient";
export {
isSearchByHeightQuery,
isSearchBySentFromOrToQuery,
isSearchByTagsQuery,
SearchByHeightQuery,
SearchBySentFromOrToQuery,
SearchByTagsQuery,
SearchTxFilter,
SearchTxQuery,
} from "./search";
export { SearchByHeightQuery, SearchBySentFromOrToQuery, SearchTxQuery } from "./search";
export {
createDefaultAminoConverters,
defaultRegistryTypes,
packages/stargate/src/modules/authz/queries.spec.ts
+12 -10
View File
@@ -11,11 +11,10 @@ import {
defaultSigningClientOptions,
faucet,
makeRandomAddress,
pendingWithoutSimapp44Or46,
pendingWithoutSimapp46,
pendingWithoutSimapp,
pendingWithoutSimapp46OrHigher,
simapp,
simapp44Enabled,
simapp46Enabled,
simappEnabled,
} from "../../testutils.spec";
import { AuthzExtension, setupAuthzExtension } from "./queries";
@@ -37,7 +36,7 @@ describe("AuthzExtension", () => {
const grantedMsg = "/cosmos.distribution.v1beta1.MsgWithdrawDelegatorReward";
beforeAll(async () => {
if (simapp44Enabled() || simapp46Enabled()) {
if (simappEnabled()) {
const wallet = await DirectSecp256k1HdWallet.fromMnemonic(faucet.mnemonic, {
// Use address 1 and 2 instead of 0 to avoid conflicts with other delegation tests
// This must match `voterAddress` above.
@@ -81,7 +80,7 @@ describe("AuthzExtension", () => {
describe("grants", () => {
it("works", async () => {
pendingWithoutSimapp44Or46();
pendingWithoutSimapp();
const [client, tmClient] = await makeClientWithAuthz(simapp.tendermintUrl);
const response = await client.authz.grants(granter1Address, grantee1Address, "");
expect(response.grants.length).toEqual(1);
@@ -105,11 +104,14 @@ describe("AuthzExtension", () => {
describe("granter grants", () => {
it("works", async () => {
pendingWithoutSimapp46();
pendingWithoutSimapp46OrHigher();
const [client, tmClient] = await makeClientWithAuthz(simapp.tendermintUrl);
const response = await client.authz.granterGrants(granter1Address);
expect(response.grants.length).toEqual(1);
const grant = response.grants[0];
expect(response.grants.length).toBeGreaterThanOrEqual(1);
const grant = response.grants.find(
(g) => g.granter == granter1Address && g.grantee === grantee1Address,
);
assertDefined(grant, "Grant not found");
// Needs to respond with a grant
assertDefined(grant.authorization);
@@ -133,7 +135,7 @@ describe("AuthzExtension", () => {
describe("grantee grants", () => {
it("works", async () => {
pendingWithoutSimapp46();
pendingWithoutSimapp46OrHigher();
const [client, tmClient] = await makeClientWithAuthz(simapp.tendermintUrl);
const response = await client.authz.granteeGrants(grantee1Address);
expect(response.grants.length).toEqual(1);
packages/stargate/src/modules/bank/queries.spec.ts
+42 -38
View File
@@ -150,25 +150,27 @@ describe("BankExtension", () => {
const [client, tmClient] = await makeClientWithBank(simapp.tendermintUrl);
const metadata = await client.bank.denomMetadata("ucosm");
expect(metadata).toEqual({
description: "The fee token of this test chain",
denomUnits: [
{
denom: "ucosm",
exponent: 0,
aliases: [],
},
{
denom: "COSM",
exponent: 6,
aliases: [],
},
],
base: "ucosm",
display: "COSM",
name: "",
symbol: "",
});
expect(metadata).toEqual(
jasmine.objectContaining({
description: "The fee token of this test chain",
denomUnits: [
{
denom: "ucosm",
exponent: 0,
aliases: [],
},
{
denom: "COSM",
exponent: 6,
aliases: [],
},
],
base: "ucosm",
display: "COSM",
name: "",
symbol: "",
}),
);
tmClient.disconnect();
});
@@ -190,25 +192,27 @@ describe("BankExtension", () => {
const metadatas = await client.bank.denomsMetadata();
expect(metadatas.length).toEqual(1);
expect(metadatas[0]).toEqual({
description: "The fee token of this test chain",
denomUnits: [
{
denom: "ucosm",
exponent: 0,
aliases: [],
},
{
denom: "COSM",
exponent: 6,
aliases: [],
},
],
base: "ucosm",
display: "COSM",
name: "",
symbol: "",
});
expect(metadatas[0]).toEqual(
jasmine.objectContaining({
description: "The fee token of this test chain",
denomUnits: [
{
denom: "ucosm",
exponent: 0,
aliases: [],
},
{
denom: "COSM",
exponent: 6,
aliases: [],
},
],
base: "ucosm",
display: "COSM",
name: "",
symbol: "",
}),
);
tmClient.disconnect();
});
packages/stargate/src/modules/gov/messages.spec.ts
+2 -3
View File
@@ -12,7 +12,6 @@ import {
faucet,
nonNegativeIntegerMatcher,
pendingWithoutSimapp,
pendingWithoutSimapp44Or46,
simapp,
simappEnabled,
validator,
@@ -171,7 +170,7 @@ describe("gov messages", () => {
describe("MsgVoteWeighted", () => {
it("works", async () => {
pendingWithoutSimapp44Or46(); // MsgVoteWeighted does not yet exist in Cosmos SDK 0.42
pendingWithoutSimapp();
assert(voterWallet);
assert(proposalId, "Missing proposal ID");
const client = await SigningStargateClient.connectWithSigner(simapp.tendermintUrl, voterWallet);
@@ -204,7 +203,7 @@ describe("gov messages", () => {
});
it("works with Amino JSON sign mode", async () => {
pendingWithoutSimapp44Or46(); // MsgVoteWeighted does not yet exist in Cosmos SDK 0.42
pendingWithoutSimapp();
assert(voterWalletAmino);
assert(proposalId, "Missing proposal ID");
const client = await SigningStargateClient.connectWithSigner(simapp.tendermintUrl, voterWalletAmino);
packages/stargate/src/modules/vesting/messages.spec.ts
+2 -2
View File
@@ -10,7 +10,7 @@ import {
faucet,
makeRandomAddress,
pendingWithoutSimapp,
pendingWithoutSimapp46,
pendingWithoutSimapp46OrHigher,
simapp,
} from "../../testutils.spec";
@@ -47,7 +47,7 @@ describe("vesting messages", () => {
});
it("works with Amino JSON sign mode", async () => {
pendingWithoutSimapp46(); // Amino JSON broken on chain before Cosmos SDK 0.46
pendingWithoutSimapp46OrHigher(); // Amino JSON broken on chain before Cosmos SDK 0.46
const wallet = await Secp256k1HdWallet.fromMnemonic(faucet.mnemonic);
const client = await SigningStargateClient.connectWithSigner(
simapp.tendermintUrl,
packages/stargate/src/queryclient/queryclient.spec.ts
-77
View File
@@ -92,83 +92,6 @@ describe("QueryClient", () => {
});
});
describe("queryUnverified", () => {
it("works via WebSockets", async () => {
pendingWithoutSimapp();
const [client, tmClient] = await makeClient(simapp.tendermintUrlWs);
const requestData = Uint8Array.from(
QueryAllBalancesRequest.encode({ address: unused.address }).finish(),
);
const data = await client.queryUnverified(`/cosmos.bank.v1beta1.Query/AllBalances`, requestData);
const response = QueryAllBalancesResponse.decode(data);
expect(response.balances.length).toEqual(2);
tmClient.disconnect();
});
it("works via http", async () => {
pendingWithoutSimapp();
const [client, tmClient] = await makeClient(simapp.tendermintUrlHttp);
const requestData = Uint8Array.from(
QueryAllBalancesRequest.encode({ address: unused.address }).finish(),
);
const data = await client.queryUnverified(`/cosmos.bank.v1beta1.Query/AllBalances`, requestData);
const response = QueryAllBalancesResponse.decode(data);
expect(response.balances.length).toEqual(2);
tmClient.disconnect();
});
it("works for height", async () => {
pendingWithoutSimapp();
const [queryClient, tmClient] = await makeClient(simapp.tendermintUrlHttp);
const joe = makeRandomAddress();
const h1 = (await tmClient.status()).syncInfo.latestBlockHeight;
// Send tokens to `recipient`
const wallet = await DirectSecp256k1HdWallet.fromMnemonic(faucet.mnemonic);
const client = await SigningStargateClient.connectWithSigner(
simapp.tendermintUrlHttp,
wallet,
defaultSigningClientOptions,
);
const amount = coin(332211, simapp.denomFee);
await client.sendTokens(faucet.address0, joe, [amount], "auto");
const h2 = (await tmClient.status()).syncInfo.latestBlockHeight;
assert(h1 < h2);
// Query with no height
{
const requestData = QueryBalanceRequest.encode({ address: joe, denom: simapp.denomFee }).finish();
const data = await queryClient.queryUnverified(`/cosmos.bank.v1beta1.Query/Balance`, requestData);
const response = QueryBalanceResponse.decode(data);
expect(response.balance).toEqual(amount);
}
// Query at h2 (after send)
{
const requestData = QueryBalanceRequest.encode({ address: joe, denom: simapp.denomFee }).finish();
const data = await queryClient.queryUnverified(`/cosmos.bank.v1beta1.Query/Balance`, requestData, h2);
const response = QueryBalanceResponse.decode(data);
expect(response.balance).toEqual(amount);
}
// Query at h1 (before send)
{
const requestData = QueryBalanceRequest.encode({ address: joe, denom: simapp.denomFee }).finish();
const data = await queryClient.queryUnverified(`/cosmos.bank.v1beta1.Query/Balance`, requestData, h1);
const response = QueryBalanceResponse.decode(data);
expect(response.balance).toEqual({ amount: "0", denom: simapp.denomFee });
}
tmClient.disconnect();
});
});
describe("queryAbci", () => {
it("works via WebSockets", async () => {
pendingWithoutSimapp();
packages/stargate/src/queryclient/queryclient.ts
-26
View File
@@ -512,18 +512,6 @@ export class QueryClient {
this.tmClient = tmClient;
}
/**
* @deprecated use queryStoreVerified instead
*/
public async queryVerified(
store: string,
queryKey: Uint8Array,
desiredHeight?: number,
): Promise<Uint8Array> {
const { value } = await this.queryStoreVerified(store, queryKey, desiredHeight);
return value;
}
/**
* Queries the database store with a proof, which is then verified.
*
@@ -608,20 +596,6 @@ export class QueryClient {
};
}
/**
* Performs an ABCI query to Tendermint without requesting a proof.
*
* @deprecated use queryAbci instead
*/
public async queryUnverified(
path: string,
request: Uint8Array,
desiredHeight?: number,
): Promise<Uint8Array> {
const response = await this.queryAbci(path, request, desiredHeight);
return response.value;
}
/**
* Performs an ABCI query to Tendermint without requesting a proof.
*
packages/stargate/src/search.ts
+7 -24
View File
@@ -7,28 +7,11 @@ export interface SearchBySentFromOrToQuery {
}
/**
* This query type allows you to pass arbitrary key/value pairs to the backend. It is
* more powerful and slightly lower level than the other search options.
* This query type allows you to pass arbitrary key/value pairs to the backend.
*/
export interface SearchByTagsQuery {
readonly tags: ReadonlyArray<{ readonly key: string; readonly value: string }>;
}
export type SearchTxQuery = SearchByHeightQuery | SearchBySentFromOrToQuery | SearchByTagsQuery;
export function isSearchByHeightQuery(query: SearchTxQuery): query is SearchByHeightQuery {
return (query as SearchByHeightQuery).height !== undefined;
}
export function isSearchBySentFromOrToQuery(query: SearchTxQuery): query is SearchBySentFromOrToQuery {
return (query as SearchBySentFromOrToQuery).sentFromOrTo !== undefined;
}
export function isSearchByTagsQuery(query: SearchTxQuery): query is SearchByTagsQuery {
return (query as SearchByTagsQuery).tags !== undefined;
}
export interface SearchTxFilter {
readonly minHeight?: number;
readonly maxHeight?: number;
}
export type SearchTxQuery =
| string
| ReadonlyArray<{
readonly key: string;
readonly value: string;
}>;
packages/stargate/src/signingstargateclient.spec.ts
+10 -5
View File
@@ -29,7 +29,11 @@ import {
setupFeegrantExtension,
} from "./modules";
import { QueryClient } from "./queryclient";
import { PrivateSigningStargateClient, SigningStargateClient } from "./signingstargateclient";
import {
PrivateSigningStargateClient,
SigningStargateClient,
SigningStargateClientOptions,
} from "./signingstargateclient";
import { assertIsDeliverTxFailure, assertIsDeliverTxSuccess, isDeliverTxFailure } from "./stargateclient";
import {
defaultGasPrice,
@@ -51,7 +55,7 @@ describe("SigningStargateClient", () => {
const wallet = await DirectSecp256k1HdWallet.fromMnemonic(faucet.mnemonic);
const registry = new Registry();
registry.register("/custom.MsgCustom", MsgSend);
const options = { ...defaultSigningClientOptions, registry: registry };
const options: SigningStargateClientOptions = { ...defaultSigningClientOptions, registry: registry };
const client = await SigningStargateClient.connectWithSigner(simapp.tendermintUrl, wallet, options);
const openedClient = client as unknown as PrivateSigningStargateClient;
expect(openedClient.registry.lookupType("/custom.MsgCustom")).toEqual(MsgSend);
@@ -204,7 +208,8 @@ describe("SigningStargateClient", () => {
allowance: allowance,
}),
};
const grantResult = await client.signAndBroadcast(payer, [grantMsg], "auto", "Create allowance");
const fee = 1.5; // See https://github.com/cosmos/cosmos-sdk/issues/16020
const grantResult = await client.signAndBroadcast(payer, [grantMsg], fee, "Create allowance");
assertIsDeliverTxSuccess(grantResult);
}
@@ -621,7 +626,7 @@ describe("SigningStargateClient", () => {
}),
},
});
const options = {
const options: SigningStargateClientOptions = {
...defaultSigningClientOptions,
registry: customRegistry,
aminoTypes: customAminoTypes,
@@ -901,7 +906,7 @@ describe("SigningStargateClient", () => {
}),
},
});
const options = {
const options: SigningStargateClientOptions = {
...defaultSigningClientOptions,
registry: customRegistry,
aminoTypes: customAminoTypes,
packages/stargate/src/signingstargateclient.ts
+20 -4
View File
@@ -12,7 +12,12 @@ import {
Registry,
TxBodyEncodeObject,
} from "@cosmjs/proto-signing";
import { HttpEndpoint, Tendermint34Client, TendermintClient } from "@cosmjs/tendermint-rpc";
import {
HttpEndpoint,
Tendermint34Client,
Tendermint37Client,
TendermintClient,
} from "@cosmjs/tendermint-rpc";
import { assert, assertDefined } from "@cosmjs/utils";
import { Coin } from "cosmjs-types/cosmos/base/v1beta1/coin";
import { MsgWithdrawDelegatorReward } from "cosmjs-types/cosmos/distribution/v1beta1/tx";
@@ -113,15 +118,26 @@ export class SigningStargateClient extends StargateClient {
/**
* Creates an instance by connecting to the given Tendermint RPC endpoint.
*
* For now this uses the Tendermint 0.34 client. If you need Tendermint 0.37
* support, see `createWithSigner`.
* This uses auto-detection to decide between a Tendermint 0.37 and 0.34 client.
* To set the Tendermint client explicitly, use `createWithSigner`.
*/
public static async connectWithSigner(
endpoint: string | HttpEndpoint,
signer: OfflineSigner,
options: SigningStargateClientOptions = {},
): Promise<SigningStargateClient> {
const tmClient = await Tendermint34Client.connect(endpoint);
// Tendermint/CometBFT 0.34/0.37 auto-detection. Starting with 0.37 we seem to get reliable versions again 🎉
// Using 0.34 as the fallback.
let tmClient: TendermintClient;
const tm37Client = await Tendermint37Client.connect(endpoint);
const version = (await tm37Client.status()).nodeInfo.version;
if (version.startsWith("0.37.")) {
tmClient = tm37Client;
} else {
tm37Client.disconnect();
tmClient = await Tendermint34Client.connect(endpoint);
}
return SigningStargateClient.createWithSigner(tmClient, signer, options);
}
packages/stargate/src/stargateclient.searchtx.spec.ts
+35 -67
View File
@@ -10,6 +10,7 @@ import {
TxBodyEncodeObject,
} from "@cosmjs/proto-signing";
import { assert, sleep } from "@cosmjs/utils";
import { MsgSendResponse } from "cosmjs-types/cosmos/bank/v1beta1/tx";
import { Coin } from "cosmjs-types/cosmos/base/v1beta1/coin";
import { TxRaw } from "cosmjs-types/cosmos/tx/v1beta1/tx";
@@ -22,6 +23,7 @@ import {
makeRandomAddress,
pendingWithoutSimapp,
simapp,
simapp44Enabled,
simappEnabled,
} from "./testutils.spec";
@@ -156,6 +158,7 @@ describe("StargateClient.getTx and .searchTx", () => {
assert(sendSuccessful, "value must be set in beforeAll()");
const client = await StargateClient.connect(simapp.tendermintUrl);
const result = await client.getTx(sendSuccessful.hash);
assert(result);
expect(result).toEqual(
jasmine.objectContaining({
height: sendSuccessful.height,
@@ -164,6 +167,14 @@ describe("StargateClient.getTx and .searchTx", () => {
tx: sendSuccessful.tx,
}),
);
// works on SDK 0.46+
if (!simapp44Enabled()) {
expect(result.msgResponses.length).toEqual(1);
expect(result.msgResponses[0].typeUrl).toEqual("/cosmos.bank.v1beta1.MsgSendResponse");
const _response = MsgSendResponse.decode(result.msgResponses[0].value);
// MsgSendResponse has no fields to check 🤷‍♂️
}
});
it("can get unsuccessful tx by ID", async () => {
@@ -171,6 +182,7 @@ describe("StargateClient.getTx and .searchTx", () => {
assert(sendUnsuccessful, "value must be set in beforeAll()");
const client = await StargateClient.connect(simapp.tendermintUrl);
const result = await client.getTx(sendUnsuccessful.hash);
assert(result);
expect(result).toEqual(
jasmine.objectContaining({
height: sendUnsuccessful.height,
@@ -179,6 +191,12 @@ describe("StargateClient.getTx and .searchTx", () => {
tx: sendUnsuccessful.tx,
}),
);
// works on SDK 0.46+
if (!simapp44Enabled()) {
// unsuccessful tx should not have responses
expect(result.msgResponses.length).toEqual(0);
}
});
it("can get by ID (non existent)", async () => {
@@ -190,12 +208,12 @@ describe("StargateClient.getTx and .searchTx", () => {
});
});
describe("with SearchByHeightQuery", () => {
describe("searchTx", () => {
it("can search successful tx by height", async () => {
pendingWithoutSimapp();
assert(sendSuccessful, "value must be set in beforeAll()");
const client = await StargateClient.connect(simapp.tendermintUrl);
const result = await client.searchTx({ height: sendSuccessful.height });
const result = await client.searchTx(`tx.height=${sendSuccessful.height}`);
expect(result.length).toBeGreaterThanOrEqual(1);
expect(result).toContain(
jasmine.objectContaining({
@@ -205,13 +223,21 @@ describe("StargateClient.getTx and .searchTx", () => {
tx: sendSuccessful.tx,
}),
);
// works on SDK 0.46+
if (!simapp44Enabled()) {
expect(result[0].msgResponses.length).toEqual(1);
expect(result[0].msgResponses[0].typeUrl).toEqual("/cosmos.bank.v1beta1.MsgSendResponse");
const _response = MsgSendResponse.decode(result[0].msgResponses[0].value);
// MsgSendResponse has no fields to check 🤷‍♂️
}
});
it("can search unsuccessful tx by height", async () => {
pendingWithoutSimapp();
assert(sendUnsuccessful, "value must be set in beforeAll()");
const client = await StargateClient.connect(simapp.tendermintUrl);
const result = await client.searchTx({ height: sendUnsuccessful.height });
const result = await client.searchTx(`tx.height=${sendUnsuccessful.height}`);
expect(result.length).toBeGreaterThanOrEqual(1);
expect(result).toContain(
jasmine.objectContaining({
@@ -222,14 +248,14 @@ describe("StargateClient.getTx and .searchTx", () => {
}),
);
});
});
describe("with SearchBySentFromOrToQuery", () => {
it("can search by sender", async () => {
pendingWithoutSimapp();
assert(sendSuccessful, "value must be set in beforeAll()");
const client = await StargateClient.connect(simapp.tendermintUrl);
const results = await client.searchTx({ sentFromOrTo: sendSuccessful.sender });
// Since Cosmos SDK 0.47 we can only combine attributes of a single event
const query = `message.action = '/cosmos.bank.v1beta1.MsgSend' AND message.sender = '${sendSuccessful.sender}'`;
const results = await client.searchTx(query);
expect(results.length).toBeGreaterThanOrEqual(1);
// Check basic structure of all results
@@ -257,7 +283,7 @@ describe("StargateClient.getTx and .searchTx", () => {
pendingWithoutSimapp();
assert(sendSuccessful, "value must be set in beforeAll()");
const client = await StargateClient.connect(simapp.tendermintUrl);
const results = await client.searchTx({ sentFromOrTo: sendSuccessful.recipient });
const results = await client.searchTx(`transfer.recipient='${sendSuccessful.recipient}'`);
expect(results.length).toBeGreaterThanOrEqual(1);
// Check basic structure of all results
@@ -281,69 +307,11 @@ describe("StargateClient.getTx and .searchTx", () => {
);
});
it("can search by recipient and filter by minHeight", async () => {
pendingWithoutSimapp();
assert(sendSuccessful);
const client = await StargateClient.connect(simapp.tendermintUrl);
const query = { sentFromOrTo: sendSuccessful.recipient };
{
const result = await client.searchTx(query, { minHeight: 0 });
expect(result.length).toEqual(1);
}
{
const result = await client.searchTx(query, { minHeight: sendSuccessful.height - 1 });
expect(result.length).toEqual(1);
}
{
const result = await client.searchTx(query, { minHeight: sendSuccessful.height });
expect(result.length).toEqual(1);
}
{
const result = await client.searchTx(query, { minHeight: sendSuccessful.height + 1 });
expect(result.length).toEqual(0);
}
});
it("can search by recipient and filter by maxHeight", async () => {
pendingWithoutSimapp();
assert(sendSuccessful);
const client = await StargateClient.connect(simapp.tendermintUrl);
const query = { sentFromOrTo: sendSuccessful.recipient };
{
const result = await client.searchTx(query, { maxHeight: 9999999999999 });
expect(result.length).toEqual(1);
}
{
const result = await client.searchTx(query, { maxHeight: sendSuccessful.height + 1 });
expect(result.length).toEqual(1);
}
{
const result = await client.searchTx(query, { maxHeight: sendSuccessful.height });
expect(result.length).toEqual(1);
}
{
const result = await client.searchTx(query, { maxHeight: sendSuccessful.height - 1 });
expect(result.length).toEqual(0);
}
});
});
describe("with SearchByTagsQuery", () => {
it("can search by transfer.recipient", async () => {
it("works with tags", async () => {
pendingWithoutSimapp();
assert(sendSuccessful, "value must be set in beforeAll()");
const client = await StargateClient.connect(simapp.tendermintUrl);
const results = await client.searchTx({
tags: [{ key: "transfer.recipient", value: sendSuccessful.recipient }],
});
const results = await client.searchTx([{ key: "transfer.recipient", value: sendSuccessful.recipient }]);
expect(results.length).toBeGreaterThanOrEqual(1);
// Check basic structure of all results
packages/stargate/src/stargateclient.spec.ts
+2
View File
@@ -45,6 +45,7 @@ const resultFailure: DeliverTxResponse = {
"failed to execute message; message index: 0: 1855527000ufct is smaller than 20000000000000000000000ufct: insufficient funds",
transactionHash: "FDC4FB701AABD465935F7D04AE490D1EF5F2BD4B227601C4E98B57EB077D9B7D",
events: [],
msgResponses: [],
gasUsed: 54396,
gasWanted: 200000,
};
@@ -56,6 +57,7 @@ const resultSuccess: DeliverTxResponse = {
'[{"events":[{"type":"message","attributes":[{"key":"action","value":"send"},{"key":"sender","value":"firma1trqyle9m2nvyafc2n25frkpwed2504y6avgfzr"},{"key":"module","value":"bank"}]},{"type":"transfer","attributes":[{"key":"recipient","value":"firma12er8ls2sf5zess3jgjxz59xat9xtf8hz0hk6n4"},{"key":"sender","value":"firma1trqyle9m2nvyafc2n25frkpwed2504y6avgfzr"},{"key":"amount","value":"2000000ufct"}]}]}]',
transactionHash: "C0B416CA868C55C2B8C1BBB8F3CFA233854F13A5CB15D3E9599F50CAF7B3D161",
events: [],
msgResponses: [],
gasUsed: 61556,
gasWanted: 200000,
};
packages/stargate/src/stargateclient.ts
+43 -47
View File
@@ -5,11 +5,12 @@ import { Uint53 } from "@cosmjs/math";
import {
HttpEndpoint,
Tendermint34Client,
Tendermint37Client,
TendermintClient,
toRfc3339WithNanoseconds,
} from "@cosmjs/tendermint-rpc";
import { assert, sleep } from "@cosmjs/utils";
import { MsgData } from "cosmjs-types/cosmos/base/abci/v1beta1/abci";
import { MsgData, TxMsgData } from "cosmjs-types/cosmos/base/abci/v1beta1/abci";
import { Coin } from "cosmjs-types/cosmos/base/v1beta1/coin";
import { QueryDelegatorDelegationsResponse } from "cosmjs-types/cosmos/staking/v1beta1/query";
import { DelegationResponse } from "cosmjs-types/cosmos/staking/v1beta1/staking";
@@ -27,13 +28,7 @@ import {
TxExtension,
} from "./modules";
import { QueryClient } from "./queryclient";
import {
isSearchByHeightQuery,
isSearchBySentFromOrToQuery,
isSearchByTagsQuery,
SearchTxFilter,
SearchTxQuery,
} from "./search";
import { SearchTxQuery } from "./search";
export class TimeoutError extends Error {
public readonly txId: string;
@@ -96,6 +91,12 @@ export interface IndexedTx {
* Use `decodeTxRaw` from @cosmjs/proto-signing to decode this.
*/
readonly tx: Uint8Array;
/**
* The message responses of the [TxMsgData](https://github.com/cosmos/cosmos-sdk/blob/v0.46.3/proto/cosmos/base/abci/v1beta1/abci.proto#L128-L140)
* as `Any`s.
* This field is an empty list for chains running Cosmos SDK < 0.46.
*/
readonly msgResponses: Array<{ readonly typeUrl: string; readonly value: Uint8Array }>;
readonly gasUsed: number;
readonly gasWanted: number;
}
@@ -125,7 +126,14 @@ export interface DeliverTxResponse {
* field instead.
*/
readonly rawLog?: string;
/** @deprecated Use `msgResponses` instead. */
readonly data?: readonly MsgData[];
/**
* The message responses of the [TxMsgData](https://github.com/cosmos/cosmos-sdk/blob/v0.46.3/proto/cosmos/base/abci/v1beta1/abci.proto#L128-L140)
* as `Any`s.
* This field is an empty list for chains running Cosmos SDK < 0.46.
*/
readonly msgResponses: Array<{ readonly typeUrl: string; readonly value: Uint8Array }>;
readonly gasUsed: number;
readonly gasWanted: number;
}
@@ -198,14 +206,25 @@ export class StargateClient {
/**
* Creates an instance by connecting to the given Tendermint RPC endpoint.
*
* For now this uses the Tendermint 0.34 client. If you need Tendermint 0.37
* support, see `create`.
* This uses auto-detection to decide between a Tendermint 0.37 and 0.34 client.
* To set the Tendermint client explicitly, use `create`.
*/
public static async connect(
endpoint: string | HttpEndpoint,
options: StargateClientOptions = {},
): Promise<StargateClient> {
const tmClient = await Tendermint34Client.connect(endpoint);
// Tendermint/CometBFT 0.34/0.37 auto-detection. Starting with 0.37 we seem to get reliable versions again 🎉
// Using 0.34 as the fallback.
let tmClient: TendermintClient;
const tm37Client = await Tendermint37Client.connect(endpoint);
const version = (await tm37Client.status()).nodeInfo.version;
if (version.startsWith("0.37.")) {
tmClient = tm37Client;
} else {
tm37Client.disconnect();
tmClient = await Tendermint34Client.connect(endpoint);
}
return StargateClient.create(tmClient, options);
}
@@ -382,42 +401,16 @@ export class StargateClient {
return results[0] ?? null;
}
public async searchTx(query: SearchTxQuery, filter: SearchTxFilter = {}): Promise<readonly IndexedTx[]> {
const minHeight = filter.minHeight || 0;
const maxHeight = filter.maxHeight || Number.MAX_SAFE_INTEGER;
if (maxHeight < minHeight) return []; // optional optimization
function withFilters(originalQuery: string): string {
return `${originalQuery} AND tx.height>=${minHeight} AND tx.height<=${maxHeight}`;
}
let txs: readonly IndexedTx[];
if (isSearchByHeightQuery(query)) {
txs =
query.height >= minHeight && query.height <= maxHeight
? await this.txsQuery(`tx.height=${query.height}`)
: [];
} else if (isSearchBySentFromOrToQuery(query)) {
const sentQuery = withFilters(`message.module='bank' AND transfer.sender='${query.sentFromOrTo}'`);
const receivedQuery = withFilters(
`message.module='bank' AND transfer.recipient='${query.sentFromOrTo}'`,
);
const [sent, received] = await Promise.all(
[sentQuery, receivedQuery].map((rawQuery) => this.txsQuery(rawQuery)),
);
const sentHashes = sent.map((t) => t.hash);
txs = [...sent, ...received.filter((t) => !sentHashes.includes(t.hash))];
} else if (isSearchByTagsQuery(query)) {
const rawQuery = withFilters(query.tags.map((t) => `${t.key}='${t.value}'`).join(" AND "));
txs = await this.txsQuery(rawQuery);
public async searchTx(query: SearchTxQuery): Promise<IndexedTx[]> {
let rawQuery: string;
if (typeof query === "string") {
rawQuery = query;
} else if (Array.isArray(query)) {
rawQuery = query.map((t) => `${t.key}='${t.value}'`).join(" AND ");
} else {
throw new Error("Unknown query type");
throw new Error("Got unsupported query type. See CosmJS 0.31 CHANGELOG for API breaking changes here.");
}
const filtered = txs.filter((tx) => tx.height >= minHeight && tx.height <= maxHeight);
return filtered;
return this.txsQuery(rawQuery);
}
public disconnect(): void {
@@ -464,6 +457,7 @@ export class StargateClient {
events: result.events,
rawLog: result.rawLog,
transactionHash: txId,
msgResponses: result.msgResponses,
gasUsed: result.gasUsed,
gasWanted: result.gasWanted,
}
@@ -511,9 +505,10 @@ export class StargateClient {
return transactionId;
}
private async txsQuery(query: string): Promise<readonly IndexedTx[]> {
private async txsQuery(query: string): Promise<IndexedTx[]> {
const results = await this.forceGetTmClient().txSearchAll({ query: query });
return results.txs.map((tx) => {
return results.txs.map((tx): IndexedTx => {
const txMsgData = TxMsgData.decode(tx.result.data ?? new Uint8Array());
return {
height: tx.height,
txIndex: tx.index,
@@ -522,6 +517,7 @@ export class StargateClient {
events: tx.result.events.map(fromTendermintEvent),
rawLog: tx.result.log || "",
tx: tx.tx,
msgResponses: txMsgData.msgResponses,
gasUsed: tx.result.gasUsed,
gasWanted: tx.result.gasWanted,
};
packages/stargate/src/testutils.spec.ts
+18 -16
View File
@@ -23,35 +23,37 @@ export function simapp46Enabled(): boolean {
return !!process.env.SIMAPP46_ENABLED;
}
export function simapp47Enabled(): boolean {
return !!process.env.SIMAPP47_ENABLED;
}
export function simappEnabled(): boolean {
return simapp44Enabled() || simapp46Enabled();
return simapp44Enabled() || simapp46Enabled() || simapp47Enabled();
}
export function pendingWithoutSimapp44Or46(): void {
if (!simapp44Enabled() && !simapp46Enabled()) {
return pending("Set SIMAPP{44,46}_ENABLED to enable Simapp based tests");
}
}
export function pendingWithoutSimapp46(): void {
if (!simapp46Enabled()) {
return pending("Set SIMAPP46_ENABLED to enable Simapp based tests");
export function pendingWithoutSimapp46OrHigher(): void {
if (!simapp46Enabled() && !simapp47Enabled()) {
return pending("Set SIMAPP46_ENABLED or SIMAPP47_ENABLED to enable Simapp based tests");
}
}
export function pendingWithoutSimapp(): void {
if (!simappEnabled()) {
return pending("Set SIMAPP{44,46}_ENABLED to enable Simapp based tests");
return pending("Set SIMAPP{44,46,47}_ENABLED to enable Simapp based tests");
}
}
export function slowSimappEnabled(): boolean {
return !!process.env.SLOW_SIMAPP44_ENABLED || !!process.env.SLOW_SIMAPP46_ENABLED;
return (
!!process.env.SLOW_SIMAPP44_ENABLED ||
!!process.env.SLOW_SIMAPP46_ENABLED ||
!!process.env.SLOW_SIMAPP47_ENABLED
);
}
export function pendingWithoutSlowSimapp(): void {
if (!slowSimappEnabled()) {
return pending("Set SLOW_SIMAPP{44,46}_ENABLED to enable slow Simapp based tests");
return pending("Set SLOW_SIMAPP{44,46,47}_ENABLED to enable slow Simapp based tests");
}
}
@@ -155,7 +157,7 @@ export const validator = {
*/
pubkey: {
type: "tendermint/PubKeySecp256k1",
value: "AtDcuH4cX1eaxZrJ5shheLG3tXPAoV4awoIZmNQtQxmf",
value: "A0RZ3+xLf9xJiySHQxQsQtW8HJYEcniJKbFxG2R9ZEQv",
},
/**
* delegator_address from /cosmos.staking.v1beta1.MsgCreateValidator in scripts/simapp44/template/.simapp/config/genesis.json
@@ -164,7 +166,7 @@ export const validator = {
* jq ".app_state.genutil.gen_txs[0].body.messages[0].delegator_address" scripts/simapp44/template/.simapp/config/genesis.json
* ```
*/
delegatorAddress: "cosmos1urk9gy7cfws0ak9x5nu7lx4un9n6gqkry79679",
delegatorAddress: "cosmos12nt2hqjps8r065wc02qks88tvqzdeua0ld3jxy",
/**
* validator_address from /cosmos.staking.v1beta1.MsgCreateValidator in scripts/simapp44/template/.simapp/config/genesis.json
*
@@ -172,7 +174,7 @@ export const validator = {
* jq ".app_state.genutil.gen_txs[0].body.messages[0].validator_address" scripts/simapp44/template/.simapp/config/genesis.json
* ```
*/
validatorAddress: "cosmosvaloper1urk9gy7cfws0ak9x5nu7lx4un9n6gqkrp230jk",
validatorAddress: "cosmosvaloper12nt2hqjps8r065wc02qks88tvqzdeua06e982h",
accountNumber: 0,
sequence: 1,
};
packages/stargate/webpack.web.config.js
+2
View File
@@ -21,6 +21,8 @@ module.exports = [
SLOW_SIMAPP44_ENABLED: "",
SIMAPP46_ENABLED: "",
SLOW_SIMAPP46_ENABLED: "",
SIMAPP47_ENABLED: "",
SLOW_SIMAPP47_ENABLED: "",
}),
new webpack.ProvidePlugin({
Buffer: ["buffer", "Buffer"],