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.

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

An example specification of the Cosmos SDK bank module #1271

Merged
merged 39 commits into from
Jan 9, 2024
Merged

Conversation

konnov
Copy link
Contributor

@konnov konnov commented Nov 27, 2023

I've prototyped this specification in January. Since then we have added plenty of good features in the language. It feels to be the right time for merging this spec.

The distinct feature of this example is literate programming. Both the functional specification and the state machine are introduced in the markdown text directly. So the markdown file is the only file that actually needs a review. The text description of the bank module is copied from Cosmos SDK. We do not have to proof-read text issues, if there are any.

This specification could be further improved. For instance, we could more tests. However, it is already large enough. It could still be interesting to the people who are looking at the bank module.

@konnov konnov marked this pull request as ready for review December 13, 2023 13:52
@konnov konnov changed the title A specification of the Cosmos SDK bank module An example specification of the Cosmos SDK bank module Dec 13, 2023
@shonfeder shonfeder self-assigned this Jan 3, 2024
run sendTest = {
init
// the King has bananas and he can send it
.then(send("king",
"donkeykong",
Set("banana").mapBy(d => 2_000)))
Map("banana" -> 2_000)))
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks! This indeed looks much simpler :)

Copy link
Collaborator

Choose a reason for hiding this comment

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

I just realized that I need to update the markdown, and then re-generate the file. I'm doing that right now!

Copy link
Collaborator

@bugarela bugarela left a comment

Choose a reason for hiding this comment

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

I didn't look into much detail, but it looks good to me!

@konnov konnov enabled auto-merge (squash) January 9, 2024 12:30
@konnov
Copy link
Contributor Author

konnov commented Jan 9, 2024

Thanks! Then let's merge it. I have enabled automerge.

@bugarela bugarela disabled auto-merge January 9, 2024 12:44
@bugarela bugarela merged commit 5d1daa7 into main Jan 9, 2024
@bugarela bugarela deleted the igor/cosmos-bank branch January 9, 2024 12:44
@bugarela
Copy link
Collaborator

bugarela commented Jan 9, 2024

For some reason, auto-merge didn't work, so I merged it manually

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants