Add License and update instructions (#27)

* add LICENSE

* update cli instructions

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 OmniFlix Network
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

readme.md

@@ -38,7 +38,7 @@ streampayd version
 rm -rf ~/.streampay/config/*
 
 #Init node	
-streampayd unsafe-reset-all
+streampayd tendermint unsafe-reset-all
 streampayd init "sp-node"  --chain-id "sp-test-1"
 
 # Add keys
@@ -47,15 +47,15 @@ streampayd keys add user1 --keyring-backend test
 streampayd keys add user2 --keyring-backend test
 
 # Add genesis accounts
-streampayd add-genesis-account $(streampayd keys show validator -a --keyring-backend test) 1000000000stake
-streampayd add-genesis-account $(streampayd keys show user1 -a --keyring-backend test) 1000000000000stake
+streampayd genesis add-genesis-account $(streampayd keys show validator -a --keyring-backend test) 1000000000stake
+streampayd genesis add-genesis-account $(streampayd keys show user1 -a --keyring-backend test) 1000000000000stake
 
 # Create gentx
-streampayd gentx validator 10000000stake --moniker "validator-1" --chain-id "sp-test-1" --keyring-backend test
+streampayd genesis gentx validator 10000000stake --moniker "validator-1" --chain-id "sp-test-1" --keyring-backend test
 
 # Collect Gentxs
-streampayd collect-gentxs
-streampayd validate-genesis
+streampayd genesis collect-gentxs
+streampayd genesis validate-genesis
 
 # Start Chain with default config
 streampayd start
@@ -105,11 +105,11 @@ To Start a stream payment
 
 cmd :
 
- `streampayd tx streampay stream-send [recipient] [amount] --end-time <unix-timestamp> --delayed --chain-id <chain-id> --from <key>`
+ `streampayd tx streampay stream-send [recipient] [amount] --duration <stream-duration> --delayed --chain-id <chain-id> --from <key>`
 
 To start a continuous payment stream
 ```bash=
-streampayd tx streampay stream-send streampay1vnlgxmzh8mr5e43ku38f9470p2q0jfscksa98g 10000stake --end-time 1638786850  --chain-id streampay  --from bob
+streampayd tx streampay stream-send streampay1vnlgxmzh8mr5e43ku38f9470p2q0jfscksa98g 10000stake --duration 86400s  --chain-id streampay  --from bob
 ```
 Use --delayed flag for delayed payments.
 

x/streampay/client/cli/flags.go

@@ -14,8 +14,8 @@ const (
 var FsStreamSend = flag.NewFlagSet("", flag.ContinueOnError)
 
 func init() {
-	FsStreamSend.String(FlagDuration, "", "duration of stream")
-	FsStreamSend.Bool(FlagDelayed, false, "use to set delayed stream")
+	FsStreamSend.String(FlagDuration, "", "to set duration of stream payment")
+	FsStreamSend.Bool(FlagDelayed, false, "to create a delayed stream payment")
 	FsStreamSend.String(FlagStreamPeriodsFile, "", "stream periods json file")
-	FsStreamSend.Bool(FlagCancellable, false, "use to set cancellable stream")
+	FsStreamSend.Bool(FlagCancellable, false, "to create cancellable stream payment")
 }

x/streampay/client/cli/tx.go

@@ -60,13 +60,13 @@ func GetCmdStreamSend() *cobra.Command {
 			"cancellation of stream payments:\n" +
 			"using --cancellable flag, you can create a cancellable stream payment\n",
 		Example: fmt.Sprintf(
-			"$ %s tx streampay stream-send [recipient] [amount] --end-time <end-timestamp>"+
+			"$ %s tx streampay stream-send [recipient] [amount] --duration <duration>"+
 				" --chain-id <chain-id> --from <sender> --fees <fees>\n\n"+
 				"delayed payment:\n"+
-				"$ %s tx streampay stream-send [recipient] [amount] --end-time <end-timestamp> --delayed"+
+				"$ %s tx streampay stream-send [recipient] [amount] --duration <stream-duration> --delayed"+
 				" --chain-id <chain-id> --from <sender> --fees <fees>\n\n"+
 				"periodic payment:\n"+
-				"$ %s tx streampay stream-send [recipient] [amount] --end-time <end-timestamp> --stream-periods-file <stream-periods-file>"+
+				"$ %s tx streampay stream-send [recipient] [amount]  --stream-periods-file <stream-periods-file>"+
 				" --chain-id <chain-id> --from <sender> --fees <fees>\n\n",
 			version.AppName, version.AppName, version.AppName,
 		),