list allowances standard initial commit #191
Conversation
| } | ||
| ``` | ||
|
|
||
| The endpoint returns up to `taken` allowances of the from_account.owner, starting with the allowance between `from_account` and `to_account`. |
| |:------:| | ||
| |Draft| | ||
|
|
||
| # ICRC-191: Enhanced Allowance Query Mechanism with Pagination |
There was a problem hiding this comment.
typically the number comes from github.com/dfinity/icrc and not from the icrc-1 repo...I think we're around about 101 or 102.
There was a problem hiding this comment.
moved it there: got number 103
|
|
||
| Outstanding allowances, as specified in the ICRC-2 standard, are represented as a map from pairs of accounts to allowances. To specify the behavior of `icrc191_list_allowances`, the set of pairs `(Account, Account)` is ordered lexicographically. Let `first_principal` be the lexicographically first principal, and `first_subaccount` be the lexicographically first subaccount (the default subaccount, i.e., the all-0 32-byte string). Let `caller_principal` be the principal of the caller. | ||
|
|
||
| The `icrc191_list_allwances` method behaves as follows: |
|
|
||
| Then: | ||
|
|
||
| - If `p0` calls the list allowances endpoint, with `from_account = (p0, s0)`, `prev_spender = None` and `take=4` the endpoint returns ``(A1, A2, A3)``, i.e. the endpoint only returns allowances of accounts belonging to `p0`. It is limited to allowances of `p0`, but not only to those having `(p0,s0)` as source of the allowance. |
There was a problem hiding this comment.
I think you need an example of from_account = (p0, s1) (which I think would just get you the one item because this is in lexicographic order correct?
I still think I like
type ListAllowancesArgs = record {
from_account : opt {
owner = principal;
subaccount = opt opt blob;
};
prev_spender : opt Account;
take : opt nat;
}
....so that I can indicate I either want All subaccount for a principal with null or A specific subaccount with opt null for default subaccount and opt opt blob for a specific subaccount.
But I seem to recall you may have had a really good reason not to do this? I apologize...the meeting was a while back and I don't quite remember the note.
There was a problem hiding this comment.
I think the API is already not very intuitive so I'd lean towards pushing the implied complexity related to result filtering on the users of the API rather than on the implementation of the API itself. WDYT?
This is a draft for the ICRC-191 standard for listing outstanding allowances on ICP ledgers