CoordinationKit

The CoordinationKit helps you build services to show off community contributions by letting users mint badges which evolve as they make contributions to the DAO. Such services work by monitoring user contributions, updating their badges accordingly and showing off contributions on NFT-enabled social media sites.

This kit leverages Ceramic streams to automate the tracking and rewarding of users' contributions on the ecosystem. We provide a demo agent service based on the IEKit which is designed to track contributions in the form of Twitter mentions of the Autonolas DAO (@autonolas). Generic scores can be also read from a Ceramic stream. The demo service implements three main features:

Monitor for new users' registrations. Reads registered users both from tweets that contain the #autonolas hashtag and also from a Ceramic stream that contains user data like discord ids and wallet addresses.
Monitor for users' contributions. The service periodically scans for new mentions of @autonolas on Twitter and updates to the scores stream, and increments and updates the score of the corresponding user.
Update the badge of users according to their score. To access the badge image associated to a user's NFT, the metadata URI associated to it is redirected to an agent in the service. Upon reading the concrete NFT from the request, the service provides the IPFS address of the image, which is updated periodically in relation to the user's score.

The demo service uses dedicated Ceramic streams as a persistent solution to store users' scores and registration metadata. The service demonstrates the applicability of the IEKit to build a particular use case, but of course, the IEKit is modular by design and can be adapted to a range of custom impact evaluators.

Check the demo service leaderboard on the Autonolas Contribute web app.

Demo

Important

This section is under active development - please report issues in the Autonolas Discord.

In order to run a local demo service based on the IEKit:

Set up your system to work with the Open Autonomy framework. We recommend that you use these commands:

mkdir your_workspace && cd your_workspace
touch Pipfile && pipenv --python 3.10 && pipenv shell

pipenv install open-autonomy[all]==0.14.6
autonomy init --remote --ipfs --reset --author=your_name

Fetch the IEKit.

autonomy fetch valory/impact_evaluator:0.1.0:bafybeidbtkjf6qqnlv3pbfehdb3aesnzvp4r3lc7nge6nbacscj65otlvi --service

Build the Docker image of the service agents

cd impact_evaluator
autonomy build-image

Prepare the keys.json file containing the wallet address and the private key for each of the agents.

Example of a keys.json file

WARNING: Use this file for testing purposes only. Never use the keys or addresses provided in this example in a production environment or for personal use.

[
  {
      "address": "0x15d34AAf54267DB7D7c367839AAf71A00a2C6A65",
      "private_key": "0x47e179ec197488593b187f80a00eb0da91f1b9d0b13f8733639f19c30a34926a"
  },
  {
      "address": "0x9965507D1a55bcC2695C58ba16FB37d819B0A4dc",
      "private_key": "0x8b3a350cf5c34c9194ca85829a2df0ec3153be0318b5e2d3348e872092edffba"
  },
  {
      "address": "0x976EA74026E726554dB657fA54763abd0C3a0aa9",
      "private_key": "0x92db14e403b83dfe3df233f83dfa3a0d7096f21ca9b0d6d6b8d88b2b4ec1564e"
  },
  {
      "address": "0x14dC79964da2C08b23698B3D3cc7Ca32193d9955",
      "private_key": "0x4bbbf85ce3377467afe5d46f804f221813b2bb87f24d81f60f1fcdbf7cbf4356"
  }
]

Prepare the environment and build the service deployment.

Create a Twitter API Bearer Token.
Create a Ceramic Decentralized Identity (DID) using Glaze.
Using the DID created in the previous step, create two empty Ceramic streams. The service will optionally read generic scores from the first one and will write scores to the second one.
Create an API key for Infura or your preferred provider.

Create an .env file with the required environment variables, modifying its values to your needs.

ETHEREUM_LEDGER_RPC=https://goerli.infura.io/v3/<infura_api_key>
DYNAMIC_CONTRIBUTION_CONTRACT_ADDRESS=0x7C3B976434faE9986050B26089649D9f63314BD8
CERAMIC_DID_SEED=<ceramic_seed_did>
CERAMIC_DID_STR=<ceramic_did_string>
DEFAULT_READ_STREAM_ID=<main_database_stream>
DEFAULT_WRITE_STREAM_ID=<main_database_stream>
DEFAULT_READ_TARGET_PROPERTY=ceramic_db
DEFAULT_WRITE_TARGET_PROPERTY=ceramic_db
MANUAL_POINTS_STREAM_ID=<generic_scores_stream>
TWITTER_API_BEARER_TOKEN=<twitter_api_token>
TWITTER_MENTION_POINTS=300
RESET_PAUSE_DURATION=10
ALL_PARTICIPANTS='["0x15d34AAf54267DB7D7c367839AAf71A00a2C6A65","0x9965507D1a55bcC2695C58ba16FB37d819B0A4dc","0x976EA74026E726554dB657fA54763abd0C3a0aa9","0x14dC79964da2C08b23698B3D3cc7Ca32193d9955"]'
POINTS_TO_IMAGE_HASHES='{"0":"bafybeiabtdl53v2a3irrgrg7eujzffjallpymli763wvhv6gceurfmcemm","100":"bafybeid46w6yzbehir7ackcnsyuasdkun5aq7jnckt4sknvmiewpph776q","50000":"bafybeigbxlwzljbxnlwteupmt6c6k7k2m4bbhunvxxa53dc7niuedilnr4","100000":"bafybeiawxpq4mqckbau3mjwzd3ic2o7ywlhp6zqo7jnaft26zeqm3xsjjy","150000":"bafybeie6k53dupf7rf6622rzfxu3dmlv36hytqrmzs5yrilxwcrlhrml2m"}'

and export them:

export $(grep -v '^#' .env | xargs)

Build the service deployment.
```
autonomy deploy build keys.json -ltm
```

Run the service.
```
cd abci_build
autonomy deploy run
```
You can cancel the local execution at any time by pressing Ctrl+C.
Check that the service is running. Open a separate terminal and execute the command below. You should see the service transitioning along different states.
```
docker logs -f abci0 | grep -E 'Entered|round is done'
```

You can try some examples on how to curl the service endpoints from inside one of the agent containers. For example:

# Enter one of the agent containers
docker exec -it <container_id> /bin/bash

# Install curl and jq if they are not present
sudo apt install -y curl jq

# Get the metadata for the token with id=1
curl localhost:8000/1 | jq

# Output
{
  "title": "Autonolas Contribute Badges",
  "name": "Badge 1",
  "description": "This NFT recognizes the contributions made by the holder to the Autonolas Community.",
  "image": "ipfs://bafybeiabtdl53v2a3irrgrg7eujzffjallpymli763wvhv6gceurfmcemm",
  "attributes": []
}

# Get the service health status
curl localhost:8000/healthcheck | jq

# Output
{
  "seconds_since_last_reset": 15.812911033630371,
  "healthy": true,
  "seconds_until_next_update": -5.812911033630371
}

Build

Fork the IEKit repository.
Make the necessary adjustments to tailor the service to your needs. This could include:
- Adjust configuration parameters (e.g., in the service.yaml file).
- Expand the service finite-state machine with your custom states.
Run your service as detailed above.

Looking for help building your own?

Refer to the Autonolas Discord community, or consider ecosystem services like Valory Propel for the fastest way to get your first autonomous service in production.