feat: token api #58
feat: token api #58
Conversation
text/0006-token-api.md
Outdated
| # Summary | ||
| [summary]: #summary | ||
|
|
||
| Token API will provide token information by requesting `hathor-wallet-service`. |
There was a problem hiding this comment.
I guess we don't have to explain the low level in the summary. Maybe explain where it will be used.
text/0006-token-api.md
Outdated
| # Motivation | ||
| [motivation]: #motivation | ||
|
|
||
| We need to retrieve token data without requesting the full node. Wallet service holds those data, so, we'll use it for now. |
There was a problem hiding this comment.
The motivation is to replace the full node's API so the explorer can scale as much as we want without hitting the full node direclty.
text/0006-token-api.md
Outdated
| # Drawbacks | ||
| [drawbacks]: #drawbacks | ||
|
|
||
| None. |
There was a problem hiding this comment.
It depends on the wallet service.
text/0006-token-api.md
Outdated
| # Reference-level explanation | ||
| [reference-level-explanation]: #reference-level-explanation | ||
|
|
||
| **Endpoints:** |
There was a problem hiding this comment.
I guess these endpoints belong to the guide level explanation.
text/0006-token-api.md
Outdated
| # Reference-level explanation | ||
| [reference-level-explanation]: #reference-level-explanation | ||
|
|
||
| **Endpoints:** |
| ) for token in self.tokens] | ||
| ) | ||
| except Exception: | ||
| raise Exception('malformed_token_list') |
| timestamp=transaction.timestamp | ||
| ) for transaction in self.transactions] | ||
| ) | ||
| except Exception: |
There was a problem hiding this comment.
It feel dangerous to catch Exception. Why is that? It would capture ANY exception generated inside it (even if your code is broken).
| ) for transaction in self.transactions] | ||
| ) | ||
| except Exception: | ||
| raise Exception('malformed_token_transaction_list') |
|
|
||
| @classmethod | ||
| def from_dict(cls, dikt: dict) -> 'HathorWalletServiceTokenResponse': | ||
| return from_dict(data_class=cls, data=dikt) |
text/0006-token-api.md
Outdated
|
|
||
| - We'll basically act as a proxy making requests to wallet service | ||
|
|
||
| # Reference-level explanation |
There was a problem hiding this comment.
Still in the low level design, how will it be deployed? Lambdas, right? I'm concerned that it can get really expensive if the Wallet Service's Token API hangs for any reason and we keep waiting for them. What would be a reasonable timeout here? Should we deploy it using k8s?
domain/tx/token.py
Outdated
| :return: Dict representations of TokenList | ||
| :rtype: dict | ||
| """ | ||
| return asdict(self) |
There was a problem hiding this comment.
I feel like all of these to_dict and from_dict aren't really helping in any way. I'd be fine using asdict and from_dict directly, or at most making thin wrapper functions on a util module in case we want to customize some behavior. What do you think?
| """Response from hathor wallet service when requesting a token | ||
|
|
||
| :param id: id of token | ||
| :type id: str |
There was a problem hiding this comment.
Are we generating a docs with these comments? If we are, is it possible to make it use the type annotations instead of having to duplicate the information with :type? If we aren't I feel like we have no feedback if we're making a mistake or not, and I wouldn't bother with :type at all, but the descriptions are nice.
text/0006-token-api.md
Outdated
| - Start Date: 2021-08-04 | ||
| - RFC PR: (leave this empty) | ||
| - Hathor Issue: (leave this empty) | ||
| - Author: Giovane Costa <[email protected]> |
There was a problem hiding this comment.
Since this isn't in the RFC repo, I think we should remove this, because these fields are mostly specific to the RFC repo. And maybe also drop the 0006- from the file name (I'm not sure if we have an RFC 0006 or not but it would certainly conflict with that).
lucas3003
force-pushed
the
feat/token-api
branch
from
5068afc to
7164d39
Compare
* chore: stop diff early * feat: increased timeout on data aggregator
Rendered Design