@@ -39,6 +25,7 @@ Because these resources are public facing, you should review security and best p
## IAM Roles
The Quick Start creates the following IAM roles:
+
- **Administration Role:** Grants the provided administrator ID with administrator access
- **Execution Role:** Grants cloudformation.amazonaws.com the administration role to extend the functionality of stacks by enabling create, update, or delete stacks across multiple accounts and regions with a single operation
- **Chainlink Node Role:**
@@ -49,6 +36,7 @@ The Quick Start creates the following IAM roles:
## Billable Services
The Quick Start has the following billable services. Click on each link to learn about the pricing model for each service:
+
- [**Amazon EC2**](https://aws.amazon.com/ec2/pricing/?nc2=type_a)
- [**Amazon Virtual Private Cloud (VPC)**](https://aws.amazon.com/vpc/pricing/)
- [**Amazon Aurora PostgreSQL-Compatible DB**](https://aws.amazon.com/rds/aurora/pricing/)
@@ -56,8 +44,8 @@ The Quick Start has the following billable services. Click on each link to learn
- [**AWS Secrets Manager**](https://aws.amazon.com/secrets-manager/pricing/?nc1=h_ls)
- [**AWS Key Management Service**](https://aws.amazon.com/kms/pricing/?nc2=type_a)
- [**Amazon CloudWatch**](https://aws.amazon.com/cloudwatch/pricing/?nc2=type_a)
-- (*Optional* if you are not using a public certificate with AWS Certificate Manager) [**Application Load Balancer**](https://aws.amazon.com/elasticloadbalancing/pricing/?nc=sn&loc=3)
-- (*Optional*) [**Amazon Devops Guru**](https://aws.amazon.com/devops-guru/pricing/?nc=sn&loc=3&refid=0c5ce5de-7dc6-4ce5-95c9-29c9047095fc~ha_awssm-10495_event_prospect)
+- (_Optional_ if you are not using a public certificate with AWS Certificate Manager) [**Application Load Balancer**](https://aws.amazon.com/elasticloadbalancing/pricing/?nc=sn&loc=3)
+- (_Optional_) [**Amazon Devops Guru**](https://aws.amazon.com/devops-guru/pricing/?nc=sn&loc=3&refid=0c5ce5de-7dc6-4ce5-95c9-29c9047095fc~ha_awssm-10495_event_prospect)
You are responsible for the cost of the AWS services and any third-party licenses that you use while running this Quick Start. There is no additional cost for using the Quick Start.
@@ -65,18 +53,20 @@ AWS maintains service limits for each account to help guarantee the availability
For more information, visit [Manage Service Limits](https://aws.amazon.com/premiumsupport/knowledge-center/manage-service-limits/).
-
## Best Practices
### Do not run as the root user
+
The operations on the Chainlink node do not require the root user so it is recommended to use the default user or run as a non-root user.
### Protect your AWS account
+
As a best security practice, [rotate programmatic system credentials](https://aws.amazon.com/blogs/security/how-to-rotate-access-keys-for-iam-users/) and [cryptographic keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html).
If you enable Amazon Devops Guru, the Quick Start deploys an AWS managed customer key (CMK) that is used for the Amazon SNS topic for DevOps Guru. The default setting is automatically set to rotate this KMS key every year.
### Monitor your Chainlink node's health
+
Run regular health checks of your Chainlink node.
We recommend using a monitoring solution to track the health of your Chainlink node, such as [Prometheus](https://prometheus.io/docs/prometheus/latest/getting_started/) or [Grafana](https://grafana.com/docs/grafana/latest/getting-started/getting-started-prometheus/). Chainlink exposes metrics on the `/metrics` endpoint of the UI. By default, that's http://localhost:6688/metrics.
@@ -98,6 +88,7 @@ Alternatively, you can run a health check on your node using `curl` and make sur
curl -XGET localhost:6688/health | jq '.'
```
+
```json
% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
@@ -140,7 +131,6 @@ curl -XGET localhost:6688/health | jq '.'
To check the status of your Chainlink node container, use the `docker ps` command.
-
## Recovering or Upgrading your Chainlink Node Container
Tag versions for Chainlink node releases are available in the [Chainlink docker hub](https://hub.docker.com/r/smartcontract/chainlink/tags)
@@ -199,7 +189,7 @@ cd /home/ec2-user/.chainlink && docker run -d \
-a /chainlink/.api
```
-You can find more details with maintenance and examples in the [Performing System Maintenance](https://docs.chain.link/docs/performing-system-maintenance/) guide.
+You can find more details with maintenance and examples in the [Performing System Maintenance](/chainlink-nodes/performing-system-maintenance/) guide.
Additionally, follow the directions in the [User Guide for Linux Instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/install-updates.html) to keep your Amazon Linux instance software up to date.
@@ -243,10 +233,10 @@ Management of AWS service limits are not required for proper disaster recovery.
In the AWS console, if the **SSL certificate with AWS Certificate Manager** is set to `false`, you can leave **arn:aws:acm:region:account-id:certificate** as is. However, if your node is external facing and must be reached by the internet, enable this feature and set it to `true`.
-
+
### Amazon Devops Guru
In the AWS console, if the **Amazon DevOps Guru** is set to `false`, you can leave **AdministerAccountId** and **EmailAddress** as is.
-
+
diff --git a/docs/chainlink-nodes/best-security-practices.md b/src/pages/chainlink-nodes/best-security-practices.md
similarity index 78%
rename from docs/chainlink-nodes/best-security-practices.md
rename to src/pages/chainlink-nodes/best-security-practices.md
index c5e9dc1affc..b4590d7e400 100644
--- a/docs/chainlink-nodes/best-security-practices.md
+++ b/src/pages/chainlink-nodes/best-security-practices.md
@@ -1,10 +1,11 @@
---
-layout: nodes.liquid
+layout: ../../layouts/MainLayout.astro
section: nodeOperator
date: Last Modified
title: "Security and Operation Best Practices"
permalink: "docs/best-security-practices/"
---
+
The following information provides a set of security and operation best practices that node operators need to use at a minimum to enhance the security and reliability of their infrastructure.
## Restricting Access
@@ -34,8 +35,8 @@ To ensure there is very minimal downtime, failover capabilities are required on
**Ethereum-specific:**
- Ethereum client websocket connectivity is fronted by a load balancer, used by the Chainlink nodes. [Here is an example on how to set up a load balancer](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/tutorial-target-ecs-containers.html).
- - If a VPN and internal routing is configured, SSL is not needed but still recommended, as all traffic is purely internal.
- - If both Ethereum and Chainlink nodes are public facing without a VPN, SSL is required to ensure that no communication between both can be intercepted.
+ - If a VPN and internal routing is configured, SSL is not needed but still recommended, as all traffic is purely internal.
+ - If both Ethereum and Chainlink nodes are public facing without a VPN, SSL is required to ensure that no communication between both can be intercepted.
## Disaster Recovery
@@ -59,29 +60,29 @@ To be proactive in detecting any issues before or when they occur, active monito
- Ethereum client disk, RAM and CPU usage.
Monitoring can be set up from the Docker container's output and fed into most major logging providers. For example, you can use Docker's docs to set up the logging driver for [Amazon CloudWatch](https://docs.docker.com/config/containers/logging/awslogs/) and [Google Cloud Logging](https://docs.docker.com/config/containers/logging/gcplogs/). You will want to set the [
-JSON_CONSOLE](../configuration-variables/#json_console) configuration variable to `true` so that the output of the container is JSON-formatted for logging.
+JSON_CONSOLE](/chainlink-nodes/configuration-variables/#json_console) configuration variable to `true` so that the output of the container is JSON-formatted for logging.
## Frequent Updates
Due to the early nature of the software, it may be required to perform frequent updates to your Chainlink node.
-On performing system maintenance to update the Chainlink node, follow [this](/docs/performing-system-maintenance/#failover-node-example) guide.
+On performing system maintenance to update the Chainlink node, follow [this](/chainlink-nodes/performing-system-maintenance/#failover-node-example) guide.
## Jobs and Config
The following are suggestions for job specifications and configuration settings for the node.
-[Job Specifications](../jobs/):
+[Job Specifications](/chainlink-nodes/oracle-jobs/jobs/):
-- Include the address of your oracle contract address for all RunLog initiated jobs, as shown in the [Fulfilling Requests](../fulfilling-requests/#add-a-job-to-the-node) guide.
+- Include the address of your oracle contract address for all RunLog initiated jobs, as shown in the [Fulfilling Requests](/chainlink-nodes/fulfilling-requests/#add-a-job-to-the-node) guide.
- Override the global `MIN_INCOMING_CONFIRMATIONS` config by setting a `confirmations` field in jobs which perform off-chain payments to allow for greater security by making the node ensure the transaction is still valid after X blocks.
-[Configuring Chainlink Nodes](../configuration-variables/):
+[Configuring Chainlink Nodes](/chainlink-nodes/configuration-variables/):
-- [MINIMUM_CONTRACT_PAYMENT_LINK_JUELS](../configuration-variables/#minimum_contract_payment_link_juels): ensure your required payment amount is high enough to meet the costs of responding on-chain.
-- [MIN_INCOMING_CONFIRMATIONS](../configuration-variables/#min_incoming_confirmations): this can be set to 0 for common data request jobs. See the bullet above on setting individual `confirmations` for specific jobs.
-- [LOG_FILE_MAX_SIZE](../configuration-variables/#log_file_max_size): Set this to `0` if you're using external log drivers which parse the output from Docker containers. This will save you disk space.
-- [JSON_CONSOLE](../configuration-variables/#json_console): Set to `true` if you're using external log drivers to parse the output of Docker containers. This will make it easier to parse individual fields of the log and set up alerts.
+- [MINIMUM_CONTRACT_PAYMENT_LINK_JUELS](/chainlink-nodes/configuration-variables/#minimum_contract_payment_link_juels): ensure your required payment amount is high enough to meet the costs of responding on-chain.
+- [MIN_INCOMING_CONFIRMATIONS](/chainlink-nodes/configuration-variables/#min_incoming_confirmations): this can be set to 0 for common data request jobs. See the bullet above on setting individual `confirmations` for specific jobs.
+- [LOG_FILE_MAX_SIZE](/chainlink-nodes/configuration-variables/#log_file_max_size): Set this to `0` if you're using external log drivers which parse the output from Docker containers. This will save you disk space.
+- [JSON_CONSOLE](/chainlink-nodes/configuration-variables/#json_console): Set to `true` if you're using external log drivers to parse the output of Docker containers. This will make it easier to parse individual fields of the log and set up alerts.
## Addresses
diff --git a/docs/chainlink-nodes/configuration-variables.md b/src/pages/chainlink-nodes/configuration-variables.md
similarity index 92%
rename from docs/chainlink-nodes/configuration-variables.md
rename to src/pages/chainlink-nodes/configuration-variables.md
index 01214528216..0835f302dc2 100644
--- a/docs/chainlink-nodes/configuration-variables.md
+++ b/src/pages/chainlink-nodes/configuration-variables.md
@@ -1,5 +1,5 @@
---
-layout: nodes.liquid
+layout: ../../layouts/MainLayout.astro
section: nodeOperator
date: Last Modified
title: "Configuring Chainlink Nodes"
@@ -18,7 +18,7 @@ The environment variables listed here are explicitly supported and current as of
As of Chainlink node v1.1.0 and up, the way nodes manage configuration is changing. Previously, environment variables exclusively handled all node configuration. Although this configuration method worked well in the past, it has its limitations. Notably, it doesn't mesh well with chain-specific configuration profiles.
-For this reason, Chainlink nodes are moving towards a model where you set variables using the API, [CLI](/docs/configuration-variables/#cli-client), or GUI, and the configuration is saved in the database. We encourage you to become familiar with this model because it is likely that nodes will continue to move away from environment variable configuration in the future.
+For this reason, Chainlink nodes are moving towards a model where you set variables using the API, [CLI](/chainlink-nodes/configuration-variables/#cli-client), or GUI, and the configuration is saved in the database. We encourage you to become familiar with this model because it is likely that nodes will continue to move away from environment variable configuration in the future.
As of v1.1.0, Chainlink nodes still support environment variables to configure node settings and chain-specific settings. If the environment variable is set, it overrides any chain-specific, job-specific, or database configuration setting. The log displays a warning to indicate when an override happens, so you know when variables lower in the hierarchy are being ignored.
@@ -28,7 +28,7 @@ Your node applies configuration settings using following hierarchy:
1. Chain-specific variables
1. Job-specific variables
-**Topics**
+**Table of contents:**
- [Changes to node configuration starting in v1.1.0 nodes](#changes-to-node-configuration-starting-in-v110-nodes)
- [Essential environment variables](#essential-environment-variables)
@@ -178,8 +178,8 @@ Your node applies configuration settings using following hierarchy:
- [BLOCK_HISTORY_ESTIMATOR_EIP1559_FEE_CAP_BUFFER_BLOCKS](#block_history_estimator_eip1559_fee_cap_buffer_blocks)
- [BLOCK_HISTORY_ESTIMATOR_TRANSACTION_PERCENTILE](#block_history_estimator_transaction_percentile)
- [EVM/Ethereum Transaction Simulation](#evmethereum-transaction-simulation)
- - [FM_SIMULATE_TRANSACTIONS](#fm_simulate_transactions)
- - [OCR_SIMULATE_TRANSACTIONS](#ocr_simulate_transactions)
+ - [FM_SIMULATE_TRANSACTIONS](#fm_simulate_transactions)
+ - [OCR_SIMULATE_TRANSACTIONS](#ocr_simulate_transactions)
- [Job Pipeline and tasks](#job-pipeline-and-tasks)
- [DEFAULT_HTTP_LIMIT](#default_http_limit)
- [DEFAULT_HTTP_TIMEOUT](#default_http_timeout)
@@ -189,6 +189,7 @@ Your node applies configuration settings using following hierarchy:
- [JOB_PIPELINE_REAPER_THRESHOLD](#job_pipeline_reaper_threshold)
- [JOB_PIPELINE_RESULT_WRITE_QUEUE_DEPTH](#job_pipeline_result_write_queue_depth)
- [OCR](#ocr)
+
- [FEATURE_OFFCHAIN_REPORTING](#feature_offchain_reporting)
- [OCR_KEY_BUNDLE_ID](#ocr_key_bundle_id)
- [OCR_MONITORING_ENDPOINT](#ocr_monitoring_endpoint)
@@ -234,7 +235,7 @@ These are the only environment variables that are _required_ for a Chainlink nod
- Default: _none_
-The PostgreSQL URI to connect to your database. Chainlink nodes require Postgres versions >= 11. See the [Running a Chainlink Node](../running-a-chainlink-node/#set-the-remote-database_url-config) for an example.
+The PostgreSQL URI to connect to your database. Chainlink nodes require Postgres versions >= 11. See the [Running a Chainlink Node](/chainlink-nodes/running-a-chainlink-node/#set-the-remote-database_url-config) for an example.
## General Node Configuration
@@ -334,7 +335,9 @@ Toggles sending telemetry to the ingress server using the batch client.
### SOLANA_ENABLED
-> 🚧 Not intended for use on the Solana mainnet.
+:::caution
+Not intended for use on the Solana mainnet.
+:::
- Default: `"false"`
@@ -559,9 +562,10 @@ Previous versions of Chainlink nodes wrote JSON logs with a unix timestamp. As o
When set, this environment variable configures and enables an optional HTTP logger which is used specifically to send audit log events. Audit logs events are emitted when specific actions are performed by any of the users through the node's API. The value of this variable should be a full URL. Log items will be sent via POST HTTP requests.
There are audit log implemented for the following events:
- - Auth & Sessions (new session, login success, login failed, 2FA enrolled, 2FA failed, password reset, password reset failed, etc.)
- - CRUD actions for all resources (add/create/delete resources such as bridges, nodes, keys)
- - Sensitive actions (keys exported/imported, config changed, log level changed, environment dumped)
+
+- Auth & Sessions (new session, login success, login failed, 2FA enrolled, 2FA failed, password reset, password reset failed, etc.)
+- CRUD actions for all resources (add/create/delete resources such as bridges, nodes, keys)
+- Sensitive actions (keys exported/imported, config changed, log level changed, environment dumped)
A full list of audit log enum types can be found in the source within the `audit` package ([`audit_types.go`](https://github.com/smartcontractkit/chainlink/blob/develop/core/logger/audit/audit_types.go)).
@@ -583,11 +587,11 @@ The `AUDIT_LOGS_*` environment variables below configure this optional audit log
- Default: _none_
-An optional list of HTTP headers to be added for every optional audit log event. If the above `AUDIT_LOGGER_FORWARD_TO_URL` is set, audit log events will be POSTed to that URL, and will include headers specified in this environment variable. One example use case is auth for example:
-```AUDIT_LOGGER_HEADERS="Authorization||{token}"```
+An optional list of HTTP headers to be added for every optional audit log event. If the above `AUDIT_LOGGER_FORWARD_TO_URL` is set, audit log events will be POSTed to that URL, and will include headers specified in this environment variable. One example use case is auth for example:
+`AUDIT_LOGGER_HEADERS="Authorization||{token}"`
Header keys and values are delimited on `||`, and multiple headers can be added with a forward slash delimiter (`\`). An example of multiple key value pairs:
-```AUDIT_LOGGER_HEADERS="Authorization||{token}\Some-Other-Header||{token2}"```
+`AUDIT_LOGGER_HEADERS="Authorization||{token}\Some-Other-Header||{token2}"`
##### AUDIT_LOGGER_JSON_WRAPPER_KEY
@@ -733,7 +737,7 @@ Do not change this setting unless you know what you are doing.
- Default: `"6688"`
-Port used for the Chainlink Node API, [CLI](/docs/configuration-variables/#cli-client), and GUI.
+Port used for the Chainlink Node API, [CLI](/chainlink-nodes/configuration-variables/#cli-client), and GUI.
### SECURE_COOKIES
@@ -815,17 +819,17 @@ The location of the TLS private key file. Example: `/home/$USER/.chainlink/tls/s
Previous Chainlink node versions supported only one chain. From v1.1.0 and up, Chainlink nodes support multiple EVM and non-EVM chains, so the way that chains and nodes are configured has changed.
-The preferred way of configuring Chainlink nodes as of v1.1.0 and up is to use the API, [CLI](/docs/configuration-variables/#cli-client), or UI to set chain-specific configuration and create nodes.
+The preferred way of configuring Chainlink nodes as of v1.1.0 and up is to use the API, [CLI](/chainlink-nodes/configuration-variables/#cli-client), or UI to set chain-specific configuration and create nodes.
The old way of specifying chains using environment variables is still supported, but discouraged. It works as follows:
If you set any value for `ETH_URL`, the values of `ETH_CHAIN_ID`, `ETH_URL`, `ETH_HTTP_URL` and `ETH_SECONDARY_URLS` will be used to create and update chains and nodes representing these values in the database. If an existing chain or node is found, it will be overwritten. This mode is used mainly to ease the process of upgrading. On subsequent runs (once your old settings have been written to the database) it is recommended to unset `ETH_URL` and use the API commands exclusively to administer chains and nodes.
-In the future, support for the `ETH_URL` and associated environment variables might be removed, so it is recommended to use the API, [CLI](/docs/configuration-variables/#cli-client), or GUI instead to setup chains and nodes.
+In the future, support for the `ETH_URL` and associated environment variables might be removed, so it is recommended to use the API, [CLI](/chainlink-nodes/configuration-variables/#cli-client), or GUI instead to setup chains and nodes.
### ETH_URL
-Setting this will enable "legacy eth ENV" mode, which is not compatible with multi-chain. It is better to configure settings using the API, [CLI](/docs/configuration-variables/#cli-client), or GUI instead.
+Setting this will enable "legacy eth ENV" mode, which is not compatible with multi-chain. It is better to configure settings using the API, [CLI](/chainlink-nodes/configuration-variables/#cli-client), or GUI instead.
- Default: _none_
@@ -835,7 +839,7 @@ NOTE: It is also required to set `ETH_CHAIN_ID` if you set ETH_URL.
### ETH_HTTP_URL
-Only has effect if `ETH_URL` set. Otherwise, it can be set in the API, [CLI](/docs/configuration-variables/#cli-client), or GUI.
+Only has effect if `ETH_URL` set. Otherwise, it can be set in the API, [CLI](/chainlink-nodes/configuration-variables/#cli-client), or GUI.
- Default: _none_
@@ -843,14 +847,15 @@ This should be set to the HTTP URL that points to the same ETH node as the prima
### EVM_NODES
-> 🚧 WARNING
->
-> Setting this environment variable will **COMPLETELY ERASE** your `evm_nodes` table on every boot and repopulate from the given data to nullify any runtime modifications. This is a temporary solution until this configuration can be defined in a file in the future.
+:::caution
+Setting this environment variable will **COMPLETELY ERASE** your `evm_nodes` table on every boot and repopulate from the given data to nullify any runtime modifications. This is a temporary solution until this configuration can be defined in a file in the future.
+:::
- Default: _none_
A JSON array of node specifications that allows you to configure multiple nodes or chains using an environment variable. This is not compatible with other environment variables that specify the node such as `ETH_URL` or `ETH_SECONDARY_URLS`. Set this variable using a configuration like the following example:
+
```json
EVM_NODES='
[
@@ -904,13 +909,14 @@ EVM_NODES='
Usage of Docker requires the variable to be formatted as one line with no whitespaces and quotes wrapping it, as follows in the example:
+
```bash
EVM_NODES=[{"name":"primary_0_1","evmChainId":"0","wsUrl":"ws://test1.invalid","sendOnly":false},{"name":"primary_0_2","evmChainId":"0","wsUrl":"ws://test2.invalid","httpUrl":"https://test3.invalid","sendOnly":false},{"name":"primary_1337_1","evmChainId":"1337","wsUrl":"ws://test4.invalid","httpUrl":"http://test5.invalid","sendOnly":false}]
```
### ETH_SECONDARY_URLS
-Only has effect if `ETH_URL` set. Otherwise, it can be set in the API, [CLI](/docs/configuration-variables/#cli-client), or GUI.
+Only has effect if `ETH_URL` set. Otherwise, it can be set in the API, [CLI](/chainlink-nodes/configuration-variables/#cli-client), or GUI.
- Default: _none_
@@ -967,10 +973,9 @@ This variable specifies the number of blocks before the current head that the lo
This variable enables skipping of very long log backfills. For example, this happens in a situation when the node is started after being offline for a long time.
This might be useful on fast chains and if only recent chain events are relevant
-
### ETH_TX_REAPER_INTERVAL
-NOTE: This overrides the setting for _all_ chains, you might want to set this on a per-chain basis using the API, [CLI](/docs/configuration-variables/#cli-client), or GUI instead
+NOTE: This overrides the setting for _all_ chains, you might want to set this on a per-chain basis using the API, [CLI](/chainlink-nodes/configuration-variables/#cli-client), or GUI instead
- Default: `"1h"`
@@ -991,7 +996,7 @@ Setting to `0` disables the reaper.
### ETH_TX_RESEND_AFTER_THRESHOLD
-NOTE: This overrides the setting for _all_ chains, you might want to set this on a per-chain basis using the API, [CLI](/docs/configuration-variables/#cli-client), or GUI instead.
+NOTE: This overrides the setting for _all_ chains, you might want to set this on a per-chain basis using the API, [CLI](/chainlink-nodes/configuration-variables/#cli-client), or GUI instead.
- Default: _automatically set based on Chain ID, typically 1m_
@@ -1068,8 +1073,9 @@ You can override this on a per-job basis.
`MIN_INCOMING_CONFIRMATIONS=1` would kick off a job after seeing the transaction in just one block.
-> 🚧 NOTE
-> The lowest value allowed here is 1, since setting to 0 would imply that logs are processed from the mempool before they are even mined into a block, which isn't possible with Chainlink's current architecture.
+:::caution
+The lowest value allowed here is 1, since setting to 0 would imply that logs are processed from the mempool before they are even mined into a block, which isn't possible with Chainlink's current architecture.
+:::
### MIN_OUTGOING_CONFIRMATIONS
@@ -1084,16 +1090,17 @@ This can be overridden on a per-task basis by setting the `MinRequiredOutgoingCo
### MINIMUM_CONTRACT_PAYMENT_LINK_JUELS
-> 🚧 NOTE
-> This has replaced the formerly used MINIMUM_CONTRACT_PAYMENT
+:::note
+This has replaced the formerly used MINIMUM_CONTRACT_PAYMENT.
+:::
- Default: _automatically set based on Chain ID, typically 10000000000000 (0.00001 LINK) on all chains except Ethereum Mainnet and Goerli where it is 100000000000000000 (0.1 LINK)._
For jobs that use the `EthTx` adapter, this is the minimum payment amount in order for the node to accept and process the job. Since there are no decimals on the EVM, the value is represented like wei.
-> 🚧 Note
->
-> Keep in mind, the Chainlink node currently responds with a 500,000 gas limit. Under pricing your node could mean it spends more in ETH (on gas) than it earns in LINK.
+:::note
+Keep in mind, the Chainlink node currently responds with a 500,000 gas limit. Under pricing your node could mean it spends more in ETH (on gas) than it earns in LINK.
+:::
### NODE_NO_NEW_HEADS_THRESHOLD
@@ -1126,13 +1133,13 @@ Set to zero to disable poll checking.
Controls node picking strategy. Supported values:
- `HighestHead` (default) mode picks a node having the highest reported head number among other alive nodes. When several nodes have the same latest head number, the strategy sticks to the last used node. This mode requires `NODE_NO_NEW_HEADS_THRESHOLD` to be configured, otherwise it will always use the first alive node.
-- `RoundRobin` mode simply iterates among available alive nodes. This was the default behavior prior to this release.
+- `RoundRobin` mode simply iterates among available alive nodes. This was the default behavior prior to this release.
## EVM Gas Controls
These settings allow you to tune your node's gas limits and pricing. In most cases, leaving these values at their defaults should give good results.
-As of Chainlink node v1.1.0, it is recommended to use the API, [CLI](/docs/configuration-variables/#cli-client), or GUI to configure gas controls because you might want to use different settings for different chains. Setting the environment variable typically overrides the setting for all chains.
+As of Chainlink node v1.1.0, it is recommended to use the API, [CLI](/chainlink-nodes/configuration-variables/#cli-client), or GUI to configure gas controls because you might want to use different settings for different chains. Setting the environment variable typically overrides the setting for all chains.
### Configuring your ETH node
@@ -1148,6 +1155,7 @@ It is also recommended to configure go-ethereum properly before increasing `ETH_
Relevant settings for geth and forks (such as BSC).
+
```toml
[Eth]
RPCGasCap = 0 # it is recommended to disable both gas and txfee cap
@@ -1186,10 +1194,12 @@ In EIP-1559 mode, the total price for the transaction is the minimum of base fee
Chainlink's implementation of EIP-1559 works as follows:
If you are using FixedPriceEstimator:
-- With gas bumping disabled, it will submit all transactions with `feecap=ETH_MAX_GAS_PRICE_WEI` and `tipcap=EVM_GAS_TIP_CAP_DEFAULT`.
+
+- With gas bumping disabled, it will submit all transactions with `feecap=ETH_MAX_GAS_PRICE_WEI` and `tipcap=EVM_GAS_TIP_CAP_DEFAULT`
- With gas bumping enabled, it will submit all transactions initially with `feecap=EVM_GAS_FEE_CAP_DEFAULT` and `tipcap=EVM_GAS_TIP_CAP_DEFAULT`.
If you are using BlockHistoryEstimator (default for most chains):
+
- With gas bumping disabled, it will submit all transactions with `feecap=ETH_MAX_GAS_PRICE_WEI` and `tipcap=
`
- With gas bumping enabled (default for most chains) it will submit all transactions initially with `feecap=current block base fee * (1.125 ^ N)` where N is configurable by setting BLOCK_HISTORY_ESTIMATOR_EIP1559_FEE_CAP_BUFFER_BLOCKS but defaults to `gas bump threshold+1` and `tipcap=`
@@ -1384,7 +1394,7 @@ Enables or disables sending transactions through forwarder contracts.
These settings allow you to configure how your node calculates gas prices. In most cases, leaving these values at their defaults should give good results.
-As of Chainlink node v1.1.0, it is recommended to use the API, [CLI](/docs/configuration-variables/#cli-client), or GUI to configure gas controls because you might want to use different settings for different chains. Setting the environment variable typically overrides the setting for all chains.
+As of Chainlink node v1.1.0, it is recommended to use the API, [CLI](/chainlink-nodes/configuration-variables/#cli-client), or GUI to configure gas controls because you might want to use different settings for different chains. Setting the environment variable typically overrides the setting for all chains.
Chainlink nodes decide what gas price to use using an `Estimator`. It ships with several simple and battle-hardened built-in estimators that should work well for almost all use-cases. Note that estimators will change their behaviour slightly depending on if you are in EIP-1559 mode or not.
@@ -1586,7 +1596,9 @@ Example: `P2P_PEER_ID=12D3KooWMHMRLQkgPbFSYHwD3NBuwtS1AmxhvKVUrcfyaGDASR4U`
### Networking Stack V1
-> 🚧 Do not set environment variables for Networking Stack v1 if you are using [Networking Stack V2](#networking-stack-v2).
+:::caution
+Do not set environment variables for Networking Stack v1 if you are using [Networking Stack V2](#networking-stack-v2).
+:::
#### P2P_ANNOUNCE_IP
@@ -1621,17 +1633,28 @@ The default IP address to bind to.
The port to listen on. If left blank, the node randomly selects a different port each time it boots. It is highly recommended to set this to a static value to avoid network instability.
+#### P2P_PEER_ID
+
+- Default: _none_
+
+This environment variable is used for both Networking Stack V1 and V2.
+
+The default peer ID to use for OCR jobs. If unspecified, uses the first available peer ID.
+Example: `P2P_PEER_ID=12D3KooWMHMRLQkgPbFSYHwD3NBuwtS1AmxhvKVUrcfyaGDASR4U`
+
### Networking Stack V2
-> 🚧 If using the Networking Stack V2, you must unset the following [Networking Stack V1](#networking-stack-v1) configuration variables:
->
-> - [P2P_ANNOUNCE_IP](#p2p_announce_ip)
-> - [P2P_ANNOUNCE_PORT](#p2p_announce_port)
-> - [P2P_BOOTSTRAP_PEERS](#p2p_bootstrap_peers)
-> - [P2P_LISTEN_IP](#p2p_listen_ip)
-> - [P2P_LISTEN_PORT](#p2p_listen_port)
->
-> `P2P_PEER_ID` is used for both Networking Stack V1 and V2.
+:::caution
+If using the Networking Stack V2, you must unset the following [Networking Stack V1](#networking-stack-v1) configuration variables:
+
+- [P2P_ANNOUNCE_IP](#p2p_announce_ip)
+- [P2P_ANNOUNCE_PORT](#p2p_announce_port)
+- [P2P_BOOTSTRAP_PEERS](#p2p_bootstrap_peers)
+- [P2P_LISTEN_IP](#p2p_listen_ip)
+- [P2P_LISTEN_PORT](#p2p_listen_port)
+
+[`P2P_PEER_ID`](#p2p_peer_id) is used for both Networking Stack V1 and V2.
+:::
#### P2PV2_ANNOUNCE_ADDRESSES
@@ -1661,21 +1684,21 @@ These environment variables are used specificly for Chainlink Keepers. For most
### KEEPER_CHECK_UPKEEP_GAS_PRICE_FEATURE_ENABLED
-> 🚧 **ADVANCED**
->
-> Do not change this setting unless you know what you are doing.
+:::caution
+Do not change this setting unless you know what you are doing.
+:::
- Default: `"false"`
-Use this setting *only* on Polygon networks.
+Use this setting _only_ on Polygon networks.
Includes gas price in calls to `checkUpkeep()` when set to `true`.
### KEEPER_GAS_PRICE_BUFFER_PERCENT
-> 🚧 **ADVANCED**
->
-> Do not change this setting unless you know what you are doing.
+:::caution
+Do not change this setting unless you know what you are doing.
+:::
- Default: `"20"`
@@ -1683,9 +1706,9 @@ Includes gas price in calls to `checkUpkeep()` when set to `true`.
### KEEPER_GAS_TIP_CAP_BUFFER_PERCENT
-> 🚧 **ADVANCED**
->
-> Do not change this setting unless you know what you are doing.
+:::caution
+Do not change this setting unless you know what you are doing.
+:::
- Default: `"20"`
@@ -1693,9 +1716,9 @@ Includes gas price in calls to `checkUpkeep()` when set to `true`.
### KEEPER_BASE_FEE_BUFFER_PERCENT
-> 🚧 **ADVANCED**
->
-> Do not change this setting unless you know what you are doing.
+:::caution
+Do not change this setting unless you know what you are doing.
+:::
- Default: `"20"`
@@ -1703,9 +1726,9 @@ Adds the specified percentage to the base fee used for checking whether to perfo
### KEEPER_MAXIMUM_GRACE_PERIOD
-> 🚧 **ADVANCED**
->
-> Do not change this setting unless you know what you are doing.
+:::caution
+Do not change this setting unless you know what you are doing.
+:::
- Default: `"100"`
@@ -1713,9 +1736,9 @@ The maximum number of blocks that a keeper will wait after performing an upkeep
### KEEPER_REGISTRY_CHECK_GAS_OVERHEAD
-> 🚧 **ADVANCED**
->
-> Do not change this setting unless you know what you are doing.
+:::caution
+Do not change this setting unless you know what you are doing.
+:::
- Default: `"200000"`
@@ -1723,9 +1746,9 @@ The amount of extra gas to provide checkUpkeep() calls to account for the gas co
### KEEPER_REGISTRY_PERFORM_GAS_OVERHEAD
-> 🚧 **ADVANCED**
->
-> Do not change this setting unless you know what you are doing.
+:::caution
+Do not change this setting unless you know what you are doing.
+:::
- Default: `"300000"`
@@ -1733,9 +1756,9 @@ The amount of extra gas to provide performUpkeep() calls to account for the gas
### KEEPER_REGISTRY_SYNC_INTERVAL
-> 🚧 **ADVANCED**
->
-> Do not change this setting unless you know what you are doing.
+:::caution
+Do not change this setting unless you know what you are doing.
+:::
- Default: `"30m"`
@@ -1743,9 +1766,9 @@ The interval in which the RegistrySynchronizer performs a full sync of the keepe
### KEEPER_REGISTRY_SYNC_UPKEEP_QUEUE_SIZE
-> 🚧 **ADVANCED**
->
-> Do not change this setting unless you know what you are doing.
+:::caution
+Do not change this setting unless you know what you are doing.
+:::
- Default: `"10"`
@@ -1753,9 +1776,9 @@ The interval in which the RegistrySynchronizer performs a full sync of the keepe
### KEEPER_TURN_LOOK_BACK
-> 🚧 **ADVANCED**
->
-> Do not change this setting unless you know what you are doing.
+:::caution
+Do not change this setting unless you know what you are doing.
+:::
- Default: `"1000"`
@@ -1763,9 +1786,9 @@ The number of blocks in the past to look back when getting a block for a turn.
### KEEPER_TURN_FLAG_ENABLED
-> 🚧 **ADVANCED**
->
-> Do not change this setting unless you know what you are doing.
+:::caution
+Do not change this setting unless you know what you are doing.
+:::
- Default: `"false"`
@@ -1777,10 +1800,9 @@ The environment variables in this section apply only when running CLI commands t
### ADMIN_CREDENTIALS_FILE
-> 🚧 Deprecated:
->
-> This environment variable is deprecated and will be removed in a future release. Use the `--admin-credentials-file FILE` CLI argument instead.
-
+:::caution[Deprecated]
+This environment variable is deprecated and will be removed in a future release. Use the `--admin-credentials-file FILE` CLI argument instead.
+:::
- Default: `$ROOT/apicredentials`
@@ -1796,9 +1818,9 @@ mysecurepassw0rd
### CLIENT_NODE_URL
-> 🚧 Deprecated:
->
-> This environment variable is deprecated and will be removed in a future release. Use the `--remote-node-url URL` CLI argument instead.
+:::caution[Deprecated]
+This environment variable is deprecated and will be removed in a future release. Use the `--remote-node-url URL` CLI argument instead.
+:::
- Default: `"http://localhost:6688"`
@@ -1806,9 +1828,9 @@ This is the URL that you will use to interact with the node, including the GUI.
### INSECURE_SKIP_VERIFY
-> 🚧 Deprecated:
->
-> This environment variable is deprecated and will be removed in a future release. Use the `--insecure-skip-verify` CLI argument instead.
+:::caution[Deprecated]
+This environment variable is deprecated and will be removed in a future release. Use the `--insecure-skip-verify` CLI argument instead.
+:::
- Default: `"false"`
@@ -1818,15 +1840,17 @@ It is not recommended to change this unless you know what you are doing.
## Notes on setting environment variables
-> 🚧 NOTE
-> Some environment variables require a duration. A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms", "-1.5h" or "2h45m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". Some examples:
+:::note
+Some environment variables require a duration. A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms", "-1.5h" or "2h45m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". Some examples:
+:::
`10ms`
`1h15m`
`42m30s`
-> 🚧 NOTE
-> Some configuration variables require a file size. A file size string is an unsigned integer (123) or a float (12.3) followed by a unit suffix. Valid file size units are "b", "kb", "mb", "gb", and "tb". If the unit is omitted, it is assumed to be "b" (bytes). Capitalization does not matter. Some examples:
+:::note
+Some configuration variables require a file size. A file size string is an unsigned integer (123) or a float (12.3) followed by a unit suffix. Valid file size units are "b", "kb", "mb", "gb", and "tb". If the unit is omitted, it is assumed to be "b" (bytes). Capitalization does not matter. Some examples:
+:::
`123gb`
`1.2TB`
diff --git a/docs/chainlink-nodes/connecting-to-a-remote-database.md b/src/pages/chainlink-nodes/connecting-to-a-remote-database.md
similarity index 90%
rename from docs/chainlink-nodes/connecting-to-a-remote-database.md
rename to src/pages/chainlink-nodes/connecting-to-a-remote-database.md
index cbcbbe1c8b3..a17f89f218f 100644
--- a/docs/chainlink-nodes/connecting-to-a-remote-database.md
+++ b/src/pages/chainlink-nodes/connecting-to-a-remote-database.md
@@ -1,14 +1,16 @@
---
-layout: nodes.liquid
+layout: ../../layouts/MainLayout.astro
section: nodeOperator
date: Last Modified
title: "Connecting to a Remote Database"
permalink: "docs/connecting-to-a-remote-database/"
-whatsnext: {"Configuring Chainlink":"/docs/configuration-variables/"}
+whatsnext: { "Configuring Chainlink": "/chainlink-nodes/configuration-variables/" }
---
+
This page will serve as a basic, vendor-neutral guide for setting up a PostgreSQL database and connecting your Chainlink node to it.
PostgreSQL is a popular and secure database available on a variety of platforms. This guide will not show you how to create and set up a PostgreSQL database, however, some common guides can be found below:
+
- [Amazon AWS](https://aws.amazon.com/getting-started/tutorials/create-connect-postgresql-db/)
- [Azure](https://docs.microsoft.com/en-us/azure/postgresql/quickstart-create-server-database-portal)
- [Docker](https://docs.docker.com/samples/library/postgres/)
@@ -17,6 +19,7 @@ PostgreSQL is a popular and secure database available on a variety of platforms.
## Obtain Information About Your Database
In order to connect to a remote database, you will need to obtain information about the database and server. Take note of the database's:
+
- Server or IP
- Port
- Username
@@ -25,7 +28,7 @@ In order to connect to a remote database, you will need to obtain information ab
The user must be the owner of the desired database. On first run, the migrations will create the tables necessary for the Chainlink node.
-## Set Your DATABASE_URL Environment Variable
+## Set Your DATABASE_URL Environment Variable
Below is an example for setting the `DATABASE_URL` environment variable:
@@ -34,6 +37,7 @@ DATABASE_URL=postgresql://$USERNAME:$PASSWORD@$SERVER:$PORT/$DATABASE
```
You will need to change the following placeholders to their real values:
+
- `$USERNAME`: The database username (must be owner)
- `$PASSWORD`: The user's password
- `$SERVER`: The server name or IP address of the database server
diff --git a/docs/chainlink-nodes/enabling-https-connections.md b/src/pages/chainlink-nodes/enabling-https-connections.md
similarity index 91%
rename from docs/chainlink-nodes/enabling-https-connections.md
rename to src/pages/chainlink-nodes/enabling-https-connections.md
index 43ae09b5df2..b9a50c73ac6 100644
--- a/docs/chainlink-nodes/enabling-https-connections.md
+++ b/src/pages/chainlink-nodes/enabling-https-connections.md
@@ -1,22 +1,24 @@
---
-layout: nodes.liquid
+layout: ../../layouts/MainLayout.astro
section: nodeOperator
date: Last Modified
title: "Enabling HTTPS Connections"
permalink: "docs/enabling-https-connections/"
-whatsnext: {"Miscellaneous":"/docs/miscellaneous/"}
+whatsnext: { "Miscellaneous": "/chainlink-nodes/miscellaneous/" }
---
+
This guide will walk you through how to generate your own self-signed certificates for use by the Chainlink node. You can also substitute self-signed certificates with certificates of your own, like those created by Let's Encrypt .
-> 📘 Important
->
-> You will need [OpenSSL](https://www.openssl.org) in order to generate your own self-signed certificates.
+:::tip[TLS]
+You will need [OpenSSL](https://www.openssl.org) in order to generate your own self-signed certificates.
+:::
Create a directory `tls/` within your local Chainlink directory:
```text Goerli
mkdir ~/.chainlink-goerli/tls
```
+
```text Mainnet
mkdir ~/.chainlink/tls
```
@@ -29,6 +31,7 @@ openssl req -x509 -out ~/.chainlink-goerli/tls/server.crt -keyout ~/.chainlink
-subj '/CN=localhost' -extensions EXT -config <( \
printf "[dn]\nCN=localhost\n[req]\ndistinguished_name = dn\n[EXT]\nsubjectAltName=DNS:localhost\nkeyUsage=digitalSignature\nextendedKeyUsage=serverAuth")
```
+
```shell Mainnet
openssl req -x509 -out ~/.chainlink/tls/server.crt -keyout ~/.chainlink/tls/server.key \
-newkey rsa:2048 -nodes -sha256 -days 365 \
@@ -60,6 +63,7 @@ Finally, update your run command to forward port 6689 to the container instead o
```shell Goerli
cd ~/.chainlink-goerli && docker run -p 6689:6689 -v ~/.chainlink-goerli:/chainlink -it --env-file=.env smartcontract/chainlink local n
```
+
```shell Mainnet
cd ~/.chainlink && docker run -p 6689:6689 -v ~/.chainlink:/chainlink -it --env-file=.env smartcontract/chainlink local n
```
diff --git a/docs/chainlink-nodes/evm-performance-configuration.md b/src/pages/chainlink-nodes/evm-performance-configuration.md
similarity index 72%
rename from docs/chainlink-nodes/evm-performance-configuration.md
rename to src/pages/chainlink-nodes/evm-performance-configuration.md
index ef7346010c8..6f31c76ca22 100644
--- a/docs/chainlink-nodes/evm-performance-configuration.md
+++ b/src/pages/chainlink-nodes/evm-performance-configuration.md
@@ -1,40 +1,30 @@
---
-layout: nodes.liquid
+layout: ../../layouts/MainLayout.astro
section: nodeOperator
date: Last Modified
-title: 'Optimizing EVM Performance'
-permalink: 'docs/evm-performance-configuration/'
-whatsnext: {
- "Performing System Maintenance":"/docs/performing-system-maintenance/",
- "Security and Operation Best Practices":"/docs/best-security-practices/"
-}
+title: "Optimizing EVM Performance"
+permalink: "docs/evm-performance-configuration/"
+whatsnext:
+ {
+ "Performing System Maintenance": "/chainlink-nodes/performing-system-maintenance/",
+ "Security and Operation Best Practices": "/chainlink-nodes/best-security-practices/",
+ }
metadata:
- title: 'Optimizing EVM Performance'
- description: 'Configure your Chainlink and EVM nodes for high throughput and reliability'
+ title: "Optimizing EVM Performance"
+ description: "Configure your Chainlink and EVM nodes for high throughput and reliability"
---
The most basic Chainlink node deployment uses the default configuration on only a single primary node with a websocket URL. This configuration is appropriate for small or simple workloads with only a few jobs that execute infrequently. If you need to run hundreds of jobs and thousands of transactions per hour, your Chainlink and RPC nodes will require a more advanced configuration. This guide explains how to configure Chainlink and your EVM nodes for high reliability and throughput.
-> 📘 Note:
->
-> Ethereum clients have bugs. Much work is done on the Chainlink node software to mitigate bugs in various different RPC implementations. This guide helps you understand how to mitigate and work around these bugs.
-
-**Topics**
-
-- [Using multiple nodes](#using-multiple-nodes)
-- [Automatic load balancing and failover](#automatic-load-balancing-and-failover)
-- [Configuring websocket and HTTP URLs](#configuring-websocket-and-http-urls)
-- [Increasing transaction throughput](#increasing-transaction-throughput)
- - [Increase ETH_MAX_QUEUED_TRANSACTIONS](#increase-eth_max_queued_transactions)
- - [Increase ETH_MAX_IN_FLIGHT_TRANSACTIONS](#increasing-transaction-throughput)
-- [Optimizing RPC nodes](#optimizing-rpc-nodes)
-- [Remove rejections on expensive transactions](#remove-rejections-on-expensive-transactions)
-- [Adjusting minimum outgoing confirmations for high throughput jobs](#adjusting-minimum-outgoing-confirmations-for-high-throughput-jobs)
-- [Increase ORM_MAX_OPEN_CONNS and ORM_MAX_IDLE_CONNS](#increase-orm_max_open_conns-and-orm_max_idle_conns)
+:::note[Note on Ethereum clients]
+Ethereum clients have bugs. Much work is done on the Chainlink node software to mitigate bugs in various different RPC implementations. This guide helps you understand how to mitigate and work around these bugs.
+:::
## Using multiple nodes
-> 📘 Providing multiple primary nodes can improve performance and reliability.
+:::note[Use multiple nodes]
+Providing multiple primary nodes can improve performance and reliability.
+:::
Chainlink node version 1.3.0 and later support configurations with multiple primary nodes and send-only nodes with automatic liveness detection and failover. It is no longer necessary to run a load balancing failover RPC proxy between Chainlink and its EVM RPC nodes.
@@ -44,9 +34,11 @@ You can have as many primary nodes as you want. Requests are evenly distributed
You can configure as many send-only nodes as you want. Send-only nodes only broadcast transactions and do not process regular RPC calls. Specifying additional send-only nodes uses a minimum number of RPC calls and can help to include transactions faster. Send-only nodes also act as backup if your primary node starts to blackhole transactions.
-> 📘 Transaction broadcasts are always sent to every primary node and send-only node. It is redundant to specify the same URL for a send-only node as an existing primary node, and it has no effect.
+:::note[Transaction broadcasts]
+Transaction broadcasts are always sent to every primary node and send-only node. It is redundant to specify the same URL for a send-only node as an existing primary node, and it has no effect.
+:::
-Here is an example for how to specifiy the [`EVM_NODES` environment variable](/docs/configuration-variables/#evm_nodes):
+Here is an example for how to specifiy the [`EVM_NODES` environment variable](/chainlink-nodes/configuration-variables/#evm_nodes):
```shell
export EVM_NODES='
@@ -104,9 +96,9 @@ NODE_POLL_FAILURE_THRESHOLD=0
NODE_POLL_INTERVAL=0
```
-- [NODE_NO_NEW_HEADS_THRESHOLD](/docs/configuration-variables/#node_no_new_heads_threshold): Controls how long to wait receiving no new heads before marking a node dead
-- [NODE_POLL_FAILURE_THRESHOLD](/docs/configuration-variables/#node_poll_failure_threshold): Controls how many consecutive poll failures will disable a node
-- [NODE_POLL_INTERVAL](/docs/configuration-variables/#node_poll_interval): Controls how often the node will be polled
+- [NODE_NO_NEW_HEADS_THRESHOLD](/chainlink-nodes/configuration-variables/#node_no_new_heads_threshold): Controls how long to wait receiving no new heads before marking a node dead
+- [NODE_POLL_FAILURE_THRESHOLD](/chainlink-nodes/configuration-variables/#node_poll_failure_threshold): Controls how many consecutive poll failures will disable a node
+- [NODE_POLL_INTERVAL](/chainlink-nodes/configuration-variables/#node_poll_interval): Controls how often the node will be polled
By default, these environment variables use the following values:
@@ -118,15 +110,17 @@ NODE_POLL_INTERVAL="10s"
## Configuring websocket and HTTP URLs
-> 📘 Ideally, every primary node specifies an HTTP URL in addition to the websocket URL.
+:::note[Note on URLs]
+Ideally, every primary node specifies an HTTP URL in addition to the websocket URL.
+:::
-It is not recommended to configure primary nodes with *only* a websocket URL. Routing all traffic over only a websocket can cause problems. As a best practices, every primary node must have both websocket and HTTP URLs specified. This allows Chainlink to route almost all RPC calls over HTTP, which tends to be more robust and reliable. The websocket URL is used only for subscriptions. Both URLs must point to the same node because they are bundled together and have the same liveness state.
+It is not recommended to configure primary nodes with _only_ a websocket URL. Routing all traffic over only a websocket can cause problems. As a best practices, every primary node must have both websocket and HTTP URLs specified. This allows Chainlink to route almost all RPC calls over HTTP, which tends to be more robust and reliable. The websocket URL is used only for subscriptions. Both URLs must point to the same node because they are bundled together and have the same liveness state.
If you enabled HTTP URLs on all your primary nodes, you can increase the values for the following environment variables:
-- [ETH_RPC_DEFAULT_BATCH_SIZE](/docs/configuration-variables/#eth_rpc_default_batch_size)
-- [BLOCK_HISTORY_ESTIMATOR_BATCH_SIZE](/docs/configuration-variables/#block_history_estimator_batch_size)
-- [ETH_LOG_BACKFILL_BATCH_SIZE](/docs/configuration-variables/#eth_log_backfill_batch_size)
+- [ETH_RPC_DEFAULT_BATCH_SIZE](/chainlink-nodes/configuration-variables/#eth_rpc_default_batch_size)
+- [BLOCK_HISTORY_ESTIMATOR_BATCH_SIZE](/chainlink-nodes/configuration-variables/#block_history_estimator_batch_size)
+- [ETH_LOG_BACKFILL_BATCH_SIZE](/chainlink-nodes/configuration-variables/#eth_log_backfill_batch_size)
By default, these config variables are set conservatively to avoid overflowing websocket frames. In HTTP mode, there are no such limitations. You might be able to improve performance with increased values similar to the following example:
@@ -136,17 +130,19 @@ BLOCK_HISTORY_ESTIMATOR_BATCH_SIZE=100
ETH_LOG_BACKFILL_BATCH_SIZE=1000
```
-> 🚧 REMINDER:
->
-> Do not modify these values unless *all* primary nodes are configured with HTTP URLs.
+:::caution
+Do not modify these values unless _all_ primary nodes are configured with HTTP URLs.
+:::
## Increasing transaction throughput
By default, Chainlink has conservative limits because it must be compliant with standard out-of-the-box RPC configurations. This limits transaction throughput and the performance of some RPC calls.
-Before you make any changes to your Chainlink configuration, you must ensure that *all* of your primary and send-only nodes are configured to handle the increased throughput.
+Before you make any changes to your Chainlink configuration, you must ensure that _all_ of your primary and send-only nodes are configured to handle the increased throughput.
-> 📘 The best way to improve transaction throughput is to keep the default configuration and use multiple keys to transmit. Chainlink supports an arbitrary number of keys for any given chain. By default, tasks will round-robin through keys, but you can assign them individually to keys as well. Assigning tasks to keys is the preferred way to improve throughput because increasing the max number of in-flight requests can have complicated effects based on the mempool conmfigurations of other RPC nodes. If you are unable to distribute transmission load across multiple keys, try the following options to increase throughput.
+:::note[Transaction throughput]
+The best way to improve transaction throughput is to keep the default configuration and use multiple keys to transmit. Chainlink supports an arbitrary number of keys for any given chain. By default, tasks will round-robin through keys, but you can assign them individually to keys as well. Assigning tasks to keys is the preferred way to improve throughput because increasing the max number of in-flight requests can have complicated effects based on the mempool conmfigurations of other RPC nodes. If you are unable to distribute transmission load across multiple keys, try the following options to increase throughput.
+:::
### Increase `ETH_MAX_QUEUED_TRANSACTIONS`
@@ -166,7 +162,9 @@ Do not set `ETH_MAX_QUEUED_TRANSACTIONS` too high. It acts as a sanity limit and
The default is set conservatively at `16` because this is a pessimistic minimum that go-ethereum will hold without evicting local transactions. If your node is falling behind and not able to get transactions in as fast as they are created, you can increase this setting.
-> 🚧 If you increase `ETH_MAX_IN_FLIGHT_TRANSACTIONS` you must make sure that your ETH node is configured properly otherwise you can get nonce-gapped and your node will get stuck.
+:::caution
+If you increase `ETH_MAX_IN_FLIGHT_TRANSACTIONS` you must make sure that your ETH node is configured properly otherwise you can get nonce-gapped and your node will get stuck.
+:::
## Optimizing RPC nodes
@@ -208,7 +206,6 @@ Arbitrum Nitro runs a fork of go-ethereum internally, but the original flags are
`--node.rpc.gas-cap 0 --node.rpc.tx-fee-cap 0`
-
## Adjusting minimum outgoing confirmations for high throughput jobs
`ethtx` tasks have a `minConfirmations` label that can be adjusted. You can get a minor performance boost if you set this label to `0`. Use this if you do not need to wait for confirmations on your `ethtx` tasks. For example, if you don't need the receipt or don’t care about failing the task if the transaction reverts on-chain, you can set `minConfirmations` to `0`.
@@ -219,7 +216,9 @@ Set the task label similiarly to the following example:
Note that this only affects the presentation of jobs, and whether they are marked as errored or not. It has no effect on inclusion of the transaction, which is handled with separate logic.
-> 🚧 Do not confuse `minConfirmations` set on the task with transaction inclusion. The transaction manager always attempts to get every transaction mined up to `EVMFinalityDepth`. `minConfirmations` on the task is a task-specific view of when the transaction that can be considered final, which might be fewer blocks than `EVMFinalityDepth`.
+:::caution
+Do not confuse `minConfirmations` set on the task with transaction inclusion. The transaction manager always attempts to get every transaction mined up to `EVMFinalityDepth`. `minConfirmations` on the task is a task-specific view of when the transaction that can be considered final, which might be fewer blocks than `EVMFinalityDepth`.
+:::
## Increase `ORM_MAX_OPEN_CONNS` and `ORM_MAX_IDLE_CONNS`
diff --git a/docs/chainlink-nodes/external-adapters/contract-creators.md b/src/pages/chainlink-nodes/external-adapters/contract-creators.md
similarity index 59%
rename from docs/chainlink-nodes/external-adapters/contract-creators.md
rename to src/pages/chainlink-nodes/external-adapters/contract-creators.md
index 33cd3b8b7bd..6e3fa21030c 100644
--- a/docs/chainlink-nodes/external-adapters/contract-creators.md
+++ b/src/pages/chainlink-nodes/external-adapters/contract-creators.md
@@ -1,20 +1,26 @@
---
-layout: nodes.liquid
+layout: ../../../layouts/MainLayout.astro
section: nodeOperator
date: Last Modified
title: "External Adapters in Solidity"
permalink: "docs/contract-creators/"
-whatsnext: {"Building External Adapters":"/docs/developers/", "Bridges: Adding External Adapters to Nodes":"/docs/node-operators/"}
+whatsnext:
+ {
+ "Building External Adapters": "/chainlink-nodes/external-adapters/developers/",
+ "Bridges: Adding External Adapters to Nodes": "/chainlink-nodes/external-adapters/node-operators/",
+ }
---
+
### Using parameters with an External Adapter
As a contract creator, using an external adapter is no different than creating a request for any other job spec. You will simply need to know which parameters are supported by the adapter. Notice the method below uses `req.add` to create a run parameter for each required value.
-```javascript
+
+```solidity
function requestMWAPrice(string _coin, string _market)
public
onlyOwner
- returns (bytes32 requestId)
+ returns (bytes32 requestId)
{
Chainlink.Request memory req = buildChainlinkRequest(SPEC_ID, this, this.fulfill.selector);
req.add("endpoint", "mwa-historic");
@@ -28,39 +34,42 @@ function requestMWAPrice(string _coin, string _market)
### Using the Copy adapter with an External Adapter
-The [Copy](../core-adapters/#copy) adapter allows for the same functionality of the [JsonParse](../core-adapters/#jsonparse) adapter but for getting data from the external adapter's response.
+The [Copy](/chainlink-nodes/oracle-jobs/v1/adapters/#copy) adapter allows for the same functionality of the [JsonParse](/chainlink-nodes/oracle-jobs/v1/adapters/#jsonparse) adapter but for getting data from the external adapter's response.
For example, if an adapter returns JSON data like what is below:
```json
{
- "firstValue": "SomeValue",
- "details": {
- "close": "100",
- "open": "110",
- "current": "111"
- },
- "other": "GetData"
+ "firstValue": "SomeValue",
+ "details": {
+ "close": "100",
+ "open": "110",
+ "current": "111"
+ },
+ "other": "GetData"
}
```
And you wanted the value in the field "open", you would specify the path for the adapter to walk through the JSON object to your desired field.
+
```json
"copyPath": ["details", "open"]
```
In Solidity, this would look like:
-```javascript
+
+```solidity
string[] memory path = new string[](2);
path[0] = "details";
path[1] = "open";
run.addStringArray("copyPath", path);
```
-Or you can use dot-notation JSONPath to simplify it:
+Or you can use dot-notation JSONPath to simplify it:
-```javascript
-run.add("copyPath", "details.open");
-```
\ No newline at end of file
+
+```solidity
+run.add("copyPath", "details.open")
+```
diff --git a/docs/chainlink-nodes/external-adapters/developers.md b/src/pages/chainlink-nodes/external-adapters/developers.md
similarity index 79%
rename from docs/chainlink-nodes/external-adapters/developers.md
rename to src/pages/chainlink-nodes/external-adapters/developers.md
index e9297030efc..4934ed38aab 100644
--- a/docs/chainlink-nodes/external-adapters/developers.md
+++ b/src/pages/chainlink-nodes/external-adapters/developers.md
@@ -1,16 +1,17 @@
---
-layout: nodes.liquid
+layout: ../../../layouts/MainLayout.astro
section: nodeOperator
date: Last Modified
title: "Building External Adapters"
permalink: "docs/developers/"
-whatsnext: {"Bridges: Adding External Adapters to Nodes":"/docs/node-operators/"}
+whatsnext: { "Bridges: Adding External Adapters to Nodes": "/chainlink-nodes/external-adapters/node-operators/" }
---
+
Developers of external adapters will need to know how the Chainlink node requests data from it, and how the data should be formatted for a response. External adapters can be written in any language, and even run on separate machines, to include serverless functions.
Here is our external adapters monorepo which contains many examples to help get you started:
-* Official Chainlink External Adapter Monorepo (NodeJS)
+- Official Chainlink External Adapter Monorepo (NodeJS)
### Requesting Data
@@ -24,15 +25,22 @@ When an external adapter receives a request from the Chainlink node, the JSON pa
#### Examples
```json
-{"data":{}}
+{ "data": {} }
```
```json
-{"data":{}, "responseURL": "http://localhost:6688/v2/runs/278c97ffadb54a5bbb93cfec5f7b5503"}
+{
+ "data": {},
+ "responseURL": "http://localhost:6688/v2/runs/278c97ffadb54a5bbb93cfec5f7b5503"
+}
```
```json
-{"data":{"foo": 42}, "meta":{"bar": "baz"}, "id": "2d38ecdb-975c-4f99-801c-b916a429947c"}
+{
+ "data": { "foo": 42 },
+ "meta": { "bar": "baz" },
+ "id": "2d38ecdb-975c-4f99-801c-b916a429947c"
+}
```
Additional data may be specified in the spec to be utilized by the adapter. This can be useful for requesting data from a REST endpoint where the keys and values can be specified by the requester. For example, if the REST endpoint supports the following:
@@ -99,7 +107,7 @@ If the external adapter wants to use the response URL to send data later, it may
```json
{
- "pending": true
+ "pending": true
}
```
@@ -107,7 +115,6 @@ In this case, the job run on Chainlink side will be put into a `pending` state,
When the external adapter is ready, it should callback to the node to resume the JobRun using an HTTP PATCH request to the `responseURL` field. This will resume the job on the Chainlink side.
-
```json
{
"data": {
@@ -134,43 +141,43 @@ Or, for the error case:
Here is a complete example of a simple external adapter written as a serverless function. This external adapter takes two input fields, inserts the API key as a header, and returns the resulting payload to the node.
```javascript External Adapter
-let request = require('request');
+let request = require("request")
exports.myExternalAdapter = (req, res) => {
- const url = "https://some-api.example.com/api";
- const coin = req.body.data.coin || "";
- const market = req.body.data.market || "";
+ const url = "https://some-api.example.com/api"
+ const coin = req.body.data.coin || ""
+ const market = req.body.data.market || ""
let requestObj = {
coin: coin,
- market: market
- };
+ market: market,
+ }
let headerObj = {
- "API_KEY": "abcd-efgh-ijkl-mnop-qrst-uvwy"
- };
+ API_KEY: "abcd-efgh-ijkl-mnop-qrst-uvwy",
+ }
let options = {
- url: url,
- headers: headerObj,
- qs: requestObj,
- json: true
- };
+ url: url,
+ headers: headerObj,
+ qs: requestObj,
+ json: true,
+ }
request(options, (error, response, body) => {
if (error || response.statusCode >= 400) {
- let errorData = {
- jobRunID: req.body.id,
- status: "errored",
- error: body
- };
- res.status(response.statusCode).send(errorData);
+ let errorData = {
+ jobRunID: req.body.id,
+ status: "errored",
+ error: body,
+ }
+ res.status(response.statusCode).send(errorData)
} else {
let returnData = {
jobRunID: req.body.id,
- data: body
- };
- res.status(response.statusCode).send(returnData);
+ data: body,
+ }
+ res.status(response.statusCode).send(returnData)
}
- });
-};
+ })
+}
```
If given "ETH" as the value for `coin` and "USD" as the value for `market`, this external adapter will build the following URL for the request:
diff --git a/src/pages/chainlink-nodes/external-adapters/external-adapters.md b/src/pages/chainlink-nodes/external-adapters/external-adapters.md
new file mode 100644
index 00000000000..3cf402c0445
--- /dev/null
+++ b/src/pages/chainlink-nodes/external-adapters/external-adapters.md
@@ -0,0 +1,21 @@
+---
+layout: ../../../layouts/MainLayout.astro
+section: nodeOperator
+date: Last Modified
+title: "External Adapters Introduction"
+permalink: "docs/external-adapters/"
+whatsnext:
+ {
+ "External Adapters in Solidity": "/chainlink-nodes/external-adapters/contract-creators/",
+ "Building External Adapters": "/chainlink-nodes/external-adapters/developers/",
+ "Bridges: Adding External Adapters to Nodes": "/chainlink-nodes/external-adapters/node-operators/",
+ }
+---
+
+External adapters are how Chainlink enables easy integration of custom computations and specialized APIs. External adapters are services which the core of the Chainlink node communicates via its API with a simple JSON specification. If you want a step by step, be sure to check out our [blog post](https://blog.chain.link/build-and-use-external-adapters/).
+
+Information on external adapters is broken up into three main categories: contract creators, developers, and node operators.
+
+- [Contract Creators](/chainlink-nodes/external-adapters/contract-creators/) will need to know how to specify an external adapter in their request for external data.
+- [Developers](/chainlink-nodes/external-adapters/developers/) will need to know how to implement an external adapter for an API.
+- [Node Operators](/chainlink-nodes/external-adapters/node-operators/) will need to know how to add an external adapter to their node so that they can provide specialized services to smart contracts.
diff --git a/docs/chainlink-nodes/external-adapters/node-operators.md b/src/pages/chainlink-nodes/external-adapters/node-operators.md
similarity index 79%
rename from docs/chainlink-nodes/external-adapters/node-operators.md
rename to src/pages/chainlink-nodes/external-adapters/node-operators.md
index 12ebeb023d9..9e64bfc1144 100644
--- a/docs/chainlink-nodes/external-adapters/node-operators.md
+++ b/src/pages/chainlink-nodes/external-adapters/node-operators.md
@@ -1,11 +1,12 @@
---
-layout: nodes.liquid
+layout: ../../../layouts/MainLayout.astro
section: nodeOperator
date: Last Modified
title: "Bridges: Adding External Adapters to Nodes"
permalink: "docs/node-operators/"
---
-You can add external adapters to a Chainlink node by creating a bridge in the Node Operators Interface. Each bridge must have a unique name and a URL for the external adapter. If a job has a [Bridge Task](/docs/jobs/task-types/bridge/), the node searches for a bridge by name and uses that bridge as your external adapter. Bridge names are case insensitive.
+
+You can add external adapters to a Chainlink node by creating a bridge in the Node Operators Interface. Each bridge must have a unique name and a URL for the external adapter. If a job has a [Bridge Task](/chainlink-nodes/oracle-jobs/task-types/task_bridge/), the node searches for a bridge by name and uses that bridge as your external adapter. Bridge names are case insensitive.
To create a bridge on the node, go to the **Create Bridge** tab in the Node Operators Interface. Specify a name for the bridge, the URL for your external adapter, and optionally specify the minimum contract payment and number of confirmations for the bridge. Minimum contract payment is a fee paid in LINK for the Chainlink node making a call to the external adapter via the bridge. This fee is in addition to the fee specified at the global node level for processing job requests.
@@ -13,9 +14,10 @@ To create a bridge on the node, go to the **Create Bridge** tab in the Node Oper
The bridge name must be unique to the local node. The bridge URL is the URL of your external adapter, which can be local or on a separate machine.
-To add jobs that use the bridge, add a [Bridge Task](/docs/jobs/task-types/bridge/) to your job. The `bridge` task defined in the example below is defined as `fetch` and the name of the bridge is `soccer-data`.
+To add jobs that use the bridge, add a [Bridge Task](/chainlink-nodes/oracle-jobs/task-types/task_bridge/) to your job. The `bridge` task defined in the example below is defined as `fetch` and the name of the bridge is `soccer-data`.
-```jpv2
+
+```toml
type = "directrequest"
schemaVersion = 1
name = "Soccer-Data-EA"
@@ -45,19 +47,25 @@ Since `soccer-data` is a bridge task, each node that has this job defined needs
## Testing External Adapters and Bridges
-The easiest way to test if your external adapter is working is to use a [Webhook Job](/docs/jobs/types/webhook/).
+The easiest way to test if your external adapter is working is to use a [Webhook Job](/chainlink-nodes/oracle-jobs/job-types/webhook/).
As an example, assume you have an external adapter named `soccer-data` that is registered in the `bridges` section and it takes one parameter named `playerId`. In solidity, you would pass the parameter with the following request:
+
+
```solidity
request.add("playerId","12345678")
```
+
How can you test the adapter on your node?
-The easiest way is to setup a [Webhook Job](/docs/jobs/types/webhook/) that uses the external adapter, and manually set the parameter.
+The easiest way is to setup a [Webhook Job](/chainlink-nodes/oracle-jobs/job-types/webhook/) that uses the external adapter, and manually set the parameter.
-> Note: You might need to set the [configuration variable](/docs/configuration-variables/) `FEATURE_WEBHOOK_V2=true` in your `.env` file.
+:::note
+You might need to set the [configuration variable](/chainlink-nodes/configuration-variables/) `FEATURE_WEBHOOK_V2=true` in your `.env` file.
+:::
-```jpv2
+
+```toml
type = "webhook"
schemaVersion = 1
name = "Soccer-Data-EA-Web"
@@ -70,11 +78,11 @@ fetch [type=bridge name="soccer-data" requestData="{\\"id\\": \\"0\\", \\
Adding the following into the TOML spec manually sets the parameters passed into the bridge task. It is equivalent to using `request.add` as shown above or adding the data with the `--d` flag if you're using [curl](https://curl.se/).
+
```json
requestData="{\\"id\\": \\"0\\", \\"data\\": { \\"playerId\\": \\"12345678\\"}}"
```
-
There will be a big `Run` button on your job definition, which you can use to kick off the job.
-
\ No newline at end of file
+
diff --git a/docs/chainlink-nodes/external-initiators/building-external-initiators.md b/src/pages/chainlink-nodes/external-initiators/building-external-initiators.md
similarity index 80%
rename from docs/chainlink-nodes/external-initiators/building-external-initiators.md
rename to src/pages/chainlink-nodes/external-initiators/building-external-initiators.md
index 82fde74da27..62110369f18 100644
--- a/docs/chainlink-nodes/external-initiators/building-external-initiators.md
+++ b/src/pages/chainlink-nodes/external-initiators/building-external-initiators.md
@@ -1,10 +1,11 @@
---
-layout: nodes.liquid
+layout: ../../../layouts/MainLayout.astro
section: nodeOperator
date: Last Modified
title: "Building External Initiators"
permalink: "docs/building-external-initiators/"
-whatsnext: {"Adding External Initiators to Nodes":"/docs/external-initiators-in-nodes/"}
+whatsnext:
+ { "Adding External Initiators to Nodes": "/chainlink-nodes/external-initiators/external-initiators-in-nodes/" }
---
An external initiator can trigger a run for any webhook job that it has been linked to.
@@ -22,10 +23,10 @@ You will need to specify two headers:
## JSON jobs (REMOVED)
-> ❗️ v1 Jobs are removed
-> The initiators for v1 Jobs are removed for Chainlink nodes running version 1.0.0 and later. Use [v2 jobs](/docs/jobs) instead.
->
-> See the [v2 jobs migration page](/docs/jobs/migration-v1-v2) to learn how to migrate to v2 jobs.
+:::caution[v1 Jobs are removed]
+The initiators for v1 Jobs are removed for Chainlink nodes running version 1.0.0 and later. Use [v2 job types](/chainlink-nodes/oracle-jobs/jobs) instead.Chainlink external initiator repo for reference. You can see some examples of existing initiators in the blockchain folder.
diff --git a/docs/chainlink-nodes/external-initiators/external-initiators-in-nodes.md b/src/pages/chainlink-nodes/external-initiators/external-initiators-in-nodes.md
similarity index 83%
rename from docs/chainlink-nodes/external-initiators/external-initiators-in-nodes.md
rename to src/pages/chainlink-nodes/external-initiators/external-initiators-in-nodes.md
index 3aaca9d253b..0bfc86f1a29 100644
--- a/docs/chainlink-nodes/external-initiators/external-initiators-in-nodes.md
+++ b/src/pages/chainlink-nodes/external-initiators/external-initiators-in-nodes.md
@@ -1,23 +1,27 @@
---
-layout: nodes.liquid
+layout: ../../../layouts/MainLayout.astro
section: nodeOperator
date: Last Modified
title: "Adding External Initiators to Nodes"
permalink: "docs/external-initiators-in-nodes/"
---
-> 🚧 External initiators are disabled on nodes by default. Set the `FEATURE_EXTERNAL_INITIATORS=true` [configuration variable](/docs/configuration-variables/#feature_external_initiators) to enable this feature.
+:::note
+External initiators are disabled on nodes by default. Set the `FEATURE_EXTERNAL_INITIATORS=true` [configuration variable](/chainlink-nodes/configuration-variables/#feature_external_initiators) to enable this feature.
+:::
## Creating an external initiator
To create an external initiator you must use the remote API. You can do this yourself, like so:
+
```text
POST http:///v2/external_initiators -d
```
where payload is a JSON blob that contains:
+
```json
{
"name": ,
@@ -29,20 +33,23 @@ If a URL is provided, Chainlink will notify this URL of added and deleted jobs t
On creation:
+
```text
POST -d {"jobId": , "type": , "params": }
```
On deletion:
+
```text
DELETE /
```
You can use the chainlink client for convenience to access this API.
-Enter the [Chainlink nodes CLI](/docs/miscellaneous/#execute-commands-running-docker) and run the following command
+Enter the [Chainlink nodes CLI](/chainlink-nodes/miscellaneous/#execute-commands-running-docker) and run the following command
+
```shell
chainlink initiators create
```
@@ -83,7 +90,9 @@ To try a real-life example, feel free to follow along with the Additional external initiator reference
-> 🚧 The External Initiator can only initiate [webhook jobs](/docs/jobs/types/webhook) that have been linked to it. Trying to initiate a job that is not linked will give an unauthorised error.
+:::note
+The External Initiator can only initiate [webhook jobs](/chainlink-nodes/oracle-jobs/job-types/webhook) that have been linked to it. Trying to initiate a job that is not linked will give an unauthorised error.
+:::
## Deleting an external initiator
diff --git a/docs/chainlink-nodes/external-initiators/external-initiators-introduction.md b/src/pages/chainlink-nodes/external-initiators/external-initiators-introduction.md
similarity index 59%
rename from docs/chainlink-nodes/external-initiators/external-initiators-introduction.md
rename to src/pages/chainlink-nodes/external-initiators/external-initiators-introduction.md
index 34f3a82b81f..61bee730620 100644
--- a/docs/chainlink-nodes/external-initiators/external-initiators-introduction.md
+++ b/src/pages/chainlink-nodes/external-initiators/external-initiators-introduction.md
@@ -1,21 +1,29 @@
---
-layout: nodes.liquid
+layout: ../../../layouts/MainLayout.astro
section: nodeOperator
date: Last Modified
title: "Introduction"
permalink: "docs/external-initiators-introduction/"
-whatsnext: {"Building External Initiators":"/docs/building-external-initiators/", "Adding External Initiators to Nodes":"/docs/external-initiators-in-nodes/"}
+whatsnext:
+ {
+ "Building External Initiators": "/chainlink-nodes/external-initiators/building-external-initiators/",
+ "Adding External Initiators to Nodes": "/chainlink-nodes/external-initiators/external-initiators-in-nodes/",
+ }
---
External initiators allow jobs in a node to be initiated depending on some external condition. The ability to create and add external initiators to Chainlink nodes enables blockchain agnostic cross-chain compatibility.
-> 🚧 At this time of writing, external initiators do not show up in the bridges tab. However, they act exactly the same as if they did.
+:::note
+At this time of writing, external initiators do not show up in the bridges tab. However, they act exactly the same as if they did.
+:::
-> 🚧 External initiators are disabled on nodes by default. Set the `FEATURE_EXTERNAL_INITIATORS=true` [configuration variable](/docs/configuration-variables/#feature_external_initiators) to enable this feature.
+:::note
+External initiators are disabled on nodes by default. Set the `FEATURE_EXTERNAL_INITIATORS=true` [configuration variable](/chainlink-nodes/configuration-variables/#feature_external_initiators) to enable this feature.
+:::
Initiator Bridges handle the authentication to and from the External Initiator and where to send the messages. When creating a Bridge two parameters are required:
-Only the [webhook](/docs/jobs/types/webhook/) job type can be initiated using an External Initiator.
+Only the [webhook](/chainlink-nodes/oracle-jobs/job-types/webhook/) job type can be initiated using an External Initiator.
The external initiator must be created before the webhook job, and must be referenced by name (whitelisted) in order for that external initiator to be allowed to trigger the given webhook job.
@@ -23,4 +31,4 @@ When the External Initiator is created it generates two pairs of credentials: Ou
Then, once you've created the name, bridge, and have the correct access keys for the URL, you can proceed to use the external initiator as if it's a regular initiator in future job specs.
-For how to create an external initiator see [adding external initiators to nodes](/docs/external-initiators-in-nodes).
+For how to create an external initiator see [adding external initiators to nodes](/chainlink-nodes/external-initiators/external-initiators-in-nodes).
diff --git a/docs/chainlink-nodes/fulfilling-requests.md b/src/pages/chainlink-nodes/fulfilling-requests.md
similarity index 67%
rename from docs/chainlink-nodes/fulfilling-requests.md
rename to src/pages/chainlink-nodes/fulfilling-requests.md
index 4dcfa3daf04..d0ac113e78b 100644
--- a/docs/chainlink-nodes/fulfilling-requests.md
+++ b/src/pages/chainlink-nodes/fulfilling-requests.md
@@ -1,34 +1,36 @@
---
-layout: nodes.liquid
+layout: ../../layouts/MainLayout.astro
section: nodeOperator
date: Last Modified
-title: 'Fulfilling Requests'
-permalink: 'docs/fulfilling-requests/'
+title: "Fulfilling Requests"
+permalink: "docs/fulfilling-requests/"
whatsnext:
{
- 'Performing System Maintenance': '/docs/performing-system-maintenance/',
- 'v2 Jobs': '/docs/jobs/',
- 'Security and Operation Best Practices': '/docs/best-security-practices/',
+ "Performing System Maintenance": "/chainlink-nodes/performing-system-maintenance/",
+ "v2 Jobs": "/chainlink-nodes/oracle-jobs/jobs/",
+ "Security and Operation Best Practices": "/chainlink-nodes/best-security-practices/",
}
metadata:
- title: 'Chainlink Node Operators: Fulfilling Requests'
- description: 'Deploy your own Oracle contract and add jobs to your node so that it can provide data to smart contracts.'
+ title: "Chainlink Node Operators: Fulfilling Requests"
+ description: "Deploy your own Oracle contract and add jobs to your node so that it can provide data to smart contracts."
+setup: |
+ import CodeSample from "@components/CodeSample/CodeSample.astro"
---
With your own Oracle contract, you can use your own node to fulfill requests. This guide will show you how to deploy your own Oracle contract and add jobs to your node so that it can provide data to smart contracts.
-Chainlink nodes can fulfill requests from open or unauthenticated APIs without the need for [External Adapters](../external-adapters/) as long as you've [added the jobs](#add-a-job-to-the-node) to the node. For these requests, requesters supply the URL to the open API that they want each node to retrieve. The Chainlink node will use [tasks](/docs/tasks/) to fulfill the request.
+Chainlink nodes can fulfill requests from open or unauthenticated APIs without the need for [External Adapters](/chainlink-nodes/external-adapters/external-adapters/) as long as you've [added the jobs](#add-a-job-to-the-node) to the node. For these requests, requesters supply the URL to the open API that they want each node to retrieve. The Chainlink node will use [tasks](/chainlink-nodes/oracle-jobs/task-types/tasks/) to fulfill the request.
-Some APIs require authentication by providing request headers for the operator's API key, which the Chainlink node supports. If you would like to provide access to an API that requires authentication, you must create a job that is specific for that API either using an external adapter or by using the parameters of the [HTTP task](/docs/jobs/task-types/http/).
+Some APIs require authentication by providing request headers for the operator's API key, which the Chainlink node supports. If you would like to provide access to an API that requires authentication, you must create a job that is specific for that API either using an external adapter or by using the parameters of the [HTTP task](/chainlink-nodes/oracle-jobs/task-types/task_http).
## Requirements
Before you begin this guide, complete the following tasks to make sure you have all of the tools that you need:
-- [Set up MetaMask](/docs/deploy-your-first-contract/#install-and-fund-your-metamask-wallet) and [obtain testnet LINK](/docs/acquire-link/).
-- Configure an Ethereum client with an active websocket connection. Either [Run an Ethereum Client](../run-an-ethereum-client/) yourself or use an [External Service](../run-an-ethereum-client/#external-services) that your Chainlink Node can access.
-- [Run a Chainlink Node](../running-a-chainlink-node/) and connect it to a [supported database](../connecting-to-a-remote-database/).
-- Fund the Ethereum address that your Chainlink node uses. You can find the address in the node Operator GUI under the **Keys** tab. The address of the node is the `Regular` type. You can obtain test ETH from several [faucets](../link-token-contracts/).
+- [Set up MetaMask](/getting-started/deploy-your-first-contract/#install-and-fund-your-metamask-wallet) and [obtain testnet LINK](/resources/acquire-link/).
+- Configure an Ethereum client with an active websocket connection. Either [Run an Ethereum Client](/chainlink-nodes/run-an-ethereum-client/) yourself or use an [External Service](/chainlink-nodes/run-an-ethereum-client/#external-services) that your Chainlink Node can access.
+- [Run a Chainlink Node](/chainlink-nodes/running-a-chainlink-node/) and connect it to a [supported database](/chainlink-nodes/connecting-to-a-remote-database/).
+- Fund the Ethereum address that your Chainlink node uses. You can find the address in the node Operator GUI under the **Keys** tab. The address of the node is the `Regular` type. You can obtain test ETH from several [faucets](/resources/link-token-contracts/).
## Address Types
@@ -40,7 +42,7 @@ Your node works with several different types of addresses. Each address type has
## Deploy your own Oracle contract
-1. Go to Remix and [open the `Oracle.sol` smart contract](https://remix.ethereum.org/#url=https://docs.chain.link/samples/NodeOperators/Oracle.sol). The contents of this file will be very minimal.
+1. Go to Remix and [open the `Oracle.sol` smart contract](https://remix.ethereum.org/#url=https://docs.chain.link/samples/ChainlinkNodes/Oracle.sol). The contents of this file will be very minimal.
1. On the **Compile** tab, click the **Compile** button for `Oracle.sol`. Remix automatically selects the compiler version and language from the `pragma` line unless you select a specific version manually.
@@ -48,11 +50,12 @@ Your node works with several different types of addresses. Each address type has
- Select "Injected Provider" as your **Environment**. The Javascript VM environment cannot access your oracle node.
- Select the "Oracle" contract from the **Contract** menu.
- - Copy the [LINK token contract address](/docs/link-token-contracts/) for the network you are using and paste it into the `address_link` field next to the **Deploy** button. Use one of the following network addresses:
+ - Copy the [LINK token contract address](/resources/link-token-contracts/) for the network you are using and paste it into the `address_link` field next to the **Deploy** button. Use one of the following network addresses:
```text Goerli
0x326C977E6efc84E512bB9C30f76E30c160eD06FB
```
+
```text Mainnet
0x514910771AF9Ca656af840dff83E8264EcF986CA
```
@@ -61,11 +64,10 @@ Your node works with several different types of addresses. Each address type has
1. Click **Deploy**. MetaMask prompts you to confirm the transaction.
- > 🚧 MetaMask doesn't pop up?
- >
- > If MetaMask does not prompt you and instead displays the error below, disable "Privacy Mode" in MetaMask. You can do this by clicking on your unique account icon at the top-right, then go to the Settings. Privacy Mode will be a switch near the bottom.
- >
- > Error: **Send transaction failed: Invalid address. If you use an injected provider, please check it is properly unlocked.**
+ :::note[MetaMask doesn't pop up?]
+ If MetaMask does not prompt you and instead displays the error below, disable "Privacy Mode" in MetaMask. You can do this by clicking on your unique account icon at the top-right, then go to the Settings. Privacy Mode will be a switch near the bottom.). If a task needs data produced by another task, this must be specified using DOT.
To facilitate explicitness, v2 jobs require the author to specify inputs to tasks using `$(variable)` syntax. For example, if an `http` task feeds data into a `jsonparse` task, it must be specified like the following example:
-```jpv2
+```toml
fetch [type="http" method=GET url="http://chain.link/price_feeds/ethusd"]
// This task consumes the output of the 'fetch' task in its 'data' parameter
@@ -40,7 +40,7 @@ fetch -> parse
Task names must be defined before their opening `[` bracket. In this example, the name of the task is `fetch`. The output of each task is stored in the variable corresponding to the name of the task. In some cases, tasks return complex values like maps or arrays. By using dot access syntax, you can access the elements of these values. For example:
-```jpv2
+```toml
// Assume that this task returns the following object:
// { "ethusd": 123.45, "btcusd": 678.90 }
parse [type="jsonparse" path="data" data="$(fetch)"]
@@ -57,14 +57,13 @@ parse -> submit_btcusd
Some tasks, like the `bridge` tasks above, require you to specify a JSON object. Because the keys of JSON objects must be enclosed in double quotes, you must use the alternative `<` angle bracket `>` quotes. Angle brackets also enable multi-line strings, which can be useful when a JSON object parameter is large:
-```jpv2
+```toml
submit_btcusd [type="bridge"
name="btcusd"
requestData="{\\"data\\":{\\"value\\": $(foo), \\"price\\": $(bar), \\"timestamp\\": $(baz)}}"
]
```
-
### Misc. notes
- Each job type provides a particular set of variables to its pipeline. See the documentation for each job type to understand which variables are provided.
@@ -109,12 +108,13 @@ This spec relies on CBOR-encoded on-chain values for the `httpget` URL and `json
```
Notes:
+
- In v1, the job ID is randomly generated at creation time. In v2 jobs, the job ID can be manually specified or the Chainlink node will automatically generate it.
-- In v2, the `ethbytes32` task and all of the other ABI encoding tasks are now encapsulated in the `ethabiencode` task with much more flexibility. See the [ETH ABI Encode task](/docs/jobs/task-types/eth-abi-encode/) page to learn more.
+- In v2, the `ethbytes32` task and all of the other ABI encoding tasks are now encapsulated in the `ethabiencode` task with much more flexibility. See the [ETH ABI Encode task](/chainlink-nodes/oracle-jobs/task-types/task_eth_abi_encode/) page to learn more.
**Equivalent v2 spec:**
-```jpv2
+```toml
type = "directrequest"
schemaVersion = 1
name = "Get > Bytes32"
@@ -165,9 +165,7 @@ observationSource = """
{
"type": "JSONParse",
"params": {
- "path": [
- "last"
- ]
+ "path": ["last"]
}
},
{
@@ -191,7 +189,7 @@ observationSource = """
**Equivalent v2 spec:**
-```jpv2
+```toml
type = "directrequest"
schemaVersion = 1
name = "Get > Bytes32"
@@ -242,10 +240,7 @@ observationSource = """
{
"type": "JsonParse",
"params": {
- "path": [
- "data",
- "price"
- ]
+ "path": ["data", "price"]
}
},
{
@@ -266,7 +261,7 @@ observationSource = """
**Equivalent v2 spec:**
-```jpv2
+```toml
type = "cron"
schemaVersion = 1
schedule = "CRON_TZ=UTC * */20 * * * *"
@@ -312,7 +307,7 @@ observationSource = """
**Equivalent v2 spec:**
-```jpv2
+```toml
type = "webhook"
schemaVersion = 1
# Optional externalJobID: Automatically generated if unspecified
diff --git a/docs/chainlink-nodes/oracle-jobs/task-types/pipelines.md b/src/pages/chainlink-nodes/oracle-jobs/task-types/pipelines.md
similarity index 94%
rename from docs/chainlink-nodes/oracle-jobs/task-types/pipelines.md
rename to src/pages/chainlink-nodes/oracle-jobs/task-types/pipelines.md
index 981e1773eef..d35ca87fb72 100644
--- a/docs/chainlink-nodes/oracle-jobs/task-types/pipelines.md
+++ b/src/pages/chainlink-nodes/oracle-jobs/task-types/pipelines.md
@@ -1,5 +1,5 @@
---
-layout: nodes.liquid
+layout: ../../../../layouts/MainLayout.astro
section: nodeOperator
date: Last Modified
title: "Job Pipelines"
@@ -12,13 +12,13 @@ Pipelines are composed of tasks arranged in a DAG (directed acyclic graph). Pipe
Each node in the graph is a task with a user-specified ID and a set of configuration parameters and attributes:
-```jpv2
+```toml
my_fetch_task [type="http" method=GET url="https://chain.link/eth_usd"]
```
The edges between tasks define how data flows from one task to the next. Some tasks can have multiple inputs, such as `median`. Other tasks are limited to 0 (`http`) or 1 (`jsonparse`).
-```jpv2
+```toml
data_source_1 [type="http" method=GET url="https://chain.link/eth_usd"]
data_source_2 [type="http" method=GET url="https://coingecko.com/eth_usd"]
medianize_data [type="median"]
diff --git a/docs/chainlink-nodes/oracle-jobs/task-types/task_any.md b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_any.md
similarity index 91%
rename from docs/chainlink-nodes/oracle-jobs/task-types/task_any.md
rename to src/pages/chainlink-nodes/oracle-jobs/task-types/task_any.md
index b392ba045cc..4eb9c89e5f0 100644
--- a/docs/chainlink-nodes/oracle-jobs/task-types/task_any.md
+++ b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_any.md
@@ -1,5 +1,5 @@
---
-layout: nodes.liquid
+layout: ../../../../layouts/MainLayout.astro
section: nodeOperator
date: Last Modified
title: "'Any' Task"
@@ -22,7 +22,7 @@ A randomly-selected value from the set of inputs.
**Example**
-```jpv2
+```toml
fetch1 [type="http" ...]
fetch2 [type="http" ...]
fetch3 [type="http" ...]
@@ -34,4 +34,3 @@ fetch3 -> pick_any
```
`pick_any` will return either the result of `fetch1`, `fetch2`, or `fetch3`.
-
diff --git a/docs/chainlink-nodes/oracle-jobs/task-types/task_base64decode.md b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_base64decode.md
similarity index 89%
rename from docs/chainlink-nodes/oracle-jobs/task-types/task_base64decode.md
rename to src/pages/chainlink-nodes/oracle-jobs/task-types/task_base64decode.md
index 32221295ca3..1add3a6e34f 100644
--- a/docs/chainlink-nodes/oracle-jobs/task-types/task_base64decode.md
+++ b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_base64decode.md
@@ -1,5 +1,5 @@
---
-layout: nodes.liquid
+layout: ../../../../layouts/MainLayout.astro
section: nodeOperator
date: Last Modified
title: "Base64 Decode Task"
@@ -18,7 +18,7 @@ Decoded bytes.
**Example**
-```jpv2
+```toml
my_base64decode_task [type="base64decode" input="SGVsbG8sIHBsYXlncm91bmQ="]
```
diff --git a/docs/chainlink-nodes/oracle-jobs/task-types/task_base64encode.md b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_base64encode.md
similarity index 89%
rename from docs/chainlink-nodes/oracle-jobs/task-types/task_base64encode.md
rename to src/pages/chainlink-nodes/oracle-jobs/task-types/task_base64encode.md
index 57da8899391..d7ab32a3b4d 100644
--- a/docs/chainlink-nodes/oracle-jobs/task-types/task_base64encode.md
+++ b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_base64encode.md
@@ -1,5 +1,5 @@
---
-layout: nodes.liquid
+layout: ../../../../layouts/MainLayout.astro
section: nodeOperator
date: Last Modified
title: "Base64 Encode Task"
@@ -18,7 +18,7 @@ String with Base64 encoding of input.
**Example**
-```jpv2
+```toml
my_base64encode_task [type="base64encode" input="Hello, playground"]
```
diff --git a/docs/chainlink-nodes/oracle-jobs/task-types/task_bridge.md b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_bridge.md
similarity index 83%
rename from docs/chainlink-nodes/oracle-jobs/task-types/task_bridge.md
rename to src/pages/chainlink-nodes/oracle-jobs/task-types/task_bridge.md
index 192fcd98091..ae77879bbdf 100644
--- a/docs/chainlink-nodes/oracle-jobs/task-types/task_bridge.md
+++ b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_bridge.md
@@ -1,19 +1,19 @@
---
-layout: nodes.liquid
+layout: ../../../../layouts/MainLayout.astro
section: nodeOperator
date: Last Modified
title: "Bridge Task"
permalink: "docs/jobs/task-types/bridge/"
---
-Bridge tasks make HTTP POST requests to pre-configured URLs. Bridges can be configured via the UI or the CLI, and are referred to by a simple user-specified name. This is the way that most jobs interact with [External Adapters](/docs/external-adapters/).
+Bridge tasks make HTTP POST requests to pre-configured URLs. Bridges can be configured via the UI or the CLI, and are referred to by a simple user-specified name. This is the way that most jobs interact with [External Adapters](/chainlink-nodes/external-adapters/external-adapters/).
**Parameters**
- `name`: an arbitrary name given to the bridge by the node operator.
- `requestData` (optional): a statically-defined payload to be sent to the external adapter.
- `async` (optional): a boolean indicating whether the task should hibernate and wait for the Bridge to make an HTTP request back to the node at a later time with the result.
-- `cacheTTL` (optional): a duration-formatted string indicating the maximum acceptable staleness for cached bridge responses in case of intermittent failures. This is disabled by default.
+- `cacheTTL` (optional): a duration-formatted string indicating the maximum acceptable staleness for cached bridge responses in case of intermittent failures. This is disabled by default.
**Outputs**
@@ -21,7 +21,7 @@ A string containing the response body.
**Example**
-```jpv2
+```toml
my_bridge_task [type="bridge"
name="some_bridge"
requestData="{\\"data\\":{\\"foo\\": $(foo), \\"bar\\": $(bar)}}"
diff --git a/docs/chainlink-nodes/oracle-jobs/task-types/task_cborparse.md b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_cborparse.md
similarity index 88%
rename from docs/chainlink-nodes/oracle-jobs/task-types/task_cborparse.md
rename to src/pages/chainlink-nodes/oracle-jobs/task-types/task_cborparse.md
index 05b133ab10d..cc3c68c9757 100644
--- a/docs/chainlink-nodes/oracle-jobs/task-types/task_cborparse.md
+++ b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_cborparse.md
@@ -1,5 +1,5 @@
---
-layout: nodes.liquid
+layout: ../../../../layouts/MainLayout.astro
section: nodeOperator
date: Last Modified
title: "CBOR Parse Task"
@@ -19,7 +19,7 @@ A map containing the request parameters. Parameters can be individually accessed
**Example**
-```jpv2
+```toml
// First, we parse the request log and the CBOR payload inside of it
decode_log [type="ethabidecodelog"
data="$(jobRun.logData)"
@@ -36,4 +36,4 @@ parse [type="jsonparse" path="$(decode_cbor.jsonPath)" data="$(fetch)"]
// ... etc ...
```
-See the [Direct Request page](/docs/jobs/types/direct-request/) for a more comprehensive example.
+See the [Direct Request page](/chainlink-nodes/oracle-jobs/job-types/direct_request) for a more comprehensive example.
diff --git a/docs/chainlink-nodes/oracle-jobs/task-types/task_divide.md b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_divide.md
similarity index 70%
rename from docs/chainlink-nodes/oracle-jobs/task-types/task_divide.md
rename to src/pages/chainlink-nodes/oracle-jobs/task-types/task_divide.md
index cd65d2246aa..d7fcfbe892f 100644
--- a/docs/chainlink-nodes/oracle-jobs/task-types/task_divide.md
+++ b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_divide.md
@@ -1,5 +1,5 @@
---
-layout: nodes.liquid
+layout: ../../../../layouts/MainLayout.astro
section: nodeOperator
date: Last Modified
title: "Divide Task"
@@ -11,20 +11,20 @@ Divides the provided `input` by the `divisor` and returns the result with a numb
**Parameters**
- `input`: The value to be divided
- - number
- - stringified number
- - bytes-ified number
- - `$(variable)`
+ - number
+ - stringified number
+ - bytes-ified number
+ - `$(variable)`
- `divisor`: The value by which to divide the `input`
- - number
- - stringified number
- - bytes-ified number
- - `$(variable)`
+ - number
+ - stringified number
+ - bytes-ified number
+ - `$(variable)`
- `precision`: The number of decimal places to retain in the result
- - number
- - stringified number
- - bytes-ified number
- - `$(variable)`
+ - number
+ - stringified number
+ - bytes-ified number
+ - `$(variable)`
**Outputs**
@@ -32,7 +32,7 @@ The result of the division.
**Example**
-```jpv2
+```toml
my_divide_task [type="divide"
input="$(json_parse_result)"
divisor="3"
diff --git a/docs/chainlink-nodes/oracle-jobs/task-types/task_eth_abi_decode.md b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_eth_abi_decode.md
similarity index 72%
rename from docs/chainlink-nodes/oracle-jobs/task-types/task_eth_abi_decode.md
rename to src/pages/chainlink-nodes/oracle-jobs/task-types/task_eth_abi_decode.md
index 7f22c72469b..1c1b56a31a3 100644
--- a/docs/chainlink-nodes/oracle-jobs/task-types/task_eth_abi_decode.md
+++ b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_eth_abi_decode.md
@@ -1,21 +1,21 @@
---
-layout: nodes.liquid
+layout: ../../../../layouts/MainLayout.astro
section: nodeOperator
date: Last Modified
title: "ETH ABI Decode Task"
permalink: "docs/jobs/task-types/eth-abi-decode/"
---
-Decodes a ETH ABI-encoded payload, typically the result of an [ETH Call task](/docs/jobs/task-types/eth-call/).
+Decodes a ETH ABI-encoded payload, typically the result of an [ETH Call task](/chainlink-nodes/oracle-jobs/task-types/task_eth_call/).
**Parameters**
- `abi`: a canonical ETH ABI argument string. Should be formatted exactly as in Solidity. Each argument must be named. Examples:
- - `uint256 foo, bytes32 bar, address[] baz`
- - `address a, uint80[3][] u, bytes b, bytes32 b32`
+ - `uint256 foo, bytes32 bar, address[] baz`
+ - `address a, uint80[3][] u, bytes b, bytes32 b32`
- `data`: the ABI-encoded payload to decode. Can be:
- - a byte array
- - a hex-encoded string beginning with `0x`
+ - a byte array
+ - a hex-encoded string beginning with `0x`
**Outputs**
@@ -23,7 +23,8 @@ A map containing the decoded values.
**Example**
-```jpv2
+
+```toml
decode [type="ethabidecode"
abi="bytes32 requestID, uint256 price, address[] oracles"
data="$(eth_call_result)"]
@@ -31,6 +32,7 @@ decode [type="ethabidecode"
This task will return a map with the following schema:
+
```json
{
"requestID": ..., // [32]byte value
diff --git a/docs/chainlink-nodes/oracle-jobs/task-types/task_eth_abi_decode_log.md b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_eth_abi_decode_log.md
similarity index 55%
rename from docs/chainlink-nodes/oracle-jobs/task-types/task_eth_abi_decode_log.md
rename to src/pages/chainlink-nodes/oracle-jobs/task-types/task_eth_abi_decode_log.md
index 7035dd338c8..0a90a34574a 100644
--- a/docs/chainlink-nodes/oracle-jobs/task-types/task_eth_abi_decode_log.md
+++ b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_eth_abi_decode_log.md
@@ -1,5 +1,5 @@
---
-layout: nodes.liquid
+layout: ../../../../layouts/MainLayout.astro
section: nodeOperator
date: Last Modified
title: "ETH ABI Decode Log Task"
@@ -11,16 +11,16 @@ Decodes a log emitted by an ETH contract.
**Parameters**
- `abi`: a canonical ETH log event definition. Should be formatted exactly as in Solidity. Each argument must be named. Examples:
- - `NewRound(uint256 indexed roundId, address indexed startedBy, uint256 startedAt)`
- - `AuthorizedSendersChanged(address[] senders)`
+ - `NewRound(uint256 indexed roundId, address indexed startedBy, uint256 startedAt)`
+ - `AuthorizedSendersChanged(address[] senders)`
- `data`: the ABI-encoded log data. Can be:
- - a byte array
- - a hex-encoded string beginning with `0x`
- - ... but generally should just be set to `$(jobRun.logData)` (see the [Direct Request page](/docs/jobs/types/direct-request/))
+ - a byte array
+ - a hex-encoded string beginning with `0x`
+ - ... but generally should just be set to `$(jobRun.logData)` (see the [Direct Request page](/chainlink-nodes/oracle-jobs/job-types/direct_request))
- `topics`: the ABI-encoded log topics (i.e., the `indexed` parameters)
- - an array of bytes32 values
- - an array of hex-encoded bytes32 values beginning with `0x`
- - ... but generally should just be set to `$(jobRun.logTopics)` (see the [Direct Request page](/docs/jobs/types/direct-request/))
+ - an array of bytes32 values
+ - an array of hex-encoded bytes32 values beginning with `0x`
+ - ... but generally should just be set to `$(jobRun.logTopics)` (see the [Direct Request page](/chainlink-nodes/oracle-jobs/job-types/direct_request))
**Outputs**
@@ -28,7 +28,8 @@ A map containing the decoded values.
**Example**
-```jpv2
+
+```toml
decode [type="ethabidecodelog"
abi="NewRound(uint256 indexed roundId, address indexed startedBy, uint256 startedAt)"
data="$(jobRun.logData)"
@@ -37,6 +38,7 @@ decode [type="ethabidecodelog"
This task will return a map with the following schema:
+
```json
{
"roundId": ..., // a number
diff --git a/docs/chainlink-nodes/oracle-jobs/task-types/task_eth_abi_encode.md b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_eth_abi_encode.md
similarity index 70%
rename from docs/chainlink-nodes/oracle-jobs/task-types/task_eth_abi_encode.md
rename to src/pages/chainlink-nodes/oracle-jobs/task-types/task_eth_abi_encode.md
index ee98e94a4e1..80d04cb9d22 100644
--- a/docs/chainlink-nodes/oracle-jobs/task-types/task_eth_abi_encode.md
+++ b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_eth_abi_encode.md
@@ -1,18 +1,18 @@
---
-layout: nodes.liquid
+layout: ../../../../layouts/MainLayout.astro
section: nodeOperator
date: Last Modified
title: "ETH ABI Encode Task"
permalink: "docs/jobs/task-types/eth-abi-encode/"
---
-Encodes a bytes payload according to ETH ABI encoding, typically in order to perform an [ETH Call](/docs/jobs/task-types/eth-call/) or an [ETH Tx](/docs/jobs/task-types/eth-tx/).
+Encodes a bytes payload according to ETH ABI encoding, typically in order to perform an [ETH Call](/chainlink-nodes/oracle-jobs/task-types/task_eth_call/) or an [ETH Tx](/chainlink-nodes/oracle-jobs/task-types/task_eth_tx/).
**Parameters**
- `abi`: a canonical ETH ABI argument string. Should be formatted exactly as in Solidity. Each argument must be named. If a method name is provided, the 4-byte method signature is prepended to the result. Examples:
- - `uint256 foo, bytes32 bar, address[] baz`
- - `fulfillRequest(bytes32 requestID, uint256 answer)`
+ - `uint256 foo, bytes32 bar, address[] baz`
+ - `fulfillRequest(bytes32 requestID, uint256 answer)`
- `data`: a map of the values to be encoded. The task will make a best effort at converting values to the appropriate types.
**Outputs**
@@ -21,7 +21,7 @@ A byte array.
**Example**
-```jpv2
+```toml
encode [type="ethabiencode"
abi="fulfillRequest(bytes32 requestID, uint256 answer)"
data="{\\"requestID\\": $(foo), \\"answer\\": $(bar)}"
diff --git a/docs/chainlink-nodes/oracle-jobs/task-types/task_eth_call.md b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_eth_call.md
similarity index 96%
rename from docs/chainlink-nodes/oracle-jobs/task-types/task_eth_call.md
rename to src/pages/chainlink-nodes/oracle-jobs/task-types/task_eth_call.md
index d4bb997f9e2..abe7d64a262 100644
--- a/docs/chainlink-nodes/oracle-jobs/task-types/task_eth_call.md
+++ b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_eth_call.md
@@ -1,5 +1,5 @@
---
-layout: nodes.liquid
+layout: ../../../../layouts/MainLayout.astro
section: nodeOperator
date: Last Modified
title: "ETH Call Task"
@@ -25,7 +25,7 @@ An ABI-encoded byte array containing the return value of the contract function.
**Example**
-```jpv2
+```toml
encode_call [type="ethabiencode"
abi="checkUpkeep(bytes data)"
data="{ \\"data\\": $(upkeep_data) }"]
diff --git a/docs/chainlink-nodes/oracle-jobs/task-types/task_eth_tx.md b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_eth_tx.md
similarity index 97%
rename from docs/chainlink-nodes/oracle-jobs/task-types/task_eth_tx.md
rename to src/pages/chainlink-nodes/oracle-jobs/task-types/task_eth_tx.md
index 5f321463b93..2916bf9a70d 100644
--- a/docs/chainlink-nodes/oracle-jobs/task-types/task_eth_tx.md
+++ b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_eth_tx.md
@@ -1,5 +1,5 @@
---
-layout: nodes.liquid
+layout: ../../../../layouts/MainLayout.astro
section: nodeOperator
date: Last Modified
title: "ETH Tx Task"
@@ -24,7 +24,7 @@ The hash of the transaction attempt that eventually succeeds (after potentially
**Example**
-```jpv2
+```toml
encode_tx [type="ethabiencode"
abi="performUpkeep(bytes performData)"
data="{ \\"data\\": $(upkeep_data) }"]
diff --git a/docs/chainlink-nodes/oracle-jobs/task-types/task_hexdecode.md b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_hexdecode.md
similarity index 89%
rename from docs/chainlink-nodes/oracle-jobs/task-types/task_hexdecode.md
rename to src/pages/chainlink-nodes/oracle-jobs/task-types/task_hexdecode.md
index b403821fb9f..85440071fd1 100644
--- a/docs/chainlink-nodes/oracle-jobs/task-types/task_hexdecode.md
+++ b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_hexdecode.md
@@ -1,5 +1,5 @@
---
-layout: nodes.liquid
+layout: ../../../../layouts/MainLayout.astro
section: nodeOperator
date: Last Modified
title: "Hex Decode Task"
@@ -18,7 +18,7 @@ Decoded bytes.
**Example**
-```jpv2
+```toml
my_hexdecode_task [type="hexdecode" input="0x12345678"]
```
diff --git a/docs/chainlink-nodes/oracle-jobs/task-types/task_hexencode.md b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_hexencode.md
similarity index 90%
rename from docs/chainlink-nodes/oracle-jobs/task-types/task_hexencode.md
rename to src/pages/chainlink-nodes/oracle-jobs/task-types/task_hexencode.md
index afabe2ed7b8..8d17656cd94 100644
--- a/docs/chainlink-nodes/oracle-jobs/task-types/task_hexencode.md
+++ b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_hexencode.md
@@ -1,5 +1,5 @@
---
-layout: nodes.liquid
+layout: ../../../../layouts/MainLayout.astro
section: nodeOperator
date: Last Modified
title: "Hex Encode Task"
@@ -18,7 +18,7 @@ Hexadecimal string prefixed with "0x" (or empty string if input was empty).
**Example**
-```jpv2
+```toml
my_hexencode_task [type="hexencode" input="xyz"]
```
diff --git a/docs/chainlink-nodes/oracle-jobs/task-types/task_http.md b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_http.md
similarity index 95%
rename from docs/chainlink-nodes/oracle-jobs/task-types/task_http.md
rename to src/pages/chainlink-nodes/oracle-jobs/task-types/task_http.md
index ea3d39e3f64..f99da0aeac0 100644
--- a/docs/chainlink-nodes/oracle-jobs/task-types/task_http.md
+++ b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_http.md
@@ -1,5 +1,5 @@
---
-layout: nodes.liquid
+layout: ../../../../layouts/MainLayout.astro
section: nodeOperator
date: Last Modified
title: "HTTP Task"
@@ -22,7 +22,7 @@ A string containing the response body.
**Example**
-```jpv2
+```toml
my_http_task [type="http"
method=PUT
url="http://chain.link"
diff --git a/docs/chainlink-nodes/oracle-jobs/task-types/task_jsonparse.md b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_jsonparse.md
similarity index 86%
rename from docs/chainlink-nodes/oracle-jobs/task-types/task_jsonparse.md
rename to src/pages/chainlink-nodes/oracle-jobs/task-types/task_jsonparse.md
index bfdf520be86..34b0c681e00 100644
--- a/docs/chainlink-nodes/oracle-jobs/task-types/task_jsonparse.md
+++ b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_jsonparse.md
@@ -1,5 +1,5 @@
---
-layout: nodes.liquid
+layout: ../../../../layouts/MainLayout.astro
section: nodeOperator
date: Last Modified
title: "JSON Parse Task"
@@ -11,8 +11,8 @@ JSON Parse tasks parse a JSON payload and extract a value at a given keypath.
**Parameters**
- `data`: the JSON string. Can be:
- - string
- - byte array
+ - string
+ - byte array
- `path`: the keypath to extract. Must be a comma-delimited list of keys, or specify a custom `separator` alternative.
- `separator`: (optional) custom `path` key separator. Defaults to comma (`,`).
- `lax` (optional): if false (or omitted), and the keypath doesn't exist, the task will error. If true, the task will return `nil` to the next task.
@@ -23,7 +23,7 @@ The value at the provided keypath.
**Example**
-```jpv2
+```toml
my_json_task [type="jsonparse"
data="$(http_fetch_result)"
path="data,0,price"]
@@ -33,9 +33,6 @@ This task returns `123.45` (float64) when given the following example `data` val
```json
{
- "data": [
- {"price": 123.45},
- {"price": 678.90},
- ]
+ "data": [{ "price": 123.45 }, { "price": 678.9 }]
}
```
diff --git a/docs/chainlink-nodes/oracle-jobs/task-types/task_length.md b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_length.md
similarity index 91%
rename from docs/chainlink-nodes/oracle-jobs/task-types/task_length.md
rename to src/pages/chainlink-nodes/oracle-jobs/task-types/task_length.md
index a3bb7a08dd6..a1d68fc1bfb 100644
--- a/docs/chainlink-nodes/oracle-jobs/task-types/task_length.md
+++ b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_length.md
@@ -1,5 +1,5 @@
---
-layout: nodes.liquid
+layout: ../../../../layouts/MainLayout.astro
section: nodeOperator
date: Last Modified
title: "Length Task"
@@ -20,7 +20,7 @@ The length of the byte array or string.
**Example**
-```jpv2
+```toml
my_length_task [type="length" input="xyz"]
```
diff --git a/docs/chainlink-nodes/oracle-jobs/task-types/task_lessthan.md b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_lessthan.md
similarity index 63%
rename from docs/chainlink-nodes/oracle-jobs/task-types/task_lessthan.md
rename to src/pages/chainlink-nodes/oracle-jobs/task-types/task_lessthan.md
index 681633428ba..9c1bee4744c 100644
--- a/docs/chainlink-nodes/oracle-jobs/task-types/task_lessthan.md
+++ b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_lessthan.md
@@ -1,25 +1,25 @@
---
-layout: nodes.liquid
+layout: ../../../../layouts/MainLayout.astro
section: nodeOperator
date: Last Modified
title: "Less Than Task"
permalink: "docs/jobs/task-types/lessthan/"
---
-Returns a boolean, result of computing `left` < `right`.
+Returns a boolean, result of computing `left < right`.
**Parameters**
- `left`: the left hand side of comparison. Possible values:
- - number
- - stringified number
- - bytes-ified number
- - `$(variable)`
+ - number
+ - stringified number
+ - bytes-ified number
+ - `$(variable)`
- `right`: the right hand side of comparison. Possible values:
- - number
- - stringified number
- - bytes-ified number
- - `$(variable)`
+ - number
+ - stringified number
+ - bytes-ified number
+ - `$(variable)`
**Outputs**
@@ -27,7 +27,7 @@ The result of less than comparison.
**Example**
-```jpv2
+```toml
my_lessthan_task [type="lessthan" left="3" right="10"]
```
diff --git a/docs/chainlink-nodes/oracle-jobs/task-types/task_lowercase.md b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_lowercase.md
similarity index 87%
rename from docs/chainlink-nodes/oracle-jobs/task-types/task_lowercase.md
rename to src/pages/chainlink-nodes/oracle-jobs/task-types/task_lowercase.md
index 00e383c326b..f5df22c6cab 100644
--- a/docs/chainlink-nodes/oracle-jobs/task-types/task_lowercase.md
+++ b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_lowercase.md
@@ -1,5 +1,5 @@
---
-layout: nodes.liquid
+layout: ../../../../layouts/MainLayout.astro
section: nodeOperator
date: Last Modified
title: "Lowercase Task"
@@ -18,7 +18,7 @@ Lowercase string.
**Example**
-```jpv2
+```toml
my_lowercase_task [type="lowercase" input="Hello World!"]
```
diff --git a/docs/chainlink-nodes/oracle-jobs/task-types/task_mean.md b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_mean.md
similarity index 93%
rename from docs/chainlink-nodes/oracle-jobs/task-types/task_mean.md
rename to src/pages/chainlink-nodes/oracle-jobs/task-types/task_mean.md
index 0b4e6ed77bc..56805197f15 100644
--- a/docs/chainlink-nodes/oracle-jobs/task-types/task_mean.md
+++ b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_mean.md
@@ -1,5 +1,5 @@
---
-layout: nodes.liquid
+layout: ../../../../layouts/MainLayout.astro
section: nodeOperator
date: Last Modified
title: "Mean Task"
@@ -20,7 +20,7 @@ The average of the values in the `values` array.
**Example**
-```jpv2
+```toml
my_mean_task [type="mean"
values=<[ $(fetch1), $(fetch2), $(fetch3) ]>
precision=2
diff --git a/docs/chainlink-nodes/oracle-jobs/task-types/task_median.md b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_median.md
similarity index 93%
rename from docs/chainlink-nodes/oracle-jobs/task-types/task_median.md
rename to src/pages/chainlink-nodes/oracle-jobs/task-types/task_median.md
index 8d55750cf3f..702c29945c7 100644
--- a/docs/chainlink-nodes/oracle-jobs/task-types/task_median.md
+++ b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_median.md
@@ -1,5 +1,5 @@
---
-layout: nodes.liquid
+layout: ../../../../layouts/MainLayout.astro
section: nodeOperator
date: Last Modified
title: "Median Task"
@@ -19,7 +19,7 @@ The median of the values in the `values` array.
**Example**
-```jpv2
+```toml
my_median_task [type="median"
values=<[ $(fetch1), $(fetch2), $(fetch3) ]>
allowedFaults=1]
diff --git a/docs/chainlink-nodes/oracle-jobs/task-types/task_mode.md b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_mode.md
similarity index 85%
rename from docs/chainlink-nodes/oracle-jobs/task-types/task_mode.md
rename to src/pages/chainlink-nodes/oracle-jobs/task-types/task_mode.md
index 6cea4ca76f7..7155d4b6ebd 100644
--- a/docs/chainlink-nodes/oracle-jobs/task-types/task_mode.md
+++ b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_mode.md
@@ -1,9 +1,9 @@
---
-layout: nodes.liquid
+layout: ../../../../layouts/MainLayout.astro
section: nodeOperator
date: Last Modified
-title: 'Mode Task'
-permalink: 'docs/jobs/task-types/mode/'
+title: "Mode Task"
+permalink: "docs/jobs/task-types/mode/"
---
Accepts multiple numerical inputs and returns the mode (most common) of them. If more than one value occur the maximum number of times, it returns all of them.
@@ -17,6 +17,7 @@ Accepts multiple numerical inputs and returns the mode (most common) of them. If
A map containing two keys:
+
```json
{
"results": [ ... ], // An array containing all of the values that occurred the maximum number of times
@@ -26,7 +27,8 @@ A map containing two keys:
**Example**
-```jpv2
+
+```toml
my_mode_task [type="mode"
values=<[ $(fetch1), $(fetch2), $(fetch3), $(fetch4), $(fetch5), $(fetch6), $(fetch7), $(fetch8) ]>
allowedFaults=3]
@@ -34,6 +36,7 @@ my_mode_task [type="mode"
Given a `values` array containing `[ 2, 5, 2, "foo", "foo" "bar", "foo", 2 ]`, the task will return:
+
```json
{
"results": [2, "foo"],
diff --git a/docs/chainlink-nodes/oracle-jobs/task-types/task_multiply.md b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_multiply.md
similarity index 70%
rename from docs/chainlink-nodes/oracle-jobs/task-types/task_multiply.md
rename to src/pages/chainlink-nodes/oracle-jobs/task-types/task_multiply.md
index 3fa127569d4..57090100b7b 100644
--- a/docs/chainlink-nodes/oracle-jobs/task-types/task_multiply.md
+++ b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_multiply.md
@@ -1,5 +1,5 @@
---
-layout: nodes.liquid
+layout: ../../../../layouts/MainLayout.astro
section: nodeOperator
date: Last Modified
title: "Multiply Task"
@@ -11,15 +11,15 @@ Multiplies the provided `input` and `times` values.
**Parameters**
- `input`: the value to be multipled. Possible values:
- - number
- - stringified number
- - bytes-ified number
- - `$(variable)`
+ - number
+ - stringified number
+ - bytes-ified number
+ - `$(variable)`
- `times`: the value to multiply the input with.
- - number
- - stringified number
- - bytes-ified number
- - `$(variable)`
+ - number
+ - stringified number
+ - bytes-ified number
+ - `$(variable)`
**Outputs**
@@ -27,9 +27,8 @@ The result of the multiplication.
**Example**
-```jpv2
+```toml
my_multiply_task [type="multiply" input="$(json_parse_result)" times=3]
```
Given the input `10`, the task will return `30`.
-
diff --git a/docs/chainlink-nodes/oracle-jobs/task-types/task_sum.md b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_sum.md
similarity index 92%
rename from docs/chainlink-nodes/oracle-jobs/task-types/task_sum.md
rename to src/pages/chainlink-nodes/oracle-jobs/task-types/task_sum.md
index 206c619ccd5..1173f6f5ad8 100644
--- a/docs/chainlink-nodes/oracle-jobs/task-types/task_sum.md
+++ b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_sum.md
@@ -1,5 +1,5 @@
---
-layout: nodes.liquid
+layout: ../../../../layouts/MainLayout.astro
section: nodeOperator
date: Last Modified
title: "Sum Task"
@@ -19,7 +19,7 @@ The sum of the values in the `values` array.
**Example**
-```jpv2
+```toml
my_sum_task [type="sum"
values=<[ $(fetch1), $(fetch2), $(fetch3) ]>
allowedFaults=1]
diff --git a/docs/chainlink-nodes/oracle-jobs/task-types/task_uppercase.md b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_uppercase.md
similarity index 87%
rename from docs/chainlink-nodes/oracle-jobs/task-types/task_uppercase.md
rename to src/pages/chainlink-nodes/oracle-jobs/task-types/task_uppercase.md
index f791ac086c5..d8455628c55 100644
--- a/docs/chainlink-nodes/oracle-jobs/task-types/task_uppercase.md
+++ b/src/pages/chainlink-nodes/oracle-jobs/task-types/task_uppercase.md
@@ -1,5 +1,5 @@
---
-layout: nodes.liquid
+layout: ../../../../layouts/MainLayout.astro
section: nodeOperator
date: Last Modified
title: "Uppercase Task"
@@ -18,7 +18,7 @@ Uppercase string.
**Example**
-```jpv2
+```toml
my_uppercase_task [type="uppercase" input="Hello World!"]
```
diff --git a/docs/chainlink-nodes/oracle-jobs/task-types/tasks.md b/src/pages/chainlink-nodes/oracle-jobs/task-types/tasks.md
similarity index 64%
rename from docs/chainlink-nodes/oracle-jobs/task-types/tasks.md
rename to src/pages/chainlink-nodes/oracle-jobs/task-types/tasks.md
index 8db8c48b5c2..0bd37610a1a 100644
--- a/docs/chainlink-nodes/oracle-jobs/task-types/tasks.md
+++ b/src/pages/chainlink-nodes/oracle-jobs/task-types/tasks.md
@@ -1,5 +1,5 @@
---
-layout: nodes.liquid
+layout: ../../../../layouts/MainLayout.astro
section: nodeOperator
date: Last Modified
title: "Tasks"
@@ -8,11 +8,13 @@ permalink: "docs/tasks/"
## What is a Task?
-> 📘 Tasks replace the [core adapters](/docs/core-adapters/) from v1 jobs.
+:::note[Tasks]
+Tasks replace the [core adapters](/chainlink-nodes/oracle-jobs/v1/adapters/) from v1 jobs.
+:::
-Tasks are a replacement for core adapters that is more flexible. Tasks can be composed in arbitrary order into [pipelines](/docs/jobs/task-types/pipelines/). Pipelines consist of one or more threads of execution where tasks are executed in a well-defined order.
+Tasks are a replacement for core adapters that is more flexible. Tasks can be composed in arbitrary order into [pipelines](/chainlink-nodes/oracle-jobs/task-types/pipelines/). Pipelines consist of one or more threads of execution where tasks are executed in a well-defined order.
-Chainlink has a number of built-in tasks which are listed below. You can also create your own [external adapters](/docs/external-adapters/) for tasks which are accessed through a `bridge`.
+Chainlink has a number of built-in tasks which are listed below. You can also create your own [external adapters](/chainlink-nodes/external-adapters/external-adapters/) for tasks which are accessed through a `bridge`.
## Shared attributes
@@ -20,7 +22,7 @@ All tasks share a few common attributes:
`index`: when a task has more than one input (or the pipeline overall needs to support more than one final output), and the ordering of the values matters, the index parameter can be used to specify that ordering.
-```jpv2
+```toml
data_1 [type="http" method=GET url="https://chain.link/eth_usd" index=0]
data_2 [type="http" method=GET url="https://chain.link/eth_dominance" index=1]
multiword_abi_encode [type="eth_abi_encode" method="fulfill(uint256,uint256)"]
diff --git a/docs/chainlink-nodes/oracle-jobs/v1/adapters.md b/src/pages/chainlink-nodes/oracle-jobs/v1/adapters.md
similarity index 78%
rename from docs/chainlink-nodes/oracle-jobs/v1/adapters.md
rename to src/pages/chainlink-nodes/oracle-jobs/v1/adapters.md
index 60cf5e86c60..368e85e6ccc 100644
--- a/docs/chainlink-nodes/oracle-jobs/v1/adapters.md
+++ b/src/pages/chainlink-nodes/oracle-jobs/v1/adapters.md
@@ -1,18 +1,22 @@
---
-layout: nodes.liquid
+layout: ../../../../layouts/MainLayout.astro
section: legacy
date: Last Modified
-title: 'Core Adapters [v1]'
-permalink: 'docs/core-adapters/'
-whatsnext: { 'Introduction to External Adapters': '/docs/external-adapters/', 'Initiators': '/docs/initiators/' }
+title: "Core Adapters [v1]"
+permalink: "docs/core-adapters/"
+whatsnext:
+ {
+ "Introduction to External Adapters": "/chainlink-nodes/external-adapters/external-adapters/",
+ "Initiators": "/chainlink-nodes/oracle-jobs/v1/initiators/",
+ }
---
# REMOVED
-> ❗️ v1 Jobs are removed
-> The adapters or JSON adapters for v1 Jobs are removed for Chainlink nodes running version 1.0.0 and later. Use [v2 job tasks](/docs/tasks) instead.
->
-> See the [v2 jobs migration page](/docs/jobs/migration-v1-v2) to learn how to migrate to v2 jobs.
+:::caution[v1 Jobs are removed]
+The initiators for v1 Jobs are removed for Chainlink nodes running version 1.0.0 and later. Use [v2 job types](/chainlink-nodes/oracle-jobs/jobs) instead.` with your desired version.
```shell Goerli
cd ~/.chainlink-goerli && docker run -p 6688:6688 -v ~/.chainlink-goerli:/chainlink -it --env-file=.env smartcontract/chainlink: local n
```
+
```shell Mainnet
cd ~/.chainlink && docker run -p 6688:6688 -v ~/.chainlink:/chainlink -it --env-file=.env smartcontract/chainlink: local n
```
-> 📘 Local Database
->
-> If you're running a local database you may need to add the `--network host` flag to the command above.
+:::note[Local Database]
+If you're running a local database you may need to add the `--network host` flag to the command above.
+:::
-The first time running the image, it will ask you for a password and confirmation. This will be your wallet password that you can use to unlock the keystore file generated for you. Then, you'll be prompted to enter an API Email and Password. This will be used to expose the API for the GUI interface, and will be used every time you log into your node. When running the node again, you can supply the `-p` option with a path to a text file containing the wallet key password, and a `-a` option, pointing to a text file containing the API email and password. Instructions on how to do that are [here](../miscellaneous/#use-password-and-api-files-on-startup).
+The first time running the image, it will ask you for a password and confirmation. This will be your wallet password that you can use to unlock the keystore file generated for you. Then, you'll be prompted to enter an API Email and Password. This will be used to expose the API for the GUI interface, and will be used every time you log into your node. When running the node again, you can supply the `-p` option with a path to a text file containing the wallet key password, and a `-a` option, pointing to a text file containing the API email and password. Instructions on how to do that are [here](/chainlink-nodes/miscellaneous/#use-password-and-api-files-on-startup).
-> 📘 Important
->
-> You will need to send some ETH to your node's address in order for it to fulfill requests. You can view your node's ETH address when the node starts up or on the Configuration page of the GUI.
+:::tip[Important]
+You will need to send some ETH to your node's address in order for it to fulfill requests. You can view your node's ETH address when the node starts up or on the Configuration page of the GUI.
+:::
-You can now connect to your Chainlink node's UI interface by navigating to [http://localhost:6688](http://localhost:6688). If using a VPS, you can create a [SSH tunnel](https://www.howtogeek.com/168145/how-to-use-ssh-tunneling/) to your node for `6688:localhost:6688` to enable connectivity to the GUI. Typically this is done with `ssh -i $KEY $USER@$REMOTE-IP -L 6688:localhost:6688 -N`. A SSH tunnel is recommended over opening up ports specific to the Chainlink node to be public facing. See the [Security and Operation Best Practices](../best-security-practices/) page for more details on how to secure your node.
+You can now connect to your Chainlink node's UI interface by navigating to [http://localhost:6688](http://localhost:6688). If using a VPS, you can create a [SSH tunnel](https://www.howtogeek.com/168145/how-to-use-ssh-tunneling/) to your node for `6688:localhost:6688` to enable connectivity to the GUI. Typically this is done with `ssh -i $KEY $USER@$REMOTE-IP -L 6688:localhost:6688 -N`. A SSH tunnel is recommended over opening up ports specific to the Chainlink node to be public facing. See the [Security and Operation Best Practices](/chainlink-nodes/best-security-practices/) page for more details on how to secure your node.
diff --git a/src/pages/data-feeds/deprecating-feeds.md b/src/pages/data-feeds/deprecating-feeds.md
new file mode 100644
index 00000000000..e25897cd1af
--- /dev/null
+++ b/src/pages/data-feeds/deprecating-feeds.md
@@ -0,0 +1,12 @@
+---
+layout: ../../layouts/MainLayout.astro
+title: "Deprecation of Chainlink Data Feeds"
+section: ethereum
+metadata:
+ description: "Deprecation of Chainlink Data Feeds"
+date: Last Modified
+setup: |
+ import { FeedPage } from "@features/feeds"
+---
+
+
+ The Feed Registry only lists feeds with a canonical token address on a network. Non-token feeds such as stock indexes
+ are not supported because they do not have a canonical token address.
+
+
+For a complete list of functions and parameters for the `FeedRegistryInterface` contract, see the [Feed Registry API Reference](/data-feeds/feed-registry/feed-registry-functions/).
+
+## Base and Quote
+
+The Feed Registry fully supports the [`AggregatorV3Interface`](https://github.com/smartcontractkit/chainlink/blob/develop/contracts/src/v0.8/interfaces/AggregatorV3Interface.sol) API for multiple feeds. It maps feeds from `base` and `quote` address pairs. To get the latest LINK / USD round data from the registry, call:
+
+{/* prettier-ignore */}
+```solidity
+latestRoundData(address base, address quote)
+```
+
+For example, to get the latest LINK / USD price:
+
+- `base`: The LINK token address on that network e.g. `0x514910771AF9Ca656af840dff83E8264EcF986CA` for LINK on Ethereum mainnet
+- `quote`: A `Denominations.USD` address (`0x0000000000000000000000000000000000000348`), which is based on [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
+
+{/* prettier-ignore */}
+```solidity Mainnet
+latestRoundData(0x514910771AF9Ca656af840dff83E8264EcF986CA, 0x0000000000000000000000000000000000000348)
+```
+
+To get the latest LINK / ETH price on Ethereum:
+
+- `base`: The LINK token address on that network e.g. `0x514910771AF9Ca656af840dff83E8264EcF986CA` for LINK on Ethereum mainnet
+- `quote`: A `Denominations.ETH` address (`0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE`)
+
+{/* prettier-ignore */}
+```solidity Mainnet
+latestRoundData(0x514910771AF9Ca656af840dff83E8264EcF986CA, 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE)
+```
+
+### Denominations library
+
+A [`Denominations`](https://github.com/smartcontractkit/chainlink/blob/develop/contracts/src/v0.8/Denominations.sol) Solidity library is available for you to fetch currency identifiers which lack a canonical Ethereum address:
+
+
+ You can find a working Feed Registry Hardhat project
+ [here](https://github.com/smartcontractkit/feed-registry-example). Clone the repo and follow the setup instructions to
+ run the example locally.
+
+
+### Javascript
+
+
+ {"Price Feeds"}
+
+
+### Proof of Reserve Feeds
+
+Proof of Reserves feeds provide the status of reserves for stablecoins, wrapped assets, and real world assets. Proof of Reserve Feeds operate similarly to Price Feeds, but provide answers in units of measurement such as ounces (oz) or number of tokens.
+
+To learn more about Proof of Reserve Feeds, see the [Proof of Reserve](/data-feeds/proof-of-reserve/) documentation.
+
+
+ {"Proof of Reserve Feeds"}
+
+
+### NFT Floor Pricing Feeds
+
+NFT Floor Pricing Feeds provide the price of the lowest priced NFT available in a collection. These feeds operate similarly to [Price Feeds](/data-feeds/price-feeds/) so you can use the [AggregatorV3Interface.sol](https://github.com/smartcontractkit/chainlink/blob/master/contracts/src/v0.8/interfaces/AggregatorV3Interface.sol) contract to retrieve price answers.
+
+To learn more, see the [NFT Floor Pricing Feeds](/data-feeds/nft-floor-price/) documentation.
+
+
+ {"NFT Floor Pricing Feeds"}
+
+
+### L2 sequencer uptime feeds
+
+L2 sequencer feeds track the last known status of the sequencer on an L2 network at a given point in time. This helps you prevent mass liquidations by providing a grace period to allow customers to react to these events.
+
+To learn how to use L2 sequencer uptime feeds feeds, see the [L2 Sequencer Uptime Feeds](/data-feeds/l2-sequencer-feeds/) documentation.
+
+
+ {"L2 Sequencer Uptime Feeds"}
+
+
+## Components of a data feed
+
+Data Feeds are an example of a decentralized oracle network and include the following components:
+
+- **Consumer**: A consumer is an on-chain or off-chain application that uses Data Feeds. Consumer contracts use the [`AggregatorV3Interface`](https://github.com/smartcontractkit/chainlink/blob/master/contracts/src/v0.8/interfaces/AggregatorV3Interface.sol) to call functions on the proxy contract and retrieve information from the aggregator contract. For a complete list of functions available in the `AggregatorV3Interface`, see the [Data Feeds API Reference](/data-feeds/price-feeds/api-reference/#aggregatorv3interface).
+- **Proxy contract**: Proxy contracts are on-chain proxies that point to the aggregator for a particular data feed. Using proxies enables the underlying aggregator to be upgraded without any service interruption to consuming contracts. Proxy contracts can vary from one data feed to another, but the [`AggregatorProxy.sol` contract](https://github.com/smartcontractkit/chainlink/blob/develop/contracts/src/v0.7/dev/AggregatorProxy.sol) on Github is a common example.
+- **Aggregator contract**: An aggregator is a contract that receives periodic data updates from the oracle network. Aggregators store aggregated data on-chain so that consumers can retrieve it and act upon it within the same transaction. For a complete list of functions and variables available on most aggregator contracts, see the [Data Feeds API Reference](/data-feeds/price-feeds/api-reference/#accesscontrolledoffchainaggregator).
+
+To learn how to create a consumer contract that uses an existing data feed, read the [Using Data Feeds](/data-feeds/price-feeds/) documentation.
+
+## Reading proxy and aggregator configurations
+
+Because the proxy and aggregator contracts are all on-chain, you can see the current configuration by reading the variables through an [ABI](https://docs.soliditylang.org/en/latest/abi-spec.html) or using a blockchain explorer for your network. For example, you can see the [BTC/USD proxy configuration](https://etherscan.io/address/0xF4030086522a5bEEa4988F8cA5B36dbC97BeE88c#readContract) on the Ethereum network using Etherscan.
+
+If you read the BTC/USD proxy configuration, you can query all of the functions and variables that are publicly accessible for that contract including the `aggregator` address, `latestRoundData()` function, `latestAnswer` variable, `owner` address, `latestTimestamp` variable, and several others. To see descriptions for the proxy contract variables and functions, see the source code for your specific data feed on [Etherscan](https://etherscan.io/address/0xF4030086522a5bEEa4988F8cA5B36dbC97BeE88c#code#L568).
+
+The proxy contract points to an aggregator. This allows you to retrieve data through the proxy even if the aggregator is upgraded. If you view the `aggregator` address defined in the proxy configuration, you can see the aggregator and its configuration. For example, see the [BTC/USD aggregator contract](https://etherscan.io/address/0xF4030086522a5bEEa4988F8cA5B36dbC97BeE88c#code) in Etherscan. This contract includes several variables and functions, including another `latestRoundData()`. To see descriptions for the aggregator variables and functions, see the source code on [GitHub](https://github.com/smartcontractkit/libocr/blob/master/contract/AccessControlledOffchainAggregator.sol) or [Etherscan](https://etherscan.io/address/0xae74faa92cb67a95ebcab07358bc222e33a34da7#code#F1#L1).
+
+You can call the `latestRoundData()` function directly on the aggregator, but it is a best practice to use the proxy instead so that changes to the aggregator do not affect your application. Similar to the proxy contract, the aggregator contract has a `latestAnswer` variable, `owner` address, `latestTimestamp` variable, and several others.
+
+## Components of an aggregator
+
+The aggregator contract has several variables and functions that might be useful for your application. Although aggregator contracts are similar for each data feed, some aggregators have different variables. Use the `typeAndVersion()` function on the aggregator to identify what type of aggregator it is and what version it is running.
+
+Always check the contract source code and configuration to understand how specific data feeds operate. For example, the [aggregator contract for BTC/USD on Arbitrum](https://arbiscan.io/address/0x942d00008d658dbb40745bbec89a93c253f9b882#code) is different from the aggregators on other networks.
+
+For examples of the contracts that are typically used in aggregator deployments, see the [libocr repository](https://github.com/smartcontractkit/libocr/blob/master/contract/) on GitHub.
+
+For a complete list of functions and variables available on most aggregator contracts, see the [Data Feeds API Reference](/data-feeds/price-feeds/api-reference/#accesscontrolledoffchainaggregator).
+
+## Updates to proxy and aggregator contracts
+
+To accommodate the dynamic nature of off-chain environments, Chainlink Data Feeds are updated from time to time to add new features and capabilities as well as respond to externalities such as token migrations, protocol rebrands, extreme market events, and upstream issues with data or node operations.
+
+These updates include changes to the aggregator configuration or a complete replacement of the aggregator that the proxy uses. If you consume data feeds through the proxy, your applications can continue to operate during these changes.
+
+Proxy and aggregator contracts all have an `owner` address that has permission to change variables and functions. For example, if you read the [BTC/USD proxy contract](https://etherscan.io/address/0xF4030086522a5bEEa4988F8cA5B36dbC97BeE88c#readContract) in Etherscan, you can see the `owner` address. This address is a [multi-signature safe](https://docs.gnosis-safe.io/introduction/the-programmable-account/gnosis-safe) (multisig) that you can also inspect.
+
+If you [view the multisig contract](https://etherscan.io/address/0x21f73d42eb58ba49ddb685dc29d3bf5c0f0373ca#readProxyContract) in Etherscan using the _Read as Proxy_ feature, you can see the full details of the multisig including the list of addresses that can sign and the number of signers required for the multisig to approve actions on any contracts that it owns.
+
+The multisig-coordinated upgradability of Chainlink Data Feeds involves time-tested processes that balance collusion-resistance with the flexibility required to implement improvements and swiftly react to external conditions. The approach taken to upgradability will continue to evolve over time to meet user requirements.
+
+## Monitoring data feeds
+
+When you build applications and protocols that depend on data feeds, include monitoring and safeguards to protect against the negative impact of extreme market events, possible malicious activity on third-party venues or contracts, potential delays, and outages.
+
+Create your own monitoring alerts based on deviations in the answers that data feeds provide. This will notify you when potential issues occur so you can respond to them.
+
+### Check the latest answer against reasonable limits
+
+The data feed aggregator includes both [`minAnswer` and `maxAnswer` values](https://github.com/smartcontractkit/libocr/blob/9e4afd8896f365b964bdf769ca28f373a3fb0300/contract/AccessControlledOffchainAggregator.sol#L33). These variables prevent the aggregator from updating the `latestAnswer` outside the agreed range of acceptable values, but they do not stop your application from reading the most recent answer.
+
+Configure your application to detect when the reported answer is close to reaching `minAnswer` or `maxAnswer` and issue an alert so you can respond to a potential market event. Separately, configure your application to detect and respond to extreme price volatility or prices that are outside of your acceptable limits.
+
+### Check the timestamp of the latest answer
+
+Chainlink Price Feeds do not provide streaming data. Rather, the aggregator updates its `latestAnswer` when the value deviates beyond a specified threshold or when the heartbeat idle time has passed. You can find the heartbeat and deviation values for each data feed at [data.chain.link](https://data.chain.link/) or in the [Contract Addresses](/data-feeds/price-feeds/addresses/) lists.
+
+Your application should track the `latestTimestamp` variable or use the `updatedAt` value from the `latestRoundData()` function to make sure that the latest answer is recent enough for your application to use it. If your application detects that the reported answer is not updated within the heartbeat or within time limits that you determine are acceptable for your application, pause operation or switch to an alternate operation mode while identifying the cause of the delay.
+
+During periods of low volatility, the heartbeat triggers updates to the latest answer. Some heartbeats are configured to last several hours, so your application should check the timestamp and verify that the latest answer is recent enough for your application.
+
+To learn more about the heartbeat and deviation threshold, read the [Decentralized Data Model](/architecture-overview/architecture-decentralized-model#aggregator) page.
diff --git a/src/pages/data-feeds/l2-sequencer-feeds.md b/src/pages/data-feeds/l2-sequencer-feeds.md
new file mode 100644
index 00000000000..11adeb1d55a
--- /dev/null
+++ b/src/pages/data-feeds/l2-sequencer-feeds.md
@@ -0,0 +1,102 @@
+---
+layout: ../../layouts/MainLayout.astro
+section: ethereum
+date: Last Modified
+title: "L2 Sequencer Uptime Feeds"
+---
+
+Optimistic rollup protocols move all execution off the layer 1 (L1) Ethereum chain, complete execution on a layer 2 (L2) chain, and return the results of the L2 execution back to the L1. These protocols have a [sequencer](https://community.optimism.io/docs/how-optimism-works/#block-production) that executes and rolls up the L2 transactions by batching multiple transactions into a single transaction.
+
+If a sequencer becomes unavailable, it is impossible to access read/write APIs that consumers are using and applications on the L2 network will be down for most users without interacting directly through the L1 optimistic rollup contracts. The L2 has not stopped, but it would be unfair to continue providing service on your applications when only a few users can use them.
+
+To help your applications identify when the sequencer is unavailable, you can use a data feed that tracks the last known status of the sequencer at a given point in time. This helps you prevent mass liquidations by providing a grace period to allow customers to react to such an event.
+
+## Available networks
+
+You can find proxy addresses for the L2 sequencer feeds at the following addresses:
+
+- Arbitrum:
+ - Arbitrum mainnet: [0xFdB631F5EE196F0ed6FAa767959853A9F217697D](https://arbiscan.io/address/0xfdb631f5ee196f0ed6faa767959853a9f217697d)
+ - Arbitrum Goerli testnet: [0x4da69F028a5790fCCAfe81a75C0D24f46ceCDd69](https://goerli-rollup-explorer.arbitrum.io/address/0x4da69F028a5790fCCAfe81a75C0D24f46ceCDd69)
+- Optimism:
+ - Optimism mainnet: [0x371EAD81c9102C9BF4874A9075FFFf170F2Ee389](https://optimistic.etherscan.io/address/0x371EAD81c9102C9BF4874A9075FFFf170F2Ee389)
+ - Optimism Goerli testnet: [0x4C4814aa04433e0FB31310379a4D6946D5e1D353](https://goerli-optimism.etherscan.io/address/0x4C4814aa04433e0FB31310379a4D6946D5e1D353)
+- Metis:
+ - Andromeda mainnet: [0x58218ea7422255EBE94e56b504035a784b7AA204](https://andromeda-explorer.metis.io/address/0x58218ea7422255EBE94e56b504035a784b7AA204)
+
+### Arbitrum
+
+The diagram below shows how these feeds update and how a consumer retrieves the status of the Arbitrum sequencer.
+
+
+
+1. Chainlink nodes trigger an OCR round every 30s and update the sequencer status by calling the `validate` function in the [`ArbitrumValidator` contract](https://github.com/smartcontractkit/chainlink/blob/master/contracts/src/v0.8/dev/ArbitrumValidator.sol) by calling it through the [`ValidatorProxy` contract](https://github.com/smartcontractkit/chainlink/blob/master/contracts/src/v0.8/ValidatorProxy.sol).
+1. The `ArbitrumValidator` checks to see if the latest update is different from the previous update. If it detects a difference, it places a message in the [Arbitrum inbox contract](https://developer.offchainlabs.com/docs/inside_arbitrum#the-big-picture).
+1. The inbox contract sends the message to the [`ArbitrumSequencerUptimeFeed` contract](https://github.com/smartcontractkit/chainlink/blob/master/contracts/src/v0.8/dev/ArbitrumSequencerUptimeFeed.sol). The message calls the `updateStatus` function in the `ArbitrumSequencerUptimeFeed` contract and updates the latest sequencer status to 0 if the sequencer is up and 1 if it is down. It also records the block timestamp to indicate when the message was sent from the L1 network.
+1. A consumer contract on the L2 network can read these values from the [`ArbitrumUptimeFeedProxy` contract](https://github.com/smartcontractkit/chainlink/blob/develop/contracts/src/v0.6/EACAggregatorProxy.sol), which reads values from the `ArbitrumSequencerUptimeFeed` contract.
+
+### Handling Arbitrum outages
+
+If the Arbitrum network becomes unavailable, the `ArbitrumValidator` contract continues to send messages to the L2 network through the delayed inbox on L1. This message stays there until the sequencer is back up again. When the sequencer comes back online after downtime, it processes all transactions from the delayed inbox before it accepts new transactions. The message that signals when the sequencer is down will be processed before any new messages with transactions that require the sequencer to be operational.
+
+## Optimism and Metis
+
+On Optimism and Metis, the sequencer’s status is relayed from L1 to L2 where the consumer can retrieve it.
+
+
+
+**On the L1 network:**
+
+1. A network of node operators runs the external adapter to post the latest sequencer status to the `AggregatorProxy` contract and relays the status to the `Aggregator` contract. The `Aggregator` contract calls the `validate` function in the `OptimismValidator` contract.
+
+1. The `OptimismValidator` contract calls the `sendMessage` function in the `L1CrossDomainMessenger` contract. This message contains instructions to call the `updateStatus(bool status, uint64 timestamp)` function in the sequencer uptime feed deployed on the L2 network.
+
+1. The `L1CrossDomainMessenger` contract calls the `enqueue` function to enqueue a new message to the `CanonicalTransactionChain`.
+
+1. The `Sequencer` processes the transaction enqueued in the `CanonicalTransactionChain` contract to send it to the L2 contract.
+
+**On the L2 network:**
+
+1. The `Sequencer` posts the message to the `L2CrossDomainMessenger` contract.
+
+1. The `L2CrossDomainMessenger` contract relays the message to the `OptimismSequencerUptimeFeed` contract.
+
+1. The message relayed by the `L2CrossDomainMessenger` contains instructions to call `updateStatus` in the `OptimismSequencerUptimeFeed` contract.
+
+1. Consumers can then read from the `AggregatorProxy` contract, which fetches the latest round data from the `OptimismSequencerUptimeFeed` contract.
+
+### Handling outages on Optimism and Metis
+
+If the sequencer is down, messages cannot be transmitted from L1 to L2 and **no L2 transactions are executed**. Instead, messages are enqueued in the `CanonicalTransactionChain` on L1 and only processed in the order they arrived later when the sequencer comes back up. As long as the message from the validator on L1 is already enqueued in the `CTC`, the flag on the sequencer uptime feed on L2 will be guaranteed to be flipped prior to any subsequent transactions. The transaction that flips the flag on the uptime feed will be executed before transactions that were enqueued after it. This is further explained in the diagrams below.
+
+When the Sequencer is down, all L2 transactions sent from the L1 network wait in the pending queue.
+
+1. **Transaction 3** contains Chainlink’s transaction to set the status of the sequencer as being down on L2.
+1. **Transaction 4** is a transaction made by a consumer that is dependent on the sequencer status.
+
+
+
+After the sequencer comes back up, it moves moves all transactions in the pending queue to the processed queue.
+
+1. Transactions are processed in the order they arrived so **Transaction 3** is processed before **Transaction 4**.
+1. Because **Transaction 3** happens before **Transaction 4**, **Transaction 4** will read the status of the Sequencer as being down and responds accordingly.
+
+
+
+## Example code
+
+Create the consumer contract for sequencer uptime feeds similarly to contracts you use for [Chainlink Data Feeds](/data-feeds/price-feeds/#solidity). Configure the constructor using the following variables:
+
+- Configure the `sequencerUptimeFeed` object with the [sequencer uptime feed proxy address](#available-networks) for your L2 network.
+- Configure the `priceFeed` object with one of the [Data Feed proxy addresses](/data-feeds/price-feeds/addresses/) that are available for your network.
+
+::solidity-remix[samples/PriceFeeds/PriceConsumerWithSequencerCheck.sol]
+
+The `sequencerUptimeFeed` object returns the following values:
+
+- `answer`: A variable with a value of either `1` or `0`
+ - 0: The sequencer is up
+ - 1: The sequencer is down
+- `startedAt`: This timestamp indicates when the sequencer changed status. This timestamp returns `0` if a round is invalid. When the sequencer comes back up after an outage, wait for the `GRACE_PERIOD_TIME` to pass before accepting answers from the price data feed. Subtract `startedAt` from `block.timestamp` and revert the request if the result is less than the `GRACE_PERIOD_TIME`.
+
+If the sequencer is up and the `GRACE_PERIOD_TIME` has passed, the function retrieves the latest price from the data feed using the `priceFeed` object.
diff --git a/src/pages/data-feeds/nft-floor-price/addresses.md b/src/pages/data-feeds/nft-floor-price/addresses.md
new file mode 100644
index 00000000000..5f2e5bd5030
--- /dev/null
+++ b/src/pages/data-feeds/nft-floor-price/addresses.md
@@ -0,0 +1,14 @@
+---
+layout: ../../../layouts/MainLayout.astro
+title: "NFT Floor Pricing Feed Addresses"
+section: ethereum
+datafeedtype: nftFloor
+metadata:
+ title: "NFT Floor Pricing Feed Addresses"
+ description: "NFT Floor Pricing Feed Addresses"
+date: Last Modified
+setup: |
+ import { FeedPage } from "@features/feeds"
+---
+
+
+ The example formula above ensures that no matter how many times the underlying aggregator changes, the proxy `roundId`
+ will always increase.
+
+
+**Example:**
+
+When you query historical data, it is important to know when you reach the end of the history of the underlying aggregator. As an example, if the `latestRoundData` [function](/data-feeds/price-feeds/api-reference/#latestrounddata) of the [LINK / USD feed on Ethereum Mainnet](/data-feeds/price-feeds/addresses/?network=ethereum) returns `roundId = 92233720368547771158`, you can use this value to compute the `phaseId` and `aggregatorRoundId`:
+
+- `phaseId = 92233720368547771158 >> 64`: Right shifting an integer by 64 bits is equivalent to dividing it by 2^64: `phaseId = 92233720368547771158/ 2^64 = 5`. The current phase id is 5 , which means that this proxy has had 5 underlying aggregators since its initial deployment.
+- `aggregatorRoundId = uint64(92233720368547771158)`: This retrieves the first 64 bits from the right. To calculate this off-chain, you can use the following JavaScript example:
+
+```javascript
+// First parse to BigInt to perform computation with big integers
+const num = BigInt("92233720368547771158")
+const num2 = BigInt("0xFFFFFFFFFFFFFFFF") // Largest 64bits integer
+
+console.log(Number(num >> 64n)) // returns 5 (phaseId)
+console.log(Number(num & num2)) // returns 13078 (aggregatorRoundId) . Use & (AND bitwise operator) which sets each bit to _1_ if both bits are _1_
+```
+
+Using _13078_ as the current aggregator's round, get its historical data by looping over the [`getRoundData` function](/data-feeds/price-feeds/api-reference/#getrounddata):
+
+- Start from the first round: _92233720368547758081_ (result of _92233720368547771158 - 13078 + 1_)
+- Continue until the current round: _92233720368547771158_
+
+To get the historical data for previous aggregators, decrement the `phaseId` and start from round _1_. For phase _4_, get the starting `roundId` off-chain using the following JavaScript example:
+
+```javascript
+const phaseId = BigInt("4")
+const aggregatorRoundId = BigInt("1")
+
+roundId = (phaseId << 64n) | aggregatorRoundId // returns 73786976294838206465n
+```
+
+Loop over the [`getRoundData` function](/data-feeds/price-feeds/api-reference/#getrounddata). Start at _73786976294838206465_ and increment it until you get a revert. This means that you reached the last round for the underlying aggregator. The same process could be repeated for previous `phaseIds` (3,2,1).
+
+
+ The examples showed how to loop off-chain to fetch all historical data from a given proxy. You could also write a
+ similar code on-chain, but be aware that this could cause **very high gas prices** if a state is changed within the
+ same function.
+
+
+### `getRoundData` return values
+
+The [`getRoundData` function](/data-feeds/price-feeds/api-reference/#getrounddata) returns the following values:
+
+- `roundId`: The combination of `aggregatorRoundId` and `phaseId` (see explanation above). The `roundId` can jump significantly when the `phaseId` is updated.
+- `answer` is the price.
+- `answeredInRound`: The combination of `aggregatorAnsweredInRound` and `phaseId`. `aggregatorAnsweredInRound`: The round the answer was updated in. You can check `answeredInRound` against the current `roundId`. If `answeredInRound` is less than `roundId`, the answer is being carried over. If `answeredInRound` is equal to `roundId`, then the answer is fresh.
+- `startedAt`: The timestamp when the round started.
+- `updatedAt`: The timestamp when the answer was computed.
+
+
+ A read can revert if the caller is requesting the details of a round that was invalid or has not yet been answered. If
+ you are deriving a round ID without having observed it before, the round might not be complete. To check the round,
+ validate that the timestamp on that round is not 0. In a best-case scenario, rounds update chronologically. However, a
+ round can time out if it doesn't reach consensus. Technically, that is a timed out round that carries over the answer
+ from the previous round.
+
+
+### Solidity
+
+
+ {"Run this Python example"}
+
diff --git a/src/pages/data-feeds/price-feeds/index.mdx b/src/pages/data-feeds/price-feeds/index.mdx
new file mode 100644
index 00000000000..413ac748bd0
--- /dev/null
+++ b/src/pages/data-feeds/price-feeds/index.mdx
@@ -0,0 +1,116 @@
+---
+layout: ../../../layouts/MainLayout.astro
+section: ethereum
+date: Last Modified
+title: "Using Price Feeds"
+permalink: "docs/data-feeds/price-feeds/"
+whatsnext:
+ {
+ "Historical Price Data": "/data-feeds/price-feeds/historical-data/",
+ "Price Feeds API Reference": "/data-feeds/price-feeds/api-reference/",
+ "Price Feed Contract Addresses": "/data-feeds/price-feeds/addresses/",
+ }
+metadata:
+ title: "Using Data Feeds"
+ description: "How to use Chainlink Data Feeds in your smart contracts."
+---
+
+import { LatestPrice, priceFeedAddresses } from "@features/feeds"
+import { Aside } from "@components"
+import { Tabs } from "@components/Tabs"
+import button from "@chainlink/design-system/button.module.css"
+import CodeSample from "@components/CodeSample/CodeSample.astro"
+
+Chainlink Data Feeds are the quickest way to connect your smart contracts to the real-world market prices of assets. For example, one use for data feeds is to enable smart contracts to retrieve the latest pricing data of an asset in a single call.
+
+This guide applies specifically to using data feeds on EVM Chains. To get the full list of Chainlink Price Feeds running on the EVM Chains, see the [Contract Addresses](/data-feeds/price-feeds/addresses/) page.
+
+
+ Be aware of the quality of the data that you use. [Learn more about making responsible data quality
+ decisions.](/data-feeds/selecting-data-feeds/)
+
+
+For important updates regarding the use of Chainlink Price Feeds, users should join the official Chainlink Discord and subscribe to the data-feeds-user-notifications channel: [https://discord.gg/Dqy5N9UbsR](https://discord.gg/Dqy5N9UbsR)
+
+These examples show you how to get the price of Ethereum (ETH) on the Ethereum Goerli testnet, but you can modify the examples to work on other chains as well. The list of price feeds for each network are available on the [Data Feed Contracts](/data-feeds/price-feeds/addresses/) page. For development, use testnet data feeds such as the [BTC / USD feed](https://goerli.etherscan.io/address/0xA39434A63A52E749F02807ae27335515BA4b07F7) on the Goerli testnet.
+
+You can write smart contracts that consume Price Feeds using several languages, but this guide shows examples using the following languages:
+
+- [Solidity](#solidity)
+- [Vyper](#vyper)
+- [Javascript](#javascript) with [web3.js](https://web3js.readthedocs.io/)
+- [Python](#python) with [Web3.py](https://web3py.readthedocs.io/en/stable/)
+- [Golang](#golang) with [go-ethereum](https://github.com/ethereum/go-ethereum)
+
+## Solidity
+
+To consume price data, your smart contract should reference [`AggregatorV3Interface`](https://github.com/smartcontractkit/chainlink/blob/master/contracts/src/v0.8/interfaces/AggregatorV3Interface.sol), which defines the external functions implemented by Data Feeds.
+
+
+ web3.js
+ ethers.js
+
+
+
+
+
+
+
+ {"Run this Python example"}
+
+
+## Golang
+
+You can find an example with all the source files [here](https://github.com/smartcontractkit/smart-contract-examples/tree/main/pricefeed-golang). This example uses [go-ethereum](https://github.com/ethereum/go-ethereum) to retrieve feed data from the [BTC / USD feed](https://goerli.etherscan.io/address/0xA39434A63A52E749F02807ae27335515BA4b07F7) on the Goerli testnet.
+To learn how to run the example, see the [README](https://github.com/smartcontractkit/smart-contract-examples/blob/main/pricefeed-golang/README.md).
+
+
+ You can use the [Feed Registry](/data-feeds/feed-registry/) to reference data feed assets by name or currency
+ identifier instead of by pair/proxy address.
+
+
+## Getting a different price denomination
+
+Chainlink Data Feeds can be used in combination to derive denominated price pairs in other currencies.
+
+If you require a denomination other than what is provided, you can use two data feeds to derive the pair that you need. For example, if you needed a BTC / EUR price, you could take the BTC / USD feed and the EUR / USD feed and derive BTC / EUR using division.
+
+
+
+
+ If your contracts require Solidity versions that are `>=0.6.0 <0.8.0`, use [OpenZeppelin's SafeMath version 3.4](https://github.com/OpenZeppelin/openzeppelin-contracts/blob/release-v3.4/contracts/math/SafeMath.sol).
+
+
+
+
+ Get Data Feeds in your Smart Contracts
+
+ Retrieve the latest prices and data points of assets in your smart
+ contracts.
+
+
+ {"Learn More"}
+
+
+
+
+
+
Generate Verifiable Random Numbers (VRF)
+
Use Chainlink VRF to consume randomness in your smart contracts.
+
+ {"Learn More"}
+
+
+
+ Call External APIs from Smart Contracts
+
+ Request & Receive data from any API using the Chainlink contract
+ library.
+
+
+ {"Learn More"}
+
+
+
+
+
+
+
+
New to Chainlink and Smart Contracts?
+
Learn the basics in the Getting Started Guide. Build your first smart contract on Ethereum.
+
+ {"Getting Started Guide"}
+
+
+
+
+
+
Automate and Maintain with Chainlink Automation
+
+ Chainlink Automation provides smart contract developers, decentralized applications (dApps), and decentralized
+ autonomous organizations (DAOs) with a highly reliable, decentralized, and cost-efficient method of automating
+ smart contract functions and regular contract maintenance.
+
+
+ {"Learn More"}
+
+
+
+
+
Explore Additional Resources
+
Find all the right resources to get the most out of Chainlink.
+
+
+
Explore Chainlink Developer Tools
+
+
Good stub, {stub}!
diff --git a/src/pages/getting-started/advanced-tutorial.md b/src/pages/getting-started/advanced-tutorial.md
new file mode 100644
index 00000000000..301588bc1c7
--- /dev/null
+++ b/src/pages/getting-started/advanced-tutorial.md
@@ -0,0 +1,149 @@
+---
+layout: ../../layouts/MainLayout.astro
+section: gettingStarted
+date: Last Modified
+title: "API Calls: Using Any API"
+permalink: "docs/advanced-tutorial/"
+excerpt: "Calling APIs from Smart Contracts"
+whatsnext:
+ {
+ "Make a GET Request": "/any-api/get-request/introduction/",
+ "Make an Existing Job Request": "/any-api/get-request/examples/existing-job-request/",
+ }
+metadata:
+ image:
+ 0: "/files/04b8e56-cl.png"
+---
+
+:::note[ Requirements]
+
+This guide requires basic knowledge about smart contracts. If you are new to smart contract development, read the [Consuming Data Feeds](/getting-started/consuming-data-feeds/) and [Random Numbers](/getting-started/intermediates-tutorial/) guides before you begin.
+
+:::
+
+
- https://www.youtube.com/watch?v=rFXSEEQG9YE
-
+- [Deploy Your First Smart Contract](/getting-started/deploy-your-first-contract/): If you are new to smart contracts, deploy your first smart contract in an interactive web development environment.
+- [Learn how to use Data Feeds](/getting-started/consuming-data-feeds/): If you are already familiar with smart contracts and want to learn how to create _hybrid_ smart contracts, use Chainlink Data Feeds to get asset price data on-chain.
-**Topics**
-
-+ [What is a smart contract? What is a hybrid smart contract?](#what-is-a-smart-contract-what-is-a-hybrid-smart-contract)
-+ [What language is a smart contract written in?](#what-language-is-a-smart-contract-written-in)
-+ [What does a smart contract look like?](#what-does-a-smart-contract-look-like)
-+ [What does "deploying" mean?](#what-does-deploying-mean)
-+ [What is a LINK token?](#what-is-a-link-token)
-+ [What are oracles? Why are they important?](#what-are-oracles)
-+ [How do smart contracts use oracles?](#how-do-smart-contracts-use-oracles)
-+ [What is Remix?](#what-is-remix)
-+ [What is Metamask?](#what-is-metamask)
+
- https://www.youtube.com/watch?v=JWJWT9cwFbo
-
+
- https://www.youtube.com/watch?v=rdJ5d8j1RCg&ab
-
+This guide assumes that you have basic knowledge about writing and deploying smart contracts. If you are new to smart contract development, read the [Consuming Data Feeds](/getting-started/consuming-data-feeds/) guide before you begin.
-VRF v2 - Developer Walkthrough
-
-## Overview
+:::
-In this guide, you will learn about generating randomness on blockchains. This includes learning how to implement a Request and Receive cycle with Chainlink oracles and how to consume random numbers with Chainlink VRF in smart contracts.
+VRF v2 - Developer Walkthrough
-- [Overview](#overview)
-- [1. How is randomness generated on blockchains? What is Chainlink VRF?](#1-how-is-randomness-generated-on-blockchains-what-is-chainlink-vrf)
-- [2. What is the Request and Receive cycle?](#2-what-is-the-request-and-receive-cycle)
-- [3. What is the payment process for generating a random number?](#3-what-is-the-payment-process-for-generating-a-random-number)
-- [4. How can I use Chainlink VRF?](#4-how-can-i-use-chainlink-vrf)
-- [5. How do I deploy to testnet?](#5-how-do-i-deploy-to-testnet)
-- [6. How do I add my contract to my subscription account ?](#6-how-do-i-add-my-contract-to-my-subscription-account)
-- [7. How do I test `rollDice`?](#7-how-do-i-test-rolldice)
-- [8. Further Reading](#8-further-reading)
+In this guide, you will learn about generating randomness on blockchains. This includes learning how to implement a Request and Receive cycle with Chainlink oracles and how to consume random numbers with Chainlink VRF in smart contracts.
-## 1. How is randomness generated on blockchains? What is Chainlink VRF?
+## How is randomness generated on blockchains? What is Chainlink VRF?
-Randomness is very difficult to generate on blockchains. This is because every node on the blockchain must come to the same conclusion and form a consensus. Even though random numbers are versatile and useful in a variety of blockchain applications, they cannot be generated natively in smart contracts. The solution to this issue is [**Chainlink VRF**](/docs/vrf/v2/introduction/), also known as Chainlink Verifiable Random Function.
+Randomness is very difficult to generate on blockchains. This is because every node on the blockchain must come to the same conclusion and form a consensus. Even though random numbers are versatile and useful in a variety of blockchain applications, they cannot be generated natively in smart contracts. The solution to this issue is [**Chainlink VRF**](/vrf/v2/introduction/), also known as Chainlink Verifiable Random Function.
-## 2. What is the Request and Receive cycle?
+## What is the Request and Receive cycle?
-The [previous guide](/docs/consuming-data-feeds/) explained how to consume Chainlink Data Feeds, which consist of reference data posted on-chain by oracles. This data is stored in a contract and can be referenced by consumers until the oracle updates the data again.
+The [previous guide](/getting-started/consuming-data-feeds/) explained how to consume Chainlink Data Feeds, which consist of reference data posted on-chain by oracles. This data is stored in a contract and can be referenced by consumers until the oracle updates the data again.
-Randomness, on the other hand, cannot be reference data. If the result of randomness is stored on-chain, any actor could retrieve the value and predict the outcome. Instead, randomness must be requested from an oracle, which generates a number and a cryptographic proof. Then, the oracle returns that result to the contract that requested it. This sequence is known as the **[Request and Receive cycle](../architecture-request-model/)**.
+Randomness, on the other hand, cannot be reference data. If the result of randomness is stored on-chain, any actor could retrieve the value and predict the outcome. Instead, randomness must be requested from an oracle, which generates a number and a cryptographic proof. Then, the oracle returns that result to the contract that requested it. This sequence is known as the **[Request and Receive cycle](/architecture-overview/architecture-request-model/)**.
-## 3. What is the payment process for generating a random number?
+## What is the payment process for generating a random number?
VRF requests receive funding from subscription accounts. The [Subscription Manager](https://vrf.chain.link) lets you create an account and pre-pay for VRF requests, so that funding of all your application requests are managed in a single location.
-To learn more about VRF request funding, see [Subscriptions](/docs/vrf/v2/subscription/#subscriptions).
+To learn more about VRF requests funding, see [Subscriptions limits](/vrf/v2/subscription#subscription-limits).
-## 4. How can I use Chainlink VRF?
+## How can I use Chainlink VRF?
-To see a basic implementation of Chainlink VRF, see [Get a Random Number](/docs/vrf/v2/subscription/examples/get-a-random-number/). In this section, you will create an application that uses Chainlink VRF to generate randomness. The contract used in this application will have a [_Game of Thrones_](https://en.wikipedia.org/wiki/Game_of_Thrones) theme.
+To see a basic implementation of Chainlink VRF, see [Get a Random Number](/vrf/v2/subscription/examples/get-a-random-number/). In this section, you will create an application that uses Chainlink VRF to generate randomness. The contract used in this application will have a [_Game of Thrones_](https://en.wikipedia.org/wiki/Game_of_Thrones) theme.
The contract will request randomness from Chainlink VRF. The result of the randomness will transform into a number between 1 and 20, mimicking the rolling of a 20 sided die. Each number represents a _Game of Thrones_ house. If the dice land on the value 1, the user is assigned house Targaryan, 2 for Lannister, and so on. A full list of houses can be found [here](https://gameofthrones.fandom.com/wiki/Great_House).
@@ -80,7 +66,7 @@ The contract will have the following functions:
### Create and fund a subscription
Chainlink VRF requests receive funding from subscription accounts. The [Subscription Manager](https://vrf.chain.link) lets you create an account and pre-pay your use of Chainlink VRF requests.
-For this example, create a new subscription on the Goerli testnet as explained [here](/docs/vrf/v2/subscription/examples/get-a-random-number/#create-and-fund-a-subscription).
+For this example, create a new subscription on the Goerli testnet as explained [here](/vrf/v2/subscription/examples/get-a-random-number/#create-and-fund-a-subscription).
### Importing `VRFConsumerBaseV2` and `VRFCoordinatorV2Interface`
@@ -89,21 +75,24 @@ Chainlink maintains a [library of contracts](https://github.com/smartcontractkit
- [`VRFConsumerBaseV2`](https://github.com/smartcontractkit/chainlink/blob/master/contracts/src/v0.8/VRFConsumerBaseV2.sol) that must be imported and extended from the contract that you create.
- [`VRFCoordinatorV2Interface`](https://github.com/smartcontractkit/chainlink/blob/master/contracts/src/v0.8/interfaces/VRFCoordinatorV2Interface.sol) that must be imported to communicate with the VRF coordinator.
+
```solidity
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.7;
-import '@chainlink/contracts/src/v0.8/interfaces/VRFCoordinatorV2Interface.sol';
-import '@chainlink/contracts/src/v0.8/VRFConsumerBaseV2.sol';
+import "@chainlink/contracts/src/v0.8/interfaces/VRFCoordinatorV2Interface.sol";
+import "@chainlink/contracts/src/v0.8/VRFConsumerBaseV2.sol";
-contract VRFD20 is VRFConsumerBaseV2 {}
+contract VRFD20 is VRFConsumerBaseV2 {
+}
```
### Contract variables
-This example is adapted for [Goerli testnet](/docs/vrf/v2/subscription/supported-networks/#goerli-testnet) but you can change the configuration and make it run for any [supported network](/docs/vrf/v2/subscription/supported-networks/#configurations).
+This example is adapted for [Goerli testnet](/vrf/v2/subscription/supported-networks/#goerli-testnet) but you can change the configuration and make it run for any [supported network](/vrf/v2/subscription/supported-networks/#configurations).
+
```solidity
uint64 s_subscriptionId;
address vrfCoordinator = 0x2Ca8E0C643bDe4C2E08ab1fA0da3401AdAD7734D;
@@ -122,6 +111,7 @@ uint32 numWords = 1;
To keep track of addresses that roll the dice, the contract uses mappings. [Mappings](https://medium.com/upstate-interactive/mappings-in-solidity-explained-in-under-two-minutes-ecba88aff96e) are unique key-value pair data structures similar to hash tables in Java.
+
```solidity
mapping(uint256 => address) private s_rollers;
mapping(address => uint256) private s_results;
@@ -135,31 +125,31 @@ mapping(address => uint256) private s_results;
The coordinator and subscription id must be initialized in the `constructor` of the contract. To use `VRFConsumerBaseV2` properly, you must also pass the VRF coordinator address into its constructor.
The address that creates the smart contract is the owner of the contract. the modifier `onlyOwner()` checks that only the owner is allowed to do some tasks.
+
```solidity
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.7;
-import '@chainlink/contracts/src/v0.8/interfaces/VRFCoordinatorV2Interface.sol';
-import '@chainlink/contracts/src/v0.8/VRFConsumerBaseV2.sol';
+import "@chainlink/contracts/src/v0.8/interfaces/VRFCoordinatorV2Interface.sol";
+import "@chainlink/contracts/src/v0.8/VRFConsumerBaseV2.sol";
contract VRFD20 is VRFConsumerBaseV2 {
- // variables
- // ...
-
- // constructor
- constructor(uint64 subscriptionId) VRFConsumerBaseV2(vrfCoordinator) {
- COORDINATOR = VRFCoordinatorV2Interface(vrfCoordinator);
- s_owner = msg.sender;
- s_subscriptionId = subscriptionId;
- }
-
- //...
- modifier onlyOwner() {
- require(msg.sender == s_owner);
- _;
- }
+ // variables
+ // ...
+
+ // constructor
+ constructor(uint64 subscriptionId) VRFConsumerBaseV2(vrfCoordinator) {
+ COORDINATOR = VRFCoordinatorV2Interface(vrfCoordinator);
+ s_owner = msg.sender;
+ s_subscriptionId = subscriptionId;
+ }
+
+ //...
+ modifier onlyOwner() {
+ require(msg.sender == s_owner);
+ _;
+ }
}
-
```
### `rollDice` function
@@ -175,45 +165,44 @@ You must add a `ROLL_IN_PROGRESS` constant to signify that the dice has been rol
Only the owner of the contract can execute the `rollDice` function.
+
```solidity
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.7;
-import '@chainlink/contracts/src/v0.8/interfaces/VRFCoordinatorV2Interface.sol';
-import '@chainlink/contracts/src/v0.8/VRFConsumerBaseV2.sol';
+import "@chainlink/contracts/src/v0.8/interfaces/VRFCoordinatorV2Interface.sol";
+import "@chainlink/contracts/src/v0.8/VRFConsumerBaseV2.sol";
contract VRFD20 is VRFConsumerBaseV2 {
- // variables
- uint256 private constant ROLL_IN_PROGRESS = 42;
- // ...
-
- // events
- event DiceRolled(uint256 indexed requestId, address indexed roller);
-
- // ...
-
- // ...
- // { constructor }
- // ...
-
- // rollDice function
- function rollDice(address roller) public onlyOwner returns (uint256 requestId) {
- require(s_results[roller] == 0, 'Already rolled');
- // Will revert if subscription is not set and funded.
- requestId = COORDINATOR.requestRandomWords(
- s_keyHash,
- s_subscriptionId,
- requestConfirmations,
- callbackGasLimit,
- numWords
- );
-
- s_rollers[requestId] = roller;
- s_results[roller] = ROLL_IN_PROGRESS;
- emit DiceRolled(requestId, roller);
- }
+ // variables
+ uint256 private constant ROLL_IN_PROGRESS = 42;
+ // ...
+
+ // events
+ event DiceRolled(uint256 indexed requestId, address indexed roller);
+ // ...
+
+ // ...
+ // { constructor }
+ // ...
+
+ // rollDice function
+ function rollDice(address roller) public onlyOwner returns (uint256 requestId) {
+ require(s_results[roller] == 0, "Already rolled");
+ // Will revert if subscription is not set and funded.
+ requestId = COORDINATOR.requestRandomWords(
+ s_keyHash,
+ s_subscriptionId,
+ requestConfirmations,
+ callbackGasLimit,
+ numWords
+ );
+
+ s_rollers[requestId] = roller;
+ s_results[roller] = ROLL_IN_PROGRESS;
+ emit DiceRolled(requestId, roller);
+ }
}
-
```
### `fulfillRandomWords` function
@@ -224,43 +213,44 @@ contract VRFD20 is VRFConsumerBaseV2 {
1. Assign the transformed value to the address in the `s_results` mapping variable.
1. Emit a `DiceLanded` event.
+
```solidity
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.7;
-import '@chainlink/contracts/src/v0.8/interfaces/VRFCoordinatorV2Interface.sol';
-import '@chainlink/contracts/src/v0.8/VRFConsumerBaseV2.sol';
+import "@chainlink/contracts/src/v0.8/interfaces/VRFCoordinatorV2Interface.sol";
+import "@chainlink/contracts/src/v0.8/VRFConsumerBaseV2.sol";
contract VRFD20 is VRFConsumerBaseV2 {
- // ...
- // { variables }
- // ...
+ // ...
+ // { variables }
+ // ...
- // events
- // ...
- event DiceLanded(uint256 indexed requestId, uint256 indexed result);
+ // events
+ // ...
+ event DiceLanded(uint256 indexed requestId, uint256 indexed result);
- // ...
- // { constructor }
- // ...
+ // ...
+ // { constructor }
+ // ...
- // ...
- // { rollDice function }
- // ...
+ // ...
+ // { rollDice function }
+ // ...
- // fulfillRandomWords function
- function fulfillRandomWords(uint256 requestId, uint256[] memory randomWords) internal override {
- // transform the result to a number between 1 and 20 inclusively
- uint256 d20Value = (randomWords[0] % 20) + 1;
+ // fulfillRandomWords function
+ function fulfillRandomWords(uint256 requestId , uint256[] memory randomWords) internal override {
- // assign the transformed value to the address in the s_results mapping variable
- s_results[s_rollers[requestId]] = d20Value;
+ // transform the result to a number between 1 and 20 inclusively
+ uint256 d20Value = (randomWords[0] % 20) + 1;
- // emitting event to signal that dice landed
- emit DiceLanded(requestId, d20Value);
- }
-}
+ // assign the transformed value to the address in the s_results mapping variable
+ s_results[s_rollers[requestId]] = d20Value;
+ // emitting event to signal that dice landed
+ emit DiceLanded(requestId, d20Value);
+ }
+}
```
### `house` function
@@ -269,89 +259,89 @@ Finally, the `house` function returns the house of an address.
To have a list of the house's names, create the `getHouseName` function that is called in the `house` function.
+
```solidity
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.7;
-import '@chainlink/contracts/src/v0.8/interfaces/VRFCoordinatorV2Interface.sol';
-import '@chainlink/contracts/src/v0.8/VRFConsumerBaseV2.sol';
+import "@chainlink/contracts/src/v0.8/interfaces/VRFCoordinatorV2Interface.sol";
+import "@chainlink/contracts/src/v0.8/VRFConsumerBaseV2.sol";
contract VRFD20 is VRFConsumerBaseV2 {
- // ...
- // { variables }
- // ...
-
- // ...
- // { events }
- // ...
-
- // ...
- // { constructor }
- // ...
-
- // ...
- // { rollDice function }
- // ...
-
- // ...
- // { fulfillRandomWords function }
- // ...
-
- // house function
- function house(address player) public view returns (string memory) {
- // dice has not yet been rolled to this address
- require(s_results[player] != 0, 'Dice not rolled');
-
- // not waiting for the result of a thrown dice
- require(s_results[player] != ROLL_IN_PROGRESS, 'Roll in progress');
-
- // returns the house name from the name list function
- return getHouseName(s_results[player]);
- }
-
- // getHouseName function
- function getHouseName(uint256 id) private pure returns (string memory) {
- // array storing the list of house's names
- string[20] memory houseNames = [
- 'Targaryen',
- 'Lannister',
- 'Stark',
- 'Tyrell',
- 'Baratheon',
- 'Martell',
- 'Tully',
- 'Bolton',
- 'Greyjoy',
- 'Arryn',
- 'Frey',
- 'Mormont',
- 'Tarley',
- 'Dayne',
- 'Umber',
- 'Valeryon',
- 'Manderly',
- 'Clegane',
- 'Glover',
- 'Karstark'
- ];
-
- // returns the house name given an index
- return houseNames[id.sub(1)];
- }
+ // ...
+ // { variables }
+ // ...
+
+ // ...
+ // { events }
+ // ...
+
+ // ...
+ // { constructor }
+ // ...
+
+ // ...
+ // { rollDice function }
+ // ...
+
+ // ...
+ // { fulfillRandomWords function }
+ // ...
+
+ // house function
+ function house(address player) public view returns (string memory) {
+ // dice has not yet been rolled to this address
+ require(s_results[player] != 0, "Dice not rolled");
+
+ // not waiting for the result of a thrown dice
+ require(s_results[player] != ROLL_IN_PROGRESS, "Roll in progress");
+
+ // returns the house name from the name list function
+ return getHouseName(s_results[player]);
+ }
+
+ // getHouseName function
+ function getHouseName(uint256 id) private pure returns (string memory) {
+ // array storing the list of house's names
+ string[20] memory houseNames = [
+ "Targaryen",
+ "Lannister",
+ "Stark",
+ "Tyrell",
+ "Baratheon",
+ "Martell",
+ "Tully",
+ "Bolton",
+ "Greyjoy",
+ "Arryn",
+ "Frey",
+ "Mormont",
+ "Tarley",
+ "Dayne",
+ "Umber",
+ "Valeryon",
+ "Manderly",
+ "Clegane",
+ "Glover",
+ "Karstark"
+ ];
+
+ // returns the house name given an index
+ return houseNames[id.sub(1)];
+ }
}
-
```
You have now completed all necessary functions to generate randomness and assign the user a _Game of Thrones_ house. We've added a few helper functions in there to make using the contract easier and more flexible. You can deploy and interact with the complete contract in Remix.
-## 5. How do I deploy to testnet?
+## How do I deploy to testnet?
-You will now deploy your completed contract. This deployment is slightly different than the example in the [Deploy Your First Contract](/docs/deploy-your-first-contract/) guide. In our case, you will have to pass in parameters to the constructor upon deployment.
+You will now deploy your completed contract. This deployment is slightly different than the example in the [Deploy Your First Contract](/getting-started/deploy-your-first-contract/) guide. In our case, you will have to pass in parameters to the constructor upon deployment.
Once compiled, you'll see a dropdown menu that looks like this in the deploy pane:
@@ -365,27 +355,27 @@ Click the caret arrow on the right hand side of **Deploy** to expand the paramet
Then click the `Deploy` button and use your Metamask account to confirm the transaction.
-**Note**: You should [have some Goerli ETH](/docs/deploy-your-first-contract/#install-and-fund-your-metamask-wallet) in your Metamask account to pay for the GAS.
+**Note**: You should [have some Goerli ETH](/getting-started/deploy-your-first-contract/#install-and-fund-your-metamask-wallet) in your Metamask account to pay for the GAS.
-> 📘 Address, Key Hashes and more
->
-> For a full reference of the addresses, key hashes and fees for each network, see [VRF v2 Subscription method - Supported Networks](/docs/vrf/v2/subscription/supported-networks/#configurations).
+:::note[ Address, Key Hashes and more]
+For a full reference of the addresses, key hashes and fees for each network, see [VRF Supported Networks](/vrf/v2/subscription/supported-networks/#configurations).
+:::
At this point, your contract should be successfully deployed. However, it can't request anything because it is not yet approved to use the LINK balance in your subscription. If you click `rollDice`, the transaction will revert.
-## 6. How do I add my contract to my subscription account?
+## How do I add my contract to my subscription account?
After you deploy your contract, you must add it as an approved consumer contract so it can use the subscription balance when requesting for randomness. Go to the [Subscription Manager](https://vrf.chain.link) and add your deployed contract address to the list of consumers. Find your contract address in Remix under **Deployed Contracts** on the bottom left.
-## 7. How do I test `rollDice`?
+## How do I test `rollDice`?
After you open the deployed contract tab in the bottom left, the function buttons are available. Find `rollDice` and click the caret to expand the parameter fields. Enter an Ethereum address to specify a "dice roller", and click 'rollDice'.
You will have to wait a few minutes for your transaction to confirm and the response to be sent back. You can get your house by clicking the `house` function button with the address passed in `rollDice`. After the response is sent back, you'll be assigned a _Game of Thrones_ house!
-## 8. Further Reading
+## Further Reading
To read more about generating random numbers in Solidity, read our blog posts:
diff --git a/docs/getting-started/other-tutorials.md b/src/pages/getting-started/other-tutorials.md
similarity index 79%
rename from docs/getting-started/other-tutorials.md
rename to src/pages/getting-started/other-tutorials.md
index b3f35b0ab6f..4f5f89a90b1 100644
--- a/docs/getting-started/other-tutorials.md
+++ b/src/pages/getting-started/other-tutorials.md
@@ -1,27 +1,11 @@
---
-layout: nodes.liquid
+layout: ../../layouts/MainLayout.astro
section: gettingStarted
date: Last Modified
title: "Learning Resources"
-permalink: "docs/other-tutorials/"
---
-Welcome to the Resources page. This is a list of links and pages that you might need to help you throughout your learning journey. If you're new to Chainlink, start with the [Getting Started](/docs/conceptual-overview/) guide to better understand the products and services Chainlink offers. This page contains more resources, inspiration, and outreach information to further your learning.
-
-**Topics**
-
-+ [Smart contract learning materials](#smart-contract-learning-materials)
- + [Video tutorials](#video-tutorials)
- + [Applications](#applications)
- + [Game resources](#game-resources)
- + [Coding bootcamps](#coding-bootcamps)
- + [Starter kits](#starter-kits)
- + [External tutorials](#external-tutorials)
- + [More inspiration](#more-inspiration)
-+ [Outreach](#outreach)
- + [Get support](#get-support)
- + [Join the community](#join-the-community)
-
+Welcome to the Resources page. This is a list of links and pages that you might need to help you throughout your learning journey. If you're new to Chainlink, start with the [Getting Started](/getting-started/conceptual-overview/) guide to better understand the products and services Chainlink offers. This page contains more resources, inspiration, and outreach information to further your learning.
## Smart contract learning materials
@@ -42,35 +26,37 @@ We're constantly uploading new videos to our [YouTube](https://www.youtube.com/c
- [Nader Dabit](https://www.youtube.com/watch?v=nS9xP1hxg3w)
### Applications
+
Below is a list of applications of Chainlink's products and services sorted by difficulty and type to help you navigate and search for projects that you might find interesting. See the [Chainlink Blog](https://blog.chain.link/) to stay up to date with new ways to use Chainlink.
#### Data feeds
-| Name | Type | Difficulty |
-|:-------------------------------------------------------------------------------------------------------------------------------------------------- |:-------- |:---------- |
-| [How to Calculate Price Volatility for DeFi Variance Swaps](https://blog.chain.link/how-to-calculate-price-volatility-for-defi-variance-swaps/) | DeFi | Advanced |
-| [Build a dApp on Gnosis Chain (xDai) with Secure Data Feeds](https://blog.chain.link/build-a-dapp-on-xdai-chain-with-secure-data-feeds/) | DeFi | Medium |
-| [Craft Whiskey Crypto Payments With Chainlink Oracles](https://blog.chain.link/craft-whiskey-crypto-payments-with-chainlink-oracles/) | Payments | Advanced |
+
+| Name | Type | Difficulty |
+| :------------------------------------------------------------------------------------------------------------------------------------------------ | :------- | :--------- |
+| [How to Calculate Price Volatility for DeFi Variance Swaps](https://blog.chain.link/how-to-calculate-price-volatility-for-defi-variance-swaps/) | DeFi | Advanced |
+| [Build a dApp on Gnosis Chain (xDai) with Secure Data Feeds](https://blog.chain.link/build-a-dapp-on-xdai-chain-with-secure-data-feeds/) | DeFi | Medium |
+| [Craft Whiskey Crypto Payments With Chainlink Oracles](https://blog.chain.link/craft-whiskey-crypto-payments-with-chainlink-oracles/) | Payments | Advanced |
| [Convert a Vending Machine to Accept Cryptocurrency Payments Using Chainlink Data Feeds](https://blog.chain.link/cryptocurrency-vending-machine/) | Payments | Advanced |
-| [Build a dApp on BNB Chain With Secure Data Feeds](https://blog.chain.link/build-a-dapp-on-binance-smart-chain-with-secure-data-feeds/) | DeFi | Medium |
-| [How to Use Chainlink With Hardhat](https://blog.chain.link/using-chainlink-with-hardhat/) | DeFi | Medium |
-| [Develop a DeFi Project Using Python](https://blog.chain.link/develop-python-defi-project/) | DeFi | Medium |
+| [Build a dApp on BNB Chain With Secure Data Feeds](https://blog.chain.link/build-a-dapp-on-binance-smart-chain-with-secure-data-feeds/) | DeFi | Medium |
+| [How to Use Chainlink With Hardhat](https://blog.chain.link/using-chainlink-with-hardhat/) | DeFi | Medium |
+| [Develop a DeFi Project Using Python](https://blog.chain.link/develop-python-defi-project/) | DeFi | Medium |
| [Build a DeFi Call Option Exchange With Chainlink Data Feeds](https://blog.chain.link/defi-call-option-exchange-in-solidity/) | DeFi | Advanced |
| [Build a DeFi Yield Farming dApp Using Chainlink Data Feeds](https://blog.chain.link/build-defi-yield-farming-application-with-chainlink/) | DeFi | Advanced |
| [Build and Deploy an Avalanche Smart Contract](https://blog.chain.link/how-to-build-and-deploy-an-avalanche-smart-contract/) | DeFi | Beginner |
-
#### Randomness (VRF)
-| Name | Type | Difficulty |
-|:------------------------------------------------------------------------------------------------------- |:-------- |:---------- |
-| [How to Get a Random Number on Polygon](https://blog.chain.link/how-to-get-a-random-number-on-polygon/) | DeFi | Medium |
-| [Build Your Own Dynamic NFT With Hardhat](https://blog.chain.link/dynamic-nft-hardhat/) | NFT | Advanced |
-| [Build, Deploy, and Sell Your Own Dynamic NFT](https://blog.chain.link/build-deploy-and-sell-your-own-dynamic-nft/) | NFT | Advanced |
-| [How to Build a Blockchain Lottery](https://blog.chain.link/how-to-build-a-blockchain-lottery-2/) | Gambling | Advanced |
+
+| Name | Type | Difficulty |
+| :------------------------------------------------------------------------------------------------------------------ | :------- | :--------- |
+| [How to Get a Random Number on Polygon](https://blog.chain.link/how-to-get-a-random-number-on-polygon/) | DeFi | Medium |
+| [Build Your Own Dynamic NFT With Hardhat](https://blog.chain.link/dynamic-nft-hardhat/) | NFT | Advanced |
+| [Build, Deploy, and Sell Your Own Dynamic NFT](https://blog.chain.link/build-deploy-and-sell-your-own-dynamic-nft/) | NFT | Advanced |
+| [How to Build a Blockchain Lottery](https://blog.chain.link/how-to-build-a-blockchain-lottery-2/) | Gambling | Advanced |
#### API requests
| Name | Type | Difficulty |
-| -------------------------------------------------------------------------------------------------------------------------------------------------------------- |:-------------------- |:---------- |
+| -------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------- | :--------- |
| [Build a Real Estate dApp With Chainlink Oracles](https://blog.chain.link/build-a-real-estate-dapp-with-chainlink-oracles/) | Real-Estate | Medium |
| [Off-Chain Computation: Statistical Analysis With Chainlink](https://blog.chain.link/off-chain-computation-statistical-analysis-with-chainlink/) | Statistical Analysis | Advanced |
| [Blockchain Fintech Tutorial: Lending and Borrowing With Python](https://blog.chain.link/blockchain-fintech-defi-tutorial-lending-borrowing-python/) | Lending | Medium |
@@ -82,21 +68,21 @@ Below is a list of applications of Chainlink's products and services sorted by d
| [Connect a Smart Contract to the Twitter API](https://blog.chain.link/connect-smart-contract-to-twitter-api/) | Social Media | Advanced |
| [Build an RFID Blockchain Integration With Chainlink External Adapters](https://blog.chain.link/rfid-blockchain-integration-with-chainlink-external-adapters/) | Identification | Advanced |
| [How to Connect a Tesla Vehicle API to a Smart Contract Via a Chainlink External Adapter](https://blog.chain.link/create-tesla-smart-contract-rental/) | Transportation | Advanced |
-| [OAuth and API Authentication in Smart Contracts](https://blog.chain.link/oauth-and-api-authentication-in-smart-contracts-2/) | Security | Advanced |
+| [OAuth and API Authentication in Smart Contracts](https://blog.chain.link/oauth-and-api-authentication-in-smart-contracts-2/) | Security | Advanced |
#### Automation (Keepers)
-| Name | Type | Difficulty |
-| -------------------------------------------------------------------------------------------------------------------------------------------------------------- |:-------------------- |:---------- |
-| [Smart Contract Automation Master Class Module #1](https://youtu.be/D3rMFshrj7c) | Automation | Beginner |
-| [Smart Contract Automation Master Class Module #2](https://youtu.be/UT2qpUh0tmA/) | Automation | Beginner |
-| [Entropyfi Saves Engineering Hours with Chainlink Keepers](https://medium.com/entropyfi/entropyfi-saves-engineering-hours-with-chainlink-keepers-6ec172a76249) | Gaming | Medium |
-| [Enabling Limit Orders on CivTrade With Chainlink Keepers](https://news.civfund.org/civtrade-with-chainlink-keepers-8b6c3965a92e) | Trading | Medium |
-| [Pickle Finance UniV3 Jars Powered by Chainlink Keepers](https://picklefinance.medium.com/pickle-finance-univ3-jars-powered-by-chainlink-keepers-8ce1756a2497) | Finance | Medium |
-| [JamonSwap Introduces New Limit Order Functionality Using Chainlink Keepers](https://medium.com/@JamonSwap/jamonswap-introduces-new-limit-order-functionality-using-chainlink-keepers-51bd94d75feb) | DeFi | Medium |
-| [How Cratos used Chainlink Keepers to automate the token vesting process](https://cratostoken.medium.com/how-cratos-used-chainlink-keepers-to-automate-the-token-vesting-process-69bcb3611161) | DeFi | Medium |
-| [Enabling automated NFT lotteries with Chainlink Keepers and VRF](https://czodiac.medium.com/enabling-automated-nft-lotteries-with-chainlink-keepers-and-vrf-34dcc191965b) | NFT | Medium |
-| [How ApeSwap Integrated Chainlink Keepers for BANANA Maximizer Vaults](https://ape-swap.medium.com/how-apeswap-integrated-chainlink-keepers-for-banana-maximizer-vaults-2e88abb34eca) | DeFi | Medium |
+| Name | Type | Difficulty |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------- | :--------- |
+| [Smart Contract Automation Master Class Module #1](https://youtu.be/D3rMFshrj7c) | Automation | Beginner |
+| [Smart Contract Automation Master Class Module #2](https://youtu.be/UT2qpUh0tmA/) | Automation | Beginner |
+| [Entropyfi Saves Engineering Hours with Chainlink Keepers](https://medium.com/entropyfi/entropyfi-saves-engineering-hours-with-chainlink-keepers-6ec172a76249) | Gaming | Medium |
+| [Enabling Limit Orders on CivTrade With Chainlink Keepers](https://news.civfund.org/civtrade-with-chainlink-keepers-8b6c3965a92e) | Trading | Medium |
+| [Pickle Finance UniV3 Jars Powered by Chainlink Keepers](https://picklefinance.medium.com/pickle-finance-univ3-jars-powered-by-chainlink-keepers-8ce1756a2497) | Finance | Medium |
+| [JamonSwap Introduces New Limit Order Functionality Using Chainlink Keepers](https://medium.com/@JamonSwap/jamonswap-introduces-new-limit-order-functionality-using-chainlink-keepers-51bd94d75feb) | DeFi | Medium |
+| [How Cratos used Chainlink Keepers to automate the token vesting process](https://cratostoken.medium.com/how-cratos-used-chainlink-keepers-to-automate-the-token-vesting-process-69bcb3611161) | DeFi | Medium |
+| [Enabling automated NFT lotteries with Chainlink Keepers and VRF](https://czodiac.medium.com/enabling-automated-nft-lotteries-with-chainlink-keepers-and-vrf-34dcc191965b) | NFT | Medium |
+| [How ApeSwap Integrated Chainlink Keepers for BANANA Maximizer Vaults](https://ape-swap.medium.com/how-apeswap-integrated-chainlink-keepers-for-banana-maximizer-vaults-2e88abb34eca) | DeFi | Medium |
### Game resources
@@ -128,11 +114,11 @@ Our Starter Kits help jumpstart your full-stack development process. You can get
Looking for more ways to use Chainlink? Here are some resources that discuss Chainlink's use cases as well as the winning projects we've had in our previous hackathons. There is also a link to the Marketplace where you can find the latest data provider nodes and explore the network.
- [77 Use Cases by Chainlink](https://blog.chain.link/44-ways-to-enhance-your-smart-contract-with-chainlink/)
-- [Past Hackathon Winning Projects](/docs/example-projects)
+- [Past Hackathon Winning Projects](/resources/example-projects/)
## Outreach
-The Chainlink community is an inviting group of engineers that is always looking to help users expand their knowledge on Chainlink and solve related issues. Refer back to the [Getting Help](/docs/getting-help) page for the latest information about how to get support.
+The Chainlink community is an inviting group of engineers that is always looking to help users expand their knowledge on Chainlink and solve related issues. Refer back to the [Getting Help](/resources/getting-help/) page for the latest information about how to get support.
### Get support
diff --git a/src/pages/index.astro b/src/pages/index.astro
new file mode 100644
index 00000000000..95c47e8ce8a
--- /dev/null
+++ b/src/pages/index.astro
@@ -0,0 +1,31 @@
+---
+import NodesCTA from "../features/landing/sections/NodesCTA.astro"
+import ProductTabs from "../features/landing/sections/ProductTabs.astro"
+import LinksCTA from "../features/landing/sections/LinksCTA.astro"
+import ResourcesCTA from "../features/landing/sections/ResourcesCTA.astro"
+import LandingLayout from "../layouts/LandingLayout.astro"
+import TutorialsCTA from "../features/landing/sections/TutorialsCTA.astro"
+import HeroCTA from "../features/landing/sections/HeroCTA.astro"
+import NewUserCTA from "~/features/landing/sections/NewUserCTA.astro"
+---
+
+
+
+
+
diff --git a/src/pages/rc.mdx b/src/pages/rc.mdx
new file mode 100644
index 00000000000..7d73db22304
--- /dev/null
+++ b/src/pages/rc.mdx
@@ -0,0 +1,203 @@
+---
+layout: ../layouts/MainLayout.astro
+section: gettingStarted
+date: Last Modified
+title: "Overview"
+excerpt: "Smart Contracts"
+whatsnext:
+ {
+ "Deploy Your First Smart Contract": "/getting-started/deploy-your-first-contract/",
+ "Consuming Data Feeds": "/getting-started/consuming-data-feeds/",
+ }
+clientSideToc: false
+---
+
+import { Aside, ClickToZoom, CodeSample } from "@components"
+import { Tabs } from "@components/Tabs"
+
+test heading
+
+
+ web3.js
+ ethers.js
+
+
+
+
+
+
+on our Wiki .
+
+### External Adapter
+
+[External adapters](https://github.com/smartcontractkit/chainlink/wiki/External-Adapters) are what make Chainlink easily extensible, providing simple integration of custom computations and specialized APIs.
+
+A Chainlink node communicates with external adapters by sending a POST request with a JSON data payload. More information can be found on the external adapter [page](/chainlink-nodes/external-adapters/external-adapters).
+
+### Function Selector
+
+A [function selector](https://docs.soliditylang.org/en/develop/abi-spec.html#function-selector) specifies the function to be called in Ethereum. It is the first four bytes of the call data for a function call in an Ethereum transaction. Solidity contracts have a built-in helper method to access the function selector by using `this.myFunction.selector`, where `myFunction` is a non-overloaded function in the contract.
+
+### Initiator
+
+:::danger[ The initiators for v1 Jobs are removed for Chainlink nodes running version 1.0.0 and later. Use the [v2 job types](/chainlink-nodes/oracle-jobs/jobs/) instead.]
+
+:::
+
+Triggers the execution of a [Job Spec](#job-spec).
+
+### Job
+
+Short-hand for a [Job Spec](#job-spec).
+
+### Job Run
+
+The Job Run is the artifact documenting the outcome of executing a [Job](#job). The Job Run is made up of a [Task](#task) and a [Run Result](#run-result) representing the ultimate outcome of the Job Run.
+
+### JobID
+
+The ID associated to a given [Job Spec](#job-spec). This will be unique per-node, even with the same contents within the spec itself.
+
+### Job Spec
+
+The [Job Specification](/chainlink-nodes/oracle-jobs/jobs/) is the specification of a piece of work to be completed by an Oracle Node. The Job Spec is made up of two main parts:
+
+- The [Task Type](/chainlink-nodes/oracle-jobs/jobs#shared-fields) or the [External Initiator](/chainlink-nodes/external-initiators/external-initiators-introduction/): Defines the ways a Job can be triggered to execute.
+- The [Task list](#task-spec): The `tasks` that specify all of the computation steps to perform when executing a Job Spec. The Task list is sometimes referred to as the [Job Pipeline](/chainlink-nodes/oracle-jobs/task-types/pipelines) because all of the Tasks' operations are performed in order, with the result being fed into the next task.
+
+### Oracle
+
+Entity which connects computations on blockchains with off-chain resources. Typically made up of two components: the [Oracle Node](#oracle-node) (off-chain) and the [Oracle Contract](#oracle-contract) (on-chain).
+
+### Oracle Contract
+
+The on-chain component of an [Oracle](#oracle). The Oracle Contract is the interface through which [Consuming Contracts](#consumer-contract) pass and receive data with off-chain resources.
+
+### Oracle Node
+
+The off-chain component of an [Oracle](#oracle).
+
+### Phase
+
+For data feeds, a phase indicates the underlying aggregator implementation has been updated. Phases are relevant only for the EACAggregatorProxys. You can think of a roundId on the proxies as a large number containing data for two numbers (phaseId + roundId). The roundId is pulled from the aggregator's implementation and combined by bit shifting with the latest phaseId of the proxy.
+
+### Requester
+
+A Smart Contract or Externally Owned Account which requests data from an [Oracle](#oracle). The Requester does not have to be the same entity as the [Consumer](#consumer-contract) but commonly is the same.
+
+### Run Result
+
+A Run Result is the result of executing a [Job Spec](#job-spec).
+
+### Run Status
+
+Each [Job Run](#job) has a status field indicating its current progress. The Run Status can be in one of the [following states](https://godoc.org/github.com/smartcontractkit/chainlink/core/store/models/#pkg-constants):
+
+- Unstarted
+- In Progress
+- Pending Confrimations
+- Pending Bridge
+- Pending Sleep
+- Errored
+- Completed
+
+### SAID
+
+The ID associated with a given [Service Agreement](#service-agreement).
+
+### Service Agreement
+
+The Service agreement consists of a [Job Spec](#job-spec) and a set of [encumbrance parameters](#encumbrance-parameters) that is shared among a creator and multiple Chainlink nodes. Information on service agreements can be found [on our Wiki](https://github.com/smartcontractkit/chainlink/wiki/Service-Agreements-and-the-Coordinator-Contract).
+
+### Spec
+
+Another short-hand for a [Job Spec](#job-spec).
+
+### Task
+
+A v2 job [task](/chainlink-nodes/oracle-jobs/task-types/tasks/).
+
+### Task Spec
+
+The Task Spec is the definition for an individual task to be performed within the [job specification](/chainlink-nodes/oracle-jobs/jobs/) by a specific adapter. The Task Spec always includes a `type` field which specifies which [adapter](#adapter) will execute it. Optionally, a Task Spec can specify additional `params` which will be passed on to its adapter, and `confirmations` which specify how many confirmations a [Task Run](#task-run) needs before executing.
+
+### Task Run
+
+The result of the individual [Task Spec](#task-spec)'s execution. A Task Run includes the Task Spec that it used for input and the [Run Result](#run-result) which was the output of the execution.
diff --git a/src/pages/resources/hackathon-resources.md b/src/pages/resources/hackathon-resources.md
new file mode 100644
index 00000000000..5f4af48c224
--- /dev/null
+++ b/src/pages/resources/hackathon-resources.md
@@ -0,0 +1,73 @@
+---
+layout: ../../layouts/MainLayout.astro
+section: ethereum
+date: Last Modified
+title: "Hackathon Resources"
+permalink: "docs/hackathon-resources/"
+---
+
+:::note[ Note on Resources]
+
+For a comprehensive list of resources, refer to the [Learning Resources](/getting-started/other-tutorials/) page.
+
+:::
+
+### Hackathon & Project Resources
+
+If you're looking to just start jumping into stuff, here is a directory that can help you out.
+
+# Want to check out winners code of past hackathons to get some inspiration?
+
+Check out the example winners projects here.
+
+## Boilerplate code, and starter kits
+
+Be sure to check the docs above for remix examples!
+
+- [Chainlink Brownie Starter Kit (Python)](https://github.com/smartcontractkit/chainlink-mix)
+- [Chainlink Truffle Starter Kit (Javascript)](https://github.com/smartcontractkit/truffle-starter-kit)
+- [Chainlink Hardhat Starter Kit (Javascript)](https://github.com/smartcontractkit/hardhat-starter-kit)
+
+## Support Communications
+
+Always refer back to the [getting help](/resources/getting-help) page for the latest information about how to get support.
+
+- [Getting Help](/resources/getting-help)
+- [Stack Overflow](https://stackoverflow.com/questions/tagged/chainlink)
+- [Stack Exchange Ethereum](https://ethereum.stackexchange.com/questions/tagged/chainlink)
+- [Hackathon Discord](https://discord.gg/h3AvTHj)
+- [Developer Discord](https://discord.gg/2YHSAey)
+
+## Tutorials
+
+Be sure to check the documentation in the links above for in depth-descriptions of everything.
+
+New? See the [Getting Started Guide](/getting-started/conceptual-overview/).
+
+- [Video Tutorials](https://www.youtube.com/playlist?list=PLVP9aGDn-X0QwJVbQvuKr-zrh2_DV5M6J)
+- [What is Ethereum?](https://www.youtube.com/playlist?list=PLVP9aGDn-X0QwJVbQvuKr-zrh2_DV5M6J)
+- [Developer Blog (many tutorials)](https://blog.chain.link/tag/developers/)
+- [Testing Chainlink Smart Contracts](https://blog.chain.link/testing-chainlink-smart-contracts/)
+- [NFTs and Chainlink](https://blog.chain.link/build-deploy-and-sell-your-own-dynamic-nft/)
+- [Build an external adapter](/chainlink-nodes/external-adapters/developers/)
+
+## Inspiration
+
+- [77 Use Cases by Chainlink](https://blog.chain.link/44-ways-to-enhance-your-smart-contract-with-chainlink/)
+- [Past winners & code](/resources/example-projects/)
+- [Chainlink docs](/)
+
+### The chainlink community is some of the most inviting groups of engineers always looking to help you grow to the next stage.
+
+# Join the community
+
+- [Twitter](https://mobile.twitter.com/chainlink)
+- [Reddit](https://www.reddit.com/r/Chainlink/)
+- [Telegram](https://t.me/chainlinkofficial)
+- [Blog](https://blog.chain.link)
+
+## Blockchain Specific
+
+- [Matic Data Feeds](/data-feeds/price-feeds/addresses/?network=polygon)
+- [BNB Chain Data Feeds](/data-feeds/price-feeds/addresses/?network=bnb-chain)
+- [Conflux](https://github.com/Conflux-Network-Global/demo-cfx-chainlink)
diff --git a/src/pages/resources/hackathon-rules-waiver-and-release.md b/src/pages/resources/hackathon-rules-waiver-and-release.md
new file mode 100644
index 00000000000..c44678ff35a
--- /dev/null
+++ b/src/pages/resources/hackathon-rules-waiver-and-release.md
@@ -0,0 +1,61 @@
+---
+layout: ../../layouts/MainLayout.astro
+section: ethereum
+date: Last Modified
+title: "Hackathon Rules, Waiver & Release, and Code of Conduct"
+permalink: "docs/hackathon-rules-waiver-release-and-code-of-conduct/"
+---
+
+**Code of Conduct**
+
+This event is a community hackathon intended for collaboration and learning in the Chainlink and broader blockchain communities. We value the participation of each member of the community and want all participants to have an enjoyable experience. Accordingly, all participants are expected to show respect and courtesy to other participants throughout the hackathon. To make clear what is expected, all participants of this hackathon are required to conform to the following Code of Conduct. Organizers will enforce this code throughout the event.
+
+##### **The Code**
+
+The spirit of The Code is to prohibit activities including but not limited to:
+
+- Comments that others find offensive
+- Cheating or taking unfair advantage of other participants’ work or efforts
+- Any activity related to harassing, demeaning, mocking, or intimidating others, especially this behavior as it relates to characteristics such as:
+ - Gender
+ - Sexual orientation
+ - Physical or mental ability
+ - Age
+ - Socioeconomic status
+ - Ethnicity
+ - Physical appearance
+ - Race
+ - Religion
+ - Country of origin
+- Examples of other prohibited behaviors include, but are not limited to:
+ - Stalking
+ - Unwanted sexual attention
+ - Use of sexualized content
+
+Participants asked to stop any behavior deemed as harassment are expected to comply immediately. If a participant fails to comply they will be asked to leave the event. Sponsors, judges, mentors, volunteers, organizers, Chainlink team, and anyone else at the event are also subject to the Code.
+
+If a participant engages in behavior that violates the Code, the hackathon organizers will take any action they deem appropriate, including warning the offender or expelling them from the event.
+
+If you feel uncomfortable or think there may be a potential violation of the code of conduct, please report it immediately to one of the event organizers or by emailing us at legal@chain.link. All reporters have the right to remain anonymous.
+
+##### **Event Rules & Conditions**
+
+1. The following rules & conditions (the “Rules”) apply to this Chainlink hackathon (the “Event"). By clicking the “I Accept” button, you acknowledge that you have read these Rules, understand them, and agree to be bound as follows:
+1. You assume full responsibility for any damage or injury caused by you in your participation in the Event (whether to persons or property, and whether to yourself or others) and release SmartContract Chainlink Limited SEZC (and its affiliates) (“Chainlink”), the Event, the organizers of the Event (the “Organizers”), all sponsors of the Event (“Sponsors”), the Event volunteers and the Event staff, (collectively, the “Releasees”) from any liability therefore. **YOU ARE AWARE THAT YOUR PARTICIPATION IN THE EVENT IS SOLELY AT YOUR OWN RISK, AND THAT THE RELEASE HEREIN IS INTENDED TO REFLECT THAT UNDERSTANDING**
+1. You will own any developments that you create during the Event, and all right, title and interest in those developments, including the intellectual property rights therein, shall belong to you. However, you acknowledge that during the course of the Event, you may obtain access to products, developments, information and other materials belonging to Chainlink, other participants of the Event, the Sponsors and/or other third parties (“Third Party Materials”), and that nothing in this Agreement is deemed to transfer any ownership, right, title or interest in such Third Party Materials to you. Your only rights to the Third Party Materials shall be those expressly granted to you by the owner(s) of the Third Party Materials. Specifically, any APIs or other software provided to you by the Sponsors are subject to the subscription terms and software licenses associated with such APIs or other software.
+1. By entering this Event, you represent and warrant that your participation complies with these Rules and that you have sufficient rights to (1) authorize the publication and dissemination of any submission materials and presentations (“Submitted Materials”); (2) allow the Organizers and Sponsors to use and to authorize others to use, publish and disseminate your Submitted Materials. Further, you are entirely responsible for your Submitted Materials, in whole or in part, if: (a) determined to be defamatory, offensive or otherwise inappropriate; (b) determined to violate any laws, rules or regulations; (c) determined to be infringing, or constitute a misappropriation of any intellectual property rights or confidential or proprietary information of any third party; or (d) determined to violate these Rules. Your Submitted Materials must be true and accurate and in compliance with these Rules in all regards. At any time, the Organizers at their sole discretion, reserve the right to remove your Submitted Materials from the Event, in whole or in part, for any violation of these Official Rules.
+1. You acknowledge that the Event is intended to be a place where ideas are shared freely, and therefore acknowledge that any information that you share with other participants of the Event, the Sponsors and/or other third parties during the Event is solely at your discretion and risk. If you wish to protect your information, it is solely your responsibility to implement confidentiality and security measures with respect to the persons to whom you are disclosing your information. None of the Releasees shall have any responsibility under this Agreement or by virtue of their participation in the Event with respect to your information.
+1. You acknowledge that the Organizers and Chainlink have the right to reject participants in the Event at their sole discretion.
+1. The Organizers have the unrestricted right to use your likeness, image, voice, opinions, and appearance, and also any images of your projects, developments, materials and belongings made at or brought to the Event, captured through video, photographs or other media during the Event for the express purpose of creating promotional material (the “Images”), for the purposes of use in websites, promotional materials, publications and other media of any of the Organizers, whether in print or electronically (the “Materials”). The foregoing right includes permission to copyright, use, re-use, publish, and republish Images in which you may be included, intact or in part, composite or distorted in character or form, without restriction as to changes or transformations, in conjunction with your own or a fictitious name, reproduction in color or otherwise, made through any and all media now or hereafter known;
+ 1. The Organizers shall solely own the Materials in which you or your Images, in whole or in part, may appear, including copyright interests, and you have no ownership rights therein;
+ 1. You give all clearances, copyright and otherwise, for use of your Images, and waive any moral rights that you may have in the Materials in which you or your Images may appear. The rights granted to the Organizers herein are perpetual and worldwide. For greater certainty, you agree that your images may continue to be used after the completion of the Event;
+ 1. You relinquish any right that you may have to examine or approve the Materials in which you or your Images may appear or the use to which they may be applied; and
+ 1. You hereby release, discharge and agree to save harmless each and all of the Organizers from any liability by virtue of any blurring, distortion, alteration, optical illusion, or use in composite form of the Images whether intentional or otherwise, that may occur or be produced in the recording of the Images or in any subsequent processing thereof, as well as any publication thereof, including without limitation any claims for libel or invasion of privacy.
+1. You agree that the Organizers may share your registration details, LinkedIn/Github profiles, details of your Hackathon submission, and other information obtained from you in the course of, or relating to, the Event with the Sponsors, and acknowledge that such Sponsors may contact you during and after the Event. By agreeing to this document and/or participating in the Event, you are providing your express consent to communications by the Organizers and Sponsors (including email communications, both marketing and informational) respecting the products and services of the Organizers and Sponsors, and future events.
+1. For valuable consideration, including permission to take part in the Event, you hereby covenant not to sue, and release, waive, and discharge the Releasees, their owners, officers, agents, affiliates, employees, volunteers, and/or any other person or entity in any way associated with the Event, from liability for any injury to your person or property or death arising out of or related to your participation in the Event, whether caused by an act of negligence of the Releasees or otherwise; and hereby assume full responsibility for any risk of bodily injury, death or property damage arising out of or related to your participation in the Event, whether occurring to you or to any other person or entity for whom you are responsible or with whom you are associated, and whether caused by an act of negligence of the Releasees or otherwise. The foregoing release includes, but is not limited to, any occurrences of personal injury, illness (food-borne or otherwise), and loss of belongings, whether by theft or otherwise. You further agree that this instrument (the terms of which collectively are referred to as the Rules) is intended to be as broad and inclusive as is permitted by the laws of the State of California and that if any portion thereof is held invalid, that portion shall be invalid only to the extent required by law, and the balance shall, notwithstanding, continue in full force and effect.
+1. You agree to indemnify and hold the Organizers and Sponsors (and judges, mentors, volunteers, organizers, Chainlink team administering the Event) and each of their employees, representatives, agents, attorneys, affiliates, directors, employees, officers, managers, and shareholders (the “Indemnified Parties”) harmless from any damage, loss, cost, or expense (including without limitation, attorneys’ fees and costs) incurred in connection with any third-party claim, demand, or action (“Claim”) brought or asserted against any of the Indemnified Parties, alleging facts or circumstances that would constitute a breach of any provision of the these Rules by you; arising from, related to, or connected with your entry, Submitted Materials, presentations and participation in any way in any aspect of Event , including receipt of any prize. If you are obligated to provide indemnification pursuant to this provision, the Indemnified Parties may, in their sole discretion, control the disposition of any claim at your sole cost and expense. Without limitation of the foregoing, you may not settle, compromise, or in any other manner dispose of any claim without the Organizers’s express written consent.
+1. If selected as a winner of a Chainlink award, your acceptance of the Chainlink award means you agree to the following:
+ 1. You will not disparage Chainlink or its products, services, agents, representatives, directors, officers, shareholders, attorneys, employees, vendors, business partners, affiliates, successors or assigns, or any person acting by, through, under or in concert with any of them, with any written or oral statement. Nothing in this paragraph shall prohibit the winner from providing truthful information in response to a valid subpoena or other legal process; however, the winning participant agrees to provide Company sufficient notice of such to allow Company the opportunity to oppose such subpoena or legal process prior to providing any information (unless expressly prohibited by applicable law).
+ 1. You agree that awards are subject to availability and Chainlink and the Sponsors reserve the right to substitute or withdraw any prize without giving notice at their sole discretion.
+ 1. Any media, such as a blog post, that is created about winning the Event, will first be shared with the Chainlink team beforehand so that we can coordinate and help you spread the message.
+ 1. You agree to an interview with a writer affiliated with the Chainlink team, which will result in featuring your project on the Chainlink website and sharing your project with the greater community.
diff --git a/src/pages/resources/link-token-contracts.md b/src/pages/resources/link-token-contracts.md
new file mode 100644
index 00000000000..5af3113e9c3
--- /dev/null
+++ b/src/pages/resources/link-token-contracts.md
@@ -0,0 +1,342 @@
+---
+layout: ../../layouts/MainLayout.astro
+section: ethereum
+date: Last Modified
+title: "LINK Token Contracts"
+permalink: "docs/link-token-contracts/"
+metadata:
+ title: "LINK Token Contracts"
+ description: "Addresses for the LINK token on supported networks."
+ linkToWallet: true
+ image:
+ 0: "/files/72d4bd9-link.png"
+---
+
+LINK tokens are used to pay node operators for retrieving data for smart contracts and also for deposits placed by node operators as required by contract creators. The smallest denomination of LINK is called a Juel, and 1,000,000,000,000,000,000 (1e18) Juels are equal to 1 LINK. This is similar to Wei, which is the [smallest denomination of ETH](https://ethereum.org/en/developers/docs/intro-to-ether/#denominations).
+
+The LINK token is an ERC677 token that inherits functionality from the ERC20 token standard and allows token transfers to contain a data payload. Read more about the [ERC677 transferAndCall token standard](https://github.com/ethereum/EIPs/issues/677).
+
+## Ethereum
+
+### Ethereum Mainnet
+
+| Parameter | Value |
+| :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `ETH_CHAIN_ID` | `1` |
+| Address | `0x514910771AF9Ca656af840dff83E8264EcF986CA` |
+| Name | Chainlink Token |
+| Symbol | LINK |
+| Decimals | 18 |
+| Network status | [ethstats.net](https://ethstats.net/) |
+
+### Goerli testnet
+
+Testnet LINK is available at [faucets.chain.link](https://faucets.chain.link/goerli). Testnet ETH is available at [goerlifaucet.com](https://goerlifaucet.com/) or the faucets listed at [faucetlink.to/goerli](https://faucetlink.to/goerli).
+
+| Parameter | Value |
+| :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `ETH_CHAIN_ID` | `5` |
+| Address | `0x326C977E6efc84E512bB9C30f76E30c160eD06FB` |
+| Name | Chainlink Token |
+| Symbol | LINK |
+| Decimals | 18 |
+
+## BNB Chain
+
+### BNB Chain mainnet
+
+BNB is used to pay for transactions on the BNB Chain mainnet.
+
+:::caution[ ERC-677 LINK on BNB Chain]
+
+The LINK provided by the [BNB Chain Bridge](https://www.bnbchain.world/en/bridge) is not ERC-677 compatible, so you cannot use it with Chainlink services or oracle nodes. Use the [**Chainlink PegSwap service**](https://pegswap.chain.link/) to convert bridged LINK to the official ERC-677 LINK token on BNB Chain.
+
+:::
+
+| Parameter | Value |
+| :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `ETH_CHAIN_ID` | `56` |
+| Address | `0x404460C6A5EdE2D891e8297795264fDe62ADBB75` |
+| Name | Chainlink Token |
+| Symbol | LINK |
+| Decimals | 18 |
+| Network status | [bscscan.freshstatus.io](https://bscscan.freshstatus.io/) |
+
+### BNB Chain testnet
+
+Testnet LINK is available at [faucets.chain.link](https://faucets.chain.link/chapel). Testnet BNB is availalbe at [testnet.binance.org/faucet-smart](https://testnet.binance.org/faucet-smart).
+
+| Parameter | Value |
+| :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `ETH_CHAIN_ID` | `97` |
+| Address | `0x84b9B910527Ad5C03A9Ca831909E21e236EA7b06` |
+| Name | Chainlink Token |
+| Symbol | LINK |
+| Decimals | 18 |
+
+## Polygon (Matic)
+
+### Polygon mainnet
+
+MATIC is used to pay for transactions on Polygon. You can use the [Polygon Bridge](https://wallet.polygon.technology/bridge) to transfer tokens to Polygon mainnet and then use [Polygon Gas Swap](https://wallet.polygon.technology/gas-swap/) to swap supported tokens to MATIC.
+
+:::caution[ ERC-677 LINK on Polygon]
+
+The LINK provided by the [Polygon (Matic) Bridge](https://wallet.polygon.technology/bridge) is not ERC-677 compatible, so you cannot use it with Chainlink services or oracle nodes. Use the [**Chainlink PegSwap service**](https://pegswap.chain.link/) to convert bridged LINK to the official ERC-677 LINK token on Polygon.
+
+Watch the [Moving Chainlink Cross-Chains](https://www.youtube.com/watch?v=WKvIGkBWRUA) video to learn more.
+
+:::
+
+| Parameter | Value |
+| :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `ETH_CHAIN_ID` | `137` |
+| Address | `0xb0897686c545045aFc77CF20eC7A532E3120E0F1` |
+| Name | Chainlink Token |
+| Symbol | LINK |
+| Decimals | 18 |
+| Network status | [polygon.io/system](https://polygon.io/system) |
+
+### Mumbai testnet
+
+Testnet LINK is available at [faucets.chain.link](https://faucets.chain.link/mumbai). Testnet MATIC is available at the [Polygon faucet](https://faucet.polygon.technology/).
+
+| Parameter | Value |
+| :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `ETH_CHAIN_ID` | `80001` |
+| Address | `0x326C977E6efc84E512bB9C30f76E30c160eD06FB ` |
+| Name | Chainlink Token |
+| Symbol | LINK |
+| Decimals | 18 |
+
+## RSK
+
+### RSK mainnet
+
+RBTC is used to pay for transactions on RSK mainnet. Use [RSK’s built in PowPeg](https://developers.rsk.co/guides/get-crypto-on-rsk/powpeg-btc-rbtc/) to transfer BTC to RSK mainnet as RBTC. You can use the [RSK bridge](https://tokenbridge.rsk.co/) to send LINK from Ethereum Mainnet to RSK.
+
+| Parameter | Value |
+| :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `ETH_CHAIN_ID` | `30` |
+| Address | `0x14ADAE34beF7Ca957ce2DDe5AdD97EA050123827` |
+| Name | rLINK |
+| Symbol | rLINK |
+| Decimals | 18 |
+
+## Gnosis Chain (xDai)
+
+### Gnosis Chain mainnet
+
+xDAI is used to pay for transactions on Gnosis Chain mainnet. Use the [xDai Bridge](https://bridge.gnosischain.com/) to send DAI from Ethereum Mainnet to Gnosis Chain and convert it to xDAI. Use [OmniBridge](https://omni.gnosischain.com/bridge) to send LINK from Ethereum Mainnet to Gnosis Chain.
+
+| Parameter | Value |
+| :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `ETH_CHAIN_ID` | `100` |
+| Address | `0xE2e73A1c69ecF83F464EFCE6A5be353a37cA09b2` |
+| Name | Chainlink Token on Gnosis Chain (xDai) |
+| Symbol | LINK |
+| Decimals | 18 |
+| Network status | [gnosisscan.io/](https://gnosisscan.io/) |
+
+## Avalanche
+
+### Avalanche mainnet
+
+AVAX is the token you use to pay for transactions on Avalanche mainnet. Use the [Avalanche Bridge](https://bridge.avax.network/) to transfer LINK from Ethereum Mainnet to Avalanche.
+
+| Parameter | Value |
+| :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `ETH_CHAIN_ID` | `43114` |
+| Address | `0x5947BB275c521040051D82396192181b413227A3` |
+| Name | Chainlink Token on Avalanche |
+| Symbol | LINK |
+| Decimals | 18 |
+| Network status | [status.avax.network](https://status.avax.network/) |
+
+### Fuji testnet
+
+Testnet LINK is available at [faucets.chain.link](https://faucets.chain.link/fuji). Testnet AVAX is available at [faucet.avax.network](https://faucet.avax.network/).
+
+| Parameter | Value |
+| :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `ETH_CHAIN_ID` | `43113` |
+| Address | `0x0b9d5D9136855f6FEc3c0993feE6E9CE8a297846` |
+| Name | Chainlink Token on Avalanche |
+| Symbol | LINK |
+| Decimals | 18 |
+
+## Fantom
+
+### Fantom mainnet
+
+FTM is used to pay for transactions on Fantom Mainnet. Use [bridge.multichain.org](https://bridge.multichain.org/#/router) to transfer FTM and LINK to Fantom mainnet.
+
+:::caution[ ERC-677 LINK on Fantom]
+
+You must use ERC-677 LINK on Fantom. ERC-20 LINK will not work with Chainlink services.
+When you use [bridge.multichain.org](https://bridge.multichain.org/#/router) to send LINK to the Fantom network, be sure to select LINK-ERC677 as the token you will receive on Fantom mainnet.
+
+:::
+
+| Parameter | Value |
+| :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `ETH_CHAIN_ID` | `250` |
+| Address | `0x6F43FF82CCA38001B6699a8AC47A2d0E66939407` |
+| Name | Chainlink Token on Fantom |
+| Symbol | LINK |
+| Decimals | 18 |
+| Network status | [ftmscan.com](https://ftmscan.com/) |
+
+### Fantom testnet
+
+Testnet LINK is available at [faucets.chain.link](https://faucets.chain.link/fantom-testnet). Testnet FTM is available at [faucet.fantom.network](https://faucet.fantom.network/).
+
+| Parameter | Value |
+| :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `ETH_CHAIN_ID` | `4002` |
+| Address | `0xfaFedb041c0DD4fA2Dc0d87a6B0979Ee6FA7af5F` |
+| Name | Chainlink Token on Fantom |
+| Symbol | LINK |
+| Decimals | 18 |
+
+## Arbitrum
+
+### Arbitrum mainnet
+
+ETH is used to pay for transactions on the Arbitrum mainnet. You can use the [Arbitrum Bridge](https://bridge.arbitrum.io/) to transfer ETH and LINK to from Ethereum Mainnet to Arbitrum.
+
+| Parameter | Value |
+| :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `ETH_CHAIN_ID` | `42161` |
+| Address | `0xf97f4df75117a78c1A5a0DBb814Af92458539FB4` |
+| Name | Chainlink Token on Arbitrum Mainnet |
+| Symbol | LINK |
+| Decimals | 18 |
+| Network status | [arbiscan.freshstatus.io](https://arbiscan.freshstatus.io/) |
+
+### Arbitrum Goerli testnet
+
+Testnet ETH is used to pay for transactions on Arbitrum Goerli. Use the [Arbitrum Bridge](https://bridge.arbitrum.io/) to transfer testnet ETH and LINK from Ethereum Goerli to Arbitrum Goerli.
+
+| Parameter | Value |
+| :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `ETH_CHAIN_ID` | `421613` |
+| Address | `0xd14838A68E8AFBAdE5efb411d5871ea0011AFd28` |
+| Name | Chainlink Token on Arbitrum Rinkeby |
+| Symbol | LINK |
+| Decimals | 18 |
+
+## HECO Chain
+
+### HECO Chain mainnet
+
+| Parameter | Value |
+| :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `ETH_CHAIN_ID` | `128` |
+| Address | `0x9e004545c59D359F6B7BFB06a26390b087717b42` |
+| Name | Heco-Peg LINK Token |
+| Symbol | LINK |
+| Decimals | 18 |
+| Network status | [hecoinfo.com](https://hecoinfo.com/) |
+
+## Optimism
+
+### Optimism mainnet
+
+ETH is used to pay for transactions on Optimism. Use the [Optimism Bridge](https://app.optimism.io/bridge) to transfer ETH and LINK from Ethereum Mainnet to Optimism mainnet.
+
+| Parameter | Value |
+| :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `ETH_CHAIN_ID` | `10` |
+| Address | `0x350a791Bfc2C21F9Ed5d10980Dad2e2638ffa7f6` |
+| Name | Chainlink Token on Optimism Mainnet |
+| Symbol | LINK |
+| Decimals | 18 |
+| Network status | [status.optimism.io](https://status.optimism.io/) |
+
+### Optimism Goerli testnet
+
+Testnet ETH is used to pay for transactions on Optimism. Use the [Optimism Bridge](https://app.optimism.io/bridge) to transfer testnet ETH and LINK from Ethereum Goerli to Optimistim Goerli. Select Optimism Goerli in your wallet to access the Optimism Goerli bridge.
+
+| Parameter | Value |
+| :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `ETH_CHAIN_ID` | `420` |
+| Address | `0xdc2CC710e42857672E7907CF474a69B63B93089f` |
+| Name | Chainlink Token on Optimism Goerli |
+| Symbol | LINK |
+| Decimals | 18 |
+
+## Harmony
+
+### Harmony mainnet
+
+ONE is used to pay for transactions on Harmony mainnet. You can use the [Harmony Bridge](https://bridge.harmony.one/) to transfer ONE and LINK token from Ethereum Mainnet to Harmony mainnet.
+
+| Parameter | Value |
+| :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `ETH_CHAIN_ID` | `1666600000` |
+| Address | `0x218532a12a389a4a92fC0C5Fb22901D1c19198aA` |
+| Name | Chainlink Token on Harmony Mainnet |
+| Symbol | LINK |
+| Decimals | 18 |
+| Network status | [status.harmony.one](https://status.harmony.one/) |
+
+## Moonriver
+
+### Moonriver mainnet
+
+MOVR is used to pay transaction fees on Moonriver mainnet. You can use [bridge.multichain.org](https://bridge.multichain.org/#/router) to transfer LINK to Moonriver mainnet.
+
+| Parameter | Value |
+| :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `ETH_CHAIN_ID` | `1285` |
+| Address | `0x8b12Ac23BFe11cAb03a634C1F117D64a7f2cFD3e` |
+| Name | Chainlink Token on Moonriver Mainnet |
+| Symbol | LINK |
+| Decimals | 18 |
+| Network status | [moonscan.freshstatus.io](https://moonscan.freshstatus.io/) |
+
+## Moonbeam
+
+### Moonbeam mainnet
+
+GLMR is used to pay transaction fees on Moonbeam mainnet.
+
+| Parameter | Value |
+| :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `ETH_CHAIN_ID` | `1284` |
+| Address | `0x012414A392F9FA442a3109f1320c439C45518aC3` |
+| Name | Chainlink Token on Moonbeam Mainnet |
+| Symbol | LINK |
+| Decimals | 18 |
+| Network status | [moonscan.freshstatus.io](https://moonscan.freshstatus.io/) |
+
+## Metis
+
+### Andromeda mainnet
+
+METIS is the currency that you use to pay for transactions on Metis mainnet. You can use the [Metis Bridge](https://bridge.metis.io/) to transfer METIS and LINK from Ethereum Mainnet to Metis mainnet.
+
+| Parameter | Value |
+| :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `ETH_CHAIN_ID` | `1088` |
+| Address | `0x79892E8A3Aea66C8F6893fa49eC6208ef07EC046` |
+| Name | Chainlink Token on Metis Mainnet |
+| Symbol | LINK |
+| Decimals | 18 |
+| Network status | [andromeda-explorer.metis.io](https://andromeda-explorer.metis.io/) |
+
+## Klaytn
+
+### Baobab testnet
+
+KLAY is the currency that you use to pay for transactions on Klaytn testnet. Testnet LINK is available from [faucets.chain.link](https://faucets.chain.link/klaytn-testnet). Use the [KLAY Faucet](https://baobab.wallet.klaytn.foundation/faucet) to obtain testnet KLAY.
+
+| Parameter | Value |
+| :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `ETH_CHAIN_ID` | `1001` |
+| Address | `0x04c5046A1f4E3fFf094c26dFCAA75eF293932f18` |
+| Name | Chainlink Token on the Klaytn testnet |
+| Symbol | LINK |
+| Decimals | 18 |
+| Network status | [status.klaytnapi.com](https://status.klaytnapi.com/) |
diff --git a/src/pages/search-index.astro b/src/pages/search-index.astro
new file mode 100644
index 00000000000..6101d36ac73
--- /dev/null
+++ b/src/pages/search-index.astro
@@ -0,0 +1,46 @@
+---
+import { MarkdownInstance } from "astro"
+import fs from "node:fs"
+
+// import .astro files
+const pages = await Astro.glob("./**/*.astro")
+
+// import .md files
+const posts = [...(await Astro.glob("./**/*.md")).filter((post) => !post.frontmatter.draft)]
+const postsMdx = [...(await Astro.glob("./**/*.mdx")).filter((post) => !post.frontmatter.draft)]
+const postsMdxWithContent = postsMdx.map((post) => {
+ const url = new URL(post.file, import.meta.url)
+ const content = fs.readFileSync(url, "utf-8")
+ return { ...post, rawContent: () => content }
+})
+
+const markDownFiles = [...posts, ...postsMdxWithContent]
+
+const allContent = [...pages, ...posts, ...postsMdx]
+
+const transformMarkdownInstancesToIndexes = async (instances: MarkdownInstance>[]) => {
+ return Promise.all(
+ instances.map(async (instance) => {
+ const { title, section, metadata } = instance.frontmatter
+ const headings = await instance.getHeadings()
+ const content = !!instance.rawContent ? await instance.rawContent() : undefined
+ return {
+ title,
+ headings,
+ url: instance.url,
+ section,
+ description: metadata?.description ?? undefined,
+ content,
+ }
+ })
+ )
+}
+
+const index = await transformMarkdownInstancesToIndexes(markDownFiles)
+
+const stringifiedJson = JSON.stringify({ index }, null, 2)
+
+fs.writeFileSync(`${process.cwd()}/public/search-index.json`, stringifiedJson)
+---
+
+
+
+ {"Data feeds on Solana"}
+
+
+
+
+
+ Learn the basics in the Getting Started Guide. Build your first smart contract on Ethereum.
+
+ {"Getting Started Guide"}
+
+
diff --git a/src/pages/solana/data-feeds/data-feeds-solana.md b/src/pages/solana/data-feeds/data-feeds-solana.md
new file mode 100644
index 00000000000..ac78b962371
--- /dev/null
+++ b/src/pages/solana/data-feeds/data-feeds-solana.md
@@ -0,0 +1,15 @@
+---
+layout: ../../../layouts/MainLayout.astro
+section: solana
+title: "Solana Data Feeds Addresses"
+stub: data-feeds-solana
+permalink: "docs/solana/data-feeds-solana/"
+metadata:
+ ecosystem: solana
+ networkstatusurl: "https://status.solana.com/"
+date: Last Modified
+setup: |
+ import { FeedPage } from "@features/feeds"
+---
+
+
+
+
+ ```shell yarn
+ yarn add @project-serum/anchor
+ ```
+
+
+
+ ```shell npm
+ npm i @project-serum/anchor
+ ```
+
+
+
+1. Add the [Chainlink Solana NPM library](https://www.npmjs.com/package/@chainlink/solana-sdk) to your project:
+
+
+
+ ```shell yarn
+ yarn add @chainlink/solana-sdk
+ ```
+
+
+
+ ```shell npm
+ npm i -g @chainlink/solana-sdk
+ ```
+
+
+
+1. Create a temporary Solana wallet to use for this example. Alternatively, if you have an existing wallet that you want to use, locate the path to your [keypair](https://docs.solana.com/terminology#keypair) file and use it as the keypair for the rest of this guide.
+
+ ```shell
+ solana-keygen new --outfile ./id.json
+ ```
+
+1. Set the [Anchor environment variables](https://www.twilio.com/blog/2017/01/how-to-set-environment-variables.html). Anchor uses these to determine which wallet to use and how to get a connection to a Solana cluster. Because this example does not generate or sign any transactions, no lamports are required. The wallet is required only by the Anchor library. For a list of available networks and endpoints, see the [Solana Cluster RPC Endpoints](https://docs.solana.com/cluster/rpc-endpoints) documentation.
+
+ ```shell
+ export ANCHOR_PROVIDER_URL=https://api.devnet.solana.com &&
+ export ANCHOR_WALLET=./id.json
+ ```
+
+1. Copy the sample code into your project. This example queries price data off-chain. By default, the script reads the SOL/USD feed, but you can change the `CHAINLINK_FEED_ADDRESS` variable to point to the [feed account addresses](/solana/data-feeds/data-feeds-solana/) that you want to query. You can take the components of these code samples and integrate them with your existing project. Because these examples read data feeds without making any on-chain changes, no lamports are required to run them.
+
+::solidity-remix[samples/Solana/PriceFeeds/off-chain-read.js]
+
+::solidity-remix[samples/Solana/PriceFeeds/off-chain-read.ts]
+
+You can run these examples using the following commands:
+
+
+ Javascript
+ Typescript
+
+ ```shell JavaScript
+ node javascript-example.js
+ ```
+
+
+ ```shell TypeScript
+ yarn add ts-node typescript && yarn ts-node typescript-example.ts
+ ```
+
+
+
+To learn more about Solana and Anchor, see the [Solana Documentation](https://docs.solana.com/) and the [Anchor Documentation](https://book.anchor-lang.com/).
+
+## Using the Solana Starter Kit
+
+This example reads price data from an off-chain client using the [Solana Starter Kit](https://github.com/smartcontractkit/solana-starter-kit).
+
+### Install the required tools
+
+Before you begin, set up your environment for development on Solana:
+
+1. Install [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) if it is not already configured on your system.
+
+1. Install the latest Mainnet version of [the Solana CLI](https://github.com/solana-labs/solana/releases) and export the path to the CLI:
+
+ ```shell
+ sh -c "$(curl -sSfL https://release.solana.com/v1.9.28/install)" &&
+ export PATH="~/.local/share/solana/install/active_release/bin:$PATH"
+ ```
+
+ Run `solana --version` to make sure the Solana CLI is installed correctly.
+
+ ```shell
+ solana --version
+ ```
+
+1. Install [Node.js 14 or higher](https://nodejs.org/en/download/). Run `node --version` to verify which version you have installed:
+
+ ```shell
+ node --version
+ ```
+
+1. [Install Anchor](https://book.anchor-lang.com/getting_started/installation.html). On some operating systems, you might need to build and install Anchor locally. See the [Anchor documentation](https://book.anchor-lang.com/getting_started/installation.html#build-from-source-for-other-operating-systems-without-avm) for instructions.
+
+1. Install [Yarn](https://classic.yarnpkg.com/lang/en/docs/install/) to simplify package management and run code samples in the Starter Kit.
+
+ ```shell
+ npm install -g yarn
+ ```
+
+### Run the example program
+
+After you install the required tools, clone the example code from the [solana-starter-kit](https://github.com/smartcontractkit/solana-starter-kit) repository.
+
+1. In a terminal, clone the [solana-starter-kit](https://github.com/smartcontractkit/solana-starter-kit) repository and change to the `solana-starter-kit` directory:
+
+ ```shell
+ git clone https://github.com/smartcontractkit/solana-starter-kit &&
+ cd ./solana-starter-kit
+ ```
+
+ You can see the complete code for the example on [GitHub](https://github.com/smartcontractkit/solana-starter-kit/).
+
+1. In the `./solana-starter-kit` directory, install Node.js dependencies defined in the `package.json` file:
+
+ ```shell
+ yarn install
+ ```
+
+1. Create a temporary Solana wallet file to use for this example. Because your application runs off-chain and does not run any functions or alter data on-chain, the wallet does not require any SOL tokens to function.
+
+ ```shell
+ solana-keygen new --outfile ./id.json
+ ```
+
+1. Set the [Anchor environment variables](https://www.twilio.com/blog/2017/01/how-to-set-environment-variables.html). Anchor uses these to determine which wallet to use and Solana cluster to use. Take note that because we are not generating or signing any transactions, the wallet isn't used, it's just required by the Anchor library. For a list of available networks and endpoints, see the [Solana Cluster RPC Endpoints](https://docs.solana.com/cluster/rpc-endpoints) documentation.
+
+ ```shell Solana Devnet
+ export ANCHOR_PROVIDER_URL=https://api.devnet.solana.com &&
+ export ANCHOR_WALLET=./id.json
+ ```
+
+1. Run the example:
+
+ ```shell JavaScript
+ node read-data.js
+ ```
+
+ ```shell TypeScript
+ yarn run read-data
+ ```
+
+ The example code retrieves and prints the current price feed data until you close the application:
+
+ ```
+ 4027000000
+ 4026439929
+ 4026476542
+ 4023000000
+ ```
+
+To learn more about Solana and Anchor, see the [Solana Documentation](https://docs.solana.com/) and the [Anchor Documentation](https://book.anchor-lang.com/).
diff --git a/src/pages/solana/data-feeds/using-data-feeds-solana.md b/src/pages/solana/data-feeds/using-data-feeds-solana.md
new file mode 100644
index 00000000000..5b59d4cee1c
--- /dev/null
+++ b/src/pages/solana/data-feeds/using-data-feeds-solana.md
@@ -0,0 +1,341 @@
+---
+layout: ../../../layouts/MainLayout.astro
+section: solana
+date: Last Modified
+title: "Using Data Feeds On-Chain (Solana)"
+permalink: "docs/solana/using-data-feeds-solana/"
+whatsnext:
+ {
+ "Use data feeds off-chain": "/solana/data-feeds/using-data-feeds-off-chain/",
+ "See the available data feeds on Solana": "/solana/data-feeds/data-feeds-solana/",
+ }
+metadata:
+ title: "Using Data Feeds On-Chain (Solana)"
+ description: "How to use Chainlink Data Feeds in your on-chain Solana programs."
+setup: |
+ import { Tabs } from "@components/Tabs"
+---
+
+Chainlink Data Feeds are the quickest way to connect your smart contracts to the real-world market prices of assets. This guide demonstrates how to deploy a program to the Solana Devnet cluster and access Data Feeds on-chain using the [Chainlink Solana Starter Kit](https://github.com/smartcontractkit/solana-starter-kit). To learn how to read price feed data using off-chain applications, see the [Using Data Feeds Off-Chain](/solana/using-data-feeds-off-chain/) guide.
+
+To get the full list of available Chainlink Data Feeds on Solana, see the [Solana Feeds](/solana/data-feeds/data-feeds-solana/) page. View the program that owns the Chainlink Data Feeds in the [Solana Devnet Explorer](https://solscan.io/account/HEvSKofvBgfaexv23kMabbYqxasxU3mQ4ibBMEmJWHny?cluster=devnet), or the [Solana Mainnet Explorer](https://solscan.io/account/HEvSKofvBgfaexv23kMabbYqxasxU3mQ4ibBMEmJWHny).
+
+> 🚧 Select quality data feeds
+>
+> Be aware of the quality of the data that you use. [Learn more about making responsible data quality decisions.](/data-feeds/selecting-data-feeds/)
+
+## The Chainlink Data Feeds OCR2 Program
+
+The program that owns the data feeds on both Devnet and Mainnet is [HEvSKofvBgfaexv23kMabbYqxasxU3mQ4ibBMEmJWHny](https://solscan.io/account/HEvSKofvBgfaexv23kMabbYqxasxU3mQ4ibBMEmJWHny?cluster=devnet). This is the program ID that you use to retrieve Chainlink Price Data on-chain in your program. The source code for this program is available in the [smartcontractkit/chainlink-solana](https://github.com/smartcontractkit/chainlink-solana/tree/develop/contracts/programs/ocr2) repository on GitHub.
+
+You can [add data feeds to an existing project](#adding-data-feeds-on-chain-in-an-existing-project) or [use the Solana Starter Kit](#using-the-solana-starter-kit).
+
+## Adding Data Feeds On-Chain In An Existing Project
+
+You can read Chainlink Data Feed data on-chain in your existing project using the [Chainlink Solana Crate](https://crates.io/crates/chainlink_solana).
+
+:::caution[ Reading feed data]
+
+Although you can directly query the data feed accounts, you should not rely on the memory layout always being the same as it currently is. Based on this, the recommendation is to always use the consumer library queries below.
+
+:::
+
+Import the Chainlink Solana Crate into your project and use the code sample to make function calls.
+
+1. Add the Chainlink Solana Crate as an entry in your `Cargo.toml` file dependencies section, as shown in the [starter kit Cargo.toml example](https://github.com/smartcontractkit/solana-starter-kit/blob/main/programs/chainlink_solana_demo/Cargo.toml).
+
+ ```toml
+ [dependencies]
+ chainlink_solana = "1.0.0"
+ ```
+
+1. Use the following code sample to query price data. Each function call to the Chainlink Solana library takes two parameters:
+
+ - The [feed account](/solana/data-feeds/data-feeds-solana/) that you want to query.
+ - The [Chainlink Data Feeds OCR2 Program](#the-chainlink-data-feeds-ocr2-program) for the network. This is a static value that never changes.
+
+The code sample has the following components:
+
+- `latest_round_data`: Returns the latest round information for the specified price pair including the latest price
+- `description`: Returns a price pair description such as SOL/USD
+- `decimals`: Returns the precision of the price, as in how many numbers the price is padded out to
+- `Display`: A helper function that formats the padded out price data into a human-readable price
+
+::solidity-remix[samples/Solana/PriceFeeds/on-chain-read.rs]
+
+::solidity-remix[samples/Solana/PriceFeeds/on-chain-read-anchor.rs]
+
+Program Transaction logs:
+
+
+ Rust
+ Rust with Anchor
+
+ ```shell Rust
+ > Program logged: "Chainlink Price Feed Consumer entrypoint"
+ > Program logged: "SOL / USD price is 83.99000000"
+ > Program consumed: 95953 of 1400000 compute units
+ > Program return: HNYSbr77Jc9LhHeb9tx53SrWbWfNBnQzQrM4b3BB3PCR CA==
+ ```
+
+
+ ```shell Rust with Anchor
+ Fetching transaction logs...
+ [
+ 'Program HEvSKofvBgfaexv23kMabbYqxasxU3mQ4ibBMEmJWHny consumed 1826 of 1306895 compute units',
+ 'Program return: HEvSKofvBgfaexv23kMabbYqxasxU3mQ4ibBMEmJWHny CA==',
+ 'Program HEvSKofvBgfaexv23kMabbYqxasxU3mQ4ibBMEmJWHny success',
+ 'Program log: SOL / USD price is 93.76988029',
+ ]
+ ```
+
+
+
+To learn more about Solana and Anchor, see the [Solana Documentation](https://docs.solana.com/) and the [Anchor Documentation](https://project-serum.github.io/anchor/).
+
+## Using the Solana Starter Kit
+
+This guide demonstrates the following tasks:
+
+- Write and deploy programs to the [Solana Devnet](https://solscan.io/?cluster=devnet) cluster using Anchor.
+- Retrieve price data data using the [Solana Web3 JavaScript API](https://www.npmjs.com/package/@solana/web3.js) with Node.js.
+
+This example shows a full end to end example of using Chainlink Price Feeds on Solana. It includes an on-chain program written in rust, as well as an off-chain client written in JavaScript. The client passes in an account to the program, the program then looks up the latest price of the specified price feed account, and then stores the result in the passed in account. The off-chain client then reads the value stored in the account.
+
+### Install the required tools
+
+Before you begin, set up your environment for development on Solana:
+
+1. Install [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) if it is not already configured on your system.
+
+1. Install [Node.js 14 or higher](https://nodejs.org/en/download/). Run `node --version` to verify which version you have installed:
+
+ ```shell
+ node --version
+ ```
+
+1. Install [Yarn](https://classic.yarnpkg.com/lang/en/docs/install/) to simplify package management and run code samples.
+
+1. Install a C compiler such as the one included in [GCC](https://gcc.gnu.org/install/). Some of the dependencies require a C compiler.
+
+1. Install [Rust](https://www.rust-lang.org/tools/install):
+
+ ```shell
+ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh &&
+ source $HOME/.cargo/env
+ ```
+
+1. Install the latest Mainnet version of [the Solana CLI](https://github.com/solana-labs/solana/releases) and export the path to the CLI:
+
+ ```shell
+ sh -c "$(curl -sSfL https://release.solana.com/v1.9.28/install)" &&
+ export PATH="~/.local/share/solana/install/active_release/bin:$PATH"
+ ```
+
+ Run `solana --version` to make sure the Solana CLI is installed correctly.
+
+ ```shell
+ solana --version
+ ```
+
+1. [Install Anchor](https://book.anchor-lang.com/getting_started/installation.html). On some operating systems, you might need to build and install Anchor locally. See the [Anchor documentation](https://book.anchor-lang.com/getting_started/installation.html#build-from-source-for-other-operating-systems-without-avm) for instructions.
+
+After you install the required tools, build and deploy the example program from the [solana-starter-kit](https://github.com/smartcontractkit/solana-starter-kit) repository.
+
+### Deploy the example program
+
+This example includes a contract written in Rust. Deploy the contract to the Solana Devnet cluster.
+
+1. In a terminal, clone the [solana-starter-kit](https://github.com/smartcontractkit/solana-starter-kit) repository and change to the `solana-starter-kit` directory:
+
+ ```shell
+ git clone https://github.com/smartcontractkit/solana-starter-kit &&
+ cd ./solana-starter-kit
+ ```
+
+ You can see the complete code for the example on [GitHub](https://github.com/smartcontractkit/solana-starter-kit/).
+
+1. In the `./solana-starter-kit` directory, install Node.js dependencies defined in the `package.json` file:
+
+ ```shell
+ yarn install
+ ```
+
+1. Create a temporary Solana wallet to use for this example. Use a temporary wallet to isolate development from your other wallets and prevent you from unintentionally using lamports on the Solana Mainnet. Alternatively, if you have an existing wallet that you want to use, locate the path to your [keypair](https://docs.solana.com/terminology#keypair) file and use it as the keypair for the rest of this guide.
+
+ ```shell
+ solana-keygen new --outfile ./id.json
+ ```
+
+ When you build your production applications and deploy Solana programs to the Mainnet cluster, always follow the security best practices in the [Solana Wallet Guide](https://docs.solana.com/wallet-guide) for managing your wallets and keypairs.
+
+1. Fund your Solana wallet. On Devnet, use `solana airdrop` to add tokens to your account. The contract requires at least 4 SOL to deploy and the faucet limits each request to 2 SOL, so you must make two requests to get a total of 4 SOL on your wallet:
+
+ ```shell
+ solana airdrop 2 --keypair ./id.json --url devnet &&
+ solana airdrop 2 --keypair ./id.json --url devnet
+ ```
+
+ - If the command line faucet does not work, run `solana address` on the temporary wallet to print the public key value for the wallet and request tokens from [SolFaucet](https://solfaucet.com/):
+
+ ```shell
+ solana address -k ./id.json
+ ```
+
+1. Run `anchor build` to build the example program. If you receive the `no such subcommand: 'build-bpf'` error, restart your terminal session and run `anchor build` again:
+
+ ```shell
+ anchor build
+ ```
+
+1. The build process generates the keypair for your program's account. Before you deploy your program, you must add this public key to the `lib.rs` file:
+
+ 1. Get the keypair from the `./target/deploy/chainlink_solana_demo-keypair.json` file that Anchor generated:
+
+ ```shell
+ solana address -k ./target/deploy/chainlink_solana_demo-keypair.json
+ ```
+
+ 1. Edit the `./programs/chainlink_solana_demo/src/lib.rs` file and replace the keypair in the `declare_id!()` definition:
+
+ ```shell
+ vi ./programs/chainlink_solana_demo/src/lib.rs
+ ```
+
+ ```shell
+ declare_id!("JC16qi56dgcLoaTVe4BvnCoDL6FhH5NtahA7jmWZFdqm");
+ ```
+
+1. With the new program ID added, run `anchor build` again. This recreates the necessary program files with the correct program ID:
+
+ ```shell
+ anchor build
+ ```
+
+1. Run `anchor deploy` to deploy the program to the Solana Devnet. Remember to specify the keypair file for your wallet and override the default. This wallet is the [account owner](https://docs.solana.com/terminology#account-owner) (authority) for the program:
+
+ ```shell
+ anchor deploy --provider.wallet ./id.json --provider.cluster devnet
+ ```
+
+1. To confirm that the program deployed correctly, run `solana program show --programs` to get a list of deployed programs that your wallet owns. For this example, check the list of deployed programs for the `id.json` wallet on the Solana Devnet:
+
+ ```shell
+ solana program show --programs --keypair ./id.json --url devnet
+ ```
+
+ The command prints the program ID, slot number, the wallet address that owns the program, and the program balance:
+
+ ```shell
+ Program Id | Slot | Authority | Balance
+ GRt21UnJFHZvcaWLbcUrXaTCFMREewDrm1DweDYBak3Z | 110801571 | FsQPnANKDhqpoayxCL3oDHFCBmrhP34NrfbDR34qbQUt | 3.07874904 SOL
+ ```
+
+ To see additional details of your deployed program, copy the program ID and look it up in the [Solana Devnet Explorer](https://solscan.io/?cluster=devnet).
+
+Now that the program is on-chain, you can call it using the [Anchor Web3 module](https://project-serum.github.io/anchor/ts/modules/web3.html).
+
+### Call the deployed program
+
+Use your deployed program to retrieve price data from a Chainlink data feed on Solana Devnet. For this example, call your deployed program using the [Anchor Web3 module](https://project-serum.github.io/anchor/ts/modules/web3.html) and the [`client.js` example](https://github.com/smartcontractkit/solana-starter-kit/blob/main/client.js) code.
+
+1. Set the [Anchor environment variables](https://www.twilio.com/blog/2017/01/how-to-set-environment-variables.html). Anchor uses these to determine which wallet to use and Solana cluster to use.
+
+ ```shell
+ export ANCHOR_PROVIDER_URL=https://api.devnet.solana.com &&
+ export ANCHOR_WALLET=./id.json
+ ```
+
+1. Run the `client.js` example and pass the program address in using the `--program` flag:
+
+ ```shell
+ node client.js --program $(solana address -k ./target/deploy/chainlink_solana_demo-keypair.json)
+ ```
+
+ If the script executes correctly, you will see output with the current price of SOL / USD.
+
+ ```shell
+ ⋮
+ Price Is: 96.79778375
+ Success
+ ⋮
+ ```
+
+1. Each request costs an amount of SOL that is subtracted from the `id.json` wallet. Run `solana balance` to check the remaining balance for your temporary wallet on Devnet.
+
+ ```shell
+ solana balance --keypair ./id.json --url devnet
+ ```
+
+1. To get prices for a different asset pair, run `client.js` again and add the `--feed` flag with one of the available [Chainlink data feeds](/solana/data-feeds/data-feeds-solana/). For example, to get the price of BTC / USD on Devnet, use the following command:
+
+ ```shell
+ node client.js \
+ --program $(solana address -k ./target/deploy/chainlink_solana_demo-keypair.json) \
+ --feed CzZQBrJCLqjXRfMjRN3fhbxur2QYHUzkpaRwkWsiPqbz
+ ```
+
+ ```shell
+ Price Is: 12.4215826
+ Success
+ ```
+
+The program that owns the data feeds is [HEvSKofvBgfaexv23kMabbYqxasxU3mQ4ibBMEmJWHny](https://solscan.io/account/HEvSKofvBgfaexv23kMabbYqxasxU3mQ4ibBMEmJWHny?cluster=devnet), which you can see defined for `const CHAINLINK_PROGRAM_ID` in the `client.js` file.
+
+### Clean up
+
+After you are done with your deployed contract and no longer need it, it is nice to close the program and withdraw the Devnet SOL tokens for future use. In a production environment, you will want to withdraw unused SOL tokens from any Solana program that you no longer plan to use, so it is good to practice the process when you are done with programs on Devnet.
+
+1. Run `solana program show` to see the list of deployed programs that your wallet owns and the balances for each of those programs:
+
+ ```shell
+ solana program show --programs --keypair ./id.json --url devnet
+ ```
+
+ ```shell
+ Program Id | Slot | Authority | Balance
+ GRt21UnJFHZvcaWLbcUrXaTCFMREewDrm1DweDYBak3Z | 110801571 | FsQPnANKDhqpoayxCL3oDHFCBmrhP34NrfbDR34qbQUt | 3.07874904 SOL
+ ```
+
+1. Run `solana program close` and specify the program that you want to close:
+
+ ```shell
+ solana program close [YOUR_PROGRAM_ID] --keypair ./id.json --url devnet
+ ```
+
+ The program closes and the remaining SOL is transferred to your temporary wallet.
+
+1. If you have deployments that failed, they might still be in the buffer holding SOL tokens. Run `solana program show` again with the `--buffers` flag:
+
+ ```shell
+ solana program show --buffers --keypair ./id.json --url devnet
+ ```
+
+ If you have open buffers, they will appear in the list.
+
+ ```shell
+ Buffer Address | Authority | Balance
+ CSc9hnBqYJoYtBgsryJAmrjAE6vZ918qaFhL6N6BdEmB | FsQPnANKDhqpoayxCL3oDHFCBmrhP34NrfbDR34qbQUt | 1.28936088 SOL
+ ```
+
+1. If you have any buffers that you do not plan to finish deploying, run the same `solana program close` command to close them and retrieve the unused SOL tokens:
+
+ ```shell
+ solana program close [YOUR_PROGRAM_ID] --keypair ./id.json --url devnet
+ ```
+
+1. Check the balance on your temporary wallet.
+
+ ```shell
+ solana balance --keypair ./id.json --url devnet
+ ```
+
+1. If you are done using this wallet for examples and testing, you can use [`solana transfer`](https://docs.solana.com/cli/transfer-tokens) to send the remaining SOL tokens to your default wallet or another Solana wallet that you use. For example, if your default wallet keypair is at `~/.config/solana/id.json`, you can send `ALL` of the temporary wallet's balance with the following command:
+
+ ```shell
+ solana transfer ~/.config/solana/id.json ALL --keypair ./id.json --url devnet
+ ```
+
+ Alternatively, you can send the remaining balance to a web wallet. Specify the public key for your wallet instead of the path the default wallet keypair. Now you can use those Devnet funds for other examples and development.
+
+To learn more about Solana and Anchor, see the [Solana Documentation](https://docs.solana.com/) and the [Anchor Documentation](https://project-serum.github.io/anchor/).
diff --git a/src/pages/solana/overview.md b/src/pages/solana/overview.md
new file mode 100644
index 00000000000..0fb4924403c
--- /dev/null
+++ b/src/pages/solana/overview.md
@@ -0,0 +1,83 @@
+---
+layout: ../../layouts/MainLayout.astro
+section: solana
+date: Last Modified
+title: "Overview"
+permalink: "docs/solana/"
+whatsnext:
+ {
+ "Use data feeds off-chain": "/solana/using-data-feeds-off-chain/",
+ "Use data feeds on-chain": "/solana/using-data-feeds-solana/",
+ "See the available data feeds on Solana": "/solana/data-feeds/data-feeds-solana/",
+ }
+---
+
+Chainlink provides data feeds on the [Solana](https://solana.com/) network. Chainlink data feeds on Solana employ [Off-Chain Reporting (OCR)](/architecture-overview/off-chain-reporting/) to aggregate data from data providers who pull from both centralized and decentralized exchanges. Chainlink’s Solana deployment has no dependencies on external blockchain networks such as Ethereum. In Solana, storage and smart contract logic are separate. Programs store all the logic similar to an EVM (Ethereum) smart contract. The accounts store all the data. Compared to Solidity, the combination of an account and a program is equivalent to a smart contract on an EVM chain. State and logic are separate in Solana.
+
+Solana programs are stateless, so you don't always need to deploy your program to the network to test it. You can deploy and test your programs on a [Solana Test Validator](https://docs.solana.com/developing/test-validator). However, to use Chainlink products on Solana, you must deploy your contract on-chain to one of the [supported Solana clusters](#chainlink-products-and-solana-clusters).
+
+:::note
+Please note that Price Feeds performance relies on the chains they are deployed on. Periods of high network congestion may impact the frequency of Chainlink Price Feeds. Subscribe to [Solana status](https://status.solana.com/) notifications to stay updated on system performance.
+:::
+
+To learn how to mitigate risk to your applications, read the [Selecting Quality Data Feeds](/data-feeds/selecting-data-feeds/) page.
+
+## Chainlink products and Solana clusters
+
+[Data Feeds](/solana/data-feeds/data-feeds-solana/) are available on the following Solana clusters:
+
+- [Solana Mainnet](https://solscan.io/)
+- [Solana Devnet](https://solscan.io/?cluster=devnet)
+
+Solana provides a [Testnet cluster](https://docs.solana.com/clusters#testnet) that runs newer [Solana releases](https://github.com/solana-labs/solana/releases), but Chainlink Data Feeds are not available on this cluster.
+
+See the [Solana Data Feeds](/solana/data-feeds/data-feeds-solana/) page for a full list of Chainlink data feeds that are available on Solana.
+
+To learn when more Chainlink services become available, follow us on [Twitter](https://twitter.com/chainlink) or sign up for our [mailing list](/resources/developer-communications/).
+
+## Languages, tools, and frameworks
+
+The examples in the Chainlink documentation use the following languages, tools, and frameworks:
+
+- [Node.js 14 or higher](https://nodejs.org/en/download/): Used to run client code
+- [Rust](https://docs.solana.com/developing/on-chain-programs/developing-rust): A general-purpose programming language designed for performance and memory safety
+- [Anchor](https://project-serum.github.io/anchor/getting-started/introduction.html): A framework for the [Solana Sealevel runtime](https://github.com/solana-labs/sealevel) that provides several developer tools
+- [Chainlink Solana Starter Kit](https://github.com/smartcontractkit/solana-starter-kit): An Anchor based program and client that shows developers how to use and interact with Chainlink Data Feeds on Solana
+- [Solana CLI](https://docs.solana.com/cli): The Solana command line interface
+- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git): Used to clone the example code repository
+
+When developing applications to use Chainlink products on Solana, always use a [Mainnet release](https://github.com/solana-labs/solana/releases) version of the Solana CLI that is equal to or greater than the version currently running on your target cluster. Use `solana --version` and `solana cluster-version` to check CLI and cluster versions:
+
+```shell
+solana --version
+solana-cli 1.9.28 (src:b576e9cc; feat:320703611)
+
+solana cluster-version --url devnet
+1.9.25
+
+solana cluster-version --url mainnet-beta
+1.9.28
+```
+
+The examples in this documentation use Solana programs in [Rust](https://docs.solana.com/developing/on-chain-programs/developing-rust), but you can also write Solana programs in [C](https://docs.solana.com/developing/on-chain-programs/developing-c). To learn more about the Solana programming model, see the [Solana Documentation](https://docs.solana.com/developing/programming-model/overview).
+
+## Solana Wallets
+
+When you use Chainlink on Solana, you need a [Solana wallet](https://docs.solana.com/wallet-guide/). The Chainlink documentation uses [file system wallets](https://docs.solana.com/wallet-guide/file-system-wallet) and free Devnet SOL tokens to demonstrate examples. When you deploy your programs to the Solana Mainnet, you must use wallets with mainnet lamports.
+
+If you have existing wallets that you want to use for the guides in the Chainlink documentation, find your wallet keypair and make it available in your development environment as a file. You can point [Anchor](https://project-serum.github.io/anchor/getting-started/introduction.html) and the [Solana CLI](https://docs.solana.com/cli) to a specific keypair when you deploy or manage your Solana programs.
+
+```shell
+anchor build
+⋮
+
+anchor deploy --provider.wallet ~/.config/solana/id.json --provider.cluster devnet
+⋮
+
+solana program show --programs --keypair ~/.config/solana/id.json --url devnet
+
+Program Id | Slot | Authority | Balance
+6U4suTp55kiJRKqV7HGAQvFgcLaStLnUA4myg5DRqsKw | 109609728 | E6gKKToCJPgf4zEL1GRLL6T99g2WcfAzJAMvtma1KijT | 2.57751768 SOL
+```
+
+When you build your production applications and deploy Solana programs to the Mainnet cluster, always follow the security best practices in the [Solana Wallet Guide](https://docs.solana.com/wallet-guide) for managing your wallets and keypairs.
diff --git a/src/pages/vrf/v1/api-reference.md b/src/pages/vrf/v1/api-reference.md
new file mode 100644
index 00000000000..770b7edf61a
--- /dev/null
+++ b/src/pages/vrf/v1/api-reference.md
@@ -0,0 +1,84 @@
+---
+layout: ../../../layouts/MainLayout.astro
+section: legacy
+date: Last Modified
+title: "Chainlink VRF API Reference [v1]"
+permalink: "docs/vrf/v1/api-reference/"
+metadata:
+ title: "Chainlink VRF API Reference"
+ description: "API reference for VRFConsumerBase."
+setup: |
+ import VrfCommon from "@features/vrf/v1/common/VrfCommon.astro"
+---
+
+`0x514910771AF9Ca656af840dff83E8264EcF986CA` |
+| VRF Wrapper | [`0x5A861794B927983406fCE1D062e00b9368d97Df6`](https://etherscan.io/address/0x5A861794B927983406fCE1D062e00b9368d97Df6) |
+| VRF Coordinator | [`0x271682DEB8C4E0901D1a1550aD2e64D568E69909`](https://etherscan.io/address/0x271682DEB8C4E0901D1a1550aD2e64D568E69909) |
+| Wrapper Premium Percentage | 0 |
+| Coordinator Flat Fee | 0.25 LINK |
+| Maximum Confirmations | 200 |
+| Maximum Random Values | 10 |
+| Wrapper Gas overhead | 40000 |
+| Coordinator Gas Overhead | 90000 |
+
+### Goerli testnet
+
+:::note[Goerli Faucets]
+Testnet LINK is available from https://faucets.chain.link/goerli`0x326C977E6efc84E512bB9C30f76E30c160eD06FB` |
+| VRF Wrapper | [`0x708701a1DfF4f478de54383E49a627eD4852C816`](https://goerli.etherscan.io/address/0x708701a1DfF4f478de54383E49a627eD4852C816) |
+| VRF Coordinator | [`0x2ca8e0c643bde4c2e08ab1fa0da3401adad7734d`](https://goerli.etherscan.io/address/0x2ca8e0c643bde4c2e08ab1fa0da3401adad7734d) |
+| Wrapper Premium Percentage | 0 |
+| Coordinator Flat Fee | 0.25 LINK |
+| Maximum Confirmations | 200 |
+| Maximum Random Values | 10 |
+| Wrapper Gas overhead | 40000 |
+| Coordinator Gas Overhead | 90000 |
+
+### BNB Chain
+
+:::tip[Important]
+The LINK provided by the [BNB Chain Bridge](https://www.bnbchain.world/en/bridge) is not ERC-677 compatible, so cannot be used with Chainlink oracles. However, it can be [**converted to the official LINK token on BNB Chain using Chainlink's PegSwap service**](https://pegswap.chain.link/).
+:::
+
+| Item | Value |
+| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| LINK Token | `0x404460C6A5EdE2D891e8297795264fDe62ADBB75` |
+| VRF Wrapper | [`0x721DFbc5Cfe53d32ab00A9bdFa605d3b8E1f3f42`](https://bscscan.com/address/0x721DFbc5Cfe53d32ab00A9bdFa605d3b8E1f3f42) |
+| VRF Coordinator | [`0xc587d9053cd1118f25F645F9E08BB98c9712A4EE`](https://bscscan.com/address/0xc587d9053cd1118f25F645F9E08BB98c9712A4EE) |
+| Wrapper Premium Percentage | 0 |
+| Coordinator Flat Fee | 0.005 LINK |
+| Maximum Confirmations | 200 |
+| Maximum Random Values | 10 |
+| Wrapper Gas overhead | 40000 |
+| Coordinator Gas Overhead | 90000 |
+
+### BNB Chain testnet
+
+:::note[BNB Chain Faucet]
+Testnet LINK is available from https://faucets.chain.link/chapel
+:::
+
+| Item | Value |
+| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| LINK Token | `0x84b9B910527Ad5C03A9Ca831909E21e236EA7b06` |
+| VRF Wrapper | [`0x699d428ee890d55D56d5FC6e26290f3247A762bd`](https://testnet.bscscan.com/address/0x699d428ee890d55D56d5FC6e26290f3247A762bd) |
+| VRF Coordinator | [`0x6A2AAd07396B36Fe02a22b33cf443582f682c82f`](https://testnet.bscscan.com/address/0x6A2AAd07396B36Fe02a22b33cf443582f682c82f) |
+| Wrapper Premium Percentage | 0 |
+| Coordinator Flat Fee | 0.005 LINK |
+| Maximum Confirmations | 200 |
+| Maximum Random Values | 10 |
+| Wrapper Gas overhead | 40000 |
+| Coordinator Gas Overhead | 90000 |
+
+### Polygon (Matic) Mainnet
+
+:::tip[Important]
+The LINK provided by the [Polygon (Matic) Bridge](https://wallet.polygon.technology/bridge) is not ERC-677 compatible, so cannot be used with Chainlink oracles. However, it can be [**converted to the official LINK token on Polygon (Matic) using Chainlink's PegSwap service**](https://pegswap.chain.link/)
+:::
+
+| Item | Value |
+| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| LINK Token | `0xb0897686c545045aFc77CF20eC7A532E3120E0F1` |
+| VRF Wrapper | [`0x4e42f0adEB69203ef7AaA4B7c414e5b1331c14dc`](https://polygonscan.com/address/0x4e42f0adEB69203ef7AaA4B7c414e5b1331c14dc) |
+| VRF Coordinator | [`0xAE975071Be8F8eE67addBC1A82488F1C24858067`](https://polygonscan.com/address/0xAE975071Be8F8eE67addBC1A82488F1C24858067) |
+| Wrapper Premium Percentage | 0 |
+| Coordinator Flat Fee | 0.0005 LINK |
+| Maximum Confirmations | 200 |
+| Maximum Random Values | 10 |
+| Wrapper Gas overhead | 40000 |
+| Coordinator Gas Overhead | 90000 |
+
+### Polygon (Matic) Mumbai Testnet
+
+:::note[Mumbai Faucet]
+Testnet LINK and MATIC are available from [the Polygon faucet](https://faucet.polygon.technology/) and https://faucets.chain.link/mumbai.
+:::
+
+| Item | Value |
+| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| LINK Token | `0x326C977E6efc84E512bB9C30f76E30c160eD06FB ` |
+| VRF Wrapper | [`0x99aFAf084eBA697E584501b8Ed2c0B37Dd136693`](https://mumbai.polygonscan.com/address/0x99aFAf084eBA697E584501b8Ed2c0B37Dd136693) |
+| VRF Coordinator | [`0x7a1BaC17Ccc5b313516C5E16fb24f7659aA5ebed`](https://mumbai.polygonscan.com/address/0x7a1BaC17Ccc5b313516C5E16fb24f7659aA5ebed) |
+| Wrapper Premium Percentage | 0 |
+| Coordinator Flat Fee | 0.0005 LINK |
+| Maximum Confirmations | 200 |
+| Maximum Random Values | 10 |
+| Wrapper Gas overhead | 40000 |
+| Coordinator Gas Overhead | 90000 |
+
+### Avalanche Mainnet
+
+| Item | Value |
+| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| LINK Token | `0x5947BB275c521040051D82396192181b413227A3` |
+| VRF Wrapper | [`0x721DFbc5Cfe53d32ab00A9bdFa605d3b8E1f3f42`](https://snowtrace.io/address/0x721DFbc5Cfe53d32ab00A9bdFa605d3b8E1f3f42) |
+| VRF Coordinator | [`0xd5D517aBE5cF79B7e95eC98dB0f0277788aFF634`](https://snowtrace.io/address/0xd5D517aBE5cF79B7e95eC98dB0f0277788aFF634) |
+| Wrapper Premium Percentage | 0 |
+| Coordinator Flat Fee | 0.005 LINK |
+| Maximum Confirmations | 200 |
+| Maximum Random Values | 10 |
+| Wrapper Gas overhead | 40000 |
+| Coordinator Gas Overhead | 90000 |
+
+### Avalanche Fuji Testnet
+
+:::note[Avax Fuji Faucet]
+Testnet LINK is available from https://faucets.chain.link/fuji
+:::
+
+| Item | Value |
+| -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| LINK Token | `0x0b9d5D9136855f6FEc3c0993feE6E9CE8a297846` |
+| VRF Wrapper | [`0x9345AC54dA4D0B5Cda8CB749d8ef37e5F02BBb21`](https://testnet.snowtrace.io/address/0x9345AC54dA4D0B5Cda8CB749d8ef37e5F02BBb21) |
+| VRF Coordinator | [`0x2eD832Ba664535e5886b75D64C46EB9a228C2610`](https://testnet.snowtrace.io/address/0x2eD832Ba664535e5886b75D64C46EB9a228C2610) |
+| Wrapper Premium Percentage | 0 |
+| Coordinator Flat Fee | 0.005 LINK |
+| Maximum Confirmations | 200 |
+| Maximum Random Values | 10 |
+| Wrapper Gas overhead | 40000 |
+| Coordinator Gas Overhead | 90000 |
+
+### Fantom Mainnet
+
+:::tip[Important]
+You must use ERC-677 LINK on Fantom. ERC-20 LINK will not work with Chainlink services.`0x6F43FF82CCA38001B6699a8AC47A2d0E66939407` |
+| VRF Wrapper | [`0xeDA5B00fB33B13c730D004Cf5D1aDa1ac191Ddc2`](https://ftmscan.com/address/0xeDA5B00fB33B13c730D004Cf5D1aDa1ac191Ddc2) |
+| VRF Coordinator | [`0xd5D517aBE5cF79B7e95eC98dB0f0277788aFF634`](https://ftmscan.com/address/0xd5d517abe5cf79b7e95ec98db0f0277788aff634) |
+| Wrapper Premium Percentage | 0 |
+| Coordinator Flat Fee | 0.0005 LINK |
+| Maximum Confirmations | 200 |
+| Maximum Random Values | 10 |
+| Wrapper Gas overhead | 40000 |
+| Coordinator Gas Overhead | 90000 |
+
+### Fantom Testnet
+
+:::note[Fantom Testnet Faucet]
+Testnet LINK is available from https://faucets.chain.link/fantom-testnet
+:::
+
+| Item | Value |
+| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| LINK Token | `0xfaFedb041c0DD4fA2Dc0d87a6B0979Ee6FA7af5F` |
+| VRF Wrapper | [`0x38336BDaE79747a1d2c4e6C67BBF382244287ca6`](https://testnet.ftmscan.com/address/0x38336BDaE79747a1d2c4e6C67BBF382244287ca6) |
+| VRF Coordinator | [`0xbd13f08b8352A3635218ab9418E340c60d6Eb418`](https://testnet.ftmscan.com/address/0xbd13f08b8352a3635218ab9418e340c60d6eb418) |
+| Wrapper Premium Percentage | 0 |
+| Coordinator Flat Fee | 0.0005 LINK |
+| Maximum Confirmations | 200 |
+| Maximum Random Values | 10 |
+| Wrapper Gas overhead | 40000 |
+| Coordinator Gas Overhead | 90000 |
diff --git a/src/pages/vrf/v2/introduction.md b/src/pages/vrf/v2/introduction.md
new file mode 100644
index 00000000000..ae3f56df6f6
--- /dev/null
+++ b/src/pages/vrf/v2/introduction.md
@@ -0,0 +1,71 @@
+---
+layout: ../../../layouts/MainLayout.astro
+section: ethereum
+date: Last Modified
+title: "Introduction to Chainlink VRF"
+permalink: "docs/vrf/v2/introduction/"
+whatsnext: { "Subscription Method": "/vrf/v2/subscription/", "Direct Funding Method": "/vrf/v2/direct-funding/" }
+metadata:
+ title: "Generate Random Numbers for Smart Contracts using Chainlink VRF"
+ description: "Learn how to securely generate random numbers for your smart contract with Chainlink VRF (an RNG). This guide uses Solidity code examples."
+setup: |
+ import VrfCommon from "@features/vrf/v2/common/VrfCommon.astro"
+---
+
+
+
+`0x514910771AF9Ca656af840dff83E8264EcF986CA` |
+| VRF Coordinator | [`0x271682DEB8C4E0901D1a1550aD2e64D568E69909`](https://etherscan.io/address/0x271682DEB8C4E0901D1a1550aD2e64D568E69909) |
+| 200 gwei Key Hash | `0x8af398995b04c28e9951adb9721ef74c74f93e6a478f39e7e0777be13527e7ef` |
+| 500 gwei Key Hash | `0xff8dedfbfa60af186cf3c830acbc32c05aae823045ae5ea7da1e45fbfaba4f92` |
+| 1000 gwei Key Hash | `0x9fe0eebf5e446e3c998ec9bb19951541aee00bb90ea201ae456421a2ded86805` |
+| Premium | 0.25 LINK |
+| Max Gas Limit | 2,500,000 |
+| Minimum Confirmations | 3 |
+| Maximum Confirmations | 200 |
+| Maximum Random Values | 500 |
+
+### Goerli testnet
+
+:::note[Goerli Faucets]
+Testnet LINK is available from https://faucets.chain.link/goerli`0x326C977E6efc84E512bB9C30f76E30c160eD06FB` |
+| VRF Coordinator | [`0x2Ca8E0C643bDe4C2E08ab1fA0da3401AdAD7734D`](https://goerli.etherscan.io/address/0x2Ca8E0C643bDe4C2E08ab1fA0da3401AdAD7734D) |
+| 150 gwei Key Hash | `0x79d3d8832d904592c0bf9818b621522c988bb8b0c05cdc3b15aea1b6e8db0c15` |
+| Premium | 0.25 LINK |
+| Max Gas Limit | 2,500,000 |
+| Minimum Confirmations | 3 |
+| Maximum Confirmations | 200 |
+| Maximum Random Values | 500 |
+
+### BNB Chain
+
+:::tip[Important]
+The LINK provided by the [BNB Chain Bridge](https://www.bnbchain.world/en/bridge) is not ERC-677 compatible, so cannot be used with Chainlink oracles. However, it can be [**converted to the official LINK token on BNB Chain using Chainlink's PegSwap service**](https://pegswap.chain.link/).
+:::
+
+| Item | Value |
+| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| LINK Token | `0x404460C6A5EdE2D891e8297795264fDe62ADBB75` |
+| VRF Coordinator | [`0xc587d9053cd1118f25F645F9E08BB98c9712A4EE`](https://bscscan.com/address/0xc587d9053cd1118f25F645F9E08BB98c9712A4EE) |
+| 200 gwei Key Hash | `0x114f3da0a805b6a67d6e9cd2ec746f7028f1b7376365af575cfea3550dd1aa04` |
+| 500 gwei Key Hash | `0xba6e730de88d94a5510ae6613898bfb0c3de5d16e609c5b7da808747125506f7` |
+| 1000 gwei Key Hash | `0x17cd473250a9a479dc7f234c64332ed4bc8af9e8ded7556aa6e66d83da49f470` |
+| Premium | 0.005 LINK |
+| Max Gas Limit | 2,500,000 |
+| Minimum Confirmations | 3 |
+| Maximum Confirmations | 200 |
+| Maximum Random Values | 500 |
+
+### BNB Chain testnet
+
+:::note[BNB Chain Faucet]
+Testnet LINK is available from https://faucets.chain.link/chapel
+:::
+
+| Item | Value |
+| --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| LINK Token | `0x84b9B910527Ad5C03A9Ca831909E21e236EA7b06` |
+| VRF Coordinator | [`0x6A2AAd07396B36Fe02a22b33cf443582f682c82f`](https://testnet.bscscan.com/address/0x6A2AAd07396B36Fe02a22b33cf443582f682c82f) |
+| 50 gwei Key Hash | `0xd4bb89654db74673a187bd804519e65e3f71a52bc55f11da7601a13dcf505314` |
+| Premium | 0.005 LINK |
+| Max Gas Limit | 2,500,000 |
+| Minimum Confirmations | 3 |
+| Maximum Confirmations | 200 |
+| Maximum Random Values | 500 |
+
+### Polygon (Matic) mainnet
+
+:::tip[Important]
+The LINK provided by the [Polygon (Matic) Bridge](https://wallet.polygon.technology/bridge) is not ERC-677 compatible, so cannot be used with Chainlink oracles. However, it can be [**converted to the official LINK token on Polygon (Matic) using Chainlink's PegSwap service**](https://pegswap.chain.link/)
+:::
+
+| Item | Value |
+| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| LINK Token | `0xb0897686c545045aFc77CF20eC7A532E3120E0F1` |
+| VRF Coordinator | [`0xAE975071Be8F8eE67addBC1A82488F1C24858067`](https://polygonscan.com/address/0xAE975071Be8F8eE67addBC1A82488F1C24858067) |
+| 200 gwei Key Hash | `0x6e099d640cde6de9d40ac749b4b594126b0169747122711109c9985d47751f93` |
+| 500 gwei Key Hash | `0xcc294a196eeeb44da2888d17c0625cc88d70d9760a69d58d853ba6581a9ab0cd` |
+| 1000 gwei Key Hash | `0xd729dc84e21ae57ffb6be0053bf2b0668aa2aaf300a2a7b2ddf7dc0bb6e875a8` |
+| Premium | 0.0005 LINK |
+| Max Gas Limit | 2,500,000 |
+| Minimum Confirmations | 3 |
+| Maximum Confirmations | 200 |
+| Maximum Random Values | 500 |
+
+### Polygon (Matic) Mumbai testnet
+
+:::note[Mumbai Faucet]
+Testnet LINK and MATIC are available from [the Polygon faucet](https://faucet.polygon.technology/) and https://faucets.chain.link/mumbai.
+:::
+
+| Item | Value |
+| --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| LINK Token | `0x326C977E6efc84E512bB9C30f76E30c160eD06FB ` |
+| VRF Coordinator | [`0x7a1BaC17Ccc5b313516C5E16fb24f7659aA5ebed`](https://mumbai.polygonscan.com/address/0x7a1BaC17Ccc5b313516C5E16fb24f7659aA5ebed) |
+| 500 gwei Key Hash | `0x4b09e658ed251bcafeebbc69400383d49f344ace09b9576fe248bb02c003fe9f` |
+| Premium | 0.0005 LINK |
+| Max Gas Limit | 2,500,000 |
+| Minimum Confirmations | 3 |
+| Maximum Confirmations | 200 |
+| Maximum Random Values | 500 |
+
+### Avalanche mainnet
+
+| Item | Value |
+| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| LINK Token | `0x5947BB275c521040051D82396192181b413227A3` |
+| VRF Coordinator | [`0xd5D517aBE5cF79B7e95eC98dB0f0277788aFF634`](https://snowtrace.io/address/0xd5D517aBE5cF79B7e95eC98dB0f0277788aFF634) |
+| 200 gwei Key Hash | `0x83250c5584ffa93feb6ee082981c5ebe484c865196750b39835ad4f13780435d` |
+| 500 gwei Key Hash | `0x89630569c9567e43c4fe7b1633258df9f2531b62f2352fa721cf3162ee4ecb46` |
+| 1000 gwei Key Hash | `0x06eb0e2ea7cca202fc7c8258397a36f33d88568d2522b37aaa3b14ff6ee1b696` |
+| Premium | 0.005 LINK |
+| Max Gas Limit | 2,500,000 |
+| Minimum Confirmations | 1 |
+| Maximum Confirmations | 200 |
+| Maximum Random Values | 500 |
+
+### Avalanche Fuji testnet
+
+:::note[Avax Fuji Faucet]
+Testnet LINK is available from https://faucets.chain.link/fuji
+:::
+
+| Item | Value |
+| --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| LINK Token | `0x0b9d5D9136855f6FEc3c0993feE6E9CE8a297846` |
+| VRF Coordinator | [`0x2eD832Ba664535e5886b75D64C46EB9a228C2610`](https://testnet.snowtrace.io/address/0x2eD832Ba664535e5886b75D64C46EB9a228C2610) |
+| 300 gwei Key Hash | `0x354d2f95da55398f44b7cff77da56283d9c6c829a4bdf1bbcaf2ad6a4d081f61` |
+| Premium | 0.005 LINK |
+| Max Gas Limit | 2,500,000 |
+| Minimum Confirmations | 1 |
+| Maximum Confirmations | 200 |
+| Maximum Random Values | 500 |
+
+### Fantom mainnet
+
+:::tip[Important]
+You must use ERC-677 LINK on Fantom. ERC-20 LINK will not work with Chainlink services.`0x6F43FF82CCA38001B6699a8AC47A2d0E66939407` |
+| VRF Coordinator | [`0xd5D517aBE5cF79B7e95eC98dB0f0277788aFF634`](https://ftmscan.com/address/0xd5d517abe5cf79b7e95ec98db0f0277788aff634) |
+| 4000 gwei Key Hash | `0xb4797e686f9a1548b9a2e8c68988d74788e0c4af5899020fb0c47784af76ddfa` |
+| 10000 gwei Key Hash | `0x5881eea62f9876043df723cf89f0c2bb6f950da25e9dfe66995c24f919c8f8ab` |
+| 20000 gwei Key Hash | `0x64ae04e5dba58bc08ba2d53eb33fe95bf71f5002789692fe78fb3778f16121c9` |
+| Premium | 0.0005 LINK |
+| Max Gas Limit | 2,500,000 |
+| Minimum Confirmations | 1 |
+| Maximum Confirmations | 200 |
+| Maximum Random Values | 500 |
+
+### Fantom testnet
+
+:::note[Fantom Testnet Faucet]
+Testnet LINK is available from https://faucets.chain.link/fantom-testnet
+:::
+
+| Item | Value |
+| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| LINK Token | `0xfaFedb041c0DD4fA2Dc0d87a6B0979Ee6FA7af5F` |
+| VRF Coordinator | [`0xbd13f08b8352A3635218ab9418E340c60d6Eb418`](https://testnet.ftmscan.com/address/0xbd13f08b8352a3635218ab9418e340c60d6eb418) |
+| 3000 gwei Key Hash | `0x121a143066e0f2f08b620784af77cccb35c6242460b4a8ee251b4b416abaebd4` |
+| Premium | 0.0005 LINK |
+| Max Gas Limit | 2,500,000 |
+| Minimum Confirmations | 1 |
+| Maximum Confirmations | 200 |
+| Maximum Random Values | 500 |
+
+### Klaytn Baobab testnet
+
+:::note[Klaytn Testnet Faucet]
+Testnet LINK is available from [faucets.chain.link](https://faucets.chain.link/klaytn-testnet). Use the [KLAY Faucet](https://baobab.wallet.klaytn.foundation/faucet) to obtain testnet KLAY.
+:::
+
+| Item | Value |
+| --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| LINK Token | `0x04c5046A1f4E3fFf094c26dFCAA75eF293932f18` |
+| VRF Coordinator | [`0x771143FcB645128b07E41D79D82BE707ad8bDa1C`](https://baobab.scope.klaytn.com/address/0x771143FcB645128b07E41D79D82BE707ad8bDa1C) |
+| 750 gwei Key Hash | `0x9be50e2346ee6abe000e6d3a34245e1d232c669703efc44660a413854427027c` |
+| Premium | 0.005 LINK |
+| Max Gas Limit | 2,500,000 |
+| Minimum Confirmations | 1 |
+| Maximum Confirmations | 200 |
+| Maximum Random Values | 500 |
diff --git a/src/pages/vrf/v2/subscription/ui.md b/src/pages/vrf/v2/subscription/ui.md
new file mode 100644
index 00000000000..d2ec158b8d0
--- /dev/null
+++ b/src/pages/vrf/v2/subscription/ui.md
@@ -0,0 +1,120 @@
+---
+layout: ../../../../layouts/MainLayout.astro
+section: ethereum
+date: Last Modified
+title: "Subscription Manager User Interface"
+permalink: "docs/vrf/v2/subscription/ui/"
+whatsnext:
+ {
+ "Security Considerations": "/vrf/v2/security/",
+ "Best Practices": "/vrf/v2/best-practices/",
+ "Migrating from VRF v1 to v2": "/vrf/v2/subscription/migration-from-v1/",
+ "Supported Networks": "/vrf/v2/subscription/supported-networks/",
+ }
+metadata:
+ title: "Subscription Manager User Interface"
+ description: "Walkthrough Subscription Manager User Interface"
+setup: |
+ import VrfCommon from "@features/vrf/v2/common/VrfCommon.astro"
+---
+
+
+ * @version 1.0
+ */
+
+code[class*="language-"],
+pre[class*="language-"] {
+ color: #a9b7c6;
+ font-family: Consolas, Monaco, "Andale Mono", monospace;
+ direction: ltr;
+ text-align: left;
+ white-space: pre;
+ word-spacing: normal;
+ word-break: normal;
+ line-height: 1.5;
+
+ -moz-tab-size: 4;
+ -o-tab-size: 4;
+ tab-size: 4;
+
+ -webkit-hyphens: none;
+ -moz-hyphens: none;
+ -ms-hyphens: none;
+ hyphens: none;
+}
+
+pre[class*="language-"]::-moz-selection,
+pre[class*="language-"] ::-moz-selection,
+code[class*="language-"]::-moz-selection,
+code[class*="language-"] ::-moz-selection {
+ color: inherit;
+ background: rgba(33, 66, 131, 0.85);
+}
+
+pre[class*="language-"]::selection,
+pre[class*="language-"] ::selection,
+code[class*="language-"]::selection,
+code[class*="language-"] ::selection {
+ color: inherit;
+ background: rgba(33, 66, 131, 0.85);
+}
+
+/* Code blocks */
+pre[class*="language-"] {
+ padding: 1em;
+ margin: 0.5em 0;
+ overflow: auto;
+}
+
+:not(pre) > code[class*="language-"],
+pre[class*="language-"] {
+ background: #2b2b2b;
+}
+
+/* Inline code */
+:not(pre) > code[class*="language-"] {
+ padding: 0.1em;
+ border-radius: 0.3em;
+}
+
+.token.comment,
+.token.prolog,
+.token.cdata {
+ color: #808080;
+}
+
+.token.delimiter,
+.token.boolean,
+.token.keyword,
+.token.selector,
+.token.important,
+.token.atrule {
+ color: #cc7832;
+}
+
+.token.operator,
+.token.punctuation,
+.token.attr-name {
+ color: #a9b7c6;
+}
+
+.token.tag,
+.token.tag .punctuation,
+.token.doctype,
+.token.builtin {
+ color: #e8bf6a;
+}
+
+.token.entity,
+.token.number,
+.token.symbol {
+ color: #6897bb;
+}
+
+.token.property,
+.token.constant,
+.token.variable {
+ color: #9876aa;
+}
+
+.token.string,
+.token.char {
+ color: #6a8759;
+}
+
+.token.attr-value,
+.token.attr-value .punctuation {
+ color: #a5c261;
+}
+
+.token.attr-value .punctuation:first-child {
+ color: #a9b7c6;
+}
+
+.token.url {
+ color: #287bde;
+ text-decoration: underline;
+}
+
+.token.function {
+ color: #ffc66d;
+}
+
+.token.regex {
+ background: #364135;
+}
+
+.token.bold {
+ font-weight: bold;
+}
+
+.token.italic {
+ font-style: italic;
+}
+
+.token.inserted {
+ background: #294436;
+}
+
+.token.deleted {
+ background: #484a4a;
+}
+
+code.language-css .token.property,
+code.language-css .token.property + .token.punctuation {
+ color: #a9b7c6;
+}
+
+code.language-css .token.id {
+ color: #ffc66d;
+}
+
+code.language-css .token.selector > .token.class,
+code.language-css .token.selector > .token.attribute,
+code.language-css .token.selector > .token.pseudo-class,
+code.language-css .token.selector > .token.pseudo-element {
+ color: #ffc66d;
+}
diff --git a/src/styles/theme.css b/src/styles/theme.css
new file mode 100644
index 00000000000..bcdab87281b
--- /dev/null
+++ b/src/styles/theme.css
@@ -0,0 +1,87 @@
+/* Starter file. Has to be replaced with styles from design-system */
+:root {
+ --font-body: var(--font-family-text);
+ --font-mono: var(--font-family-code);
+
+ /*
+ * Variables with --color-base prefix define
+ * the hue, and saturation values to be used for
+ * hsla colors.
+ *
+ * ex:
+ *
+ * --color-base-{color}: {hue}, {saturation};
+ *
+ */
+
+ --color-base-white: 0, 0%;
+ --color-base-black: 240, 100%;
+ --color-base-gray: 215, 14%;
+ --color-base-blue: 212, 100%;
+ --color-base-blue-dark: 212, 72%;
+ --color-base-green: 158, 79%;
+ --color-base-orange: 22, 100%;
+ --color-base-purple: 269, 79%;
+ --color-base-red: 351, 100%;
+ --color-base-yellow: 41, 100%;
+
+ /*
+ * Color palettes are made using --color-base
+ * variables, along with a lightness value to
+ * define different variants.
+ *
+ */
+
+ --color-gray-5: var(--color-base-gray), 5%;
+ --color-gray-10: var(--color-base-gray), 10%;
+ --color-gray-20: var(--color-base-gray), 20%;
+ --color-gray-30: var(--color-base-gray), 30%;
+ --color-gray-40: var(--color-base-gray), 40%;
+ --color-gray-50: var(--color-base-gray), 50%;
+ --color-gray-60: var(--color-base-gray), 60%;
+ --color-gray-70: var(--color-base-gray), 70%;
+ --color-gray-80: var(--color-base-gray), 80%;
+ --color-gray-90: var(--color-base-gray), 90%;
+ --color-gray-95: var(--color-base-gray), 95%;
+
+ --color-blue: var(--color-base-blue), 61%;
+ --color-blue-dark: var(--color-base-blue-dark), 39%;
+ --color-green: var(--color-base-green), 42%;
+ --color-orange: var(--color-base-orange), 50%;
+ --color-purple: var(--color-base-purple), 54%;
+ --color-red: var(--color-base-red), 54%;
+ --color-yellow: var(--color-base-yellow), 59%;
+}
+
+:root {
+ --theme-accent: hsla(var(--color-blue), 1);
+ --theme-text-accent: hsla(var(--color-blue), 1);
+ --theme-accent-opacity: 0.15;
+ --theme-divider: hsla(var(--color-gray-95), 1);
+ --theme-text: hsla(var(--color-gray-10), 1);
+ --theme-text-light: hsla(var(--color-gray-40), 1);
+ /* @@@: not used anywhere */
+ --theme-text-lighter: hsla(var(--color-gray-80), 1);
+ --theme-bg: hsla(var(--color-base-white), 100%, 1);
+ --theme-bg-hover: hsla(var(--color-gray-95), 1);
+ --theme-bg-offset: hsla(var(--color-gray-90), 1);
+ --theme-bg-accent: hsla(var(--color-blue), var(--theme-accent-opacity));
+ --theme-code-inline-bg: hsla(var(--color-gray-95), 1);
+ --theme-code-inline-text: var(--theme-text);
+ --theme-code-bg: hsla(217, 19%, 27%, 1);
+ --theme-code-text: hsla(var(--color-gray-95), 1);
+ --theme-navbar-bg: hsla(var(--color-base-white), 100%, 1);
+ --theme-navbar-height: 88px;
+ --theme-selection-color: hsla(var(--color-blue), 1);
+ --theme-selection-bg: hsla(var(--color-blue), var(--theme-accent-opacity));
+}
+
+body {
+ background: var(--color-background-primary);
+ color: var(--color-text-primary);
+}
+
+::selection {
+ color: var(--theme-selection-color);
+ background-color: var(--theme-selection-bg);
+}
diff --git a/tsconfig.json b/tsconfig.json
index c320b78ae5f..29b8a241b94 100644
--- a/tsconfig.json
+++ b/tsconfig.json
@@ -1,73 +1,28 @@
{
+ "extends": "astro/tsconfigs/base",
"compilerOptions": {
- /* Visit https://aka.ms/tsconfig.json to read more about this file */
-
- /* Basic Options */
- // "incremental": true, /* Enable incremental compilation */
- "target": "es5" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */,
- "module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */,
- // "lib": [], /* Specify library files to be included in the compilation. */
- // "allowJs": true, /* Allow javascript files to be compiled. */
- // "checkJs": true, /* Report errors in .js files. */
- // "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', 'react', 'react-jsx' or 'react-jsxdev'. */
- // "declaration": true, /* Generates corresponding '.d.ts' file. */
- // "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
- // "sourceMap": true, /* Generates corresponding '.map' file. */
- // "outFile": "./", /* Concatenate and emit output to single file. */
- // "outDir": "./", /* Redirect output structure to the directory. */
- // "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
- // "composite": true, /* Enable project compilation */
- // "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */
- // "removeComments": true, /* Do not emit comments to output. */
- // "noEmit": true, /* Do not emit outputs. */
- // "importHelpers": true, /* Import emit helpers from 'tslib'. */
- // "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
- // "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
-
- /* Strict Type-Checking Options */
- "strict": true /* Enable all strict type-checking options. */,
- // "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
- // "strictNullChecks": true, /* Enable strict null checks. */
- // "strictFunctionTypes": true, /* Enable strict checking of function types. */
- // "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
- // "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
- // "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
- // "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */
-
- /* Additional Checks */
- // "noUnusedLocals": true, /* Report errors on unused locals. */
- // "noUnusedParameters": true, /* Report errors on unused parameters. */
- // "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
- // "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */
- // "noUncheckedIndexedAccess": true, /* Include 'undefined' in index signature results */
- // "noPropertyAccessFromIndexSignature": true, /* Require undeclared properties from index signatures to use element accesses. */
-
- /* Module Resolution Options */
- // "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
- // "baseUrl": "./", /* Base directory to resolve non-absolute module names. */
- // "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
- // "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
- // "typeRoots": [], /* List of folders to include type definitions from. */
- // "types": [], /* Type declaration files to be included in compilation. */
- // "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
- "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */,
+ // Enable top-level await, and other modern ESM features.
+ "target": "ESNext",
+ "module": "CommonJS",
+ // Enable node-style module resolution, for things like npm package imports.
+ "moduleResolution": "node",
+ // Enable JSON imports.
"resolveJsonModule": true,
- // "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
- // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
-
- /* Source Map Options */
- // "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
- // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
- // "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
- // "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
-
- /* Experimental Options */
- // "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
- // "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
-
- /* Advanced Options */
- "skipLibCheck": true /* Skip type checking of declaration files. */,
- "forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
- },
- "exclude": ["_site", "_includes"]
+ // Enable stricter transpilation for better output.
+ "isolatedModules": true,
+ "esModuleInterop": true,
+ // Add type definitions for our Vite runtime.
+ "types": ["vite/client"],
+ "baseUrl": ".",
+ "paths": {
+ "~/*": ["src/*"],
+ "@config": ["src/config/"],
+ "@config/*": ["src/config/*"],
+ "@features/*": ["src/features/*"],
+ "@variables": ["src/config/markdown-variables.ts"],
+ "@components/*": ["src/components/*"],
+ "@components": ["src/components/index.ts"],
+ "@abi": ["src/features/abi/index.ts"]
+ }
+ }
}
diff --git a/vercel.json b/vercel.json
new file mode 100644
index 00000000000..9da233752bf
--- /dev/null
+++ b/vercel.json
@@ -0,0 +1,412 @@
+{
+ "headers": [
+ {
+ "source": "/samples/(.*)",
+ "headers": [{ "key": "Access-Control-Allow-Origin", "value": "*" }]
+ }
+ ],
+ "cleanUrls": true,
+ "redirects": [
+ {
+ "source": "docs/any-api/api-reference/",
+ "destination": "any-api/api-reference",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/any-api/data-providers/dns-ownership/",
+ "destination": "any-api/data-providers/dns-ownership",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/any-api/data-providers/google-weather/",
+ "destination": "any-api/data-providers/google-weather",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/any-api/data-providers/introduction/",
+ "destination": "any-api/data-providers/introduction",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/any-api/find-oracle/",
+ "destination": "any-api/find-oracle",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/any-api/get-request/examples/api-array-response/",
+ "destination": "any-api/get-request/examples/array-response",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/any-api/get-request/examples/existing-job-request/",
+ "destination": "any-api/get-request/examples/existing-job-request",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/any-api/get-request/examples/large-responses/",
+ "destination": "any-api/get-request/examples/large-responses",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/any-api/get-request/examples/multi-variable-responses/",
+ "destination": "any-api/get-request/examples/multi-variable-responses",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/any-api/get-request/examples/single-word-response/",
+ "destination": "any-api/get-request/examples/single-word-response",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/any-api/get-request/introduction/",
+ "destination": "any-api/get-request/introduction",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/any-api/introduction/",
+ "destination": "any-api/introduction",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/any-api/testnet-oracles/",
+ "destination": "any-api/testnet-oracles",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/architecture-decentralized-model/",
+ "destination": "architecture-overview/architecture-decentralized-model",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/architecture-overview/",
+ "destination": "architecture-overview/architecture-overview",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/architecture-request-model/",
+ "destination": "architecture-overview/architecture-request-model",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/off-chain-reporting/",
+ "destination": "architecture-overview/off-chain-reporting",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/chainlink-automation/automation-economics",
+ "destination": "chainlink-automation/automation-economics",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/chainlink-automation/automation-release-notes",
+ "destination": "chainlink-automation/automation-release-notes",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/chainlink-automation/compatible-contracts",
+ "destination": "chainlink-automation/compatible-contracts",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/chainlink-automation/faqs",
+ "destination": "chainlink-automation/faqs",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/chainlink-automation/flexible-upkeeps",
+ "destination": "chainlink-automation/flexible-upkeeps",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/chainlink-automation/introduction",
+ "destination": "chainlink-automation/introduction",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/chainlink-automation/job-scheduler",
+ "destination": "chainlink-automation/job-scheduler",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/chainlink-automation/manage-upkeeps",
+ "destination": "chainlink-automation/manage-upkeeps",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/chainlink-automation/overview",
+ "destination": "chainlink-automation/overview",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/chainlink-automation/register-upkeep",
+ "destination": "chainlink-automation/register-upkeep",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/chainlink-automation/supported-networks",
+ "destination": "chainlink-automation/supported-networks",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/chainlink-automation/util-overview",
+ "destination": "chainlink-automation/util-overview",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/chainlink-automation/utility-contracts",
+ "destination": "chainlink-automation/utility-contracts",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/data-feeds/deprecating-feeds/",
+ "destination": "data-feeds/deprecating-feeds",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/data-feeds/ens/",
+ "destination": "data-feeds/ens",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/data-feeds/feed-registry/feed-registry-functions/",
+ "destination": "data-feeds/feed-registry/feed-registry-functions",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/data-feeds/feed-registry/",
+ "destination": "data-feeds/feed-registry/index",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/data-feeds/",
+ "destination": "data-feeds/index",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/data-feeds/l2-sequencer-feeds/",
+ "destination": "data-feeds/l2-sequencer-feeds",
+ "statusCode": 301
+ },
+ {
+ "source": "/docs/data-feeds/nft-floor-price/addresses/",
+ "destination": "data-feeds/nft-floor-price/addresses",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/data-feeds/nft-floor-price/",
+ "destination": "data-feeds/nft-floor-price/index",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/data-feeds/price-feeds/addresses/",
+ "destination": "data-feeds/price-feeds/addresses",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/data-feeds/price-feeds/api-reference/",
+ "destination": "data-feeds/price-feeds/api-reference",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/data-feeds/price-feeds/historical-data/",
+ "destination": "data-feeds/price-feeds/historical-data",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/data-feeds/price-feeds/",
+ "destination": "data-feeds/price-feeds/index",
+ "statusCode": 301
+ },
+ {
+ "source": "/docs/data-feeds/proof-of-reserve/addresses/",
+ "destination": "data-feeds/proof-of-reserve/addresses",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/data-feeds/proof-of-reserve/",
+ "destination": "data-feeds/proof-of-reserve/index",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/data-feeds/selecting-data-feeds/",
+ "destination": "data-feeds/selecting-data-feeds",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/acquire-link/",
+ "destination": "resources/acquire-link",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/contributing-to-chainlink/",
+ "destination": "resources/contributing-to-chainlink",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/create-a-chainlinked-project/",
+ "destination": "resources/create-a-chainlinked-project",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/developer-communications/",
+ "destination": "resources/developer-communications",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/ethereum-proof-of-stake-merge/",
+ "destination": "resources/ethereum-proof-of-stake-merge",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/example-projects/",
+ "destination": "resources/example-projects",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/fund-your-contract/",
+ "destination": "resources/fund-your-contract",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/getting-help/",
+ "destination": "resources/getting-help",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/glossary/",
+ "destination": "resources/glossary",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/hackathon-resources/",
+ "destination": "resources/hackathon-resources",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/hackathon-rules-waiver-release-and-code-of-conduct/",
+ "destination": "resources/hackathon-rules-waiver-and-release",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/link-token-contracts/",
+ "destination": "resources/link-token-contracts",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/solana/data-feeds-solana/",
+ "destination": "solana/data-feeds/data-feeds-solana",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/solana/using-data-feeds-off-chain/",
+ "destination": "solana/data-feeds/using-data-feeds-off-chain",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/solana/using-data-feeds-solana/",
+ "destination": "solana/data-feeds/using-data-feeds-solana",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/solana/",
+ "destination": "solana/overview",
+ "statusCode": 301
+ },
+ { "source": "/solana/", "destination": "solana", "statusCode": 301 },
+ {
+ "source": "docs/vrf/v1/api-reference/",
+ "destination": "vrf/v1/api-reference",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/vrf/v1/best-practices/",
+ "destination": "vrf/v1/best-practices",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/vrf/v1/examples/get-a-random-number/",
+ "destination": "vrf/v1/examples/get-a-random-number",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/vrf/v1/introduction/",
+ "destination": "vrf/v1/introduction",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/vrf/v1/security/",
+ "destination": "vrf/v1/security",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/vrf/v1/supported-networks/",
+ "destination": "vrf/v1/supported-networks",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/vrf/v2/best-practices/",
+ "destination": "vrf/v2/best-practices",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/vrf/v2/direct-funding/",
+ "destination": "vrf/v2/direct-funding/design",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/vrf/v2/direct-funding/examples/get-a-random-number/",
+ "destination": "vrf/v2/direct-funding/examples/get-a-random-number",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/vrf/v2/direct-funding/migration-from-v1/",
+ "destination": "vrf/v2/direct-funding/migration-from-v1",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/vrf/v2/direct-funding/supported-networks/",
+ "destination": "vrf/v2/direct-funding/supported-networks",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/vrf/v2/introduction/",
+ "destination": "vrf/v2/introduction",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/vrf/v2/security/",
+ "destination": "vrf/v2/security",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/vrf/v2/subscription/",
+ "destination": "vrf/v2/subscription/design",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/vrf/v2/subscription/examples/get-a-random-number/",
+ "destination": "vrf/v2/subscription/examples/get-a-random-number",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/vrf/v2/subscription/examples/programmatic-subscription/",
+ "destination": "vrf/v2/subscription/examples/programmatic-subscription",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/vrf/v2/subscription/migration-from-v1/",
+ "destination": "vrf/v2/subscription/migration-from-v1",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/vrf/v2/subscription/supported-networks/",
+ "destination": "vrf/v2/subscription/supported-networks",
+ "statusCode": 301
+ },
+ {
+ "source": "docs/vrf/v2/subscription/ui/",
+ "destination": "vrf/v2/subscription/ui",
+ "statusCode": 301
+ }
+ ]
+}
- 
- 
- 
- 
- 
- 
-