demo-protobuf: Add alternatives to generated static code

This commit is contained in:
willclarktech 2020-06-15 13:38:02 +01:00
parent 75cb4b92f2
commit 90d16c61d8
No known key found for this signature in database
GPG Key ID: 551A86E2E398ADF7
6 changed files with 142 additions and 7 deletions

View File

@ -0,0 +1,12 @@
{
"nested": {
"MsgDemo": {
"fields": {
"example": {
"type": "string",
"id": 1
}
}
}
}
}

View File

@ -0,0 +1,8 @@
export default `
syntax = "proto3";
package demo;
message MsgDemo {
string example = 1;
}
`;

View File

@ -1,14 +1,28 @@
/* eslint-disable @typescript-eslint/camelcase */
import { assert } from "@cosmjs/utils";
import protobuf from "protobufjs";
import reflectionRoot from "./demo";
import demoJson from "./demo.json";
import demoProto from "./demo.proto";
import { cosmos_sdk as cosmosSdk, google } from "./generated/codecimpl";
type MsgDemo = {
readonly example: string;
};
const { Coin } = cosmosSdk.v1;
const { TxBody } = cosmosSdk.tx.v1;
const { MsgSend } = cosmosSdk.x.bank.v1;
const { Any } = google.protobuf;
function getTypeName(typeUrl: string): string {
const parts = typeUrl.split(".");
return parts[parts.length - 1];
}
describe("protobuf demo", () => {
it("works", () => {
it("works with generated static code", () => {
const coin = Coin.create({
denom: "ucosm",
amount: "1234567890",
@ -18,12 +32,9 @@ describe("protobuf demo", () => {
toAddress: Uint8Array.from(Array.from({ length: 20 }, () => 2)),
amount: [coin],
});
// Serialization
const msgSendBytes = MsgSend.encode(msgSend).finish();
const msgSendWrapped = Any.create({
// eslint-disable-next-line @typescript-eslint/camelcase
type_url: "xxx",
type_url: "cosmos_sdk/cosmos.bank.MsgSend",
value: msgSendBytes,
});
const txBody = TxBody.create({
@ -36,12 +47,105 @@ describe("protobuf demo", () => {
// Deserialization
const txBodyDecoded = TxBody.decode(txBodyBytes);
assert(txBodyDecoded.messages[0].value);
const msgSendDecoded = MsgSend.decode(txBodyDecoded.messages[0].value);
const msg = txBodyDecoded.messages[0];
assert(msg.value);
const msgSendDecoded = MsgSend.decode(msg.value);
// fromAddress and toAddress are now Buffers
expect(Uint8Array.from(msgSendDecoded.fromAddress)).toEqual(msgSend.fromAddress);
expect(Uint8Array.from(msgSendDecoded.toAddress)).toEqual(msgSend.toAddress);
expect(msgSendDecoded.amount).toEqual(msgSend.amount);
});
it("works with dynamically loaded proto files", () => {
const { root } = protobuf.parse(demoProto);
const typeUrl = "demo/demo.MsgDemo";
const encoder = root.lookupType(getTypeName(typeUrl));
const msgDemo = (encoder.create({
example: "Some example text",
}) as unknown) as MsgDemo;
const msgDemoBytes = encoder.encode(msgDemo).finish();
const msgDemoWrapped = Any.create({
type_url: typeUrl,
value: msgDemoBytes,
});
const txBody = TxBody.create({
messages: [msgDemoWrapped],
memo: "Some memo",
timeoutHeight: 9999,
extensionOptions: [],
});
const txBodyBytes = TxBody.encode(txBody).finish();
// Deserialization
const txBodyDecoded = TxBody.decode(txBodyBytes);
const msg = txBodyDecoded.messages[0];
assert(msg.type_url);
assert(msg.value);
const decoder = root.lookupType(getTypeName(msg.type_url));
const msgDemoDecoded = (decoder.decode(msg.value) as unknown) as MsgDemo;
expect(msgDemoDecoded.example).toEqual(msgDemo.example);
});
it("works with dynamically loaded json files", () => {
const root = protobuf.Root.fromJSON(demoJson);
const typeUrl = "demo/demo.MsgDemo";
const encoder = root.lookupType(getTypeName(typeUrl));
const msgDemo = (encoder.create({
example: "Some example text",
}) as unknown) as MsgDemo;
const msgDemoBytes = encoder.encode(msgDemo).finish();
const msgDemoWrapped = Any.create({
type_url: typeUrl,
value: msgDemoBytes,
});
const txBody = TxBody.create({
messages: [msgDemoWrapped],
memo: "Some memo",
timeoutHeight: 9999,
extensionOptions: [],
});
const txBodyBytes = TxBody.encode(txBody).finish();
// Deserialization
const txBodyDecoded = TxBody.decode(txBodyBytes);
const msg = txBodyDecoded.messages[0];
assert(msg.type_url);
assert(msg.value);
const decoder = root.lookupType(getTypeName(msg.type_url));
const msgDemoDecoded = (decoder.decode(msg.value) as unknown) as MsgDemo;
expect(msgDemoDecoded.example).toEqual(msgDemo.example);
});
it("works with reflection", () => {
const typeUrl = "demo/demo.MsgDemo";
const encoder = reflectionRoot.lookupType(getTypeName(typeUrl));
const msgDemo = (encoder.create({
example: "Some example text",
}) as unknown) as MsgDemo;
const msgDemoBytes = encoder.encode(msgDemo).finish();
const msgDemoWrapped = Any.create({
type_url: typeUrl,
value: msgDemoBytes,
});
const txBody = TxBody.create({
messages: [msgDemoWrapped],
memo: "Some memo",
timeoutHeight: 9999,
extensionOptions: [],
});
const txBodyBytes = TxBody.encode(txBody).finish();
// Deserialization
const txBodyDecoded = TxBody.decode(txBodyBytes);
const msg = txBodyDecoded.messages[0];
assert(msg.type_url);
assert(msg.value);
const decoder = reflectionRoot.lookupType(getTypeName(msg.type_url));
const msgDemoDecoded = (decoder.decode(msg.value) as unknown) as MsgDemo;
expect(msgDemoDecoded.example).toEqual(msgDemo.example);
});
});

View File

@ -0,0 +1,7 @@
import { Field, Root, Type } from "protobufjs";
const MsgDemo = new Type("MsgDemo").add(new Field("example", 1, "string"));
const root = new Root().define("demo").add(MsgDemo);
export default root;

View File

@ -0,0 +1,2 @@
declare const root: import("protobufjs").Namespace;
export default root;

View File

@ -0,0 +1,2 @@
declare const _default: '\nsyntax = "proto3";\npackage demo;\n\nmessage MsgDemo {\n string example = 1;\n}\n';
export default _default;