Skip to content

Budget is a Cosmos SDK module that implements budget functionality.

License

Notifications You must be signed in to change notification settings

CoinedLiberty/budget

 
 

Repository files navigation

codecov PkgGoDev

Budget Module

A budget module is a Cosmos SDK module that implements budget functionality. It is an independent module from other SDK modules and core functionality is to enable anyone to create a budget plan through governance param change proposal. Once it is agreed within the community, voted, and passed, it uses the budget source address to distribute amount of coins by the rate defined in the plan to the collection address. Collecting all budgets and distribution take place every epoch blocks that can be modified by a governance proposal.

One use case is for Gravity DEX farming plan. Budget module can be used to create a budget plan that defines Cosmos Hub's FeeCollector module account where transaction gas fees and part of ATOM inflation are collected as budget source address and uses custom module account (created by budget creator) as collection address. Read spec docs to get to know more about the module.

Budget module v1 is in active development - see "master" branch for the latest update

Installation

Requirements

If you haven't already, install Golang by following the official docs. Make sure that your GOPATH and GOBIN environment variables are properly set up.

Requirement Notes
Go version Go1.15 or higher
Cosmos SDK v0.44.0 or higher

Get Budget Module source code

git clone https://github.com/tendermint/budget.git
cd budget
make install

Development

Test

make test-all

Setup local testnet using script

# This script bootstraps a single local testnet.
# Note that config, data, and keys are created in the ./data/localnet folder and
# RPC, GRPC, and REST ports are all open.
$ make localnet

Resources

About

Budget is a Cosmos SDK module that implements budget functionality.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 89.6%
  • Makefile 6.6%
  • Shell 3.3%
  • Dockerfile 0.5%