Skip to content

Commit fb0a02a

Browse files
committed
fix format
1 parent 992a640 commit fb0a02a

15 files changed

+195
-164
lines changed

src/content/quickstarts/automated-portfolio-manager.mdx

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,25 @@ A live demo is available at https://automated-portfolio-manager.vercel.app.
1919

2020
The example contract supports dynamic asset management using tokens that adhere to the ERC20 standard. For this demonstration, Mimic Tokens representing gold (mXAU), Wrapped Bitcoin (mWBTC), and Ethereum (mETH) are used as the underlying assets. These tokens are automatically bought or sold to mirror changes in crypto market sentiment and gold volatility (GVZ) to ensure the portfolio adjusts to evolving market conditions. This functionality demonstrates how blockchain and Chainlink technologies can be used to create a dynamic investment strategy that adapts to global financial movements in real time.
2121

22-
**Note**: In a real-world use case, you can integrate the portfolio rebalancing mechanism with any DeFi protocol, such as a swapping mechanism or investments in ERC-4626 vaults.
22+
**Note**: In a real-world use case, you can integrate the portfolio rebalancing mechanism with any DeFi protocol, such as a swapping mechanism or investments in ERC-4626 vaults.
2323

2424
<ClickToZoom src="/images/quickstarts/automated-portfolio-manager/Automated_Portfolio_Manager_Concept.webp" />
2525

2626
<Aside type="caution" title="Disclaimer">
27-
This tutorial represents an example of using a Chainlink product or service and is provided to help you understand how to interact with Chainlink's systems and services so that you can integrate them into your own. This template is provided "AS IS" and "AS AVAILABLE" without warranties of any kind, has not been audited, and may be missing key checks or error handling to make the usage of the product more clear. Do not use the code in this example in a production environment without completing your own audits and application of best practices. Neither Chainlink Labs, the Chainlink Foundation, nor Chainlink node operators are responsible for unintended outputs that are generated due to errors in code.
27+
This tutorial represents an example of using a Chainlink product or service and is provided to help you understand how
28+
to interact with Chainlink's systems and services so that you can integrate them into your own. This template is
29+
provided "AS IS" and "AS AVAILABLE" without warranties of any kind, has not been audited, and may be missing key
30+
checks or error handling to make the usage of the product more clear. Do not use the code in this example in a
31+
production environment without completing your own audits and application of best practices. Neither Chainlink Labs,
32+
the Chainlink Foundation, nor Chainlink node operators are responsible for unintended outputs that are generated due
33+
to errors in code.
2834
</Aside>
2935

3036
<Aside type="caution" title="Disclaimer">
31-
The rebalancing strategy and logic outlined in this tutorial are solely for educational purposes and have not been backtested. This content is not meant to be financial advice and should not be interpreted as such. The example is intended to demonstrate the potential of Chainlink products. Users are strongly advised to perform their own due diligence before making any financial decisions.
37+
The rebalancing strategy and logic outlined in this tutorial are solely for educational purposes and have not been
38+
backtested. This content is not meant to be financial advice and should not be interpreted as such. The example is
39+
intended to demonstrate the potential of Chainlink products. Users are strongly advised to perform their own due
40+
diligence before making any financial decisions.
3241
</Aside>
3342

3443
## Table of Content
@@ -113,6 +122,7 @@ Run the following script to deploy your `OffchainDataFetcher` contract on Ethere
113122
```bash
114123
forge script script/DeployOffChainDataFetcher.s.sol --rpc-url $RPC_URL_SEPOLIA --private-key $PRIVATE_KEY --broadcast --verify -vvvv
115124
```
125+
116126
</Accordion>
117127

118128
<Accordion title="Add the contract to your Functions subscription and configure it" number={2}>
@@ -207,9 +217,11 @@ forge script script/DeployAutomatedPortfolioManager.s.sol --rpc-url $RPC_URL_SEP
207217
cp .env.example .env.local
208218
```
209219
1. Open your `.env.local` file and add your Sepolia RPC URL:
220+
210221
```
211222
NEXT_PUBLIC_SEPOLIA_RPC_URL=your_sepolia_rpc_url
212223
```
224+
213225
You can use the same RPC URL you used for contract deployment or get one from providers like [Alchemy](https://www.alchemy.com/) or [Infura](https://www.infura.io/).
214226
215227
1. Run the dApp locally:

src/content/quickstarts/automation-station.mdx

Lines changed: 84 additions & 66 deletions
Large diffs are not rendered by default.

src/content/quickstarts/ccip-direct-staking.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Direct Staking Guide for Third-Party Integrators"
33
description: "A guide for third-party integrators to integrate with direct staking solutions that allow users to stake L1 assets from L2 networks using Chainlink CCIP."
4-
excerpt: "Learn how to integrate with direct staking solutions using Chainlink CCIP. This guide covers fast stake and slow stake implementations, fee estimation, allowance management, and cross-chain tracking using the chainlink-csr repository with Lido as an example."
4+
excerpt: "Learn how to integrate with direct staking solutions using Chainlink CCIP Programmable Token Transfers. This comprehensive integration guide covers fast stake (instant swaps via liquidity pools) and slow stake (cross-chain bridging) implementations, CCIP fee estimation and encoding, ERC-20 token allowance management, cross-chain transaction tracking, and error handling patterns. Includes hands-on tutorial with Lido wstETH staking on Base Mainnet, TypeScript utilities from chainlink-csr repository, and production-ready reference implementations for third-party integrators building offchain components for liquid staking protocols."
55
githubSourceCodeUrl: "https://github.com/Aphyla/chainlink-csr"
66
image: "QuickStarts-CCIP-Liquid-Staking.webp"
77
products: ["ccip"]

src/content/quickstarts/chainlink-hardhat-starter-kit.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ time: "10 minutes"
88
requires: "Wallet with gas token & ERC-677 LINK"
99
---
1010

11-
1211
import { Aside } from "@components"
1312

1413
## Overview

src/content/quickstarts/deploy-your-first-contract.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Deploying smart contracts onchain requires a wallet and ETH. The ETH pays for th
5555

5656
![Screenshot showing the network selection menu in MetaMask. The Sepolia Test Network is selected.](/images/getting-started/selectSepolia.webp)
5757

58-
1. Go to [faucets.chain.link](https://faucets.chain.link/sepolia) and follow the steps to send testnet ETH to your MetaMask wallet address. After the faucet completes the transaction, you should have testnet ETH in your MetaMask wallet on the Sepolia testnet. Optionally, you can get testnet ETH from one of the [alternative faucets](https://faucetlink.to/sepolia).
58+
1. Go to [faucets.chain.link](https://faucets.chain.link/sepolia) and follow the steps to send testnet ETH to your MetaMask wallet address. After the faucet completes the transaction, you should have testnet ETH in your MetaMask wallet on the Sepolia testnet. Optionally, you can get testnet ETH from one of the [alternative faucets](https://faucetlink.to/sepolia).
5959

6060
Now that you configured your wallet and funded it with testnet ETH, you can write, compile, and deploy your contract.
6161

src/content/quickstarts/eth-balance-monitor.mdx

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -130,22 +130,22 @@ The [`EthBalanceMonitor` contract](https://github.com/smartcontractkit/documenta
130130

131131
Functions with an asterisk (`*`) denote features that only the owner can change. Click on each function to learn more about its parameters and design patterns:
132132

133-
| Function Name | Description |
134-
| ---------------------------- | -------------------------------------------------------------------------------------- |
135-
| `setWatchList`\* | Addresses to watch minimum balance and how much to top it up. |
136-
| `setForwarderAddress`\* | Updates your upkeep's forwarder address, which is available after you create your upkeep. |
137-
| `setMinWaitPeriodSeconds`\* | Updates the global minimum period between top ups. |
138-
| `topUp` | Used by `performUpkeep`. This function will only trigger top up if conditions are met. |
133+
| Function Name | Description |
134+
| --------------------------- | ----------------------------------------------------------------------------------------- |
135+
| `setWatchList`\* | Addresses to watch minimum balance and how much to top it up. |
136+
| `setForwarderAddress`\* | Updates your upkeep's forwarder address, which is available after you create your upkeep. |
137+
| `setMinWaitPeriodSeconds`\* | Updates the global minimum period between top ups. |
138+
| `topUp` | Used by `performUpkeep`. This function will only trigger top up if conditions are met. |
139139

140140
Below are the feed functions in `EthBalanceMonitor`:
141141

142-
| Read Function Name | Description |
143-
| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
144-
| `getUnderfundedAddresses` | View function used in `checkUpkeep` to find underfunded balances. |
145-
| `getForwarderAddress` | Views the upkeep's forwarder address. |
146-
| `getMinWaitPeriodSeconds` | Views the global minimum period between top ups. |
147-
| `getWatchList` | Views addresses to watch minimum balance and how much to top it up. |
148-
| `getAccountInfo` | Provides information about the specific target address, including the last time it was topped up. This function is _external only_. |
142+
| Read Function Name | Description |
143+
| ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
144+
| `getUnderfundedAddresses` | View function used in `checkUpkeep` to find underfunded balances. |
145+
| `getForwarderAddress` | Views the upkeep's forwarder address. |
146+
| `getMinWaitPeriodSeconds` | Views the global minimum period between top ups. |
147+
| `getWatchList` | Views addresses to watch minimum balance and how much to top it up. |
148+
| `getAccountInfo` | Provides information about the specific target address, including the last time it was topped up. This function is _external only_. |
149149

150150
### `setWatchList` Function
151151

@@ -163,9 +163,9 @@ Only the owner can `setWatchList`. Each of the parameters should be set with dis
163163

164164
#### Parameters
165165

166-
| Name | Description |
167-
| ----------------------- | -------------------------------------------------- |
168-
| `forwarderAddress` | Unique forwarder address used to secure your upkeep |
166+
| Name | Description |
167+
| ------------------ | --------------------------------------------------- |
168+
| `forwarderAddress` | Unique forwarder address used to secure your upkeep |
169169

170170
Only the `forwarderAddress` can `performUpkeep`. Your upkeep's forwarder address can be found on the [Chainlink Automation app](https://automation.chain.link/) after you create the upkeep. Only the owner can set a new `forwarderAddress` after deployment.
171171

src/content/quickstarts/functions-demo-app.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ requires: "Wallet with gas token & ERC-677 LINK"
1111
import { Aside } from "@components"
1212

1313
<Aside type="caution" title="Polygon testnet change">
14-
The Mumbai network has stopped producing blocks, so example code will not function on this network. Check again soon
15-
for updates about future testnet support on Polygon.
14+
The Mumbai network has stopped producing blocks, so example code will not function on this network. Check again soon
15+
for updates about future testnet support on Polygon.
1616
</Aside>
1717

1818
## Overview

src/content/quickstarts/giveaway.mdx

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -83,11 +83,11 @@ For demo purposes, use Sepolia for this tutorial. Create a block explorer API ke
8383
- The private key for your deployer account. If your deployer account is in MetaMask, [export your private key from MetaMask](https://support.metamask.io/hc/en-us/articles/360015289632-How-to-export-an-account-s-private-key).
8484
- The block explorer API key from Etherscan that you [created earlier](#create-a-block-explorer-api-key).
8585

86-
| Parameter | Description | Example |
87-
| ----------------- | --------------------------------------------------------------------------------------- | ------------------------------------------------------ |
86+
| Parameter | Description | Example |
87+
| ----------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------- |
8888
| `NETWORK_RPC_URL` | The RPC URL for the network you want to deploy to. | `https://eth-sepolia.g.alchemy.com/v2/your-api-key` |
89-
| `PRIVATE_KEY` | The private key of the account you want to deploy from. <br/> Add `0x` before your key. | `0xabc123abc123abc123abc123abc123...` |
90-
| `EXPLORER_KEY` | The block explorer API key needed for contract verification. | `ABC123ABC123ABC123ABC123ABC123ABC1` |
89+
| `PRIVATE_KEY` | The private key of the account you want to deploy from. <br/> Add `0x` before your key. | `0xabc123abc123abc123abc123abc123...` |
90+
| `EXPLORER_KEY` | The block explorer API key needed for contract verification. | `ABC123ABC123ABC123ABC123ABC123ABC1` |
9191

9292
1. In the `contracts` directory, create a `.env` file for your contract environment variables:
9393

@@ -148,35 +148,35 @@ Install [GNU make](https://www.gnu.org/software/make/) if you do not already hav
148148

149149
### macOS
150150

151-
1. The Xcode command line tools include `make`. If you've previously installed Xcode, skip to step 2 to verify your installation. Otherwise, open a Terminal window and run:
152-
```sh
153-
xcode-select --install
154-
```
155-
Alternatively, if you prefer to [use Homebrew](https://formulae.brew.sh/formula/make), be aware that GNU `make` is installed as `gmake`.
156-
1. Verify your `make` installation:
157-
```sh
158-
make
159-
```
160-
If `make` is installed successfully, you will get the following output:
161-
```sh
162-
make: *** No targets specified or no makefile found. Stop.
163-
```
151+
1. The Xcode command line tools include `make`. If you've previously installed Xcode, skip to step 2 to verify your installation. Otherwise, open a Terminal window and run:
152+
```sh
153+
xcode-select --install
154+
```
155+
Alternatively, if you prefer to [use Homebrew](https://formulae.brew.sh/formula/make), be aware that GNU `make` is installed as `gmake`.
156+
1. Verify your `make` installation:
157+
```sh
158+
make
159+
```
160+
If `make` is installed successfully, you will get the following output:
161+
```sh
162+
make: *** No targets specified or no makefile found. Stop.
163+
```
164164

165165
### Windows
166166

167-
1. If you're using WSL, open an Ubuntu terminal and run:
168-
```sh
169-
sudo apt install make
170-
```
171-
1. [Edit your path variable to include `make`](https://help.ubuntu.com/community/EnvironmentVariables#Persistent_environment_variables).
172-
1. Verify your `make` installation:
173-
```sh
174-
make
175-
```
176-
If `make` is installed successfully, you will get the following output:
177-
```sh
178-
make: *** No targets specified or no makefile found. Stop.
179-
```
167+
1. If you're using WSL, open an Ubuntu terminal and run:
168+
```sh
169+
sudo apt install make
170+
```
171+
1. [Edit your path variable to include `make`](https://help.ubuntu.com/community/EnvironmentVariables#Persistent_environment_variables).
172+
1. Verify your `make` installation:
173+
```sh
174+
make
175+
```
176+
If `make` is installed successfully, you will get the following output:
177+
```sh
178+
make: *** No targets specified or no makefile found. Stop.
179+
```
180180

181181
Install contract dependencies if changes have been made to contracts:
182182

@@ -232,10 +232,10 @@ Set environment variables to run the UI and then view it locally.
232232

233233
1. Prepare your UI environment variables. These are needed for each time you want to run the UI:
234234

235-
| Item | Value |
236-
| -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
237-
| `UI_GIVEAWAY_MANAGER_CONTRACT_ADDRESS` | The address of the Giveaway Contract Manager contract that you [deployed earlier](#deploy-contract) |
238-
| `UI_LINK_TOKEN_CONTRACT_ADDRESS` | For Ethereum Sepolia: <CopyText text="0x779877A7B0D9E8603169DdbD7836e478b4624789" code/> <br/> See all [LINK token contract addresses](/resources/link-token-contracts) |
235+
| Item | Value |
236+
| -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
237+
| `UI_GIVEAWAY_MANAGER_CONTRACT_ADDRESS` | The address of the Giveaway Contract Manager contract that you [deployed earlier](#deploy-contract) |
238+
| `UI_LINK_TOKEN_CONTRACT_ADDRESS` | For Ethereum Sepolia: <CopyText text="0x779877A7B0D9E8603169DdbD7836e478b4624789" code/> <br/> See all [LINK token contract addresses](/resources/link-token-contracts) |
239239
| `UI_KEEPER_REGISTRY_CONTRACT_ADDRESS` | For Ethereum Sepolia: <CopyText text="0xE16Df59B887e3Caa439E0b29B42bA2e7976FD8b2" code/> <br/> This app currently supports Automation v1.2. See all [Automation registry contract addresses](/chainlink-automation/overview/supported-networks) |
240240

241241
1. Navigate to the `/client/packages/ui` directory, and run these commands to set up your UI environment variables. Do not use quotes to assign values:

src/content/quickstarts/hardhat-plugin.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ Instead, you can call the methods by passing its name as a parameter for the rel
122122
If the subtask and/or args are not passed directly, they will be interactively inquired during the CLI command execution.
123123

124124
<Aside type="note">
125-
<p>Arguments for methods called with CLI should be provided as a valid JSON string.</p>
125+
<p>Arguments for methods called with CLI should be provided as a valid JSON string.</p>
126126
</Aside>
127127

128128
To get a list of all available methods (subtasks) and their arguments for a specific service, you can use:

0 commit comments

Comments
 (0)