Skip to content
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

docs: review Icrc2ApproveRequest jsdocs types #841

Merged
merged 1 commit into from
Feb 11, 2025
Merged

docs: review Icrc2ApproveRequest jsdocs types #841

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 6 additions & 6 deletions packages/ledger-icp/src/types/ledger_converters.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,12 @@ export type Icrc1TransferRequest = {
*
* @param {Account} spender The account of the spender.
* @param {Tokens} amount The amount of tokens to approve.
* @param {Subaccount?} from_subaccount The subaccount to transfer tokens from.
* @param {Uint8Array|number?} icrc1Memo Approve memo.
* @param {Timestamp?} created_at_time nanoseconds since unix epoc to trigger deduplication and avoid other issues
* @param {Tokens?} fee The fee of the transfer when it's not the default fee.
* @param {Tokens?} expected_allowance The optional allowance expected. If the expected_allowance field is set, the ledger MUST ensure that the current allowance for the spender from the caller's account is equal to the given value and return the AllowanceChanged error otherwise.
* @param {Timestamp?} expires_at When the approval expires. If the field is set, it's greater than the current ledger time.
* @param {SubAccount?} from_subaccount The subaccount to transfer tokens from.
* @param {Uint8Array?} icrc1Memo Approve memo.
* @param {Icrc1Timestamp?} createdAt nanoseconds since unix epoc to trigger deduplication and avoid other issues
* @param {Icrc1Tokens?} fee The fee of the transfer when it's not the default fee.
* @param {Icrc1Tokens?} expected_allowance The optional allowance expected. If the expected_allowance field is set, the ledger MUST ensure that the current allowance for the spender from the caller's account is equal to the given value and return the AllowanceChanged error otherwise.
* @param {Icrc1Timestamp?} expires_at When the approval expires. If the field is set, it's greater than the current ledger time.
*/
export type Icrc2ApproveRequest = Omit<Icrc1TransferRequest, "to"> & {
expected_allowance?: Icrc1Tokens;
Expand Down