From 7d2a6a01240436c1833517247a636bb747cd9767 Mon Sep 17 00:00:00 2001 From: aelmanaa Date: Thu, 16 Jan 2025 09:54:53 +0100 Subject: [PATCH] regorg --- .../sidebar/ccip/api-reference/v1_5_0.json | 4 + .../sidebar/ccip/api-reference/v1_5_1.json | 12 + src/config/versions/page-availability.ts | 6 + .../v1.5.0/i-type-and-version.mdx | 34 + .../v1.5.1/burn-from-mint-token-pool.mdx | 108 +- .../api-reference/v1.5.1/burn-mint-erc20.mdx | 402 +++-- .../v1.5.1/burn-mint-token-pool-abstract.mdx | 130 +- .../v1.5.1/burn-mint-token-pool.mdx | 112 +- .../api-reference/v1.5.1/ccip-receiver.mdx | 177 +- .../ccip/api-reference/v1.5.1/client.mdx | 217 ++- .../api-reference/v1.5.1/i-router-client.mdx | 128 +- .../v1.5.1/i-type-and-version.mdx | 34 + .../ccip/api-reference/v1.5.1/index.mdx | 18 +- .../v1.5.1/lock-release-token-pool.mdx | 372 ++-- .../v1.5.1/ownable-2-step-msg-sender.mdx | 51 + .../api-reference/v1.5.1/ownable-2-step.mdx | 222 +++ .../ccip/api-reference/v1.5.1/pool.mdx | 147 +- .../api-reference/v1.5.1/rate-limiter.mdx | 313 ++-- .../v1.5.1/registry-module-owner-custom.mdx | 239 ++- .../v1.5.1/token-admin-registry.mdx | 667 +++++--- .../ccip/api-reference/v1.5.1/token-pool.mdx | 1504 +++++++++++------ src/content/ccip/best-practices.mdx | 2 +- 22 files changed, 3306 insertions(+), 1593 deletions(-) create mode 100644 src/content/ccip/api-reference/v1.5.0/i-type-and-version.mdx create mode 100644 src/content/ccip/api-reference/v1.5.1/i-type-and-version.mdx create mode 100644 src/content/ccip/api-reference/v1.5.1/ownable-2-step-msg-sender.mdx create mode 100644 src/content/ccip/api-reference/v1.5.1/ownable-2-step.mdx diff --git a/src/config/sidebar/ccip/api-reference/v1_5_0.json b/src/config/sidebar/ccip/api-reference/v1_5_0.json index 36b3f4fae03..6d456357a30 100644 --- a/src/config/sidebar/ccip/api-reference/v1_5_0.json +++ b/src/config/sidebar/ccip/api-reference/v1_5_0.json @@ -3,6 +3,10 @@ "title": "Client Library", "url": "ccip/api-reference/v1.5.0/client" }, + { + "title": "ITypeAndVersion", + "url": "ccip/api-reference/v1.5.0/i-type-and-version" + }, { "title": "IRouterClient", "url": "ccip/api-reference/v1.5.0/i-router-client" diff --git a/src/config/sidebar/ccip/api-reference/v1_5_1.json b/src/config/sidebar/ccip/api-reference/v1_5_1.json index 99801228da3..7b44a661313 100644 --- a/src/config/sidebar/ccip/api-reference/v1_5_1.json +++ b/src/config/sidebar/ccip/api-reference/v1_5_1.json @@ -3,6 +3,10 @@ "title": "Client Library", "url": "ccip/api-reference/v1.5.1/client" }, + { + "title": "ITypeAndVersion", + "url": "ccip/api-reference/v1.5.1/i-type-and-version" + }, { "title": "IRouterClient", "url": "ccip/api-reference/v1.5.1/i-router-client" @@ -54,5 +58,13 @@ { "title": "Errors", "url": "ccip/api-reference/v1.5.1/errors" + }, + { + "title": "Ownable2Step", + "url": "ccip/api-reference/v1.5.1/ownable-2-step" + }, + { + "title": "Ownable2StepMsgSender", + "url": "ccip/api-reference/v1.5.1/ownable-2-step-msg-sender" } ] diff --git a/src/config/versions/page-availability.ts b/src/config/versions/page-availability.ts index f23c8cd5447..bb9f93708ec 100644 --- a/src/config/versions/page-availability.ts +++ b/src/config/versions/page-availability.ts @@ -11,6 +11,12 @@ export const PAGE_AVAILABILITY: Record> "rate-limiter": { notAvailableIn: ["v1.5.0"], }, + "ownable-2-step-msg-sender": { + notAvailableIn: ["v1.5.0"], + }, + "ownable-2-step": { + notAvailableIn: ["v1.5.0"], + }, }, "chainlink-local": { "mock-evm2evm-offramp": { diff --git a/src/content/ccip/api-reference/v1.5.0/i-type-and-version.mdx b/src/content/ccip/api-reference/v1.5.0/i-type-and-version.mdx new file mode 100644 index 00000000000..05f492abe0e --- /dev/null +++ b/src/content/ccip/api-reference/v1.5.0/i-type-and-version.mdx @@ -0,0 +1,34 @@ +--- +section: ccip +date: Last Modified +title: "CCIP v1.5.0 ITypeAndVersion Interface API Reference" +metadata: + description: "API documentation for the ITypeAndVersion interface in Chainlink CCIP v1.5.0, providing type and version information for contracts." +--- + +import { Aside } from "@components" +import CcipCommon from "@features/ccip/CcipCommon.astro" + + + +## ITypeAndVersion + +An interface that provides type and version information for contracts. + +[Git Source](https://github.com/smartcontractkit/ccip/tree/release/contracts-ccip-1.5.0/contracts/src/v0.8/shared/interfaces/ITypeAndVersion.sol) + +## Functions + +### typeAndVersion + +Returns the type and version of the contract. + +```solidity +function typeAndVersion() external pure returns (string memory); +``` + +**Returns** + +| Type | Description | +| -------- | ------------------------------------- | +| `string` | The type and version of the contract. | diff --git a/src/content/ccip/api-reference/v1.5.1/burn-from-mint-token-pool.mdx b/src/content/ccip/api-reference/v1.5.1/burn-from-mint-token-pool.mdx index f6b5897a841..4f0b025aceb 100644 --- a/src/content/ccip/api-reference/v1.5.1/burn-from-mint-token-pool.mdx +++ b/src/content/ccip/api-reference/v1.5.1/burn-from-mint-token-pool.mdx @@ -11,71 +11,95 @@ import CcipCommon from "@features/ccip/CcipCommon.astro" -The [`BurnFromMintTokenPool`](https://github.com/smartcontractkit/ccip/blob/release/contracts-ccip-1.5.1/contracts/src/v0.8/ccip/pools/BurnFromMintTokenPool.sol) contract extends BurnMintTokenPoolAbstract to implement burn/mint functionality for third-party tokens using the `burnFrom(from, amount)` signature. +## BurnFromMintTokenPool + +A specialized token pool contract that manages third-party tokens through minting and burning operations, specifically using the `burnFrom` function. + +[Git Source](https://github.com/smartcontractkit/ccip/blob/0df0625eea603ba8572d5382d72979a7f2b12bfb/contracts/src/v0.8/ccip/pools/BurnFromMintTokenPool.sol) + +**Inherits:** + +- [BurnMintTokenPoolAbstract](/ccip/api-reference/v1.5.1/burn-mint-token-pool-abstract) +- [ITypeAndVersion](/ccip/api-reference/v1.5.1/i-type-and-version) + +