Actions

Node Management Index: Difference between revisions

From Chainlink Community Wiki

No edit summary
No edit summary
 
(46 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Chainlink Node Management Index ==


=== This page is an index of the various docs and guides hosted on this site that will help manage and maintain a Chainlink Node. Please feel free to contact us with suggestions or if you'd like to contribute. ===
== [[File:Index.png|left|frameless|30x30px]] '''Node Management Index''' ==


==== Accessing Chianlink Node CLI ====
The purpose of this page is to provide an index of content made available to you on this wiki.
Many of the  tasks on this page require you to have access to the Chianlink Node's CLI.


To access the CLI, you must attach to your Chainlink container's bash tty session
This content is either not indexed elsewhere, or does not exist outside of this wiki.


<code>docker exec -it $CONTAINER_NAME /bin/bash</code>


----
[[File:Pencil.png|left|frameless|30x30px]]
=== '''Environment Variable Details''' ===


Once connected, for the majority of the tasks you will want to accompish, you'll need to authenticate via your API credentials (the same credentials you use to access the web UI)


<code>chainlink admin login</code>
When you deploy a Chainlink Node, you need to create a .env file to include in your container's instantiation.


The purpose of this file is to override the default configuration your Chainlink node would set without it.


Now that you've authenticated with your API credentials, we can accomplish some more nuanced tasks that are not available via the web UI.


----
=== '''Miscellaneous Trouble Shooting''' ===
* [https://wiki.dextrac.com/index.php/Node-stuck-on-nonce Node stuck on incorrect nonce]


=== Chainlink Node Private Key Management ===


==== '''Where to Find Your Key(s)''' ====
----
* The command you want to run will vary based on the type of keys you're looking for
[[File:Pencil.png|left|frameless|30x30px]]
** CSA keys
=== '''External Initiators''' ===
*** <code>chainlink keys csa list</code>
** Ethereum/EVM keys
*** <code>chainlink keys eth list</code>
** OCR keys
*** <code>chainlink keys ocr list</code>
** OCR 2 keys
*** <code>chainlink keys ocr2 list</code>
** P2P keys
*** <code>chainlink keys p2p list</code>
** Solana keys
*** <code>chainlink keys solana list</code>
** Terra keys
*** <code>chainlink keys terra list</code>
** VRK keys
*** <code>chainlink keys vrf list</code>


==== '''Generate New Key(s)''' ====
* This command will vary based on which key's you're creating
** CSA keys
*** <code>chainlink keys csa create</code>
** Ethereum/EVM keys
*** <code>chainlink keys eth create --evmChainID 1</code>
** OCR keys
*** <code>chainlink keys ocr create</code>
** OCR 2 keys
*** <code>chainlink keys ocr2 create</code>
** P2P keys
*** <code>chainlink keys p2p create</code>
** Solana keys
*** <code>chainlink keys solana create</code>
** Terra keys
*** <code>chainlink keys terra create</code>
** VRK keys
*** <code>chainlink keys vrf create</code>


=== '''Exporting Your Private Keys''' ===
If you'd like to export your private keys, the following steps will provide you with directions and examples


While connected to, and authenticated with, the Chainlink CLI, we will want to:
----
[[File:Construction.png|left|frameless|30x30px]]
=== '''Job Management''' ===
Chainlink Nodes require jobs in order for them to know what is expected of them.


# List our keys to identify which one(s) we wish to export.
==== '''Example JobSpecs''' ====
# Create a file containing our password used to encrypt the exported password.
Below you will find example jobspecs for each job type that the Chainlink Node Supports
# Export our password.
# Copy the private key file to our host.


In the below example, we will be exporting an Ethereum mainnet private key.
===== '''Direct Request Example''' =====
Please click above to navigate to Direct Request (DR) / RunLog (RL) example spec


==== List our keys to identify which one(s) we wish to export. ====
===== '''FluxMonitor Example''' =====
<code>chainlink keys eth list</code>
Please click above to navigate to FluxMonitor (FM) example spec


==== Create a file containing our password used to encrypt the exported password. ====
===== '''Off Chain Reporting Example''' =====
<code>echo "$YOURPASSWORD" > passwordFile</code>
Please click above to navigate to Off Chain Reporting (OCR) example spec


====  Export our password. ====
<code>chainlink keys eth export $0xKEY_ADDRESS --newpassword passwordFile --output $NAME_FOR_PRIAVTEKEY_FILE</code>


====  Copy the private key file to our host. ====
<code>docker cp $CONTAINER_NAME:/chainlink/$NAMEFOR_PRIVATEKEY_FILE /host/path/target</code>


Now that the file is on your Docker host, you can scp it somewhere else, or whatever you'd like to do with it.
----
[[File:Bridge.png|left|frameless|30x30px]]
=== '''Bridge Management''' ===
Chainlink Nodes use bridges to enable a key:value association local to the Chainlink Node.


This enables the node operator to modify where a bridge points to without having to redeploy every job that references that data source


=== '''Importing/Replacing Your Private Keys''' ===
==== '''Adding / Replacing / Removing Bridges''' ====
In some situations, you may find yourself in need of importing your own keys, or perhaps you've gotten a borked node and want to export your old keys and import them into a newly built Chainlink node.
This page will provide directions on managing your bridges and all potential "gotchas" that you may run into


Whatever your situation, the steps below will assist


==== '''Key Format''' ====
In order for your keys to be accepted for use in the Chainlink node, they must be in the proper, single line, json format.


An example is shown below:
----
[[File:Key.png|left|frameless|30x30px]]
=== '''Key Managmeent''' ===


<pre style="white-space:pre-wrap; width:100%; border:1px solid lightgrey; background:black; color:white;">{"address":"bdcfbbd9da176e233d5a8d9a77905c2853bf10a9","crypto":{"cipher":"aes-128-ctr","ciphertext":"69ecad9449d479b7c2dc7eac19131da1af9bb64347d33e5b3bff314c7a3710f9","cipherparams":{"iv":"dd4535b11fa85e25fe0b9d4f2889aa66"},"kdf":"scrypt","kdfparams":{"dklen":32,"n":262144,"p":1,"r":8,"salt":"4be7fad8f62c395bbb7457e1e398f37a346f36df6673c377dd91d0efe201821f"},"mac":"9a7c8461b60b98d16376e665b290aecf75620d8276799fbe75045dbbf2b3bdd8"},"id":"bdcfbbd9-da17-6e23-3d5a-8d9a77905c28","version":3}</pre>
==== [[Node Key Management|'''Chainlink Node Account Private Keys''']] ====
The Chainlink Node manages its own wallet's private keys keys for each network type it supports.  At the time of this writing, that includes Layer One and Layer Two EVM chains, Solana, and Terra.
 
These wallets are responsible for paying the transaction fees associated with writing data on-chain for each network.
 
==== '''CSA Keys''' ====
The purpose of the CSA keys is for an unreleased feature.  No more details can be provided at this time.
 
==== '''OCR Keys''' ====
The purpose of your OCR keys is to enable OCR communication between the nodes.
 
Each Chainlink node has their own OCR keys.  Modifying these keys in any manner is not suggested.
 
==== '''P2P Keys''' ====
Similar to the OCR keys, the P2P keys enable peer to peer communication among the Chainlink Nodes
 
==== '''VRF Keys''' ====
The VRF Keys are specifically for the VRF functionality.  No more details are available at this time.

Latest revision as of 20:40, 9 January 2023

Index.png
Node Management Index

The purpose of this page is to provide an index of content made available to you on this wiki.

This content is either not indexed elsewhere, or does not exist outside of this wiki.


Pencil.png

Environment Variable Details

When you deploy a Chainlink Node, you need to create a .env file to include in your container's instantiation.

The purpose of this file is to override the default configuration your Chainlink node would set without it.


Miscellaneous Trouble Shooting


Pencil.png

External Initiators

Construction.png

Job Management

Chainlink Nodes require jobs in order for them to know what is expected of them.

Example JobSpecs

Below you will find example jobspecs for each job type that the Chainlink Node Supports

Direct Request Example

Please click above to navigate to Direct Request (DR) / RunLog (RL) example spec

FluxMonitor Example

Please click above to navigate to FluxMonitor (FM) example spec

Off Chain Reporting Example

Please click above to navigate to Off Chain Reporting (OCR) example spec


Bridge.png

Bridge Management

Chainlink Nodes use bridges to enable a key:value association local to the Chainlink Node.

This enables the node operator to modify where a bridge points to without having to redeploy every job that references that data source

Adding / Replacing / Removing Bridges

This page will provide directions on managing your bridges and all potential "gotchas" that you may run into


Key.png

Key Managmeent

Chainlink Node Account Private Keys

The Chainlink Node manages its own wallet's private keys keys for each network type it supports. At the time of this writing, that includes Layer One and Layer Two EVM chains, Solana, and Terra.

These wallets are responsible for paying the transaction fees associated with writing data on-chain for each network.

CSA Keys

The purpose of the CSA keys is for an unreleased feature. No more details can be provided at this time.

OCR Keys

The purpose of your OCR keys is to enable OCR communication between the nodes.

Each Chainlink node has their own OCR keys. Modifying these keys in any manner is not suggested.

P2P Keys

Similar to the OCR keys, the P2P keys enable peer to peer communication among the Chainlink Nodes

VRF Keys

The VRF Keys are specifically for the VRF functionality. No more details are available at this time.

Retrieved from "https://wiki.dextrac.com:3443/index.php?title=Node_Management_Index&oldid=3836"