# Setting Up Chainlink Automation

Welcome to the Guide for using Chainlink Automation to auto-claim your weekly staking rewards on Horizon Stake.

The following guide will take you through the process of setting Chainlink Automation up (screenshots may reflect and older version of the UI).

{% hint style="info" %}
Note that setting up Chainlink Automation for Horizon Stake will help with auto-claiming, but it does not auto-burn to fix your C-Ratio. 

We will be looking into how to potentially include auto-burning into the Chainlink Automation contract so it can be completely hands-off in the future.
{% endhint %}

#### Chainlink Automation Quick Start

[Step 0. Grant Contract Authorization](#step-0.-grant-contract-authorization)\
[Step 1. Get LINK BEP-20 Tokens](#step-1.-get-link-bep-20-tokens)\
[Step 2. Convert LINK BEP-20 to BEP-677](#step-2.-convert-link-bep-20-to-bep-677)\
[Step 3. Register Upkeep](#step-3.-register-upkeep)\
[Step 4. Auto-Claiming](#step-4.-auto-claiming)\
[Optional Step 5. Canceling Your Upkeep](#optional-step-5.-canceling-your-upkeep)

### What is Chainlink Automation?

Chainlink Automation is a decentralized automation service. For Horizon Stake, the way Chainlink Automation works is it will check every block to see if a reward claim is available. If it is, it will automatically claim your rewards for you on your behalf. Each claim transaction will cost LINK tokens, though checking if a claim is available or not is free and will not cost anything.

{% hint style="warning" %}
Before you start, it is important to note that a Chainlink Automation upkeep costs money to maintain. A minimum balance of LINK tokens is required to be stored in an upkeep for it to operate and each weekly claim will deduct a small amount of LINK tokens.

Also, the entire process currently is only supported by MetaMask wallet.
{% endhint %}

To activate, you need to give the Chainlink Automation upkeep contract permission to take the actions you want and deposit enough money (in the form of ERC-677 LINK tokens) for it to take these actions for you.

For more information about Chainlink Automation, you can read about it here: 

{% embed url="<https://docs.chain.link/docs/chainlink-automation/introduction/>" %}

One of the most important questions will be how many LINK tokens are required to maintain an upkeep. There is specific documentation regarding this available here:&#x20;

{% embed url="<https://docs.chain.link/docs/chainlink-automation/manage-upkeeps/>" %}

### Step 0. Grant Contract Authorization

The pre-requisite step is to allow the Chainlink Automation upkeep contract to claim for you by giving it permission to claim on your behalf.

The target contract address you will be giving permission to is: \
0xa623F29ae4cEd27dFBB39a94152F3184140f6c21

To grant authorization, please complete the following steps:

<figure><img src="https://content.gitbook.com/content/BrNnH1lxpRlQwwFmJoqL/blobs/ggzG5dpoe3ErRfqntkyG/Authorize%20-%20Connected%20-%20No%20Input%20-%20No%20Data.png" alt=""><figcaption><p>Go to the “Authorize” tab on the “Account” page.</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/BrNnH1lxpRlQwwFmJoqL/blobs/QvG7QYCUiI9lZnl8hR4H/Authorize%20-%20Connected%20-%20With%20Inputs%20-%20Full%20Data.png" alt=""><figcaption><p>Add the wallet/contract address to authorize and select what permissions to give it. Below in "Manage Authorizations", you can see all permissions that have been given out previously with the ability to remove these permissions at any time. </p></figcaption></figure>

You should get a wallet confirmation screen as shown below.

<figure><img src="https://content.gitbook.com/content/BrNnH1lxpRlQwwFmJoqL/blobs/Uh6LUJ85gzY3A5awmgxD/0_Grant_Permission_BSCScan_03.png" alt=""><figcaption><p>Your wallet will ask you to confirm.</p></figcaption></figure>

Once confirmed, authorization will have been completed.

### Step 1. Get LINK BEP-20 Tokens

The first thing you will need to do to create a Chainlink Automation Upkeep is to acquire LINK tokens.

1. You can acquire LINK BEP-20 tokens at DEXs, such as PancakeSwap, or CEXs, such as Binance. It is recommended to buy at least **10 LINK tokens** to maintain your Auto-Claim Upkeep. This balance could maintain your upkeep for about 4-5 months, but the true duration is based on market prices.
2. If you are buying LINK tokens on a CEX, such as Binance, make sure you are withdrawing the LINK onto the BNB Chain (BEP-20 token) and not withdrawing onto the Ethereum chain (ERC-20 token). Since the Chainlink Automation upkeep is operating on the BNB Chain for Horizon Protocol, it must be a BEP-20 LINK token.

The screenshots below will focus on using PancakeSwap to buy LINK BEP-20 tokens:

{% embed url="<https://pancakeswap.finance/swap?outputCurrency=0xF8A0BF9cF54Bb92F17374d9e9A321E6a111a51bD>" %}

<figure><img src="https://content.gitbook.com/content/BrNnH1lxpRlQwwFmJoqL/blobs/4qOWipjVKyyqUaS9i8Zb/1_Get_LINK_BEP-20_Tokens_03.png" alt=""><figcaption><p>Connect your wallet to PancakeSwap. Click on "CAKE" on the right side Swap section of the page to open the modal.</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/BrNnH1lxpRlQwwFmJoqL/blobs/CpYVVq0WmsHMxFjJWVM1/1_Get_LINK_BEP-20_Tokens_04.png" alt=""><figcaption><p>Find the LINK token. You can access this modal by clicking on a token on the Swap screen. Search for LINK. Click Import.</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/BrNnH1lxpRlQwwFmJoqL/blobs/osGPqG79Lyt6QKvfZxPp/1_Get_LINK_BEP-20_Tokens_05.png" alt=""><figcaption><p>After clicking Import, you will see this. Check "I understand" and then click "Import".</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/BrNnH1lxpRlQwwFmJoqL/blobs/yghcZ1GcoEMQnA7ltj2e/1_Get_LINK_BEP-20_Tokens_07.png" alt=""><figcaption><p>If you are using MetaMask, you will see the following pop up. Click Add Token.</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/BrNnH1lxpRlQwwFmJoqL/blobs/uDhHgrHYSKq9oQFrVxIb/1_Get_LINK_BEP-20_Tokens_11.png" alt=""><figcaption><p>You will now see LINK selected in the Swap section of the page. Enter the amount you want to trade for.</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/BrNnH1lxpRlQwwFmJoqL/blobs/ZUXOr6hy3cFvxG0FnwVL/1_Get_LINK_BEP-20_Tokens_08.png" alt=""><figcaption><p>We will be trading for 6 LINK with BNB.</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/BrNnH1lxpRlQwwFmJoqL/blobs/9bg0zFwn02nvZaA9wMzk/1_Get_LINK_BEP-20_Tokens_09.png" alt=""><figcaption><p>The MetaMask transaction (to show approximate fees involved).</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/BrNnH1lxpRlQwwFmJoqL/blobs/f5LcAnrhS85HZJiBpzoe/1_Get_LINK_BEP-20_Tokens_10.png" alt=""><figcaption><p>Once the Transaction has been submitted, you will get this screen. If LINK is not already in your wallet as a token, you can click "Add LINK to Wallet". You can also always click the MetaMask fox logo in the Swap section to prompt adding the token to your wallet.</p></figcaption></figure>

### Step 2. Convert LINK BEP-20 to BEP-677

Chainlink Automation uses a special wrapped ERC-677 format, which allows you to include additional data along with the contract. This functionality is required for Chainlink Automation upkeep to be able to perform its decentralized automation.

In this step, we will be converting LINK BEP-20 into a LINK BEP-677 token.

{% hint style="info" %}
Fun fact: the LINK BEP-677 token is a wrapped ERC677 token, which is a synthetic asset that uses the original BEP-20 token as collateral.
{% endhint %}

To convert, we will be going to the following website:

{% embed url="<https://pegswap.chain.link/>" %}

<figure><img src="https://content.gitbook.com/content/BrNnH1lxpRlQwwFmJoqL/blobs/Kqp6rCO2e1hA6bFPoTSx/2_Convert_to_LINK_BEP-677_02.png" alt=""><figcaption><p>When you first get to https://pegswap.chain.link/, you will need to connect your wallet.</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/BrNnH1lxpRlQwwFmJoqL/blobs/bgdFiyG0ft9JjELkV3Ni/2_Convert_to_LINK_BEP-677_03.png" alt=""><figcaption><p>Connect your wallet to Pegswap. Always confirm that the address is correct.</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/BrNnH1lxpRlQwwFmJoqL/blobs/KDy6J6ptztJO1wZY9YAQ/2_Convert_to_LINK_BEP-677_04.png" alt=""><figcaption><p>Once your wallet is connected, you can go ahead and type in what you want to swap. Your wallet should show and you should see Binance Pegged LINK and Wrapped ERC677 LINK in the "Swap Chainlink" section.</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/BrNnH1lxpRlQwwFmJoqL/blobs/kB4xmjY5z5l0sLh5NXEj/2_Convert_to_LINK_BEP-677_06.png" alt=""><figcaption><p>When you click Swap, this will show up in your wallet (this is in MetaMask, other wallets might be slightly different). You will need to give it permission. In this guide, we will be converting all of our LINK BEP-20 (all 6 tokens).</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/BrNnH1lxpRlQwwFmJoqL/blobs/lR0xbXry8H9dCViUjyyQ/2_Convert_to_LINK_BEP-677_08.png" alt=""><figcaption><p>Here are the transaction fees. Click confirm (off screen to the bottom) to finish the Swap.</p></figcaption></figure>

After a successful swap, the PegSwap page will typically freeze. Just refresh it (this is a known bug) and it should show your tokens have swapped.&#x20;

Lastly, if you want to add the token to your Metamask wallet, this is the Wrapped ERC677 LINK token address for the BNB Chain: 0x404460C6A5EdE2D891e8297795264fDe62ADBB75

More details on the contract address here:

{% embed url="<https://docs.chain.link/docs/link-token-contracts/#bnb-chain>" %}

### Step 3. Register Upkeep

We are at the final step of this process.

We will now register your upkeep:&#x20;

{% embed url="<https://automation.chain.link/bsc>" %}

<figure><img src="https://content.gitbook.com/content/BrNnH1lxpRlQwwFmJoqL/blobs/iHTmNids1ImDxhAAZWEy/3_Register_Keepers_01.png" alt=""><figcaption><p>This is the Chainlink Automation page.</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/BrNnH1lxpRlQwwFmJoqL/blobs/DN3sP3Srlgd3Mut1SZzO/3_Register_Keepers_02.png" alt=""><figcaption><p>Connect your wallet. Currently only supports MetaMask.</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/BrNnH1lxpRlQwwFmJoqL/blobs/FRaJdbUS9yEIFjsjRpfN/3_Register_Keepers_05.png" alt=""><figcaption><p>MetaMask pop up to Connect.</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/BrNnH1lxpRlQwwFmJoqL/blobs/9ON3CMUgpGOvOWQS2elU/3_Register_Keepers_08.png" alt=""><figcaption><p>After connecting, you should be able to click on your wallet to confirm that you already have LINK tokens ready. Next, click "Register new Upkeep" to get started.</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/BrNnH1lxpRlQwwFmJoqL/blobs/TT0ilpcvWgE7r5REErLg/3_Register_Keepers_09.png" alt=""><figcaption><p>Select "Custom logic".</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/BrNnH1lxpRlQwwFmJoqL/blobs/rR22LJ0oSoCO8A9h6eIN/3_Register_Keepers_12.png" alt=""><figcaption><p>Input the Target contract address (address available below).</p></figcaption></figure>

Target contract address: 0xa623F29ae4cEd27dFBB39a94152F3184140f6c21

<figure><img src="https://content.gitbook.com/content/BrNnH1lxpRlQwwFmJoqL/blobs/H0T6fE9liWYNvwshyaEv/3_Register_Keepers_14.png" alt=""><figcaption><p>Fill in the above information and then click "Register Upkeep". Information details below.</p></figcaption></figure>

Information to be written above:

* **Upkeep Name**: Horizon Protocol Auto-Claim\
  (limited length, you can choose whatever name)
* **Gas limit**: 700,000\
  (gas limit will be higher than how much it would cost to just claim directly because it is a contract calling another contract. Typical gas required for small transactions are around 250000, within the same order of magnitude. It is unusual to see 2300 as a gas limit written in the text box.)
* **Starting Balance** (LINK): 10+ \
  (add how much LINK, the wrapped ERC677 ones, that you want to deposit into your upkeep. It is recommended to deposit at least 10 as the Minimum Balance to maintain the upkeep can fluctuate based on market prices)
* **Check data (Hexadecimal)**: Your Wallet Address \
  (Is the public address of your wallet you want to claim rewards on)
* **Your email address**\
  (Email Needed for Upkeep notifications)

The above information can be changed later, but it will cost a transaction.

<figure><img src="https://content.gitbook.com/content/BrNnH1lxpRlQwwFmJoqL/blobs/ygbFo928UMsdWOWRC9Uq/3_Register_Keepers_15.png" alt=""><figcaption><p>Once you click "Register Upkeep", the submission will be in process and your MetaMask will prompt you for confirmation.</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/BrNnH1lxpRlQwwFmJoqL/blobs/4RJ9EXvkIOkIXqsrZCuE/3_Register_Keepers_16.png" alt=""><figcaption><p>MetaMask confirmation with transaction cost.</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/BrNnH1lxpRlQwwFmJoqL/blobs/3wIDNUnit7cMXnTuo79H/3_Register_Keepers_17.png" alt=""><figcaption><p>Once confirmed, the Upkeep page will look like this. Please wait until the transaction is confirmed.</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/BrNnH1lxpRlQwwFmJoqL/blobs/oEsP2xPlDeL3YY3XKAoF/3_Register_Keepers_18.png" alt=""><figcaption><p>Once the transaction confirmed, you will see this.</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/BrNnH1lxpRlQwwFmJoqL/blobs/Re3sHE06ZXZPrSpxMC69/3_Register_Keepers_19.png" alt=""><figcaption><p>Upon completion, your Upkeep page should look like this, with "Status" showing "Active".</p></figcaption></figure>

If everything is set up properly and you have rewards to claim with the proper C-Ratio, the Upkeep should immediately claim your rewards for you.

Remember to refresh your Upkeep page until the "Minimum Balance" shows up. "Balance" should also show up.

Here you will find additional information about automation costs:&#x20;

{% embed url="<https://docs.chain.link/docs/chainlink-automation/automation-economics/#minimum-balance>" %}
&#x20;\[gas limit] \* \[current gas price] \* \[gasCeilingMultiplier]
{% endembed %}

### Step 4. Auto-Claiming

This isn't really a step, but just showing how the Auto-Claiming will work.

<figure><img src="https://content.gitbook.com/content/BrNnH1lxpRlQwwFmJoqL/blobs/netm4n7jhVdpKmxPRyDF/4_Auto_Claim_01.png" alt=""><figcaption><p>If you had not claimed before you set up an Upkeep and a Claim was available, this is what your Claim page will look like before.</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/BrNnH1lxpRlQwwFmJoqL/blobs/RbvwJWbWyVDfcbZbwTyR/4_Auto_Claim_02.png" alt=""><figcaption><p>And this is what your Claim page will look like after (basically, you didn't click "Claim Now" because your Upkeep claimed for you). Note that the Upkeep can only Claim when you have the proper C-Ratio. The Upkeep currently cannot auto-burn for you.</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/BrNnH1lxpRlQwwFmJoqL/blobs/4h0zcdc7x6ZHMbJZhj5P/4_Auto_Claim_03.png" alt=""><figcaption><p>If you go to https://automation.chain.link/, you will see "Perform Upkeep" in History.</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/BrNnH1lxpRlQwwFmJoqL/blobs/8gKwJ9IvRS9UBZflHHpe/4_Auto_Claim_05.png" alt=""><figcaption><p>If you go to <a href="https://bscscan.com/address/0x9657a0FD98e88464E1159d98b517A4945dbFBFC8">https://bscscan.com/address/0x9657a0FD98e88464E1159d98b517A4945dbFBFC8</a>, you should also be able to see your automated transaction.</p></figcaption></figure>

For reference, the automated Upkeep transaction cost $1.22 ($0.95 + 30% premium). The 30% premium on BNB Chain is lower than on any of the other chains. You can compare here:&#x20;

{% embed url="<https://docs.chain.link/docs/chainlink-automation/supported-networks/>" %}

The above Upkeep transaction can also be found here:&#x20;

{% embed url="<https://keepers.chain.link/bsc/61895360697707478624580988307616544952190176251316156526569833881526378957381>" %}

### Optional Step 5. Canceling Your Upkeep

The final step is for canceling Upkeeps. Canceling your Upkeep consists of two parts:

1. Cancel Upkeep
2. Withdraw Funds

We can start this step by going back to <https://automation.chain.link/bsc>. Make sure your wallet is connected.

<figure><img src="https://content.gitbook.com/content/BrNnH1lxpRlQwwFmJoqL/blobs/VngBOvMa4p5JcKZDT3QJ/5_Cancel_Keepers_01.png" alt=""><figcaption><p>Click on "Actions", and then "Cancel upkeep".</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/BrNnH1lxpRlQwwFmJoqL/blobs/vJ1aKq96ZyVypk79quSf/5_Cancel_Keepers_03.png" alt=""><figcaption><p>MetaMask prompt for confirmation.</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/BrNnH1lxpRlQwwFmJoqL/blobs/B7kUZiwxVuIJqD3vKZbw/5_Cancel_Keepers_02.png" alt=""><figcaption><p>Waiting for final confirmation.</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/BrNnH1lxpRlQwwFmJoqL/blobs/y1plS4njkNLZoFJCRvor/5_Cancel_Keepers_04.png" alt=""><figcaption><p>Transaction confirmation that upkeep is cancelled.</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/BrNnH1lxpRlQwwFmJoqL/blobs/ALfWiKty9cIfIuK68BjI/5_Cancel_Keepers_07.png" alt=""><figcaption><p>Your "Status" should now say "Cancelled". Click on "Actions" to "Withdraw funds".</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/BrNnH1lxpRlQwwFmJoqL/blobs/Liyc4gQUw5tkA2pteUHO/5_Cancel_Keepers_09.png" alt=""><figcaption><p>Confirm the "Withdrawal address" is your wallet. Click Confirm.</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/BrNnH1lxpRlQwwFmJoqL/blobs/fLM0EQLrvh9y0Q2yYyJc/5_Cancel_Keepers_10.png" alt=""><figcaption><p>MetaMask confirmation screen.</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/BrNnH1lxpRlQwwFmJoqL/blobs/UHNHoHXOR9O7GCkMIMsV/5_Cancel_Keepers_11.png" alt=""><figcaption><p>Waiting for transaction confirmation.</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/BrNnH1lxpRlQwwFmJoqL/blobs/Jvftk1FIl2AuB6dJ8tCK/5_Cancel_Keepers_13.png" alt=""><figcaption><p>Funds withdrawn.</p></figcaption></figure>

The process for Cancel Upkeep and Withdraw Funds will lose you a bit of LINK (in this case, we went from 6 --> 5.9).

If you check your wallet, you should see your LINK there. Note that this is still the Wrapped LINK ERC677 token. You will need to go to Step 2. and perform a reverse swap to get back LINK BEP-20 tokens.