docs: improve basic_solana Candid documentation#161
Conversation
lpahlavi
changed the title
basic_solana Candid documentationbasic_solana Candid documentation
gregorydemay
left a comment
gregorydemay
left a comment
There was a problem hiding this comment.
Thanks @lpahlavi for improving the docs!
| // Parameters: | ||
| // - `owner` (optional): The principal to derive the address from. | ||
| // If omitted, the caller's principal is used. | ||
| solana_account : (owner: opt principal) -> (Address); |
There was a problem hiding this comment.
it's a bit confusing that the function is called solana_account but returns an address. should this be renamed for this and the other endpoints?
There was a problem hiding this comment.
@letmejustputthishere That's a good point. I merged this PR, but I can potentially open another one for renaming the endpoints. My reasoning is that pretty much everywhere in the Candid interface, accounts are identified by an address. It's a bit of a subtle difference, as the account is rather the data contained in the account, and the address is the identifier for an account. In this sense I don't see a contradiction per se, but I agree that it could be confusing... One option would be to just use address everywhere (i.e. in parameter and method names). @gregorydemay do you have an opinion?
3 participants
(XC-405) Improve the documentation in
basic_solana.didfor all endpoints.