🤖 Documentation auto-update

dfinity · Jul 2, 2023 · 7df86c3 · 7df86c3
1 parent 40b7c35
commit 7df86c3
Show file tree

Hide file tree

Showing 7 changed files with 0 additions and 108 deletions.
diff --git a/packages/ckbtc/README.md b/packages/ckbtc/README.md
@@ -74,8 +74,6 @@ Parameters:
 - `params`: The Bitcoin address and network to parse
 - `params.network`: Optional. Default BtcNetwork is Mainnet
 
-[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ckbtc/src/utils/btc.utils.ts#L194)
-
 ### :factory: CkBTCMinterCanister
 
 #### Methods
@@ -183,8 +181,6 @@ Parameters:
 - `params`: The parameters to get the deposit fee.
 - `params.certified`: query or update call
 
-[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ckbtc/src/minter.canister.ts#L33)
-
 <!-- TSDOC_END -->
 
 ## Resources

diff --git a/packages/cmc/README.md b/packages/cmc/README.md
@@ -94,6 +94,4 @@ It returns the new Cycles of the canister.
 | ------------- | ---------------------------------------------- |
 | `notifyTopUp` | `(request: NotifyTopUpArg) => Promise<bigint>` |
 
-[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/cmc/src/cmc.canister.ts#L13)
-
 <!-- TSDOC_END -->
diff --git a/packages/ic-management/README.md b/packages/ic-management/README.md
@@ -154,8 +154,6 @@ Creates a canister. Only available on development instances.
 | ------------------------------------- | ------------------------------------------------------------------------------------------------------- |
 | `provisionalCreateCanisterWithCycles` | `({ settings, amount, canisterId, }?: ProvisionalCreateCanisterWithCyclesParams) => Promise<Principal>` |
 
-[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ic-management/src/ic-management.canister.ts#L24)
-
 <!-- TSDOC_END -->
 
 ## Resources

diff --git a/packages/ledger/README.md b/packages/ledger/README.md
@@ -73,8 +73,6 @@ 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.
@@ -88,8 +86,6 @@ Parameters:
 
 - `accountString`: string
 
-[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ledger/src/utils/ledger.utils.ts#L59)
-
 #### :gear: decodePayment
 
 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.
@@ -117,8 +113,6 @@ Parameters:
 
 - `code`: string
 
-[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ledger/src/utils/payment.utils.ts#L24)
-
 ### :factory: IcrcLedgerCanister
 
 #### Methods
@@ -184,8 +178,6 @@ Returns the total supply of tokens.
 | ------------------- | ------------------------------------------ |
 | `totalTokensSupply` | `(params: QueryParams) => Promise<bigint>` |
 
-[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ledger/src/ledger.canister.ts#L16)
-
 ### :factory: IcrcIndexCanister
 
 #### Methods
@@ -212,8 +204,6 @@ Index Canister only holds the transactions ids in state, not the whole transacti
 | ----------------- | -------------------------------------------------------------------- |
 | `getTransactions` | `(params: GetAccountTransactionsParams) => Promise<GetTransactions>` |
 
-[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ledger/src/index.canister.ts#L13)
-
 <!-- TSDOC_END -->
 
 ## Resources

diff --git a/packages/nns/README.md b/packages/nns/README.md
@@ -87,8 +87,6 @@ Parameters:
 - `params.neurons`: The neurons to filter.
 - `params.proposal`: The proposal to match against the selected neurons.
 
-[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/utils/neurons.utils.ts#L39)
-
 #### :gear: votableNeurons
 
 Filter the neurons that can vote for a proposal - i.e. the neurons that have not voted yet and are eligible
@@ -102,8 +100,6 @@ Parameters:
 - `params.neurons`: The neurons to filter.
 - `params.proposal`: The proposal to match against the selected neurons.
 
-[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/utils/neurons.utils.ts#L68)
-
 #### :gear: votedNeurons
 
 Filter the neurons that have voted for a proposal.
@@ -117,8 +113,6 @@ Parameters:
 - `params.neurons`: The neurons to filter.
 - `params.proposal`: The proposal for which some neurons might have already voted.
 
-[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/utils/neurons.utils.ts#L94)
-
 ### :factory: AccountIdentifier
 
 #### Methods
@@ -173,8 +167,6 @@ Parameters:
 | ------------------------- | ------------------------- |
 | `toAccountIdentifierHash` | `() => AccountIdentifier` |
 
-[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/account_identifier.ts#L12)
-
 ### :factory: SubAccount
 
 #### Methods
@@ -208,8 +200,6 @@ Parameters:
 | -------------- | ------------------ |
 | `toUint8Array` | `() => Uint8Array` |
 
-[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/account_identifier.ts#L73)
-
 ### :factory: GenesisTokenCanister
 
 #### Methods
@@ -229,8 +219,6 @@ Parameters:
 | -------------- | --------------------------------------------------------------- |
 | `claimNeurons` | `({ hexPubKey, }: { hexPubKey: string; }) => Promise<bigint[]>` |
 
-[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/genesis_token.canister.ts#L9)
-
 ### :factory: LedgerCanister
 
 #### Methods
@@ -274,8 +262,6 @@ Returns the index of the block containing the tx if it was successful.
 | ---------- | ----------------------------------------------- |
 | `transfer` | `(request: TransferRequest) => Promise<bigint>` |
 
-[:link: Source](https://github.com/dfinity/ic-js/tree/main//home/runner/work/ic-js/ic-js/packages/nns/src/ledger.canister.ts#L27)
-
 ### :factory: GovernanceCanister
 
 #### Methods
@@ -584,8 +570,6 @@ Return the data of the neuron provided as id.
 | ----------- | ---------------------------------------------------------------------------------------------- |
 | `getNeuron` | `({ certified, neuronId, }: { certified: boolean; neuronId: bigint; }) => Promise<NeuronInfo>` |
 
-[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L106)
-
 ### :factory: ICP
 
 We don't extend to keep `fromE8s` and `fromString` as backwards compatible.
@@ -627,8 +611,6 @@ Initialize from a string. Accepted formats:
 | --------- | ---------------------- |
 | `toProto` | `() => Promise<ICPTs>` |
 
-[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/icp.ts#L14)
-
 ### :factory: SnsWasmCanister
 
 #### Methods
@@ -648,6 +630,4 @@ Initialize from a string. Accepted formats:
 | ----------- | ---------------------------------------------------------------------- |
 | `listSnses` | `({ certified, }: { certified?: boolean; }) => Promise<DeployedSns[]>` |
 
-[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/sns_wasm.canister.ts#L10)
-
 <!-- TSDOC_END -->
diff --git a/packages/sns/README.md b/packages/sns/README.md
@@ -79,8 +79,6 @@ Lookup for the canister ids of a Sns and initialize the wrapper to access its fe
 | ---------------- | ---------------- |
 | `initSnsWrapper` | `InitSnsWrapper` |
 
-[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.ts#L33)
-
 ### :factory: SnsGovernanceCanister
 
 #### Methods
@@ -317,8 +315,6 @@ Claim neuron
 | ------------- | -------------------------------------------------------------------------------- |
 | `claimNeuron` | `({ memo, controller, subaccount, }: SnsClaimNeuronParams) => Promise<NeuronId>` |
 
-[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L60)
-
 ### :factory: SnsRootCanister
 
 #### Methods
@@ -342,8 +338,6 @@ Source code: https://github.com/dfinity/ic/blob/master/rs/sns/root/src/lib.rs
 | ------------------ | --------------------------------------------------------------------------------- |
 | `listSnsCanisters` | `({ certified, }: { certified?: boolean; }) => Promise<ListSnsCanistersResponse>` |
 
-[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/root.canister.ts#L10)
-
 ### :factory: SnsSwapCanister
 
 #### Methods
@@ -437,8 +431,6 @@ Get sale lifecycle state
 | -------------- | -------------------------------------------------------- |
 | `getLifecycle` | `(params: QueryParams) => Promise<GetLifecycleResponse>` |
 
-[:link: Source](https://github.com/dfinity/ic-js/tree/main//home/runner/work/ic-js/ic-js/packages/sns/src/swap.canister.ts#L30)
-
 ### :factory: SnsWrapper
 
 Sns wrapper - notably used by NNS-dapp - ease the access to a particular Sns.
@@ -773,6 +765,4 @@ Always certified
 | ------------------- | ------------------------------------------------------------- |
 | `autoStakeMaturity` | `(params: SnsNeuronAutoStakeMaturityParams) => Promise<void>` |
 
-[:link: Source](https://github.com/dfinity/ic-js/tree/main//home/runner/work/ic-js/ic-js/packages/sns/src/sns.wrapper.ts#L82)
-
 <!-- TSDOC_END -->