Skip to content

Create get-hodlers-for-public-key #379

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Create get-hodlers-for-public-key #379

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9acbeb3
Create get-hodlers-for-public-key
superzordon Jul 1, 2022
1695d6f
Add endpoints
superzordon Jul 1, 2022
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
10 changes: 9 additions & 1 deletion routes/server.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ const (
RoutePathGetSingleProfile = "/api/v0/get-single-profile"
RoutePathGetSingleProfilePicture = "/api/v0/get-single-profile-picture"
RoutePathGetHodlersForPublicKey = "/api/v0/get-hodlers-for-public-key"
RoutePathGetHodlersForPublicKeys = "/api/v0/get-hodlers-for-public-keys"
RoutePathGetHodlersCountForPublicKeys = "/api/v0/get-hodlers-count-for-public-keys"
RoutePathGetDiamondsForPublicKey = "/api/v0/get-diamonds-for-public-key"
RoutePathGetFollowsStateless = "/api/v0/get-follows-stateless"
Expand Down Expand Up @@ -824,7 +825,14 @@ func (fes *APIServer) NewRouter() *muxtrace.Router {
"GetHodlersForPublicKey",
[]string{"POST", "OPTIONS"},
RoutePathGetHodlersForPublicKey,
fes.GetHodlersForPublicKey,
fes.GetHodlersForPublicKeyEndpoint,
PublicAccess,
},
{
"GetHodlersForPublicKeys",
[]string{"POST", "OPTIONS"},
RoutePathGetHodlersForPublicKeys,
fes.GetHodlersForPublicKeysEndpoint,
PublicAccess,
},
{
Expand Down
128 changes: 107 additions & 21 deletions routes/user.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1310,6 +1310,30 @@ type GetHodlersForPublicKeyResponse struct {
LastPublicKeyBase58Check string
}

type GetHodlersForPublicKeysRequest struct {
// Array of Public Keys to retrieve hodlers for.
PublicKeysBase58Check []string `safeForLogging:"true"`

// If true, fetch DAO coin balance entries instead of creator coin balance entries.
IsDAOCoin bool `safeForLogging:"true"`

// If true, fetch balance entries for your hodlings instead of balance entries for hodler's of your coin.
FetchHodlings bool

// The sorting method to use when returning profiles. Defaults to
// "coin_balance" when unset.
SortType TopHodlerSortType
}

type GetHodlersForPublicKeysSingleResponse struct {
Hodlers []*BalanceEntryResponse
PublicKeyBase58Check string
}

type GetHodlersForPublicKeysResponse struct {
HodlersForPublicKeys []*GetHodlersForPublicKeysSingleResponse
}

// Helper function to get the creator public key or the hodler public key depending upon fetchHodlings.
func getHodlerOrHodlingPublicKey(balanceEntryResponse *BalanceEntryResponse, fetchHodlings bool) (_publicKeyBase58Check string) {
if fetchHodlings {
Expand All @@ -1336,7 +1360,7 @@ func (fes *APIServer) ComputeWealth(
}

// GetHodlersForPublicKey... Get BalanceEntryResponses for hodlings.
func (fes *APIServer) GetHodlersForPublicKey(ww http.ResponseWriter, req *http.Request) {
func (fes *APIServer) GetHodlersForPublicKeyEndpoint(ww http.ResponseWriter, req *http.Request) {
decoder := json.NewDecoder(io.LimitReader(req.Body, MaxRequestBodySizeBytes))
requestData := GetHodlersForPublicKeyRequest{}
if err := decoder.Decode(&requestData); err != nil {
Expand All @@ -1352,22 +1376,96 @@ func (fes *APIServer) GetHodlersForPublicKey(ww http.ResponseWriter, req *http.R
return
}

res, err := fes.GetHodlersForPublicKey(&requestData, utxoView)

if err != nil {
_AddBadRequestError(ww, fmt.Sprintf(
"GetHodlersForPublicKeyEndpoint: Problem getting hodlers for public key: %v", err))
return
}

if err = json.NewEncoder(ww).Encode(res); err != nil {
_AddBadRequestError(ww, fmt.Sprintf(
"GetHodlersForPublicKeyEndpoint: Problem encoding response as JSON: %v", err))
return
}

}

func (fes *APIServer) GetHodlersForPublicKeysEndpoint(ww http.ResponseWriter, req *http.Request) {
decoder := json.NewDecoder(io.LimitReader(req.Body, MaxRequestBodySizeBytes))
requestData := GetHodlersForPublicKeysRequest{}
if err := decoder.Decode(&requestData); err != nil {
_AddBadRequestError(ww, fmt.Sprintf(
"GetHodlersForPublicKey: Problem parsing request body: %v", err))
return
}

// Get a view
utxoView, err := fes.backendServer.GetMempool().GetAugmentedUniversalView()
if err != nil {
_AddBadRequestError(ww, fmt.Sprintf("GetHodlersForPublicKey: Error getting utxoView: %v", err))
return
}

if len(requestData.PublicKeysBase58Check) == 0 {
_AddBadRequestError(ww, fmt.Sprintf(
"GetHodlersForPublicKeysEndpoint: Must provide at least one public key."))
return
}

var hodlersForPublicKeys []*GetHodlersForPublicKeysSingleResponse

for _, publicKey := range requestData.PublicKeysBase58Check {
publicKeyRequestData := &GetHodlersForPublicKeyRequest{
PublicKeyBase58Check: publicKey,
IsDAOCoin: requestData.IsDAOCoin,
FetchHodlings: requestData.FetchHodlings,
SortType: requestData.SortType,
FetchAll: true,
}
res, err := fes.GetHodlersForPublicKey(publicKeyRequestData, utxoView)
if err != nil {
_AddBadRequestError(ww, fmt.Sprintf(
"GetHodlersForPublicKeyEndpoint: Problem getting hodlers for public key: %v", err))
return
}
hodlersForPublicKey := &GetHodlersForPublicKeysSingleResponse{
Hodlers: res.Hodlers,
PublicKeyBase58Check: publicKey,
}
hodlersForPublicKeys = append(hodlersForPublicKeys, hodlersForPublicKey)
}

res := &GetHodlersForPublicKeysResponse{
HodlersForPublicKeys: hodlersForPublicKeys,
}

if err = json.NewEncoder(ww).Encode(res); err != nil {
_AddBadRequestError(ww, fmt.Sprintf(
"GetHodlersForPublicKeyEndpoint: Problem encoding response as JSON: %v", err))
return
}

}

// GetHodlersForPublicKey... Get BalanceEntryResponses for hodlings.
func (fes *APIServer) GetHodlersForPublicKey(requestData *GetHodlersForPublicKeyRequest, utxoView *lib.UtxoView) (*GetHodlersForPublicKeyResponse, error) {
// Decode the public key for which we are fetching hodlers / hodlings. If public key is not provided, use username
var publicKeyBytes []byte
var err error
if requestData.PublicKeyBase58Check != "" {
publicKeyBytes, _, err = lib.Base58CheckDecode(requestData.PublicKeyBase58Check)
if err != nil {
_AddBadRequestError(ww, fmt.Sprintf("GetHodlersForPublicKey: Problem decoding user public key: %v", err))
return
return nil, fmt.Errorf("GetHodlersForPublicKey: Problem decoding user public key: %v", err)
}
} else {
username := requestData.Username
profileEntry := utxoView.GetProfileEntryForUsername([]byte(username))

// Return an error if we failed to find a profile entry
if profileEntry == nil {
_AddNotFoundError(ww, fmt.Sprintf("GetHodlersForPublicKey: could not find profile for username: %v", username))
return
return nil, fmt.Errorf("GetHodlersForPublicKey: could not find profile for username: %v", username)
}
publicKeyBytes = profileEntry.PublicKey
}
Expand All @@ -1379,16 +1477,14 @@ func (fes *APIServer) GetHodlersForPublicKey(ww http.ResponseWriter, req *http.R
hodlMap, err = fes.GetYouHodlMap(
utxoView.GetPKIDForPublicKey(publicKeyBytes), false, requestData.IsDAOCoin, utxoView)
if err != nil {
_AddBadRequestError(ww, fmt.Sprintf("GetHodlersForPublicKey: error getting youHodlMap: %v", err))
return
return nil, fmt.Errorf("GetHodlersForPublicKey: error getting youHodlMap: %v", err)
}

} else {
hodlMap, err = fes.GetHodlYouMap(
utxoView.GetPKIDForPublicKey(publicKeyBytes), false, requestData.IsDAOCoin, utxoView)
if err != nil {
_AddBadRequestError(ww, fmt.Sprintf("GetHodlersForPublicKey: error getting youHodlMap: %v", err))
return
return nil, fmt.Errorf("GetHodlersForPublicKey: error getting youHodlMap: %v", err)
}
}
for _, balanceEntryResponse := range hodlMap {
Expand All @@ -1399,10 +1495,7 @@ func (fes *APIServer) GetHodlersForPublicKey(ww http.ResponseWriter, req *http.R
if requestData.SortType != TopHodlerSortTypeNone &&
requestData.SortType != TopHodlerSortTypeCoinBalance &&
requestData.SortType != TopHodlerSortTypeWealth {

_AddBadRequestError(ww, fmt.Sprintf("GetHodlersForPublicKey: Unrecognized "+
"sort type: %v", requestData.SortType))
return
return nil, fmt.Errorf("GetHodlersForPublicKey: Unrecognized sort type: %v", requestData.SortType)
}
sort.Slice(hodlList, func(ii, jj int) bool {
if hodlList[ii].CreatorPublicKeyBase58Check == hodlList[ii].HODLerPublicKeyBase58Check {
Expand All @@ -1426,9 +1519,6 @@ func (fes *APIServer) GetHodlersForPublicKey(ww http.ResponseWriter, req *http.R
jjWealth := fes.ComputeWealth(hodlList[jj], utxoView)
return iiWealth > jjWealth
} else {
_AddBadRequestError(ww, fmt.Sprintf("GetHodlersForPublicKey: Unrecognized "+
"sort type: %v", requestData.SortType))
// TODO: We can't break the execution here but we should
return false
}
})
Expand Down Expand Up @@ -1470,11 +1560,7 @@ func (fes *APIServer) GetHodlersForPublicKey(ww http.ResponseWriter, req *http.R
Hodlers: hodlList,
LastPublicKeyBase58Check: resLastPublicKey,
}
if err = json.NewEncoder(ww).Encode(res); err != nil {
_AddBadRequestError(ww, fmt.Sprintf(
"GetHodlersForPublicKey: Problem encoding response as JSON: %v", err))
return
}
return res, nil
}

type GetHolderCountForPublicKeysRequest struct {
Expand Down