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.

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

chore: release #932

Merged
merged 4 commits into from
Nov 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
131 changes: 70 additions & 61 deletions src/utils/addressMap.test.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { beforeEach, describe, expect, it, vi } from 'vitest';
import { beforeEach, describe, expect, it, test, vi } from 'vitest';
import { address } from '../fixtures/common';
import { Address } from '../serializable/fxs/common';
import { AddressMap, AddressMaps, matchOwners } from './addressMap';
Expand Down Expand Up @@ -245,67 +245,76 @@ describe('AddressMaps', () => {
});

describe('matchOwners', () => {
it('matches owners', () => {
const owner1 = address();
const owner2 = Address.fromHex('7db97c7cece249c2b98bdc0226cc4c2a57bf52fc');
const ownerAddresses: Uint8Array[] = [owner1.toBytes(), owner2.toBytes()];
const goodOwner = OutputOwners.fromNative(ownerAddresses, 0n, 1);
const threasholdTooHigh = OutputOwners.fromNative(ownerAddresses, 0n, 5);
const wrongOwner = OutputOwners.fromNative(
[hexToBuffer('0x12345123451234512345')],
0n,
5,
);
const locked = OutputOwners.fromNative(
ownerAddresses,
9999999999999999999999999999999999n,
5,
);
const owner1 = address();
const owner2 = Address.fromHex('7db97c7cece249c2b98bdc0226cc4c2a57bf52fc');
const ownerAddresses: Uint8Array[] = [owner1.toBytes(), owner2.toBytes()];
// NOTE: the ownerAddresses will be sorted in the OutputOwners -- owner2 is at index 0.
const goodOwner = OutputOwners.fromNative(ownerAddresses, 0n, 1);
const goodOwnerMultisig = OutputOwners.fromNative(ownerAddresses, 0n, 2);
const threasholdTooHigh = OutputOwners.fromNative(ownerAddresses, 0n, 5);
const wrongOwner = OutputOwners.fromNative(
[hexToBuffer('0x12345123451234512345')],
0n,
5,
);
const locked = OutputOwners.fromNative(
ownerAddresses,
9999999999999999999999999999999999n,
5,
);

const specs = [
{
testCase: goodOwner,
expectedSigIndices: [0],
expectedAddressMap: new AddressMap([[owner1, 0]]),
},
{
testCase: threasholdTooHigh,
expectedSigIndices: undefined,
expectedAddressMap: undefined,
},
{
testCase: locked,
expectedSigIndices: undefined,
expectedAddressMap: undefined,
},
{
testCase: wrongOwner,
expectedSigIndices: undefined,
expectedAddressMap: undefined,
},
{
testCase: goodOwner,
sigindices: [1],
expectedSigIndices: [1],
expectedAddressMap: new AddressMap([[owner2, 1]]),
},
{
testCase: goodOwner,
sigindices: [2],
expectedSigIndices: undefined,
expectedAddressMap: undefined,
},
];
const specs = [
{
testCase: goodOwner,
expectedSigIndices: [0],
expectedAddressMap: new AddressMap([[owner2, 0]]),
},
{
testCase: threasholdTooHigh,
expectedSigIndices: undefined,
expectedAddressMap: undefined,
},
{
testCase: locked,
expectedSigIndices: undefined,
expectedAddressMap: undefined,
},
{
testCase: wrongOwner,
expectedSigIndices: undefined,
expectedAddressMap: undefined,
},
{
testCase: goodOwner,
sigindices: [1],
expectedSigIndices: [1],
expectedAddressMap: new AddressMap([[owner1, 1]]),
},
{
testCase: goodOwnerMultisig,
sigindices: [0, 1],
expectedSigIndices: [0, 1],
expectedAddressMap: new AddressMap([
[owner2, 0],
[owner1, 1],
]),
},
{
testCase: goodOwner,
sigindices: [2],
expectedSigIndices: undefined,
expectedAddressMap: undefined,
},
];

specs.forEach((spec) => {
const result = matchOwners(
spec.testCase,
addressesFromBytes(ownerAddresses),
50n,
spec.sigindices,
);
expect(result?.sigIndicies).toEqual(spec.expectedSigIndices);
expect(result?.addressMap).toEqual(spec.expectedAddressMap);
});
test.each(specs)('matchOwners($testCase, $sigIndices)', (spec) => {
const result = matchOwners(
spec.testCase,
addressesFromBytes(ownerAddresses),
50n,
spec.sigindices,
);
expect(result?.sigIndicies).toEqual(spec.expectedSigIndices);
expect(result?.addressMap).toEqual(spec.expectedAddressMap);
});
});
4 changes: 3 additions & 1 deletion src/utils/addressesFromBytes.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
import { Address } from '../serializable/fxs/common';
import { bytesCompare } from './bytesCompare';

export function addressesFromBytes(bytes: readonly Uint8Array[]): Address[] {
return bytes.map((b) => new Address(b));
const sortedBytes = bytes.toSorted(bytesCompare);
return sortedBytes.map((b) => new Address(b));
}
7 changes: 7 additions & 0 deletions src/vms/pvm/etna-builder/builder.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -308,6 +308,13 @@ describe('./src/vms/pvm/etna-builder/builder.test.ts', () => {
);

expectTxs(unsignedTx.getTx(), expectedTx);

// Ensure that the unsigned tx utxos are the filtered utxos,
// and not the inputUtxos registered in the spend helper.
// This is only relevant for the ImportTx.
expect(unsignedTx.utxos).toHaveLength(1);
expect(unsignedTx.utxos).not.toContain(utxos[0]);
expect(unsignedTx.utxos).not.toContain(utxos[1]);
});

test('newExportTx', () => {
Expand Down
99 changes: 52 additions & 47 deletions src/vms/pvm/etna-builder/builder.ts
Original file line number Diff line number Diff line change
Expand Up @@ -302,50 +302,52 @@ export const newImportTx: TxBuilderFn<NewImportTxProps> = (
) => {
const fromAddresses = addressesFromBytes(fromAddressesBytes);

const { importedInputs, importedAmounts } = utxos
.filter(
(utxo): utxo is Utxo<TransferOutput> =>
isTransferOut(utxo.output) &&
// Currently - only AVAX is allowed to be imported to the P-Chain
utxo.assetId.toString() === context.avaxAssetID,
)
.reduce<{
importedInputs: TransferableInput[];
importedAmounts: Record<string, bigint>;
}>(
(acc, utxo) => {
const { sigIndicies: inputSigIndices } =
matchOwners(utxo.getOutputOwners(), fromAddresses, minIssuanceTime) ||
{};

if (inputSigIndices === undefined) {
// We couldn't spend this UTXO, so we skip to the next one.
return acc;
}

const assetId = utxo.getAssetId();

return {
importedInputs: [
...acc.importedInputs,
new TransferableInput(
utxo.utxoId,
utxo.assetId,
new TransferInput(
utxo.output.amt,
new Input(inputSigIndices.map((value) => new Int(value))),
),
const filteredUtxos = utxos.filter(
(utxo): utxo is Utxo<TransferOutput> =>
isTransferOut(utxo.output) &&
// Currently - only AVAX is allowed to be imported to the P-Chain
utxo.assetId.toString() === context.avaxAssetID,
);

const { importedInputs, importedAmounts, inputUtxos } = filteredUtxos.reduce<{
importedInputs: TransferableInput[];
importedAmounts: Record<string, bigint>;
inputUtxos: Utxo[];
}>(
(acc, utxo) => {
const { sigIndicies: inputSigIndices } =
matchOwners(utxo.getOutputOwners(), fromAddresses, minIssuanceTime) ||
{};

if (inputSigIndices === undefined) {
// We couldn't spend this UTXO, so we skip to the next one.
return acc;
}

const assetId = utxo.getAssetId();

return {
importedInputs: [
...acc.importedInputs,
new TransferableInput(
utxo.utxoId,
utxo.assetId,
new TransferInput(
utxo.output.amt,
new Input(inputSigIndices.map((value) => new Int(value))),
),
],
importedAmounts: {
...acc.importedAmounts,
[assetId]:
(acc.importedAmounts[assetId] ?? 0n) + utxo.output.amount(),
},
};
},
{ importedInputs: [], importedAmounts: {} },
);
),
],
importedAmounts: {
...acc.importedAmounts,
[assetId]:
(acc.importedAmounts[assetId] ?? 0n) + utxo.output.amount(),
},
inputUtxos: [...acc.inputUtxos, utxo],
};
},
{ importedInputs: [], importedAmounts: {}, inputUtxos: [] },
);

if (importedInputs.length === 0) {
throw new Error('no UTXOs available to import');
Expand All @@ -355,7 +357,7 @@ export const newImportTx: TxBuilderFn<NewImportTxProps> = (

const addressMaps = AddressMaps.fromTransferableInputs(
importedInputs,
utxos,
filteredUtxos,
minIssuanceTime,
fromAddressesBytes,
);
Expand Down Expand Up @@ -391,13 +393,16 @@ export const newImportTx: TxBuilderFn<NewImportTxProps> = (
fromAddresses,
initialComplexity: complexity,
minIssuanceTime,
utxos,
utxos: filteredUtxos,
},
[useUnlockedUTXOs],
context,
);

const { changeOutputs, inputs, inputUTXOs } = spendResults;
// Note: We don't use the `inputUTXOs` from `spendResults`
// for the `UnsignedTx` because we want to use the original
// UTXOs that were imported.
const { changeOutputs, inputs } = spendResults;

return new UnsignedTx(
new ImportTx(
Expand All @@ -411,7 +416,7 @@ export const newImportTx: TxBuilderFn<NewImportTxProps> = (
Id.fromString(sourceChainId),
importedInputs.sort(TransferableInput.compare),
),
inputUTXOs,
inputUtxos,
addressMaps,
);
};
Expand Down