Skip to content

add fixed array serialization/deserialization #27

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

Merged
mehtaphysical merged 2 commits into from
Jul 22, 2021
Merged

add fixed array serialization/deserialization #27

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e7c935e
add fixed array serialization/deserialization
mehtaphysical Jul 21, 2021
f092104
add tests for error cases
mehtaphysical Jul 22, 2021
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
21 changes: 17 additions & 4 deletions borsh-ts/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,13 @@ function serializeField(schema: Schema, fieldName: string, value: any, fieldType
throw new BorshError(`Expecting byte array of length ${fieldType[0]}, but got ${value.length} bytes`);
}
writer.writeFixedArray(value);
} else if(fieldType.length === 2 && typeof fieldType[1] === 'number' ) {
if (value.length !== fieldType[1]) {
throw new BorshError(`Expecting byte array of length ${fieldType[1]}, but got ${value.length} bytes`);
}
for(let i = 0; i < fieldType[1]; i++) {
serializeField(schema, null, value[i], fieldType[0], writer);
}
} else {
writer.writeArray(value, (item: any) => { serializeField(schema, fieldName, item, fieldType[0], writer); });
}
Expand Down Expand Up @@ -275,8 +282,8 @@ function serializeField(schema: Schema, fieldName: string, value: any, fieldType

function serializeStruct(schema: Schema, obj: any, writer: BinaryWriter) {
if (typeof obj.borshSerialize === 'function') {
obj.borshSerialize(writer);
return;
obj.borshSerialize(writer);
return;
}
const structSchema = schema.get(obj.constructor);
if (!structSchema) {
Expand Down Expand Up @@ -318,9 +325,15 @@ function deserializeField(schema: Schema, fieldName: string, fieldType: any, rea
if (fieldType instanceof Array) {
if (typeof fieldType[0] === 'number') {
return reader.readFixedArray(fieldType[0]);
} else if(typeof fieldType[1] === 'number') {
const arr = [];
for(let i = 0; i < fieldType[1]; i++) {
arr.push(deserializeField(schema, null, fieldType[0], reader));
}
return arr;
} else {
return reader.readArray(() => deserializeField(schema, fieldName, fieldType[0], reader));
}

return reader.readArray(() => deserializeField(schema, fieldName, fieldType[0], reader));
}

if (fieldType.kind === 'option') {
Expand Down
52 changes: 49 additions & 3 deletions borsh-ts/test/serialize.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,9 +91,55 @@ test('serialize/deserialize with class methods', () => {
expect(newValue).toEqual(item);
});

test('serialize/deserialize fixed array', () => {
const value = new Test({
a: ['hello', 'world']
});
const schema = new Map([[Test, {
kind: 'struct',
fields: [
['a', ['string', 2]]
]
}]]);

const buf = borsh.serialize(schema, value);
const deserializedValue = borsh.deserialize(schema, Test, buf);

expect(buf).toEqual(Buffer.from([5, 0, 0, 0, 104, 101, 108, 108, 111, 5, 0, 0, 0, 119, 111, 114, 108, 100]));
expect(deserializedValue.a).toEqual(['hello', 'world']);
});

Copy link
Member

@ailisp ailisp Jul 22, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This test looks nice. I think we also need a test to test error to serilaize/deserialize when given array has a different array in schema.

test('errors serializing fixed array of wrong size', () => {
const value = new Test({
a: ['hello', 'world', 'you']
});
const schema = new Map([[Test, {
kind: 'struct',
fields: [
['a', ['string', 2]]
]
}]]);

expect(() => borsh.serialize(schema, value)).toThrow('Expecting byte array of length 2, but got 3 bytes');
});

test('errors serializing fixed array of wrong type', () => {
const value = new Test({
a: [244, 34]
});
const schema = new Map([[Test, {
kind: 'struct',
fields: [
['a', ['string', 2]]
]
}]]);

expect(() => borsh.serialize(schema, value)).toThrow('The first argument must be of type string');
});

test('baseEncode string test', async () => {
const encodedValue = borsh.baseEncode("244ZQ9cgj3CQ6bWBdytfrJMuMQ1jdXLFGnr4HhvtCTnM");
const expectedValue = "HKk9gqNj4xb4rLdJuzT5zzJbLa4vHBdYCxQT9H99csQh6nz3Hfpqn4jtWA92";
const encodedValue = borsh.baseEncode('244ZQ9cgj3CQ6bWBdytfrJMuMQ1jdXLFGnr4HhvtCTnM');
const expectedValue = 'HKk9gqNj4xb4rLdJuzT5zzJbLa4vHBdYCxQT9H99csQh6nz3Hfpqn4jtWA92';
expect(encodedValue).toEqual(expectedValue);
});

Expand All @@ -102,7 +148,7 @@ test('baseEncode array test', async () => {
});

test('baseDecode test', async () => {
const value = "HKk9gqNj4xb4rLdJu";
const value = 'HKk9gqNj4xb4rLdJu';
const expectedDecodedArray = [3, 96, 254, 84, 10, 240, 93, 199, 52, 244, 164, 240, 6];
const expectedBuffer = Buffer.from(expectedDecodedArray);
expect(borsh.baseDecode(value)).toEqual(expectedBuffer);
Expand Down
19 changes: 18 additions & 1 deletion lib/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,6 +260,14 @@ function serializeField(schema, fieldName, value, fieldType, writer) {
}
writer.writeFixedArray(value);
}
else if (fieldType.length === 2 && typeof fieldType[1] === 'number') {
if (value.length !== fieldType[1]) {
throw new BorshError(`Expecting byte array of length ${fieldType[1]}, but got ${value.length} bytes`);
}
for (let i = 0; i < fieldType[1]; i++) {
serializeField(schema, null, value[i], fieldType[0], writer);
}
}
else {
writer.writeArray(value, (item) => { serializeField(schema, fieldName, item, fieldType[0], writer); });
}
Expand Down Expand Up @@ -336,7 +344,16 @@ function deserializeField(schema, fieldName, fieldType, reader) {
if (typeof fieldType[0] === 'number') {
return reader.readFixedArray(fieldType[0]);
}
return reader.readArray(() => deserializeField(schema, fieldName, fieldType[0], reader));
else if (typeof fieldType[1] === 'number') {
const arr = [];
for (let i = 0; i < fieldType[1]; i++) {
arr.push(deserializeField(schema, null, fieldType[0], reader));
}
return arr;
}
else {
return reader.readArray(() => deserializeField(schema, fieldName, fieldType[0], reader));
}
}
if (fieldType.kind === 'option') {
const option = reader.readU8();
Expand Down