-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add support for cosmos.gov.v1 messages (#629)
## Description This PR adds the support to the new x/gov messages Closes: SDK-13 Closes: #625 --- ### Author Checklist *All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.* I have... - [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] targeted the correct branch (see [PR Targeting](https://github.com/desmos-labs/desmjs/blob/master/CONTRIBUTING.md#pr-targeting)) - [ ] provided a link to the relevant issue or specification - [ ] reviewed "Files changed" and left comments if necessary - [ ] confirmed all CI checks have passed ### Reviewers Checklist *All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.* I have... - [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] confirmed all author checklist items have been addressed - [ ] confirmed that this PR does not change production code
- Loading branch information
Showing
155 changed files
with
44,863 additions
and
2,093 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,127 @@ | ||
| import { AminoMsg } from "@cosmjs/amino"; | ||
| import { EncodeObject, Registry } from "@cosmjs/proto-signing"; | ||
| import { | ||
| AminoConverter as CosmJSAminoConverter, | ||
| AminoTypes as CosmJSAminoTypes, | ||
| } from "@cosmjs/stargate"; | ||
| import { Any } from "@desmoslabs/desmjs-types/google/protobuf/any"; | ||
|
|
||
| /** | ||
| * Interface that represents an object capable of convert | ||
| * an {@link EncodeObject} from and to {@link AminoMsg}. | ||
| * NOTE: This is an extension of the {@link CosmJSAminoConverter} from | ||
| * cosmjs to allow the conversion of objects that have a field with | ||
| * type {@link Any} like the MsgExec of the x/authz module. | ||
| */ | ||
| export interface AminoConverter extends CosmJSAminoConverter { | ||
| /** | ||
| * Converts an {@link EncodeObject} to its amino representation. | ||
| * @param encodeObject - The object to convert to {@link AminoMsg}. | ||
| * @param aminoTypes - An object to convert an {@link Any} encoded object | ||
| * from and to {@link AminoMsg}. | ||
| * NOTE: This is optional to make the interface backward compatible with | ||
| * {@link CosmJSAminoConverter}. | ||
| */ | ||
| readonly toAmino: ( | ||
| encodeObject: EncodeObject, | ||
| aminoTypes?: AminoTypes | ||
| ) => AminoMsg; | ||
| /** | ||
| * Converts an {@link AminoMsg} to its {@link EncodeObject} representation. | ||
| * @param aminoMsg - The object to convert to {@link AminoMsg} | ||
| * @param aminoTypes - An object to convert an {@link Any} encoded object | ||
| * from and to {@link AminoMsg}. | ||
| * NOTE: This is optional to make the interface backward compatible with | ||
| * {@link CosmJSAminoConverter}. | ||
| */ | ||
| readonly fromAmino: ( | ||
| aminoMsg: AminoMsg, | ||
| aminoTypes?: AminoTypes | ||
| ) => EncodeObject; | ||
| } | ||
|
|
||
| declare type AminoConverters = Record<string, AminoConverter>; | ||
|
|
||
| /** | ||
| * Extensions of the {@link CosmJSAminoTypes} that supports | ||
| * the amino serialization of messages that have {@link Any} encoed | ||
| * messages as child like the MsgExec of the x/authz module. | ||
| */ | ||
| export class AminoTypes extends CosmJSAminoTypes { | ||
| private readonly converters; | ||
|
|
||
| private readonly registry; | ||
|
|
||
| constructor(converters: AminoConverters, registry: Registry) { | ||
| super(converters); | ||
| this.converters = converters; | ||
| this.registry = registry; | ||
| } | ||
|
|
||
| public override toAmino({ typeUrl, value }: EncodeObject): AminoMsg { | ||
| const converter = this.converters[typeUrl]; | ||
| if (!converter) { | ||
| throw new Error( | ||
| `Type URL '${typeUrl}' does not exist in the Amino message type register. ` + | ||
| "If you need support for this message type, you can pass in additional entries to the AminoTypes constructor. " + | ||
| "If you think this message type should be included by default, please open an issue at https://github.com/cosmos/cosmjs/issues." | ||
| ); | ||
| } | ||
|
|
||
| return { | ||
| type: converter.aminoType, | ||
| value: converter.toAmino(value, this), | ||
| }; | ||
| } | ||
|
|
||
| public override fromAmino({ type, value }: AminoMsg): EncodeObject { | ||
| const matches = Object.entries(this.converters).filter( | ||
| ([, converter]) => converter.aminoType === type | ||
| ); | ||
|
|
||
| switch (matches.length) { | ||
| case 0: { | ||
| throw new Error( | ||
| `Amino type identifier '${type}' does not exist in the Amino message type register. ` + | ||
| "If you need support for this message type, you can pass in additional entries to the AminoTypes constructor. " + | ||
| "If you think this message type should be included by default, please open an issue at https://github.com/cosmos/cosmjs/issues." | ||
| ); | ||
| } | ||
| case 1: { | ||
| const [typeUrl, converter] = matches[0]; | ||
| return { | ||
| typeUrl, | ||
| value: converter.fromAmino(value, this), | ||
| }; | ||
| } | ||
| default: | ||
| throw new Error( | ||
| `Multiple types are registered with Amino type identifier '${type}': '${matches | ||
| .map(([key]) => key) | ||
| .sort() | ||
| .join("', '")}'. Thus fromAmino cannot be performed.` | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Function to convert a {@link Any} encoded object to its | ||
| * amino representation. | ||
| * @param anyEncodedObject - The object to convert to amino. | ||
| */ | ||
| public fromAny(anyEncodedObject: Any): AminoMsg { | ||
| return this.toAmino({ | ||
| typeUrl: anyEncodedObject.typeUrl, | ||
| value: this.registry.decode(anyEncodedObject), | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * Function to convert a {@link AminoMsg} to its {@link Any} | ||
| * representation. | ||
| * @param aminoEncodedObject - The object to convert to {@link Any}. | ||
| */ | ||
| public toAny(aminoEncodedObject: AminoMsg): Any { | ||
| return this.registry.encodeAsAny(this.fromAmino(aminoEncodedObject)); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.