@dfinity/ledger-icrc 5.0.0-next-2025-10-22.3 → 5.0.0-next-2025-11-05
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +32 -32
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -78,7 +78,7 @@ Returns:
|
|
|
78
78
|
|
|
79
79
|
string
|
|
80
80
|
|
|
81
|
-
[:link: Source](https://github.com/dfinity/
|
|
81
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ledger-icrc/src/utils/ledger.utils.ts#L27)
|
|
82
82
|
|
|
83
83
|
#### :gear: decodeIcrcAccount
|
|
84
84
|
|
|
@@ -97,7 +97,7 @@ Returns:
|
|
|
97
97
|
|
|
98
98
|
IcrcAccount { owner: Principal, subaccount?: Uint8Array }
|
|
99
99
|
|
|
100
|
-
[:link: Source](https://github.com/dfinity/
|
|
100
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ledger-icrc/src/utils/ledger.utils.ts#L67)
|
|
101
101
|
|
|
102
102
|
#### :gear: mapTokenMetadata
|
|
103
103
|
|
|
@@ -120,7 +120,7 @@ Returns:
|
|
|
120
120
|
|
|
121
121
|
- A structured metadata record or `undefined` if required fields are missing.
|
|
122
122
|
|
|
123
|
-
[:link: Source](https://github.com/dfinity/
|
|
123
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ledger-icrc/src/utils/ledger.utils.ts#L118)
|
|
124
124
|
|
|
125
125
|
#### :gear: decodePayment
|
|
126
126
|
|
|
@@ -155,11 +155,11 @@ Returns:
|
|
|
155
155
|
|
|
156
156
|
: string; identifier: string; amount?: number } | undefined
|
|
157
157
|
|
|
158
|
-
[:link: Source](https://github.com/dfinity/
|
|
158
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ledger-icrc/src/utils/payment.utils.ts#L26)
|
|
159
159
|
|
|
160
160
|
### :factory: IcrcCanister
|
|
161
161
|
|
|
162
|
-
[:link: Source](https://github.com/dfinity/
|
|
162
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ledger-icrc/src/canister.ts#L9)
|
|
163
163
|
|
|
164
164
|
#### Methods
|
|
165
165
|
|
|
@@ -181,11 +181,11 @@ Returns:
|
|
|
181
181
|
|
|
182
182
|
The balance of the given account.
|
|
183
183
|
|
|
184
|
-
[:link: Source](https://github.com/dfinity/
|
|
184
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ledger-icrc/src/canister.ts#L18)
|
|
185
185
|
|
|
186
186
|
### :factory: IcrcLedgerCanister
|
|
187
187
|
|
|
188
|
-
[:link: Source](https://github.com/dfinity/
|
|
188
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ledger-icrc/src/ledger.canister.ts#L44)
|
|
189
189
|
|
|
190
190
|
#### Static Methods
|
|
191
191
|
|
|
@@ -197,7 +197,7 @@ The balance of the given account.
|
|
|
197
197
|
| -------- | ---------------------------------------------------------------------- |
|
|
198
198
|
| `create` | `(options: IcrcLedgerCanisterOptions<_SERVICE>) => IcrcLedgerCanister` |
|
|
199
199
|
|
|
200
|
-
[:link: Source](https://github.com/dfinity/
|
|
200
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ledger-icrc/src/ledger.canister.ts#L45)
|
|
201
201
|
|
|
202
202
|
#### Methods
|
|
203
203
|
|
|
@@ -224,7 +224,7 @@ The token metadata (name, symbol, etc.).
|
|
|
224
224
|
| ---------- | ------------------------------------------------------------- |
|
|
225
225
|
| `metadata` | `(params: QueryParams) => Promise<IcrcTokenMetadataResponse>` |
|
|
226
226
|
|
|
227
|
-
[:link: Source](https://github.com/dfinity/
|
|
227
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ledger-icrc/src/ledger.canister.ts#L59)
|
|
228
228
|
|
|
229
229
|
##### :gear: transactionFee
|
|
230
230
|
|
|
@@ -238,7 +238,7 @@ Returns:
|
|
|
238
238
|
|
|
239
239
|
The ledger transaction fees in Tokens
|
|
240
240
|
|
|
241
|
-
[:link: Source](https://github.com/dfinity/
|
|
241
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ledger-icrc/src/ledger.canister.ts#L67)
|
|
242
242
|
|
|
243
243
|
##### :gear: balance
|
|
244
244
|
|
|
@@ -256,7 +256,7 @@ Returns:
|
|
|
256
256
|
|
|
257
257
|
The balance of the given account.
|
|
258
258
|
|
|
259
|
-
[:link: Source](https://github.com/dfinity/
|
|
259
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ledger-icrc/src/ledger.canister.ts#L76)
|
|
260
260
|
|
|
261
261
|
##### :gear: transfer
|
|
262
262
|
|
|
@@ -270,7 +270,7 @@ Parameters:
|
|
|
270
270
|
|
|
271
271
|
- `params`: The parameters to transfer tokens.
|
|
272
272
|
|
|
273
|
-
[:link: Source](https://github.com/dfinity/
|
|
273
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ledger-icrc/src/ledger.canister.ts#L89)
|
|
274
274
|
|
|
275
275
|
##### :gear: totalTokensSupply
|
|
276
276
|
|
|
@@ -280,7 +280,7 @@ Returns the total supply of tokens.
|
|
|
280
280
|
| ------------------- | ------------------------------------------ |
|
|
281
281
|
| `totalTokensSupply` | `(params: QueryParams) => Promise<bigint>` |
|
|
282
282
|
|
|
283
|
-
[:link: Source](https://github.com/dfinity/
|
|
283
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ledger-icrc/src/ledger.canister.ts#L105)
|
|
284
284
|
|
|
285
285
|
##### :gear: transferFrom
|
|
286
286
|
|
|
@@ -296,7 +296,7 @@ Parameters:
|
|
|
296
296
|
|
|
297
297
|
- `params`: The parameters to transfer tokens from to.
|
|
298
298
|
|
|
299
|
-
[:link: Source](https://github.com/dfinity/
|
|
299
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ledger-icrc/src/ledger.canister.ts#L117)
|
|
300
300
|
|
|
301
301
|
##### :gear: approve
|
|
302
302
|
|
|
@@ -312,7 +312,7 @@ Parameters:
|
|
|
312
312
|
|
|
313
313
|
- `params`: The parameters to approve.
|
|
314
314
|
|
|
315
|
-
[:link: Source](https://github.com/dfinity/
|
|
315
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ledger-icrc/src/ledger.canister.ts#L139)
|
|
316
316
|
|
|
317
317
|
##### :gear: allowance
|
|
318
318
|
|
|
@@ -332,7 +332,7 @@ Returns:
|
|
|
332
332
|
|
|
333
333
|
The token allowance. If there is no active approval, the ledger MUST return `{ allowance = 0; expires_at = null }`.
|
|
334
334
|
|
|
335
|
-
[:link: Source](https://github.com/dfinity/
|
|
335
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ledger-icrc/src/ledger.canister.ts#L161)
|
|
336
336
|
|
|
337
337
|
##### :gear: consentMessage
|
|
338
338
|
|
|
@@ -350,7 +350,7 @@ Returns:
|
|
|
350
350
|
|
|
351
351
|
- A promise that resolves to the consent message response, which includes the consent message in the specified language and other related information.
|
|
352
352
|
|
|
353
|
-
[:link: Source](https://github.com/dfinity/
|
|
353
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ledger-icrc/src/ledger.canister.ts#L179)
|
|
354
354
|
|
|
355
355
|
##### :gear: getBlocks
|
|
356
356
|
|
|
@@ -368,7 +368,7 @@ Returns:
|
|
|
368
368
|
|
|
369
369
|
The list of blocks.
|
|
370
370
|
|
|
371
|
-
[:link: Source](https://github.com/dfinity/
|
|
371
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ledger-icrc/src/ledger.canister.ts#L203)
|
|
372
372
|
|
|
373
373
|
##### :gear: getIndexPrincipal
|
|
374
374
|
|
|
@@ -382,7 +382,7 @@ Returns:
|
|
|
382
382
|
|
|
383
383
|
The principal of the index canister.
|
|
384
384
|
|
|
385
|
-
[:link: Source](https://github.com/dfinity/
|
|
385
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ledger-icrc/src/ledger.canister.ts#L216)
|
|
386
386
|
|
|
387
387
|
##### :gear: icrc1SupportedStandards
|
|
388
388
|
|
|
@@ -396,7 +396,7 @@ Returns:
|
|
|
396
396
|
|
|
397
397
|
The list of standards.
|
|
398
398
|
|
|
399
|
-
[:link: Source](https://github.com/dfinity/
|
|
399
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ledger-icrc/src/ledger.canister.ts#L235)
|
|
400
400
|
|
|
401
401
|
##### :gear: icrc10SupportedStandards
|
|
402
402
|
|
|
@@ -410,7 +410,7 @@ Returns:
|
|
|
410
410
|
|
|
411
411
|
The list of standards.
|
|
412
412
|
|
|
413
|
-
[:link: Source](https://github.com/dfinity/
|
|
413
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ledger-icrc/src/ledger.canister.ts#L245)
|
|
414
414
|
|
|
415
415
|
##### :gear: getMintingAccount
|
|
416
416
|
|
|
@@ -424,11 +424,11 @@ Returns:
|
|
|
424
424
|
|
|
425
425
|
The minting account as a Nullable object.
|
|
426
426
|
|
|
427
|
-
[:link: Source](https://github.com/dfinity/
|
|
427
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ledger-icrc/src/ledger.canister.ts#L257)
|
|
428
428
|
|
|
429
429
|
### :factory: IcrcIndexCanister
|
|
430
430
|
|
|
431
|
-
[:link: Source](https://github.com/dfinity/
|
|
431
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ledger-icrc/src/index.canister.ts#L14)
|
|
432
432
|
|
|
433
433
|
#### Static Methods
|
|
434
434
|
|
|
@@ -440,7 +440,7 @@ The minting account as a Nullable object.
|
|
|
440
440
|
| -------- | --------------------------------------------------------------------- |
|
|
441
441
|
| `create` | `(options: IcrcLedgerCanisterOptions<_SERVICE>) => IcrcIndexCanister` |
|
|
442
442
|
|
|
443
|
-
[:link: Source](https://github.com/dfinity/
|
|
443
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ledger-icrc/src/index.canister.ts#L15)
|
|
444
444
|
|
|
445
445
|
#### Methods
|
|
446
446
|
|
|
@@ -460,7 +460,7 @@ Index Canister only holds the transactions ids in state, not the whole transacti
|
|
|
460
460
|
| ----------------- | -------------------------------------------------------------------- |
|
|
461
461
|
| `getTransactions` | `(params: GetAccountTransactionsParams) => Promise<GetTransactions>` |
|
|
462
462
|
|
|
463
|
-
[:link: Source](https://github.com/dfinity/
|
|
463
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ledger-icrc/src/index.canister.ts#L34)
|
|
464
464
|
|
|
465
465
|
##### :gear: ledgerId
|
|
466
466
|
|
|
@@ -470,11 +470,11 @@ Returns the ledger canister ID related to the index canister.
|
|
|
470
470
|
| ---------- | --------------------------------------------- |
|
|
471
471
|
| `ledgerId` | `(params: QueryParams) => Promise<Principal>` |
|
|
472
472
|
|
|
473
|
-
[:link: Source](https://github.com/dfinity/
|
|
473
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ledger-icrc/src/index.canister.ts#L51)
|
|
474
474
|
|
|
475
475
|
### :factory: IcrcIndexNgCanister
|
|
476
476
|
|
|
477
|
-
[:link: Source](https://github.com/dfinity/
|
|
477
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ledger-icrc/src/index-ng.canister.ts#L23)
|
|
478
478
|
|
|
479
479
|
#### Static Methods
|
|
480
480
|
|
|
@@ -486,7 +486,7 @@ Returns the ledger canister ID related to the index canister.
|
|
|
486
486
|
| -------- | ----------------------------------------------------------------------- |
|
|
487
487
|
| `create` | `(options: IcrcLedgerCanisterOptions<_SERVICE>) => IcrcIndexNgCanister` |
|
|
488
488
|
|
|
489
|
-
[:link: Source](https://github.com/dfinity/
|
|
489
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ledger-icrc/src/index-ng.canister.ts#L24)
|
|
490
490
|
|
|
491
491
|
#### Methods
|
|
492
492
|
|
|
@@ -511,7 +511,7 @@ Returns:
|
|
|
511
511
|
|
|
512
512
|
The list of transactions and further related information of the given account.
|
|
513
513
|
|
|
514
|
-
[:link: Source](https://github.com/dfinity/
|
|
514
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ledger-icrc/src/index-ng.canister.ts#L49)
|
|
515
515
|
|
|
516
516
|
##### :gear: ledgerId
|
|
517
517
|
|
|
@@ -521,7 +521,7 @@ Returns the ledger canister ID related to the index canister.
|
|
|
521
521
|
| ---------- | --------------------------------------------- |
|
|
522
522
|
| `ledgerId` | `(params: QueryParams) => Promise<Principal>` |
|
|
523
523
|
|
|
524
|
-
[:link: Source](https://github.com/dfinity/
|
|
524
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ledger-icrc/src/index-ng.canister.ts#L67)
|
|
525
525
|
|
|
526
526
|
##### :gear: status
|
|
527
527
|
|
|
@@ -539,7 +539,7 @@ Returns:
|
|
|
539
539
|
|
|
540
540
|
The status of the index canister.
|
|
541
541
|
|
|
542
|
-
[:link: Source](https://github.com/dfinity/
|
|
542
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ledger-icrc/src/index-ng.canister.ts#L78)
|
|
543
543
|
|
|
544
544
|
##### :gear: listSubaccounts
|
|
545
545
|
|
|
@@ -557,7 +557,7 @@ Returns:
|
|
|
557
557
|
|
|
558
558
|
The list of subaccounts.
|
|
559
559
|
|
|
560
|
-
[:link: Source](https://github.com/dfinity/
|
|
560
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ledger-icrc/src/index-ng.canister.ts#L87)
|
|
561
561
|
|
|
562
562
|
<!-- TSDOC_END -->
|
|
563
563
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dfinity/ledger-icrc",
|
|
3
|
-
"version": "5.0.0-next-2025-
|
|
3
|
+
"version": "5.0.0-next-2025-11-05",
|
|
4
4
|
"description": "A library for interfacing with ICRC ledgers on the Internet Computer.",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"type": "module",
|
|
@@ -33,11 +33,11 @@
|
|
|
33
33
|
},
|
|
34
34
|
"repository": {
|
|
35
35
|
"type": "git",
|
|
36
|
-
"url": "git+https://github.com/dfinity/
|
|
36
|
+
"url": "git+https://github.com/dfinity/icp-js-canisters.git",
|
|
37
37
|
"directory": "packages/ledger-icrc"
|
|
38
38
|
},
|
|
39
39
|
"bugs": {
|
|
40
|
-
"url": "https://github.com/dfinity/
|
|
40
|
+
"url": "https://github.com/dfinity/icp-js-canisters"
|
|
41
41
|
},
|
|
42
42
|
"keywords": [
|
|
43
43
|
"internet computer",
|
|
@@ -48,7 +48,7 @@
|
|
|
48
48
|
"ICRC-1 ledger",
|
|
49
49
|
"token"
|
|
50
50
|
],
|
|
51
|
-
"homepage": "https://github.com/dfinity/
|
|
51
|
+
"homepage": "https://github.com/dfinity/icp-js-canisters#readme",
|
|
52
52
|
"peerDependencies": {
|
|
53
53
|
"@dfinity/utils": "*",
|
|
54
54
|
"@icp-sdk/core": "*"
|