docs: generate

dfinity · Sep 26, 2023 · 25e0bdc · 25e0bdc
1 parent 8eb911a
commit 25e0bdc
Showing 1 changed file with 0 additions and 99 deletions.
diff --git a/packages/ledger-icrc/README.md b/packages/ledger-icrc/README.md
@@ -54,73 +54,6 @@ const data = await metadata();
 
 <!-- TSDOC_START -->
 
-### :toolbox: Functions
-
-- [encodeIcrcAccount](#gear-encodeicrcaccount)
-- [decodeIcrcAccount](#gear-decodeicrcaccount)
-- [decodePayment](#gear-decodepayment)
-
-#### :gear: encodeIcrcAccount
-
-Encodes an Icrc-1 account compatible into a string.
-Formatting Reference: https://github.com/dfinity/ICRC-1/blob/main/standards/ICRC-1/TextualEncoding.md
-
-| Function            | Type                                              |
-| ------------------- | ------------------------------------------------- |
-| `encodeIcrcAccount` | `({ owner, subaccount, }: IcrcAccount) => string` |
-
-Parameters:
-
-- `account`: : Principal, subaccount?: Uint8Array }
-
-[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ledger/src/utils/ledger.utils.ts#L21)
-
-#### :gear: decodeIcrcAccount
-
-Decodes a string into an Icrc-1 compatible account.
-Formatting Reference: https://github.com/dfinity/ICRC-1/blob/main/standards/ICRC-1/TextualEncoding.md
-
-| Function            | Type                                     |
-| ------------------- | ---------------------------------------- |
-| `decodeIcrcAccount` | `(accountString: string) => IcrcAccount` |
-
-Parameters:
-
-- `accountString`: string
-
-[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ledger/src/utils/ledger.utils.ts#L59)
-
-#### :gear: decodePayment
-
-👀 This feature is currently in draft. You can find more information about it at https://github.com/dfinity/ICRC/issues/22.
-
-A naive implementation of a payment parser. Given a code, the function attempts to extract a token name, account identifier (textual representation), and an optional amount.
-
-If the code doesn't match the expected pattern, `undefined` is returned for simplicity.
-Similarly, if an optional amount is provided but it's not a valid number, the parser will not throw an exception and returns `undefined`.
-
-Please note that this function doesn't perform any validity checks on the extracted information.
-It does not verify if the token is known or if the identifier is a valid address.
-
-```
-urn            = token ":" address [ "?" params]
-token         = [ ckbtc / icp / chat / bitcoin / ethereum ... ]
-address       = STRING
-params        = param [ "&" params ]
-param         = [ amountparam ]
-amountparam   = "amount=" *digit [ "." *digit ]
-```
-
-| Function        | Type                                                                        |
-| --------------- | --------------------------------------------------------------------------- |
-| `decodePayment` | `(code: string) => { token: string; identifier: string; amount?: number; }` |
-
-Parameters:
-
-- `code`: string
-
-[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ledger/src/utils/payment.utils.ts#L26)
-
 ### :factory: IcrcLedgerCanister
 
 [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ledger/src/ledger.canister.ts#L27)
@@ -251,38 +184,6 @@ Parameters:
 
 [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ledger/src/ledger.canister.ts#L145)
 
-### :factory: IcrcIndexCanister
-
-[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ledger/src/index.canister.ts#L13)
-
-#### Methods
-
-- [create](#gear-create)
-- [getTransactions](#gear-gettransactions)
-
-##### :gear: create
-
-| Method   | Type                                                                  |
-| -------- | --------------------------------------------------------------------- |
-| `create` | `(options: IcrcLedgerCanisterOptions<_SERVICE>) => IcrcIndexCanister` |
-
-[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ledger/src/index.canister.ts#L14)
-
-##### :gear: getTransactions
-
-Get the transactions of an account
-
-Always certified.
-`get_account_transactions` needs to be called with an update
-because the index canisters makes a call to the ledger canister to get the transaction data.
-Index Canister only holds the transactions ids in state, not the whole transaction data.
-
-| Method            | Type                                                                 |
-| ----------------- | -------------------------------------------------------------------- |
-| `getTransactions` | `(params: GetAccountTransactionsParams) => Promise<GetTransactions>` |
-
-[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ledger/src/index.canister.ts#L33)
-
 <!-- TSDOC_END -->
 
 ## Resources