Skip to content

test(bitcoin-wallet-snap): repair the integration suite and cover template output order #158

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
jeremytsng wants to merge 1 commit into
base: fix/btc-output-reordering-fx-fail
Choose a base branch
from
Draft

test(bitcoin-wallet-snap): repair the integration suite and cover template output order #158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
167 changes: 99 additions & 68 deletions packages/bitcoin-wallet-snap/integration-test/keyring-request.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,11 @@ import { Caip19Asset } from '../src/handlers/caip';
import type { FillPsbtResponse } from '../src/handlers/KeyringRequestHandler';
import { BlockchainTestUtils } from './blockchain-utils';
import { MNEMONIC, ORIGIN } from './constants';
import { buildTemplatePsbt, readOutputs } from './psbt-utils';

const DEPOSIT_SCRIPT =
'5120e44fd4d762ab7db99520bf8cc1b44658404c7626bae50b7d78041d4337bb98b8';
const OP_RETURN_SCRIPT = '6a0568656c6c6f';

const ACCOUNT_INDEX = 3;
const submitRequestMethod = 'keyring_submitRequest';
Expand Down Expand Up @@ -132,24 +137,20 @@ describe('KeyringRequestHandler', () => {
} as KeyringRequest,
});

expect(response).toRespondWith({
pending: false,
result: [
{
address: 'bcrt1qs2fj7czz0amfm74j73yujx6dn6223md56gkkuy',
derivationIndex: 0,
outpoint: expect.any(String),
scriptPubkey:
'OP_0 OP_PUSHBYTES_20 82932f60427f769dfab2f449c91b4d9e94a8edb4',
scriptPubkeyHex: '001482932f60427f769dfab2f449c91b4d9e94a8edb4',
value: '1000000000',
},
],
});
expect(response).toRespondWith([
{
address: 'bcrt1qs2fj7czz0amfm74j73yujx6dn6223md56gkkuy',
derivationIndex: 0,
outpoint: expect.any(String),
scriptPubkey:
'OP_0 OP_PUSHBYTES_20 82932f60427f769dfab2f449c91b4d9e94a8edb4',
scriptPubkeyHex: '001482932f60427f769dfab2f449c91b4d9e94a8edb4',
value: '1000000000',
},
]);

const utxos = (
response.response as { result: { result: { outpoint: string }[] } }
).result.result;
const utxos = (response.response as { result: { outpoint: string }[] })
.result;

response = await snap.onKeyringRequest({
origin: ORIGIN,
Expand All @@ -169,10 +170,7 @@ describe('KeyringRequestHandler', () => {
} as KeyringRequest,
});

expect(response).toRespondWith({
pending: false,
result: utxos[0],
});
expect(response).toRespondWith(utxos[0]);
});

it('publicDescriptor', async () => {
Expand All @@ -190,11 +188,9 @@ describe('KeyringRequestHandler', () => {
} as KeyringRequest,
});

expect(response).toRespondWith({
pending: false,
result:
"wpkh([27f9035f/84'/1'/0']tpubDCkv2fHDfPg5ok9EPv6CDozH72rvY2jgEPm79szMeBwCBwUf2T6n5nLrWFfhuuD48SgzrELezoiyDM9KbZaVen4wuuGwrqQANDhzB7E8yDh/0/*)#sx899xk6",
});
expect(response).toRespondWith(
"wpkh([27f9035f/84'/1'/0']tpubDCkv2fHDfPg5ok9EPv6CDozH72rvY2jgEPm79szMeBwCBwUf2T6n5nLrWFfhuuD48SgzrELezoiyDM9KbZaVen4wuuGwrqQANDhzB7E8yDh/0/*)#sx899xk6",
);
});
});

Expand Down Expand Up @@ -236,11 +232,8 @@ describe('KeyringRequestHandler', () => {
const result = await response;

expect(result).toRespondWith({
pending: false,
result: {
psbt: SIGNED_PSBT,
txid: null,
},
psbt: SIGNED_PSBT,
txid: null,
});
});

Expand Down Expand Up @@ -275,11 +268,8 @@ describe('KeyringRequestHandler', () => {
const result = await response;

expect(result).toRespondWith({
pending: false,
result: {
psbt: expect.any(String), // non deterministic
txid: null,
},
psbt: expect.any(String), // non deterministic
txid: null,
});
});

Expand Down Expand Up @@ -314,12 +304,9 @@ describe('KeyringRequestHandler', () => {
const result = await response;

expect(result).toRespondWith({
pending: false,
result: {
psbt: expect.any(String), // non deterministic
txid: expect.any(String),
canBeMalleable: false,
},
psbt: expect.any(String), // non deterministic
txid: expect.any(String),
canBeMalleable: false,
});

// Regression for issue #597: after broadcasting a partial-spend tx
Expand Down Expand Up @@ -466,11 +453,69 @@ describe('KeyringRequestHandler', () => {
});

expect(response).toRespondWith({
pending: false,
result: {
psbt: expect.any(String), // non deterministic
},
psbt: expect.any(String), // the change amount is not deterministic
});

const { psbt } = (response.response as { result: FillPsbtResponse })
.result;
const templateOutputs = readOutputs(TEMPLATE_PSBT);

// the last template output belongs to the wallet, so it becomes the drain
// output and takes the excess: assert the order, not its value
expect(
readOutputs(psbt)
.slice(0, templateOutputs.length)
.map((output) => output.scriptHex),
).toStrictEqual(templateOutputs.map((output) => output.scriptHex));
});

it('keeps a wallet-owned output in its template position', async () => {
const utxosResponse = await snap.onKeyringRequest({
origin: ORIGIN,
method: submitRequestMethod,
params: {
id: account.id,
origin,
scope: BtcScope.Regtest,
account: account.id,
request: { method: AccountCapability.ListUtxos },
} as KeyringRequest,
});
const ourScriptHex = (
utxosResponse.response as { result: { scriptPubkeyHex: string }[] }
).result[0]?.scriptPubkeyHex as string;

const templateOutputs = [
{ scriptHex: DEPOSIT_SCRIPT, value: 20000 },
{ scriptHex: ourScriptHex, value: 1000 },
{ scriptHex: OP_RETURN_SCRIPT, value: 0 },
];

const response = await snap.onKeyringRequest({
origin: ORIGIN,
method: submitRequestMethod,
params: {
id: account.id,
origin,
scope: BtcScope.Regtest,
account: account.id,
request: {
method: AccountCapability.FillPsbt,
params: {
account: { address: account.address },
psbt: buildTemplatePsbt(templateOutputs),
feeRate: 3,
},
},
} as KeyringRequest,
});

const { psbt } = (response.response as { result: FillPsbtResponse })
.result;
const builtOutputs = readOutputs(psbt);

expect(builtOutputs.slice(0, 3)).toStrictEqual(templateOutputs);
expect(builtOutputs.length).toBeGreaterThan(3);
});

it('fails if invalid PSBT', async () => {
Expand Down Expand Up @@ -526,10 +571,7 @@ describe('KeyringRequestHandler', () => {
});

expect(response).toRespondWith({
pending: false,
result: {
fee: '632',
},
fee: '632',
});
});

Expand Down Expand Up @@ -596,9 +638,7 @@ describe('KeyringRequestHandler', () => {

const signResult = await signResponse;

const { result } = (
signResult.response as { result: { result: FillPsbtResponse } }
).result;
const { result } = signResult.response as { result: FillPsbtResponse };

const response = await snap.onKeyringRequest({
origin: ORIGIN,
Expand All @@ -619,11 +659,8 @@ describe('KeyringRequestHandler', () => {
});

expect(response).toRespondWith({
pending: false,
result: {
txid: expect.any(String),
canBeMalleable: false,
},
txid: expect.any(String),
canBeMalleable: false,
});
});

Expand Down Expand Up @@ -687,11 +724,8 @@ describe('KeyringRequestHandler', () => {
const result = await response;

expect(result).toRespondWith({
pending: false,
result: {
txid: expect.any(String),
canBeMalleable: false,
},
txid: expect.any(String),
canBeMalleable: false,
});
});

Expand Down Expand Up @@ -749,11 +783,8 @@ describe('KeyringRequestHandler', () => {
const result = await response;

expect(result).toRespondWith({
pending: false,
result: {
signature:
'AkcwRAIgZxodJQ60t9Rr/hABEHZ1zPUJ4m5hdM5QLpysH8fDSzgCIENOEuZtYf9/Nn/ZW15PcImkknol403dmZrgoOQ+6K+TASECwDKypXm/ElmVTxTLJ7nao6X5mB/iGbU2Q2qtot0QRL4=',
},
signature:
'AkcwRAIgZxodJQ60t9Rr/hABEHZ1zPUJ4m5hdM5QLpysH8fDSzgCIENOEuZtYf9/Nn/ZW15PcImkknol403dmZrgoOQ+6K+TASECwDKypXm/ElmVTxTLJ7nao6X5mB/iGbU2Q2qtot0QRL4=',
});
});
});
Expand Down
12 changes: 8 additions & 4 deletions packages/bitcoin-wallet-snap/integration-test/keyring.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -353,10 +353,14 @@ describe('Keyring', () => {
},
});

expect(response).toRespondWith({
data: [{ ...FUNDING_TX, account: accoundId }],
next: null,
});
const { data, next } = (
response.response as {
result: { data: unknown[]; next: string | null };
}
).result;

expect(data).toContainEqual({ ...FUNDING_TX, account: accoundId });
expect(next).toBeNull();
});

it('gets an account balance', async () => {
Expand Down
Loading
Loading