Skip to content

chore: change proto generate script to apply compatibility patch #187

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
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
164 changes: 164 additions & 0 deletions scripts/amino-json-compatibility.patch
Original file line number Diff line number Diff line change
@@ -0,0 +1,164 @@
diff --git a/src/proto/gno/vm.ts b/src/proto/gno/vm.ts
index 79f24a4..bed60a0 100644
--- a/src/proto/gno/vm.ts
+++ b/src/proto/gno/vm.ts
@@ -42,7 +42,7 @@ export interface MsgAddPackage {
/** the amount of funds to be deposited at deployment, if any ("<amount><denomination>") */
send: string;
/** the amount of funds to put down for the storage fee, if any ("<amount><denomination>") */
- max_deposit: string;
+ max_deposit?: string;
}

/**
@@ -72,9 +72,9 @@ export interface MemPackage {
/** the associated package gno source */
files: MemFile[];
/** the (user defined) package type */
- type?: Any | undefined;
+ type?: Any | null;
/** the (user defined) extra information */
- info?: Any | undefined;
+ info?: Any | null;
}

/**
@@ -221,7 +221,7 @@ export const MsgCall: MessageFns<MsgCall> = {
if (message.send !== undefined) {
obj.send = message.send;
}
- if (message.max_deposit !== undefined) {
+ if (message.max_deposit !== undefined && message.max_deposit !== '') {
obj.max_deposit = message.max_deposit;
}
if (message.pkg_path !== undefined) {
@@ -254,7 +254,7 @@ export const MsgCall: MessageFns<MsgCall> = {
};

function createBaseMsgAddPackage(): MsgAddPackage {
- return { creator: '', package: undefined, send: '', max_deposit: '' };
+ return { creator: '', package: undefined, send: '', max_deposit: undefined };
}

export const MsgAddPackage: MessageFns<MsgAddPackage> = {
@@ -271,7 +271,7 @@ export const MsgAddPackage: MessageFns<MsgAddPackage> = {
if (message.send !== '') {
writer.uint32(26).string(message.send);
}
- if (message.max_deposit !== '') {
+ if (message.max_deposit !== '' && message.max_deposit !== undefined) {
writer.uint32(34).string(message.max_deposit);
}
return writer;
@@ -313,8 +313,10 @@ export const MsgAddPackage: MessageFns<MsgAddPackage> = {
if (tag !== 34) {
break;
}
-
- message.max_deposit = reader.string();
+ const max_deposit = reader.string();
+ if (max_deposit !== '') {
+ message.max_deposit = max_deposit;
+ }
continue;
}
}
@@ -335,7 +337,7 @@ export const MsgAddPackage: MessageFns<MsgAddPackage> = {
send: isSet(object.send) ? globalThis.String(object.send) : '',
max_deposit: isSet(object.max_deposit)
? globalThis.String(object.max_deposit)
- : '',
+ : undefined,
};
},

@@ -371,7 +373,7 @@ export const MsgAddPackage: MessageFns<MsgAddPackage> = {
? MemPackage.fromPartial(object.package)
: undefined;
message.send = object.send ?? '';
- message.max_deposit = object.max_deposit ?? '';
+ message.max_deposit = object.max_deposit ?? undefined;
return message;
},
};
@@ -496,7 +498,7 @@ export const MsgRun: MessageFns<MsgRun> = {
};

function createBaseMemPackage(): MemPackage {
- return { name: '', path: '', files: [], type: undefined, info: undefined };
+ return { name: '', path: '', files: [], type: null, info: null };
}

export const MemPackage: MessageFns<MemPackage> = {
@@ -513,10 +515,10 @@ export const MemPackage: MessageFns<MemPackage> = {
for (const v of message.files) {
MemFile.encode(v!, writer.uint32(26).fork()).join();
}
- if (message.type !== undefined) {
+ if (message.type !== undefined && message.type !== null) {
Any.encode(message.type, writer.uint32(34).fork()).join();
}
- if (message.info !== undefined) {
+ if (message.info !== undefined && message.info !== null) {
Any.encode(message.info, writer.uint32(42).fork()).join();
}
return writer;
@@ -556,6 +558,7 @@ export const MemPackage: MessageFns<MemPackage> = {
}
case 4: {
if (tag !== 34) {
+ message.type = null;
break;
}

@@ -564,6 +567,7 @@ export const MemPackage: MessageFns<MemPackage> = {
}
case 5: {
if (tag !== 42) {
+ message.info = null;
break;
}

@@ -586,8 +590,8 @@ export const MemPackage: MessageFns<MemPackage> = {
files: globalThis.Array.isArray(object?.files)
? object.files.map((e: any) => MemFile.fromJSON(e))
: [],
- type: isSet(object.type) ? Any.fromJSON(object.type) : undefined,
- info: isSet(object.info) ? Any.fromJSON(object.info) : undefined,
+ type: isSet(object.type) ? Any.fromJSON(object.type) : null,
+ info: isSet(object.info) ? Any.fromJSON(object.info) : null,
};
},

@@ -602,11 +606,15 @@ export const MemPackage: MessageFns<MemPackage> = {
if (message.files?.length) {
obj.files = message.files.map((e) => MemFile.toJSON(e));
}
- if (message.type !== undefined) {
+ if (message.type !== undefined && message.type !== null) {
obj.type = Any.toJSON(message.type);
+ } else {
+ obj.type = null;
}
- if (message.info !== undefined) {
+ if (message.info !== undefined && message.info !== null) {
obj.info = Any.toJSON(message.info);
+ } else {
+ obj.info = null;
}
return obj;
},
@@ -624,11 +632,11 @@ export const MemPackage: MessageFns<MemPackage> = {
message.type =
object.type !== undefined && object.type !== null
? Any.fromPartial(object.type)
- : undefined;
+ : null;
message.info =
object.info !== undefined && object.info !== null
? Any.fromPartial(object.info)
- : undefined;
+ : null;
return message;
},
};
14 changes: 14 additions & 0 deletions scripts/generate.sh
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,17 @@ for x in ${FILES}; do
--ts_proto_opt="esModuleInterop=true,forceLong=long,useOptionals=messages,useDate=false,snakeToCamel=false,emitDefaultValues=json-methods" \
${x}
done

# Apply amino JSON compatibility changes to patch proto generated files.
# Patch fixes two issues:
# - Empty `max_deposit` is represented in JSON as an empty string in proto while omitted completely in Amino JSON
# - Empty `google.protobuf.Any` fields are omitted in proto JSON while explicitly set to null in Amino JSON
#
# See: https://github.com/gnolang/gno-js-client/pull/184
#
# This is a short term solution that potentially requires maintaining the patch updated.
if [ $? -eq 0 ]; then
# First prettify generated code to allow the patch to be applied
./node_modules/.bin/prettier --write ${OUT_DIR}/gno/vm.ts && \
Copy link
Member Author

Choose a reason for hiding this comment

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

The proto generated code seems to have been prettified, without this extra step the changes from #184 don't apply successfully right after the gno/vm.ts file is generated

git apply ./scripts/amino-json-compatibility.patch
fi