-
Notifications
You must be signed in to change notification settings - Fork 1
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.
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
integrate census3 api client #50
Open
jordipainan
wants to merge
3
commits into
main
Choose a base branch
from
f/c3
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,151 @@ | ||
| package census3 | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "net/url" | ||
| "time" | ||
|
|
||
| "github.com/google/uuid" | ||
| c3types "github.com/vocdoni/census3/api" | ||
| c3client "github.com/vocdoni/census3/apiclient" | ||
| ) | ||
|
|
||
| const ( | ||
| // maxRetries is the maximum number of retries for a request. | ||
| maxRetries = 3 | ||
| // retryTime is the time to wait between retries. | ||
| retryTime = time.Second * 2 | ||
| ) | ||
|
|
||
| // Client wraps a client for the Census3 API and other revelant data. | ||
| type Client struct { | ||
| c *c3client.HTTPclient | ||
| } | ||
|
|
||
| // NewClient creates a new client for the Census3 API. | ||
| func NewClient(endpoint string, bearerToken string) (*Client, error) { | ||
| bt, err := uuid.Parse(bearerToken) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("invalid bearer token: %v", err) | ||
| } | ||
| addr, err := url.Parse(endpoint) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("invalid endpoint: %v", err) | ||
| } | ||
| httpClient, err := c3client.NewHTTPclient(addr, &bt) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("error creating HTTP client: %v", err) | ||
| } | ||
| c3 := &Client{ | ||
| c: httpClient, | ||
| } | ||
| return c3, nil | ||
| } | ||
|
|
||
| // reqFunc is a function type that encapsulates an API call | ||
| type reqFunc[T any] func() (T, error) | ||
|
|
||
| // requestWithRetry handles the retry logic for a request | ||
| func requestWithRetry[T any](fn reqFunc[T]) (T, error) { | ||
| var result T | ||
| for i := 0; i < maxRetries; i++ { | ||
| result, err := fn() | ||
| if err != nil { | ||
| time.Sleep(retryTime) | ||
| continue | ||
| } | ||
| return result, nil | ||
| } | ||
| return result, fmt.Errorf("failed after %d retries", maxRetries) | ||
| } | ||
|
|
||
| // SupportedChains returns the information of the Census3 endpoint supported chains. | ||
| func (c3 *Client) SupportedChains() ([]c3types.SupportedChain, error) { | ||
| return requestWithRetry(func() ([]c3types.SupportedChain, error) { | ||
| info, err := c3.c.Info() | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to get supported chains: %w", err) | ||
| } | ||
| return info.SupportedChains, nil | ||
| }) | ||
| } | ||
|
|
||
| // Tokens returns the list of tokens registered in the Census3 endpoint. | ||
| func (c3 *Client) Tokens() ([]*c3types.TokenListItem, error) { | ||
| return requestWithRetry(func() ([]*c3types.TokenListItem, error) { | ||
| tokens, err := c3.c.Tokens(-1, "", "") | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to get tokens: %w", err) | ||
| } | ||
| return tokens, nil | ||
|
|
||
| }) | ||
| } | ||
|
|
||
| // Token returns the token with the given ID. | ||
| func (c3 *Client) Token(tokenID, externalID string, chainID uint64) (*c3types.Token, error) { | ||
| return requestWithRetry(func() (*c3types.Token, error) { | ||
| token, err := c3.c.Token(tokenID, chainID, externalID) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to get token: %w", err) | ||
| } | ||
| return token, nil | ||
| }) | ||
| } | ||
|
|
||
| // SupportedTokens returns the list of tokens supported by the Census3 endpoint. | ||
| func (c3 *Client) SupportedTokens() ([]string, error) { | ||
| return requestWithRetry(func() ([]string, error) { | ||
| tokens, err := c3.c.TokenTypes() | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to get supported tokens: %w", err) | ||
| } | ||
| return tokens, nil | ||
| }) | ||
| } | ||
|
|
||
| // Strategies returns the list of strategies registered in the Census3 endpoint. | ||
| func (c3 *Client) Strategies() ([]*c3types.Strategy, error) { | ||
| return requestWithRetry(func() ([]*c3types.Strategy, error) { | ||
| strategies, err := c3.c.Strategies(-1, "", "") | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to get strategies: %w", err) | ||
| } | ||
| return strategies, nil | ||
| }) | ||
| } | ||
|
|
||
| // Strategy returns the strategy with the given ID. | ||
| func (c3 *Client) Strategy(strategyID uint64) (*c3types.Strategy, error) { | ||
| return requestWithRetry(func() (*c3types.Strategy, error) { | ||
| strategy, err := c3.c.Strategy(strategyID) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to get strategy: %w", err) | ||
| } | ||
| return strategy, nil | ||
| }) | ||
| } | ||
|
|
||
| // StrategyHolders returns the list of holders for the given strategy. | ||
| // The returned map has the holder's address as key and the holder's balance as a string encoded big.Int | ||
| func (c3 *Client) StrategyHolders(strategyID uint64) (map[string]string, error) { | ||
| return requestWithRetry(func() (map[string]string, error) { | ||
| holders, err := c3.c.HoldersByStrategy(strategyID) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to get strategy holders: %w", err) | ||
| } | ||
| return holders.Holders, nil | ||
| }) | ||
| } | ||
|
|
||
| // Census returns the census with the given ID. | ||
| func (c3 *Client) Census(censusID uint64) (*c3types.Census, error) { | ||
| return requestWithRetry(func() (*c3types.Census, error) { | ||
| census, err := c3.c.Census(censusID) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to get census: %w", err) | ||
| } | ||
| return census, nil | ||
|
|
||
| }) | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
tbh I'm not sure for the need of this wrapper of the census3 client (which is already a wrapper for the API).
The retry mechanism could also be implemented on the original client instead of here.
What's the point @jordipainan ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like to wrap these kind of imports so they can be extended on the consumer, imo adds more flexibility i.e: a new attribute needs to be added.
I dont think the retry mechanism should be added on the base client, and I think thats up to the consumer too. The base client needs to be simplest as possible and the retry mechanism is something one may decide to add or not.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Most of the methods for the wrapper are just calls to the census3 client with the retry helper. I still don't see the reason to have this wrapper, tbh.
Adding a wrapper adds complexity, and I'm not sure about the flexibility thing. Keep it simple if possible.
Anyway, let's call for more feedback @lucasmenendez