@futureverse/sylo-protocol-sdk v0.0.0-pre-SM-279.4

JS/TS client for the Event Relay Protocol

A typescript implementation for the event relay protocol. Implements functionality for performing the auth, notify, and delivery protocols.

The canonical go-lang representation can be found within the sylo-node repository: https://github.com/dn3010/go-sylo-node/tree/v1.3.0-release/events.

Install

yarn

Build protobufs

First ensure that the ssh file used to authenticate with GitHub is available as the environment variable: DN3010_GITHUB_SSH_KEY.

export DN3010_GITHUB_SSH_KEY=$HOME/.ssh/id_ed25519

To build the protobufs and their type definitions, run:

npm run build:pb

Protobufs are pulled from the sylo-protocol repo as the event relay protocol relies on the Auth protocol.

Testing

Testing currently requires running a local testnet.

To start the testnet run:

docker compose -f testnet/docker-compose.yaml up --remove-orphans --force-recreate -d

After all the services started, run the script:

./testnet/prep_testnet.sh to prepare the network for local testing.

Run docker compose -f testnet/docker-compose.yaml down to stop the local testnet.

To execute tests, run npm run test.