feat(pyth-lazer-publisher-sdk): Add SDK for Publisher Transactions #2557
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| name: Publish Rust package pyth-lazer-publisher-sdk to crates.io | ||
|
|
||
| on: | ||
| push: | ||
| tags: | ||
| - rust-pyth-lazer-publisher-sdk-v* | ||
| jobs: | ||
| publish-pyth-lazer-publisher-sdk: | ||
| name: Publish Rust package pyth-lazer-published-sdk to crates.io | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout sources | ||
| uses: actions/checkout@v2 | ||
|
|
||
| - run: cargo publish --token ${CARGO_REGISTRY_TOKEN} | ||
| env: | ||
| CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }} | ||
| working-directory: "lazer/sdk/rust/published-sdk" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # Coverage directory used by tools like istanbul | ||
| coverage | ||
|
|
||
| # Build directory | ||
| dist/ | ||
|
|
||
| # Types generated for .proto files | ||
| src/generated/ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| .vscode/ | ||
| coverage/ | ||
| dist/ | ||
| doc/ | ||
| doc*/ | ||
| node_modules/ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| # pyth-lazer-publisher-sdk - Readme | ||
|
|
||
| ## Contributing & Development | ||
|
|
||
| See [contributing.md](docs/contributing/contributing.md) for information on how to develop or contribute to this project! | ||
|
|
||
| ## Installation and build | ||
|
|
||
| ### pnpm | ||
|
|
||
| ``` | ||
| cd to crosschain root | ||
| $ pnpm install | ||
| $ pnpm turbo --filter @pythnetwork/pyth-lazer-publisher-sdk build | ||
| ``` | ||
|
|
||
| As part of the build, files will be generated from the proto files found in the lazer/proto folder. These generated files are placed in the src/generated/ folder. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| export { base as default } from "@cprussin/eslint-config"; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| { | ||
| "name": "@pythnetwork/pyth-lazer-publisher-sdk", | ||
| "version": "0.1.0", | ||
| "description": "Pyth Lazer Publisher SDK", | ||
| "publishConfig": { | ||
| "access": "public" | ||
| }, | ||
| "files": [ | ||
| "dist/**/*" | ||
| ], | ||
| "main": "./src/generated/proto.js", | ||
| "types": "./src/generated/proto.d.ts", | ||
| "exports": { | ||
| "import": { | ||
| "types": "./src/generated/proto.d.ts", | ||
| "default": "./src/generated//proto.js" | ||
| }, | ||
| "require": { | ||
| "types": "./src/generated/proto.d.ts", | ||
| "default": "./src/generated//proto.js" | ||
| } | ||
| }, | ||
| "scripts": { | ||
| "build:proto-codegen": "mkdir -p src/generated && pnpm exec pbjs -t static-module -w es6 -o src/generated/proto.js ../proto/*.proto && pnpm exec pbts -o src/generated/proto.d.ts src/generated/proto.js", | ||
| "build:cjs": "tsc --project tsconfig.build.json --verbatimModuleSyntax false --module commonjs --outDir ./dist/cjs && echo '{\"type\":\"commonjs\"}' > dist/cjs/package.json", | ||
| "build:esm": "tsc --project tsconfig.build.json --outDir ./dist/esm && echo '{\"type\":\"module\"}' > dist/esm/package.json", | ||
darunrs marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "fix:lint": "eslint --fix . --max-warnings 0", | ||
| "test:lint": "eslint . --max-warnings 0", | ||
| "test:types": "tsc", | ||
| "test:format": "prettier --check .", | ||
| "fix:format": "prettier --write .", | ||
| "doc": "typedoc --out docs/typedoc src", | ||
| "prepublishOnly": "pnpm run build", | ||
| "publish": "pnpm run script -- publish" | ||
| }, | ||
| "type": "module", | ||
| "homepage": "https://github.com/pyth-network/pyth-crosschain/tree/main/lazer/publisher_sdk/js", | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "https://github.com/pyth-network/pyth-crosschain", | ||
| "directory": "lazer/publisher_sdk/js" | ||
| }, | ||
| "keywords": [ | ||
| "pyth", | ||
| "oracle" | ||
| ], | ||
| "license": "Apache-2.0", | ||
| "devDependencies": { | ||
| "@cprussin/eslint-config": "catalog:", | ||
| "@cprussin/tsconfig": "catalog:", | ||
| "@types/node": "^18.19.54", | ||
| "eslint": "catalog:", | ||
| "prettier": "catalog:", | ||
| "protobufjs": "^7.4.0", | ||
| "protobufjs-cli": "^1.1.3", | ||
| "ts-node": "catalog:", | ||
| "typedoc": "^0.26.8", | ||
| "typescript": "catalog:" | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| { | ||
| "extends": "./tsconfig.json", | ||
| "compilerOptions": { | ||
| "noEmit": false, | ||
| "incremental": false, | ||
| "declaration": true | ||
| }, | ||
| "include": ["src/**/*"], | ||
| "exclude": ["node_modules", "dist", "examples/"] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "extends": "@cprussin/tsconfig/base.json", | ||
| "include": ["src/**/*"], | ||
| "exclude": ["node_modules", "dist"] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| { | ||
| "$schema": "https://turbo.build/schema.json", | ||
| "extends": ["//"], | ||
| "tasks": { | ||
| "build:proto-codegen": { | ||
| "dependsOn": ["//#install:modules"], | ||
| "inputs": ["../proto/**"], | ||
| "outputs": ["src/generated/**"], | ||
| "cache": false | ||
| }, | ||
| "build": { | ||
| "dependsOn": ["build:cjs", "build:esm"], | ||
| "inputs": [ | ||
| "$TURBO_DEFAULT$", | ||
| "!README.md", | ||
| "!**/*.test.*", | ||
| "!jest.config.js", | ||
| "!eslint.config.js", | ||
| "!prettier.config.js", | ||
| "!vercel.json" | ||
| ], | ||
| "outputs": ["dist/**"] | ||
| }, | ||
| "build:cjs": { | ||
| "dependsOn": ["build:proto-codegen", "^build"], | ||
| "inputs": [ | ||
| "$TURBO_DEFAULT$", | ||
| "!README.md", | ||
| "!**/*.test.*", | ||
| "!jest.config.js", | ||
| "!eslint.config.js", | ||
| "!prettier.config.js", | ||
| "!vercel.json" | ||
| ], | ||
| "outputs": ["dist/cjs/**"] | ||
| }, | ||
| "build:esm": { | ||
| "dependsOn": ["build:proto-codegen", "^build"], | ||
| "inputs": [ | ||
| "$TURBO_DEFAULT$", | ||
| "!README.md", | ||
| "!**/*.test.*", | ||
| "!jest.config.js", | ||
| "!eslint.config.js", | ||
| "!prettier.config.js", | ||
| "!vercel.json" | ||
| ], | ||
| "outputs": ["dist/esm/**"] | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| syntax = "proto3"; | ||
|
|
||
| import "google/protobuf/timestamp.proto"; | ||
|
|
||
| package pyth_lazer_transaction; | ||
|
|
||
| // PublisherUpdate contains an array of individual updates and a timestamp | ||
| message PublisherUpdate { | ||
| // Array of updates, each of which target a single feed | ||
| repeated FeedUpdate updates = 1; | ||
|
|
||
| // ID of the Publisher that is sending the update | ||
| // Should match ID stored in Pyth Lazer | ||
| optional uint32 publisher_id = 2; | ||
|
|
||
| // Timestamp when this message was created | ||
| optional google.protobuf.Timestamp publisher_timestamp = 3; | ||
| } | ||
|
|
||
| // Update to a feed. May contain different types of data depending on what kind of update it is | ||
| message FeedUpdate { | ||
| // Feed which the update should be applied to | ||
| // Should match a feed id recognized by PythLazer | ||
| optional uint32 feed_id = 1; | ||
|
|
||
| // Timestamp when this data was first acquired or generated | ||
| optional google.protobuf.Timestamp source_timestamp = 2; | ||
|
|
||
| // one of the valid updates allowed by publishers for a lazer feed | ||
| oneof update { | ||
| PriceUpdate price_update = 3; | ||
| FundingRateUpdate funding_rate_update = 4; | ||
| }; | ||
| } | ||
|
|
||
| message PriceUpdate { | ||
| // Price for the symbol as an integer | ||
| // Should be produced with a matching exponent to the configured exponent value in PythLazer | ||
| // May be missing if no price data is available | ||
| optional int64 price = 1; | ||
|
|
||
| // Best Bid Price for the symbol as an integer | ||
| // Should be produced with a matching exponent to the configured exponent value in PythLazer | ||
| // May be missing if no data is available | ||
| optional int64 best_bid_price = 2; | ||
|
|
||
| // Best Ask Price for the symbol as an integer | ||
| // Should be produced with a matching exponent to the configured exponent value in PythLazer | ||
| // May be missing if no data is available | ||
| optional int64 best_ask_price = 3; | ||
| } | ||
|
|
||
| message FundingRateUpdate { | ||
| // Price for which the funding rate applies to | ||
| optional int64 price = 1; | ||
|
|
||
| // Perpetual Future funding rate | ||
| optional int64 rate = 2; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| syntax = "proto3"; | ||
|
|
||
| package pyth_lazer_transaction; | ||
|
|
||
| import "publisher_update.proto"; | ||
|
|
||
| // Types of Signatures allowed for signing Lazer Transactions | ||
| enum TransactionSignatureType { | ||
| // signature is 64 bytes long | ||
| ed25519 = 0; | ||
| } | ||
|
|
||
| // Signed lazer transaction payload | ||
| // This is what Pyth Lazer expects as input to the system | ||
| message SignedLazerTransaction { | ||
| // Type and signature should match | ||
| optional TransactionSignatureType signature_type = 1; | ||
|
|
||
| // Signature derived by signing payload with private key | ||
| optional bytes signature = 2; | ||
|
|
||
| // a LazerTransaction message which is already encoded with protobuf as bytes | ||
| // The encoded bytes are what should be signed | ||
| optional bytes payload = 3; | ||
| } | ||
|
Comment on lines
+15
to
+25
There was a problem hiding this comment. After yesterday's discussion I realized that this structure is not very well suited for governance mesages that are based on wormhole. Maybe we need something like this? There was a problem hiding this comment. I like to have a fixed transaction layout and then have customisability in the payload layer. I see transaction as something for sequencer and content of it as something for the aggregator. It's good to have permissioning over who does what. And then, you can say that the sequencer only streams txs from verified pubkeys. Otherwise, you'd need to either think of continuing the tokenized gateway (which is kind of like sigs) or verifying wh messages (which is very expensive) |
||
|
|
||
| // Transaction contianing one of the valid Lazer Transactions | ||
| message LazerTransaction { | ||
| oneof payload { | ||
| // Expected transaction sent by Publishers | ||
| // May contain many individual updates to various feeds | ||
| PublisherUpdate publisher_update = 1; | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Usually
buildin and of itself isn't a goal -- usually you're building to do something else. My general advice is to document the actual things you might want to do in the docs (e.g. "run tests" or "run this example" etc) and let the build happen automatically with the task orchestratorThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah that makes sense. I will add in a followup PR an example showing how to use the SDK to create some of the types, sign them, and then encode them.