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.

Sign up for GitHub

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

[Docs] AAT related comments & documentation improvements #1598

Merged
merged 10 commits into from
Mar 13, 2024
Merged

[Docs] AAT related comments & documentation improvements #1598

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
dc232f1
WIP - Improve comments & naming
Olshansk Jan 31, 2024
4f13ce1
Reply to a few review comments
Olshansk Feb 13, 2024
37d245b
Reply to some of the review comments
Olshansk Feb 16, 2024
a22eb56
Reply to all review comments
Olshansk Feb 16, 2024
c5965fe
Revert code changes
Olshansk Feb 16, 2024
0054870
Reply to PR review comments
Olshansk Mar 7, 2024
ee408ab
Fix Uncompressed Inline tar cmd (#1597)
0xThresh Mar 7, 2024
5fcb117
applicaitons typo fix
Olshansk Mar 12, 2024
b0f23ab
Reply to PR review comments
Olshansk Mar 12, 2024
37dd286
Remove "gateway" terms because it's a concept in Shannon (#1602)
msmania Mar 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 21 additions & 8 deletions app/cmd/cli/app.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,11 @@ import (
"strconv"
"strings"

"github.com/spf13/cobra"

"github.com/pokt-network/pocket-core/app"
"github.com/pokt-network/pocket-core/crypto/keys/mintkey"
"github.com/pokt-network/pocket-core/types"
"github.com/spf13/cobra"
)

func init() {
Expand All @@ -26,7 +27,7 @@ func init() {
var appCmd = &cobra.Command{
Use: "apps",
Short: "application management",
Long: `The apps namespace handles all applicaiton related interactions,
Long: `The apps namespace handles all application related interactions,
from staking and unstaking; to generating AATs.`,
}

Expand Down Expand Up @@ -179,10 +180,15 @@ command, you must have the private key of the current staked app <fromAddr>
var createAATCmd = &cobra.Command{
Use: "create-aat <appAddr> <clientPubKey>",
Short: "Creates an application authentication token",
Long: `Creates a signed application authentication token (version 0.0.1 of the AAT spec), that can be embedded into application software for Relay servicing.
Will prompt the user for the <appAddr> account passphrase.
Read the Application Authentication Token documentation for more information.
NOTE: USE THIS METHOD AT YOUR OWN RISK. READ THE APPLICATION SECURITY GUIDELINES IN ORDER TO UNDERSTAND WHAT'S THE RECOMMENDED AAT CONFIGURATION FOR YOUR APPLICATION.`,
Long: `Creates a signed Application Authentication Token.
Creates a signed AAT (= Application Authentication Token) where the version is
hardcoded as "0.0.1" that is the only version supported by the protocol.

This command prompts you to input the <appAddr> account passphrase.
When you send a relay request with AAT, <appAddr> needs to be a staked
application.

Please read doc/specs/application-auth-token.md for additional details.`,
Args: cobra.ExactArgs(2),
Run: func(cmd *cobra.Command, args []string) {
app.InitConfig(datadir, tmNode, persistentPeers, seeds, remoteCLIURL)
Expand All @@ -203,15 +209,22 @@ NOTE: USE THIS METHOD AT YOUR OWN RISK. READ THE APPLICATION SECURITY GUIDELINES
}
fmt.Println("Enter passphrase: ")
cred := app.Credentials(pwd)
privkey, err := mintkey.UnarmorDecryptPrivKey(kp.PrivKeyArmor, cred)

// Retrieve the priv & public keys
pubKey := kp.PublicKey.RawBytes()
pubKeyHexEncoded := hex.EncodeToString(pubKey)
privKeyArmored := kp.PrivKeyArmor
privKey, err := mintkey.UnarmorDecryptPrivKey(privKeyArmored, cred)
if err != nil {
return
}
aat, err := app.GenerateAAT(hex.EncodeToString(kp.PublicKey.RawBytes()), args[1], privkey)

aat, err := app.GenerateAAT(pubKeyHexEncoded, args[1], privKey)
if err != nil {
fmt.Println(err)
return
}

fmt.Println(string(aat))
},
}
5 changes: 4 additions & 1 deletion app/cmd/cli/gov.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,11 @@ import (
"strconv"
"strings"

"github.com/spf13/cobra"

"github.com/pokt-network/pocket-core/app"
"github.com/pokt-network/pocket-core/types"
govTypes "github.com/pokt-network/pocket-core/x/gov/types"
"github.com/spf13/cobra"
)

func init() {
Expand Down Expand Up @@ -120,6 +121,7 @@ Actions: [burn, transfer]`,
fmt.Println(resp)
},
}

var govChangeParam = &cobra.Command{
Use: "change_param <fromAddr> <networkID> <paramKey module/param> <paramValue (jsonObj)> <fees>",
Short: "Edit a param in the network",
Expand Down Expand Up @@ -205,6 +207,7 @@ func dropTag(version string) string {
}

const FeatureUpgradeKey = "FEATURE"

const FeatureUpgradeHeight = int64(1)

var govFeatureEnable = &cobra.Command{
Expand Down
3 changes: 2 additions & 1 deletion app/cmd/cli/node.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,9 @@ import (
"fmt"
"strconv"

"github.com/pokt-network/pocket-core/app"
"github.com/spf13/cobra"

"github.com/pokt-network/pocket-core/app"
)

func init() {
Expand Down
11 changes: 8 additions & 3 deletions app/cmd/cli/query.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ import (
"strconv"
"strings"

"github.com/spf13/cobra"

"github.com/pokt-network/pocket-core/app"
"github.com/pokt-network/pocket-core/app/cmd/rpc"
"github.com/pokt-network/pocket-core/types"
types2 "github.com/pokt-network/pocket-core/x/apps/types"

"github.com/pokt-network/pocket-core/app"
nodeTypes "github.com/pokt-network/pocket-core/x/nodes/types"
"github.com/spf13/cobra"
)

func init() {
Expand Down Expand Up @@ -342,9 +342,13 @@ var queryAccount = &cobra.Command{
}

var nodeStakingStatus string

var nodeJailedStatus string

var blockchain string

var nodePage int

var nodeLimit int

func init() {
Expand Down Expand Up @@ -490,6 +494,7 @@ var queryNodeParams = &cobra.Command{
}

var appStakingStatus string

var appPage, appLimit int

func init() {
Expand Down
3 changes: 2 additions & 1 deletion app/cmd/cli/root.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,10 @@ import (
"syscall"
"time"

"github.com/spf13/cobra"

"github.com/pokt-network/pocket-core/app"
"github.com/pokt-network/pocket-core/app/cmd/rpc"
"github.com/spf13/cobra"
)

var (
Expand Down
3 changes: 2 additions & 1 deletion app/cmd/cli/stake.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,10 @@ import (
"strconv"
"strings"

"github.com/spf13/cobra"

"github.com/pokt-network/pocket-core/app"
"github.com/pokt-network/pocket-core/types"
"github.com/spf13/cobra"
)

func init() {
Expand Down
5 changes: 3 additions & 2 deletions app/cmd/cli/util.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,15 @@ package cli

import (
"fmt"
"github.com/pokt-network/pocket-core/x/pocketcore/types"
"os"
"strconv"

"github.com/pokt-network/pocket-core/app"
"github.com/spf13/cobra"
"github.com/tendermint/tendermint/libs/log"
"github.com/tendermint/tendermint/state"

"github.com/pokt-network/pocket-core/app"
"github.com/pokt-network/pocket-core/x/pocketcore/types"
)

func init() {
Expand Down
3 changes: 2 additions & 1 deletion app/cmd/rpc/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,16 @@ import (
"encoding/hex"
"encoding/json"
"fmt"
nodesTypes "github.com/pokt-network/pocket-core/x/nodes/types"
"io/ioutil"
"net/http"
"os"
"strings"
"time"

"github.com/julienschmidt/httprouter"

"github.com/pokt-network/pocket-core/app"
nodesTypes "github.com/pokt-network/pocket-core/x/nodes/types"
"github.com/pokt-network/pocket-core/x/pocketcore/types"
)

Expand Down
31 changes: 16 additions & 15 deletions app/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,22 @@ import (

kitlevel "github.com/go-kit/kit/log/level"
"github.com/go-kit/kit/log/term"
"github.com/spf13/cobra"
config2 "github.com/tendermint/tendermint/config"
cryptoamino "github.com/tendermint/tendermint/crypto/encoding/amino"
"github.com/tendermint/tendermint/libs/cli/flags"
"github.com/tendermint/tendermint/libs/log"
cmn "github.com/tendermint/tendermint/libs/os"
"github.com/tendermint/tendermint/libs/rand"
"github.com/tendermint/tendermint/node"
"github.com/tendermint/tendermint/p2p"
"github.com/tendermint/tendermint/privval"
"github.com/tendermint/tendermint/rpc/client"
"github.com/tendermint/tendermint/rpc/client/http"
"github.com/tendermint/tendermint/rpc/client/local"
dbm "github.com/tendermint/tm-db"
"golang.org/x/crypto/ssh/terminal"

"github.com/pokt-network/pocket-core/baseapp"
"github.com/pokt-network/pocket-core/codec"
types2 "github.com/pokt-network/pocket-core/codec/types"
Expand All @@ -33,21 +49,6 @@ import (
nodesTypes "github.com/pokt-network/pocket-core/x/nodes/types"
pocket "github.com/pokt-network/pocket-core/x/pocketcore"
"github.com/pokt-network/pocket-core/x/pocketcore/types"
"github.com/spf13/cobra"
config2 "github.com/tendermint/tendermint/config"
cryptoamino "github.com/tendermint/tendermint/crypto/encoding/amino"
"github.com/tendermint/tendermint/libs/cli/flags"
"github.com/tendermint/tendermint/libs/log"
cmn "github.com/tendermint/tendermint/libs/os"
"github.com/tendermint/tendermint/libs/rand"
"github.com/tendermint/tendermint/node"
"github.com/tendermint/tendermint/p2p"
"github.com/tendermint/tendermint/privval"
"github.com/tendermint/tendermint/rpc/client"
"github.com/tendermint/tendermint/rpc/client/http"
"github.com/tendermint/tendermint/rpc/client/local"
dbm "github.com/tendermint/tm-db"
"golang.org/x/crypto/ssh/terminal"
)

var (
Expand Down
4 changes: 3 additions & 1 deletion app/query.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import (
"strconv"
"strings"

core_types "github.com/tendermint/tendermint/rpc/core/types"
tmtypes "github.com/tendermint/tendermint/types"

"github.com/pokt-network/pocket-core/codec"
Expand All @@ -19,7 +20,6 @@ import (
"github.com/pokt-network/pocket-core/x/gov/types"
nodesTypes "github.com/pokt-network/pocket-core/x/nodes/types"
pocketTypes "github.com/pokt-network/pocket-core/x/pocketcore/types"
core_types "github.com/tendermint/tendermint/rpc/core/types"
)

const (
Expand Down Expand Up @@ -66,6 +66,7 @@ func (app PocketCoreApp) QueryAccountTxs(addr string, page, perPage int, prove b
res, err = tmClient.TxSearch(query, prove, page, perPage, checkSort(sort))
return
}

func (app PocketCoreApp) QueryRecipientTxs(addr string, page, perPage int, prove bool, sort string, height int64) (res *core_types.ResultTxSearch, err error) {
tmClient := app.GetClient()
defer func() { _ = tmClient.Stop() }()
Expand Down Expand Up @@ -625,6 +626,7 @@ func checkPagination(page, limit int) (int, int) {
}
return page, limit
}

func checkSort(s string) string {
switch s {
case "asc":
Expand Down
8 changes: 6 additions & 2 deletions app/util.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,12 @@ import (
pocketKeeper "github.com/pokt-network/pocket-core/x/pocketcore/keeper"
)

func GenerateAAT(appPubKey, clientPubKey string, key crypto.PrivateKey) (aatjson []byte, err error) {
aat, er := pocketKeeper.AATGeneration(appPubKey, clientPubKey, key)
// GenerateAAT generates an AAT to be used for relay request authentication.
// - appPubKey is the public key of the application that's staking for on-chain service.
// - clientPubKey is the public key of a client facilitating relays on behalf of the app.
// - appPubKey and clientPubKey may or may not be the same.
func GenerateAAT(appPubKey, clientPubKey string, appPrivKey crypto.PrivateKey) (aatjson []byte, err error) {
aat, er := pocketKeeper.AATGeneration(appPubKey, clientPubKey, appPrivKey)
if er != nil {
return nil, er
}
Expand Down
4 changes: 2 additions & 2 deletions doc/guides/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ pocket accounts set-validator <address>
{% hint style="info" %} Check with `pocket accounts get-validator`
{% endhint %}

### Set [Relay Chains](https://docs.pokt.network/supported-blockchains/)
### Set [Relay Chains](https://docs.pokt.network/reference/supported-chains)

{% tabs %} {% tab title="Command" %}

Expand Down Expand Up @@ -468,7 +468,7 @@ Use pocket core flags --mainnet or --testnet to automatically write
Use the CLI or Manually Edit: `$HOME/.pocket/config/chains.json`

{% hint style="info" %} Relay Chain ID's and docs can be
found [here](https://docs.pokt.network/supported-blockchains/). {% endhint %}
found [here](https://docs.pokt.network/reference/supported-chains). {% endhint %}

These are external blockchain nodes such as ethereum, polygon and harmony. You will need to set these up by following their respective documentation. Once they are synced, you can enter the url and credentials into the following file.

Expand Down
26 changes: 10 additions & 16 deletions doc/guides/snapshot.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,41 +45,35 @@ export POCKET_DATA_DIR=<absolute path to your data dir>
#### Uncompressed

```bash
wget -O latest.txt https://pocket-snapshot.liquify.com/files/latest.txt
latestFile=$(cat latest.txt)
aria2c -s6 -x6 "https://pocket-snapshot.liquify.com/files/$latestFile"
[ -d ${POCKET_DATA_DIR} ] || mkdir -p ${POCKET_DATA_DIR}
aria2c -s6 -x6 "https://pocket-snapshot.liquify.com/files/$(curl -s https://pocket-snapshot.liquify.com/files/latest.txt)"
tar xvf "$latestFile" -C ${POCKET_DATA_DIR}
rm latest.txt
```

#### Uncompressed Inline (slower but smaller disk footprint)

The below snippet will download and extract the snapshot inline. This may be beneficial if you have constrained disk space and cannot afford to store both the temp archive and extracted datadir.

```bash
wget -O latest.txt https://pocket-snapshot.liquify.com/files/latest.txt
latestFile=$(cat latest.txt)
wget -c "https://pocket-snapshot.liquify.com/files/$latestFile" -O - | sudo tar -xz -C {POCKET_DATA_DIR}
rm latest.txt
[ -d ${POCKET_DATA_DIR} ] || mkdir -p ${POCKET_DATA_DIR}
wget -c "https://pocket-snapshot.liquify.com/files/$(curl -s https://pocket-snapshot.liquify.com/files/latest.txt)" -O - \
| tar -xv -C ${POCKET_DATA_DIR}
```

#### Compressed

```bash
wget -O latest.txt https://pocket-snapshot.liquify.com/files/latest_compressed.txt
latestFile=$(cat latest.txt)
aria2c -s6 -x6 "https://pocket-snapshot.liquify.com/files/$latestFile"
[ -d ${POCKET_DATA_DIR} ] || mkdir -p ${POCKET_DATA_DIR}
aria2c -s6 -x6 "https://pocket-snapshot.liquify.com/files/$(curl -s https://pocket-snapshot.liquify.com/files/latest_compressed.txt)"
lz4 -c -d "$latestFile" | tar -x -C ${POCKET_DATA_DIR}
rm latest.txt
```

#### Compressed Inline (slower but smaller disk footprint)

```bash
wget -O latest.txt https://pocket-snapshot.liquify.com/files/latest_compressed.txt
latestFile=$(cat latest.txt)
wget -O - "https://pocket-snapshot.liquify.com/files/$latestFile" | lz4 -d - | tar -xv -C {POCKET_DATA_DIR}
rm latest.txt
[ -d ${POCKET_DATA_DIR} ] || mkdir -p ${POCKET_DATA_DIR}
wget -c "https://pocket-snapshot.liquify.com/files/$(curl -s https://pocket-snapshot.liquify.com/files/latest_compressed.txt)" -O - \
| lz4 -d - | tar -xv -C ${POCKET_DATA_DIR}
```

### Issues
Expand Down
Loading
Loading