Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/main' into SUM_URL_CONTENT
Browse files Browse the repository at this point in the history
  • Loading branch information
jhehemann committed Sep 29, 2023
2 parents 3fb3f09 + fdb487e commit 4f376bc
Show file tree
Hide file tree
Showing 17 changed files with 646 additions and 444 deletions.
17 changes: 17 additions & 0 deletions docs/images/mechkit.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 24 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
![MechKit](images/mechkit.svg){ align=left }
The MechKit is a toolkit to build services (AI Mechs) based on the [Gnosis chain](https://www.gnosis.io/) which enable users to post *AI tasks requests* on-chain and get their result delivered back efficiently. An AI Mech will execute these tasks for the user. All the user requires is to pay a xDAI fee to reward the worker service executing the task. AI Mechs are **hassle-free**, **crypto-native**, and **infinitely composable**.

!!! info

This section will be completed soon.

## Demo

!!! info

This section will be completed soon.

## Build

1. Fork the [MechKit repository](https://github.com/valory-xyz/mech).
2. 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.
3. Run your service as detailed above.

!!! tip "Looking for help building your own?"

Refer to the [Autonolas Discord community](https://discord.com/invite/z2PT65jKqQ), or consider ecosystem services like [Valory Propel](https://propel.valory.xyz) for the fastest way to get your first autonomous service in production.
105 changes: 105 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
site_name: product/mechkit #Required format to work with monorepo including a specific route in the address.
site_url: https://docs.autonolas.network/product/mechkit/
site_description: Autonolas MechKit developer documentation
repo_url: https://github.com/valory-xyz/agent-academy-1
site_author: [email protected]
edit_uri: ""
copyright: Copyright © 2021 - 2023 Valory AG


strict: true


theme:
name: 'material'
language: en
favicon: images/favicon.ico
logo: images/logo.svg
icon:
admonition:
abstract: material/book-open-variant
features:
- navigation.indexes
- navigation.top
- navigation.tracking
- navigation.footer
- search.highlight
- search.share
- search.suggest
- content.code.copy
- content.code.annotate
- content.tabs.link


extra_css:
- stylesheets/extra.css


nav:
- MechKit: 'index.md'


plugins:
- macros:
on_error_fail: true
on_undefined: strict
- search


markdown_extensions:
- admonition
- attr_list
- pymdownx.details
- pymdownx.keys
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.highlight
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.arithmatex:
generic: true
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- def_list
- md_in_html
- toc:
title: On this page
toc_depth: 3


extra:
open_aea: '[Open AEA](https://github.com/valory-xyz/open-aea)'
open_aea_doc: '[Open AEA documentation](https://open-aea.docs.autonolas.tech)'
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_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_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)'
social:
- icon: fontawesome/brands/twitter
link: https://twitter.com/autonolas
name: Autonolas on Twitter
- icon: fontawesome/brands/discord
link: https://discord.com/invite/z2PT65jKqQ
name: Autonolas on Discord
- icon: fontawesome/brands/github
link: https://github.com/valory-xyz
name: Autonolas on GitHub


extra_javascript:
- https://unpkg.com/[email protected]/dist/mermaid.min.js
- javascripts/mathjax.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
38 changes: 19 additions & 19 deletions packages/packages.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
{
"dev": {
"connection/valory/websocket_client/0.1.0": "bafybeicz53kzs5uvyiod2azntl76zwgmpgr22ven4wl5fnwt2m546j3wsu",
"skill/valory/contract_subscription/0.1.0": "bafybeifbgzfrhtdtendqzwmh3o436nyexwkif6mbvsouvk2ktdfk5lhe7y",
"agent/valory/mech/0.1.0": "bafybeigfkzy7beir3tasc7ndcgfj3vcg6vrsjptojerum3ajccwuglczg4",
"skill/valory/mech_abci/0.1.0": "bafybeigzfa5pr647fg4nflzgie3xla4araotperomibfp2totzpaxwgmje",
"contract/valory/agent_mech/0.1.0": "bafybeidl6kwc3sgcxiphgb3osjqlqwylhqetv2nyv2fu6zxcgn5qctv2ju",
"service/valory/mech/0.1.0": "bafybeibulanqkh6hvo4cofquwtyvveala2bh7xtmembuq5zdzhgxdeet7a",
"skill/valory/contract_subscription/0.1.0": "bafybeialscmefsroacttr5um4667yjnceu4hqdmiwvo3e7pg7ld5mhbo5q",
"agent/valory/mech/0.1.0": "bafybeidacwkdcyoourzhovzrevd252ujf2eeltiiio4dy2xrtvvlr5xyxi",
"skill/valory/mech_abci/0.1.0": "bafybeieyt5isib2uxdhfdcv46ajcw5q3wslxcuassmd4l5akl46cg6vfri",
"contract/valory/agent_mech/0.1.0": "bafybeiccjt6322pee3als6v3ale75wxgrv4hy532dlfaugndpq6swahyba",
"service/valory/mech/0.1.0": "bafybeibww5ob6smbg6ad7zkmngdfmbhs75b6zdbueiyzxkptyoqyrqofqq",
"protocol/valory/acn_data_share/0.1.0": "bafybeieyixetwvz767zekhvg7r6etumyanzys6xbalx2brrfswybinnlhi",
"protocol/valory/default/1.0.0": "bafybeiecmut3235aen7wxukllv424f3dysvvlgfmn562kzdunc5hdj3hxu",
"skill/valory/task_submission_abci/0.1.0": "bafybeidcjfmhtgwh24sgf3gmk6soiyr2fmaebjvphhz6xob6d5m6aeguce",
"skill/valory/task_execution/0.1.0": "bafybeih6caazog2vq34dupe4cbkv2v3zrffsmfztuvvshtku7tnhmvxcrq"
"skill/valory/task_submission_abci/0.1.0": "bafybeihvyzkhhikrhwzf55uu77gbvz6rgld6gipnrh32f2arneqgej2zea",
"skill/valory/task_execution/0.1.0": "bafybeig5ceg4rpgyocqb4scfxf5i5oxcvwtifypa2ubqufvquyez6sfxre"
},
"third_party": {
"protocol/open_aea/signing/1.0.0": "bafybeifuxs7gdg2okbn7uofymenjlmnih2wxwkym44lsgwmklgwuckxm2m",
Expand All @@ -20,20 +20,20 @@
"protocol/valory/acn/1.1.0": "bafybeiapa5ilsobggnspoqhspftwolrx52udrwmaxdxgrk26heuvl4oooa",
"protocol/valory/ipfs/0.1.0": "bafybeibjzhsengtxfofqpxy6syamplevp35obemwfp4c5lhag3v2bvgysa",
"protocol/valory/tendermint/0.1.0": "bafybeidjqmwvgi4rqgp65tbkhmi45fwn2odr5ecezw6q47hwitsgyw4jpa",
"skill/valory/abstract_abci/0.1.0": "bafybeicg7dv7cff34nv2k2z47c4yp4kddsxp3wozonzow6tnvfvwndz3cy",
"skill/valory/reset_pause_abci/0.1.0": "bafybeid445uy6wwvugf3byzl7r73c7teu6xr5ezxb4h7cxbenghg3copvy",
"skill/valory/registration_abci/0.1.0": "bafybeibc4kczqbh23sc6tufrzn3axmhp3vjav7fa3u6cnpvolrbbc2fd7i",
"skill/valory/abstract_round_abci/0.1.0": "bafybeigxjcci53vwytymzlhr37436yvenh7jup4astrn7dgyixo24aq2pq",
"contract/valory/service_registry/0.1.0": "bafybeif6x4zvsokwcetbrjdb4uyv4l3pqx756cg2ohv2zgcky5yuiwuqvi",
"connection/valory/abci/0.1.0": "bafybeicasheudousm2unmh5qmy5n3qdq5hmkg2j42fxfm2crxmgq3nzjkq",
"skill/valory/abstract_abci/0.1.0": "bafybeigafjci7m7ezwzasav5xqo7v2mbxxn7qb4y7vnuc2wr2irzvn7wsy",
"skill/valory/reset_pause_abci/0.1.0": "bafybeigeoc363gv3wp2rrmk6p2fdxney33nxd3owtpfugzapgruwe4klyu",
"skill/valory/registration_abci/0.1.0": "bafybeibndt6vxiwc2edgtaxpjbhwto3eyu33ujz3zmvtygvo2qz7xme5li",
"skill/valory/abstract_round_abci/0.1.0": "bafybeih2fyfb6kkf7r45pvdk7pyyebr5xloia4xiqxtb3qsrasnstqmepq",
"contract/valory/service_registry/0.1.0": "bafybeige6pubafkiqmaiyuql6pcojm6fvh5thvhrsapi53au2rhuumqymu",
"connection/valory/abci/0.1.0": "bafybeib3exj2vkz4u76rc2amtwz6veeozipr6zdgzlaqsovu3dorppcina",
"connection/valory/http_client/0.23.0": "bafybeieoeuy4brzimtnubmokwirhrx27ezls6cdnl5qik4rkykfle3nn2y",
"connection/valory/ipfs/0.1.0": "bafybeiau32pzy55ta6ugl2bebevlxudal6pnlfomhplfm5mph6reaw3krq",
"connection/valory/ipfs/0.1.0": "bafybeidu3xd6rd5zysv2due2cnrc3sxx5vss2usxwaxxtxxuyha2kuhd3e",
"connection/valory/ledger/0.19.0": "bafybeigfoz7d7si7s4jehvloq2zmiiocpbxcaathl3bxkyarxoerxq7g3a",
"connection/valory/p2p_libp2p_client/0.1.0": "bafybeihdnfdth3qgltefgrem7xyi4b3ejzaz67xglm2hbma2rfvpl2annq",
"contract/valory/gnosis_safe_proxy_factory/0.1.0": "bafybeie4iivrxcd5dcwzj3y2t66mc5mdvtsuqu426gk2kcdc6fxbki6neu",
"contract/valory/gnosis_safe/0.1.0": "bafybeigvqg4lapdaa23dpc3pv67rdptdhey6e435mxqsw2gb2u74yw4yei",
"skill/valory/transaction_settlement_abci/0.1.0": "bafybeidpsnguxizkpihtkqzojr3em7yy7c6qc7gxpbh5vglmwws5wke7bi",
"contract/valory/multisend/0.1.0": "bafybeie7m7pjbnw7cccpbvmbgkut24dtlt4cgvug3tbac7gej37xvwbv3a",
"skill/valory/termination_abci/0.1.0": "bafybeiguy7pkrcptg6c754ioig4mlkr7truccym3fpv6jwpjx2tmpdbzhi"
"contract/valory/gnosis_safe_proxy_factory/0.1.0": "bafybeid6glyjikjxmefwmhn62cxiofophegjmg2z5vqqsvk6tmyunwc274",
"contract/valory/gnosis_safe/0.1.0": "bafybeih6d3vxz3jlgodxm5b2qcwsmansqj4xobuyd6hjnhzremuvd65yrm",
"skill/valory/transaction_settlement_abci/0.1.0": "bafybeia7rzsbea3ch4gcafyp3z6uvqh4npws2xpdwbkkdbrqqpjops7nui",
"contract/valory/multisend/0.1.0": "bafybeieg4tywd5lww2vygvpkilg3hcepa4rmhehjuamyvdf6vazt554v6u",
"skill/valory/termination_abci/0.1.0": "bafybeigqpij2sgrpnilqjljfciixop4fldq5qceixc7534q6af4potdmdm"
}
}
39 changes: 22 additions & 17 deletions packages/valory/agents/mech/aea-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,18 @@ aea_version: '>=1.37.0, <2.0.0'
fingerprint: {}
fingerprint_ignore_patterns: []
connections:
- valory/abci:0.1.0:bafybeicasheudousm2unmh5qmy5n3qdq5hmkg2j42fxfm2crxmgq3nzjkq
- valory/abci:0.1.0:bafybeib3exj2vkz4u76rc2amtwz6veeozipr6zdgzlaqsovu3dorppcina
- valory/http_client:0.23.0:bafybeieoeuy4brzimtnubmokwirhrx27ezls6cdnl5qik4rkykfle3nn2y
- valory/ipfs:0.1.0:bafybeiau32pzy55ta6ugl2bebevlxudal6pnlfomhplfm5mph6reaw3krq
- valory/ipfs:0.1.0:bafybeidu3xd6rd5zysv2due2cnrc3sxx5vss2usxwaxxtxxuyha2kuhd3e
- valory/ledger:0.19.0:bafybeigfoz7d7si7s4jehvloq2zmiiocpbxcaathl3bxkyarxoerxq7g3a
- valory/p2p_libp2p_client:0.1.0:bafybeihdnfdth3qgltefgrem7xyi4b3ejzaz67xglm2hbma2rfvpl2annq
- valory/websocket_client:0.1.0:bafybeicz53kzs5uvyiod2azntl76zwgmpgr22ven4wl5fnwt2m546j3wsu
contracts:
- valory/agent_mech:0.1.0:bafybeidl6kwc3sgcxiphgb3osjqlqwylhqetv2nyv2fu6zxcgn5qctv2ju
- valory/gnosis_safe:0.1.0:bafybeigvqg4lapdaa23dpc3pv67rdptdhey6e435mxqsw2gb2u74yw4yei
- valory/gnosis_safe_proxy_factory:0.1.0:bafybeie4iivrxcd5dcwzj3y2t66mc5mdvtsuqu426gk2kcdc6fxbki6neu
- valory/multisend:0.1.0:bafybeie7m7pjbnw7cccpbvmbgkut24dtlt4cgvug3tbac7gej37xvwbv3a
- valory/service_registry:0.1.0:bafybeif6x4zvsokwcetbrjdb4uyv4l3pqx756cg2ohv2zgcky5yuiwuqvi
- valory/agent_mech:0.1.0:bafybeiccjt6322pee3als6v3ale75wxgrv4hy532dlfaugndpq6swahyba
- valory/gnosis_safe:0.1.0:bafybeih6d3vxz3jlgodxm5b2qcwsmansqj4xobuyd6hjnhzremuvd65yrm
- valory/gnosis_safe_proxy_factory:0.1.0:bafybeid6glyjikjxmefwmhn62cxiofophegjmg2z5vqqsvk6tmyunwc274
- valory/multisend:0.1.0:bafybeieg4tywd5lww2vygvpkilg3hcepa4rmhehjuamyvdf6vazt554v6u
- valory/service_registry:0.1.0:bafybeige6pubafkiqmaiyuql6pcojm6fvh5thvhrsapi53au2rhuumqymu
protocols:
- open_aea/signing:1.0.0:bafybeifuxs7gdg2okbn7uofymenjlmnih2wxwkym44lsgwmklgwuckxm2m
- valory/abci:0.1.0:bafybeigootsvqpk6th5xpdtzanxum3earifrrezfyhylfrit7yvqdrtgpe
Expand All @@ -31,16 +31,16 @@ protocols:
- valory/ledger_api:1.0.0:bafybeigsvceac33asd6ecbqev34meyyjwu3rangenv6xp5rkxyz4krvcby
- valory/tendermint:0.1.0:bafybeidjqmwvgi4rqgp65tbkhmi45fwn2odr5ecezw6q47hwitsgyw4jpa
skills:
- valory/abstract_abci:0.1.0:bafybeicg7dv7cff34nv2k2z47c4yp4kddsxp3wozonzow6tnvfvwndz3cy
- valory/abstract_round_abci:0.1.0:bafybeigxjcci53vwytymzlhr37436yvenh7jup4astrn7dgyixo24aq2pq
- valory/contract_subscription:0.1.0:bafybeifbgzfrhtdtendqzwmh3o436nyexwkif6mbvsouvk2ktdfk5lhe7y
- valory/mech_abci:0.1.0:bafybeigzfa5pr647fg4nflzgie3xla4araotperomibfp2totzpaxwgmje
- valory/task_execution:0.1.0:bafybeih6caazog2vq34dupe4cbkv2v3zrffsmfztuvvshtku7tnhmvxcrq
- valory/registration_abci:0.1.0:bafybeibc4kczqbh23sc6tufrzn3axmhp3vjav7fa3u6cnpvolrbbc2fd7i
- valory/reset_pause_abci:0.1.0:bafybeid445uy6wwvugf3byzl7r73c7teu6xr5ezxb4h7cxbenghg3copvy
- valory/task_submission_abci:0.1.0:bafybeidcjfmhtgwh24sgf3gmk6soiyr2fmaebjvphhz6xob6d5m6aeguce
- valory/termination_abci:0.1.0:bafybeiguy7pkrcptg6c754ioig4mlkr7truccym3fpv6jwpjx2tmpdbzhi
- valory/transaction_settlement_abci:0.1.0:bafybeidpsnguxizkpihtkqzojr3em7yy7c6qc7gxpbh5vglmwws5wke7bi
- valory/abstract_abci:0.1.0:bafybeigafjci7m7ezwzasav5xqo7v2mbxxn7qb4y7vnuc2wr2irzvn7wsy
- valory/abstract_round_abci:0.1.0:bafybeih2fyfb6kkf7r45pvdk7pyyebr5xloia4xiqxtb3qsrasnstqmepq
- valory/contract_subscription:0.1.0:bafybeialscmefsroacttr5um4667yjnceu4hqdmiwvo3e7pg7ld5mhbo5q
- valory/mech_abci:0.1.0:bafybeieyt5isib2uxdhfdcv46ajcw5q3wslxcuassmd4l5akl46cg6vfri
- valory/task_execution:0.1.0:bafybeig5ceg4rpgyocqb4scfxf5i5oxcvwtifypa2ubqufvquyez6sfxre
- valory/registration_abci:0.1.0:bafybeibndt6vxiwc2edgtaxpjbhwto3eyu33ujz3zmvtygvo2qz7xme5li
- valory/reset_pause_abci:0.1.0:bafybeigeoc363gv3wp2rrmk6p2fdxney33nxd3owtpfugzapgruwe4klyu
- valory/task_submission_abci:0.1.0:bafybeihvyzkhhikrhwzf55uu77gbvz6rgld6gipnrh32f2arneqgej2zea
- valory/termination_abci:0.1.0:bafybeigqpij2sgrpnilqjljfciixop4fldq5qceixc7534q6af4potdmdm
- valory/transaction_settlement_abci:0.1.0:bafybeia7rzsbea3ch4gcafyp3z6uvqh4npws2xpdwbkkdbrqqpjops7nui
default_ledger: ethereum
required_ledgers:
- ethereum
Expand Down Expand Up @@ -152,6 +152,11 @@ models:
all_participants: ${list:["0x10E867Ac2Fb0Aa156ca81eF440a5cdf373bE1AaC"]}
safe_contract_address: ${str:0x5e1D1eb61E1164D5a50b28C575dA73A29595dFf7}
consensus_threshold: ${int:null}
use_slashing: ${bool:false}
slash_cooldown_hours: ${int:3}
slash_threshold_amount: ${int:10000000000000000}
light_slash_unit_amount: ${int:5000000000000000}
serious_slash_unit_amount: ${int:8000000000000000}
---
public_id: valory/task_execution:0.1.0
type: skill
Expand Down
2 changes: 1 addition & 1 deletion packages/valory/contracts/agent_mech/contract.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ contract_interface_paths:
ethereum: build/AgentMech.json
dependencies:
open-aea-ledger-ethereum:
version: ==1.38.0
version: ==1.39.0.post1
open-aea-web3:
version: ==6.0.1
contracts: []
Loading

0 comments on commit 4f376bc

Please sign in to comment.