feats: init payment module

.github/workflows/buf.yml

@@ -0,0 +1,21 @@
+# Protobuf files lint and backwards compatibility check job
+# reference: <https://docs.buf.build/ci-cd/github-actions>
+name: protobuf-check
+
+on:
+  push:
+    branches:
+      - master
+      - develop
+  pull_request:
+    branches:
+      - master
+      - develop
+
+jobs:
+  protobuf-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: bufbuild/buf-setup-action@v1
+      - run: buf format --diff --exit-code

.gitignore

@@ -4,6 +4,9 @@ release/
 .idea/
 .vscode/
 .DS_Store
+spec/
+Taskfile.yaml
 build/
 vendor/
-.local
+.local
+.task

Makefile

@@ -1,7 +1,7 @@
 .PHONY: build build-linux build-macos build-windows
-.PHONY: tools proto test
+.PHONY: tools proto-gen proto-format test
 
-VERSION=$(shell git describe --tags)
+VERSION=$(shell git describe --tags --always)
 GIT_COMMIT=$(shell git rev-parse HEAD)
 GIT_COMMIT_DATE=$(shell git log -n1 --pretty='format:%cd' --date=format:'%Y%m%d')
 REPO=github.com/bnb-chain/inscription
@@ -15,15 +15,20 @@ ldflags = -X $(REPO)/version.AppVersion=$(VERSION) \
 tools:
 	curl https://get.ignite.com/cli! | bash
 
-proto:
-	ignite generate proto-go 
+proto-gen:
+	#ignite generate proto-go
+	cd proto && buf generate && cp -r github.com/bnb-chain/bfs/x/* ../x && rm -rf github.com
 
-build: 
+proto-format:
+	buf format -w
+
+
+build:
 	go build -o build/bin/bfsd -ldflags="$(ldflags)" ./cmd/bfsd/main.go
 
 docker-image:
 	go mod vendor # temporary, should be removed after open source
 	docker build . -t ${IMAGE_NAME}
 
 test:
-	go test ./...
+	go test ./...

app/app.go

@@ -94,6 +94,11 @@ import (
 	bridgemodulekeeper "github.com/bnb-chain/bfs/x/bridge/keeper"
 	bridgemoduletypes "github.com/bnb-chain/bfs/x/bridge/types"
 	// this line is used by starport scaffolding # stargate/app/moduleImport
+
+	paymentmodule "github.com/bnb-chain/bfs/x/payment"
+	paymentmodulekeeper "github.com/bnb-chain/bfs/x/payment/keeper"
+	paymentmoduletypes "github.com/bnb-chain/bfs/x/payment/types"
+	// this line is used by starport scaffolding # stargate/app/moduleImport
 )
 
 const (
@@ -144,6 +149,7 @@ var (
 		crosschain.AppModuleBasic{},
 		oracle.AppModuleBasic{},
 		bridgemodule.AppModuleBasic{},
+		paymentmodule.AppModuleBasic{},
 		// this line is used by starport scaffolding # stargate/app/moduleBasic
 	)
 
@@ -154,6 +160,8 @@ var (
 		stakingtypes.BondedPoolName:    {authtypes.Burner, authtypes.Staking},
 		stakingtypes.NotBondedPoolName: {authtypes.Burner, authtypes.Staking},
 		govtypes.ModuleName:            {authtypes.Burner},
+		ibctransfertypes.ModuleName:    {authtypes.Minter, authtypes.Burner},
+		paymentmoduletypes.ModuleName:  {authtypes.Minter, authtypes.Burner, authtypes.Staking},
 		crosschaintypes.ModuleName:     {authtypes.Minter},
 		bridgemoduletypes.ModuleName:   nil,
 		// this line is used by starport scaffolding # stargate/app/maccPerms
@@ -206,8 +214,8 @@ type App struct {
 	OracleKeeper     oraclekeeper.Keeper
 
 	BfsKeeper bfsmodulekeeper.Keeper
-
 	BridgeKeeper bridgemodulekeeper.Keeper
+	PaymentKeeper paymentmodulekeeper.Keeper
 	// this line is used by starport scaffolding # stargate/app/keeperDeclaration
 
 	// mm is the module manager
@@ -260,6 +268,7 @@ func New(
 		crosschaintypes.StoreKey,
 		oracletypes.StoreKey,
 		bridgemoduletypes.StoreKey,
+		paymentmoduletypes.StoreKey,
 		// this line is used by starport scaffolding # stargate/app/storeKey
 	)
 	tkeys := sdk.NewTransientStoreKeys(paramstypes.TStoreKey)
@@ -418,6 +427,17 @@ func New(
 	)
 	bridgeModule := bridgemodule.NewAppModule(appCodec, app.BridgeKeeper, app.AccountKeeper, app.BankKeeper)
 
+	app.PaymentKeeper = *paymentmodulekeeper.NewKeeper(
+		appCodec,
+		keys[paymentmoduletypes.StoreKey],
+		keys[paymentmoduletypes.MemStoreKey],
+		app.GetSubspace(paymentmoduletypes.ModuleName),
+
+		app.BankKeeper,
+		app.AccountKeeper,
+	)
+	paymentModule := paymentmodule.NewAppModule(appCodec, app.PaymentKeeper, app.AccountKeeper, app.BankKeeper)
+
 	// this line is used by starport scaffolding # stargate/app/keeperDefinition
 
 	/****  Module Options ****/
@@ -447,6 +467,7 @@ func New(
 		oracle.NewAppModule(app.OracleKeeper),
 		bfsModule,
 		bridgeModule,
+		paymentModule,
 		// this line is used by starport scaffolding # stargate/app/appModule
 	)
 
@@ -471,6 +492,7 @@ func New(
 		crosschaintypes.ModuleName,
 		oracletypes.ModuleName,
 		bridgemoduletypes.ModuleName,
+		paymentmoduletypes.ModuleName,
 		// this line is used by starport scaffolding # stargate/app/beginBlockers
 	)
 
@@ -490,6 +512,7 @@ func New(
 		crosschaintypes.ModuleName,
 		oracletypes.ModuleName,
 		bridgemoduletypes.ModuleName,
+		paymentmoduletypes.ModuleName,
 		// this line is used by starport scaffolding # stargate/app/endBlockers
 	)
 
@@ -514,6 +537,7 @@ func New(
 		crosschaintypes.ModuleName,
 		oracletypes.ModuleName,
 		bridgemoduletypes.ModuleName,
+		paymentmoduletypes.ModuleName,
 		// this line is used by starport scaffolding # stargate/app/initGenesis
 	)
 
@@ -540,6 +564,7 @@ func New(
 		oracle.NewAppModule(app.OracleKeeper),
 		bfsModule,
 		bridgeModule,
+		paymentModule,
 		// this line is used by starport scaffolding # stargate/app/appModule
 	)
 	app.sm.RegisterStoreDecoders()
@@ -768,6 +793,7 @@ func initParamsKeeper(appCodec codec.BinaryCodec, legacyAmino *codec.LegacyAmino
 	paramsKeeper.Subspace(crosschaintypes.ModuleName)
 	paramsKeeper.Subspace(oracletypes.ModuleName)
 	paramsKeeper.Subspace(bridgemoduletypes.ModuleName)
+	paramsKeeper.Subspace(paymentmoduletypes.ModuleName)
 	// this line is used by starport scaffolding # stargate/app/paramSubspace
 
 	return paramsKeeper

app/simulation_test.go

@@ -20,7 +20,7 @@ func init() {
 	simapp.GetSimulatorFlags()
 }
 
-// nolint: unused
+// nolint
 var defaultConsensusParams = &abci.ConsensusParams{
 	Block: &abci.BlockParams{
 		MaxBytes: 200000,

config.yml

@@ -1,19 +1,55 @@
 version: 1
 accounts:
   - name: alice
-    coins: ["20000token", "200000000stake"]
+    coins: ["200000000000000token", "200000000stake"]
+    mnemonic: "marine giant loud party thrive venture winter ill grid kind bus shaft custom bunker cable trend another mosquito banner curtain rib asthma board beach"
   - name: bob
-    coins: ["10000token", "100000000stake"]
+    coins: ["10000token", "200000000stake"]
+    mnemonic: "bridge zoo loyal super right wet cool nice interest bronze bring behave smoke transfer palace arctic cool thank outer runway blade diesel giraffe goat"
+  - name: sp0
+    coins: ["200000000000000token", "200000000stake"]
+    mnemonic: "million twice blue eternal travel number section abstract chest affair decade volcano member impose setup floor rail title female spider item nature reunion shoulder"
+  - name: sp1
+    coins: ["200000000000000token", "200000000stake"]
+    mnemonic: "tackle saddle wine net release bread guide reject chat cluster truly soap garden ugly search elegant hurry scrap surge item thunder liquid crop machine"
+  - name: sp2
+    coins: ["200000000000000token", "200000000stake"]
+    mnemonic: "genre cash give exercise dumb glove switch laugh umbrella welcome fix census record sheriff process bicycle zero apple message hunt private myself pig wealth"
+  - name: sp3
+    coins: ["200000000000000token", "200000000stake"]
+    mnemonic: "top ritual shaft camera type embody wedding daring direct census dad dilemma gorilla tree iron forum notable will drum bright student exhibit abuse pass"
+  - name: sp4
+    coins: ["200000000000000token", "200000000stake"]
+    mnemonic: "drip muffin rule hurry orphan wink light draft slush dune wisdom flag convince next this define copy pulp piano document someone found slight random"
+  - name: sp5
+    coins: ["200000000000000token", "200000000stake"]
+    mnemonic: "sudden float cube train okay range soap raw noise gorilla thrive clip baby december tenant help slim tumble version maximum ride buddy place loyal"
+  - name: sp6
+    coins: ["200000000000000token", "200000000stake"]
+    mnemonic: "among hamster prison animal grant resource crime rough affair train pelican swallow fee stove ring silk truck person loan fit play excuse athlete sauce"
+  - name: user
+    coins: ["200000000000000token", "200000000stake"]
+    mnemonic: "faith bomb frequent inflict endless cute glass kick session fence sell firm energy sun march melody claim almost useless burden fish force gorilla immense"
+  - name: user2
+    coins: ["200000000000000token", "200000000stake"]
+    mnemonic: "home piano firm basket label melt shove rhythm opinion question dragon gain sister someone marble program hurdle neither absent gown end woman stadium rare"
 validators:
   - name: alice
     bonded: "100000000stake"
+    validator_addr: 0xb7B7BC92b60794be9f83D4ebAB30760407bA1676
+    relayer_addr: 0xb7B7BC92b60794be9f83D4ebAB30760407bA1676
+    relayer_blskey: ac1e598ae0ccbeeaafa31bc6faefa85c2ae3138699cac79169cd718f1a38445201454ec092a86f200e08a15266bdc6e9
+    gentx:
+      min-self-delegation: 10000
 faucet:
   name: bob
   coins: ["5token", "100000stake"]
-
 init:
   client:
     chain-id: "inscription_9000-1"
-
 genesis:
   chain_id: "inscription_9000-1"
+  app_state:
+    gov:
+      voting_params:
+        voting_period: "300s"

go.mod

@@ -26,7 +26,11 @@ require (
 
 require golang.org/x/text v0.5.0 // indirect
 
-require github.com/spf13/viper v1.13.0
+require (
+	github.com/cosmos/cosmos-proto v1.0.0-alpha7
+	github.com/cosmos/gogoproto v1.4.3
+	github.com/spf13/viper v1.13.0
+)
 
 require (
 	filippo.io/edwards25519 v1.0.0-rc.1 // indirect
@@ -62,7 +66,6 @@ require (
 	github.com/containerd/cgroups v1.0.3 // indirect
 	github.com/containerd/containerd v1.6.8 // indirect
 	github.com/cosmos/btcutil v1.0.4 // indirect
-	github.com/cosmos/cosmos-proto v1.0.0-alpha7 // indirect
 	github.com/cosmos/go-bip39 v1.0.0 // indirect
 	github.com/cosmos/gorocksdb v1.2.0 // indirect
 	github.com/cosmos/iavl v0.19.4 // indirect

go.sum

@@ -433,6 +433,8 @@ github.com/cosmos/cosmos-sdk/ics23/go v0.8.0/go.mod h1:2a4dBq88TUoqoWAU5eu0lGvpF
 github.com/cosmos/go-bip39 v0.0.0-20180819234021-555e2067c45d/go.mod h1:tSxLoYXyBmiFeKpvmq4dzayMdCjCnu8uqmCysIGBT2Y=
 github.com/cosmos/go-bip39 v1.0.0 h1:pcomnQdrdH22njcAatO0yWojsUnCO3y2tNoV1cb6hHY=
 github.com/cosmos/go-bip39 v1.0.0/go.mod h1:RNJv0H/pOIVgxw6KS7QeX2a0Uo0aKUlfhZ4xuwvCdJw=
+github.com/cosmos/gogoproto v1.4.3 h1:RP3yyVREh9snv/lsOvmsAPQt8f44LgL281X0IOIhhcI=
+github.com/cosmos/gogoproto v1.4.3/go.mod h1:0hLIG5TR7IvV1fme1HCFKjfzW9X2x0Mo+RooWXCnOWU=
 github.com/cosmos/gorocksdb v1.2.0 h1:d0l3jJG8M4hBouIZq0mDUHZ+zjOx044J3nGRskwTb4Y=
 github.com/cosmos/gorocksdb v1.2.0/go.mod h1:aaKvKItm514hKfNJpUJXnnOWeBnk2GL4+Qw9NHizILw=
 github.com/cosmos/iavl v0.19.4 h1:t82sN+Y0WeqxDLJRSpNd8YFX5URIrT+p8n6oJbJ2Dok=

proto/bfs/bfs/genesis.proto

@@ -1,8 +1,8 @@
 syntax = "proto3";
 package bfs.bfs;
 
-import "gogoproto/gogo.proto";
 import "bfs/bfs/params.proto";
+import "gogoproto/gogo.proto";
 // this line is used by starport scaffolding # genesis/proto/import
 
 option go_package = "github.com/bnb-chain/bfs/x/bfs/types";

proto/bfs/bfs/params.proto

@@ -8,5 +8,4 @@ option go_package = "github.com/bnb-chain/bfs/x/bfs/types";
 // Params defines the parameters for the module.
 message Params {
   option (gogoproto.goproto_stringer) = false;
-
 }

proto/bfs/bfs/query.proto

@@ -1,10 +1,10 @@
 syntax = "proto3";
 package bfs.bfs;
 
+import "bfs/bfs/params.proto";
+import "cosmos/base/query/v1beta1/pagination.proto";
 import "gogoproto/gogo.proto";
 import "google/api/annotations.proto";
-import "cosmos/base/query/v1beta1/pagination.proto";
-import "bfs/bfs/params.proto";
 // this line is used by starport scaffolding # 1
 
 option go_package = "github.com/bnb-chain/bfs/x/bfs/types";

proto/bfs/bfs/tx.proto

@@ -7,7 +7,7 @@ option go_package = "github.com/bnb-chain/bfs/x/bfs/types";
 
 // Msg defines the Msg service.
 service Msg {
-    // this line is used by starport scaffolding # proto/tx/rpc
+  // this line is used by starport scaffolding # proto/tx/rpc
 }
 
 // this line is used by starport scaffolding # proto/tx/message

proto/bfs/payment/auto_settle_queue.proto

@@ -0,0 +1,9 @@
+syntax = "proto3";
+package bnbchain.bfs.payment;
+
+option go_package = "github.com/bnb-chain/bfs/x/payment/types";
+
+message AutoSettleQueue {
+  int64 timestamp = 1;
+  string addr = 2;
+}

proto/bfs/payment/base.proto

@@ -0,0 +1,24 @@
+syntax = "proto3";
+package bnbchain.bfs.payment;
+
+import "cosmos_proto/cosmos.proto";
+import "gogoproto/gogo.proto";
+
+option go_package = "github.com/bnb-chain/bfs/x/payment/types";
+
+message OutFlowInUSD {
+  string spAddress = 1;
+  string rate = 2 [
+    (cosmos_proto.scalar) = "cosmos.Int",
+    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Int",
+    (gogoproto.nullable) = false
+  ];
+}
+
+enum ReadPacket {
+  option (gogoproto.goproto_enum_prefix) = false;
+
+  ReadPacketFree = 0;
+  ReadPacket1GB = 1;
+  ReadPacket10GB = 2;
+}

proto/bfs/payment/bnb_price.proto

@@ -0,0 +1,14 @@
+syntax = "proto3";
+package bnbchain.bfs.payment;
+
+option go_package = "github.com/bnb-chain/bfs/x/payment/types";
+
+message SingleBnbPrice {
+  int64 time = 1;
+  // price in USD, cast to uint64 with 8 decimal places, e.g. "276.40000000" => 27640000000
+  uint64 price = 2;
+}
+
+message BnbPrice {
+  repeated SingleBnbPrice prices = 1;
+}

proto/bfs/payment/events.proto

@@ -0,0 +1,22 @@
+syntax = "proto3";
+package bnbchain.bfs.payment;
+
+import "cosmos_proto/cosmos.proto";
+import "gogoproto/gogo.proto";
+
+option go_package = "github.com/bnb-chain/bfs/x/payment/types";
+
+message EventCreatePaymentAccount {
+  string addr = 1;
+  string owner = 2;
+  uint64 index = 3;
+}
+
+message EventForceSettle {
+  string addr = 1;
+  string settledBalance = 2 [
+    (cosmos_proto.scalar) = "cosmos.Int",
+    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Int",
+    (gogoproto.nullable) = false
+  ];
+}