fix: inspectability

Author: blake-regalia

build.rs

@@ -6,7 +6,7 @@ use std::path::Path;
 fn main() {
     // config parameters
     let dwb_capacity = env::var("DWB_CAPACITY").unwrap_or_else(|_| "64".to_string());
-    let btbe_capacity = env::var("BTBE_CAPACITY").unwrap_or_else(|_| "128".to_string());
+    let btbe_capacity = env::var("BTBE_CAPACITY").unwrap_or_else(|_| "64".to_string());
 
     // path to destination config.rs file
     let out_dir = env::var("OUT_DIR").expect("Missing OUT_DIR");

src/contract.rs

@@ -313,7 +313,8 @@ pub fn execute(deps: DepsMut, env: Env, info: MessageInfo, msg: ExecuteMsg) -> S
     };
 
     let padded_result = pad_handle_result(response, RESPONSE_BLOCK_SIZE);
-    msg.evaporate_to_target(api)?;
+    let evaporated = msg.evaporate_to_target(api)?;
+
     padded_result
 }
 

src/dwb.rs

@@ -11,6 +11,10 @@ use crate::state::{safe_add, safe_add_u64};
 use crate::transaction_history::{Tx, TRANSACTIONS};
 #[cfg(feature = "gas_tracking")]
 use crate::gas_tracker::GasTracker;
+#[cfg(feature = "gas_tracking")]
+use cosmwasm_std::{Binary, to_binary};
+#[cfg(feature = "gas_tracking")]
+use crate::msg::QueryAnswer;
 
 include!(concat!(env!("OUT_DIR"), "/config.rs"));
 

src/msg.rs

@@ -368,11 +368,11 @@ pub enum ExecuteAnswer {
 }
 
 pub trait Evaporator {
-    fn evaporate_to_target(&self, api: &dyn Api) -> StdResult<()>;
+    fn evaporate_to_target(&self, api: &dyn Api) -> StdResult<u64>;
 }
 
 impl Evaporator for ExecuteMsg {
-    fn evaporate_to_target(&self, api: &dyn Api) -> StdResult<()> {
+    fn evaporate_to_target(&self, api: &dyn Api) -> StdResult<u64> {
         match self {
             ExecuteMsg::Redeem { gas_target, .. }
             | ExecuteMsg::Deposit { gas_target, .. }
@@ -407,10 +407,11 @@ impl Evaporator for ExecuteMsg {
                     if gas_used < gas_target.u64() {
                         let evaporate_amount = gas_target.u64() - gas_used;
                         api.gas_evaporate(evaporate_amount as u32)?;
+                        return Ok(evaporate_amount)
                     }
-                    Ok(())
+                    Ok(0)
                 }
-                None => Ok(()),
+                None => Ok(0),
             },
         }
     }

tests/dwb/.env.example

@@ -0,0 +1,4 @@
+SECRET_LCD=http://localhost:1317
+SECRET_RPC=http://localhost:26657
+SECRET_CHAIN=secretdev-1
+ENABLE_EVAPORATION_TESTS=1

tests/dwb/README.md

@@ -0,0 +1,29 @@
+# DWB Integration Test Suite
+
+## Requirements
+The test suite is run using [bun](https://bun.sh/).
+
+## Setup
+From this directory:
+```sh
+bun install
+cp .env.example .env
+```
+
+Edit the `.env` file (or leave as is) to configure the network to either your localsecret or pulsar-3.
+
+## Run
+```sh
+bun run test  ## compiles the contract for integration tests and runs the main test suite
+```
+
+
+## Debugging
+
+In case there is a silent failure, it may help to run the suite using node.js instead of bun. You can compile it and run it and debug it interactively with the following commands:
+```sh
+bun run build && node --env-file=.env --inspect-brk dist/main.js
+```
+
+The console output should look something like this:
+![Integration test preview](https://github.com/user-attachments/assets/be2fedda-550c-45e6-aee4-5af45a84d5b8)

tests/dwb/src/constants.ts

@@ -3,8 +3,9 @@ import type {TrustedContextUrl} from '@solar-republic/types';
 import {base64_to_bytes} from '@blake.regalia/belt';
 import {Wallet} from '@solar-republic/neutrino';
 
-export const P_LOCALSECRET_LCD = (process.env['SECRET_LCD'] || 'http://localhost:1317') as TrustedContextUrl;
-export const P_LOCALSECRET_RPC = (process.env['SECRET_RPC'] || 'http://localhost:26656') as TrustedContextUrl;
+export const P_SECRET_LCD = (process.env['SECRET_LCD'] || 'http://localhost:1317') as TrustedContextUrl;
+export const P_SECRET_RPC = (process.env['SECRET_RPC'] || 'http://localhost:26656') as TrustedContextUrl;
+export const SI_SECRET_CHAIN = (process.env['SECRET_CHAIN'] || 'secretdev-1') as TrustedContextUrl;
 export const B_TEST_EVAPORATION = !!parseInt(process.env['ENABLE_EVAPORATION_TESTS'] || '0');
 
 export const X_GAS_PRICE = 0.1;
@@ -15,7 +16,7 @@ export const [k_wallet_a, k_wallet_b, k_wallet_c, k_wallet_d] = await Promise.al
 	'buqil+tLeeW7VLuugvOdTmkP3+tUwlCoScPZxeteBPE=',
 	'UFrCdmofR9iChp6Eg7kE5O3wT+jsOXwJPWwB6kSeuhE=',
 	'MM/1ZSbT5RF1BnaY6ui/i7yEN0mukGzvXUv+jOyjD0E=',
-].map(sb64_sk => Wallet(base64_to_bytes(sb64_sk), 'secretdev-1', P_LOCALSECRET_LCD, P_LOCALSECRET_RPC, 'secret')));
+].map(sb64_sk => Wallet(base64_to_bytes(sb64_sk), SI_SECRET_CHAIN, P_SECRET_LCD, P_SECRET_RPC, 'secret')));
 
 export const H_ADDRS = {
 	[k_wallet_a.addr]: 'Alice',

tests/dwb/src/contract.ts

@@ -15,9 +15,9 @@ import {destructSecretRegistrationKey} from '@solar-republic/cosmos-grpc/secret/
 import {querySecretRegistrationTxKey} from '@solar-republic/cosmos-grpc/secret/registration/v1beta1/query';
 import {SecretWasm, TendermintEventFilter, TendermintWs, broadcast_result, create_and_sign_tx_direct, exec_fees} from '@solar-republic/neutrino';
 
-import {X_GAS_PRICE, P_LOCALSECRET_LCD, P_LOCALSECRET_RPC} from './constants';
+import {X_GAS_PRICE, P_SECRET_LCD, P_SECRET_RPC} from './constants';
 
-const k_tef = await TendermintEventFilter(P_LOCALSECRET_RPC);
+const k_tef = await TendermintEventFilter(P_SECRET_RPC);
 
 export async function exec(k_wallet: Wallet, atu8_msg: EncodedGoogleProtobufAny, xg_gas_limit: bigint): Promise<TxResultTuple> {
 	const [atu8_raw, atu8_signdoc, si_txn] = await create_and_sign_tx_direct(
@@ -43,11 +43,13 @@ export async function upload_code(k_wallet: Wallet, atu8_wasm: Uint8Array): Prom
 	const sb16_hash = cast<CwHexLower>(bytes_to_hex(atu8_hash));
 
 	// fetch all uploaded codes
-	const [,, g_codes] = await querySecretComputeCodes(P_LOCALSECRET_LCD);
+	const [,, g_codes] = await querySecretComputeCodes(P_SECRET_LCD);
 
 	// already uploaded
 	const g_existing = g_codes?.code_infos?.find(g => g.code_hash! === sb16_hash);
 	if(g_existing) {
+		console.info(`Found code ID ${g_existing.code_id} already uploaded to network`);
+
 		return g_existing.code_id as WeakUintStr;
 	}
 
@@ -66,10 +68,10 @@ export async function upload_code(k_wallet: Wallet, atu8_wasm: Uint8Array): Prom
 }
 
 export async function instantiate_contract(k_wallet: Wallet, sg_code_id: WeakUintStr, h_init_msg: JsonObject): Promise<WeakSecretAccAddr> {
-	const [,, g_reg] = await querySecretRegistrationTxKey(P_LOCALSECRET_LCD);
+	const [,, g_reg] = await querySecretRegistrationTxKey(P_SECRET_LCD);
 	const [atu8_cons_pk] = destructSecretRegistrationKey(g_reg!);
 	const k_wasm = SecretWasm(atu8_cons_pk!);
-	const [,, g_hash] = await querySecretComputeCodeHashByCodeId(P_LOCALSECRET_LCD, sg_code_id);
+	const [,, g_hash] = await querySecretComputeCodeHashByCodeId(P_SECRET_LCD, sg_code_id);
 
 	// @ts-expect-error imported types versioning
 	const atu8_body = await k_wasm.encodeMsg(g_hash!.code_hash, h_init_msg);

tests/dwb/src/gas-checker.ts

@@ -23,9 +23,6 @@ export class GasChecker {
 
 		// each group
 		for(const [si_group, a_logs_local] of entries(h_local)) {
-			// logs emitted from this transfer group
-			let c_logs = 0;
-
 			// find group in baseline
 			const a_logs_baseline = _h_baseline[si_group];
 
@@ -50,12 +47,13 @@ export class GasChecker {
 
 				// comment only
 				if('#' === si_group[0]) {
-					console.log([
-						' '.repeat(8)+si_group.slice(0, 20).padEnd(20, ' '),
-						' '.repeat(3),
-						SX_ANSI_CYAN+s_comment_local+SX_ANSI_RESET,
-					].join(' │ '));
-					c_logs += 1;
+					if(s_comment_local.trim()) {
+						console.log([
+							' '.repeat(8)+si_group.slice(0, 20).padEnd(20, ' '),
+							' '.repeat(3),
+							SX_ANSI_CYAN+s_comment_local+SX_ANSI_RESET,
+						].join(' │ '));
+					}
 				}
 				// non-zero delta
 				else if(xg_delta || '@' === s_comment_local[0]) {
@@ -64,7 +62,6 @@ export class GasChecker {
 						delta_color(xg_delta, 3),
 						('@' === s_comment_local[0]? SX_ANSI_MAGENTA: '')+s_comment_local+SX_ANSI_RESET,
 					].join(' │ '));
-					c_logs += 1;
 				}
 			}
 		}

tests/dwb/src/main.ts

@@ -12,7 +12,7 @@ import {encodeGoogleProtobufAny} from '@solar-republic/cosmos-grpc/google/protob
 import {SecretApp, SecretContract, Wallet, broadcast_result, create_and_sign_tx_direct, random_32, type TxMeta, type WeakSecretAccAddr} from '@solar-republic/neutrino';
 import {BigNumber} from 'bignumber.js';
 
-import {B_TEST_EVAPORATION, N_DECIMALS, P_LOCALSECRET_LCD, P_LOCALSECRET_RPC, X_GAS_PRICE, k_wallet_a, k_wallet_b, k_wallet_c, k_wallet_d} from './constants';
+import {B_TEST_EVAPORATION, N_DECIMALS, P_SECRET_LCD, P_SECRET_RPC, SI_SECRET_CHAIN, X_GAS_PRICE, k_wallet_a, k_wallet_b, k_wallet_c, k_wallet_d} from './constants';
 import {upload_code, instantiate_contract} from './contract';
 import {DwbValidator} from './dwb';
 import {GasChecker} from './gas-checker';
@@ -22,6 +22,8 @@ const S_CONTRACT_LABEL = 'snip2x-test_'+bytes_to_base64(crypto.getRandomValues(b
 
 const atu8_wasm = readFileSync('../../contract.wasm');
 
+console.log(k_wallet_a.addr);
+
 console.debug(`Uploading code...`);
 const sg_code_id = await upload_code(k_wallet_a, atu8_wasm);
 
@@ -58,7 +60,7 @@ const k_contract = await SecretContract<SecretContractInterface<{
 			gas_target?: WeakUint128Str;
 		}];
 	};
-}>>(P_LOCALSECRET_LCD, sa_snip);
+}>>(P_SECRET_LCD, sa_snip);
 
 const k_app_a = SecretApp(k_wallet_a, k_contract, X_GAS_PRICE);
 const k_app_b = SecretApp(k_wallet_b, k_contract, X_GAS_PRICE);
@@ -103,25 +105,29 @@ async function transfer_chain(sx_chain: string) {
 
 // evaporation
 if(B_TEST_EVAPORATION) {
-	const xg_gas_wanted = 250_000n;
-	const xg_gas_target = xg_gas_wanted - 100n;
+	const xg_post_evaporate_buffer = 50_000n;
+	const xg_gas_wanted = 100_000n;
+	const xg_gas_target = xg_gas_wanted - xg_post_evaporate_buffer;
 
 	const [g_exec, xc_code, sx_res, g_meta, h_events, si_txn] = await k_app_a.exec('transfer', {
 		amount: `${500000n}` as CwUint128,
 		recipient: k_wallet_b.addr,
 		gas_target: `${xg_gas_target}`,
 	}, xg_gas_wanted);
 
+	console.log({g_meta});
+
 	if(xc_code) {
 		throw Error(`Failed evaporation test: ${sx_res}`);
 	}
 
 	const xg_gas_used = BigInt(g_meta?.gas_used || '0');
-	if(bigint_abs(xg_gas_wanted, xg_gas_used) > 1000n) {
+	if(xg_gas_used < xg_gas_target) {
+		throw Error(`Expected gas used to be greater than ${xg_gas_target} but only used ${xg_gas_used}`);
+	}
+	else if(bigint_abs(xg_gas_wanted, xg_gas_used) > xg_post_evaporate_buffer) {
 		throw Error(`Expected gas used to be ${xg_gas_wanted} but found ${xg_gas_used}`);
 	}
-
-	console.log(g_meta);
 }
 
 {
@@ -161,7 +167,7 @@ if(B_TEST_EVAPORATION) {
 	for(let i_sim=0; i_sim<N_SIMULATIONS; i_sim++) {
 		const si_receiver = i_sim+'';
 
-		const k_wallet = await Wallet(await sha256(text_to_bytes(si_receiver)), 'secretdev-1', P_LOCALSECRET_LCD, P_LOCALSECRET_RPC, 'secret');
+		const k_wallet = await Wallet(await sha256(text_to_bytes(si_receiver)), SI_SECRET_CHAIN, P_SECRET_LCD, P_SECRET_RPC, 'secret');
 
 		const k_app_sim = SecretApp(k_wallet, k_contract, X_GAS_PRICE);
 
@@ -223,8 +229,8 @@ if(B_TEST_EVAPORATION) {
 		const si_owner = i_sim+'';
 		const si_recipient = (i_sim - 1)+'';
 
-		const k_wallet_owner = await Wallet(await sha256(text_to_bytes(si_owner)), 'secretdev-1', P_LOCALSECRET_LCD, P_LOCALSECRET_RPC, 'secret');
-		const k_wallet_recipient = await Wallet(await sha256(text_to_bytes(si_recipient)), 'secretdev-1', P_LOCALSECRET_LCD, P_LOCALSECRET_RPC, 'secret');
+		const k_wallet_owner = await Wallet(await sha256(text_to_bytes(si_owner)), SI_SECRET_CHAIN, P_SECRET_LCD, P_SECRET_RPC, 'secret');
+		const k_wallet_recipient = await Wallet(await sha256(text_to_bytes(si_recipient)), SI_SECRET_CHAIN, P_SECRET_LCD, P_SECRET_RPC, 'secret');
 
 		const k_app_owner = SecretApp(k_wallet_owner, k_contract, X_GAS_PRICE);
 		const k_app_recipient = SecretApp(k_wallet_recipient, k_contract, X_GAS_PRICE);