Skip to content
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

refactor: simplify wallet ord logic #452

Merged
merged 4 commits into from
Jan 14, 2025
Merged

refactor: simplify wallet ord logic #452

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
16b6041
refactor: simplify wallet ord logic
gregdhill Jan 13, 2025
0e75865
chore: run prettier format
slavastartsev Jan 13, 2025
8c9d875
chore: skip process utxo test
slavastartsev Jan 13, 2025
03b315e
chore: uncomment test for find safe utxo
slavastartsev Jan 14, 2025
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
146 changes: 49 additions & 97 deletions sdk/src/wallet/utxo.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,134 +17,87 @@

type Output = { address: string; amount: bigint } | { script: Uint8Array; amount: bigint };

class TreeNode<T> {
val: T;
children: TreeNode<T>[];
const isCardinalOutput = (output: OutputJson) =>
output.inscriptions.length === 0 && Object.keys(output.runes).length === 0;

constructor(val: T, children: TreeNode<T>[] = []) {
this.val = val;
this.children = children;
}
}

const isCardinal = (output: OutputJson) => output.inscriptions.length === 0 && Object.keys(output.runes).length === 0;

const createUtxoNodes = async (
utxos: UTXO[],
const isCardinalTx = async (
txid: string,
cardinalOutputsSet: Set<string>,
ordinalsClient: OrdinalsClient
): Promise<(null | TreeNode<OutputNodeData>)[]> => {
return Promise.all(
utxos.map<Promise<TreeNode<OutputNodeData> | null>>(async (utxo) => {
if (cardinalOutputsSet.has(OutPoint.toString(utxo))) return null;

const output = await ordinalsClient.getInscriptionsFromOutPoint(utxo);

return new TreeNode<OutputNodeData>({
...utxo,
cardinal: isCardinal(output),
indexed: output.indexed,
});
esploraClient: EsploraClient,
ordinalsClient: OrdinalsClient,
limit: number = 3
): Promise<boolean> => {
if (limit === 0) return false;
const transaction = await esploraClient.getTransaction(txid);
const results = await Promise.all(
transaction.vin.map(async (vin) => {
if (cardinalOutputsSet.has(OutPoint.toString(vin))) return true;

const output = await ordinalsClient.getInscriptionsFromOutPoint(vin);
if (output.indexed) {
return isCardinalOutput(output);
} else {
return isCardinalTx(vin.txid, cardinalOutputsSet, esploraClient, ordinalsClient, limit - 1);
}
})
);
};

const processNodes = async (
rootNodes: (TreeNode<OutputNodeData> | null)[],
cardinalOutputsSet: Set<string>,
esploraClient: EsploraClient,
ordinalsClient: OrdinalsClient
) => {
const queue = Array.from(rootNodes);

while (queue.length > 0) {
const childNode = queue.shift();

if (childNode === null) continue;

const transaction = await esploraClient.getTransaction(childNode.val.txid);

if (transaction.status.confirmed) {
// if confirmed check if it contains ordinals
childNode.val.cardinal = cardinalOutputsSet.has(OutPoint.toString(childNode.val));
} else if (!childNode.val.indexed || childNode.val.cardinal) {
// if not confirmed check inputs for current utxo
childNode.children = await Promise.all(
transaction.vin.map(async (vin) => {
const output = await ordinalsClient.getInscriptionsFromOutPoint(vin);

return new TreeNode<OutputNodeData>({
vout: vin.vout,
txid: vin.txid,
cardinal: isCardinal(output),
indexed: output.indexed,
});
})
);

queue.push(...childNode.children);
}
}
};

const checkUtxoNode = (node: TreeNode<OutputNodeData> | null): boolean => {
// if `null` then node is confirmed and indexed and included in cardinals set -> can be spent
if (node === null) return true;
// leaf node either confirmed or contains ordinals
if (node.children.length === 0) return node.val.cardinal;

return node.children.reduce((acc, child) => acc && checkUtxoNode(child), true);
return results.every((result) => result === true);
};

/**
* @ignore
*/
export const _processUtxos = async (
export const findSafeUtxos = async (
utxos: UTXO[],
cardinalOutputsSet: Set<string>,
esploraClient: EsploraClient,
ordinalsClient: OrdinalsClient
): Promise<UTXO[]> => {
const rootUtxoNodes = await createUtxoNodes(utxos, cardinalOutputsSet, ordinalsClient);

await processNodes(rootUtxoNodes, cardinalOutputsSet, esploraClient, ordinalsClient);
const results = await Promise.all(
utxos.map(async (utxo) => {
// the utxo is confirmed and a known cardinal
if (cardinalOutputsSet.has(OutPoint.toString(utxo))) return true;

const allowedList = rootUtxoNodes.map(checkUtxoNode);
// the utxo is unconfirmed (not indexed by Ord)
return isCardinalTx(utxo.txid, cardinalOutputsSet, esploraClient, ordinalsClient);
})
);

return utxos.filter((_, index) => allowedList[index]);
return utxos.filter((_, index) => results[index]);
};

// NOTE: consider refactoring boolean argument
const processUtxos = async (address: string, esploraClient: EsploraClient, checkUtxos = false): Promise<UTXO[]> => {
const addressInfo = getAddressInfo(address);

const ordinalsClient = new OrdinalsClient(addressInfo.network);

const getSafeUtxos = async (
address: string,
esploraClient: EsploraClient,
ordinalsClient: OrdinalsClient
): Promise<UTXO[]> => {
const [utxos, cardinalOutputs] = await Promise.all([
// all utxos including unconfirmed txs
esploraClient.getAddressUtxos(address),
// cardinal = return UTXOs not containing inscriptions or runes
ordinalsClient.getOutputsFromAddress(address, 'cardinal'),
]);

if (checkUtxos && utxos.length === 0) {
throw new Error('No confirmed UTXOs');
}

const cardinalOutputsSet = new Set(cardinalOutputs.map((output) => output.outpoint));

return _processUtxos(utxos, cardinalOutputsSet, esploraClient, ordinalsClient);
return findSafeUtxos(utxos, cardinalOutputsSet, esploraClient, ordinalsClient);
};

const collectPossibleInputs = async (fromAddress: string, publicKey: string) => {
const addressInfo = getAddressInfo(fromAddress);

const esploraClient = new EsploraClient(addressInfo.network);
const ordinalsClient = new OrdinalsClient(addressInfo.network);

const allowedUtxos = await processUtxos(fromAddress, esploraClient, true);
const safeUtxos = await getSafeUtxos(fromAddress, esploraClient, ordinalsClient);

if (safeUtxos.length === 0) {
throw new Error('No confirmed UTXOs');
}

// To construct the spending transaction and estimate the fee, we need the transactions for the UTXOs
return Promise.all(
allowedUtxos.map(async (utxo) => {
safeUtxos.map(async (utxo) => {
const hex = await esploraClient.getTransactionHex(utxo.txid);
const transaction = Transaction.fromRaw(Buffer.from(hex, 'hex'), { allowUnknownOutputs: true });
const input = getInputFromUtxoAndTx(
Expand All @@ -160,8 +113,6 @@
);
};

type OutputNodeData = Pick<UTXO, 'txid' | 'vout'> & { cardinal: boolean; indexed: boolean };

export interface Input {
txid: string;
index: number;
Expand Down Expand Up @@ -279,7 +230,7 @@
console.debug(`fromAddress: ${fromAddress}, toAddress: ${toAddress}, amount: ${amount}`);
console.debug(`publicKey: ${publicKey}, opReturnData: ${opReturnData}`);
console.debug(`feeRate: ${feeRate}, confirmationTarget: ${confirmationTarget}`);
throw new Error('Failed to create transaction. Do you have enough funds?');

Check failure on line 233 in sdk/src/wallet/utxo.ts

View workflow job for this annotation

GitHub Actions / SDK

test/utxo.test.ts > UTXO Tests > should not spend outputs with inscriptions 

Error: Failed to create transaction. Do you have enough funds?
 ❯ Module.createBitcoinPsbt src/wallet/utxo.ts:233:15
 ❯ test/utxo.test.ts:374:9
}

return base64.encode(transaction.tx.toPSBT(0));
Expand Down Expand Up @@ -492,12 +443,13 @@
const addressInfo = getAddressInfo(address);

const esploraClient = new EsploraClient(addressInfo.network);
const ordinalsClient = new OrdinalsClient(addressInfo.network);

const allowedUtxos = await processUtxos(address, esploraClient);
const safeUtxos = await getSafeUtxos(address, esploraClient, ordinalsClient);

const total = allowedUtxos.reduce((acc, utxo) => acc + utxo.value, 0);
const total = safeUtxos.reduce((acc, utxo) => acc + utxo.value, 0);

const confirmed = allowedUtxos.reduce((acc, utxo) => {
const confirmed = safeUtxos.reduce((acc, utxo) => {
if (utxo.confirmed) {
return acc + utxo.value;
}
Expand Down
8 changes: 4 additions & 4 deletions sdk/test/utxo.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {
estimateTxFee,
Input,
getBalance,
_processUtxos,
findSafeUtxos,
} from '../src/wallet/utxo';
import { TransactionOutput } from '@scure/btc-signer/psbt';
import { OrdinalsClient, OutPoint } from '../src/ordinal-api';
Expand Down Expand Up @@ -517,8 +517,8 @@ describe('UTXO Tests', () => {

const balanceData = await getBalance(taprootAddress);

expect(balanceData.total).toBeLessThan(BigInt(total));
expect(balanceData.confirmed).toBeLessThan(BigInt(confirmed));
expect(balanceData.total).toEqual(BigInt(total));
expect(balanceData.confirmed).toEqual(BigInt(confirmed));
}
);

Expand Down Expand Up @@ -658,7 +658,7 @@ describe('UTXO Tests', () => {
return result;
});

const allowedUtxos = await _processUtxos(utxos, cardinalOutputsSet, esploraClient, ordinalsClient);
const allowedUtxos = await findSafeUtxos(utxos, cardinalOutputsSet, esploraClient, ordinalsClient);

expect(allowedUtxos).toEqual([utxos[0], utxos[1]]);
});
Expand Down
Loading