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

Jump to bottom

Fix encoding of all 0 lease and assetMetadataHash #280

Merged
merged 1 commit into from
Apr 1, 2021
Merged

Fix encoding of all 0 lease and assetMetadataHash #280

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
26 changes: 17 additions & 9 deletions src/transaction.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -371,20 +371,24 @@ export class Transaction implements TransactionStorageStructure {
txn.assetMetadataHash.length !== 0
) {
if (typeof txn.assetMetadataHash === 'string') {
const encoded = Buffer.from(txn.assetMetadataHash);
if (encoded.byteLength !== ASSET_METADATA_HASH_LENGTH) {
throw Error(
`assetMetadataHash must be a ${ASSET_METADATA_HASH_LENGTH} byte Uint8Array or string.`
);
}
txn.assetMetadataHash = new Uint8Array(encoded);
} else if (
txn.assetMetadataHash = new Uint8Array(
Buffer.from(txn.assetMetadataHash)
);
}

if (
txn.assetMetadataHash.constructor !== Uint8Array ||
txn.assetMetadataHash.byteLength !== ASSET_METADATA_HASH_LENGTH
)
) {
throw Error(
`assetMetadataHash must be a ${ASSET_METADATA_HASH_LENGTH} byte Uint8Array or string.`
);
}

if (txn.assetMetadataHash.every((value) => value === 0)) {
// if hash contains all 0s, omit it
txn.assetMetadataHash = undefined;
}
} else {
txn.assetMetadataHash = undefined;
}
Expand All @@ -401,6 +405,10 @@ export class Transaction implements TransactionStorageStructure {
throw Error(
`lease must be of length ${ALGORAND_TRANSACTION_LEASE_LENGTH.toString()}.`
);
if (txn.lease.every((value) => value === 0)) {
// if lease contains all 0s, omit it
txn.lease = new Uint8Array(0);
}
} else {
txn.lease = new Uint8Array(0);
}
Expand Down
101 changes: 101 additions & 0 deletions tests/5.Transaction.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,107 @@ describe('Sign', () => {
);
});

it('should not drop a note of all zeros', () => {
const txnWithNote = new algosdk.Transaction({
from: '7ZUECA7HFLZTXENRV24SHLU4AVPUTMTTDUFUBNBD64C73F3UHRTHAIOF6Q',
to: '7ZUECA7HFLZTXENRV24SHLU4AVPUTMTTDUFUBNBD64C73F3UHRTHAIOF6Q',
fee: 10,
amount: 847,
firstRound: 51,
lastRound: 61,
genesisHash: 'JgsgCaCTqIaLeVhyL6XlRu3n7Rfk2FxMeK+wRSaQ7dI=',
note: new Uint8Array(32),
});

const txnWithoutNote = new algosdk.Transaction({
from: '7ZUECA7HFLZTXENRV24SHLU4AVPUTMTTDUFUBNBD64C73F3UHRTHAIOF6Q',
to: '7ZUECA7HFLZTXENRV24SHLU4AVPUTMTTDUFUBNBD64C73F3UHRTHAIOF6Q',
fee: 10,
amount: 847,
firstRound: 51,
lastRound: 61,
genesisHash: 'JgsgCaCTqIaLeVhyL6XlRu3n7Rfk2FxMeK+wRSaQ7dI=',
});

const serializedWithNote = algosdk.encodeUnsignedTransaction(txnWithNote);
const serializedWithoutNote = algosdk.encodeUnsignedTransaction(
txnWithoutNote
);

assert.notDeepStrictEqual(serializedWithNote, serializedWithoutNote);
});

it('should drop a lease of all zeros', () => {
const txnWithLease = new algosdk.Transaction({
from: '7ZUECA7HFLZTXENRV24SHLU4AVPUTMTTDUFUBNBD64C73F3UHRTHAIOF6Q',
to: '7ZUECA7HFLZTXENRV24SHLU4AVPUTMTTDUFUBNBD64C73F3UHRTHAIOF6Q',
fee: 10,
amount: 847,
firstRound: 51,
lastRound: 61,
genesisHash: 'JgsgCaCTqIaLeVhyL6XlRu3n7Rfk2FxMeK+wRSaQ7dI=',
lease: new Uint8Array(32),
});

const txnWithoutLease = new algosdk.Transaction({
from: '7ZUECA7HFLZTXENRV24SHLU4AVPUTMTTDUFUBNBD64C73F3UHRTHAIOF6Q',
to: '7ZUECA7HFLZTXENRV24SHLU4AVPUTMTTDUFUBNBD64C73F3UHRTHAIOF6Q',
fee: 10,
amount: 847,
firstRound: 51,
lastRound: 61,
genesisHash: 'JgsgCaCTqIaLeVhyL6XlRu3n7Rfk2FxMeK+wRSaQ7dI=',
});

const serializedWithLease = algosdk.encodeUnsignedTransaction(txnWithLease);
const serializedWithoutLease = algosdk.encodeUnsignedTransaction(
txnWithoutLease
);

assert.deepStrictEqual(serializedWithLease, serializedWithoutLease);
});

it('should drop an assetMetadataHash of all zeros', () => {
const address =
'BH55E5RMBD4GYWXGX5W5PJ5JAHPGM5OXKDQH5DC4O2MGI7NW4H6VOE4CP4';

const txnWithHash = new algosdk.Transaction({
from: address,
fee: 10,
firstRound: 322575,
lastRound: 323575,
genesisHash: 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=',
assetIndex: 1234,
assetManager: address,
assetReserve: address,
assetFreeze: address,
assetClawback: address,
type: 'acfg',
assetMetadataHash: new Uint8Array(32),
});

const txnWithoutHash = new algosdk.Transaction({
from: address,
fee: 10,
firstRound: 322575,
lastRound: 323575,
genesisHash: 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=',
assetIndex: 1234,
assetManager: address,
assetReserve: address,
assetFreeze: address,
assetClawback: address,
type: 'acfg',
});

const serializedWithHash = algosdk.encodeUnsignedTransaction(txnWithHash);
const serializedWithoutHash = algosdk.encodeUnsignedTransaction(
txnWithoutHash
);

assert.deepStrictEqual(serializedWithHash, serializedWithoutHash);
});

it('should be able to prettyprint and go toString without throwing', () => {
const o = {
from: '7ZUECA7HFLZTXENRV24SHLU4AVPUTMTTDUFUBNBD64C73F3UHRTHAIOF6Q',
Expand Down