feat: new event listener automation package #726

FedericoAmura · 2024-11-27T15:39:21Z

Description

This PR adds a new top-level package (no other package depends on this) used to define automations.

It uses a state machine to move between states based on conditions that every state continuously monitors

states execute one time actions
listeners monitor things onchain or offchain
transitions move machine between states based on their contained listeners

State machine is designed to allow for a functional interface that has no boundaries and therefore can do anything but also has a declarative interface that allows a client to send a machine definition over the wire to a long running server
Declarative interface can be extended with new types of states(actions) or transitions by adding their corresponding code that builds the final machine

For examples and more doc check the README file

Type of change

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

Unit tests
Manual testing automatizations included in README as examples

Checklist:

My code follows the style guidelines of this project
I have performed a self-review of my code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes
Any dependent changes have been merged and published in downstream modules

…, listeners, state and transitions

…terfaces. File restructuring. Fix multiple transitions in same state

… have several actions in one state

… execution

…een state machine components

…ck and the onMatch/onMismatch functions. Fixes when multiple events trigger transitions at nearly the same time

- move pkp config to context to allow for dynamic switching of pkps - add support from capacityCreditTokens and therefore paid Lit networks - add pkp and capacity credit nft minting states - restricted state machine public interface - use verrors in remaining normal errors

…ipulating methods to be used in functional interface

packages/automation/README.md

… contract call and also using an array from context for params

…s BigNumberish

Ansonhkg

Very exciting! LGTM!

…-4031-new-listener-sdk typo readme

feat: add automation package building blocks, including state machine…

327964e

…, listeners, state and transitions

FedericoAmura requested review from MaximusHaximus and DashKash54 November 27, 2024 15:39

FedericoAmura self-assigned this Nov 27, 2024

FedericoAmura requested a review from Ansonhkg as a code owner November 27, 2024 15:39

FedericoAmura added 4 commits November 27, 2024 20:29

feat: add ids in state machines

40bbafe

feat: state machine creation using declarative config

1f76cc6

feat: native and erc20 balances monitoring transitions declarative in…

720cce3

…terfaces. File restructuring. Fix multiple transitions in same state

feat: add lit action run state machine capability as a state

be62dbc

Ansonhkg added the High priority label Dec 4, 2024

FedericoAmura added 17 commits December 5, 2024 19:10

feat: give state machine ability to sign and send transactions and to…

47cc68a

… have several actions in one state

feat: add machine PKP and private key handling and refactor LitAction…

4b39424

… execution

feat: include transitions definitions inside states definitions

6a1b481

fix: missing change, transitions property in StateDefinition

3e37a56

feat: refactor types

751b1dd

Merge branch 'refs/heads/master' into feature/lit-4031-new-listener-sdk

dcf0f07

feat: add state machine context to dynamically share information betw…

06a6da5

…een state machine components

feat: generalize context usage to states variables

3889f78

feat: types improvement

c4786f9

fix: queue events in transition to avoid multiple racing calls to che…

7598448

…ck and the onMatch/onMismatch functions. Fixes when multiple events trigger transitions at nearly the same time

fix: remove unnecessary context functions in machine

3e12d72

feat: error handling while in automation execution

2c26270

feat:

fbe2cce

- move pkp config to context to allow for dynamic switching of pkps - add support from capacityCreditTokens and therefore paid Lit networks - add pkp and capacity credit nft minting states - restricted state machine public interface - use verrors in remaining normal errors

feat: remove unnecessary things and restore state machine context man…

74d59c2

…ipulating methods to be used in functional interface

feat: update README.md

cdf0715

Merge branch 'refs/heads/master' into feature/lit-4031-new-listener-sdk

a82feb2

chore: fmt

a829079

a1ttech reviewed Dec 13, 2024

View reviewed changes

packages/automation/README.md Outdated Show resolved Hide resolved

a1ttech reviewed Dec 13, 2024

View reviewed changes

packages/automation/README.md Outdated Show resolved Hide resolved

a1ttech reviewed Dec 13, 2024

View reviewed changes

packages/automation/README.md Outdated Show resolved Hide resolved

FedericoAmura added 20 commits December 16, 2024 18:30

fix: readme timer example

c554d2c

feat: improve comments

8ec1b83

feat: improve state machine context methods types

a677568

fix: replace jsParams anys for unknowns

00435e9

feat: refactor state functions into Actions

2728414

feat: update readme with new Actions concept, removed from State

a9ee7ae

fix: remove some anys in types

0b55dd4

feat: replace states function properties with a generic actions array

0e6ac5c

feat: update readme with actions in states

ae7cade

feat: improve types

48e47e0

feat: improve types

ddf1261

feat: allow actions in transitions triggered when a match is found

407c97e

feat: readme descriptions update

8cebae7

Merge branch 'refs/heads/master' into feature/lit-4031-new-listener-sdk

32ac3e9

fix: log all context path check

c4c8731

fix: make contextUpdates optional

40f2600

feat: throw if lit action response is not successful

fc570e3

feat: allow transaction definitions with data instead of populating a…

c313106

… contract call and also using an array from context for params

feat: increase support for evmChainIds in different types using ether…

0f4df3b

…s BigNumberish

feat: rename automation package to event-listener

528bc01

Ansonhkg changed the title ~~feat: new automation package~~ feat: new event listener automation package Dec 20, 2024

Ansonhkg approved these changes Dec 20, 2024

View reviewed changes

Ansonhkg and others added 6 commits December 22, 2024 00:11

Merge branch 'master' into feature/lit-4031-new-listener-sdk

bc14aa5

typo

947367b

feat: add machine drawings in README.md to clarify explanation

026103a

feat: add reference to the open source machine running server

331dc2d

Merge pull request #746 from zach-is-my-name/app/upstream/feature/lit…

8723f8b

…-4031-new-listener-sdk typo readme

fix: rename event-listener repo reference

d4bf15a

FedericoAmura merged commit b599a54 into master Dec 23, 2024
5 checks passed

FedericoAmura deleted the feature/lit-4031-new-listener-sdk branch December 23, 2024 18:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: new event listener automation package #726

feat: new event listener automation package #726

FedericoAmura commented Nov 27, 2024 •

edited

Loading

Ansonhkg left a comment

feat: new event listener automation package #726

feat: new event listener automation package #726

Conversation

FedericoAmura commented Nov 27, 2024 • edited Loading

Description

Type of change

How Has This Been Tested?

Checklist:

Ansonhkg left a comment

Choose a reason for hiding this comment

FedericoAmura commented Nov 27, 2024 •

edited

Loading