Skip to content

Commit

Permalink
Merge pull request #232 from valory-xyz/dix/links
Browse files Browse the repository at this point in the history
Dix/links
  • Loading branch information
dvilelaf authored Nov 15, 2024
2 parents 8e5ec59 + 828d19d commit 0e3ba54
Show file tree
Hide file tree
Showing 13 changed files with 28 additions and 28 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,4 +62,4 @@ def some_method(some_arg: Type) -> ReturnType:

### Agent development

You can find several general recommendations in the **Considerations to Develop FSM Apps** section in our documentation [here](https://docs.autonolas.network/open-autonomy/key_concepts/fsm_app_introduction/).
You can find several general recommendations in the **Considerations to Develop FSM Apps** section in our documentation [here](https://open-autonomy.docs.autonolas.tech/open-autonomy/key_concepts/fsm_app_introduction/).
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# IEKit
An toolkit for autonomous services implementing a decentralized Impact Evaluator built with the [Open Autonomy](https://docs.autonolas.network/open-autonomy/) framework.
An toolkit for autonomous services implementing a decentralized Impact Evaluator built with the [Open Autonomy](https://open-autonomy.docs.autonolas.tech/open-autonomy/) framework.

The demo service for the IEKit tracks mentions of [@autonolas](https://twitter.com/autonolas) on Twitter, assigns scores to them and writes those scores to a [Ceramic](https://ceramic.network/) stream.

## Running a demo service

To learn how to run a demo service based on the IEKit, read the [IEKit technical docs](https://docs.autonolas.network/product/iekit/).
To learn how to run a demo service based on the IEKit, read the [IEKit technical docs](https://open-autonomy.docs.autonolas.tech/product/iekit/).

## For Developers

Expand Down
6 changes: 3 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
![IEKit](images/iekit.svg){ align=left }
The Impact Evaluator Kit (IEKit) is an enhanced version of the [CoordinationKit](https://docs.autonolas.network/product/coordinationkit/), which leverages [Ceramic streams](https://developers.ceramic.network/docs/advanced/standards/stream-programs/) 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](https://twitter.com/autonolas)). Generic scores can be also read from a [Ceramic stream](https://developers.ceramic.network/docs/advanced/standards/stream-programs/). The demo service implements three main features:
The Impact Evaluator Kit (IEKit) is an enhanced version of the [CoordinationKit](https://open-autonomy.docs.autonolas.tech/product/coordinationkit/), which leverages [Ceramic streams](https://developers.ceramic.network/docs/advanced/standards/stream-programs/) 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](https://twitter.com/autonolas)). Generic scores can be also read from a [Ceramic stream](https://developers.ceramic.network/docs/advanced/standards/stream-programs/). The demo service implements three main features:

1. **Monitor for new users' registrations.** Reads registered users both from tweets that contain the `#olas` hashtag and also from a [Ceramic stream](https://developers.ceramic.network/docs/advanced/standards/stream-programs/) that contains user data like discord ids and wallet addresses.

Expand All @@ -18,7 +18,7 @@ The service demonstrates the applicability of the IEKit to build a particular us

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

1. [Set up your system](https://docs.autonolas.network/open-autonomy/guides/set_up/) to work with the Open Autonomy framework. We recommend that you use these commands:
1. [Set up your system](https://open-autonomy.docs.autonolas.tech/open-autonomy/guides/set_up/) to work with the Open Autonomy framework. We recommend that you use these commands:

```bash
mkdir your_workspace && cd your_workspace
Expand All @@ -31,7 +31,7 @@ In order to run a local demo service based on the IEKit:
2. Fetch the IEKit.

```bash
autonomy fetch valory/impact_evaluator:0.1.0:bafybeidsxutduw7l6xls4a67hgzkzqigujssjl2cfw76q3lvulbjx2lqm4 --service
autonomy fetch valory/impact_evaluator:0.1.0:bafybeibsu6l3uf767fnbae64qwwu7zdgeojl2mwiterlubff5eb2g7qocq --service
```

3. Build the Docker image of the service agents
Expand Down
16 changes: 8 additions & 8 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
site_name: product/iekit #Required format to work with monorepo including a specific route in the address.
site_url: https://docs.autonolas.network/product/iekit/
site_url: https://open-autonomy.docs.autonolas.tech/product/iekit/
site_description: Autonolas ContributionKit developer documentation
repo_url: https://github.com/valory-xyz/contribution-service
site_author: developer@valory.xyz
edit_uri: ""
copyright: Copyright © 2021 - 2023 Valory AG
copyright: Copyright © 2021 - 2023 Valory AG


strict: true
Expand All @@ -14,10 +14,10 @@ theme:
name: 'material'
language: en
favicon: images/favicon.ico
logo: images/logo.svg
logo: images/logo.svg
icon:
admonition:
abstract: material/book-open-variant
abstract: material/book-open-variant
features:
- navigation.indexes
- navigation.top
Expand All @@ -36,7 +36,7 @@ extra_css:


nav:
- IEKit: 'index.md'
- IEKit: 'index.md'


plugins:
Expand Down Expand Up @@ -65,7 +65,7 @@ markdown_extensions:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- def_list
- def_list
- md_in_html
- toc:
title: On this page
Expand All @@ -78,11 +78,11 @@ extra:
open_aea_api: '[Open AEA API](https://open-aea.docs.autonolas.tech/api)'
fsm_app: 'FSM App'
open_autonomy: '[Open Autonomy](https://github.com/valory-xyz/open-autonomy)'
open_autonomy_api: '[Open Autonomy API](https://docs.autonolas.network)'
open_autonomy_api: '[Open Autonomy API](https://open-autonomy.docs.autonolas.tech)'
open_aea_repository: '[Open AEA repository](https://github.com/valory-xyz/open-aea)'
open_autonomy_repository: '[Open Autonomy repository](https://github.com/valory-xyz/open-autonomy)'
autonolas_whitepaper: '[Autonolas Whitepaper](https://www.autonolas.network/documents/whitepaper/Whitepaper%20v1.0.pdf)'
autonolas_protocol: '[Autonolas Protocol](https://docs.autonolas.network/protocol)'
autonolas_protocol: '[Autonolas Protocol](https://open-autonomy.docs.autonolas.tech/protocol)'
autonolas_protocol_registry_dapp_link: 'https://registry.olas.network'
autonolas_protocol_registry_dapp: '[Autonolas Protocol web app](https://registry.olas.network)'
autonolas_protocol_tokenomics_dapp: '[Autonolas Tokenomics web app](https://tokenomics.olas.network)'
Expand Down
12 changes: 6 additions & 6 deletions packages/packages.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,20 +18,20 @@
"skill/valory/twitter_scoring_abci/0.1.0": "bafybeicyd6inmijhqivrtugw6ny4gqg25swytouq23akqfcsndwvtccofu",
"skill/valory/ceramic_read_abci/0.1.0": "bafybeigz7rzfls3niv3urfb4z4vwr525ooxveelgg3djpvkg5jzetxlm2u",
"skill/valory/ceramic_write_abci/0.1.0": "bafybeic6c3iub3nsr5tmr7g5vzoixbin6w64ewudfiq6u4r2fiqwbg753i",
"skill/valory/impact_evaluator_abci/0.1.0": "bafybeie4d45tej22xdxr57din6bkik7bhhkslnz4jzmx5ijrsu7jxxrelm",
"skill/valory/impact_evaluator_abci/0.1.0": "bafybeictpsxyfre3ab5ku6tpe22n255hfjd7xuj6gy2gi5ope52tctuaxu",
"skill/valory/generic_scoring_abci/0.1.0": "bafybeib4s7nljlbj4m4ruqcpstqlts4phklmn3j5iqm5nx57aus5bcw47i",
"skill/valory/twitter_write_abci/0.1.0": "bafybeibp7zai2qwvfjd5fgpayx44x5c2zshbukpobvz2la7ws2l5f5fjde",
"skill/valory/llm_abci/0.1.0": "bafybeib2k62hilwglfad33bzxkjlviw5bxwiw7z3rjvweyeamatdjznpeq",
"skill/valory/decision_making_abci/0.1.0": "bafybeifbzj62j4dxaunuvvbo5lkvsp2fkajwp3rk2rcoigvl2cdywu5uw4",
"skill/valory/olas_week_abci/0.1.0": "bafybeibtlcammnitcogyg5gikxdvgcqz2bqdwjqqncbnjhbqnt533dzcgm",
"skill/valory/mech_interact_abci/0.1.0": "bafybeicpskytv7osu6bdpmcweemlsb4f3m6gldzpyoxgawkczsmvlrzgma",
"skill/valory/farcaster_write_abci/0.1.0": "bafybeigx2wyujnojer7er7g2eufm5lojon2dckotvsgwb6tn5iyiwdfgsu",
"skill/valory/farcaster_test_abci/0.1.0": "bafybeihd3h37ngkxlqo6o3vuvdik54bwmbrjmqcxtgsr5is3tqgbk73yoa",
"skill/valory/farcaster_test_abci/0.1.0": "bafybeielv62wl7hrnmbnqdtjfj5uz6onm46awmuzfpwotxa4ex4tqme7am",
"skill/valory/staking_abci/0.1.0": "bafybeicb6hrw7f5f3dcrxgwir3wviwg44w3ncvkqszuq7jfqfqyzjc352y",
"agent/valory/impact_evaluator/0.1.0": "bafybeifyc5pbogilpr63osvmcqoaq4m5jy2faa7xuvjby2i53ciqvm4lfy",
"agent/valory/farcaster_test/0.1.0": "bafybeiefui6dnhhy5leqyvfrbkeleb64gap5tzctkrzzggjf4ubbxamjvy",
"service/valory/impact_evaluator/0.1.0": "bafybeidsxutduw7l6xls4a67hgzkzqigujssjl2cfw76q3lvulbjx2lqm4",
"service/valory/impact_evaluator_local/0.1.0": "bafybeifxdgelvaapk3777er3onnffinwjzqdvh34kianhbkwgcuifurwv4"
"agent/valory/impact_evaluator/0.1.0": "bafybeidshbgf23ymgyiznfvmkv7f2imevcz7b5gu4auemqljz64cdyyjku",
"agent/valory/farcaster_test/0.1.0": "bafybeicm25cyzmnnqxfschr3qpwfamiecc6zbog2brzxuxzlbv7wsykxlu",
"service/valory/impact_evaluator/0.1.0": "bafybeibsu6l3uf767fnbae64qwwu7zdgeojl2mwiterlubff5eb2g7qocq",
"service/valory/impact_evaluator_local/0.1.0": "bafybeidhsk4ukzg5kmbzjjia3xeyaliel4z4jxr22vikgrvooknnpesdwy"
},
"third_party": {
"protocol/open_aea/signing/1.0.0": "bafybeihv62fim3wl2bayavfcg3u5e5cxu3b7brtu4cn5xoxd6lqwachasi",
Expand Down
2 changes: 1 addition & 1 deletion packages/valory/agents/farcaster_test/aea-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ protocols:
skills:
- valory/abstract_abci:0.1.0:bafybeieo7pe5wqjphs5izpz5aujjbubymlxub62b3rhx6yglu65ibalffu
- valory/abstract_round_abci:0.1.0:bafybeibiw4oqwqvo4jccwz5fb73iardzychgvcl66tceiildohoju2ikti
- valory/farcaster_test_abci:0.1.0:bafybeihd3h37ngkxlqo6o3vuvdik54bwmbrjmqcxtgsr5is3tqgbk73yoa
- valory/farcaster_test_abci:0.1.0:bafybeielv62wl7hrnmbnqdtjfj5uz6onm46awmuzfpwotxa4ex4tqme7am
- valory/registration_abci:0.1.0:bafybeib3n6vqkfbrcubcbliebjnuwyywdinxkbzt76n6gbn2kg7ace47dq
- valory/reset_pause_abci:0.1.0:bafybeihkj6lmaypspyxe5qqrjgnolyck62pyvqoylr24ab6ue4steqcw7e
- valory/farcaster_write_abci:0.1.0:bafybeigx2wyujnojer7er7g2eufm5lojon2dckotvsgwb6tn5iyiwdfgsu
Expand Down
2 changes: 1 addition & 1 deletion packages/valory/agents/impact_evaluator/aea-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ protocols:
skills:
- valory/abstract_abci:0.1.0:bafybeieo7pe5wqjphs5izpz5aujjbubymlxub62b3rhx6yglu65ibalffu
- valory/abstract_round_abci:0.1.0:bafybeibiw4oqwqvo4jccwz5fb73iardzychgvcl66tceiildohoju2ikti
- valory/impact_evaluator_abci:0.1.0:bafybeie4d45tej22xdxr57din6bkik7bhhkslnz4jzmx5ijrsu7jxxrelm
- valory/impact_evaluator_abci:0.1.0:bafybeictpsxyfre3ab5ku6tpe22n255hfjd7xuj6gy2gi5ope52tctuaxu
- valory/generic_scoring_abci:0.1.0:bafybeib4s7nljlbj4m4ruqcpstqlts4phklmn3j5iqm5nx57aus5bcw47i
- valory/twitter_scoring_abci:0.1.0:bafybeicyd6inmijhqivrtugw6ny4gqg25swytouq23akqfcsndwvtccofu
- valory/ceramic_read_abci:0.1.0:bafybeigz7rzfls3niv3urfb4z4vwr525ooxveelgg3djpvkg5jzetxlm2u
Expand Down
2 changes: 1 addition & 1 deletion packages/valory/services/impact_evaluator/service.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ license: Apache-2.0
fingerprint:
README.md: bafybeign56hilwuoa6bgos3uqabss4gew4vadkik7vhj3ucpqw6nxtqtpe
fingerprint_ignore_patterns: []
agent: valory/impact_evaluator:0.1.0:bafybeifyc5pbogilpr63osvmcqoaq4m5jy2faa7xuvjby2i53ciqvm4lfy
agent: valory/impact_evaluator:0.1.0:bafybeidshbgf23ymgyiznfvmkv7f2imevcz7b5gu4auemqljz64cdyyjku
number_of_agents: 4
deployment:
agent:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ license: Apache-2.0
fingerprint:
README.md: bafybeign56hilwuoa6bgos3uqabss4gew4vadkik7vhj3ucpqw6nxtqtpe
fingerprint_ignore_patterns: []
agent: valory/impact_evaluator:0.1.0:bafybeifyc5pbogilpr63osvmcqoaq4m5jy2faa7xuvjby2i53ciqvm4lfy
agent: valory/impact_evaluator:0.1.0:bafybeidshbgf23ymgyiznfvmkv7f2imevcz7b5gu4auemqljz64cdyyjku
number_of_agents: 1
deployment:
agent:
Expand Down
2 changes: 1 addition & 1 deletion packages/valory/skills/farcaster_test_abci/composition.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@


# Here we define how the transition between the FSMs should happen
# more information here: https://docs.autonolas.network/fsm_app_introduction/#composition-of-fsm-apps
# more information here: https://open-autonomy.docs.autonolas.tech/fsm_app_introduction/#composition-of-fsm-apps
abci_app_transition_mapping: AbciAppTransitionMapping = {
RegistrationAbci.FinishedRegistrationRound: FarcasterWriteAbci.RandomnessFarcasterRound,
FarcasterWriteAbci.FinishedFarcasterWriteRound: ResetAndPauseAbci.ResetAndPauseRound,
Expand Down
2 changes: 1 addition & 1 deletion packages/valory/skills/farcaster_test_abci/skill.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ aea_version: '>=1.0.0, <2.0.0'
fingerprint:
__init__.py: bafybeihrdg7ppm4zxmrbfscm7t6ftonw667zivzl3c6kwdtvpcwmugqr3i
behaviours.py: bafybeiencqonbknwiptgpw6ab7hj4ba5if5ztolghcsqkymf3hmubjozxe
composition.py: bafybeibti2jell3skqhxzkrk7eiipwzwa4u4amjpobcfyt4gdyx7c6wndu
composition.py: bafybeihmrcstlclie5lk36wgquwti5gg2lv73sn7yhfzfzmw67pavbzbve
dialogues.py: bafybeibhbdeicko6fq5pbzl5xm2bjbo4iwdkyyhwpepjnwbxyqbx6tx6hu
fsm_specification.yaml: bafybeicj4ajbfschtxknkh6nbg4rjpejqykpo5twbyfd2iidmop5bvmad4
handlers.py: bafybeigquxsw3z2v36ts4xmmxnuxyd3z2aaymccbp7ghtzhewhbfesw54y
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@


# Here we define how the transition between the FSMs should happen
# more information here: https://docs.autonolas.network/open-autonomy/key_concepts/fsm_app_introduction/?h=composition#composition-of-fsm-apps
# more information here: https://open-autonomy.docs.autonolas.tech/open-autonomy/key_concepts/fsm_app_introduction/?h=composition#composition-of-fsm-apps
abci_app_transition_mapping: AbciAppTransitionMapping = {
RegistrationAbci.FinishedRegistrationRound: DecisionMakingAbci.DecisionMakingRound,
DecisionMakingAbci.FinishedDecisionMakingReadCentaursRound: CeramicReadAbci.StreamReadRound,
Expand Down
2 changes: 1 addition & 1 deletion packages/valory/skills/impact_evaluator_abci/skill.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ aea_version: '>=1.0.0, <2.0.0'
fingerprint:
__init__.py: bafybeigmhxenrqb2ysjhcm2au2lang4abyny6irkzqqg4dtclz6net6zpy
behaviours.py: bafybeiciogdifxopcplhlbnpuftwqh5zo4bubyimx7b4r5vfcdtpv5vhpq
composition.py: bafybeibumunfp56hvztyvgk4m64fmddfm4evgdacvbek464oexm665nwvy
composition.py: bafybeiguzgq3lhiax752jkp6w3ghspyhh4eltu5nwm6yb74ri3vbxflp74
dialogues.py: bafybeigjknz4qqynbsltjje46gidg4rftsqw6ybjwegz24wetmycutpzh4
fsm_specification.yaml: bafybeibgb5o2idctxri6ykl7iva2j6brwgn56mdz2pl5onsbz2p63t2vce
handlers.py: bafybeidkli6fphcmdgwsys4lkyf3fx6fbawet4nt2pnixfypzijhg6b3ze
Expand Down

0 comments on commit 0e3ba54

Please sign in to comment.