Quick start

A quick way to start interacting with the protocol is to deploy it locally. This requires several actions:

1. Having a development blockchain running.

2. Having an IPFS node running.

3. Having a development External Adapter running.

4. Deploy the contracts to the local blockchain.

5. Having, at least, 1 Chainlink Node running.

6. Configure the Chainlink Node with the proper jobs and bridges, depending on the contracts deployed.

All this can be achieved easily in a few simple steps:

Prerequisites

Please ensure you have the following installed in order to successfully deploy and start using the Developer Toolkit (DTK)

• Docker

• Hardhat

• Node.js version 16.13.0 LTS (We recommend using nvm)

• npm version 8.13.2

Do you feel like life is too short to read documentations?

TLDR; copy the code pieces and execute them in the order they appear in this section, and voila! DSLA deployed in your computer.

Install Hardhat shorthand

Refer to this section to install hh shorthand to run all the developer toolkit available tasks, or simply run this command:

npm i -g hardhat-shorthand && hardhat-completion install

Clone the developer toolkit repository

git clone https://github.com/Stacktical/stacktical-dsla-developer-toolkit.git

Install the DTK packages

Navigate into the cloned repo folder /stacktical-dsla-developer-toolkit/ and install NPM packages:

cd stacktical-dsla-developer-toolkit
npm install

Create the .env file

Copy the env-min file and paste it in a .env file, or execute the next:

cp env-min .env

Set the environment values that are suitable for you in the .env file.

Deploy 'develop' services

The services folder contains docker-compose files for multiple services, including:

• Local Blockchain: Ganache, pre-configured. It will be replaced once hardhat node is compatible with Chainlink.

• IPFS node.

To run these services, make sure Docker is running then use the following Hardhat task:

hh stacktical:restart-services --network develop

Deploy 'develop' external adapter

The services folder contains an external-adapter subfolder with the code for a simple Express.js app. It can be modified to implement the logic of an indexer for a new use case.

In a new console tab, navigate to the DTK repository folder and run the following command:

npm run external-adapter

This will run the services/external-adapter/index.ts using pm2 so it has hot reload, and any change to the external adapter files will restart the service.

There are other external adapters used in the protocol:

Staking Efficiency: https://github.com/Stacktical/stacktical-dsla-oracle-se

Leave this service running and switch back to your other console tab.

Enable the networks you need

While using the DTK, you can update as many networks as needed at once, by editing the networks/index.ts file.

But we highly recommend focusing on one network at a time. Make sure you update the networks/index.ts file accordingly:

import { NETWORKS } from '../constants';

export const networks = [
  { name: NETWORKS.DEVELOP, enabled: true },
  { name: NETWORKS.KOVAN, enabled: false },
  { name: NETWORKS.MUMBAI, enabled: false },
  { name: NETWORKS.HARMONYTESTNET, enabled: false },
  { name: NETWORKS.ETHEREUM, enabled: false },
  { name: NETWORKS.HARMONY, enabled: false },
  { name: NETWORKS.POLYGON, enabled: false },
  { name: NETWORKS.RINKEBY, enabled: false },
  { name: NETWORKS.BSC, enabled: false },
  { name: NETWORKS.AVALANCHE, enabled: false },
  { name: NETWORKS.DEVELOP_AVALANCHE, enabled: false },
  { name: NETWORKS.FUJI, enabled: false },
  { name: NETWORKS.FANTOM, enabled: false },
];

This will ensure that only the develop network is active for the next steps.

Deploy contracts and Chainlink nodes

Once the necessary services are running we can deploy the contracts along with the Chainlink nodes by executing:

hh deploy --network develop --reset

This will clean the previous develop deployment, and will run the Chainlink nodes locally, setting them up automatically.

You may run into a permissions error on the /services/chainlink-nodes/ folder or the /services/graph-protocol/postgres/ folder if you run the hh deploy --network develop --reset command more than once.

If so, use chown to ensure proper permissions on these folders. Execute the following commands substituting in your username and the proper path to your local DTK repo:

sudo chown -R YOUR_USER: /home/your_path_to_DTK/stacktical-dsla-developer-toolkit/services/chainlink-nodes
sudo chown -R YOUR_USER: /home/your_path_to_DTK/stacktical-dsla-developer-toolkit/services/graph-protocol

Once the previous process is finished, we have to bootstrap the protocol:

hh stacktical:bootstrap --network develop

At this point, if you want to run the local subgraph deploy it with the following command:

npm run graph:deploy:develop

After this, the protocol is ready to use! Execute the following script to deploy a pre configured SLA:

hh stacktical:deploy-sla --network develop --index 1

This will deploy the SLA defined in the scripts.config.ts. You can expect an output like this:

Starting SLA deployment process
----------------------------------------------------------------------------------------------------------------
Deploying SLA:
{
  sloValue: 7000,
  sloType: 4,
  whitelisted: false,
  periodType: 2,
  initialPeriodId: 6,
  finalPeriodId: 9,
  extraData: [
    '0x4f4e450000000000000000000000000000000000000000000000000000000000'
  ],
  initialTokenSupply: '10000000',
  initialTokenSupplyDivisor: 100,
  deployerStakeTimes: 100,
  notDeployerStakeTimes: 2,
  leverage: 50,
  serviceMetadata: {
    serviceName: 'P-OPS',
    serviceDescription: 'Official bDSLA Beta Partner.',
    serviceImage: 'https://storage.googleapis.com/bdsla-incentivized-beta/validators/chainode.svg',
    serviceURL: 'https://bdslaToken.network',
    serviceAddress: 'one1kf42rl6yg2avkjsu34ch2jn8yjs64ycn4n9wdj',
    serviceTicker: 'ONE'
  }
}
Starting process 1: Allowance on Stake registry to deploy SLA
Starting process 2: Deploy SLA
SLA address: 0xfA21C6587aA120BFBaaE9E777065556A13aCb947
Starting process 3: Stake on deployer and notOwner pools
Starting process 3.1: deployer: 10000000 DSLA
Starting process 3.2: notDeployer: 200000 DSLA
----------------------------------------------------------------------------------------------------------------
SLA deployment process finished

Depending on networks/develop.config.ts configuration, the first period of the SLA contract is going to be "expired", so we can proceed to verify the SLA contract by executing:

hh stacktical:request-sli --network develop

Previous task will take the last deployed SLA to verify it.

Expect an output like this:

Starting SLI request process for period 6
SLA address: 0xfA21C6587aA120BFBaaE9E777065556A13aCb947
Requesting SLI...
Transaction receipt: 
{
  hash: '0xef8298f6711d4c58fe2ccaf8a464b0b15afeccdc3a05ca09affb616865fbda99',
  type: null,
  accessList: null,
  blockHash: '0x28b7fa3a07433765494ea688047248c6bfbda0dab9b87a4cc87020a66433714e',
  blockNumber: 69,
  transactionIndex: 0,
  confirmations: 1,
  from: '0x90F8bf6A479f320ead074411a4B0e7944Ea8c9C1',
  gasPrice: BigNumber { _hex: '0x04a817c800', _isBigNumber: true },
  gasLimit: BigNumber { _hex: '0x3941b7', _isBigNumber: true },
  to: '0x4cFB3F70BF6a80397C2e634e5bDd85BC0bb189EE',
  value: BigNumber { _hex: '0x00', _isBigNumber: true },
  nonce: 64,
  data: '0x788164b10000000000000000000000000000000000000000000000000000000000000006000000000000000000000000a91a3be505946964d5f9d448bf54ddeeb9b2385e0000000000000000000000000000000000000000000000000000000000000001',
  r: '0x2f7cc6daac823401c40eab00343298277e000371ed6bba26400b338aa991de75',
  s: '0x2e7e64f28bdc7aec89def07c845a306194b57757d29ffd21d575d7ec22572c2e',
  v: 2710,
  creates: null,
  chainId: 1337,
  wait: [Function (anonymous)]
}
Created SLI timestamp:  1625779909
Created SLI sli:  28221
Created SLI status:  Respected
SLI request process finished

This means that our request traveled back and forth from the SLA contract to the external adapter. You can check this by reading the external adapter log:

npx pm2 logs

Comparing the result, in both cases is 28221.

0|external | SLA Data:
0|external | {
0|external |   serviceName: 'P-OPS',
0|external |   serviceDescription: 'Official bDSLA Beta Partner.',
0|external |   serviceImage: 'https://storage.googleapis.com/bdsla-incentivized-beta/validators/chainode.svg',
0|external |   serviceURL: 'https://bdslaToken.network',
0|external |   serviceAddress: 'one1kf42rl6yg2avkjsu34ch2jn8yjs64ycn4n9wdj',
0|external |   serviceTicker: 'ONE',
0|external |   periodType: '2',
0|external |   networkName: '0x4f4e450000000000000000000000000000000000000000000000000000000000',
0|external |   messengerAddress: '0xc0b3B62DD0400E4baa721DdEc9B8A384147b23fF'
0|external | }
0|external | result: 28221

Please note that we are checking if they are equal, since you can get a different number because the development external adapter returns a random number.

That's it! A full DSLA protocol deployment.

You can check the Chainlink node by browsing to http://localhost:6688 using [email protected] and password=PaSSword123456 as credentials, or you might want to check your IPFS node UI by visiting http://localhost:5001/webui.

You can access the Subgraph, if you deployed it earlier, at http://127.0.0.1:8000/subgraphs/name/dsla-protocol/core/graphql