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

Merge pull request #1022 from cosmos/gas-in-cosmwasm

Browse Source 
Add height/gasWanted/gasUsed values to all result types of CosmWasm client
This commit is contained in:
Simon Warta 2022-02-07 10:57:02 +01:00 committed by GitHub
commit 63c1c0a3c9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 82 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGELOG.md
View File

@ -13,6 +13,8 @@ and this project adheres to
`AminoTypesOptions`. This is an object with a required `prefix` field. Before
the prefix defaulted to "cosmos" but this is almost never the right choice for
CosmJS users that need to add Amino types manually. ([#989])
- @cosmjs/cosmwasm-stargate: `height`, `gasWanted` and `gasUsed` have been added
to all result types of `SigningCosmWasmClient`
- @cosmjs/stargate: `MsgSend` and `Coin` are now parts of `defaultRegistryTypes`. ([#994])
- @cosmjs/proto-signing: `Registry`'s constructor can now override default types. ([#994])
- @cosmjs/tendermint-rpc: The property `evidence` in the interface `Block` is now

51
packages/cosmwasm-stargate/src/signingcosmwasmclient.spec.ts
View File

@ -123,7 +123,7 @@ describe("SigningCosmWasmClient", () => {
const { codeId } = await client.upload(alice.address0, getHackatom().data, defaultUploadFee);
const funds = [coin(1234, "ucosm"), coin(321, "ustake")];
const beneficiaryAddress = makeRandomAddress();
const { contractAddress } = await client.instantiate(
const { contractAddress, height, gasWanted, gasUsed } = await client.instantiate(
alice.address0,
codeId,
{
@ -139,9 +139,12 @@ describe("SigningCosmWasmClient", () => {
);
const wasmClient = await makeWasmClient(wasmd.endpoint);
const ucosmBalance = await wasmClient.bank.balance(contractAddress, "ucosm");
expect(ucosmBalance).toEqual(funds[0]);
const ustakeBalance = await wasmClient.bank.balance(contractAddress, "ustake");
expect(ucosmBalance).toEqual(funds[0]);
expect(ustakeBalance).toEqual(funds[1]);
expect(height).toBeGreaterThan(0);
expect(gasWanted).toBeGreaterThan(0);
expect(gasUsed).toBeGreaterThan(0);
client.disconnect();
});
@ -152,7 +155,7 @@ describe("SigningCosmWasmClient", () => {
const client = await SigningCosmWasmClient.connectWithSigner(wasmd.endpoint, wallet, options);
const { codeId } = await client.upload(alice.address0, getHackatom().data, defaultUploadFee);
const beneficiaryAddress = makeRandomAddress();
const { contractAddress } = await client.instantiate(
const { contractAddress, height, gasWanted, gasUsed } = await client.instantiate(
alice.address0,
codeId,
{
@ -166,6 +169,9 @@ describe("SigningCosmWasmClient", () => {
const wasmClient = await makeWasmClient(wasmd.endpoint);
const { contractInfo } = await wasmClient.wasm.getContractInfo(contractAddress);
assert(contractInfo);
expect(height).toBeGreaterThan(0);
expect(gasWanted).toBeGreaterThan(0);
expect(gasUsed).toBeGreaterThan(0);
expect(contractInfo.admin).toEqual(unused.address);
client.disconnect();
});
@ -176,7 +182,12 @@ describe("SigningCosmWasmClient", () => {
const options = { ...defaultSigningClientOptions, prefix: wasmd.prefix };
const client = await SigningCosmWasmClient.connectWithSigner(wasmd.endpoint, wallet, options);
const { codeId } = await client.upload(alice.address0, getHackatom().data, defaultUploadFee);
const { contractAddress: address1 } = await client.instantiate(
const {
contractAddress: address1,
height,
gasWanted,
gasUsed,
} = await client.instantiate(
alice.address0,
codeId,
{
@ -196,6 +207,9 @@ describe("SigningCosmWasmClient", () => {
"contract 2",
defaultInstantiateFee,
);
expect(height).toBeGreaterThan(0);
expect(gasWanted).toBeGreaterThan(0);
expect(gasUsed).toBeGreaterThan(0);
expect(address1).not.toEqual(address2);
client.disconnect();
});
@ -262,11 +276,18 @@ describe("SigningCosmWasmClient", () => {
assert(contractInfo1);
expect(contractInfo1.admin).toEqual(alice.address0);
await client.updateAdmin(alice.address0, contractAddress, unused.address, defaultUpdateAdminFee);
const { height, gasUsed, gasWanted } = await client.updateAdmin(
alice.address0,
contractAddress,
unused.address,
defaultUpdateAdminFee,
);
const { contractInfo: contractInfo2 } = await wasmClient.wasm.getContractInfo(contractAddress);
assert(contractInfo2);
expect(contractInfo2.admin).toEqual(unused.address);
expect(height).toBeGreaterThan(0);
expect(gasWanted).toBeGreaterThan(0);
expect(gasUsed).toBeGreaterThan(0);
client.disconnect();
});
});
@ -297,11 +318,17 @@ describe("SigningCosmWasmClient", () => {
assert(contractInfo1);
expect(contractInfo1.admin).toEqual(alice.address0);
await client.clearAdmin(alice.address0, contractAddress, defaultClearAdminFee);
const { height, gasUsed, gasWanted } = await client.clearAdmin(
alice.address0,
contractAddress,
defaultClearAdminFee,
);
const { contractInfo: contractInfo2 } = await wasmClient.wasm.getContractInfo(contractAddress);
assert(contractInfo2);
expect(contractInfo2.admin).toEqual("");
expect(height).toBeGreaterThan(0);
expect(gasWanted).toBeGreaterThan(0);
expect(gasUsed).toBeGreaterThan(0);
client.disconnect();
});
});
@ -334,13 +361,16 @@ describe("SigningCosmWasmClient", () => {
expect(contractInfo1.admin).toEqual(alice.address0);
const newVerifier = makeRandomAddress();
await client.migrate(
const { height, gasUsed, gasWanted } = await client.migrate(
alice.address0,
contractAddress,
codeId2,
{ verifier: newVerifier },
defaultMigrateFee,
);
expect(height).toBeGreaterThan(0);
expect(gasWanted).toBeGreaterThan(0);
expect(gasUsed).toBeGreaterThan(0);
const { contractInfo: contractInfo2 } = await wasmClient.wasm.getContractInfo(contractAddress);
assert(contractInfo2);
expect({ ...contractInfo2 }).toEqual({
@ -424,6 +454,9 @@ describe("SigningCosmWasmClient", () => {
{ release: {} },
defaultExecuteFee,
);
expect(result.height).toBeGreaterThan(0);
expect(result.gasWanted).toBeGreaterThan(0);
expect(result.gasUsed).toBeGreaterThan(0);
const wasmEvent = result.logs[0].events.find((e) => e.type === "wasm");
assert(wasmEvent, "Event of type wasm expected");
expect(wasmEvent.attributes).toContain({ key: "action", value: "release" });

38
packages/cosmwasm-stargate/src/signingcosmwasmclient.ts
View File

@ -69,8 +69,12 @@ export interface UploadResult {
/** The ID of the code asigned by the chain */
readonly codeId: number;
readonly logs: readonly logs.Log[];
/** Block height in which the transaction is included */
readonly height: number;
/** Transaction hash (might be used as transaction ID). Guaranteed to be non-empty upper-case hex */
readonly transactionHash: string;
readonly gasWanted: number;
readonly gasUsed: number;
}
/**
@ -98,8 +102,12 @@ export interface InstantiateResult {
/** The address of the newly instantiated contract */
readonly contractAddress: string;
readonly logs: readonly logs.Log[];
/** Block height in which the transaction is included */
readonly height: number;
/** Transaction hash (might be used as transaction ID). Guaranteed to be non-empty upper-case hex */
readonly transactionHash: string;
readonly gasWanted: number;
readonly gasUsed: number;
}
/**
@ -107,20 +115,32 @@ export interface InstantiateResult {
*/
export interface ChangeAdminResult {
readonly logs: readonly logs.Log[];
/** Block height in which the transaction is included */
readonly height: number;
/** Transaction hash (might be used as transaction ID). Guaranteed to be non-empty upper-case hex */
readonly transactionHash: string;
readonly gasWanted: number;
readonly gasUsed: number;
}
export interface MigrateResult {
readonly logs: readonly logs.Log[];
/** Block height in which the transaction is included */
readonly height: number;
/** Transaction hash (might be used as transaction ID). Guaranteed to be non-empty upper-case hex */
readonly transactionHash: string;
readonly gasWanted: number;
readonly gasUsed: number;
}
export interface ExecuteResult {
readonly logs: readonly logs.Log[];
/** Block height in which the transaction is included */
readonly height: number;
/** Transaction hash (might be used as transaction ID). Guaranteed to be non-empty upper-case hex */
readonly transactionHash: string;
readonly gasWanted: number;
readonly gasUsed: number;
}
function createDeliverTxResponseErrorMessage(result: DeliverTxResponse): string {
@ -249,7 +269,10 @@ export class SigningCosmWasmClient extends CosmWasmClient {
compressedChecksum: toHex(sha256(compressed)),
codeId: Number.parseInt(codeIdAttr.value, 10),
logs: parsedLogs,
height: result.height,
transactionHash: result.transactionHash,
gasWanted: result.gasWanted,
gasUsed: result.gasUsed,
};
}
@ -281,7 +304,10 @@ export class SigningCosmWasmClient extends CosmWasmClient {
return {
contractAddress: contractAddressAttr.value,
logs: parsedLogs,
height: result.height,
transactionHash: result.transactionHash,
gasWanted: result.gasWanted,
gasUsed: result.gasUsed,
};
}
@ -306,7 +332,10 @@ export class SigningCosmWasmClient extends CosmWasmClient {
}
return {
logs: logs.parseRawLog(result.rawLog),
height: result.height,
transactionHash: result.transactionHash,
gasWanted: result.gasWanted,
gasUsed: result.gasUsed,
};
}
@ -329,7 +358,10 @@ export class SigningCosmWasmClient extends CosmWasmClient {
}
return {
logs: logs.parseRawLog(result.rawLog),
height: result.height,
transactionHash: result.transactionHash,
gasWanted: result.gasWanted,
gasUsed: result.gasUsed,
};
}
@ -356,7 +388,10 @@ export class SigningCosmWasmClient extends CosmWasmClient {
}
return {
logs: logs.parseRawLog(result.rawLog),
height: result.height,
transactionHash: result.transactionHash,
gasWanted: result.gasWanted,
gasUsed: result.gasUsed,
};
}
@ -383,7 +418,10 @@ export class SigningCosmWasmClient extends CosmWasmClient {
}
return {
logs: logs.parseRawLog(result.rawLog),
height: result.height,
transactionHash: result.transactionHash,
gasWanted: result.gasWanted,
gasUsed: result.gasUsed,
};
}